cuda_device.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2021-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <rmm/aligned.hpp>
#include <rmm/detail/export.hpp>
 
#include <cstddef>
#include <utility>
 
RMM_NAMESPACE_BEGIN
 
struct cuda_device_id;
cuda_device_id get_current_cuda_device();

struct cuda_device_id {
  using value_type = int;  

  cuda_device_id() noexcept : id_{get_current_cuda_device().value()} {}

  explicit constexpr cuda_device_id(value_type dev_id) noexcept : id_{dev_id} {}

  [[nodiscard]] constexpr value_type value() const noexcept { return id_; }
 
  // TODO re-add doxygen comment specifier /** for these hidden friend operators once this Breathe
  // bug is fixed: https://github.com/breathe-doc/breathe/issues/916

  [[nodiscard]] constexpr friend bool operator==(cuda_device_id const& lhs,
                                                 cuda_device_id const& rhs) noexcept
  {
    return lhs.value() == rhs.value();
  }

  [[nodiscard]] constexpr friend bool operator!=(cuda_device_id const& lhs,
                                                 cuda_device_id const& rhs) noexcept
  {
    return lhs.value() != rhs.value();
  }
 private:
  value_type id_;
};

cuda_device_id get_current_cuda_device();

int get_num_cuda_devices();

std::pair<std::size_t, std::size_t> available_device_memory();

std::size_t percent_of_free_device_memory(int percent);

struct cuda_set_device_raii {
  explicit cuda_set_device_raii(cuda_device_id dev_id);
  ~cuda_set_device_raii() noexcept;
 
  cuda_set_device_raii(cuda_set_device_raii const&)            = delete;
  cuda_set_device_raii& operator=(cuda_set_device_raii const&) = delete;
  cuda_set_device_raii(cuda_set_device_raii&&)                 = delete;
  cuda_set_device_raii& operator=(cuda_set_device_raii&&)      = delete;
 
 private:
  cuda_device_id old_device_;
  bool needs_reset_;
};
  // end of group
RMM_NAMESPACE_END