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/tracing_path.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
86 /* On most systems <limits.h> would have given us this, but
87 * not on some systems (e.g. GNU/Hurd).
88 */
89 #ifndef PATH_MAX
90 #define PATH_MAX 4096
91 #endif
92
93 #ifndef PRIuMAX
94 #define PRIuMAX "llu"
95 #endif
96
97 #ifndef PRIu32
98 #define PRIu32 "u"
99 #endif
100
101 #ifndef PRIx32
102 #define PRIx32 "x"
103 #endif
104
105 #ifndef PATH_SEP
106 #define PATH_SEP ':'
107 #endif
108
109 #ifndef STRIP_EXTENSION
110 #define STRIP_EXTENSION ""
111 #endif
112
113 #ifndef has_dos_drive_prefix
114 #define has_dos_drive_prefix(path) 0
115 #endif
116
117 #ifndef is_dir_sep
118 #define is_dir_sep(c) ((c) == '/')
119 #endif
120
121 #ifdef __GNUC__
122 #define NORETURN __attribute__((__noreturn__))
123 #else
124 #define NORETURN
125 #ifndef __attribute__
126 #define __attribute__(x)
127 #endif
128 #endif
129
130 #define PERF_GTK_DSO "libperf-gtk.so"
131
132 /* General helper functions */
133 extern void usage(const char *err) NORETURN;
134 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
135 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
136 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
137
138 #include "../../../include/linux/stringify.h"
139
140 #define DIE_IF(cnd) \
141 do { if (cnd) \
142 die(" at (" __FILE__ ":" __stringify(__LINE__) "): " \
143 __stringify(cnd) "\n"); \
144 } while (0)
145
146
147 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
148 extern void set_warning_routine(void (*routine)(const char *err, va_list params));
149
150 extern int prefixcmp(const char *str, const char *prefix);
151 extern void set_buildid_dir(const char *dir);
152
skip_prefix(const char * str,const char * prefix)153 static inline const char *skip_prefix(const char *str, const char *prefix)
154 {
155 size_t len = strlen(prefix);
156 return strncmp(str, prefix, len) ? NULL : str + len;
157 }
158
159 #ifdef __GLIBC_PREREQ
160 #if __GLIBC_PREREQ(2, 1)
161 #define HAVE_STRCHRNUL
162 #endif
163 #endif
164
165 #ifndef HAVE_STRCHRNUL
166 #define strchrnul gitstrchrnul
gitstrchrnul(const char * s,int c)167 static inline char *gitstrchrnul(const char *s, int c)
168 {
169 while (*s && *s != c)
170 s++;
171 return (char *)s;
172 }
173 #endif
174
175 /*
176 * Wrappers:
177 */
178 extern char *xstrdup(const char *str);
179 extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
180
181
zalloc(size_t size)182 static inline void *zalloc(size_t size)
183 {
184 return calloc(1, size);
185 }
186
187 #define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
188
has_extension(const char * filename,const char * ext)189 static inline int has_extension(const char *filename, const char *ext)
190 {
191 size_t len = strlen(filename);
192 size_t extlen = strlen(ext);
193
194 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
195 }
196
197 /* Sane ctype - no locale, and works with signed chars */
198 #undef isascii
199 #undef isspace
200 #undef isdigit
201 #undef isxdigit
202 #undef isalpha
203 #undef isprint
204 #undef isalnum
205 #undef islower
206 #undef isupper
207 #undef tolower
208 #undef toupper
209
210 #ifndef NSEC_PER_MSEC
211 #define NSEC_PER_MSEC 1000000L
212 #endif
213
214 int parse_nsec_time(const char *str, u64 *ptime);
215
216 extern unsigned char sane_ctype[256];
217 #define GIT_SPACE 0x01
218 #define GIT_DIGIT 0x02
219 #define GIT_ALPHA 0x04
220 #define GIT_GLOB_SPECIAL 0x08
221 #define GIT_REGEX_SPECIAL 0x10
222 #define GIT_PRINT_EXTRA 0x20
223 #define GIT_PRINT 0x3E
224 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
225 #define isascii(x) (((x) & ~0x7f) == 0)
226 #define isspace(x) sane_istest(x,GIT_SPACE)
227 #define isdigit(x) sane_istest(x,GIT_DIGIT)
228 #define isxdigit(x) \
229 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
230 #define isalpha(x) sane_istest(x,GIT_ALPHA)
231 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
232 #define isprint(x) sane_istest(x,GIT_PRINT)
233 #define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
234 #define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
235 #define tolower(x) sane_case((unsigned char)(x), 0x20)
236 #define toupper(x) sane_case((unsigned char)(x), 0)
237
sane_case(int x,int high)238 static inline int sane_case(int x, int high)
239 {
240 if (sane_istest(x, GIT_ALPHA))
241 x = (x & ~0x20) | high;
242 return x;
243 }
244
245 int mkdir_p(char *path, mode_t mode);
246 int rm_rf(char *path);
247 int copyfile(const char *from, const char *to);
248 int copyfile_mode(const char *from, const char *to, mode_t mode);
249 int copyfile_offset(int fromfd, loff_t from_ofs, int tofd, loff_t to_ofs, u64 size);
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);
strisglob(const char * str)256 static inline bool strisglob(const char *str)
257 {
258 return strpbrk(str, "*?[") != NULL;
259 }
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 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 void sighandler_dump_stack(int sig);
281
282 extern unsigned int page_size;
283 extern int cacheline_size;
284
285 void get_term_dimensions(struct winsize *ws);
286 void set_term_quiet_input(struct termios *old);
287
288 struct parse_tag {
289 char tag;
290 int mult;
291 };
292
293 unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
294
295 #define SRCLINE_UNKNOWN ((char *) "??:0")
296
path__join(char * bf,size_t size,const char * path1,const char * path2)297 static inline int path__join(char *bf, size_t size,
298 const char *path1, const char *path2)
299 {
300 return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
301 }
302
path__join3(char * bf,size_t size,const char * path1,const char * path2,const char * path3)303 static inline int path__join3(char *bf, size_t size,
304 const char *path1, const char *path2,
305 const char *path3)
306 {
307 return scnprintf(bf, size, "%s%s%s%s%s",
308 path1, path1[0] ? "/" : "",
309 path2, path2[0] ? "/" : "", path3);
310 }
311
312 struct dso;
313 struct symbol;
314
315 extern bool srcline_full_filename;
316 char *get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
317 bool show_sym);
318 char *__get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
319 bool show_sym, bool unwind_inlines);
320 void free_srcline(char *srcline);
321
322 int filename__read_str(const char *filename, char **buf, size_t *sizep);
323 int perf_event_paranoid(void);
324
325 void mem_bswap_64(void *src, int byte_size);
326 void mem_bswap_32(void *src, int byte_size);
327
328 const char *get_filename_for_perf_kvm(void);
329 bool find_process(const char *name);
330
331 #ifdef HAVE_ZLIB_SUPPORT
332 int gzip_decompress_to_file(const char *input, int output_fd);
333 #endif
334
335 #ifdef HAVE_LZMA_SUPPORT
336 int lzma_decompress_to_file(const char *input, int output_fd);
337 #endif
338
339 char *asprintf_expr_inout_ints(const char *var, bool in, size_t nints, int *ints);
340
asprintf_expr_in_ints(const char * var,size_t nints,int * ints)341 static inline char *asprintf_expr_in_ints(const char *var, size_t nints, int *ints)
342 {
343 return asprintf_expr_inout_ints(var, true, nints, ints);
344 }
345
asprintf_expr_not_in_ints(const char * var,size_t nints,int * ints)346 static inline char *asprintf_expr_not_in_ints(const char *var, size_t nints, int *ints)
347 {
348 return asprintf_expr_inout_ints(var, false, nints, ints);
349 }
350
351 int get_stack_size(const char *str, unsigned long *_size);
352
353 int fetch_kernel_version(unsigned int *puint,
354 char *str, size_t str_sz);
355 #define KVER_VERSION(x) (((x) >> 16) & 0xff)
356 #define KVER_PATCHLEVEL(x) (((x) >> 8) & 0xff)
357 #define KVER_SUBLEVEL(x) ((x) & 0xff)
358 #define KVER_FMT "%d.%d.%d"
359 #define KVER_PARAM(x) KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)
360
361 #endif /* GIT_COMPAT_UTIL_H */
362