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

#ifndef GIT_COMPAT_UTIL_H
#define GIT_COMPAT_UTIL_H

#define _FILE_OFFSET_BITS 64

#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 "types.h"
#include <sys/ttydefaults.h>

extern const char *graph_line;
extern const char *graph_dotted_line;
extern char buildid_dir[];

/* 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

/* 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);
}

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

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) && sane_istest(x,0x20))
#define isupper(x) (sane_istest(x,GIT_ALPHA) && !sane_istest(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);

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);
unsigned long convert_unit(unsigned long value, char *unit);
int readn(int fd, void *buf, size_t size);

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));
}

size_t hex_width(u64 v);

char *rtrim(char *s);

void dump_stack(void);

extern unsigned int page_size;

#endif
Commit	Line	Data
07800601 IM	1	#ifndef GIT_COMPAT_UTIL_H
	2	#define GIT_COMPAT_UTIL_H
	3
	4	#define _FILE_OFFSET_BITS 64
	5
	6	#ifndef FLEX_ARRAY
	7	/*
	8	* See if our compiler is known to support flexible array members.
	9	*/
	10	#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
	11	# define FLEX_ARRAY /* empty */
	12	#elif defined(__GNUC__)
	13	# if (__GNUC__ >= 3)
	14	# define FLEX_ARRAY /* empty */
	15	# else
	16	# define FLEX_ARRAY 0 /* older GNU extension */
	17	# endif
	18	#endif
	19
	20	/*
	21	* Otherwise, default to safer but a bit wasteful traditional style
	22	*/
	23	#ifndef FLEX_ARRAY
	24	# define FLEX_ARRAY 1
	25	#endif
	26	#endif
	27
	28	#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
	29
	30	#ifdef __GNUC__
	31	#define TYPEOF(x) (__typeof__(x))
	32	#else
	33	#define TYPEOF(x)
	34	#endif
	35
	36	#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
	37	#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
	38
	39	/* Approximation of the length of the decimal representation of this type. */
	40	#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
	41
07800601	42	#define _ALL_SOURCE 1
07800601	43	#define _BSD_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 IM	68	#include <sys/wait.h>
	69	#include <sys/poll.h>
	70	#include <sys/socket.h>
	71	#include <sys/ioctl.h>
07800601	72	#include <inttypes.h>
f8fcd776	73	#include <linux/magic.h>
e206d556	74	#include "types.h"
46e3e055	75	#include <sys/ttydefaults.h>
1fe2c106	76
2890284b ACM	77	extern const char *graph_line;
2890284b ACM	78	extern const char *graph_dotted_line;
45de34bb	79	extern char buildid_dir[];
2890284b	80
07800601 IM	81	/* On most systems <limits.h> would have given us this, but
	82	* not on some systems (e.g. GNU/Hurd).
	83	*/
	84	#ifndef PATH_MAX
	85	#define PATH_MAX 4096
	86	#endif
	87
	88	#ifndef PRIuMAX
	89	#define PRIuMAX "llu"
	90	#endif
	91
	92	#ifndef PRIu32
	93	#define PRIu32 "u"
	94	#endif
	95
	96	#ifndef PRIx32
	97	#define PRIx32 "x"
	98	#endif
	99
	100	#ifndef PATH_SEP
	101	#define PATH_SEP ':'
	102	#endif
	103
	104	#ifndef STRIP_EXTENSION
	105	#define STRIP_EXTENSION ""
	106	#endif
	107
	108	#ifndef has_dos_drive_prefix
	109	#define has_dos_drive_prefix(path) 0
	110	#endif
	111
	112	#ifndef is_dir_sep
	113	#define is_dir_sep(c) ((c) == '/')
	114	#endif
	115
	116	#ifdef __GNUC__
	117	#define NORETURN __attribute__((__noreturn__))
	118	#else
	119	#define NORETURN
	120	#ifndef __attribute__
	121	#define __attribute__(x)
	122	#endif
	123	#endif
	124
	125	/* General helper functions */
	126	extern void usage(const char *err) NORETURN;
	127	extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
	128	extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
	129	extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
	130
9769833b MH	131	#include "../../../include/linux/stringify.h"
	132
	133	#define DIE_IF(cnd) \
	134	do { if (cnd) \
	135	die(" at (" __FILE__ ":" __stringify(__LINE__) "): " \
	136	__stringify(cnd) "\n"); \
	137	} while (0)
	138
	139
07800601 IM	140	extern void set_die_routine(void (routine)(const char err, va_list params) NORETURN);
	141
	142	extern int prefixcmp(const char str, const char prefix);
45de34bb	143	extern void set_buildid_dir(void);
a1ac1d3c	144	extern void disable_buildid_cache(void);
07800601 IM	145
	146	static inline const char skip_prefix(const char str, const char *prefix)
	147	{
	148	size_t len = strlen(prefix);
	149	return strncmp(str, prefix, len) ? NULL : str + len;
	150	}
	151
07800601 IM	152	#ifdef __GLIBC_PREREQ
	153	#if __GLIBC_PREREQ(2, 1)
	154	#define HAVE_STRCHRNUL
	155	#endif
	156	#endif
	157
	158	#ifndef HAVE_STRCHRNUL
	159	#define strchrnul gitstrchrnul
	160	static inline char gitstrchrnul(const char s, int c)
	161	{
	162	while (s && s != c)
	163	s++;
	164	return (char *)s;
	165	}
	166	#endif
	167
6f06ccbc IM	168	/*
	169	* Wrappers:
	170	*/
	171	extern char xstrdup(const char str);
727dad10	172	extern void xrealloc(void ptr, size_t size) __attribute__((weak));
16f762a2	173
a1d37d52	174
36479484 ACM	175	static inline void *zalloc(size_t size)
	176	{
	177	return calloc(1, size);
	178	}
	179
07800601 IM	180	static inline int has_extension(const char filename, const char ext)
	181	{
	182	size_t len = strlen(filename);
	183	size_t extlen = strlen(ext);
a1d37d52	184
07800601 IM	185	return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
	186	}
	187
	188	/* Sane ctype - no locale, and works with signed chars */
	189	#undef isascii
	190	#undef isspace
	191	#undef isdigit
9e827dd0	192	#undef isxdigit
07800601	193	#undef isalpha
5f9c39dc	194	#undef isprint
07800601	195	#undef isalnum
2cd13b0f NK	196	#undef islower
2cd13b0f NK	197	#undef isupper
07800601 IM	198	#undef tolower
07800601 IM	199	#undef toupper
a1d37d52	200
752fde44 ACM	201	#ifndef NSEC_PER_MSEC
	202	#define NSEC_PER_MSEC 1000000L
	203	#endif
	204
07800601	205	extern unsigned char sane_ctype[256];
a73c7d84 PZ	206	#define GIT_SPACE 0x01
	207	#define GIT_DIGIT 0x02
	208	#define GIT_ALPHA 0x04
	209	#define GIT_GLOB_SPECIAL 0x08
	210	#define GIT_REGEX_SPECIAL 0x10
	211	#define GIT_PRINT_EXTRA 0x20
	212	#define GIT_PRINT 0x3E
07800601 IM	213	#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
	214	#define isascii(x) (((x) & ~0x7f) == 0)
	215	#define isspace(x) sane_istest(x,GIT_SPACE)
	216	#define isdigit(x) sane_istest(x,GIT_DIGIT)
9e827dd0 FW	217	#define isxdigit(x) \
9e827dd0 FW	218	(sane_istest(toupper(x), GIT_ALPHA \| GIT_DIGIT) && toupper(x) < 'G')
07800601 IM	219	#define isalpha(x) sane_istest(x,GIT_ALPHA)
07800601 IM	220	#define isalnum(x) sane_istest(x,GIT_ALPHA \| GIT_DIGIT)
a73c7d84	221	#define isprint(x) sane_istest(x,GIT_PRINT)
2cd13b0f NK	222	#define islower(x) (sane_istest(x,GIT_ALPHA) && sane_istest(x,0x20))
2cd13b0f NK	223	#define isupper(x) (sane_istest(x,GIT_ALPHA) && !sane_istest(x,0x20))
07800601 IM	224	#define tolower(x) sane_case((unsigned char)(x), 0x20)
	225	#define toupper(x) sane_case((unsigned char)(x), 0)
	226
	227	static inline int sane_case(int x, int high)
	228	{
	229	if (sane_istest(x, GIT_ALPHA))
	230	x = (x & ~0x20) \| high;
	231	return x;
	232	}
	233
4cf40131 ACM	234	int mkdir_p(char *path, mode_t mode);
	235	int copyfile(const char from, const char to);
	236
e206d556 ACM	237	s64 perf_atoll(const char *str);
	238	char *argv_split(const char str, int *argcp);
	239	void argv_free(char **argv);
	240	bool strglobmatch(const char str, const char pat);
	241	bool strlazymatch(const char str, const char pat);
bad03ae4	242	int strtailcmp(const char s1, const char s2);
c82ee828	243	unsigned long convert_unit(unsigned long value, char *unit);
1e7972cc	244	int readn(int fd, void *buf, size_t size);
e206d556	245
1aed2671 JR	246	struct perf_event_attr;
	247
	248	void event_attr_init(struct perf_event_attr *attr);
	249
e206d556 ACM	250	#define _STR(x) #x
	251	#define STR(x) _STR(x)
	252
41d0d933 NE	253	/*
	254	* Determine whether some value is a power of two, where zero is
	255	* not considered a power of two.
	256	*/
	257
	258	static inline __attribute__((const))
	259	bool is_power_of_2(unsigned long n)
	260	{
	261	return (n != 0 && ((n & (n - 1)) == 0));
	262	}
	263
61e04b33 ACM	264	size_t hex_width(u64 v);
61e04b33 ACM	265
cb1a28a0 ACM	266	char rtrim(char s);
cb1a28a0 ACM	267
dc4552bf ACM	268	void dump_stack(void);
dc4552bf ACM	269
0c1fe6b2 ACM	270	extern unsigned int page_size;
0c1fe6b2 ACM	271
07800601	272	#endif