David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 1 | /* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */ |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 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 | */ |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 23 | #ifndef __LIBBPF_BPF_H |
| 24 | #define __LIBBPF_BPF_H |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 25 | |
| 26 | #include <linux/bpf.h> |
| 27 | #include <stdbool.h> |
| 28 | #include <stddef.h> |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 29 | #include <stdint.h> |
| 30 | |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 31 | #include "libbpf_common.h" |
| 32 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 33 | #ifdef __cplusplus |
| 34 | extern "C" { |
| 35 | #endif |
| 36 | |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 37 | struct 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; |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 49 | union { |
| 50 | __u32 inner_map_fd; |
| 51 | __u32 btf_vmlinux_value_type_id; |
| 52 | }; |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 53 | }; |
| 54 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 55 | LIBBPF_API int |
| 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, |
| 72 | __u32 map_flags); |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 73 | |
| 74 | struct 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; |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 81 | union { |
| 82 | __u32 kern_version; |
| 83 | __u32 attach_prog_fd; |
| 84 | }; |
| 85 | union { |
| 86 | __u32 prog_ifindex; |
| 87 | __u32 attach_btf_id; |
| 88 | }; |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 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; |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 98 | }; |
| 99 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 100 | /* Flags to direct loading requirements */ |
| 101 | #define MAPS_RELAX_COMPAT 0x01 |
| 102 | |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 103 | /* Recommend log buffer size */ |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 104 | #define BPF_LOG_BUF_SIZE (UINT32_MAX >> 8) /* verifier maximum in kernels <= 5.1 */ |
| 105 | LIBBPF_API int |
| 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, |
| 117 | int log_level); |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 118 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 119 | LIBBPF_API int bpf_map_update_elem(int fd, const void *key, const void *value, |
| 120 | __u64 flags); |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 121 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 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, |
| 124 | __u64 flags); |
| 125 | LIBBPF_API int bpf_map_lookup_and_delete_elem(int fd, const void *key, |
| 126 | void *value); |
| 127 | LIBBPF_API int bpf_map_delete_elem(int fd, const void *key); |
| 128 | LIBBPF_API int bpf_map_get_next_key(int fd, const void *key, void *next_key); |
| 129 | LIBBPF_API int bpf_map_freeze(int fd); |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 130 | |
| 131 | struct bpf_map_batch_opts { |
| 132 | size_t sz; /* size of this struct for forward/backward compatibility */ |
| 133 | __u64 elem_flags; |
| 134 | __u64 flags; |
| 135 | }; |
| 136 | #define bpf_map_batch_opts__last_field flags |
| 137 | |
| 138 | LIBBPF_API int bpf_map_delete_batch(int fd, void *keys, |
| 139 | __u32 *count, |
| 140 | const struct bpf_map_batch_opts *opts); |
| 141 | LIBBPF_API int bpf_map_lookup_batch(int fd, void *in_batch, void *out_batch, |
| 142 | void *keys, void *values, __u32 *count, |
| 143 | const struct bpf_map_batch_opts *opts); |
| 144 | LIBBPF_API int bpf_map_lookup_and_delete_batch(int fd, void *in_batch, |
| 145 | void *out_batch, void *keys, |
| 146 | void *values, __u32 *count, |
| 147 | const struct bpf_map_batch_opts *opts); |
| 148 | LIBBPF_API int bpf_map_update_batch(int fd, void *keys, void *values, |
| 149 | __u32 *count, |
| 150 | const struct bpf_map_batch_opts *opts); |
| 151 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 152 | LIBBPF_API int bpf_obj_pin(int fd, const char *pathname); |
| 153 | LIBBPF_API int bpf_obj_get(const char *pathname); |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 154 | |
| 155 | struct bpf_prog_attach_opts { |
| 156 | size_t sz; /* size of this struct for forward/backward compatibility */ |
| 157 | unsigned int flags; |
| 158 | int replace_prog_fd; |
| 159 | }; |
| 160 | #define bpf_prog_attach_opts__last_field replace_prog_fd |
| 161 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 162 | LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd, |
| 163 | enum bpf_attach_type type, unsigned int flags); |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 164 | LIBBPF_API int bpf_prog_attach_xattr(int prog_fd, int attachable_fd, |
| 165 | enum bpf_attach_type type, |
| 166 | const struct bpf_prog_attach_opts *opts); |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 167 | LIBBPF_API int bpf_prog_detach(int attachable_fd, enum bpf_attach_type type); |
| 168 | LIBBPF_API int bpf_prog_detach2(int prog_fd, int attachable_fd, |
| 169 | enum bpf_attach_type type); |
| 170 | |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 171 | union bpf_iter_link_info; /* defined in up-to-date linux/bpf.h */ |
| 172 | struct bpf_link_create_opts { |
| 173 | size_t sz; /* size of this struct for forward/backward compatibility */ |
| 174 | __u32 flags; |
| 175 | union bpf_iter_link_info *iter_info; |
| 176 | __u32 iter_info_len; |
| 177 | __u32 target_btf_id; |
| 178 | }; |
| 179 | #define bpf_link_create_opts__last_field target_btf_id |
| 180 | |
| 181 | LIBBPF_API int bpf_link_create(int prog_fd, int target_fd, |
| 182 | enum bpf_attach_type attach_type, |
| 183 | const struct bpf_link_create_opts *opts); |
| 184 | |
| 185 | LIBBPF_API int bpf_link_detach(int link_fd); |
| 186 | |
| 187 | struct bpf_link_update_opts { |
| 188 | size_t sz; /* size of this struct for forward/backward compatibility */ |
| 189 | __u32 flags; /* extra flags */ |
| 190 | __u32 old_prog_fd; /* expected old program FD */ |
| 191 | }; |
| 192 | #define bpf_link_update_opts__last_field old_prog_fd |
| 193 | |
| 194 | LIBBPF_API int bpf_link_update(int link_fd, int new_prog_fd, |
| 195 | const struct bpf_link_update_opts *opts); |
| 196 | |
| 197 | LIBBPF_API int bpf_iter_create(int link_fd); |
| 198 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 199 | struct bpf_prog_test_run_attr { |
| 200 | int prog_fd; |
| 201 | int repeat; |
| 202 | const void *data_in; |
| 203 | __u32 data_size_in; |
| 204 | void *data_out; /* optional */ |
| 205 | __u32 data_size_out; /* in: max length of data_out |
| 206 | * out: length of data_out */ |
| 207 | __u32 retval; /* out: return code of the BPF program */ |
| 208 | __u32 duration; /* out: average per repetition in ns */ |
| 209 | const void *ctx_in; /* optional */ |
| 210 | __u32 ctx_size_in; |
| 211 | void *ctx_out; /* optional */ |
| 212 | __u32 ctx_size_out; /* in: max length of ctx_out |
| 213 | * out: length of cxt_out */ |
| 214 | }; |
| 215 | |
| 216 | LIBBPF_API int bpf_prog_test_run_xattr(struct bpf_prog_test_run_attr *test_attr); |
| 217 | |
| 218 | /* |
| 219 | * bpf_prog_test_run does not check that data_out is large enough. Consider |
| 220 | * using bpf_prog_test_run_xattr instead. |
| 221 | */ |
| 222 | LIBBPF_API int bpf_prog_test_run(int prog_fd, int repeat, void *data, |
| 223 | __u32 size, void *data_out, __u32 *size_out, |
| 224 | __u32 *retval, __u32 *duration); |
| 225 | LIBBPF_API int bpf_prog_get_next_id(__u32 start_id, __u32 *next_id); |
| 226 | LIBBPF_API int bpf_map_get_next_id(__u32 start_id, __u32 *next_id); |
| 227 | LIBBPF_API int bpf_btf_get_next_id(__u32 start_id, __u32 *next_id); |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 228 | LIBBPF_API int bpf_link_get_next_id(__u32 start_id, __u32 *next_id); |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 229 | LIBBPF_API int bpf_prog_get_fd_by_id(__u32 id); |
| 230 | LIBBPF_API int bpf_map_get_fd_by_id(__u32 id); |
| 231 | LIBBPF_API int bpf_btf_get_fd_by_id(__u32 id); |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 232 | LIBBPF_API int bpf_link_get_fd_by_id(__u32 id); |
| 233 | LIBBPF_API int bpf_obj_get_info_by_fd(int bpf_fd, void *info, __u32 *info_len); |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 234 | LIBBPF_API int bpf_prog_query(int target_fd, enum bpf_attach_type type, |
| 235 | __u32 query_flags, __u32 *attach_flags, |
| 236 | __u32 *prog_ids, __u32 *prog_cnt); |
| 237 | LIBBPF_API int bpf_raw_tracepoint_open(const char *name, int prog_fd); |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 238 | LIBBPF_API int bpf_load_btf(const void *btf, __u32 btf_size, char *log_buf, |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 239 | __u32 log_buf_size, bool do_log); |
| 240 | LIBBPF_API int bpf_task_fd_query(int pid, int fd, __u32 flags, char *buf, |
| 241 | __u32 *buf_len, __u32 *prog_id, __u32 *fd_type, |
| 242 | __u64 *probe_offset, __u64 *probe_addr); |
| 243 | |
Olivier Deprez | 157378f | 2022-04-04 15:47:50 +0200 | [diff] [blame^] | 244 | enum bpf_stats_type; /* defined in up-to-date linux/bpf.h */ |
| 245 | LIBBPF_API int bpf_enable_stats(enum bpf_stats_type type); |
| 246 | |
| 247 | struct bpf_prog_bind_opts { |
| 248 | size_t sz; /* size of this struct for forward/backward compatibility */ |
| 249 | __u32 flags; |
| 250 | }; |
| 251 | #define bpf_prog_bind_opts__last_field flags |
| 252 | |
| 253 | LIBBPF_API int bpf_prog_bind_map(int prog_fd, int map_fd, |
| 254 | const struct bpf_prog_bind_opts *opts); |
| 255 | |
| 256 | struct bpf_test_run_opts { |
| 257 | size_t sz; /* size of this struct for forward/backward compatibility */ |
| 258 | const void *data_in; /* optional */ |
| 259 | void *data_out; /* optional */ |
| 260 | __u32 data_size_in; |
| 261 | __u32 data_size_out; /* in: max length of data_out |
| 262 | * out: length of data_out |
| 263 | */ |
| 264 | const void *ctx_in; /* optional */ |
| 265 | void *ctx_out; /* optional */ |
| 266 | __u32 ctx_size_in; |
| 267 | __u32 ctx_size_out; /* in: max length of ctx_out |
| 268 | * out: length of cxt_out |
| 269 | */ |
| 270 | __u32 retval; /* out: return code of the BPF program */ |
| 271 | int repeat; |
| 272 | __u32 duration; /* out: average per repetition in ns */ |
| 273 | __u32 flags; |
| 274 | __u32 cpu; |
| 275 | }; |
| 276 | #define bpf_test_run_opts__last_field cpu |
| 277 | |
| 278 | LIBBPF_API int bpf_prog_test_run_opts(int prog_fd, |
| 279 | struct bpf_test_run_opts *opts); |
| 280 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 281 | #ifdef __cplusplus |
| 282 | } /* extern "C" */ |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 283 | #endif |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame] | 284 | |
| 285 | #endif /* __LIBBPF_BPF_H */ |