blob: 88f607af1f47036842f6ff77ad2c203b68dcb7c3 [file] [log] [blame]
Ingo Molnar07800602009-04-20 15:00:56 +02001#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
Ingo Molnar07800602009-04-20 15:00:56 +02004#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
Ingo Molnar07800602009-04-20 15:00:56 +020040#define _ALL_SOURCE 1
Ingo Molnar07800602009-04-20 15:00:56 +020041#define _BSD_SOURCE 1
Chanho Park512fe362014-09-12 11:10:17 +090042/* glibc 2.20 deprecates _BSD_SOURCE in favour of _DEFAULT_SOURCE */
43#define _DEFAULT_SOURCE 1
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -030044#define HAS_BOOL
Ingo Molnar07800602009-04-20 15:00:56 +020045
46#include <unistd.h>
47#include <stdio.h>
48#include <sys/stat.h>
Jason Baronf6bdafe2009-07-21 12:20:22 -040049#include <sys/statfs.h>
Ingo Molnar07800602009-04-20 15:00:56 +020050#include <fcntl.h>
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -030051#include <stdbool.h>
Ingo Molnar07800602009-04-20 15:00:56 +020052#include <stddef.h>
53#include <stdlib.h>
54#include <stdarg.h>
55#include <string.h>
Josh Poimboeuf1fe143c2015-12-07 22:21:42 -060056#include <term.h>
Ingo Molnar07800602009-04-20 15:00:56 +020057#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>
Ingo Molnar07800602009-04-20 15:00:56 +020069#include <sys/wait.h>
Arnaldo Carvalho de Meloa8fa4962014-09-15 15:54:34 -030070#include <poll.h>
Ingo Molnar07800602009-04-20 15:00:56 +020071#include <sys/socket.h>
72#include <sys/ioctl.h>
Ingo Molnar07800602009-04-20 15:00:56 +020073#include <inttypes.h>
Arnaldo Carvalho de Melo972f3932014-07-29 10:21:58 -030074#include <linux/kernel.h>
Irina Tirdeaf8fcd772012-09-11 01:14:58 +030075#include <linux/magic.h>
Borislav Petkovd944c4e2014-04-25 21:31:02 +020076#include <linux/types.h>
Arnaldo Carvalho de Melo46e3e052010-05-22 11:25:40 -030077#include <sys/ttydefaults.h>
Jiri Olsa4605eab2015-09-02 09:56:43 +020078#include <api/fs/tracing_path.h>
Joonsoo Kim756bbc82013-06-19 10:02:30 +090079#include <termios.h>
Adrian Hunter1dbfa9382013-12-09 15:18:39 +020080#include <linux/bitops.h>
Jiri Olsa9398c482014-08-11 10:50:02 +020081#include <termios.h>
Masami Hiramatsue1ce7262016-04-26 18:02:42 +090082#include "strlist.h"
Frederic Weisbecker1fe2c102009-08-12 10:19:53 +020083
Arnaldo Carvalho de Melo28902842009-11-23 17:51:08 -020084extern const char *graph_line;
85extern const char *graph_dotted_line;
Namhyung Kim8e2fc442016-02-25 00:13:42 +090086extern const char *spaces;
87extern const char *dots;
Stephane Eranian45de34b2010-06-01 21:25:01 +020088extern char buildid_dir[];
Arnaldo Carvalho de Melo28902842009-11-23 17:51:08 -020089
Ingo Molnar07800602009-04-20 15:00:56 +020090/* On most systems <limits.h> would have given us this, but
91 * not on some systems (e.g. GNU/Hurd).
92 */
93#ifndef PATH_MAX
94#define PATH_MAX 4096
95#endif
96
97#ifndef PRIuMAX
98#define PRIuMAX "llu"
99#endif
100
101#ifndef PRIu32
102#define PRIu32 "u"
103#endif
104
105#ifndef PRIx32
106#define PRIx32 "x"
107#endif
108
109#ifndef PATH_SEP
110#define PATH_SEP ':'
111#endif
112
113#ifndef STRIP_EXTENSION
114#define STRIP_EXTENSION ""
115#endif
116
117#ifndef has_dos_drive_prefix
118#define has_dos_drive_prefix(path) 0
119#endif
120
121#ifndef is_dir_sep
122#define is_dir_sep(c) ((c) == '/')
123#endif
124
125#ifdef __GNUC__
126#define NORETURN __attribute__((__noreturn__))
127#else
128#define NORETURN
129#ifndef __attribute__
130#define __attribute__(x)
131#endif
132#endif
133
Namhyung Kimfc672972013-09-13 15:27:43 +0900134#define PERF_GTK_DSO "libperf-gtk.so"
135
Ingo Molnar07800602009-04-20 15:00:56 +0200136/* General helper functions */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300137void usage(const char *err) NORETURN;
138void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
139int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
140void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
Ingo Molnar07800602009-04-20 15:00:56 +0200141
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300142void set_warning_routine(void (*routine)(const char *err, va_list params));
Ingo Molnar07800602009-04-20 15:00:56 +0200143
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300144int prefixcmp(const char *str, const char *prefix);
145void set_buildid_dir(const char *dir);
Ingo Molnar07800602009-04-20 15:00:56 +0200146
Ingo Molnar07800602009-04-20 15:00:56 +0200147#ifdef __GLIBC_PREREQ
148#if __GLIBC_PREREQ(2, 1)
149#define HAVE_STRCHRNUL
150#endif
151#endif
152
153#ifndef HAVE_STRCHRNUL
154#define strchrnul gitstrchrnul
155static inline char *gitstrchrnul(const char *s, int c)
156{
157 while (*s && *s != c)
158 s++;
159 return (char *)s;
160}
161#endif
162
Ingo Molnar6f06ccb2009-04-20 15:22:22 +0200163/*
164 * Wrappers:
165 */
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300166void *xrealloc(void *ptr, size_t size) __attribute__((weak));
Ingo Molnar16f762a2009-05-27 09:10:38 +0200167
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400168
Arnaldo Carvalho de Melo36479482009-11-24 12:05:16 -0200169static inline void *zalloc(size_t size)
170{
171 return calloc(1, size);
172}
173
Arnaldo Carvalho de Melo04662522013-12-26 17:41:15 -0300174#define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
175
Ingo Molnar07800602009-04-20 15:00:56 +0200176/* Sane ctype - no locale, and works with signed chars */
177#undef isascii
178#undef isspace
179#undef isdigit
Frederic Weisbecker9e827dd2009-11-11 04:51:07 +0100180#undef isxdigit
Ingo Molnar07800602009-04-20 15:00:56 +0200181#undef isalpha
Frederic Weisbecker5f9c39d2009-08-17 16:18:08 +0200182#undef isprint
Ingo Molnar07800602009-04-20 15:00:56 +0200183#undef isalnum
Namhyung Kim2cd13b02012-02-10 10:10:15 +0900184#undef islower
185#undef isupper
Ingo Molnar07800602009-04-20 15:00:56 +0200186#undef tolower
187#undef toupper
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400188
Arnaldo Carvalho de Melo752fde42012-10-06 18:43:19 -0300189#ifndef NSEC_PER_MSEC
190#define NSEC_PER_MSEC 1000000L
191#endif
192
Namhyung Kim3b47abe2013-06-04 10:50:29 +0900193int parse_nsec_time(const char *str, u64 *ptime);
194
Ingo Molnar07800602009-04-20 15:00:56 +0200195extern unsigned char sane_ctype[256];
Peter Zijlstraa73c7d82009-06-18 09:44:20 +0200196#define GIT_SPACE 0x01
197#define GIT_DIGIT 0x02
198#define GIT_ALPHA 0x04
199#define GIT_GLOB_SPECIAL 0x08
200#define GIT_REGEX_SPECIAL 0x10
201#define GIT_PRINT_EXTRA 0x20
202#define GIT_PRINT 0x3E
Ingo Molnar07800602009-04-20 15:00:56 +0200203#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
204#define isascii(x) (((x) & ~0x7f) == 0)
205#define isspace(x) sane_istest(x,GIT_SPACE)
206#define isdigit(x) sane_istest(x,GIT_DIGIT)
Frederic Weisbecker9e827dd2009-11-11 04:51:07 +0100207#define isxdigit(x) \
208 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
Ingo Molnar07800602009-04-20 15:00:56 +0200209#define isalpha(x) sane_istest(x,GIT_ALPHA)
210#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
Peter Zijlstraa73c7d82009-06-18 09:44:20 +0200211#define isprint(x) sane_istest(x,GIT_PRINT)
Sukadev Bhattiprolu69566642013-03-29 12:14:43 -0700212#define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
213#define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
Ingo Molnar07800602009-04-20 15:00:56 +0200214#define tolower(x) sane_case((unsigned char)(x), 0x20)
215#define toupper(x) sane_case((unsigned char)(x), 0)
216
217static inline int sane_case(int x, int high)
218{
219 if (sane_istest(x, GIT_ALPHA))
220 x = (x & ~0x20) | high;
221 return x;
222}
223
Arnaldo Carvalho de Melo4cf40132009-12-27 21:37:06 -0200224int mkdir_p(char *path, mode_t mode);
Namhyung Kim0b1de0be2015-05-18 09:30:17 +0900225int rm_rf(char *path);
Masami Hiramatsue1ce7262016-04-26 18:02:42 +0900226struct strlist *lsdir(const char *name, bool (*filter)(const char *, struct dirent *));
227bool lsdir_no_dot_filter(const char *name, struct dirent *d);
Arnaldo Carvalho de Melo4cf40132009-12-27 21:37:06 -0200228int copyfile(const char *from, const char *to);
Adrian Hunter9a17d722013-10-14 13:43:41 +0300229int copyfile_mode(const char *from, const char *to, mode_t mode);
Namhyung Kim9c9f5a22015-05-18 09:30:18 +0900230int copyfile_offset(int fromfd, loff_t from_ofs, int tofd, loff_t to_ofs, u64 size);
Arnaldo Carvalho de Melo4cf40132009-12-27 21:37:06 -0200231
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300232s64 perf_atoll(const char *str);
233char **argv_split(const char *str, int *argcp);
234void argv_free(char **argv);
235bool strglobmatch(const char *str, const char *pat);
236bool strlazymatch(const char *str, const char *pat);
Masami Hiramatsu4c859352015-05-08 10:03:35 +0900237static inline bool strisglob(const char *str)
238{
239 return strpbrk(str, "*?[") != NULL;
240}
Masami Hiramatsubad03ae2011-06-27 16:27:15 +0900241int strtailcmp(const char *s1, const char *s2);
Jiri Olsaea36c462012-10-27 23:18:31 +0200242char *strxfrchar(char *s, char from, char to);
Arnaldo Carvalho de Meloc82ee822010-05-14 14:19:35 -0300243unsigned long convert_unit(unsigned long value, char *unit);
Jiri Olsa727ebd52013-11-28 11:30:14 +0100244ssize_t readn(int fd, void *buf, size_t n);
Jiri Olsabc3a5022013-11-28 11:30:16 +0100245ssize_t writen(int fd, void *buf, size_t n);
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300246
Joerg Roedel1aed2672012-01-04 17:54:20 +0100247struct perf_event_attr;
248
249void event_attr_init(struct perf_event_attr *attr);
250
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300251#define _STR(x) #x
252#define STR(x) _STR(x)
253
Arnaldo Carvalho de Melo61e04b32012-04-19 13:15:24 -0300254size_t hex_width(u64 v);
Jiri Olsab2aff5f2012-10-27 23:18:30 +0200255int hex2u64(const char *ptr, u64 *val);
Arnaldo Carvalho de Melo61e04b32012-04-19 13:15:24 -0300256
Namhyung Kim08aa9cc2013-01-22 18:09:41 +0900257char *ltrim(char *s);
Arnaldo Carvalho de Melocb1a28a2012-06-07 18:23:31 -0300258char *rtrim(char *s);
259
Jiri Olsa7d6a7e72016-04-07 09:11:11 +0200260static inline char *trim(char *s)
261{
262 return ltrim(rtrim(s));
263}
264
Arnaldo Carvalho de Melodc4552b2012-08-07 23:32:05 -0300265void dump_stack(void);
Arnaldo Carvalho de Melo07c1a0d2015-02-24 15:34:23 -0300266void sighandler_dump_stack(int sig);
Arnaldo Carvalho de Melodc4552b2012-08-07 23:32:05 -0300267
Arnaldo Carvalho de Melo0c1fe6b2012-10-06 14:57:10 -0300268extern unsigned int page_size;
Don Zickus2b1b7102014-05-30 16:10:05 -0400269extern int cacheline_size;
Arnaldo Carvalho de Melo4cb93442016-04-27 10:16:24 -0300270extern unsigned int sysctl_perf_event_max_stack;
Arnaldo Carvalho de Melo0c1fe6b2012-10-06 14:57:10 -0300271
Jiri Olsa27050f52013-09-01 12:36:13 +0200272struct parse_tag {
273 char tag;
274 int mult;
275};
276
277unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
Namhyung Kimf048d542013-09-11 14:09:28 +0900278
279#define SRCLINE_UNKNOWN ((char *) "??:0")
280
Arnaldo Carvalho de Melo972f3932014-07-29 10:21:58 -0300281static inline int path__join(char *bf, size_t size,
282 const char *path1, const char *path2)
283{
284 return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
285}
286
287static inline int path__join3(char *bf, size_t size,
288 const char *path1, const char *path2,
289 const char *path3)
290{
291 return scnprintf(bf, size, "%s%s%s%s%s",
292 path1, path1[0] ? "/" : "",
293 path2, path2[0] ? "/" : "", path3);
294}
295
Namhyung Kim86c98ca2013-09-11 14:09:30 +0900296struct dso;
Andi Kleen85c116a2014-11-12 18:05:27 -0800297struct symbol;
Namhyung Kim86c98ca2013-09-11 14:09:30 +0900298
Andi Kleena9710ba2015-08-07 15:24:05 -0700299extern bool srcline_full_filename;
Wang Nanac931f82014-12-16 14:19:06 +0800300char *get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
Andi Kleen85c116a2014-11-12 18:05:27 -0800301 bool show_sym);
Andi Kleen2f84b422015-09-01 11:47:19 -0700302char *__get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
303 bool show_sym, bool unwind_inlines);
Namhyung Kimf048d542013-09-11 14:09:28 +0900304void free_srcline(char *srcline);
Arnaldo Carvalho de Melo97a07f12013-10-17 16:33:43 -0300305
Adrian Hunter1a472452013-12-11 14:36:23 +0200306int perf_event_paranoid(void);
Dongsheng Yange1a2b172013-12-06 17:25:51 -0500307
Adrian Hunter71db07b2013-12-11 14:36:32 +0200308void mem_bswap_64(void *src, int byte_size);
309void mem_bswap_32(void *src, int byte_size);
310
Dongsheng Yange1a2b172013-12-06 17:25:51 -0500311const char *get_filename_for_perf_kvm(void);
Jiri Olsa63914ac2014-08-01 17:46:54 +0200312bool find_process(const char *name);
Namhyung Kime92ce122014-10-31 16:51:38 +0900313
314#ifdef HAVE_ZLIB_SUPPORT
315int gzip_decompress_to_file(const char *input, int output_fd);
316#endif
317
Jiri Olsa80a32e5b2015-01-29 13:29:39 +0100318#ifdef HAVE_LZMA_SUPPORT
319int lzma_decompress_to_file(const char *input, int output_fd);
320#endif
321
Arnaldo Carvalho de Melo93ec4ce2015-07-02 17:48:23 -0300322char *asprintf_expr_inout_ints(const char *var, bool in, size_t nints, int *ints);
323
324static inline char *asprintf_expr_in_ints(const char *var, size_t nints, int *ints)
325{
326 return asprintf_expr_inout_ints(var, true, nints, ints);
327}
328
329static inline char *asprintf_expr_not_in_ints(const char *var, size_t nints, int *ints)
330{
331 return asprintf_expr_inout_ints(var, false, nints, ints);
332}
333
Kan Liang076a30c2015-08-06 15:44:52 -0400334int get_stack_size(const char *str, unsigned long *_size);
335
Wang Nan07bc5c62015-11-06 13:55:35 +0000336int fetch_kernel_version(unsigned int *puint,
337 char *str, size_t str_sz);
Wang Nand3e0ce32015-11-06 13:58:09 +0000338#define KVER_VERSION(x) (((x) >> 16) & 0xff)
339#define KVER_PATCHLEVEL(x) (((x) >> 8) & 0xff)
340#define KVER_SUBLEVEL(x) ((x) & 0xff)
341#define KVER_FMT "%d.%d.%d"
342#define KVER_PARAM(x) KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)
Wang Nan07bc5c62015-11-06 13:55:35 +0000343
Namhyung Kim14cbfbe2016-01-07 20:41:53 +0900344const char *perf_tip(const char *dirpath);
Jiri Olsa40356722016-01-20 12:56:32 +0100345bool is_regular_file(const char *file);
Wang Nan37b20152016-01-25 09:56:13 +0000346int fetch_current_timestamp(char *buf, size_t sz);
Namhyung Kim14cbfbe2016-01-07 20:41:53 +0900347
Wang Nanc339b1a2016-02-24 11:20:44 +0000348enum binary_printer_ops {
349 BINARY_PRINT_DATA_BEGIN,
350 BINARY_PRINT_LINE_BEGIN,
351 BINARY_PRINT_ADDR,
352 BINARY_PRINT_NUM_DATA,
353 BINARY_PRINT_NUM_PAD,
354 BINARY_PRINT_SEP,
355 BINARY_PRINT_CHAR_DATA,
356 BINARY_PRINT_CHAR_PAD,
357 BINARY_PRINT_LINE_END,
358 BINARY_PRINT_DATA_END,
359};
360
361typedef void (*print_binary_t)(enum binary_printer_ops,
362 unsigned int val,
363 void *extra);
364
365void print_binary(unsigned char *data, size_t len,
366 size_t bytes_per_line, print_binary_t printer,
367 void *extra);
Borislav Petkov13559152013-02-20 16:32:31 +0100368#endif /* GIT_COMPAT_UTIL_H */