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
28 lines
1.4 KiB
ReStructuredText
28 lines
1.4 KiB
ReStructuredText
.. meta::
|
|
:description: hipFile driver reference counting
|
|
:keywords: hipFile, driver, lifecycle, reference counting, ROCm, GPU I/O
|
|
|
|
***************************
|
|
hipFile reference counting
|
|
***************************
|
|
|
|
The hipFile runtime, or driver, maintains the internal state for a hipFile process, including the backends, the registered files and buffers, and the internal maps that track those objects.
|
|
|
|
When the reference count is 0, the hipFile driver's internal state isn't initialized and any calls to ``hipFileRead()`` or ``hipFileWrite()`` will fail. The internal state is only initialized when the reference count increases to 1.
|
|
|
|
``hipFileHandleRegister()`` and ``hipFileBufRegister()`` increase the reference count to 1 if it was previously 0. ``hipFileDriverOpen()`` increments the reference count by 1 each time it's called.
|
|
|
|
hipFile clears its registered buffers and file handles when the process exits or the reference count drops to 0.
|
|
|
|
.. note::
|
|
|
|
The reference count can only be decremented through calls to ``hipFileDriverClose()``. Calls to ``hipFileHandleDeregister()`` and ``hipFileBufDeregister()`` don't decrement the reference count.
|
|
|
|
If the reference count drops to 0, the hipFile driver will be uninitialized and calls to ``hipFileRead()`` or ``hipFileWrite()`` will return an error. ``hipFileUseCount()`` can be used to get the current driver reference count.
|
|
|
|
|
|
|
|
|
|
|
|
|