cufile_h_wrapper.hpp

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

#include <sys/types.h>

#include <kvikio/shim/cuda_h_wrapper.hpp>

#ifdef KVIKIO_CUFILE_FOUND
#include <cufile.h>
#else

// 如果未定义 cuFile，我们在此定义一些数据类型。
// 注意，这不需要与 cufile 定义 ABI 兼容。

using CUfileHandle_t = void*;
using CUfileOpError = int;
#define CUFILE_ERRSTR(x) ("KvikIO 未使用 cuFile.h 编译")
#define CUFILEOP_BASE_ERR 5000
#define CU_FILE_SUCCESS 0
#define CU_FILE_CUDA_DRIVER_ERROR 1

struct CUfileError_t {
 CUfileOpError err; // cufile 错误
 CUresult cu_err; // cuda 驱动错误
};

using CUfileDriverControlFlags_t = enum CUfileDriverControlFlags {
 CU_FILE_USE_POLL_MODE = 0,
 CU_FILE_ALLOW_COMPAT_MODE = 1
};

enum CUfileFileHandleType { CU_FILE_HANDLE_TYPE_OPAQUE_FD = 1 };

struct CUfileDescr_t {
 enum CUfileFileHandleType type;
 struct handle_t {
 int fd;
 } handle;
};

inline static char const* cufileop_status_error(CUfileOpError err) { return CUFILE_ERRSTR(err); };
CUfileError_t cuFileHandleRegister(...);
CUfileError_t cuFileHandleDeregister(...);
ssize_t cuFileRead(...);
ssize_t cuFileWrite(...);
CUfileError_t cuFileBufRegister(...);
CUfileError_t cuFileBufDeregister(...);
CUfileError_t cuFileDriverOpen(...);
CUfileError_t cuFileDriverClose(...);
CUfileError_t cuFileDriverGetProperties(...);
CUfileError_t cuFileDriverSetPollMode(...);
CUfileError_t cuFileDriverSetMaxCacheSize(...);
CUfileError_t cuFileDriverSetMaxPinnedMemSize(...);

#endif

// 如果未定义一些 cufile API，我们在此定义一些数据类型。
// 注意，这不需要与 cufile 定义 ABI 兼容，并且
// 缺少定义不是问题，因为链接器永远不会查找
// 这些符号，因为“真实”函数调用是通过 shim 实例进行的。
#ifndef KVIKIO_CUFILE_BATCH_API_FOUND
typedef enum CUfileOpcode { CUFILE_READ = 0, CUFILE_WRITE } CUfileOpcode_t;

typedef enum CUFILEStatus_enum {
 CUFILE_WAITING = 0x000001, /* 提交前所需的值 */
 CUFILE_PENDING = 0x000002, /* 入队后 */
 CUFILE_INVALID = 0x000004, /* 请求格式错误或无法入队 */
 CUFILE_CANCELED = 0x000008, /* 请求成功取消 */
 CUFILE_COMPLETE = 0x0000010, /* 请求成功完成 */
 CUFILE_TIMEOUT = 0x0000020, /* 请求超时 */
 CUFILE_FAILED = 0x0000040 /* 无法完成 */
} CUfileStatus_t;

typedef struct CUfileIOEvents {
 void* cookie;
 CUfileStatus_t status; /* 操作状态 */
 size_t ret; /* 负数表示错误，正数表示已完成的 I/O 量。 */
} CUfileIOEvents_t;

CUfileError_t cuFileBatchIOSetUp(...);
CUfileError_t cuFileBatchIOSubmit(...);
CUfileError_t cuFileBatchIOGetStatus(...);
CUfileError_t cuFileBatchIOCancel(...);
CUfileError_t cuFileBatchIODestroy(...);
#endif

#ifndef KVIKIO_CUFILE_STREAM_API_FOUND
CUfileError_t cuFileReadAsync(...);
CUfileError_t cuFileWriteAsync(...);
CUfileError_t cuFileStreamRegister(...);
CUfileError_t cuFileStreamDeregister(...);
#endif

#ifndef KVIKIO_CUFILE_VERSION_API_FOUND
CUfileError_t cuFileGetVersion(...);
#endif