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