tools/perf/util/mmap.h
Source file repositories/reference/linux-study-clean/tools/perf/util/mmap.h
File Facts
- System
- Linux kernel
- Corpus path
tools/perf/util/mmap.h- Extension
.h- Size
- 1490 bytes
- Lines
- 65
- 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
internal/mmap.hlinux/types.hlinux/bitops.hperf/cpumap.haio.hauxtrace.hutil/compress.h
Detected Declarations
struct aiocbstruct mmap_cpu_maskstruct mmapstruct mmap_params
Annotated Snippet
struct mmap_cpu_mask {
unsigned long *bits;
size_t nbits;
};
#define MMAP_CPU_MASK_BYTES(m) \
(BITS_TO_LONGS(((struct mmap_cpu_mask *)m)->nbits) * sizeof(unsigned long))
/**
* struct mmap - perf's ring buffer mmap details
*
* @refcnt - e.g. code using PERF_EVENT_IOC_SET_OUTPUT to share this
*/
struct mmap {
struct perf_mmap core;
struct auxtrace_mmap auxtrace_mmap;
#ifdef HAVE_AIO_SUPPORT
struct {
void **data;
struct aiocb *cblocks;
struct aiocb **aiocb;
int nr_cblocks;
} aio;
#endif
struct mmap_cpu_mask affinity_mask;
void *data;
struct perf_data_file *file;
struct zstd_data zstd_data;
};
struct mmap_params {
struct perf_mmap_param core;
int nr_cblocks, affinity, flush, comp_level;
struct auxtrace_mmap_params auxtrace_mp;
};
int mmap__mmap(struct mmap *map, struct mmap_params *mp, int fd, struct perf_cpu cpu);
void mmap__munmap(struct mmap *map);
union perf_event *perf_mmap__read_forward(struct mmap *map);
int perf_mmap__push(struct mmap *md, void *to,
int push(struct mmap *map, void *to, void *buf, size_t size));
size_t mmap__mmap_len(struct mmap *map);
void mmap_cpu_mask__scnprintf(struct mmap_cpu_mask *mask, const char *tag);
#endif /*__PERF_MMAP_H */
Annotation
- Immediate include surface: `internal/mmap.h`, `linux/types.h`, `linux/bitops.h`, `perf/cpumap.h`, `aio.h`, `auxtrace.h`, `util/compress.h`.
- Detected declarations: `struct aiocb`, `struct mmap_cpu_mask`, `struct mmap`, `struct mmap_params`.
- 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.