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