]> git.ipfire.org Git - thirdparty/kernel/linux.git/blame - include/linux/btf.h
tools/resolve_btfids: Add support for 8-byte BTF sets
[thirdparty/kernel/linux.git] / include / linux / btf.h
CommitLineData
eb3f595d
MKL
1/* SPDX-License-Identifier: GPL-2.0 */
2/* Copyright (c) 2018 Facebook */
3
4#ifndef _LINUX_BTF_H
5#define _LINUX_BTF_H 1
6
7#include <linux/types.h>
14f267d9 8#include <linux/bpfptr.h>
38207291 9#include <uapi/linux/btf.h>
c4d0bfb4 10#include <uapi/linux/bpf.h>
eb3f595d 11
85d33df3 12#define BTF_TYPE_EMIT(type) ((void)(type *)0)
97a19caf 13#define BTF_TYPE_EMIT_ENUM(enum_val) ((void)enum_val)
85d33df3 14
dee872e1
KKD
15enum btf_kfunc_type {
16 BTF_KFUNC_TYPE_CHECK,
17 BTF_KFUNC_TYPE_ACQUIRE,
18 BTF_KFUNC_TYPE_RELEASE,
19 BTF_KFUNC_TYPE_RET_NULL,
a1ef1959 20 BTF_KFUNC_TYPE_KPTR_ACQUIRE,
dee872e1
KKD
21 BTF_KFUNC_TYPE_MAX,
22};
23
eb3f595d 24struct btf;
ffa0c1cf 25struct btf_member;
eb3f595d 26struct btf_type;
f56a653c 27union bpf_attr;
31d0bc81 28struct btf_show;
dee872e1
KKD
29struct btf_id_set;
30
31struct btf_kfunc_id_set {
32 struct module *owner;
33 union {
34 struct {
35 struct btf_id_set *check_set;
36 struct btf_id_set *acquire_set;
37 struct btf_id_set *release_set;
38 struct btf_id_set *ret_null_set;
a1ef1959 39 struct btf_id_set *kptr_acquire_set;
dee872e1
KKD
40 };
41 struct btf_id_set *sets[BTF_KFUNC_TYPE_MAX];
42 };
43};
eb3f595d 44
5ce937d6
KKD
45struct btf_id_dtor_kfunc {
46 u32 btf_id;
47 u32 kfunc_btf_id;
48};
49
14a324f6
KKD
50typedef void (*btf_dtor_kfunc_t)(void *);
51
60197cfb
MKL
52extern const struct file_operations btf_fops;
53
22dc4a0f 54void btf_get(struct btf *btf);
f56a653c 55void btf_put(struct btf *btf);
c571bd75 56int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr);
f56a653c 57struct btf *btf_get_by_fd(int fd);
60197cfb
MKL
58int btf_get_info_by_fd(const struct btf *btf,
59 const union bpf_attr *attr,
60 union bpf_attr __user *uattr);
eb3f595d
MKL
61/* Figure out the size of a type_id. If type_id is a modifier
62 * (e.g. const), it will be resolved to find out the type with size.
63 *
64 * For example:
65 * In describing "const void *", type_id is "const" and "const"
66 * refers to "void *". The return type will be "void *".
67 *
68 * If type_id is a simple "int", then return type will be "int".
69 *
70 * @btf: struct btf object
71 * @type_id: Find out the size of type_id. The type_id of the return
72 * type is set to *type_id.
73 * @ret_size: It can be NULL. If not NULL, the size of the return
74 * type is set to *ret_size.
75 * Return: The btf_type (resolved to another type with size info if needed).
76 * NULL is returned if type_id itself does not have size info
77 * (e.g. void) or it cannot be resolved to another type that
78 * has size info.
79 * *type_id and *ret_size will not be changed in the
80 * NULL return case.
81 */
82const struct btf_type *btf_type_id_size(const struct btf *btf,
83 u32 *type_id,
84 u32 *ret_size);
31d0bc81
AM
85
86/*
87 * Options to control show behaviour.
88 * - BTF_SHOW_COMPACT: no formatting around type information
89 * - BTF_SHOW_NONAME: no struct/union member names/types
90 * - BTF_SHOW_PTR_RAW: show raw (unobfuscated) pointer values;
91 * equivalent to %px.
92 * - BTF_SHOW_ZERO: show zero-valued struct/union members; they
93 * are not displayed by default
94 * - BTF_SHOW_UNSAFE: skip use of bpf_probe_read() to safely read
95 * data before displaying it.
96 */
c4d0bfb4
AM
97#define BTF_SHOW_COMPACT BTF_F_COMPACT
98#define BTF_SHOW_NONAME BTF_F_NONAME
99#define BTF_SHOW_PTR_RAW BTF_F_PTR_RAW
100#define BTF_SHOW_ZERO BTF_F_ZERO
31d0bc81
AM
101#define BTF_SHOW_UNSAFE (1ULL << 4)
102
b00b8dae
MKL
103void btf_type_seq_show(const struct btf *btf, u32 type_id, void *obj,
104 struct seq_file *m);
eb411377
AM
105int btf_type_seq_show_flags(const struct btf *btf, u32 type_id, void *obj,
106 struct seq_file *m, u64 flags);
31d0bc81
AM
107
108/*
109 * Copy len bytes of string representation of obj of BTF type_id into buf.
110 *
111 * @btf: struct btf object
112 * @type_id: type id of type obj points to
113 * @obj: pointer to typed data
114 * @buf: buffer to write to
115 * @len: maximum length to write to buf
116 * @flags: show options (see above)
117 *
118 * Return: length that would have been/was copied as per snprintf, or
119 * negative error.
120 */
121int btf_type_snprintf_show(const struct btf *btf, u32 type_id, void *obj,
122 char *buf, int len, u64 flags);
123
78958fca 124int btf_get_fd_by_id(u32 id);
22dc4a0f 125u32 btf_obj_id(const struct btf *btf);
290248a5 126bool btf_is_kernel(const struct btf *btf);
541c3bad
AN
127bool btf_is_module(const struct btf *btf);
128struct module *btf_try_get_module(const struct btf *btf);
129u32 btf_nr_types(const struct btf *btf);
ffa0c1cf
YS
130bool btf_member_is_reg_int(const struct btf *btf, const struct btf_type *s,
131 const struct btf_member *m,
132 u32 expected_offset, u32 expected_size);
d83525ca 133int btf_find_spin_lock(const struct btf *btf, const struct btf_type *t);
68134668 134int btf_find_timer(const struct btf *btf, const struct btf_type *t);
61df10c7
KKD
135struct bpf_map_value_off *btf_parse_kptrs(const struct btf *btf,
136 const struct btf_type *t);
2824ecb7 137bool btf_type_is_void(const struct btf_type *t);
27ae7997
MKL
138s32 btf_find_by_name_kind(const struct btf *btf, const char *name, u8 kind);
139const struct btf_type *btf_type_skip_modifiers(const struct btf *btf,
140 u32 id, u32 *res_id);
141const struct btf_type *btf_type_resolve_ptr(const struct btf *btf,
142 u32 id, u32 *res_id);
143const struct btf_type *btf_type_resolve_func_ptr(const struct btf *btf,
144 u32 id, u32 *res_id);
85d33df3
MKL
145const struct btf_type *
146btf_resolve_size(const struct btf *btf, const struct btf_type *type,
6298399b 147 u32 *type_size);
e6ac2450 148const char *btf_type_str(const struct btf_type *t);
27ae7997
MKL
149
150#define for_each_member(i, struct_type, member) \
151 for (i = 0, member = btf_type_member(struct_type); \
152 i < btf_type_vlen(struct_type); \
153 i++, member++)
f6161a8f 154
eaa6bcb7
HL
155#define for_each_vsi(i, datasec_type, member) \
156 for (i = 0, member = btf_type_var_secinfo(datasec_type); \
157 i < btf_type_vlen(datasec_type); \
158 i++, member++)
159
38207291
MKL
160static inline bool btf_type_is_ptr(const struct btf_type *t)
161{
162 return BTF_INFO_KIND(t->info) == BTF_KIND_PTR;
163}
164
165static inline bool btf_type_is_int(const struct btf_type *t)
166{
167 return BTF_INFO_KIND(t->info) == BTF_KIND_INT;
168}
169
a9b59159
JF
170static inline bool btf_type_is_small_int(const struct btf_type *t)
171{
172 return btf_type_is_int(t) && t->size <= sizeof(u64);
173}
174
38207291
MKL
175static inline bool btf_type_is_enum(const struct btf_type *t)
176{
177 return BTF_INFO_KIND(t->info) == BTF_KIND_ENUM;
178}
179
6089fb32
YS
180static inline bool btf_is_any_enum(const struct btf_type *t)
181{
182 return BTF_INFO_KIND(t->info) == BTF_KIND_ENUM ||
183 BTF_INFO_KIND(t->info) == BTF_KIND_ENUM64;
184}
185
186static inline bool btf_kind_core_compat(const struct btf_type *t1,
187 const struct btf_type *t2)
188{
189 return BTF_INFO_KIND(t1->info) == BTF_INFO_KIND(t2->info) ||
190 (btf_is_any_enum(t1) && btf_is_any_enum(t2));
191}
192
29db4bea
AS
193static inline bool str_is_empty(const char *s)
194{
195 return !s || !s[0];
196}
197
198static inline u16 btf_kind(const struct btf_type *t)
199{
200 return BTF_INFO_KIND(t->info);
201}
202
203static inline bool btf_is_enum(const struct btf_type *t)
204{
205 return btf_kind(t) == BTF_KIND_ENUM;
206}
207
6089fb32
YS
208static inline bool btf_is_enum64(const struct btf_type *t)
209{
210 return btf_kind(t) == BTF_KIND_ENUM64;
211}
212
213static inline u64 btf_enum64_value(const struct btf_enum64 *e)
214{
215 return ((u64)e->val_hi32 << 32) | e->val_lo32;
216}
217
29db4bea
AS
218static inline bool btf_is_composite(const struct btf_type *t)
219{
220 u16 kind = btf_kind(t);
221
222 return kind == BTF_KIND_STRUCT || kind == BTF_KIND_UNION;
223}
224
225static inline bool btf_is_array(const struct btf_type *t)
226{
227 return btf_kind(t) == BTF_KIND_ARRAY;
228}
229
230static inline bool btf_is_int(const struct btf_type *t)
231{
232 return btf_kind(t) == BTF_KIND_INT;
233}
234
235static inline bool btf_is_ptr(const struct btf_type *t)
236{
237 return btf_kind(t) == BTF_KIND_PTR;
238}
239
240static inline u8 btf_int_offset(const struct btf_type *t)
241{
242 return BTF_INT_OFFSET(*(u32 *)(t + 1));
243}
244
245static inline u8 btf_int_encoding(const struct btf_type *t)
246{
247 return BTF_INT_ENCODING(*(u32 *)(t + 1));
248}
249
34747c41
MKL
250static inline bool btf_type_is_scalar(const struct btf_type *t)
251{
252 return btf_type_is_int(t) || btf_type_is_enum(t);
253}
254
38207291
MKL
255static inline bool btf_type_is_typedef(const struct btf_type *t)
256{
257 return BTF_INFO_KIND(t->info) == BTF_KIND_TYPEDEF;
258}
259
260static inline bool btf_type_is_func(const struct btf_type *t)
261{
262 return BTF_INFO_KIND(t->info) == BTF_KIND_FUNC;
263}
264
265static inline bool btf_type_is_func_proto(const struct btf_type *t)
266{
267 return BTF_INFO_KIND(t->info) == BTF_KIND_FUNC_PROTO;
268}
269
4976b718
HL
270static inline bool btf_type_is_var(const struct btf_type *t)
271{
272 return BTF_INFO_KIND(t->info) == BTF_KIND_VAR;
273}
274
c6f1bfe8
YS
275static inline bool btf_type_is_type_tag(const struct btf_type *t)
276{
277 return BTF_INFO_KIND(t->info) == BTF_KIND_TYPE_TAG;
278}
279
4976b718
HL
280/* union is only a special case of struct:
281 * all its offsetof(member) == 0
282 */
283static inline bool btf_type_is_struct(const struct btf_type *t)
284{
285 u8 kind = BTF_INFO_KIND(t->info);
286
287 return kind == BTF_KIND_STRUCT || kind == BTF_KIND_UNION;
288}
289
27ae7997
MKL
290static inline u16 btf_type_vlen(const struct btf_type *t)
291{
292 return BTF_INFO_VLEN(t->info);
293}
294
29db4bea
AS
295static inline u16 btf_vlen(const struct btf_type *t)
296{
297 return btf_type_vlen(t);
298}
299
be8704ff
AS
300static inline u16 btf_func_linkage(const struct btf_type *t)
301{
302 return BTF_INFO_VLEN(t->info);
303}
304
27ae7997
MKL
305static inline bool btf_type_kflag(const struct btf_type *t)
306{
307 return BTF_INFO_KFLAG(t->info);
308}
309
8293eb99
AS
310static inline u32 __btf_member_bit_offset(const struct btf_type *struct_type,
311 const struct btf_member *member)
85d33df3
MKL
312{
313 return btf_type_kflag(struct_type) ? BTF_MEMBER_BIT_OFFSET(member->offset)
314 : member->offset;
315}
316
8293eb99
AS
317static inline u32 __btf_member_bitfield_size(const struct btf_type *struct_type,
318 const struct btf_member *member)
27ae7997
MKL
319{
320 return btf_type_kflag(struct_type) ? BTF_MEMBER_BITFIELD_SIZE(member->offset)
321 : 0;
322}
323
29db4bea
AS
324static inline struct btf_member *btf_members(const struct btf_type *t)
325{
326 return (struct btf_member *)(t + 1);
327}
328
329static inline u32 btf_member_bit_offset(const struct btf_type *t, u32 member_idx)
330{
331 const struct btf_member *m = btf_members(t) + member_idx;
332
333 return __btf_member_bit_offset(t, m);
334}
335
336static inline u32 btf_member_bitfield_size(const struct btf_type *t, u32 member_idx)
337{
338 const struct btf_member *m = btf_members(t) + member_idx;
339
340 return __btf_member_bitfield_size(t, m);
341}
342
27ae7997
MKL
343static inline const struct btf_member *btf_type_member(const struct btf_type *t)
344{
345 return (const struct btf_member *)(t + 1);
346}
347
29db4bea
AS
348static inline struct btf_array *btf_array(const struct btf_type *t)
349{
350 return (struct btf_array *)(t + 1);
351}
352
353static inline struct btf_enum *btf_enum(const struct btf_type *t)
354{
355 return (struct btf_enum *)(t + 1);
356}
357
6089fb32
YS
358static inline struct btf_enum64 *btf_enum64(const struct btf_type *t)
359{
360 return (struct btf_enum64 *)(t + 1);
361}
362
eaa6bcb7
HL
363static inline const struct btf_var_secinfo *btf_type_var_secinfo(
364 const struct btf_type *t)
365{
366 return (const struct btf_var_secinfo *)(t + 1);
367}
368
e70e13e7
MC
369static inline struct btf_param *btf_params(const struct btf_type *t)
370{
371 return (struct btf_param *)(t + 1);
372}
373
f6161a8f 374#ifdef CONFIG_BPF_SYSCALL
22dc4a0f
AN
375struct bpf_prog;
376
838e9690
YS
377const struct btf_type *btf_type_by_id(const struct btf *btf, u32 type_id);
378const char *btf_name_by_offset(const struct btf *btf, u32 offset);
8580ac94 379struct btf *btf_parse_vmlinux(void);
5b92a28a 380struct btf *bpf_prog_get_target_btf(const struct bpf_prog *prog);
dee872e1
KKD
381bool btf_kfunc_id_set_contains(const struct btf *btf,
382 enum bpf_prog_type prog_type,
383 enum btf_kfunc_type type, u32 kfunc_btf_id);
384int register_btf_kfunc_id_set(enum bpf_prog_type prog_type,
385 const struct btf_kfunc_id_set *s);
5ce937d6
KKD
386s32 btf_find_dtor_kfunc(struct btf *btf, u32 btf_id);
387int register_btf_id_dtor_kfuncs(const struct btf_id_dtor_kfunc *dtors, u32 add_cnt,
388 struct module *owner);
f6161a8f
YS
389#else
390static inline const struct btf_type *btf_type_by_id(const struct btf *btf,
391 u32 type_id)
392{
393 return NULL;
394}
395static inline const char *btf_name_by_offset(const struct btf *btf,
396 u32 offset)
397{
398 return NULL;
399}
dee872e1
KKD
400static inline bool btf_kfunc_id_set_contains(const struct btf *btf,
401 enum bpf_prog_type prog_type,
402 enum btf_kfunc_type type,
403 u32 kfunc_btf_id)
404{
405 return false;
406}
407static inline int register_btf_kfunc_id_set(enum bpf_prog_type prog_type,
408 const struct btf_kfunc_id_set *s)
409{
410 return 0;
411}
5ce937d6
KKD
412static inline s32 btf_find_dtor_kfunc(struct btf *btf, u32 btf_id)
413{
414 return -ENOENT;
415}
416static inline int register_btf_id_dtor_kfuncs(const struct btf_id_dtor_kfunc *dtors,
417 u32 add_cnt, struct module *owner)
418{
419 return 0;
420}
f6161a8f 421#endif
eb3f595d
MKL
422
423#endif