877 lines · 23.9 KB · C
RawDownload
// SPDX-License-Identifier: GPL-2.0-only/* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com * Copyright (c) 2016 Facebook * Copyright (c) 2018 Covalent IO, Inc. http://covalent.io */#include <uapi/linux/btf.h>#include <linux/kernel.h>#include <linux/types.h>#include <linux/bpf.h>#include <linux/bpf_verifier.h>#include <linux/math64.h>#include <linux/string.h> #define verbose(env, fmt, args...) bpf_verifier_log_write(env, fmt, ##args) static bool bpf_verifier_log_attr_valid(const struct bpf_verifier_log *log){	/* ubuf and len_total should both be specified (or not) together */	if (!!log->ubuf != !!log->len_total)		return false;	/* log buf without log_level is meaningless */	if (log->ubuf && log->level == 0)		return false;	if (log->level & ~BPF_LOG_MASK)		return false;	if (log->len_total > UINT_MAX >> 2)		return false;	return true;} int bpf_vlog_init(struct bpf_verifier_log *log, u32 log_level,		  char __user *log_buf, u32 log_size){	log->level = log_level;	log->ubuf = log_buf;	log->len_total = log_size; 	/* log attributes have to be sane */	if (!bpf_verifier_log_attr_valid(log))		return -EINVAL; 	return 0;} static void bpf_vlog_update_len_max(struct bpf_verifier_log *log, u32 add_len){	/* add_len includes terminal \0, so no need for +1. */	u64 len = log->end_pos + add_len; 	/* log->len_max could be larger than our current len due to	 * bpf_vlog_reset() calls, so we maintain the max of any length at any	 * previous point	 */	if (len > UINT_MAX)		log->len_max = UINT_MAX;	else if (len > log->len_max)		log->len_max = len;} void bpf_verifier_vlog(struct bpf_verifier_log *log, const char *fmt,		       va_list args){	u64 cur_pos;	u32 new_n, n; 	n = vscnprintf(log->kbuf, BPF_VERIFIER_TMP_LOG_SIZE, fmt, args); 	if (log->level == BPF_LOG_KERNEL) {		bool newline = n > 0 && log->kbuf[n - 1] == '\n'; 		pr_err("BPF: %s%s", log->kbuf, newline ? "" : "\n");		return;	} 	n += 1; /* include terminating zero */	bpf_vlog_update_len_max(log, n); 	if (log->level & BPF_LOG_FIXED) {		/* check if we have at least something to put into user buf */		new_n = 0;		if (log->end_pos < log->len_total) {			new_n = min_t(u32, log->len_total - log->end_pos, n);			log->kbuf[new_n - 1] = '\0';		} 		cur_pos = log->end_pos;		log->end_pos += n - 1; /* don't count terminating '\0' */ 		if (log->ubuf && new_n &&		    copy_to_user(log->ubuf + cur_pos, log->kbuf, new_n))			goto fail;	} else {		u64 new_end, new_start;		u32 buf_start, buf_end; 		new_end = log->end_pos + n;		if (new_end - log->start_pos >= log->len_total)			new_start = new_end - log->len_total;		else			new_start = log->start_pos; 		log->start_pos = new_start;		log->end_pos = new_end - 1; /* don't count terminating '\0' */ 		if (!log->ubuf)			return; 		new_n = min(n, log->len_total);		cur_pos = new_end - new_n;		div_u64_rem(cur_pos, log->len_total, &buf_start);		div_u64_rem(new_end, log->len_total, &buf_end);		/* new_end and buf_end are exclusive indices, so if buf_end is		 * exactly zero, then it actually points right to the end of		 * ubuf and there is no wrap around		 */		if (buf_end == 0)			buf_end = log->len_total; 		/* if buf_start > buf_end, we wrapped around;		 * if buf_start == buf_end, then we fill ubuf completely; we		 * can't have buf_start == buf_end to mean that there is		 * nothing to write, because we always write at least		 * something, even if terminal '\0'		 */		if (buf_start < buf_end) {			/* message fits within contiguous chunk of ubuf */			if (copy_to_user(log->ubuf + buf_start,					 log->kbuf + n - new_n,					 buf_end - buf_start))				goto fail;		} else {			/* message wraps around the end of ubuf, copy in two chunks */			if (copy_to_user(log->ubuf + buf_start,					 log->kbuf + n - new_n,					 log->len_total - buf_start))				goto fail;			if (copy_to_user(log->ubuf,					 log->kbuf + n - buf_end,					 buf_end))				goto fail;		}	} 	return;fail:	log->ubuf = NULL;} void bpf_vlog_reset(struct bpf_verifier_log *log, u64 new_pos){	char zero = 0;	u32 pos; 	if (WARN_ON_ONCE(new_pos > log->end_pos))		return; 	if (!bpf_verifier_log_needed(log) || log->level == BPF_LOG_KERNEL)		return; 	/* if position to which we reset is beyond current log window,	 * then we didn't preserve any useful content and should adjust	 * start_pos to end up with an empty log (start_pos == end_pos)	 */	log->end_pos = new_pos;	if (log->end_pos < log->start_pos)		log->start_pos = log->end_pos; 	if (!log->ubuf)		return; 	if (log->level & BPF_LOG_FIXED)		pos = log->end_pos + 1;	else		div_u64_rem(new_pos, log->len_total, &pos); 	if (pos < log->len_total && put_user(zero, log->ubuf + pos))		log->ubuf = NULL;} static void bpf_vlog_reverse_kbuf(char *buf, int len){	int i, j; 	for (i = 0, j = len - 1; i < j; i++, j--)		swap(buf[i], buf[j]);} static int bpf_vlog_reverse_ubuf(struct bpf_verifier_log *log, int start, int end){	/* we split log->kbuf into two equal parts for both ends of array */	int n = sizeof(log->kbuf) / 2, nn;	char *lbuf = log->kbuf, *rbuf = log->kbuf + n; 	/* Read ubuf's section [start, end) two chunks at a time, from left	 * and right side; within each chunk, swap all the bytes; after that	 * reverse the order of lbuf and rbuf and write result back to ubuf.	 * This way we'll end up with swapped contents of specified	 * [start, end) ubuf segment.	 */	while (end - start > 1) {		nn = min(n, (end - start ) / 2); 		if (copy_from_user(lbuf, log->ubuf + start, nn))			return -EFAULT;		if (copy_from_user(rbuf, log->ubuf + end - nn, nn))			return -EFAULT; 		bpf_vlog_reverse_kbuf(lbuf, nn);		bpf_vlog_reverse_kbuf(rbuf, nn); 		/* we write lbuf to the right end of ubuf, while rbuf to the		 * left one to end up with properly reversed overall ubuf		 */		if (copy_to_user(log->ubuf + start, rbuf, nn))			return -EFAULT;		if (copy_to_user(log->ubuf + end - nn, lbuf, nn))			return -EFAULT; 		start += nn;		end -= nn;	} 	return 0;} int bpf_vlog_finalize(struct bpf_verifier_log *log, u32 *log_size_actual){	u32 sublen;	int err; 	*log_size_actual = 0;	if (!log || log->level == 0 || log->level == BPF_LOG_KERNEL)		return 0; 	if (!log->ubuf)		goto skip_log_rotate;	/* If we never truncated log, there is nothing to move around. */	if (log->start_pos == 0)		goto skip_log_rotate; 	/* Otherwise we need to rotate log contents to make it start from the	 * buffer beginning and be a continuous zero-terminated string. Note	 * that if log->start_pos != 0 then we definitely filled up entire log	 * buffer with no gaps, and we just need to shift buffer contents to	 * the left by (log->start_pos % log->len_total) bytes.	 *	 * Unfortunately, user buffer could be huge and we don't want to	 * allocate temporary kernel memory of the same size just to shift	 * contents in a straightforward fashion. Instead, we'll be clever and	 * do in-place array rotation. This is a leetcode-style problem, which	 * could be solved by three rotations.	 *	 * Let's say we have log buffer that has to be shifted left by 7 bytes	 * (spaces and vertical bar is just for demonstrative purposes):	 *   E F G H I J K | A B C D	 *	 * First, we reverse entire array:	 *   D C B A | K J I H G F E	 *	 * Then we rotate first 4 bytes (DCBA) and separately last 7 bytes	 * (KJIHGFE), resulting in a properly rotated array:	 *   A B C D | E F G H I J K	 *	 * We'll utilize log->kbuf to read user memory chunk by chunk, swap	 * bytes, and write them back. Doing it byte-by-byte would be	 * unnecessarily inefficient. Altogether we are going to read and	 * write each byte twice, for total 4 memory copies between kernel and	 * user space.	 */ 	/* length of the chopped off part that will be the beginning;	 * len(ABCD) in the example above	 */	div_u64_rem(log->start_pos, log->len_total, &sublen);	sublen = log->len_total - sublen; 	err = bpf_vlog_reverse_ubuf(log, 0, log->len_total);	err = err ?: bpf_vlog_reverse_ubuf(log, 0, sublen);	err = err ?: bpf_vlog_reverse_ubuf(log, sublen, log->len_total);	if (err)		log->ubuf = NULL; skip_log_rotate:	*log_size_actual = log->len_max; 	/* properly initialized log has either both ubuf!=NULL and len_total>0	 * or ubuf==NULL and len_total==0, so if this condition doesn't hold,	 * we got a fault somewhere along the way, so report it back	 */	if (!!log->ubuf != !!log->len_total)		return -EFAULT; 	/* did truncation actually happen? */	if (log->ubuf && log->len_max > log->len_total)		return -ENOSPC; 	return 0;} /* log_level controls verbosity level of eBPF verifier. * bpf_verifier_log_write() is used to dump the verification trace to the log, * so the user can figure out what's wrong with the program */__printf(2, 3) void bpf_verifier_log_write(struct bpf_verifier_env *env,					   const char *fmt, ...){	va_list args; 	if (!bpf_verifier_log_needed(&env->log))		return; 	va_start(args, fmt);	bpf_verifier_vlog(&env->log, fmt, args);	va_end(args);}EXPORT_SYMBOL_GPL(bpf_verifier_log_write); __printf(2, 3) void bpf_log(struct bpf_verifier_log *log,			    const char *fmt, ...){	va_list args; 	if (!bpf_verifier_log_needed(log))		return; 	va_start(args, fmt);	bpf_verifier_vlog(log, fmt, args);	va_end(args);}EXPORT_SYMBOL_GPL(bpf_log); static const struct bpf_line_info *find_linfo(const struct bpf_verifier_env *env, u32 insn_off){	const struct bpf_line_info *linfo;	const struct bpf_prog *prog;	u32 nr_linfo;	int l, r, m; 	prog = env->prog;	nr_linfo = prog->aux->nr_linfo; 	if (!nr_linfo || insn_off >= prog->len)		return NULL; 	linfo = prog->aux->linfo;	/* Loop invariant: linfo[l].insn_off <= insns_off.	 * linfo[0].insn_off == 0 which always satisfies above condition.	 * Binary search is searching for rightmost linfo entry that satisfies	 * the above invariant, giving us the desired record that covers given	 * instruction offset.	 */	l = 0;	r = nr_linfo - 1;	while (l < r) {		/* (r - l + 1) / 2 means we break a tie to the right, so if:		 * l=1, r=2, linfo[l].insn_off <= insn_off, linfo[r].insn_off > insn_off,		 * then m=2, we see that linfo[m].insn_off > insn_off, and so		 * r becomes 1 and we exit the loop with correct l==1.		 * If the tie was broken to the left, m=1 would end us up in		 * an endless loop where l and m stay at 1 and r stays at 2.		 */		m = l + (r - l + 1) / 2;		if (linfo[m].insn_off <= insn_off)			l = m;		else			r = m - 1;	} 	return &linfo[l];} static const char *ltrim(const char *s){	while (isspace(*s))		s++; 	return s;} __printf(3, 4) void verbose_linfo(struct bpf_verifier_env *env,				  u32 insn_off,				  const char *prefix_fmt, ...){	const struct bpf_line_info *linfo, *prev_linfo;	const struct btf *btf;	const char *s, *fname; 	if (!bpf_verifier_log_needed(&env->log))		return; 	prev_linfo = env->prev_linfo;	linfo = find_linfo(env, insn_off);	if (!linfo || linfo == prev_linfo)		return; 	/* It often happens that two separate linfo records point to the same	 * source code line, but have differing column numbers. Given verifier	 * log doesn't emit column information, from user perspective we just	 * end up emitting the same source code line twice unnecessarily.	 * So instead check that previous and current linfo record point to	 * the same file (file_name_offs match) and the same line number, and	 * avoid emitting duplicated source code line in such case.	 */	if (prev_linfo && linfo->file_name_off == prev_linfo->file_name_off &&	    BPF_LINE_INFO_LINE_NUM(linfo->line_col) == BPF_LINE_INFO_LINE_NUM(prev_linfo->line_col))		return; 	if (prefix_fmt) {		va_list args; 		va_start(args, prefix_fmt);		bpf_verifier_vlog(&env->log, prefix_fmt, args);		va_end(args);	} 	btf = env->prog->aux->btf;	s = ltrim(btf_name_by_offset(btf, linfo->line_off));	verbose(env, "%s", s); /* source code line */ 	s = btf_name_by_offset(btf, linfo->file_name_off);	/* leave only file name */	fname = strrchr(s, '/');	fname = fname ? fname + 1 : s;	verbose(env, " @ %s:%u\n", fname, BPF_LINE_INFO_LINE_NUM(linfo->line_col)); 	env->prev_linfo = linfo;} static const char *btf_type_name(const struct btf *btf, u32 id){	return btf_name_by_offset(btf, btf_type_by_id(btf, id)->name_off);} /* string representation of 'enum bpf_reg_type' * * Note that reg_type_str() can not appear more than once in a single verbose() * statement. */const char *reg_type_str(struct bpf_verifier_env *env, enum bpf_reg_type type){	char postfix[16] = {0}, prefix[64] = {0};	static const char * const str[] = {		[NOT_INIT]		= "?",		[SCALAR_VALUE]		= "scalar",		[PTR_TO_CTX]		= "ctx",		[CONST_PTR_TO_MAP]	= "map_ptr",		[PTR_TO_MAP_VALUE]	= "map_value",		[PTR_TO_STACK]		= "fp",		[PTR_TO_PACKET]		= "pkt",		[PTR_TO_PACKET_META]	= "pkt_meta",		[PTR_TO_PACKET_END]	= "pkt_end",		[PTR_TO_FLOW_KEYS]	= "flow_keys",		[PTR_TO_SOCKET]		= "sock",		[PTR_TO_SOCK_COMMON]	= "sock_common",		[PTR_TO_TCP_SOCK]	= "tcp_sock",		[PTR_TO_TP_BUFFER]	= "tp_buffer",		[PTR_TO_XDP_SOCK]	= "xdp_sock",		[PTR_TO_BTF_ID]		= "ptr_",		[PTR_TO_MEM]		= "mem",		[PTR_TO_ARENA]		= "arena",		[PTR_TO_BUF]		= "buf",		[PTR_TO_FUNC]		= "func",		[PTR_TO_MAP_KEY]	= "map_key",		[CONST_PTR_TO_DYNPTR]	= "dynptr_ptr",	}; 	if (type & PTR_MAYBE_NULL) {		if (base_type(type) == PTR_TO_BTF_ID)			strscpy(postfix, "or_null_");		else			strscpy(postfix, "_or_null");	} 	snprintf(prefix, sizeof(prefix), "%s%s%s%s%s%s%s",		 type & MEM_RDONLY ? "rdonly_" : "",		 type & MEM_RINGBUF ? "ringbuf_" : "",		 type & MEM_USER ? "user_" : "",		 type & MEM_PERCPU ? "percpu_" : "",		 type & MEM_RCU ? "rcu_" : "",		 type & PTR_UNTRUSTED ? "untrusted_" : "",		 type & PTR_TRUSTED ? "trusted_" : ""	); 	snprintf(env->tmp_str_buf, TMP_STR_BUF_LEN, "%s%s%s",		 prefix, str[base_type(type)], postfix);	return env->tmp_str_buf;} const char *dynptr_type_str(enum bpf_dynptr_type type){	switch (type) {	case BPF_DYNPTR_TYPE_LOCAL:		return "local";	case BPF_DYNPTR_TYPE_RINGBUF:		return "ringbuf";	case BPF_DYNPTR_TYPE_SKB:		return "skb";	case BPF_DYNPTR_TYPE_XDP:		return "xdp";

Lines 1–500 of 877.