drivers/vfio/vfio_iommu_type1.c

File Facts

System

Linux kernel

Corpus path

drivers/vfio/vfio_iommu_type1.c

Extension

.c

Size

81252 bytes

Lines

3285

Domain

Driver Families

Bucket

drivers/vfio

Inferred role

Driver Families: exported/initcall integration point

Status

integration implementation candidate

Why This File Exists

Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.

• Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
• Exports symbols or registers init work; inspect boot/module ordering and who consumes the exported contract.
• Touches user memory; correctness depends on fault-safe copying and privilege boundary handling.
• Uses kernel synchronization; read lock ordering, sleepability, and interrupt context assumptions before translating.
• Touches IRQ or DMA behavior; this matters for the representative real-device path.
• Allocates kernel memory; connect allocation flags and lifetime to context constraints.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• linux/compat.h
• linux/device.h
• linux/fs.h
• linux/highmem.h
• linux/iommu.h
• linux/module.h
• linux/mm.h
• linux/kthread.h
• linux/rbtree.h
• linux/sched/signal.h
• linux/sched/mm.h
• linux/slab.h
• linux/uaccess.h
• linux/vfio.h
• linux/workqueue.h
• linux/mm_inline.h
• linux/overflow.h
• vfio.h

Detected Declarations

• struct vfio_iommu
• struct vfio_domain
• struct vfio_dma
• struct vfio_batch
• struct vfio_iommu_group
• struct vfio_iova
• struct vfio_pfn
• struct vfio_regions
• function vfio_link_dma
• function vfio_unlink_dma
• function vfio_dma_bitmap_alloc
• function vfio_dma_bitmap_free
• function vfio_dma_populate_bitmap
• function vfio_iommu_populate_bitmap_full
• function vfio_dma_bitmap_alloc_all
• function vfio_dma_bitmap_free_all
• function vfio_link_pfn
• function vfio_unlink_pfn
• function vfio_add_to_pfn_list
• function vfio_remove_from_pfn_list
• function vfio_iova_put_vfio_pfn
• function mm_lock_acct
• function vfio_lock_acct
• function is_invalid_reserved_pfn
• function put_pfn
• function __vfio_batch_init
• function vfio_batch_init
• function vfio_batch_init_single
• function vfio_batch_unpin
• function vfio_batch_fini
• function follow_fault_pfn
• function vaddr_get_pfns
• function vpfn_pages
• function vfio_pin_pages_remote
• function vaddr_get_pfns
• function put_valid_unreserved_pfns
• function vfio_unpin_pages_remote
• function vfio_pin_page_external
• function vfio_unpin_page_external
• function vfio_iommu_type1_pin_pages
• function vfio_iommu_type1_unpin_pages
• function vfio_sync_unpin
• function list_for_each_entry_safe
• function regions
• function unmap_unpin_slow
• function vfio_unmap_unpin
• function list_for_each_entry_continue
• function vfio_remove_dma

Annotated Snippet

module_init(vfio_iommu_type1_init);
module_exit(vfio_iommu_type1_cleanup);

MODULE_VERSION(DRIVER_VERSION);
MODULE_LICENSE("GPL v2");
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);

Annotation

• Immediate include surface: `linux/compat.h`, `linux/device.h`, `linux/fs.h`, `linux/highmem.h`, `linux/iommu.h`, `linux/module.h`, `linux/mm.h`, `linux/kthread.h`.
• Detected declarations: `struct vfio_iommu`, `struct vfio_domain`, `struct vfio_dma`, `struct vfio_batch`, `struct vfio_iommu_group`, `struct vfio_iova`, `struct vfio_pfn`, `struct vfio_regions`, `function vfio_link_dma`, `function vfio_unlink_dma`.
• Atlas domain: Driver Families / drivers/vfio.
• Implementation status: integration implementation candidate.
• This snippet crosses the user/kernel memory boundary; validate fault handling and access checks before translating the pattern.
• Synchronization appears in or near this file; preserve lock ordering, sleepability, and interrupt-context constraints.
• IRQ or DMA behavior appears here, which is relevant to the selected PCIe/NVMe device path.

Implementation Notes

• This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
• Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
• Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.