1076a95f5SAlan Maguire // SPDX-License-Identifier: GPL-2.0
2076a95f5SAlan Maguire /* Copyright (c) 2020, Oracle and/or its affiliates. */
3076a95f5SAlan Maguire
4cfe77683SAlan Maguire #include "btf_ptr.h"
5076a95f5SAlan Maguire #include <bpf/bpf_helpers.h>
6076a95f5SAlan Maguire #include <bpf/bpf_tracing.h>
7076a95f5SAlan Maguire #include <bpf/bpf_core_read.h>
8076a95f5SAlan Maguire
9076a95f5SAlan Maguire #include <errno.h>
10076a95f5SAlan Maguire
11076a95f5SAlan Maguire long ret = 0;
12076a95f5SAlan Maguire int num_subtests = 0;
13076a95f5SAlan Maguire int ran_subtests = 0;
14076a95f5SAlan Maguire bool skip = false;
15076a95f5SAlan Maguire
16076a95f5SAlan Maguire #define STRSIZE 2048
17076a95f5SAlan Maguire #define EXPECTED_STRSIZE 256
18076a95f5SAlan Maguire
19*42a382a4SIlya Leoshkevich #if defined(bpf_target_s390)
20*42a382a4SIlya Leoshkevich /* NULL points to a readable struct lowcore on s390, so take the last page */
21*42a382a4SIlya Leoshkevich #define BADPTR ((void *)0xFFFFFFFFFFFFF000ULL)
22*42a382a4SIlya Leoshkevich #else
23*42a382a4SIlya Leoshkevich #define BADPTR 0
24*42a382a4SIlya Leoshkevich #endif
25*42a382a4SIlya Leoshkevich
26076a95f5SAlan Maguire #ifndef ARRAY_SIZE
27076a95f5SAlan Maguire #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
28076a95f5SAlan Maguire #endif
29076a95f5SAlan Maguire
30076a95f5SAlan Maguire struct {
31076a95f5SAlan Maguire __uint(type, BPF_MAP_TYPE_PERCPU_ARRAY);
32076a95f5SAlan Maguire __uint(max_entries, 1);
33076a95f5SAlan Maguire __type(key, __u32);
34076a95f5SAlan Maguire __type(value, char[STRSIZE]);
35076a95f5SAlan Maguire } strdata SEC(".maps");
36076a95f5SAlan Maguire
__strncmp(const void * m1,const void * m2,size_t len)37076a95f5SAlan Maguire static int __strncmp(const void *m1, const void *m2, size_t len)
38076a95f5SAlan Maguire {
39076a95f5SAlan Maguire const unsigned char *s1 = m1;
40076a95f5SAlan Maguire const unsigned char *s2 = m2;
41076a95f5SAlan Maguire int i, delta = 0;
42076a95f5SAlan Maguire
43076a95f5SAlan Maguire for (i = 0; i < len; i++) {
44076a95f5SAlan Maguire delta = s1[i] - s2[i];
45076a95f5SAlan Maguire if (delta || s1[i] == 0 || s2[i] == 0)
46076a95f5SAlan Maguire break;
47076a95f5SAlan Maguire }
48076a95f5SAlan Maguire return delta;
49076a95f5SAlan Maguire }
50076a95f5SAlan Maguire
51076a95f5SAlan Maguire #if __has_builtin(__builtin_btf_type_id)
52076a95f5SAlan Maguire #define TEST_BTF(_str, _type, _flags, _expected, ...) \
53076a95f5SAlan Maguire do { \
54076a95f5SAlan Maguire static const char _expectedval[EXPECTED_STRSIZE] = \
55076a95f5SAlan Maguire _expected; \
56076a95f5SAlan Maguire __u64 _hflags = _flags | BTF_F_COMPACT; \
57076a95f5SAlan Maguire static _type _ptrdata = __VA_ARGS__; \
58076a95f5SAlan Maguire static struct btf_ptr _ptr = { }; \
59076a95f5SAlan Maguire int _cmp; \
60076a95f5SAlan Maguire \
61076a95f5SAlan Maguire ++num_subtests; \
62076a95f5SAlan Maguire if (ret < 0) \
63076a95f5SAlan Maguire break; \
64076a95f5SAlan Maguire ++ran_subtests; \
65076a95f5SAlan Maguire _ptr.ptr = &_ptrdata; \
66076a95f5SAlan Maguire _ptr.type_id = bpf_core_type_id_kernel(_type); \
67076a95f5SAlan Maguire if (_ptr.type_id <= 0) { \
68076a95f5SAlan Maguire ret = -EINVAL; \
69076a95f5SAlan Maguire break; \
70076a95f5SAlan Maguire } \
71076a95f5SAlan Maguire ret = bpf_snprintf_btf(_str, STRSIZE, \
72076a95f5SAlan Maguire &_ptr, sizeof(_ptr), _hflags); \
73076a95f5SAlan Maguire if (ret) \
74076a95f5SAlan Maguire break; \
75076a95f5SAlan Maguire _cmp = __strncmp(_str, _expectedval, EXPECTED_STRSIZE); \
76076a95f5SAlan Maguire if (_cmp != 0) { \
77076a95f5SAlan Maguire bpf_printk("(%d) got %s", _cmp, _str); \
78076a95f5SAlan Maguire bpf_printk("(%d) expected %s", _cmp, \
79076a95f5SAlan Maguire _expectedval); \
80076a95f5SAlan Maguire ret = -EBADMSG; \
81076a95f5SAlan Maguire break; \
82076a95f5SAlan Maguire } \
83076a95f5SAlan Maguire } while (0)
84076a95f5SAlan Maguire #endif
85076a95f5SAlan Maguire
86076a95f5SAlan Maguire /* Use where expected data string matches its stringified declaration */
87076a95f5SAlan Maguire #define TEST_BTF_C(_str, _type, _flags, ...) \
88076a95f5SAlan Maguire TEST_BTF(_str, _type, _flags, "(" #_type ")" #__VA_ARGS__, \
89076a95f5SAlan Maguire __VA_ARGS__)
90076a95f5SAlan Maguire
91076a95f5SAlan Maguire /* TRACE_EVENT(netif_receive_skb,
92076a95f5SAlan Maguire * TP_PROTO(struct sk_buff *skb),
93076a95f5SAlan Maguire */
94076a95f5SAlan Maguire SEC("tp_btf/netif_receive_skb")
BPF_PROG(trace_netif_receive_skb,struct sk_buff * skb)95076a95f5SAlan Maguire int BPF_PROG(trace_netif_receive_skb, struct sk_buff *skb)
96076a95f5SAlan Maguire {
97076a95f5SAlan Maguire static __u64 flags[] = { 0, BTF_F_COMPACT, BTF_F_ZERO, BTF_F_PTR_RAW,
98076a95f5SAlan Maguire BTF_F_NONAME, BTF_F_COMPACT | BTF_F_ZERO |
99076a95f5SAlan Maguire BTF_F_PTR_RAW | BTF_F_NONAME };
100076a95f5SAlan Maguire static struct btf_ptr p = { };
101076a95f5SAlan Maguire __u32 key = 0;
102076a95f5SAlan Maguire int i, __ret;
103076a95f5SAlan Maguire char *str;
104076a95f5SAlan Maguire
105076a95f5SAlan Maguire #if __has_builtin(__builtin_btf_type_id)
106076a95f5SAlan Maguire str = bpf_map_lookup_elem(&strdata, &key);
107076a95f5SAlan Maguire if (!str)
108076a95f5SAlan Maguire return 0;
109076a95f5SAlan Maguire
110076a95f5SAlan Maguire /* Ensure we can write skb string representation */
111076a95f5SAlan Maguire p.type_id = bpf_core_type_id_kernel(struct sk_buff);
112076a95f5SAlan Maguire p.ptr = skb;
113076a95f5SAlan Maguire for (i = 0; i < ARRAY_SIZE(flags); i++) {
114076a95f5SAlan Maguire ++num_subtests;
115076a95f5SAlan Maguire ret = bpf_snprintf_btf(str, STRSIZE, &p, sizeof(p), 0);
116076a95f5SAlan Maguire if (ret < 0)
117076a95f5SAlan Maguire bpf_printk("returned %d when writing skb", ret);
118076a95f5SAlan Maguire ++ran_subtests;
119076a95f5SAlan Maguire }
120076a95f5SAlan Maguire
121076a95f5SAlan Maguire /* Check invalid ptr value */
122*42a382a4SIlya Leoshkevich p.ptr = BADPTR;
123076a95f5SAlan Maguire __ret = bpf_snprintf_btf(str, STRSIZE, &p, sizeof(p), 0);
124076a95f5SAlan Maguire if (__ret >= 0) {
125*42a382a4SIlya Leoshkevich bpf_printk("printing %llx should generate error, got (%d)",
126*42a382a4SIlya Leoshkevich (unsigned long long)BADPTR, __ret);
127076a95f5SAlan Maguire ret = -ERANGE;
128076a95f5SAlan Maguire }
129076a95f5SAlan Maguire
130076a95f5SAlan Maguire /* Verify type display for various types. */
131076a95f5SAlan Maguire
132076a95f5SAlan Maguire /* simple int */
133076a95f5SAlan Maguire TEST_BTF_C(str, int, 0, 1234);
134076a95f5SAlan Maguire TEST_BTF(str, int, BTF_F_NONAME, "1234", 1234);
135076a95f5SAlan Maguire /* zero value should be printed at toplevel */
136076a95f5SAlan Maguire TEST_BTF(str, int, 0, "(int)0", 0);
137076a95f5SAlan Maguire TEST_BTF(str, int, BTF_F_NONAME, "0", 0);
138076a95f5SAlan Maguire TEST_BTF(str, int, BTF_F_ZERO, "(int)0", 0);
139076a95f5SAlan Maguire TEST_BTF(str, int, BTF_F_NONAME | BTF_F_ZERO, "0", 0);
140076a95f5SAlan Maguire TEST_BTF_C(str, int, 0, -4567);
141076a95f5SAlan Maguire TEST_BTF(str, int, BTF_F_NONAME, "-4567", -4567);
142076a95f5SAlan Maguire
143076a95f5SAlan Maguire /* simple char */
144076a95f5SAlan Maguire TEST_BTF_C(str, char, 0, 100);
145076a95f5SAlan Maguire TEST_BTF(str, char, BTF_F_NONAME, "100", 100);
146076a95f5SAlan Maguire /* zero value should be printed at toplevel */
147076a95f5SAlan Maguire TEST_BTF(str, char, 0, "(char)0", 0);
148076a95f5SAlan Maguire TEST_BTF(str, char, BTF_F_NONAME, "0", 0);
149076a95f5SAlan Maguire TEST_BTF(str, char, BTF_F_ZERO, "(char)0", 0);
150076a95f5SAlan Maguire TEST_BTF(str, char, BTF_F_NONAME | BTF_F_ZERO, "0", 0);
151076a95f5SAlan Maguire
152076a95f5SAlan Maguire /* simple typedef */
153076a95f5SAlan Maguire TEST_BTF_C(str, uint64_t, 0, 100);
154076a95f5SAlan Maguire TEST_BTF(str, u64, BTF_F_NONAME, "1", 1);
155076a95f5SAlan Maguire /* zero value should be printed at toplevel */
156076a95f5SAlan Maguire TEST_BTF(str, u64, 0, "(u64)0", 0);
157076a95f5SAlan Maguire TEST_BTF(str, u64, BTF_F_NONAME, "0", 0);
158076a95f5SAlan Maguire TEST_BTF(str, u64, BTF_F_ZERO, "(u64)0", 0);
159076a95f5SAlan Maguire TEST_BTF(str, u64, BTF_F_NONAME|BTF_F_ZERO, "0", 0);
160076a95f5SAlan Maguire
161076a95f5SAlan Maguire /* typedef struct */
162076a95f5SAlan Maguire TEST_BTF_C(str, atomic_t, 0, {.counter = (int)1,});
163076a95f5SAlan Maguire TEST_BTF(str, atomic_t, BTF_F_NONAME, "{1,}", {.counter = 1,});
164076a95f5SAlan Maguire /* typedef with 0 value should be printed at toplevel */
165076a95f5SAlan Maguire TEST_BTF(str, atomic_t, 0, "(atomic_t){}", {.counter = 0,});
166076a95f5SAlan Maguire TEST_BTF(str, atomic_t, BTF_F_NONAME, "{}", {.counter = 0,});
167076a95f5SAlan Maguire TEST_BTF(str, atomic_t, BTF_F_ZERO, "(atomic_t){.counter = (int)0,}",
168076a95f5SAlan Maguire {.counter = 0,});
169076a95f5SAlan Maguire TEST_BTF(str, atomic_t, BTF_F_NONAME|BTF_F_ZERO,
170076a95f5SAlan Maguire "{0,}", {.counter = 0,});
171076a95f5SAlan Maguire
172076a95f5SAlan Maguire /* enum where enum value does (and does not) exist */
173076a95f5SAlan Maguire TEST_BTF_C(str, enum bpf_cmd, 0, BPF_MAP_CREATE);
174076a95f5SAlan Maguire TEST_BTF(str, enum bpf_cmd, 0, "(enum bpf_cmd)BPF_MAP_CREATE", 0);
175076a95f5SAlan Maguire TEST_BTF(str, enum bpf_cmd, BTF_F_NONAME, "BPF_MAP_CREATE",
176076a95f5SAlan Maguire BPF_MAP_CREATE);
177076a95f5SAlan Maguire TEST_BTF(str, enum bpf_cmd, BTF_F_NONAME|BTF_F_ZERO,
178076a95f5SAlan Maguire "BPF_MAP_CREATE", 0);
179076a95f5SAlan Maguire
180076a95f5SAlan Maguire TEST_BTF(str, enum bpf_cmd, BTF_F_ZERO, "(enum bpf_cmd)BPF_MAP_CREATE",
181076a95f5SAlan Maguire BPF_MAP_CREATE);
182076a95f5SAlan Maguire TEST_BTF(str, enum bpf_cmd, BTF_F_NONAME|BTF_F_ZERO,
183076a95f5SAlan Maguire "BPF_MAP_CREATE", BPF_MAP_CREATE);
184076a95f5SAlan Maguire TEST_BTF_C(str, enum bpf_cmd, 0, 2000);
185076a95f5SAlan Maguire TEST_BTF(str, enum bpf_cmd, BTF_F_NONAME, "2000", 2000);
186076a95f5SAlan Maguire
187076a95f5SAlan Maguire /* simple struct */
188076a95f5SAlan Maguire TEST_BTF_C(str, struct btf_enum, 0,
189076a95f5SAlan Maguire {.name_off = (__u32)3,.val = (__s32)-1,});
190076a95f5SAlan Maguire TEST_BTF(str, struct btf_enum, BTF_F_NONAME, "{3,-1,}",
191076a95f5SAlan Maguire { .name_off = 3, .val = -1,});
192076a95f5SAlan Maguire TEST_BTF(str, struct btf_enum, BTF_F_NONAME, "{-1,}",
193076a95f5SAlan Maguire { .name_off = 0, .val = -1,});
194076a95f5SAlan Maguire TEST_BTF(str, struct btf_enum, BTF_F_NONAME|BTF_F_ZERO, "{0,-1,}",
195076a95f5SAlan Maguire { .name_off = 0, .val = -1,});
196076a95f5SAlan Maguire /* empty struct should be printed */
197076a95f5SAlan Maguire TEST_BTF(str, struct btf_enum, 0, "(struct btf_enum){}",
198076a95f5SAlan Maguire { .name_off = 0, .val = 0,});
199076a95f5SAlan Maguire TEST_BTF(str, struct btf_enum, BTF_F_NONAME, "{}",
200076a95f5SAlan Maguire { .name_off = 0, .val = 0,});
201076a95f5SAlan Maguire TEST_BTF(str, struct btf_enum, BTF_F_ZERO,
202076a95f5SAlan Maguire "(struct btf_enum){.name_off = (__u32)0,.val = (__s32)0,}",
203076a95f5SAlan Maguire { .name_off = 0, .val = 0,});
204076a95f5SAlan Maguire
205076a95f5SAlan Maguire /* struct with pointers */
206076a95f5SAlan Maguire TEST_BTF(str, struct list_head, BTF_F_PTR_RAW,
207076a95f5SAlan Maguire "(struct list_head){.next = (struct list_head *)0x0000000000000001,}",
208076a95f5SAlan Maguire { .next = (struct list_head *)1 });
209076a95f5SAlan Maguire /* NULL pointer should not be displayed */
210076a95f5SAlan Maguire TEST_BTF(str, struct list_head, BTF_F_PTR_RAW,
211076a95f5SAlan Maguire "(struct list_head){}",
212076a95f5SAlan Maguire { .next = (struct list_head *)0 });
213076a95f5SAlan Maguire
214076a95f5SAlan Maguire /* struct with char array */
215076a95f5SAlan Maguire TEST_BTF(str, struct bpf_prog_info, 0,
216076a95f5SAlan Maguire "(struct bpf_prog_info){.name = (char[])['f','o','o',],}",
217076a95f5SAlan Maguire { .name = "foo",});
218076a95f5SAlan Maguire TEST_BTF(str, struct bpf_prog_info, BTF_F_NONAME,
219076a95f5SAlan Maguire "{['f','o','o',],}",
220076a95f5SAlan Maguire {.name = "foo",});
221076a95f5SAlan Maguire /* leading null char means do not display string */
222076a95f5SAlan Maguire TEST_BTF(str, struct bpf_prog_info, 0,
223076a95f5SAlan Maguire "(struct bpf_prog_info){}",
224076a95f5SAlan Maguire {.name = {'\0', 'f', 'o', 'o'}});
225076a95f5SAlan Maguire /* handle non-printable characters */
226076a95f5SAlan Maguire TEST_BTF(str, struct bpf_prog_info, 0,
227076a95f5SAlan Maguire "(struct bpf_prog_info){.name = (char[])[1,2,3,],}",
228076a95f5SAlan Maguire { .name = {1, 2, 3, 0}});
229076a95f5SAlan Maguire
230076a95f5SAlan Maguire /* struct with non-char array */
231076a95f5SAlan Maguire TEST_BTF(str, struct __sk_buff, 0,
232076a95f5SAlan Maguire "(struct __sk_buff){.cb = (__u32[])[1,2,3,4,5,],}",
233076a95f5SAlan Maguire { .cb = {1, 2, 3, 4, 5,},});
234076a95f5SAlan Maguire TEST_BTF(str, struct __sk_buff, BTF_F_NONAME,
235076a95f5SAlan Maguire "{[1,2,3,4,5,],}",
236076a95f5SAlan Maguire { .cb = { 1, 2, 3, 4, 5},});
237076a95f5SAlan Maguire /* For non-char, arrays, show non-zero values only */
238076a95f5SAlan Maguire TEST_BTF(str, struct __sk_buff, 0,
239076a95f5SAlan Maguire "(struct __sk_buff){.cb = (__u32[])[1,],}",
240076a95f5SAlan Maguire { .cb = { 0, 0, 1, 0, 0},});
241076a95f5SAlan Maguire
242076a95f5SAlan Maguire /* struct with bitfields */
243076a95f5SAlan Maguire TEST_BTF_C(str, struct bpf_insn, 0,
244076a95f5SAlan Maguire {.code = (__u8)1,.dst_reg = (__u8)0x2,.src_reg = (__u8)0x3,.off = (__s16)4,.imm = (__s32)5,});
245076a95f5SAlan Maguire TEST_BTF(str, struct bpf_insn, BTF_F_NONAME, "{1,0x2,0x3,4,5,}",
246076a95f5SAlan Maguire {.code = 1, .dst_reg = 0x2, .src_reg = 0x3, .off = 4,
247076a95f5SAlan Maguire .imm = 5,});
248076a95f5SAlan Maguire #else
249076a95f5SAlan Maguire skip = true;
250076a95f5SAlan Maguire #endif
251076a95f5SAlan Maguire
252076a95f5SAlan Maguire return 0;
253076a95f5SAlan Maguire }
254076a95f5SAlan Maguire
255076a95f5SAlan Maguire char _license[] SEC("license") = "GPL";
256