lib/bpf/btf.h

1 /* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
49  * On error, error-code-encoded-as-pointer is returned, not a NULL. To extract
51  * `libbpf_set_strict_mode(LIBBPF_STRICT_CLEAN_PTRS)` is enabled, NULL is
52  * returned on error instead. In both cases thread-local `errno` variable is
69  * creates non-split BTF.
71  * On error, error-code-encoded-as-pointer is returned, not a NULL. To extract
73  * `libbpf_set_strict_mode(LIBBPF_STRICT_CLEAN_PTRS)` is enabled, NULL is
74  * returned on error instead. In both cases thread-local `errno` variable is
85  * On error, error-code-encoded-as-pointer is returned, not a NULL. To extract
87  * `libbpf_set_strict_mode(LIBBPF_STRICT_CLEAN_PTRS)` is enabled, NULL is
88  * returned on error instead. In both cases thread-local `errno` variable is
101  * `btf__new_empty()` and creates non-split BTF.
103  * On error, error-code-encoded-as-pointer is returned, not a NULL. To extract
105  * `libbpf_set_strict_mode(LIBBPF_STRICT_CLEAN_PTRS)` is enabled, NULL is
106  * returned on error instead. In both cases thread-local `errno` variable is
126  * A negative value is returned on error and the thread-local `errno` variable
180  * @param btf BTF object which all the BTF types and strings are added to
181  * @param src_btf BTF object which all BTF types and referenced strings are copied from
187  * Only strings referenced from BTF types are copied over and deduplicated, so
188  * if there were some unused strings in *src_btf*, those won't be copied over,
194  * semantics and the operation as a whole is all-or-nothing.
196  * *src_btf* has to be non-split BTF, as of now copying types from split BTF
197  * is not supported and will result in -ENOTSUP error code returned.
265  * *base_btf*; if they are, *btf* is adjusted such that is re-parented to
266  * *base_btf* and type ids and strings are adjusted to accommodate this.
271  * A negative value is returned on error and the thread-local `errno` variable
298 	 * - struct my_struct <FNAME>
299 	 * - void (*<FNAME>)(int)
300 	 * - char (*<FNAME>)[123]
303 	/* extra indentation level (in number of tabs) to emit for multi-line
328 	bool emit_zeroes;	/* show 0-valued fields */
360 #define BTF_KIND_ENUM64		19	/* Enum for up-to 64bit values */
364 	return BTF_INFO_KIND(t->info);  in btf_kind()
369 	return BTF_INFO_VLEN(t->info);  in btf_vlen()
374 	return BTF_INFO_KFLAG(t->info);  in btf_kflag()
541 	 * bleeding-edge. Here we are avoiding relying on struct btf_enum64  in btf_enum64_value()
543 	 * of system-wide kernel headers.  in btf_enum64_value()
548 	 * a three-element array of u32 and access second (lo32) and third  in btf_enum64_value()
576 	return kflag ? BTF_MEMBER_BIT_OFFSET(m->offset) : m->offset;  in btf_member_bit_offset()
588 	return kflag ? BTF_MEMBER_BITFIELD_SIZE(m->offset) : 0;  in btf_member_bitfield_size()