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 <term.h>
57 #include <errno.h>
58 #include <limits.h>
59 #include <sys/param.h>
60 #include <sys/types.h>
61 #include <dirent.h>
62 #include <sys/time.h>
63 #include <time.h>
64 #include <signal.h>
65 #include <fnmatch.h>
66 #include <assert.h>
67 #include <regex.h>
68 #include <utime.h>
69 #include <sys/wait.h>
70 #include <poll.h>
71 #include <sys/socket.h>
72 #include <sys/ioctl.h>
73 #include <inttypes.h>
74 #include <linux/kernel.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 #include "strlist.h"
82
83 extern const char *graph_line;
84 extern const char *graph_dotted_line;
85 extern const char *spaces;
86 extern const char *dots;
87 extern char buildid_dir[];
88
89 /* On most systems <limits.h> would have given us this, but
90 * not on some systems (e.g. GNU/Hurd).
91 */
92 #ifndef PATH_MAX
93 #define PATH_MAX 4096
94 #endif
95
96 #ifndef PRIuMAX
97 #define PRIuMAX "llu"
98 #endif
99
100 #ifndef PRIu32
101 #define PRIu32 "u"
102 #endif
103
104 #ifndef PRIx32
105 #define PRIx32 "x"
106 #endif
107
108 #ifndef PATH_SEP
109 #define PATH_SEP ':'
110 #endif
111
112 #ifndef STRIP_EXTENSION
113 #define STRIP_EXTENSION ""
114 #endif
115
116 #ifndef has_dos_drive_prefix
117 #define has_dos_drive_prefix(path) 0
118 #endif
119
120 #ifndef is_dir_sep
121 #define is_dir_sep(c) ((c) == '/')
122 #endif
123
124 #ifdef __GNUC__
125 #define NORETURN __attribute__((__noreturn__))
126 #else
127 #define NORETURN
128 #ifndef __attribute__
129 #define __attribute__(x)
130 #endif
131 #endif
132
133 #define PERF_GTK_DSO "libperf-gtk.so"
134
135 /* General helper functions */
136 void usage(const char *err) NORETURN;
137 void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
138 int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
139 void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
140
141 void set_warning_routine(void (*routine)(const char *err, va_list params));
142
143 int prefixcmp(const char *str, const char *prefix);
144 void set_buildid_dir(const char *dir);
145
146 #ifdef __GLIBC_PREREQ
147 #if __GLIBC_PREREQ(2, 1)
148 #define HAVE_STRCHRNUL
149 #endif
150 #endif
151
152 #ifndef HAVE_STRCHRNUL
153 #define strchrnul gitstrchrnul
gitstrchrnul(const char * s,int c)154 static inline char *gitstrchrnul(const char *s, int c)
155 {
156 while (*s && *s != c)
157 s++;
158 return (char *)s;
159 }
160 #endif
161
zalloc(size_t size)162 static inline void *zalloc(size_t size)
163 {
164 return calloc(1, size);
165 }
166
167 #define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
168
169 /* Sane ctype - no locale, and works with signed chars */
170 #undef isascii
171 #undef isspace
172 #undef isdigit
173 #undef isxdigit
174 #undef isalpha
175 #undef isprint
176 #undef isalnum
177 #undef islower
178 #undef isupper
179 #undef tolower
180 #undef toupper
181
182 int parse_nsec_time(const char *str, u64 *ptime);
183
184 extern unsigned char sane_ctype[256];
185 #define GIT_SPACE 0x01
186 #define GIT_DIGIT 0x02
187 #define GIT_ALPHA 0x04
188 #define GIT_GLOB_SPECIAL 0x08
189 #define GIT_REGEX_SPECIAL 0x10
190 #define GIT_PRINT_EXTRA 0x20
191 #define GIT_PRINT 0x3E
192 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
193 #define isascii(x) (((x) & ~0x7f) == 0)
194 #define isspace(x) sane_istest(x,GIT_SPACE)
195 #define isdigit(x) sane_istest(x,GIT_DIGIT)
196 #define isxdigit(x) \
197 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
198 #define isalpha(x) sane_istest(x,GIT_ALPHA)
199 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
200 #define isprint(x) sane_istest(x,GIT_PRINT)
201 #define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
202 #define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
203 #define tolower(x) sane_case((unsigned char)(x), 0x20)
204 #define toupper(x) sane_case((unsigned char)(x), 0)
205
sane_case(int x,int high)206 static inline int sane_case(int x, int high)
207 {
208 if (sane_istest(x, GIT_ALPHA))
209 x = (x & ~0x20) | high;
210 return x;
211 }
212
213 int mkdir_p(char *path, mode_t mode);
214 int rm_rf(char *path);
215 struct strlist *lsdir(const char *name, bool (*filter)(const char *, struct dirent *));
216 bool lsdir_no_dot_filter(const char *name, struct dirent *d);
217 int copyfile(const char *from, const char *to);
218 int copyfile_mode(const char *from, const char *to, mode_t mode);
219 int copyfile_offset(int fromfd, loff_t from_ofs, int tofd, loff_t to_ofs, u64 size);
220
221 s64 perf_atoll(const char *str);
222 char **argv_split(const char *str, int *argcp);
223 void argv_free(char **argv);
224 bool strglobmatch(const char *str, const char *pat);
225 bool strlazymatch(const char *str, const char *pat);
strisglob(const char * str)226 static inline bool strisglob(const char *str)
227 {
228 return strpbrk(str, "*?[") != NULL;
229 }
230 int strtailcmp(const char *s1, const char *s2);
231 char *strxfrchar(char *s, char from, char to);
232 unsigned long convert_unit(unsigned long value, char *unit);
233 ssize_t readn(int fd, void *buf, size_t n);
234 ssize_t writen(int fd, void *buf, size_t n);
235
236 struct perf_event_attr;
237
238 void event_attr_init(struct perf_event_attr *attr);
239
240 #define _STR(x) #x
241 #define STR(x) _STR(x)
242
243 size_t hex_width(u64 v);
244 int hex2u64(const char *ptr, u64 *val);
245
246 char *ltrim(char *s);
247 char *rtrim(char *s);
248
trim(char * s)249 static inline char *trim(char *s)
250 {
251 return ltrim(rtrim(s));
252 }
253
254 void dump_stack(void);
255 void sighandler_dump_stack(int sig);
256
257 extern unsigned int page_size;
258 extern int cacheline_size;
259 extern int sysctl_perf_event_max_stack;
260 extern int sysctl_perf_event_max_contexts_per_stack;
261
262 struct parse_tag {
263 char tag;
264 int mult;
265 };
266
267 unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
268
269 #define SRCLINE_UNKNOWN ((char *) "??:0")
270
path__join(char * bf,size_t size,const char * path1,const char * path2)271 static inline int path__join(char *bf, size_t size,
272 const char *path1, const char *path2)
273 {
274 return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
275 }
276
path__join3(char * bf,size_t size,const char * path1,const char * path2,const char * path3)277 static inline int path__join3(char *bf, size_t size,
278 const char *path1, const char *path2,
279 const char *path3)
280 {
281 return scnprintf(bf, size, "%s%s%s%s%s",
282 path1, path1[0] ? "/" : "",
283 path2, path2[0] ? "/" : "", path3);
284 }
285
286 struct dso;
287 struct symbol;
288
289 extern bool srcline_full_filename;
290 char *get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
291 bool show_sym);
292 char *__get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
293 bool show_sym, bool unwind_inlines);
294 void free_srcline(char *srcline);
295
296 int perf_event_paranoid(void);
297
298 void mem_bswap_64(void *src, int byte_size);
299 void mem_bswap_32(void *src, int byte_size);
300
301 const char *get_filename_for_perf_kvm(void);
302 bool find_process(const char *name);
303
304 #ifdef HAVE_ZLIB_SUPPORT
305 int gzip_decompress_to_file(const char *input, int output_fd);
306 #endif
307
308 #ifdef HAVE_LZMA_SUPPORT
309 int lzma_decompress_to_file(const char *input, int output_fd);
310 #endif
311
312 char *asprintf_expr_inout_ints(const char *var, bool in, size_t nints, int *ints);
313
asprintf_expr_in_ints(const char * var,size_t nints,int * ints)314 static inline char *asprintf_expr_in_ints(const char *var, size_t nints, int *ints)
315 {
316 return asprintf_expr_inout_ints(var, true, nints, ints);
317 }
318
asprintf_expr_not_in_ints(const char * var,size_t nints,int * ints)319 static inline char *asprintf_expr_not_in_ints(const char *var, size_t nints, int *ints)
320 {
321 return asprintf_expr_inout_ints(var, false, nints, ints);
322 }
323
324 int get_stack_size(const char *str, unsigned long *_size);
325
326 int fetch_kernel_version(unsigned int *puint,
327 char *str, size_t str_sz);
328 #define KVER_VERSION(x) (((x) >> 16) & 0xff)
329 #define KVER_PATCHLEVEL(x) (((x) >> 8) & 0xff)
330 #define KVER_SUBLEVEL(x) ((x) & 0xff)
331 #define KVER_FMT "%d.%d.%d"
332 #define KVER_PARAM(x) KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)
333
334 const char *perf_tip(const char *dirpath);
335 bool is_regular_file(const char *file);
336 int fetch_current_timestamp(char *buf, size_t sz);
337
338 enum binary_printer_ops {
339 BINARY_PRINT_DATA_BEGIN,
340 BINARY_PRINT_LINE_BEGIN,
341 BINARY_PRINT_ADDR,
342 BINARY_PRINT_NUM_DATA,
343 BINARY_PRINT_NUM_PAD,
344 BINARY_PRINT_SEP,
345 BINARY_PRINT_CHAR_DATA,
346 BINARY_PRINT_CHAR_PAD,
347 BINARY_PRINT_LINE_END,
348 BINARY_PRINT_DATA_END,
349 };
350
351 typedef void (*print_binary_t)(enum binary_printer_ops,
352 unsigned int val,
353 void *extra);
354
355 void print_binary(unsigned char *data, size_t len,
356 size_t bytes_per_line, print_binary_t printer,
357 void *extra);
358
359 #if !defined(__GLIBC__) && !defined(__ANDROID__)
360 extern int sched_getcpu(void);
361 #endif
362
363 int is_printable_array(char *p, unsigned int len);
364 #endif /* GIT_COMPAT_UTIL_H */
365