Skip to content

Commit ae227b0

Browse files
add note
Signed-off-by: Tikhomirova, Kseniya <[email protected]>
1 parent a48d8be commit ae227b0

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

sycl/doc/design/SYCLInstrumentationUsingXPTI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ All trace point types in bold provide semantic information about the graph, node
256256
| `barrier_end` | <div style="text-align: left"><li>**trace_type**: `xpti::trace_point_type_t::barrier_end` that marks the end of the barrier that is encountered during enqueue.</li> <li> **parent**: The global graph event that is created during the `graph_create` event.</li> <li> **event**: The event ID will reflect the ID of the command group object that has encountered a barrier during the enqueue operation. </li> <li> **instance**: Unique ID to allow the correlation of the `barrier_begin` event with the `barrier_end` event. </li> <li> **user_data**: String indicating `enqueue.barrier` and the reason for the barrier as a `const char *` </li> <p></p>The reason for the barrier could be one of `Buffer locked by host accessor`, `Blocked by host task` or `Unknown reason`.</div> | <li> Computational Kernels </li> `sycl_device`, `sycl_device_type`, `sycl_device_name`, `kernel_name`, `from_source`, `sym_function_name`, `sym_source_file_name`, `sym_line_no`, `sym_column_no` <li>Memory operations</li> `memory_object`, `offset`, `access_range_start`, `access_range_end`, `allocation_type`, `copy_from`, `copy_to` |
257257
| `diagnostics` | <div style="text-align: left"><li>**trace_type**: `xpti::trace_point_type_t::diagnostics` that represents general purpose notifications. For example, it is emitted when an exception is thrown in SYCL runtime. </li> <li> **parent**: Set to NULL.</li> <li> **event**: The event ID will reflect the code location of notification origin, if available. </li> <li> **instance**: An instance ID that records the number of times this code location has been seen. </li> <li> **user_data**: String with diagnostic message as a `const char *` </li></div> | `sym_function_name`, `sym_source_file_name`, `sym_line_no`, `sym_column_no` |
258258
| `queue_create` | <div style="text-align: left"><li>**trace_type**: `xpti::trace_point_type_t::queue_create` that marks the creation of a queue, which could be a device or host queue.</li> <li> **parent**: Set to NULL.</li> <li> **event**: The event ID will reflect the code location of notification origin, if available. </li> <li> **instance**: Not meaningful for this trace type. </li> <li> **user_data**: Not meaningful for this trace type. Could contain string with 'queue_create' or nullptr. </li> <p></p> This signal is emitted only once for every queue object, notifies about successful queue creation (the signal is not emitted if any exception happens during queue creation). </div> | `sycl_context`, `sycl_device_name`, `sycl_device`, `is_inorder`, `queue_id`, `queue_handle` <p></p> <p></p> `queue_id` is a per-queue unique identificator within program lifetime. Allows to map traces of queue creation, destruction and task executions on a queue. `queue_handle` is absent for host queue since no backend object is used. |
259-
| `queue_destroy` | <div style="text-align: left"><li>**trace_type**: `xpti::trace_point_type_t::queue_destroy` that marks the destruction of a queue, which could be a device or host queue.</li> <li> **parent**: Set to NULL.</li> <li> **event**: The event ID will reflect the code location of notification origin, if available. </li> <li> **instance**: Not meaningful for this trace type. </li> <li> **user_data**: Not meaningful for this trace type. Could contain string with 'queue_destroy' or nullptr. </li> <p></p> This signal is emitted only once for every queue object, notifies about queue destruction. Contains the same metadata set for corresponding 'queue_create' signal. </div> | `sycl_context`, `sycl_device_name`, `sycl_device`, `is_inorder`, `queue_id`, `queue_handle` <p></p> <p></p> `queue_id` is a per-queue unique identificator within program lifetime. Allows to map traces of queue creation, destruction and task executions on a queue. `queue_handle` is absent for host queue since no backend object is used. </li>|
259+
| `queue_destroy` | <div style="text-align: left"><li>**trace_type**: `xpti::trace_point_type_t::queue_destroy` that marks the destruction of a queue, which could be a device or host queue.</li> <li> **parent**: Set to NULL.</li> <li> **event**: The event ID will reflect the code location of notification origin, if available. </li> <li> **instance**: Not meaningful for this trace type. </li> <li> **user_data**: Not meaningful for this trace type. Could contain string with 'queue_destroy' or nullptr. </li> <p></p> This signal is emitted only once for every queue object, notifies about queue destruction. Contains the same metadata set for corresponding 'queue_create' signal. **event** and corresponding metadata will be destroyed right after notification. </div> | `sycl_context`, `sycl_device_name`, `sycl_device`, `is_inorder`, `queue_id`, `queue_handle` <p></p> <p></p> `queue_id` is a per-queue unique identificator within program lifetime. Allows to map traces of queue creation, destruction and task executions on a queue. `queue_handle` is absent for host queue since no backend object is used. </li>|
260260

261261
### Metadata description
262262

0 commit comments

Comments
 (0)