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 <termios.h>
80
81 extern const char *graph_line;
82 extern const char *graph_dotted_line;
83 extern char buildid_dir[];
84
85 /* On most systems <limits.h> would have given us this, but
86 * not on some systems (e.g. GNU/Hurd).
87 */
88 #ifndef PATH_MAX
89 #define PATH_MAX 4096
90 #endif
91
92 #ifndef PRIuMAX
93 #define PRIuMAX "llu"
94 #endif
95
96 #ifndef PRIu32
97 #define PRIu32 "u"
98 #endif
99
100 #ifndef PRIx32
101 #define PRIx32 "x"
102 #endif
103
104 #ifndef PATH_SEP
105 #define PATH_SEP ':'
106 #endif
107
108 #ifndef STRIP_EXTENSION
109 #define STRIP_EXTENSION ""
110 #endif
111
112 #ifndef has_dos_drive_prefix
113 #define has_dos_drive_prefix(path) 0
114 #endif
115
116 #ifndef is_dir_sep
117 #define is_dir_sep(c) ((c) == '/')
118 #endif
119
120 #ifdef __GNUC__
121 #define NORETURN __attribute__((__noreturn__))
122 #else
123 #define NORETURN
124 #ifndef __attribute__
125 #define __attribute__(x)
126 #endif
127 #endif
128
129 #define PERF_GTK_DSO "libperf-gtk.so"
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 extern void set_warning_routine(void (*routine)(const char *err, va_list params));
148
149 extern int prefixcmp(const char *str, const char *prefix);
150 extern void set_buildid_dir(const char *dir);
151
skip_prefix(const char * str,const char * prefix)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
gitstrchrnul(const char * s,int c)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
zalloc(size_t size)181 static inline void *zalloc(size_t size)
182 {
183 return calloc(1, size);
184 }
185
186 #define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
187
has_extension(const char * filename,const char * ext)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
sane_case(int x,int high)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 rm_rf(char *path);
246 int copyfile(const char *from, const char *to);
247 int copyfile_mode(const char *from, const char *to, mode_t mode);
248 int copyfile_offset(int fromfd, loff_t from_ofs, int tofd, loff_t to_ofs, u64 size);
249
250 s64 perf_atoll(const char *str);
251 char **argv_split(const char *str, int *argcp);
252 void argv_free(char **argv);
253 bool strglobmatch(const char *str, const char *pat);
254 bool strlazymatch(const char *str, const char *pat);
strisglob(const char * str)255 static inline bool strisglob(const char *str)
256 {
257 return strpbrk(str, "*?[") != NULL;
258 }
259 int strtailcmp(const char *s1, const char *s2);
260 char *strxfrchar(char *s, char from, char to);
261 unsigned long convert_unit(unsigned long value, char *unit);
262 ssize_t readn(int fd, void *buf, size_t n);
263 ssize_t writen(int fd, void *buf, size_t n);
264
265 struct perf_event_attr;
266
267 void event_attr_init(struct perf_event_attr *attr);
268
269 #define _STR(x) #x
270 #define STR(x) _STR(x)
271
272 size_t hex_width(u64 v);
273 int hex2u64(const char *ptr, u64 *val);
274
275 char *ltrim(char *s);
276 char *rtrim(char *s);
277
278 void dump_stack(void);
279 void sighandler_dump_stack(int sig);
280
281 extern unsigned int page_size;
282 extern int cacheline_size;
283
284 void get_term_dimensions(struct winsize *ws);
285 void set_term_quiet_input(struct termios *old);
286
287 struct parse_tag {
288 char tag;
289 int mult;
290 };
291
292 unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
293
294 #define SRCLINE_UNKNOWN ((char *) "??:0")
295
path__join(char * bf,size_t size,const char * path1,const char * path2)296 static inline int path__join(char *bf, size_t size,
297 const char *path1, const char *path2)
298 {
299 return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
300 }
301
path__join3(char * bf,size_t size,const char * path1,const char * path2,const char * path3)302 static inline int path__join3(char *bf, size_t size,
303 const char *path1, const char *path2,
304 const char *path3)
305 {
306 return scnprintf(bf, size, "%s%s%s%s%s",
307 path1, path1[0] ? "/" : "",
308 path2, path2[0] ? "/" : "", path3);
309 }
310
311 struct dso;
312 struct symbol;
313
314 extern bool srcline_full_filename;
315 char *get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
316 bool show_sym);
317 char *__get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
318 bool show_sym, bool unwind_inlines);
319 void free_srcline(char *srcline);
320
321 int filename__read_str(const char *filename, char **buf, size_t *sizep);
322 int perf_event_paranoid(void);
323
324 void mem_bswap_64(void *src, int byte_size);
325 void mem_bswap_32(void *src, int byte_size);
326
327 const char *get_filename_for_perf_kvm(void);
328 bool find_process(const char *name);
329
330 #ifdef HAVE_ZLIB_SUPPORT
331 int gzip_decompress_to_file(const char *input, int output_fd);
332 #endif
333
334 #ifdef HAVE_LZMA_SUPPORT
335 int lzma_decompress_to_file(const char *input, int output_fd);
336 #endif
337
338 char *asprintf_expr_inout_ints(const char *var, bool in, size_t nints, int *ints);
339
asprintf_expr_in_ints(const char * var,size_t nints,int * ints)340 static inline char *asprintf_expr_in_ints(const char *var, size_t nints, int *ints)
341 {
342 return asprintf_expr_inout_ints(var, true, nints, ints);
343 }
344
asprintf_expr_not_in_ints(const char * var,size_t nints,int * ints)345 static inline char *asprintf_expr_not_in_ints(const char *var, size_t nints, int *ints)
346 {
347 return asprintf_expr_inout_ints(var, false, nints, ints);
348 }
349
350 int get_stack_size(const char *str, unsigned long *_size);
351
352 int fetch_kernel_version(unsigned int *puint,
353 char *str, size_t str_sz);
354 #define KVER_VERSION(x) (((x) >> 16) & 0xff)
355 #define KVER_PATCHLEVEL(x) (((x) >> 8) & 0xff)
356 #define KVER_SUBLEVEL(x) ((x) & 0xff)
357 #define KVER_FMT "%d.%d.%d"
358 #define KVER_PARAM(x) KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)
359
360 #endif /* GIT_COMPAT_UTIL_H */
361