[SYCL][Ordered Queue] Begin moving ordered_queue to be a property on the queue (#1035)

Old ordered_queue is marked as deprecated.

Signed-off-by: James Brodman <[email protected]>

Author: jbrodman

sycl/include/CL/sycl/ordered_queue.hpp

@@ -18,13 +18,23 @@
 #include <memory>
 #include <utility>
 
+#ifdef __has_cpp_attribute
+  #if __has_cpp_attribute(deprecated)
+    #define __SYCL_DEPRECATED__ [[deprecated("Replaced by in_order queue property")]]
+  #endif
+#endif
+#ifndef __SYCL_DEPRECATED__
+  #define __SYCL_DEPRECATED__
+#endif
+
 __SYCL_INLINE namespace cl {
 namespace sycl {
 
 // Forward declaration
 class context;
 class device;
-class ordered_queue {
+
+class __SYCL_DEPRECATED__ ordered_queue {
 public:
   explicit ordered_queue(const property_list &propList = {})
       : ordered_queue(default_selector(), async_handler{}, propList) {}
@@ -37,7 +47,6 @@ class ordered_queue {
                 const property_list &propList = {})
       : ordered_queue(deviceSelector.select_device(), async_handler{},
                       propList) {}
-
   ordered_queue(const device_selector &deviceSelector,
                 const async_handler &asyncHandler,
                 const property_list &propList = {})
@@ -171,6 +180,8 @@ class ordered_queue {
   friend decltype(Obj::impl) detail::getSyclObjImpl(const Obj &SyclObject);
 };
 
+#undef __SYCL_DEPRECATED__
+
 } // namespace sycl
 } // namespace cl
 

sycl/include/CL/sycl/property_list.hpp

@@ -39,6 +39,7 @@ class context_bound;
 
 namespace queue {
 class enable_profiling;
+class in_order;
 } // namespace queue
 
 namespace detail {
@@ -57,6 +58,7 @@ enum PropKind {
 
   // Queue properties
   QueueEnableProfiling,
+  InOrder,
 
   PropKindSize
 };
@@ -110,6 +112,7 @@ RegisterProp(PropKind::BufferContextBound, buffer::context_bound);
 
 // Queue
 RegisterProp(PropKind::QueueEnableProfiling, queue::enable_profiling);
+RegisterProp(PropKind::InOrder, queue::in_order);
 
 // Sentinel, needed for automatic build of tuple in property_list.
 RegisterProp(PropKind::PropKindSize, PropBase);
@@ -172,6 +175,8 @@ class context_bound
 namespace queue {
 class enable_profiling
     : public detail::Prop<detail::PropKind::QueueEnableProfiling> {};
+
+class in_order : public detail::Prop<detail::PropKind::InOrder> {};
 } // namespace queue
 
 } // namespace property

sycl/include/CL/sycl/queue.hpp

@@ -421,6 +421,13 @@ class queue {
     });
   }
 
+  /// Returns whether the queue is in order or OoO
+  ///
+  /// Equivalent to has_property<property::queue::in_order>()
+  bool is_in_order() const {
+    return impl->has_property<property::queue::in_order>();
+  }
+
 private:
   shared_ptr_class<detail::queue_impl> impl;
   template <class Obj>

sycl/source/queue.cpp

@@ -17,6 +17,18 @@
 
 __SYCL_INLINE namespace cl {
 namespace sycl {
+
+namespace detail {
+
+QueueOrder getQueueOrder(const property_list &propList) {
+  if (propList.has_property<property::queue::in_order>()) {
+    return QueueOrder::Ordered;
+  }
+  return QueueOrder::OOO;
+}
+
+} // namespace detail
+
 queue::queue(const context &syclContext, const device_selector &deviceSelector,
              const async_handler &asyncHandler, const property_list &propList) {
 
@@ -27,16 +39,17 @@ queue::queue(const context &syclContext, const device_selector &deviceSelector,
   };
 
   const device &syclDevice = *std::max_element(Devs.begin(), Devs.end(), Comp);
+
   impl = std::make_shared<detail::queue_impl>(
       detail::getSyclObjImpl(syclDevice), detail::getSyclObjImpl(syclContext),
-      asyncHandler, cl::sycl::detail::QueueOrder::OOO, propList);
+      asyncHandler, detail::getQueueOrder(propList), propList);
 }
 
 queue::queue(const device &syclDevice, const async_handler &asyncHandler,
              const property_list &propList) {
   impl = std::make_shared<detail::queue_impl>(
       detail::getSyclObjImpl(syclDevice), asyncHandler,
-      cl::sycl::detail::QueueOrder::OOO, propList);
+      detail::getQueueOrder(propList), propList);
 }
 
 queue::queue(cl_command_queue clQueue, const context &syclContext,

sycl/test/ordered_queue/prop.cpp

@@ -0,0 +1,44 @@
+// RUN: %clangxx -fsycl %s -o %t1.out -lOpenCL
+// RUN: %CPU_RUN_PLACEHOLDER %t1.out
+// RUN: %GPU_RUN_PLACEHOLDER %t1.out
+
+//==----------- ordered_dmemll.cpp - Device Memory Linked List test --------==//
+// It uses an ordered queue where explicit waiting is not necessary between
+// kernels
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include <CL/sycl.hpp>
+
+using namespace cl::sycl;
+
+constexpr int numNodes = 4;
+
+bool getQueueOrder(cl_command_queue cq) {
+  cl_command_queue_properties reportedProps;
+  cl_int iRet = clGetCommandQueueInfo(
+      cq, CL_QUEUE_PROPERTIES, sizeof(reportedProps), &reportedProps, nullptr);
+  assert(CL_SUCCESS == iRet && "Failed to obtain queue info from ocl device");
+  return (reportedProps & CL_QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE) ? false
+                                                                  : true;
+}
+
+int main() {
+  queue q{property::queue::in_order()};
+  auto dev = q.get_device();
+  
+  cl_command_queue cq = q.get(); 
+  bool expected_result = dev.is_host() ? true : getQueueOrder(cq);
+  if (!expected_result)
+    return -1;
+
+  expected_result = dev.is_host() ? true : q.is_in_order();
+  if (!expected_result)
+    return -2;
+
+  return 0;
+}