[thirdparty/kernel/linux.git] / tools / perf / util / env.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __PERF_ENV_H
#define __PERF_ENV_H

#include <linux/types.h>
#include <linux/rbtree.h>
#include "cpumap.h"
#include "rwsem.h"

struct perf_cpu_map;

struct cpu_topology_map {
	int	socket_id;
	int	die_id;
	int	cluster_id;
	int	core_id;
};

struct cpu_cache_level {
	u32	level;
	u32	line_size;
	u32	sets;
	u32	ways;
	char	*type;
	char	*size;
	char	*map;
};

struct numa_node {
	u32		 node;
	u64		 mem_total;
	u64		 mem_free;
	struct perf_cpu_map	*map;
};

struct memory_node {
	u64		 node;
	u64		 size;
	unsigned long	*set;
};

struct hybrid_node {
	char	*pmu_name;
	char	*cpus;
};

struct pmu_caps {
	int		nr_caps;
	unsigned int    max_branches;
	unsigned int	br_cntr_nr;
	unsigned int	br_cntr_width;

	char            **caps;
	char            *pmu_name;
};

typedef const char *(arch_syscalls__strerrno_t)(int err);

struct perf_env {
	char			*hostname;
	char			*os_release;
	char			*version;
	char			*arch;
	int			nr_cpus_online;
	int			nr_cpus_avail;
	char			*cpu_desc;
	char			*cpuid;
	unsigned long long	total_mem;
	unsigned int		msr_pmu_type;
	unsigned int		max_branches;
	unsigned int		br_cntr_nr;
	unsigned int		br_cntr_width;
	int			kernel_is_64_bit;

	int			nr_cmdline;
	int			nr_sibling_cores;
	int			nr_sibling_dies;
	int			nr_sibling_threads;
	int			nr_numa_nodes;
	int			nr_memory_nodes;
	int			nr_pmu_mappings;
	int			nr_groups;
	int			nr_cpu_pmu_caps;
	int			nr_hybrid_nodes;
	int			nr_pmus_with_caps;
	char			*cmdline;
	const char		**cmdline_argv;
	char			*sibling_cores;
	char			*sibling_dies;
	char			*sibling_threads;
	char			*pmu_mappings;
	char			**cpu_pmu_caps;
	struct cpu_topology_map	*cpu;
	struct cpu_cache_level	*caches;
	int			 caches_cnt;
	u32			comp_ratio;
	u32			comp_ver;
	u32			comp_type;
	u32			comp_level;
	u32			comp_mmap_len;
	struct numa_node	*numa_nodes;
	struct memory_node	*memory_nodes;
	unsigned long long	 memory_bsize;
	struct hybrid_node	*hybrid_nodes;
	struct pmu_caps		*pmu_caps;
#ifdef HAVE_LIBBPF_SUPPORT
	/*
	 * bpf_info_lock protects bpf rbtrees. This is needed because the
	 * trees are accessed by different threads in perf-top
	 */
	struct {
		struct rw_semaphore	lock;
		struct rb_root		infos;
		u32			infos_cnt;
		struct rb_root		btfs;
		u32			btfs_cnt;
	} bpf_progs;
#endif // HAVE_LIBBPF_SUPPORT
	/* same reason as above (for perf-top) */
	struct {
		struct rw_semaphore	lock;
		struct rb_root		tree;
	} cgroups;

	/* For fast cpu to numa node lookup via perf_env__numa_node */
	int			*numa_map;
	int			 nr_numa_map;

	/* For real clock time reference. */
	struct {
		u64	tod_ns;
		u64	clockid_ns;
		u64     clockid_res_ns;
		int	clockid;
		/*
		 * enabled is valid for report mode, and is true if above
		 * values are set, it's set in process_clock_data
		 */
		bool	enabled;
	} clock;
	arch_syscalls__strerrno_t *arch_strerrno;
};

enum perf_compress_type {
	PERF_COMP_NONE = 0,
	PERF_COMP_ZSTD,
	PERF_COMP_MAX
};

struct bpf_prog_info_node;
struct btf_node;

extern struct perf_env perf_env;

void perf_env__exit(struct perf_env *env);

int perf_env__kernel_is_64_bit(struct perf_env *env);

int perf_env__set_cmdline(struct perf_env *env, int argc, const char *argv[]);

int perf_env__read_cpuid(struct perf_env *env);
int perf_env__read_pmu_mappings(struct perf_env *env);
int perf_env__nr_pmu_mappings(struct perf_env *env);
const char *perf_env__pmu_mappings(struct perf_env *env);

int perf_env__read_cpu_topology_map(struct perf_env *env);

void cpu_cache_level__free(struct cpu_cache_level *cache);

const char *perf_env__arch(struct perf_env *env);
const char *perf_env__arch_strerrno(struct perf_env *env, int err);
const char *perf_env__cpuid(struct perf_env *env);
const char *perf_env__raw_arch(struct perf_env *env);
int perf_env__nr_cpus_avail(struct perf_env *env);

void perf_env__init(struct perf_env *env);
bool __perf_env__insert_bpf_prog_info(struct perf_env *env,
				      struct bpf_prog_info_node *info_node);
bool perf_env__insert_bpf_prog_info(struct perf_env *env,
				    struct bpf_prog_info_node *info_node);
struct bpf_prog_info_node *perf_env__find_bpf_prog_info(struct perf_env *env,
							__u32 prog_id);
bool perf_env__insert_btf(struct perf_env *env, struct btf_node *btf_node);
bool __perf_env__insert_btf(struct perf_env *env, struct btf_node *btf_node);
struct btf_node *perf_env__find_btf(struct perf_env *env, __u32 btf_id);
struct btf_node *__perf_env__find_btf(struct perf_env *env, __u32 btf_id);

int perf_env__numa_node(struct perf_env *env, struct perf_cpu cpu);
char *perf_env__find_pmu_cap(struct perf_env *env, const char *pmu_name,
			     const char *cap);

bool perf_env__has_pmu_mapping(struct perf_env *env, const char *pmu_name);
void perf_env__find_br_cntr_info(struct perf_env *env,
				 unsigned int *nr,
				 unsigned int *width);

bool x86__is_amd_cpu(void);
bool perf_env__is_x86_amd_cpu(struct perf_env *env);

#endif /* __PERF_ENV_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
f0ce888c ACM	2	#ifndef __PERF_ENV_H
	3	#define __PERF_ENV_H
	4
720e98b5	5	#include <linux/types.h>
e4378f0c	6	#include <linux/rbtree.h>
6d18804b	7	#include "cpumap.h"
e4378f0c	8	#include "rwsem.h"
720e98b5	9
87ffb6c6 ACM	10	struct perf_cpu_map;
87ffb6c6 ACM	11
f0ce888c ACM	12	struct cpu_topology_map {
f0ce888c ACM	13	int socket_id;
acae8b36	14	int die_id;
cbc917a1	15	int cluster_id;
f0ce888c ACM	16	int core_id;
	17	};
	18
720e98b5 JO	19	struct cpu_cache_level {
	20	u32 level;
	21	u32 line_size;
	22	u32 sets;
	23	u32 ways;
	24	char *type;
	25	char *size;
	26	char *map;
	27	};
	28
c60da22a JO	29	struct numa_node {
	30	u32 node;
	31	u64 mem_total;
	32	u64 mem_free;
f854839b	33	struct perf_cpu_map *map;
c60da22a JO	34	};
c60da22a JO	35
e2091ced JO	36	struct memory_node {
	37	u64 node;
	38	u64 size;
	39	unsigned long *set;
	40	};
	41
f7d74ce3 JY	42	struct hybrid_node {
	43	char *pmu_name;
	44	char *cpus;
	45	};
	46
2139f742 RB	47	struct pmu_caps {
2139f742 RB	48	int nr_caps;
e119083b	49	unsigned int max_branches;
ac9cd724 KL	50	unsigned int br_cntr_nr;
	51	unsigned int br_cntr_width;
	52
2139f742	53	char **caps;
e119083b JY	54	char *pmu_name;
	55	};
	56
4acef676 ACM	57	typedef const char *(arch_syscalls__strerrno_t)(int err);
4acef676 ACM	58
f0ce888c ACM	59	struct perf_env {
	60	char *hostname;
	61	char *os_release;
	62	char *version;
	63	char *arch;
	64	int nr_cpus_online;
	65	int nr_cpus_avail;
	66	char *cpu_desc;
	67	char *cpuid;
	68	unsigned long long total_mem;
e0838e02	69	unsigned int msr_pmu_type;
6f91ea28	70	unsigned int max_branches;
ac9cd724 KL	71	unsigned int br_cntr_nr;
ac9cd724 KL	72	unsigned int br_cntr_width;
7c0223e1	73	int kernel_is_64_bit;
f0ce888c ACM	74
	75	int nr_cmdline;
	76	int nr_sibling_cores;
acae8b36	77	int nr_sibling_dies;
f0ce888c ACM	78	int nr_sibling_threads;
f0ce888c ACM	79	int nr_numa_nodes;
e2091ced	80	int nr_memory_nodes;
f0ce888c ACM	81	int nr_pmu_mappings;
f0ce888c ACM	82	int nr_groups;
6f91ea28	83	int nr_cpu_pmu_caps;
f7d74ce3	84	int nr_hybrid_nodes;
2139f742	85	int nr_pmus_with_caps;
f0ce888c ACM	86	char *cmdline;
	87	const char **cmdline_argv;
	88	char *sibling_cores;
acae8b36	89	char *sibling_dies;
f0ce888c	90	char *sibling_threads;
f0ce888c	91	char *pmu_mappings;
ff34eaa8	92	char **cpu_pmu_caps;
f0ce888c	93	struct cpu_topology_map *cpu;
720e98b5 JO	94	struct cpu_cache_level *caches;
720e98b5 JO	95	int caches_cnt;
d3c8c08e	96	u32 comp_ratio;
42e1fd80 AB	97	u32 comp_ver;
	98	u32 comp_type;
	99	u32 comp_level;
	100	u32 comp_mmap_len;
c60da22a	101	struct numa_node *numa_nodes;
e2091ced JO	102	struct memory_node *memory_nodes;
e2091ced JO	103	unsigned long long memory_bsize;
f7d74ce3	104	struct hybrid_node *hybrid_nodes;
2139f742	105	struct pmu_caps *pmu_caps;
ef0580ec	106	#ifdef HAVE_LIBBPF_SUPPORT
e4378f0c SL	107	/*
	108	* bpf_info_lock protects bpf rbtrees. This is needed because the
	109	* trees are accessed by different threads in perf-top
	110	*/
	111	struct {
	112	struct rw_semaphore lock;
	113	struct rb_root infos;
	114	u32 infos_cnt;
3792cb2f SL	115	struct rb_root btfs;
3792cb2f SL	116	u32 btfs_cnt;
e4378f0c	117	} bpf_progs;
ef0580ec	118	#endif // HAVE_LIBBPF_SUPPORT
d1277aa3 NK	119	/* same reason as above (for perf-top) */
	120	struct {
	121	struct rw_semaphore lock;
	122	struct rb_root tree;
	123	} cgroups;
	124
389799a7 JO	125	/* For fast cpu to numa node lookup via perf_env__numa_node */
	126	int *numa_map;
	127	int nr_numa_map;
d1e325cf JO	128
	129	/* For real clock time reference. */
	130	struct {
	131	u64 tod_ns;
	132	u64 clockid_ns;
9d88a1a1	133	u64 clockid_res_ns;
d1e325cf JO	134	int clockid;
	135	/*
	136	* enabled is valid for report mode, and is true if above
	137	* values are set, it's set in process_clock_data
	138	*/
	139	bool enabled;
	140	} clock;
4acef676	141	arch_syscalls__strerrno_t *arch_strerrno;
f0ce888c ACM	142	};
f0ce888c ACM	143
42e1fd80 AB	144	enum perf_compress_type {
	145	PERF_COMP_NONE = 0,
	146	PERF_COMP_ZSTD,
	147	PERF_COMP_MAX
	148	};
	149
e4378f0c	150	struct bpf_prog_info_node;
3792cb2f	151	struct btf_node;
e4378f0c	152
b6998692 ACM	153	extern struct perf_env perf_env;
b6998692 ACM	154
f0ce888c ACM	155	void perf_env__exit(struct perf_env *env);
f0ce888c ACM	156
7c0223e1 LY	157	int perf_env__kernel_is_64_bit(struct perf_env *env);
7c0223e1 LY	158
b6998692 ACM	159	int perf_env__set_cmdline(struct perf_env env, int argc, const char argv[]);
b6998692 ACM	160
f1cedfb8	161	int perf_env__read_cpuid(struct perf_env *env);
9fe8895a KP	162	int perf_env__read_pmu_mappings(struct perf_env *env);
	163	int perf_env__nr_pmu_mappings(struct perf_env *env);
	164	const char perf_env__pmu_mappings(struct perf_env env);
	165
aa36ddd7 ACM	166	int perf_env__read_cpu_topology_map(struct perf_env *env);
aa36ddd7 ACM	167
720e98b5	168	void cpu_cache_level__free(struct cpu_cache_level *cache);
4e8fbc1c ACM	169
4e8fbc1c ACM	170	const char perf_env__arch(struct perf_env env);
54373b5d	171	const char perf_env__arch_strerrno(struct perf_env env, int err);
9fe8895a	172	const char perf_env__cpuid(struct perf_env env);
dbbd34a6	173	const char perf_env__raw_arch(struct perf_env env);
9cecca32	174	int perf_env__nr_cpus_avail(struct perf_env *env);
dbbd34a6	175
e4378f0c	176	void perf_env__init(struct perf_env *env);
a7da6c70	177	bool __perf_env__insert_bpf_prog_info(struct perf_env *env,
9c51f878	178	struct bpf_prog_info_node *info_node);
03edb702	179	bool perf_env__insert_bpf_prog_info(struct perf_env *env,
e4378f0c SL	180	struct bpf_prog_info_node *info_node);
	181	struct bpf_prog_info_node perf_env__find_bpf_prog_info(struct perf_env env,
	182	__u32 prog_id);
4924b1f7	183	bool perf_env__insert_btf(struct perf_env env, struct btf_node btf_node);
9c51f878	184	bool __perf_env__insert_btf(struct perf_env env, struct btf_node btf_node);
3792cb2f	185	struct btf_node perf_env__find_btf(struct perf_env env, __u32 btf_id);
9c51f878	186	struct btf_node __perf_env__find_btf(struct perf_env env, __u32 btf_id);
389799a7	187
6d18804b	188	int perf_env__numa_node(struct perf_env *env, struct perf_cpu cpu);
2139f742 RB	189	char perf_env__find_pmu_cap(struct perf_env env, const char *pmu_name,
2139f742 RB	190	const char *cap);
dd678532 ACM	191
dd678532 ACM	192	bool perf_env__has_pmu_mapping(struct perf_env env, const char pmu_name);
edf3ce0e KL	193	void perf_env__find_br_cntr_info(struct perf_env *env,
	194	unsigned int *nr,
	195	unsigned int *width);
28398ce1 NK	196
	197	bool x86__is_amd_cpu(void);
	198	bool perf_env__is_x86_amd_cpu(struct perf_env *env);
	199
f0ce888c	200	#endif /* __PERF_ENV_H */