utils.hpp

/*
 * 版权所有 (c) 2021-2025, NVIDIA CORPORATION.
 *
 * 根据 Apache 许可证 2.0 版（“许可证”）获得许可；
 * 除非遵守许可证的规定，否则您不得使用此文件。
 * 您可以在以下网址获取许可证副本：
 *
 * https://apache.ac.cn/licenses/LICENSE-2.0
 *
 * 除非适用法律要求或书面同意，否则根据许可证分发的软件按“原样”分发，
 * 不附带任何明示或暗示的担保或条件。
 * 请参阅许可证了解具体的语言许可和限制。
 *
 */
/*
#pragma once

#include <chrono>
#include <cstring>
#include <future>
#include <optional>
#include <stdexcept>
#include <tuple>
#include <type_traits>

#include <kvikio/error.hpp>
#include <kvikio/shim/cuda.hpp>

namespace kvikio {

// cuFile 将页面大小定义为 4 KiB
inline constexpr std::size_t page_size = 4096;

[[nodiscard]] off_t convert_size2off(std::size_t x);

[[nodiscard]] ssize_t convert_size2ssize(std::size_t x);

[[nodiscard]] CUdeviceptr convert_void2deviceptr(void const* devPtr);

/** 辅助函数，用于将值转换为 64 位带符号整数。*/
template <typename T, std::enable_if_t<std::is_integral_v<T>>* = nullptr>
[[nodiscard]] std::int64_t convert_to_64bit(T value)
{
 if constexpr (std::numeric_limits<T>::max() > std::numeric_limits<std::int64_t>::max()) {
 KVIKIO_EXPECT(value <= std::numeric_limits<std::int64_t>::max(),
 "convert_to_64bit(x): x too large to fit std::int64_t",
 std::overflow_error);
 }
 return std::int64_t(value);
}
/** 针对 `std::uint64_t` 的特化。*/
[[nodiscard]] inline std::uint64_t convert_to_64bit(std::uint64_t value) { return value; }
/** 针对浮点类型的特化。*/
template <typename T, std::enable_if_t<std::is_floating_point_v<T>>* = nullptr>
[[nodiscard]] double convert_to_64bit(T value)
{
 return double(value);
}
/** 检查 ptr 是否指向主机内存（而不是设备内存）*/
#ifdef KVIKIO_CUDA_FOUND
bool is_host_memory(void const* ptr);
#else
constexpr bool is_host_memory(void const* ptr) { return true; }
#endif
/** 返回拥有该指针的设备。*/
[[nodiscard]] int get_device_ordinal_from_pointer(CUdeviceptr dev_ptr);
/** 给定设备序号，返回设备的主上下文。*/
[[nodiscard]] KVIKIO_EXPORT CUcontext get_primary_cuda_context(int ordinal);
/** 返回与给定设备指针关联的 CUDA 上下文（如果存在）。*/
[[nodiscard]] std::optional<CUcontext> get_context_associated_pointer(CUdeviceptr dev_ptr);
/** 检查当前的 CUDA 上下文是否可以访问给定的设备指针。*/
[[nodiscard]] bool current_context_can_access_pointer(CUdeviceptr dev_ptr);
/** 返回一个可以与给定设备指针一起使用的 CUDA 上下文。*/
[[nodiscard]] CUcontext get_context_from_pointer(void const* devPtr);
/** 在创建时压入 CUDA 上下文，在销毁时弹出它。*/
class PushAndPopContext {
 private
 CUcontext _ctx;

 public
 PushAndPopContext(CUcontext ctx);
 PushAndPopContext(PushAndPopContext const&) = delete;
 PushAndPopContext& operator=(PushAndPopContext const&) = delete;
 PushAndPopContext(PushAndPopContext&&) = delete;
 PushAndPopContext&& operator=(PushAndPopContext&&) = delete;
 ~PushAndPopContext();
};

// 查找 devPtr 所在内存分配的基址和偏移量
std::tuple<void*, std::size_t, std::size_t> get_alloc_info(void const* devPtr,
 CUcontext* ctx = nullptr);
/** 在 future 对象中创建一个立即就绪的共享状态。*/
template <typename T>
std::future<std::decay_t<T>> make_ready_future(T&& t)
{
 std::promise<std::decay_t<T>> p;
 auto fut = p.get_future();
 p.set_value(std::forward<T>(t));
 return fut;
}
/** 检查 future 对象的状态。True 表示结果在 future 的共享状态中可用。*/
template <typename T>
bool is_future_done(T const& future)
{
 KVIKIO_EXPECT(future.valid(),
 "The future object does not refer to a valid shared state.",
 std::invalid_argument);
 return future.wait_for(std::chrono::seconds(0)) != std::future_status::timeout;
}