Documentation/devicetree/bindings/reserved-memory/xen,shared-memory.txt

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/reserved-memory/xen,shared-memory.txt

File Facts

System: Linux kernel
Corpus path: Documentation/devicetree/bindings/reserved-memory/xen,shared-memory.txt
Extension: .txt
Size: 850 bytes
Lines: 25
Domain: Support Tooling And Documentation
Bucket: Documentation
Inferred role: Support Tooling And Documentation: documentation
Status: atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

No C-style include directives detected by the generator.

Detected Declarations

No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

Expose one or more memory regions as reserved-memory to the guest
virtual machine. Typically, a region is configured at VM creation time
to be a shared memory area across multiple virtual machines for
communication among them.

For each of these pre-shared memory regions, a range is exposed under
the /reserved-memory node as a child node. Each range sub-node is named
xen-shmem@<address> and has the following properties:

- compatible:
	compatible = "xen,shared-memory-v1"

- reg:
	the base guest physical address and size of the shared memory region

- xen,offset: (borrower VMs only)
	64 bit integer offset within the owner virtual machine's shared
	memory region used for the mapping in the borrower VM.

- xen,id:
	a string that identifies the shared memory region as specified in
	the VM config file

Annotation

Atlas domain: Support Tooling And Documentation / Documentation.
Implementation status: atlas-only.

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.