From bcdb3a1ddfa4f00df998c25481fc66a94d331676 Mon Sep 17 00:00:00 2001 From: "Larsen, Steffen" Date: Wed, 6 Mar 2024 23:59:16 -0800 Subject: [PATCH 1/3] [SYCL][Docs] Specify command_start meaning for profiling tags This commit clarifies the meaning of command_start on profiling tags. Signed-off-by: Larsen, Steffen --- .../proposed/sycl_ext_oneapi_profiling_tag.asciidoc | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/sycl/doc/extensions/proposed/sycl_ext_oneapi_profiling_tag.asciidoc b/sycl/doc/extensions/proposed/sycl_ext_oneapi_profiling_tag.asciidoc index b5440acff8de..afeffccf88cf 100644 --- a/sycl/doc/extensions/proposed/sycl_ext_oneapi_profiling_tag.asciidoc +++ b/sycl/doc/extensions/proposed/sycl_ext_oneapi_profiling_tag.asciidoc @@ -151,13 +151,16 @@ The event's `info::event_profiling::command_submit` timestamp reflects the time at which `submit_profiling_tag` is called. The event's `info::event_profiling::command_end` timestamp reflects the time at which the event enters the "complete" state. +The event's `info::event_profiling::command_start` timestamp reflects the time +that the profiling tag command starts executing. This timestamp is between +the `info::event_profiling::command_submit` and +`info::event_profiling::command_end` timestamps. It is unspecified whether the event ever has the -`info::event_command_status::running` status, and the meaning of the -`info::event_profiling::command_start` timestamp is also unspecified. -Implementations are encouraged to transition the event directly from the -"submitted" status to the "complete" status and are encouraged to set the -"command_start" timestamp to the same value as the "command_end" timestamp. +`info::event_command_status::running` status. Implementations are encouraged +to transition the event directly from the "submitted" status to the "complete" +status and are encouraged to set the "command_start" timestamp to the same value +as the "command_end" timestamp. _Throws:_ A synchronous `exception` with the `errc::invalid` error code if the queue was not constructed with the `property::queue::enable_profiling` property From b37eeb751bc3a8e312779f10d32f56fbf93defb4 Mon Sep 17 00:00:00 2001 From: "Larsen, Steffen" Date: Thu, 7 Mar 2024 06:34:31 -0800 Subject: [PATCH 2/3] Add newline Signed-off-by: Larsen, Steffen --- .../proposed/sycl_ext_oneapi_profiling_tag.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sycl/doc/extensions/proposed/sycl_ext_oneapi_profiling_tag.asciidoc b/sycl/doc/extensions/proposed/sycl_ext_oneapi_profiling_tag.asciidoc index afeffccf88cf..1b5d84b630a5 100644 --- a/sycl/doc/extensions/proposed/sycl_ext_oneapi_profiling_tag.asciidoc +++ b/sycl/doc/extensions/proposed/sycl_ext_oneapi_profiling_tag.asciidoc @@ -152,8 +152,8 @@ time at which `submit_profiling_tag` is called. The event's `info::event_profiling::command_end` timestamp reflects the time at which the event enters the "complete" state. The event's `info::event_profiling::command_start` timestamp reflects the time -that the profiling tag command starts executing. This timestamp is between -the `info::event_profiling::command_submit` and +that the profiling tag command starts executing. +This timestamp is between the `info::event_profiling::command_submit` and `info::event_profiling::command_end` timestamps. It is unspecified whether the event ever has the From b6a812ffe7a8f7566f6ab7de9dfb67a107daa7df Mon Sep 17 00:00:00 2001 From: "Larsen, Steffen" Date: Thu, 7 Mar 2024 07:32:14 -0800 Subject: [PATCH 3/3] Add another newline Signed-off-by: Larsen, Steffen --- .../proposed/sycl_ext_oneapi_profiling_tag.asciidoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/sycl/doc/extensions/proposed/sycl_ext_oneapi_profiling_tag.asciidoc b/sycl/doc/extensions/proposed/sycl_ext_oneapi_profiling_tag.asciidoc index 1b5d84b630a5..03886a27106e 100644 --- a/sycl/doc/extensions/proposed/sycl_ext_oneapi_profiling_tag.asciidoc +++ b/sycl/doc/extensions/proposed/sycl_ext_oneapi_profiling_tag.asciidoc @@ -157,10 +157,10 @@ This timestamp is between the `info::event_profiling::command_submit` and `info::event_profiling::command_end` timestamps. It is unspecified whether the event ever has the -`info::event_command_status::running` status. Implementations are encouraged -to transition the event directly from the "submitted" status to the "complete" -status and are encouraged to set the "command_start" timestamp to the same value -as the "command_end" timestamp. +`info::event_command_status::running` status. +Implementations are encouraged to transition the event directly from the +"submitted" status to the "complete" status and are encouraged to set the +"command_start" timestamp to the same value as the "command_end" timestamp. _Throws:_ A synchronous `exception` with the `errc::invalid` error code if the queue was not constructed with the `property::queue::enable_profiling` property