[mirror_ubuntu-jammy-kernel.git] / tools / perf / util / target.h

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

#include <stdbool.h>
#include <sys/types.h>

struct target {
	const char   *pid;
	const char   *tid;
	const char   *cpu_list;
	const char   *uid_str;
	uid_t	     uid;
	bool	     system_wide;
	bool	     uses_mmap;
	bool	     default_per_cpu;
	bool	     per_thread;
};

enum target_errno {
	TARGET_ERRNO__SUCCESS		= 0,

	/*
	 * Choose an arbitrary negative big number not to clash with standard
	 * errno since SUS requires the errno has distinct positive values.
	 * See 'Issue 6' in the link below.
	 *
	 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
	 */
	__TARGET_ERRNO__START		= -10000,

	/* for target__validate() */
	TARGET_ERRNO__PID_OVERRIDE_CPU	= __TARGET_ERRNO__START,
	TARGET_ERRNO__PID_OVERRIDE_UID,
	TARGET_ERRNO__UID_OVERRIDE_CPU,
	TARGET_ERRNO__PID_OVERRIDE_SYSTEM,
	TARGET_ERRNO__UID_OVERRIDE_SYSTEM,
	TARGET_ERRNO__SYSTEM_OVERRIDE_THREAD,

	/* for target__parse_uid() */
	TARGET_ERRNO__INVALID_UID,
	TARGET_ERRNO__USER_NOT_FOUND,

	__TARGET_ERRNO__END,
};

enum target_errno target__validate(struct target *target);
enum target_errno target__parse_uid(struct target *target);

int target__strerror(struct target *target, int errnum, char *buf, size_t buflen);

static inline bool target__has_task(struct target *target)
{
	return target->tid || target->pid || target->uid_str;
}

static inline bool target__has_cpu(struct target *target)
{
	return target->system_wide || target->cpu_list;
}

static inline bool target__none(struct target *target)
{
	return !target__has_task(target) && !target__has_cpu(target);
}

static inline bool target__has_per_thread(struct target *target)
{
	return target->system_wide && target->per_thread;
}

static inline bool target__uses_dummy_map(struct target *target)
{
	bool use_dummy = false;

	if (target->default_per_cpu)
		use_dummy = target->per_thread ? true : false;
	else if (target__has_task(target) ||
	         (!target__has_cpu(target) && !target->uses_mmap))
		use_dummy = true;
	else if (target__has_per_thread(target))
		use_dummy = true;

	return use_dummy;
}

#endif /* _PERF_TARGET_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
12864b31 NK	2	#ifndef _PERF_TARGET_H
	3	#define _PERF_TARGET_H
	4
	5	#include <stdbool.h>
	6	#include <sys/types.h>
	7
602ad878	8	struct target {
12864b31 NK	9	const char *pid;
	10	const char *tid;
	11	const char *cpu_list;
	12	const char *uid_str;
	13	uid_t uid;
	14	bool system_wide;
d1cb9fce	15	bool uses_mmap;
3aa5939d AH	16	bool default_per_cpu;
3aa5939d AH	17	bool per_thread;
12864b31 NK	18	};
12864b31 NK	19
602ad878 ACM	20	enum target_errno {
602ad878 ACM	21	TARGET_ERRNO__SUCCESS = 0,
60bbddaa NK	22
	23	/*
	24	* Choose an arbitrary negative big number not to clash with standard
	25	* errno since SUS requires the errno has distinct positive values.
	26	* See 'Issue 6' in the link below.
	27	*
	28	* http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
	29	*/
602ad878	30	__TARGET_ERRNO__START = -10000,
60bbddaa	31
602ad878 ACM	32	/* for target__validate() */
	33	TARGET_ERRNO__PID_OVERRIDE_CPU = __TARGET_ERRNO__START,
	34	TARGET_ERRNO__PID_OVERRIDE_UID,
	35	TARGET_ERRNO__UID_OVERRIDE_CPU,
	36	TARGET_ERRNO__PID_OVERRIDE_SYSTEM,
	37	TARGET_ERRNO__UID_OVERRIDE_SYSTEM,
3aa5939d	38	TARGET_ERRNO__SYSTEM_OVERRIDE_THREAD,
60bbddaa	39
602ad878 ACM	40	/* for target__parse_uid() */
	41	TARGET_ERRNO__INVALID_UID,
	42	TARGET_ERRNO__USER_NOT_FOUND,
60bbddaa	43
602ad878	44	__TARGET_ERRNO__END,
60bbddaa NK	45	};
60bbddaa NK	46
602ad878 ACM	47	enum target_errno target__validate(struct target *target);
602ad878 ACM	48	enum target_errno target__parse_uid(struct target *target);
12864b31	49
602ad878	50	int target__strerror(struct target target, int errnum, char buf, size_t buflen);
16ad2ffb	51
602ad878	52	static inline bool target__has_task(struct target *target)
d67356e7	53	{
aa22dd49	54	return target->tid \|\| target->pid \|\| target->uid_str;
d67356e7 NK	55	}
d67356e7 NK	56
602ad878	57	static inline bool target__has_cpu(struct target *target)
d67356e7	58	{
aa22dd49	59	return target->system_wide \|\| target->cpu_list;
d67356e7 NK	60	}
d67356e7 NK	61
602ad878	62	static inline bool target__none(struct target *target)
d67356e7	63	{
602ad878	64	return !target__has_task(target) && !target__has_cpu(target);
d67356e7 NK	65	}
d67356e7 NK	66
1d9f8d1b JY	67	static inline bool target__has_per_thread(struct target *target)
	68	{
	69	return target->system_wide && target->per_thread;
	70	}
	71
9c105fbc DY	72	static inline bool target__uses_dummy_map(struct target *target)
	73	{
	74	bool use_dummy = false;
	75
	76	if (target->default_per_cpu)
	77	use_dummy = target->per_thread ? true : false;
	78	else if (target__has_task(target) \|\|
	79	(!target__has_cpu(target) && !target->uses_mmap))
	80	use_dummy = true;
1d9f8d1b JY	81	else if (target__has_per_thread(target))
1d9f8d1b JY	82	use_dummy = true;
9c105fbc DY	83
	84	return use_dummy;
	85	}
	86
12864b31	87	#endif /* _PERF_TARGET_H */