[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/kernel.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>
#include <termios.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);
void set_term_quiet_input(struct termios *old);

struct parse_tag {
	char tag;
	int mult;
};

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

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

static inline int path__join(char *bf, size_t size,
			     const char *path1, const char *path2)
{
	return scnprintf(bf, size, "%s%s%s", path1, path1[0] ? "/" : "", path2);
}

static inline int path__join3(char *bf, size_t size,
			      const char *path1, const char *path2,
			      const char *path3)
{
	return scnprintf(bf, size, "%s%s%s%s%s",
			 path1, path1[0] ? "/" : "",
			 path2, path2[0] ? "/" : "", path3);
}

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