Use BPF filters for a "perf top -u" workaround
Subsystems (2)
Ian Rogers
reviewerv3 cover Use BPF filters for a "perf top -u" workaround
Allow uid and gid to be terms in BPF filters by first breaking the connection between filter terms and PERF_SAMPLE_xx values. Calculate the uid and gid using the bpf_get_current_uid_gid helper, rather than from a value in the sample. Allow filters to be passed to perf top, this allows:
$ perf top -e cycles:P --filter "uid == $(id -u)"
to work as a "perf top -u" workaround, as "perf top -u" usually fails due to processes/threads terminating between the /proc scan and the perf_event_open.
v3. Move PERF_SAMPLE_xx asserts to sample_filter.bpf.c to avoid
conflicting definitions between vmlinux.h and perf_event.h as reported by Namhyung.
v2. Allow PERF_SAMPLE_xx to be computed from the PBF_TERM_xx value
using a shift as requested by Namhyung.
Ian Rogers (3):
perf bpf filter: Give terms their own enum
perf bpf filter: Add uid and gid terms
perf top: Allow filters on events
tools/perf/Documentation/perf-record.txt | 2 +- tools/perf/Documentation/perf-top.txt | 4 ++ tools/perf/builtin-top.c | 9 +++ tools/perf/util/bpf-filter.c | 33 +++++---- tools/perf/util/bpf-filter.h | 5 +- tools/perf/util/bpf-filter.l | 66 +++++++++--------- tools/perf/util/bpf-filter.y | 7 +- tools/perf/util/bpf_skel/sample-filter.h | 40 ++++++++++- tools/perf/util/bpf_skel/sample_filter.bpf.c | 73 +++++++++++++++----- 9 files changed, 169 insertions(+), 70 deletions(-)
Signature · 1 line
2.45.1.288.g0e0cd299f1-goog
Ian Rogers
reviewerPATCH v3 1/3 perf bpf filter: Give terms their own enum
Give the term types their own enum so that additional terms can be added that don't correspond to a PERF_SAMPLE_xx flag. The term values are numerically ascending rather than bit field positions, this means they need translating to a PERF_SAMPLE_xx bit field in certain places using a shift.
--- tools/perf/util/bpf-filter.c | 28 ++++---- tools/perf/util/bpf-filter.h | 5 +- tools/perf/util/bpf-filter.l | 64 +++++++++--------- tools/perf/util/bpf-filter.y | 7 +- tools/perf/util/bpf_skel/sample-filter.h | 37 ++++++++++- tools/perf/util/bpf_skel/sample_filter.bpf.c | 69 +++++++++++++++----- 6 files changed, 141 insertions(+), 69 deletions(-)
tools/perf/util/bpf-filter.c +15 -13
@@ -17,11 +17,11 @@#define FD (e, x, y) (*(int *)xyarray__entry(e->core.fd, x, y)) -#define __PERF_SAMPLE_TYPE (st, opt) { st, #st, opt } -#define PERF_SAMPLE_TYPE (_st, opt) __PERF_SAMPLE_TYPE(PERF_SAMPLE_##_st, opt) +#define __PERF_SAMPLE_TYPE (tt, st, opt) { tt, #st, opt } +#define PERF_SAMPLE_TYPE (_st, opt) __PERF_SAMPLE_TYPE(PBF_TERM_##_st, PERF_SAMPLE_##_st, opt)static const struct perf_sample_info { -u64 type; +enum perf_bpf_filter_term type;const char *name;const char *option; } sample_table[] = {
@@ -44,12 +44,12 @@ static const struct perf_sample_info { PERF_SAMPLE_TYPE(DATA_PAGE_SIZE, "--data-page-size"), }; -static const struct perf_sample_info *get_sample_info (u64 flags) +static const struct perf_sample_info *get_sample_info (enum perf_bpf_filter_term type) {size_t i;for (i =0 ; i <ARRAY_SIZE (sample_table); i++) { -if (sample_table[i].type == flags) +if (sample_table[i].type == type)return &sample_table[i]; }return NULL ;
@@ -59,7 +59,8 @@ static int check_sample_flags(struct evsel *evsel, struct perf_bpf_filter_expr * {const struct perf_sample_info *info; -if (evsel->core.attr.sample_type & expr->sample_flags) +if (expr->term >=PBF_TERM_SAMPLE_START && expr->term <=PBF_TERM_SAMPLE_END && + (evsel->core.attr.sample_type & (1 << (expr->term -PBF_TERM_SAMPLE_START ))))return 0 ;if (expr->op ==PBF_OP_GROUP_BEGIN ) {
@@ -72,10 +73,10 @@ static int check_sample_flags(struct evsel *evsel, struct perf_bpf_filter_expr *return 0 ; } - info =get_sample_info (expr->sample_flags); + info =get_sample_info (expr->term);if (info ==NULL ) { -pr_err ("Error: %s event does not have sample flags %lx\n" , -evsel__name (evsel), expr->sample_flags); +pr_err ("Error: %s event does not have sample flags %d\n" , +evsel__name (evsel), expr->term);return -1 ; }
@@ -105,7 +106,7 @@ int perf_bpf_filter__prepare(struct evsel *evsel)struct perf_bpf_filter_entry entry = { .op = expr->op, .part = expr->part, - .flags = expr->sample_flags, + .term = expr->term, .value = expr->val, };
@@ -122,7 +123,7 @@ int perf_bpf_filter__prepare(struct evsel *evsel)struct perf_bpf_filter_entry group_entry = { .op = group->op, .part = group->part, - .flags = group->sample_flags, + .term = group->term, .value = group->val, };bpf_map_update_elem (fd, &i, &group_entry,BPF_ANY );
@@ -173,7 +174,8 @@ u64 perf_bpf_filter__lost_count(struct evsel *evsel)return skel ? skel->bss->dropped :0 ; } -struct perf_bpf_filter_expr *perf_bpf_filter_expr__new (unsigned long sample_flags,int part, +struct perf_bpf_filter_expr *perf_bpf_filter_expr__new (enum perf_bpf_filter_term term, +int part,enum perf_bpf_filter_op op,unsigned long val) {
@@ -181,7 +183,7 @@ struct perf_bpf_filter_expr *perf_bpf_filter_expr__new(unsigned long sample_flag expr =malloc (sizeof (*expr));if (expr !=NULL ) { - expr->sample_flags = sample_flags; + expr->term = term; expr->part = part; expr->op = op; expr->val = val;
tools/perf/util/bpf-filter.h +3 -2
@@ -11,14 +11,15 @@ struct perf_bpf_filter_expr {struct list_head groups;enum perf_bpf_filter_op op;int part; -unsigned long sample_flags; +enum perf_bpf_filter_term term;unsigned long val; };struct evsel ;#ifdef HAVE_BPF_SKEL -struct perf_bpf_filter_expr *perf_bpf_filter_expr__new (unsigned long sample_flags,int part, +struct perf_bpf_filter_expr *perf_bpf_filter_expr__new (enum perf_bpf_filter_term term, +int part,enum perf_bpf_filter_op op,unsigned long val);int perf_bpf_filter__parse (struct list_head *expr_head,const char *str);
tools/perf/util/bpf-filter.l +32 -32
82 lines not on this page · raw message
tools/perf/util/bpf-filter.y +4 -3
@@ -27,7 +27,7 @@ static void perf_bpf_filter_error(struct list_head *expr __maybe_unused, { unsigned long num; struct { - unsigned long type; + enum perf_bpf_filter_term term; int part; } sample; enum perf_bpf_filter_op op;
@@ -62,7 +62,8 @@ filter_term BFT_LOGICAL_OR filter_expr if ($1->op == PBF_OP_GROUP_BEGIN) { expr = $1; } else { - expr = perf_bpf_filter_expr__new(0, 0, PBF_OP_GROUP_BEGIN, 1); + expr = perf_bpf_filter_expr__new(PBF_TERM_NONE, /*part=*/0, + PBF_OP_GROUP_BEGIN, /*val=*/1); list_add_tail(&$1->list, &expr->groups); } expr->val++;
@@ -78,7 +79,7 @@ filter_expr filter_expr: BFT_SAMPLE BFT_OP BFT_NUM { - $$ = perf_bpf_filter_expr__new($1.type, $1.part, $2, $3); + $$ = perf_bpf_filter_expr__new($1.term, $1.part, $2, $3); } %%
tools/perf/util/bpf_skel/sample-filter.h +35 -2
@@ -16,12 +16,45 @@ enum perf_bpf_filter_op { PBF_OP_GROUP_END, }; +enum perf_bpf_filter_term { +/* No term is in use. */ +PBF_TERM_NONE =0 , +/* Terms that correspond to PERF_SAMPLE_xx values. */ +PBF_TERM_SAMPLE_START =PBF_TERM_NONE +1 , +PBF_TERM_IP =PBF_TERM_SAMPLE_START +0 ,/* SAMPLE_IP = 1U << 0 */ +PBF_TERM_TID =PBF_TERM_SAMPLE_START +1 ,/* SAMPLE_TID = 1U << 1 */ +PBF_TERM_TIME =PBF_TERM_SAMPLE_START +2 ,/* SAMPLE_TIME = 1U << 2 */ +PBF_TERM_ADDR =PBF_TERM_SAMPLE_START +3 ,/* SAMPLE_ADDR = 1U << 3 */ + __PBF_UNUSED_TERM4 =PBF_TERM_SAMPLE_START +4 ,/* SAMPLE_READ = 1U << 4 */ + __PBF_UNUSED_TERM5 =PBF_TERM_SAMPLE_START +5 ,/* SAMPLE_CALLCHAIN = 1U << 5 */ +PBF_TERM_ID =PBF_TERM_SAMPLE_START +6 ,/* SAMPLE_ID = 1U << 6 */ +PBF_TERM_CPU =PBF_TERM_SAMPLE_START +7 ,/* SAMPLE_CPU = 1U << 7 */ +PBF_TERM_PERIOD =PBF_TERM_SAMPLE_START +8 ,/* SAMPLE_PERIOD = 1U << 8 */ + __PBF_UNUSED_TERM9 =PBF_TERM_SAMPLE_START +9 ,/* SAMPLE_STREAM_ID = 1U << 9 */ + __PBF_UNUSED_TERM10 =PBF_TERM_SAMPLE_START +10 ,/* SAMPLE_RAW = 1U << 10 */ + __PBF_UNUSED_TERM11 =PBF_TERM_SAMPLE_START +11 ,/* SAMPLE_BRANCH_STACK = 1U << 11 */ + __PBF_UNUSED_TERM12 =PBF_TERM_SAMPLE_START +12 ,/* SAMPLE_REGS_USER = 1U << 12 */ + __PBF_UNUSED_TERM13 =PBF_TERM_SAMPLE_START +13 ,/* SAMPLE_STACK_USER = 1U << 13 */ +PBF_TERM_WEIGHT =PBF_TERM_SAMPLE_START +14 ,/* SAMPLE_WEIGHT = 1U << 14 */ +PBF_TERM_DATA_SRC =PBF_TERM_SAMPLE_START +15 ,/* SAMPLE_DATA_SRC = 1U << 15 */ + __PBF_UNUSED_TERM16 =PBF_TERM_SAMPLE_START +16 ,/* SAMPLE_IDENTIFIER = 1U << 16 */ +PBF_TERM_TRANSACTION =PBF_TERM_SAMPLE_START +17 ,/* SAMPLE_TRANSACTION = 1U << 17 */ + __PBF_UNUSED_TERM18 =PBF_TERM_SAMPLE_START +18 ,/* SAMPLE_REGS_INTR = 1U << 18 */ +PBF_TERM_PHYS_ADDR =PBF_TERM_SAMPLE_START +19 ,/* SAMPLE_PHYS_ADDR = 1U << 19 */ + __PBF_UNUSED_TERM20 =PBF_TERM_SAMPLE_START +20 ,/* SAMPLE_AUX = 1U << 20 */ + __PBF_UNUSED_TERM21 =PBF_TERM_SAMPLE_START +21 ,/* SAMPLE_CGROUP = 1U << 21 */ +PBF_TERM_DATA_PAGE_SIZE =PBF_TERM_SAMPLE_START +22 ,/* SAMPLE_DATA_PAGE_SIZE = 1U << 22 */ +PBF_TERM_CODE_PAGE_SIZE =PBF_TERM_SAMPLE_START +23 ,/* SAMPLE_CODE_PAGE_SIZE = 1U << 23 */ +PBF_TERM_WEIGHT_STRUCT =PBF_TERM_SAMPLE_START +24 ,/* SAMPLE_WEIGHT_STRUCT = 1U << 24 */ +PBF_TERM_SAMPLE_END =PBF_TERM_WEIGHT_STRUCT , +}; +/* BPF map entry for filtering */ struct perf_bpf_filter_entry {enum perf_bpf_filter_op op;__u32 part;/* sub-sample type info when it has multiple values */ -__u64 flags;/* perf sample type flags */ +enum perf_bpf_filter_term term;__u64 value; }; -#endif /* PERF_UTIL_BPF_SKEL_SAMPLE_FILTER_H */ +#endif /* PERF_UTIL_BPF_SKEL_SAMPLE_FILTER_H */
tools/perf/util/bpf_skel/sample_filter.bpf.c +52 -17
104 lines not on this page · raw message
Signature · 1 line
2.45.1.288.g0e0cd299f1-goog
Ian Rogers
reviewerPATCH v3 2/3 perf bpf filter: Add uid and gid terms
In reply to Ian RogersAllow the BPF filter to use the uid and gid terms determined by the bpf_get_current_uid_gid BPF helper. For example, the following will record the cpu-clock event system wide discarding samples that don't belong to the current user.
$ perf record -e cpu-clock --filter "uid == $(id -u)" -a sleep 0.1
--- tools/perf/Documentation/perf-record.txt | 2 +- tools/perf/util/bpf-filter.c | 5 +++++ tools/perf/util/bpf-filter.l | 2 ++ tools/perf/util/bpf_skel/sample-filter.h | 3 +++ tools/perf/util/bpf_skel/sample_filter.bpf.c | 4 ++++ 5 files changed, 15 insertions(+), 1 deletion(-)
tools/perf/Documentation/perf-record.txt +1 -1
@@ -200,7 +200,7 @@ OPTIONS ip, id, tid, pid, cpu, time, addr, period, txn, weight, phys_addr, code_pgsz, data_pgsz, weight1, weight2, weight3, ins_lat, retire_lat, p_stage_cyc, mem_op, mem_lvl, mem_snoop, mem_remote, mem_lock, - mem_dtlb, mem_blk, mem_hops + mem_dtlb, mem_blk, mem_hops, uid, gid The <operator> can be one of: ==, !=, >, >=, <, <=, &
tools/perf/util/bpf-filter.c +5 -0
@@ -63,6 +63,11 @@ static int check_sample_flags(struct evsel *evsel, struct perf_bpf_filter_expr * (evsel->core.attr.sample_type & (1 << (expr->term - PBF_TERM_SAMPLE_START))))return 0 ; +if (expr->term ==PBF_TERM_UID || expr->term ==PBF_TERM_GID ) { +/* Not dependent on the sample_type as computed from a BPF helper. */ +return 0 ; + } +if (expr->op ==PBF_OP_GROUP_BEGIN ) {struct perf_bpf_filter_expr *group;
tools/perf/util/bpf-filter.l +2 -0
@@ -95,6 +95,8 @@ mem_lock { return sample_part(PBF_TERM_DATA_SRC, 5); } mem_dtlb { return sample_part(PBF_TERM_DATA_SRC, 6); } mem_blk { return sample_part(PBF_TERM_DATA_SRC, 7); } mem_hops { return sample_part(PBF_TERM_DATA_SRC, 8); } +uid { return sample(PBF_TERM_UID); } +gid { return sample(PBF_TERM_GID); } "==" { return operator(PBF_OP_EQ); } "!=" { return operator(PBF_OP_NEQ); }
tools/perf/util/bpf_skel/sample-filter.h +3 -0
@@ -47,6 +47,9 @@ enum perf_bpf_filter_term {PBF_TERM_CODE_PAGE_SIZE =PBF_TERM_SAMPLE_START +23 ,/* SAMPLE_CODE_PAGE_SIZE = 1U << 23 */ PBF_TERM_WEIGHT_STRUCT =PBF_TERM_SAMPLE_START +24 ,/* SAMPLE_WEIGHT_STRUCT = 1U << 24 */ PBF_TERM_SAMPLE_END =PBF_TERM_WEIGHT_STRUCT , +/* Terms computed from BPF helpers. */ +PBF_TERM_UID , + PBF_TERM_GID, };/* BPF map entry for filtering */
tools/perf/util/bpf_skel/sample_filter.bpf.c +4 -0
@@ -140,6 +140,10 @@ static inline __u64 perf_get_sample(struct bpf_perf_event_data_kern *kctx, }/* return the whole word */ return kctx->data->data_src.val; +case PBF_TERM_UID : +return bpf_get_current_uid_gid () &0xFFFFFFFF ; +case PBF_TERM_GID : +return bpf_get_current_uid_gid () >>32 ;case PBF_TERM_NONE :case __PBF_UNUSED_TERM4:case __PBF_UNUSED_TERM5:
Signature · 1 line
2.45.1.288.g0e0cd299f1-goog
Ian Rogers
reviewerPATCH v3 3/3 perf top: Allow filters on events
In reply to Ian RogersAllow filters to be added to perf top events. One use is to workaround issues with:
``` $ perf top --uid="$(id -u)" ``` which tries to scan /proc find processes belonging to the uid and can fail in such a pid terminates between the scan and the perf_event_open reporting: ``` Error: The sys_perf_event_open() syscall returned with 3 (No such process) for event (cycles:P). /bin/dmesg | grep -i perf may provide additional information. ``` A similar filter: ``` $ perf top -e cycles:P --filter "uid == $(id -u)" ```
doesn't fail this way.
--- tools/perf/Documentation/perf-top.txt | 4 ++++ tools/perf/builtin-top.c | 9 +++++++++ 2 files changed, 13 insertions(+)
tools/perf/Documentation/perf-top.txt +4 -0
@@ -43,6 +43,10 @@ Default is to monitor all CPUS. encoding with the layout of the event control registers as described by entries in /sys/bus/event_source/devices/cpu/format/*. +--filter=<filter>:: + Event filter. This option should follow an event selector (-e). For + syntax see linkperf:perf-record[1]. + -E <entries>:: --entries=<entries>:: Display this many functions.
tools/perf/builtin-top.c +9 -0
@@ -1055,6 +1055,13 @@ static int perf_top__start_counters(struct perf_top *top) } } +if (evlist__apply_filters (evlist, &counter)) { +pr_err ("failed to set filter \"%s\" on event %s with %d (%s)\n" , + counter->filter ?:"BPF" ,evsel__name (counter), errno, +str_error_r (errno, msg,sizeof (msg))); + goto out_err; + } +if (evlist__mmap (evlist, opts->mmap_pages) <0 ) {ui__error ("Failed to mmap with %d (%s)\n" , errno,str_error_r (errno, msg,sizeof (msg)));
@@ -1462,6 +1469,8 @@ int cmd_top(int argc, const char **argv)OPT_CALLBACK ('e' ,"event" , &parse_events_option_args,"event" ,"event selector. use 'perf list' to list available events" , parse_events_option), +OPT_CALLBACK (0 ,"filter" , &top.evlist,"filter" , +"event filter" , parse_filter),OPT_U64 ('c' ,"count" , &opts->user_interval,"event period to sample" ),OPT_STRING ('p' ,"pid" , &target->pid,"pid" , "profile events on existing process id"),
Signature · 1 line
2.45.1.288.g0e0cd299f1-goog
Quoted 18 lines · Ian Rogers
Allow uid and gid to be terms in BPF filters by first breaking the connection between filter terms and
PERF_SAMPLE_xxvalues. Calculate the uid and gid using thebpf_get_current_uid_gidhelper, rather than from a value in the sample. Allow filters to be passed to perf top, this allows:$ perf top -e cycles:P --filter "uid == $(id -u)"to work as a "perf top -u" workaround, as "perf top -u" usually fails due to processes/threads terminating between the /proc scan and the
perf_event_open.v3. Move
PERF_SAMPLE_xxasserts tosample_filter.bpf.cto avoid
conflicting definitions betweenvmlinux.handperf_event.has reported by Namhyung.
v2. AllowPERF_SAMPLE_xxto be computed from thePBF_TERM_xxvalue
using a shift as requested by Namhyung.
Quoted 4 lines
Ian Rogers (3):
perf bpf filter: Give terms their own enum
perf bpf filter: Add uid and gid terms
perf top: Allow filters on events
Thanks,
Namhyung
Quoted 15 lines
tools/perf/Documentation/perf-record.txt | 2 +- tools/perf/Documentation/perf-top.txt | 4 ++ tools/perf/builtin-top.c | 9 +++ tools/perf/util/bpf-filter.c | 33 +++++---- tools/perf/util/bpf-filter.h | 5 +- tools/perf/util/bpf-filter.l | 66 +++++++++--------- tools/perf/util/bpf-filter.y | 7 +- tools/perf/util/bpf_skel/sample-filter.h | 40 ++++++++++- tools/perf/util/bpf_skel/sample_filter.bpf.c | 73 +++++++++++++++----- 9 files changed, 169 insertions(+), 70 deletions(-)--
2.45.1.288.g0e0cd299f1-goog
Quoted 8 lines · Ian Rogers
Allow uid and gid to be terms in BPF filters by first breaking the connection between filter terms and
PERF_SAMPLE_xxvalues. Calculate the uid and gid using thebpf_get_current_uid_gidhelper, rather than from a value in the sample. Allow filters to be passed to perf top, this allows:$ perf top -e cycles:P --filter "uid == $(id -u)"[...]
Applied to perf-tools-next, thanks!
[1/3] perf bpf filter: Give terms their own enum
commit: 63b9cbd7941aa9ec5cb61567042176c4ce04b020
[2/3] perf bpf filter: Add uid and gid terms
commit: d92aa899fe0a66350303a1986d6dc7ec4b3a1ea7
[3/3] perf top: Allow filters on events
commit: af752016340021d433a962063067e819dba889b1Best regards,
Signature · 1 line
Namhyung Kim <[email protected]>