tools: bpftool: make -d option print debug output from verifier

The "-d" option is used to require all logs available for bpftool. So
far it meant telling libbpf to print even debug-level information. But
there is another source of info that can be made more verbose: when we
attemt to load programs with bpftool, we can pass a log_level parameter
to the verifier in order to control the amount of information that is
printed to the console.

Reuse the "-d" option to print all information the verifier can tell. At
this time, this means logs related to BPF_LOG_LEVEL1, BPF_LOG_LEVEL2 and
BPF_LOG_STATS. As mentioned in the discussion on the first version of
this set, these macros are internal to the kernel
(include/linux/bpf_verifier.h) and are not meant to be part of the
stable user API, therefore we simply use the related constants to print
whatever we can at this time, without trying to tell users what is
log_level1 or what is statistics.

Verifier logs are only used when loading programs for now (In the
future: for loading BTF objects with bpftool? Although libbpf does not
currently offer to print verifier info at debug level if no error
occurred when loading BTF objects), so bpftool.rst and bpftool-prog.rst
are the only man pages to get the update.

v3:
- Add details on log level and BTF loading at the end of commit log.

v2:
- Remove the possibility to select the log levels to use (v1 offered a
  combination of "log_level1", "log_level2" and "stats").
- The macros from kernel header bpf_verifier.h are not used (and
  therefore not moved to UAPI header).
- In v1 this was a distinct option, but is now merged in the only "-d"
  switch to activate libbpf and verifier debug-level logs all at the
  same time.

Signed-off-by: Quentin Monnet <quentin.monnet@netronome.com>
Reviewed-by: Jakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>

diff --git a/tools/bpf/bpftool/Documentation/bpftool-prog.rst b/tools/bpf/bpftool/Documentation/bpftool-prog.rst
index 9a92614569e645bd66e5e26f1548f3d2b8935e83..228a5c863cc7522b4f2308967e15d08316de4421 100644 (file)
--- a/tools/bpf/bpftool/Documentation/bpftool-prog.rst
+++ b/tools/bpf/bpftool/Documentation/bpftool-prog.rst
@@ -175,8 +175,9 @@ OPTIONS
                  (such as tracefs or BPF virtual file system) when necessary.
 
        -d, --debug
-                 Print all logs available from libbpf, including debug-level
-                 information.
+                 Print all logs available, even debug-level information. This
+                 includes logs from libbpf as well as from the verifier, when
+                 attempting to load programs.
 
 EXAMPLES
 ========

diff --git a/tools/bpf/bpftool/Documentation/bpftool.rst b/tools/bpf/bpftool/Documentation/bpftool.rst
index 43dba0717953460877adcdab760075795f1ce57d..6a9c52ef84a9e1c85c820ee69c4c73a7c78f9f47 100644 (file)
--- a/tools/bpf/bpftool/Documentation/bpftool.rst
+++ b/tools/bpf/bpftool/Documentation/bpftool.rst
@@ -67,8 +67,9 @@ OPTIONS
                  (such as tracefs or BPF virtual file system) when necessary.
 
        -d, --debug
-                 Print all logs available from libbpf, including debug-level
-                 information.
+                 Print all logs available, even debug-level information. This
+                 includes logs from libbpf as well as from the verifier, when
+                 attempting to load programs.
 
 SEE ALSO
 ========

diff --git a/tools/bpf/bpftool/main.c b/tools/bpf/bpftool/main.c
index d74293938a05ce617fb16b292ea8eb99785a872d..4879f6395c7e2d01398551a7ce6be4d675d201a9 100644 (file)
--- a/tools/bpf/bpftool/main.c
+++ b/tools/bpf/bpftool/main.c
@@ -26,6 +26,7 @@ bool pretty_output;
 bool json_output;
 bool show_pinned;
 bool block_mount;
+bool verifier_logs;
 int bpf_flags;
 struct pinned_obj_table prog_table;
 struct pinned_obj_table map_table;
@@ -373,6 +374,7 @@ int main(int argc, char **argv)
                        break;
                case 'd':
                        libbpf_set_print(print_all_levels);
+                       verifier_logs = true;
                        break;
                default:
                        p_err("unrecognized option '%s'", argv[optind - 1]);

diff --git a/tools/bpf/bpftool/main.h b/tools/bpf/bpftool/main.h
index 3d63feb7f852fb8cb9a23a5b6b51b25d860ffceb..28a2a5857e141ec3fa5ceece0257d59b62e58a7f 100644 (file)
--- a/tools/bpf/bpftool/main.h
+++ b/tools/bpf/bpftool/main.h
@@ -91,6 +91,7 @@ extern json_writer_t *json_wtr;
 extern bool json_output;
 extern bool show_pinned;
 extern bool block_mount;
+extern bool verifier_logs;
 extern int bpf_flags;
 extern struct pinned_obj_table prog_table;
 extern struct pinned_obj_table map_table;

diff --git a/tools/bpf/bpftool/prog.c b/tools/bpf/bpftool/prog.c
index 26336bad0442734d6a56fd94243c6412f9adca4f..1f209c80d906e63230e844a60b2d451521cad8c8 100644 (file)
--- a/tools/bpf/bpftool/prog.c
+++ b/tools/bpf/bpftool/prog.c
@@ -750,10 +750,11 @@ static int do_detach(int argc, char **argv)
 
 static int load_with_options(int argc, char **argv, bool first_prog_only)
 {
-       enum bpf_attach_type expected_attach_type;
-       struct bpf_object_open_attr attr = {
-               .prog_type      = BPF_PROG_TYPE_UNSPEC,
+       struct bpf_object_load_attr load_attr = { 0 };
+       struct bpf_object_open_attr open_attr = {
+               .prog_type = BPF_PROG_TYPE_UNSPEC,
        };
+       enum bpf_attach_type expected_attach_type;
        struct map_replace *map_replace = NULL;
        struct bpf_program *prog = NULL, *pos;
        unsigned int old_map_fds = 0;
@@ -767,7 +768,7 @@ static int load_with_options(int argc, char **argv, bool first_prog_only)
 
        if (!REQ_ARGS(2))
                return -1;
-       attr.file = GET_ARG();
+       open_attr.file = GET_ARG();
        pinfile = GET_ARG();
 
        while (argc) {
@@ -776,7 +777,7 @@ static int load_with_options(int argc, char **argv, bool first_prog_only)
 
                        NEXT_ARG();
 
-                       if (attr.prog_type != BPF_PROG_TYPE_UNSPEC) {
+                       if (open_attr.prog_type != BPF_PROG_TYPE_UNSPEC) {
                                p_err("program type already specified");
                                goto err_free_reuse_maps;
                        }
@@ -793,7 +794,8 @@ static int load_with_options(int argc, char **argv, bool first_prog_only)
                        strcat(type, *argv);
                        strcat(type, "/");
 
-                       err = libbpf_prog_type_by_name(type, &attr.prog_type,
+                       err = libbpf_prog_type_by_name(type,
+                                                      &open_attr.prog_type,
                                                       &expected_attach_type);
                        free(type);
                        if (err < 0)
@@ -881,16 +883,16 @@ static int load_with_options(int argc, char **argv, bool first_prog_only)
 
        set_max_rlimit();
 
-       obj = __bpf_object__open_xattr(&attr, bpf_flags);
+       obj = __bpf_object__open_xattr(&open_attr, bpf_flags);
        if (IS_ERR_OR_NULL(obj)) {
                p_err("failed to open object file");
                goto err_free_reuse_maps;
        }
 
        bpf_object__for_each_program(pos, obj) {
-               enum bpf_prog_type prog_type = attr.prog_type;
+               enum bpf_prog_type prog_type = open_attr.prog_type;
 
-               if (attr.prog_type == BPF_PROG_TYPE_UNSPEC) {
+               if (open_attr.prog_type == BPF_PROG_TYPE_UNSPEC) {
                        const char *sec_name = bpf_program__title(pos, false);
 
                        err = libbpf_prog_type_by_name(sec_name, &prog_type,
@@ -960,7 +962,12 @@ static int load_with_options(int argc, char **argv, bool first_prog_only)
                goto err_close_obj;
        }
 
-       err = bpf_object__load(obj);
+       load_attr.obj = obj;
+       if (verifier_logs)
+               /* log_level1 + log_level2 + stats, but not stable UAPI */
+               load_attr.log_level = 1 + 2 + 4;
+
+       err = bpf_object__load_xattr(&load_attr);
        if (err) {
                p_err("failed to load object file");
                goto err_close_obj;