perf callchain: Make get_srcline fall back to sym+offset
[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>
56#include <errno.h>
57#include <limits.h>
58#include <sys/param.h>
59#include <sys/types.h>
60#include <dirent.h>
61#include <sys/time.h>
62#include <time.h>
63#include <signal.h>
64#include <fnmatch.h>
65#include <assert.h>
66#include <regex.h>
67#include <utime.h>
07800601 68#include <sys/wait.h>
a8fa4960 69#include <poll.h>
07800601
IM
70#include <sys/socket.h>
71#include <sys/ioctl.h>
07800601 72#include <inttypes.h>
972f393b 73#include <linux/kernel.h>
f8fcd776 74#include <linux/magic.h>
d944c4ee 75#include <linux/types.h>
46e3e055 76#include <sys/ttydefaults.h>
553873e1 77#include <api/fs/debugfs.h>
756bbc84 78#include <termios.h>
1dbfa938 79#include <linux/bitops.h>
9398c484 80#include <termios.h>
1fe2c106 81
2890284b
ACM
82extern const char *graph_line;
83extern const char *graph_dotted_line;
45de34bb 84extern char buildid_dir[];
1355915a
BP
85extern char tracing_events_path[];
86extern void perf_debugfs_set_path(const char *mountpoint);
87const char *perf_debugfs_mount(const char *mountpoint);
167aedc4
NK
88const char *find_tracing_dir(void);
89char *get_tracing_file(const char *name);
90void put_tracing_file(char *file);
2890284b 91
07800601
IM
92/* On most systems <limits.h> would have given us this, but
93 * not on some systems (e.g. GNU/Hurd).
94 */
95#ifndef PATH_MAX
96#define PATH_MAX 4096
97#endif
98
99#ifndef PRIuMAX
100#define PRIuMAX "llu"
101#endif
102
103#ifndef PRIu32
104#define PRIu32 "u"
105#endif
106
107#ifndef PRIx32
108#define PRIx32 "x"
109#endif
110
111#ifndef PATH_SEP
112#define PATH_SEP ':'
113#endif
114
115#ifndef STRIP_EXTENSION
116#define STRIP_EXTENSION ""
117#endif
118
119#ifndef has_dos_drive_prefix
120#define has_dos_drive_prefix(path) 0
121#endif
122
123#ifndef is_dir_sep
124#define is_dir_sep(c) ((c) == '/')
125#endif
126
127#ifdef __GNUC__
128#define NORETURN __attribute__((__noreturn__))
129#else
130#define NORETURN
131#ifndef __attribute__
132#define __attribute__(x)
133#endif
134#endif
135
fc67297b
NK
136#define PERF_GTK_DSO "libperf-gtk.so"
137
07800601
IM
138/* General helper functions */
139extern void usage(const char *err) NORETURN;
140extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
141extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
142extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
143
9769833b
MH
144#include "../../../include/linux/stringify.h"
145
146#define DIE_IF(cnd) \
147 do { if (cnd) \
148 die(" at (" __FILE__ ":" __stringify(__LINE__) "): " \
149 __stringify(cnd) "\n"); \
150 } while (0)
151
152
07800601
IM
153extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
154
155extern int prefixcmp(const char *str, const char *prefix);
45de34bb 156extern void set_buildid_dir(void);
07800601
IM
157
158static inline const char *skip_prefix(const char *str, const char *prefix)
159{
160 size_t len = strlen(prefix);
161 return strncmp(str, prefix, len) ? NULL : str + len;
162}
163
07800601
IM
164#ifdef __GLIBC_PREREQ
165#if __GLIBC_PREREQ(2, 1)
166#define HAVE_STRCHRNUL
167#endif
168#endif
169
170#ifndef HAVE_STRCHRNUL
171#define strchrnul gitstrchrnul
172static inline char *gitstrchrnul(const char *s, int c)
173{
174 while (*s && *s != c)
175 s++;
176 return (char *)s;
177}
178#endif
179
6f06ccbc
IM
180/*
181 * Wrappers:
182 */
183extern char *xstrdup(const char *str);
727dad10 184extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));
16f762a2 185
a1d37d52 186
36479484
ACM
187static inline void *zalloc(size_t size)
188{
189 return calloc(1, size);
190}
191
04662523
ACM
192#define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
193
07800601
IM
194static inline int has_extension(const char *filename, const char *ext)
195{
196 size_t len = strlen(filename);
197 size_t extlen = strlen(ext);
a1d37d52 198
07800601
IM
199 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
200}
201
202/* Sane ctype - no locale, and works with signed chars */
203#undef isascii
204#undef isspace
205#undef isdigit
9e827dd0 206#undef isxdigit
07800601 207#undef isalpha
5f9c39dc 208#undef isprint
07800601 209#undef isalnum
2cd13b0f
NK
210#undef islower
211#undef isupper
07800601
IM
212#undef tolower
213#undef toupper
a1d37d52 214
752fde44
ACM
215#ifndef NSEC_PER_MSEC
216#define NSEC_PER_MSEC 1000000L
217#endif
218
3b47abe1
NK
219int parse_nsec_time(const char *str, u64 *ptime);
220
07800601 221extern unsigned char sane_ctype[256];
a73c7d84
PZ
222#define GIT_SPACE 0x01
223#define GIT_DIGIT 0x02
224#define GIT_ALPHA 0x04
225#define GIT_GLOB_SPECIAL 0x08
226#define GIT_REGEX_SPECIAL 0x10
227#define GIT_PRINT_EXTRA 0x20
228#define GIT_PRINT 0x3E
07800601
IM
229#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
230#define isascii(x) (((x) & ~0x7f) == 0)
231#define isspace(x) sane_istest(x,GIT_SPACE)
232#define isdigit(x) sane_istest(x,GIT_DIGIT)
9e827dd0
FW
233#define isxdigit(x) \
234 (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
07800601
IM
235#define isalpha(x) sane_istest(x,GIT_ALPHA)
236#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
a73c7d84 237#define isprint(x) sane_istest(x,GIT_PRINT)
6956664a
SB
238#define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
239#define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
07800601
IM
240#define tolower(x) sane_case((unsigned char)(x), 0x20)
241#define toupper(x) sane_case((unsigned char)(x), 0)
242
243static inline int sane_case(int x, int high)
244{
245 if (sane_istest(x, GIT_ALPHA))
246 x = (x & ~0x20) | high;
247 return x;
248}
249
4cf40131
ACM
250int mkdir_p(char *path, mode_t mode);
251int copyfile(const char *from, const char *to);
9a17d726 252int copyfile_mode(const char *from, const char *to, mode_t mode);
4cf40131 253
e206d556
ACM
254s64 perf_atoll(const char *str);
255char **argv_split(const char *str, int *argcp);
256void argv_free(char **argv);
257bool strglobmatch(const char *str, const char *pat);
258bool strlazymatch(const char *str, const char *pat);
bad03ae4 259int strtailcmp(const char *s1, const char *s2);
ea36c46b 260char *strxfrchar(char *s, char from, char to);
c82ee828 261unsigned long convert_unit(unsigned long value, char *unit);
727ebd54 262ssize_t readn(int fd, void *buf, size_t n);
bc3a502b 263ssize_t writen(int fd, void *buf, size_t n);
e206d556 264
1aed2671
JR
265struct perf_event_attr;
266
267void event_attr_init(struct perf_event_attr *attr);
268
e206d556
ACM
269#define _STR(x) #x
270#define STR(x) _STR(x)
271
41d0d933
NE
272/*
273 * Determine whether some value is a power of two, where zero is
274 * *not* considered a power of two.
275 */
276
277static inline __attribute__((const))
278bool is_power_of_2(unsigned long n)
279{
280 return (n != 0 && ((n & (n - 1)) == 0));
281}
282
27050f53
JO
283static inline unsigned next_pow2(unsigned x)
284{
285 if (!x)
286 return 1;
287 return 1ULL << (32 - __builtin_clz(x - 1));
288}
289
1dbfa938
AH
290static inline unsigned long next_pow2_l(unsigned long x)
291{
292#if BITS_PER_LONG == 64
293 if (x <= (1UL << 31))
294 return next_pow2(x);
295 return (unsigned long)next_pow2(x >> 32) << 32;
296#else
297 return next_pow2(x);
298#endif
299}
300
61e04b33 301size_t hex_width(u64 v);
b2aff5f6 302int hex2u64(const char *ptr, u64 *val);
61e04b33 303
08aa9cce 304char *ltrim(char *s);
cb1a28a0
ACM
305char *rtrim(char *s);
306
dc4552bf
ACM
307void dump_stack(void);
308
0c1fe6b2 309extern unsigned int page_size;
2b1b7100 310extern int cacheline_size;
0c1fe6b2 311
2c803e52 312void get_term_dimensions(struct winsize *ws);
9398c484 313void set_term_quiet_input(struct termios *old);
27050f53
JO
314
315struct parse_tag {
316 char tag;
317 int mult;
318};
319
320unsigned long parse_tag_value(const char *str, struct parse_tag *tags);
f048d548
NK
321
322#define SRCLINE_UNKNOWN ((char *) "??:0")
323
972f393b
ACM
324static inline int path__join(char *bf, size_t size,
325 const char *path1, const char *path2)
326{
327 return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
328}
329
330static inline int path__join3(char *bf, size_t size,
331 const char *path1, const char *path2,
332 const char *path3)
333{
334 return scnprintf(bf, size, "%s%s%s%s%s",
335 path1, path1[0] ? "/" : "",
336 path2, path2[0] ? "/" : "", path3);
337}
338
86c98cab 339struct dso;
85c116a6 340struct symbol;
86c98cab 341
85c116a6
AK
342char *get_srcline(struct dso *dso, unsigned long addr, struct symbol *sym,
343 bool show_sym);
f048d548 344void free_srcline(char *srcline);
97a07f10
ACM
345
346int filename__read_int(const char *filename, int *value);
cef82c9f 347int filename__read_str(const char *filename, char **buf, size_t *sizep);
1a47245d 348int perf_event_paranoid(void);
e1a2b174 349
71db07b1
AH
350void mem_bswap_64(void *src, int byte_size);
351void mem_bswap_32(void *src, int byte_size);
352
e1a2b174 353const char *get_filename_for_perf_kvm(void);
63914aca 354bool find_process(const char *name);
e92ce12e
NK
355
356#ifdef HAVE_ZLIB_SUPPORT
357int gzip_decompress_to_file(const char *input, int output_fd);
358#endif
359
1355915a 360#endif /* GIT_COMPAT_UTIL_H */
This page took 0.230967 seconds and 5 git commands to generate.