xref: /linux/tools/perf/util/util.h (revision e53524cdcc02d089e757b668da031ba06ff665c3)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_UTIL_H
3 #define __PERF_UTIL_H
4 
5 #define _BSD_SOURCE 1
6 /* glibc 2.20 deprecates _BSD_SOURCE in favour of _DEFAULT_SOURCE */
7 #define _DEFAULT_SOURCE 1
8 
9 #include <fcntl.h>
10 #include <stdbool.h>
11 #include <stddef.h>
12 #include <linux/compiler.h>
13 #include <sys/types.h>
14 #ifndef __cplusplus
15 #include <internal/cpumap.h>
16 #endif
17 
18 extern const char perf_usage_string[];
19 extern const char perf_more_info_string[];
20 
21 extern const char *input_name;
22 
23 extern bool perf_host;
24 extern bool perf_guest;
25 
26 /* General helper functions */
27 void usage(const char *err) __noreturn;
28 void die(const char *err, ...) __noreturn __printf(1, 2);
29 
30 struct dirent;
31 struct strlist;
32 
33 int mkdir_p(char *path, mode_t mode);
34 int rm_rf(const char *path);
35 int rm_rf_perf_data(const char *path);
36 struct strlist *lsdir(const char *name, bool (*filter)(const char *, struct dirent *));
37 bool lsdir_no_dot_filter(const char *name, struct dirent *d);
38 
39 size_t hex_width(u64 v);
40 
41 int sysctl__max_stack(void);
42 
43 bool sysctl__nmi_watchdog_enabled(void);
44 
45 int fetch_kernel_version(unsigned int *puint,
46 			 char *str, size_t str_sz);
47 #define KVER_VERSION(x)		(((x) >> 16) & 0xff)
48 #define KVER_PATCHLEVEL(x)	(((x) >> 8) & 0xff)
49 #define KVER_SUBLEVEL(x)	((x) & 0xff)
50 #define KVER_FMT	"%d.%d.%d"
51 #define KVER_PARAM(x)	KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)
52 
53 int perf_tip(char **strp, const char *dirpath);
54 
55 #ifndef HAVE_SCHED_GETCPU_SUPPORT
56 int sched_getcpu(void);
57 #endif
58 
59 extern bool perf_singlethreaded;
60 
61 void perf_set_singlethreaded(void);
62 void perf_set_multithreaded(void);
63 
64 char *perf_exe(char *buf, int len);
65 
66 #ifndef O_CLOEXEC
67 #ifdef __sparc__
68 #define O_CLOEXEC      0x400000
69 #elif defined(__alpha__) || defined(__hppa__)
70 #define O_CLOEXEC      010000000
71 #else
72 #define O_CLOEXEC      02000000
73 #endif
74 #endif
75 
76 extern bool test_attr__enabled;
77 void test_attr__ready(void);
78 void test_attr__init(void);
79 struct perf_event_attr;
80 void test_attr__open(struct perf_event_attr *attr, pid_t pid, struct perf_cpu cpu,
81 		     int fd, int group_fd, unsigned long flags);
82 
83 struct perf_debuginfod {
84 	const char	*urls;
85 	bool		 set;
86 };
87 void perf_debuginfod_setup(struct perf_debuginfod *di);
88 
89 char *filename_with_chroot(int pid, const char *filename);
90 
91 int do_realloc_array_as_needed(void **arr, size_t *arr_sz, size_t x,
92 			       size_t msz, const void *init_val);
93 
94 #define realloc_array_as_needed(a, n, x, v) ({			\
95 	typeof(x) __x = (x);					\
96 	__x >= (n) ?						\
97 		do_realloc_array_as_needed((void **)&(a),	\
98 					   &(n),		\
99 					   __x,			\
100 					   sizeof(*(a)),	\
101 					   (const void *)(v)) :	\
102 		0;						\
103 	})
104 
105 static inline bool host_is_bigendian(void)
106 {
107 #ifdef __BYTE_ORDER__
108 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
109 	return false;
110 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
111 	return true;
112 #else
113 #error "Unrecognized __BYTE_ORDER__"
114 #endif
115 #else /* !__BYTE_ORDER__ */
116 	unsigned char str[] = { 0x1, 0x2, 0x3, 0x4, 0x0, 0x0, 0x0, 0x0};
117 	unsigned int *ptr;
118 
119 	ptr = (unsigned int *)(void *)str;
120 	return *ptr == 0x01020304;
121 #endif
122 }
123 
124 #endif /* __PERF_UTIL_H */
125