perf bpf filter: Give terms their own enum
authorIan Rogers <irogers@google.com>
Fri, 24 May 2024 20:52:25 +0000 (13:52 -0700)
committerNamhyung Kim <namhyung@kernel.org>
Thu, 30 May 2024 17:05:57 +0000 (10:05 -0700)
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.

Signed-off-by: Ian Rogers <irogers@google.com>
Acked-by: Namhyung Kim <namhyung@kernel.org>
Cc: John Fastabend <john.fastabend@gmail.com>
Cc: Changbin Du <changbin.du@huawei.com>
Cc: Yang Jihong <yangjihong1@huawei.com>
Cc: Andrii Nakryiko <andrii@kernel.org>
Cc: bpf@vger.kernel.org
Signed-off-by: Namhyung Kim <namhyung@kernel.org>
Link: https://lore.kernel.org/r/20240524205227.244375-2-irogers@google.com
tools/perf/util/bpf-filter.c
tools/perf/util/bpf-filter.h
tools/perf/util/bpf-filter.l
tools/perf/util/bpf-filter.y
tools/perf/util/bpf_skel/sample-filter.h
tools/perf/util/bpf_skel/sample_filter.bpf.c

index b51544996046d47d9d12c224c63027852fb87b75..f10148623a8e4a67c2ee739e90b1aa14db7bf587 100644 (file)
 
 #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;
index 7afd159411b8b8e74ae56a5f1456c7102ccc98f6..cd6764442c165a7f6049f369fa45dbe513ec3df9 100644 (file)
@@ -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);
index d4ff0f1345cddc738bb6d87269c1ddeb9fa79523..62c959813466c185679353f8674d1acdb3d50c0b 100644 (file)
@@ -9,16 +9,16 @@
 #include "bpf-filter.h"
 #include "bpf-filter-bison.h"
 
-static int sample(unsigned long sample_flag)
+static int sample(enum perf_bpf_filter_term term)
 {
-       perf_bpf_filter_lval.sample.type = sample_flag;
+       perf_bpf_filter_lval.sample.term = term;
        perf_bpf_filter_lval.sample.part = 0;
        return BFT_SAMPLE;
 }
 
-static int sample_part(unsigned long sample_flag, int part)
+static int sample_part(enum perf_bpf_filter_term term, int part)
 {
-       perf_bpf_filter_lval.sample.type = sample_flag;
+       perf_bpf_filter_lval.sample.term = term;
        perf_bpf_filter_lval.sample.part = part;
        return BFT_SAMPLE;
 }
@@ -67,34 +67,34 @@ ident               [_a-zA-Z][_a-zA-Z0-9]+
 {num_hex}      { return value(16); }
 {space}                { }
 
-ip             { return sample(PERF_SAMPLE_IP); }
-id             { return sample(PERF_SAMPLE_ID); }
-tid            { return sample(PERF_SAMPLE_TID); }
-pid            { return sample_part(PERF_SAMPLE_TID, 1); }
-cpu            { return sample(PERF_SAMPLE_CPU); }
-time           { return sample(PERF_SAMPLE_TIME); }
-addr           { return sample(PERF_SAMPLE_ADDR); }
-period         { return sample(PERF_SAMPLE_PERIOD); }
-txn            { return sample(PERF_SAMPLE_TRANSACTION); }
-weight         { return sample(PERF_SAMPLE_WEIGHT); }
-weight1                { return sample_part(PERF_SAMPLE_WEIGHT_STRUCT, 1); }
-weight2                { return sample_part(PERF_SAMPLE_WEIGHT_STRUCT, 2); }
-weight3                { return sample_part(PERF_SAMPLE_WEIGHT_STRUCT, 3); }
-ins_lat                { return sample_part(PERF_SAMPLE_WEIGHT_STRUCT, 2); } /* alias for weight2 */
-p_stage_cyc    { return sample_part(PERF_SAMPLE_WEIGHT_STRUCT, 3); } /* alias for weight3 */
-retire_lat     { return sample_part(PERF_SAMPLE_WEIGHT_STRUCT, 3); } /* alias for weight3 */
-phys_addr      { return sample(PERF_SAMPLE_PHYS_ADDR); }
-code_pgsz      { return sample(PERF_SAMPLE_CODE_PAGE_SIZE); }
-data_pgsz      { return sample(PERF_SAMPLE_DATA_PAGE_SIZE); }
-mem_op         { return sample_part(PERF_SAMPLE_DATA_SRC, 1); }
-mem_lvlnum     { return sample_part(PERF_SAMPLE_DATA_SRC, 2); }
-mem_lvl                { return sample_part(PERF_SAMPLE_DATA_SRC, 2); } /* alias for mem_lvlnum */
-mem_snoop      { return sample_part(PERF_SAMPLE_DATA_SRC, 3); } /* include snoopx */
-mem_remote     { return sample_part(PERF_SAMPLE_DATA_SRC, 4); }
-mem_lock       { return sample_part(PERF_SAMPLE_DATA_SRC, 5); }
-mem_dtlb       { return sample_part(PERF_SAMPLE_DATA_SRC, 6); }
-mem_blk                { return sample_part(PERF_SAMPLE_DATA_SRC, 7); }
-mem_hops       { return sample_part(PERF_SAMPLE_DATA_SRC, 8); }
+ip             { return sample(PBF_TERM_IP); }
+id             { return sample(PBF_TERM_ID); }
+tid            { return sample(PBF_TERM_TID); }
+pid            { return sample_part(PBF_TERM_TID, 1); }
+cpu            { return sample(PBF_TERM_CPU); }
+time           { return sample(PBF_TERM_TIME); }
+addr           { return sample(PBF_TERM_ADDR); }
+period         { return sample(PBF_TERM_PERIOD); }
+txn            { return sample(PBF_TERM_TRANSACTION); }
+weight         { return sample(PBF_TERM_WEIGHT); }
+weight1                { return sample_part(PBF_TERM_WEIGHT_STRUCT, 1); }
+weight2                { return sample_part(PBF_TERM_WEIGHT_STRUCT, 2); }
+weight3                { return sample_part(PBF_TERM_WEIGHT_STRUCT, 3); }
+ins_lat                { return sample_part(PBF_TERM_WEIGHT_STRUCT, 2); } /* alias for weight2 */
+p_stage_cyc    { return sample_part(PBF_TERM_WEIGHT_STRUCT, 3); } /* alias for weight3 */
+retire_lat     { return sample_part(PBF_TERM_WEIGHT_STRUCT, 3); } /* alias for weight3 */
+phys_addr      { return sample(PBF_TERM_PHYS_ADDR); }
+code_pgsz      { return sample(PBF_TERM_CODE_PAGE_SIZE); }
+data_pgsz      { return sample(PBF_TERM_DATA_PAGE_SIZE); }
+mem_op         { return sample_part(PBF_TERM_DATA_SRC, 1); }
+mem_lvlnum     { return sample_part(PBF_TERM_DATA_SRC, 2); }
+mem_lvl                { return sample_part(PBF_TERM_DATA_SRC, 2); } /* alias for mem_lvlnum */
+mem_snoop      { return sample_part(PBF_TERM_DATA_SRC, 3); } /* include snoopx */
+mem_remote     { return sample_part(PBF_TERM_DATA_SRC, 4); }
+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); }
 
 "=="           { return operator(PBF_OP_EQ); }
 "!="           { return operator(PBF_OP_NEQ); }
index 0e4d6de3c2ad994db8978d8bab13946f0416fcc8..0c56fccb8874885ad368a1be2f2ce923e6f62b32 100644 (file)
@@ -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);
 }
 
 %%
index 2e96e1ab084ae9af421467cb14a88eafd4c9d90d..25f78002295111233ad594e0ca43e93862832be8 100644 (file)
@@ -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 */
\ No newline at end of file
+#endif /* PERF_UTIL_BPF_SKEL_SAMPLE_FILTER_H */
index fb94f5280626635007430f9952ad0dcbdd502cc8..5ac1778ff66eb2228e7fc81e8bda72b179ac5d14 100644 (file)
@@ -48,31 +48,54 @@ static inline __u64 perf_get_sample(struct bpf_perf_event_data_kern *kctx,
 {
        struct perf_sample_data___new *data = (void *)kctx->data;
 
-       if (!bpf_core_field_exists(data->sample_flags) ||
-           (data->sample_flags & entry->flags) == 0)
+       if (!bpf_core_field_exists(data->sample_flags))
                return 0;
 
-       switch (entry->flags) {
-       case PERF_SAMPLE_IP:
+#define BUILD_CHECK_SAMPLE(x)                                  \
+       _Static_assert((1 << (PBF_TERM_##x - PBF_TERM_SAMPLE_START)) == PERF_SAMPLE_##x, \
+               "Mismatched PBF term to sample bit " #x)
+       BUILD_CHECK_SAMPLE(IP);
+       BUILD_CHECK_SAMPLE(TID);
+       BUILD_CHECK_SAMPLE(TIME);
+       BUILD_CHECK_SAMPLE(ADDR);
+       BUILD_CHECK_SAMPLE(ID);
+       BUILD_CHECK_SAMPLE(CPU);
+       BUILD_CHECK_SAMPLE(PERIOD);
+       BUILD_CHECK_SAMPLE(WEIGHT);
+       BUILD_CHECK_SAMPLE(DATA_SRC);
+       BUILD_CHECK_SAMPLE(TRANSACTION);
+       BUILD_CHECK_SAMPLE(PHYS_ADDR);
+       BUILD_CHECK_SAMPLE(DATA_PAGE_SIZE);
+       BUILD_CHECK_SAMPLE(CODE_PAGE_SIZE);
+       BUILD_CHECK_SAMPLE(WEIGHT_STRUCT);
+#undef BUILD_CHECK_SAMPLE
+
+       /* For sample terms check the sample bit is set. */
+       if (entry->term >= PBF_TERM_SAMPLE_START && entry->term <= PBF_TERM_SAMPLE_END &&
+           (data->sample_flags & (1 << (entry->term - PBF_TERM_SAMPLE_START))) == 0)
+               return 0;
+
+       switch (entry->term) {
+       case PBF_TERM_IP:
                return kctx->data->ip;
-       case PERF_SAMPLE_ID:
+       case PBF_TERM_ID:
                return kctx->data->id;
-       case PERF_SAMPLE_TID:
+       case PBF_TERM_TID:
                if (entry->part)
                        return kctx->data->tid_entry.pid;
                else
                        return kctx->data->tid_entry.tid;
-       case PERF_SAMPLE_CPU:
+       case PBF_TERM_CPU:
                return kctx->data->cpu_entry.cpu;
-       case PERF_SAMPLE_TIME:
+       case PBF_TERM_TIME:
                return kctx->data->time;
-       case PERF_SAMPLE_ADDR:
+       case PBF_TERM_ADDR:
                return kctx->data->addr;
-       case PERF_SAMPLE_PERIOD:
+       case PBF_TERM_PERIOD:
                return kctx->data->period;
-       case PERF_SAMPLE_TRANSACTION:
+       case PBF_TERM_TRANSACTION:
                return kctx->data->txn;
-       case PERF_SAMPLE_WEIGHT_STRUCT:
+       case PBF_TERM_WEIGHT_STRUCT:
                if (entry->part == 1)
                        return kctx->data->weight.var1_dw;
                if (entry->part == 2)
@@ -80,15 +103,15 @@ static inline __u64 perf_get_sample(struct bpf_perf_event_data_kern *kctx,
                if (entry->part == 3)
                        return kctx->data->weight.var3_w;
                /* fall through */
-       case PERF_SAMPLE_WEIGHT:
+       case PBF_TERM_WEIGHT:
                return kctx->data->weight.full;
-       case PERF_SAMPLE_PHYS_ADDR:
+       case PBF_TERM_PHYS_ADDR:
                return kctx->data->phys_addr;
-       case PERF_SAMPLE_CODE_PAGE_SIZE:
+       case PBF_TERM_CODE_PAGE_SIZE:
                return kctx->data->code_page_size;
-       case PERF_SAMPLE_DATA_PAGE_SIZE:
+       case PBF_TERM_DATA_PAGE_SIZE:
                return kctx->data->data_page_size;
-       case PERF_SAMPLE_DATA_SRC:
+       case PBF_TERM_DATA_SRC:
                if (entry->part == 1)
                        return kctx->data->data_src.mem_op;
                if (entry->part == 2)
@@ -117,6 +140,18 @@ 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_NONE:
+       case __PBF_UNUSED_TERM4:
+       case __PBF_UNUSED_TERM5:
+       case __PBF_UNUSED_TERM9:
+       case __PBF_UNUSED_TERM10:
+       case __PBF_UNUSED_TERM11:
+       case __PBF_UNUSED_TERM12:
+       case __PBF_UNUSED_TERM13:
+       case __PBF_UNUSED_TERM16:
+       case __PBF_UNUSED_TERM18:
+       case __PBF_UNUSED_TERM20:
+       case __PBF_UNUSED_TERM21:
        default:
                break;
        }