Skip to content

Commit d849467

Browse files
committed
Apply comments + fix pre-commit
1 parent 8047c6f commit d849467

13 files changed

+53
-79
lines changed

sycl/doc/extensions/EnqueueBarrier/enqueue_barrier.asciidoc

+13-13
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,9 @@ two new members to the `queue` class:
8686
[grid="rows"]
8787
[options="header"]
8888
|========================================
89-
|*handler::ext_intel_barrier*|*queue::ext_oneapi_submit_barrier*
90-
|`void ext_intel_barrier()` | `event ext_oneapi_submit_barrier()`
91-
|`void ext_intel_barrier( const vector_class<event> &waitList )` | `event ext_oneapi_submit_barrier( const vector_class<event> &waitList )`
89+
|*handler::ext_oneapi_barrier*|*queue::ext_oneapi_submit_barrier*
90+
|`void ext_oneapi_barrier()` | `event ext_oneapi_submit_barrier()`
91+
|`void ext_oneapi_barrier( const vector_class<event> &waitList )` | `event ext_oneapi_submit_barrier( const vector_class<event> &waitList )`
9292
|========================================
9393

9494
The first variant of the barrier takes no parameters, and waits for all previously submitted commands to the queue to enter the `info::event_command_status::complete` state before any command later submitted to the same queue is allowed to execute. A second variant of the barrier accepts a list of events, with the behavior that no commands submitted to the same queue after barrier submission may execute until all events in the `waitList` have entered the `info::event_command_status::complete` state. Both variants are non-blocking from the host program perspective, in that they do not wait for the barrier conditions to have been met before returning.
@@ -104,7 +104,7 @@ Some forms of the new barrier methods return an `event`, which can be used to pe
104104

105105
CG4 doesn't execute until all previous command groups submitted to the same queue (CG1, CG2, CG3) have entered the completed state.
106106

107-
==== 1. Using `handler::ext_intel_barrier()`:
107+
==== 1. Using `handler::ext_oneapi_barrier()`:
108108

109109
[source,c++,NoName,linenums]
110110
----
@@ -120,7 +120,7 @@ Queue.submit([&](cl::sycl::handler& cgh) {
120120
});
121121
122122
Queue.submit([&](cl::sycl::handler& cgh) {
123-
cgh.ext_intel_barrier();
123+
cgh.ext_oneapi_barrier();
124124
});
125125
126126
Queue.submit([&](cl::sycl::handler& cgh) {
@@ -157,7 +157,7 @@ Queue.submit([&](cl::sycl::handler& cgh) {
157157

158158
CG3 requires CG1 (in Queue1) and CG2 (in Queue2) to have completed before it (CG3) begins execution.
159159

160-
==== 1. Using `handler::ext_intel_barrier()`:
160+
==== 1. Using `handler::ext_oneapi_barrier()`:
161161

162162
[source,c++,NoName,linenums]
163163
----
@@ -171,7 +171,7 @@ auto event_barrier2 = Queue2.submit([&](cl::sycl::handler& cgh) {
171171
});
172172
173173
Queue3.submit([&](cl::sycl::handler& cgh) {
174-
cgh.ext_intel_barrier( vector_class<event>{event_barrier1, event_barrier2} );
174+
cgh.ext_oneapi_barrier( vector_class<event>{event_barrier1, event_barrier2} );
175175
});
176176
177177
Queue3.submit([&](cl::sycl::handler& cgh) {
@@ -236,8 +236,8 @@ void wait();
236236
[options="header"]
237237
|========================================
238238
|*Member functions*|*Description*
239-
|`event ext_oneapi_submit_barrier()` | Same effect as submitting a `handler::ext_intel_barrier()` within a command group to this `queue`. The returned event enters the `info::event_command_status::complete` state when all events that the barrier is dependent on (implicitly from all previously submitted commands to the same queue) have entered the `info::event_command_status::complete` state.
240-
|`event ext_oneapi_submit_barrier( const vector_class<event> &waitList )` | Same effect as submitting a `handler:ext_intel_barrier( const vector_class<event> &waitList )` within a command group to this `queue`. The returned event enters the `info::event_command_status::complete` state when all events that the barrier is dependent on (explicitly from `waitList`) have entered the `info::event_command_status::complete` state.
239+
|`event ext_oneapi_submit_barrier()` | Same effect as submitting a `handler::ext_oneapi_barrier()` within a command group to this `queue`. The returned event enters the `info::event_command_status::complete` state when all events that the barrier is dependent on (implicitly from all previously submitted commands to the same queue) have entered the `info::event_command_status::complete` state.
240+
|`event ext_oneapi_submit_barrier( const vector_class<event> &waitList )` | Same effect as submitting a `handler:ext_oneapi_barrier( const vector_class<event> &waitList )` within a command group to this `queue`. The returned event enters the `info::event_command_status::complete` state when all events that the barrier is dependent on (explicitly from `waitList`) have entered the `info::event_command_status::complete` state.
241241
|========================================
242242

243243

@@ -273,9 +273,9 @@ void fill(void *ptr, const T &pattern, size_t count);
273273
template <typename T>
274274
void fill(void *ptr, const T &pattern, size_t count);
275275
276-
void ext_intel_barrier();
276+
void ext_oneapi_barrier();
277277
278-
void ext_intel_barrier( const vector_class<event> &waitList );
278+
void ext_oneapi_barrier( const vector_class<event> &waitList );
279279
280280
};
281281
...
@@ -296,8 +296,8 @@ Barriers can be created by two members of the `handler` class that force synchro
296296
[options="header"]
297297
|========================================
298298
|*Member functions*|*Description*
299-
|`void ext_intel_barrier()` | Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the `info::event_command_status::complete` state.
300-
|`void ext_intel_barrier( const vector_class<event> &waitList` ) | Prevents any commands submitted afterward to this queue from executing until all events in `waitList` have entered the `info::event_command_status::complete` state. If `waitList` is empty, then the barrier has no effect.
299+
|`void ext_oneapi_barrier()` | Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the `info::event_command_status::complete` state.
300+
|`void ext_oneapi_barrier( const vector_class<event> &waitList` ) | Prevents any commands submitted afterward to this queue from executing until all events in `waitList` have entered the `info::event_command_status::complete` state. If `waitList` is empty, then the barrier has no effect.
301301
|========================================
302302

303303
== Issues

sycl/doc/extensions/MemChannel/MemChannel.asciidoc

+9-27
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= SYCL_EXT_INTEL_MEM_CHANNEL_PROPERTY
1+
= SYCL_INTEL_mem_channel_property
22

33
== Introduction
44
NOTE: 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.
@@ -23,30 +23,14 @@ Because the interfaces defined by this specification are not final and are subje
2323
== Version
2424

2525
Built On: {docdate} +
26-
Revision: 2
26+
Revision: 1
2727

2828
== Dependencies
2929

30-
This extension is written against the SYCL 2020 specification, Revision 3.
30+
This extension is written against the SYCL 2020 provisional specification, Revision 1.
3131

3232
The use of this extension requires a target that supports cl_intel_mem_channel_property or equivalent if OpenCL is used as the underlying device runtime.
3333

34-
== Feature Test Macro
35-
36-
This extension provides a feature-test macro as described in the core SYCL
37-
specification section 6.3.3 "Feature test macros". Therefore, an
38-
implementation supporting this extension must predefine the macro
39-
`SYCL_EXT_INTEL_MEM_CHANNEL_PROPERTY` to one of the values defined in the table below.
40-
Applications can test for the existence of this macro to determine if the
41-
implementation supports this feature, or applications can test the macro's
42-
value to determine which of the extension's APIs the implementation supports.
43-
44-
[%header,cols="1,5"]
45-
|===
46-
|Value |Description
47-
|1 |Initial extension version. Base features are supported.
48-
|===
49-
5034
== Overview
5135

5236
On some targets manual assignment of buffers to memory regions can improve memory bandwidth. This extension adds a buffer property to indicate in which memory channel a particular buffer should be allocated. This information is an optimization hint to the runtime and thus it is legal to ignore.
@@ -61,27 +45,27 @@ Add a new property to Table 4.33: Properties supported by the SYCL buffer class
6145
[options="header"]
6246
|===
6347
| Property | Description
64-
| property::buffer::ext_intel_mem_channel | The `ext_intel_mem_channel` property is a hint to the SYCL runtime that the buffer should be stored in a particular memory channel provided to the property.
48+
| property::buffer::mem_channel | The `mem_channel` property is a hint to the SYCL runtime that the buffer should be stored in a particular memory channel provided to the property.
6549
|===
6650
--
6751

68-
Add a new constructor to Table 41: Constructors of the buffer property classes as follows:
52+
Add a new constructor to Table 4.34: Constructors of the buffer property classes as follows:
6953

7054
--
7155
[options="header"]
7256
|===
7357
| Constructor | Description
74-
| property::buffer::ext_intel_mem_channel::ext_intel_mem_channel(cl_uint channel) | Constructs a SYCL `ext_intel_mem_channel` property instance with the specified channel ID. The range of valid values depends on the target and is implementation defined. Invalid values do not need to result in an error as the property is only a hint.
58+
| property::buffer::mem_channel::mem_channel(cl_uint channel) | Constructs a SYCL `mem_channel` property instance with the specified channel ID. The range of valid values depends on the target and is implementation defined. Invalid values do not need to result in an error as the property is only a hint.
7559
|===
7660
--
7761

78-
Add a new member function to Table 42: Member functions of the buffer property classes as follows:
62+
Add a new member function to Table 4.35: Member functions of the buffer property classes as follows:
7963

8064
--
8165
[options="header"]
8266
|===
8367
| Member function | Description
84-
| cl_uint property::buffer::ext_intel_mem_channel::get_channel() const | Returns the cl_uint which was specified when constructing this SYCL `ext_intel_mem_channel` property.
68+
| cl_uint property::buffer::mem_channel::get_channel() const | Returns the cl_uint which was specified when constructing this SYCL `mem_channel` property.
8569
|===
8670
--
8771

@@ -103,7 +87,7 @@ enum class aspect {
10387
} // namespace sycl
10488
```
10589

106-
Add an entry for the new aspect to Table 26: Device aspects defined by the core SYCL specification:
90+
Add an entry for the new aspect to Table 4.20: Device aspects defined by the core SYCL specification:
10791

10892
--
10993
[options="header"]
@@ -123,6 +107,4 @@ Add an entry for the new aspect to Table 26: Device aspects defined by the core
123107
|========================================
124108
|Rev|Date|Author|Changes
125109
|1|2020-10-26|Joe Garvey|*Initial public draft*
126-
|2|2021-08-30|Dmitry Vodopyanov|*Updated according to SYCL 2020 reqs for extensions*
127-
128110
|========================================

sycl/doc/extensions/SYCL_ONEAPI_dot_accumulate.asciidoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Because the interfaces defined by this specification are not final and are subje
4646
== Version
4747

4848
Built On: {docdate} +
49-
Revision: B
49+
Revision: 3
5050

5151
== Contact
5252

@@ -135,9 +135,9 @@ None.
135135
[options="header"]
136136
|========================================
137137
|Rev|Date|Author|Changes
138-
|A|2019-12-13|Ben Ashbaugh|*Initial draft*
139-
|B|2019-12-18|Ben Ashbaugh|Switched to standard C++ fixed width types.
140-
|C|2020-10-26|Rajiv Deodhar|Added int32 types.
138+
|1|2019-12-13|Ben Ashbaugh|*Initial draft*
139+
|2|2019-12-18|Ben Ashbaugh|Switched to standard C++ fixed width types.
140+
|3|2020-10-26|Rajiv Deodhar|Added int32 types.
141141
|========================================
142142

143143
//************************************************************************

sycl/doc/extensions/USMAddressSpaces/usm_address_spaces.asciidoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Because the interfaces defined by this specification are not final and are subje
2525
== Version
2626

2727
Built On: {docdate} +
28-
Revision: B
28+
Revision: 2
2929

3030
== Dependencies
3131

@@ -134,6 +134,6 @@ using host_ptr = multi_ptr<ElementType, access::address_space::ext_intel_global_
134134
[options="header"]
135135
|========================================
136136
|Rev|Date|Author|Changes
137-
|A|2020-06-18|Joe Garvey|Initial public draft
138-
|B|2021-08-30|Dmitry Vodopyanov|Updated according to SYCL 2020 reqs for extensions
137+
|1|2020-06-18|Joe Garvey|Initial public draft
138+
|2|2021-08-30|Dmitry Vodopyanov|Updated according to SYCL 2020 reqs for extensions
139139
|========================================

sycl/doc/extensions/accessor_properties/SYCL_INTEL_buffer_location.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Because the interfaces defined by this specification are not final and are subje
3131
== Version
3232

3333
Built On: {docdate} +
34-
Revision: A
34+
Revision: 1
3535

3636
== Contact
3737
Michael Kinsner, Intel (michael 'dot' kinsner 'at' intel 'dot' com)
@@ -95,5 +95,5 @@ It also notifies the SYCL runtime to store the given accessor in that memory. |
9595
[options="header"]
9696
|========================================
9797
|Rev|Date|Author|Changes
98-
|A|2020-09-08|Joe Garvey|*Initial public draft*
98+
|1|2020-09-08|Joe Garvey|*Initial public draft*
9999
|========================================

sycl/include/CL/sycl/feature_test.hpp

-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ namespace sycl {
2525
#endif
2626
#define SYCL_EXT_INTEL_BF16_CONVERSION 1
2727
#define SYCL_EXT_ONEAPI_ENQUEUE_BARRIER 1
28-
#define SYCL_EXT_INTEL_MEM_CHANNEL_PROPERTY 1
2928
#define SYCL_EXT_INTEL_USM_ADDRESS_SPACES 1
3029
#define SYCL_EXT_ONEAPI_BACKEND_LEVEL_ZERO 1
3130

sycl/include/CL/sycl/handler.hpp

+6-8
Original file line numberDiff line numberDiff line change
@@ -2281,35 +2281,33 @@ class __SYCL_EXPORT handler {
22812281
/// Prevents any commands submitted afterward to this queue from executing
22822282
/// until all commands previously submitted to this queue have entered the
22832283
/// complete state.
2284-
void ext_intel_barrier() {
2284+
void ext_oneapi_barrier() {
22852285
throwIfActionIsCreated();
22862286
setType(detail::CG::Barrier);
22872287
}
22882288

22892289
/// Prevents any commands submitted afterward to this queue from executing
22902290
/// until all commands previously submitted to this queue have entered the
22912291
/// complete state.
2292-
__SYCL2020_DEPRECATED("use 'ext_intel_barrier' instead")
2293-
void barrier() { ext_intel_barrier(); }
2292+
__SYCL2020_DEPRECATED("use 'ext_oneapi_barrier' instead")
2293+
void barrier() { ext_oneapi_barrier(); }
22942294

22952295
/// Prevents any commands submitted afterward to this queue from executing
22962296
/// until all events in WaitList have entered the complete state. If WaitList
22972297
/// is empty, then the barrier has no effect.
22982298
///
22992299
/// \param WaitList is a vector of valid SYCL events that need to complete
23002300
/// before barrier command can be executed.
2301-
void ext_intel_barrier(const std::vector<event> &WaitList);
2301+
void ext_oneapi_barrier(const std::vector<event> &WaitList);
23022302

23032303
/// Prevents any commands submitted afterward to this queue from executing
23042304
/// until all events in WaitList have entered the complete state. If WaitList
23052305
/// is empty, then the barrier has no effect.
23062306
///
23072307
/// \param WaitList is a vector of valid SYCL events that need to complete
23082308
/// before barrier command can be executed.
2309-
__SYCL2020_DEPRECATED("use 'ext_intel_barrier' instead")
2310-
void barrier(const std::vector<event> &WaitList) {
2311-
ext_intel_barrier(WaitList);
2312-
}
2309+
__SYCL2020_DEPRECATED("use 'ext_oneapi_barrier' instead")
2310+
void barrier(const std::vector<event> &WaitList);
23132311

23142312
/// Copies data from one memory region to another, both pointed by
23152313
/// USM pointers.

sycl/include/CL/sycl/properties/buffer_properties.hpp

+3-9
Original file line numberDiff line numberDiff line change
@@ -40,22 +40,16 @@ class context_bound
4040
sycl::context MCtx;
4141
};
4242

43-
class ext_intel_mem_channel : public detail::PropertyWithData<
44-
detail::PropWithDataKind::BufferMemChannel> {
43+
class mem_channel : public detail::PropertyWithData<
44+
detail::PropWithDataKind::BufferMemChannel> {
4545
public:
46-
ext_intel_mem_channel(uint32_t Channel) : MChannel(Channel) {}
46+
mem_channel(uint32_t Channel) : MChannel(Channel) {}
4747
uint32_t get_channel() const { return MChannel; }
4848

4949
private:
5050
uint32_t MChannel;
5151
};
5252

53-
class __SYCL2020_DEPRECATED("use 'ext_intel_mem_channel' instead") mem_channel
54-
: public ext_intel_mem_channel {
55-
public:
56-
mem_channel(uint32_t Channel) : ext_intel_mem_channel(Channel) {}
57-
};
58-
5953
} // namespace buffer
6054
} // namespace property
6155

sycl/include/CL/sycl/queue.hpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ class __SYCL_EXPORT queue {
253253
/// group is being enqueued on.
254254
event ext_oneapi_submit_barrier(_CODELOCONLYPARAM(&CodeLoc)) {
255255
return submit(
256-
[=](handler &CGH) { CGH.ext_intel_barrier(); } _CODELOCFW(CodeLoc));
256+
[=](handler &CGH) { CGH.ext_oneapi_barrier(); } _CODELOCFW(CodeLoc));
257257
}
258258

259259
/// Prevents any commands submitted afterward to this queue from executing
@@ -281,7 +281,7 @@ class __SYCL_EXPORT queue {
281281
event ext_oneapi_submit_barrier(
282282
const std::vector<event> &WaitList _CODELOCPARAM(&CodeLoc)) {
283283
return submit([=](handler &CGH) {
284-
CGH.ext_intel_barrier(WaitList);
284+
CGH.ext_oneapi_barrier(WaitList);
285285
} _CODELOCFW(CodeLoc));
286286
}
287287

sycl/source/handler.cpp

+6-1
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,7 @@ std::string handler::getKernelName() {
488488
return MKernel->get_info<info::kernel::function_name>();
489489
}
490490

491-
void handler::ext_intel_barrier(const std::vector<event> &WaitList) {
491+
void handler::ext_oneapi_barrier(const std::vector<event> &WaitList) {
492492
throwIfActionIsCreated();
493493
MCGType = detail::CG::BarrierWaitlist;
494494
MEventsWaitWithBarrier.resize(WaitList.size());
@@ -497,6 +497,11 @@ void handler::ext_intel_barrier(const std::vector<event> &WaitList) {
497497
[](const event &Event) { return detail::getSyclObjImpl(Event); });
498498
}
499499

500+
__SYCL2020_DEPRECATED("use 'ext_oneapi_barrier' instead")
501+
void handler::barrier(const std::vector<event> &WaitList) {
502+
handler::ext_oneapi_barrier(WaitList);
503+
}
504+
500505
using namespace sycl::detail;
501506
bool handler::DisableRangeRounding() {
502507
return SYCLConfig<SYCL_DISABLE_PARALLEL_FOR_RANGE_ROUNDING>::get();

sycl/test/abi/sycl_symbols_linux.dump

+1-1
Original file line numberDiff line numberDiff line change
@@ -3911,7 +3911,7 @@ _ZN2cl4sycl7handler10mem_adviseEPKvmi
39113911
_ZN2cl4sycl7handler10processArgEPvRKNS0_6detail19kernel_param_kind_tEimRmb
39123912
_ZN2cl4sycl7handler10processArgEPvRKNS0_6detail19kernel_param_kind_tEimRmbb
39133913
_ZN2cl4sycl7handler13getKernelNameB5cxx11Ev
3914-
_ZN2cl4sycl7handler17ext_intel_barrierERKSt6vectorINS0_5eventESaIS3_EE
3914+
_ZN2cl4sycl7handler17ext_oneapi_barrierERKSt6vectorINS0_5eventESaIS3_EE
39153915
_ZN2cl4sycl7handler18RangeRoundingTraceEv
39163916
_ZN2cl4sycl7handler18extractArgsAndReqsEv
39173917
_ZN2cl4sycl7handler20DisableRangeRoundingEv

sycl/test/abi/sycl_symbols_windows.dump

+2-2
Original file line numberDiff line numberDiff line change
@@ -1740,8 +1740,8 @@
17401740
?expm1@__host_std@cl@@YA?AVhalf@half_impl@detail@sycl@2@V34562@@Z
17411741
?expm1@__host_std@cl@@YAMM@Z
17421742
?expm1@__host_std@cl@@YANN@Z
1743-
?ext_intel_barrier@handler@sycl@cl@@QEAAXAEBV?$vector@Vevent@sycl@cl@@V?$allocator@Vevent@sycl@cl@@@std@@@std@@@Z
1744-
?ext_intel_barrier@handler@sycl@cl@@QEAAXXZ
1743+
?ext_oneapi_barrier@handler@sycl@cl@@QEAAXAEBV?$vector@Vevent@sycl@cl@@V?$allocator@Vevent@sycl@cl@@@std@@@std@@@Z
1744+
?ext_oneapi_barrier@handler@sycl@cl@@QEAAXXZ
17451745
?ext_oneapi_submit_barrier@queue@sycl@cl@@QEAA?AVevent@23@AEBUcode_location@detail@23@@Z
17461746
?ext_oneapi_submit_barrier@queue@sycl@cl@@QEAA?AVevent@23@AEBV?$vector@Vevent@sycl@cl@@V?$allocator@Vevent@sycl@cl@@@std@@@std@@AEBUcode_location@detail@23@@Z
17471747
?extractArgsAndReqs@handler@sycl@cl@@AEAAXXZ

sycl/test/warnings/sycl_2020_deprecations.cpp

+2-6
Original file line numberDiff line numberDiff line change
@@ -165,15 +165,11 @@ int main() {
165165
auto BitCastRes = sycl::detail::bit_cast<unsigned short>(Val);
166166
(void)BitCastRes;
167167

168-
// expected-warning@+1{{'submit_barrier' is deprecated: use 'ext_intel_submit_barrier' instead}}
168+
// expected-warning@+1{{'submit_barrier' is deprecated: use 'ext_oneapi_submit_barrier' instead}}
169169
Queue.submit_barrier();
170170

171-
// expected-warning@+1{{'barrier' is deprecated: use 'ext_intel_barrier' instead}}
171+
// expected-warning@+1{{'barrier' is deprecated: use 'ext_oneapi_barrier' instead}}
172172
Queue.submit([&](sycl::handler &CGH) { CGH.barrier(); });
173173

174-
// expected-warning@+1{{'mem_channel' is deprecated: use 'ext_intel_mem_channel' instead}}
175-
sycl::property_list MemChannelProp{sycl::property::buffer::mem_channel(2)};
176-
(void)MemChannelProp;
177-
178174
return 0;
179175
}

0 commit comments

Comments
 (0)