tools/perf/util/target.h

   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         bool         use_bpf;
  20         bool         inherit;
  21         int          initial_delay;
  22         const char   *attr_map;
  23 };
  24
  25 enum target_errno {
  26         TARGET_ERRNO__SUCCESS           = 0,
  27
  28         /*
  29          * Choose an arbitrary negative big number not to clash with standard
  30          * errno since SUS requires the errno has distinct positive values.
  31          * See 'Issue 6' in the link below.
  32          *
  33          * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
  34          */
  35         __TARGET_ERRNO__START           = -10000,
  36
  37         /* for target__validate() */
  38         TARGET_ERRNO__PID_OVERRIDE_CPU  = __TARGET_ERRNO__START,
  39         TARGET_ERRNO__PID_OVERRIDE_UID,
  40         TARGET_ERRNO__UID_OVERRIDE_CPU,
  41         TARGET_ERRNO__PID_OVERRIDE_SYSTEM,
  42         TARGET_ERRNO__UID_OVERRIDE_SYSTEM,
  43         TARGET_ERRNO__SYSTEM_OVERRIDE_THREAD,
  44         TARGET_ERRNO__BPF_OVERRIDE_CPU,
  45         TARGET_ERRNO__BPF_OVERRIDE_PID,
  46         TARGET_ERRNO__BPF_OVERRIDE_UID,
  47         TARGET_ERRNO__BPF_OVERRIDE_THREAD,
  48
  49         /* for target__parse_uid() */
  50         TARGET_ERRNO__INVALID_UID,
  51         TARGET_ERRNO__USER_NOT_FOUND,
  52
  53         __TARGET_ERRNO__END,
  54 };
  55
  56 enum target_errno target__validate(struct target *target);
  57 enum target_errno target__parse_uid(struct target *target);
  58
  59 int target__strerror(struct target *target, int errnum, char *buf, size_t buflen);
  60
  61 static inline bool target__has_task(struct target *target)
  62 {
  63         return target->tid || target->pid || target->uid_str;
  64 }
  65
  66 static inline bool target__has_cpu(struct target *target)
  67 {
  68         return target->system_wide || target->cpu_list;
  69 }
  70
  71 static inline bool target__none(struct target *target)
  72 {
  73         return !target__has_task(target) && !target__has_cpu(target);
  74 }
  75
  76 static inline bool target__enable_on_exec(struct target *target)
  77 {
  78         /*
  79          * Normally enable_on_exec should be set if:
  80          *  1) The tracee process is forked (not attaching to existed task or cpu).
  81          *  2) And initial_delay is not configured.
  82          * Otherwise, we enable tracee events manually.
  83          */
  84         return target__none(target) && !target->initial_delay;
  85 }
  86
  87 static inline bool target__has_per_thread(struct target *target)
  88 {
  89         return target->system_wide && target->per_thread;
  90 }
  91
  92 static inline bool target__uses_dummy_map(struct target *target)
  93 {
  94         bool use_dummy = false;
  95
  96         if (target->default_per_cpu)
  97                 use_dummy = target->per_thread ? true : false;
  98         else if (target__has_task(target) ||
  99                  (!target__has_cpu(target) && !target->uses_mmap))
 100                 use_dummy = true;
 101         else if (target__has_per_thread(target))
 102                 use_dummy = true;
 103
 104         return use_dummy;
 105 }
 106
 107 #endif /* _PERF_TARGET_H */