tools/lib/perf/include/perf/mmap.h

File Facts

System

Linux kernel

Corpus path

tools/lib/perf/include/perf/mmap.h

Extension

.h

Size

441 bytes

Lines

16

Domain

Support Tooling And Documentation

Bucket

tools

Inferred role

Support Tooling And Documentation: implementation source

Status

source implementation candidate

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.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• perf/core.h

Detected Declarations

• struct perf_mmap

Annotated Snippet

#ifndef __LIBPERF_MMAP_H
#define __LIBPERF_MMAP_H

#include <perf/core.h>

struct perf_mmap;
union perf_event;

LIBPERF_API void perf_mmap__consume(struct perf_mmap *map);
LIBPERF_API int perf_mmap__read_init(struct perf_mmap *map);
LIBPERF_API void perf_mmap__read_done(struct perf_mmap *map);
LIBPERF_API union perf_event *perf_mmap__read_event(struct perf_mmap *map);

#endif /* __LIBPERF_MMAP_H */

Annotation

• Immediate include surface: `perf/core.h`.
• Detected declarations: `struct perf_mmap`.
• Atlas domain: Support Tooling And Documentation / tools.
• Implementation status: source implementation candidate.

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.