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