cufile (JavaCPP Presets for CUDA 12.9-9.10-1.5.12 API)

java.lang.Object
- org.bytedeco.cuda.presets.cufile
- - org.bytedeco.cuda.global.cufile

All Implemented Interfaces:

InfoMapper
```
public class cufile
extends cufile
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CU_FILE_ALLOW_COMPAT_MODE` enum CUfileDriverControlFlags_t
`static int`	`CU_FILE_ASYNC_NOT_SUPPORTED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_BATCH_FULL` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_BATCH_IO_SUPPORTED` enum CUfileFeatureFlags_t
`static int`	`CU_FILE_BATCH_SUBMIT_FAILED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_BEEGFS_SUPPORTED` enum CUfileDriverStatusFlags_t
`static int`	`CU_FILE_CUDA_CONTEXT_MISMATCH` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_CUDA_DRIVER_ERROR` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_CUDA_MEMORY_TYPE_INVALID` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_CUDA_POINTER_INVALID` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_CUDA_POINTER_RANGE_ERROR` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_DEVICE_NOT_FOUND` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_DEVICE_NOT_SUPPORTED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_DIO_NOT_SET` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_DRIVER_ALREADY_OPEN` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_DRIVER_CLOSING` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_DRIVER_INVALID_PROPS` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_DRIVER_NOT_INITIALIZED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_DRIVER_UNSUPPORTED_LIMIT` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_DRIVER_VERSION_MISMATCH` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_DRIVER_VERSION_READ_ERROR` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_DYN_ROUTING_SUPPORTED` enum CUfileFeatureFlags_t
`static int`	`CU_FILE_GETNEWFD_FAILED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_GPFS_SUPPORTED` enum CUfileDriverStatusFlags_t
`static int`	`CU_FILE_GPU_MEMORY_PINNING_FAILED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_HANDLE_ALREADY_REGISTERED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_HANDLE_NOT_REGISTERED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_HANDLE_TYPE_OPAQUE_FD` enum CUfileFileHandleType
`static int`	`CU_FILE_HANDLE_TYPE_OPAQUE_WIN32` enum CUfileFileHandleType
`static int`	`CU_FILE_HANDLE_TYPE_USERSPACE_FS` enum CUfileFileHandleType
`static int`	`CU_FILE_INTERNAL_ERROR` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_INVALID_FILE_OPEN_FLAG` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_INVALID_FILE_TYPE` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_INVALID_MAPPING_RANGE` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_INVALID_MAPPING_SIZE` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_INVALID_VALUE` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_IO_DISABLED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_IO_MAX_ERROR` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_IO_NOT_SUPPORTED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_LUSTRE_SUPPORTED` enum CUfileDriverStatusFlags_t
`static int`	`CU_FILE_MEMORY_ALREADY_REGISTERED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_MEMORY_NOT_REGISTERED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_NFS_SUPPORTED` enum CUfileDriverStatusFlags_t
`static int`	`CU_FILE_NVFS_DRIVER_ERROR` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_NVFS_SETUP_ERROR` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_NVME_P2P_SUPPORTED` enum CUfileDriverStatusFlags_t
`static int`	`CU_FILE_NVME_SUPPORTED` enum CUfileDriverStatusFlags_t
`static int`	`CU_FILE_NVMEOF_SUPPORTED` enum CUfileDriverStatusFlags_t
`static int`	`CU_FILE_NVMESH_SUPPORTED` enum CUfileDriverStatusFlags_t
`static int`	`CU_FILE_PARALLEL_IO_SUPPORTED` enum CUfileFeatureFlags_t
`static int`	`CU_FILE_PERMISSION_DENIED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_PLATFORM_NOT_SUPPORTED` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_RDMA_REGISTER`
`static int`	`CU_FILE_RDMA_RELAXED_ORDERING`
`static int`	`CU_FILE_SCALEFLUX_CSD_SUPPORTED` enum CUfileDriverStatusFlags_t
`static int`	`CU_FILE_SCATEFS_SUPPORTED` enum CUfileDriverStatusFlags_t
`static int`	`CU_FILE_SCSI_SUPPORTED` enum CUfileDriverStatusFlags_t
`static int`	`CU_FILE_STREAM_FIXED_BUF_OFFSET`
`static int`	`CU_FILE_STREAM_FIXED_FILE_OFFSET`
`static int`	`CU_FILE_STREAM_FIXED_FILE_SIZE`
`static int`	`CU_FILE_STREAM_PAGE_ALIGNED_INPUTS`
`static int`	`CU_FILE_STREAMS_SUPPORTED` enum CUfileFeatureFlags_t
`static int`	`CU_FILE_SUCCESS` \cond DOXYGEN_SKIP_MACRO
`static int`	`CU_FILE_USE_POLL_MODE` enum CUfileDriverControlFlags_t
`static int`	`CU_FILE_WEKAFS_SUPPORTED` enum CUfileDriverStatusFlags_t
`static int`	`CUFILE_BATCH` enum CUfileBatchMode_t
`static int`	`CUFILE_CANCELED` enum CUfileStatus_t
`static int`	`CUFILE_COMPLETE` enum CUfileStatus_t
`static int`	`CUFILE_FAILED` enum CUfileStatus_t
`static int`	`CUFILE_INVALID` enum CUfileStatus_t
`static int`	`CUFILE_PARAM_ENV_LOGFILE_PATH` enum CUFileStringConfigParameter_t
`static int`	`CUFILE_PARAM_EXECUTION_MAX_IO_QUEUE_DEPTH` enum CUFileSizeTConfigParameter_t
`static int`	`CUFILE_PARAM_EXECUTION_MAX_IO_THREADS` enum CUFileSizeTConfigParameter_t
`static int`	`CUFILE_PARAM_EXECUTION_MAX_REQUEST_PARALLELISM` enum CUFileSizeTConfigParameter_t
`static int`	`CUFILE_PARAM_EXECUTION_MIN_IO_THRESHOLD_SIZE_KB` enum CUFileSizeTConfigParameter_t
`static int`	`CUFILE_PARAM_EXECUTION_PARALLEL_IO` enum CUFileBoolConfigParameter_t
`static int`	`CUFILE_PARAM_FORCE_COMPAT_MODE` enum CUFileBoolConfigParameter_t
`static int`	`CUFILE_PARAM_FORCE_ODIRECT_MODE` enum CUFileBoolConfigParameter_t
`static int`	`CUFILE_PARAM_FS_MISC_API_CHECK_AGGRESSIVE` enum CUFileBoolConfigParameter_t
`static int`	`CUFILE_PARAM_LOG_DIR` enum CUFileStringConfigParameter_t
`static int`	`CUFILE_PARAM_LOGGING_LEVEL` enum CUFileStringConfigParameter_t
`static int`	`CUFILE_PARAM_POLLTHRESHOLD_SIZE_KB` enum CUFileSizeTConfigParameter_t
`static int`	`CUFILE_PARAM_PREFER_IO_URING` enum CUFileBoolConfigParameter_t
`static int`	`CUFILE_PARAM_PROFILE_NVTX` enum CUFileBoolConfigParameter_t
`static int`	`CUFILE_PARAM_PROFILE_STATS` enum CUFileSizeTConfigParameter_t
`static int`	`CUFILE_PARAM_PROPERTIES_ALLOW_COMPAT_MODE` enum CUFileBoolConfigParameter_t
`static int`	`CUFILE_PARAM_PROPERTIES_ALLOW_SYSTEM_MEMORY` enum CUFileBoolConfigParameter_t
`static int`	`CUFILE_PARAM_PROPERTIES_BATCH_IO_TIMEOUT_MS` enum CUFileSizeTConfigParameter_t
`static int`	`CUFILE_PARAM_PROPERTIES_IO_BATCHSIZE` enum CUFileSizeTConfigParameter_t
`static int`	`CUFILE_PARAM_PROPERTIES_MAX_DEVICE_CACHE_SIZE_KB` enum CUFileSizeTConfigParameter_t
`static int`	`CUFILE_PARAM_PROPERTIES_MAX_DEVICE_PINNED_MEM_SIZE_KB` enum CUFileSizeTConfigParameter_t
`static int`	`CUFILE_PARAM_PROPERTIES_MAX_DIRECT_IO_SIZE_KB` enum CUFileSizeTConfigParameter_t
`static int`	`CUFILE_PARAM_PROPERTIES_PER_BUFFER_CACHE_SIZE_KB` enum CUFileSizeTConfigParameter_t
`static int`	`CUFILE_PARAM_PROPERTIES_USE_POLL_MODE` enum CUFileBoolConfigParameter_t
`static int`	`CUFILE_PARAM_SKIP_TOPOLOGY_DETECTION` enum CUFileBoolConfigParameter_t
`static int`	`CUFILE_PARAM_STREAM_MEMOPS_BYPASS` enum CUFileBoolConfigParameter_t
`static int`	`CUFILE_PARAM_USE_PCIP2PDMA` enum CUFileBoolConfigParameter_t
`static int`	`CUFILE_PENDING` enum CUfileStatus_t
`static int`	`CUFILE_READ` enum CUfileOpcode_t
`static int`	`CUFILE_TIMEOUT` enum CUfileStatus_t
`static int`	`CUFILE_WAITING` enum CUfileStatus_t
`static int`	`CUFILE_WRITE` enum CUfileOpcode_t
`static int`	`CUFILEOP_BASE_ERR` \cond DOXYGEN_SKIP_MACRO

Constructor Summary

Constructors
Constructor and Description

cufile()

Constructors
Constructor and Description
`cufile()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static CUfileError_t`	`cuFileBatchIOCancel(CUfileBatchHandle_t batch_idp)`
`static void`	`cuFileBatchIODestroy(CUfileBatchHandle_t batch_idp)`
`static CUfileError_t`	`cuFileBatchIOGetStatus(CUfileBatchHandle_t batch_idp, int min_nr, int[] nr, CUfileIOEvents_t iocbp, Pointer timeout)`
`static CUfileError_t`	`cuFileBatchIOGetStatus(CUfileBatchHandle_t batch_idp, int min_nr, IntBuffer nr, CUfileIOEvents_t iocbp, Pointer timeout)`
`static CUfileError_t`	`cuFileBatchIOGetStatus(CUfileBatchHandle_t batch_idp, int min_nr, IntPointer nr, CUfileIOEvents_t iocbp, Pointer timeout)`
`static CUfileError_t`	`cuFileBatchIOSetUp(CUfileBatchHandle_t batch_idp, int nr)`
`static CUfileError_t`	`cuFileBatchIOSubmit(CUfileBatchHandle_t batch_idp, int nr, CUfileIOParams_t iocbp, int flags)`
`static CUfileError_t`	`cuFileBufDeregister(Pointer bufPtr_base)` \brief deregister an already registered device or host memory from cuFile
`static CUfileError_t`	`cuFileBufRegister(Pointer bufPtr_base, long length, int flags)` \brief register an existing cudaMalloced memory with cuFile to pin for GPUDirect Storage access or register host allocated memory with cuFile.
`static CUfileError_t`	`cuFileDriverClose()`
`static CUfileError_t`	`cuFileDriverGetProperties(CUfileDrvProps_t props)` \brief Gets the Driver session properties
`static CUfileError_t`	`cuFileDriverOpen()` \brief Initialize the cuFile library and open the nvidia-fs driver
`static CUfileError_t`	`cuFileDriverSetMaxCacheSize(long max_cache_size)` \brief Control parameter to set maximum GPU memory reserved per device by the library for internal buffering
`static CUfileError_t`	`cuFileDriverSetMaxDirectIOSize(long max_direct_io_size)` \brief Control parameter to set max IO size(KB) used by the library to talk to nvidia-fs driver
`static CUfileError_t`	`cuFileDriverSetMaxPinnedMemSize(long max_pinned_size)` \brief Sets maximum buffer space that is pinned in KB for use by \ref cuFileBufRegister
`static CUfileError_t`	`cuFileDriverSetPollMode(boolean poll, long poll_threshold_size)` \brief Sets whether the Read/Write APIs use polling to do IO operations
`static CUfileError_t`	`cuFileGetParameterBool(int param, boolean[] value)`
`static CUfileError_t`	`cuFileGetParameterBool(int param, BoolPointer value)`
`static CUfileError_t`	`cuFileGetParameterSizeT(int param, SizeTPointer value)` \brief
`static CUfileError_t`	`cuFileGetParameterString(int param, byte[] desc_str, int len)`
`static CUfileError_t`	`cuFileGetParameterString(int param, ByteBuffer desc_str, int len)`
`static CUfileError_t`	`cuFileGetParameterString(int param, BytePointer desc_str, int len)`
`static CUfileError_t`	`cuFileGetVersion(int[] version)`
`static CUfileError_t`	`cuFileGetVersion(IntBuffer version)`
`static CUfileError_t`	`cuFileGetVersion(IntPointer version)` \brief
`static void`	`cuFileHandleDeregister(CUfileHandle_t fh)` \brief releases a registered filehandle from cuFile
`static CUfileError_t`	`cuFileHandleRegister(CUfileHandle_t fh, CUfileDescr_t descr)` \brief cuFileHandleRegister is required, and performs extra checking that is memoized to provide increased performance on later cuFile operations.
`static BytePointer`	`cufileop_status_error(int status)` \endcond
`static long`	`cuFileRead(CUfileHandle_t fh, Pointer bufPtr_base, long size, long file_offset, long bufPtr_offset)` \brief read data from a registered file handle to a specified device or host memory
`static CUfileError_t`	`cuFileReadAsync(CUfileHandle_t fh, Pointer bufPtr_base, SizeTPointer size_p, SizeTPointer file_offset_p, SizeTPointer bufPtr_offset_p, SizeTPointer bytes_read_p, CUstream_st stream)` \brief
`static CUfileError_t`	`cuFileSetParameterBool(int param, boolean value)`
`static CUfileError_t`	`cuFileSetParameterSizeT(int param, long value)` \brief
`static CUfileError_t`	`cuFileSetParameterString(int param, BytePointer desc_str)`
`static CUfileError_t`	`cuFileSetParameterString(int param, String desc_str)`
`static CUfileError_t`	`cuFileStreamDeregister(CUstream_st stream)` \brief
`static CUfileError_t`	`cuFileStreamRegister(CUstream_st stream, int flags)` \brief
`static long`	`cuFileUseCount()` \brief returns use count of cufile drivers at that moment by the process.
`static long`	`cuFileWrite(CUfileHandle_t fh, Pointer bufPtr_base, long size, long file_offset, long bufPtr_offset)` \brief write data from a specified device or host memory to a registered file handle
`static CUfileError_t`	`cuFileWriteAsync(CUfileHandle_t fh, Pointer bufPtr_base, SizeTPointer size_p, SizeTPointer file_offset_p, SizeTPointer bufPtr_offset_p, SizeTPointer bytes_written_p, CUstream_st stream)` \brief

Methods inherited from class org.bytedeco.cuda.presets.cufile
map

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- CUFILEOP_BASE_ERR
```
public static final int CUFILEOP_BASE_ERR
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_SUCCESS
```
public static final int CU_FILE_SUCCESS
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_DRIVER_NOT_INITIALIZED
```
public static final int CU_FILE_DRIVER_NOT_INITIALIZED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_DRIVER_INVALID_PROPS
```
public static final int CU_FILE_DRIVER_INVALID_PROPS
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_DRIVER_UNSUPPORTED_LIMIT
```
public static final int CU_FILE_DRIVER_UNSUPPORTED_LIMIT
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_DRIVER_VERSION_MISMATCH
```
public static final int CU_FILE_DRIVER_VERSION_MISMATCH
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_DRIVER_VERSION_READ_ERROR
```
public static final int CU_FILE_DRIVER_VERSION_READ_ERROR
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_DRIVER_CLOSING
```
public static final int CU_FILE_DRIVER_CLOSING
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_PLATFORM_NOT_SUPPORTED
```
public static final int CU_FILE_PLATFORM_NOT_SUPPORTED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_IO_NOT_SUPPORTED
```
public static final int CU_FILE_IO_NOT_SUPPORTED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_DEVICE_NOT_SUPPORTED
```
public static final int CU_FILE_DEVICE_NOT_SUPPORTED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_NVFS_DRIVER_ERROR
```
public static final int CU_FILE_NVFS_DRIVER_ERROR
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_CUDA_DRIVER_ERROR
```
public static final int CU_FILE_CUDA_DRIVER_ERROR
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_CUDA_POINTER_INVALID
```
public static final int CU_FILE_CUDA_POINTER_INVALID
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_CUDA_MEMORY_TYPE_INVALID
```
public static final int CU_FILE_CUDA_MEMORY_TYPE_INVALID
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_CUDA_POINTER_RANGE_ERROR
```
public static final int CU_FILE_CUDA_POINTER_RANGE_ERROR
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_CUDA_CONTEXT_MISMATCH
```
public static final int CU_FILE_CUDA_CONTEXT_MISMATCH
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_INVALID_MAPPING_SIZE
```
public static final int CU_FILE_INVALID_MAPPING_SIZE
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_INVALID_MAPPING_RANGE
```
public static final int CU_FILE_INVALID_MAPPING_RANGE
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_INVALID_FILE_TYPE
```
public static final int CU_FILE_INVALID_FILE_TYPE
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_INVALID_FILE_OPEN_FLAG
```
public static final int CU_FILE_INVALID_FILE_OPEN_FLAG
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_DIO_NOT_SET
```
public static final int CU_FILE_DIO_NOT_SET
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_INVALID_VALUE
```
public static final int CU_FILE_INVALID_VALUE
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_MEMORY_ALREADY_REGISTERED
```
public static final int CU_FILE_MEMORY_ALREADY_REGISTERED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_MEMORY_NOT_REGISTERED
```
public static final int CU_FILE_MEMORY_NOT_REGISTERED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_PERMISSION_DENIED
```
public static final int CU_FILE_PERMISSION_DENIED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_DRIVER_ALREADY_OPEN
```
public static final int CU_FILE_DRIVER_ALREADY_OPEN
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_HANDLE_NOT_REGISTERED
```
public static final int CU_FILE_HANDLE_NOT_REGISTERED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_HANDLE_ALREADY_REGISTERED
```
public static final int CU_FILE_HANDLE_ALREADY_REGISTERED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_DEVICE_NOT_FOUND
```
public static final int CU_FILE_DEVICE_NOT_FOUND
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_INTERNAL_ERROR
```
public static final int CU_FILE_INTERNAL_ERROR
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_GETNEWFD_FAILED
```
public static final int CU_FILE_GETNEWFD_FAILED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_NVFS_SETUP_ERROR
```
public static final int CU_FILE_NVFS_SETUP_ERROR
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_IO_DISABLED
```
public static final int CU_FILE_IO_DISABLED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_BATCH_SUBMIT_FAILED
```
public static final int CU_FILE_BATCH_SUBMIT_FAILED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_GPU_MEMORY_PINNING_FAILED
```
public static final int CU_FILE_GPU_MEMORY_PINNING_FAILED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_BATCH_FULL
```
public static final int CU_FILE_BATCH_FULL
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_ASYNC_NOT_SUPPORTED
```
public static final int CU_FILE_ASYNC_NOT_SUPPORTED
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_IO_MAX_ERROR
```
public static final int CU_FILE_IO_MAX_ERROR
```
  \cond DOXYGEN_SKIP_MACRO
  
  See Also:
  
  Constant Field Values
- CU_FILE_LUSTRE_SUPPORTED
```
public static final int CU_FILE_LUSTRE_SUPPORTED
```
  enum CUfileDriverStatusFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_WEKAFS_SUPPORTED
```
public static final int CU_FILE_WEKAFS_SUPPORTED
```
  enum CUfileDriverStatusFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_NFS_SUPPORTED
```
public static final int CU_FILE_NFS_SUPPORTED
```
  enum CUfileDriverStatusFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_GPFS_SUPPORTED
```
public static final int CU_FILE_GPFS_SUPPORTED
```
  enum CUfileDriverStatusFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_NVME_SUPPORTED
```
public static final int CU_FILE_NVME_SUPPORTED
```
  enum CUfileDriverStatusFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_NVMEOF_SUPPORTED
```
public static final int CU_FILE_NVMEOF_SUPPORTED
```
  enum CUfileDriverStatusFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_SCSI_SUPPORTED
```
public static final int CU_FILE_SCSI_SUPPORTED
```
  enum CUfileDriverStatusFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_SCALEFLUX_CSD_SUPPORTED
```
public static final int CU_FILE_SCALEFLUX_CSD_SUPPORTED
```
  enum CUfileDriverStatusFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_NVMESH_SUPPORTED
```
public static final int CU_FILE_NVMESH_SUPPORTED
```
  enum CUfileDriverStatusFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_BEEGFS_SUPPORTED
```
public static final int CU_FILE_BEEGFS_SUPPORTED
```
  enum CUfileDriverStatusFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_NVME_P2P_SUPPORTED
```
public static final int CU_FILE_NVME_P2P_SUPPORTED
```
  enum CUfileDriverStatusFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_SCATEFS_SUPPORTED
```
public static final int CU_FILE_SCATEFS_SUPPORTED
```
  enum CUfileDriverStatusFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_USE_POLL_MODE
```
public static final int CU_FILE_USE_POLL_MODE
```
  enum CUfileDriverControlFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_ALLOW_COMPAT_MODE
```
public static final int CU_FILE_ALLOW_COMPAT_MODE
```
  enum CUfileDriverControlFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_DYN_ROUTING_SUPPORTED
```
public static final int CU_FILE_DYN_ROUTING_SUPPORTED
```
  enum CUfileFeatureFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_BATCH_IO_SUPPORTED
```
public static final int CU_FILE_BATCH_IO_SUPPORTED
```
  enum CUfileFeatureFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_STREAMS_SUPPORTED
```
public static final int CU_FILE_STREAMS_SUPPORTED
```
  enum CUfileFeatureFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_PARALLEL_IO_SUPPORTED
```
public static final int CU_FILE_PARALLEL_IO_SUPPORTED
```
  enum CUfileFeatureFlags_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_RDMA_REGISTER
```
public static final int CU_FILE_RDMA_REGISTER
```
  See Also:
  
  Constant Field Values
- CU_FILE_RDMA_RELAXED_ORDERING
```
public static final int CU_FILE_RDMA_RELAXED_ORDERING
```
  See Also:
  
  Constant Field Values
- CU_FILE_HANDLE_TYPE_OPAQUE_FD
```
public static final int CU_FILE_HANDLE_TYPE_OPAQUE_FD
```
  enum CUfileFileHandleType
  
  See Also:
  
  Constant Field Values
- CU_FILE_HANDLE_TYPE_OPAQUE_WIN32
```
public static final int CU_FILE_HANDLE_TYPE_OPAQUE_WIN32
```
  enum CUfileFileHandleType
  
  See Also:
  
  Constant Field Values
- CU_FILE_HANDLE_TYPE_USERSPACE_FS
```
public static final int CU_FILE_HANDLE_TYPE_USERSPACE_FS
```
  enum CUfileFileHandleType
  
  See Also:
  
  Constant Field Values
- CUFILE_READ
```
public static final int CUFILE_READ
```
  enum CUfileOpcode_t
  
  See Also:
  
  Constant Field Values
- CUFILE_WRITE
```
public static final int CUFILE_WRITE
```
  enum CUfileOpcode_t
  
  See Also:
  
  Constant Field Values
- CUFILE_WAITING
```
public static final int CUFILE_WAITING
```
  enum CUfileStatus_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PENDING
```
public static final int CUFILE_PENDING
```
  enum CUfileStatus_t
  
  See Also:
  
  Constant Field Values
- CUFILE_INVALID
```
public static final int CUFILE_INVALID
```
  enum CUfileStatus_t
  
  See Also:
  
  Constant Field Values
- CUFILE_CANCELED
```
public static final int CUFILE_CANCELED
```
  enum CUfileStatus_t
  
  See Also:
  
  Constant Field Values
- CUFILE_COMPLETE
```
public static final int CUFILE_COMPLETE
```
  enum CUfileStatus_t
  
  See Also:
  
  Constant Field Values
- CUFILE_TIMEOUT
```
public static final int CUFILE_TIMEOUT
```
  enum CUfileStatus_t
  
  See Also:
  
  Constant Field Values
- CUFILE_FAILED
```
public static final int CUFILE_FAILED
```
  enum CUfileStatus_t
  
  See Also:
  
  Constant Field Values
- CUFILE_BATCH
```
public static final int CUFILE_BATCH
```
  enum CUfileBatchMode_t
  
  See Also:
  
  Constant Field Values
- CU_FILE_STREAM_FIXED_BUF_OFFSET
```
public static final int CU_FILE_STREAM_FIXED_BUF_OFFSET
```
  See Also:
  
  Constant Field Values
- CU_FILE_STREAM_FIXED_FILE_OFFSET
```
public static final int CU_FILE_STREAM_FIXED_FILE_OFFSET
```
  See Also:
  
  Constant Field Values
- CU_FILE_STREAM_FIXED_FILE_SIZE
```
public static final int CU_FILE_STREAM_FIXED_FILE_SIZE
```
  See Also:
  
  Constant Field Values
- CU_FILE_STREAM_PAGE_ALIGNED_INPUTS
```
public static final int CU_FILE_STREAM_PAGE_ALIGNED_INPUTS
```
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_PROFILE_STATS
```
public static final int CUFILE_PARAM_PROFILE_STATS
```
  enum CUFileSizeTConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_EXECUTION_MAX_IO_QUEUE_DEPTH
```
public static final int CUFILE_PARAM_EXECUTION_MAX_IO_QUEUE_DEPTH
```
  enum CUFileSizeTConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_EXECUTION_MAX_IO_THREADS
```
public static final int CUFILE_PARAM_EXECUTION_MAX_IO_THREADS
```
  enum CUFileSizeTConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_EXECUTION_MIN_IO_THRESHOLD_SIZE_KB
```
public static final int CUFILE_PARAM_EXECUTION_MIN_IO_THRESHOLD_SIZE_KB
```
  enum CUFileSizeTConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_EXECUTION_MAX_REQUEST_PARALLELISM
```
public static final int CUFILE_PARAM_EXECUTION_MAX_REQUEST_PARALLELISM
```
  enum CUFileSizeTConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_PROPERTIES_MAX_DIRECT_IO_SIZE_KB
```
public static final int CUFILE_PARAM_PROPERTIES_MAX_DIRECT_IO_SIZE_KB
```
  enum CUFileSizeTConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_PROPERTIES_MAX_DEVICE_CACHE_SIZE_KB
```
public static final int CUFILE_PARAM_PROPERTIES_MAX_DEVICE_CACHE_SIZE_KB
```
  enum CUFileSizeTConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_PROPERTIES_PER_BUFFER_CACHE_SIZE_KB
```
public static final int CUFILE_PARAM_PROPERTIES_PER_BUFFER_CACHE_SIZE_KB
```
  enum CUFileSizeTConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_PROPERTIES_MAX_DEVICE_PINNED_MEM_SIZE_KB
```
public static final int CUFILE_PARAM_PROPERTIES_MAX_DEVICE_PINNED_MEM_SIZE_KB
```
  enum CUFileSizeTConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_PROPERTIES_IO_BATCHSIZE
```
public static final int CUFILE_PARAM_PROPERTIES_IO_BATCHSIZE
```
  enum CUFileSizeTConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_POLLTHRESHOLD_SIZE_KB
```
public static final int CUFILE_PARAM_POLLTHRESHOLD_SIZE_KB
```
  enum CUFileSizeTConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_PROPERTIES_BATCH_IO_TIMEOUT_MS
```
public static final int CUFILE_PARAM_PROPERTIES_BATCH_IO_TIMEOUT_MS
```
  enum CUFileSizeTConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_PROPERTIES_USE_POLL_MODE
```
public static final int CUFILE_PARAM_PROPERTIES_USE_POLL_MODE
```
  enum CUFileBoolConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_PROPERTIES_ALLOW_COMPAT_MODE
```
public static final int CUFILE_PARAM_PROPERTIES_ALLOW_COMPAT_MODE
```
  enum CUFileBoolConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_FORCE_COMPAT_MODE
```
public static final int CUFILE_PARAM_FORCE_COMPAT_MODE
```
  enum CUFileBoolConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_FS_MISC_API_CHECK_AGGRESSIVE
```
public static final int CUFILE_PARAM_FS_MISC_API_CHECK_AGGRESSIVE
```
  enum CUFileBoolConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_EXECUTION_PARALLEL_IO
```
public static final int CUFILE_PARAM_EXECUTION_PARALLEL_IO
```
  enum CUFileBoolConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_PROFILE_NVTX
```
public static final int CUFILE_PARAM_PROFILE_NVTX
```
  enum CUFileBoolConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_PROPERTIES_ALLOW_SYSTEM_MEMORY
```
public static final int CUFILE_PARAM_PROPERTIES_ALLOW_SYSTEM_MEMORY
```
  enum CUFileBoolConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_USE_PCIP2PDMA
```
public static final int CUFILE_PARAM_USE_PCIP2PDMA
```
  enum CUFileBoolConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_PREFER_IO_URING
```
public static final int CUFILE_PARAM_PREFER_IO_URING
```
  enum CUFileBoolConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_FORCE_ODIRECT_MODE
```
public static final int CUFILE_PARAM_FORCE_ODIRECT_MODE
```
  enum CUFileBoolConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_SKIP_TOPOLOGY_DETECTION
```
public static final int CUFILE_PARAM_SKIP_TOPOLOGY_DETECTION
```
  enum CUFileBoolConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_STREAM_MEMOPS_BYPASS
```
public static final int CUFILE_PARAM_STREAM_MEMOPS_BYPASS
```
  enum CUFileBoolConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_LOGGING_LEVEL
```
public static final int CUFILE_PARAM_LOGGING_LEVEL
```
  enum CUFileStringConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_ENV_LOGFILE_PATH
```
public static final int CUFILE_PARAM_ENV_LOGFILE_PATH
```
  enum CUFileStringConfigParameter_t
  
  See Also:
  
  Constant Field Values
- CUFILE_PARAM_LOG_DIR
```
public static final int CUFILE_PARAM_LOG_DIR
```
  enum CUFileStringConfigParameter_t
  
  See Also:
  
  Constant Field Values

Constructor Detail
- cufile
```
public cufile()
```

Method Detail

cufileop_status_error

@Cast(value="const char*")
public static BytePointer cufileop_status_error(@Cast(value="CUfileOpError")
                                                                            int status)

\endcond

/** \brief cufileop status string

cuFileHandleRegister
```
@ByVal
public static CUfileError_t cuFileHandleRegister(@ByPtrPtr
                                                         CUfileHandle_t fh,
                                                         CUfileDescr_t descr)
```
\brief cuFileHandleRegister is required, and performs extra checking that is memoized to provide increased performance on later cuFile operations.

Parameters:

fh - \ref CUfileHandle_t opaque file handle for IO operations

descr - \ref CUfileDescr_t file descriptor (OS agnostic)

Returns:

CU_FILE_SUCCESS on successful completion. fh will be updated for use in \ref cuFileRead, \ref cuFileWrite, \ref cuFileHandleDeregister

See Also:

cuFileRead, cuFileWrite, cuFileHandleDeregister

cuFileHandleDeregister
```
public static void cuFileHandleDeregister(CUfileHandle_t fh)
```
\brief releases a registered filehandle from cuFile

Parameters:

fh - \ref CUfileHandle_t file handle

See Also:

cuFileHandleRegister

cuFileBufRegister

@ByVal
public static CUfileError_t cuFileBufRegister(@Const
                                                      Pointer bufPtr_base,
                                                      @Cast(value="size_t")
                                                      long length,
                                                      int flags)

\brief register an existing cudaMalloced memory with cuFile to pin for GPUDirect Storage access or register host allocated memory with cuFile.

Parameters:: bufPtr_base - buffer pointer allocated; length - size of memory region from the above specified bufPtr; flags - CU_FILE_RDMA_REGISTER
Returns:: CU_FILE_SUCCESS on success
See Also:: cuFileBufDeregister, cuFileRead, cuFileWrite

cuFileBufDeregister
```
@ByVal
public static CUfileError_t cuFileBufDeregister(@Const
                                                        Pointer bufPtr_base)
```
\brief deregister an already registered device or host memory from cuFile

Parameters:

bufPtr_base - buffer pointer to deregister

Returns:

CU_FILE_SUCCESS on success

See Also:

cuFileBufRegister, cuFileRead, cuFileWrite

cuFileRead

@Cast(value="ssize_t")
public static long cuFileRead(CUfileHandle_t fh,
                                                      Pointer bufPtr_base,
                                                      @Cast(value="size_t")
                                                      long size,
                                                      @Cast(value="off_t")
                                                      long file_offset,
                                                      @Cast(value="off_t")
                                                      long bufPtr_offset)

\brief read data from a registered file handle to a specified device or host memory

Parameters:: fh - \ref CUfileHandle_t opaque file handle; bufPtr_base - base address of buffer in device or host memory; size - size bytes to read; file_offset - file-offset from begining of the file; bufPtr_offset - offset relative to the bufPtr_base pointer to read into.
Returns:: size of bytes successfully read
See Also:: cuFileBufRegister, cuFileHandleRegister, cuFileWrite

cuFileWrite

@Cast(value="ssize_t")
public static long cuFileWrite(CUfileHandle_t fh,
                                                       @Const
                                                       Pointer bufPtr_base,
                                                       @Cast(value="size_t")
                                                       long size,
                                                       @Cast(value="off_t")
                                                       long file_offset,
                                                       @Cast(value="off_t")
                                                       long bufPtr_offset)

\brief write data from a specified device or host memory to a registered file handle

Parameters:: fh - \ref CUfileHandle_t opaque file handle; bufPtr_base - base address of buffer in device or host memory; size - size bytes to write; file_offset - file-offset from begining of the file; bufPtr_offset - offset relative to the bufPtr_base pointer to write from.
Returns:: size of bytes successfully written
See Also:: cuFileBufRegister, cuFileHandleRegister, cuFileRead

cuFileDriverOpen
```
@ByVal
public static CUfileError_t cuFileDriverOpen()
```
\brief Initialize the cuFile library and open the nvidia-fs driver

Returns:

CU_FILE_SUCCESS on success

See Also:

cuFileDriverClose

cuFileDriverClose

@ByVal
public static CUfileError_t cuFileDriverClose()

cuFileUseCount
```
public static long cuFileUseCount()
```
\brief returns use count of cufile drivers at that moment by the process.

cuFileDriverGetProperties
```
@ByVal
public static CUfileError_t cuFileDriverGetProperties(CUfileDrvProps_t props)
```
\brief Gets the Driver session properties

Returns:

CU_FILE_SUCCESS on success

See Also:

cuFileDriverSetPollMode, cuFileDriverSetMaxDirectIOSize, cuFileDriverSetMaxCacheSize, cuFileDriverSetMaxPinnedMemSize

cuFileDriverSetPollMode

@ByVal
public static CUfileError_t cuFileDriverSetPollMode(@Cast(value="bool")
                                                            boolean poll,
                                                            @Cast(value="size_t")
                                                            long poll_threshold_size)

\brief Sets whether the Read/Write APIs use polling to do IO operations

Parameters:: poll - boolean to indicate whether to use poll mode or not; poll_threshold_size - max IO size to use for POLLING mode in KB
Returns:: CU_FILE_SUCCESS on success
See Also:: cuFileDriverGetProperties

cuFileDriverSetMaxDirectIOSize
```
@ByVal
public static CUfileError_t cuFileDriverSetMaxDirectIOSize(@Cast(value="size_t")
                                                                   long max_direct_io_size)
```
\brief Control parameter to set max IO size(KB) used by the library to talk to nvidia-fs driver

Parameters:

max_direct_io_size - maximum allowed direct io size in KB

Returns:

CU_FILE_SUCCESS on success

See Also:

cuFileDriverGetProperties

cuFileDriverSetMaxCacheSize
```
@ByVal
public static CUfileError_t cuFileDriverSetMaxCacheSize(@Cast(value="size_t")
                                                                long max_cache_size)
```
\brief Control parameter to set maximum GPU memory reserved per device by the library for internal buffering

Parameters:

max_cache_size - The maximum GPU buffer space per device used for internal use in KB

Returns:

CU_FILE_SUCCESS on success

See Also:

cuFileDriverGetProperties

cuFileDriverSetMaxPinnedMemSize
```
@ByVal
public static CUfileError_t cuFileDriverSetMaxPinnedMemSize(@Cast(value="size_t")
                                                                    long max_pinned_size)
```
\brief Sets maximum buffer space that is pinned in KB for use by \ref cuFileBufRegister

Parameters:

max_pinned_size - maximum buffer space that is pinned in KB

Returns:

CU_FILE_SUCCESS on success

See Also:

cuFileDriverGetProperties

cuFileBatchIOSetUp

@ByVal
public static CUfileError_t cuFileBatchIOSetUp(@ByPtrPtr
                                                       CUfileBatchHandle_t batch_idp,
                                                       @Cast(value="unsigned")
                                                       int nr)

cuFileBatchIOSubmit

@ByVal
public static CUfileError_t cuFileBatchIOSubmit(CUfileBatchHandle_t batch_idp,
                                                        @Cast(value="unsigned")
                                                        int nr,
                                                        CUfileIOParams_t iocbp,
                                                        @Cast(value="unsigned int")
                                                        int flags)

cuFileBatchIOGetStatus

@ByVal
public static CUfileError_t cuFileBatchIOGetStatus(CUfileBatchHandle_t batch_idp,
                                                           @Cast(value="unsigned")
                                                           int min_nr,
                                                           @Cast(value="unsigned*")
                                                           IntPointer nr,
                                                           CUfileIOEvents_t iocbp,
                                                           @Cast(value="timespec*")
                                                           Pointer timeout)

cuFileBatchIOGetStatus

@ByVal
public static CUfileError_t cuFileBatchIOGetStatus(CUfileBatchHandle_t batch_idp,
                                                           @Cast(value="unsigned")
                                                           int min_nr,
                                                           @Cast(value="unsigned*")
                                                           IntBuffer nr,
                                                           CUfileIOEvents_t iocbp,
                                                           @Cast(value="timespec*")
                                                           Pointer timeout)

cuFileBatchIOGetStatus

@ByVal
public static CUfileError_t cuFileBatchIOGetStatus(CUfileBatchHandle_t batch_idp,
                                                           @Cast(value="unsigned")
                                                           int min_nr,
                                                           @Cast(value="unsigned*")
                                                           int[] nr,
                                                           CUfileIOEvents_t iocbp,
                                                           @Cast(value="timespec*")
                                                           Pointer timeout)

cuFileBatchIOCancel

@ByVal
public static CUfileError_t cuFileBatchIOCancel(CUfileBatchHandle_t batch_idp)

cuFileBatchIODestroy

public static void cuFileBatchIODestroy(CUfileBatchHandle_t batch_idp)

cuFileReadAsync

@ByVal
public static CUfileError_t cuFileReadAsync(CUfileHandle_t fh,
                                                    Pointer bufPtr_base,
                                                    @Cast(value="size_t*")
                                                    SizeTPointer size_p,
                                                    @Cast(value="off_t*")
                                                    SizeTPointer file_offset_p,
                                                    @Cast(value="off_t*")
                                                    SizeTPointer bufPtr_offset_p,
                                                    @Cast(value="ssize_t*")
                                                    SizeTPointer bytes_read_p,
                                                    CUstream_st stream)

\brief

Parameters:: fh - The cuFile handle for the file.; bufPtr_base - base address of buffer in device or host memory; size_p - pointer to size bytes to read \note *size_p if the size is not known at the time of submission, then must provide the max possible size for I/O request.; file_offset_p - pointer to file-offset from begining of the file; bufPtr_offset_p - pointer to offset relative to the bufPtr_base pointer to read into.; bytes_read_p - pointer to the number of bytes that were successfully read.; CUstream - stream cuda stream for the operation.
Returns:: size of bytes successfully read in *bytes_read_p
See Also:: cuFileBufRegister, cuFileHandleRegister, cuFileRead, cuFileStreamRegister, cuFileStreamDeregister

cuFileWriteAsync

@ByVal
public static CUfileError_t cuFileWriteAsync(CUfileHandle_t fh,
                                                     Pointer bufPtr_base,
                                                     @Cast(value="size_t*")
                                                     SizeTPointer size_p,
                                                     @Cast(value="off_t*")
                                                     SizeTPointer file_offset_p,
                                                     @Cast(value="off_t*")
                                                     SizeTPointer bufPtr_offset_p,
                                                     @Cast(value="ssize_t*")
                                                     SizeTPointer bytes_written_p,
                                                     CUstream_st stream)

\brief

Parameters:: fh - The cuFile handle for the file.; bufPtr_base - base address of buffer in device or host memory; size_p - pointer to size bytes to write. \note *size_p if the size is not known at the time of submission, then must provide the max possible size for I/O request.; file_offset_p - pointer to file-offset from begining of the file; bufPtr_offset_p - pointer to offset relative to the bufPtr_base pointer to write from.; bytes_written_p - pointer to the number of bytes that were successfully written.; CUstream - cuda stream for the operation.
Returns:: size of bytes successfully written in *bytes_written_p
See Also:: cuFileBufRegister, cuFileHandleRegister, cuFileWrite, cuFileStreamRegister, cuFileStreamDeregister

cuFileStreamRegister
```
@ByVal
public static CUfileError_t cuFileStreamRegister(CUstream_st stream,
                                                         @Cast(value="unsigned")
                                                         int flags)
```
\brief

Parameters:

CUstream - cuda stream for the operation.

flags - for the stream to improve the stream execution of IO based on input parameters. \note supported FLAGS are \note CU_FILE_STREAM_FIXED_BUF_OFFSET - buffer pointer offset is set at submission time \note CU_FILE_STREAM_FIXED_FILE_OFFSET - file offset is set at submission time \note CU_FILE_STREAM_FIXED_FILE_SIZE - file size is set at submission time \note CU_FILE_STREAM_PAGE_ALIGNED_INPUTS - size, offset and buffer offset are 4k aligned \note allocates resources needed to support cuFile operations asynchronously for the cuda stream \note This is useful for applications that need to perform IO to unaligned file offsets and/or size. This is also recommended for cases where the BAR1 memory size is smaller than the size of the allocated memory.

Returns:

CU_FILE_SUCCESS on success

See Also:

cuFileReadAsync, cuFileWriteAsync, cuFileStreamDeregister

cuFileStreamDeregister
```
@ByVal
public static CUfileError_t cuFileStreamDeregister(CUstream_st stream)
```
\brief

Parameters:

CUstream - cuda stream for the operation. \note deallocates resources used by previous cuFile asynchronous operations for the cuda stream \note highly recommend to call after cuda stream errors to release any outstanding cuFile resources for this stream \note must be called before cuStreamDestroy call for the specified stream. \note This is useful for applications that need to perform IO to unaligned file offsets and/or size. This is also recommended for cases where the BAR1 memory size is smaller than the size of the allocated memory.

Returns:

CU_FILE_SUCCESS on success

See Also:

cuFileReadAsync, cuFileWriteAsync, cuFileStreamRegister

cuFileGetVersion
```
@ByVal
public static CUfileError_t cuFileGetVersion(IntPointer version)
```
\brief

Returns:

cufile library version. \The version is returned as (1000 major + 10 minor). \For example, CUFILE 1.7.0 would be represented by 1070. \note This is useful for applications that need to inquire the library.

cuFileGetVersion

@ByVal
public static CUfileError_t cuFileGetVersion(IntBuffer version)

cuFileGetVersion

@ByVal
public static CUfileError_t cuFileGetVersion(int[] version)

cuFileGetParameterSizeT

@ByVal
public static CUfileError_t cuFileGetParameterSizeT(@Cast(value="CUFileSizeTConfigParameter_t")
                                                            int param,
                                                            @Cast(value="size_t*")
                                                            SizeTPointer value)

\brief

Parameters:: param - The parameter to get.; value - The location where the value will be stored.
Returns:: CU_FILE_SUCCESS on success

cuFileGetParameterBool

@ByVal
public static CUfileError_t cuFileGetParameterBool(@Cast(value="CUFileBoolConfigParameter_t")
                                                           int param,
                                                           @Cast(value="bool*")
                                                           BoolPointer value)

cuFileGetParameterBool

@ByVal
public static CUfileError_t cuFileGetParameterBool(@Cast(value="CUFileBoolConfigParameter_t")
                                                           int param,
                                                           @Cast(value="bool*")
                                                           boolean[] value)

cuFileGetParameterString

@ByVal
public static CUfileError_t cuFileGetParameterString(@Cast(value="CUFileStringConfigParameter_t")
                                                             int param,
                                                             @Cast(value="char*")
                                                             BytePointer desc_str,
                                                             int len)

cuFileGetParameterString

@ByVal
public static CUfileError_t cuFileGetParameterString(@Cast(value="CUFileStringConfigParameter_t")
                                                             int param,
                                                             @Cast(value="char*")
                                                             ByteBuffer desc_str,
                                                             int len)

cuFileGetParameterString

@ByVal
public static CUfileError_t cuFileGetParameterString(@Cast(value="CUFileStringConfigParameter_t")
                                                             int param,
                                                             @Cast(value="char*")
                                                             byte[] desc_str,
                                                             int len)

cuFileSetParameterSizeT

@ByVal
public static CUfileError_t cuFileSetParameterSizeT(@Cast(value="CUFileSizeTConfigParameter_t")
                                                            int param,
                                                            @Cast(value="size_t")
                                                            long value)

\brief

Parameters:: param - The parameter to set.; value - The source of the parameter value.
Returns:: CU_FILE_SUCCESS on success

cuFileSetParameterBool

@ByVal
public static CUfileError_t cuFileSetParameterBool(@Cast(value="CUFileBoolConfigParameter_t")
                                                           int param,
                                                           @Cast(value="bool")
                                                           boolean value)

cuFileSetParameterString

@ByVal
public static CUfileError_t cuFileSetParameterString(@Cast(value="CUFileStringConfigParameter_t")
                                                             int param,
                                                             @Cast(value="const char*")
                                                             BytePointer desc_str)

cuFileSetParameterString

@ByVal
public static CUfileError_t cuFileSetParameterString(@Cast(value="CUFileStringConfigParameter_t")
                                                             int param,
                                                             String desc_str)

Class cufile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.bytedeco.cuda.presets.cufile

Methods inherited from class java.lang.Object

Field Detail

CUFILEOP_BASE_ERR

CU_FILE_SUCCESS

CU_FILE_DRIVER_NOT_INITIALIZED

CU_FILE_DRIVER_INVALID_PROPS

CU_FILE_DRIVER_UNSUPPORTED_LIMIT

CU_FILE_DRIVER_VERSION_MISMATCH

CU_FILE_DRIVER_VERSION_READ_ERROR

CU_FILE_DRIVER_CLOSING

CU_FILE_PLATFORM_NOT_SUPPORTED

CU_FILE_IO_NOT_SUPPORTED

CU_FILE_DEVICE_NOT_SUPPORTED

CU_FILE_NVFS_DRIVER_ERROR

CU_FILE_CUDA_DRIVER_ERROR

CU_FILE_CUDA_POINTER_INVALID

CU_FILE_CUDA_MEMORY_TYPE_INVALID

CU_FILE_CUDA_POINTER_RANGE_ERROR

CU_FILE_CUDA_CONTEXT_MISMATCH

CU_FILE_INVALID_MAPPING_SIZE

CU_FILE_INVALID_MAPPING_RANGE

CU_FILE_INVALID_FILE_TYPE

CU_FILE_INVALID_FILE_OPEN_FLAG

CU_FILE_DIO_NOT_SET

CU_FILE_INVALID_VALUE

CU_FILE_MEMORY_ALREADY_REGISTERED

CU_FILE_MEMORY_NOT_REGISTERED

CU_FILE_PERMISSION_DENIED

CU_FILE_DRIVER_ALREADY_OPEN

CU_FILE_HANDLE_NOT_REGISTERED

CU_FILE_HANDLE_ALREADY_REGISTERED

CU_FILE_DEVICE_NOT_FOUND

CU_FILE_INTERNAL_ERROR

CU_FILE_GETNEWFD_FAILED

CU_FILE_NVFS_SETUP_ERROR

CU_FILE_IO_DISABLED

CU_FILE_BATCH_SUBMIT_FAILED

CU_FILE_GPU_MEMORY_PINNING_FAILED

CU_FILE_BATCH_FULL

CU_FILE_ASYNC_NOT_SUPPORTED

CU_FILE_IO_MAX_ERROR

CU_FILE_LUSTRE_SUPPORTED

CU_FILE_WEKAFS_SUPPORTED

CU_FILE_NFS_SUPPORTED

CU_FILE_GPFS_SUPPORTED

CU_FILE_NVME_SUPPORTED

CU_FILE_NVMEOF_SUPPORTED

CU_FILE_SCSI_SUPPORTED

CU_FILE_SCALEFLUX_CSD_SUPPORTED

CU_FILE_NVMESH_SUPPORTED

CU_FILE_BEEGFS_SUPPORTED

CU_FILE_NVME_P2P_SUPPORTED

CU_FILE_SCATEFS_SUPPORTED

CU_FILE_USE_POLL_MODE

CU_FILE_ALLOW_COMPAT_MODE

CU_FILE_DYN_ROUTING_SUPPORTED

CU_FILE_BATCH_IO_SUPPORTED

CU_FILE_STREAMS_SUPPORTED

CU_FILE_PARALLEL_IO_SUPPORTED

CU_FILE_RDMA_REGISTER

CU_FILE_RDMA_RELAXED_ORDERING

CU_FILE_HANDLE_TYPE_OPAQUE_FD

CU_FILE_HANDLE_TYPE_OPAQUE_WIN32

CU_FILE_HANDLE_TYPE_USERSPACE_FS

CUFILE_READ

CUFILE_WRITE

CUFILE_WAITING

CUFILE_PENDING

CUFILE_INVALID

CUFILE_CANCELED

CUFILE_COMPLETE

CUFILE_TIMEOUT

CUFILE_FAILED

CUFILE_BATCH

CU_FILE_STREAM_FIXED_BUF_OFFSET