1 /* SPDX-License-Identifier: GPL-2.0 */ 1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* Copyright (c) 2018 Facebook */ 2 /* Copyright (c) 2018 Facebook */ 3 3 4 #ifndef _LINUX_BTF_H 4 #ifndef _LINUX_BTF_H 5 #define _LINUX_BTF_H 1 5 #define _LINUX_BTF_H 1 6 6 7 #include <linux/types.h> 7 #include <linux/types.h> 8 #include <linux/bpfptr.h> 8 #include <linux/bpfptr.h> 9 #include <linux/bsearch.h> 9 #include <linux/bsearch.h> 10 #include <linux/btf_ids.h> 10 #include <linux/btf_ids.h> 11 #include <uapi/linux/btf.h> 11 #include <uapi/linux/btf.h> 12 #include <uapi/linux/bpf.h> 12 #include <uapi/linux/bpf.h> 13 13 14 #define BTF_TYPE_EMIT(type) ((void)(type *)0) 14 #define BTF_TYPE_EMIT(type) ((void)(type *)0) 15 #define BTF_TYPE_EMIT_ENUM(enum_val) ((void)en 15 #define BTF_TYPE_EMIT_ENUM(enum_val) ((void)enum_val) 16 16 17 /* These need to be macros, as the expressions 17 /* These need to be macros, as the expressions are used in assembler input */ 18 #define KF_ACQUIRE (1 << 0) /* kfunc is a 18 #define KF_ACQUIRE (1 << 0) /* kfunc is an acquire function */ 19 #define KF_RELEASE (1 << 1) /* kfunc is a 19 #define KF_RELEASE (1 << 1) /* kfunc is a release function */ 20 #define KF_RET_NULL (1 << 2) /* kfunc retu 20 #define KF_RET_NULL (1 << 2) /* kfunc returns a pointer that may be NULL */ 21 /* Trusted arguments are those which are guara 21 /* Trusted arguments are those which are guaranteed to be valid when passed to 22 * the kfunc. It is used to enforce that point 22 * the kfunc. It is used to enforce that pointers obtained from either acquire 23 * kfuncs, or from the main kernel on a tracep 23 * kfuncs, or from the main kernel on a tracepoint or struct_ops callback 24 * invocation, remain unmodified when being pa 24 * invocation, remain unmodified when being passed to helpers taking trusted 25 * args. 25 * args. 26 * 26 * 27 * Consider, for example, the following new ta 27 * Consider, for example, the following new task tracepoint: 28 * 28 * 29 * SEC("tp_btf/task_newtask") 29 * SEC("tp_btf/task_newtask") 30 * int BPF_PROG(new_task_tp, struct task_ 30 * int BPF_PROG(new_task_tp, struct task_struct *task, u64 clone_flags) 31 * { 31 * { 32 * ... 32 * ... 33 * } 33 * } 34 * 34 * 35 * And the following kfunc: 35 * And the following kfunc: 36 * 36 * 37 * BTF_ID_FLAGS(func, bpf_task_acquire, K 37 * BTF_ID_FLAGS(func, bpf_task_acquire, KF_ACQUIRE | KF_TRUSTED_ARGS) 38 * 38 * 39 * All invocations to the kfunc must pass the 39 * All invocations to the kfunc must pass the unmodified, unwalked task: 40 * 40 * 41 * bpf_task_acquire(task); // 41 * bpf_task_acquire(task); // Allowed 42 * bpf_task_acquire(task->last_wakee); // 42 * bpf_task_acquire(task->last_wakee); // Rejected, walked task 43 * 43 * 44 * Programs may also pass referenced tasks dir 44 * Programs may also pass referenced tasks directly to the kfunc: 45 * 45 * 46 * struct task_struct *acquired; 46 * struct task_struct *acquired; 47 * 47 * 48 * acquired = bpf_task_acquire(task); 48 * acquired = bpf_task_acquire(task); // Allowed, same as above 49 * bpf_task_acquire(acquired); 49 * bpf_task_acquire(acquired); // Allowed 50 * bpf_task_acquire(task); 50 * bpf_task_acquire(task); // Allowed 51 * bpf_task_acquire(acquired->last_wakee) 51 * bpf_task_acquire(acquired->last_wakee); // Rejected, walked task 52 * 52 * 53 * Programs may _not_, however, pass a task fr 53 * Programs may _not_, however, pass a task from an arbitrary fentry/fexit, or 54 * kprobe/kretprobe to the kfunc, as BPF canno 54 * kprobe/kretprobe to the kfunc, as BPF cannot guarantee that all of these 55 * pointers are guaranteed to be safe. For exa 55 * pointers are guaranteed to be safe. For example, the following BPF program 56 * would be rejected: 56 * would be rejected: 57 * 57 * 58 * SEC("kretprobe/free_task") 58 * SEC("kretprobe/free_task") 59 * int BPF_PROG(free_task_probe, struct task_s 59 * int BPF_PROG(free_task_probe, struct task_struct *tsk) 60 * { 60 * { 61 * struct task_struct *acquired; 61 * struct task_struct *acquired; 62 * 62 * 63 * acquired = bpf_task_acquire(acquired); 63 * acquired = bpf_task_acquire(acquired); // Rejected, not a trusted pointer 64 * bpf_task_release(acquired); 64 * bpf_task_release(acquired); 65 * 65 * 66 * return 0; 66 * return 0; 67 * } 67 * } 68 */ 68 */ 69 #define KF_TRUSTED_ARGS (1 << 4) /* kfunc only 69 #define KF_TRUSTED_ARGS (1 << 4) /* kfunc only takes trusted pointer arguments */ 70 #define KF_SLEEPABLE (1 << 5) /* kfunc may 70 #define KF_SLEEPABLE (1 << 5) /* kfunc may sleep */ 71 #define KF_DESTRUCTIVE (1 << 6) /* kfunc perf 71 #define KF_DESTRUCTIVE (1 << 6) /* kfunc performs destructive actions */ 72 #define KF_RCU (1 << 7) /* kfunc take 72 #define KF_RCU (1 << 7) /* kfunc takes either rcu or trusted pointer arguments */ 73 /* only one of KF_ITER_{NEW,NEXT,DESTROY} coul 73 /* only one of KF_ITER_{NEW,NEXT,DESTROY} could be specified per kfunc */ 74 #define KF_ITER_NEW (1 << 8) /* kfunc impl 74 #define KF_ITER_NEW (1 << 8) /* kfunc implements BPF iter constructor */ 75 #define KF_ITER_NEXT (1 << 9) /* kfunc impl 75 #define KF_ITER_NEXT (1 << 9) /* kfunc implements BPF iter next method */ 76 #define KF_ITER_DESTROY (1 << 10) /* kfunc imp 76 #define KF_ITER_DESTROY (1 << 10) /* kfunc implements BPF iter destructor */ 77 #define KF_RCU_PROTECTED (1 << 11) /* kfunc sh 77 #define KF_RCU_PROTECTED (1 << 11) /* kfunc should be protected by rcu cs when they are invoked */ 78 78 79 /* 79 /* 80 * Tag marking a kernel function as a kfunc. T 80 * Tag marking a kernel function as a kfunc. This is meant to minimize the 81 * amount of copy-paste that kfunc authors hav 81 * amount of copy-paste that kfunc authors have to include for correctness so 82 * as to avoid issues such as the compiler inl 82 * as to avoid issues such as the compiler inlining or eliding either a static 83 * kfunc, or a global kfunc in an LTO build. 83 * kfunc, or a global kfunc in an LTO build. 84 */ 84 */ 85 #define __bpf_kfunc __used __retain noinline 85 #define __bpf_kfunc __used __retain noinline 86 86 87 #define __bpf_kfunc_start_defs() 87 #define __bpf_kfunc_start_defs() \ 88 __diag_push(); 88 __diag_push(); \ 89 __diag_ignore_all("-Wmissing-declarati 89 __diag_ignore_all("-Wmissing-declarations", \ 90 "Global kfuncs as th 90 "Global kfuncs as their definitions will be in BTF");\ 91 __diag_ignore_all("-Wmissing-prototype 91 __diag_ignore_all("-Wmissing-prototypes", \ 92 "Global kfuncs as th 92 "Global kfuncs as their definitions will be in BTF") 93 93 94 #define __bpf_kfunc_end_defs() __diag_pop() 94 #define __bpf_kfunc_end_defs() __diag_pop() 95 #define __bpf_hook_start() __bpf_kfunc_start_d 95 #define __bpf_hook_start() __bpf_kfunc_start_defs() 96 #define __bpf_hook_end() __bpf_kfunc_end_defs( 96 #define __bpf_hook_end() __bpf_kfunc_end_defs() 97 97 98 /* 98 /* 99 * Return the name of the passed struct, if ex 99 * Return the name of the passed struct, if exists, or halt the build if for 100 * example the structure gets renamed. In this 100 * example the structure gets renamed. In this way, developers have to revisit 101 * the code using that structure name, and upd 101 * the code using that structure name, and update it accordingly. 102 */ 102 */ 103 #define stringify_struct(x) 103 #define stringify_struct(x) \ 104 ({ BUILD_BUG_ON(sizeof(struct x) < 0); 104 ({ BUILD_BUG_ON(sizeof(struct x) < 0); \ 105 __stringify(x); }) 105 __stringify(x); }) 106 106 107 struct btf; 107 struct btf; 108 struct btf_member; 108 struct btf_member; 109 struct btf_type; 109 struct btf_type; 110 union bpf_attr; 110 union bpf_attr; 111 struct btf_show; 111 struct btf_show; 112 struct btf_id_set; 112 struct btf_id_set; 113 struct bpf_prog; 113 struct bpf_prog; 114 114 115 typedef int (*btf_kfunc_filter_t)(const struct 115 typedef int (*btf_kfunc_filter_t)(const struct bpf_prog *prog, u32 kfunc_id); 116 116 117 struct btf_kfunc_id_set { 117 struct btf_kfunc_id_set { 118 struct module *owner; 118 struct module *owner; 119 struct btf_id_set8 *set; 119 struct btf_id_set8 *set; 120 btf_kfunc_filter_t filter; 120 btf_kfunc_filter_t filter; 121 }; 121 }; 122 122 123 struct btf_id_dtor_kfunc { 123 struct btf_id_dtor_kfunc { 124 u32 btf_id; 124 u32 btf_id; 125 u32 kfunc_btf_id; 125 u32 kfunc_btf_id; 126 }; 126 }; 127 127 128 struct btf_struct_meta { 128 struct btf_struct_meta { 129 u32 btf_id; 129 u32 btf_id; 130 struct btf_record *record; 130 struct btf_record *record; 131 }; 131 }; 132 132 133 struct btf_struct_metas { 133 struct btf_struct_metas { 134 u32 cnt; 134 u32 cnt; 135 struct btf_struct_meta types[]; 135 struct btf_struct_meta types[]; 136 }; 136 }; 137 137 138 extern const struct file_operations btf_fops; 138 extern const struct file_operations btf_fops; 139 139 140 const char *btf_get_name(const struct btf *btf 140 const char *btf_get_name(const struct btf *btf); 141 void btf_get(struct btf *btf); 141 void btf_get(struct btf *btf); 142 void btf_put(struct btf *btf); 142 void btf_put(struct btf *btf); 143 const struct btf_header *btf_header(const stru 143 const struct btf_header *btf_header(const struct btf *btf); 144 int btf_new_fd(const union bpf_attr *attr, bpf 144 int btf_new_fd(const union bpf_attr *attr, bpfptr_t uattr, u32 uattr_sz); 145 struct btf *btf_get_by_fd(int fd); 145 struct btf *btf_get_by_fd(int fd); 146 int btf_get_info_by_fd(const struct btf *btf, 146 int btf_get_info_by_fd(const struct btf *btf, 147 const union bpf_attr *a 147 const union bpf_attr *attr, 148 union bpf_attr __user * 148 union bpf_attr __user *uattr); 149 /* Figure out the size of a type_id. If type_ 149 /* Figure out the size of a type_id. If type_id is a modifier 150 * (e.g. const), it will be resolved to find o 150 * (e.g. const), it will be resolved to find out the type with size. 151 * 151 * 152 * For example: 152 * For example: 153 * In describing "const void *", type_id is " 153 * In describing "const void *", type_id is "const" and "const" 154 * refers to "void *". The return type will b 154 * refers to "void *". The return type will be "void *". 155 * 155 * 156 * If type_id is a simple "int", then return t 156 * If type_id is a simple "int", then return type will be "int". 157 * 157 * 158 * @btf: struct btf object 158 * @btf: struct btf object 159 * @type_id: Find out the size of type_id. The 159 * @type_id: Find out the size of type_id. The type_id of the return 160 * type is set to *type_id. 160 * type is set to *type_id. 161 * @ret_size: It can be NULL. If not NULL, th 161 * @ret_size: It can be NULL. If not NULL, the size of the return 162 * type is set to *ret_size. 162 * type is set to *ret_size. 163 * Return: The btf_type (resolved to another t 163 * Return: The btf_type (resolved to another type with size info if needed). 164 * NULL is returned if type_id itself 164 * NULL is returned if type_id itself does not have size info 165 * (e.g. void) or it cannot be resolve 165 * (e.g. void) or it cannot be resolved to another type that 166 * has size info. 166 * has size info. 167 * *type_id and *ret_size will not be 167 * *type_id and *ret_size will not be changed in the 168 * NULL return case. 168 * NULL return case. 169 */ 169 */ 170 const struct btf_type *btf_type_id_size(const 170 const struct btf_type *btf_type_id_size(const struct btf *btf, 171 u32 *t 171 u32 *type_id, 172 u32 *r 172 u32 *ret_size); 173 173 174 /* 174 /* 175 * Options to control show behaviour. 175 * Options to control show behaviour. 176 * - BTF_SHOW_COMPACT: no formatting arou 176 * - BTF_SHOW_COMPACT: no formatting around type information 177 * - BTF_SHOW_NONAME: no struct/union mem 177 * - BTF_SHOW_NONAME: no struct/union member names/types 178 * - BTF_SHOW_PTR_RAW: show raw (unobfusc 178 * - BTF_SHOW_PTR_RAW: show raw (unobfuscated) pointer values; 179 * equivalent to %px. 179 * equivalent to %px. 180 * - BTF_SHOW_ZERO: show zero-valued stru 180 * - BTF_SHOW_ZERO: show zero-valued struct/union members; they 181 * are not displayed by default 181 * are not displayed by default 182 * - BTF_SHOW_UNSAFE: skip use of bpf_pro 182 * - BTF_SHOW_UNSAFE: skip use of bpf_probe_read() to safely read 183 * data before displaying it. 183 * data before displaying it. 184 */ 184 */ 185 #define BTF_SHOW_COMPACT BTF_F_COMPACT 185 #define BTF_SHOW_COMPACT BTF_F_COMPACT 186 #define BTF_SHOW_NONAME BTF_F_NONAME 186 #define BTF_SHOW_NONAME BTF_F_NONAME 187 #define BTF_SHOW_PTR_RAW BTF_F_PTR_RAW 187 #define BTF_SHOW_PTR_RAW BTF_F_PTR_RAW 188 #define BTF_SHOW_ZERO BTF_F_ZERO 188 #define BTF_SHOW_ZERO BTF_F_ZERO 189 #define BTF_SHOW_UNSAFE (1ULL << 4) 189 #define BTF_SHOW_UNSAFE (1ULL << 4) 190 190 191 void btf_type_seq_show(const struct btf *btf, 191 void btf_type_seq_show(const struct btf *btf, u32 type_id, void *obj, 192 struct seq_file *m); 192 struct seq_file *m); 193 int btf_type_seq_show_flags(const struct btf * 193 int btf_type_seq_show_flags(const struct btf *btf, u32 type_id, void *obj, 194 struct seq_file *m 194 struct seq_file *m, u64 flags); 195 195 196 /* 196 /* 197 * Copy len bytes of string representation of 197 * Copy len bytes of string representation of obj of BTF type_id into buf. 198 * 198 * 199 * @btf: struct btf object 199 * @btf: struct btf object 200 * @type_id: type id of type obj points to 200 * @type_id: type id of type obj points to 201 * @obj: pointer to typed data 201 * @obj: pointer to typed data 202 * @buf: buffer to write to 202 * @buf: buffer to write to 203 * @len: maximum length to write to buf 203 * @len: maximum length to write to buf 204 * @flags: show options (see above) 204 * @flags: show options (see above) 205 * 205 * 206 * Return: length that would have been/was cop 206 * Return: length that would have been/was copied as per snprintf, or 207 * negative error. 207 * negative error. 208 */ 208 */ 209 int btf_type_snprintf_show(const struct btf *b 209 int btf_type_snprintf_show(const struct btf *btf, u32 type_id, void *obj, 210 char *buf, int len, 210 char *buf, int len, u64 flags); 211 211 212 int btf_get_fd_by_id(u32 id); 212 int btf_get_fd_by_id(u32 id); 213 u32 btf_obj_id(const struct btf *btf); 213 u32 btf_obj_id(const struct btf *btf); 214 bool btf_is_kernel(const struct btf *btf); 214 bool btf_is_kernel(const struct btf *btf); 215 bool btf_is_module(const struct btf *btf); 215 bool btf_is_module(const struct btf *btf); 216 bool btf_is_vmlinux(const struct btf *btf); 216 bool btf_is_vmlinux(const struct btf *btf); 217 struct module *btf_try_get_module(const struct 217 struct module *btf_try_get_module(const struct btf *btf); 218 u32 btf_nr_types(const struct btf *btf); 218 u32 btf_nr_types(const struct btf *btf); 219 struct btf *btf_base_btf(const struct btf *btf 219 struct btf *btf_base_btf(const struct btf *btf); 220 bool btf_member_is_reg_int(const struct btf *b 220 bool btf_member_is_reg_int(const struct btf *btf, const struct btf_type *s, 221 const struct btf_me 221 const struct btf_member *m, 222 u32 expected_offset 222 u32 expected_offset, u32 expected_size); 223 struct btf_record *btf_parse_fields(const stru 223 struct btf_record *btf_parse_fields(const struct btf *btf, const struct btf_type *t, 224 u32 field_ 224 u32 field_mask, u32 value_size); 225 int btf_check_and_fixup_fields(const struct bt 225 int btf_check_and_fixup_fields(const struct btf *btf, struct btf_record *rec); 226 bool btf_type_is_void(const struct btf_type *t 226 bool btf_type_is_void(const struct btf_type *t); 227 s32 btf_find_by_name_kind(const struct btf *bt 227 s32 btf_find_by_name_kind(const struct btf *btf, const char *name, u8 kind); 228 s32 bpf_find_btf_id(const char *name, u32 kind 228 s32 bpf_find_btf_id(const char *name, u32 kind, struct btf **btf_p); 229 const struct btf_type *btf_type_skip_modifiers 229 const struct btf_type *btf_type_skip_modifiers(const struct btf *btf, 230 230 u32 id, u32 *res_id); 231 const struct btf_type *btf_type_resolve_ptr(co 231 const struct btf_type *btf_type_resolve_ptr(const struct btf *btf, 232 u3 232 u32 id, u32 *res_id); 233 const struct btf_type *btf_type_resolve_func_p 233 const struct btf_type *btf_type_resolve_func_ptr(const struct btf *btf, 234 234 u32 id, u32 *res_id); 235 const struct btf_type * 235 const struct btf_type * 236 btf_resolve_size(const struct btf *btf, const 236 btf_resolve_size(const struct btf *btf, const struct btf_type *type, 237 u32 *type_size); 237 u32 *type_size); 238 const char *btf_type_str(const struct btf_type 238 const char *btf_type_str(const struct btf_type *t); 239 239 240 #define for_each_member(i, struct_type, member 240 #define for_each_member(i, struct_type, member) \ 241 for (i = 0, member = btf_type_member(s 241 for (i = 0, member = btf_type_member(struct_type); \ 242 i < btf_type_vlen(struct_type); 242 i < btf_type_vlen(struct_type); \ 243 i++, member++) 243 i++, member++) 244 244 245 #define for_each_vsi(i, datasec_type, member) 245 #define for_each_vsi(i, datasec_type, member) \ 246 for (i = 0, member = btf_type_var_seci 246 for (i = 0, member = btf_type_var_secinfo(datasec_type); \ 247 i < btf_type_vlen(datasec_type); 247 i < btf_type_vlen(datasec_type); \ 248 i++, member++) 248 i++, member++) 249 249 250 static inline bool btf_type_is_ptr(const struc 250 static inline bool btf_type_is_ptr(const struct btf_type *t) 251 { 251 { 252 return BTF_INFO_KIND(t->info) == BTF_K 252 return BTF_INFO_KIND(t->info) == BTF_KIND_PTR; 253 } 253 } 254 254 255 static inline bool btf_type_is_int(const struc 255 static inline bool btf_type_is_int(const struct btf_type *t) 256 { 256 { 257 return BTF_INFO_KIND(t->info) == BTF_K 257 return BTF_INFO_KIND(t->info) == BTF_KIND_INT; 258 } 258 } 259 259 260 static inline bool btf_type_is_small_int(const 260 static inline bool btf_type_is_small_int(const struct btf_type *t) 261 { 261 { 262 return btf_type_is_int(t) && t->size < 262 return btf_type_is_int(t) && t->size <= sizeof(u64); 263 } 263 } 264 264 265 static inline u8 btf_int_encoding(const struct 265 static inline u8 btf_int_encoding(const struct btf_type *t) 266 { 266 { 267 return BTF_INT_ENCODING(*(u32 *)(t + 1 267 return BTF_INT_ENCODING(*(u32 *)(t + 1)); 268 } 268 } 269 269 270 static inline bool btf_type_is_signed_int(cons 270 static inline bool btf_type_is_signed_int(const struct btf_type *t) 271 { 271 { 272 return btf_type_is_int(t) && (btf_int_ 272 return btf_type_is_int(t) && (btf_int_encoding(t) & BTF_INT_SIGNED); 273 } 273 } 274 274 275 static inline bool btf_type_is_enum(const stru 275 static inline bool btf_type_is_enum(const struct btf_type *t) 276 { 276 { 277 return BTF_INFO_KIND(t->info) == BTF_K 277 return BTF_INFO_KIND(t->info) == BTF_KIND_ENUM; 278 } 278 } 279 279 280 static inline bool btf_is_any_enum(const struc 280 static inline bool btf_is_any_enum(const struct btf_type *t) 281 { 281 { 282 return BTF_INFO_KIND(t->info) == BTF_K 282 return BTF_INFO_KIND(t->info) == BTF_KIND_ENUM || 283 BTF_INFO_KIND(t->info) == BTF_K 283 BTF_INFO_KIND(t->info) == BTF_KIND_ENUM64; 284 } 284 } 285 285 286 static inline bool btf_kind_core_compat(const 286 static inline bool btf_kind_core_compat(const struct btf_type *t1, 287 const 287 const struct btf_type *t2) 288 { 288 { 289 return BTF_INFO_KIND(t1->info) == BTF_ 289 return BTF_INFO_KIND(t1->info) == BTF_INFO_KIND(t2->info) || 290 (btf_is_any_enum(t1) && btf_is_ 290 (btf_is_any_enum(t1) && btf_is_any_enum(t2)); 291 } 291 } 292 292 293 static inline bool str_is_empty(const char *s) 293 static inline bool str_is_empty(const char *s) 294 { 294 { 295 return !s || !s[0]; 295 return !s || !s[0]; 296 } 296 } 297 297 298 static inline u16 btf_kind(const struct btf_ty 298 static inline u16 btf_kind(const struct btf_type *t) 299 { 299 { 300 return BTF_INFO_KIND(t->info); 300 return BTF_INFO_KIND(t->info); 301 } 301 } 302 302 303 static inline bool btf_is_enum(const struct bt 303 static inline bool btf_is_enum(const struct btf_type *t) 304 { 304 { 305 return btf_kind(t) == BTF_KIND_ENUM; 305 return btf_kind(t) == BTF_KIND_ENUM; 306 } 306 } 307 307 308 static inline bool btf_is_enum64(const struct 308 static inline bool btf_is_enum64(const struct btf_type *t) 309 { 309 { 310 return btf_kind(t) == BTF_KIND_ENUM64; 310 return btf_kind(t) == BTF_KIND_ENUM64; 311 } 311 } 312 312 313 static inline u64 btf_enum64_value(const struc 313 static inline u64 btf_enum64_value(const struct btf_enum64 *e) 314 { 314 { 315 return ((u64)e->val_hi32 << 32) | e->v 315 return ((u64)e->val_hi32 << 32) | e->val_lo32; 316 } 316 } 317 317 318 static inline bool btf_is_composite(const stru 318 static inline bool btf_is_composite(const struct btf_type *t) 319 { 319 { 320 u16 kind = btf_kind(t); 320 u16 kind = btf_kind(t); 321 321 322 return kind == BTF_KIND_STRUCT || kind 322 return kind == BTF_KIND_STRUCT || kind == BTF_KIND_UNION; 323 } 323 } 324 324 325 static inline bool btf_is_array(const struct b 325 static inline bool btf_is_array(const struct btf_type *t) 326 { 326 { 327 return btf_kind(t) == BTF_KIND_ARRAY; 327 return btf_kind(t) == BTF_KIND_ARRAY; 328 } 328 } 329 329 330 static inline bool btf_is_int(const struct btf 330 static inline bool btf_is_int(const struct btf_type *t) 331 { 331 { 332 return btf_kind(t) == BTF_KIND_INT; 332 return btf_kind(t) == BTF_KIND_INT; 333 } 333 } 334 334 335 static inline bool btf_is_ptr(const struct btf 335 static inline bool btf_is_ptr(const struct btf_type *t) 336 { 336 { 337 return btf_kind(t) == BTF_KIND_PTR; 337 return btf_kind(t) == BTF_KIND_PTR; 338 } 338 } 339 339 340 static inline u8 btf_int_offset(const struct b 340 static inline u8 btf_int_offset(const struct btf_type *t) 341 { 341 { 342 return BTF_INT_OFFSET(*(u32 *)(t + 1)) 342 return BTF_INT_OFFSET(*(u32 *)(t + 1)); 343 } 343 } 344 344 345 static inline __u8 btf_int_bits(const struct b 345 static inline __u8 btf_int_bits(const struct btf_type *t) 346 { 346 { 347 return BTF_INT_BITS(*(__u32 *)(t + 1)) 347 return BTF_INT_BITS(*(__u32 *)(t + 1)); 348 } 348 } 349 349 350 static inline bool btf_type_is_scalar(const st 350 static inline bool btf_type_is_scalar(const struct btf_type *t) 351 { 351 { 352 return btf_type_is_int(t) || btf_type_ 352 return btf_type_is_int(t) || btf_type_is_enum(t); 353 } 353 } 354 354 355 static inline bool btf_type_is_typedef(const s 355 static inline bool btf_type_is_typedef(const struct btf_type *t) 356 { 356 { 357 return BTF_INFO_KIND(t->info) == BTF_K 357 return BTF_INFO_KIND(t->info) == BTF_KIND_TYPEDEF; 358 } 358 } 359 359 360 static inline bool btf_type_is_volatile(const 360 static inline bool btf_type_is_volatile(const struct btf_type *t) 361 { 361 { 362 return BTF_INFO_KIND(t->info) == BTF_K 362 return BTF_INFO_KIND(t->info) == BTF_KIND_VOLATILE; 363 } 363 } 364 364 365 static inline bool btf_type_is_func(const stru 365 static inline bool btf_type_is_func(const struct btf_type *t) 366 { 366 { 367 return BTF_INFO_KIND(t->info) == BTF_K 367 return BTF_INFO_KIND(t->info) == BTF_KIND_FUNC; 368 } 368 } 369 369 370 static inline bool btf_type_is_func_proto(cons 370 static inline bool btf_type_is_func_proto(const struct btf_type *t) 371 { 371 { 372 return BTF_INFO_KIND(t->info) == BTF_K 372 return BTF_INFO_KIND(t->info) == BTF_KIND_FUNC_PROTO; 373 } 373 } 374 374 375 static inline bool btf_type_is_var(const struc 375 static inline bool btf_type_is_var(const struct btf_type *t) 376 { 376 { 377 return BTF_INFO_KIND(t->info) == BTF_K 377 return BTF_INFO_KIND(t->info) == BTF_KIND_VAR; 378 } 378 } 379 379 380 static inline bool btf_type_is_type_tag(const 380 static inline bool btf_type_is_type_tag(const struct btf_type *t) 381 { 381 { 382 return BTF_INFO_KIND(t->info) == BTF_K 382 return BTF_INFO_KIND(t->info) == BTF_KIND_TYPE_TAG; 383 } 383 } 384 384 385 /* union is only a special case of struct: 385 /* union is only a special case of struct: 386 * all its offsetof(member) == 0 386 * all its offsetof(member) == 0 387 */ 387 */ 388 static inline bool btf_type_is_struct(const st 388 static inline bool btf_type_is_struct(const struct btf_type *t) 389 { 389 { 390 u8 kind = BTF_INFO_KIND(t->info); 390 u8 kind = BTF_INFO_KIND(t->info); 391 391 392 return kind == BTF_KIND_STRUCT || kind 392 return kind == BTF_KIND_STRUCT || kind == BTF_KIND_UNION; 393 } 393 } 394 394 395 static inline bool __btf_type_is_struct(const 395 static inline bool __btf_type_is_struct(const struct btf_type *t) 396 { 396 { 397 return BTF_INFO_KIND(t->info) == BTF_K 397 return BTF_INFO_KIND(t->info) == BTF_KIND_STRUCT; 398 } 398 } 399 399 400 static inline bool btf_type_is_array(const str 400 static inline bool btf_type_is_array(const struct btf_type *t) 401 { 401 { 402 return BTF_INFO_KIND(t->info) == BTF_K 402 return BTF_INFO_KIND(t->info) == BTF_KIND_ARRAY; 403 } 403 } 404 404 405 static inline u16 btf_type_vlen(const struct b 405 static inline u16 btf_type_vlen(const struct btf_type *t) 406 { 406 { 407 return BTF_INFO_VLEN(t->info); 407 return BTF_INFO_VLEN(t->info); 408 } 408 } 409 409 410 static inline u16 btf_vlen(const struct btf_ty 410 static inline u16 btf_vlen(const struct btf_type *t) 411 { 411 { 412 return btf_type_vlen(t); 412 return btf_type_vlen(t); 413 } 413 } 414 414 415 static inline u16 btf_func_linkage(const struc 415 static inline u16 btf_func_linkage(const struct btf_type *t) 416 { 416 { 417 return BTF_INFO_VLEN(t->info); 417 return BTF_INFO_VLEN(t->info); 418 } 418 } 419 419 420 static inline bool btf_type_kflag(const struct 420 static inline bool btf_type_kflag(const struct btf_type *t) 421 { 421 { 422 return BTF_INFO_KFLAG(t->info); 422 return BTF_INFO_KFLAG(t->info); 423 } 423 } 424 424 425 static inline u32 __btf_member_bit_offset(cons 425 static inline u32 __btf_member_bit_offset(const struct btf_type *struct_type, 426 cons 426 const struct btf_member *member) 427 { 427 { 428 return btf_type_kflag(struct_type) ? B 428 return btf_type_kflag(struct_type) ? BTF_MEMBER_BIT_OFFSET(member->offset) 429 : m 429 : member->offset; 430 } 430 } 431 431 432 static inline u32 __btf_member_bitfield_size(c 432 static inline u32 __btf_member_bitfield_size(const struct btf_type *struct_type, 433 c 433 const struct btf_member *member) 434 { 434 { 435 return btf_type_kflag(struct_type) ? B 435 return btf_type_kflag(struct_type) ? BTF_MEMBER_BITFIELD_SIZE(member->offset) 436 : 0 436 : 0; 437 } 437 } 438 438 439 static inline struct btf_member *btf_members(c 439 static inline struct btf_member *btf_members(const struct btf_type *t) 440 { 440 { 441 return (struct btf_member *)(t + 1); 441 return (struct btf_member *)(t + 1); 442 } 442 } 443 443 444 static inline u32 btf_member_bit_offset(const 444 static inline u32 btf_member_bit_offset(const struct btf_type *t, u32 member_idx) 445 { 445 { 446 const struct btf_member *m = btf_membe 446 const struct btf_member *m = btf_members(t) + member_idx; 447 447 448 return __btf_member_bit_offset(t, m); 448 return __btf_member_bit_offset(t, m); 449 } 449 } 450 450 451 static inline u32 btf_member_bitfield_size(con 451 static inline u32 btf_member_bitfield_size(const struct btf_type *t, u32 member_idx) 452 { 452 { 453 const struct btf_member *m = btf_membe 453 const struct btf_member *m = btf_members(t) + member_idx; 454 454 455 return __btf_member_bitfield_size(t, m 455 return __btf_member_bitfield_size(t, m); 456 } 456 } 457 457 458 static inline const struct btf_member *btf_typ 458 static inline const struct btf_member *btf_type_member(const struct btf_type *t) 459 { 459 { 460 return (const struct btf_member *)(t + 460 return (const struct btf_member *)(t + 1); 461 } 461 } 462 462 463 static inline struct btf_array *btf_array(cons 463 static inline struct btf_array *btf_array(const struct btf_type *t) 464 { 464 { 465 return (struct btf_array *)(t + 1); 465 return (struct btf_array *)(t + 1); 466 } 466 } 467 467 468 static inline struct btf_enum *btf_enum(const 468 static inline struct btf_enum *btf_enum(const struct btf_type *t) 469 { 469 { 470 return (struct btf_enum *)(t + 1); 470 return (struct btf_enum *)(t + 1); 471 } 471 } 472 472 473 static inline struct btf_enum64 *btf_enum64(co 473 static inline struct btf_enum64 *btf_enum64(const struct btf_type *t) 474 { 474 { 475 return (struct btf_enum64 *)(t + 1); 475 return (struct btf_enum64 *)(t + 1); 476 } 476 } 477 477 478 static inline const struct btf_var_secinfo *bt 478 static inline const struct btf_var_secinfo *btf_type_var_secinfo( 479 const struct btf_type *t) 479 const struct btf_type *t) 480 { 480 { 481 return (const struct btf_var_secinfo * 481 return (const struct btf_var_secinfo *)(t + 1); 482 } 482 } 483 483 484 static inline struct btf_param *btf_params(con 484 static inline struct btf_param *btf_params(const struct btf_type *t) 485 { 485 { 486 return (struct btf_param *)(t + 1); 486 return (struct btf_param *)(t + 1); 487 } 487 } 488 488 489 static inline struct btf_decl_tag *btf_decl_ta 489 static inline struct btf_decl_tag *btf_decl_tag(const struct btf_type *t) 490 { 490 { 491 return (struct btf_decl_tag *)(t + 1); 491 return (struct btf_decl_tag *)(t + 1); 492 } 492 } 493 493 494 static inline int btf_id_cmp_func(const void * 494 static inline int btf_id_cmp_func(const void *a, const void *b) 495 { 495 { 496 const int *pa = a, *pb = b; 496 const int *pa = a, *pb = b; 497 497 498 return *pa - *pb; 498 return *pa - *pb; 499 } 499 } 500 500 501 static inline bool btf_id_set_contains(const s 501 static inline bool btf_id_set_contains(const struct btf_id_set *set, u32 id) 502 { 502 { 503 return bsearch(&id, set->ids, set->cnt 503 return bsearch(&id, set->ids, set->cnt, sizeof(u32), btf_id_cmp_func) != NULL; 504 } 504 } 505 505 506 static inline void *btf_id_set8_contains(const 506 static inline void *btf_id_set8_contains(const struct btf_id_set8 *set, u32 id) 507 { 507 { 508 return bsearch(&id, set->pairs, set->c 508 return bsearch(&id, set->pairs, set->cnt, sizeof(set->pairs[0]), btf_id_cmp_func); 509 } 509 } 510 510 511 bool btf_param_match_suffix(const struct btf * 511 bool btf_param_match_suffix(const struct btf *btf, 512 const struct btf_p 512 const struct btf_param *arg, 513 const char *suffix 513 const char *suffix); 514 int btf_ctx_arg_offset(const struct btf *btf, 514 int btf_ctx_arg_offset(const struct btf *btf, const struct btf_type *func_proto, 515 u32 arg_no); 515 u32 arg_no); 516 516 517 struct bpf_verifier_log; 517 struct bpf_verifier_log; 518 518 519 #if defined(CONFIG_BPF_JIT) && defined(CONFIG_ 519 #if defined(CONFIG_BPF_JIT) && defined(CONFIG_BPF_SYSCALL) 520 struct bpf_struct_ops; 520 struct bpf_struct_ops; 521 int __register_bpf_struct_ops(struct bpf_struc 521 int __register_bpf_struct_ops(struct bpf_struct_ops *st_ops); 522 const struct bpf_struct_ops_desc *bpf_struct_o 522 const struct bpf_struct_ops_desc *bpf_struct_ops_find_value(struct btf *btf, u32 value_id); 523 const struct bpf_struct_ops_desc *bpf_struct_o 523 const struct bpf_struct_ops_desc *bpf_struct_ops_find(struct btf *btf, u32 type_id); 524 #else 524 #else 525 static inline const struct bpf_struct_ops_desc 525 static inline const struct bpf_struct_ops_desc *bpf_struct_ops_find(struct btf *btf, u32 type_id) 526 { 526 { 527 return NULL; 527 return NULL; 528 } 528 } 529 #endif 529 #endif 530 530 531 enum btf_field_iter_kind { 531 enum btf_field_iter_kind { 532 BTF_FIELD_ITER_IDS, 532 BTF_FIELD_ITER_IDS, 533 BTF_FIELD_ITER_STRS, 533 BTF_FIELD_ITER_STRS, 534 }; 534 }; 535 535 536 struct btf_field_desc { 536 struct btf_field_desc { 537 /* once-per-type offsets */ 537 /* once-per-type offsets */ 538 int t_off_cnt, t_offs[2]; 538 int t_off_cnt, t_offs[2]; 539 /* member struct size, or zero, if no 539 /* member struct size, or zero, if no members */ 540 int m_sz; 540 int m_sz; 541 /* repeated per-member offsets */ 541 /* repeated per-member offsets */ 542 int m_off_cnt, m_offs[1]; 542 int m_off_cnt, m_offs[1]; 543 }; 543 }; 544 544 545 struct btf_field_iter { 545 struct btf_field_iter { 546 struct btf_field_desc desc; 546 struct btf_field_desc desc; 547 void *p; 547 void *p; 548 int m_idx; 548 int m_idx; 549 int off_idx; 549 int off_idx; 550 int vlen; 550 int vlen; 551 }; 551 }; 552 552 553 #ifdef CONFIG_BPF_SYSCALL 553 #ifdef CONFIG_BPF_SYSCALL 554 const struct btf_type *btf_type_by_id(const st 554 const struct btf_type *btf_type_by_id(const struct btf *btf, u32 type_id); 555 void btf_set_base_btf(struct btf *btf, const s 555 void btf_set_base_btf(struct btf *btf, const struct btf *base_btf); 556 int btf_relocate(struct btf *btf, const struct 556 int btf_relocate(struct btf *btf, const struct btf *base_btf, __u32 **map_ids); 557 int btf_field_iter_init(struct btf_field_iter 557 int btf_field_iter_init(struct btf_field_iter *it, struct btf_type *t, 558 enum btf_field_iter_ki 558 enum btf_field_iter_kind iter_kind); 559 __u32 *btf_field_iter_next(struct btf_field_it 559 __u32 *btf_field_iter_next(struct btf_field_iter *it); 560 560 561 const char *btf_name_by_offset(const struct bt 561 const char *btf_name_by_offset(const struct btf *btf, u32 offset); 562 const char *btf_str_by_offset(const struct btf 562 const char *btf_str_by_offset(const struct btf *btf, u32 offset); 563 struct btf *btf_parse_vmlinux(void); 563 struct btf *btf_parse_vmlinux(void); 564 struct btf *bpf_prog_get_target_btf(const stru 564 struct btf *bpf_prog_get_target_btf(const struct bpf_prog *prog); 565 u32 *btf_kfunc_id_set_contains(const struct bt 565 u32 *btf_kfunc_id_set_contains(const struct btf *btf, u32 kfunc_btf_id, 566 const struct bp 566 const struct bpf_prog *prog); 567 u32 *btf_kfunc_is_modify_return(const struct b 567 u32 *btf_kfunc_is_modify_return(const struct btf *btf, u32 kfunc_btf_id, 568 const struct b 568 const struct bpf_prog *prog); 569 int register_btf_kfunc_id_set(enum bpf_prog_ty 569 int register_btf_kfunc_id_set(enum bpf_prog_type prog_type, 570 const struct btf 570 const struct btf_kfunc_id_set *s); 571 int register_btf_fmodret_id_set(const struct b 571 int register_btf_fmodret_id_set(const struct btf_kfunc_id_set *kset); 572 s32 btf_find_dtor_kfunc(struct btf *btf, u32 b 572 s32 btf_find_dtor_kfunc(struct btf *btf, u32 btf_id); 573 int register_btf_id_dtor_kfuncs(const struct b 573 int register_btf_id_dtor_kfuncs(const struct btf_id_dtor_kfunc *dtors, u32 add_cnt, 574 struct module 574 struct module *owner); 575 struct btf_struct_meta *btf_find_struct_meta(c 575 struct btf_struct_meta *btf_find_struct_meta(const struct btf *btf, u32 btf_id); 576 bool btf_is_projection_of(const char *pname, c 576 bool btf_is_projection_of(const char *pname, const char *tname); 577 bool btf_is_prog_ctx_type(struct bpf_verifier_ 577 bool btf_is_prog_ctx_type(struct bpf_verifier_log *log, const struct btf *btf, 578 const struct btf_ty 578 const struct btf_type *t, enum bpf_prog_type prog_type, 579 int arg); 579 int arg); 580 int get_kern_ctx_btf_id(struct bpf_verifier_lo 580 int get_kern_ctx_btf_id(struct bpf_verifier_log *log, enum bpf_prog_type prog_type); 581 bool btf_types_are_same(const struct btf *btf1 581 bool btf_types_are_same(const struct btf *btf1, u32 id1, 582 const struct btf *btf2 582 const struct btf *btf2, u32 id2); 583 int btf_check_iter_arg(struct btf *btf, const 583 int btf_check_iter_arg(struct btf *btf, const struct btf_type *func, int arg_idx); 584 #else 584 #else 585 static inline const struct btf_type *btf_type_ 585 static inline const struct btf_type *btf_type_by_id(const struct btf *btf, 586 586 u32 type_id) 587 { 587 { 588 return NULL; 588 return NULL; 589 } 589 } 590 590 591 static inline void btf_set_base_btf(struct btf 591 static inline void btf_set_base_btf(struct btf *btf, const struct btf *base_btf) 592 { 592 { 593 } 593 } 594 594 595 static inline int btf_relocate(void *log, stru 595 static inline int btf_relocate(void *log, struct btf *btf, const struct btf *base_btf, 596 __u32 **map_ids 596 __u32 **map_ids) 597 { 597 { 598 return -EOPNOTSUPP; 598 return -EOPNOTSUPP; 599 } 599 } 600 600 601 static inline int btf_field_iter_init(struct b 601 static inline int btf_field_iter_init(struct btf_field_iter *it, struct btf_type *t, 602 enum btf 602 enum btf_field_iter_kind iter_kind) 603 { 603 { 604 return -EOPNOTSUPP; 604 return -EOPNOTSUPP; 605 } 605 } 606 606 607 static inline __u32 *btf_field_iter_next(struc 607 static inline __u32 *btf_field_iter_next(struct btf_field_iter *it) 608 { 608 { 609 return NULL; 609 return NULL; 610 } 610 } 611 611 612 static inline const char *btf_name_by_offset(c 612 static inline const char *btf_name_by_offset(const struct btf *btf, 613 u 613 u32 offset) 614 { 614 { 615 return NULL; 615 return NULL; 616 } 616 } 617 static inline u32 *btf_kfunc_id_set_contains(c 617 static inline u32 *btf_kfunc_id_set_contains(const struct btf *btf, 618 u 618 u32 kfunc_btf_id, 619 s 619 struct bpf_prog *prog) 620 620 621 { 621 { 622 return NULL; 622 return NULL; 623 } 623 } 624 static inline int register_btf_kfunc_id_set(en 624 static inline int register_btf_kfunc_id_set(enum bpf_prog_type prog_type, 625 co 625 const struct btf_kfunc_id_set *s) 626 { 626 { 627 return 0; 627 return 0; 628 } 628 } 629 static inline s32 btf_find_dtor_kfunc(struct b 629 static inline s32 btf_find_dtor_kfunc(struct btf *btf, u32 btf_id) 630 { 630 { 631 return -ENOENT; 631 return -ENOENT; 632 } 632 } 633 static inline int register_btf_id_dtor_kfuncs( 633 static inline int register_btf_id_dtor_kfuncs(const struct btf_id_dtor_kfunc *dtors, 634 634 u32 add_cnt, struct module *owner) 635 { 635 { 636 return 0; 636 return 0; 637 } 637 } 638 static inline struct btf_struct_meta *btf_find 638 static inline struct btf_struct_meta *btf_find_struct_meta(const struct btf *btf, u32 btf_id) 639 { 639 { 640 return NULL; 640 return NULL; 641 } 641 } 642 static inline bool 642 static inline bool 643 btf_is_prog_ctx_type(struct bpf_verifier_log * 643 btf_is_prog_ctx_type(struct bpf_verifier_log *log, const struct btf *btf, 644 const struct btf_type *t, 644 const struct btf_type *t, enum bpf_prog_type prog_type, 645 int arg) 645 int arg) 646 { 646 { 647 return false; 647 return false; 648 } 648 } 649 static inline int get_kern_ctx_btf_id(struct b 649 static inline int get_kern_ctx_btf_id(struct bpf_verifier_log *log, 650 enum bpf 650 enum bpf_prog_type prog_type) { 651 return -EINVAL; 651 return -EINVAL; 652 } 652 } 653 static inline bool btf_types_are_same(const st 653 static inline bool btf_types_are_same(const struct btf *btf1, u32 id1, 654 const st 654 const struct btf *btf2, u32 id2) 655 { 655 { 656 return false; 656 return false; 657 } 657 } 658 static inline int btf_check_iter_arg(struct bt 658 static inline int btf_check_iter_arg(struct btf *btf, const struct btf_type *func, int arg_idx) 659 { 659 { 660 return -EOPNOTSUPP; 660 return -EOPNOTSUPP; 661 } 661 } 662 #endif 662 #endif 663 663 664 static inline bool btf_type_is_struct_ptr(stru 664 static inline bool btf_type_is_struct_ptr(struct btf *btf, const struct btf_type *t) 665 { 665 { 666 if (!btf_type_is_ptr(t)) 666 if (!btf_type_is_ptr(t)) 667 return false; 667 return false; 668 668 669 t = btf_type_skip_modifiers(btf, t->ty 669 t = btf_type_skip_modifiers(btf, t->type, NULL); 670 670 671 return btf_type_is_struct(t); 671 return btf_type_is_struct(t); 672 } 672 } 673 673 674 #endif 674 #endif 675 675
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.