[linux-2.6-block.git] / tools / perf / util / util.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __PERF_UTIL_H
#define __PERF_UTIL_H

#define _BSD_SOURCE 1
/* glibc 2.20 deprecates _BSD_SOURCE in favour of _DEFAULT_SOURCE */
#define _DEFAULT_SOURCE 1

#include <dirent.h>
#include <fcntl.h>
#include <stdbool.h>
#include <stddef.h>
#include <linux/compiler.h>
#include <sys/types.h>
#ifndef __cplusplus
#include <internal/cpumap.h>
#endif

extern const char perf_usage_string[];
extern const char perf_more_info_string[];

extern const char *input_name;

extern bool perf_host;
extern bool perf_guest;

/* General helper functions */
void usage(const char *err) __noreturn;
void die(const char *err, ...) __noreturn __printf(1, 2);

struct dirent;
struct strlist;

int mkdir_p(char *path, mode_t mode);
int rm_rf(const char *path);
int rm_rf_perf_data(const char *path);
struct strlist *lsdir(const char *name, bool (*filter)(const char *, struct dirent *));
bool lsdir_no_dot_filter(const char *name, struct dirent *d);

size_t hex_width(u64 v);

int sysctl__max_stack(void);

bool sysctl__nmi_watchdog_enabled(void);

int fetch_kernel_version(unsigned int *puint,
			 char *str, size_t str_sz);
#define KVER_VERSION(x)		(((x) >> 16) & 0xff)
#define KVER_PATCHLEVEL(x)	(((x) >> 8) & 0xff)
#define KVER_SUBLEVEL(x)	((x) & 0xff)
#define KVER_FMT	"%d.%d.%d"
#define KVER_PARAM(x)	KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)

int perf_tip(char **strp, const char *dirpath);

#ifndef HAVE_SCHED_GETCPU_SUPPORT
int sched_getcpu(void);
#endif

#ifndef HAVE_SCANDIRAT_SUPPORT
int scandirat(int dirfd, const char *dirp,
	      struct dirent ***namelist,
	      int (*filter)(const struct dirent *),
	      int (*compar)(const struct dirent **, const struct dirent **));
#endif

extern bool perf_singlethreaded;

void perf_set_singlethreaded(void);
void perf_set_multithreaded(void);

char *perf_exe(char *buf, int len);

#ifndef O_CLOEXEC
#ifdef __sparc__
#define O_CLOEXEC      0x400000
#elif defined(__alpha__) || defined(__hppa__)
#define O_CLOEXEC      010000000
#else
#define O_CLOEXEC      02000000
#endif
#endif

extern bool test_attr__enabled;
void test_attr__ready(void);
void test_attr__init(void);
struct perf_event_attr;
void test_attr__open(struct perf_event_attr *attr, pid_t pid, struct perf_cpu cpu,
		     int fd, int group_fd, unsigned long flags);

struct perf_debuginfod {
	const char	*urls;
	bool		 set;
};
void perf_debuginfod_setup(struct perf_debuginfod *di);

char *filename_with_chroot(int pid, const char *filename);

int do_realloc_array_as_needed(void **arr, size_t *arr_sz, size_t x,
			       size_t msz, const void *init_val);

#define realloc_array_as_needed(a, n, x, v) ({			\
	typeof(x) __x = (x);					\
	__x >= (n) ?						\
		do_realloc_array_as_needed((void **)&(a),	\
					   &(n),		\
					   __x,			\
					   sizeof(*(a)),	\
					   (const void *)(v)) :	\
		0;						\
	})

static inline bool host_is_bigendian(void)
{
#ifdef __BYTE_ORDER__
#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
	return false;
#elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
	return true;
#else
#error "Unrecognized __BYTE_ORDER__"
#endif
#else /* !__BYTE_ORDER__ */
	unsigned char str[] = { 0x1, 0x2, 0x3, 0x4, 0x0, 0x0, 0x0, 0x0};
	unsigned int *ptr;

	ptr = (unsigned int *)(void *)str;
	return *ptr == 0x01020304;
#endif
}

#endif /* __PERF_UTIL_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
fce9a619 IR	2	#ifndef __PERF_UTIL_H
fce9a619 IR	3	#define __PERF_UTIL_H
07800601	4
07800601	5	#define _BSD_SOURCE 1
512fe365 CP	6	/* glibc 2.20 deprecates _BSD_SOURCE in favour of _DEFAULT_SOURCE */
512fe365 CP	7	#define _DEFAULT_SOURCE 1
07800601	8
8ece26ad	9	#include <dirent.h>
ed93d0a2	10	#include <fcntl.h>
e206d556	11	#include <stdbool.h>
07800601	12	#include <stddef.h>
6c346643	13	#include <linux/compiler.h>
ad0902e0	14	#include <sys/types.h>
6d18804b IR	15	#ifndef __cplusplus
	16	#include <internal/cpumap.h>
	17	#endif
1fe2c106	18
0adea51a IR	19	extern const char perf_usage_string[];
	20	extern const char perf_more_info_string[];
	21
f12ad272 IR	22	extern const char *input_name;
f12ad272 IR	23
ea0c5239 IR	24	extern bool perf_host;
	25	extern bool perf_guest;
	26
07800601	27	/* General helper functions */
6c346643	28	void usage(const char *err) __noreturn;
afaed6d3	29	void die(const char *err, ...) __noreturn __printf(1, 2);
07800601	30
76b31a29	31	struct dirent;
8ec20b17 ACM	32	struct strlist;
8ec20b17 ACM	33
4cf40131	34	int mkdir_p(char *path, mode_t mode);
9a9c733d	35	int rm_rf(const char *path);
c69e4c37	36	int rm_rf_perf_data(const char *path);
e1ce726e MH	37	struct strlist lsdir(const char name, bool (filter)(const char , struct dirent *));
e1ce726e MH	38	bool lsdir_no_dot_filter(const char name, struct dirent d);
4cf40131	39
61e04b33 ACM	40	size_t hex_width(u64 v);
61e04b33 ACM	41
029c75e5 ACM	42	int sysctl__max_stack(void);
029c75e5 ACM	43
2a14c1bf KL	44	bool sysctl__nmi_watchdog_enabled(void);
2a14c1bf KL	45
07bc5c69 WN	46	int fetch_kernel_version(unsigned int *puint,
07bc5c69 WN	47	char *str, size_t str_sz);
d3e0ce39 WN	48	#define KVER_VERSION(x) (((x) >> 16) & 0xff)
	49	#define KVER_PATCHLEVEL(x) (((x) >> 8) & 0xff)
	50	#define KVER_SUBLEVEL(x) ((x) & 0xff)
	51	#define KVER_FMT "%d.%d.%d"
	52	#define KVER_PARAM(x) KVER_VERSION(x), KVER_PATCHLEVEL(x), KVER_SUBLEVEL(x)
07bc5c69	53
d9fc7061	54	int perf_tip(char *strp, const char dirpath);
14cbfbeb	55
120010cb ACM	56	#ifndef HAVE_SCHED_GETCPU_SUPPORT
120010cb ACM	57	int sched_getcpu(void);
c7007e98 ACM	58	#endif
c7007e98 ACM	59
8ece26ad IR	60	#ifndef HAVE_SCANDIRAT_SUPPORT
	61	int scandirat(int dirfd, const char *dirp,
	62	struct dirent ***namelist,
	63	int (filter)(const struct dirent ),
	64	int (compar)(const struct dirent , const struct dirent *));
	65	#endif
	66
0a7c74ea ACM	67	extern bool perf_singlethreaded;
	68
	69	void perf_set_singlethreaded(void);
	70	void perf_set_multithreaded(void);
	71
94816add AK	72	char perf_exe(char buf, int len);
94816add AK	73
5c61d70e ACM	74	#ifndef O_CLOEXEC
	75	#ifdef __sparc__
	76	#define O_CLOEXEC 0x400000
	77	#elif defined(__alpha__) \|\| defined(__hppa__)
	78	#define O_CLOEXEC 010000000
	79	#else
	80	#define O_CLOEXEC 02000000
	81	#endif
	82	#endif
	83
8366f0d2 JO	84	extern bool test_attr__enabled;
	85	void test_attr__ready(void);
	86	void test_attr__init(void);
	87	struct perf_event_attr;
6d18804b	88	void test_attr__open(struct perf_event_attr *attr, pid_t pid, struct perf_cpu cpu,
8366f0d2	89	int fd, int group_fd, unsigned long flags);
9bce13ea JO	90
	91	struct perf_debuginfod {
	92	const char *urls;
	93	bool set;
	94	};
	95	void perf_debuginfod_setup(struct perf_debuginfod *di);
67fd1892 NK	96
67fd1892 NK	97	char filename_with_chroot(int pid, const char filename);
10d34700 AH	98
	99	int do_realloc_array_as_needed(void *arr, size_t arr_sz, size_t x,
	100	size_t msz, const void *init_val);
	101
	102	#define realloc_array_as_needed(a, n, x, v) ({ \
	103	typeof(x) __x = (x); \
	104	__x >= (n) ? \
	105	do_realloc_array_as_needed((void **)&(a), \
	106	&(n), \
	107	__x, \
	108	sizeof(*(a)), \
	109	(const void *)(v)) : \
	110	0; \
	111	})
	112
5b7a29fb IR	113	static inline bool host_is_bigendian(void)
	114	{
	115	#ifdef __BYTE_ORDER__
	116	#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
	117	return false;
	118	#elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
	119	return true;
	120	#else
	121	#error "Unrecognized __BYTE_ORDER__"
	122	#endif
	123	#else /* !__BYTE_ORDER__ */
	124	unsigned char str[] = { 0x1, 0x2, 0x3, 0x4, 0x0, 0x0, 0x0, 0x0};
	125	unsigned int *ptr;
	126
	127	ptr = (unsigned int )(void )str;
	128	return *ptr == 0x01020304;
	129	#endif
	130	}
	131
fce9a619	132	#endif /* __PERF_UTIL_H */