Skip to content

Commit a3f93c5

Browse files
bashbaugalycm
andauthored
clarify device enqueue clk_event_t behavior (#836)
* clarify device enqueue clk_event_t behavior * fix asciidoctor formatting issue Co-authored-by: Alastair Murray <alastair.murray@codeplay.com>
1 parent 33329d9 commit a3f93c5

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

OpenCL_C.txt

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10802,17 +10802,15 @@ events.
1080210802
| *Built-in Function* | *Description*
1080310803

1080410804
| void *retain_event*(clk_event_t _event_)
10805-
| Increments the event reference count. _event_ must be an event
10806-
returned by enqueue_kernel or enqueue_marker or a user event.
10805+
| Increments the event reference count.
10806+
Behavior is undefined if _event_ is not a valid event.
1080710807
| void *release_event*(clk_event_t _event_)
1080810808
| Decrements the event reference count.
1080910809
The event object is deleted once the event reference count is zero,
1081010810
the specific command identified by this event has completed (or
10811-
terminated) and there are no commands in any device command queue that
10811+
terminated), and there are no commands in any device command queue that
1081210812
require a wait for this event to complete.
10813-
10814-
_event_ must be an event returned by enqueue_kernel, enqueue_marker or
10815-
a user event.
10813+
Behavior is undefined if _event_ is not a valid event.
1081610814
| |
1081710815
| clk_event_t *create_user_event*()
1081810816
| Create a user event.
@@ -10824,20 +10822,21 @@ events.
1082410822
Otherwise returns _false_.
1082510823
| void *set_user_event_status*(clk_event_t _event_, int _status_)
1082610824
| Sets the execution status of a user event.
10827-
_event_ must be a user-event.
10825+
Behavior is undefined if _event_ is not a valid event returned by
10826+
*create_user_event*.
1082810827
_status_ can be either `CL_COMPLETE` or a negative integer value
1082910828
indicating an error.
1083010829
| |
1083110830
| void *capture_event_profiling_info*(clk_event_t _event_,
1083210831
clk_profiling_info _name_, global void *_value_)
1083310832
a| Captures the profiling information for functions that are enqueued as
1083410833
commands.
10835-
The specific function being referred to is: enqueue_kernel.
1083610834
These enqueued commands are identified by unique event objects.
1083710835
The profiling information will be available in _value_ once the
1083810836
command identified by _event_ has completed.
1083910837

10840-
_event_ must be an event returned by enqueue_kernel.
10838+
Behavior is undefined if _event_ is not a valid event returned by
10839+
*enqueue_kernel*.
1084110840

1084210841
_name_ identifies which profiling information is to be queried and can be:
1084310842

0 commit comments

Comments
 (0)