cuda_stream_view.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2020-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#include <rmm/detail/export.hpp>
 
#include <cuda/stream>
#include <cuda_runtime_api.h>
 
#include <concepts>
#include <cstddef>
#include <ostream>
 
RMM_NAMESPACE_BEGIN
class [[deprecated("Use cuda::stream_ref instead.")]] cuda_stream_view {
 public:
  cuda_stream_view()                        = default;
  ~cuda_stream_view()                       = default;
  cuda_stream_view(cuda_stream_view const&) = default;  
  cuda_stream_view(cuda_stream_view&&)      = default;  
  cuda_stream_view& operator=(cuda_stream_view const&) =
    default;  
  cuda_stream_view& operator=(cuda_stream_view&&) =
    default;  
 
  // Disable construction from literal 0
  cuda_stream_view(int)            = delete;  //< Prevent cast from 0
  cuda_stream_view(std::nullptr_t) = delete;  //< Prevent cast from nullptr
 
  cuda_stream_view(cudaStream_t stream) noexcept;
 
  cuda_stream_view(cuda::stream_ref stream) noexcept;
 
  [[nodiscard]] cudaStream_t value() const noexcept;
 
  [[nodiscard]] cudaStream_t get() const noexcept;
 
  operator cudaStream_t() const noexcept;
 
  operator cuda::stream_ref() const noexcept;
 
  [[nodiscard]] bool is_per_thread_default() const noexcept;
 
  [[nodiscard]] bool is_default() const noexcept;
 
  void synchronize() const;
 
  void sync() const;
 
  void synchronize_no_throw() const noexcept;
 
 private:
  cudaStream_t stream_{};
};
 
[[deprecated("Use cuda::stream_ref{cudaStream_t{cudaStreamDefault}} instead.")]]
static constexpr cuda::stream_ref cuda_stream_default{cudaStream_t{nullptr}};
 
[[deprecated("Use cuda::stream_ref{cudaStreamLegacy} instead.")]]
static const cuda::stream_ref cuda_stream_legacy{cudaStream_t{cudaStreamLegacy}};
 
[[deprecated("Use cuda::stream_ref{cudaStreamPerThread} instead.")]]
static const cuda::stream_ref cuda_stream_per_thread{cudaStream_t{cudaStreamPerThread}};
 
#if defined(__GNUC__) || defined(__clang__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
 
bool operator==(cuda_stream_view lhs, cuda_stream_view rhs);
 
template <std::same_as<cuda::stream_ref> StreamRef>
bool operator==(cuda_stream_view lhs, StreamRef const& rhs)
{
  return lhs.value() == rhs.get();
}
 
template <std::same_as<cuda::stream_ref> StreamRef>
bool operator==(StreamRef const& lhs, cuda_stream_view rhs)
{
  return lhs.get() == rhs.value();
}
 
bool operator!=(cuda_stream_view lhs, cuda_stream_view rhs);
 
template <std::same_as<cuda::stream_ref> StreamRef>
bool operator!=(cuda_stream_view lhs, StreamRef const& rhs)
{
  return lhs.value() != rhs.get();
}
 
template <std::same_as<cuda::stream_ref> StreamRef>
bool operator!=(StreamRef const& lhs, cuda_stream_view rhs)
{
  return lhs.get() != rhs.value();
}
 
std::ostream& operator<<(std::ostream& os, cuda_stream_view stream);
 
#if defined(__GNUC__) || defined(__clang__)
#pragma GCC diagnostic pop
#endif
  // end of group
RMM_NAMESPACE_END