xref: /openbmc/linux/tools/perf/util/util.h (revision cd5d5810)
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 /* General helper functions */
132 extern void usage(const char *err) NORETURN;
133 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
134 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
135 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
136 
137 #include "../../../include/linux/stringify.h"
138 
139 #define DIE_IF(cnd)	\
140 	do { if (cnd)	\
141 		die(" at (" __FILE__ ":" __stringify(__LINE__) "): "	\
142 		    __stringify(cnd) "\n");				\
143 	} while (0)
144 
145 
146 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
147 
148 extern int prefixcmp(const char *str, const char *prefix);
149 extern void set_buildid_dir(void);
150 extern void disable_buildid_cache(void);
151 
152 static inline const char *skip_prefix(const char *str, const char *prefix)
153 {
154 	size_t len = strlen(prefix);
155 	return strncmp(str, prefix, len) ? NULL : str + len;
156 }
157 
158 #ifdef __GLIBC_PREREQ
159 #if __GLIBC_PREREQ(2, 1)
160 #define HAVE_STRCHRNUL
161 #endif
162 #endif
163 
164 #ifndef HAVE_STRCHRNUL
165 #define strchrnul gitstrchrnul
166 static inline char *gitstrchrnul(const char *s, int c)
167 {
168 	while (*s && *s != c)
169 		s++;
170 	return (char *)s;
171 }
172 #endif
173 
174 /*
175  * Wrappers:
176  */
177 extern char *xstrdup(const char *str);
178 extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
179 
180 
181 static inline void *zalloc(size_t size)
182 {
183 	return calloc(1, size);
184 }
185 
186 static inline int has_extension(const char *filename, const char *ext)
187 {
188 	size_t len = strlen(filename);
189 	size_t extlen = strlen(ext);
190 
191 	return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
192 }
193 
194 /* Sane ctype - no locale, and works with signed chars */
195 #undef isascii
196 #undef isspace
197 #undef isdigit
198 #undef isxdigit
199 #undef isalpha
200 #undef isprint
201 #undef isalnum
202 #undef islower
203 #undef isupper
204 #undef tolower
205 #undef toupper
206 
207 #ifndef NSEC_PER_MSEC
208 #define NSEC_PER_MSEC	1000000L
209 #endif
210 
211 int parse_nsec_time(const char *str, u64 *ptime);
212 
213 extern unsigned char sane_ctype[256];
214 #define GIT_SPACE		0x01
215 #define GIT_DIGIT		0x02
216 #define GIT_ALPHA		0x04
217 #define GIT_GLOB_SPECIAL	0x08
218 #define GIT_REGEX_SPECIAL	0x10
219 #define GIT_PRINT_EXTRA		0x20
220 #define GIT_PRINT		0x3E
221 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
222 #define isascii(x) (((x) & ~0x7f) == 0)
223 #define isspace(x) sane_istest(x,GIT_SPACE)
224 #define isdigit(x) sane_istest(x,GIT_DIGIT)
225 #define isxdigit(x)	\
226 	(sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
227 #define isalpha(x) sane_istest(x,GIT_ALPHA)
228 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
229 #define isprint(x) sane_istest(x,GIT_PRINT)
230 #define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
231 #define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
232 #define tolower(x) sane_case((unsigned char)(x), 0x20)
233 #define toupper(x) sane_case((unsigned char)(x), 0)
234 
235 static inline int sane_case(int x, int high)
236 {
237 	if (sane_istest(x, GIT_ALPHA))
238 		x = (x & ~0x20) | high;
239 	return x;
240 }
241 
242 int mkdir_p(char *path, mode_t mode);
243 int copyfile(const char *from, const char *to);
244 
245 s64 perf_atoll(const char *str);
246 char **argv_split(const char *str, int *argcp);
247 void argv_free(char **argv);
248 bool strglobmatch(const char *str, const char *pat);
249 bool strlazymatch(const char *str, const char *pat);
250 int strtailcmp(const char *s1, const char *s2);
251 char *strxfrchar(char *s, char from, char to);
252 unsigned long convert_unit(unsigned long value, char *unit);
253 int readn(int fd, void *buf, size_t size);
254 
255 struct perf_event_attr;
256 
257 void event_attr_init(struct perf_event_attr *attr);
258 
259 #define _STR(x) #x
260 #define STR(x) _STR(x)
261 
262 /*
263  *  Determine whether some value is a power of two, where zero is
264  * *not* considered a power of two.
265  */
266 
267 static inline __attribute__((const))
268 bool is_power_of_2(unsigned long n)
269 {
270 	return (n != 0 && ((n & (n - 1)) == 0));
271 }
272 
273 size_t hex_width(u64 v);
274 int hex2u64(const char *ptr, u64 *val);
275 
276 char *ltrim(char *s);
277 char *rtrim(char *s);
278 
279 void dump_stack(void);
280 
281 extern unsigned int page_size;
282 
283 void get_term_dimensions(struct winsize *ws);
284 #endif /* GIT_COMPAT_UTIL_H */
285