KhronosGroup / KhronosGroup/OpenCL-Docs
Semaphore state after importing an external semaphore with clCreateSemaphoreWithPropertiesKHR
- Dominant language
- Python
- Stars
- 420
- Forks
- 131
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 11
Description
The specification for [clCreateSemaphoreWithPropertiesKHR](https://registry.khronos.org/OpenCL/specs/3.0-unified/html/OpenCL_API.html#clCreateSemaphoreWithPropertiesKHR) currently states:
> [clCreateSemaphoreWithPropertiesKHR](https://registry.khronos.org/OpenCL/specs/3.0-unified/html/OpenCL_API.html#clCreateSemaphoreWithPropertiesKHR) returns a valid semaphore object in an un-signaled state and errcode_ret is set to [CL_SUCCESS](https://registry.khronos.org/OpenCL/specs/3.0-unified/html/OpenCL_API.html#CL_SUCCESS) if the function is executed successfully
The fact that the new semaphore must be in an un-signaled state is not guaranteed for every type of handle, therefore it should be safe for applications to immediately wait on these semaphores by calling clEnqueueWaitSemaphoresKHR.
Contributor guide
Research direction
Start by reading the clCreateSemaphoreWithPropertiesKHR specification section and the related clEnqueueWaitSemaphoresKHR behavior. Clarify the statement about the semaphore's initial state for imported external handles, then update the specification so the documented behavior matches the intended safe wait semantics.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100