1
2
3
4#ifndef _LINUX_BTF_H
5#define _LINUX_BTF_H 1
6
7#include <linux/types.h>
8#include <uapi/linux/btf.h>
9#include <uapi/linux/bpf.h>
10
11#define BTF_TYPE_EMIT(type) ((void)(type *)0)
12#define BTF_TYPE_EMIT_ENUM(enum_val) ((void)enum_val)
13
14struct btf;
15struct btf_member;
16struct btf_type;
17union bpf_attr;
18struct btf_show;
19
20extern const struct file_operations btf_fops;
21
22void btf_get(struct btf *btf);
23void btf_put(struct btf *btf);
24int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr);
25struct btf *btf_get_by_fd(int fd);
26int btf_get_info_by_fd(const struct btf *btf,
27 const union bpf_attr *attr,
28 union bpf_attr __user *uattr);
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50const struct btf_type *btf_type_id_size(const struct btf *btf,
51 u32 *type_id,
52 u32 *ret_size);
53
54
55
56
57
58
59
60
61
62
63
64
65#define BTF_SHOW_COMPACT BTF_F_COMPACT
66#define BTF_SHOW_NONAME BTF_F_NONAME
67#define BTF_SHOW_PTR_RAW BTF_F_PTR_RAW
68#define BTF_SHOW_ZERO BTF_F_ZERO
69#define BTF_SHOW_UNSAFE (1ULL << 4)
70
71void btf_type_seq_show(const struct btf *btf, u32 type_id, void *obj,
72 struct seq_file *m);
73int btf_type_seq_show_flags(const struct btf *btf, u32 type_id, void *obj,
74 struct seq_file *m, u64 flags);
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89int btf_type_snprintf_show(const struct btf *btf, u32 type_id, void *obj,
90 char *buf, int len, u64 flags);
91
92int btf_get_fd_by_id(u32 id);
93u32 btf_obj_id(const struct btf *btf);
94bool btf_is_kernel(const struct btf *btf);
95bool btf_is_module(const struct btf *btf);
96struct module *btf_try_get_module(const struct btf *btf);
97u32 btf_nr_types(const struct btf *btf);
98bool btf_member_is_reg_int(const struct btf *btf, const struct btf_type *s,
99 const struct btf_member *m,
100 u32 expected_offset, u32 expected_size);
101int btf_find_spin_lock(const struct btf *btf, const struct btf_type *t);
102int btf_find_timer(const struct btf *btf, const struct btf_type *t);
103bool btf_type_is_void(const struct btf_type *t);
104s32 btf_find_by_name_kind(const struct btf *btf, const char *name, u8 kind);
105const struct btf_type *btf_type_skip_modifiers(const struct btf *btf,
106 u32 id, u32 *res_id);
107const struct btf_type *btf_type_resolve_ptr(const struct btf *btf,
108 u32 id, u32 *res_id);
109const struct btf_type *btf_type_resolve_func_ptr(const struct btf *btf,
110 u32 id, u32 *res_id);
111const struct btf_type *
112btf_resolve_size(const struct btf *btf, const struct btf_type *type,
113 u32 *type_size);
114const char *btf_type_str(const struct btf_type *t);
115
116#define for_each_member(i, struct_type, member) \
117 for (i = 0, member = btf_type_member(struct_type); \
118 i < btf_type_vlen(struct_type); \
119 i++, member++)
120
121#define for_each_vsi(i, datasec_type, member) \
122 for (i = 0, member = btf_type_var_secinfo(datasec_type); \
123 i < btf_type_vlen(datasec_type); \
124 i++, member++)
125
126static inline bool btf_type_is_ptr(const struct btf_type *t)
127{
128 return BTF_INFO_KIND(t->info) == BTF_KIND_PTR;
129}
130
131static inline bool btf_type_is_int(const struct btf_type *t)
132{
133 return BTF_INFO_KIND(t->info) == BTF_KIND_INT;
134}
135
136static inline bool btf_type_is_small_int(const struct btf_type *t)
137{
138 return btf_type_is_int(t) && t->size <= sizeof(u64);
139}
140
141static inline bool btf_type_is_enum(const struct btf_type *t)
142{
143 return BTF_INFO_KIND(t->info) == BTF_KIND_ENUM;
144}
145
146static inline bool btf_type_is_scalar(const struct btf_type *t)
147{
148 return btf_type_is_int(t) || btf_type_is_enum(t);
149}
150
151static inline bool btf_type_is_typedef(const struct btf_type *t)
152{
153 return BTF_INFO_KIND(t->info) == BTF_KIND_TYPEDEF;
154}
155
156static inline bool btf_type_is_func(const struct btf_type *t)
157{
158 return BTF_INFO_KIND(t->info) == BTF_KIND_FUNC;
159}
160
161static inline bool btf_type_is_func_proto(const struct btf_type *t)
162{
163 return BTF_INFO_KIND(t->info) == BTF_KIND_FUNC_PROTO;
164}
165
166static inline bool btf_type_is_var(const struct btf_type *t)
167{
168 return BTF_INFO_KIND(t->info) == BTF_KIND_VAR;
169}
170
171
172
173
174static inline bool btf_type_is_struct(const struct btf_type *t)
175{
176 u8 kind = BTF_INFO_KIND(t->info);
177
178 return kind == BTF_KIND_STRUCT || kind == BTF_KIND_UNION;
179}
180
181static inline u16 btf_type_vlen(const struct btf_type *t)
182{
183 return BTF_INFO_VLEN(t->info);
184}
185
186static inline u16 btf_func_linkage(const struct btf_type *t)
187{
188 return BTF_INFO_VLEN(t->info);
189}
190
191static inline bool btf_type_kflag(const struct btf_type *t)
192{
193 return BTF_INFO_KFLAG(t->info);
194}
195
196static inline u32 btf_member_bit_offset(const struct btf_type *struct_type,
197 const struct btf_member *member)
198{
199 return btf_type_kflag(struct_type) ? BTF_MEMBER_BIT_OFFSET(member->offset)
200 : member->offset;
201}
202
203static inline u32 btf_member_bitfield_size(const struct btf_type *struct_type,
204 const struct btf_member *member)
205{
206 return btf_type_kflag(struct_type) ? BTF_MEMBER_BITFIELD_SIZE(member->offset)
207 : 0;
208}
209
210static inline const struct btf_member *btf_type_member(const struct btf_type *t)
211{
212 return (const struct btf_member *)(t + 1);
213}
214
215static inline const struct btf_var_secinfo *btf_type_var_secinfo(
216 const struct btf_type *t)
217{
218 return (const struct btf_var_secinfo *)(t + 1);
219}
220
221#ifdef CONFIG_BPF_SYSCALL
222struct bpf_prog;
223
224const struct btf_type *btf_type_by_id(const struct btf *btf, u32 type_id);
225const char *btf_name_by_offset(const struct btf *btf, u32 offset);
226struct btf *btf_parse_vmlinux(void);
227struct btf *bpf_prog_get_target_btf(const struct bpf_prog *prog);
228#else
229static inline const struct btf_type *btf_type_by_id(const struct btf *btf,
230 u32 type_id)
231{
232 return NULL;
233}
234static inline const char *btf_name_by_offset(const struct btf *btf,
235 u32 offset)
236{
237 return NULL;
238}
239#endif
240
241#endif
242