Merge tag 'docs-for-linus' of git://git.lwn.net/linux
[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>
f8fcd776 75#include <linux/magic.h>
d944c4ee 76#include <linux/types.h>
46e3e055 77#include <sys/ttydefaults.h>
4605eab3 78#include <api/fs/tracing_path.h>
756bbc84 79#include <termios.h>
1dbfa938 80#include <linux/bitops.h>
9398c484 81#include <termios.h>
e1ce726e 82#include "strlist.h"
1fe2c106 83
2890284b
ACM
84extern const char *graph_line;
85extern const char *graph_dotted_line;
8e2fc44f
NK
86extern const char *spaces;
87extern const char *dots;
45de34bb 88extern char buildid_dir[];
2890284b 89
07800601
IM
90/* On most systems <limits.h> would have given us this, but
91 * not on some systems (e.g. GNU/Hurd).
92 */
93#ifndef PATH_MAX
94#define PATH_MAX 4096
95#endif
96
97#ifndef PRIuMAX
98#define PRIuMAX "llu"
99#endif
100
101#ifndef PRIu32
102#define PRIu32 "u"
103#endif
104
105#ifndef PRIx32
106#define PRIx32 "x"
107#endif
108
109#ifndef PATH_SEP
110#define PATH_SEP ':'
111#endif
112
113#ifndef STRIP_EXTENSION
114#define STRIP_EXTENSION ""
115#endif
116
117#ifndef has_dos_drive_prefix
118#define has_dos_drive_prefix(path) 0
119#endif
120
121#ifndef is_dir_sep
122#define is_dir_sep(c) ((c) == '/')
123#endif
124
125#ifdef __GNUC__
126#define NORETURN __attribute__((__noreturn__))
127#else
128#define NORETURN
129#ifndef __attribute__
130#define __attribute__(x)
131#endif
132#endif
133
fc67297b
NK
134#define PERF_GTK_DSO "libperf-gtk.so"
135
07800601 136/* General helper functions */
3938bad4
ACM
137void usage(const char *err) NORETURN;
138void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
139int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
140void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
07800601 141
3938bad4 142void set_warning_routine(void (*routine)(const char *err, va_list params));
07800601 143
3938bad4
ACM
144int prefixcmp(const char *str, const char *prefix);
145void set_buildid_dir(const char *dir);
07800601 146
07800601
IM
147#ifdef __GLIBC_PREREQ
148#if __GLIBC_PREREQ(2, 1)
149#define HAVE_STRCHRNUL
150#endif
151#endif
152
153#ifndef HAVE_STRCHRNUL
154#define strchrnul gitstrchrnul
155static inline char *gitstrchrnul(const char *s, int c)
156{
157 while (*s && *s != c)
158 s++;
159 return (char *)s;
160}
161#endif
162
36479484
ACM
163static inline void *zalloc(size_t size)
164{
165 return calloc(1, size);
166}
167
04662523
ACM
168#define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
169
07800601
IM
170/* Sane ctype - no locale, and works with signed chars */
171#undef isascii
172#undef isspace
173#undef isdigit
9e827dd0 174#undef isxdigit
07800601 175#undef isalpha
5f9c39dc 176#undef isprint
07800601 177#undef isalnum
2cd13b0f
NK
178#undef islower
179#undef isupper
07800601
IM
180#undef tolower
181#undef toupper
a1d37d52 182
752fde44
ACM
183#ifndef NSEC_PER_MSEC
184#define NSEC_PER_MSEC 1000000L
185#endif
186
3b47abe1
NK
187int parse_nsec_time(const char *str, u64 *ptime);
188
07800601 189extern unsigned char sane_ctype[256];
a73c7d84
PZ
190#define GIT_SPACE 0x01
191#define GIT_DIGIT 0x02
192#define GIT_ALPHA 0x04
193#define GIT_GLOB_SPECIAL 0x08
194#define GIT_REGEX_SPECIAL 0x10
195#define GIT_PRINT_EXTRA 0x20
196#define GIT_PRINT 0x3E
07800601
IM
197#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
198#define isascii(x) (((x) & ~0x7f) == 0)
199#define isspace(x) sane_istest(x,GIT_SPACE)
200#define isdigit(x) sane_istest(x,GIT_DIGIT)
9e827dd0
FW
201#define isxdigit(x) \
202 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
07800601
IM
203#define isalpha(x) sane_istest(x,GIT_ALPHA)
204#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
a73c7d84 205#define isprint(x) sane_istest(x,GIT_PRINT)
6956664a
SB
206#define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
207#define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
07800601
IM
208#define tolower(x) sane_case((unsigned char)(x), 0x20)
209#define toupper(x) sane_case((unsigned char)(x), 0)
210
211static inline int sane_case(int x, int high)
212{
213 if (sane_istest(x, GIT_ALPHA))
214 x = (x & ~0x20) | high;
215 return x;
216}
217
4cf40131 218int mkdir_p(char *path, mode_t mode);
0b1de0be 219int rm_rf(char *path);
e1ce726e
MH
220struct strlist *lsdir(const char *name, bool (*filter)(const char *, struct dirent *));
221bool lsdir_no_dot_filter(const char *name, struct dirent *d);
4cf40131 222int copyfile(const char *from, const char *to);
9a17d726 223int copyfile_mode(const char *from, const char *to, mode_t mode);
9c9f5a2f 224int copyfile_offset(int fromfd, loff_t from_ofs, int tofd, loff_t to_ofs, u64 size);
4cf40131 225
e206d556
ACM
226s64 perf_atoll(const char *str);
227char **argv_split(const char *str, int *argcp);
228void argv_free(char **argv);
229bool strglobmatch(const char *str, const char *pat);
230bool strlazymatch(const char *str, const char *pat);
4c859351
MH
231static inline bool strisglob(const char *str)
232{
233 return strpbrk(str, "*?[") != NULL;
234}
bad03ae4 235int strtailcmp(const char *s1, const char *s2);
ea36c46b 236char *strxfrchar(char *s, char from, char to);
c82ee828 237unsigned long convert_unit(unsigned long value, char *unit);
727ebd54 238ssize_t readn(int fd, void *buf, size_t n);
bc3a502b 239ssize_t writen(int fd, void *buf, size_t n);
e206d556 240
1aed2671
JR
241struct perf_event_attr;
242
243void event_attr_init(struct perf_event_attr *attr);
244
e206d556
ACM
245#define _STR(x) #x
246#define STR(x) _STR(x)
247
61e04b33 248size_t hex_width(u64 v);
b2aff5f6 249int hex2u64(const char *ptr, u64 *val);
61e04b33 250
08aa9cce 251char *ltrim(char *s);
cb1a28a0
ACM
252char *rtrim(char *s);
253
7d6a7e78
JO
254static inline char *trim(char *s)
255{
256 return ltrim(rtrim(s));
257}
258
dc4552bf 259void dump_stack(void);
07c1a0da 260void sighandler_dump_stack(int sig);
dc4552bf 261
0c1fe6b2 262extern unsigned int page_size;
2b1b7100 263extern int cacheline_size;
4cb93446 264extern unsigned int sysctl_perf_event_max_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);
1355915a 362#endif /* GIT_COMPAT_UTIL_H */
This page took 0.25427 seconds and 5 git commands to generate.