xref: /linux/tools/perf/util/util.h (revision 80d443e8876602be2c130f79c4de81e12e2a700d)
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
3 
4 #ifndef FLEX_ARRAY
5 /*
6  * See if our compiler is known to support flexible array members.
7  */
8 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
9 # define FLEX_ARRAY /* empty */
10 #elif defined(__GNUC__)
11 # if (__GNUC__ >= 3)
12 #  define FLEX_ARRAY /* empty */
13 # else
14 #  define FLEX_ARRAY 0 /* older GNU extension */
15 # endif
16 #endif
17 
18 /*
19  * Otherwise, default to safer but a bit wasteful traditional style
20  */
21 #ifndef FLEX_ARRAY
22 # define FLEX_ARRAY 1
23 #endif
24 #endif
25 
26 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
27 
28 #ifdef __GNUC__
29 #define TYPEOF(x) (__typeof__(x))
30 #else
31 #define TYPEOF(x)
32 #endif
33 
34 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
35 #define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
36 
37 /* Approximation of the length of the decimal representation of this type. */
38 #define decimal_length(x)	((int)(sizeof(x) * 2.56 + 0.5) + 1)
39 
40 #define _ALL_SOURCE 1
41 #define _BSD_SOURCE 1
42 /* glibc 2.20 deprecates _BSD_SOURCE in favour of _DEFAULT_SOURCE */
43 #define _DEFAULT_SOURCE 1
44 #define HAS_BOOL
45 
46 #include <unistd.h>
47 #include <stdio.h>
48 #include <sys/stat.h>
49 #include <sys/statfs.h>
50 #include <fcntl.h>
51 #include <stdbool.h>
52 #include <stddef.h>
53 #include <stdlib.h>
54 #include <stdarg.h>
55 #include <string.h>
56 #include <term.h>
57 #include <errno.h>
58 #include <limits.h>
59 #include <sys/param.h>
60 #include <sys/types.h>
61 #include <dirent.h>
62 #include <sys/time.h>
63 #include <time.h>
64 #include <signal.h>
65 #include <fnmatch.h>
66 #include <assert.h>
67 #include <regex.h>
68 #include <utime.h>
69 #include <sys/wait.h>
70 #include <poll.h>
71 #include <sys/socket.h>
72 #include <sys/ioctl.h>
73 #include <inttypes.h>
74 #include <linux/kernel.h>
75 #include <linux/types.h>
76 #include <sys/ttydefaults.h>
77 #include <api/fs/tracing_path.h>
78 #include <termios.h>
79 #include <linux/bitops.h>
80 #include <termios.h>
81 #include "strlist.h"
82 
83 extern const char *graph_line;
84 extern const char *graph_dotted_line;
85 extern const char *spaces;
86 extern const char *dots;
87 extern char buildid_dir[];
88 
89 /* On most systems <limits.h> would have given us this, but
90  * not on some systems (e.g. GNU/Hurd).
91  */
92 #ifndef PATH_MAX
93 #define PATH_MAX 4096
94 #endif
95 
96 #ifndef PRIuMAX
97 #define PRIuMAX "llu"
98 #endif
99 
100 #ifndef PRIu32
101 #define PRIu32 "u"
102 #endif
103 
104 #ifndef PRIx32
105 #define PRIx32 "x"
106 #endif
107 
108 #ifndef PATH_SEP
109 #define PATH_SEP ':'
110 #endif
111 
112 #ifndef STRIP_EXTENSION
113 #define STRIP_EXTENSION ""
114 #endif
115 
116 #ifndef has_dos_drive_prefix
117 #define has_dos_drive_prefix(path) 0
118 #endif
119 
120 #ifndef is_dir_sep
121 #define is_dir_sep(c) ((c) == '/')
122 #endif
123 
124 #ifdef __GNUC__
125 #define NORETURN __attribute__((__noreturn__))
126 #else
127 #define NORETURN
128 #ifndef __attribute__
129 #define __attribute__(x)
130 #endif
131 #endif
132 
133 #define PERF_GTK_DSO  "libperf-gtk.so"
134 
135 /* General helper functions */
136 void usage(const char *err) NORETURN;
137 void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
138 int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
139 void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
140 
141 void set_warning_routine(void (*routine)(const char *err, va_list params));
142 
143 int prefixcmp(const char *str, const char *prefix);
144 void set_buildid_dir(const char *dir);
145 
146 #ifdef __GLIBC_PREREQ
147 #if __GLIBC_PREREQ(2, 1)
148 #define HAVE_STRCHRNUL
149 #endif
150 #endif
151 
152 #ifndef HAVE_STRCHRNUL
153 #define strchrnul gitstrchrnul
154 static inline char *gitstrchrnul(const char *s, int c)
155 {
156 	while (*s && *s != c)
157 		s++;
158 	return (char *)s;
159 }
160 #endif
161 
162 static inline void *zalloc(size_t size)
163 {
164 	return calloc(1, size);
165 }
166 
167 #define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
168 
169 /* Sane ctype - no locale, and works with signed chars */
170 #undef isascii
171 #undef isspace
172 #undef isdigit
173 #undef isxdigit
174 #undef isalpha
175 #undef isprint
176 #undef isalnum
177 #undef islower
178 #undef isupper
179 #undef tolower
180 #undef toupper
181 
182 extern unsigned char sane_ctype[256];
183 #define GIT_SPACE		0x01
184 #define GIT_DIGIT		0x02
185 #define GIT_ALPHA		0x04
186 #define GIT_GLOB_SPECIAL	0x08
187 #define GIT_REGEX_SPECIAL	0x10
188 #define GIT_PRINT_EXTRA		0x20
189 #define GIT_PRINT		0x3E
190 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
191 #define isascii(x) (((x) & ~0x7f) == 0)
192 #define isspace(x) sane_istest(x,GIT_SPACE)
193 #define isdigit(x) sane_istest(x,GIT_DIGIT)
194 #define isxdigit(x)	\
195 	(sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
196 #define isalpha(x) sane_istest(x,GIT_ALPHA)
197 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
198 #define isprint(x) sane_istest(x,GIT_PRINT)
199 #define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
200 #define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
201 #define tolower(x) sane_case((unsigned char)(x), 0x20)
202 #define toupper(x) sane_case((unsigned char)(x), 0)
203 
204 static inline int sane_case(int x, int high)
205 {
206 	if (sane_istest(x, GIT_ALPHA))
207 		x = (x & ~0x20) | high;
208 	return x;
209 }
210 
211 int mkdir_p(char *path, mode_t mode);
212 int rm_rf(char *path);
213 struct strlist *lsdir(const char *name, bool (*filter)(const char *, struct dirent *));
214 bool lsdir_no_dot_filter(const char *name, struct dirent *d);
215 int copyfile(const char *from, const char *to);
216 int copyfile_mode(const char *from, const char *to, mode_t mode);
217 int copyfile_offset(int fromfd, loff_t from_ofs, int tofd, loff_t to_ofs, u64 size);
218 
219 s64 perf_atoll(const char *str);
220 char **argv_split(const char *str, int *argcp);
221 void argv_free(char **argv);
222 bool strglobmatch(const char *str, const char *pat);
223 bool strglobmatch_nocase(const char *str, const char *pat);
224 bool strlazymatch(const char *str, const char *pat);
225 static inline bool strisglob(const char *str)
226 {
227 	return strpbrk(str, "*?[") != NULL;
228 }
229 int strtailcmp(const char *s1, const char *s2);
230 char *strxfrchar(char *s, char from, char to);
231 unsigned long convert_unit(unsigned long value, char *unit);
232 ssize_t readn(int fd, void *buf, size_t n);
233 ssize_t writen(int fd, void *buf, size_t n);
234 
235 struct perf_event_attr;
236 
237 void event_attr_init(struct perf_event_attr *attr);
238 
239 #define _STR(x) #x
240 #define STR(x) _STR(x)
241 
242 size_t hex_width(u64 v);
243 int hex2u64(const char *ptr, u64 *val);
244 
245 char *ltrim(char *s);
246 char *rtrim(char *s);
247 
248 static inline char *trim(char *s)
249 {
250 	return ltrim(rtrim(s));
251 }
252 
253 void dump_stack(void);
254 void sighandler_dump_stack(int sig);
255 
256 extern unsigned int page_size;
257 extern int cacheline_size;
258 extern int sysctl_perf_event_max_stack;
259 extern int sysctl_perf_event_max_contexts_per_stack;
260 
261 struct parse_tag {
262 	char tag;
263 	int mult;
264 };
265 
266 unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
267 
268 #define SRCLINE_UNKNOWN  ((char *) "??:0")
269 
270 static inline int path__join(char *bf, size_t size,
271 			     const char *path1, const char *path2)
272 {
273 	return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
274 }
275 
276 static inline int path__join3(char *bf, size_t size,
277 			      const char *path1, const char *path2,
278 			      const char *path3)
279 {
280 	return scnprintf(bf, size, "%s%s%s%s%s",
281 			 path1, path1[0] ? "/" : "",
282 			 path2, path2[0] ? "/" : "", path3);
283 }
284 
285 struct dso;
286 struct symbol;
287 
288 extern bool srcline_full_filename;
289 char *get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
290 		  bool show_sym);
291 char *__get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
292 		  bool show_sym, bool unwind_inlines);
293 void free_srcline(char *srcline);
294 
295 int perf_event_paranoid(void);
296 
297 void mem_bswap_64(void *src, int byte_size);
298 void mem_bswap_32(void *src, int byte_size);
299 
300 const char *get_filename_for_perf_kvm(void);
301 bool find_process(const char *name);
302 
303 #ifdef HAVE_ZLIB_SUPPORT
304 int gzip_decompress_to_file(const char *input, int output_fd);
305 #endif
306 
307 #ifdef HAVE_LZMA_SUPPORT
308 int lzma_decompress_to_file(const char *input, int output_fd);
309 #endif
310 
311 char *asprintf_expr_inout_ints(const char *var, bool in, size_t nints, int *ints);
312 
313 static inline char *asprintf_expr_in_ints(const char *var, size_t nints, int *ints)
314 {
315 	return asprintf_expr_inout_ints(var, true, nints, ints);
316 }
317 
318 static inline char *asprintf_expr_not_in_ints(const char *var, size_t nints, int *ints)
319 {
320 	return asprintf_expr_inout_ints(var, false, nints, ints);
321 }
322 
323 int get_stack_size(const char *str, unsigned long *_size);
324 
325 int fetch_kernel_version(unsigned int *puint,
326 			 char *str, size_t str_sz);
327 #define KVER_VERSION(x)		(((x) >> 16) & 0xff)
328 #define KVER_PATCHLEVEL(x)	(((x) >> 8) & 0xff)
329 #define KVER_SUBLEVEL(x)	((x) & 0xff)
330 #define KVER_FMT	"%d.%d.%d"
331 #define KVER_PARAM(x)	KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)
332 
333 const char *perf_tip(const char *dirpath);
334 bool is_regular_file(const char *file);
335 int fetch_current_timestamp(char *buf, size_t sz);
336 
337 enum binary_printer_ops {
338 	BINARY_PRINT_DATA_BEGIN,
339 	BINARY_PRINT_LINE_BEGIN,
340 	BINARY_PRINT_ADDR,
341 	BINARY_PRINT_NUM_DATA,
342 	BINARY_PRINT_NUM_PAD,
343 	BINARY_PRINT_SEP,
344 	BINARY_PRINT_CHAR_DATA,
345 	BINARY_PRINT_CHAR_PAD,
346 	BINARY_PRINT_LINE_END,
347 	BINARY_PRINT_DATA_END,
348 };
349 
350 typedef void (*print_binary_t)(enum binary_printer_ops,
351 			       unsigned int val,
352 			       void *extra);
353 
354 void print_binary(unsigned char *data, size_t len,
355 		  size_t bytes_per_line, print_binary_t printer,
356 		  void *extra);
357 
358 #if !defined(__GLIBC__) && !defined(__ANDROID__)
359 extern int sched_getcpu(void);
360 #endif
361 
362 int is_printable_array(char *p, unsigned int len);
363 
364 int timestamp__scnprintf_usec(u64 timestamp, char *buf, size_t sz);
365 
366 #endif /* GIT_COMPAT_UTIL_H */
367