cuFile API supported by HIP

cuFile API supported by HIP#

Note: In the tables that follow the columns marked A, D, C, R, U, and E mean the following: A - Added; D - Deprecated; C - Changed; R - Removed; U - Unsupported for CUDA version(s); E - Experimental

1. cuFile Types#

CUDA

A

D

C

R

HIP

A

D

C

R

U

E

CUFILEStatus_enum

1.2.0

hipFileStatus_t

7.2.0

CUFILE_BATCH

1.2.0

hipFileBatch

7.2.0

CUFILE_C2C

1.16.0

CUFILE_CANCELED

1.2.0

hipFileCanceled

7.2.0

CUFILE_COMPLETE

1.2.0

hipFileComplete

7.2.0

CUFILE_DMABUF

1.16.0

CUFILE_ERRSTR

1.0.0

HIPFILE_ERRSTR

7.2.0

CUFILE_FAILED

1.2.0

hipFileFailed

7.2.0

CUFILE_GPU_UUID_LEN

1.15.0

CUFILE_INVALID

1.2.0

hipFileInvalid

7.2.0

CUFILE_NVFS

1.16.0

CUFILE_NVIDIA_PEERMEM

1.16.0

CUFILE_P2PDMA

1.16.0

CUFILE_PARAM_ENV_LOGFILE_PATH

1.14.0

hipFileParamEnvLogfilePath

7.2.0

CUFILE_PARAM_EXECUTION_MAX_IO_QUEUE_DEPTH

1.14.0

hipFileParamExecutionMaxIOQueueDepth

7.2.0

CUFILE_PARAM_EXECUTION_MAX_IO_THREADS

1.14.0

hipFileParamExecutionMaxIOThreads

7.2.0

CUFILE_PARAM_EXECUTION_MAX_REQUEST_PARALLELISM

1.14.0

hipFileParamExecutionMaxRequestParallelism

7.2.0

CUFILE_PARAM_EXECUTION_MIN_IO_THRESHOLD_SIZE_KB

1.14.0

hipFileParamExecutionMinIOThresholdSizeKB

7.2.0

CUFILE_PARAM_EXECUTION_PARALLEL_IO

1.14.0

hipFileParamExecutionParallelIO

7.2.0

CUFILE_PARAM_FORCE_COMPAT_MODE

1.14.0

hipFileParamForceCompatMode

7.2.0

CUFILE_PARAM_FORCE_ODIRECT_MODE

1.14.0

hipFileParamForceOdirectMode

7.2.0

CUFILE_PARAM_FS_MISC_API_CHECK_AGGRESSIVE

1.14.0

hipFileParamFsMiscApiCheckAggressive

7.2.0

CUFILE_PARAM_GPU_BOUNCE_BUFFER_SLAB_COUNT

1.17.0

CUFILE_PARAM_GPU_BOUNCE_BUFFER_SLAB_SIZE_KB

1.17.0

CUFILE_PARAM_LOGGING_LEVEL

1.14.0

hipFileParamLoggingLevel

7.2.0

CUFILE_PARAM_LOG_DIR

1.14.0

hipFileParamLogDir

7.2.0

CUFILE_PARAM_POLLTHRESHOLD_SIZE_KB

1.14.0

hipFileParamPollthresholdSizeKB

7.2.0

CUFILE_PARAM_POSIX_POOL_SLAB_COUNT

1.15.0

CUFILE_PARAM_POSIX_POOL_SLAB_SIZE_KB

1.15.0

CUFILE_PARAM_PREFER_IO_URING

1.14.0

hipFileParamPreferIOUring

7.2.0

CUFILE_PARAM_PROFILE_NVTX

1.14.0

hipFileParamProfileNvtx

7.2.0

CUFILE_PARAM_PROFILE_STATS

1.14.0

hipFileParamProfileStats

7.2.0

CUFILE_PARAM_PROPERTIES_ALLOW_COMPAT_MODE

1.14.0

hipFileParamPropertiesAllowCompatMode

7.2.0

CUFILE_PARAM_PROPERTIES_ALLOW_SYSTEM_MEMORY

1.14.0

hipFileParamPropertiesAllowSystemMemory

7.2.0

CUFILE_PARAM_PROPERTIES_BATCH_IO_TIMEOUT_MS

1.14.0

hipFileParamPropertiesBatchIOTimeoutMs

7.2.0

CUFILE_PARAM_PROPERTIES_IO_BATCHSIZE

1.14.0

hipFileParamPropertiesIOBatchsize

7.2.0

CUFILE_PARAM_PROPERTIES_MAX_DEVICE_CACHE_SIZE_KB

1.14.0

hipFileParamPropertiesMaxDeviceCacheSizeKB

7.2.0

CUFILE_PARAM_PROPERTIES_MAX_DEVICE_PINNED_MEM_SIZE_KB

1.14.0

hipFileParamPropertiesMaxDevicePinnedMemSizeKB

7.2.0

CUFILE_PARAM_PROPERTIES_MAX_DIRECT_IO_SIZE_KB

1.14.0

hipFileParamPropertiesMaxDirectIOSizeKB

7.2.0

CUFILE_PARAM_PROPERTIES_PER_BUFFER_CACHE_SIZE_KB

1.14.0

hipFileParamPropertiesPerBufferCacheSizeKB

7.2.0

CUFILE_PARAM_PROPERTIES_USE_POLL_MODE

1.14.0

hipFileParamPropertiesUsePollMode

7.2.0

CUFILE_PARAM_SKIP_TOPOLOGY_DETECTION

1.14.0

hipFileParamSkipTopologyDetection

7.2.0

CUFILE_PARAM_STREAM_MEMOPS_BYPASS

1.14.0

hipFileParamStreamMemopsBypass

7.2.0

CUFILE_PARAM_USE_PCIP2PDMA

1.14.0

hipFileParamUsePcip2pdma

7.2.0

CUFILE_PENDING

1.2.0

hipFilePending

7.2.0

CUFILE_READ

1.2.0

hipFileBatchRead

7.2.0

CUFILE_TIMEOUT

1.2.0

hipFileTimeout

7.2.0

CUFILE_WAITING

1.2.0

hipFileWaiting

7.2.0

CUFILE_WRITE

1.2.0

hipFileBatchWrite

7.2.0

CUFileArrayConfigParameter_t

1.15.0

CUFileBoolConfigParameter_t

1.14.0

hipFileBoolConfigParameter_t

7.2.0

CUFileSizeTConfigParameter_t

1.14.0

hipFileSizeTConfigParameter_t

7.2.0

CUFileStringConfigParameter_t

1.14.0

hipFileStringConfigParameter_t

7.2.0

CU_FILE_ALLOW_COMPAT_MODE

1.0.0

hipFileAllowCompatMode

7.2.0

CU_FILE_ASYNC_NOT_SUPPORTED

1.7.0

hipFileAsyncNotSupported

7.2.0

CU_FILE_BATCH_FULL

1.5.1

hipFileBatchFull

7.2.0

CU_FILE_BATCH_IO_SUPPORTED

1.0.0

hipFileBatchIOSupported

7.2.0

CU_FILE_BATCH_SUBMIT_FAILED

1.2.0

hipFileBatchSubmitFailed

7.2.0

CU_FILE_BEEGFS_SUPPORTED

1.1.1

hipFileBEEGFSSupported

7.2.0

CU_FILE_CUDA_CONTEXT_MISMATCH

1.0.0

hipFileHipContextMismatch

7.2.0

CU_FILE_CUDA_DRIVER_ERROR

1.0.0

hipFileHipDriverError

7.2.0

CU_FILE_CUDA_ERR

1.0.0

HIP_DRV_ERR

7.2.0

CU_FILE_CUDA_MEMORY_TYPE_INVALID

1.0.0

hipFileHipMemoryTypeInvalid

7.2.0

CU_FILE_CUDA_POINTER_INVALID

1.0.0

hipFileHipPointerInvalid

7.2.0

CU_FILE_CUDA_POINTER_RANGE_ERROR

1.0.0

hipFileHipPointerRangeError

7.2.0

CU_FILE_DEVICE_NOT_FOUND

1.0.0

hipFileDeviceNotFound

7.2.0

CU_FILE_DEVICE_NOT_SUPPORTED

1.0.0

hipFileDeviceNotSupported

7.2.0

CU_FILE_DIO_NOT_SET

1.0.0

hipFileDIONotSet

7.2.0

CU_FILE_DRIVER_ALREADY_OPEN

1.0.0

hipFileDriverAlreadyOpen

7.2.0

CU_FILE_DRIVER_CLOSING

1.0.0

hipFileDriverClosing

7.2.0

CU_FILE_DRIVER_INVALID_PROPS

1.0.0

hipFileDriverInvalidProps

7.2.0

CU_FILE_DRIVER_NOT_INITIALIZED

1.0.0

hipFileDriverNotInitialized

7.2.0

CU_FILE_DRIVER_UNSUPPORTED_LIMIT

1.0.0

hipFileDriverUnsupportedLimit

7.2.0

CU_FILE_DRIVER_VERSION_MISMATCH

1.0.0

hipFileDriverVersionMismatch

7.2.0

CU_FILE_DRIVER_VERSION_READ_ERROR

1.0.0

hipFileDriverVersionReadError

7.2.0

CU_FILE_DYN_ROUTING_SUPPORTED

1.0.0

hipFileDynRoutingSupported

7.2.0

CU_FILE_FALLBACK_IO_MODE

1.17.0

CU_FILE_GETNEWFD_FAILED

1.0.0

hipFileGetNewFDFailed

7.2.0

CU_FILE_GPFS_SUPPORTED

1.0.0

hipFileGPFSSupported

7.2.0

CU_FILE_GPU_MEMORY_PINNING_FAILED

1.2.0

hipFileGPUMemoryPinningFailed

7.2.0

CU_FILE_HANDLE_ALREADY_REGISTERED

1.0.0

hipFileHandleAlreadyRegistered

7.2.0

CU_FILE_HANDLE_NOT_REGISTERED

1.0.0

hipFileHandleNotRegistered

7.2.0

CU_FILE_HANDLE_TYPE_OPAQUE_FD

1.0.0

hipFileHandleTypeOpaqueFD

7.2.0

CU_FILE_HANDLE_TYPE_OPAQUE_WIN32

1.0.0

hipFileHandleTypeOpaqueWin32

7.2.0

CU_FILE_HANDLE_TYPE_USERSPACE_FS

1.0.0

hipFileHandleTypeUserspaceFS

7.2.0

CU_FILE_INTERNAL_ERROR

1.0.0

hipFileInternalError

7.2.0

CU_FILE_INVALID_FILE_OPEN_FLAG

1.0.0

hipFileInvalidFileOpenFlag

7.2.0

CU_FILE_INVALID_FILE_TYPE

1.0.0

hipFileInvalidFileType

7.2.0

CU_FILE_INVALID_MAPPING_RANGE

1.0.0

hipFileInvalidMappingRange

7.2.0

CU_FILE_INVALID_MAPPING_SIZE

1.0.0

hipFileInvalidMappingSize

7.2.0

CU_FILE_INVALID_VALUE

1.0.0

hipFileInvalidValue

7.2.0

CU_FILE_IO_DISABLED

1.0.0

hipFileIODisabled

7.2.0

CU_FILE_IO_MAX_ERROR

1.1.0

hipFileIOMaxError

7.2.0

CU_FILE_IO_NOT_SUPPORTED

1.0.0

hipFileIONotSupported

7.2.0

CU_FILE_LUSTRE_SUPPORTED

1.0.0

hipFileLustreSupported

7.2.0

CU_FILE_MAX_TARGET_TYPES

1.16.0

CU_FILE_MEMORY_ALREADY_REGISTERED

1.0.0

hipFileMemoryAlreadyRegistered

7.2.0

CU_FILE_MEMORY_NOT_REGISTERED

1.0.0

hipFileMemoryNotRegistered

7.2.0

CU_FILE_NFS_SUPPORTED

1.0.0

hipFileNFSSupported

7.2.0

CU_FILE_NVFS_DRIVER_ERROR

1.0.0

hipFileDriverError

7.2.0

CU_FILE_NVFS_SETUP_ERROR

1.0.0

hipFileDriverSetupError

7.2.0

CU_FILE_NVMEOF_SUPPORTED

1.0.0

hipFileNVMeoFSupported

7.2.0

CU_FILE_NVMESH_SUPPORTED

1.0.0

hipFileNVMeshSupported

7.2.0

CU_FILE_NVME_P2P_SUPPORTED

1.13.0

hipFileNVMeP2PSupported

7.2.0

CU_FILE_NVME_SUPPORTED

1.0.0

hipFileNVMeSupported

7.2.0

CU_FILE_P2P_FLAG_C2C

1.16.0

CU_FILE_P2P_FLAG_DMABUF

1.16.0

CU_FILE_P2P_FLAG_NVFS

1.16.0

CU_FILE_P2P_FLAG_PCI_P2PDMA

1.16.0

CU_FILE_P2P_SUPPORTED

1.16.0

CU_FILE_PARALLEL_IO_SUPPORTED

1.8.0

hipFileParallelIOSupported

7.2.0

CU_FILE_PERMISSION_DENIED

1.0.0

hipFilePermissionDenied

7.2.0

CU_FILE_PLATFORM_NOT_SUPPORTED

1.0.0

hipFilePlatformNotSupported

7.2.0

CU_FILE_POSIX_IO_MODE

1.17.0

CU_FILE_RDMA_REGISTER

1.0.0

HIPFILE_RDMA_REGISTER

7.2.0

CU_FILE_RDMA_RELAXED_ORDERING

1.0.0

HIPFILE_RDMA_RELAXED_ORDERING

7.2.0

CU_FILE_SCALEFLUX_CSD_SUPPORTED

1.0.0

hipFileScaleFluxCSDSupported

7.2.0

CU_FILE_SCATEFS_SUPPORTED

1.14.0

CU_FILE_SCSI_SUPPORTED

1.0.0

hipFileSCSISupported

7.2.0

CU_FILE_STREAMS_SUPPORTED

1.0.0

hipFileStreamsSupported

7.2.0

CU_FILE_STREAM_FIXED_BUF_OFFSET

1.7.0

HIPFILE_STREAM_FIXED_BUF_OFFSET

7.2.0

CU_FILE_STREAM_FIXED_FILE_OFFSET

1.7.0

HIPFILE_STREAM_FIXED_FILE_OFFSET

7.2.0

CU_FILE_STREAM_FIXED_FILE_SIZE

1.7.0

HIPFILE_STREAM_FIXED_FILE_SIZE

7.2.0

CU_FILE_STREAM_PAGE_ALIGNED_INPUTS

1.7.0

HIPFILE_STREAM_PAGE_ALIGNED_INPUTS

7.2.0

CU_FILE_SUCCESS

1.0.0

hipFileSuccess

7.2.0

CU_FILE_USE_POLL_MODE

1.0.0

hipFileUsePollMode

7.2.0

CU_FILE_VIRTIOFS_SUPPORTED

1.16.0

CU_FILE_WEKAFS_SUPPORTED

1.0.0

hipFileWekaFSSupported

7.2.0

CUfileBatchHandle_t

1.2.0

hipFileBatchHandle_t

7.2.0

CUfileBatchMode_t

1.2.0

hipFileBatchMode_t

7.2.0

CUfileDescr_t

1.0.0

hipFileDescr_t

7.2.0

CUfileDriverControlFlags

1.0.0

hipFileDriverControlFlags_t

7.2.0

CUfileDriverControlFlags_t

1.0.0

hipFileDriverControlFlags_t

7.2.0

CUfileDriverStatusFlags_t

1.0.0

hipFileDriverStatusFlags_t

7.2.0

CUfileDrvProps

1.0.0

hipFileDriverProps_t

7.2.0

CUfileDrvProps_t

1.0.0

hipFileDriverProps_t

7.2.0

CUfileError_t

1.0.0

hipFileError_t

7.2.0

CUfileFSOps

1.0.0

hipFileFSOps_t

7.2.0

CUfileFSOps_t

1.0.0

hipFileFSOps_t

7.2.0

CUfileFeatureFlags

1.0.0

hipFileFeatureFlags_t

7.2.0

CUfileFeatureFlags_t

1.0.0

hipFileFeatureFlags_t

7.2.0

CUfileFileHandleType

1.0.0

hipFileFileHandleType

7.2.0

CUfileHandle_t

1.0.0

hipFileHandle_t

7.2.0

CUfileIOEvents

1.2.0

hipFileIOEvents_t

7.2.0

CUfileIOEvents_t

1.2.0

hipFileIOEvents_t

7.2.0

CUfileIOParams

1.2.0

hipFileIOParams_t

7.2.0

CUfileIOParams_t

1.2.0

hipFileIOParams_t

7.2.0

CUfileOpCounter

1.15.0

CUfileOpCounter_t

1.15.0

CUfileOpError

1.0.0

hipFileOpError_t

7.2.0

CUfileOpcode

1.0.0

hipFileDriverProps_t

7.2.0

CUfileOpcode_t

1.2.0

hipFileOpcode_t

7.2.0

CUfileP2PFlags

1.16.0

CUfileP2PFlags_t

1.16.0

CUfilePerGpuStats

1.15.0

CUfilePerGpuStats_t

1.15.0

CUfileStatsLevel1

1.15.0

CUfileStatsLevel1_t

1.15.0

CUfileStatsLevel2

1.15.0

CUfileStatsLevel2_t

1.15.0

CUfileStatsLevel3

1.15.0

CUfileStatsLevel3_t

1.15.0

CUfileStatus_t

1.2.0

hipFileStatus_t

7.2.0

IS_CUDA_ERR

1.0.0

IS_HIP_DRV_ERR

7.2.0

IS_CUFILE_ERR

1.0.0

IS_HIPFILE_ERR

7.2.0

cufileBatchMode

1.2.0

hipFileBatchMode_t

7.2.0

cufileRDMAInfo

1.0.0

hipFileRDMAInfo_t

7.2.0

cufileRDMAInfo_t

1.0.0

hipFileRDMAInfo_t

7.2.0

sockaddr_t

1.0.0

sockaddr

2. cuFile Functions#

CUDA

A

D

C

R

HIP

A

D

C

R

U

E

cuFileBatchIOCancel

1.2.0

hipFileBatchIOCancel

7.2.0

cuFileBatchIODestroy

1.2.0

hipFileBatchIODestroy

7.2.0

cuFileBatchIOGetStatus

1.2.0

hipFileBatchIOGetStatus

7.2.0

cuFileBatchIOSetUp

1.2.0

hipFileBatchIOSetUp

7.2.0

cuFileBatchIOSubmit

1.2.0

hipFileBatchIOSubmit

7.2.0

cuFileBufDeregister

1.0.0

hipFileBufDeregister

7.2.0

cuFileBufRegister

1.0.0

hipFileBufRegister

7.2.0

cuFileDriverClose

1.0.0

hipFileDriverClose

7.2.0

cuFileDriverClose_v2

1.4.0

hipFileDriverClose

7.2.0

cuFileDriverGetP2PFlags

1.15.0

cuFileDriverGetProperties

1.0.0

hipFileDriverGetProperties

7.2.0

cuFileDriverOpen

1.0.0

hipFileDriverOpen

7.2.0

cuFileDriverSetMaxCacheSize

1.0.0

hipFileDriverSetMaxCacheSize

7.2.0

cuFileDriverSetMaxDirectIOSize

1.0.0

hipFileDriverSetMaxDirectIOSize

7.2.0

cuFileDriverSetMaxPinnedMemSize

1.0.0

hipFileDriverSetMaxPinnedMemSize

7.2.0

cuFileDriverSetP2PFlags

1.15.0

cuFileDriverSetPollMode

1.0.0

hipFileDriverSetPollMode

7.2.0

cuFileExportPCIeTopology

1.17.0

cuFileGetBARSizeInKB

1.15.0

cuFileGetParameterBool

1.14.0

hipFileGetParameterBool

7.2.0

cuFileGetParameterGpuBounceBufferSlabArray

1.17.0

cuFileGetParameterMinMaxValue

1.15.0

cuFileGetParameterPosixPoolSlabArray

1.15.0

cuFileGetParameterSizeT

1.14.0

hipFileGetParameterSizeT

7.2.0

cuFileGetParameterString

1.14.0

hipFileGetParameterString

7.2.0

cuFileGetStatsL1

1.15.0

cuFileGetStatsL2

1.15.0

cuFileGetStatsL3

1.15.0

cuFileGetStatsLevel

1.15.0

cuFileGetVersion

1.8.0

cuFileHandleDeregister

1.0.0

hipFileHandleDeregister

7.2.0

cuFileHandleRegister

1.0.0

hipFileHandleRegister

7.2.0

cuFileRead

1.0.0

hipFileRead

7.2.0

cuFileReadAsync

1.7.0

hipFileReadAsync

7.2.0

cuFileSetParameterBool

1.14.0

hipFileSetParameterBool

7.2.0

cuFileSetParameterGpuBounceBufferSlabArray

1.17.0

cuFileSetParameterPosixPoolSlabArray

1.15.0

cuFileSetParameterSizeT

1.14.0

hipFileSetParameterSizeT

7.2.0

cuFileSetParameterString

1.14.0

hipFileSetParameterString

7.2.0

cuFileSetStatsLevel

1.15.0

cuFileStatsReset

1.15.0

cuFileStatsStart

1.15.0

cuFileStatsStop

1.15.0

cuFileStreamDeregister

1.7.0

hipFileStreamDeregister

7.2.0

cuFileStreamRegister

1.7.0

hipFileStreamRegister

7.2.0

cuFileUseCount

1.4.0

hipFileUseCount

7.2.0

cuFileWrite

1.0.0

hipFileWrite

7.2.0

cuFileWriteAsync

1.7.0

hipFileWriteAsync

7.2.0

cufileop_status_error

1.0.0

hipFileOpStatusError

7.2.0

Contents