cuda_stream.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/cuda_stream_view.hpp>
#include <rmm/detail/export.hpp>
 
#include <cuda/stream>
#include <cuda_runtime_api.h>
 
#include <functional>
#include <memory>
 
RMM_NAMESPACE_BEGIN
class cuda_stream {
 public:
  enum class flags : unsigned int {
    sync_default = cudaStreamDefault,  
    non_blocking =
      cudaStreamNonBlocking,  
  };
  cuda_stream(cuda_stream&&) = default;
  cuda_stream& operator=(cuda_stream&&) = default;
  ~cuda_stream()                        = default;
  cuda_stream(cuda_stream const&)       = delete;  // Copying disallowed: one stream one owner
  cuda_stream& operator=(cuda_stream&)  = delete;
 
  cuda_stream(cuda_stream::flags flags = cuda_stream::flags::sync_default);
 
  [[nodiscard]] bool is_valid() const;
 
  [[nodiscard]] cudaStream_t value() const;
 
  explicit operator cudaStream_t() const noexcept;
 
#if defined(__GNUC__) || defined(__clang__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
 
  [[nodiscard, deprecated("Use conversion to cuda::stream_ref instead.")]] cuda_stream_view view()
    const;
 
  [[deprecated("Use conversion to cuda::stream_ref instead.")]] operator cuda_stream_view() const;
 
#if defined(__GNUC__) || defined(__clang__)
#pragma GCC diagnostic pop
#endif
 
  operator cuda::stream_ref() const noexcept;
 
  void synchronize() const;
 
  void synchronize_no_throw() const noexcept;
 
 private:
  std::unique_ptr<cudaStream_t, std::function<void(cudaStream_t*)>> stream_;
};
  // end of group
RMM_NAMESPACE_END