Commit 8918dc42 authored by Quentin Monnet's avatar Quentin Monnet Committed by Alexei Starovoitov
Browse files

tools: bpftool: move "__printf()" attributes to header file 



Some functions in bpftool have a "__printf()" format attributes to tell
the compiler they should expect printf()-like arguments. But because
these attributes are not used for the function prototypes in the header
files, the compiler does not run the checks everywhere the functions are
used, and some mistakes on format string and corresponding arguments
slipped in over time.

Let's move the __printf() attributes to the correct places.

Note: We add guards around the definition of GCC_VERSION in
tools/include/linux/compiler-gcc.h to prevent a conflict in jit_disasm.c
on GCC_VERSION from headers pulled via libbfd.

Fixes: c101189b ("tools: bpftool: fix -Wmissing declaration warnings")
Reported-by: default avatarJakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: default avatarQuentin Monnet <quentin.monnet@netronome.com>
Reviewed-by: default avatarJakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: default avatarAlexei Starovoitov <ast@kernel.org>
parent b0ead6d7

tools/bpf/bpftool/common.c

+2 −2
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ 
#define BPF_FS_MAGIC		0xcafe4a11

#endif



void __printf(1, 2) p_err(const char *fmt, ...)

void p_err(const char *fmt, ...)

{

	va_list ap;
@@ -47,7 +47,7 @@ void __printf(1, 2) p_err(const char *fmt, ...) 
	va_end(ap);

}



void __printf(1, 2) p_info(const char *fmt, ...)

void p_info(const char *fmt, ...)

{

	va_list ap;

tools/bpf/bpftool/json_writer.c

+2 −4
Original line number Diff line number Diff line
@@ -15,7 +15,6 @@ 
#include <malloc.h>

#include <inttypes.h>

#include <stdint.h>

#include <linux/compiler.h>



#include "json_writer.h"
@@ -153,8 +152,7 @@ void jsonw_name(json_writer_t *self, const char *name) 
		putc(' ', self->out);

}



void __printf(2, 0)

jsonw_vprintf_enquote(json_writer_t *self, const char *fmt, va_list ap)

void jsonw_vprintf_enquote(json_writer_t *self, const char *fmt, va_list ap)

{

	jsonw_eor(self);

	putc('"', self->out);
@@ -162,7 +160,7 @@ jsonw_vprintf_enquote(json_writer_t *self, const char *fmt, va_list ap) 
	putc('"', self->out);

}



void __printf(2, 3) jsonw_printf(json_writer_t *self, const char *fmt, ...)

void jsonw_printf(json_writer_t *self, const char *fmt, ...)

{

	va_list ap;

tools/bpf/bpftool/json_writer.h

+4 −2
Original line number Diff line number Diff line
@@ -14,6 +14,7 @@ 
#include <stdbool.h>

#include <stdint.h>

#include <stdarg.h>

#include <linux/compiler.h>



/* Opaque class structure */

typedef struct json_writer json_writer_t;
@@ -30,8 +31,9 @@ void jsonw_pretty(json_writer_t *self, bool on); 
void jsonw_name(json_writer_t *self, const char *name);



/* Add value  */

void jsonw_vprintf_enquote(json_writer_t *self, const char *fmt, va_list ap);

void jsonw_printf(json_writer_t *self, const char *fmt, ...);

void __printf(2, 0) jsonw_vprintf_enquote(json_writer_t *self, const char *fmt,

					  va_list ap);

void __printf(2, 3) jsonw_printf(json_writer_t *self, const char *fmt, ...);

void jsonw_string(json_writer_t *self, const char *value);

void jsonw_bool(json_writer_t *self, bool value);

void jsonw_float(json_writer_t *self, double number);

tools/bpf/bpftool/main.h

+2 −2
Original line number Diff line number Diff line
@@ -98,8 +98,8 @@ extern int bpf_flags; 
extern struct pinned_obj_table prog_table;

extern struct pinned_obj_table map_table;



void p_err(const char *fmt, ...);

void p_info(const char *fmt, ...);

void __printf(1, 2) p_err(const char *fmt, ...);

void __printf(1, 2) p_info(const char *fmt, ...);



bool is_prefix(const char *pfx, const char *str);

int detect_common_prefix(const char *arg, ...);

tools/include/linux/compiler-gcc.h

+2 −0
Original line number Diff line number Diff line
@@ -6,9 +6,11 @@ 
/*

 * Common definitions for all gcc versions go here.

 */

#ifndef GCC_VERSION

#define GCC_VERSION (__GNUC__ * 10000		\

		     + __GNUC_MINOR__ * 100	\

		     + __GNUC_PATCHLEVEL__)

#endif



#if GCC_VERSION >= 70000 && !defined(__CHECKER__)

# define __fallthrough __attribute__ ((fallthrough))

CRA Git | Maintained and supported by SUSTech CRA and CCSE