xref: /openbmc/linux/tools/perf/util/util.h (revision 8684014d)
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 <errno.h>
57 #include <limits.h>
58 #include <sys/param.h>
59 #include <sys/types.h>
60 #include <dirent.h>
61 #include <sys/time.h>
62 #include <time.h>
63 #include <signal.h>
64 #include <fnmatch.h>
65 #include <assert.h>
66 #include <regex.h>
67 #include <utime.h>
68 #include <sys/wait.h>
69 #include <poll.h>
70 #include <sys/socket.h>
71 #include <sys/ioctl.h>
72 #include <inttypes.h>
73 #include <linux/kernel.h>
74 #include <linux/magic.h>
75 #include <linux/types.h>
76 #include <sys/ttydefaults.h>
77 #include <api/fs/debugfs.h>
78 #include <termios.h>
79 #include <linux/bitops.h>
80 #include <termios.h>
81 
82 extern const char *graph_line;
83 extern const char *graph_dotted_line;
84 extern char buildid_dir[];
85 extern char tracing_events_path[];
86 extern void perf_debugfs_set_path(const char *mountpoint);
87 const char *perf_debugfs_mount(const char *mountpoint);
88 const char *find_tracing_dir(void);
89 char *get_tracing_file(const char *name);
90 void put_tracing_file(char *file);
91 
92 /* On most systems <limits.h> would have given us this, but
93  * not on some systems (e.g. GNU/Hurd).
94  */
95 #ifndef PATH_MAX
96 #define PATH_MAX 4096
97 #endif
98 
99 #ifndef PRIuMAX
100 #define PRIuMAX "llu"
101 #endif
102 
103 #ifndef PRIu32
104 #define PRIu32 "u"
105 #endif
106 
107 #ifndef PRIx32
108 #define PRIx32 "x"
109 #endif
110 
111 #ifndef PATH_SEP
112 #define PATH_SEP ':'
113 #endif
114 
115 #ifndef STRIP_EXTENSION
116 #define STRIP_EXTENSION ""
117 #endif
118 
119 #ifndef has_dos_drive_prefix
120 #define has_dos_drive_prefix(path) 0
121 #endif
122 
123 #ifndef is_dir_sep
124 #define is_dir_sep(c) ((c) == '/')
125 #endif
126 
127 #ifdef __GNUC__
128 #define NORETURN __attribute__((__noreturn__))
129 #else
130 #define NORETURN
131 #ifndef __attribute__
132 #define __attribute__(x)
133 #endif
134 #endif
135 
136 #define PERF_GTK_DSO  "libperf-gtk.so"
137 
138 /* General helper functions */
139 extern void usage(const char *err) NORETURN;
140 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
141 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
142 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
143 
144 #include "../../../include/linux/stringify.h"
145 
146 #define DIE_IF(cnd)	\
147 	do { if (cnd)	\
148 		die(" at (" __FILE__ ":" __stringify(__LINE__) "): "	\
149 		    __stringify(cnd) "\n");				\
150 	} while (0)
151 
152 
153 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
154 
155 extern int prefixcmp(const char *str, const char *prefix);
156 extern void set_buildid_dir(const char *dir);
157 
158 static inline const char *skip_prefix(const char *str, const char *prefix)
159 {
160 	size_t len = strlen(prefix);
161 	return strncmp(str, prefix, len) ? NULL : str + len;
162 }
163 
164 #ifdef __GLIBC_PREREQ
165 #if __GLIBC_PREREQ(2, 1)
166 #define HAVE_STRCHRNUL
167 #endif
168 #endif
169 
170 #ifndef HAVE_STRCHRNUL
171 #define strchrnul gitstrchrnul
172 static inline char *gitstrchrnul(const char *s, int c)
173 {
174 	while (*s && *s != c)
175 		s++;
176 	return (char *)s;
177 }
178 #endif
179 
180 /*
181  * Wrappers:
182  */
183 extern char *xstrdup(const char *str);
184 extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
185 
186 
187 static inline void *zalloc(size_t size)
188 {
189 	return calloc(1, size);
190 }
191 
192 #define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
193 
194 static inline int has_extension(const char *filename, const char *ext)
195 {
196 	size_t len = strlen(filename);
197 	size_t extlen = strlen(ext);
198 
199 	return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
200 }
201 
202 /* Sane ctype - no locale, and works with signed chars */
203 #undef isascii
204 #undef isspace
205 #undef isdigit
206 #undef isxdigit
207 #undef isalpha
208 #undef isprint
209 #undef isalnum
210 #undef islower
211 #undef isupper
212 #undef tolower
213 #undef toupper
214 
215 #ifndef NSEC_PER_MSEC
216 #define NSEC_PER_MSEC	1000000L
217 #endif
218 
219 int parse_nsec_time(const char *str, u64 *ptime);
220 
221 extern unsigned char sane_ctype[256];
222 #define GIT_SPACE		0x01
223 #define GIT_DIGIT		0x02
224 #define GIT_ALPHA		0x04
225 #define GIT_GLOB_SPECIAL	0x08
226 #define GIT_REGEX_SPECIAL	0x10
227 #define GIT_PRINT_EXTRA		0x20
228 #define GIT_PRINT		0x3E
229 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
230 #define isascii(x) (((x) & ~0x7f) == 0)
231 #define isspace(x) sane_istest(x,GIT_SPACE)
232 #define isdigit(x) sane_istest(x,GIT_DIGIT)
233 #define isxdigit(x)	\
234 	(sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
235 #define isalpha(x) sane_istest(x,GIT_ALPHA)
236 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
237 #define isprint(x) sane_istest(x,GIT_PRINT)
238 #define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
239 #define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
240 #define tolower(x) sane_case((unsigned char)(x), 0x20)
241 #define toupper(x) sane_case((unsigned char)(x), 0)
242 
243 static inline int sane_case(int x, int high)
244 {
245 	if (sane_istest(x, GIT_ALPHA))
246 		x = (x & ~0x20) | high;
247 	return x;
248 }
249 
250 int mkdir_p(char *path, mode_t mode);
251 int copyfile(const char *from, const char *to);
252 int copyfile_mode(const char *from, const char *to, mode_t mode);
253 
254 s64 perf_atoll(const char *str);
255 char **argv_split(const char *str, int *argcp);
256 void argv_free(char **argv);
257 bool strglobmatch(const char *str, const char *pat);
258 bool strlazymatch(const char *str, const char *pat);
259 int strtailcmp(const char *s1, const char *s2);
260 char *strxfrchar(char *s, char from, char to);
261 unsigned long convert_unit(unsigned long value, char *unit);
262 ssize_t readn(int fd, void *buf, size_t n);
263 ssize_t writen(int fd, void *buf, size_t n);
264 
265 struct perf_event_attr;
266 
267 void event_attr_init(struct perf_event_attr *attr);
268 
269 #define _STR(x) #x
270 #define STR(x) _STR(x)
271 
272 size_t hex_width(u64 v);
273 int hex2u64(const char *ptr, u64 *val);
274 
275 char *ltrim(char *s);
276 char *rtrim(char *s);
277 
278 void dump_stack(void);
279 
280 extern unsigned int page_size;
281 extern int cacheline_size;
282 
283 void get_term_dimensions(struct winsize *ws);
284 void set_term_quiet_input(struct termios *old);
285 
286 struct parse_tag {
287 	char tag;
288 	int mult;
289 };
290 
291 unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
292 
293 #define SRCLINE_UNKNOWN  ((char *) "??:0")
294 
295 static inline int path__join(char *bf, size_t size,
296 			     const char *path1, const char *path2)
297 {
298 	return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
299 }
300 
301 static inline int path__join3(char *bf, size_t size,
302 			      const char *path1, const char *path2,
303 			      const char *path3)
304 {
305 	return scnprintf(bf, size, "%s%s%s%s%s",
306 			 path1, path1[0] ? "/" : "",
307 			 path2, path2[0] ? "/" : "", path3);
308 }
309 
310 struct dso;
311 struct symbol;
312 
313 char *get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
314 		  bool show_sym);
315 void free_srcline(char *srcline);
316 
317 int filename__read_str(const char *filename, char **buf, size_t *sizep);
318 int perf_event_paranoid(void);
319 
320 void mem_bswap_64(void *src, int byte_size);
321 void mem_bswap_32(void *src, int byte_size);
322 
323 const char *get_filename_for_perf_kvm(void);
324 bool find_process(const char *name);
325 
326 #ifdef HAVE_ZLIB_SUPPORT
327 int gzip_decompress_to_file(const char *input, int output_fd);
328 #endif
329 
330 #endif /* GIT_COMPAT_UTIL_H */
331