cuda_stream.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/cuda_stream_view.hpp>
#include <rmm/detail/export.hpp>
 
#include <cuda_runtime_api.h>
 
#include <functional>
#include <memory>
 
namespace RMM_EXPORT rmm {
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;
 
  [[nodiscard]] cuda_stream_view view() const;
 
  operator cuda_stream_view() const;
 
  void synchronize() const;
 
  void synchronize_no_throw() const noexcept;
 
 private:
  std::unique_ptr<cudaStream_t, std::function<void(cudaStream_t*)>> stream_;
};
  // end of group
}  // namespace RMM_EXPORT rmm