Change to properties on submit

Signed-off-by: Larsen, Steffen <[email protected]>

Author: steffenlarsen

sycl/doc/extensions/experimental/sycl_ext_oneapi_enqueue_functions.asciidoc

@@ -230,8 +230,8 @@ a!
 ----
 namespace sycl::ext::oneapi::experimental {
 
-template <typename CommandGroupFunc>
-void submit(sycl::queue q, CommandGroupFunc&& cgf);
+template <typename CommandGroupFunc, typename Properties = empty_properties_t>
+void submit(sycl::queue q, CommandGroupFunc&& cgf, Properties properties = {});
 
 }
 ----
@@ -247,8 +247,9 @@ a!
 ----
 namespace sycl::ext::oneapi::experimental {
 
-template <typename CommandGroupFunc>
-sycl::event submit_with_event(sycl::queue q, CommandGroupFunc&& cgf);
+template <typename CommandGroupFunc, typename Properties = empty_properties_t>
+sycl::event submit_with_event(sycl::queue q, CommandGroupFunc&& cgf,
+                              Properties properties = {});
 
 }
 ----
@@ -670,11 +671,9 @@ a!
 ----
 namespace sycl::ext::oneapi::experimental {
 
-template <typename Properties = empty_properties_t>
-void barrier(sycl::queue q, Properties properties = {});
+void barrier(sycl::queue q);
 
-template <typename Properties = empty_properties_t>
-void barrier(sycl::handler h, Properties properties = {});
+void barrier(sycl::handler h);
 
 }
 ----
@@ -692,13 +691,9 @@ a!
 ----
 namespace sycl::ext::oneapi::experimental {
 
-template <typename Properties = empty_properties_t>
-void partial_barrier(sycl::queue q, const std::vector<sycl::event>& events,
-                     Properties properties = {});
+void partial_barrier(sycl::queue q, const std::vector<sycl::event>& events);
 
-template <typename Properties = empty_properties_t>
-void partial_barrier(sycl::handler h, const std::vector<sycl::event>& events,
-                     Properties properties = {});
+void partial_barrier(sycl::handler h, const std::vector<sycl::event>& events);
 
 }
 ----

sycl/doc/extensions/proposed/sycl_ext_intel_low_power_event.asciidoc

@@ -69,11 +69,11 @@ On some backends, calling `wait()` on a `event` will synchronize using a
 busy-waiting implementation. Though this comes at a low latency for the
 synchronization of the event, it has the downside of consuming high amounts of
 CPU time for no meaningful work.  This extension introduces a new property for
-`sycl::ext::oneapi::experimental::barrier()` that will produce a "low-power"
-event. These new low-power events will, if possible, yield the thread that the
-`wait()` member function is called on and only wake up occasionally to check if
-the event has finished. This reduces the time the CPU spends checking finish
-condition of the wait, at the cost of latency.
+SYCL commands that will produce a "low-power" event. These new low-power events
+will, if possible, yield the thread that the `wait()` member function is called
+on and only wake up occasionally to check if the event has finished. This
+reduces the time the CPU spends checking finish condition of the wait, at the
+cost of latency.
 
 
 == Specification
@@ -101,15 +101,20 @@ supports.
 
 === Low-power event property
 
-This extension also adds a new property which can be used with the `barrier`
-and `partial_barrier` enqueue free functions from
+This extension adds a new property which can be used with the
+`submit_with_event` free function from
 link:../experimental/sycl_ext_oneapi_enqueue_functions.asciidoc[sycl_ext_oneapi_enqueue_functions].
 Passing this property to either of these functions will act as a hint to the
 `event` created from the corresponding commands to do low-power synchronization.
 If the backend is able to handle low-power events, calling `event::wait()` or
 `event::wait_and_throw()` will cause the thread to yield and only do occasional
 wake-ups to check the event progress.
 
+[_Note:_ The property currently only has an effect on `barrier` and
+`partial_barrier` commands enqueued on queues that return
+`backend::ext_oneapi_level_zero` from `queue::get_backend()`.
+_{endnote}_]
+
 ```
 namespace sycl::ext::intel::experimental {
 
@@ -140,10 +145,10 @@ int main() {
   // Submit some work to the queue.
   oneapiex::submit(Q, [&](sycl::handler &CGH) {...});
 
-  // Submit a barrier with the low-power event property.
+  // Submit a command with the low-power event property.
   sycl::event E = oneapiex::submit_with_event(Q, [&](sycl::handler &CGH) {
-    oneapiex::barrier(CGH, oneapiex::properties{intelex::low_power_event});
-  });
+    ...
+  }, oneapiex::properties{intelex::low_power_event});
 
   // Waiting for the resulting event will use low-power waiting if possible.
   E.wait();

sycl/include/sycl/ext/oneapi/experimental/enqueue_functions.hpp

@@ -95,18 +95,20 @@ void submit_impl(queue &Q, CommandGroupFunc &&CGF,
 }
 } // namespace detail
 
-template <typename CommandGroupFunc>
-void submit(queue Q, CommandGroupFunc &&CGF,
+template <typename CommandGroupFunc, typename PropertiesT = empty_properties_t>
+void submit(queue Q, CommandGroupFunc &&CGF, PropertiesT Props = {},
             const sycl::detail::code_location &CodeLoc =
                 sycl::detail::code_location::current()) {
+  std::ignore = Props;
   sycl::ext::oneapi::experimental::detail::submit_impl(
       Q, std::forward<CommandGroupFunc>(CGF), CodeLoc);
 }
 
-template <typename CommandGroupFunc>
-event submit_with_event(queue Q, CommandGroupFunc &&CGF,
+template <typename CommandGroupFunc, typename PropertiesT = empty_properties_t>
+event submit_with_event(queue Q, CommandGroupFunc &&CGF, PropertiesT Props = {},
                         const sycl::detail::code_location &CodeLoc =
                             sycl::detail::code_location::current()) {
+  std::ignore = Props;
   return Q.submit(std::forward<CommandGroupFunc>(CGF), CodeLoc);
 }
 
@@ -349,34 +351,21 @@ __SYCL_EXPORT void mem_advise(queue Q, void *Ptr, size_t NumBytes, int Advice,
                               const sycl::detail::code_location &CodeLoc =
                                   sycl::detail::code_location::current());
 
-template <typename PropertiesT = empty_properties_t>
-inline void barrier(handler &CGH, PropertiesT Properties = {}) {
-  std::ignore = Properties;
-  CGH.ext_oneapi_barrier();
-}
+inline void barrier(handler &CGH) { CGH.ext_oneapi_barrier(); }
 
-template <typename PropertiesT = empty_properties_t>
-inline void barrier(queue Q, PropertiesT Properties = {},
-                    const sycl::detail::code_location &CodeLoc =
-                        sycl::detail::code_location::current()) {
-  submit(Q, [&](handler &CGH) { barrier(CGH, Properties); }, CodeLoc);
+inline void barrier(queue Q, const sycl::detail::code_location &CodeLoc =
+                                 sycl::detail::code_location::current()) {
+  submit(Q, [&](handler &CGH) { barrier(CGH); }, CodeLoc);
 }
 
-template <typename PropertiesT = empty_properties_t>
-inline void partial_barrier(handler &CGH, const std::vector<event> &Events,
-                            PropertiesT Properties = {}) {
-  std::ignore = Properties;
+inline void partial_barrier(handler &CGH, const std::vector<event> &Events) {
   CGH.ext_oneapi_barrier(Events);
 }
 
-template <typename PropertiesT = empty_properties_t>
 inline void partial_barrier(queue Q, const std::vector<event> &Events,
-                            PropertiesT Properties = {},
                             const sycl::detail::code_location &CodeLoc =
                                 sycl::detail::code_location::current()) {
-  submit(
-      Q, [&](handler &CGH) { partial_barrier(CGH, Events, Properties); },
-      CodeLoc);
+  submit(Q, [&](handler &CGH) { partial_barrier(CGH, Events); }, CodeLoc);
 }
 
 } // namespace ext::oneapi::experimental