xref: /openbmc/linux/tools/perf/util/util.h (revision 95b384f9)
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/magic.h>
76 #include <linux/types.h>
77 #include <sys/ttydefaults.h>
78 #include <api/fs/tracing_path.h>
79 #include <termios.h>
80 #include <linux/bitops.h>
81 #include <termios.h>
82 #include "strlist.h"
83 
84 extern const char *graph_line;
85 extern const char *graph_dotted_line;
86 extern const char *spaces;
87 extern const char *dots;
88 extern char buildid_dir[];
89 
90 /* On most systems <limits.h> would have given us this, but
91  * not on some systems (e.g. GNU/Hurd).
92  */
93 #ifndef PATH_MAX
94 #define PATH_MAX 4096
95 #endif
96 
97 #ifndef PRIuMAX
98 #define PRIuMAX "llu"
99 #endif
100 
101 #ifndef PRIu32
102 #define PRIu32 "u"
103 #endif
104 
105 #ifndef PRIx32
106 #define PRIx32 "x"
107 #endif
108 
109 #ifndef PATH_SEP
110 #define PATH_SEP ':'
111 #endif
112 
113 #ifndef STRIP_EXTENSION
114 #define STRIP_EXTENSION ""
115 #endif
116 
117 #ifndef has_dos_drive_prefix
118 #define has_dos_drive_prefix(path) 0
119 #endif
120 
121 #ifndef is_dir_sep
122 #define is_dir_sep(c) ((c) == '/')
123 #endif
124 
125 #ifdef __GNUC__
126 #define NORETURN __attribute__((__noreturn__))
127 #else
128 #define NORETURN
129 #ifndef __attribute__
130 #define __attribute__(x)
131 #endif
132 #endif
133 
134 #define PERF_GTK_DSO  "libperf-gtk.so"
135 
136 /* General helper functions */
137 void usage(const char *err) NORETURN;
138 void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
139 int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
140 void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
141 
142 void set_warning_routine(void (*routine)(const char *err, va_list params));
143 
144 int prefixcmp(const char *str, const char *prefix);
145 void set_buildid_dir(const char *dir);
146 
147 #ifdef __GLIBC_PREREQ
148 #if __GLIBC_PREREQ(2, 1)
149 #define HAVE_STRCHRNUL
150 #endif
151 #endif
152 
153 #ifndef HAVE_STRCHRNUL
154 #define strchrnul gitstrchrnul
155 static inline char *gitstrchrnul(const char *s, int c)
156 {
157 	while (*s && *s != c)
158 		s++;
159 	return (char *)s;
160 }
161 #endif
162 
163 static inline void *zalloc(size_t size)
164 {
165 	return calloc(1, size);
166 }
167 
168 #define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
169 
170 /* Sane ctype - no locale, and works with signed chars */
171 #undef isascii
172 #undef isspace
173 #undef isdigit
174 #undef isxdigit
175 #undef isalpha
176 #undef isprint
177 #undef isalnum
178 #undef islower
179 #undef isupper
180 #undef tolower
181 #undef toupper
182 
183 #ifndef NSEC_PER_MSEC
184 #define NSEC_PER_MSEC	1000000L
185 #endif
186 
187 int parse_nsec_time(const char *str, u64 *ptime);
188 
189 extern unsigned char sane_ctype[256];
190 #define GIT_SPACE		0x01
191 #define GIT_DIGIT		0x02
192 #define GIT_ALPHA		0x04
193 #define GIT_GLOB_SPECIAL	0x08
194 #define GIT_REGEX_SPECIAL	0x10
195 #define GIT_PRINT_EXTRA		0x20
196 #define GIT_PRINT		0x3E
197 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
198 #define isascii(x) (((x) & ~0x7f) == 0)
199 #define isspace(x) sane_istest(x,GIT_SPACE)
200 #define isdigit(x) sane_istest(x,GIT_DIGIT)
201 #define isxdigit(x)	\
202 	(sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
203 #define isalpha(x) sane_istest(x,GIT_ALPHA)
204 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
205 #define isprint(x) sane_istest(x,GIT_PRINT)
206 #define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
207 #define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
208 #define tolower(x) sane_case((unsigned char)(x), 0x20)
209 #define toupper(x) sane_case((unsigned char)(x), 0)
210 
211 static inline int sane_case(int x, int high)
212 {
213 	if (sane_istest(x, GIT_ALPHA))
214 		x = (x & ~0x20) | high;
215 	return x;
216 }
217 
218 int mkdir_p(char *path, mode_t mode);
219 int rm_rf(char *path);
220 struct strlist *lsdir(const char *name, bool (*filter)(const char *, struct dirent *));
221 bool lsdir_no_dot_filter(const char *name, struct dirent *d);
222 int copyfile(const char *from, const char *to);
223 int copyfile_mode(const char *from, const char *to, mode_t mode);
224 int copyfile_offset(int fromfd, loff_t from_ofs, int tofd, loff_t to_ofs, u64 size);
225 
226 s64 perf_atoll(const char *str);
227 char **argv_split(const char *str, int *argcp);
228 void argv_free(char **argv);
229 bool strglobmatch(const char *str, const char *pat);
230 bool strlazymatch(const char *str, const char *pat);
231 static inline bool strisglob(const char *str)
232 {
233 	return strpbrk(str, "*?[") != NULL;
234 }
235 int strtailcmp(const char *s1, const char *s2);
236 char *strxfrchar(char *s, char from, char to);
237 unsigned long convert_unit(unsigned long value, char *unit);
238 ssize_t readn(int fd, void *buf, size_t n);
239 ssize_t writen(int fd, void *buf, size_t n);
240 
241 struct perf_event_attr;
242 
243 void event_attr_init(struct perf_event_attr *attr);
244 
245 #define _STR(x) #x
246 #define STR(x) _STR(x)
247 
248 size_t hex_width(u64 v);
249 int hex2u64(const char *ptr, u64 *val);
250 
251 char *ltrim(char *s);
252 char *rtrim(char *s);
253 
254 static inline char *trim(char *s)
255 {
256 	return ltrim(rtrim(s));
257 }
258 
259 void dump_stack(void);
260 void sighandler_dump_stack(int sig);
261 
262 extern unsigned int page_size;
263 extern int cacheline_size;
264 extern int sysctl_perf_event_max_stack;
265 extern int sysctl_perf_event_max_contexts_per_stack;
266 
267 struct parse_tag {
268 	char tag;
269 	int mult;
270 };
271 
272 unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
273 
274 #define SRCLINE_UNKNOWN  ((char *) "??:0")
275 
276 static inline int path__join(char *bf, size_t size,
277 			     const char *path1, const char *path2)
278 {
279 	return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
280 }
281 
282 static inline int path__join3(char *bf, size_t size,
283 			      const char *path1, const char *path2,
284 			      const char *path3)
285 {
286 	return scnprintf(bf, size, "%s%s%s%s%s",
287 			 path1, path1[0] ? "/" : "",
288 			 path2, path2[0] ? "/" : "", path3);
289 }
290 
291 struct dso;
292 struct symbol;
293 
294 extern bool srcline_full_filename;
295 char *get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
296 		  bool show_sym);
297 char *__get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
298 		  bool show_sym, bool unwind_inlines);
299 void free_srcline(char *srcline);
300 
301 int perf_event_paranoid(void);
302 
303 void mem_bswap_64(void *src, int byte_size);
304 void mem_bswap_32(void *src, int byte_size);
305 
306 const char *get_filename_for_perf_kvm(void);
307 bool find_process(const char *name);
308 
309 #ifdef HAVE_ZLIB_SUPPORT
310 int gzip_decompress_to_file(const char *input, int output_fd);
311 #endif
312 
313 #ifdef HAVE_LZMA_SUPPORT
314 int lzma_decompress_to_file(const char *input, int output_fd);
315 #endif
316 
317 char *asprintf_expr_inout_ints(const char *var, bool in, size_t nints, int *ints);
318 
319 static inline char *asprintf_expr_in_ints(const char *var, size_t nints, int *ints)
320 {
321 	return asprintf_expr_inout_ints(var, true, nints, ints);
322 }
323 
324 static inline char *asprintf_expr_not_in_ints(const char *var, size_t nints, int *ints)
325 {
326 	return asprintf_expr_inout_ints(var, false, nints, ints);
327 }
328 
329 int get_stack_size(const char *str, unsigned long *_size);
330 
331 int fetch_kernel_version(unsigned int *puint,
332 			 char *str, size_t str_sz);
333 #define KVER_VERSION(x)		(((x) >> 16) & 0xff)
334 #define KVER_PATCHLEVEL(x)	(((x) >> 8) & 0xff)
335 #define KVER_SUBLEVEL(x)	((x) & 0xff)
336 #define KVER_FMT	"%d.%d.%d"
337 #define KVER_PARAM(x)	KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)
338 
339 const char *perf_tip(const char *dirpath);
340 bool is_regular_file(const char *file);
341 int fetch_current_timestamp(char *buf, size_t sz);
342 
343 enum binary_printer_ops {
344 	BINARY_PRINT_DATA_BEGIN,
345 	BINARY_PRINT_LINE_BEGIN,
346 	BINARY_PRINT_ADDR,
347 	BINARY_PRINT_NUM_DATA,
348 	BINARY_PRINT_NUM_PAD,
349 	BINARY_PRINT_SEP,
350 	BINARY_PRINT_CHAR_DATA,
351 	BINARY_PRINT_CHAR_PAD,
352 	BINARY_PRINT_LINE_END,
353 	BINARY_PRINT_DATA_END,
354 };
355 
356 typedef void (*print_binary_t)(enum binary_printer_ops,
357 			       unsigned int val,
358 			       void *extra);
359 
360 void print_binary(unsigned char *data, size_t len,
361 		  size_t bytes_per_line, print_binary_t printer,
362 		  void *extra);
363 #endif /* GIT_COMPAT_UTIL_H */
364