leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

bpftool: Use libbpf_bpf_attach_type_str

Browse Source 
This change switches bpftool over to using the recently introduced
libbpf_bpf_attach_type_str function instead of maintaining its own
string representation for the bpf_attach_type enum.

Note that contrary to other enum types, the variant names that bpftool
maps bpf_attach_type to do not adhere a simple to follow rule. With
bpf_prog_type, for example, the textual representation can easily be
inferred by stripping the BPF_PROG_TYPE_ prefix and lowercasing the
remaining string. bpf_attach_type violates this rule for various
variants.
We decided to fix up this deficiency with this change, meaning that
bpftool uses the same textual representations as libbpf. Supporting
tests, completion scripts, and man pages have been adjusted accordingly.
However, we did add support for accepting (the now undocumented)
original attach type names when they are provided by users.

For the test (test_bpftool_synctypes.py), I have removed the enum
representation checks, because we no longer mirror the various enum
variant names in bpftool source code. For the man page, help text, and
completion script checks we are now using enum definitions from
uapi/linux/bpf.h as the source of truth directly.

Signed-off-by: Daniel Müller <deso@posteo.net>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Acked-by: Quentin Monnet <quentin@isovalent.com>
Link: https://lore.kernel.org/bpf/20220523230428.3077108-10-deso@posteo.net
This commit is contained in:
Daniel Müller 2022-05-23 23:04:25 +00:00 committed by Andrii Nakryiko
parent 0b27b3d9fd
commit 1ba5ad36e0
9 changed files with 182 additions and 150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
tools/bpf/bpftool/Documentation/bpftool-cgroup.rst
View File

@ -31,11 +31,17 @@ CGROUP COMMANDS
| **bpftool** **cgroup help** | **bpftool** **cgroup help**
| |
| *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* } | *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* }
| *ATTACH_TYPE* := { **ingress** | **egress** | **sock_create** | **sock_ops** | **device** | | *ATTACH_TYPE* := { **cgroup_inet_ingress** | **cgroup_inet_egress** |
| **bind4** | **bind6** | **post_bind4** | **post_bind6** | **connect4** | **connect6** | | **cgroup_inet_sock_create** | **cgroup_sock_ops** |
| **getpeername4** | **getpeername6** | **getsockname4** | **getsockname6** | **sendmsg4** | | **cgroup_device** | **cgroup_inet4_bind** | **cgroup_inet6_bind** |
| **sendmsg6** | **recvmsg4** | **recvmsg6** | **sysctl** | **getsockopt** | **setsockopt** | | **cgroup_inet4_post_bind** | **cgroup_inet6_post_bind** |
| **sock_release** } | **cgroup_inet4_connect** | **cgroup_inet6_connect** |
| **cgroup_inet4_getpeername** | **cgroup_inet6_getpeername** |
| **cgroup_inet4_getsockname** | **cgroup_inet6_getsockname** |
| **cgroup_udp4_sendmsg** | **cgroup_udp6_sendmsg** |
| **cgroup_udp4_recvmsg** | **cgroup_udp6_recvmsg** |
| **cgroup_sysctl** | **cgroup_getsockopt** | **cgroup_setsockopt** |
| **cgroup_inet_sock_release** }
| *ATTACH_FLAGS* := { **multi** | **override** } | *ATTACH_FLAGS* := { **multi** | **override** }
DESCRIPTION DESCRIPTION

3
tools/bpf/bpftool/Documentation/bpftool-prog.rst
View File

@ -54,7 +54,8 @@ PROG COMMANDS
| **struct_ops** | **fentry** | **fexit** | **freplace** | **sk_lookup** | **struct_ops** | **fentry** | **fexit** | **freplace** | **sk_lookup**
| } | }
| *ATTACH_TYPE* := { | *ATTACH_TYPE* := {
| **msg_verdict** | **skb_verdict** | **stream_verdict** | **stream_parser** | **flow_dissector** | **sk_msg_verdict** | **sk_skb_verdict** | **sk_skb_stream_verdict** |
| **sk_skb_stream_parser** | **flow_dissector**
| } | }
| *METRICs* := { | *METRICs* := {
| **cycles** | **instructions** | **l1d_loads** | **llc_misses** | | **cycles** | **instructions** | **l1d_loads** | **llc_misses** |

18
tools/bpf/bpftool/bash-completion/bpftool
View File

@ -407,8 +407,8 @@ _bpftool()
return 0 return 0
;; ;;
5) 5)
local BPFTOOL_PROG_ATTACH_TYPES='msg_verdict \ local BPFTOOL_PROG_ATTACH_TYPES='sk_msg_verdict \
skb_verdict stream_verdict stream_parser \ sk_skb_verdict sk_skb_stream_verdict sk_skb_stream_parser \
flow_dissector' flow_dissector'
COMPREPLY=( $( compgen -W "$BPFTOOL_PROG_ATTACH_TYPES" -- "$cur" ) ) COMPREPLY=( $( compgen -W "$BPFTOOL_PROG_ATTACH_TYPES" -- "$cur" ) )
return 0 return 0
@ -1039,12 +1039,14 @@ _bpftool()
return 0 return 0
;; ;;
attach|detach) attach|detach)
local BPFTOOL_CGROUP_ATTACH_TYPES='ingress egress \ local BPFTOOL_CGROUP_ATTACH_TYPES='cgroup_inet_ingress cgroup_inet_egress \
sock_create sock_ops device \ cgroup_inet_sock_create cgroup_sock_ops cgroup_device cgroup_inet4_bind \
bind4 bind6 post_bind4 post_bind6 connect4 connect6 \ cgroup_inet6_bind cgroup_inet4_post_bind cgroup_inet6_post_bind \
getpeername4 getpeername6 getsockname4 getsockname6 \ cgroup_inet4_connect cgroup_inet6_connect cgroup_inet4_getpeername \
sendmsg4 sendmsg6 recvmsg4 recvmsg6 sysctl getsockopt \ cgroup_inet6_getpeername cgroup_inet4_getsockname cgroup_inet6_getsockname \
setsockopt sock_release' cgroup_udp4_sendmsg cgroup_udp6_sendmsg cgroup_udp4_recvmsg \
cgroup_udp6_recvmsg cgroup_sysctl cgroup_getsockopt cgroup_setsockopt \
cgroup_inet_sock_release'
local ATTACH_FLAGS='multi override' local ATTACH_FLAGS='multi override'
local PROG_TYPE='id pinned tag name' local PROG_TYPE='id pinned tag name'
# Check for $prev = $command first # Check for $prev = $command first

51
tools/bpf/bpftool/cgroup.c
View File

@ -22,24 +22,42 @@
"ATTACH_FLAGS := { multi | override }" "ATTACH_FLAGS := { multi | override }"
#define HELP_SPEC_ATTACH_TYPES \ #define HELP_SPEC_ATTACH_TYPES \
" ATTACH_TYPE := { ingress | egress | sock_create |\n" \ " ATTACH_TYPE := { cgroup_inet_ingress | cgroup_inet_egress |\n" \
" sock_ops | device | bind4 | bind6 |\n" \ " cgroup_inet_sock_create | cgroup_sock_ops |\n" \
" post_bind4 | post_bind6 | connect4 |\n" \ " cgroup_device | cgroup_inet4_bind |\n" \
" connect6 | getpeername4 | getpeername6 |\n" \ " cgroup_inet6_bind | cgroup_inet4_post_bind |\n" \
" getsockname4 | getsockname6 | sendmsg4 |\n" \ " cgroup_inet6_post_bind | cgroup_inet4_connect |\n" \
" sendmsg6 | recvmsg4 | recvmsg6 |\n" \ " cgroup_inet6_connect | cgroup_inet4_getpeername |\n" \
" sysctl | getsockopt | setsockopt |\n" \ " cgroup_inet6_getpeername | cgroup_inet4_getsockname |\n" \
" sock_release }" " cgroup_inet6_getsockname | cgroup_udp4_sendmsg |\n" \
" cgroup_udp6_sendmsg | cgroup_udp4_recvmsg |\n" \
" cgroup_udp6_recvmsg | cgroup_sysctl |\n" \
" cgroup_getsockopt | cgroup_setsockopt |\n" \
" cgroup_inet_sock_release }"
static unsigned int query_flags; static unsigned int query_flags;
static enum bpf_attach_type parse_attach_type(const char *str) static enum bpf_attach_type parse_attach_type(const char *str)
{ {
const char *attach_type_str;
enum bpf_attach_type type; enum bpf_attach_type type;
for (type = 0; type < __MAX_BPF_ATTACH_TYPE; type++) { for (type = 0; ; type++) {
if (attach_type_name[type] && attach_type_str = libbpf_bpf_attach_type_str(type);
is_prefix(str, attach_type_name[type])) if (!attach_type_str)
break;
if (!strcmp(str, attach_type_str))
return type;
}
/* Also check traditionally used attach type strings. For these we keep
* allowing prefixed usage.
*/
for (type = 0; ; type++) {
attach_type_str = bpf_attach_type_input_str(type);
if (!attach_type_str)
break;
if (is_prefix(str, attach_type_str))
return type; return type;
} }
@ -52,6 +70,7 @@ static int show_bpf_prog(int id, enum bpf_attach_type attach_type,
{ {
char prog_name[MAX_PROG_FULL_NAME]; char prog_name[MAX_PROG_FULL_NAME];
struct bpf_prog_info info = {}; struct bpf_prog_info info = {};
const char *attach_type_str;
__u32 info_len = sizeof(info); __u32 info_len = sizeof(info);
int prog_fd; int prog_fd;
@ -64,13 +83,13 @@ static int show_bpf_prog(int id, enum bpf_attach_type attach_type,
return -1; return -1;
} }
attach_type_str = libbpf_bpf_attach_type_str(attach_type);
get_prog_full_name(&info, prog_fd, prog_name, sizeof(prog_name)); get_prog_full_name(&info, prog_fd, prog_name, sizeof(prog_name));
if (json_output) { if (json_output) {
jsonw_start_object(json_wtr); jsonw_start_object(json_wtr);
jsonw_uint_field(json_wtr, "id", info.id); jsonw_uint_field(json_wtr, "id", info.id);
if (attach_type < ARRAY_SIZE(attach_type_name)) if (attach_type_str)
jsonw_string_field(json_wtr, "attach_type", jsonw_string_field(json_wtr, "attach_type", attach_type_str);
attach_type_name[attach_type]);
else else
jsonw_uint_field(json_wtr, "attach_type", attach_type); jsonw_uint_field(json_wtr, "attach_type", attach_type);
jsonw_string_field(json_wtr, "attach_flags", jsonw_string_field(json_wtr, "attach_flags",
@ -79,8 +98,8 @@ static int show_bpf_prog(int id, enum bpf_attach_type attach_type,
jsonw_end_object(json_wtr); jsonw_end_object(json_wtr);
} else { } else {
printf("%s%-8u ", level ? " " : "", info.id); printf("%s%-8u ", level ? " " : "", info.id);
if (attach_type < ARRAY_SIZE(attach_type_name)) if (attach_type_str)
printf("%-15s", attach_type_name[attach_type]); printf("%-15s", attach_type_str);
else else
printf("type %-10u", attach_type); printf("type %-10u", attach_type);
printf(" %-15s %-15s\n", attach_flags_str, prog_name); printf(" %-15s %-15s\n", attach_flags_str, prog_name);

82
tools/bpf/bpftool/common.c
View File

@ -31,52 +31,6 @@
#define BPF_FS_MAGIC 0xcafe4a11 #define BPF_FS_MAGIC 0xcafe4a11
#endif #endif
const char * const attach_type_name[__MAX_BPF_ATTACH_TYPE] = {
[BPF_CGROUP_INET_INGRESS] = "ingress",
[BPF_CGROUP_INET_EGRESS] = "egress",
[BPF_CGROUP_INET_SOCK_CREATE] = "sock_create",
[BPF_CGROUP_INET_SOCK_RELEASE] = "sock_release",
[BPF_CGROUP_SOCK_OPS] = "sock_ops",
[BPF_CGROUP_DEVICE] = "device",
[BPF_CGROUP_INET4_BIND] = "bind4",
[BPF_CGROUP_INET6_BIND] = "bind6",
[BPF_CGROUP_INET4_CONNECT] = "connect4",
[BPF_CGROUP_INET6_CONNECT] = "connect6",
[BPF_CGROUP_INET4_POST_BIND] = "post_bind4",
[BPF_CGROUP_INET6_POST_BIND] = "post_bind6",
[BPF_CGROUP_INET4_GETPEERNAME] = "getpeername4",
[BPF_CGROUP_INET6_GETPEERNAME] = "getpeername6",
[BPF_CGROUP_INET4_GETSOCKNAME] = "getsockname4",
[BPF_CGROUP_INET6_GETSOCKNAME] = "getsockname6",
[BPF_CGROUP_UDP4_SENDMSG] = "sendmsg4",
[BPF_CGROUP_UDP6_SENDMSG] = "sendmsg6",
[BPF_CGROUP_SYSCTL] = "sysctl",
[BPF_CGROUP_UDP4_RECVMSG] = "recvmsg4",
[BPF_CGROUP_UDP6_RECVMSG] = "recvmsg6",
[BPF_CGROUP_GETSOCKOPT] = "getsockopt",
[BPF_CGROUP_SETSOCKOPT] = "setsockopt",
[BPF_SK_SKB_STREAM_PARSER] = "sk_skb_stream_parser",
[BPF_SK_SKB_STREAM_VERDICT] = "sk_skb_stream_verdict",
[BPF_SK_SKB_VERDICT] = "sk_skb_verdict",
[BPF_SK_MSG_VERDICT] = "sk_msg_verdict",
[BPF_LIRC_MODE2] = "lirc_mode2",
[BPF_FLOW_DISSECTOR] = "flow_dissector",
[BPF_TRACE_RAW_TP] = "raw_tp",
[BPF_TRACE_FENTRY] = "fentry",
[BPF_TRACE_FEXIT] = "fexit",
[BPF_MODIFY_RETURN] = "mod_ret",
[BPF_LSM_MAC] = "lsm_mac",
[BPF_SK_LOOKUP] = "sk_lookup",
[BPF_TRACE_ITER] = "trace_iter",
[BPF_XDP_DEVMAP] = "xdp_devmap",
[BPF_XDP_CPUMAP] = "xdp_cpumap",
[BPF_XDP] = "xdp",
[BPF_SK_REUSEPORT_SELECT] = "sk_skb_reuseport_select",
[BPF_SK_REUSEPORT_SELECT_OR_MIGRATE] = "sk_skb_reuseport_select_or_migrate",
[BPF_PERF_EVENT] = "perf_event",
[BPF_TRACE_KPROBE_MULTI] = "trace_kprobe_multi",
};
void p_err(const char *fmt, ...) void p_err(const char *fmt, ...)
{ {
va_list ap; va_list ap;
@ -1009,3 +963,39 @@ bool equal_fn_for_key_as_id(const void *k1, const void *k2, void *ctx)
{ {
return k1 == k2; return k1 == k2;
} }
const char *bpf_attach_type_input_str(enum bpf_attach_type t)
{
switch (t) {
case BPF_CGROUP_INET_INGRESS: return "ingress";
case BPF_CGROUP_INET_EGRESS: return "egress";
case BPF_CGROUP_INET_SOCK_CREATE: return "sock_create";
case BPF_CGROUP_INET_SOCK_RELEASE: return "sock_release";
case BPF_CGROUP_SOCK_OPS: return "sock_ops";
case BPF_CGROUP_DEVICE: return "device";
case BPF_CGROUP_INET4_BIND: return "bind4";
case BPF_CGROUP_INET6_BIND: return "bind6";
case BPF_CGROUP_INET4_CONNECT: return "connect4";
case BPF_CGROUP_INET6_CONNECT: return "connect6";
case BPF_CGROUP_INET4_POST_BIND: return "post_bind4";
case BPF_CGROUP_INET6_POST_BIND: return "post_bind6";
case BPF_CGROUP_INET4_GETPEERNAME: return "getpeername4";
case BPF_CGROUP_INET6_GETPEERNAME: return "getpeername6";
case BPF_CGROUP_INET4_GETSOCKNAME: return "getsockname4";
case BPF_CGROUP_INET6_GETSOCKNAME: return "getsockname6";
case BPF_CGROUP_UDP4_SENDMSG: return "sendmsg4";
case BPF_CGROUP_UDP6_SENDMSG: return "sendmsg6";
case BPF_CGROUP_SYSCTL: return "sysctl";
case BPF_CGROUP_UDP4_RECVMSG: return "recvmsg4";
case BPF_CGROUP_UDP6_RECVMSG: return "recvmsg6";
case BPF_CGROUP_GETSOCKOPT: return "getsockopt";
case BPF_CGROUP_SETSOCKOPT: return "setsockopt";
case BPF_TRACE_RAW_TP: return "raw_tp";
case BPF_TRACE_FENTRY: return "fentry";
case BPF_TRACE_FEXIT: return "fexit";
case BPF_MODIFY_RETURN: return "mod_ret";
case BPF_SK_REUSEPORT_SELECT: return "sk_skb_reuseport_select";
case BPF_SK_REUSEPORT_SELECT_OR_MIGRATE: return "sk_skb_reuseport_select_or_migrate";
default: return libbpf_bpf_attach_type_str(t);
}
}

15
tools/bpf/bpftool/link.c
View File

@ -78,9 +78,11 @@ show_link_header_json(struct bpf_link_info *info, json_writer_t *wtr)
static void show_link_attach_type_json(__u32 attach_type, json_writer_t *wtr) static void show_link_attach_type_json(__u32 attach_type, json_writer_t *wtr)
{ {
if (attach_type < ARRAY_SIZE(attach_type_name)) const char *attach_type_str;
jsonw_string_field(wtr, "attach_type",
attach_type_name[attach_type]); attach_type_str = libbpf_bpf_attach_type_str(attach_type);
if (attach_type_str)
jsonw_string_field(wtr, "attach_type", attach_type_str);
else else
jsonw_uint_field(wtr, "attach_type", attach_type); jsonw_uint_field(wtr, "attach_type", attach_type);
} }
@ -196,8 +198,11 @@ static void show_link_header_plain(struct bpf_link_info *info)
static void show_link_attach_type_plain(__u32 attach_type) static void show_link_attach_type_plain(__u32 attach_type)
{ {
if (attach_type < ARRAY_SIZE(attach_type_name)) const char *attach_type_str;
printf("attach_type %s ", attach_type_name[attach_type]);
attach_type_str = libbpf_bpf_attach_type_str(attach_type);
if (attach_type_str)
printf("attach_type %s ", attach_type_str);
else else
printf("attach_type %u ", attach_type); printf("attach_type %u ", attach_type);
} }

14
tools/bpf/bpftool/main.h
View File

@ -243,6 +243,20 @@ int print_all_levels(__maybe_unused enum libbpf_print_level level,
size_t hash_fn_for_key_as_id(const void *key, void *ctx); size_t hash_fn_for_key_as_id(const void *key, void *ctx);
bool equal_fn_for_key_as_id(const void *k1, const void *k2, void *ctx); bool equal_fn_for_key_as_id(const void *k1, const void *k2, void *ctx);
/* bpf_attach_type_input_str - convert the provided attach type value into a
* textual representation that we accept for input purposes.
*
* This function is similar in nature to libbpf_bpf_attach_type_str, but
* recognizes some attach type names that have been used by the program in the
* past and which do not follow the string inference scheme that libbpf uses.
* These textual representations should only be used for user input.
*
* @t: The attach type
* Returns a pointer to a static string identifying the attach type. NULL is
* returned for unknown bpf_attach_type values.
*/
const char *bpf_attach_type_input_str(enum bpf_attach_type t);
static inline void *u32_as_hash_field(__u32 x) static inline void *u32_as_hash_field(__u32 x)
{ {
return (void *)(uintptr_t)x; return (void *)(uintptr_t)x;

25
tools/bpf/bpftool/prog.c
View File

@ -41,12 +41,23 @@ enum dump_mode {
DUMP_XLATED, DUMP_XLATED,
}; };
static const bool attach_types[] = {
[BPF_SK_SKB_STREAM_PARSER] = true,
[BPF_SK_SKB_STREAM_VERDICT] = true,
[BPF_SK_SKB_VERDICT] = true,
[BPF_SK_MSG_VERDICT] = true,
[BPF_FLOW_DISSECTOR] = true,
[__MAX_BPF_ATTACH_TYPE] = false,
};
/* Textual representations traditionally used by the program and kept around
* for the sake of backwards compatibility.
*/
static const char * const attach_type_strings[] = { static const char * const attach_type_strings[] = {
[BPF_SK_SKB_STREAM_PARSER] = "stream_parser", [BPF_SK_SKB_STREAM_PARSER] = "stream_parser",
[BPF_SK_SKB_STREAM_VERDICT] = "stream_verdict", [BPF_SK_SKB_STREAM_VERDICT] = "stream_verdict",
[BPF_SK_SKB_VERDICT] = "skb_verdict", [BPF_SK_SKB_VERDICT] = "skb_verdict",
[BPF_SK_MSG_VERDICT] = "msg_verdict", [BPF_SK_MSG_VERDICT] = "msg_verdict",
[BPF_FLOW_DISSECTOR] = "flow_dissector",
[__MAX_BPF_ATTACH_TYPE] = NULL, [__MAX_BPF_ATTACH_TYPE] = NULL,
}; };
@ -57,6 +68,14 @@ static enum bpf_attach_type parse_attach_type(const char *str)
enum bpf_attach_type type; enum bpf_attach_type type;
for (type = 0; type < __MAX_BPF_ATTACH_TYPE; type++) { for (type = 0; type < __MAX_BPF_ATTACH_TYPE; type++) {
if (attach_types[type]) {
const char *attach_type_str;
attach_type_str = libbpf_bpf_attach_type_str(type);
if (!strcmp(str, attach_type_str))
return type;
}
if (attach_type_strings[type] && if (attach_type_strings[type] &&
is_prefix(str, attach_type_strings[type])) is_prefix(str, attach_type_strings[type]))
return type; return type;
@ -2341,8 +2360,8 @@ static int do_help(int argc, char **argv)
" cgroup/sendmsg6 | cgroup/recvmsg4 | cgroup/recvmsg6 |\n" " cgroup/sendmsg6 | cgroup/recvmsg4 | cgroup/recvmsg6 |\n"
" cgroup/getsockopt | cgroup/setsockopt | cgroup/sock_release |\n" " cgroup/getsockopt | cgroup/setsockopt | cgroup/sock_release |\n"
" struct_ops | fentry | fexit | freplace | sk_lookup }\n" " struct_ops | fentry | fexit | freplace | sk_lookup }\n"
" ATTACH_TYPE := { msg_verdict | skb_verdict | stream_verdict |\n" " ATTACH_TYPE := { sk_msg_verdict | sk_skb_verdict | sk_skb_stream_verdict |\n"
" stream_parser | flow_dissector }\n" " sk_skb_stream_parser | flow_dissector }\n"
" METRIC := { cycles | instructions | l1d_loads | llc_misses | itlb_misses | dtlb_misses }\n" " METRIC := { cycles | instructions | l1d_loads | llc_misses | itlb_misses | dtlb_misses }\n"
" " HELP_SPEC_OPTIONS " |\n" " " HELP_SPEC_OPTIONS " |\n"
" {-f|--bpffs} | {-m|--mapcompat} | {-n|--nomount} |\n" " {-f|--bpffs} | {-m|--mapcompat} | {-n|--nomount} |\n"

104
tools/testing/selftests/bpf/test_bpftool_synctypes.py
View File

@ -58,7 +58,7 @@ class BlockParser(object):
class ArrayParser(BlockParser): class ArrayParser(BlockParser):
""" """
A parser for extracting dicionaries of values from some BPF-related arrays. A parser for extracting a set of values from some BPF-related arrays.
@reader: a pointer to the open file to parse @reader: a pointer to the open file to parse
@array_name: name of the array to parse @array_name: name of the array to parse
""" """
@ -66,7 +66,7 @@ class ArrayParser(BlockParser):
def __init__(self, reader, array_name): def __init__(self, reader, array_name):
self.array_name = array_name self.array_name = array_name
self.start_marker = re.compile(f'(static )?const char \* const {self.array_name}\[.*\] = {{\n') self.start_marker = re.compile(f'(static )?const bool {self.array_name}\[.*\] = {{\n')
super().__init__(reader) super().__init__(reader)
def search_block(self): def search_block(self):
@ -80,15 +80,15 @@ class ArrayParser(BlockParser):
Parse a block and return data as a dictionary. Items to extract must be Parse a block and return data as a dictionary. Items to extract must be
on separate lines in the file. on separate lines in the file.
""" """
pattern = re.compile('\[(BPF_\w*)\]\s*= "(.*)",?$') pattern = re.compile('\[(BPF_\w*)\]\s*= (true|false),?$')
entries = {} entries = set()
while True: while True:
line = self.reader.readline() line = self.reader.readline()
if line == '' or re.match(self.end_marker, line): if line == '' or re.match(self.end_marker, line):
break break
capture = pattern.search(line) capture = pattern.search(line)
if capture: if capture:
entries[capture.group(1)] = capture.group(2) entries |= {capture.group(1)}
return entries return entries
class InlineListParser(BlockParser): class InlineListParser(BlockParser):
@ -115,7 +115,7 @@ class InlineListParser(BlockParser):
class FileExtractor(object): class FileExtractor(object):
""" """
A generic reader for extracting data from a given file. This class contains A generic reader for extracting data from a given file. This class contains
several helper methods that wrap arround parser objects to extract values several helper methods that wrap around parser objects to extract values
from different structures. from different structures.
This class does not offer a way to set a filename, which is expected to be This class does not offer a way to set a filename, which is expected to be
defined in children classes. defined in children classes.
@ -139,21 +139,19 @@ class FileExtractor(object):
def get_types_from_array(self, array_name): def get_types_from_array(self, array_name):
""" """
Search for and parse an array associating names to BPF_* enum members, Search for and parse a list of allowed BPF_* enum members, for example:
for example:
const char * const prog_type_name[] = { const bool prog_type_name[] = {
[BPF_PROG_TYPE_UNSPEC] = "unspec", [BPF_PROG_TYPE_UNSPEC] = true,
[BPF_PROG_TYPE_SOCKET_FILTER] = "socket_filter", [BPF_PROG_TYPE_SOCKET_FILTER] = true,
[BPF_PROG_TYPE_KPROBE] = "kprobe", [BPF_PROG_TYPE_KPROBE] = true,
}; };
Return a dictionary with the enum member names as keys and the Return a set of the enum members, for example:
associated names as values, for example:
{'BPF_PROG_TYPE_UNSPEC': 'unspec', {'BPF_PROG_TYPE_UNSPEC',
'BPF_PROG_TYPE_SOCKET_FILTER': 'socket_filter', 'BPF_PROG_TYPE_SOCKET_FILTER',
'BPF_PROG_TYPE_KPROBE': 'kprobe'} 'BPF_PROG_TYPE_KPROBE'}
@array_name: name of the array to parse @array_name: name of the array to parse
""" """
@ -355,7 +353,8 @@ class ProgFileExtractor(SourceFileExtractor):
filename = os.path.join(BPFTOOL_DIR, 'prog.c') filename = os.path.join(BPFTOOL_DIR, 'prog.c')
def get_attach_types(self): def get_attach_types(self):
return self.get_types_from_array('attach_type_strings') types = self.get_types_from_array('attach_types')
return self.make_enum_map(types, 'BPF_')
def get_prog_attach_help(self): def get_prog_attach_help(self):
return self.get_help_list('ATTACH_TYPE') return self.get_help_list('ATTACH_TYPE')
@ -378,30 +377,6 @@ class CgroupFileExtractor(SourceFileExtractor):
def get_prog_attach_help(self): def get_prog_attach_help(self):
return self.get_help_list('ATTACH_TYPE') return self.get_help_list('ATTACH_TYPE')
class CommonFileExtractor(SourceFileExtractor):
"""
An extractor for bpftool's common.c.
"""
filename = os.path.join(BPFTOOL_DIR, 'common.c')
def __init__(self):
super().__init__()
self.attach_types = {}
def get_attach_types(self):
if not self.attach_types:
self.attach_types = self.get_types_from_array('attach_type_name')
return self.attach_types
def get_cgroup_attach_types(self):
if not self.attach_types:
self.get_attach_types()
cgroup_types = {}
for (key, value) in self.attach_types.items():
if key.find('BPF_CGROUP') != -1:
cgroup_types[key] = value
return cgroup_types
class GenericSourceExtractor(SourceFileExtractor): class GenericSourceExtractor(SourceFileExtractor):
""" """
An extractor for generic source code files. An extractor for generic source code files.
@ -418,6 +393,10 @@ class BpfHeaderExtractor(FileExtractor):
""" """
filename = os.path.join(INCLUDE_DIR, 'uapi/linux/bpf.h') filename = os.path.join(INCLUDE_DIR, 'uapi/linux/bpf.h')
def __init__(self):
super().__init__()
self.attach_types = {}
def get_prog_types(self): def get_prog_types(self):
return self.get_enum('bpf_prog_type') return self.get_enum('bpf_prog_type')
@ -425,8 +404,17 @@ class BpfHeaderExtractor(FileExtractor):
names = self.get_enum('bpf_map_type') names = self.get_enum('bpf_map_type')
return self.make_enum_map(names, 'BPF_MAP_TYPE_') return self.make_enum_map(names, 'BPF_MAP_TYPE_')
def get_attach_types(self): def get_attach_type_map(self):
return self.get_enum('bpf_attach_type') if not self.attach_types:
names = self.get_enum('bpf_attach_type')
self.attach_types = self.make_enum_map(names, 'BPF_')
return self.attach_types
def get_cgroup_attach_type_map(self):
if not self.attach_types:
self.get_attach_type_map()
return {name: text for name, text in self.attach_types.items()
if name.startswith('BPF_CGROUP')}
class ManPageExtractor(FileExtractor): class ManPageExtractor(FileExtractor):
""" """
@ -540,17 +528,6 @@ def main():
verify(source_map_types, bashcomp_map_types, verify(source_map_types, bashcomp_map_types,
f'Comparing {BpfHeaderExtractor.filename} (bpf_map_type) and {BashcompExtractor.filename} (BPFTOOL_MAP_CREATE_TYPES):') f'Comparing {BpfHeaderExtractor.filename} (bpf_map_type) and {BashcompExtractor.filename} (BPFTOOL_MAP_CREATE_TYPES):')
# Attach types (enum)
ref = bpf_info.get_attach_types()
bpf_info.close()
common_info = CommonFileExtractor()
attach_types = common_info.get_attach_types()
verify(ref, attach_types,
f'Comparing BPF header (enum bpf_attach_type) and {CommonFileExtractor.filename} (attach_type_name):')
# Attach types (names) # Attach types (names)
prog_info = ProgFileExtractor() prog_info = ProgFileExtractor()
@ -569,18 +546,17 @@ def main():
bashcomp_prog_attach_types = bashcomp_info.get_prog_attach_types() bashcomp_prog_attach_types = bashcomp_info.get_prog_attach_types()
verify(source_prog_attach_types, help_prog_attach_types, verify(source_prog_attach_types, help_prog_attach_types,
f'Comparing {ProgFileExtractor.filename} (attach_type_strings) and {ProgFileExtractor.filename} (do_help() ATTACH_TYPE):') f'Comparing {ProgFileExtractor.filename} (bpf_attach_type) and {ProgFileExtractor.filename} (do_help() ATTACH_TYPE):')
verify(source_prog_attach_types, man_prog_attach_types, verify(source_prog_attach_types, man_prog_attach_types,
f'Comparing {ProgFileExtractor.filename} (attach_type_strings) and {ManProgExtractor.filename} (ATTACH_TYPE):') f'Comparing {ProgFileExtractor.filename} (bpf_attach_type) and {ManProgExtractor.filename} (ATTACH_TYPE):')
verify(help_prog_options, man_prog_options, verify(help_prog_options, man_prog_options,
f'Comparing {ProgFileExtractor.filename} (do_help() OPTIONS) and {ManProgExtractor.filename} (OPTIONS):') f'Comparing {ProgFileExtractor.filename} (do_help() OPTIONS) and {ManProgExtractor.filename} (OPTIONS):')
verify(source_prog_attach_types, bashcomp_prog_attach_types, verify(source_prog_attach_types, bashcomp_prog_attach_types,
f'Comparing {ProgFileExtractor.filename} (attach_type_strings) and {BashcompExtractor.filename} (BPFTOOL_PROG_ATTACH_TYPES):') f'Comparing {ProgFileExtractor.filename} (bpf_attach_type) and {BashcompExtractor.filename} (BPFTOOL_PROG_ATTACH_TYPES):')
# Cgroup attach types # Cgroup attach types
source_cgroup_attach_types = set(bpf_info.get_cgroup_attach_type_map().values())
source_cgroup_attach_types = set(common_info.get_cgroup_attach_types().values()) bpf_info.close()
common_info.close()
cgroup_info = CgroupFileExtractor() cgroup_info = CgroupFileExtractor()
help_cgroup_attach_types = cgroup_info.get_prog_attach_help() help_cgroup_attach_types = cgroup_info.get_prog_attach_help()
@ -596,13 +572,13 @@ def main():
bashcomp_info.close() bashcomp_info.close()
verify(source_cgroup_attach_types, help_cgroup_attach_types, verify(source_cgroup_attach_types, help_cgroup_attach_types,
f'Comparing {CommonFileExtractor.filename} (attach_type_strings) and {CgroupFileExtractor.filename} (do_help() ATTACH_TYPE):') f'Comparing {BpfHeaderExtractor.filename} (bpf_attach_type) and {CgroupFileExtractor.filename} (do_help() ATTACH_TYPE):')
verify(source_cgroup_attach_types, man_cgroup_attach_types, verify(source_cgroup_attach_types, man_cgroup_attach_types,
f'Comparing {CommonFileExtractor.filename} (attach_type_strings) and {ManCgroupExtractor.filename} (ATTACH_TYPE):') f'Comparing {BpfHeaderExtractor.filename} (bpf_attach_type) and {ManCgroupExtractor.filename} (ATTACH_TYPE):')
verify(help_cgroup_options, man_cgroup_options, verify(help_cgroup_options, man_cgroup_options,
f'Comparing {CgroupFileExtractor.filename} (do_help() OPTIONS) and {ManCgroupExtractor.filename} (OPTIONS):') f'Comparing {CgroupFileExtractor.filename} (do_help() OPTIONS) and {ManCgroupExtractor.filename} (OPTIONS):')
verify(source_cgroup_attach_types, bashcomp_cgroup_attach_types, verify(source_cgroup_attach_types, bashcomp_cgroup_attach_types,
f'Comparing {CommonFileExtractor.filename} (attach_type_strings) and {BashcompExtractor.filename} (BPFTOOL_CGROUP_ATTACH_TYPES):') f'Comparing {BpfHeaderExtractor.filename} (bpf_attach_type) and {BashcompExtractor.filename} (BPFTOOL_CGROUP_ATTACH_TYPES):')
# Options for remaining commands # Options for remaining commands