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
33 lines
1.3 KiB
ReStructuredText
33 lines
1.3 KiB
ReStructuredText
.. meta::
|
|
:description: Batch I/O API reference for hipFile, covering batch handle lifecycle, I/O parameter and event types, opcodes, and status codes.
|
|
:keywords: hipFile, batch, API, ROCm, GPU, I/O, hipFileBatchIOSetUp, hipFileBatchIOSubmit, hipFileBatchIOGetStatus, hipFileBatchIOCancel, hipFileBatchIODestroy
|
|
|
|
************************
|
|
Batch I/O API reference
|
|
************************
|
|
|
|
The hipFile batch I/O API lets you create batch contexts, submit multiple I/O
|
|
requests in a single call, poll for completion, cancel pending operations, and
|
|
tear down batch handles. All batch types and functions belong to the
|
|
``batch`` Doxygen group declared in ``hipfile.h``.
|
|
|
|
.. warning::
|
|
|
|
The batch API is not currently supported on the AMD backend.
|
|
``hipFileBatchIOGetStatus``, ``hipFileBatchIOCancel``, and
|
|
``hipFileBatchIODestroy`` are not implemented and return errors or perform
|
|
no operation. The maximum batch size is 128 operations.
|
|
|
|
For related API surfaces, see :doc:`/reference/api-synchronous-io`,
|
|
:doc:`/reference/api-async`, and :doc:`/reference/api-errors`.
|
|
|
|
Batch I/O types and functions
|
|
==============================
|
|
|
|
Enumerations, structures, and handles used by batch I/O operations, together
|
|
with the functions to create, submit, poll, cancel, and destroy batch I/O
|
|
contexts.
|
|
|
|
.. doxygengroup:: batch
|
|
:content-only:
|