blob: a53535949043f32654a181c3728a421c52baf276 [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>
Joonsoo Kim756bbc82013-06-19 10:02:30 +090075#include <termios.h>
Frederic Weisbecker1fe2c102009-08-12 10:19:53 +020076
Arnaldo Carvalho de Melo28902842009-11-23 17:51:08 -020077extern const char *graph_line;
78extern const char *graph_dotted_line;
Stephane Eranian45de34b2010-06-01 21:25:01 +020079extern char buildid_dir[];
Borislav Petkov13559152013-02-20 16:32:31 +010080extern char tracing_events_path[];
81extern void perf_debugfs_set_path(const char *mountpoint);
82const char *perf_debugfs_mount(const char *mountpoint);
Namhyung Kim167aedc2013-06-26 16:14:04 +090083const char *find_tracing_dir(void);
84char *get_tracing_file(const char *name);
85void put_tracing_file(char *file);
Arnaldo Carvalho de Melo28902842009-11-23 17:51:08 -020086
Ingo Molnar07800602009-04-20 15:00:56 +020087/* On most systems <limits.h> would have given us this, but
88 * not on some systems (e.g. GNU/Hurd).
89 */
90#ifndef PATH_MAX
91#define PATH_MAX 4096
92#endif
93
94#ifndef PRIuMAX
95#define PRIuMAX "llu"
96#endif
97
98#ifndef PRIu32
99#define PRIu32 "u"
100#endif
101
102#ifndef PRIx32
103#define PRIx32 "x"
104#endif
105
106#ifndef PATH_SEP
107#define PATH_SEP ':'
108#endif
109
110#ifndef STRIP_EXTENSION
111#define STRIP_EXTENSION ""
112#endif
113
114#ifndef has_dos_drive_prefix
115#define has_dos_drive_prefix(path) 0
116#endif
117
118#ifndef is_dir_sep
119#define is_dir_sep(c) ((c) == '/')
120#endif
121
122#ifdef __GNUC__
123#define NORETURN __attribute__((__noreturn__))
124#else
125#define NORETURN
126#ifndef __attribute__
127#define __attribute__(x)
128#endif
129#endif
130
131/* General helper functions */
132extern void usage(const char *err) NORETURN;
133extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
134extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
135extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
136
Masami Hiramatsu97698332009-10-16 20:08:18 -0400137#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
Ingo Molnar07800602009-04-20 15:00:56 +0200146extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
147
148extern int prefixcmp(const char *str, const char *prefix);
Stephane Eranian45de34b2010-06-01 21:25:01 +0200149extern void set_buildid_dir(void);
Stephane Eraniana1ac1d32010-06-17 11:39:01 +0200150extern void disable_buildid_cache(void);
Ingo Molnar07800602009-04-20 15:00:56 +0200151
152static 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
Ingo Molnar07800602009-04-20 15:00:56 +0200158#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
166static inline char *gitstrchrnul(const char *s, int c)
167{
168 while (*s && *s != c)
169 s++;
170 return (char *)s;
171}
172#endif
173
Ingo Molnar6f06ccb2009-04-20 15:22:22 +0200174/*
175 * Wrappers:
176 */
177extern char *xstrdup(const char *str);
Arnaldo Carvalho de Melo727dad12009-11-24 12:05:17 -0200178extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
Ingo Molnar16f762a2009-05-27 09:10:38 +0200179
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400180
Arnaldo Carvalho de Melo36479482009-11-24 12:05:16 -0200181static inline void *zalloc(size_t size)
182{
183 return calloc(1, size);
184}
185
Ingo Molnar07800602009-04-20 15:00:56 +0200186static inline int has_extension(const char *filename, const char *ext)
187{
188 size_t len = strlen(filename);
189 size_t extlen = strlen(ext);
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400190
Ingo Molnar07800602009-04-20 15:00:56 +0200191 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
192}
193
194/* Sane ctype - no locale, and works with signed chars */
195#undef isascii
196#undef isspace
197#undef isdigit
Frederic Weisbecker9e827dd2009-11-11 04:51:07 +0100198#undef isxdigit
Ingo Molnar07800602009-04-20 15:00:56 +0200199#undef isalpha
Frederic Weisbecker5f9c39d2009-08-17 16:18:08 +0200200#undef isprint
Ingo Molnar07800602009-04-20 15:00:56 +0200201#undef isalnum
Namhyung Kim2cd13b0f2012-02-10 10:10:15 +0900202#undef islower
203#undef isupper
Ingo Molnar07800602009-04-20 15:00:56 +0200204#undef tolower
205#undef toupper
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400206
Arnaldo Carvalho de Melo752fde42012-10-06 18:43:19 -0300207#ifndef NSEC_PER_MSEC
208#define NSEC_PER_MSEC 1000000L
209#endif
210
Namhyung Kim3b47abe2013-06-04 10:50:29 +0900211int parse_nsec_time(const char *str, u64 *ptime);
212
Ingo Molnar07800602009-04-20 15:00:56 +0200213extern unsigned char sane_ctype[256];
Peter Zijlstraa73c7d82009-06-18 09:44:20 +0200214#define GIT_SPACE 0x01
215#define GIT_DIGIT 0x02
216#define GIT_ALPHA 0x04
217#define GIT_GLOB_SPECIAL 0x08
218#define GIT_REGEX_SPECIAL 0x10
219#define GIT_PRINT_EXTRA 0x20
220#define GIT_PRINT 0x3E
Ingo Molnar07800602009-04-20 15:00:56 +0200221#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
222#define isascii(x) (((x) & ~0x7f) == 0)
223#define isspace(x) sane_istest(x,GIT_SPACE)
224#define isdigit(x) sane_istest(x,GIT_DIGIT)
Frederic Weisbecker9e827dd2009-11-11 04:51:07 +0100225#define isxdigit(x) \
226 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
Ingo Molnar07800602009-04-20 15:00:56 +0200227#define isalpha(x) sane_istest(x,GIT_ALPHA)
228#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
Peter Zijlstraa73c7d82009-06-18 09:44:20 +0200229#define isprint(x) sane_istest(x,GIT_PRINT)
Sukadev Bhattiprolu69566642013-03-29 12:14:43 -0700230#define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
231#define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
Ingo Molnar07800602009-04-20 15:00:56 +0200232#define tolower(x) sane_case((unsigned char)(x), 0x20)
233#define toupper(x) sane_case((unsigned char)(x), 0)
234
235static inline int sane_case(int x, int high)
236{
237 if (sane_istest(x, GIT_ALPHA))
238 x = (x & ~0x20) | high;
239 return x;
240}
241
Arnaldo Carvalho de Melo4cf40132009-12-27 21:37:06 -0200242int mkdir_p(char *path, mode_t mode);
243int copyfile(const char *from, const char *to);
244
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300245s64 perf_atoll(const char *str);
246char **argv_split(const char *str, int *argcp);
247void argv_free(char **argv);
248bool strglobmatch(const char *str, const char *pat);
249bool strlazymatch(const char *str, const char *pat);
Masami Hiramatsubad03ae2011-06-27 16:27:15 +0900250int strtailcmp(const char *s1, const char *s2);
Jiri Olsaea36c462012-10-27 23:18:31 +0200251char *strxfrchar(char *s, char from, char to);
Arnaldo Carvalho de Meloc82ee822010-05-14 14:19:35 -0300252unsigned long convert_unit(unsigned long value, char *unit);
Arnaldo Carvalho de Melo1e7972c2011-01-03 16:50:55 -0200253int readn(int fd, void *buf, size_t size);
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300254
Joerg Roedel1aed2672012-01-04 17:54:20 +0100255struct perf_event_attr;
256
257void event_attr_init(struct perf_event_attr *attr);
258
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300259#define _STR(x) #x
260#define STR(x) _STR(x)
261
Nelson Elhage41d0d932011-12-19 08:39:32 -0500262/*
263 * Determine whether some value is a power of two, where zero is
264 * *not* considered a power of two.
265 */
266
267static inline __attribute__((const))
268bool is_power_of_2(unsigned long n)
269{
270 return (n != 0 && ((n & (n - 1)) == 0));
271}
272
Arnaldo Carvalho de Melo61e04b32012-04-19 13:15:24 -0300273size_t hex_width(u64 v);
Jiri Olsab2aff5f2012-10-27 23:18:30 +0200274int hex2u64(const char *ptr, u64 *val);
Arnaldo Carvalho de Melo61e04b32012-04-19 13:15:24 -0300275
Namhyung Kim08aa9cc2013-01-22 18:09:41 +0900276char *ltrim(char *s);
Arnaldo Carvalho de Melocb1a28a2012-06-07 18:23:31 -0300277char *rtrim(char *s);
278
Arnaldo Carvalho de Melodc4552b2012-08-07 23:32:05 -0300279void dump_stack(void);
280
Arnaldo Carvalho de Melo0c1fe6b2012-10-06 14:57:10 -0300281extern unsigned int page_size;
282
David Ahern2c803e52013-01-14 10:48:01 -0700283void get_term_dimensions(struct winsize *ws);
Borislav Petkov13559152013-02-20 16:32:31 +0100284#endif /* GIT_COMPAT_UTIL_H */