tools/perf/Documentation/guest-files.txt

File Facts

System

Linux kernel

Corpus path

tools/perf/Documentation/guest-files.txt

Extension

.txt

Size

493 bytes

Lines

17

Domain

Support Tooling And Documentation

Bucket

tools

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

include::guestmount.txt[]

--guestkallsyms=<path>::
	Guest OS /proc/kallsyms file copy. perf reads it to get guest
	kernel symbols. Users copy it out from guest OS.

--guestmodules=<path>::
	Guest OS /proc/modules file copy. perf reads it to get guest
	kernel module information. Users copy it out from guest OS.

--guestvmlinux=<path>::
	Guest OS kernel vmlinux.

--guest-code::
	Indicate that guest code can be found in the hypervisor process,
	which is a common case for KVM test programs.

Annotation

• Atlas domain: Support Tooling And Documentation / tools.
• 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.