batch.hpp

/*
 * 版权所有 (c) 2023-2025, NVIDIA CORPORATION.
 *
 * 根据 Apache 许可证 2.0 版（以下简称“许可证”）获得许可；
 * 除非符合许可证的规定，否则您不得使用此文件。
 * 您可以在以下位置获取许可证副本：
 *
 * https://apache.ac.cn/licenses/LICENSE-2.0
 *
 * 除非适用法律要求或书面同意，否则根据许可证分发的软件
 * 按“原样”分发，不带任何明示或暗示的保证或条件。
 * 有关管理权限和限制的特定语言，请参阅许可证。
 * limitations under the License.
 */

#pragma once

#include <cstddef>
#include <ctime>
#include <utility>
#include <vector>

#include <kvikio/error.hpp>
#include <kvikio/file_handle.hpp>
#include <kvikio/shim/cufile.hpp>

namespace kvikio {

struct BatchOp {
 // 要读取或写入的文件的文件句柄
 FileHandle& file_handle;
 // 设备内存中缓冲区的基地址（不支持主机内存）。
 void* devPtr_base;
 // 文件中要读取或写入的偏移量。
 off_t file_offset;
 // 相对于 \p devPtr_base 指针的偏移量，用于写入或读取。
 off_t devPtr_offset;
 // 要读取或写入的大小（字节）。
 size_t size;
 // 操作类型：CUFILE_READ 或 CUFILE_WRITE。
 CUfileOpcode_t opcode;
};

#ifdef KVIKIO_CUFILE_BATCH_API_FOUND

class BatchHandle {
 private
 bool _initialized{false};
 int _max_num_events{};
 CUfileBatchHandle_t _handle{};

 public
 /// 构造函数
 BatchHandle() noexcept = default;
 /// 构造函数
 /// \param max_num_events 此批处理句柄可以管理的事件最大数量。
 BatchHandle(int max_num_events);
 /// 禁用拷贝构造函数
 BatchHandle(BatchHandle const&) = delete;
 /// 禁用拷贝赋值
 BatchHandle& operator=(BatchHandle const&) = delete;
 /// 移动构造函数
 BatchHandle(BatchHandle&& o) noexcept;
 /// 析构函数
 ~BatchHandle() noexcept;

 /// 检查批处理句柄是否已关闭。
 [[nodiscard]] bool closed() const noexcept;

 /// 关闭批处理句柄。
 void close() noexcept;

 /// 提交一批操作。
 /// \param operations 要提交的操作向量。
 /// 获取已提交操作的状态。
 /// \param min_nr 等待的最小事件数。
 /// \param max_nr 要返回的最大事件数。
 /// \param timeout 等待超时时间。如果为 null，则无限期等待。
 /// \return 完成事件的向量。
 std::vector<CUfileIOEvents_t> status(unsigned min_nr,
 unsigned max_nr,
 struct timespec* timeout = nullptr);

 /// 取消所有已提交的操作。
 void cancel();
};

#else

class BatchHandle {
 public
 BatchHandle() noexcept = default;

 BatchHandle(int max_num_events);

 [[nodiscard]] bool closed() const noexcept;

 void close() noexcept;