xref: /kernel/linux/linux-6.6/tools/perf/util/cpumap.h (revision 62306a36)
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __PERF_CPUMAP_H
3#define __PERF_CPUMAP_H
4
5#include <stdbool.h>
6#include <stdio.h>
7#include <perf/cpumap.h>
8#include <linux/refcount.h>
9
10/** Identify where counts are aggregated, -1 implies not to aggregate. */
11struct aggr_cpu_id {
12	/** A value in the range 0 to number of threads. */
13	int thread_idx;
14	/** The numa node X as read from /sys/devices/system/node/nodeX. */
15	int node;
16	/**
17	 * The socket number as read from
18	 * /sys/devices/system/cpu/cpuX/topology/physical_package_id.
19	 */
20	int socket;
21	/** The die id as read from /sys/devices/system/cpu/cpuX/topology/die_id. */
22	int die;
23	/** The cache level as read from /sys/devices/system/cpu/cpuX/cache/indexY/level */
24	int cache_lvl;
25	/**
26	 * The cache instance ID, which is the first CPU in the
27	 * /sys/devices/system/cpu/cpuX/cache/indexY/shared_cpu_list
28	 */
29	int cache;
30	/** The core id as read from /sys/devices/system/cpu/cpuX/topology/core_id. */
31	int core;
32	/** CPU aggregation, note there is one CPU for each SMT thread. */
33	struct perf_cpu cpu;
34};
35
36/** A collection of aggr_cpu_id values, the "built" version is sorted and uniqued. */
37struct cpu_aggr_map {
38	refcount_t refcnt;
39	/** Number of valid entries. */
40	int nr;
41	/** The entries. */
42	struct aggr_cpu_id map[];
43};
44
45#define cpu_aggr_map__for_each_idx(idx, aggr_map)				\
46	for ((idx) = 0; (idx) < aggr_map->nr; (idx)++)
47
48struct perf_record_cpu_map_data;
49
50bool perf_record_cpu_map_data__test_bit(int i, const struct perf_record_cpu_map_data *data);
51
52struct perf_cpu_map *perf_cpu_map__empty_new(int nr);
53
54struct perf_cpu_map *cpu_map__new_data(const struct perf_record_cpu_map_data *data);
55size_t cpu_map__snprint(struct perf_cpu_map *map, char *buf, size_t size);
56size_t cpu_map__snprint_mask(struct perf_cpu_map *map, char *buf, size_t size);
57size_t cpu_map__fprintf(struct perf_cpu_map *map, FILE *fp);
58struct perf_cpu_map *cpu_map__online(void); /* thread unsafe */
59
60int cpu__setup_cpunode_map(void);
61
62int cpu__max_node(void);
63struct perf_cpu cpu__max_cpu(void);
64struct perf_cpu cpu__max_present_cpu(void);
65
66/**
67 * cpu_map__is_dummy - Events associated with a pid, rather than a CPU, use a single dummy map with an entry of -1.
68 */
69static inline bool cpu_map__is_dummy(const struct perf_cpu_map *cpus)
70{
71	return perf_cpu_map__nr(cpus) == 1 && perf_cpu_map__cpu(cpus, 0).cpu == -1;
72}
73
74/**
75 * cpu__get_node - Returns the numa node X as read from
76 * /sys/devices/system/node/nodeX for the given CPU.
77 */
78int cpu__get_node(struct perf_cpu cpu);
79/**
80 * cpu__get_socket_id - Returns the socket number as read from
81 * /sys/devices/system/cpu/cpuX/topology/physical_package_id for the given CPU.
82 */
83int cpu__get_socket_id(struct perf_cpu cpu);
84/**
85 * cpu__get_die_id - Returns the die id as read from
86 * /sys/devices/system/cpu/cpuX/topology/die_id for the given CPU.
87 */
88int cpu__get_die_id(struct perf_cpu cpu);
89/**
90 * cpu__get_core_id - Returns the core id as read from
91 * /sys/devices/system/cpu/cpuX/topology/core_id for the given CPU.
92 */
93int cpu__get_core_id(struct perf_cpu cpu);
94
95/**
96 * cpu_aggr_map__empty_new - Create a cpu_aggr_map of size nr with every entry
97 * being empty.
98 */
99struct cpu_aggr_map *cpu_aggr_map__empty_new(int nr);
100
101typedef struct aggr_cpu_id (*aggr_cpu_id_get_t)(struct perf_cpu cpu, void *data);
102
103/**
104 * cpu_aggr_map__new - Create a cpu_aggr_map with an aggr_cpu_id for each cpu in
105 * cpus. The aggr_cpu_id is created with 'get_id' that may have a data value
106 * passed to it. The cpu_aggr_map is sorted with duplicate values removed.
107 */
108struct cpu_aggr_map *cpu_aggr_map__new(const struct perf_cpu_map *cpus,
109				       aggr_cpu_id_get_t get_id,
110				       void *data, bool needs_sort);
111
112bool aggr_cpu_id__equal(const struct aggr_cpu_id *a, const struct aggr_cpu_id *b);
113bool aggr_cpu_id__is_empty(const struct aggr_cpu_id *a);
114struct aggr_cpu_id aggr_cpu_id__empty(void);
115
116
117/**
118 * aggr_cpu_id__socket - Create an aggr_cpu_id with the socket populated with
119 * the socket for cpu. The function signature is compatible with
120 * aggr_cpu_id_get_t.
121 */
122struct aggr_cpu_id aggr_cpu_id__socket(struct perf_cpu cpu, void *data);
123/**
124 * aggr_cpu_id__die - Create an aggr_cpu_id with the die and socket populated
125 * with the die and socket for cpu. The function signature is compatible with
126 * aggr_cpu_id_get_t.
127 */
128struct aggr_cpu_id aggr_cpu_id__die(struct perf_cpu cpu, void *data);
129/**
130 * aggr_cpu_id__core - Create an aggr_cpu_id with the core, die and socket
131 * populated with the core, die and socket for cpu. The function signature is
132 * compatible with aggr_cpu_id_get_t.
133 */
134struct aggr_cpu_id aggr_cpu_id__core(struct perf_cpu cpu, void *data);
135/**
136 * aggr_cpu_id__core - Create an aggr_cpu_id with the cpu, core, die and socket
137 * populated with the cpu, core, die and socket for cpu. The function signature
138 * is compatible with aggr_cpu_id_get_t.
139 */
140struct aggr_cpu_id aggr_cpu_id__cpu(struct perf_cpu cpu, void *data);
141/**
142 * aggr_cpu_id__node - Create an aggr_cpu_id with the numa node populated for
143 * cpu. The function signature is compatible with aggr_cpu_id_get_t.
144 */
145struct aggr_cpu_id aggr_cpu_id__node(struct perf_cpu cpu, void *data);
146/**
147 * aggr_cpu_id__global - Create an aggr_cpu_id for global aggregation.
148 * The function signature is compatible with aggr_cpu_id_get_t.
149 */
150struct aggr_cpu_id aggr_cpu_id__global(struct perf_cpu cpu, void *data);
151#endif /* __PERF_CPUMAP_H */
152