[SYCL] Add property list to stream (#4898)

These changes add a constructor to the SYCL 2020 stream class taking a
property list argument. Additionally it adds the common property
interface to the stream class.

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

Author: steffenlarsen

sycl/include/CL/sycl/stream.hpp

@@ -750,6 +750,11 @@ class __SYCL_EXPORT __SYCL_SPECIAL_CLASS stream {
   // Throws exception in case of invalid input parameters
   stream(size_t BufferSize, size_t MaxStatementSize, handler &CGH);
 
+  // Property-list constructor variant.
+  // TODO: Merge with other stream constructor and give PropList default value.
+  stream(size_t BufferSize, size_t MaxStatementSize, handler &CGH,
+         const property_list &PropList);
+
   size_t get_size() const;
 
   size_t get_max_statement_size() const;
@@ -764,6 +769,10 @@ class __SYCL_EXPORT __SYCL_SPECIAL_CLASS stream {
 
   bool operator!=(const stream &LHS) const;
 
+  template <typename propertyT> bool has_property() const noexcept;
+
+  template <typename propertyT> propertyT get_property() const;
+
 private:
 #ifdef __SYCL_DEVICE_ONLY__
   char padding[sizeof(std::shared_ptr<detail::stream_impl>)];

sycl/source/detail/stream_impl.cpp

@@ -18,8 +18,14 @@ namespace detail {
 
 stream_impl::stream_impl(size_t BufferSize, size_t MaxStatementSize,
                          handler &CGH)
-    : BufferSize_(BufferSize), MaxStatementSize_(MaxStatementSize) {
+    : stream_impl(BufferSize, MaxStatementSize, {}) {
   (void)CGH;
+}
+
+stream_impl::stream_impl(size_t BufferSize, size_t MaxStatementSize,
+                         const property_list &PropList)
+    : BufferSize_(BufferSize), MaxStatementSize_(MaxStatementSize),
+      PropList_(PropList) {
   // We need to store stream buffers in the scheduler because they need to be
   // alive after submitting the kernel. They cannot be stored in the stream
   // object because it causes loop dependency between objects and results in

sycl/source/detail/stream_impl.hpp

@@ -12,6 +12,7 @@
 #include <CL/sycl/buffer.hpp>
 #include <CL/sycl/detail/export.hpp>
 #include <CL/sycl/handler.hpp>
+#include <CL/sycl/property_list.hpp>
 #include <CL/sycl/range.hpp>
 #include <CL/sycl/stream.hpp>
 
@@ -23,10 +24,13 @@ namespace detail {
 
 class __SYCL_EXPORT stream_impl {
 public:
-  // TODO: Handler argument is not used in constructor.
+  // TODO: This constructor is unused.
   // To be removed when API/ABI changes are allowed.
   stream_impl(size_t BufferSize, size_t MaxStatementSize, handler &CGH);
 
+  stream_impl(size_t BufferSize, size_t MaxStatementSize,
+              const property_list &PropList);
+
   // Method to provide an access to the global stream buffer
   GlobalBufAccessorT accessGlobalBuf(handler &CGH);
 
@@ -44,6 +48,14 @@ class __SYCL_EXPORT stream_impl {
 
   size_t get_max_statement_size() const;
 
+  template <typename propertyT> bool has_property() const noexcept {
+    return PropList_.has_property<propertyT>();
+  }
+
+  template <typename propertyT> propertyT get_property() const {
+    return PropList_.get_property<propertyT>();
+  }
+
 private:
   // Size of the stream buffer
   size_t BufferSize_;
@@ -52,6 +64,9 @@ class __SYCL_EXPORT stream_impl {
   // statement till the semicolon
   unsigned MaxStatementSize_;
 
+  // Property list
+  property_list PropList_;
+
   // Additinonal memory is allocated in the beginning of the stream buffer for
   // 2 variables: offset in the stream buffer and offset in the flush buffer.
   static const size_t OffsetSize = 2 * sizeof(unsigned);

sycl/source/stream.cpp

@@ -6,6 +6,7 @@
 //
 //===----------------------------------------------------------------------===//
 
+#include <CL/sycl/properties/all_properties.hpp>
 #include <CL/sycl/stream.hpp>
 #include <detail/queue_impl.hpp>
 #include <detail/stream_impl.hpp>
@@ -32,8 +33,12 @@ static size_t CheckMaxStatementSize(const size_t &MaxStatementSize) {
 }
 
 stream::stream(size_t BufferSize, size_t MaxStatementSize, handler &CGH)
+    : stream(BufferSize, MaxStatementSize, CGH, {}) {}
+
+stream::stream(size_t BufferSize, size_t MaxStatementSize, handler &CGH,
+               const property_list &PropList)
     : impl(std::make_shared<detail::stream_impl>(
-          BufferSize, CheckMaxStatementSize(MaxStatementSize), CGH)),
+          BufferSize, CheckMaxStatementSize(MaxStatementSize), PropList)),
       GlobalBuf(impl->accessGlobalBuf(CGH)),
       GlobalOffset(impl->accessGlobalOffset(CGH)),
       // Allocate the flush buffer, which contains space for each work item
@@ -59,6 +64,24 @@ bool stream::operator==(const stream &RHS) const { return (impl == RHS.impl); }
 
 bool stream::operator!=(const stream &RHS) const { return !(impl == RHS.impl); }
 
+#define __SYCL_PARAM_TRAITS_SPEC(param_type)                                   \
+  template <>                                                                  \
+  __SYCL_EXPORT bool stream::has_property<param_type>() const noexcept {       \
+    return impl->has_property<param_type>();                                   \
+  }
+#include <CL/sycl/detail/properties_traits.def>
+
+#undef __SYCL_PARAM_TRAITS_SPEC
+
+#define __SYCL_PARAM_TRAITS_SPEC(param_type)                                   \
+  template <>                                                                  \
+  __SYCL_EXPORT param_type stream::get_property<param_type>() const {          \
+    return impl->get_property<param_type>();                                   \
+  }
+#include <CL/sycl/detail/properties_traits.def>
+
+#undef __SYCL_PARAM_TRAITS_SPEC
+
 } // namespace sycl
 } // __SYCL_INLINE_NAMESPACE(cl)
 

sycl/test/abi/sycl_symbols_linux.dump

@@ -3811,7 +3811,9 @@ _ZN2cl4sycl6detail11stream_impl15accessGlobalBufERNS0_7handlerE
 _ZN2cl4sycl6detail11stream_impl18accessGlobalOffsetERNS0_7handlerE
 _ZN2cl4sycl6detail11stream_impl20accessGlobalFlushBufERNS0_7handlerE
 _ZN2cl4sycl6detail11stream_impl5flushEv
+_ZN2cl4sycl6detail11stream_implC1EmmRKNS0_13property_listE
 _ZN2cl4sycl6detail11stream_implC1EmmRNS0_7handlerE
+_ZN2cl4sycl6detail11stream_implC2EmmRKNS0_13property_listE
 _ZN2cl4sycl6detail11stream_implC2EmmRNS0_7handlerE
 _ZN2cl4sycl6detail12compile_implERKNS0_13kernel_bundleILNS0_12bundle_stateE0EEERKSt6vectorINS0_6deviceESaIS8_EERKNS0_13property_listE
 _ZN2cl4sycl6detail12isOutOfRangeENS0_3vecIiLi4EEENS0_15addressing_modeENS0_5rangeILi3EEE
@@ -3925,7 +3927,9 @@ _ZN2cl4sycl6opencl12make_contextEm
 _ZN2cl4sycl6opencl12make_programERKNS0_7contextEm
 _ZN2cl4sycl6opencl13make_platformEm
 _ZN2cl4sycl6streamC1EmmRNS0_7handlerE
+_ZN2cl4sycl6streamC1EmmRNS0_7handlerERKNS0_13property_listE
 _ZN2cl4sycl6streamC2EmmRNS0_7handlerE
+_ZN2cl4sycl6streamC2EmmRNS0_7handlerERKNS0_13property_listE
 _ZN2cl4sycl7contextC1EP11_cl_contextSt8functionIFvNS0_14exception_listEEE
 _ZN2cl4sycl7contextC1ERKNS0_13property_listE
 _ZN2cl4sycl7contextC1ERKNS0_6deviceERKNS0_13property_listE
@@ -4277,6 +4281,32 @@ _ZNK2cl4sycl6kernel8get_infoILNS0_4info6kernelE4499EEENS3_12param_traitsIS4_XT_E
 _ZNK2cl4sycl6kernel8get_infoILNS0_4info6kernelE4500EEENS3_12param_traitsIS4_XT_EE11return_typeEv
 _ZNK2cl4sycl6kernel8get_infoILNS0_4info6kernelE4501EEENS3_12param_traitsIS4_XT_EE11return_typeEv
 _ZNK2cl4sycl6kernel9getNativeEv
+_ZNK2cl4sycl6stream12get_propertyINS0_3ext6oneapi4cuda8property7context19use_primary_contextEEET_v
+_ZNK2cl4sycl6stream12get_propertyINS0_3ext6oneapi8property6buffer22use_pinned_host_memoryEEET_v
+_ZNK2cl4sycl6stream12get_propertyINS0_8property5image12use_host_ptrEEET_v
+_ZNK2cl4sycl6stream12get_propertyINS0_8property5image13context_boundEEET_v
+_ZNK2cl4sycl6stream12get_propertyINS0_8property5image9use_mutexEEET_v
+_ZNK2cl4sycl6stream12get_propertyINS0_8property5queue8in_orderEEET_v
+_ZNK2cl4sycl6stream12get_propertyINS0_8property6buffer12use_host_ptrEEET_v
+_ZNK2cl4sycl6stream12get_propertyINS0_8property6buffer13context_boundEEET_v
+_ZNK2cl4sycl6stream12get_propertyINS0_8property6buffer9use_mutexEEET_v
+_ZNK2cl4sycl6stream12get_propertyINS0_8property6noinitEEET_v
+_ZNK2cl4sycl6stream12get_propertyINS0_8property7context4cuda19use_primary_contextEEET_v
+_ZNK2cl4sycl6stream12get_propertyINS0_8property7no_initEEET_v
+_ZNK2cl4sycl6stream12get_propertyINS0_8property9reduction22initialize_to_identityEEET_v
+_ZNK2cl4sycl6stream12has_propertyINS0_3ext6oneapi4cuda8property7context19use_primary_contextEEEbv
+_ZNK2cl4sycl6stream12has_propertyINS0_3ext6oneapi8property6buffer22use_pinned_host_memoryEEEbv
+_ZNK2cl4sycl6stream12has_propertyINS0_8property5image12use_host_ptrEEEbv
+_ZNK2cl4sycl6stream12has_propertyINS0_8property5image13context_boundEEEbv
+_ZNK2cl4sycl6stream12has_propertyINS0_8property5image9use_mutexEEEbv
+_ZNK2cl4sycl6stream12has_propertyINS0_8property5queue8in_orderEEEbv
+_ZNK2cl4sycl6stream12has_propertyINS0_8property6buffer12use_host_ptrEEEbv
+_ZNK2cl4sycl6stream12has_propertyINS0_8property6buffer13context_boundEEEbv
+_ZNK2cl4sycl6stream12has_propertyINS0_8property6buffer9use_mutexEEEbv
+_ZNK2cl4sycl6stream12has_propertyINS0_8property6noinitEEEbv
+_ZNK2cl4sycl6stream12has_propertyINS0_8property7context4cuda19use_primary_contextEEEbv
+_ZNK2cl4sycl6stream12has_propertyINS0_8property7no_initEEEbv
+_ZNK2cl4sycl6stream12has_propertyINS0_8property9reduction22initialize_to_identityEEEbv
 _ZNK2cl4sycl6stream22get_max_statement_sizeEv
 _ZNK2cl4sycl6stream8get_sizeEv
 _ZNK2cl4sycl6streameqERKS1_