derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
61 lines
2.8 KiB
ReStructuredText
61 lines
2.8 KiB
ReStructuredText
.. Generated by ROCm docgen prompt_version=2026-06-02-v15-wiki-pm-exclusion-and-install-fix at 2026-06-03T04:15:01Z
|
|
|
|
.. meta::
|
|
:description: hipFile documentation.
|
|
:keywords: hipFile, AMD, ROCm, GPU
|
|
|
|
**********************
|
|
hipFile documentation
|
|
**********************
|
|
|
|
hipFile is AMD's Infinity Storage library that provides direct-to-GPU I/O without requiring a host-side buffer. The library provides C and Python APIs for synchronous, asynchronous, and batch I/O operations. hipFile automatically falls back to POSIX I/O when operations are unable to use the direct-to-GPU path.
|
|
|
|
hipFile is delivered as part of `TheRock <https://github.com/ROCm/TheRock>`_. The hipFile source code is located at https://github.com/ROCm/rocm-systems/tree/develop/projects/hipfile.
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Install
|
|
|
|
* :doc:`Install hipFile <install/install>`
|
|
* :doc:`Build hipFile from source <install/build-from-source>`
|
|
* :doc:`Install the hipFile Python bindings <install/python-bindings>`
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: How to
|
|
|
|
* :doc:`Set up a local NVMe drive <how-to/setup-local-nvme>`
|
|
* :doc:`Set up an NVMe-oF disk <how-to/setup-nvmeof>`
|
|
* :doc:`Set up an NFSoRDMA share <how-to/setup-nfsordma>`
|
|
* :doc:`Register a file and GPU buffer for GPU I/O <how-to/register-file-and-buffer>`
|
|
* :doc:`Benchmark hipFile with fio <how-to/use-with-fio>`
|
|
* :doc:`Use the hipFile Python API <how-to/use-python-api>`
|
|
|
|
.. grid-item-card:: Tutorials
|
|
|
|
* :doc:`Copy a file via GPU memory using hipFile <tutorials/copy-a-file>`
|
|
* :doc:`Async multistream I/O <tutorials/async-multistream-io>`
|
|
* :doc:`Query the hipFile version <tutorials/get-version>`
|
|
* :doc:`Perform GPU I/O with the Python bindings <tutorials/python-gpu-io>`
|
|
|
|
.. grid-item-card:: Reference
|
|
|
|
* :doc:`hipFile fastpath and fallback backends <reference/hipFile-io-backends>`
|
|
* :doc:`hipFile file registration <reference/hipFile-file-registration>`
|
|
* :doc:`hipFile buffer registration <reference/hipFile-buffer-registration>`
|
|
* :doc:`hipFile reference counting <reference/hipFile-reference-count>`
|
|
* :doc:`hipFile ais-stats tool <reference/hipFile-ais-stats-tool>`
|
|
* :doc:`hipFile environment variables <reference/hipFile-environment-variables>`
|
|
* :doc:`cuFile compatibility <reference/hipFile-cuFile-compatibility>`
|
|
* :doc:`hipFile API reference <reference/hipFile-api-reference>`
|
|
|
|
.. grid-item-card:: Troubleshooting
|
|
|
|
* :doc:`Troubleshooting <troubleshooting/troubleshooting>`
|
|
* :doc:`Known issues <troubleshooting/known-issues>`
|
|
* :doc:`Limitations <troubleshooting/limitations>`
|
|
|
|
Licensing information is in the `LICENSE.md <https://github.com/ROCm/rocm-systems/blob/develop/projects/hipfile/LICENSE.md>`_ file in the repository.
|