xref: /linux/tools/perf/util/util.h (revision 19a9ed115fda95317c98bef0c716ea8412cd8ce0)
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 <linux/bitmap.h>
15 #include <sys/types.h>
16 #ifndef __cplusplus
17 #include <internal/cpumap.h>
18 #endif
19 
20 extern const char perf_usage_string[];
21 extern const char perf_more_info_string[];
22 
23 extern const char *input_name;
24 
25 /* This will control if perf_{host,guest} will set attr.exclude_{host,guest}. */
26 extern bool exclude_GH_default;
27 
28 extern bool perf_host;
29 extern bool perf_guest;
30 
31 /* General helper functions */
32 void usage(const char *err) __noreturn;
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 perf_tip(char **strp, const char *dirpath);
50 
51 void cpumask_to_cpulist(char *cpumask, char *cpulist);
52 
53 void print_separator2(int pre_dash_cnt, const char *s, int post_dash_cnt);
54 
55 #ifndef HAVE_SCHED_GETCPU_SUPPORT
56 int sched_getcpu(void);
57 #endif
58 
59 #ifndef HAVE_SCANDIRAT_SUPPORT
60 int scandirat(int dirfd, const char *dirp,
61 	      struct dirent ***namelist,
62 	      int (*filter)(const struct dirent *),
63 	      int (*compar)(const struct dirent **, const struct dirent **));
64 #endif
65 
66 extern bool perf_singlethreaded;
67 
68 void perf_set_singlethreaded(void);
69 void perf_set_multithreaded(void);
70 
71 char *perf_exe(char *buf, int len);
72 
73 #ifndef O_CLOEXEC
74 #ifdef __sparc__
75 #define O_CLOEXEC      0x400000
76 #elif defined(__alpha__) || defined(__hppa__)
77 #define O_CLOEXEC      010000000
78 #else
79 #define O_CLOEXEC      02000000
80 #endif
81 #endif
82 
83 struct perf_debuginfod {
84 	const char	*urls;
85 	bool		 set;
86 };
87 void perf_debuginfod_setup(struct perf_debuginfod *di);
88 
89 const char *perf_basename(const char *path);
90 
91 char *filename_with_chroot(int pid, const char *filename);
92 
93 int do_realloc_array_as_needed(void **arr, size_t *arr_sz, size_t x,
94 			       size_t msz, const void *init_val);
95 
96 #define realloc_array_as_needed(a, n, x, v) ({			\
97 	typeof(x) __x = (x);					\
98 	__x >= (n) ?						\
99 		do_realloc_array_as_needed((void **)&(a),	\
100 					   &(n),		\
101 					   __x,			\
102 					   sizeof(*(a)),	\
103 					   (const void *)(v)) :	\
104 		0;						\
105 	})
106 
107 static inline bool host_is_bigendian(void)
108 {
109 #ifdef __BYTE_ORDER__
110 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
111 	return false;
112 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
113 	return true;
114 #else
115 #error "Unrecognized __BYTE_ORDER__"
116 #endif
117 #else /* !__BYTE_ORDER__ */
118 	unsigned char str[] = { 0x1, 0x2, 0x3, 0x4, 0x0, 0x0, 0x0, 0x0};
119 	unsigned int *ptr;
120 
121 	ptr = (unsigned int *)(void *)str;
122 	return *ptr == 0x01020304;
123 #endif
124 }
125 
126 #endif /* __PERF_UTIL_H */
127