-
Notifications
You must be signed in to change notification settings - Fork 745
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[SYCL][DOC] Remove size, get_wait_list from queue (#7612)
Remove the `queue::size` and `queue::get_wait_list` member functions from the proposed "sycl_ext_oneapi_queue_status_query" extension. After some implementation experience, we learned that these functions cause some unexpected overhead. Since we only have a strong use case for `queue::empty`, we decided to remove these others. Also rename the extension to match the new scope.
- Loading branch information
Showing
2 changed files
with
110 additions
and
145 deletions.
There are no files selected for viewing
110 changes: 110 additions & 0 deletions
110
sycl/doc/extensions/proposed/sycl_ext_oneapi_queue_empty.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
= sycl_ext_oneapi_queue_empty | ||
|
||
:source-highlighter: coderay | ||
:coderay-linenums-mode: table | ||
|
||
// This section needs to be after the document title. | ||
:doctype: book | ||
:toc2: | ||
:toc: left | ||
:encoding: utf-8 | ||
:lang: en | ||
:dpcpp: pass:[DPC++] | ||
|
||
// Set the default source code type in this document to C++, | ||
// for syntax highlighting purposes. This is needed because | ||
// docbook uses c++ and html5 uses cpp. | ||
:language: {basebackend@docbook:c++:cpp} | ||
|
||
|
||
== Notice | ||
|
||
Copyright (C) 2022-2022 Intel Corporation. All rights reserved. | ||
|
||
Khronos(R) is a registered trademark and SYCL(TM) and SPIR(TM) are trademarks | ||
of The Khronos Group Inc. OpenCL(TM) is a trademark of Apple Inc. used by | ||
permission by Khronos. | ||
|
||
|
||
== Contact | ||
|
||
To report problems with this extension, please open a new issue at: | ||
|
||
https://github.com/intel/llvm/issues | ||
|
||
|
||
== Dependencies | ||
|
||
This extension is written against the SYCL 2020 revision 6 specification. All | ||
references below to the "core SYCL specification" or to section numbers in the | ||
SYCL specification refer to that revision. | ||
|
||
|
||
== Status | ||
|
||
This is a proposed extension specification, intended to gather community | ||
feedback. Interfaces defined in this specification may not be implemented yet | ||
or may be in a preliminary state. The specification itself may also change in | ||
incompatible ways before it is finalized. *Shipping software products should | ||
not rely on APIs defined in this specification.* | ||
|
||
|
||
== Overview | ||
|
||
:cuda-stream: https://docs.nvidia.com/cuda/cuda-runtime-api/group__CUDART__STREAM.html#group__CUDART__STREAM_1g2021adeb17905c7ec2a3c1bf125c5435 | ||
|
||
This extension adds a new API that tells whether a `queue` is empty, similar to | ||
the CUDA function {cuda-stream}[CudaStreamQuery]. | ||
|
||
|
||
== Specification | ||
|
||
This extension provides a feature-test macro as described in the core SYCL | ||
specification. An implementation supporting this extension must predefine the | ||
macro `SYCL_EXT_ONEAPI_QUEUE_EMPTY` to one of the values defined in the table | ||
below. Applications can test for the existence of this macro to determine if | ||
the implementation supports this feature, or applications can test the macro's | ||
value to determine which of the extension's features the implementation | ||
supports. | ||
|
||
[%header,cols="2,5"] | ||
|=== | ||
|Value | ||
|Description | ||
|
||
|1 | ||
|Initial version of this extension. | ||
|=== | ||
|
||
=== New queue member function | ||
|
||
This extension adds the following new member function to the `queue` class. | ||
|
||
[source,c++] | ||
---- | ||
namespace sycl { | ||
class queue { | ||
bool ext_oneapi_empty() const; | ||
}; | ||
} // namespace sycl | ||
---- | ||
|
||
The semantics of the new function are: | ||
|
||
[frame="topbot",options="header"] | ||
|=== | ||
|Function |Description | ||
|
||
// --- ROW BREAK --- | ||
a| | ||
[source,c++] | ||
---- | ||
bool ext_oneapi_empty() const | ||
---- | ||
| | ||
Returns `true` if all commands previously submitted to this queue have | ||
completed at the point when this function is called. | ||
|
||
|=== |
145 changes: 0 additions & 145 deletions
145
sycl/doc/extensions/proposed/sycl_ext_oneapi_queue_status_query.asciidoc
This file was deleted.
Oops, something went wrong.