1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __LIBPERF_CPUMAP_H 3 #define __LIBPERF_CPUMAP_H 4 5 #include <perf/core.h> 6 #include <stdbool.h> 7 #include <stdint.h> 8 9 /** A wrapper around a CPU to avoid confusion with the perf_cpu_map's map's indices. */ 10 struct perf_cpu { 11 int16_t cpu; 12 }; 13 14 struct perf_cache { 15 int cache_lvl; 16 int cache; 17 }; 18 19 struct perf_cpu_map; 20 21 /** 22 * perf_cpu_map__new_any_cpu - a map with a singular "any CPU"/dummy -1 value. 23 */ 24 LIBPERF_API struct perf_cpu_map *perf_cpu_map__new_any_cpu(void); 25 /** 26 * perf_cpu_map__new_online_cpus - a map read from 27 * /sys/devices/system/cpu/online if 28 * available. If reading wasn't possible a map 29 * is created using the online processors 30 * assuming the first 'n' processors are all 31 * online. 32 */ 33 LIBPERF_API struct perf_cpu_map *perf_cpu_map__new_online_cpus(void); 34 /** 35 * perf_cpu_map__new - create a map from the given cpu_list such as "0-7". If no 36 * cpu_list argument is provided then 37 * perf_cpu_map__new_online_cpus is returned. 38 */ 39 LIBPERF_API struct perf_cpu_map *perf_cpu_map__new(const char *cpu_list); 40 /** perf_cpu_map__new_int - create a map with the one given cpu. */ 41 LIBPERF_API struct perf_cpu_map *perf_cpu_map__new_int(int cpu); 42 LIBPERF_API struct perf_cpu_map *perf_cpu_map__get(struct perf_cpu_map *map); 43 LIBPERF_API int perf_cpu_map__merge(struct perf_cpu_map **orig, 44 struct perf_cpu_map *other); 45 LIBPERF_API struct perf_cpu_map *perf_cpu_map__intersect(struct perf_cpu_map *orig, 46 struct perf_cpu_map *other); 47 LIBPERF_API void perf_cpu_map__put(struct perf_cpu_map *map); 48 /** 49 * perf_cpu_map__cpu - get the CPU value at the given index. Returns -1 if index 50 * is invalid. 51 */ 52 LIBPERF_API struct perf_cpu perf_cpu_map__cpu(const struct perf_cpu_map *cpus, int idx); 53 /** 54 * perf_cpu_map__nr - for an empty map returns 1, as perf_cpu_map__cpu returns a 55 * cpu of -1 for an invalid index, this makes an empty map 56 * look like it contains the "any CPU"/dummy value. Otherwise 57 * the result is the number CPUs in the map plus one if the 58 * "any CPU"/dummy value is present. 59 */ 60 LIBPERF_API int perf_cpu_map__nr(const struct perf_cpu_map *cpus); 61 /** 62 * perf_cpu_map__has_any_cpu_or_is_empty - is map either empty or has the "any CPU"/dummy value. 63 */ 64 LIBPERF_API bool perf_cpu_map__has_any_cpu_or_is_empty(const struct perf_cpu_map *map); 65 /** 66 * perf_cpu_map__is_any_cpu_or_is_empty - is map either empty or the "any CPU"/dummy value. 67 */ 68 LIBPERF_API bool perf_cpu_map__is_any_cpu_or_is_empty(const struct perf_cpu_map *map); 69 /** 70 * perf_cpu_map__is_empty - does the map contain no values and it doesn't 71 * contain the special "any CPU"/dummy value. 72 */ 73 LIBPERF_API bool perf_cpu_map__is_empty(const struct perf_cpu_map *map); 74 /** 75 * perf_cpu_map__min - the minimum CPU value or -1 if empty or just the "any CPU"/dummy value. 76 */ 77 LIBPERF_API struct perf_cpu perf_cpu_map__min(const struct perf_cpu_map *map); 78 /** 79 * perf_cpu_map__max - the maximum CPU value or -1 if empty or just the "any CPU"/dummy value. 80 */ 81 LIBPERF_API struct perf_cpu perf_cpu_map__max(const struct perf_cpu_map *map); 82 LIBPERF_API bool perf_cpu_map__has(const struct perf_cpu_map *map, struct perf_cpu cpu); 83 LIBPERF_API bool perf_cpu_map__equal(const struct perf_cpu_map *lhs, 84 const struct perf_cpu_map *rhs); 85 /** 86 * perf_cpu_map__any_cpu - Does the map contain the "any CPU"/dummy -1 value? 87 */ 88 LIBPERF_API bool perf_cpu_map__has_any_cpu(const struct perf_cpu_map *map); 89 90 #define perf_cpu_map__for_each_cpu(cpu, idx, cpus) \ 91 for ((idx) = 0, (cpu) = perf_cpu_map__cpu(cpus, idx); \ 92 (idx) < perf_cpu_map__nr(cpus); \ 93 (idx)++, (cpu) = perf_cpu_map__cpu(cpus, idx)) 94 95 #define perf_cpu_map__for_each_cpu_skip_any(_cpu, idx, cpus) \ 96 for ((idx) = 0, (_cpu) = perf_cpu_map__cpu(cpus, idx); \ 97 (idx) < perf_cpu_map__nr(cpus); \ 98 (idx)++, (_cpu) = perf_cpu_map__cpu(cpus, idx)) \ 99 if ((_cpu).cpu != -1) 100 101 #define perf_cpu_map__for_each_idx(idx, cpus) \ 102 for ((idx) = 0; (idx) < perf_cpu_map__nr(cpus); (idx)++) 103 104 #endif /* __LIBPERF_CPUMAP_H */ 105