blob: ec5de5e3330ca7a8373012f847902e3b95e405a2 [file] [log] [blame]
Ingo Molnar07800602009-04-20 15:00:56 +02001#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
4#define _FILE_OFFSET_BITS 64
5
6#ifndef FLEX_ARRAY
7/*
8 * See if our compiler is known to support flexible array members.
9 */
10#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
11# define FLEX_ARRAY /* empty */
12#elif defined(__GNUC__)
13# if (__GNUC__ >= 3)
14# define FLEX_ARRAY /* empty */
15# else
16# define FLEX_ARRAY 0 /* older GNU extension */
17# endif
18#endif
19
20/*
21 * Otherwise, default to safer but a bit wasteful traditional style
22 */
23#ifndef FLEX_ARRAY
24# define FLEX_ARRAY 1
25#endif
26#endif
27
28#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29
30#ifdef __GNUC__
31#define TYPEOF(x) (__typeof__(x))
32#else
33#define TYPEOF(x)
34#endif
35
36#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
37#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
38
39/* Approximation of the length of the decimal representation of this type. */
40#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
41
Ingo Molnar07800602009-04-20 15:00:56 +020042#define _ALL_SOURCE 1
Ingo Molnar07800602009-04-20 15:00:56 +020043#define _BSD_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>
56#include <errno.h>
57#include <limits.h>
58#include <sys/param.h>
59#include <sys/types.h>
60#include <dirent.h>
61#include <sys/time.h>
62#include <time.h>
63#include <signal.h>
64#include <fnmatch.h>
65#include <assert.h>
66#include <regex.h>
67#include <utime.h>
Ingo Molnar07800602009-04-20 15:00:56 +020068#include <sys/wait.h>
69#include <sys/poll.h>
70#include <sys/socket.h>
71#include <sys/ioctl.h>
Ingo Molnar07800602009-04-20 15:00:56 +020072#include <inttypes.h>
Irina Tirdeaf8fcd772012-09-11 01:14:58 +030073#include <linux/magic.h>
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -030074#include "types.h"
Arnaldo Carvalho de Melo46e3e052010-05-22 11:25:40 -030075#include <sys/ttydefaults.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[];
Arnaldo Carvalho de Melo28902842009-11-23 17:51:08 -020080
Ingo Molnar07800602009-04-20 15:00:56 +020081/* On most systems <limits.h> would have given us this, but
82 * not on some systems (e.g. GNU/Hurd).
83 */
84#ifndef PATH_MAX
85#define PATH_MAX 4096
86#endif
87
88#ifndef PRIuMAX
89#define PRIuMAX "llu"
90#endif
91
92#ifndef PRIu32
93#define PRIu32 "u"
94#endif
95
96#ifndef PRIx32
97#define PRIx32 "x"
98#endif
99
100#ifndef PATH_SEP
101#define PATH_SEP ':'
102#endif
103
104#ifndef STRIP_EXTENSION
105#define STRIP_EXTENSION ""
106#endif
107
108#ifndef has_dos_drive_prefix
109#define has_dos_drive_prefix(path) 0
110#endif
111
112#ifndef is_dir_sep
113#define is_dir_sep(c) ((c) == '/')
114#endif
115
116#ifdef __GNUC__
117#define NORETURN __attribute__((__noreturn__))
118#else
119#define NORETURN
120#ifndef __attribute__
121#define __attribute__(x)
122#endif
123#endif
124
125/* General helper functions */
126extern void usage(const char *err) NORETURN;
127extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
128extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
129extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
130
Masami Hiramatsu97698332009-10-16 20:08:18 -0400131#include "../../../include/linux/stringify.h"
132
133#define DIE_IF(cnd) \
134 do { if (cnd) \
135 die(" at (" __FILE__ ":" __stringify(__LINE__) "): " \
136 __stringify(cnd) "\n"); \
137 } while (0)
138
139
Ingo Molnar07800602009-04-20 15:00:56 +0200140extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
141
142extern int prefixcmp(const char *str, const char *prefix);
Stephane Eranian45de34b2010-06-01 21:25:01 +0200143extern void set_buildid_dir(void);
Stephane Eraniana1ac1d32010-06-17 11:39:01 +0200144extern void disable_buildid_cache(void);
Ingo Molnar07800602009-04-20 15:00:56 +0200145
146static inline const char *skip_prefix(const char *str, const char *prefix)
147{
148 size_t len = strlen(prefix);
149 return strncmp(str, prefix, len) ? NULL : str + len;
150}
151
Ingo Molnar07800602009-04-20 15:00:56 +0200152#ifdef __GLIBC_PREREQ
153#if __GLIBC_PREREQ(2, 1)
154#define HAVE_STRCHRNUL
155#endif
156#endif
157
158#ifndef HAVE_STRCHRNUL
159#define strchrnul gitstrchrnul
160static inline char *gitstrchrnul(const char *s, int c)
161{
162 while (*s && *s != c)
163 s++;
164 return (char *)s;
165}
166#endif
167
Ingo Molnar6f06ccb2009-04-20 15:22:22 +0200168/*
169 * Wrappers:
170 */
171extern char *xstrdup(const char *str);
Arnaldo Carvalho de Melo727dad12009-11-24 12:05:17 -0200172extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
Ingo Molnar16f762a2009-05-27 09:10:38 +0200173
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400174
Arnaldo Carvalho de Melo36479482009-11-24 12:05:16 -0200175static inline void *zalloc(size_t size)
176{
177 return calloc(1, size);
178}
179
Ingo Molnar07800602009-04-20 15:00:56 +0200180static inline int has_extension(const char *filename, const char *ext)
181{
182 size_t len = strlen(filename);
183 size_t extlen = strlen(ext);
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400184
Ingo Molnar07800602009-04-20 15:00:56 +0200185 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
186}
187
188/* Sane ctype - no locale, and works with signed chars */
189#undef isascii
190#undef isspace
191#undef isdigit
Frederic Weisbecker9e827dd2009-11-11 04:51:07 +0100192#undef isxdigit
Ingo Molnar07800602009-04-20 15:00:56 +0200193#undef isalpha
Frederic Weisbecker5f9c39d2009-08-17 16:18:08 +0200194#undef isprint
Ingo Molnar07800602009-04-20 15:00:56 +0200195#undef isalnum
Namhyung Kim2cd13b02012-02-10 10:10:15 +0900196#undef islower
197#undef isupper
Ingo Molnar07800602009-04-20 15:00:56 +0200198#undef tolower
199#undef toupper
Masami Hiramatsua1d37d52010-03-16 18:05:21 -0400200
Arnaldo Carvalho de Melo752fde42012-10-06 18:43:19 -0300201#ifndef NSEC_PER_MSEC
202#define NSEC_PER_MSEC 1000000L
203#endif
204
Ingo Molnar07800602009-04-20 15:00:56 +0200205extern unsigned char sane_ctype[256];
Peter Zijlstraa73c7d82009-06-18 09:44:20 +0200206#define GIT_SPACE 0x01
207#define GIT_DIGIT 0x02
208#define GIT_ALPHA 0x04
209#define GIT_GLOB_SPECIAL 0x08
210#define GIT_REGEX_SPECIAL 0x10
211#define GIT_PRINT_EXTRA 0x20
212#define GIT_PRINT 0x3E
Ingo Molnar07800602009-04-20 15:00:56 +0200213#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
214#define isascii(x) (((x) & ~0x7f) == 0)
215#define isspace(x) sane_istest(x,GIT_SPACE)
216#define isdigit(x) sane_istest(x,GIT_DIGIT)
Frederic Weisbecker9e827dd2009-11-11 04:51:07 +0100217#define isxdigit(x) \
218 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
Ingo Molnar07800602009-04-20 15:00:56 +0200219#define isalpha(x) sane_istest(x,GIT_ALPHA)
220#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
Peter Zijlstraa73c7d82009-06-18 09:44:20 +0200221#define isprint(x) sane_istest(x,GIT_PRINT)
Namhyung Kim2cd13b02012-02-10 10:10:15 +0900222#define islower(x) (sane_istest(x,GIT_ALPHA) && sane_istest(x,0x20))
223#define isupper(x) (sane_istest(x,GIT_ALPHA) && !sane_istest(x,0x20))
Ingo Molnar07800602009-04-20 15:00:56 +0200224#define tolower(x) sane_case((unsigned char)(x), 0x20)
225#define toupper(x) sane_case((unsigned char)(x), 0)
226
227static inline int sane_case(int x, int high)
228{
229 if (sane_istest(x, GIT_ALPHA))
230 x = (x & ~0x20) | high;
231 return x;
232}
233
Arnaldo Carvalho de Melo4cf40132009-12-27 21:37:06 -0200234int mkdir_p(char *path, mode_t mode);
235int copyfile(const char *from, const char *to);
236
Arnaldo Carvalho de Meloe206d552010-04-03 10:19:26 -0300237s64 perf_atoll(const char *str);
238char **argv_split(const char *str, int *argcp);
239void argv_free(char **argv);
240bool strglobmatch(const char *str, const char *pat);
241bool strlazymatch(const char *str, const char *pat);
Masami Hiramatsubad03ae2011-06-27 16:27:15 +0900242int strtailcmp(const char *s1, const char *s2);
Jiri Olsaea36c462012-10-27 23:18:31 +0200243char *strxfrchar(char *s, char from, char to);
Arnaldo Carvalho de Meloc82ee822010-05-14 14:19:35 -0300244unsigned long convert_unit(unsigned long value, char *unit);
Arnaldo Carvalho de Melo1e7972c2011-01-03 16:50:55 -0200245int readn(int fd, void *buf, size_t size);
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
Nelson Elhage41d0d932011-12-19 08:39:32 -0500254/*
255 * Determine whether some value is a power of two, where zero is
256 * *not* considered a power of two.
257 */
258
259static inline __attribute__((const))
260bool is_power_of_2(unsigned long n)
261{
262 return (n != 0 && ((n & (n - 1)) == 0));
263}
264
Arnaldo Carvalho de Melo61e04b32012-04-19 13:15:24 -0300265size_t hex_width(u64 v);
Jiri Olsab2aff5f2012-10-27 23:18:30 +0200266int hex2u64(const char *ptr, u64 *val);
Arnaldo Carvalho de Melo61e04b32012-04-19 13:15:24 -0300267
Arnaldo Carvalho de Melocb1a28a2012-06-07 18:23:31 -0300268char *rtrim(char *s);
269
Arnaldo Carvalho de Melodc4552b2012-08-07 23:32:05 -0300270void dump_stack(void);
271
Arnaldo Carvalho de Melo0c1fe6b2012-10-06 14:57:10 -0300272extern unsigned int page_size;
273
David Ahern2c803e52013-01-14 10:48:01 -0700274struct winsize;
275void get_term_dimensions(struct winsize *ws);
276
Ingo Molnar07800602009-04-20 15:00:56 +0200277#endif