Skip to contentSkip to conversation

libbpf: fix libbpf_print

PATCH In review Stanislav Fomichev 3 participants 4 messages Feb 5, 2019

Subsystems (7)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 libbpf: fix libbpf_print

With the recent print rework we now have the following problem:
pr_{warning,info,debug} expand to __pr which calls libbpf_print. libbpf_print does va_start and calls __libbpf_pr with va_list argument. In __base_pr we again do va_start. Because the next argument is a va_list, we don't get correct pointer to the argument (and print noting in my case, I don't know why it doesn't crash tbh).

Fix this by changing libbpf_print_fn_t signature to accept va_list and remove unneeded calls to va_start in the existing users.

Alternatively, this can we solved by exporting __libbpf_pr and changing __pr macro to (and killing libbpf_print):

{
	if (__libbpf_pr)
		__libbpf_pr(level, "libbpf: " fmt, ##__VA_ARGS__)
}
---
 tools/lib/bpf/libbpf.c                         | 14 ++++----------
 tools/lib/bpf/libbpf.h                         |  3 +--
 tools/perf/util/bpf-loader.c                   | 10 ++--------
 tools/testing/selftests/bpf/test_btf.c         | 13 ++-----------
 tools/testing/selftests/bpf/test_libbpf_open.c | 10 ++--------
 tools/testing/selftests/bpf/test_progs.c       | 10 ++--------
 6 files changed, 13 insertions(+), 47 deletions(-)
tools/lib/bpf/libbpf.c +4 -10
index 84ca6c2bea91..47969aa0faf8 100644
@@ -54,22 +54,16 @@
 
 #define __printf(a, b)	__attribute__((format(printf, a, b)))
 
-__printf(2, 3)
-static int __base_pr(enum libbpf_print_level level, const char *format, ...)
+static int __base_pr(enum libbpf_print_level level, const char *format,
+		     va_list args)
 {
-	va_list args;
-	int err;
-
 	if (level == LIBBPF_DEBUG)
 		return 0;
 
-	va_start(args, format);
-	err = vfprintf(stderr, format, args);
-	va_end(args);
-	return err;
+	return vfprintf(stderr, format, args);
 }
 
-static __printf(2, 3) libbpf_print_fn_t __libbpf_pr = __base_pr;
+static libbpf_print_fn_t __libbpf_pr = __base_pr;
 
 void libbpf_set_print(libbpf_print_fn_t fn)
 {
tools/lib/bpf/libbpf.h +1 -2
index 19dbc1bed960..69a7c25eaccc 100644
@@ -54,8 +54,7 @@ enum libbpf_print_level {
 };
 
 typedef int (*libbpf_print_fn_t)(enum libbpf_print_level level,
-				 const char *, ...)
-	__attribute__((format(printf, 2, 3)));
+				 const char *, va_list ap);
 
 LIBBPF_API void libbpf_set_print(libbpf_print_fn_t fn);
 
tools/perf/util/bpf-loader.c +2 -8
index 38afdbe6a9e0..037d8ff6a634 100644
@@ -25,15 +25,9 @@
 #include "c++/clang-c.h"
 
 static int libbpf_perf_print(enum libbpf_print_level level __attribute__((unused)),
-			      const char *fmt, ...)
+			      const char *fmt, va_list args)
 {
-	va_list args;
-	int ret;
-
-	va_start(args, fmt);
-	ret = veprintf(1, verbose, pr_fmt(fmt), args);
-	va_end(args);
-	return ret;
+	return veprintf(1, verbose, pr_fmt(fmt), args);
 }
 
 struct bpf_prog_priv {
tools/testing/selftests/bpf/test_btf.c +2 -11
index aebaeff5a5a0..5afab823ffbe 100644
@@ -52,19 +52,10 @@ static int count_result(int err)
 	return err;
 }
 
-#define __printf(a, b)	__attribute__((format(printf, a, b)))
-
-__printf(2, 3)
 static int __base_pr(enum libbpf_print_level level __attribute__((unused)),
-		     const char *format, ...)
+		     const char *format, va_list args)
 {
-	va_list args;
-	int err;
-
-	va_start(args, format);
-	err = vfprintf(stderr, format, args);
-	va_end(args);
-	return err;
+	return vfprintf(stderr, format, args);
 }
 
 #define BTF_INFO_ENC(kind, kind_flag, vlen)			\
tools/testing/selftests/bpf/test_libbpf_open.c +2 -8
index b9ff3bf76544..1909ecf4d999 100644
@@ -36,19 +36,13 @@ static void usage(char *argv[])
 
 static bool debug = 0;
 static int libbpf_debug_print(enum libbpf_print_level level,
-			      const char *fmt, ...)
+			      const char *fmt, va_list args)
 {
-	va_list args;
-	int ret;
-
 	if (level == LIBBPF_DEBUG && !debug)
 		return 0;
 
-	va_start(args, fmt);
 	fprintf(stderr, "[%d] ", level);
-	ret = vfprintf(stderr, fmt, args);
-	va_end(args);
-	return ret;
+	return vfprintf(stderr, fmt, args);
 }
 
 #define EXIT_FAIL_LIBBPF EXIT_FAILURE
tools/testing/selftests/bpf/test_progs.c +2 -8
index 55d05102e7bf..c52bd90fbb34 100644
@@ -1785,18 +1785,12 @@ static void test_task_fd_query_tp(void)
 }
 
 static int libbpf_debug_print(enum libbpf_print_level level,
-			      const char *format, ...)
+			      const char *format, va_list args)
 {
-	va_list args;
-	int ret;
-
 	if (level == LIBBPF_DEBUG)
 		return 0;
 
-	va_start(args, format);
-	ret = vfprintf(stderr, format, args);
-	va_end(args);
-	return ret;
+	return vfprintf(stderr, format, args);
 }
 
 static void test_reference_tracking()
Signature · 1 line
2.20.1.611.gfbb209baf1-goog
Acked-by on v1 1/1
#1 lore raw
Quoted 10 lines · Stanislav Fomichev

With the recent print rework we now have the following problem:
pr_{warning,info,debug} expand to __pr which calls libbpf_print. libbpf_print does va_start and calls __libbpf_pr with va_list argument. In __base_pr we again do va_start. Because the next argument is a va_list, we don't get correct pointer to the argument (and print noting in my case, I don't know why it doesn't crash tbh).

Fix this by changing libbpf_print_fn_t signature to accept va_list and remove unneeded calls to va_start in the existing users.

Quoted 8 lines

Alternatively, this can we solved by exporting __libbpf_pr and changing __pr macro to (and killing libbpf_print):

{
	if (__libbpf_pr)
		__libbpf_pr(level, "libbpf: " fmt, ##__VA_ARGS__)
}

It is my mistake. My early version did passed correctly and later on I made some changes and did not test properly. Thanks for the fix!

Quoted 154 lines
---
  tools/lib/bpf/libbpf.c                         | 14 ++++----------
  tools/lib/bpf/libbpf.h                         |  3 +--
  tools/perf/util/bpf-loader.c                   | 10 ++--------
  tools/testing/selftests/bpf/test_btf.c         | 13 ++-----------
  tools/testing/selftests/bpf/test_libbpf_open.c | 10 ++--------
  tools/testing/selftests/bpf/test_progs.c       | 10 ++--------
  6 files changed, 13 insertions(+), 47 deletions(-)
tools/lib/bpf/libbpf.c +4 -10
index 84ca6c2bea91..47969aa0faf8 100644
@@ -54,22 +54,16 @@
 
  #define __printf(a, b)	__attribute__((format(printf, a, b)))
 
-__printf(2, 3)
-static int __base_pr(enum libbpf_print_level level, const char *format, ...)
+static int __base_pr(enum libbpf_print_level level, const char *format,
+		     va_list args)
  {
-	va_list args;
-	int err;
-
  	if (level == LIBBPF_DEBUG)
  		return 0;
 
-	va_start(args, format);
-	err = vfprintf(stderr, format, args);
-	va_end(args);
-	return err;
+	return vfprintf(stderr, format, args);
  }
 
-static __printf(2, 3) libbpf_print_fn_t __libbpf_pr = __base_pr;
+static libbpf_print_fn_t __libbpf_pr = __base_pr;
 
  void libbpf_set_print(libbpf_print_fn_t fn)
  {
tools/lib/bpf/libbpf.h +1 -2
index 19dbc1bed960..69a7c25eaccc 100644
@@ -54,8 +54,7 @@ enum libbpf_print_level {
  };
 
  typedef int (*libbpf_print_fn_t)(enum libbpf_print_level level,
-				 const char *, ...)
-	__attribute__((format(printf, 2, 3)));
+				 const char *, va_list ap);
 
  LIBBPF_API void libbpf_set_print(libbpf_print_fn_t fn);
 
tools/perf/util/bpf-loader.c +2 -8
index 38afdbe6a9e0..037d8ff6a634 100644
@@ -25,15 +25,9 @@
  #include "c++/clang-c.h"
 
  static int libbpf_perf_print(enum libbpf_print_level level __attribute__((unused)),
-			      const char *fmt, ...)
+			      const char *fmt, va_list args)
  {
-	va_list args;
-	int ret;
-
-	va_start(args, fmt);
-	ret = veprintf(1, verbose, pr_fmt(fmt), args);
-	va_end(args);
-	return ret;
+	return veprintf(1, verbose, pr_fmt(fmt), args);
  }
 
  struct bpf_prog_priv {
tools/testing/selftests/bpf/test_btf.c +2 -11
index aebaeff5a5a0..5afab823ffbe 100644
@@ -52,19 +52,10 @@ static int count_result(int err)
  	return err;
  }
 
-#define __printf(a, b)	__attribute__((format(printf, a, b)))
-
-__printf(2, 3)
  static int __base_pr(enum libbpf_print_level level __attribute__((unused)),
-		     const char *format, ...)
+		     const char *format, va_list args)
  {
-	va_list args;
-	int err;
-
-	va_start(args, format);
-	err = vfprintf(stderr, format, args);
-	va_end(args);
-	return err;
+	return vfprintf(stderr, format, args);
  }
 
  #define BTF_INFO_ENC(kind, kind_flag, vlen)			\
tools/testing/selftests/bpf/test_libbpf_open.c +2 -8
index b9ff3bf76544..1909ecf4d999 100644
@@ -36,19 +36,13 @@ static void usage(char *argv[])
 
  static bool debug = 0;
  static int libbpf_debug_print(enum libbpf_print_level level,
-			      const char *fmt, ...)
+			      const char *fmt, va_list args)
  {
-	va_list args;
-	int ret;
-
  	if (level == LIBBPF_DEBUG && !debug)
  		return 0;
 
-	va_start(args, fmt);
  	fprintf(stderr, "[%d] ", level);
-	ret = vfprintf(stderr, fmt, args);
-	va_end(args);
-	return ret;
+	return vfprintf(stderr, fmt, args);
  }
 
  #define EXIT_FAIL_LIBBPF EXIT_FAILURE
tools/testing/selftests/bpf/test_progs.c +2 -8
index 55d05102e7bf..c52bd90fbb34 100644
@@ -1785,18 +1785,12 @@ static void test_task_fd_query_tp(void)
  }
 
  static int libbpf_debug_print(enum libbpf_print_level level,
-			      const char *format, ...)
+			      const char *format, va_list args)
  {
-	va_list args;
-	int ret;
-
  	if (level == LIBBPF_DEBUG)
  		return 0;
 
-	va_start(args, format);
-	ret = vfprintf(stderr, format, args);
-	va_end(args);
-	return ret;
+	return vfprintf(stderr, format, args);
  }
 
  static void test_reference_tracking()
#2 lore raw
Quoted 20 lines · Yonghong Song
Quoted 17 lines · Stanislav Fomichev

With the recent print rework we now have the following problem:
pr_{warning,info,debug} expand to __pr which calls libbpf_print. libbpf_print does va_start and calls __libbpf_pr with va_list argument. In __base_pr we again do va_start. Because the next argument is a va_list, we don't get correct pointer to the argument (and print noting in my case, I don't know why it doesn't crash tbh).

Fix this by changing libbpf_print_fn_t signature to accept va_list and remove unneeded calls to va_start in the existing users.

Alternatively, this can we solved by exporting __libbpf_pr and changing __pr macro to (and killing libbpf_print):

{
	if (__libbpf_pr)
		__libbpf_pr(level, "libbpf: " fmt, ##__VA_ARGS__)
}
Quoted 6 lines
Quoted 1 line

It is my mistake. My early version did passed correctly and later on I made some changes and did not test properly. Thanks for the fix!

argh.
Applied. Thanks for the fix.
Yonghong, how was the earlier patch set tested? It sounds that nothing should have worked. How perf changes were tested?

#3 lore raw
Quoted 23 lines · Alexei Starovoitov
Quoted 22 lines · Yonghong Song
Quoted 18 lines · Stanislav Fomichev

With the recent print rework we now have the following problem:
pr_{warning,info,debug} expand to __pr which calls libbpf_print. libbpf_print does va_start and calls __libbpf_pr with va_list argument. In __base_pr we again do va_start. Because the next argument is a va_list, we don't get correct pointer to the argument (and print noting in my case, I don't know why it doesn't crash tbh).

Fix this by changing libbpf_print_fn_t signature to accept va_list and remove unneeded calls to va_start in the existing users.

Alternatively, this can we solved by exporting __libbpf_pr and changing __pr macro to (and killing libbpf_print):

{
	if (__libbpf_pr)
		__libbpf_pr(level, "libbpf: " fmt, ##__VA_ARGS__)
}
Quoted 8 lines
Quoted 4 lines

It is my mistake. My early version did passed correctly and later on I made some changes and did not test properly. Thanks for the fix!

argh.
Applied. Thanks for the fix.
Yonghong, how was the earlier patch set tested?

Before the global function patch set, I have a global variable version, which I tested and worked. Later on when changing to global libbpf_print approach, I tested it through test_btf. That is why I found a missing check for LIBBPF_DEBUG level in default __base_pr. But I have to admit that I probably did not pay attention to contents somehow so I missed the garbled output.

Quoted 2 lines

It sounds that nothing should have worked.
How perf changes were tested?

I only tested compilation. The context is similar to a few other bpf selftests programs and I assume with similar implementation, the result should be similar. But really badly, they are all incorrect :-(