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(void);
157 extern void disable_buildid_cache(void);
158
skip_prefix(const char * str,const char * prefix)159 static inline const char *skip_prefix(const char *str, const char *prefix)
160 {
161 size_t len = strlen(prefix);
162 return strncmp(str, prefix, len) ? NULL : str + len;
163 }
164
165 #ifdef __GLIBC_PREREQ
166 #if __GLIBC_PREREQ(2, 1)
167 #define HAVE_STRCHRNUL
168 #endif
169 #endif
170
171 #ifndef HAVE_STRCHRNUL
172 #define strchrnul gitstrchrnul
gitstrchrnul(const char * s,int c)173 static inline char *gitstrchrnul(const char *s, int c)
174 {
175 while (*s && *s != c)
176 s++;
177 return (char *)s;
178 }
179 #endif
180
181 /*
182 * Wrappers:
183 */
184 extern char *xstrdup(const char *str);
185 extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
186
187
zalloc(size_t size)188 static inline void *zalloc(size_t size)
189 {
190 return calloc(1, size);
191 }
192
193 #define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
194
has_extension(const char * filename,const char * ext)195 static inline int has_extension(const char *filename, const char *ext)
196 {
197 size_t len = strlen(filename);
198 size_t extlen = strlen(ext);
199
200 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
201 }
202
203 /* Sane ctype - no locale, and works with signed chars */
204 #undef isascii
205 #undef isspace
206 #undef isdigit
207 #undef isxdigit
208 #undef isalpha
209 #undef isprint
210 #undef isalnum
211 #undef islower
212 #undef isupper
213 #undef tolower
214 #undef toupper
215
216 #ifndef NSEC_PER_MSEC
217 #define NSEC_PER_MSEC 1000000L
218 #endif
219
220 int parse_nsec_time(const char *str, u64 *ptime);
221
222 extern unsigned char sane_ctype[256];
223 #define GIT_SPACE 0x01
224 #define GIT_DIGIT 0x02
225 #define GIT_ALPHA 0x04
226 #define GIT_GLOB_SPECIAL 0x08
227 #define GIT_REGEX_SPECIAL 0x10
228 #define GIT_PRINT_EXTRA 0x20
229 #define GIT_PRINT 0x3E
230 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
231 #define isascii(x) (((x) & ~0x7f) == 0)
232 #define isspace(x) sane_istest(x,GIT_SPACE)
233 #define isdigit(x) sane_istest(x,GIT_DIGIT)
234 #define isxdigit(x) \
235 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
236 #define isalpha(x) sane_istest(x,GIT_ALPHA)
237 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
238 #define isprint(x) sane_istest(x,GIT_PRINT)
239 #define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
240 #define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
241 #define tolower(x) sane_case((unsigned char)(x), 0x20)
242 #define toupper(x) sane_case((unsigned char)(x), 0)
243
sane_case(int x,int high)244 static inline int sane_case(int x, int high)
245 {
246 if (sane_istest(x, GIT_ALPHA))
247 x = (x & ~0x20) | high;
248 return x;
249 }
250
251 int mkdir_p(char *path, mode_t mode);
252 int copyfile(const char *from, const char *to);
253 int copyfile_mode(const char *from, const char *to, mode_t mode);
254
255 s64 perf_atoll(const char *str);
256 char **argv_split(const char *str, int *argcp);
257 void argv_free(char **argv);
258 bool strglobmatch(const char *str, const char *pat);
259 bool strlazymatch(const char *str, const char *pat);
260 int strtailcmp(const char *s1, const char *s2);
261 char *strxfrchar(char *s, char from, char to);
262 unsigned long convert_unit(unsigned long value, char *unit);
263 ssize_t readn(int fd, void *buf, size_t n);
264 ssize_t writen(int fd, void *buf, size_t n);
265
266 struct perf_event_attr;
267
268 void event_attr_init(struct perf_event_attr *attr);
269
270 #define _STR(x) #x
271 #define STR(x) _STR(x)
272
273 /*
274 * Determine whether some value is a power of two, where zero is
275 * *not* considered a power of two.
276 */
277
278 static inline __attribute__((const))
is_power_of_2(unsigned long n)279 bool is_power_of_2(unsigned long n)
280 {
281 return (n != 0 && ((n & (n - 1)) == 0));
282 }
283
next_pow2(unsigned x)284 static inline unsigned next_pow2(unsigned x)
285 {
286 if (!x)
287 return 1;
288 return 1ULL << (32 - __builtin_clz(x - 1));
289 }
290
next_pow2_l(unsigned long x)291 static inline unsigned long next_pow2_l(unsigned long x)
292 {
293 #if BITS_PER_LONG == 64
294 if (x <= (1UL << 31))
295 return next_pow2(x);
296 return (unsigned long)next_pow2(x >> 32) << 32;
297 #else
298 return next_pow2(x);
299 #endif
300 }
301
302 size_t hex_width(u64 v);
303 int hex2u64(const char *ptr, u64 *val);
304
305 char *ltrim(char *s);
306 char *rtrim(char *s);
307
308 void dump_stack(void);
309
310 extern unsigned int page_size;
311 extern int cacheline_size;
312
313 void get_term_dimensions(struct winsize *ws);
314 void set_term_quiet_input(struct termios *old);
315
316 struct parse_tag {
317 char tag;
318 int mult;
319 };
320
321 unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
322
323 #define SRCLINE_UNKNOWN ((char *) "??:0")
324
path__join(char * bf,size_t size,const char * path1,const char * path2)325 static inline int path__join(char *bf, size_t size,
326 const char *path1, const char *path2)
327 {
328 return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
329 }
330
path__join3(char * bf,size_t size,const char * path1,const char * path2,const char * path3)331 static inline int path__join3(char *bf, size_t size,
332 const char *path1, const char *path2,
333 const char *path3)
334 {
335 return scnprintf(bf, size, "%s%s%s%s%s",
336 path1, path1[0] ? "/" : "",
337 path2, path2[0] ? "/" : "", path3);
338 }
339
340 struct dso;
341
342 char *get_srcline(struct dso *dso, unsigned long addr);
343 void free_srcline(char *srcline);
344
345 int filename__read_int(const char *filename, int *value);
346 int filename__read_str(const char *filename, char **buf, size_t *sizep);
347 int perf_event_paranoid(void);
348
349 void mem_bswap_64(void *src, int byte_size);
350 void mem_bswap_32(void *src, int byte_size);
351
352 const char *get_filename_for_perf_kvm(void);
353 bool find_process(const char *name);
354 #endif /* GIT_COMPAT_UTIL_H */
355