Loading...
Note: File does not exist in v3.15.
1/* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
2
3/*
4 * common eBPF 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
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37struct bpf_create_map_attr {
38 const char *name;
39 enum bpf_map_type map_type;
40 __u32 map_flags;
41 __u32 key_size;
42 __u32 value_size;
43 __u32 max_entries;
44 __u32 numa_node;
45 __u32 btf_fd;
46 __u32 btf_key_type_id;
47 __u32 btf_value_type_id;
48 __u32 map_ifindex;
49 union {
50 __u32 inner_map_fd;
51 __u32 btf_vmlinux_value_type_id;
52 };
53};
54
55LIBBPF_API int
56bpf_create_map_xattr(const struct bpf_create_map_attr *create_attr);
57LIBBPF_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);
60LIBBPF_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);
63LIBBPF_API int bpf_create_map(enum bpf_map_type map_type, int key_size,
64 int value_size, int max_entries, __u32 map_flags);
65LIBBPF_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);
69LIBBPF_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,
72 __u32 map_flags);
73
74struct bpf_load_program_attr {
75 enum bpf_prog_type prog_type;
76 enum bpf_attach_type expected_attach_type;
77 const char *name;
78 const struct bpf_insn *insns;
79 size_t insns_cnt;
80 const char *license;
81 union {
82 __u32 kern_version;
83 __u32 attach_prog_fd;
84 };
85 union {
86 __u32 prog_ifindex;
87 __u32 attach_btf_id;
88 };
89 __u32 prog_btf_fd;
90 __u32 func_info_rec_size;
91 const void *func_info;
92 __u32 func_info_cnt;
93 __u32 line_info_rec_size;
94 const void *line_info;
95 __u32 line_info_cnt;
96 __u32 log_level;
97 __u32 prog_flags;
98};
99
100/* Flags to direct loading requirements */
101#define MAPS_RELAX_COMPAT 0x01
102
103/* Recommend log buffer size */
104#define BPF_LOG_BUF_SIZE (UINT32_MAX >> 8) /* verifier maximum in kernels <= 5.1 */
105LIBBPF_API int
106bpf_load_program_xattr(const struct bpf_load_program_attr *load_attr,
107 char *log_buf, size_t log_buf_sz);
108LIBBPF_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);
112LIBBPF_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,
117 int log_level);
118
119LIBBPF_API int bpf_map_update_elem(int fd, const void *key, const void *value,
120 __u64 flags);
121
122LIBBPF_API int bpf_map_lookup_elem(int fd, const void *key, void *value);
123LIBBPF_API int bpf_map_lookup_elem_flags(int fd, const void *key, void *value,
124 __u64 flags);
125LIBBPF_API int bpf_map_lookup_and_delete_elem(int fd, const void *key,
126 void *value);
127LIBBPF_API int bpf_map_lookup_and_delete_elem_flags(int fd, const void *key,
128 void *value, __u64 flags);
129LIBBPF_API int bpf_map_delete_elem(int fd, const void *key);
130LIBBPF_API int bpf_map_get_next_key(int fd, const void *key, void *next_key);
131LIBBPF_API int bpf_map_freeze(int fd);
132
133struct bpf_map_batch_opts {
134 size_t sz; /* size of this struct for forward/backward compatibility */
135 __u64 elem_flags;
136 __u64 flags;
137};
138#define bpf_map_batch_opts__last_field flags
139
140LIBBPF_API int bpf_map_delete_batch(int fd, void *keys,
141 __u32 *count,
142 const struct bpf_map_batch_opts *opts);
143LIBBPF_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);
146LIBBPF_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);
150LIBBPF_API int bpf_map_update_batch(int fd, void *keys, void *values,
151 __u32 *count,
152 const struct bpf_map_batch_opts *opts);
153
154LIBBPF_API int bpf_obj_pin(int fd, const char *pathname);
155LIBBPF_API int bpf_obj_get(const char *pathname);
156
157struct bpf_prog_attach_opts {
158 size_t sz; /* size of this struct for forward/backward compatibility */
159 unsigned int flags;
160 int replace_prog_fd;
161};
162#define bpf_prog_attach_opts__last_field replace_prog_fd
163
164LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,
165 enum bpf_attach_type type, unsigned int flags);
166LIBBPF_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);
169LIBBPF_API int bpf_prog_detach(int attachable_fd, enum bpf_attach_type type);
170LIBBPF_API int bpf_prog_detach2(int prog_fd, int attachable_fd,
171 enum bpf_attach_type type);
172
173union bpf_iter_link_info; /* defined in up-to-date linux/bpf.h */
174struct bpf_link_create_opts {
175 size_t sz; /* size of this struct for forward/backward compatibility */
176 __u32 flags;
177 union bpf_iter_link_info *iter_info;
178 __u32 iter_info_len;
179 __u32 target_btf_id;
180};
181#define bpf_link_create_opts__last_field target_btf_id
182
183LIBBPF_API int bpf_link_create(int prog_fd, int target_fd,
184 enum bpf_attach_type attach_type,
185 const struct bpf_link_create_opts *opts);
186
187LIBBPF_API int bpf_link_detach(int link_fd);
188
189struct bpf_link_update_opts {
190 size_t sz; /* size of this struct for forward/backward compatibility */
191 __u32 flags; /* extra flags */
192 __u32 old_prog_fd; /* expected old program FD */
193};
194#define bpf_link_update_opts__last_field old_prog_fd
195
196LIBBPF_API int bpf_link_update(int link_fd, int new_prog_fd,
197 const struct bpf_link_update_opts *opts);
198
199LIBBPF_API int bpf_iter_create(int link_fd);
200
201struct bpf_prog_test_run_attr {
202 int prog_fd;
203 int repeat;
204 const void *data_in;
205 __u32 data_size_in;
206 void *data_out; /* optional */
207 __u32 data_size_out; /* in: max length of data_out
208 * out: length of data_out */
209 __u32 retval; /* out: return code of the BPF program */
210 __u32 duration; /* out: average per repetition in ns */
211 const void *ctx_in; /* optional */
212 __u32 ctx_size_in;
213 void *ctx_out; /* optional */
214 __u32 ctx_size_out; /* in: max length of ctx_out
215 * out: length of cxt_out */
216};
217
218LIBBPF_API int bpf_prog_test_run_xattr(struct bpf_prog_test_run_attr *test_attr);
219
220/*
221 * bpf_prog_test_run does not check that data_out is large enough. Consider
222 * using bpf_prog_test_run_xattr instead.
223 */
224LIBBPF_API int bpf_prog_test_run(int prog_fd, int repeat, void *data,
225 __u32 size, void *data_out, __u32 *size_out,
226 __u32 *retval, __u32 *duration);
227LIBBPF_API int bpf_prog_get_next_id(__u32 start_id, __u32 *next_id);
228LIBBPF_API int bpf_map_get_next_id(__u32 start_id, __u32 *next_id);
229LIBBPF_API int bpf_btf_get_next_id(__u32 start_id, __u32 *next_id);
230LIBBPF_API int bpf_link_get_next_id(__u32 start_id, __u32 *next_id);
231LIBBPF_API int bpf_prog_get_fd_by_id(__u32 id);
232LIBBPF_API int bpf_map_get_fd_by_id(__u32 id);
233LIBBPF_API int bpf_btf_get_fd_by_id(__u32 id);
234LIBBPF_API int bpf_link_get_fd_by_id(__u32 id);
235LIBBPF_API int bpf_obj_get_info_by_fd(int bpf_fd, void *info, __u32 *info_len);
236LIBBPF_API int bpf_prog_query(int target_fd, enum bpf_attach_type type,
237 __u32 query_flags, __u32 *attach_flags,
238 __u32 *prog_ids, __u32 *prog_cnt);
239LIBBPF_API int bpf_raw_tracepoint_open(const char *name, int prog_fd);
240LIBBPF_API int bpf_load_btf(const void *btf, __u32 btf_size, char *log_buf,
241 __u32 log_buf_size, bool do_log);
242LIBBPF_API int bpf_task_fd_query(int pid, int fd, __u32 flags, char *buf,
243 __u32 *buf_len, __u32 *prog_id, __u32 *fd_type,
244 __u64 *probe_offset, __u64 *probe_addr);
245
246enum bpf_stats_type; /* defined in up-to-date linux/bpf.h */
247LIBBPF_API int bpf_enable_stats(enum bpf_stats_type type);
248
249struct bpf_prog_bind_opts {
250 size_t sz; /* size of this struct for forward/backward compatibility */
251 __u32 flags;
252};
253#define bpf_prog_bind_opts__last_field flags
254
255LIBBPF_API int bpf_prog_bind_map(int prog_fd, int map_fd,
256 const struct bpf_prog_bind_opts *opts);
257
258struct bpf_test_run_opts {
259 size_t sz; /* size of this struct for forward/backward compatibility */
260 const void *data_in; /* optional */
261 void *data_out; /* optional */
262 __u32 data_size_in;
263 __u32 data_size_out; /* in: max length of data_out
264 * out: length of data_out
265 */
266 const void *ctx_in; /* optional */
267 void *ctx_out; /* optional */
268 __u32 ctx_size_in;
269 __u32 ctx_size_out; /* in: max length of ctx_out
270 * out: length of cxt_out
271 */
272 __u32 retval; /* out: return code of the BPF program */
273 int repeat;
274 __u32 duration; /* out: average per repetition in ns */
275 __u32 flags;
276 __u32 cpu;
277};
278#define bpf_test_run_opts__last_field cpu
279
280LIBBPF_API int bpf_prog_test_run_opts(int prog_fd,
281 struct bpf_test_run_opts *opts);
282
283#ifdef __cplusplus
284} /* extern "C" */
285#endif
286
287#endif /* __LIBBPF_BPF_H */