[deliverable/linux.git] / tools / perf / util / util.h

#ifndef GIT_COMPAT_UTIL_H
#define GIT_COMPAT_UTIL_H

#ifndef FLEX_ARRAY
/*
 * See if our compiler is known to support flexible array members.
 */
#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
# define FLEX_ARRAY /* empty */
#elif defined(__GNUC__)
# if (__GNUC__ >= 3)
#  define FLEX_ARRAY /* empty */
# else
#  define FLEX_ARRAY 0 /* older GNU extension */
# endif
#endif

/*
 * Otherwise, default to safer but a bit wasteful traditional style
 */
#ifndef FLEX_ARRAY
# define FLEX_ARRAY 1
#endif
#endif

#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))

#ifdef __GNUC__
#define TYPEOF(x) (__typeof__(x))
#else
#define TYPEOF(x)
#endif

#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
#define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */

/* Approximation of the length of the decimal representation of this type. */
#define decimal_length(x)	((int)(sizeof(x) * 2.56 + 0.5) + 1)

#define _ALL_SOURCE 1
#define _BSD_SOURCE 1
#define HAS_BOOL

#include <unistd.h>
#include <stdio.h>
#include <sys/stat.h>
#include <sys/statfs.h>
#include <fcntl.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <errno.h>
#include <limits.h>
#include <sys/param.h>
#include <sys/types.h>
#include <dirent.h>
#include <sys/time.h>
#include <time.h>
#include <signal.h>
#include <fnmatch.h>
#include <assert.h>
#include <regex.h>
#include <utime.h>
#include <sys/wait.h>
#include <sys/poll.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <inttypes.h>
#include <linux/magic.h>
#include <linux/types.h>
#include <sys/ttydefaults.h>
#include <api/fs/debugfs.h>
#include <termios.h>
#include <linux/bitops.h>

extern const char *graph_line;
extern const char *graph_dotted_line;
extern char buildid_dir[];
extern char tracing_events_path[];
extern void perf_debugfs_set_path(const char *mountpoint);
const char *perf_debugfs_mount(const char *mountpoint);
const char *find_tracing_dir(void);
char *get_tracing_file(const char *name);
void put_tracing_file(char *file);

/* On most systems <limits.h> would have given us this, but
 * not on some systems (e.g. GNU/Hurd).
 */
#ifndef PATH_MAX
#define PATH_MAX 4096
#endif

#ifndef PRIuMAX
#define PRIuMAX "llu"
#endif

#ifndef PRIu32
#define PRIu32 "u"
#endif

#ifndef PRIx32
#define PRIx32 "x"
#endif

#ifndef PATH_SEP
#define PATH_SEP ':'
#endif

#ifndef STRIP_EXTENSION
#define STRIP_EXTENSION ""
#endif

#ifndef has_dos_drive_prefix
#define has_dos_drive_prefix(path) 0
#endif

#ifndef is_dir_sep
#define is_dir_sep(c) ((c) == '/')
#endif

#ifdef __GNUC__
#define NORETURN __attribute__((__noreturn__))
#else
#define NORETURN
#ifndef __attribute__
#define __attribute__(x)
#endif
#endif

#define PERF_GTK_DSO  "libperf-gtk.so"

/* General helper functions */
extern void usage(const char *err) NORETURN;
extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));

#include "../../../include/linux/stringify.h"

#define DIE_IF(cnd)	\
	do { if (cnd)	\
		die(" at (" __FILE__ ":" __stringify(__LINE__) "): "	\
		    __stringify(cnd) "\n");				\
	} while (0)


extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);

extern int prefixcmp(const char *str, const char *prefix);
extern void set_buildid_dir(void);
extern void disable_buildid_cache(void);

static inline const char *skip_prefix(const char *str, const char *prefix)
{
	size_t len = strlen(prefix);
	return strncmp(str, prefix, len) ? NULL : str + len;
}

#ifdef __GLIBC_PREREQ
#if __GLIBC_PREREQ(2, 1)
#define HAVE_STRCHRNUL
#endif
#endif

#ifndef HAVE_STRCHRNUL
#define strchrnul gitstrchrnul
static inline char *gitstrchrnul(const char *s, int c)
{
	while (*s && *s != c)
		s++;
	return (char *)s;
}
#endif

/*
 * Wrappers:
 */
extern char *xstrdup(const char *str);
extern void *xrealloc(void *ptr, size_t size) __attribute__((weak));


static inline void *zalloc(size_t size)
{
	return calloc(1, size);
}

#define zfree(ptr) ({ free(*ptr); *ptr = NULL; })

static inline int has_extension(const char *filename, const char *ext)
{
	size_t len = strlen(filename);
	size_t extlen = strlen(ext);

	return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
}

/* Sane ctype - no locale, and works with signed chars */
#undef isascii
#undef isspace
#undef isdigit
#undef isxdigit
#undef isalpha
#undef isprint
#undef isalnum
#undef islower
#undef isupper
#undef tolower
#undef toupper

#ifndef NSEC_PER_MSEC
#define NSEC_PER_MSEC	1000000L
#endif

int parse_nsec_time(const char *str, u64 *ptime);

extern unsigned char sane_ctype[256];
#define GIT_SPACE		0x01
#define GIT_DIGIT		0x02
#define GIT_ALPHA		0x04
#define GIT_GLOB_SPECIAL	0x08
#define GIT_REGEX_SPECIAL	0x10
#define GIT_PRINT_EXTRA		0x20
#define GIT_PRINT		0x3E
#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
#define isascii(x) (((x) & ~0x7f) == 0)
#define isspace(x) sane_istest(x,GIT_SPACE)
#define isdigit(x) sane_istest(x,GIT_DIGIT)
#define isxdigit(x)	\
	(sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
#define isalpha(x) sane_istest(x,GIT_ALPHA)
#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
#define isprint(x) sane_istest(x,GIT_PRINT)
#define islower(x) (sane_istest(x,GIT_ALPHA) && (x & 0x20))
#define isupper(x) (sane_istest(x,GIT_ALPHA) && !(x & 0x20))
#define tolower(x) sane_case((unsigned char)(x), 0x20)
#define toupper(x) sane_case((unsigned char)(x), 0)

static inline int sane_case(int x, int high)
{
	if (sane_istest(x, GIT_ALPHA))
		x = (x & ~0x20) | high;
	return x;
}

int mkdir_p(char *path, mode_t mode);
int copyfile(const char *from, const char *to);
int copyfile_mode(const char *from, const char *to, mode_t mode);

s64 perf_atoll(const char *str);
char **argv_split(const char *str, int *argcp);
void argv_free(char **argv);
bool strglobmatch(const char *str, const char *pat);
bool strlazymatch(const char *str, const char *pat);
int strtailcmp(const char *s1, const char *s2);
char *strxfrchar(char *s, char from, char to);
unsigned long convert_unit(unsigned long value, char *unit);
ssize_t readn(int fd, void *buf, size_t n);
ssize_t writen(int fd, void *buf, size_t n);

struct perf_event_attr;

void event_attr_init(struct perf_event_attr *attr);

#define _STR(x) #x
#define STR(x) _STR(x)

/*
 *  Determine whether some value is a power of two, where zero is
 * *not* considered a power of two.
 */

static inline __attribute__((const))
bool is_power_of_2(unsigned long n)
{
	return (n != 0 && ((n & (n - 1)) == 0));
}

static inline unsigned next_pow2(unsigned x)
{
	if (!x)
		return 1;
	return 1ULL << (32 - __builtin_clz(x - 1));
}

static inline unsigned long next_pow2_l(unsigned long x)
{
#if BITS_PER_LONG == 64
	if (x <= (1UL << 31))
		return next_pow2(x);
	return (unsigned long)next_pow2(x >> 32) << 32;
#else
	return next_pow2(x);
#endif
}

size_t hex_width(u64 v);
int hex2u64(const char *ptr, u64 *val);

char *ltrim(char *s);
char *rtrim(char *s);

void dump_stack(void);

extern unsigned int page_size;
extern int cacheline_size;

void get_term_dimensions(struct winsize *ws);

struct parse_tag {
	char tag;
	int mult;
};

unsigned long parse_tag_value(const char *str, struct parse_tag *tags);

#define SRCLINE_UNKNOWN  ((char *) "??:0")

struct dso;

char *get_srcline(struct dso *dso, unsigned long addr);
void free_srcline(char *srcline);

int filename__read_int(const char *filename, int *value);
int filename__read_str(const char *filename, char **buf, size_t *sizep);
int perf_event_paranoid(void);

void mem_bswap_64(void *src, int byte_size);
void mem_bswap_32(void *src, int byte_size);

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