cuda_stream_view.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2025, NVIDIA CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <rmm/detail/export.hpp>
 
#include <cuda/stream_ref>
#include <cuda_runtime_api.h>
 
#include <cstddef>
#include <ostream>
 
namespace RMM_EXPORT rmm {
class 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;
 
  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 synchronize_no_throw() const noexcept;
 
 private:
  cudaStream_t stream_{};
};
 
static constexpr cuda_stream_view cuda_stream_default{};
 
static const cuda_stream_view cuda_stream_legacy{
  cudaStreamLegacy  // NOLINT(cppcoreguidelines-pro-type-cstyle-cast)
};
 
static const cuda_stream_view cuda_stream_per_thread{
  cudaStreamPerThread  // NOLINT(cppcoreguidelines-pro-type-cstyle-cast)
};
 
bool operator==(cuda_stream_view lhs, cuda_stream_view rhs);
 
bool operator!=(cuda_stream_view lhs, cuda_stream_view rhs);
 
std::ostream& operator<<(std::ostream& os, cuda_stream_view stream);
  // end of group
}  // namespace RMM_EXPORT rmm