xref: /linux/tools/lib/bpf/bpf.h (revision dbcedec3a31119d7594baacc743300d127c99c56)
1 /* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
2 
3 /*
4  * Common BPF ELF operations.
5  *
6  * Copyright (C) 2013-2015 Alexei Starovoitov <ast@kernel.org>
7  * Copyright (C) 2015 Wang Nan <wangnan0@huawei.com>
8  * Copyright (C) 2015 Huawei Inc.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation;
13  * version 2.1 of the License (not later!)
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with this program; if not,  see <http://www.gnu.org/licenses>
22  */
23 #ifndef __LIBBPF_BPF_H
24 #define __LIBBPF_BPF_H
25 
26 #include <linux/bpf.h>
27 #include <stdbool.h>
28 #include <stddef.h>
29 #include <stdint.h>
30 
31 #include "libbpf_common.h"
32 #include "libbpf_legacy.h"
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 LIBBPF_API int libbpf_set_memlock_rlim(size_t memlock_bytes);
39 
40 struct bpf_map_create_opts {
41 	size_t sz; /* size of this struct for forward/backward compatibility */
42 
43 	__u32 btf_fd;
44 	__u32 btf_key_type_id;
45 	__u32 btf_value_type_id;
46 	__u32 btf_vmlinux_value_type_id;
47 
48 	__u32 inner_map_fd;
49 	__u32 map_flags;
50 	__u64 map_extra;
51 
52 	__u32 numa_node;
53 	__u32 map_ifindex;
54 	__s32 value_type_btf_obj_fd;
55 
56 	__u32 token_fd;
57 	size_t :0;
58 };
59 #define bpf_map_create_opts__last_field token_fd
60 
61 LIBBPF_API int bpf_map_create(enum bpf_map_type map_type,
62 			      const char *map_name,
63 			      __u32 key_size,
64 			      __u32 value_size,
65 			      __u32 max_entries,
66 			      const struct bpf_map_create_opts *opts);
67 
68 struct bpf_prog_load_opts {
69 	size_t sz; /* size of this struct for forward/backward compatibility */
70 
71 	/* libbpf can retry BPF_PROG_LOAD command if bpf() syscall returns
72 	 * -EAGAIN. This field determines how many attempts libbpf has to
73 	 *  make. If not specified, libbpf will use default value of 5.
74 	 */
75 	int attempts;
76 
77 	enum bpf_attach_type expected_attach_type;
78 	__u32 prog_btf_fd;
79 	__u32 prog_flags;
80 	__u32 prog_ifindex;
81 	__u32 kern_version;
82 
83 	__u32 attach_btf_id;
84 	__u32 attach_prog_fd;
85 	__u32 attach_btf_obj_fd;
86 
87 	const int *fd_array;
88 
89 	/* .BTF.ext func info data */
90 	const void *func_info;
91 	__u32 func_info_cnt;
92 	__u32 func_info_rec_size;
93 
94 	/* .BTF.ext line info data */
95 	const void *line_info;
96 	__u32 line_info_cnt;
97 	__u32 line_info_rec_size;
98 
99 	/* verifier log options */
100 	__u32 log_level;
101 	__u32 log_size;
102 	char *log_buf;
103 	/* output: actual total log contents size (including termintaing zero).
104 	 * It could be both larger than original log_size (if log was
105 	 * truncated), or smaller (if log buffer wasn't filled completely).
106 	 * If kernel doesn't support this feature, log_size is left unchanged.
107 	 */
108 	__u32 log_true_size;
109 	__u32 token_fd;
110 	size_t :0;
111 };
112 #define bpf_prog_load_opts__last_field token_fd
113 
114 LIBBPF_API int bpf_prog_load(enum bpf_prog_type prog_type,
115 			     const char *prog_name, const char *license,
116 			     const struct bpf_insn *insns, size_t insn_cnt,
117 			     struct bpf_prog_load_opts *opts);
118 
119 /* Flags to direct loading requirements */
120 #define MAPS_RELAX_COMPAT	0x01
121 
122 /* Recommended log buffer size */
123 #define BPF_LOG_BUF_SIZE (UINT32_MAX >> 8) /* verifier maximum in kernels <= 5.1 */
124 
125 struct bpf_btf_load_opts {
126 	size_t sz; /* size of this struct for forward/backward compatibility */
127 
128 	/* kernel log options */
129 	char *log_buf;
130 	__u32 log_level;
131 	__u32 log_size;
132 	/* output: actual total log contents size (including termintaing zero).
133 	 * It could be both larger than original log_size (if log was
134 	 * truncated), or smaller (if log buffer wasn't filled completely).
135 	 * If kernel doesn't support this feature, log_size is left unchanged.
136 	 */
137 	__u32 log_true_size;
138 
139 	__u32 btf_flags;
140 	__u32 token_fd;
141 	size_t :0;
142 };
143 #define bpf_btf_load_opts__last_field token_fd
144 
145 LIBBPF_API int bpf_btf_load(const void *btf_data, size_t btf_size,
146 			    struct bpf_btf_load_opts *opts);
147 
148 LIBBPF_API int bpf_map_update_elem(int fd, const void *key, const void *value,
149 				   __u64 flags);
150 
151 LIBBPF_API int bpf_map_lookup_elem(int fd, const void *key, void *value);
152 LIBBPF_API int bpf_map_lookup_elem_flags(int fd, const void *key, void *value,
153 					 __u64 flags);
154 LIBBPF_API int bpf_map_lookup_and_delete_elem(int fd, const void *key,
155 					      void *value);
156 LIBBPF_API int bpf_map_lookup_and_delete_elem_flags(int fd, const void *key,
157 						    void *value, __u64 flags);
158 LIBBPF_API int bpf_map_delete_elem(int fd, const void *key);
159 LIBBPF_API int bpf_map_delete_elem_flags(int fd, const void *key, __u64 flags);
160 LIBBPF_API int bpf_map_get_next_key(int fd, const void *key, void *next_key);
161 LIBBPF_API int bpf_map_freeze(int fd);
162 
163 struct bpf_map_batch_opts {
164 	size_t sz; /* size of this struct for forward/backward compatibility */
165 	__u64 elem_flags;
166 	__u64 flags;
167 };
168 #define bpf_map_batch_opts__last_field flags
169 
170 
171 /**
172  * @brief **bpf_map_delete_batch()** allows for batch deletion of multiple
173  * elements in a BPF map.
174  *
175  * @param fd BPF map file descriptor
176  * @param keys pointer to an array of *count* keys
177  * @param count input and output parameter; on input **count** represents the
178  * number of  elements in the map to delete in batch;
179  * on output if a non-EFAULT error is returned, **count** represents the number of deleted
180  * elements if the output **count** value is not equal to the input **count** value
181  * If EFAULT is returned, **count** should not be trusted to be correct.
182  * @param opts options for configuring the way the batch deletion works
183  * @return 0, on success; negative error code, otherwise (errno is also set to
184  * the error code)
185  */
186 LIBBPF_API int bpf_map_delete_batch(int fd, const void *keys,
187 				    __u32 *count,
188 				    const struct bpf_map_batch_opts *opts);
189 
190 /**
191  * @brief **bpf_map_lookup_batch()** allows for batch lookup of BPF map elements.
192  *
193  * The parameter *in_batch* is the address of the first element in the batch to
194  * read. *out_batch* is an output parameter that should be passed as *in_batch*
195  * to subsequent calls to **bpf_map_lookup_batch()**. NULL can be passed for
196  * *in_batch* to indicate that the batched lookup starts from the beginning of
197  * the map. Both *in_batch* and *out_batch* must point to memory large enough to
198  * hold a single key, except for maps of type **BPF_MAP_TYPE_{HASH, PERCPU_HASH,
199  * LRU_HASH, LRU_PERCPU_HASH}**, for which the memory size must be at
200  * least 4 bytes wide regardless of key size.
201  *
202  * The *keys* and *values* are output parameters which must point to memory large enough to
203  * hold *count* items based on the key and value size of the map *map_fd*. The *keys*
204  * buffer must be of *key_size* * *count*. The *values* buffer must be of
205  * *value_size* * *count*.
206  *
207  * @param fd BPF map file descriptor
208  * @param in_batch address of the first element in batch to read, can pass NULL to
209  * indicate that the batched lookup starts from the beginning of the map.
210  * @param out_batch output parameter that should be passed to next call as *in_batch*
211  * @param keys pointer to an array large enough for *count* keys
212  * @param values pointer to an array large enough for *count* values
213  * @param count input and output parameter; on input it's the number of elements
214  * in the map to read in batch; on output it's the number of elements that were
215  * successfully read.
216  * If a non-EFAULT error is returned, count will be set as the number of elements
217  * that were read before the error occurred.
218  * If EFAULT is returned, **count** should not be trusted to be correct.
219  * @param opts options for configuring the way the batch lookup works
220  * @return 0, on success; negative error code, otherwise (errno is also set to
221  * the error code)
222  */
223 LIBBPF_API int bpf_map_lookup_batch(int fd, void *in_batch, void *out_batch,
224 				    void *keys, void *values, __u32 *count,
225 				    const struct bpf_map_batch_opts *opts);
226 
227 /**
228  * @brief **bpf_map_lookup_and_delete_batch()** allows for batch lookup and deletion
229  * of BPF map elements where each element is deleted after being retrieved.
230  *
231  * @param fd BPF map file descriptor
232  * @param in_batch address of the first element in batch to read, can pass NULL to
233  * get address of the first element in *out_batch*. If not NULL, must be large
234  * enough to hold a key. For **BPF_MAP_TYPE_{HASH, PERCPU_HASH, LRU_HASH,
235  * LRU_PERCPU_HASH}**, the memory size must be at least 4 bytes wide regardless
236  * of key size.
237  * @param out_batch output parameter that should be passed to next call as *in_batch*
238  * @param keys pointer to an array of *count* keys
239  * @param values pointer to an array large enough for *count* values
240  * @param count input and output parameter; on input it's the number of elements
241  * in the map to read and delete in batch; on output it represents the number of
242  * elements that were successfully read and deleted
243  * If a non-**EFAULT** error code is returned and if the output **count** value
244  * is not equal to the input **count** value, up to **count** elements may
245  * have been deleted.
246  * if **EFAULT** is returned up to *count* elements may have been deleted without
247  * being returned via the *keys* and *values* output parameters.
248  * @param opts options for configuring the way the batch lookup and delete works
249  * @return 0, on success; negative error code, otherwise (errno is also set to
250  * the error code)
251  */
252 LIBBPF_API int bpf_map_lookup_and_delete_batch(int fd, void *in_batch,
253 					void *out_batch, void *keys,
254 					void *values, __u32 *count,
255 					const struct bpf_map_batch_opts *opts);
256 
257 /**
258  * @brief **bpf_map_update_batch()** updates multiple elements in a map
259  * by specifying keys and their corresponding values.
260  *
261  * The *keys* and *values* parameters must point to memory large enough
262  * to hold *count* items based on the key and value size of the map.
263  *
264  * The *opts* parameter can be used to control how *bpf_map_update_batch()*
265  * should handle keys that either do or do not already exist in the map.
266  * In particular the *flags* parameter of *bpf_map_batch_opts* can be
267  * one of the following:
268  *
269  * Note that *count* is an input and output parameter, where on output it
270  * represents how many elements were successfully updated. Also note that if
271  * **EFAULT** then *count* should not be trusted to be correct.
272  *
273  * **BPF_ANY**
274  *    Create new elements or update existing.
275  *
276  * **BPF_NOEXIST**
277  *    Create new elements only if they do not exist.
278  *
279  * **BPF_EXIST**
280  *    Update existing elements.
281  *
282  * **BPF_F_LOCK**
283  *    Update spin_lock-ed map elements. This must be
284  *    specified if the map value contains a spinlock.
285  *
286  * @param fd BPF map file descriptor
287  * @param keys pointer to an array of *count* keys
288  * @param values pointer to an array of *count* values
289  * @param count input and output parameter; on input it's the number of elements
290  * in the map to update in batch; on output if a non-EFAULT error is returned,
291  * **count** represents the number of updated elements if the output **count**
292  * value is not equal to the input **count** value.
293  * If EFAULT is returned, **count** should not be trusted to be correct.
294  * @param opts options for configuring the way the batch update works
295  * @return 0, on success; negative error code, otherwise (errno is also set to
296  * the error code)
297  */
298 LIBBPF_API int bpf_map_update_batch(int fd, const void *keys, const void *values,
299 				    __u32 *count,
300 				    const struct bpf_map_batch_opts *opts);
301 
302 struct bpf_obj_pin_opts {
303 	size_t sz; /* size of this struct for forward/backward compatibility */
304 
305 	__u32 file_flags;
306 	int path_fd;
307 
308 	size_t :0;
309 };
310 #define bpf_obj_pin_opts__last_field path_fd
311 
312 LIBBPF_API int bpf_obj_pin(int fd, const char *pathname);
313 LIBBPF_API int bpf_obj_pin_opts(int fd, const char *pathname,
314 				const struct bpf_obj_pin_opts *opts);
315 
316 struct bpf_obj_get_opts {
317 	size_t sz; /* size of this struct for forward/backward compatibility */
318 
319 	__u32 file_flags;
320 	int path_fd;
321 
322 	size_t :0;
323 };
324 #define bpf_obj_get_opts__last_field path_fd
325 
326 LIBBPF_API int bpf_obj_get(const char *pathname);
327 LIBBPF_API int bpf_obj_get_opts(const char *pathname,
328 				const struct bpf_obj_get_opts *opts);
329 
330 LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,
331 			       enum bpf_attach_type type, unsigned int flags);
332 LIBBPF_API int bpf_prog_detach(int attachable_fd, enum bpf_attach_type type);
333 LIBBPF_API int bpf_prog_detach2(int prog_fd, int attachable_fd,
334 				enum bpf_attach_type type);
335 
336 struct bpf_prog_attach_opts {
337 	size_t sz; /* size of this struct for forward/backward compatibility */
338 	__u32 flags;
339 	union {
340 		int replace_prog_fd;
341 		int replace_fd;
342 	};
343 	int relative_fd;
344 	__u32 relative_id;
345 	__u64 expected_revision;
346 	size_t :0;
347 };
348 #define bpf_prog_attach_opts__last_field expected_revision
349 
350 struct bpf_prog_detach_opts {
351 	size_t sz; /* size of this struct for forward/backward compatibility */
352 	__u32 flags;
353 	int relative_fd;
354 	__u32 relative_id;
355 	__u64 expected_revision;
356 	size_t :0;
357 };
358 #define bpf_prog_detach_opts__last_field expected_revision
359 
360 /**
361  * @brief **bpf_prog_attach_opts()** attaches the BPF program corresponding to
362  * *prog_fd* to a *target* which can represent a file descriptor or netdevice
363  * ifindex.
364  *
365  * @param prog_fd BPF program file descriptor
366  * @param target attach location file descriptor or ifindex
367  * @param type attach type for the BPF program
368  * @param opts options for configuring the attachment
369  * @return 0, on success; negative error code, otherwise (errno is also set to
370  * the error code)
371  */
372 LIBBPF_API int bpf_prog_attach_opts(int prog_fd, int target,
373 				    enum bpf_attach_type type,
374 				    const struct bpf_prog_attach_opts *opts);
375 
376 /**
377  * @brief **bpf_prog_detach_opts()** detaches the BPF program corresponding to
378  * *prog_fd* from a *target* which can represent a file descriptor or netdevice
379  * ifindex.
380  *
381  * @param prog_fd BPF program file descriptor
382  * @param target detach location file descriptor or ifindex
383  * @param type detach type for the BPF program
384  * @param opts options for configuring the detachment
385  * @return 0, on success; negative error code, otherwise (errno is also set to
386  * the error code)
387  */
388 LIBBPF_API int bpf_prog_detach_opts(int prog_fd, int target,
389 				    enum bpf_attach_type type,
390 				    const struct bpf_prog_detach_opts *opts);
391 
392 union bpf_iter_link_info; /* defined in up-to-date linux/bpf.h */
393 struct bpf_link_create_opts {
394 	size_t sz; /* size of this struct for forward/backward compatibility */
395 	__u32 flags;
396 	union bpf_iter_link_info *iter_info;
397 	__u32 iter_info_len;
398 	__u32 target_btf_id;
399 	union {
400 		struct {
401 			__u64 bpf_cookie;
402 		} perf_event;
403 		struct {
404 			__u32 flags;
405 			__u32 cnt;
406 			const char **syms;
407 			const unsigned long *addrs;
408 			const __u64 *cookies;
409 		} kprobe_multi;
410 		struct {
411 			__u32 flags;
412 			__u32 cnt;
413 			const char *path;
414 			const unsigned long *offsets;
415 			const unsigned long *ref_ctr_offsets;
416 			const __u64 *cookies;
417 			__u32 pid;
418 		} uprobe_multi;
419 		struct {
420 			__u64 cookie;
421 		} tracing;
422 		struct {
423 			__u32 pf;
424 			__u32 hooknum;
425 			__s32 priority;
426 			__u32 flags;
427 		} netfilter;
428 		struct {
429 			__u32 relative_fd;
430 			__u32 relative_id;
431 			__u64 expected_revision;
432 		} tcx;
433 		struct {
434 			__u32 relative_fd;
435 			__u32 relative_id;
436 			__u64 expected_revision;
437 		} netkit;
438 	};
439 	size_t :0;
440 };
441 #define bpf_link_create_opts__last_field uprobe_multi.pid
442 
443 LIBBPF_API int bpf_link_create(int prog_fd, int target_fd,
444 			       enum bpf_attach_type attach_type,
445 			       const struct bpf_link_create_opts *opts);
446 
447 LIBBPF_API int bpf_link_detach(int link_fd);
448 
449 struct bpf_link_update_opts {
450 	size_t sz; /* size of this struct for forward/backward compatibility */
451 	__u32 flags;	   /* extra flags */
452 	__u32 old_prog_fd; /* expected old program FD */
453 	__u32 old_map_fd;  /* expected old map FD */
454 };
455 #define bpf_link_update_opts__last_field old_map_fd
456 
457 LIBBPF_API int bpf_link_update(int link_fd, int new_prog_fd,
458 			       const struct bpf_link_update_opts *opts);
459 
460 LIBBPF_API int bpf_iter_create(int link_fd);
461 
462 struct bpf_prog_test_run_attr {
463 	int prog_fd;
464 	int repeat;
465 	const void *data_in;
466 	__u32 data_size_in;
467 	void *data_out;      /* optional */
468 	__u32 data_size_out; /* in: max length of data_out
469 			      * out: length of data_out */
470 	__u32 retval;        /* out: return code of the BPF program */
471 	__u32 duration;      /* out: average per repetition in ns */
472 	const void *ctx_in; /* optional */
473 	__u32 ctx_size_in;
474 	void *ctx_out;      /* optional */
475 	__u32 ctx_size_out; /* in: max length of ctx_out
476 			     * out: length of cxt_out */
477 };
478 
479 LIBBPF_API int bpf_prog_get_next_id(__u32 start_id, __u32 *next_id);
480 LIBBPF_API int bpf_map_get_next_id(__u32 start_id, __u32 *next_id);
481 LIBBPF_API int bpf_btf_get_next_id(__u32 start_id, __u32 *next_id);
482 LIBBPF_API int bpf_link_get_next_id(__u32 start_id, __u32 *next_id);
483 
484 struct bpf_get_fd_by_id_opts {
485 	size_t sz; /* size of this struct for forward/backward compatibility */
486 	__u32 open_flags; /* permissions requested for the operation on fd */
487 	size_t :0;
488 };
489 #define bpf_get_fd_by_id_opts__last_field open_flags
490 
491 LIBBPF_API int bpf_prog_get_fd_by_id(__u32 id);
492 LIBBPF_API int bpf_prog_get_fd_by_id_opts(__u32 id,
493 				const struct bpf_get_fd_by_id_opts *opts);
494 LIBBPF_API int bpf_map_get_fd_by_id(__u32 id);
495 LIBBPF_API int bpf_map_get_fd_by_id_opts(__u32 id,
496 				const struct bpf_get_fd_by_id_opts *opts);
497 LIBBPF_API int bpf_btf_get_fd_by_id(__u32 id);
498 LIBBPF_API int bpf_btf_get_fd_by_id_opts(__u32 id,
499 				const struct bpf_get_fd_by_id_opts *opts);
500 LIBBPF_API int bpf_link_get_fd_by_id(__u32 id);
501 LIBBPF_API int bpf_link_get_fd_by_id_opts(__u32 id,
502 				const struct bpf_get_fd_by_id_opts *opts);
503 LIBBPF_API int bpf_obj_get_info_by_fd(int bpf_fd, void *info, __u32 *info_len);
504 
505 /**
506  * @brief **bpf_prog_get_info_by_fd()** obtains information about the BPF
507  * program corresponding to *prog_fd*.
508  *
509  * Populates up to *info_len* bytes of *info* and updates *info_len* with the
510  * actual number of bytes written to *info*. Note that *info* should be
511  * zero-initialized or initialized as expected by the requested *info*
512  * type. Failing to (zero-)initialize *info* under certain circumstances can
513  * result in this helper returning an error.
514  *
515  * @param prog_fd BPF program file descriptor
516  * @param info pointer to **struct bpf_prog_info** that will be populated with
517  * BPF program information
518  * @param info_len pointer to the size of *info*; on success updated with the
519  * number of bytes written to *info*
520  * @return 0, on success; negative error code, otherwise (errno is also set to
521  * the error code)
522  */
523 LIBBPF_API int bpf_prog_get_info_by_fd(int prog_fd, struct bpf_prog_info *info, __u32 *info_len);
524 
525 /**
526  * @brief **bpf_map_get_info_by_fd()** obtains information about the BPF
527  * map corresponding to *map_fd*.
528  *
529  * Populates up to *info_len* bytes of *info* and updates *info_len* with the
530  * actual number of bytes written to *info*. Note that *info* should be
531  * zero-initialized or initialized as expected by the requested *info*
532  * type. Failing to (zero-)initialize *info* under certain circumstances can
533  * result in this helper returning an error.
534  *
535  * @param map_fd BPF map file descriptor
536  * @param info pointer to **struct bpf_map_info** that will be populated with
537  * BPF map information
538  * @param info_len pointer to the size of *info*; on success updated with the
539  * number of bytes written to *info*
540  * @return 0, on success; negative error code, otherwise (errno is also set to
541  * the error code)
542  */
543 LIBBPF_API int bpf_map_get_info_by_fd(int map_fd, struct bpf_map_info *info, __u32 *info_len);
544 
545 /**
546  * @brief **bpf_btf_get_info_by_fd()** obtains information about the
547  * BTF object corresponding to *btf_fd*.
548  *
549  * Populates up to *info_len* bytes of *info* and updates *info_len* with the
550  * actual number of bytes written to *info*. Note that *info* should be
551  * zero-initialized or initialized as expected by the requested *info*
552  * type. Failing to (zero-)initialize *info* under certain circumstances can
553  * result in this helper returning an error.
554  *
555  * @param btf_fd BTF object file descriptor
556  * @param info pointer to **struct bpf_btf_info** that will be populated with
557  * BTF object information
558  * @param info_len pointer to the size of *info*; on success updated with the
559  * number of bytes written to *info*
560  * @return 0, on success; negative error code, otherwise (errno is also set to
561  * the error code)
562  */
563 LIBBPF_API int bpf_btf_get_info_by_fd(int btf_fd, struct bpf_btf_info *info, __u32 *info_len);
564 
565 /**
566  * @brief **bpf_btf_get_info_by_fd()** obtains information about the BPF
567  * link corresponding to *link_fd*.
568  *
569  * Populates up to *info_len* bytes of *info* and updates *info_len* with the
570  * actual number of bytes written to *info*. Note that *info* should be
571  * zero-initialized or initialized as expected by the requested *info*
572  * type. Failing to (zero-)initialize *info* under certain circumstances can
573  * result in this helper returning an error.
574  *
575  * @param link_fd BPF link file descriptor
576  * @param info pointer to **struct bpf_link_info** that will be populated with
577  * BPF link information
578  * @param info_len pointer to the size of *info*; on success updated with the
579  * number of bytes written to *info*
580  * @return 0, on success; negative error code, otherwise (errno is also set to
581  * the error code)
582  */
583 LIBBPF_API int bpf_link_get_info_by_fd(int link_fd, struct bpf_link_info *info, __u32 *info_len);
584 
585 struct bpf_prog_query_opts {
586 	size_t sz; /* size of this struct for forward/backward compatibility */
587 	__u32 query_flags;
588 	__u32 attach_flags; /* output argument */
589 	__u32 *prog_ids;
590 	union {
591 		/* input+output argument */
592 		__u32 prog_cnt;
593 		__u32 count;
594 	};
595 	__u32 *prog_attach_flags;
596 	__u32 *link_ids;
597 	__u32 *link_attach_flags;
598 	__u64 revision;
599 	size_t :0;
600 };
601 #define bpf_prog_query_opts__last_field revision
602 
603 /**
604  * @brief **bpf_prog_query_opts()** queries the BPF programs and BPF links
605  * which are attached to *target* which can represent a file descriptor or
606  * netdevice ifindex.
607  *
608  * @param target query location file descriptor or ifindex
609  * @param type attach type for the BPF program
610  * @param opts options for configuring the query
611  * @return 0, on success; negative error code, otherwise (errno is also set to
612  * the error code)
613  */
614 LIBBPF_API int bpf_prog_query_opts(int target, enum bpf_attach_type type,
615 				   struct bpf_prog_query_opts *opts);
616 LIBBPF_API int bpf_prog_query(int target_fd, enum bpf_attach_type type,
617 			      __u32 query_flags, __u32 *attach_flags,
618 			      __u32 *prog_ids, __u32 *prog_cnt);
619 
620 LIBBPF_API int bpf_raw_tracepoint_open(const char *name, int prog_fd);
621 LIBBPF_API int bpf_task_fd_query(int pid, int fd, __u32 flags, char *buf,
622 				 __u32 *buf_len, __u32 *prog_id, __u32 *fd_type,
623 				 __u64 *probe_offset, __u64 *probe_addr);
624 
625 #ifdef __cplusplus
626 /* forward-declaring enums in C++ isn't compatible with pure C enums, so
627  * instead define bpf_enable_stats() as accepting int as an input
628  */
629 LIBBPF_API int bpf_enable_stats(int type);
630 #else
631 enum bpf_stats_type; /* defined in up-to-date linux/bpf.h */
632 LIBBPF_API int bpf_enable_stats(enum bpf_stats_type type);
633 #endif
634 
635 struct bpf_prog_bind_opts {
636 	size_t sz; /* size of this struct for forward/backward compatibility */
637 	__u32 flags;
638 };
639 #define bpf_prog_bind_opts__last_field flags
640 
641 LIBBPF_API int bpf_prog_bind_map(int prog_fd, int map_fd,
642 				 const struct bpf_prog_bind_opts *opts);
643 
644 struct bpf_test_run_opts {
645 	size_t sz; /* size of this struct for forward/backward compatibility */
646 	const void *data_in; /* optional */
647 	void *data_out;      /* optional */
648 	__u32 data_size_in;
649 	__u32 data_size_out; /* in: max length of data_out
650 			      * out: length of data_out
651 			      */
652 	const void *ctx_in; /* optional */
653 	void *ctx_out;      /* optional */
654 	__u32 ctx_size_in;
655 	__u32 ctx_size_out; /* in: max length of ctx_out
656 			     * out: length of cxt_out
657 			     */
658 	__u32 retval;        /* out: return code of the BPF program */
659 	int repeat;
660 	__u32 duration;      /* out: average per repetition in ns */
661 	__u32 flags;
662 	__u32 cpu;
663 	__u32 batch_size;
664 };
665 #define bpf_test_run_opts__last_field batch_size
666 
667 LIBBPF_API int bpf_prog_test_run_opts(int prog_fd,
668 				      struct bpf_test_run_opts *opts);
669 
670 struct bpf_token_create_opts {
671 	size_t sz; /* size of this struct for forward/backward compatibility */
672 	__u32 flags;
673 	size_t :0;
674 };
675 #define bpf_token_create_opts__last_field flags
676 
677 /**
678  * @brief **bpf_token_create()** creates a new instance of BPF token derived
679  * from specified BPF FS mount point.
680  *
681  * BPF token created with this API can be passed to bpf() syscall for
682  * commands like BPF_PROG_LOAD, BPF_MAP_CREATE, etc.
683  *
684  * @param bpffs_fd FD for BPF FS instance from which to derive a BPF token
685  * instance.
686  * @param opts optional BPF token creation options, can be NULL
687  *
688  * @return BPF token FD > 0, on success; negative error code, otherwise (errno
689  * is also set to the error code)
690  */
691 LIBBPF_API int bpf_token_create(int bpffs_fd,
692 				struct bpf_token_create_opts *opts);
693 
694 #ifdef __cplusplus
695 } /* extern "C" */
696 #endif
697 
698 #endif /* __LIBBPF_BPF_H */
699