perf hist: Clarify events_stats fields usage
[deliverable/linux.git] / tools / perf / util / util.h
CommitLineData
07800601
IM
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
07800601
IM
42#define _ALL_SOURCE 1
43#define _GNU_SOURCE 1
44#define _BSD_SOURCE 1
e206d556 45#define HAS_BOOL
07800601
IM
46
47#include <unistd.h>
48#include <stdio.h>
49#include <sys/stat.h>
f6bdafef 50#include <sys/statfs.h>
07800601 51#include <fcntl.h>
e206d556 52#include <stdbool.h>
07800601
IM
53#include <stddef.h>
54#include <stdlib.h>
55#include <stdarg.h>
56#include <string.h>
57#include <errno.h>
58#include <limits.h>
59#include <sys/param.h>
60#include <sys/types.h>
61#include <dirent.h>
62#include <sys/time.h>
63#include <time.h>
64#include <signal.h>
65#include <fnmatch.h>
66#include <assert.h>
67#include <regex.h>
68#include <utime.h>
07800601
IM
69#include <sys/wait.h>
70#include <sys/poll.h>
71#include <sys/socket.h>
72#include <sys/ioctl.h>
73#ifndef NO_SYS_SELECT_H
74#include <sys/select.h>
75#endif
76#include <netinet/in.h>
77#include <netinet/tcp.h>
78#include <arpa/inet.h>
79#include <netdb.h>
80#include <pwd.h>
81#include <inttypes.h>
f6bdafef 82#include "../../../include/linux/magic.h"
e206d556 83#include "types.h"
07800601 84
1fe2c106 85
07800601
IM
86#ifndef NO_ICONV
87#include <iconv.h>
88#endif
89
2890284b
ACM
90extern const char *graph_line;
91extern const char *graph_dotted_line;
92
07800601
IM
93/* On most systems <limits.h> would have given us this, but
94 * not on some systems (e.g. GNU/Hurd).
95 */
96#ifndef PATH_MAX
97#define PATH_MAX 4096
98#endif
99
100#ifndef PRIuMAX
101#define PRIuMAX "llu"
102#endif
103
104#ifndef PRIu32
105#define PRIu32 "u"
106#endif
107
108#ifndef PRIx32
109#define PRIx32 "x"
110#endif
111
112#ifndef PATH_SEP
113#define PATH_SEP ':'
114#endif
115
116#ifndef STRIP_EXTENSION
117#define STRIP_EXTENSION ""
118#endif
119
120#ifndef has_dos_drive_prefix
121#define has_dos_drive_prefix(path) 0
122#endif
123
124#ifndef is_dir_sep
125#define is_dir_sep(c) ((c) == '/')
126#endif
127
128#ifdef __GNUC__
129#define NORETURN __attribute__((__noreturn__))
130#else
131#define NORETURN
132#ifndef __attribute__
133#define __attribute__(x)
134#endif
135#endif
136
137/* General helper functions */
138extern void usage(const char *err) NORETURN;
139extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
140extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
141extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
142
9769833b
MH
143#include "../../../include/linux/stringify.h"
144
145#define DIE_IF(cnd) \
146 do { if (cnd) \
147 die(" at (" __FILE__ ":" __stringify(__LINE__) "): " \
148 __stringify(cnd) "\n"); \
149 } while (0)
150
151
07800601
IM
152extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
153
154extern int prefixcmp(const char *str, const char *prefix);
155extern time_t tm_to_time_t(const struct tm *tm);
156
157static inline const char *skip_prefix(const char *str, const char *prefix)
158{
159 size_t len = strlen(prefix);
160 return strncmp(str, prefix, len) ? NULL : str + len;
161}
162
163#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
164
165#ifndef PROT_READ
166#define PROT_READ 1
167#define PROT_WRITE 2
168#define MAP_PRIVATE 1
169#define MAP_FAILED ((void*)-1)
170#endif
171
172#define mmap git_mmap
173#define munmap git_munmap
174extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
175extern int git_munmap(void *start, size_t length);
176
177#else /* NO_MMAP || USE_WIN32_MMAP */
178
179#include <sys/mman.h>
180
181#endif /* NO_MMAP || USE_WIN32_MMAP */
182
183#ifdef NO_MMAP
184
185/* This value must be multiple of (pagesize * 2) */
186#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
187
188#else /* NO_MMAP */
189
190/* This value must be multiple of (pagesize * 2) */
191#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
192 (sizeof(void*) >= 8 \
193 ? 1 * 1024 * 1024 * 1024 \
194 : 32 * 1024 * 1024)
195
196#endif /* NO_MMAP */
197
198#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
199#define on_disk_bytes(st) ((st).st_size)
200#else
201#define on_disk_bytes(st) ((st).st_blocks * 512)
202#endif
203
204#define DEFAULT_PACKED_GIT_LIMIT \
205 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
206
207#ifdef NO_PREAD
208#define pread git_pread
209extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
210#endif
211/*
212 * Forward decl that will remind us if its twin in cache.h changes.
213 * This function is used in compat/pread.c. But we can't include
214 * cache.h there.
215 */
216extern ssize_t read_in_full(int fd, void *buf, size_t count);
217
218#ifdef NO_SETENV
219#define setenv gitsetenv
220extern int gitsetenv(const char *, const char *, int);
221#endif
222
223#ifdef NO_MKDTEMP
224#define mkdtemp gitmkdtemp
225extern char *gitmkdtemp(char *);
226#endif
227
228#ifdef NO_UNSETENV
229#define unsetenv gitunsetenv
230extern void gitunsetenv(const char *);
231#endif
232
233#ifdef NO_STRCASESTR
234#define strcasestr gitstrcasestr
235extern char *gitstrcasestr(const char *haystack, const char *needle);
236#endif
237
238#ifdef NO_STRLCPY
239#define strlcpy gitstrlcpy
240extern size_t gitstrlcpy(char *, const char *, size_t);
241#endif
242
243#ifdef NO_STRTOUMAX
244#define strtoumax gitstrtoumax
245extern uintmax_t gitstrtoumax(const char *, char **, int);
246#endif
247
248#ifdef NO_HSTRERROR
249#define hstrerror githstrerror
250extern const char *githstrerror(int herror);
251#endif
252
253#ifdef NO_MEMMEM
254#define memmem gitmemmem
255void *gitmemmem(const void *haystack, size_t haystacklen,
256 const void *needle, size_t needlelen);
257#endif
258
259#ifdef FREAD_READS_DIRECTORIES
260#ifdef fopen
261#undef fopen
262#endif
263#define fopen(a,b) git_fopen(a,b)
264extern FILE *git_fopen(const char*, const char*);
265#endif
266
267#ifdef SNPRINTF_RETURNS_BOGUS
268#define snprintf git_snprintf
269extern int git_snprintf(char *str, size_t maxsize,
270 const char *format, ...);
271#define vsnprintf git_vsnprintf
272extern int git_vsnprintf(char *str, size_t maxsize,
273 const char *format, va_list ap);
274#endif
275
276#ifdef __GLIBC_PREREQ
277#if __GLIBC_PREREQ(2, 1)
278#define HAVE_STRCHRNUL
279#endif
280#endif
281
282#ifndef HAVE_STRCHRNUL
283#define strchrnul gitstrchrnul
284static inline char *gitstrchrnul(const char *s, int c)
285{
286 while (*s && *s != c)
287 s++;
288 return (char *)s;
289}
290#endif
291
6f06ccbc
IM
292/*
293 * Wrappers:
294 */
295extern char *xstrdup(const char *str);
727dad10 296extern void *xmalloc(size_t size) __attribute__((weak));
6f06ccbc
IM
297extern void *xmemdupz(const void *data, size_t len);
298extern char *xstrndup(const char *str, size_t len);
727dad10 299extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
16f762a2 300
a1d37d52
MH
301static inline void *xzalloc(size_t size)
302{
303 void *buf = xmalloc(size);
304
305 return memset(buf, 0, size);
306}
307
36479484
ACM
308static inline void *zalloc(size_t size)
309{
310 return calloc(1, size);
311}
312
07800601
IM
313static inline size_t xsize_t(off_t len)
314{
315 return (size_t)len;
316}
317
318static inline int has_extension(const char *filename, const char *ext)
319{
320 size_t len = strlen(filename);
321 size_t extlen = strlen(ext);
a1d37d52 322
07800601
IM
323 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
324}
325
326/* Sane ctype - no locale, and works with signed chars */
327#undef isascii
328#undef isspace
329#undef isdigit
9e827dd0 330#undef isxdigit
07800601 331#undef isalpha
5f9c39dc 332#undef isprint
07800601
IM
333#undef isalnum
334#undef tolower
335#undef toupper
a1d37d52 336
07800601 337extern unsigned char sane_ctype[256];
a73c7d84
PZ
338#define GIT_SPACE 0x01
339#define GIT_DIGIT 0x02
340#define GIT_ALPHA 0x04
341#define GIT_GLOB_SPECIAL 0x08
342#define GIT_REGEX_SPECIAL 0x10
343#define GIT_PRINT_EXTRA 0x20
344#define GIT_PRINT 0x3E
07800601
IM
345#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
346#define isascii(x) (((x) & ~0x7f) == 0)
347#define isspace(x) sane_istest(x,GIT_SPACE)
348#define isdigit(x) sane_istest(x,GIT_DIGIT)
9e827dd0
FW
349#define isxdigit(x) \
350 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
07800601
IM
351#define isalpha(x) sane_istest(x,GIT_ALPHA)
352#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
a73c7d84 353#define isprint(x) sane_istest(x,GIT_PRINT)
07800601
IM
354#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
355#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
356#define tolower(x) sane_case((unsigned char)(x), 0x20)
357#define toupper(x) sane_case((unsigned char)(x), 0)
358
359static inline int sane_case(int x, int high)
360{
361 if (sane_istest(x, GIT_ALPHA))
362 x = (x & ~0x20) | high;
363 return x;
364}
365
366static inline int strtoul_ui(char const *s, int base, unsigned int *result)
367{
368 unsigned long ul;
369 char *p;
370
371 errno = 0;
372 ul = strtoul(s, &p, base);
373 if (errno || *p || p == s || (unsigned int) ul != ul)
374 return -1;
375 *result = ul;
376 return 0;
377}
378
379static inline int strtol_i(char const *s, int base, int *result)
380{
381 long ul;
382 char *p;
383
384 errno = 0;
385 ul = strtol(s, &p, base);
386 if (errno || *p || p == s || (int) ul != ul)
387 return -1;
388 *result = ul;
389 return 0;
390}
391
392#ifdef INTERNAL_QSORT
393void git_qsort(void *base, size_t nmemb, size_t size,
394 int(*compar)(const void *, const void *));
395#define qsort git_qsort
396#endif
397
398#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
399# define FORCE_DIR_SET_GID S_ISGID
400#else
401# define FORCE_DIR_SET_GID 0
402#endif
403
404#ifdef NO_NSEC
405#undef USE_NSEC
406#define ST_CTIME_NSEC(st) 0
407#define ST_MTIME_NSEC(st) 0
408#else
409#ifdef USE_ST_TIMESPEC
410#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
411#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
412#else
413#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
414#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
415#endif
416#endif
417
4cf40131
ACM
418int mkdir_p(char *path, mode_t mode);
419int copyfile(const char *from, const char *to);
420
e206d556
ACM
421s64 perf_atoll(const char *str);
422char **argv_split(const char *str, int *argcp);
423void argv_free(char **argv);
424bool strglobmatch(const char *str, const char *pat);
425bool strlazymatch(const char *str, const char *pat);
426
427#define _STR(x) #x
428#define STR(x) _STR(x)
429
07800601 430#endif
This page took 0.082241 seconds and 5 git commands to generate.