Skip to contentSkip to conversation

bpftool: Implement link show support for tcx

PATCH Applied Daniel Borkmann 3 participants 6 messages Aug 16, 2023

Subsystems (2)
lore
Share & tools
lore

Daniel Borkmann

author maintainer
#0 lore raw

PATCH 1/2 bpftool: Implement link show support for tcx

Add support to dump tcx link information to bpftool. This adds a common helper show_link_ifindex_{plain,json}() which can be reused also for other link types. The plain text and json device output is the same format as in bpftool net dump.

Below shows an example link dump output along with a cgroup link for comparison:

  # bpftool link
  [...]
  10: cgroup  prog 1977
        cgroup_id 1  attach_type cgroup_inet6_post_bind
  [...]
  13: tcx  prog 2053
        ifindex enp5s0(3)  attach_type tcx_ingress
  14: tcx  prog 2080
        ifindex enp5s0(3)  attach_type tcx_egress
  [...]

Equivalent json output:

  # bpftool link --json
  [...]
  {
    "id": 10,
    "type": "cgroup",
    "prog_id": 1977,
    "cgroup_id": 1,
    "attach_type": "cgroup_inet6_post_bind"
  },
  [...]
  {
    "id": 13,
    "type": "tcx",
    "prog_id": 2053,
    "devname": "enp5s0",
    "ifindex": 3,
    "attach_type": "tcx_ingress"
  },
  {
    "id": 14,
    "type": "tcx",
    "prog_id": 2080,
    "devname": "enp5s0",
    "ifindex": 3,
    "attach_type": "tcx_egress"
  }
  [...]
---
 tools/bpf/bpftool/link.c | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
tools/bpf/bpftool/link.c +37 -0
index 65a168df63bc..a3774594f154 100644
@@ -150,6 +150,18 @@ static void show_link_attach_type_json(__u32 attach_type, json_writer_t *wtr)
 		jsonw_uint_field(wtr, "attach_type", attach_type);
 }
 
+static void show_link_ifindex_json(__u32 ifindex, json_writer_t *wtr)
+{
+	char devname[IF_NAMESIZE] = "(unknown)";
+
+	if (ifindex)
+		if_indextoname(ifindex, devname);
+	else
+		snprintf(devname, sizeof(devname), "(detached)");
+	jsonw_string_field(wtr, "devname", devname);
+	jsonw_uint_field(wtr, "ifindex", ifindex);
+}
+
 static bool is_iter_map_target(const char *target_name)
 {
 	return strcmp(target_name, "bpf_map_elem") == 0 ||
@@ -433,6 +445,10 @@ static int show_link_close_json(int fd, struct bpf_link_info *info)
 	case BPF_LINK_TYPE_NETFILTER:
 		netfilter_dump_json(info, json_wtr);
 		break;
+	case BPF_LINK_TYPE_TCX:
+		show_link_ifindex_json(info->tcx.ifindex, json_wtr);
+		show_link_attach_type_json(info->tcx.attach_type, json_wtr);
+		break;
 	case BPF_LINK_TYPE_STRUCT_OPS:
 		jsonw_uint_field(json_wtr, "map_id",
 				 info->struct_ops.map_id);
@@ -509,6 +525,22 @@ static void show_link_attach_type_plain(__u32 attach_type)
 		printf("attach_type %u  ", attach_type);
 }
 
+static void show_link_ifindex_plain(__u32 ifindex)
+{
+	char devname[IF_NAMESIZE * 2] = "(unknown)";
+	char tmpname[IF_NAMESIZE];
+	char *ret = NULL;
+
+	if (ifindex)
+		ret = if_indextoname(ifindex, tmpname);
+	else
+		snprintf(devname, sizeof(devname), "(detached)");
+	if (ret)
+		snprintf(devname, sizeof(devname), "%s(%d)",
+			 tmpname, ifindex);
+	printf("ifindex %s  ", devname);
+}
+
 static void show_iter_plain(struct bpf_link_info *info)
 {
 	const char *target_name = u64_to_ptr(info->iter.target_name);
@@ -745,6 +777,11 @@ static int show_link_close_plain(int fd, struct bpf_link_info *info)
 	case BPF_LINK_TYPE_NETFILTER:
 		netfilter_dump_plain(info);
 		break;
+	case BPF_LINK_TYPE_TCX:
+		printf("\n\t");
+		show_link_ifindex_plain(info->tcx.ifindex);
+		show_link_attach_type_plain(info->tcx.attach_type);
+		break;
 	case BPF_LINK_TYPE_KPROBE_MULTI:
 		show_kprobe_multi_plain(info);
 		break;
Signature · 1 line
2.34.1
author maintainer
#1 lore raw

PATCH 2/2 bpftool: Implement link show support for xdp

Add support to dump XDP link information to bpftool. This reuses the recently added show_link_ifindex_{plain,json}(). The XDP link info only exposes the ifindex.

Below shows an example link dump output, and a cgroup link is included for comparison, too:

  # bpftool link
  [...]
  10: cgroup  prog 2466
        cgroup_id 1  attach_type cgroup_inet6_post_bind
  [...]
  16: xdp  prog 2477
        ifindex enp5s0(3)
  [...]

Equivalent json output:

  # bpftool link --json
  [...]
  {
    "id": 10,
    "type": "cgroup",
    "prog_id": 2466,
    "cgroup_id": 1,
    "attach_type": "cgroup_inet6_post_bind"
  },
  [...]
  {
    "id": 16,
    "type": "xdp",
    "prog_id": 2477,
    "devname": "enp5s0",
    "ifindex": 3
  }
  [...]
---
 tools/bpf/bpftool/link.c | 7 +++++++
 1 file changed, 7 insertions(+)
tools/bpf/bpftool/link.c +7 -0
index a3774594f154..0b214f6ab5c8 100644
@@ -449,6 +449,9 @@ static int show_link_close_json(int fd, struct bpf_link_info *info)
 		show_link_ifindex_json(info->tcx.ifindex, json_wtr);
 		show_link_attach_type_json(info->tcx.attach_type, json_wtr);
 		break;
+	case BPF_LINK_TYPE_XDP:
+		show_link_ifindex_json(info->xdp.ifindex, json_wtr);
+		break;
 	case BPF_LINK_TYPE_STRUCT_OPS:
 		jsonw_uint_field(json_wtr, "map_id",
 				 info->struct_ops.map_id);
@@ -782,6 +785,10 @@ static int show_link_close_plain(int fd, struct bpf_link_info *info)
 		show_link_ifindex_plain(info->tcx.ifindex);
 		show_link_attach_type_plain(info->tcx.attach_type);
 		break;
+	case BPF_LINK_TYPE_XDP:
+		printf("\n\t");
+		show_link_ifindex_plain(info->xdp.ifindex);
+		break;
 	case BPF_LINK_TYPE_KPROBE_MULTI:
 		show_kprobe_multi_plain(info);
 		break;
Signature · 1 line
2.34.1
#2 lore raw
In reply to Daniel Borkmann
Quoted 50 lines · Daniel Borkmann

Add support to dump tcx link information to bpftool. This adds a common helper show_link_ifindex_{plain,json}() which can be reused also for other link types. The plain text and json device output is the same format as in bpftool net dump.

Below shows an example link dump output along with a cgroup link for comparison:

  # bpftool link
  [...]
  10: cgroup  prog 1977
        cgroup_id 1  attach_type cgroup_inet6_post_bind
  [...]
  13: tcx  prog 2053
        ifindex enp5s0(3)  attach_type tcx_ingress
  14: tcx  prog 2080
        ifindex enp5s0(3)  attach_type tcx_egress
  [...]

Equivalent json output:

  # bpftool link --json
  [...]
  {
    "id": 10,
    "type": "cgroup",
    "prog_id": 1977,
    "cgroup_id": 1,
    "attach_type": "cgroup_inet6_post_bind"
  },
  [...]
  {
    "id": 13,
    "type": "tcx",
    "prog_id": 2053,
    "devname": "enp5s0",
    "ifindex": 3,
    "attach_type": "tcx_ingress"
  },
  {
    "id": 14,
    "type": "tcx",
    "prog_id": 2080,
    "devname": "enp5s0",
    "ifindex": 3,
    "attach_type": "tcx_egress"
  }
  [...]
Quoted 3 lines

Thanks for your work. This patch looks good to me. A minor nit below.

Quoted 47 lines
---
 tools/bpf/bpftool/link.c | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
tools/bpf/bpftool/link.c +21 -0
index 65a168df63bc..a3774594f154 100644
@@ -150,6 +150,18 @@ static void show_link_attach_type_json(__u32 attach_type, json_writer_t *wtr)
                jsonw_uint_field(wtr, "attach_type", attach_type);
 }
 
+static void show_link_ifindex_json(__u32 ifindex, json_writer_t *wtr)
+{
+       char devname[IF_NAMESIZE] = "(unknown)";
+
+       if (ifindex)
+               if_indextoname(ifindex, devname);
+       else
+               snprintf(devname, sizeof(devname), "(detached)");
+       jsonw_string_field(wtr, "devname", devname);
+       jsonw_uint_field(wtr, "ifindex", ifindex);
+}
+
 static bool is_iter_map_target(const char *target_name)
 {
        return strcmp(target_name, "bpf_map_elem") == 0 ||
@@ -433,6 +445,10 @@ static int show_link_close_json(int fd, struct bpf_link_info *info)
        case BPF_LINK_TYPE_NETFILTER:
                netfilter_dump_json(info, json_wtr);
                break;
+       case BPF_LINK_TYPE_TCX:
+               show_link_ifindex_json(info->tcx.ifindex, json_wtr);
+               show_link_attach_type_json(info->tcx.attach_type, json_wtr);
+               break;
        case BPF_LINK_TYPE_STRUCT_OPS:
                jsonw_uint_field(json_wtr, "map_id",
                                 info->struct_ops.map_id);
@@ -509,6 +525,22 @@ static void show_link_attach_type_plain(__u32 attach_type)
                printf("attach_type %u  ", attach_type);
 }
 
+static void show_link_ifindex_plain(__u32 ifindex)
+{
+       char devname[IF_NAMESIZE * 2] = "(unknown)";
+       char tmpname[IF_NAMESIZE];
+       char *ret = NULL;

tools/bpf/bpftool/link.c static void show_link_attach_type_plain(__u32 attach_type) · line 542

Quoted 10 lines
tools/bpf/bpftool/link.c +10 -0
+
+       if (ifindex)
+               ret = if_indextoname(ifindex, tmpname);
+       else
+               snprintf(devname, sizeof(devname), "(detached)");
+       if (ret)
+               snprintf(devname, sizeof(devname), "%s(%d)",
+                        tmpname, ifindex);
+       printf("ifindex %s  ", devname);
+}

This function looks a little strange to me. What about the change below?

static void show_link_ifindex_plain(__u32 ifindex)

{
        char devname[IF_NAMESIZE] = "(unknown)";

        if (ifindex) {
                if_indextoname(ifindex, devname);
                printf("ifindex %s(%d)  ", devname, ifindex);
        } else {
                printf("ifindex (detached)  ");
        }
}
Quoted 19 lines
tools/bpf/bpftool/link.c +6 -1
+
 static void show_iter_plain(struct bpf_link_info *info)
 {
        const char *target_name = u64_to_ptr(info->iter.target_name);
@@ -745,6 +777,11 @@ static int show_link_close_plain(int fd, struct bpf_link_info *info)
        case BPF_LINK_TYPE_NETFILTER:
                netfilter_dump_plain(info);
                break;
+       case BPF_LINK_TYPE_TCX:
+               printf("\n\t");
+               show_link_ifindex_plain(info->tcx.ifindex);
+               show_link_attach_type_plain(info->tcx.attach_type);
+               break;
        case BPF_LINK_TYPE_KPROBE_MULTI:
                show_kprobe_multi_plain(info);
                break;
--

2.34.1

Signature · 2 lines
Regards
Yafang
author maintainer
#3 lore raw
Quoted 119 lines · Yafang Shao
Quoted 50 lines · Daniel Borkmann

Add support to dump tcx link information to bpftool. This adds a common helper show_link_ifindex_{plain,json}() which can be reused also for other link types. The plain text and json device output is the same format as in bpftool net dump.

Below shows an example link dump output along with a cgroup link for comparison:

   # bpftool link
   [...]
   10: cgroup  prog 1977
         cgroup_id 1  attach_type cgroup_inet6_post_bind
   [...]
   13: tcx  prog 2053
         ifindex enp5s0(3)  attach_type tcx_ingress
   14: tcx  prog 2080
         ifindex enp5s0(3)  attach_type tcx_egress
   [...]

Equivalent json output:

   # bpftool link --json
   [...]
   {
     "id": 10,
     "type": "cgroup",
     "prog_id": 1977,
     "cgroup_id": 1,
     "attach_type": "cgroup_inet6_post_bind"
   },
   [...]
   {
     "id": 13,
     "type": "tcx",
     "prog_id": 2053,
     "devname": "enp5s0",
     "ifindex": 3,
     "attach_type": "tcx_ingress"
   },
   {
     "id": 14,
     "type": "tcx",
     "prog_id": 2080,
     "devname": "enp5s0",
     "ifindex": 3,
     "attach_type": "tcx_egress"
   }
   [...]
Quoted 3 lines

Thanks for your work. This patch looks good to me. A minor nit below.

Quoted 47 lines
---
  tools/bpf/bpftool/link.c | 37 +++++++++++++++++++++++++++++++++++++
  1 file changed, 37 insertions(+)
tools/bpf/bpftool/link.c +21 -0
index 65a168df63bc..a3774594f154 100644
@@ -150,6 +150,18 @@ static void show_link_attach_type_json(__u32 attach_type, json_writer_t *wtr)
                 jsonw_uint_field(wtr, "attach_type", attach_type);
  }
 
+static void show_link_ifindex_json(__u32 ifindex, json_writer_t *wtr)
+{
+       char devname[IF_NAMESIZE] = "(unknown)";
+
+       if (ifindex)
+               if_indextoname(ifindex, devname);
+       else
+               snprintf(devname, sizeof(devname), "(detached)");
+       jsonw_string_field(wtr, "devname", devname);
+       jsonw_uint_field(wtr, "ifindex", ifindex);
+}
+
  static bool is_iter_map_target(const char *target_name)
  {
         return strcmp(target_name, "bpf_map_elem") == 0 ||
@@ -433,6 +445,10 @@ static int show_link_close_json(int fd, struct bpf_link_info *info)
         case BPF_LINK_TYPE_NETFILTER:
                 netfilter_dump_json(info, json_wtr);
                 break;
+       case BPF_LINK_TYPE_TCX:
+               show_link_ifindex_json(info->tcx.ifindex, json_wtr);
+               show_link_attach_type_json(info->tcx.attach_type, json_wtr);
+               break;
         case BPF_LINK_TYPE_STRUCT_OPS:
                 jsonw_uint_field(json_wtr, "map_id",
                                  info->struct_ops.map_id);
@@ -509,6 +525,22 @@ static void show_link_attach_type_plain(__u32 attach_type)
                 printf("attach_type %u  ", attach_type);
  }
 
+static void show_link_ifindex_plain(__u32 ifindex)
+{
+       char devname[IF_NAMESIZE * 2] = "(unknown)";
+       char tmpname[IF_NAMESIZE];
+       char *ret = NULL;

tools/bpf/bpftool/link.c static void show_link_attach_type_plain(__u32 attach_type) · line 542

Quoted 10 lines
tools/bpf/bpftool/link.c +10 -0
+
+       if (ifindex)
+               ret = if_indextoname(ifindex, tmpname);
+       else
+               snprintf(devname, sizeof(devname), "(detached)");
+       if (ret)
+               snprintf(devname, sizeof(devname), "%s(%d)",
+                        tmpname, ifindex);
+       printf("ifindex %s  ", devname);
+}

This function looks a little strange to me. What about the change below?

static void show_link_ifindex_plain(__u32 ifindex)

Quoted 10 lines
{
         char devname[IF_NAMESIZE] = "(unknown)";

         if (ifindex) {
                 if_indextoname(ifindex, devname);
                 printf("ifindex %s(%d)  ", devname, ifindex);
         } else {
                 printf("ifindex (detached)  ");
         }
}

Arguably, it's a corner case (and should never happen), but for the case where the if_indextoname call fails, I only intended to print ifindex (unknown) for the plain mode hence the check for if_indextoname success so that this looks similar as ifindex (detached) situation.

Thanks,
Daniel

Acked-by
#4 lore raw
Quoted 132 lines · Daniel Borkmann
Quoted 119 lines · Yafang Shao
Quoted 50 lines · Daniel Borkmann

Add support to dump tcx link information to bpftool. This adds a common helper show_link_ifindex_{plain,json}() which can be reused also for other link types. The plain text and json device output is the same format as in bpftool net dump.

Below shows an example link dump output along with a cgroup link for comparison:

   # bpftool link
   [...]
   10: cgroup  prog 1977
         cgroup_id 1  attach_type cgroup_inet6_post_bind
   [...]
   13: tcx  prog 2053
         ifindex enp5s0(3)  attach_type tcx_ingress
   14: tcx  prog 2080
         ifindex enp5s0(3)  attach_type tcx_egress
   [...]

Equivalent json output:

   # bpftool link --json
   [...]
   {
     "id": 10,
     "type": "cgroup",
     "prog_id": 1977,
     "cgroup_id": 1,
     "attach_type": "cgroup_inet6_post_bind"
   },
   [...]
   {
     "id": 13,
     "type": "tcx",
     "prog_id": 2053,
     "devname": "enp5s0",
     "ifindex": 3,
     "attach_type": "tcx_ingress"
   },
   {
     "id": 14,
     "type": "tcx",
     "prog_id": 2080,
     "devname": "enp5s0",
     "ifindex": 3,
     "attach_type": "tcx_egress"
   }
   [...]
Quoted 3 lines

Thanks for your work. This patch looks good to me. A minor nit below.

Quoted 47 lines
---
  tools/bpf/bpftool/link.c | 37 +++++++++++++++++++++++++++++++++++++
  1 file changed, 37 insertions(+)
tools/bpf/bpftool/link.c +21 -0
index 65a168df63bc..a3774594f154 100644
@@ -150,6 +150,18 @@ static void show_link_attach_type_json(__u32 attach_type, json_writer_t *wtr)
                 jsonw_uint_field(wtr, "attach_type", attach_type);
  }
 
+static void show_link_ifindex_json(__u32 ifindex, json_writer_t *wtr)
+{
+       char devname[IF_NAMESIZE] = "(unknown)";
+
+       if (ifindex)
+               if_indextoname(ifindex, devname);
+       else
+               snprintf(devname, sizeof(devname), "(detached)");
+       jsonw_string_field(wtr, "devname", devname);
+       jsonw_uint_field(wtr, "ifindex", ifindex);
+}
+
  static bool is_iter_map_target(const char *target_name)
  {
         return strcmp(target_name, "bpf_map_elem") == 0 ||
@@ -433,6 +445,10 @@ static int show_link_close_json(int fd, struct bpf_link_info *info)
         case BPF_LINK_TYPE_NETFILTER:
                 netfilter_dump_json(info, json_wtr);
                 break;
+       case BPF_LINK_TYPE_TCX:
+               show_link_ifindex_json(info->tcx.ifindex, json_wtr);
+               show_link_attach_type_json(info->tcx.attach_type, json_wtr);
+               break;
         case BPF_LINK_TYPE_STRUCT_OPS:
                 jsonw_uint_field(json_wtr, "map_id",
                                  info->struct_ops.map_id);
@@ -509,6 +525,22 @@ static void show_link_attach_type_plain(__u32 attach_type)
                 printf("attach_type %u  ", attach_type);
  }
 
+static void show_link_ifindex_plain(__u32 ifindex)
+{
+       char devname[IF_NAMESIZE * 2] = "(unknown)";
+       char tmpname[IF_NAMESIZE];
+       char *ret = NULL;

tools/bpf/bpftool/link.c static void show_link_attach_type_plain(__u32 attach_type) · line 542

Quoted 10 lines
tools/bpf/bpftool/link.c +10 -0
+
+       if (ifindex)
+               ret = if_indextoname(ifindex, tmpname);
+       else
+               snprintf(devname, sizeof(devname), "(detached)");
+       if (ret)
+               snprintf(devname, sizeof(devname), "%s(%d)",
+                        tmpname, ifindex);
+       printf("ifindex %s  ", devname);
+}

This function looks a little strange to me. What about the change below?

static void show_link_ifindex_plain(__u32 ifindex)

Quoted 10 lines
{
         char devname[IF_NAMESIZE] = "(unknown)";

         if (ifindex) {
                 if_indextoname(ifindex, devname);
                 printf("ifindex %s(%d)  ", devname, ifindex);
         } else {
                 printf("ifindex (detached)  ");
         }
}
Quoted 5 lines

Arguably, it's a corner case (and should never happen), but for the case where the if_indextoname call fails, I only intended to print ifindex (unknown) for the plain mode hence the check for if_indextoname success so that this looks similar as ifindex (detached) situation.

Fair enough.

Then fail free to add :

Signature · 2 lines
Regards
Yafang
#5 lore raw
In reply to Daniel Borkmann
This series was applied to bpf/bpf-next.git (master) by Martin KaFai Lau <[email protected]>:

Hello:

This series was applied to bpf/bpf-next.git (master) by Martin KaFai Lau <[email protected]>:

Quoted 9 lines · On Wed, 16 Aug 2023 11:56:50 +0200 you wrote:

Add support to dump tcx link information to bpftool. This adds a common helper show_link_ifindex_{plain,json}() which can be reused also for other link types. The plain text and json device output is the same format as in bpftool net dump.

Below shows an example link dump output along with a cgroup link for comparison:

[...]

Here is the summary with links:
- [bpf-next,1/2] bpftool: Implement link show support for tcx

    https://git.kernel.org/bpf/bpf-next/c/e16e6c6df475
  - [bpf-next,2/2] bpftool: Implement link show support for xdp
    https://git.kernel.org/bpf/bpf-next/c/053bbf9bff58

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html