perf probe: Search SDT/cached event from all probe caches
[deliverable/linux.git] / tools / perf / util / util.h
CommitLineData
07800601
IM
1#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
07800601
IM
4#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
07800601 40#define _ALL_SOURCE 1
07800601 41#define _BSD_SOURCE 1
512fe365
CP
42/* glibc 2.20 deprecates _BSD_SOURCE in favour of _DEFAULT_SOURCE */
43#define _DEFAULT_SOURCE 1
e206d556 44#define HAS_BOOL
07800601
IM
45
46#include <unistd.h>
47#include <stdio.h>
48#include <sys/stat.h>
f6bdafef 49#include <sys/statfs.h>
07800601 50#include <fcntl.h>
e206d556 51#include <stdbool.h>
07800601
IM
52#include <stddef.h>
53#include <stdlib.h>
54#include <stdarg.h>
55#include <string.h>
1fe143c5 56#include <term.h>
07800601
IM
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 69#include <sys/wait.h>
a8fa4960 70#include <poll.h>
07800601
IM
71#include <sys/socket.h>
72#include <sys/ioctl.h>
07800601 73#include <inttypes.h>
972f393b 74#include <linux/kernel.h>
d944c4ee 75#include <linux/types.h>
46e3e055 76#include <sys/ttydefaults.h>
4605eab3 77#include <api/fs/tracing_path.h>
756bbc84 78#include <termios.h>
1dbfa938 79#include <linux/bitops.h>
9398c484 80#include <termios.h>
e1ce726e 81#include "strlist.h"
1fe2c106 82
2890284b
ACM
83extern const char *graph_line;
84extern const char *graph_dotted_line;
8e2fc44f
NK
85extern const char *spaces;
86extern const char *dots;
45de34bb 87extern char buildid_dir[];
2890284b 88
07800601
IM
89/* On most systems <limits.h> would have given us this, but
90 * not on some systems (e.g. GNU/Hurd).
91 */
92#ifndef PATH_MAX
93#define PATH_MAX 4096
94#endif
95
96#ifndef PRIuMAX
97#define PRIuMAX "llu"
98#endif
99
100#ifndef PRIu32
101#define PRIu32 "u"
102#endif
103
104#ifndef PRIx32
105#define PRIx32 "x"
106#endif
107
108#ifndef PATH_SEP
109#define PATH_SEP ':'
110#endif
111
112#ifndef STRIP_EXTENSION
113#define STRIP_EXTENSION ""
114#endif
115
116#ifndef has_dos_drive_prefix
117#define has_dos_drive_prefix(path) 0
118#endif
119
120#ifndef is_dir_sep
121#define is_dir_sep(c) ((c) == '/')
122#endif
123
124#ifdef __GNUC__
125#define NORETURN __attribute__((__noreturn__))
126#else
127#define NORETURN
128#ifndef __attribute__
129#define __attribute__(x)
130#endif
131#endif
132
fc67297b
NK
133#define PERF_GTK_DSO "libperf-gtk.so"
134
07800601 135/* General helper functions */
3938bad4
ACM
136void usage(const char *err) NORETURN;
137void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
138int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
139void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
07800601 140
3938bad4 141void set_warning_routine(void (*routine)(const char *err, va_list params));
07800601 142
3938bad4
ACM
143int prefixcmp(const char *str, const char *prefix);
144void set_buildid_dir(const char *dir);
07800601 145
07800601
IM
146#ifdef __GLIBC_PREREQ
147#if __GLIBC_PREREQ(2, 1)
148#define HAVE_STRCHRNUL
149#endif
150#endif
151
152#ifndef HAVE_STRCHRNUL
153#define strchrnul gitstrchrnul
154static inline char *gitstrchrnul(const char *s, int c)
155{
156 while (*s && *s != c)
157 s++;
158 return (char *)s;
159}
160#endif
161
36479484
ACM
162static inline void *zalloc(size_t size)
163{
164 return calloc(1, size);
165}
166
04662523
ACM
167#define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
168
07800601
IM
169/* Sane ctype - no locale, and works with signed chars */
170#undef isascii
171#undef isspace
172#undef isdigit
9e827dd0 173#undef isxdigit
07800601 174#undef isalpha
5f9c39dc 175#undef isprint
07800601 176#undef isalnum
2cd13b0f
NK
177#undef islower
178#undef isupper
07800601
IM
179#undef tolower
180#undef toupper
a1d37d52 181
752fde44
ACM
182#ifndef NSEC_PER_MSEC
183#define NSEC_PER_MSEC 1000000L
184#endif
185
3b47abe1
NK
186int parse_nsec_time(const char *str, u64 *ptime);
187
07800601 188extern unsigned char sane_ctype[256];
a73c7d84
PZ
189#define GIT_SPACE 0x01
190#define GIT_DIGIT 0x02
191#define GIT_ALPHA 0x04
192#define GIT_GLOB_SPECIAL 0x08
193#define GIT_REGEX_SPECIAL 0x10
194#define GIT_PRINT_EXTRA 0x20
195#define GIT_PRINT 0x3E
07800601
IM
196#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
197#define isascii(x) (((x) & ~0x7f) == 0)
198#define isspace(x) sane_istest(x,GIT_SPACE)
199#define isdigit(x) sane_istest(x,GIT_DIGIT)
9e827dd0
FW
200#define isxdigit(x) \
201 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
07800601
IM
202#define isalpha(x) sane_istest(x,GIT_ALPHA)
203#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
a73c7d84 204#define isprint(x) sane_istest(x,GIT_PRINT)
6956664a
SB
205#define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
206#define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
07800601
IM
207#define tolower(x) sane_case((unsigned char)(x), 0x20)
208#define toupper(x) sane_case((unsigned char)(x), 0)
209
210static inline int sane_case(int x, int high)
211{
212 if (sane_istest(x, GIT_ALPHA))
213 x = (x & ~0x20) | high;
214 return x;
215}
216
4cf40131 217int mkdir_p(char *path, mode_t mode);
0b1de0be 218int rm_rf(char *path);
e1ce726e
MH
219struct strlist *lsdir(const char *name, bool (*filter)(const char *, struct dirent *));
220bool lsdir_no_dot_filter(const char *name, struct dirent *d);
4cf40131 221int copyfile(const char *from, const char *to);
9a17d726 222int copyfile_mode(const char *from, const char *to, mode_t mode);
9c9f5a2f 223int copyfile_offset(int fromfd, loff_t from_ofs, int tofd, loff_t to_ofs, u64 size);
4cf40131 224
e206d556
ACM
225s64 perf_atoll(const char *str);
226char **argv_split(const char *str, int *argcp);
227void argv_free(char **argv);
228bool strglobmatch(const char *str, const char *pat);
229bool strlazymatch(const char *str, const char *pat);
4c859351
MH
230static inline bool strisglob(const char *str)
231{
232 return strpbrk(str, "*?[") != NULL;
233}
bad03ae4 234int strtailcmp(const char *s1, const char *s2);
ea36c46b 235char *strxfrchar(char *s, char from, char to);
c82ee828 236unsigned long convert_unit(unsigned long value, char *unit);
727ebd54 237ssize_t readn(int fd, void *buf, size_t n);
bc3a502b 238ssize_t writen(int fd, void *buf, size_t n);
e206d556 239
1aed2671
JR
240struct perf_event_attr;
241
242void event_attr_init(struct perf_event_attr *attr);
243
e206d556
ACM
244#define _STR(x) #x
245#define STR(x) _STR(x)
246
61e04b33 247size_t hex_width(u64 v);
b2aff5f6 248int hex2u64(const char *ptr, u64 *val);
61e04b33 249
08aa9cce 250char *ltrim(char *s);
cb1a28a0
ACM
251char *rtrim(char *s);
252
7d6a7e78
JO
253static inline char *trim(char *s)
254{
255 return ltrim(rtrim(s));
256}
257
dc4552bf 258void dump_stack(void);
07c1a0da 259void sighandler_dump_stack(int sig);
dc4552bf 260
0c1fe6b2 261extern unsigned int page_size;
2b1b7100 262extern int cacheline_size;
a29d5c9b
ACM
263extern int sysctl_perf_event_max_stack;
264extern int sysctl_perf_event_max_contexts_per_stack;
0c1fe6b2 265
27050f53
JO
266struct parse_tag {
267 char tag;
268 int mult;
269};
270
271unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
f048d548
NK
272
273#define SRCLINE_UNKNOWN ((char *) "??:0")
274
972f393b
ACM
275static inline int path__join(char *bf, size_t size,
276 const char *path1, const char *path2)
277{
278 return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
279}
280
281static inline int path__join3(char *bf, size_t size,
282 const char *path1, const char *path2,
283 const char *path3)
284{
285 return scnprintf(bf, size, "%s%s%s%s%s",
286 path1, path1[0] ? "/" : "",
287 path2, path2[0] ? "/" : "", path3);
288}
289
86c98cab 290struct dso;
85c116a6 291struct symbol;
86c98cab 292
a9710ba0 293extern bool srcline_full_filename;
ac931f87 294char *get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
85c116a6 295 bool show_sym);
2f84b42b
AK
296char *__get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
297 bool show_sym, bool unwind_inlines);
f048d548 298void free_srcline(char *srcline);
97a07f10 299
1a47245d 300int perf_event_paranoid(void);
e1a2b174 301
71db07b1
AH
302void mem_bswap_64(void *src, int byte_size);
303void mem_bswap_32(void *src, int byte_size);
304
e1a2b174 305const char *get_filename_for_perf_kvm(void);
63914aca 306bool find_process(const char *name);
e92ce12e
NK
307
308#ifdef HAVE_ZLIB_SUPPORT
309int gzip_decompress_to_file(const char *input, int output_fd);
310#endif
311
80a32e5b
JO
312#ifdef HAVE_LZMA_SUPPORT
313int lzma_decompress_to_file(const char *input, int output_fd);
314#endif
315
93ec4ce7
ACM
316char *asprintf_expr_inout_ints(const char *var, bool in, size_t nints, int *ints);
317
318static inline char *asprintf_expr_in_ints(const char *var, size_t nints, int *ints)
319{
320 return asprintf_expr_inout_ints(var, true, nints, ints);
321}
322
323static inline char *asprintf_expr_not_in_ints(const char *var, size_t nints, int *ints)
324{
325 return asprintf_expr_inout_ints(var, false, nints, ints);
326}
327
076a30c4
KL
328int get_stack_size(const char *str, unsigned long *_size);
329
07bc5c69
WN
330int fetch_kernel_version(unsigned int *puint,
331 char *str, size_t str_sz);
d3e0ce39
WN
332#define KVER_VERSION(x) (((x) >> 16) & 0xff)
333#define KVER_PATCHLEVEL(x) (((x) >> 8) & 0xff)
334#define KVER_SUBLEVEL(x) ((x) & 0xff)
335#define KVER_FMT "%d.%d.%d"
336#define KVER_PARAM(x) KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)
07bc5c69 337
14cbfbeb 338const char *perf_tip(const char *dirpath);
40356721 339bool is_regular_file(const char *file);
37b20151 340int fetch_current_timestamp(char *buf, size_t sz);
14cbfbeb 341
c339b1a9
WN
342enum binary_printer_ops {
343 BINARY_PRINT_DATA_BEGIN,
344 BINARY_PRINT_LINE_BEGIN,
345 BINARY_PRINT_ADDR,
346 BINARY_PRINT_NUM_DATA,
347 BINARY_PRINT_NUM_PAD,
348 BINARY_PRINT_SEP,
349 BINARY_PRINT_CHAR_DATA,
350 BINARY_PRINT_CHAR_PAD,
351 BINARY_PRINT_LINE_END,
352 BINARY_PRINT_DATA_END,
353};
354
355typedef void (*print_binary_t)(enum binary_printer_ops,
356 unsigned int val,
357 void *extra);
358
359void print_binary(unsigned char *data, size_t len,
360 size_t bytes_per_line, print_binary_t printer,
361 void *extra);
c8b5f2c9 362
c7007e98
ACM
363#ifndef __GLIBC__
364extern int sched_getcpu(void);
365#endif
366
1355915a 367#endif /* GIT_COMPAT_UTIL_H */
This page took 0.392828 seconds and 5 git commands to generate.