]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
btf: Add BTF kind layout encoding to UAPI
authorAlan Maguire <alan.maguire@oracle.com>
Thu, 26 Mar 2026 14:54:36 +0000 (14:54 +0000)
committerAndrii Nakryiko <andrii@kernel.org>
Thu, 26 Mar 2026 20:53:56 +0000 (13:53 -0700)
BTF kind layouts provide information to parse BTF kinds. By separating
parsing BTF from using all the information it provides, we allow BTF
to encode new features even if they cannot be used by readers. This
will be helpful in particular for cases where older tools are used
to parse newer BTF with kinds the older tools do not recognize;
the BTF can still be parsed in such cases using kind layout.

The intent is to support encoding of kind layouts optionally so that
tools like pahole can add this information. For each kind, we record

- length of singular element following struct btf_type
- length of each of the btf_vlen() elements following
- a (currently unused) flags field

The ideas here were discussed at [1], [2]; hence

Suggested-by: Andrii Nakryiko <andrii@kernel.org>
Signed-off-by: Alan Maguire <alan.maguire@oracle.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20260326145444.2076244-2-alan.maguire@oracle.com
[1] https://lore.kernel.org/bpf/CAEf4BzYjWHRdNNw4B=eOXOs_ONrDwrgX4bn=Nuc1g8JPFC34MA@mail.gmail.com/
[2] https://lore.kernel.org/bpf/20230531201936.1992188-1-alan.maguire@oracle.com/

include/uapi/linux/btf.h
tools/include/uapi/linux/btf.h

index 266d4ffa6c0772b3d4b52be0229566aabf4f586d..638615ebddc220198cc201f4f82f4da94dcaa331 100644 (file)
@@ -8,6 +8,16 @@
 #define BTF_MAGIC      0xeB9F
 #define BTF_VERSION    1
 
+/*
+ * BTF layout section consists of a struct btf_layout for each known
+ * kind at BTF encoding time.
+ */
+struct btf_layout {
+       __u8 info_sz;           /* size of singular element after btf_type */
+       __u8 elem_sz;           /* size of each of btf_vlen(t) elements */
+       __u16 flags;            /* currently unused */
+};
+
 struct btf_header {
        __u16   magic;
        __u8    version;
@@ -19,6 +29,8 @@ struct btf_header {
        __u32   type_len;       /* length of type section       */
        __u32   str_off;        /* offset of string section     */
        __u32   str_len;        /* length of string section     */
+       __u32   layout_off;     /* offset of layout section     */
+       __u32   layout_len;     /* length of layout section     */
 };
 
 /* Max # of type identifier */
index 266d4ffa6c0772b3d4b52be0229566aabf4f586d..638615ebddc220198cc201f4f82f4da94dcaa331 100644 (file)
@@ -8,6 +8,16 @@
 #define BTF_MAGIC      0xeB9F
 #define BTF_VERSION    1
 
+/*
+ * BTF layout section consists of a struct btf_layout for each known
+ * kind at BTF encoding time.
+ */
+struct btf_layout {
+       __u8 info_sz;           /* size of singular element after btf_type */
+       __u8 elem_sz;           /* size of each of btf_vlen(t) elements */
+       __u16 flags;            /* currently unused */
+};
+
 struct btf_header {
        __u16   magic;
        __u8    version;
@@ -19,6 +29,8 @@ struct btf_header {
        __u32   type_len;       /* length of type section       */
        __u32   str_off;        /* offset of string section     */
        __u32   str_len;        /* length of string section     */
+       __u32   layout_off;     /* offset of layout section     */
+       __u32   layout_len;     /* length of layout section     */
 };
 
 /* Max # of type identifier */