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