Commit e57f52b4 authored by Alexei Starovoitov's avatar Alexei Starovoitov
Browse files

Merge branch 'bpf: implement variadic printk helper' 

Dave Marchevsky says:

====================

This series introduces a new helper, bpf_trace_vprintk, which functions
like bpf_trace_printk but supports > 3 arguments via a pseudo-vararg u64
array. The bpf_printk libbpf convenience macro is modified to use
bpf_trace_vprintk when > 3 varargs are passed, otherwise the previous
behavior - using bpf_trace_printk - is retained.

Helper functions and macros added during the implementation of
bpf_seq_printf and bpf_snprintf do most of the heavy lifting for
bpf_trace_vprintk. There's no novel format string wrangling here.

Usecase here is straightforward: Giving BPF program writers a more
powerful printk will ease development of BPF programs, particularly
during debugging and testing, where printk tends to be used.

This feature was proposed by Andrii in libbpf mirror's issue tracker
[1].

[1] https://github.com/libbpf/libbpf/issues/315



v5 -> v6: Rebase to pick up newly-added helper

v4 -> v5:

* patch 8: added test for "%pS" format string w/ NULL fmt arg [Daniel]
* patch 8: dmesg -> /sys/kernel/debug/tracing/trace_pipe in commit message [Andrii]
* patch 9: squash into patch 8, remove the added test in favor of just bpf_printk'ing in patch 8's test [Andrii]
    * migrate comment to /* */
* header comments improved$
    * uapi/linux/bpf.h: u64 -> long return type [Daniel]
    * uapi/linux/bpf.h: function description explains benefit of bpf_trace_vprintk over bpf_trace_printk [Daniel]
    * uapi/linux/bpf.h: added patch explaining that data_len should be a multiple of 8 in bpf_seq_printf, bpf_snprintf descriptions [Daniel]
    * tools/lib/bpf/bpf_helpers.h: move comment to new bpf_printk [Andrii]
* rebase

v3 -> v4:
* Add patch 2, which migrates reference_tracking prog_test away from
  bpf_program__load. Could be placed a bit later in the series, but
  wanted to keep the actual vprintk-related patches contiguous
* Add patch 9, which adds a program w/ 0 fmt arg bpf_printk to vprintk
  test
* bpf_printk convenience macro isn't multiline anymore, so simplify [Andrii]
* Add some comments to ___bpf_pick_printk to make it more obvious when
  implementation switches from printk to vprintk [Andrii]
* BPF_PRINTK_FMT_TYPE -> BPF_PRINTK_FMT_MOD for 'static const' fmt string
  in printk wrapper macro [Andrii]
    * checkpatch.pl doesn't like this, says "Macros with complex values
      should be enclosed in parentheses". Strange that it didn't have similar
      complaints about v3's BPF_PRINTK_FMT_TYPE. Regardless, IMO the complaint
      is not highlighting a real issue in the case of this macro.
* Fix alignment of __bpf_vprintk and __bpf_pick_printk [Andrii]
* rebase

v2 -> v3:
* Clean up patch 3's commit message [Alexei]
* Add patch 4, which modifies __bpf_printk to use 'static const char' to
  store fmt string with fallback for older kernels [Andrii]
* rebase

v1 -> v2:

* Naming conversation seems to have gone in favor of keeping
  bpf_trace_vprintk, names are unchanged

* Patch 3 now modifies bpf_printk convenience macro to choose between
  __bpf_printk and __bpf_vprintk 'implementation' macros based on arg
  count. __bpf_vprintk is a renaming of bpf_vprintk convenience macro
  from v1, __bpf_printk is the existing bpf_printk implementation.

  This patch could use some scrutiny as I think current implementation
  may regress developer experience in a specific case, turning a
  compile-time error into a load-time error. Unclear to me how
  common the case is, or whether the macro magic I chose is ideal.

* char ___fmt[] to static const char ___fmt[] change was not done,
  wanted to leave __bpf_printk 'implementation' macro unchanged for v2
  to ease discussion of above point

* Removed __always_inline from __set_printk_clr_event [Andrii]
* Simplified bpf_trace_printk docstring to refer to other functions
  instead of copy/pasting and avoid specifying 12 vararg limit [Andrii]
* Migrated trace_printk selftest to use ASSERT_ instead of CHECK
  * Adds new patch 5, previous patch 5 is now 6
* Migrated trace_vprintk selftest to use ASSERT_ instead of CHECK,
  open_and_load instead of separate open, load [Andrii]
* Patch 2's commit message now correctly mentions trace_pipe instead of
  dmesg [Andrii]
====================

Signed-off-by: default avatarAlexei Starovoitov <ast@kernel.org>
parents af54faab a42effb0

include/linux/bpf.h

+3 −0
Original line number Diff line number Diff line
@@ -1088,6 +1088,7 @@ bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *f 
int bpf_prog_calc_tag(struct bpf_prog *fp);



const struct bpf_func_proto *bpf_get_trace_printk_proto(void);

const struct bpf_func_proto *bpf_get_trace_vprintk_proto(void);



typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,

					unsigned long off, unsigned long len);
@@ -2216,6 +2217,8 @@ int bpf_arch_text_poke(void *ip, enum bpf_text_poke_type t, 
struct btf_id_set;

bool btf_id_set_contains(const struct btf_id_set *set, u32 id);



#define MAX_BPRINTF_VARARGS		12



int bpf_bprintf_prepare(char *fmt, u32 fmt_size, const u64 *raw_args,

			u32 **bin_buf, u32 num_args);

void bpf_bprintf_cleanup(void);

include/uapi/linux/bpf.h

+14 −2
Original line number Diff line number Diff line
@@ -4046,7 +4046,7 @@ union bpf_attr { 
 * 		arguments. The *data* are a **u64** array and corresponding format string

 * 		values are stored in the array. For strings and pointers where pointees

 * 		are accessed, only the pointer values are stored in the *data* array.

 * 		The *data_len* is the size of *data* in bytes.

 * 		The *data_len* is the size of *data* in bytes - must be a multiple of 8.

 *

 *		Formats **%s**, **%p{i,I}{4,6}** requires to read kernel memory.

 *		Reading kernel memory may fail due to either invalid address or
@@ -4751,7 +4751,8 @@ union bpf_attr { 
 *		Each format specifier in **fmt** corresponds to one u64 element

 *		in the **data** array. For strings and pointers where pointees

 *		are accessed, only the pointer values are stored in the *data*

 *		array. The *data_len* is the size of *data* in bytes.

 *		array. The *data_len* is the size of *data* in bytes - must be

 *		a multiple of 8.

 *

 *		Formats **%s** and **%p{i,I}{4,6}** require to read kernel

 *		memory. Reading kernel memory may fail due to either invalid
@@ -4898,6 +4899,16 @@ union bpf_attr { 
 *		**-EINVAL** if *flags* is not zero.

 *

 *		**-ENOENT** if architecture does not support branch records.

 *

 * long bpf_trace_vprintk(const char *fmt, u32 fmt_size, const void *data, u32 data_len)

 *	Description

 *		Behaves like **bpf_trace_printk**\ () helper, but takes an array of u64

 *		to format and can handle more format args as a result.

 *

 *		Arguments are to be used as in **bpf_seq_printf**\ () helper.

 *	Return

 *		The number of bytes written to the buffer, or a negative error

 *		in case of failure.

 */

#define __BPF_FUNC_MAPPER(FN)		\

	FN(unspec),			\
@@ -5077,6 +5088,7 @@ union bpf_attr { 
	FN(get_attach_cookie),		\

	FN(task_pt_regs),		\

	FN(get_branch_snapshot),	\

	FN(trace_vprintk),		\

	/* */



/* integer value in 'imm' field of BPF_CALL instruction selects which helper

kernel/bpf/core.c

+5 −0
Original line number Diff line number Diff line
@@ -2357,6 +2357,11 @@ const struct bpf_func_proto * __weak bpf_get_trace_printk_proto(void) 
	return NULL;

}



const struct bpf_func_proto * __weak bpf_get_trace_vprintk_proto(void)

{

	return NULL;

}



u64 __weak

bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,

		 void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy)

kernel/bpf/helpers.c

+3 −3
Original line number Diff line number Diff line
@@ -979,15 +979,13 @@ int bpf_bprintf_prepare(char *fmt, u32 fmt_size, const u64 *raw_args, 
	return err;

}



#define MAX_SNPRINTF_VARARGS		12



BPF_CALL_5(bpf_snprintf, char *, str, u32, str_size, char *, fmt,

	   const void *, data, u32, data_len)

{

	int err, num_args;

	u32 *bin_args;



	if (data_len % 8 || data_len > MAX_SNPRINTF_VARARGS * 8 ||

	if (data_len % 8 || data_len > MAX_BPRINTF_VARARGS * 8 ||

	    (data_len && !data))

		return -EINVAL;

	num_args = data_len / 8;
@@ -1437,6 +1435,8 @@ bpf_base_func_proto(enum bpf_func_id func_id) 
		return &bpf_snprintf_proto;

	case BPF_FUNC_task_pt_regs:

		return &bpf_task_pt_regs_proto;

	case BPF_FUNC_trace_vprintk:

		return bpf_get_trace_vprintk_proto();

	default:

		return NULL;

	}

kernel/trace/bpf_trace.c

+51 −3
Original line number Diff line number Diff line
@@ -398,7 +398,7 @@ static const struct bpf_func_proto bpf_trace_printk_proto = { 
	.arg2_type	= ARG_CONST_SIZE,

};



const struct bpf_func_proto *bpf_get_trace_printk_proto(void)

static void __set_printk_clr_event(void)

{

	/*

	 * This program might be calling bpf_trace_printk,
@@ -410,11 +410,57 @@ const struct bpf_func_proto *bpf_get_trace_printk_proto(void) 
	 */

	if (trace_set_clr_event("bpf_trace", "bpf_trace_printk", 1))

		pr_warn_ratelimited("could not enable bpf_trace_printk events");

}



const struct bpf_func_proto *bpf_get_trace_printk_proto(void)

{

	__set_printk_clr_event();

	return &bpf_trace_printk_proto;

}



#define MAX_SEQ_PRINTF_VARARGS		12

BPF_CALL_4(bpf_trace_vprintk, char *, fmt, u32, fmt_size, const void *, data,

	   u32, data_len)

{

	static char buf[BPF_TRACE_PRINTK_SIZE];

	unsigned long flags;

	int ret, num_args;

	u32 *bin_args;



	if (data_len & 7 || data_len > MAX_BPRINTF_VARARGS * 8 ||

	    (data_len && !data))

		return -EINVAL;

	num_args = data_len / 8;



	ret = bpf_bprintf_prepare(fmt, fmt_size, data, &bin_args, num_args);

	if (ret < 0)

		return ret;



	raw_spin_lock_irqsave(&trace_printk_lock, flags);

	ret = bstr_printf(buf, sizeof(buf), fmt, bin_args);



	trace_bpf_trace_printk(buf);

	raw_spin_unlock_irqrestore(&trace_printk_lock, flags);



	bpf_bprintf_cleanup();



	return ret;

}



static const struct bpf_func_proto bpf_trace_vprintk_proto = {

	.func		= bpf_trace_vprintk,

	.gpl_only	= true,

	.ret_type	= RET_INTEGER,

	.arg1_type	= ARG_PTR_TO_MEM,

	.arg2_type	= ARG_CONST_SIZE,

	.arg3_type	= ARG_PTR_TO_MEM_OR_NULL,

	.arg4_type	= ARG_CONST_SIZE_OR_ZERO,

};



const struct bpf_func_proto *bpf_get_trace_vprintk_proto(void)

{

	__set_printk_clr_event();

	return &bpf_trace_vprintk_proto;

}



BPF_CALL_5(bpf_seq_printf, struct seq_file *, m, char *, fmt, u32, fmt_size,

	   const void *, data, u32, data_len)
@@ -422,7 +468,7 @@ BPF_CALL_5(bpf_seq_printf, struct seq_file *, m, char *, fmt, u32, fmt_size, 
	int err, num_args;

	u32 *bin_args;



	if (data_len & 7 || data_len > MAX_SEQ_PRINTF_VARARGS * 8 ||

	if (data_len & 7 || data_len > MAX_BPRINTF_VARARGS * 8 ||

	    (data_len && !data))

		return -EINVAL;

	num_args = data_len / 8;
@@ -1162,6 +1208,8 @@ bpf_tracing_func_proto(enum bpf_func_id func_id, const struct bpf_prog *prog) 
		return &bpf_get_func_ip_proto_tracing;

	case BPF_FUNC_get_branch_snapshot:

		return &bpf_get_branch_snapshot_proto;

	case BPF_FUNC_trace_vprintk:

		return bpf_get_trace_vprintk_proto();

	default:

		return bpf_base_func_proto(func_id);

	}