.. 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:`Check for fastpath compatibility <how-to/checking-system-compatibility>`
      * :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.