Skip to contentSkip to conversation

bpftool: Add bpf_token show

PATCH Applied Tao Chen 4 participants 8 messages Jul 23, 2025 – Sep 16, 2025 1 message not in the archive

Subsystems (4)
lore
Share & tools
lore

Tao Chen

author
#0 lore raw

PATCH v4 1/3 bpftool: Add bpf_token show

Add bpftool token show command to get token info from bpffs in /proc/mounts.

Example plain output for token show:
token_info /sys/fs/bpf/token
allowed_cmds:
map_create prog_load
allowed_maps:
allowed_progs:
kprobe
allowed_attachs:
xdp
token_info /sys/fs/bpf/token2
allowed_cmds:
map_create prog_load
allowed_maps:
allowed_progs:
kprobe
allowed_attachs:
xdp

Example json output for token show:

[{
	"token_info": "/sys/fs/bpf/token",
	"allowed_cmds": ["map_create", "prog_load"],
	"allowed_maps": [],
	"allowed_progs": ["kprobe"],
	"allowed_attachs": ["xdp"]
}, {
	"token_info": "/sys/fs/bpf/token2",
	"allowed_cmds": ["map_create", "prog_load"],
	"allowed_maps": [],
	"allowed_progs": ["kprobe"],
	"allowed_attachs": ["xdp"]
}]
---
 tools/bpf/bpftool/main.c  |   3 +-
 tools/bpf/bpftool/main.h  |   1 +
 tools/bpf/bpftool/token.c | 225 ++++++++++++++++++++++++++++++++++++++
 3 files changed, 228 insertions(+), 1 deletion(-)
 create mode 100644 tools/bpf/bpftool/token.c

Change list:
v3 -> v4:
- patch1
- fix CHECK coding style with 'checkpatch.pl --strict'
- repalce [tab] with space when show help information
- patchset reviewed-by Quentin
v3: https://lore.kernel.org/bpf/[email protected]

v2 -> v3:
Quentin suggested:
- patch1
- remove print when token not found.
- patch2
- refactor description message.
- patch3
- update commit message.
v2: https://lore.kernel.org/bpf/[email protected]

     https://lore.kernel.org/bpf/[email protected]

v1 -> v2:
Quentin suggested:
- patch1
- remove zclose macro.
- rename __json_array_str to split_json_array_str
- print empty array when value is null for json format.
- show all tokens info and format plain output for readable.
- add info when token not found.
- add copyright in token.c
- patch2
- update 'eBPF progs' to 'eBPF tokens'.
- update description.
- patch3
- add bash-completion.
v1: https://lore.kernel.org/bpf/[email protected]

tools/bpf/bpftool/main.c +2 -1
index 2b7f2bd3a7d..0f1183b2ed0 100644
@@ -61,7 +61,7 @@ static int do_help(int argc, char **argv)
 		"       %s batch file FILE\n"
 		"       %s version\n"
 		"\n"
-		"       OBJECT := { prog | map | link | cgroup | perf | net | feature | btf | gen | struct_ops | iter }\n"
+		"       OBJECT := { prog | map | link | cgroup | perf | net | feature | btf | gen | struct_ops | iter | token }\n"
 		"       " HELP_SPEC_OPTIONS " |\n"
 		"                    {-V|--version} }\n"
 		"",
@@ -87,6 +87,7 @@ static const struct cmd commands[] = {
 	{ "gen",	do_gen },
 	{ "struct_ops",	do_struct_ops },
 	{ "iter",	do_iter },
+	{ "token",	do_token },
 	{ "version",	do_version },
 	{ 0 }
 };
tools/bpf/bpftool/main.h +1 -0
index 6db704fda5c..a2bb0714b3d 100644
@@ -166,6 +166,7 @@ int do_tracelog(int argc, char **arg) __weak;
 int do_feature(int argc, char **argv) __weak;
 int do_struct_ops(int argc, char **argv) __weak;
 int do_iter(int argc, char **argv) __weak;
+int do_token(int argc, char **argv) __weak;
 
 int parse_u32_arg(int *argc, char ***argv, __u32 *val, const char *what);
 int prog_parse_fd(int *argc, char ***argv);
tools/bpf/bpftool/token.c new file +225 -0

225 lines not on this page · raw message

Signature · 1 line
2.48.1
author
#1 lore raw

PATCH v4 2/3 bpftool: Add bpftool-token manpage

Add bpftool-token manpage with information and examples of token-related commands.

---
 .../bpftool/Documentation/bpftool-token.rst   | 64 +++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 tools/bpf/bpftool/Documentation/bpftool-token.rst
tools/bpf/bpftool/Documentation/bpftool-token.rst new file +64 -0
new file mode 100644
index 00000000000..d082c499cfe
@@ -0,0 +1,64 @@
+.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+
+================
+bpftool-token
+================
+-------------------------------------------------------------------------------
+tool for inspection and simple manipulation of eBPF tokens
+-------------------------------------------------------------------------------
+
+:Manual section: 8
+
+.. include:: substitutions.rst
+
+SYNOPSIS
+========
+
+**bpftool** [*OPTIONS*] **token** *COMMAND*
+
+*OPTIONS* := { |COMMON_OPTIONS| }
+
+*COMMANDS* := { **show** | **list** | **help** }
+
+TOKEN COMMANDS
+===============
+
+| **bpftool** **token** { **show** | **list** }
+| **bpftool** **token help**
+|
+
+DESCRIPTION
+===========
+bpftool token { show | list }
+    List BPF token information for each *bpffs* mount point containing token
+    information on the system. Information include mount point path, allowed
+    **bpf**\ () system call commands, maps, programs, and attach types for the
+    token.
+
+bpftool prog help
+    Print short help message.
+
+OPTIONS
+========
+.. include:: common_options.rst
+
+EXAMPLES
+========
+|
+| **# mkdir -p /sys/fs/bpf/token**
+| **# mount -t bpf bpffs /sys/fs/bpf/token** \
+|         **-o delegate_cmds=prog_load:map_create** \
+|         **-o delegate_progs=kprobe** \
+|         **-o delegate_attachs=xdp**
+| **# bpftool token list**
+
+::
+
+    token_info  /sys/fs/bpf/token
+            allowed_cmds:
+              map_create          prog_load
+            allowed_maps:
+            allowed_progs:
+              kprobe
+            allowed_attachs:
+              xdp
Signature · 1 line
2.48.1
author
#2 lore raw

PATCH v4 3/3 bpftool: Add bash completion for token argument

In reply to Tao Chen

This commit updates the bash completion script with the new token argument.

$ bpftool token
help  list  show
---
 tools/bpf/bpftool/bash-completion/bpftool | 11 +++++++++++
 1 file changed, 11 insertions(+)
tools/bpf/bpftool/bash-completion/bpftool +11 -0
index a759ba24471..527bb47ac46 100644
@@ -1215,6 +1215,17 @@ _bpftool()
                     ;;
             esac
             ;;
+        token)
+            case $command in
+               show|list)
+                   return 0
+                   ;;
+               *)
+                   [[ $prev == $object ]] && \
+                       COMPREPLY=( $( compgen -W 'help show list' -- "$cur" ) )
+                   ;;
+            esac
+            ;;
     esac
 } &&
 complete -F _bpftool bpftool
Signature · 1 line
2.48.1
author
#3 lore raw
In reply to Tao Chen

在 2025/7/23 22:44, Tao Chen 写道:

Ping...

Hi,

Quentin has reviewed this patchset, could someone review this again, thanks.

Quoted 344 lines

Add bpftool token show command to get token info from bpffs in /proc/mounts.

Example plain output for token show:
token_info /sys/fs/bpf/token
allowed_cmds:
map_create prog_load
allowed_maps:
allowed_progs:
kprobe
allowed_attachs:
xdp
token_info /sys/fs/bpf/token2
allowed_cmds:
map_create prog_load
allowed_maps:
allowed_progs:
kprobe
allowed_attachs:
xdp

Example json output for token show:

[{
	"token_info": "/sys/fs/bpf/token",
	"allowed_cmds": ["map_create", "prog_load"],
	"allowed_maps": [],
	"allowed_progs": ["kprobe"],
	"allowed_attachs": ["xdp"]
}, {
	"token_info": "/sys/fs/bpf/token2",
	"allowed_cmds": ["map_create", "prog_load"],
	"allowed_maps": [],
	"allowed_progs": ["kprobe"],
	"allowed_attachs": ["xdp"]
}]
---
  tools/bpf/bpftool/main.c  |   3 +-
  tools/bpf/bpftool/main.h  |   1 +
  tools/bpf/bpftool/token.c | 225 ++++++++++++++++++++++++++++++++++++++
  3 files changed, 228 insertions(+), 1 deletion(-)

create mode 100644 tools/bpf/bpftool/token.c

Change list:
v3 -> v4:
- patch1
- fix CHECK coding style with 'checkpatch.pl --strict'
- repalce [tab] with space when show help information
- patchset reviewed-by Quentin
v3: https://lore.kernel.org/bpf/[email protected]

v2 -> v3:
Quentin suggested:
- patch1
- remove print when token not found.
- patch2
- refactor description message.
- patch3
- update commit message.
v2: https://lore.kernel.org/bpf/[email protected]

      https://lore.kernel.org/bpf/[email protected]

v1 -> v2:
Quentin suggested:
- patch1
- remove zclose macro.
- rename __json_array_str to split_json_array_str
- print empty array when value is null for json format.
- show all tokens info and format plain output for readable.
- add info when token not found.
- add copyright in token.c
- patch2
- update 'eBPF progs' to 'eBPF tokens'.
- update description.
- patch3
- add bash-completion.
v1: https://lore.kernel.org/bpf/[email protected]

tools/bpf/bpftool/main.c +2 -1
index 2b7f2bd3a7d..0f1183b2ed0 100644
@@ -61,7 +61,7 @@ static int do_help(int argc, char **argv)
  		"       %s batch file FILE\n"
  		"       %s version\n"
  		"\n"
-		"       OBJECT := { prog | map | link | cgroup | perf | net | feature | btf | gen | struct_ops | iter }\n"
+		"       OBJECT := { prog | map | link | cgroup | perf | net | feature | btf | gen | struct_ops | iter | token }\n"
  		"       " HELP_SPEC_OPTIONS " |\n"
  		"                    {-V|--version} }\n"
  		"",
@@ -87,6 +87,7 @@ static const struct cmd commands[] = {
  	{ "gen",	do_gen },
  	{ "struct_ops",	do_struct_ops },
  	{ "iter",	do_iter },
+	{ "token",	do_token },
  	{ "version",	do_version },
  	{ 0 }
  };
tools/bpf/bpftool/main.h +1 -0
index 6db704fda5c..a2bb0714b3d 100644
@@ -166,6 +166,7 @@ int do_tracelog(int argc, char **arg) __weak;
  int do_feature(int argc, char **argv) __weak;
  int do_struct_ops(int argc, char **argv) __weak;
  int do_iter(int argc, char **argv) __weak;
+int do_token(int argc, char **argv) __weak;
 
  int parse_u32_arg(int *argc, char ***argv, __u32 *val, const char *what);
  int prog_parse_fd(int *argc, char ***argv);
tools/bpf/bpftool/token.c new file +225 -0
new file mode 100644
index 00000000000..6312e662a12
@@ -0,0 +1,225 @@
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright (C) 2025 Didi Technology Co., Tao Chen */
+
+#ifndef _GNU_SOURCE
+#define _GNU_SOURCE
+#endif
+#include <errno.h>
+#include <fcntl.h>
+#include <stdbool.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+#include <mntent.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+
+#include "json_writer.h"
+#include "main.h"
+
+#define MOUNTS_FILE "/proc/mounts"
+
+static bool has_delegate_options(const char *mnt_ops)
+{
+	return strstr(mnt_ops, "delegate_cmds") ||
+	       strstr(mnt_ops, "delegate_maps") ||
+	       strstr(mnt_ops, "delegate_progs") ||
+	       strstr(mnt_ops, "delegate_attachs");
+}
+
+static char *get_delegate_value(const char *opts, const char *key)
+{
+	char *token, *rest, *ret = NULL;
+	char *opts_copy = strdup(opts);
+
+	if (!opts_copy)
+		return NULL;
+
+	for (token = strtok_r(opts_copy, ",", &rest); token;
+			token = strtok_r(NULL, ",", &rest)) {
+		if (strncmp(token, key, strlen(key)) == 0 &&
+		    token[strlen(key)] == '=') {
+			ret = token + strlen(key) + 1;
+			break;
+		}
+	}
+	free(opts_copy);
+
+	return ret;
+}
+
+static void print_items_per_line(const char *input, int items_per_line)
+{
+	char *str, *rest, *strs;
+	int cnt = 0;
+
+	if (!input)
+		return;
+
+	strs = strdup(input);
+	if (!strs)
+		return;
+
+	for (str = strtok_r(strs, ":", &rest); str;
+			str = strtok_r(NULL, ":", &rest)) {
+		if (cnt % items_per_line == 0)
+			printf("\n\t  ");
+
+		printf("%-20s", str);
+		cnt++;
+	}
+
+	free(strs);
+}
+
+#define ITEMS_PER_LINE 4
+static void show_token_info_plain(struct mntent *mntent)
+{
+	char *value;
+
+	printf("token_info  %s", mntent->mnt_dir);
+
+	printf("\n\tallowed_cmds:");
+	value = get_delegate_value(mntent->mnt_opts, "delegate_cmds");
+	print_items_per_line(value, ITEMS_PER_LINE);
+
+	printf("\n\tallowed_maps:");
+	value = get_delegate_value(mntent->mnt_opts, "delegate_maps");
+	print_items_per_line(value, ITEMS_PER_LINE);
+
+	printf("\n\tallowed_progs:");
+	value = get_delegate_value(mntent->mnt_opts, "delegate_progs");
+	print_items_per_line(value, ITEMS_PER_LINE);
+
+	printf("\n\tallowed_attachs:");
+	value = get_delegate_value(mntent->mnt_opts, "delegate_attachs");
+	print_items_per_line(value, ITEMS_PER_LINE);
+	printf("\n");
+}
+
+static void split_json_array_str(const char *input)
+{
+	char *str, *rest, *strs;
+
+	if (!input) {
+		jsonw_start_array(json_wtr);
+		jsonw_end_array(json_wtr);
+		return;
+	}
+
+	strs = strdup(input);
+	if (!strs)
+		return;
+
+	jsonw_start_array(json_wtr);
+	for (str = strtok_r(strs, ":", &rest); str;
+			str = strtok_r(NULL, ":", &rest)) {
+		jsonw_string(json_wtr, str);
+	}
+	jsonw_end_array(json_wtr);
+
+	free(strs);
+}
+
+static void show_token_info_json(struct mntent *mntent)
+{
+	char *value;
+
+	jsonw_start_object(json_wtr);
+
+	jsonw_string_field(json_wtr, "token_info", mntent->mnt_dir);
+
+	jsonw_name(json_wtr, "allowed_cmds");
+	value = get_delegate_value(mntent->mnt_opts, "delegate_cmds");
+	split_json_array_str(value);
+
+	jsonw_name(json_wtr, "allowed_maps");
+	value = get_delegate_value(mntent->mnt_opts, "delegate_maps");
+	split_json_array_str(value);
+
+	jsonw_name(json_wtr, "allowed_progs");
+	value = get_delegate_value(mntent->mnt_opts, "delegate_progs");
+	split_json_array_str(value);
+
+	jsonw_name(json_wtr, "allowed_attachs");
+	value = get_delegate_value(mntent->mnt_opts, "delegate_attachs");
+	split_json_array_str(value);
+
+	jsonw_end_object(json_wtr);
+}
+
+static int __show_token_info(struct mntent *mntent)
+{
+	if (json_output)
+		show_token_info_json(mntent);
+	else
+		show_token_info_plain(mntent);
+
+	return 0;
+}
+
+static int show_token_info(void)
+{
+	FILE *fp;
+	struct mntent *ent;
+
+	fp = setmntent(MOUNTS_FILE, "r");
+	if (!fp) {
+		p_err("Failed to open: %s", MOUNTS_FILE);
+		return -1;
+	}
+
+	if (json_output)
+		jsonw_start_array(json_wtr);
+
+	while ((ent = getmntent(fp)) != NULL) {
+		if (strncmp(ent->mnt_type, "bpf", 3) == 0) {
+			if (has_delegate_options(ent->mnt_opts))
+				__show_token_info(ent);
+		}
+	}
+
+	if (json_output)
+		jsonw_end_array(json_wtr);
+
+	endmntent(fp);
+
+	return 0;
+}
+
+static int do_show(int argc, char **argv)
+{
+	if (argc)
+		return BAD_ARG();
+
+	return show_token_info();
+}
+
+static int do_help(int argc, char **argv)
+{
+	if (json_output) {
+		jsonw_null(json_wtr);
+		return 0;
+	}
+
+	fprintf(stderr,
+		"Usage: %1$s %2$s { show | list }\n"
+		"       %1$s %2$s help\n"
+		"\n"
+		"",
+		bin_name, argv[-2]);
+	return 0;
+}
+
+static const struct cmd cmds[] = {
+	{ "show",	do_show },
+	{ "list",	do_show },
+	{ "help",	do_help },
+	{ 0 }
+};
+
+int do_token(int argc, char **argv)
+{
+	return cmd_select(cmds, argc, argv, do_help);
+}
Signature · 2 lines
Best Regards
Tao Chen
#4 lore raw
Quoted 4 lines · Tao Chen

在 2025/7/23 22:44, Tao Chen 写道:

Ping...

5 days in a queue is not a lot. Pls don't ping it again. Especially during the merge window.

#5 lore raw
In reply to Tao Chen
This series was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:

Hello:

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

Quoted 21 lines · On Wed, 23 Jul 2025 22:44:40 +0800 you wrote:

Add bpftool token show command to get token info from bpffs in /proc/mounts.

Example plain output for token show:
token_info /sys/fs/bpf/token
allowed_cmds:
map_create prog_load
allowed_maps:
allowed_progs:
kprobe
allowed_attachs:
xdp
token_info /sys/fs/bpf/token2
allowed_cmds:
map_create prog_load
allowed_maps:
allowed_progs:
kprobe
allowed_attachs:
xdp

Quoted 1 line

[...]

Here is the summary with links:
- [bpf-next,v4,1/3] bpftool: Add bpf_token show

    https://git.kernel.org/bpf/bpf-next/c/2d812311c2b2
  - [bpf-next,v4,2/3] bpftool: Add bpftool-token manpage
    https://git.kernel.org/bpf/bpf-next/c/b7f640084916
  - [bpf-next,v4,3/3] bpftool: Add bash completion for token argument
    https://git.kernel.org/bpf/bpf-next/c/f3af62b6cee8

You are awesome, thank you!

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

A message that is not in the archive (sent off-list or not yet received): [email protected]

#7 lore raw
Quoted 29 lines · Chris Mason

On Wed, 23 Jul 2025 22:44:40 +0800 Tao Chen <[email protected]> wrote:

[ ... ]

Quoted 6 lines
tools/bpf/bpftool/token.c new file +0 -0
new file mode 100644
index 00000000000..6312e662a12
@@ -0,0 +1,225 @@

[ ... ]

Quoted 15 lines
tools/bpf/bpftool/token.c new file +15 -0
+
+static char *get_delegate_value(const char *opts, const char *key)
+{
+     char *token, *rest, *ret = NULL;
+     char *opts_copy = strdup(opts);
+
+     if (!opts_copy)
+             return NULL;
+
+     for (token = strtok_r(opts_copy, ",", &rest); token;
+                     token = strtok_r(NULL, ",", &rest)) {
+             if (strncmp(token, key, strlen(key)) == 0 &&
+                 token[strlen(key)] == '=') {
+                     ret = token + strlen(key) + 1;
+                     break;
Quoted 8 lines

tools/bpf/bpftool/token.c line 49

Quoted 5 lines
tools/bpf/bpftool/token.c new file +5 -0
+             }
+     }
+     free(opts_copy);
+
+     return ret;

The ret pointer is pointing inside opts_copy, but opts_copy gets freed before returning?

Thanks for the bug report, Chris!

Tao, the fix probably should be something along the lines of:

ret = token + strlen(key) + 1 - opts_copy + opts;

to translate that pointer back into the original string? Can you please send a patch?

Quoted 2 lines

-chris

author
#8 lore raw

在 2025/9/16 00:21, Andrii Nakryiko 写道:

Hi Andrii, Chris,

Quoted 39 lines · Chris Mason
Quoted 29 lines · On Wed, 23 Jul 2025 22:44:40 +0800 Tao Chen <[email protected]> wrote:

[ ... ]

Quoted 6 lines
tools/bpf/bpftool/token.c new file +0 -0
new file mode 100644
index 00000000000..6312e662a12
@@ -0,0 +1,225 @@

[ ... ]

Quoted 15 lines
tools/bpf/bpftool/token.c new file +15 -0
+
+static char *get_delegate_value(const char *opts, const char *key)
+{
+     char *token, *rest, *ret = NULL;
+     char *opts_copy = strdup(opts);
+
+     if (!opts_copy)
+             return NULL;
+
+     for (token = strtok_r(opts_copy, ",", &rest); token;
+                     token = strtok_r(NULL, ",", &rest)) {
+             if (strncmp(token, key, strlen(key)) == 0 &&
+                 token[strlen(key)] == '=') {
+                     ret = token + strlen(key) + 1;
+                     break;
Quoted 8 lines

tools/bpf/bpftool/token.c line 49

Quoted 5 lines
tools/bpf/bpftool/token.c new file +5 -0
+             }
+     }
+     free(opts_copy);
+
+     return ret;

The ret pointer is pointing inside opts_copy, but opts_copy gets freed before returning?

Quoted 9 lines

Thanks for the bug report, Chris!

Tao, the fix probably should be something along the lines of:

ret = token + strlen(key) + 1 - opts_copy + opts;

to translate that pointer back into the original string? Can you please send a patch?

Of course, i will fix it, thanks for the bug report.

Quoted 2 lines
Quoted 2 lines

-chris

Signature · 2 lines
Best Regards
Tao Chen