xref: /linux/tools/perf/util/util.h (revision 2277ab4a1df50e05bc732fe9488d4e902bb8399a)
1 #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 
42 #if !defined(__APPLE__) && !defined(__FreeBSD__)  && !defined(__USLC__) && !defined(_M_UNIX)
43 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
44 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
45 #endif
46 #define _ALL_SOURCE 1
47 #define _GNU_SOURCE 1
48 #define _BSD_SOURCE 1
49 
50 #include <unistd.h>
51 #include <stdio.h>
52 #include <sys/stat.h>
53 #include <fcntl.h>
54 #include <stddef.h>
55 #include <stdlib.h>
56 #include <stdarg.h>
57 #include <string.h>
58 #include <errno.h>
59 #include <limits.h>
60 #include <sys/param.h>
61 #include <sys/types.h>
62 #include <dirent.h>
63 #include <sys/time.h>
64 #include <time.h>
65 #include <signal.h>
66 #include <fnmatch.h>
67 #include <assert.h>
68 #include <regex.h>
69 #include <utime.h>
70 #include <sys/wait.h>
71 #include <sys/poll.h>
72 #include <sys/socket.h>
73 #include <sys/ioctl.h>
74 #ifndef NO_SYS_SELECT_H
75 #include <sys/select.h>
76 #endif
77 #include <netinet/in.h>
78 #include <netinet/tcp.h>
79 #include <arpa/inet.h>
80 #include <netdb.h>
81 #include <pwd.h>
82 #include <inttypes.h>
83 
84 #ifndef NO_ICONV
85 #include <iconv.h>
86 #endif
87 
88 /* 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 
132 /* General helper functions */
133 extern void usage(const char *err) NORETURN;
134 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
135 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
136 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
137 
138 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
139 
140 extern int prefixcmp(const char *str, const char *prefix);
141 extern time_t tm_to_time_t(const struct tm *tm);
142 
143 static inline const char *skip_prefix(const char *str, const char *prefix)
144 {
145 	size_t len = strlen(prefix);
146 	return strncmp(str, prefix, len) ? NULL : str + len;
147 }
148 
149 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
150 
151 #ifndef PROT_READ
152 #define PROT_READ 1
153 #define PROT_WRITE 2
154 #define MAP_PRIVATE 1
155 #define MAP_FAILED ((void*)-1)
156 #endif
157 
158 #define mmap git_mmap
159 #define munmap git_munmap
160 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
161 extern int git_munmap(void *start, size_t length);
162 
163 #else /* NO_MMAP || USE_WIN32_MMAP */
164 
165 #include <sys/mman.h>
166 
167 #endif /* NO_MMAP || USE_WIN32_MMAP */
168 
169 #ifdef NO_MMAP
170 
171 /* This value must be multiple of (pagesize * 2) */
172 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
173 
174 #else /* NO_MMAP */
175 
176 /* This value must be multiple of (pagesize * 2) */
177 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
178 	(sizeof(void*) >= 8 \
179 		?  1 * 1024 * 1024 * 1024 \
180 		: 32 * 1024 * 1024)
181 
182 #endif /* NO_MMAP */
183 
184 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
185 #define on_disk_bytes(st) ((st).st_size)
186 #else
187 #define on_disk_bytes(st) ((st).st_blocks * 512)
188 #endif
189 
190 #define DEFAULT_PACKED_GIT_LIMIT \
191 	((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
192 
193 #ifdef NO_PREAD
194 #define pread git_pread
195 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
196 #endif
197 /*
198  * Forward decl that will remind us if its twin in cache.h changes.
199  * This function is used in compat/pread.c.  But we can't include
200  * cache.h there.
201  */
202 extern ssize_t read_in_full(int fd, void *buf, size_t count);
203 
204 #ifdef NO_SETENV
205 #define setenv gitsetenv
206 extern int gitsetenv(const char *, const char *, int);
207 #endif
208 
209 #ifdef NO_MKDTEMP
210 #define mkdtemp gitmkdtemp
211 extern char *gitmkdtemp(char *);
212 #endif
213 
214 #ifdef NO_UNSETENV
215 #define unsetenv gitunsetenv
216 extern void gitunsetenv(const char *);
217 #endif
218 
219 #ifdef NO_STRCASESTR
220 #define strcasestr gitstrcasestr
221 extern char *gitstrcasestr(const char *haystack, const char *needle);
222 #endif
223 
224 #ifdef NO_STRLCPY
225 #define strlcpy gitstrlcpy
226 extern size_t gitstrlcpy(char *, const char *, size_t);
227 #endif
228 
229 #ifdef NO_STRTOUMAX
230 #define strtoumax gitstrtoumax
231 extern uintmax_t gitstrtoumax(const char *, char **, int);
232 #endif
233 
234 #ifdef NO_HSTRERROR
235 #define hstrerror githstrerror
236 extern const char *githstrerror(int herror);
237 #endif
238 
239 #ifdef NO_MEMMEM
240 #define memmem gitmemmem
241 void *gitmemmem(const void *haystack, size_t haystacklen,
242                 const void *needle, size_t needlelen);
243 #endif
244 
245 #ifdef FREAD_READS_DIRECTORIES
246 #ifdef fopen
247 #undef fopen
248 #endif
249 #define fopen(a,b) git_fopen(a,b)
250 extern FILE *git_fopen(const char*, const char*);
251 #endif
252 
253 #ifdef SNPRINTF_RETURNS_BOGUS
254 #define snprintf git_snprintf
255 extern int git_snprintf(char *str, size_t maxsize,
256 			const char *format, ...);
257 #define vsnprintf git_vsnprintf
258 extern int git_vsnprintf(char *str, size_t maxsize,
259 			 const char *format, va_list ap);
260 #endif
261 
262 #ifdef __GLIBC_PREREQ
263 #if __GLIBC_PREREQ(2, 1)
264 #define HAVE_STRCHRNUL
265 #endif
266 #endif
267 
268 #ifndef HAVE_STRCHRNUL
269 #define strchrnul gitstrchrnul
270 static inline char *gitstrchrnul(const char *s, int c)
271 {
272 	while (*s && *s != c)
273 		s++;
274 	return (char *)s;
275 }
276 #endif
277 
278 /*
279  * Wrappers:
280  */
281 extern char *xstrdup(const char *str);
282 extern void *xmalloc(size_t size);
283 extern void *xmemdupz(const void *data, size_t len);
284 extern char *xstrndup(const char *str, size_t len);
285 extern void *xrealloc(void *ptr, size_t size);
286 extern void *xcalloc(size_t nmemb, size_t size);
287 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
288 extern ssize_t xread(int fd, void *buf, size_t len);
289 extern ssize_t xwrite(int fd, const void *buf, size_t len);
290 extern int xdup(int fd);
291 extern FILE *xfdopen(int fd, const char *mode);
292 extern int xmkstemp(char *template);
293 
294 static inline size_t xsize_t(off_t len)
295 {
296 	return (size_t)len;
297 }
298 
299 static inline int has_extension(const char *filename, const char *ext)
300 {
301 	size_t len = strlen(filename);
302 	size_t extlen = strlen(ext);
303 	return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
304 }
305 
306 /* Sane ctype - no locale, and works with signed chars */
307 #undef isascii
308 #undef isspace
309 #undef isdigit
310 #undef isalpha
311 #undef isalnum
312 #undef tolower
313 #undef toupper
314 extern unsigned char sane_ctype[256];
315 #define GIT_SPACE		0x01
316 #define GIT_DIGIT		0x02
317 #define GIT_ALPHA		0x04
318 #define GIT_GLOB_SPECIAL	0x08
319 #define GIT_REGEX_SPECIAL	0x10
320 #define GIT_PRINT_EXTRA		0x20
321 #define GIT_PRINT		0x3E
322 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
323 #define isascii(x) (((x) & ~0x7f) == 0)
324 #define isspace(x) sane_istest(x,GIT_SPACE)
325 #define isdigit(x) sane_istest(x,GIT_DIGIT)
326 #define isalpha(x) sane_istest(x,GIT_ALPHA)
327 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
328 #define isprint(x) sane_istest(x,GIT_PRINT)
329 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
330 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
331 #define tolower(x) sane_case((unsigned char)(x), 0x20)
332 #define toupper(x) sane_case((unsigned char)(x), 0)
333 
334 static inline int sane_case(int x, int high)
335 {
336 	if (sane_istest(x, GIT_ALPHA))
337 		x = (x & ~0x20) | high;
338 	return x;
339 }
340 
341 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
342 {
343 	unsigned long ul;
344 	char *p;
345 
346 	errno = 0;
347 	ul = strtoul(s, &p, base);
348 	if (errno || *p || p == s || (unsigned int) ul != ul)
349 		return -1;
350 	*result = ul;
351 	return 0;
352 }
353 
354 static inline int strtol_i(char const *s, int base, int *result)
355 {
356 	long ul;
357 	char *p;
358 
359 	errno = 0;
360 	ul = strtol(s, &p, base);
361 	if (errno || *p || p == s || (int) ul != ul)
362 		return -1;
363 	*result = ul;
364 	return 0;
365 }
366 
367 #ifdef INTERNAL_QSORT
368 void git_qsort(void *base, size_t nmemb, size_t size,
369 	       int(*compar)(const void *, const void *));
370 #define qsort git_qsort
371 #endif
372 
373 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
374 # define FORCE_DIR_SET_GID S_ISGID
375 #else
376 # define FORCE_DIR_SET_GID 0
377 #endif
378 
379 #ifdef NO_NSEC
380 #undef USE_NSEC
381 #define ST_CTIME_NSEC(st) 0
382 #define ST_MTIME_NSEC(st) 0
383 #else
384 #ifdef USE_ST_TIMESPEC
385 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
386 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
387 #else
388 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
389 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
390 #endif
391 #endif
392 
393 #endif
394