[SYCL][Graph] Deprecate dynamic_parameter constructors that take a graph (#18199)

- Tying a dynamic param to a specific graph has no practical purpose and
prevents whole graph update usage, so this is the first step to removing
it
- Remove error wording from spec about using dynamic params across
multiple graphs
- Deprecate old constructors and add new ones under breaking changes
macro.
- Ignore graph parameter for current constructors since it is no longer
stored.
- Update tests to ignore deprecation warnings under werror

Full spec changes to detail new behaviour will be done during the next
ABI breaking window when these deprecated constructors are also removed.

Author: Bensuo

sycl/doc/extensions/experimental/sycl_ext_oneapi_graph.asciidoc

@@ -527,6 +527,10 @@ dynamic_parameter(command_graph<graph_state::modifiable> graph,
 |Constructs a dynamic parameter object that can be registered with command graph
 nodes with an initial value.
 
+[Note: This constructor which takes a graph has been deprecated and will be
+replaced in the next ABI breaking window. The new constructor will not associate
+a dynamic parameter with any specific graph. -- end note]
+
 Parameters:
 
 * `graph` - Graph containing the nodes which will have dynamic parameters.
@@ -1936,10 +1940,6 @@ a command-group submitted to a queue with is currently recording to a graph.
 * Throws synchronously with error code `invalid` if this function is called from
 a normal SYCL command-group submission.
 
-* Throws synchronously with error code `invalid` if the graph which will be
-associated with the graph node resulting from this command-group submission is
-different from the one with which `dynamicParameterAcc` was created.
-
 |
 [source,c++]
 ----
@@ -1966,10 +1966,6 @@ a command-group submitted to a queue with is currently recording to a graph.
 * Throws synchronously with error code `invalid` if this function is called from
 a normal SYCL command-group submission.
 
-* Throws synchronously with error code `invalid` if the graph which will be
-associated with the graph node resulting from this command-group submission is
-different from the one with which the dynamic_parameter was created.
-
 |===
 
 === Thread Safety

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

@@ -510,10 +510,17 @@ class command_graph<graph_state::executable>
 namespace detail {
 class __SYCL_EXPORT dynamic_parameter_base {
 public:
+#ifdef __INTEL_PREVIEW_BREAKING_CHANGES
+  dynamic_parameter_base(size_t ParamSize, const void *Data);
+  dynamic_parameter_base();
+#else
   dynamic_parameter_base() = default;
+#endif
+
   dynamic_parameter_base(
       sycl::ext::oneapi::experimental::command_graph<graph_state::modifiable>
           Graph);
+
   dynamic_parameter_base(
       sycl::ext::oneapi::experimental::command_graph<graph_state::modifiable>
           Graph,
@@ -556,10 +563,17 @@ class dynamic_work_group_memory_base
 public:
   dynamic_work_group_memory_base() = default;
 #ifndef __SYCL_DEVICE_ONLY__
+#ifdef __INTEL_PREVIEW_BREAKING_CHANGES
+
+  dynamic_work_group_memory_base(size_t Size)
+      : dynamic_parameter_base(), BufferSize(Size) {}
+#endif
+  // TODO: Remove in next ABI breaking window
   dynamic_work_group_memory_base(
       experimental::command_graph<graph_state::modifiable> Graph, size_t Size)
       : dynamic_parameter_base(Graph), BufferSize(Size) {}
 #else
+  dynamic_work_group_memory_base(size_t Size) : BufferSize(Size) {}
   dynamic_work_group_memory_base(
       experimental::command_graph<graph_state::modifiable> /*Graph*/,
       size_t Size)
@@ -592,6 +606,19 @@ __SYCL_TYPE(dynamic_work_group_memory) dynamic_work_group_memory
   // closed.
   dynamic_work_group_memory() = default;
 
+#ifdef __INTEL_PREVIEW_BREAKING_CHANGES
+  /// Constructs a new dynamic_work_group_memory object.
+  /// @param Num Number of elements in the unbounded array DataT.
+  dynamic_work_group_memory(size_t Num)
+      : detail::dynamic_work_group_memory_base(
+            Num * sizeof(std::remove_extent_t<DataT>)) {}
+#endif
+
+#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
+  __SYCL_DEPRECATED("Dynamic_work_group_memory constructors taking a graph "
+                    "object have been deprecated "
+                    "and will be removed in the next ABI breaking window.")
+#endif
   /// Constructs a new dynamic_work_group_memory object.
   /// @param Graph The graph associated with this object.
   /// @param Num Number of elements in the unbounded array DataT.
@@ -642,6 +669,19 @@ class dynamic_parameter : public detail::dynamic_parameter_base {
           : sycl::detail::kernel_param_kind_t::kind_std_layout;
 
 public:
+#ifdef __INTEL_PREVIEW_BREAKING_CHANGES
+  /// Constructs a new dynamic parameter.
+  /// @param Graph The graph associated with this parameter.
+  /// @param Param A reference value for this parameter used for CTAD.
+  dynamic_parameter(const ValueT &Param)
+      : detail::dynamic_parameter_base(sizeof(ValueT), &Param) {}
+#endif
+
+#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
+  __SYCL_DEPRECATED("Dynamic_parameter constructors taking a graph object have "
+                    "been deprecated "
+                    "and will be removed in the next ABI breaking window.")
+#endif
   /// Constructs a new dynamic parameter.
   /// @param Graph The graph associated with this parameter.
   /// @param Param A reference value for this parameter used for CTAD.

sycl/source/detail/graph_impl.cpp

@@ -1990,16 +1990,17 @@ size_t executable_command_graph::get_required_mem_size() const {
   return impl->getGraphImpl()->getMemPool().getMemUseCurrent();
 }
 
-dynamic_parameter_base::dynamic_parameter_base(
-    command_graph<graph_state::modifiable> Graph)
-    : impl(std::make_shared<dynamic_parameter_impl>(
-          sycl::detail::getSyclObjImpl(Graph))) {}
+#ifdef __INTEL_PREVIEW_BREAKING_CHANGES
+dynamic_parameter_base::dynamic_parameter_base()
+    : impl(std::make_shared<dynamic_parameter_impl>()) {}
+#endif
 
 dynamic_parameter_base::dynamic_parameter_base(
-    command_graph<graph_state::modifiable> Graph, size_t ParamSize,
-    const void *Data)
-    : impl(std::make_shared<dynamic_parameter_impl>(
-          sycl::detail::getSyclObjImpl(Graph), ParamSize, Data)) {}
+    command_graph<graph_state::modifiable>)
+    : impl(std::make_shared<dynamic_parameter_impl>()) {}
+dynamic_parameter_base::dynamic_parameter_base(
+    command_graph<graph_state::modifiable>, size_t ParamSize, const void *Data)
+    : impl(std::make_shared<dynamic_parameter_impl>(ParamSize, Data)) {}
 
 void dynamic_parameter_base::updateValue(const void *NewValue, size_t Size) {
   impl->updateValue(NewValue, Size);

sycl/source/detail/graph_impl.hpp

@@ -1551,23 +1551,19 @@ class exec_graph_impl {
 
 class dynamic_parameter_impl {
 public:
-  dynamic_parameter_impl(std::shared_ptr<graph_impl> GraphImpl)
-      : MGraph(GraphImpl),
-        MID(NextAvailableID.fetch_add(1, std::memory_order_relaxed)) {}
+  dynamic_parameter_impl()
+      : MID(NextAvailableID.fetch_add(1, std::memory_order_relaxed)) {}
 
-  dynamic_parameter_impl(std::shared_ptr<graph_impl> GraphImpl,
-                         size_t ParamSize, const void *Data)
-      : MGraph(GraphImpl), MValueStorage(ParamSize),
+  dynamic_parameter_impl(size_t ParamSize, const void *Data)
+      : MValueStorage(ParamSize),
         MID(NextAvailableID.fetch_add(1, std::memory_order_relaxed)) {
     std::memcpy(MValueStorage.data(), Data, ParamSize);
   }
 
   /// sycl_ext_oneapi_raw_kernel_arg constructor
   /// Parameter size is taken from member of raw_kernel_arg object.
-  dynamic_parameter_impl(std::shared_ptr<graph_impl> GraphImpl, size_t,
-                         raw_kernel_arg *Data)
-      : MGraph(GraphImpl),
-        MID(NextAvailableID.fetch_add(1, std::memory_order_relaxed)) {
+  dynamic_parameter_impl(size_t, raw_kernel_arg *Data)
+      : MID(NextAvailableID.fetch_add(1, std::memory_order_relaxed)) {
     size_t RawArgSize = Data->MArgSize;
     const void *RawArgData = Data->MArgData;
     MValueStorage.reserve(RawArgSize);
@@ -1660,8 +1656,6 @@ class dynamic_parameter_impl {
   std::vector<std::pair<std::weak_ptr<node_impl>, int>> MNodes;
   // Dynamic command-groups which will be updated
   std::vector<DynamicCGInfo> MDynCGs;
-
-  std::weak_ptr<graph_impl> MGraph;
   std::vector<std::byte> MValueStorage;
 
 private:

sycl/source/handler.cpp

@@ -2153,12 +2153,6 @@ void handler::registerDynamicParameter(
   }
 
   auto Paraimpl = detail::getSyclObjImpl(DynamicParamBase);
-  if (Paraimpl->MGraph.lock() != this->impl->MGraph) {
-    throw sycl::exception(
-        make_error_code(errc::invalid),
-        "Cannot use a Dynamic Parameter with a node associated with a graph "
-        "other than the one it was created with.");
-  }
   impl->MDynamicParameters.emplace_back(Paraimpl.get(), ArgIndex);
 }
 

sycl/test-e2e/Graph/Update/FreeFunctionKernels/dyn_work_group_memory_basic.cpp

@@ -1,4 +1,4 @@
-// RUN: %{build} -o %t.out
+// RUN: %{build} -Wno-error=deprecated-declarations -o %t.out
 // RUN: %{run} %t.out
 // Extra run to check for leaks in Level Zero using UR_L0_LEAKS_DEBUG
 // RUN: %if level_zero %{env SYCL_PI_LEVEL_ZERO_USE_IMMEDIATE_COMMANDLISTS=0 %{l0_leak_check} %{run} %t.out 2>&1 | FileCheck %s --implicit-check-not=LEAK %}

sycl/test-e2e/Graph/Update/FreeFunctionKernels/update_before_finalize.cpp

@@ -1,4 +1,4 @@
-// RUN: %{build} -o %t.out
+// RUN: %{build} -Wno-error=deprecated-declarations -o %t.out
 // RUN: %{run} %t.out
 // Extra run to check for leaks in Level Zero using UR_L0_LEAKS_DEBUG
 // RUN: %if level_zero %{env SYCL_PI_LEVEL_ZERO_USE_IMMEDIATE_COMMANDLISTS=0 %{l0_leak_check} %{run} %t.out 2>&1 | FileCheck %s --implicit-check-not=LEAK %}

sycl/test-e2e/Graph/Update/FreeFunctionKernels/update_with_indices_multiple_exec_graphs.cpp

@@ -1,4 +1,4 @@
-// RUN: %{build} -o %t.out
+// RUN: %{build} -Wno-error=deprecated-declarations -o %t.out
 // RUN: %{run} %t.out
 // Extra run to check for leaks in Level Zero using UR_L0_LEAKS_DEBUG
 // RUN: %if level_zero %{env SYCL_PI_LEVEL_ZERO_USE_IMMEDIATE_COMMANDLISTS=0 %{l0_leak_check} %{run} %t.out 2>&1 | FileCheck %s --implicit-check-not=LEAK %}

sycl/test-e2e/Graph/Update/FreeFunctionKernels/update_with_indices_ordering.cpp

@@ -1,4 +1,4 @@
-// RUN: %{build} -o %t.out
+// RUN: %{build} -Wno-error=deprecated-declarations -o %t.out
 // RUN: %{run} %t.out
 // Extra run to check for leaks in Level Zero using UR_L0_LEAKS_DEBUG
 // RUN: %if level_zero %{env SYCL_PI_LEVEL_ZERO_USE_IMMEDIATE_COMMANDLISTS=0 %{l0_leak_check} %{run} %t.out 2>&1 | FileCheck %s --implicit-check-not=LEAK %}

sycl/test-e2e/Graph/Update/FreeFunctionKernels/update_with_indices_ptr.cpp

@@ -1,4 +1,4 @@
-// RUN: %{build} -o %t.out
+// RUN: %{build} -Wno-error=deprecated-declarations -o %t.out
 // RUN: %{run} %t.out
 // Extra run to check for leaks in Level Zero using UR_L0_LEAKS_DEBUG
 // RUN: %if level_zero %{env SYCL_PI_LEVEL_ZERO_USE_IMMEDIATE_COMMANDLISTS=0 %{l0_leak_check} %{run} %t.out 2>&1 | FileCheck %s --implicit-check-not=LEAK %}