blob: 7a484c97e500cf6dab94a443729d242af5053d7f [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>
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -030072#include "types.h"
Arnaldo Carvalho de Melo46e3e052010-05-22 11:25:40 -030073#include <sys/ttydefaults.h>
Borislav Petkov13559152013-02-20 16:32:31 +010074#include <lk/debugfs.h>
Frederic Weisbecker1fe2c102009-08-12 10:19:53 +020075
Arnaldo Carvalho de Melo28902842009-11-23 17:51:08 -020076extern const char *graph_line;
77extern const char *graph_dotted_line;
Stephane Eranian45de34b2010-06-01 21:25:01 +020078extern char buildid_dir[];
Borislav Petkov13559152013-02-20 16:32:31 +010079extern char tracing_events_path[];
80extern void perf_debugfs_set_path(const char *mountpoint);
81const char *perf_debugfs_mount(const char *mountpoint);
Arnaldo Carvalho de Melo28902842009-11-23 17:51:08 -020082
Ingo Molnar07800602009-04-20 15:00:56 +020083/* On most systems <limits.h> would have given us this, but
84 * not on some systems (e.g. GNU/Hurd).
85 */
86#ifndef PATH_MAX
87#define PATH_MAX 4096
88#endif
89
90#ifndef PRIuMAX
91#define PRIuMAX "llu"
92#endif
93
94#ifndef PRIu32
95#define PRIu32 "u"
96#endif
97
98#ifndef PRIx32
99#define PRIx32 "x"
100#endif
101
102#ifndef PATH_SEP
103#define PATH_SEP ':'
104#endif
105
106#ifndef STRIP_EXTENSION
107#define STRIP_EXTENSION ""
108#endif
109
110#ifndef has_dos_drive_prefix
111#define has_dos_drive_prefix(path) 0
112#endif
113
114#ifndef is_dir_sep
115#define is_dir_sep(c) ((c) == '/')
116#endif
117
118#ifdef __GNUC__
119#define NORETURN __attribute__((__noreturn__))
120#else
121#define NORETURN
122#ifndef __attribute__
123#define __attribute__(x)
124#endif
125#endif
126
127/* General helper functions */
128extern void usage(const char *err) NORETURN;
129extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
130extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
131extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
132
Masami Hiramatsu97698332009-10-16 20:08:18 -0400133#include "../../../include/linux/stringify.h"
134
135#define DIE_IF(cnd) \
136 do { if (cnd) \
137 die(" at (" __FILE__ ":" __stringify(__LINE__) "): " \
138 __stringify(cnd) "\n"); \
139 } while (0)
140
141
Ingo Molnar07800602009-04-20 15:00:56 +0200142extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
143
144extern int prefixcmp(const char *str, const char *prefix);
Stephane Eranian45de34b2010-06-01 21:25:01 +0200145extern void set_buildid_dir(void);
Stephane Eraniana1ac1d32010-06-17 11:39:01 +0200146extern void disable_buildid_cache(void);
Ingo Molnar07800602009-04-20 15:00:56 +0200147
148static inline const char *skip_prefix(const char *str, const char *prefix)
149{
150 size_t len = strlen(prefix);
151 return strncmp(str, prefix, len) ? NULL : str + len;
152}
153
Ingo Molnar07800602009-04-20 15:00:56 +0200154#ifdef __GLIBC_PREREQ
155#if __GLIBC_PREREQ(2, 1)
156#define HAVE_STRCHRNUL
157#endif
158#endif
159
160#ifndef HAVE_STRCHRNUL
161#define strchrnul gitstrchrnul
162static inline char *gitstrchrnul(const char *s, int c)
163{
164 while (*s && *s != c)
165 s++;
166 return (char *)s;
167}
168#endif
169
Ingo Molnar6f06ccb2009-04-20 15:22:22 +0200170/*
171 * Wrappers:
172 */
173extern char *xstrdup(const char *str);
Arnaldo Carvalho de Melo727dad12009-11-24 12:05:17 -0200174extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
Ingo Molnar16f762a2009-05-27 09:10:38 +0200175
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400176
Arnaldo Carvalho de Melo36479482009-11-24 12:05:16 -0200177static inline void *zalloc(size_t size)
178{
179 return calloc(1, size);
180}
181
Ingo Molnar07800602009-04-20 15:00:56 +0200182static inline int has_extension(const char *filename, const char *ext)
183{
184 size_t len = strlen(filename);
185 size_t extlen = strlen(ext);
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400186
Ingo Molnar07800602009-04-20 15:00:56 +0200187 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
188}
189
190/* Sane ctype - no locale, and works with signed chars */
191#undef isascii
192#undef isspace
193#undef isdigit
Frederic Weisbecker9e827dd2009-11-11 04:51:07 +0100194#undef isxdigit
Ingo Molnar07800602009-04-20 15:00:56 +0200195#undef isalpha
Frederic Weisbecker5f9c39d2009-08-17 16:18:08 +0200196#undef isprint
Ingo Molnar07800602009-04-20 15:00:56 +0200197#undef isalnum
Namhyung Kim2cd13b0f2012-02-10 10:10:15 +0900198#undef islower
199#undef isupper
Ingo Molnar07800602009-04-20 15:00:56 +0200200#undef tolower
201#undef toupper
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400202
Arnaldo Carvalho de Melo752fde42012-10-06 18:43:19 -0300203#ifndef NSEC_PER_MSEC
204#define NSEC_PER_MSEC 1000000L
205#endif
206
Ingo Molnar07800602009-04-20 15:00:56 +0200207extern unsigned char sane_ctype[256];
Peter Zijlstraa73c7d82009-06-18 09:44:20 +0200208#define GIT_SPACE 0x01
209#define GIT_DIGIT 0x02
210#define GIT_ALPHA 0x04
211#define GIT_GLOB_SPECIAL 0x08
212#define GIT_REGEX_SPECIAL 0x10
213#define GIT_PRINT_EXTRA 0x20
214#define GIT_PRINT 0x3E
Ingo Molnar07800602009-04-20 15:00:56 +0200215#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
216#define isascii(x) (((x) & ~0x7f) == 0)
217#define isspace(x) sane_istest(x,GIT_SPACE)
218#define isdigit(x) sane_istest(x,GIT_DIGIT)
Frederic Weisbecker9e827dd2009-11-11 04:51:07 +0100219#define isxdigit(x) \
220 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
Ingo Molnar07800602009-04-20 15:00:56 +0200221#define isalpha(x) sane_istest(x,GIT_ALPHA)
222#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
Peter Zijlstraa73c7d82009-06-18 09:44:20 +0200223#define isprint(x) sane_istest(x,GIT_PRINT)
Sukadev Bhattiprolu69566642013-03-29 12:14:43 -0700224#define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
225#define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
Ingo Molnar07800602009-04-20 15:00:56 +0200226#define tolower(x) sane_case((unsigned char)(x), 0x20)
227#define toupper(x) sane_case((unsigned char)(x), 0)
228
229static inline int sane_case(int x, int high)
230{
231 if (sane_istest(x, GIT_ALPHA))
232 x = (x & ~0x20) | high;
233 return x;
234}
235
Arnaldo Carvalho de Melo4cf40132009-12-27 21:37:06 -0200236int mkdir_p(char *path, mode_t mode);
237int copyfile(const char *from, const char *to);
238
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300239s64 perf_atoll(const char *str);
240char **argv_split(const char *str, int *argcp);
241void argv_free(char **argv);
242bool strglobmatch(const char *str, const char *pat);
243bool strlazymatch(const char *str, const char *pat);
Masami Hiramatsubad03ae2011-06-27 16:27:15 +0900244int strtailcmp(const char *s1, const char *s2);
Jiri Olsaea36c462012-10-27 23:18:31 +0200245char *strxfrchar(char *s, char from, char to);
Arnaldo Carvalho de Meloc82ee822010-05-14 14:19:35 -0300246unsigned long convert_unit(unsigned long value, char *unit);
Arnaldo Carvalho de Melo1e7972c2011-01-03 16:50:55 -0200247int readn(int fd, void *buf, size_t size);
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300248
Joerg Roedel1aed2672012-01-04 17:54:20 +0100249struct perf_event_attr;
250
251void event_attr_init(struct perf_event_attr *attr);
252
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300253#define _STR(x) #x
254#define STR(x) _STR(x)
255
Nelson Elhage41d0d932011-12-19 08:39:32 -0500256/*
257 * Determine whether some value is a power of two, where zero is
258 * *not* considered a power of two.
259 */
260
261static inline __attribute__((const))
262bool is_power_of_2(unsigned long n)
263{
264 return (n != 0 && ((n & (n - 1)) == 0));
265}
266
Arnaldo Carvalho de Melo61e04b32012-04-19 13:15:24 -0300267size_t hex_width(u64 v);
Jiri Olsab2aff5f2012-10-27 23:18:30 +0200268int hex2u64(const char *ptr, u64 *val);
Arnaldo Carvalho de Melo61e04b32012-04-19 13:15:24 -0300269
Namhyung Kim08aa9cc2013-01-22 18:09:41 +0900270char *ltrim(char *s);
Arnaldo Carvalho de Melocb1a28a2012-06-07 18:23:31 -0300271char *rtrim(char *s);
272
Arnaldo Carvalho de Melodc4552b2012-08-07 23:32:05 -0300273void dump_stack(void);
274
Arnaldo Carvalho de Melo0c1fe6b2012-10-06 14:57:10 -0300275extern unsigned int page_size;
276
David Ahern2c803e52013-01-14 10:48:01 -0700277struct winsize;
278void get_term_dimensions(struct winsize *ws);
Borislav Petkov13559152013-02-20 16:32:31 +0100279#endif /* GIT_COMPAT_UTIL_H */