1 /* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
4 * common eBPF ELF operations.
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.
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!)
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.
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>
23 #ifndef __LIBBPF_BPF_H
24 #define __LIBBPF_BPF_H
26 #include <linux/bpf.h>
31 #include "libbpf_common.h"
37 struct bpf_create_map_attr {
39 enum bpf_map_type map_type;
46 __u32 btf_key_type_id;
47 __u32 btf_value_type_id;
51 __u32 btf_vmlinux_value_type_id;
56 bpf_create_map_xattr(const struct bpf_create_map_attr *create_attr);
57 LIBBPF_API int bpf_create_map_node(enum bpf_map_type map_type, const char *name,
58 int key_size, int value_size,
59 int max_entries, __u32 map_flags, int node);
60 LIBBPF_API int bpf_create_map_name(enum bpf_map_type map_type, const char *name,
61 int key_size, int value_size,
62 int max_entries, __u32 map_flags);
63 LIBBPF_API int bpf_create_map(enum bpf_map_type map_type, int key_size,
64 int value_size, int max_entries, __u32 map_flags);
65 LIBBPF_API int bpf_create_map_in_map_node(enum bpf_map_type map_type,
66 const char *name, int key_size,
67 int inner_map_fd, int max_entries,
68 __u32 map_flags, int node);
69 LIBBPF_API int bpf_create_map_in_map(enum bpf_map_type map_type,
70 const char *name, int key_size,
71 int inner_map_fd, int max_entries,
74 struct bpf_load_program_attr {
75 enum bpf_prog_type prog_type;
76 enum bpf_attach_type expected_attach_type;
78 const struct bpf_insn *insns;
90 __u32 func_info_rec_size;
91 const void *func_info;
93 __u32 line_info_rec_size;
94 const void *line_info;
100 /* Flags to direct loading requirements */
101 #define MAPS_RELAX_COMPAT 0x01
103 /* Recommend log buffer size */
104 #define BPF_LOG_BUF_SIZE (UINT32_MAX >> 8) /* verifier maximum in kernels <= 5.1 */
106 bpf_load_program_xattr(const struct bpf_load_program_attr *load_attr,
107 char *log_buf, size_t log_buf_sz);
108 LIBBPF_API int bpf_load_program(enum bpf_prog_type type,
109 const struct bpf_insn *insns, size_t insns_cnt,
110 const char *license, __u32 kern_version,
111 char *log_buf, size_t log_buf_sz);
112 LIBBPF_API int bpf_verify_program(enum bpf_prog_type type,
113 const struct bpf_insn *insns,
114 size_t insns_cnt, __u32 prog_flags,
115 const char *license, __u32 kern_version,
116 char *log_buf, size_t log_buf_sz,
119 LIBBPF_API int bpf_map_update_elem(int fd, const void *key, const void *value,
122 LIBBPF_API int bpf_map_lookup_elem(int fd, const void *key, void *value);
123 LIBBPF_API int bpf_map_lookup_elem_flags(int fd, const void *key, void *value,
125 LIBBPF_API int bpf_map_lookup_and_delete_elem(int fd, const void *key,
127 LIBBPF_API int bpf_map_lookup_and_delete_elem_flags(int fd, const void *key,
128 void *value, __u64 flags);
129 LIBBPF_API int bpf_map_delete_elem(int fd, const void *key);
130 LIBBPF_API int bpf_map_get_next_key(int fd, const void *key, void *next_key);
131 LIBBPF_API int bpf_map_freeze(int fd);
133 struct bpf_map_batch_opts {
134 size_t sz; /* size of this struct for forward/backward compatibility */
138 #define bpf_map_batch_opts__last_field flags
140 LIBBPF_API int bpf_map_delete_batch(int fd, void *keys,
142 const struct bpf_map_batch_opts *opts);
143 LIBBPF_API int bpf_map_lookup_batch(int fd, void *in_batch, void *out_batch,
144 void *keys, void *values, __u32 *count,
145 const struct bpf_map_batch_opts *opts);
146 LIBBPF_API int bpf_map_lookup_and_delete_batch(int fd, void *in_batch,
147 void *out_batch, void *keys,
148 void *values, __u32 *count,
149 const struct bpf_map_batch_opts *opts);
150 LIBBPF_API int bpf_map_update_batch(int fd, void *keys, void *values,
152 const struct bpf_map_batch_opts *opts);
154 LIBBPF_API int bpf_obj_pin(int fd, const char *pathname);
155 LIBBPF_API int bpf_obj_get(const char *pathname);
157 struct bpf_prog_attach_opts {
158 size_t sz; /* size of this struct for forward/backward compatibility */
162 #define bpf_prog_attach_opts__last_field replace_prog_fd
164 LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,
165 enum bpf_attach_type type, unsigned int flags);
166 LIBBPF_API int bpf_prog_attach_xattr(int prog_fd, int attachable_fd,
167 enum bpf_attach_type type,
168 const struct bpf_prog_attach_opts *opts);
169 LIBBPF_API int bpf_prog_detach(int attachable_fd, enum bpf_attach_type type);
170 LIBBPF_API int bpf_prog_detach2(int prog_fd, int attachable_fd,
171 enum bpf_attach_type type);
173 union bpf_iter_link_info; /* defined in up-to-date linux/bpf.h */
174 struct bpf_link_create_opts {
175 size_t sz; /* size of this struct for forward/backward compatibility */
177 union bpf_iter_link_info *iter_info;
187 #define bpf_link_create_opts__last_field perf_event
189 LIBBPF_API int bpf_link_create(int prog_fd, int target_fd,
190 enum bpf_attach_type attach_type,
191 const struct bpf_link_create_opts *opts);
193 LIBBPF_API int bpf_link_detach(int link_fd);
195 struct bpf_link_update_opts {
196 size_t sz; /* size of this struct for forward/backward compatibility */
197 __u32 flags; /* extra flags */
198 __u32 old_prog_fd; /* expected old program FD */
200 #define bpf_link_update_opts__last_field old_prog_fd
202 LIBBPF_API int bpf_link_update(int link_fd, int new_prog_fd,
203 const struct bpf_link_update_opts *opts);
205 LIBBPF_API int bpf_iter_create(int link_fd);
207 struct bpf_prog_test_run_attr {
212 void *data_out; /* optional */
213 __u32 data_size_out; /* in: max length of data_out
214 * out: length of data_out */
215 __u32 retval; /* out: return code of the BPF program */
216 __u32 duration; /* out: average per repetition in ns */
217 const void *ctx_in; /* optional */
219 void *ctx_out; /* optional */
220 __u32 ctx_size_out; /* in: max length of ctx_out
221 * out: length of cxt_out */
224 LIBBPF_API int bpf_prog_test_run_xattr(struct bpf_prog_test_run_attr *test_attr);
227 * bpf_prog_test_run does not check that data_out is large enough. Consider
228 * using bpf_prog_test_run_xattr instead.
230 LIBBPF_API int bpf_prog_test_run(int prog_fd, int repeat, void *data,
231 __u32 size, void *data_out, __u32 *size_out,
232 __u32 *retval, __u32 *duration);
233 LIBBPF_API int bpf_prog_get_next_id(__u32 start_id, __u32 *next_id);
234 LIBBPF_API int bpf_map_get_next_id(__u32 start_id, __u32 *next_id);
235 LIBBPF_API int bpf_btf_get_next_id(__u32 start_id, __u32 *next_id);
236 LIBBPF_API int bpf_link_get_next_id(__u32 start_id, __u32 *next_id);
237 LIBBPF_API int bpf_prog_get_fd_by_id(__u32 id);
238 LIBBPF_API int bpf_map_get_fd_by_id(__u32 id);
239 LIBBPF_API int bpf_btf_get_fd_by_id(__u32 id);
240 LIBBPF_API int bpf_link_get_fd_by_id(__u32 id);
241 LIBBPF_API int bpf_obj_get_info_by_fd(int bpf_fd, void *info, __u32 *info_len);
242 LIBBPF_API int bpf_prog_query(int target_fd, enum bpf_attach_type type,
243 __u32 query_flags, __u32 *attach_flags,
244 __u32 *prog_ids, __u32 *prog_cnt);
245 LIBBPF_API int bpf_raw_tracepoint_open(const char *name, int prog_fd);
246 LIBBPF_API int bpf_load_btf(const void *btf, __u32 btf_size, char *log_buf,
247 __u32 log_buf_size, bool do_log);
248 LIBBPF_API int bpf_task_fd_query(int pid, int fd, __u32 flags, char *buf,
249 __u32 *buf_len, __u32 *prog_id, __u32 *fd_type,
250 __u64 *probe_offset, __u64 *probe_addr);
253 /* forward-declaring enums in C++ isn't compatible with pure C enums, so
254 * instead define bpf_enable_stats() as accepting int as an input
256 LIBBPF_API int bpf_enable_stats(int type);
258 enum bpf_stats_type; /* defined in up-to-date linux/bpf.h */
259 LIBBPF_API int bpf_enable_stats(enum bpf_stats_type type);
262 struct bpf_prog_bind_opts {
263 size_t sz; /* size of this struct for forward/backward compatibility */
266 #define bpf_prog_bind_opts__last_field flags
268 LIBBPF_API int bpf_prog_bind_map(int prog_fd, int map_fd,
269 const struct bpf_prog_bind_opts *opts);
271 struct bpf_test_run_opts {
272 size_t sz; /* size of this struct for forward/backward compatibility */
273 const void *data_in; /* optional */
274 void *data_out; /* optional */
276 __u32 data_size_out; /* in: max length of data_out
277 * out: length of data_out
279 const void *ctx_in; /* optional */
280 void *ctx_out; /* optional */
282 __u32 ctx_size_out; /* in: max length of ctx_out
283 * out: length of cxt_out
285 __u32 retval; /* out: return code of the BPF program */
287 __u32 duration; /* out: average per repetition in ns */
291 #define bpf_test_run_opts__last_field cpu
293 LIBBPF_API int bpf_prog_test_run_opts(int prog_fd,
294 struct bpf_test_run_opts *opts);
300 #endif /* __LIBBPF_BPF_H */