leds: gpio: Support the "panic-indicator" firmware property
[linux-2.6-block.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>
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
6f06ccbc
IM
162/*
163 * Wrappers:
164 */
3938bad4 165void *xrealloc(void *ptr, size_t size) __attribute__((weak));
16f762a2 166
a1d37d52 167
36479484
ACM
168static inline void *zalloc(size_t size)
169{
170 return calloc(1, size);
171}
172
04662523
ACM
173#define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
174
07800601
IM
175/* Sane ctype - no locale, and works with signed chars */
176#undef isascii
177#undef isspace
178#undef isdigit
9e827dd0 179#undef isxdigit
07800601 180#undef isalpha
5f9c39dc 181#undef isprint
07800601 182#undef isalnum
2cd13b0f
NK
183#undef islower
184#undef isupper
07800601
IM
185#undef tolower
186#undef toupper
a1d37d52 187
752fde44
ACM
188#ifndef NSEC_PER_MSEC
189#define NSEC_PER_MSEC 1000000L
190#endif
191
3b47abe1
NK
192int parse_nsec_time(const char *str, u64 *ptime);
193
07800601 194extern unsigned char sane_ctype[256];
a73c7d84
PZ
195#define GIT_SPACE 0x01
196#define GIT_DIGIT 0x02
197#define GIT_ALPHA 0x04
198#define GIT_GLOB_SPECIAL 0x08
199#define GIT_REGEX_SPECIAL 0x10
200#define GIT_PRINT_EXTRA 0x20
201#define GIT_PRINT 0x3E
07800601
IM
202#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
203#define isascii(x) (((x) & ~0x7f) == 0)
204#define isspace(x) sane_istest(x,GIT_SPACE)
205#define isdigit(x) sane_istest(x,GIT_DIGIT)
9e827dd0
FW
206#define isxdigit(x) \
207 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
07800601
IM
208#define isalpha(x) sane_istest(x,GIT_ALPHA)
209#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
a73c7d84 210#define isprint(x) sane_istest(x,GIT_PRINT)
6956664a
SB
211#define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
212#define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
07800601
IM
213#define tolower(x) sane_case((unsigned char)(x), 0x20)
214#define toupper(x) sane_case((unsigned char)(x), 0)
215
216static inline int sane_case(int x, int high)
217{
218 if (sane_istest(x, GIT_ALPHA))
219 x = (x & ~0x20) | high;
220 return x;
221}
222
4cf40131 223int mkdir_p(char *path, mode_t mode);
0b1de0be 224int rm_rf(char *path);
4cf40131 225int copyfile(const char *from, const char *to);
9a17d726 226int copyfile_mode(const char *from, const char *to, mode_t mode);
9c9f5a2f 227int copyfile_offset(int fromfd, loff_t from_ofs, int tofd, loff_t to_ofs, u64 size);
4cf40131 228
e206d556
ACM
229s64 perf_atoll(const char *str);
230char **argv_split(const char *str, int *argcp);
231void argv_free(char **argv);
232bool strglobmatch(const char *str, const char *pat);
233bool strlazymatch(const char *str, const char *pat);
4c859351
MH
234static inline bool strisglob(const char *str)
235{
236 return strpbrk(str, "*?[") != NULL;
237}
bad03ae4 238int strtailcmp(const char *s1, const char *s2);
ea36c46b 239char *strxfrchar(char *s, char from, char to);
c82ee828 240unsigned long convert_unit(unsigned long value, char *unit);
727ebd54 241ssize_t readn(int fd, void *buf, size_t n);
bc3a502b 242ssize_t writen(int fd, void *buf, size_t n);
e206d556 243
1aed2671
JR
244struct perf_event_attr;
245
246void event_attr_init(struct perf_event_attr *attr);
247
e206d556
ACM
248#define _STR(x) #x
249#define STR(x) _STR(x)
250
61e04b33 251size_t hex_width(u64 v);
b2aff5f6 252int hex2u64(const char *ptr, u64 *val);
61e04b33 253
08aa9cce 254char *ltrim(char *s);
cb1a28a0
ACM
255char *rtrim(char *s);
256
dc4552bf 257void dump_stack(void);
07c1a0da 258void sighandler_dump_stack(int sig);
dc4552bf 259
0c1fe6b2 260extern unsigned int page_size;
2b1b7100 261extern int cacheline_size;
0c1fe6b2 262
27050f53
JO
263struct parse_tag {
264 char tag;
265 int mult;
266};
267
268unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
f048d548
NK
269
270#define SRCLINE_UNKNOWN ((char *) "??:0")
271
972f393b
ACM
272static inline int path__join(char *bf, size_t size,
273 const char *path1, const char *path2)
274{
275 return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
276}
277
278static inline int path__join3(char *bf, size_t size,
279 const char *path1, const char *path2,
280 const char *path3)
281{
282 return scnprintf(bf, size, "%s%s%s%s%s",
283 path1, path1[0] ? "/" : "",
284 path2, path2[0] ? "/" : "", path3);
285}
286
86c98cab 287struct dso;
85c116a6 288struct symbol;
86c98cab 289
a9710ba0 290extern bool srcline_full_filename;
ac931f87 291char *get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
85c116a6 292 bool show_sym);
2f84b42b
AK
293char *__get_srcline(struct dso *dso, u64 addr, struct symbol *sym,
294 bool show_sym, bool unwind_inlines);
f048d548 295void free_srcline(char *srcline);
97a07f10 296
1a47245d 297int perf_event_paranoid(void);
e1a2b174 298
71db07b1
AH
299void mem_bswap_64(void *src, int byte_size);
300void mem_bswap_32(void *src, int byte_size);
301
e1a2b174 302const char *get_filename_for_perf_kvm(void);
63914aca 303bool find_process(const char *name);
e92ce12e
NK
304
305#ifdef HAVE_ZLIB_SUPPORT
306int gzip_decompress_to_file(const char *input, int output_fd);
307#endif
308
80a32e5b
JO
309#ifdef HAVE_LZMA_SUPPORT
310int lzma_decompress_to_file(const char *input, int output_fd);
311#endif
312
93ec4ce7
ACM
313char *asprintf_expr_inout_ints(const char *var, bool in, size_t nints, int *ints);
314
315static inline char *asprintf_expr_in_ints(const char *var, size_t nints, int *ints)
316{
317 return asprintf_expr_inout_ints(var, true, nints, ints);
318}
319
320static inline char *asprintf_expr_not_in_ints(const char *var, size_t nints, int *ints)
321{
322 return asprintf_expr_inout_ints(var, false, nints, ints);
323}
324
076a30c4
KL
325int get_stack_size(const char *str, unsigned long *_size);
326
07bc5c69
WN
327int fetch_kernel_version(unsigned int *puint,
328 char *str, size_t str_sz);
d3e0ce39
WN
329#define KVER_VERSION(x) (((x) >> 16) & 0xff)
330#define KVER_PATCHLEVEL(x) (((x) >> 8) & 0xff)
331#define KVER_SUBLEVEL(x) ((x) & 0xff)
332#define KVER_FMT "%d.%d.%d"
333#define KVER_PARAM(x) KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)
07bc5c69 334
14cbfbeb 335const char *perf_tip(const char *dirpath);
40356721 336bool is_regular_file(const char *file);
37b20151 337int fetch_current_timestamp(char *buf, size_t sz);
14cbfbeb 338
c339b1a9
WN
339enum binary_printer_ops {
340 BINARY_PRINT_DATA_BEGIN,
341 BINARY_PRINT_LINE_BEGIN,
342 BINARY_PRINT_ADDR,
343 BINARY_PRINT_NUM_DATA,
344 BINARY_PRINT_NUM_PAD,
345 BINARY_PRINT_SEP,
346 BINARY_PRINT_CHAR_DATA,
347 BINARY_PRINT_CHAR_PAD,
348 BINARY_PRINT_LINE_END,
349 BINARY_PRINT_DATA_END,
350};
351
352typedef void (*print_binary_t)(enum binary_printer_ops,
353 unsigned int val,
354 void *extra);
355
356void print_binary(unsigned char *data, size_t len,
357 size_t bytes_per_line, print_binary_t printer,
358 void *extra);
1355915a 359#endif /* GIT_COMPAT_UTIL_H */