tools/perf/util/iostat.h

File Facts

System

Linux kernel

Corpus path

tools/perf/util/iostat.h

Extension

.h

Size

1399 bytes

Lines

48

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

• subcmd/parse-options.h
• util/stat.h
• util/parse-events.h
• util/evlist.h

Detected Declarations

• struct option
• struct perf_stat_config
• struct evlist
• struct timespec
• enum iostat_mode_t

Annotated Snippet

#ifndef _IOSTAT_H
#define _IOSTAT_H

#include <subcmd/parse-options.h>
#include "util/stat.h"
#include "util/parse-events.h"
#include "util/evlist.h"

struct option;
struct perf_stat_config;
struct evlist;
struct timespec;

enum iostat_mode_t {
	IOSTAT_NONE		= -1,
	IOSTAT_RUN		= 0,
	IOSTAT_LIST		= 1
};

extern enum iostat_mode_t iostat_mode;

typedef void (*iostat_print_counter_t)(struct perf_stat_config *, struct evsel *, void *);

int iostat_prepare(struct evlist *evlist, struct perf_stat_config *config);
int iostat_parse(const struct option *opt, const char *str,
		 int unset __maybe_unused);
void iostat_list(struct evlist *evlist, struct perf_stat_config *config);
void iostat_release(struct evlist *evlist);
void iostat_prefix(struct evlist *evlist, struct perf_stat_config *config,
		   char *prefix, struct timespec *ts);
void iostat_print_header_prefix(struct perf_stat_config *config);
void iostat_print_metric(struct perf_stat_config *config, struct evsel *evsel,
			 struct perf_stat_output_ctx *out);
void iostat_print_counters(struct evlist *evlist,
			   struct perf_stat_config *config, struct timespec *ts,
			   char *prefix, iostat_print_counter_t print_cnt_cb, void *arg);

#endif /* _IOSTAT_H */

Annotation

• Immediate include surface: `subcmd/parse-options.h`, `util/stat.h`, `util/parse-events.h`, `util/evlist.h`.
• Detected declarations: `struct option`, `struct perf_stat_config`, `struct evlist`, `struct timespec`, `enum iostat_mode_t`.
• 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.