1 /* SPDX-License-Identifier: GPL-2.0 */ 1 /* SPDX-License-Identifier: GPL-2.0 */
2 2
3 #ifndef _LINUX_BTF_IDS_H 3 #ifndef _LINUX_BTF_IDS_H
4 #define _LINUX_BTF_IDS_H 4 #define _LINUX_BTF_IDS_H
5 5
6 #include <linux/types.h> /* for u32 */ <<
7 <<
8 struct btf_id_set { 6 struct btf_id_set {
9 u32 cnt; 7 u32 cnt;
10 u32 ids[]; 8 u32 ids[];
11 }; 9 };
12 10
13 /* This flag implies BTF_SET8 holds kfunc(s) * <<
14 #define BTF_SET8_KFUNCS (1 << 0) <<
15 <<
16 struct btf_id_set8 { <<
17 u32 cnt; <<
18 u32 flags; <<
19 struct { <<
20 u32 id; <<
21 u32 flags; <<
22 } pairs[]; <<
23 }; <<
24 <<
25 #ifdef CONFIG_DEBUG_INFO_BTF 11 #ifdef CONFIG_DEBUG_INFO_BTF
26 12
27 #include <linux/compiler.h> /* for __PASTE */ 13 #include <linux/compiler.h> /* for __PASTE */
28 #include <linux/compiler_attributes.h> /* for 14 #include <linux/compiler_attributes.h> /* for __maybe_unused */
29 #include <linux/stringify.h> <<
30 15
31 /* 16 /*
32 * Following macros help to define lists of BT 17 * Following macros help to define lists of BTF IDs placed
33 * in .BTF_ids section. They are initially fil 18 * in .BTF_ids section. They are initially filled with zeros
34 * (during compilation) and resolved later dur 19 * (during compilation) and resolved later during the
35 * linking phase by resolve_btfids tool. 20 * linking phase by resolve_btfids tool.
36 * 21 *
37 * Any change in list layout must be reflected 22 * Any change in list layout must be reflected in resolve_btfids
38 * tool logic. 23 * tool logic.
39 */ 24 */
40 25
41 #define BTF_IDS_SECTION ".BTF_ids" 26 #define BTF_IDS_SECTION ".BTF_ids"
42 27
43 #define ____BTF_ID(symbol, word) !! 28 #define ____BTF_ID(symbol) \
44 asm( 29 asm( \
45 ".pushsection " BTF_IDS_SECTION ",\"a\"; 30 ".pushsection " BTF_IDS_SECTION ",\"a\"; \n" \
46 ".local " #symbol " ; 31 ".local " #symbol " ; \n" \
47 ".type " #symbol ", STT_OBJECT; 32 ".type " #symbol ", STT_OBJECT; \n" \
48 ".size " #symbol ", 4; 33 ".size " #symbol ", 4; \n" \
49 #symbol ": 34 #symbol ": \n" \
50 ".zero 4 35 ".zero 4 \n" \
51 word <<
52 ".popsection; 36 ".popsection; \n");
53 37
54 #define __BTF_ID(symbol, word) \ !! 38 #define __BTF_ID(symbol) \
55 ____BTF_ID(symbol, word) !! 39 ____BTF_ID(symbol)
56 40
57 #define __ID(prefix) \ 41 #define __ID(prefix) \
58 __PASTE(__PASTE(prefix, __COUNTER__), !! 42 __PASTE(prefix, __COUNTER__)
59 43
60 /* 44 /*
61 * The BTF_ID defines unique symbol for each I 45 * The BTF_ID defines unique symbol for each ID pointing
62 * to 4 zero bytes. 46 * to 4 zero bytes.
63 */ 47 */
64 #define BTF_ID(prefix, name) \ 48 #define BTF_ID(prefix, name) \
65 __BTF_ID(__ID(__BTF_ID__##prefix##__## !! 49 __BTF_ID(__ID(__BTF_ID__##prefix##__##name##__))
66 <<
67 #define ____BTF_ID_FLAGS(prefix, name, flags) <<
68 __BTF_ID(__ID(__BTF_ID__##prefix##__## <<
69 #define __BTF_ID_FLAGS(prefix, name, flags, .. <<
70 ____BTF_ID_FLAGS(prefix, name, flags) <<
71 #define BTF_ID_FLAGS(prefix, name, ...) \ <<
72 __BTF_ID_FLAGS(prefix, name, ##__VA_AR <<
73 50
74 /* 51 /*
75 * The BTF_ID_LIST macro defines pure (unsorte 52 * The BTF_ID_LIST macro defines pure (unsorted) list
76 * of BTF IDs, with following layout: 53 * of BTF IDs, with following layout:
77 * 54 *
78 * BTF_ID_LIST(list1) 55 * BTF_ID_LIST(list1)
79 * BTF_ID(type1, name1) 56 * BTF_ID(type1, name1)
80 * BTF_ID(type2, name2) 57 * BTF_ID(type2, name2)
81 * 58 *
82 * list1: 59 * list1:
83 * __BTF_ID__type1__name1__1: 60 * __BTF_ID__type1__name1__1:
84 * .zero 4 61 * .zero 4
85 * __BTF_ID__type2__name2__2: 62 * __BTF_ID__type2__name2__2:
86 * .zero 4 63 * .zero 4
87 * 64 *
88 */ 65 */
89 #define __BTF_ID_LIST(name, scope) 66 #define __BTF_ID_LIST(name, scope) \
90 asm( 67 asm( \
91 ".pushsection " BTF_IDS_SECTION ",\"a\"; 68 ".pushsection " BTF_IDS_SECTION ",\"a\"; \n" \
92 "." #scope " " #name "; 69 "." #scope " " #name "; \n" \
93 #name ":; 70 #name ":; \n" \
94 ".popsection; 71 ".popsection; \n");
95 72
96 #define BTF_ID_LIST(name) 73 #define BTF_ID_LIST(name) \
97 __BTF_ID_LIST(name, local) 74 __BTF_ID_LIST(name, local) \
98 extern u32 name[]; 75 extern u32 name[];
99 76
100 #define BTF_ID_LIST_GLOBAL(name, n) 77 #define BTF_ID_LIST_GLOBAL(name, n) \
101 __BTF_ID_LIST(name, globl) 78 __BTF_ID_LIST(name, globl)
102 79
103 /* The BTF_ID_LIST_SINGLE macro defines a BTF_ 80 /* The BTF_ID_LIST_SINGLE macro defines a BTF_ID_LIST with
104 * a single entry. 81 * a single entry.
105 */ 82 */
106 #define BTF_ID_LIST_SINGLE(name, prefix, typen 83 #define BTF_ID_LIST_SINGLE(name, prefix, typename) \
107 BTF_ID_LIST(name) \ 84 BTF_ID_LIST(name) \
108 BTF_ID(prefix, typename) 85 BTF_ID(prefix, typename)
109 #define BTF_ID_LIST_GLOBAL_SINGLE(name, prefix 86 #define BTF_ID_LIST_GLOBAL_SINGLE(name, prefix, typename) \
110 BTF_ID_LIST_GLOBAL(name, 1) 87 BTF_ID_LIST_GLOBAL(name, 1) \
111 BTF_ID(prefix, typename) 88 BTF_ID(prefix, typename)
112 89
113 /* 90 /*
114 * The BTF_ID_UNUSED macro defines 4 zero byte 91 * The BTF_ID_UNUSED macro defines 4 zero bytes.
115 * It's used when we want to define 'unused' e 92 * It's used when we want to define 'unused' entry
116 * in BTF_ID_LIST, like: 93 * in BTF_ID_LIST, like:
117 * 94 *
118 * BTF_ID_LIST(bpf_skb_output_btf_ids) 95 * BTF_ID_LIST(bpf_skb_output_btf_ids)
119 * BTF_ID(struct, sk_buff) 96 * BTF_ID(struct, sk_buff)
120 * BTF_ID_UNUSED 97 * BTF_ID_UNUSED
121 * BTF_ID(struct, task_struct) 98 * BTF_ID(struct, task_struct)
122 */ 99 */
123 100
124 #define BTF_ID_UNUSED 101 #define BTF_ID_UNUSED \
125 asm( 102 asm( \
126 ".pushsection " BTF_IDS_SECTION ",\"a\"; 103 ".pushsection " BTF_IDS_SECTION ",\"a\"; \n" \
127 ".zero 4 104 ".zero 4 \n" \
128 ".popsection; 105 ".popsection; \n");
129 106
130 /* 107 /*
131 * The BTF_SET_START/END macros pair defines s 108 * The BTF_SET_START/END macros pair defines sorted list of
132 * BTF IDs plus its members count, with follow 109 * BTF IDs plus its members count, with following layout:
133 * 110 *
134 * BTF_SET_START(list) 111 * BTF_SET_START(list)
135 * BTF_ID(type1, name1) 112 * BTF_ID(type1, name1)
136 * BTF_ID(type2, name2) 113 * BTF_ID(type2, name2)
137 * BTF_SET_END(list) 114 * BTF_SET_END(list)
138 * 115 *
139 * __BTF_ID__set__list: 116 * __BTF_ID__set__list:
140 * .zero 4 117 * .zero 4
141 * list: 118 * list:
142 * __BTF_ID__type1__name1__3: 119 * __BTF_ID__type1__name1__3:
143 * .zero 4 120 * .zero 4
144 * __BTF_ID__type2__name2__4: 121 * __BTF_ID__type2__name2__4:
145 * .zero 4 122 * .zero 4
146 * 123 *
147 */ 124 */
148 #define __BTF_SET_START(name, scope) 125 #define __BTF_SET_START(name, scope) \
149 asm( 126 asm( \
150 ".pushsection " BTF_IDS_SECTION ",\"a\"; 127 ".pushsection " BTF_IDS_SECTION ",\"a\"; \n" \
151 "." #scope " __BTF_ID__set__" #name "; 128 "." #scope " __BTF_ID__set__" #name "; \n" \
152 "__BTF_ID__set__" #name ":; 129 "__BTF_ID__set__" #name ":; \n" \
153 ".zero 4 130 ".zero 4 \n" \
154 ".popsection; 131 ".popsection; \n");
155 132
156 #define BTF_SET_START(name) 133 #define BTF_SET_START(name) \
157 __BTF_ID_LIST(name, local) 134 __BTF_ID_LIST(name, local) \
158 __BTF_SET_START(name, local) 135 __BTF_SET_START(name, local)
159 136
160 #define BTF_SET_START_GLOBAL(name) 137 #define BTF_SET_START_GLOBAL(name) \
161 __BTF_ID_LIST(name, globl) 138 __BTF_ID_LIST(name, globl) \
162 __BTF_SET_START(name, globl) 139 __BTF_SET_START(name, globl)
163 140
164 #define BTF_SET_END(name) 141 #define BTF_SET_END(name) \
165 asm( 142 asm( \
166 ".pushsection " BTF_IDS_SECTION ",\"a\"; 143 ".pushsection " BTF_IDS_SECTION ",\"a\"; \n" \
167 ".size __BTF_ID__set__" #name ", .-" #name " 144 ".size __BTF_ID__set__" #name ", .-" #name " \n" \
168 ".popsection; 145 ".popsection; \n"); \
169 extern struct btf_id_set name; 146 extern struct btf_id_set name;
170 147
171 /* <<
172 * The BTF_SET8_START/END macros pair defines <<
173 * BTF IDs and their flags plus its members co <<
174 * following layout: <<
175 * <<
176 * BTF_SET8_START(list) <<
177 * BTF_ID_FLAGS(type1, name1, flags) <<
178 * BTF_ID_FLAGS(type2, name2, flags) <<
179 * BTF_SET8_END(list) <<
180 * <<
181 * __BTF_ID__set8__list: <<
182 * .zero 8 <<
183 * list: <<
184 * __BTF_ID__type1__name1__3: <<
185 * .zero 4 <<
186 * .word (1 << 0) | (1 << 2) <<
187 * __BTF_ID__type2__name2__5: <<
188 * .zero 4 <<
189 * .word (1 << 3) | (1 << 1) | (1 << 2) <<
190 * <<
191 */ <<
192 #define __BTF_SET8_START(name, scope, flags) <<
193 __BTF_ID_LIST(name, local) <<
194 asm( <<
195 ".pushsection " BTF_IDS_SECTION ",\"a\"; <<
196 "." #scope " __BTF_ID__set8__" #name "; <<
197 "__BTF_ID__set8__" #name ":; <<
198 ".zero 4 <<
199 ".long " __stringify(flags) <<
200 ".popsection; <<
201 <<
202 #define BTF_SET8_START(name) <<
203 __BTF_SET8_START(name, local, 0) <<
204 <<
205 #define BTF_SET8_END(name) <<
206 asm( <<
207 ".pushsection " BTF_IDS_SECTION ",\"a\"; <<
208 ".size __BTF_ID__set8__" #name ", .-" #name " <<
209 ".popsection; <<
210 extern struct btf_id_set8 name; <<
211 <<
212 #define BTF_KFUNCS_START(name) <<
213 __BTF_SET8_START(name, local, BTF_SET8_KFUNCS) <<
214 <<
215 #define BTF_KFUNCS_END(name) <<
216 BTF_SET8_END(name) <<
217 <<
218 #else 148 #else
219 149
220 #define BTF_ID_LIST(name) static u32 __maybe_u !! 150 #define BTF_ID_LIST(name) static u32 __maybe_unused name[5];
221 #define BTF_ID(prefix, name) 151 #define BTF_ID(prefix, name)
222 #define BTF_ID_FLAGS(prefix, name, ...) <<
223 #define BTF_ID_UNUSED 152 #define BTF_ID_UNUSED
224 #define BTF_ID_LIST_GLOBAL(name, n) u32 __mayb 153 #define BTF_ID_LIST_GLOBAL(name, n) u32 __maybe_unused name[n];
225 #define BTF_ID_LIST_SINGLE(name, prefix, typen 154 #define BTF_ID_LIST_SINGLE(name, prefix, typename) static u32 __maybe_unused name[1];
226 #define BTF_ID_LIST_GLOBAL_SINGLE(name, prefix 155 #define BTF_ID_LIST_GLOBAL_SINGLE(name, prefix, typename) u32 __maybe_unused name[1];
227 #define BTF_SET_START(name) static struct btf_ 156 #define BTF_SET_START(name) static struct btf_id_set __maybe_unused name = { 0 };
228 #define BTF_SET_START_GLOBAL(name) static stru 157 #define BTF_SET_START_GLOBAL(name) static struct btf_id_set __maybe_unused name = { 0 };
229 #define BTF_SET_END(name) 158 #define BTF_SET_END(name)
230 #define BTF_SET8_START(name) static struct btf <<
231 #define BTF_SET8_END(name) <<
232 #define BTF_KFUNCS_START(name) static struct b <<
233 #define BTF_KFUNCS_END(name) <<
234 159
235 #endif /* CONFIG_DEBUG_INFO_BTF */ 160 #endif /* CONFIG_DEBUG_INFO_BTF */
236 161
237 #ifdef CONFIG_NET 162 #ifdef CONFIG_NET
238 /* Define a list of socket types which can be 163 /* Define a list of socket types which can be the argument for
239 * skc_to_*_sock() helpers. All these sockets 164 * skc_to_*_sock() helpers. All these sockets should have
240 * sock_common as the first argument in its me 165 * sock_common as the first argument in its memory layout.
241 */ 166 */
242 #define BTF_SOCK_TYPE_xxx \ 167 #define BTF_SOCK_TYPE_xxx \
243 BTF_SOCK_TYPE(BTF_SOCK_TYPE_INET, inet 168 BTF_SOCK_TYPE(BTF_SOCK_TYPE_INET, inet_sock) \
244 BTF_SOCK_TYPE(BTF_SOCK_TYPE_INET_CONN, 169 BTF_SOCK_TYPE(BTF_SOCK_TYPE_INET_CONN, inet_connection_sock) \
245 BTF_SOCK_TYPE(BTF_SOCK_TYPE_INET_REQ, 170 BTF_SOCK_TYPE(BTF_SOCK_TYPE_INET_REQ, inet_request_sock) \
246 BTF_SOCK_TYPE(BTF_SOCK_TYPE_INET_TW, i 171 BTF_SOCK_TYPE(BTF_SOCK_TYPE_INET_TW, inet_timewait_sock) \
247 BTF_SOCK_TYPE(BTF_SOCK_TYPE_REQ, reque 172 BTF_SOCK_TYPE(BTF_SOCK_TYPE_REQ, request_sock) \
248 BTF_SOCK_TYPE(BTF_SOCK_TYPE_SOCK, sock 173 BTF_SOCK_TYPE(BTF_SOCK_TYPE_SOCK, sock) \
249 BTF_SOCK_TYPE(BTF_SOCK_TYPE_SOCK_COMMO 174 BTF_SOCK_TYPE(BTF_SOCK_TYPE_SOCK_COMMON, sock_common) \
250 BTF_SOCK_TYPE(BTF_SOCK_TYPE_TCP, tcp_s 175 BTF_SOCK_TYPE(BTF_SOCK_TYPE_TCP, tcp_sock) \
251 BTF_SOCK_TYPE(BTF_SOCK_TYPE_TCP_REQ, t 176 BTF_SOCK_TYPE(BTF_SOCK_TYPE_TCP_REQ, tcp_request_sock) \
252 BTF_SOCK_TYPE(BTF_SOCK_TYPE_TCP_TW, tc 177 BTF_SOCK_TYPE(BTF_SOCK_TYPE_TCP_TW, tcp_timewait_sock) \
253 BTF_SOCK_TYPE(BTF_SOCK_TYPE_TCP6, tcp6 178 BTF_SOCK_TYPE(BTF_SOCK_TYPE_TCP6, tcp6_sock) \
254 BTF_SOCK_TYPE(BTF_SOCK_TYPE_UDP, udp_s 179 BTF_SOCK_TYPE(BTF_SOCK_TYPE_UDP, udp_sock) \
255 BTF_SOCK_TYPE(BTF_SOCK_TYPE_UDP6, udp6 180 BTF_SOCK_TYPE(BTF_SOCK_TYPE_UDP6, udp6_sock) \
256 BTF_SOCK_TYPE(BTF_SOCK_TYPE_UNIX, unix !! 181 BTF_SOCK_TYPE(BTF_SOCK_TYPE_UNIX, unix_sock)
257 BTF_SOCK_TYPE(BTF_SOCK_TYPE_MPTCP, mpt <<
258 BTF_SOCK_TYPE(BTF_SOCK_TYPE_SOCKET, so <<
259 182
260 enum { 183 enum {
261 #define BTF_SOCK_TYPE(name, str) name, 184 #define BTF_SOCK_TYPE(name, str) name,
262 BTF_SOCK_TYPE_xxx 185 BTF_SOCK_TYPE_xxx
263 #undef BTF_SOCK_TYPE 186 #undef BTF_SOCK_TYPE
264 MAX_BTF_SOCK_TYPE, 187 MAX_BTF_SOCK_TYPE,
265 }; 188 };
266 189
267 extern u32 btf_sock_ids[]; 190 extern u32 btf_sock_ids[];
268 #endif 191 #endif
269 192
270 #define BTF_TRACING_TYPE_xxx \ 193 #define BTF_TRACING_TYPE_xxx \
271 BTF_TRACING_TYPE(BTF_TRACING_TYPE_TASK 194 BTF_TRACING_TYPE(BTF_TRACING_TYPE_TASK, task_struct) \
272 BTF_TRACING_TYPE(BTF_TRACING_TYPE_FILE 195 BTF_TRACING_TYPE(BTF_TRACING_TYPE_FILE, file) \
273 BTF_TRACING_TYPE(BTF_TRACING_TYPE_VMA, 196 BTF_TRACING_TYPE(BTF_TRACING_TYPE_VMA, vm_area_struct)
274 197
275 enum { 198 enum {
276 #define BTF_TRACING_TYPE(name, type) name, 199 #define BTF_TRACING_TYPE(name, type) name,
277 BTF_TRACING_TYPE_xxx 200 BTF_TRACING_TYPE_xxx
278 #undef BTF_TRACING_TYPE 201 #undef BTF_TRACING_TYPE
279 MAX_BTF_TRACING_TYPE, 202 MAX_BTF_TRACING_TYPE,
280 }; 203 };
281 204
282 extern u32 btf_tracing_ids[]; 205 extern u32 btf_tracing_ids[];
283 extern u32 bpf_cgroup_btf_id[]; <<
284 extern u32 bpf_local_storage_map_btf_id[]; <<
285 extern u32 btf_bpf_map_id[]; <<
286 206
287 #endif 207 #endif
288 208
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.