blob: 66864364ccb482230e203b5369ee1fe004fadf78 [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
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -030042#define HAS_BOOL
Ingo Molnar07800602009-04-20 15:00:56 +020043
44#include <unistd.h>
45#include <stdio.h>
46#include <sys/stat.h>
Jason Baronf6bdafe2009-07-21 12:20:22 -040047#include <sys/statfs.h>
Ingo Molnar07800602009-04-20 15:00:56 +020048#include <fcntl.h>
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -030049#include <stdbool.h>
Ingo Molnar07800602009-04-20 15:00:56 +020050#include <stddef.h>
51#include <stdlib.h>
52#include <stdarg.h>
53#include <string.h>
54#include <errno.h>
55#include <limits.h>
56#include <sys/param.h>
57#include <sys/types.h>
58#include <dirent.h>
59#include <sys/time.h>
60#include <time.h>
61#include <signal.h>
62#include <fnmatch.h>
63#include <assert.h>
64#include <regex.h>
65#include <utime.h>
Ingo Molnar07800602009-04-20 15:00:56 +020066#include <sys/wait.h>
67#include <sys/poll.h>
68#include <sys/socket.h>
69#include <sys/ioctl.h>
Ingo Molnar07800602009-04-20 15:00:56 +020070#include <inttypes.h>
Irina Tirdeaf8fcd772012-09-11 01:14:58 +030071#include <linux/magic.h>
Borislav Petkovd944c4e2014-04-25 21:31:02 +020072#include <linux/types.h>
Arnaldo Carvalho de Melo46e3e052010-05-22 11:25:40 -030073#include <sys/ttydefaults.h>
Borislav Petkov553873e2013-12-09 17:14:23 +010074#include <api/fs/debugfs.h>
Joonsoo Kim756bbc82013-06-19 10:02:30 +090075#include <termios.h>
Adrian Hunter1dbfa9382013-12-09 15:18:39 +020076#include <linux/bitops.h>
Frederic Weisbecker1fe2c102009-08-12 10:19:53 +020077
Arnaldo Carvalho de Melo28902842009-11-23 17:51:08 -020078extern const char *graph_line;
79extern const char *graph_dotted_line;
Stephane Eranian45de34b2010-06-01 21:25:01 +020080extern char buildid_dir[];
Borislav Petkov13559152013-02-20 16:32:31 +010081extern char tracing_events_path[];
82extern void perf_debugfs_set_path(const char *mountpoint);
83const char *perf_debugfs_mount(const char *mountpoint);
Namhyung Kim167aedc2013-06-26 16:14:04 +090084const char *find_tracing_dir(void);
85char *get_tracing_file(const char *name);
86void put_tracing_file(char *file);
Arnaldo Carvalho de Melo28902842009-11-23 17:51:08 -020087
Ingo Molnar07800602009-04-20 15:00:56 +020088/* On most systems <limits.h> would have given us this, but
89 * not on some systems (e.g. GNU/Hurd).
90 */
91#ifndef PATH_MAX
92#define PATH_MAX 4096
93#endif
94
95#ifndef PRIuMAX
96#define PRIuMAX "llu"
97#endif
98
99#ifndef PRIu32
100#define PRIu32 "u"
101#endif
102
103#ifndef PRIx32
104#define PRIx32 "x"
105#endif
106
107#ifndef PATH_SEP
108#define PATH_SEP ':'
109#endif
110
111#ifndef STRIP_EXTENSION
112#define STRIP_EXTENSION ""
113#endif
114
115#ifndef has_dos_drive_prefix
116#define has_dos_drive_prefix(path) 0
117#endif
118
119#ifndef is_dir_sep
120#define is_dir_sep(c) ((c) == '/')
121#endif
122
123#ifdef __GNUC__
124#define NORETURN __attribute__((__noreturn__))
125#else
126#define NORETURN
127#ifndef __attribute__
128#define __attribute__(x)
129#endif
130#endif
131
Namhyung Kimfc672972013-09-13 15:27:43 +0900132#define PERF_GTK_DSO "libperf-gtk.so"
133
Ingo Molnar07800602009-04-20 15:00:56 +0200134/* General helper functions */
135extern void usage(const char *err) NORETURN;
136extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
137extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
138extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
139
Masami Hiramatsu97698332009-10-16 20:08:18 -0400140#include "../../../include/linux/stringify.h"
141
142#define DIE_IF(cnd) \
143 do { if (cnd) \
144 die(" at (" __FILE__ ":" __stringify(__LINE__) "): " \
145 __stringify(cnd) "\n"); \
146 } while (0)
147
148
Ingo Molnar07800602009-04-20 15:00:56 +0200149extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
150
151extern int prefixcmp(const char *str, const char *prefix);
Stephane Eranian45de34b2010-06-01 21:25:01 +0200152extern void set_buildid_dir(void);
Stephane Eraniana1ac1d32010-06-17 11:39:01 +0200153extern void disable_buildid_cache(void);
Ingo Molnar07800602009-04-20 15:00:56 +0200154
155static inline const char *skip_prefix(const char *str, const char *prefix)
156{
157 size_t len = strlen(prefix);
158 return strncmp(str, prefix, len) ? NULL : str + len;
159}
160
Ingo Molnar07800602009-04-20 15:00:56 +0200161#ifdef __GLIBC_PREREQ
162#if __GLIBC_PREREQ(2, 1)
163#define HAVE_STRCHRNUL
164#endif
165#endif
166
167#ifndef HAVE_STRCHRNUL
168#define strchrnul gitstrchrnul
169static inline char *gitstrchrnul(const char *s, int c)
170{
171 while (*s && *s != c)
172 s++;
173 return (char *)s;
174}
175#endif
176
Ingo Molnar6f06ccb2009-04-20 15:22:22 +0200177/*
178 * Wrappers:
179 */
180extern char *xstrdup(const char *str);
Arnaldo Carvalho de Melo727dad12009-11-24 12:05:17 -0200181extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
Ingo Molnar16f762a2009-05-27 09:10:38 +0200182
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400183
Arnaldo Carvalho de Melo36479482009-11-24 12:05:16 -0200184static inline void *zalloc(size_t size)
185{
186 return calloc(1, size);
187}
188
Arnaldo Carvalho de Melo04662522013-12-26 17:41:15 -0300189#define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
190
Ingo Molnar07800602009-04-20 15:00:56 +0200191static inline int has_extension(const char *filename, const char *ext)
192{
193 size_t len = strlen(filename);
194 size_t extlen = strlen(ext);
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400195
Ingo Molnar07800602009-04-20 15:00:56 +0200196 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
197}
198
199/* Sane ctype - no locale, and works with signed chars */
200#undef isascii
201#undef isspace
202#undef isdigit
Frederic Weisbecker9e827dd2009-11-11 04:51:07 +0100203#undef isxdigit
Ingo Molnar07800602009-04-20 15:00:56 +0200204#undef isalpha
Frederic Weisbecker5f9c39d2009-08-17 16:18:08 +0200205#undef isprint
Ingo Molnar07800602009-04-20 15:00:56 +0200206#undef isalnum
Namhyung Kim2cd13b0f2012-02-10 10:10:15 +0900207#undef islower
208#undef isupper
Ingo Molnar07800602009-04-20 15:00:56 +0200209#undef tolower
210#undef toupper
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400211
Arnaldo Carvalho de Melo752fde42012-10-06 18:43:19 -0300212#ifndef NSEC_PER_MSEC
213#define NSEC_PER_MSEC 1000000L
214#endif
215
Namhyung Kim3b47abe2013-06-04 10:50:29 +0900216int parse_nsec_time(const char *str, u64 *ptime);
217
Ingo Molnar07800602009-04-20 15:00:56 +0200218extern unsigned char sane_ctype[256];
Peter Zijlstraa73c7d82009-06-18 09:44:20 +0200219#define GIT_SPACE 0x01
220#define GIT_DIGIT 0x02
221#define GIT_ALPHA 0x04
222#define GIT_GLOB_SPECIAL 0x08
223#define GIT_REGEX_SPECIAL 0x10
224#define GIT_PRINT_EXTRA 0x20
225#define GIT_PRINT 0x3E
Ingo Molnar07800602009-04-20 15:00:56 +0200226#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
227#define isascii(x) (((x) & ~0x7f) == 0)
228#define isspace(x) sane_istest(x,GIT_SPACE)
229#define isdigit(x) sane_istest(x,GIT_DIGIT)
Frederic Weisbecker9e827dd2009-11-11 04:51:07 +0100230#define isxdigit(x) \
231 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
Ingo Molnar07800602009-04-20 15:00:56 +0200232#define isalpha(x) sane_istest(x,GIT_ALPHA)
233#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
Peter Zijlstraa73c7d82009-06-18 09:44:20 +0200234#define isprint(x) sane_istest(x,GIT_PRINT)
Sukadev Bhattiprolu69566642013-03-29 12:14:43 -0700235#define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
236#define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
Ingo Molnar07800602009-04-20 15:00:56 +0200237#define tolower(x) sane_case((unsigned char)(x), 0x20)
238#define toupper(x) sane_case((unsigned char)(x), 0)
239
240static inline int sane_case(int x, int high)
241{
242 if (sane_istest(x, GIT_ALPHA))
243 x = (x & ~0x20) | high;
244 return x;
245}
246
Arnaldo Carvalho de Melo4cf40132009-12-27 21:37:06 -0200247int mkdir_p(char *path, mode_t mode);
248int copyfile(const char *from, const char *to);
Adrian Hunter9a17d722013-10-14 13:43:41 +0300249int copyfile_mode(const char *from, const char *to, mode_t mode);
Arnaldo Carvalho de Melo4cf40132009-12-27 21:37:06 -0200250
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300251s64 perf_atoll(const char *str);
252char **argv_split(const char *str, int *argcp);
253void argv_free(char **argv);
254bool strglobmatch(const char *str, const char *pat);
255bool strlazymatch(const char *str, const char *pat);
Masami Hiramatsubad03ae2011-06-27 16:27:15 +0900256int strtailcmp(const char *s1, const char *s2);
Jiri Olsaea36c462012-10-27 23:18:31 +0200257char *strxfrchar(char *s, char from, char to);
Arnaldo Carvalho de Meloc82ee822010-05-14 14:19:35 -0300258unsigned long convert_unit(unsigned long value, char *unit);
Jiri Olsa727ebd52013-11-28 11:30:14 +0100259ssize_t readn(int fd, void *buf, size_t n);
Jiri Olsabc3a5022013-11-28 11:30:16 +0100260ssize_t writen(int fd, void *buf, size_t n);
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300261
Joerg Roedel1aed2672012-01-04 17:54:20 +0100262struct perf_event_attr;
263
264void event_attr_init(struct perf_event_attr *attr);
265
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300266#define _STR(x) #x
267#define STR(x) _STR(x)
268
Nelson Elhage41d0d932011-12-19 08:39:32 -0500269/*
270 * Determine whether some value is a power of two, where zero is
271 * *not* considered a power of two.
272 */
273
274static inline __attribute__((const))
275bool is_power_of_2(unsigned long n)
276{
277 return (n != 0 && ((n & (n - 1)) == 0));
278}
279
Jiri Olsa27050f52013-09-01 12:36:13 +0200280static inline unsigned next_pow2(unsigned x)
281{
282 if (!x)
283 return 1;
284 return 1ULL << (32 - __builtin_clz(x - 1));
285}
286
Adrian Hunter1dbfa9382013-12-09 15:18:39 +0200287static inline unsigned long next_pow2_l(unsigned long x)
288{
289#if BITS_PER_LONG == 64
290 if (x <= (1UL << 31))
291 return next_pow2(x);
292 return (unsigned long)next_pow2(x >> 32) << 32;
293#else
294 return next_pow2(x);
295#endif
296}
297
Arnaldo Carvalho de Melo61e04b32012-04-19 13:15:24 -0300298size_t hex_width(u64 v);
Jiri Olsab2aff5f2012-10-27 23:18:30 +0200299int hex2u64(const char *ptr, u64 *val);
Arnaldo Carvalho de Melo61e04b32012-04-19 13:15:24 -0300300
Namhyung Kim08aa9cc2013-01-22 18:09:41 +0900301char *ltrim(char *s);
Arnaldo Carvalho de Melocb1a28a2012-06-07 18:23:31 -0300302char *rtrim(char *s);
303
Arnaldo Carvalho de Melodc4552b2012-08-07 23:32:05 -0300304void dump_stack(void);
305
Arnaldo Carvalho de Melo0c1fe6b2012-10-06 14:57:10 -0300306extern unsigned int page_size;
Don Zickus2b1b7102014-05-30 16:10:05 -0400307extern int cacheline_size;
Arnaldo Carvalho de Melo0c1fe6b2012-10-06 14:57:10 -0300308
David Ahern2c803e52013-01-14 10:48:01 -0700309void get_term_dimensions(struct winsize *ws);
Jiri Olsa27050f52013-09-01 12:36:13 +0200310
311struct parse_tag {
312 char tag;
313 int mult;
314};
315
316unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
Namhyung Kimf048d542013-09-11 14:09:28 +0900317
318#define SRCLINE_UNKNOWN ((char *) "??:0")
319
Namhyung Kim86c98ca2013-09-11 14:09:30 +0900320struct dso;
321
322char *get_srcline(struct dso *dso, unsigned long addr);
Namhyung Kimf048d542013-09-11 14:09:28 +0900323void free_srcline(char *srcline);
Arnaldo Carvalho de Melo97a07f12013-10-17 16:33:43 -0300324
325int filename__read_int(const char *filename, int *value);
Jiri Olsacef82c92013-12-03 14:09:22 +0100326int filename__read_str(const char *filename, char **buf, size_t *sizep);
Adrian Hunter1a472452013-12-11 14:36:23 +0200327int perf_event_paranoid(void);
Dongsheng Yange1a2b172013-12-06 17:25:51 -0500328
Adrian Hunter71db07b2013-12-11 14:36:32 +0200329void mem_bswap_64(void *src, int byte_size);
330void mem_bswap_32(void *src, int byte_size);
331
Dongsheng Yange1a2b172013-12-06 17:25:51 -0500332const char *get_filename_for_perf_kvm(void);
Borislav Petkov13559152013-02-20 16:32:31 +0100333#endif /* GIT_COMPAT_UTIL_H */