]>
git.proxmox.com Git - mirror_iproute2.git/blob - include/uapi/linux/btf.h
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /* Copyright (c) 2018 Facebook */
3 #ifndef __LINUX_BTF_H__
4 #define __LINUX_BTF_H__
6 #include <linux/types.h>
8 #define BTF_MAGIC 0xeB9F
17 /* All offsets are in bytes relative to the end of this header */
18 __u32 type_off
; /* offset of type section */
19 __u32 type_len
; /* length of type section */
20 __u32 str_off
; /* offset of string section */
21 __u32 str_len
; /* length of string section */
24 /* Max # of type identifier */
25 #define BTF_MAX_TYPE 0x0000ffff
26 /* Max offset into the string section */
27 #define BTF_MAX_NAME_OFFSET 0x0000ffff
28 /* Max # of struct/union/enum members or func args */
29 #define BTF_MAX_VLEN 0xffff
33 /* "info" bits arrangement
34 * bits 0-15: vlen (e.g. # of struct's members)
36 * bits 24-27: kind (e.g. int, ptr, array...etc)
40 /* "size" is used by INT, ENUM, STRUCT and UNION.
41 * "size" tells the size of the type it is describing.
43 * "type" is used by PTR, TYPEDEF, VOLATILE, CONST, RESTRICT,
44 * FUNC and FUNC_PROTO.
45 * "type" is a type_id referring to another type.
53 #define BTF_INFO_KIND(info) (((info) >> 24) & 0x0f)
54 #define BTF_INFO_VLEN(info) ((info) & 0xffff)
56 #define BTF_KIND_UNKN 0 /* Unknown */
57 #define BTF_KIND_INT 1 /* Integer */
58 #define BTF_KIND_PTR 2 /* Pointer */
59 #define BTF_KIND_ARRAY 3 /* Array */
60 #define BTF_KIND_STRUCT 4 /* Struct */
61 #define BTF_KIND_UNION 5 /* Union */
62 #define BTF_KIND_ENUM 6 /* Enumeration */
63 #define BTF_KIND_FWD 7 /* Forward */
64 #define BTF_KIND_TYPEDEF 8 /* Typedef */
65 #define BTF_KIND_VOLATILE 9 /* Volatile */
66 #define BTF_KIND_CONST 10 /* Const */
67 #define BTF_KIND_RESTRICT 11 /* Restrict */
68 #define BTF_KIND_FUNC 12 /* Function */
69 #define BTF_KIND_FUNC_PROTO 13 /* Function Proto */
70 #define BTF_KIND_MAX 13
71 #define NR_BTF_KINDS 14
73 /* For some specific BTF_KIND, "struct btf_type" is immediately
74 * followed by extra data.
77 /* BTF_KIND_INT is followed by a u32 and the following
78 * is the 32 bits arrangement:
80 #define BTF_INT_ENCODING(VAL) (((VAL) & 0x0f000000) >> 24)
81 #define BTF_INT_OFFSET(VAL) (((VAL & 0x00ff0000)) >> 16)
82 #define BTF_INT_BITS(VAL) ((VAL) & 0x000000ff)
84 /* Attributes stored in the BTF_INT_ENCODING */
85 #define BTF_INT_SIGNED (1 << 0)
86 #define BTF_INT_CHAR (1 << 1)
87 #define BTF_INT_BOOL (1 << 2)
89 /* BTF_KIND_ENUM is followed by multiple "struct btf_enum".
90 * The exact number of btf_enum is stored in the vlen (of the
91 * info in "struct btf_type").
98 /* BTF_KIND_ARRAY is followed by one "struct btf_array" */
105 /* BTF_KIND_STRUCT and BTF_KIND_UNION are followed
106 * by multiple "struct btf_member". The exact number
107 * of btf_member is stored in the vlen (of the info in
108 * "struct btf_type").
113 __u32 offset
; /* offset in bits */
116 /* BTF_KIND_FUNC_PROTO is followed by multiple "struct btf_param".
117 * The exact number of btf_param is stored in the vlen (of the
118 * info in "struct btf_type").
125 #endif /* __LINUX_BTF_H__ */