xref: /linux-6.15/kernel/bpf/log.c (revision c8e2ee1f)
14294a0a7SAndrii Nakryiko // SPDX-License-Identifier: GPL-2.0-only
24294a0a7SAndrii Nakryiko /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
34294a0a7SAndrii Nakryiko  * Copyright (c) 2016 Facebook
44294a0a7SAndrii Nakryiko  * Copyright (c) 2018 Covalent IO, Inc. http://covalent.io
54294a0a7SAndrii Nakryiko  */
64294a0a7SAndrii Nakryiko #include <uapi/linux/btf.h>
74294a0a7SAndrii Nakryiko #include <linux/kernel.h>
84294a0a7SAndrii Nakryiko #include <linux/types.h>
94294a0a7SAndrii Nakryiko #include <linux/bpf.h>
104294a0a7SAndrii Nakryiko #include <linux/bpf_verifier.h>
1112166409SAndrii Nakryiko #include <linux/math64.h>
127cc13adbSAndrii Nakryiko #include <linux/string.h>
134294a0a7SAndrii Nakryiko 
14db840d38SAndrii Nakryiko #define verbose(env, fmt, args...) bpf_verifier_log_write(env, fmt, ##args)
15db840d38SAndrii Nakryiko 
bpf_verifier_log_attr_valid(const struct bpf_verifier_log * log)16bdcab414SAndrii Nakryiko static bool bpf_verifier_log_attr_valid(const struct bpf_verifier_log *log)
174294a0a7SAndrii Nakryiko {
18fac08d45SAndrii Nakryiko 	/* ubuf and len_total should both be specified (or not) together */
19fac08d45SAndrii Nakryiko 	if (!!log->ubuf != !!log->len_total)
20fac08d45SAndrii Nakryiko 		return false;
21fac08d45SAndrii Nakryiko 	/* log buf without log_level is meaningless */
22fac08d45SAndrii Nakryiko 	if (log->ubuf && log->level == 0)
23fac08d45SAndrii Nakryiko 		return false;
24fac08d45SAndrii Nakryiko 	if (log->level & ~BPF_LOG_MASK)
25fac08d45SAndrii Nakryiko 		return false;
26fac08d45SAndrii Nakryiko 	if (log->len_total > UINT_MAX >> 2)
27fac08d45SAndrii Nakryiko 		return false;
28fac08d45SAndrii Nakryiko 	return true;
294294a0a7SAndrii Nakryiko }
304294a0a7SAndrii Nakryiko 
bpf_vlog_init(struct bpf_verifier_log * log,u32 log_level,char __user * log_buf,u32 log_size)31bdcab414SAndrii Nakryiko int bpf_vlog_init(struct bpf_verifier_log *log, u32 log_level,
32bdcab414SAndrii Nakryiko 		  char __user *log_buf, u32 log_size)
33bdcab414SAndrii Nakryiko {
34bdcab414SAndrii Nakryiko 	log->level = log_level;
35bdcab414SAndrii Nakryiko 	log->ubuf = log_buf;
36bdcab414SAndrii Nakryiko 	log->len_total = log_size;
37bdcab414SAndrii Nakryiko 
38bdcab414SAndrii Nakryiko 	/* log attributes have to be sane */
39bdcab414SAndrii Nakryiko 	if (!bpf_verifier_log_attr_valid(log))
40bdcab414SAndrii Nakryiko 		return -EINVAL;
41bdcab414SAndrii Nakryiko 
42bdcab414SAndrii Nakryiko 	return 0;
43bdcab414SAndrii Nakryiko }
44bdcab414SAndrii Nakryiko 
bpf_vlog_update_len_max(struct bpf_verifier_log * log,u32 add_len)45fa1c7d5cSAndrii Nakryiko static void bpf_vlog_update_len_max(struct bpf_verifier_log *log, u32 add_len)
46fa1c7d5cSAndrii Nakryiko {
47fa1c7d5cSAndrii Nakryiko 	/* add_len includes terminal \0, so no need for +1. */
48fa1c7d5cSAndrii Nakryiko 	u64 len = log->end_pos + add_len;
49fa1c7d5cSAndrii Nakryiko 
50fa1c7d5cSAndrii Nakryiko 	/* log->len_max could be larger than our current len due to
51fa1c7d5cSAndrii Nakryiko 	 * bpf_vlog_reset() calls, so we maintain the max of any length at any
52fa1c7d5cSAndrii Nakryiko 	 * previous point
53fa1c7d5cSAndrii Nakryiko 	 */
54fa1c7d5cSAndrii Nakryiko 	if (len > UINT_MAX)
55fa1c7d5cSAndrii Nakryiko 		log->len_max = UINT_MAX;
56fa1c7d5cSAndrii Nakryiko 	else if (len > log->len_max)
57fa1c7d5cSAndrii Nakryiko 		log->len_max = len;
58fa1c7d5cSAndrii Nakryiko }
59fa1c7d5cSAndrii Nakryiko 
bpf_verifier_vlog(struct bpf_verifier_log * log,const char * fmt,va_list args)604294a0a7SAndrii Nakryiko void bpf_verifier_vlog(struct bpf_verifier_log *log, const char *fmt,
614294a0a7SAndrii Nakryiko 		       va_list args)
624294a0a7SAndrii Nakryiko {
63fa1c7d5cSAndrii Nakryiko 	u64 cur_pos;
64fa1c7d5cSAndrii Nakryiko 	u32 new_n, n;
654294a0a7SAndrii Nakryiko 
664294a0a7SAndrii Nakryiko 	n = vscnprintf(log->kbuf, BPF_VERIFIER_TMP_LOG_SIZE, fmt, args);
674294a0a7SAndrii Nakryiko 
684294a0a7SAndrii Nakryiko 	if (log->level == BPF_LOG_KERNEL) {
694294a0a7SAndrii Nakryiko 		bool newline = n > 0 && log->kbuf[n - 1] == '\n';
704294a0a7SAndrii Nakryiko 
714294a0a7SAndrii Nakryiko 		pr_err("BPF: %s%s", log->kbuf, newline ? "" : "\n");
724294a0a7SAndrii Nakryiko 		return;
734294a0a7SAndrii Nakryiko 	}
744294a0a7SAndrii Nakryiko 
75fa1c7d5cSAndrii Nakryiko 	n += 1; /* include terminating zero */
76fa1c7d5cSAndrii Nakryiko 	bpf_vlog_update_len_max(log, n);
77fa1c7d5cSAndrii Nakryiko 
7812166409SAndrii Nakryiko 	if (log->level & BPF_LOG_FIXED) {
79fa1c7d5cSAndrii Nakryiko 		/* check if we have at least something to put into user buf */
80fa1c7d5cSAndrii Nakryiko 		new_n = 0;
81fa1c7d5cSAndrii Nakryiko 		if (log->end_pos < log->len_total) {
82fa1c7d5cSAndrii Nakryiko 			new_n = min_t(u32, log->len_total - log->end_pos, n);
83fa1c7d5cSAndrii Nakryiko 			log->kbuf[new_n - 1] = '\0';
84fa1c7d5cSAndrii Nakryiko 		}
8512166409SAndrii Nakryiko 
86fa1c7d5cSAndrii Nakryiko 		cur_pos = log->end_pos;
8712166409SAndrii Nakryiko 		log->end_pos += n - 1; /* don't count terminating '\0' */
8812166409SAndrii Nakryiko 
89fa1c7d5cSAndrii Nakryiko 		if (log->ubuf && new_n &&
90fa1c7d5cSAndrii Nakryiko 		    copy_to_user(log->ubuf + cur_pos, log->kbuf, new_n))
91fa1c7d5cSAndrii Nakryiko 			goto fail;
92fa1c7d5cSAndrii Nakryiko 	} else {
93fa1c7d5cSAndrii Nakryiko 		u64 new_end, new_start;
9421ab4980SRafael Passos 		u32 buf_start, buf_end;
9512166409SAndrii Nakryiko 
9612166409SAndrii Nakryiko 		new_end = log->end_pos + n;
9712166409SAndrii Nakryiko 		if (new_end - log->start_pos >= log->len_total)
9812166409SAndrii Nakryiko 			new_start = new_end - log->len_total;
994294a0a7SAndrii Nakryiko 		else
10012166409SAndrii Nakryiko 			new_start = log->start_pos;
101fac08d45SAndrii Nakryiko 
102fac08d45SAndrii Nakryiko 		log->start_pos = new_start;
103fac08d45SAndrii Nakryiko 		log->end_pos = new_end - 1; /* don't count terminating '\0' */
104fac08d45SAndrii Nakryiko 
105fac08d45SAndrii Nakryiko 		if (!log->ubuf)
106fac08d45SAndrii Nakryiko 			return;
107fac08d45SAndrii Nakryiko 
10812166409SAndrii Nakryiko 		new_n = min(n, log->len_total);
10912166409SAndrii Nakryiko 		cur_pos = new_end - new_n;
11012166409SAndrii Nakryiko 		div_u64_rem(cur_pos, log->len_total, &buf_start);
11112166409SAndrii Nakryiko 		div_u64_rem(new_end, log->len_total, &buf_end);
11212166409SAndrii Nakryiko 		/* new_end and buf_end are exclusive indices, so if buf_end is
11312166409SAndrii Nakryiko 		 * exactly zero, then it actually points right to the end of
11412166409SAndrii Nakryiko 		 * ubuf and there is no wrap around
11512166409SAndrii Nakryiko 		 */
11612166409SAndrii Nakryiko 		if (buf_end == 0)
11712166409SAndrii Nakryiko 			buf_end = log->len_total;
11812166409SAndrii Nakryiko 
11912166409SAndrii Nakryiko 		/* if buf_start > buf_end, we wrapped around;
12012166409SAndrii Nakryiko 		 * if buf_start == buf_end, then we fill ubuf completely; we
12112166409SAndrii Nakryiko 		 * can't have buf_start == buf_end to mean that there is
12212166409SAndrii Nakryiko 		 * nothing to write, because we always write at least
12312166409SAndrii Nakryiko 		 * something, even if terminal '\0'
12412166409SAndrii Nakryiko 		 */
12512166409SAndrii Nakryiko 		if (buf_start < buf_end) {
12612166409SAndrii Nakryiko 			/* message fits within contiguous chunk of ubuf */
12712166409SAndrii Nakryiko 			if (copy_to_user(log->ubuf + buf_start,
12812166409SAndrii Nakryiko 					 log->kbuf + n - new_n,
12912166409SAndrii Nakryiko 					 buf_end - buf_start))
13012166409SAndrii Nakryiko 				goto fail;
13112166409SAndrii Nakryiko 		} else {
13212166409SAndrii Nakryiko 			/* message wraps around the end of ubuf, copy in two chunks */
13312166409SAndrii Nakryiko 			if (copy_to_user(log->ubuf + buf_start,
13412166409SAndrii Nakryiko 					 log->kbuf + n - new_n,
13512166409SAndrii Nakryiko 					 log->len_total - buf_start))
13612166409SAndrii Nakryiko 				goto fail;
13712166409SAndrii Nakryiko 			if (copy_to_user(log->ubuf,
13812166409SAndrii Nakryiko 					 log->kbuf + n - buf_end,
13912166409SAndrii Nakryiko 					 buf_end))
14012166409SAndrii Nakryiko 				goto fail;
14112166409SAndrii Nakryiko 		}
14212166409SAndrii Nakryiko 	}
14312166409SAndrii Nakryiko 
14412166409SAndrii Nakryiko 	return;
14512166409SAndrii Nakryiko fail:
1464294a0a7SAndrii Nakryiko 	log->ubuf = NULL;
1474294a0a7SAndrii Nakryiko }
1484294a0a7SAndrii Nakryiko 
bpf_vlog_reset(struct bpf_verifier_log * log,u64 new_pos)14912166409SAndrii Nakryiko void bpf_vlog_reset(struct bpf_verifier_log *log, u64 new_pos)
1504294a0a7SAndrii Nakryiko {
1514294a0a7SAndrii Nakryiko 	char zero = 0;
15212166409SAndrii Nakryiko 	u32 pos;
15312166409SAndrii Nakryiko 
15412166409SAndrii Nakryiko 	if (WARN_ON_ONCE(new_pos > log->end_pos))
15512166409SAndrii Nakryiko 		return;
1564294a0a7SAndrii Nakryiko 
15724bc8088SAndrii Nakryiko 	if (!bpf_verifier_log_needed(log) || log->level == BPF_LOG_KERNEL)
1584294a0a7SAndrii Nakryiko 		return;
1594294a0a7SAndrii Nakryiko 
16012166409SAndrii Nakryiko 	/* if position to which we reset is beyond current log window,
16112166409SAndrii Nakryiko 	 * then we didn't preserve any useful content and should adjust
16212166409SAndrii Nakryiko 	 * start_pos to end up with an empty log (start_pos == end_pos)
16312166409SAndrii Nakryiko 	 */
16412166409SAndrii Nakryiko 	log->end_pos = new_pos;
16512166409SAndrii Nakryiko 	if (log->end_pos < log->start_pos)
16612166409SAndrii Nakryiko 		log->start_pos = log->end_pos;
167fa1c7d5cSAndrii Nakryiko 
168fac08d45SAndrii Nakryiko 	if (!log->ubuf)
169fac08d45SAndrii Nakryiko 		return;
170fac08d45SAndrii Nakryiko 
171fa1c7d5cSAndrii Nakryiko 	if (log->level & BPF_LOG_FIXED)
172fa1c7d5cSAndrii Nakryiko 		pos = log->end_pos + 1;
173fa1c7d5cSAndrii Nakryiko 	else
17412166409SAndrii Nakryiko 		div_u64_rem(new_pos, log->len_total, &pos);
175fa1c7d5cSAndrii Nakryiko 
176fac08d45SAndrii Nakryiko 	if (pos < log->len_total && put_user(zero, log->ubuf + pos))
17712166409SAndrii Nakryiko 		log->ubuf = NULL;
17812166409SAndrii Nakryiko }
17912166409SAndrii Nakryiko 
bpf_vlog_reverse_kbuf(char * buf,int len)18012166409SAndrii Nakryiko static void bpf_vlog_reverse_kbuf(char *buf, int len)
18112166409SAndrii Nakryiko {
18212166409SAndrii Nakryiko 	int i, j;
18312166409SAndrii Nakryiko 
18412166409SAndrii Nakryiko 	for (i = 0, j = len - 1; i < j; i++, j--)
18512166409SAndrii Nakryiko 		swap(buf[i], buf[j]);
18612166409SAndrii Nakryiko }
18712166409SAndrii Nakryiko 
bpf_vlog_reverse_ubuf(struct bpf_verifier_log * log,int start,int end)18812166409SAndrii Nakryiko static int bpf_vlog_reverse_ubuf(struct bpf_verifier_log *log, int start, int end)
18912166409SAndrii Nakryiko {
19012166409SAndrii Nakryiko 	/* we split log->kbuf into two equal parts for both ends of array */
19112166409SAndrii Nakryiko 	int n = sizeof(log->kbuf) / 2, nn;
19212166409SAndrii Nakryiko 	char *lbuf = log->kbuf, *rbuf = log->kbuf + n;
19312166409SAndrii Nakryiko 
19412166409SAndrii Nakryiko 	/* Read ubuf's section [start, end) two chunks at a time, from left
19512166409SAndrii Nakryiko 	 * and right side; within each chunk, swap all the bytes; after that
19612166409SAndrii Nakryiko 	 * reverse the order of lbuf and rbuf and write result back to ubuf.
19712166409SAndrii Nakryiko 	 * This way we'll end up with swapped contents of specified
19812166409SAndrii Nakryiko 	 * [start, end) ubuf segment.
19912166409SAndrii Nakryiko 	 */
20012166409SAndrii Nakryiko 	while (end - start > 1) {
20112166409SAndrii Nakryiko 		nn = min(n, (end - start ) / 2);
20212166409SAndrii Nakryiko 
20312166409SAndrii Nakryiko 		if (copy_from_user(lbuf, log->ubuf + start, nn))
20412166409SAndrii Nakryiko 			return -EFAULT;
20512166409SAndrii Nakryiko 		if (copy_from_user(rbuf, log->ubuf + end - nn, nn))
20612166409SAndrii Nakryiko 			return -EFAULT;
20712166409SAndrii Nakryiko 
20812166409SAndrii Nakryiko 		bpf_vlog_reverse_kbuf(lbuf, nn);
20912166409SAndrii Nakryiko 		bpf_vlog_reverse_kbuf(rbuf, nn);
21012166409SAndrii Nakryiko 
21112166409SAndrii Nakryiko 		/* we write lbuf to the right end of ubuf, while rbuf to the
21212166409SAndrii Nakryiko 		 * left one to end up with properly reversed overall ubuf
21312166409SAndrii Nakryiko 		 */
21412166409SAndrii Nakryiko 		if (copy_to_user(log->ubuf + start, rbuf, nn))
21512166409SAndrii Nakryiko 			return -EFAULT;
21612166409SAndrii Nakryiko 		if (copy_to_user(log->ubuf + end - nn, lbuf, nn))
21712166409SAndrii Nakryiko 			return -EFAULT;
21812166409SAndrii Nakryiko 
21912166409SAndrii Nakryiko 		start += nn;
22012166409SAndrii Nakryiko 		end -= nn;
22112166409SAndrii Nakryiko 	}
22212166409SAndrii Nakryiko 
22312166409SAndrii Nakryiko 	return 0;
22412166409SAndrii Nakryiko }
22512166409SAndrii Nakryiko 
bpf_vlog_finalize(struct bpf_verifier_log * log,u32 * log_size_actual)226bdcab414SAndrii Nakryiko int bpf_vlog_finalize(struct bpf_verifier_log *log, u32 *log_size_actual)
22712166409SAndrii Nakryiko {
22812166409SAndrii Nakryiko 	u32 sublen;
22912166409SAndrii Nakryiko 	int err;
23012166409SAndrii Nakryiko 
231bdcab414SAndrii Nakryiko 	*log_size_actual = 0;
232bdcab414SAndrii Nakryiko 	if (!log || log->level == 0 || log->level == BPF_LOG_KERNEL)
233bdcab414SAndrii Nakryiko 		return 0;
23412166409SAndrii Nakryiko 
235bdcab414SAndrii Nakryiko 	if (!log->ubuf)
236bdcab414SAndrii Nakryiko 		goto skip_log_rotate;
23712166409SAndrii Nakryiko 	/* If we never truncated log, there is nothing to move around. */
238fac08d45SAndrii Nakryiko 	if (log->start_pos == 0)
239bdcab414SAndrii Nakryiko 		goto skip_log_rotate;
24012166409SAndrii Nakryiko 
24112166409SAndrii Nakryiko 	/* Otherwise we need to rotate log contents to make it start from the
24212166409SAndrii Nakryiko 	 * buffer beginning and be a continuous zero-terminated string. Note
24312166409SAndrii Nakryiko 	 * that if log->start_pos != 0 then we definitely filled up entire log
24412166409SAndrii Nakryiko 	 * buffer with no gaps, and we just need to shift buffer contents to
24512166409SAndrii Nakryiko 	 * the left by (log->start_pos % log->len_total) bytes.
24612166409SAndrii Nakryiko 	 *
24712166409SAndrii Nakryiko 	 * Unfortunately, user buffer could be huge and we don't want to
24812166409SAndrii Nakryiko 	 * allocate temporary kernel memory of the same size just to shift
24912166409SAndrii Nakryiko 	 * contents in a straightforward fashion. Instead, we'll be clever and
25012166409SAndrii Nakryiko 	 * do in-place array rotation. This is a leetcode-style problem, which
25112166409SAndrii Nakryiko 	 * could be solved by three rotations.
25212166409SAndrii Nakryiko 	 *
25312166409SAndrii Nakryiko 	 * Let's say we have log buffer that has to be shifted left by 7 bytes
25412166409SAndrii Nakryiko 	 * (spaces and vertical bar is just for demonstrative purposes):
25512166409SAndrii Nakryiko 	 *   E F G H I J K | A B C D
25612166409SAndrii Nakryiko 	 *
25712166409SAndrii Nakryiko 	 * First, we reverse entire array:
25812166409SAndrii Nakryiko 	 *   D C B A | K J I H G F E
25912166409SAndrii Nakryiko 	 *
26012166409SAndrii Nakryiko 	 * Then we rotate first 4 bytes (DCBA) and separately last 7 bytes
26112166409SAndrii Nakryiko 	 * (KJIHGFE), resulting in a properly rotated array:
26212166409SAndrii Nakryiko 	 *   A B C D | E F G H I J K
26312166409SAndrii Nakryiko 	 *
26412166409SAndrii Nakryiko 	 * We'll utilize log->kbuf to read user memory chunk by chunk, swap
26512166409SAndrii Nakryiko 	 * bytes, and write them back. Doing it byte-by-byte would be
26612166409SAndrii Nakryiko 	 * unnecessarily inefficient. Altogether we are going to read and
26712166409SAndrii Nakryiko 	 * write each byte twice, for total 4 memory copies between kernel and
26812166409SAndrii Nakryiko 	 * user space.
26912166409SAndrii Nakryiko 	 */
27012166409SAndrii Nakryiko 
27112166409SAndrii Nakryiko 	/* length of the chopped off part that will be the beginning;
27212166409SAndrii Nakryiko 	 * len(ABCD) in the example above
27312166409SAndrii Nakryiko 	 */
27412166409SAndrii Nakryiko 	div_u64_rem(log->start_pos, log->len_total, &sublen);
27512166409SAndrii Nakryiko 	sublen = log->len_total - sublen;
27612166409SAndrii Nakryiko 
27712166409SAndrii Nakryiko 	err = bpf_vlog_reverse_ubuf(log, 0, log->len_total);
27812166409SAndrii Nakryiko 	err = err ?: bpf_vlog_reverse_ubuf(log, 0, sublen);
27912166409SAndrii Nakryiko 	err = err ?: bpf_vlog_reverse_ubuf(log, sublen, log->len_total);
28012166409SAndrii Nakryiko 	if (err)
2814294a0a7SAndrii Nakryiko 		log->ubuf = NULL;
282bdcab414SAndrii Nakryiko 
283bdcab414SAndrii Nakryiko skip_log_rotate:
284bdcab414SAndrii Nakryiko 	*log_size_actual = log->len_max;
285bdcab414SAndrii Nakryiko 
286bdcab414SAndrii Nakryiko 	/* properly initialized log has either both ubuf!=NULL and len_total>0
287bdcab414SAndrii Nakryiko 	 * or ubuf==NULL and len_total==0, so if this condition doesn't hold,
288bdcab414SAndrii Nakryiko 	 * we got a fault somewhere along the way, so report it back
289bdcab414SAndrii Nakryiko 	 */
290bdcab414SAndrii Nakryiko 	if (!!log->ubuf != !!log->len_total)
291bdcab414SAndrii Nakryiko 		return -EFAULT;
292bdcab414SAndrii Nakryiko 
293fac08d45SAndrii Nakryiko 	/* did truncation actually happen? */
294fac08d45SAndrii Nakryiko 	if (log->ubuf && log->len_max > log->len_total)
295bdcab414SAndrii Nakryiko 		return -ENOSPC;
296bdcab414SAndrii Nakryiko 
297bdcab414SAndrii Nakryiko 	return 0;
2984294a0a7SAndrii Nakryiko }
2994294a0a7SAndrii Nakryiko 
3004294a0a7SAndrii Nakryiko /* log_level controls verbosity level of eBPF verifier.
3014294a0a7SAndrii Nakryiko  * bpf_verifier_log_write() is used to dump the verification trace to the log,
3024294a0a7SAndrii Nakryiko  * so the user can figure out what's wrong with the program
3034294a0a7SAndrii Nakryiko  */
bpf_verifier_log_write(struct bpf_verifier_env * env,const char * fmt,...)3044294a0a7SAndrii Nakryiko __printf(2, 3) void bpf_verifier_log_write(struct bpf_verifier_env *env,
3054294a0a7SAndrii Nakryiko 					   const char *fmt, ...)
3064294a0a7SAndrii Nakryiko {
3074294a0a7SAndrii Nakryiko 	va_list args;
3084294a0a7SAndrii Nakryiko 
3094294a0a7SAndrii Nakryiko 	if (!bpf_verifier_log_needed(&env->log))
3104294a0a7SAndrii Nakryiko 		return;
3114294a0a7SAndrii Nakryiko 
3124294a0a7SAndrii Nakryiko 	va_start(args, fmt);
3134294a0a7SAndrii Nakryiko 	bpf_verifier_vlog(&env->log, fmt, args);
3144294a0a7SAndrii Nakryiko 	va_end(args);
3154294a0a7SAndrii Nakryiko }
3164294a0a7SAndrii Nakryiko EXPORT_SYMBOL_GPL(bpf_verifier_log_write);
3174294a0a7SAndrii Nakryiko 
bpf_log(struct bpf_verifier_log * log,const char * fmt,...)3184294a0a7SAndrii Nakryiko __printf(2, 3) void bpf_log(struct bpf_verifier_log *log,
3194294a0a7SAndrii Nakryiko 			    const char *fmt, ...)
3204294a0a7SAndrii Nakryiko {
3214294a0a7SAndrii Nakryiko 	va_list args;
3224294a0a7SAndrii Nakryiko 
3234294a0a7SAndrii Nakryiko 	if (!bpf_verifier_log_needed(log))
3244294a0a7SAndrii Nakryiko 		return;
3254294a0a7SAndrii Nakryiko 
3264294a0a7SAndrii Nakryiko 	va_start(args, fmt);
3274294a0a7SAndrii Nakryiko 	bpf_verifier_vlog(log, fmt, args);
3284294a0a7SAndrii Nakryiko 	va_end(args);
3294294a0a7SAndrii Nakryiko }
3304294a0a7SAndrii Nakryiko EXPORT_SYMBOL_GPL(bpf_log);
331db840d38SAndrii Nakryiko 
332db840d38SAndrii Nakryiko static const struct bpf_line_info *
find_linfo(const struct bpf_verifier_env * env,u32 insn_off)333db840d38SAndrii Nakryiko find_linfo(const struct bpf_verifier_env *env, u32 insn_off)
334db840d38SAndrii Nakryiko {
335db840d38SAndrii Nakryiko 	const struct bpf_line_info *linfo;
336db840d38SAndrii Nakryiko 	const struct bpf_prog *prog;
337a4561f5aSAndrii Nakryiko 	u32 nr_linfo;
338a4561f5aSAndrii Nakryiko 	int l, r, m;
339db840d38SAndrii Nakryiko 
340db840d38SAndrii Nakryiko 	prog = env->prog;
341db840d38SAndrii Nakryiko 	nr_linfo = prog->aux->nr_linfo;
342db840d38SAndrii Nakryiko 
343db840d38SAndrii Nakryiko 	if (!nr_linfo || insn_off >= prog->len)
344db840d38SAndrii Nakryiko 		return NULL;
345db840d38SAndrii Nakryiko 
346db840d38SAndrii Nakryiko 	linfo = prog->aux->linfo;
347a4561f5aSAndrii Nakryiko 	/* Loop invariant: linfo[l].insn_off <= insns_off.
348a4561f5aSAndrii Nakryiko 	 * linfo[0].insn_off == 0 which always satisfies above condition.
349a4561f5aSAndrii Nakryiko 	 * Binary search is searching for rightmost linfo entry that satisfies
350a4561f5aSAndrii Nakryiko 	 * the above invariant, giving us the desired record that covers given
351a4561f5aSAndrii Nakryiko 	 * instruction offset.
352a4561f5aSAndrii Nakryiko 	 */
353a4561f5aSAndrii Nakryiko 	l = 0;
354a4561f5aSAndrii Nakryiko 	r = nr_linfo - 1;
355a4561f5aSAndrii Nakryiko 	while (l < r) {
356a4561f5aSAndrii Nakryiko 		/* (r - l + 1) / 2 means we break a tie to the right, so if:
357a4561f5aSAndrii Nakryiko 		 * l=1, r=2, linfo[l].insn_off <= insn_off, linfo[r].insn_off > insn_off,
358a4561f5aSAndrii Nakryiko 		 * then m=2, we see that linfo[m].insn_off > insn_off, and so
359a4561f5aSAndrii Nakryiko 		 * r becomes 1 and we exit the loop with correct l==1.
360a4561f5aSAndrii Nakryiko 		 * If the tie was broken to the left, m=1 would end us up in
361a4561f5aSAndrii Nakryiko 		 * an endless loop where l and m stay at 1 and r stays at 2.
362a4561f5aSAndrii Nakryiko 		 */
363a4561f5aSAndrii Nakryiko 		m = l + (r - l + 1) / 2;
364a4561f5aSAndrii Nakryiko 		if (linfo[m].insn_off <= insn_off)
365a4561f5aSAndrii Nakryiko 			l = m;
366a4561f5aSAndrii Nakryiko 		else
367a4561f5aSAndrii Nakryiko 			r = m - 1;
368a4561f5aSAndrii Nakryiko 	}
369db840d38SAndrii Nakryiko 
370a4561f5aSAndrii Nakryiko 	return &linfo[l];
371db840d38SAndrii Nakryiko }
372db840d38SAndrii Nakryiko 
ltrim(const char * s)373db840d38SAndrii Nakryiko static const char *ltrim(const char *s)
374db840d38SAndrii Nakryiko {
375db840d38SAndrii Nakryiko 	while (isspace(*s))
376db840d38SAndrii Nakryiko 		s++;
377db840d38SAndrii Nakryiko 
378db840d38SAndrii Nakryiko 	return s;
379db840d38SAndrii Nakryiko }
380db840d38SAndrii Nakryiko 
verbose_linfo(struct bpf_verifier_env * env,u32 insn_off,const char * prefix_fmt,...)381db840d38SAndrii Nakryiko __printf(3, 4) void verbose_linfo(struct bpf_verifier_env *env,
382db840d38SAndrii Nakryiko 				  u32 insn_off,
383db840d38SAndrii Nakryiko 				  const char *prefix_fmt, ...)
384db840d38SAndrii Nakryiko {
38557354f5fSAndrii Nakryiko 	const struct bpf_line_info *linfo, *prev_linfo;
3867cc13adbSAndrii Nakryiko 	const struct btf *btf;
3877cc13adbSAndrii Nakryiko 	const char *s, *fname;
388db840d38SAndrii Nakryiko 
389db840d38SAndrii Nakryiko 	if (!bpf_verifier_log_needed(&env->log))
390db840d38SAndrii Nakryiko 		return;
391db840d38SAndrii Nakryiko 
39257354f5fSAndrii Nakryiko 	prev_linfo = env->prev_linfo;
393db840d38SAndrii Nakryiko 	linfo = find_linfo(env, insn_off);
39457354f5fSAndrii Nakryiko 	if (!linfo || linfo == prev_linfo)
39557354f5fSAndrii Nakryiko 		return;
39657354f5fSAndrii Nakryiko 
39757354f5fSAndrii Nakryiko 	/* It often happens that two separate linfo records point to the same
39857354f5fSAndrii Nakryiko 	 * source code line, but have differing column numbers. Given verifier
39957354f5fSAndrii Nakryiko 	 * log doesn't emit column information, from user perspective we just
40057354f5fSAndrii Nakryiko 	 * end up emitting the same source code line twice unnecessarily.
40157354f5fSAndrii Nakryiko 	 * So instead check that previous and current linfo record point to
40257354f5fSAndrii Nakryiko 	 * the same file (file_name_offs match) and the same line number, and
40357354f5fSAndrii Nakryiko 	 * avoid emitting duplicated source code line in such case.
40457354f5fSAndrii Nakryiko 	 */
40557354f5fSAndrii Nakryiko 	if (prev_linfo && linfo->file_name_off == prev_linfo->file_name_off &&
40657354f5fSAndrii Nakryiko 	    BPF_LINE_INFO_LINE_NUM(linfo->line_col) == BPF_LINE_INFO_LINE_NUM(prev_linfo->line_col))
407db840d38SAndrii Nakryiko 		return;
408db840d38SAndrii Nakryiko 
409db840d38SAndrii Nakryiko 	if (prefix_fmt) {
410db840d38SAndrii Nakryiko 		va_list args;
411db840d38SAndrii Nakryiko 
412db840d38SAndrii Nakryiko 		va_start(args, prefix_fmt);
413db840d38SAndrii Nakryiko 		bpf_verifier_vlog(&env->log, prefix_fmt, args);
414db840d38SAndrii Nakryiko 		va_end(args);
415db840d38SAndrii Nakryiko 	}
416db840d38SAndrii Nakryiko 
4177cc13adbSAndrii Nakryiko 	btf = env->prog->aux->btf;
4187cc13adbSAndrii Nakryiko 	s = ltrim(btf_name_by_offset(btf, linfo->line_off));
4197cc13adbSAndrii Nakryiko 	verbose(env, "%s", s); /* source code line */
4207cc13adbSAndrii Nakryiko 
4217cc13adbSAndrii Nakryiko 	s = btf_name_by_offset(btf, linfo->file_name_off);
4227cc13adbSAndrii Nakryiko 	/* leave only file name */
4237cc13adbSAndrii Nakryiko 	fname = strrchr(s, '/');
4247cc13adbSAndrii Nakryiko 	fname = fname ? fname + 1 : s;
4257cc13adbSAndrii Nakryiko 	verbose(env, " @ %s:%u\n", fname, BPF_LINE_INFO_LINE_NUM(linfo->line_col));
426db840d38SAndrii Nakryiko 
427db840d38SAndrii Nakryiko 	env->prev_linfo = linfo;
428db840d38SAndrii Nakryiko }
42942feb662SAndrii Nakryiko 
btf_type_name(const struct btf * btf,u32 id)43042feb662SAndrii Nakryiko static const char *btf_type_name(const struct btf *btf, u32 id)
43142feb662SAndrii Nakryiko {
43242feb662SAndrii Nakryiko 	return btf_name_by_offset(btf, btf_type_by_id(btf, id)->name_off);
43342feb662SAndrii Nakryiko }
43442feb662SAndrii Nakryiko 
43542feb662SAndrii Nakryiko /* string representation of 'enum bpf_reg_type'
43642feb662SAndrii Nakryiko  *
43742feb662SAndrii Nakryiko  * Note that reg_type_str() can not appear more than once in a single verbose()
43842feb662SAndrii Nakryiko  * statement.
43942feb662SAndrii Nakryiko  */
reg_type_str(struct bpf_verifier_env * env,enum bpf_reg_type type)44042feb662SAndrii Nakryiko const char *reg_type_str(struct bpf_verifier_env *env, enum bpf_reg_type type)
44142feb662SAndrii Nakryiko {
44242feb662SAndrii Nakryiko 	char postfix[16] = {0}, prefix[64] = {0};
44342feb662SAndrii Nakryiko 	static const char * const str[] = {
44442feb662SAndrii Nakryiko 		[NOT_INIT]		= "?",
44542feb662SAndrii Nakryiko 		[SCALAR_VALUE]		= "scalar",
44642feb662SAndrii Nakryiko 		[PTR_TO_CTX]		= "ctx",
44742feb662SAndrii Nakryiko 		[CONST_PTR_TO_MAP]	= "map_ptr",
44842feb662SAndrii Nakryiko 		[PTR_TO_MAP_VALUE]	= "map_value",
44942feb662SAndrii Nakryiko 		[PTR_TO_STACK]		= "fp",
45042feb662SAndrii Nakryiko 		[PTR_TO_PACKET]		= "pkt",
45142feb662SAndrii Nakryiko 		[PTR_TO_PACKET_META]	= "pkt_meta",
45242feb662SAndrii Nakryiko 		[PTR_TO_PACKET_END]	= "pkt_end",
45342feb662SAndrii Nakryiko 		[PTR_TO_FLOW_KEYS]	= "flow_keys",
45442feb662SAndrii Nakryiko 		[PTR_TO_SOCKET]		= "sock",
45542feb662SAndrii Nakryiko 		[PTR_TO_SOCK_COMMON]	= "sock_common",
45642feb662SAndrii Nakryiko 		[PTR_TO_TCP_SOCK]	= "tcp_sock",
45742feb662SAndrii Nakryiko 		[PTR_TO_TP_BUFFER]	= "tp_buffer",
45842feb662SAndrii Nakryiko 		[PTR_TO_XDP_SOCK]	= "xdp_sock",
45942feb662SAndrii Nakryiko 		[PTR_TO_BTF_ID]		= "ptr_",
46042feb662SAndrii Nakryiko 		[PTR_TO_MEM]		= "mem",
4616082b6c3SAlexei Starovoitov 		[PTR_TO_ARENA]		= "arena",
46242feb662SAndrii Nakryiko 		[PTR_TO_BUF]		= "buf",
46342feb662SAndrii Nakryiko 		[PTR_TO_FUNC]		= "func",
46442feb662SAndrii Nakryiko 		[PTR_TO_MAP_KEY]	= "map_key",
46542feb662SAndrii Nakryiko 		[CONST_PTR_TO_DYNPTR]	= "dynptr_ptr",
46642feb662SAndrii Nakryiko 	};
46742feb662SAndrii Nakryiko 
46842feb662SAndrii Nakryiko 	if (type & PTR_MAYBE_NULL) {
46942feb662SAndrii Nakryiko 		if (base_type(type) == PTR_TO_BTF_ID)
4702e114248SJustin Stitt 			strscpy(postfix, "or_null_");
47142feb662SAndrii Nakryiko 		else
4722e114248SJustin Stitt 			strscpy(postfix, "_or_null");
47342feb662SAndrii Nakryiko 	}
47442feb662SAndrii Nakryiko 
47542feb662SAndrii Nakryiko 	snprintf(prefix, sizeof(prefix), "%s%s%s%s%s%s%s",
47642feb662SAndrii Nakryiko 		 type & MEM_RDONLY ? "rdonly_" : "",
47742feb662SAndrii Nakryiko 		 type & MEM_RINGBUF ? "ringbuf_" : "",
47842feb662SAndrii Nakryiko 		 type & MEM_USER ? "user_" : "",
47942feb662SAndrii Nakryiko 		 type & MEM_PERCPU ? "percpu_" : "",
48042feb662SAndrii Nakryiko 		 type & MEM_RCU ? "rcu_" : "",
48142feb662SAndrii Nakryiko 		 type & PTR_UNTRUSTED ? "untrusted_" : "",
48242feb662SAndrii Nakryiko 		 type & PTR_TRUSTED ? "trusted_" : ""
48342feb662SAndrii Nakryiko 	);
48442feb662SAndrii Nakryiko 
48542feb662SAndrii Nakryiko 	snprintf(env->tmp_str_buf, TMP_STR_BUF_LEN, "%s%s%s",
48642feb662SAndrii Nakryiko 		 prefix, str[base_type(type)], postfix);
48742feb662SAndrii Nakryiko 	return env->tmp_str_buf;
48842feb662SAndrii Nakryiko }
48942feb662SAndrii Nakryiko 
dynptr_type_str(enum bpf_dynptr_type type)49042feb662SAndrii Nakryiko const char *dynptr_type_str(enum bpf_dynptr_type type)
49142feb662SAndrii Nakryiko {
49242feb662SAndrii Nakryiko 	switch (type) {
49342feb662SAndrii Nakryiko 	case BPF_DYNPTR_TYPE_LOCAL:
49442feb662SAndrii Nakryiko 		return "local";
49542feb662SAndrii Nakryiko 	case BPF_DYNPTR_TYPE_RINGBUF:
49642feb662SAndrii Nakryiko 		return "ringbuf";
49742feb662SAndrii Nakryiko 	case BPF_DYNPTR_TYPE_SKB:
49842feb662SAndrii Nakryiko 		return "skb";
49942feb662SAndrii Nakryiko 	case BPF_DYNPTR_TYPE_XDP:
50042feb662SAndrii Nakryiko 		return "xdp";
50142feb662SAndrii Nakryiko 	case BPF_DYNPTR_TYPE_INVALID:
50242feb662SAndrii Nakryiko 		return "<invalid>";
50342feb662SAndrii Nakryiko 	default:
50442feb662SAndrii Nakryiko 		WARN_ONCE(1, "unknown dynptr type %d\n", type);
50542feb662SAndrii Nakryiko 		return "<unknown>";
50642feb662SAndrii Nakryiko 	}
50742feb662SAndrii Nakryiko }
50842feb662SAndrii Nakryiko 
iter_type_str(const struct btf * btf,u32 btf_id)50942feb662SAndrii Nakryiko const char *iter_type_str(const struct btf *btf, u32 btf_id)
51042feb662SAndrii Nakryiko {
51142feb662SAndrii Nakryiko 	if (!btf || btf_id == 0)
51242feb662SAndrii Nakryiko 		return "<invalid>";
51342feb662SAndrii Nakryiko 
51442feb662SAndrii Nakryiko 	/* we already validated that type is valid and has conforming name */
51542feb662SAndrii Nakryiko 	return btf_type_name(btf, btf_id) + sizeof(ITER_PREFIX) - 1;
51642feb662SAndrii Nakryiko }
51742feb662SAndrii Nakryiko 
iter_state_str(enum bpf_iter_state state)51842feb662SAndrii Nakryiko const char *iter_state_str(enum bpf_iter_state state)
51942feb662SAndrii Nakryiko {
52042feb662SAndrii Nakryiko 	switch (state) {
52142feb662SAndrii Nakryiko 	case BPF_ITER_STATE_ACTIVE:
52242feb662SAndrii Nakryiko 		return "active";
52342feb662SAndrii Nakryiko 	case BPF_ITER_STATE_DRAINED:
52442feb662SAndrii Nakryiko 		return "drained";
52542feb662SAndrii Nakryiko 	case BPF_ITER_STATE_INVALID:
52642feb662SAndrii Nakryiko 		return "<invalid>";
52742feb662SAndrii Nakryiko 	default:
52842feb662SAndrii Nakryiko 		WARN_ONCE(1, "unknown iter state %d\n", state);
52942feb662SAndrii Nakryiko 		return "<unknown>";
53042feb662SAndrii Nakryiko 	}
53142feb662SAndrii Nakryiko }
53242feb662SAndrii Nakryiko 
53342feb662SAndrii Nakryiko static char slot_type_char[] = {
53442feb662SAndrii Nakryiko 	[STACK_INVALID]	= '?',
53542feb662SAndrii Nakryiko 	[STACK_SPILL]	= 'r',
53642feb662SAndrii Nakryiko 	[STACK_MISC]	= 'm',
53742feb662SAndrii Nakryiko 	[STACK_ZERO]	= '0',
53842feb662SAndrii Nakryiko 	[STACK_DYNPTR]	= 'd',
53942feb662SAndrii Nakryiko 	[STACK_ITER]	= 'i',
540*c8e2ee1fSKumar Kartikeya Dwivedi 	[STACK_IRQ_FLAG] = 'f'
54142feb662SAndrii Nakryiko };
54242feb662SAndrii Nakryiko 
print_liveness(struct bpf_verifier_env * env,enum bpf_reg_liveness live)54342feb662SAndrii Nakryiko static void print_liveness(struct bpf_verifier_env *env,
54442feb662SAndrii Nakryiko 			   enum bpf_reg_liveness live)
54542feb662SAndrii Nakryiko {
54642feb662SAndrii Nakryiko 	if (live & (REG_LIVE_READ | REG_LIVE_WRITTEN | REG_LIVE_DONE))
54742feb662SAndrii Nakryiko 	    verbose(env, "_");
54842feb662SAndrii Nakryiko 	if (live & REG_LIVE_READ)
54942feb662SAndrii Nakryiko 		verbose(env, "r");
55042feb662SAndrii Nakryiko 	if (live & REG_LIVE_WRITTEN)
55142feb662SAndrii Nakryiko 		verbose(env, "w");
55242feb662SAndrii Nakryiko 	if (live & REG_LIVE_DONE)
55342feb662SAndrii Nakryiko 		verbose(env, "D");
55442feb662SAndrii Nakryiko }
55542feb662SAndrii Nakryiko 
5560f8dbdbcSAndrii Nakryiko #define UNUM_MAX_DECIMAL U16_MAX
5570f8dbdbcSAndrii Nakryiko #define SNUM_MAX_DECIMAL S16_MAX
5580f8dbdbcSAndrii Nakryiko #define SNUM_MIN_DECIMAL S16_MIN
5590f8dbdbcSAndrii Nakryiko 
is_unum_decimal(u64 num)5600f8dbdbcSAndrii Nakryiko static bool is_unum_decimal(u64 num)
5610f8dbdbcSAndrii Nakryiko {
5620f8dbdbcSAndrii Nakryiko 	return num <= UNUM_MAX_DECIMAL;
5630f8dbdbcSAndrii Nakryiko }
5640f8dbdbcSAndrii Nakryiko 
is_snum_decimal(s64 num)5650f8dbdbcSAndrii Nakryiko static bool is_snum_decimal(s64 num)
5660f8dbdbcSAndrii Nakryiko {
5670f8dbdbcSAndrii Nakryiko 	return num >= SNUM_MIN_DECIMAL && num <= SNUM_MAX_DECIMAL;
5680f8dbdbcSAndrii Nakryiko }
5690f8dbdbcSAndrii Nakryiko 
verbose_unum(struct bpf_verifier_env * env,u64 num)5700f8dbdbcSAndrii Nakryiko static void verbose_unum(struct bpf_verifier_env *env, u64 num)
5710f8dbdbcSAndrii Nakryiko {
5720f8dbdbcSAndrii Nakryiko 	if (is_unum_decimal(num))
5730f8dbdbcSAndrii Nakryiko 		verbose(env, "%llu", num);
5740f8dbdbcSAndrii Nakryiko 	else
5750f8dbdbcSAndrii Nakryiko 		verbose(env, "%#llx", num);
5760f8dbdbcSAndrii Nakryiko }
5770f8dbdbcSAndrii Nakryiko 
verbose_snum(struct bpf_verifier_env * env,s64 num)5780f8dbdbcSAndrii Nakryiko static void verbose_snum(struct bpf_verifier_env *env, s64 num)
5790f8dbdbcSAndrii Nakryiko {
5800f8dbdbcSAndrii Nakryiko 	if (is_snum_decimal(num))
5810f8dbdbcSAndrii Nakryiko 		verbose(env, "%lld", num);
5820f8dbdbcSAndrii Nakryiko 	else
5830f8dbdbcSAndrii Nakryiko 		verbose(env, "%#llx", num);
5840f8dbdbcSAndrii Nakryiko }
5850f8dbdbcSAndrii Nakryiko 
tnum_strn(char * str,size_t size,struct tnum a)58681eff2e3SAndrii Nakryiko int tnum_strn(char *str, size_t size, struct tnum a)
58781eff2e3SAndrii Nakryiko {
58881eff2e3SAndrii Nakryiko 	/* print as a constant, if tnum is fully known */
58981eff2e3SAndrii Nakryiko 	if (a.mask == 0) {
59081eff2e3SAndrii Nakryiko 		if (is_unum_decimal(a.value))
59181eff2e3SAndrii Nakryiko 			return snprintf(str, size, "%llu", a.value);
59281eff2e3SAndrii Nakryiko 		else
59381eff2e3SAndrii Nakryiko 			return snprintf(str, size, "%#llx", a.value);
59481eff2e3SAndrii Nakryiko 	}
59581eff2e3SAndrii Nakryiko 	return snprintf(str, size, "(%#llx; %#llx)", a.value, a.mask);
59681eff2e3SAndrii Nakryiko }
59781eff2e3SAndrii Nakryiko EXPORT_SYMBOL_GPL(tnum_strn);
59881eff2e3SAndrii Nakryiko 
print_scalar_ranges(struct bpf_verifier_env * env,const struct bpf_reg_state * reg,const char ** sep)59942feb662SAndrii Nakryiko static void print_scalar_ranges(struct bpf_verifier_env *env,
60042feb662SAndrii Nakryiko 				const struct bpf_reg_state *reg,
60142feb662SAndrii Nakryiko 				const char **sep)
60242feb662SAndrii Nakryiko {
6030f8dbdbcSAndrii Nakryiko 	/* For signed ranges, we want to unify 64-bit and 32-bit values in the
6040f8dbdbcSAndrii Nakryiko 	 * output as much as possible, but there is a bit of a complication.
6050f8dbdbcSAndrii Nakryiko 	 * If we choose to print values as decimals, this is natural to do,
6060f8dbdbcSAndrii Nakryiko 	 * because negative 64-bit and 32-bit values >= -S32_MIN have the same
6070f8dbdbcSAndrii Nakryiko 	 * representation due to sign extension. But if we choose to print
6080f8dbdbcSAndrii Nakryiko 	 * them in hex format (see is_snum_decimal()), then sign extension is
6090f8dbdbcSAndrii Nakryiko 	 * misleading.
6100f8dbdbcSAndrii Nakryiko 	 * E.g., smin=-2 and smin32=-2 are exactly the same in decimal, but in
6110f8dbdbcSAndrii Nakryiko 	 * hex they will be smin=0xfffffffffffffffe and smin32=0xfffffffe, two
6120f8dbdbcSAndrii Nakryiko 	 * very different numbers.
6130f8dbdbcSAndrii Nakryiko 	 * So we avoid sign extension if we choose to print values in hex.
6140f8dbdbcSAndrii Nakryiko 	 */
61542feb662SAndrii Nakryiko 	struct {
61642feb662SAndrii Nakryiko 		const char *name;
61742feb662SAndrii Nakryiko 		u64 val;
61842feb662SAndrii Nakryiko 		bool omit;
61942feb662SAndrii Nakryiko 	} minmaxs[] = {
62042feb662SAndrii Nakryiko 		{"smin",   reg->smin_value,         reg->smin_value == S64_MIN},
62142feb662SAndrii Nakryiko 		{"smax",   reg->smax_value,         reg->smax_value == S64_MAX},
62242feb662SAndrii Nakryiko 		{"umin",   reg->umin_value,         reg->umin_value == 0},
62342feb662SAndrii Nakryiko 		{"umax",   reg->umax_value,         reg->umax_value == U64_MAX},
6240f8dbdbcSAndrii Nakryiko 		{"smin32",
6250f8dbdbcSAndrii Nakryiko 		 is_snum_decimal((s64)reg->s32_min_value)
6260f8dbdbcSAndrii Nakryiko 			 ? (s64)reg->s32_min_value
6270f8dbdbcSAndrii Nakryiko 			 : (u32)reg->s32_min_value, reg->s32_min_value == S32_MIN},
6280f8dbdbcSAndrii Nakryiko 		{"smax32",
6290f8dbdbcSAndrii Nakryiko 		 is_snum_decimal((s64)reg->s32_max_value)
6300f8dbdbcSAndrii Nakryiko 			 ? (s64)reg->s32_max_value
6310f8dbdbcSAndrii Nakryiko 			 : (u32)reg->s32_max_value, reg->s32_max_value == S32_MAX},
63242feb662SAndrii Nakryiko 		{"umin32", reg->u32_min_value,      reg->u32_min_value == 0},
63342feb662SAndrii Nakryiko 		{"umax32", reg->u32_max_value,      reg->u32_max_value == U32_MAX},
63442feb662SAndrii Nakryiko 	}, *m1, *m2, *mend = &minmaxs[ARRAY_SIZE(minmaxs)];
63542feb662SAndrii Nakryiko 	bool neg1, neg2;
63642feb662SAndrii Nakryiko 
63742feb662SAndrii Nakryiko 	for (m1 = &minmaxs[0]; m1 < mend; m1++) {
63842feb662SAndrii Nakryiko 		if (m1->omit)
63942feb662SAndrii Nakryiko 			continue;
64042feb662SAndrii Nakryiko 
64142feb662SAndrii Nakryiko 		neg1 = m1->name[0] == 's' && (s64)m1->val < 0;
64242feb662SAndrii Nakryiko 
64342feb662SAndrii Nakryiko 		verbose(env, "%s%s=", *sep, m1->name);
64442feb662SAndrii Nakryiko 		*sep = ",";
64542feb662SAndrii Nakryiko 
64642feb662SAndrii Nakryiko 		for (m2 = m1 + 2; m2 < mend; m2 += 2) {
64742feb662SAndrii Nakryiko 			if (m2->omit || m2->val != m1->val)
64842feb662SAndrii Nakryiko 				continue;
64942feb662SAndrii Nakryiko 			/* don't mix negatives with positives */
65042feb662SAndrii Nakryiko 			neg2 = m2->name[0] == 's' && (s64)m2->val < 0;
65142feb662SAndrii Nakryiko 			if (neg2 != neg1)
65242feb662SAndrii Nakryiko 				continue;
65342feb662SAndrii Nakryiko 			m2->omit = true;
65442feb662SAndrii Nakryiko 			verbose(env, "%s=", m2->name);
65542feb662SAndrii Nakryiko 		}
65642feb662SAndrii Nakryiko 
6570f8dbdbcSAndrii Nakryiko 		if (m1->name[0] == 's')
6580f8dbdbcSAndrii Nakryiko 			verbose_snum(env, m1->val);
6590f8dbdbcSAndrii Nakryiko 		else
6600f8dbdbcSAndrii Nakryiko 			verbose_unum(env, m1->val);
66142feb662SAndrii Nakryiko 	}
66242feb662SAndrii Nakryiko }
66342feb662SAndrii Nakryiko 
type_is_map_ptr(enum bpf_reg_type t)6640c95c9fdSAndrii Nakryiko static bool type_is_map_ptr(enum bpf_reg_type t) {
6650c95c9fdSAndrii Nakryiko 	switch (base_type(t)) {
6660c95c9fdSAndrii Nakryiko 	case CONST_PTR_TO_MAP:
6670c95c9fdSAndrii Nakryiko 	case PTR_TO_MAP_KEY:
6680c95c9fdSAndrii Nakryiko 	case PTR_TO_MAP_VALUE:
6690c95c9fdSAndrii Nakryiko 		return true;
6700c95c9fdSAndrii Nakryiko 	default:
6710c95c9fdSAndrii Nakryiko 		return false;
6720c95c9fdSAndrii Nakryiko 	}
6730c95c9fdSAndrii Nakryiko }
6740c95c9fdSAndrii Nakryiko 
67522b769bbSAndrii Nakryiko /*
67622b769bbSAndrii Nakryiko  * _a stands for append, was shortened to avoid multiline statements below.
67722b769bbSAndrii Nakryiko  * This macro is used to output a comma separated list of attributes.
67822b769bbSAndrii Nakryiko  */
67922b769bbSAndrii Nakryiko #define verbose_a(fmt, ...) ({ verbose(env, "%s" fmt, sep, ##__VA_ARGS__); sep = ","; })
68022b769bbSAndrii Nakryiko 
print_reg_state(struct bpf_verifier_env * env,const struct bpf_func_state * state,const struct bpf_reg_state * reg)68146862ee8SAndrii Nakryiko static void print_reg_state(struct bpf_verifier_env *env,
68246862ee8SAndrii Nakryiko 			    const struct bpf_func_state *state,
68346862ee8SAndrii Nakryiko 			    const struct bpf_reg_state *reg)
68442feb662SAndrii Nakryiko {
68542feb662SAndrii Nakryiko 	enum bpf_reg_type t;
686009f5465SAndrii Nakryiko 	const char *sep = "";
68742feb662SAndrii Nakryiko 
68842feb662SAndrii Nakryiko 	t = reg->type;
68942feb662SAndrii Nakryiko 	if (t == SCALAR_VALUE && reg->precise)
69042feb662SAndrii Nakryiko 		verbose(env, "P");
69146862ee8SAndrii Nakryiko 	if (t == SCALAR_VALUE && tnum_is_const(reg->var_off)) {
6923e9e7087SDaniel Borkmann 		verbose_snum(env, reg->var_off.value);
693009f5465SAndrii Nakryiko 		return;
694009f5465SAndrii Nakryiko 	}
69542feb662SAndrii Nakryiko 
696009f5465SAndrii Nakryiko 	verbose(env, "%s", reg_type_str(env, t));
6976082b6c3SAlexei Starovoitov 	if (t == PTR_TO_ARENA)
6986082b6c3SAlexei Starovoitov 		return;
69946862ee8SAndrii Nakryiko 	if (t == PTR_TO_STACK) {
70046862ee8SAndrii Nakryiko 		if (state->frameno != reg->frameno)
70146862ee8SAndrii Nakryiko 			verbose(env, "[%d]", reg->frameno);
70246862ee8SAndrii Nakryiko 		if (tnum_is_const(reg->var_off)) {
70346862ee8SAndrii Nakryiko 			verbose_snum(env, reg->var_off.value + reg->off);
70446862ee8SAndrii Nakryiko 			return;
70546862ee8SAndrii Nakryiko 		}
70646862ee8SAndrii Nakryiko 	}
707009f5465SAndrii Nakryiko 	if (base_type(t) == PTR_TO_BTF_ID)
708009f5465SAndrii Nakryiko 		verbose(env, "%s", btf_type_name(reg->btf, reg->btf_id));
709009f5465SAndrii Nakryiko 	verbose(env, "(");
71042feb662SAndrii Nakryiko 	if (reg->id)
71198d7ca37SAlexei Starovoitov 		verbose_a("id=%d", reg->id & ~BPF_ADD_CONST);
71298d7ca37SAlexei Starovoitov 	if (reg->id & BPF_ADD_CONST)
71398d7ca37SAlexei Starovoitov 		verbose(env, "%+d", reg->off);
71442feb662SAndrii Nakryiko 	if (reg->ref_obj_id)
71542feb662SAndrii Nakryiko 		verbose_a("ref_obj_id=%d", reg->ref_obj_id);
71642feb662SAndrii Nakryiko 	if (type_is_non_owning_ref(reg->type))
71742feb662SAndrii Nakryiko 		verbose_a("%s", "non_own_ref");
7180c95c9fdSAndrii Nakryiko 	if (type_is_map_ptr(t)) {
7190c95c9fdSAndrii Nakryiko 		if (reg->map_ptr->name[0])
7200c95c9fdSAndrii Nakryiko 			verbose_a("map=%s", reg->map_ptr->name);
7210c95c9fdSAndrii Nakryiko 		verbose_a("ks=%d,vs=%d",
7220c95c9fdSAndrii Nakryiko 			  reg->map_ptr->key_size,
7230c95c9fdSAndrii Nakryiko 			  reg->map_ptr->value_size);
7240c95c9fdSAndrii Nakryiko 	}
7250f8dbdbcSAndrii Nakryiko 	if (t != SCALAR_VALUE && reg->off) {
7260f8dbdbcSAndrii Nakryiko 		verbose_a("off=");
7270f8dbdbcSAndrii Nakryiko 		verbose_snum(env, reg->off);
7280f8dbdbcSAndrii Nakryiko 	}
7290f8dbdbcSAndrii Nakryiko 	if (type_is_pkt_pointer(t)) {
7300f8dbdbcSAndrii Nakryiko 		verbose_a("r=");
7310f8dbdbcSAndrii Nakryiko 		verbose_unum(env, reg->range);
7320f8dbdbcSAndrii Nakryiko 	}
7331e68485dSAndrii Nakryiko 	if (base_type(t) == PTR_TO_MEM) {
7341e68485dSAndrii Nakryiko 		verbose_a("sz=");
7351e68485dSAndrii Nakryiko 		verbose_unum(env, reg->mem_size);
7361e68485dSAndrii Nakryiko 	}
73722b769bbSAndrii Nakryiko 	if (t == CONST_PTR_TO_DYNPTR)
73822b769bbSAndrii Nakryiko 		verbose_a("type=%s",  dynptr_type_str(reg->dynptr.type));
73942feb662SAndrii Nakryiko 	if (tnum_is_const(reg->var_off)) {
7401db747d7SAndrii Nakryiko 		/* a pointer register with fixed offset */
7410f8dbdbcSAndrii Nakryiko 		if (reg->var_off.value) {
7420f8dbdbcSAndrii Nakryiko 			verbose_a("imm=");
7430f8dbdbcSAndrii Nakryiko 			verbose_snum(env, reg->var_off.value);
7440f8dbdbcSAndrii Nakryiko 		}
74542feb662SAndrii Nakryiko 	} else {
74642feb662SAndrii Nakryiko 		print_scalar_ranges(env, reg, &sep);
74742feb662SAndrii Nakryiko 		if (!tnum_is_unknown(reg->var_off)) {
74842feb662SAndrii Nakryiko 			char tn_buf[48];
74942feb662SAndrii Nakryiko 
75042feb662SAndrii Nakryiko 			tnum_strn(tn_buf, sizeof(tn_buf), reg->var_off);
75142feb662SAndrii Nakryiko 			verbose_a("var_off=%s", tn_buf);
75242feb662SAndrii Nakryiko 		}
75342feb662SAndrii Nakryiko 	}
75442feb662SAndrii Nakryiko 	verbose(env, ")");
75542feb662SAndrii Nakryiko }
756009f5465SAndrii Nakryiko 
print_verifier_state(struct bpf_verifier_env * env,const struct bpf_verifier_state * vstate,u32 frameno,bool print_all)7571995edc5SKumar Kartikeya Dwivedi void print_verifier_state(struct bpf_verifier_env *env, const struct bpf_verifier_state *vstate,
7581995edc5SKumar Kartikeya Dwivedi 			  u32 frameno, bool print_all)
759009f5465SAndrii Nakryiko {
7601995edc5SKumar Kartikeya Dwivedi 	const struct bpf_func_state *state = vstate->frame[frameno];
761009f5465SAndrii Nakryiko 	const struct bpf_reg_state *reg;
762009f5465SAndrii Nakryiko 	int i;
763009f5465SAndrii Nakryiko 
764009f5465SAndrii Nakryiko 	if (state->frameno)
765009f5465SAndrii Nakryiko 		verbose(env, " frame%d:", state->frameno);
766009f5465SAndrii Nakryiko 	for (i = 0; i < MAX_BPF_REG; i++) {
767009f5465SAndrii Nakryiko 		reg = &state->regs[i];
768009f5465SAndrii Nakryiko 		if (reg->type == NOT_INIT)
769009f5465SAndrii Nakryiko 			continue;
770009f5465SAndrii Nakryiko 		if (!print_all && !reg_scratched(env, i))
771009f5465SAndrii Nakryiko 			continue;
772009f5465SAndrii Nakryiko 		verbose(env, " R%d", i);
773009f5465SAndrii Nakryiko 		print_liveness(env, reg->live);
774009f5465SAndrii Nakryiko 		verbose(env, "=");
77546862ee8SAndrii Nakryiko 		print_reg_state(env, state, reg);
77642feb662SAndrii Nakryiko 	}
77742feb662SAndrii Nakryiko 	for (i = 0; i < state->allocated_stack / BPF_REG_SIZE; i++) {
77842feb662SAndrii Nakryiko 		char types_buf[BPF_REG_SIZE + 1];
77922b769bbSAndrii Nakryiko 		const char *sep = "";
78042feb662SAndrii Nakryiko 		bool valid = false;
78167d43dfbSAndrii Nakryiko 		u8 slot_type;
78242feb662SAndrii Nakryiko 		int j;
78342feb662SAndrii Nakryiko 
78467d43dfbSAndrii Nakryiko 		if (!print_all && !stack_slot_scratched(env, i))
78567d43dfbSAndrii Nakryiko 			continue;
78667d43dfbSAndrii Nakryiko 
78742feb662SAndrii Nakryiko 		for (j = 0; j < BPF_REG_SIZE; j++) {
78867d43dfbSAndrii Nakryiko 			slot_type = state->stack[i].slot_type[j];
78967d43dfbSAndrii Nakryiko 			if (slot_type != STACK_INVALID)
79042feb662SAndrii Nakryiko 				valid = true;
79167d43dfbSAndrii Nakryiko 			types_buf[j] = slot_type_char[slot_type];
79242feb662SAndrii Nakryiko 		}
79342feb662SAndrii Nakryiko 		types_buf[BPF_REG_SIZE] = 0;
79442feb662SAndrii Nakryiko 		if (!valid)
79542feb662SAndrii Nakryiko 			continue;
79667d43dfbSAndrii Nakryiko 
79767d43dfbSAndrii Nakryiko 		reg = &state->stack[i].spilled_ptr;
79842feb662SAndrii Nakryiko 		switch (state->stack[i].slot_type[BPF_REG_SIZE - 1]) {
79942feb662SAndrii Nakryiko 		case STACK_SPILL:
80067d43dfbSAndrii Nakryiko 			/* print MISC/ZERO/INVALID slots above subreg spill */
80167d43dfbSAndrii Nakryiko 			for (j = 0; j < BPF_REG_SIZE; j++)
80267d43dfbSAndrii Nakryiko 				if (state->stack[i].slot_type[j] == STACK_SPILL)
80367d43dfbSAndrii Nakryiko 					break;
80467d43dfbSAndrii Nakryiko 			types_buf[j] = '\0';
80542feb662SAndrii Nakryiko 
80642feb662SAndrii Nakryiko 			verbose(env, " fp%d", (-i - 1) * BPF_REG_SIZE);
80742feb662SAndrii Nakryiko 			print_liveness(env, reg->live);
80867d43dfbSAndrii Nakryiko 			verbose(env, "=%s", types_buf);
80946862ee8SAndrii Nakryiko 			print_reg_state(env, state, reg);
81042feb662SAndrii Nakryiko 			break;
81142feb662SAndrii Nakryiko 		case STACK_DYNPTR:
81267d43dfbSAndrii Nakryiko 			/* skip to main dynptr slot */
81342feb662SAndrii Nakryiko 			i += BPF_DYNPTR_NR_SLOTS - 1;
81442feb662SAndrii Nakryiko 			reg = &state->stack[i].spilled_ptr;
81542feb662SAndrii Nakryiko 
81642feb662SAndrii Nakryiko 			verbose(env, " fp%d", (-i - 1) * BPF_REG_SIZE);
81742feb662SAndrii Nakryiko 			print_liveness(env, reg->live);
81822b769bbSAndrii Nakryiko 			verbose(env, "=dynptr_%s(", dynptr_type_str(reg->dynptr.type));
81922b769bbSAndrii Nakryiko 			if (reg->id)
82022b769bbSAndrii Nakryiko 				verbose_a("id=%d", reg->id);
82142feb662SAndrii Nakryiko 			if (reg->ref_obj_id)
82222b769bbSAndrii Nakryiko 				verbose_a("ref_id=%d", reg->ref_obj_id);
82322b769bbSAndrii Nakryiko 			if (reg->dynptr_id)
82422b769bbSAndrii Nakryiko 				verbose_a("dynptr_id=%d", reg->dynptr_id);
82522b769bbSAndrii Nakryiko 			verbose(env, ")");
82642feb662SAndrii Nakryiko 			break;
82742feb662SAndrii Nakryiko 		case STACK_ITER:
82842feb662SAndrii Nakryiko 			/* only main slot has ref_obj_id set; skip others */
82942feb662SAndrii Nakryiko 			if (!reg->ref_obj_id)
83042feb662SAndrii Nakryiko 				continue;
83142feb662SAndrii Nakryiko 
83242feb662SAndrii Nakryiko 			verbose(env, " fp%d", (-i - 1) * BPF_REG_SIZE);
83342feb662SAndrii Nakryiko 			print_liveness(env, reg->live);
83442feb662SAndrii Nakryiko 			verbose(env, "=iter_%s(ref_id=%d,state=%s,depth=%u)",
83542feb662SAndrii Nakryiko 				iter_type_str(reg->iter.btf, reg->iter.btf_id),
83642feb662SAndrii Nakryiko 				reg->ref_obj_id, iter_state_str(reg->iter.state),
83742feb662SAndrii Nakryiko 				reg->iter.depth);
83842feb662SAndrii Nakryiko 			break;
83942feb662SAndrii Nakryiko 		case STACK_MISC:
84042feb662SAndrii Nakryiko 		case STACK_ZERO:
84142feb662SAndrii Nakryiko 		default:
84242feb662SAndrii Nakryiko 			verbose(env, " fp%d", (-i - 1) * BPF_REG_SIZE);
84342feb662SAndrii Nakryiko 			print_liveness(env, reg->live);
84442feb662SAndrii Nakryiko 			verbose(env, "=%s", types_buf);
84542feb662SAndrii Nakryiko 			break;
84642feb662SAndrii Nakryiko 		}
84742feb662SAndrii Nakryiko 	}
8481995edc5SKumar Kartikeya Dwivedi 	if (vstate->acquired_refs && vstate->refs[0].id) {
8491995edc5SKumar Kartikeya Dwivedi 		verbose(env, " refs=%d", vstate->refs[0].id);
8501995edc5SKumar Kartikeya Dwivedi 		for (i = 1; i < vstate->acquired_refs; i++)
8511995edc5SKumar Kartikeya Dwivedi 			if (vstate->refs[i].id)
8521995edc5SKumar Kartikeya Dwivedi 				verbose(env, ",%d", vstate->refs[i].id);
85342feb662SAndrii Nakryiko 	}
85442feb662SAndrii Nakryiko 	if (state->in_callback_fn)
85542feb662SAndrii Nakryiko 		verbose(env, " cb");
85642feb662SAndrii Nakryiko 	if (state->in_async_callback_fn)
85742feb662SAndrii Nakryiko 		verbose(env, " async_cb");
85842feb662SAndrii Nakryiko 	verbose(env, "\n");
85942feb662SAndrii Nakryiko 	if (!print_all)
86042feb662SAndrii Nakryiko 		mark_verifier_state_clean(env);
86142feb662SAndrii Nakryiko }
86242feb662SAndrii Nakryiko 
vlog_alignment(u32 pos)86342feb662SAndrii Nakryiko static inline u32 vlog_alignment(u32 pos)
86442feb662SAndrii Nakryiko {
86542feb662SAndrii Nakryiko 	return round_up(max(pos + BPF_LOG_MIN_ALIGNMENT / 2, BPF_LOG_ALIGNMENT),
86642feb662SAndrii Nakryiko 			BPF_LOG_MIN_ALIGNMENT) - pos - 1;
86742feb662SAndrii Nakryiko }
86842feb662SAndrii Nakryiko 
print_insn_state(struct bpf_verifier_env * env,const struct bpf_verifier_state * vstate,u32 frameno)8691995edc5SKumar Kartikeya Dwivedi void print_insn_state(struct bpf_verifier_env *env, const struct bpf_verifier_state *vstate,
8701995edc5SKumar Kartikeya Dwivedi 		      u32 frameno)
87142feb662SAndrii Nakryiko {
87242feb662SAndrii Nakryiko 	if (env->prev_log_pos && env->prev_log_pos == env->log.end_pos) {
87342feb662SAndrii Nakryiko 		/* remove new line character */
87442feb662SAndrii Nakryiko 		bpf_vlog_reset(&env->log, env->prev_log_pos - 1);
87542feb662SAndrii Nakryiko 		verbose(env, "%*c;", vlog_alignment(env->prev_insn_print_pos), ' ');
87642feb662SAndrii Nakryiko 	} else {
87742feb662SAndrii Nakryiko 		verbose(env, "%d:", env->insn_idx);
87842feb662SAndrii Nakryiko 	}
8791995edc5SKumar Kartikeya Dwivedi 	print_verifier_state(env, vstate, frameno, false);
88042feb662SAndrii Nakryiko }
881