11bc38b8fSAlexei Starovoitov /* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */ 26061a3d6SEric Leblond 3e3ed2fefSWang Nan /* 4e3ed2fefSWang Nan * common eBPF ELF operations. 5e3ed2fefSWang Nan * 6e3ed2fefSWang Nan * Copyright (C) 2013-2015 Alexei Starovoitov <ast@kernel.org> 7e3ed2fefSWang Nan * Copyright (C) 2015 Wang Nan <wangnan0@huawei.com> 8e3ed2fefSWang Nan * Copyright (C) 2015 Huawei Inc. 9203d1cacSWang Nan * 10203d1cacSWang Nan * This program is free software; you can redistribute it and/or 11203d1cacSWang Nan * modify it under the terms of the GNU Lesser General Public 12203d1cacSWang Nan * License as published by the Free Software Foundation; 13203d1cacSWang Nan * version 2.1 of the License (not later!) 14203d1cacSWang Nan * 15203d1cacSWang Nan * This program is distributed in the hope that it will be useful, 16203d1cacSWang Nan * but WITHOUT ANY WARRANTY; without even the implied warranty of 17203d1cacSWang Nan * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18203d1cacSWang Nan * GNU Lesser General Public License for more details. 19203d1cacSWang Nan * 20203d1cacSWang Nan * You should have received a copy of the GNU Lesser General Public 21203d1cacSWang Nan * License along with this program; if not, see <http://www.gnu.org/licenses> 22e3ed2fefSWang Nan */ 23eff81908SAndrey Ignatov #ifndef __LIBBPF_BPF_H 24eff81908SAndrey Ignatov #define __LIBBPF_BPF_H 25e3ed2fefSWang Nan 26e3ed2fefSWang Nan #include <linux/bpf.h> 27878a4d32SBjörn Töpel #include <stdbool.h> 287a5980f9SMickaël Salaün #include <stddef.h> 29e3ed2fefSWang Nan 308c4905b9SStanislav Fomichev #ifdef __cplusplus 318c4905b9SStanislav Fomichev extern "C" { 328c4905b9SStanislav Fomichev #endif 338c4905b9SStanislav Fomichev 34ab9e0848SAndrey Ignatov #ifndef LIBBPF_API 35ab9e0848SAndrey Ignatov #define LIBBPF_API __attribute__((visibility("default"))) 36ab9e0848SAndrey Ignatov #endif 37ab9e0848SAndrey Ignatov 388a138aedSMartin KaFai Lau struct bpf_create_map_attr { 398a138aedSMartin KaFai Lau const char *name; 408a138aedSMartin KaFai Lau enum bpf_map_type map_type; 418a138aedSMartin KaFai Lau __u32 map_flags; 428a138aedSMartin KaFai Lau __u32 key_size; 438a138aedSMartin KaFai Lau __u32 value_size; 448a138aedSMartin KaFai Lau __u32 max_entries; 458a138aedSMartin KaFai Lau __u32 numa_node; 468a138aedSMartin KaFai Lau __u32 btf_fd; 4761746dbeSMartin KaFai Lau __u32 btf_key_type_id; 4861746dbeSMartin KaFai Lau __u32 btf_value_type_id; 49f0307a7eSDavid Beckett __u32 map_ifindex; 5091134d84SMartin KaFai Lau __u32 inner_map_fd; 518a138aedSMartin KaFai Lau }; 528a138aedSMartin KaFai Lau 53ab9e0848SAndrey Ignatov LIBBPF_API int 54ab9e0848SAndrey Ignatov bpf_create_map_xattr(const struct bpf_create_map_attr *create_attr); 55ab9e0848SAndrey Ignatov LIBBPF_API int bpf_create_map_node(enum bpf_map_type map_type, const char *name, 56ab9e0848SAndrey Ignatov int key_size, int value_size, 57ab9e0848SAndrey Ignatov int max_entries, __u32 map_flags, int node); 58ab9e0848SAndrey Ignatov LIBBPF_API int bpf_create_map_name(enum bpf_map_type map_type, const char *name, 59ab9e0848SAndrey Ignatov int key_size, int value_size, 60a5580c7fSJoe Stringer int max_entries, __u32 map_flags); 61ab9e0848SAndrey Ignatov LIBBPF_API int bpf_create_map(enum bpf_map_type map_type, int key_size, 62ab9e0848SAndrey Ignatov int value_size, int max_entries, __u32 map_flags); 63ab9e0848SAndrey Ignatov LIBBPF_API int bpf_create_map_in_map_node(enum bpf_map_type map_type, 64ab9e0848SAndrey Ignatov const char *name, int key_size, 65ab9e0848SAndrey Ignatov int inner_map_fd, int max_entries, 66ad17d0e6SMartin KaFai Lau __u32 map_flags, int node); 67ab9e0848SAndrey Ignatov LIBBPF_API int bpf_create_map_in_map(enum bpf_map_type map_type, 68ab9e0848SAndrey Ignatov const char *name, int key_size, 69ab9e0848SAndrey Ignatov int inner_map_fd, int max_entries, 7088cda1c9SMartin KaFai Lau __u32 map_flags); 71e3ed2fefSWang Nan 72d7be143bSAndrey Ignatov struct bpf_load_program_attr { 73d7be143bSAndrey Ignatov enum bpf_prog_type prog_type; 74d7be143bSAndrey Ignatov enum bpf_attach_type expected_attach_type; 75d7be143bSAndrey Ignatov const char *name; 76d7be143bSAndrey Ignatov const struct bpf_insn *insns; 77d7be143bSAndrey Ignatov size_t insns_cnt; 78d7be143bSAndrey Ignatov const char *license; 79d7be143bSAndrey Ignatov __u32 kern_version; 80f0307a7eSDavid Beckett __u32 prog_ifindex; 817e0d0fb5SYonghong Song __u32 prog_btf_fd; 827e0d0fb5SYonghong Song __u32 func_info_rec_size; 837e0d0fb5SYonghong Song const void *func_info; 847e0d0fb5SYonghong Song __u32 func_info_cnt; 853d650141SMartin KaFai Lau __u32 line_info_rec_size; 863d650141SMartin KaFai Lau const void *line_info; 873d650141SMartin KaFai Lau __u32 line_info_cnt; 88a4021a35SYonghong Song __u32 log_level; 89d7be143bSAndrey Ignatov }; 90d7be143bSAndrey Ignatov 91c034a177SJohn Fastabend /* Flags to direct loading requirements */ 92c034a177SJohn Fastabend #define MAPS_RELAX_COMPAT 0x01 93c034a177SJohn Fastabend 947bf98369SWang Nan /* Recommend log buffer size */ 95*4519efa6SMcCabe, Robert J #define BPF_LOG_BUF_SIZE (UINT32_MAX >> 8) /* verifier maximum in kernels <= 5.1 */ 96ab9e0848SAndrey Ignatov LIBBPF_API int 97ab9e0848SAndrey Ignatov bpf_load_program_xattr(const struct bpf_load_program_attr *load_attr, 98d7be143bSAndrey Ignatov char *log_buf, size_t log_buf_sz); 99ab9e0848SAndrey Ignatov LIBBPF_API int bpf_load_program(enum bpf_prog_type type, 100ab9e0848SAndrey Ignatov const struct bpf_insn *insns, size_t insns_cnt, 101ab9e0848SAndrey Ignatov const char *license, __u32 kern_version, 102ab9e0848SAndrey Ignatov char *log_buf, size_t log_buf_sz); 103ab9e0848SAndrey Ignatov LIBBPF_API int bpf_verify_program(enum bpf_prog_type type, 104ab9e0848SAndrey Ignatov const struct bpf_insn *insns, 105e9ee9efcSDavid Miller size_t insns_cnt, __u32 prog_flags, 10691045f5eSDavid S. Miller const char *license, __u32 kern_version, 107ab9e0848SAndrey Ignatov char *log_buf, size_t log_buf_sz, 108ab9e0848SAndrey Ignatov int log_level); 1097bf98369SWang Nan 110ab9e0848SAndrey Ignatov LIBBPF_API int bpf_map_update_elem(int fd, const void *key, const void *value, 11183d994d0SJoe Stringer __u64 flags); 1129742da01SWang Nan 113ab9e0848SAndrey Ignatov LIBBPF_API int bpf_map_lookup_elem(int fd, const void *key, void *value); 114df5d22faSAlexei Starovoitov LIBBPF_API int bpf_map_lookup_elem_flags(int fd, const void *key, void *value, 115df5d22faSAlexei Starovoitov __u64 flags); 11643b987d2SMauricio Vasquez B LIBBPF_API int bpf_map_lookup_and_delete_elem(int fd, const void *key, 11743b987d2SMauricio Vasquez B void *value); 118ab9e0848SAndrey Ignatov LIBBPF_API int bpf_map_delete_elem(int fd, const void *key); 119ab9e0848SAndrey Ignatov LIBBPF_API int bpf_map_get_next_key(int fd, const void *key, void *next_key); 120d859900cSDaniel Borkmann LIBBPF_API int bpf_map_freeze(int fd); 121ab9e0848SAndrey Ignatov LIBBPF_API int bpf_obj_pin(int fd, const char *pathname); 122ab9e0848SAndrey Ignatov LIBBPF_API int bpf_obj_get(const char *pathname); 123ab9e0848SAndrey Ignatov LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd, 124ab9e0848SAndrey Ignatov enum bpf_attach_type type, unsigned int flags); 125ab9e0848SAndrey Ignatov LIBBPF_API int bpf_prog_detach(int attachable_fd, enum bpf_attach_type type); 126ab9e0848SAndrey Ignatov LIBBPF_API int bpf_prog_detach2(int prog_fd, int attachable_fd, 127ab9e0848SAndrey Ignatov enum bpf_attach_type type); 12864a97591SLorenz Bauer 12964a97591SLorenz Bauer struct bpf_prog_test_run_attr { 13064a97591SLorenz Bauer int prog_fd; 13164a97591SLorenz Bauer int repeat; 13264a97591SLorenz Bauer const void *data_in; 13364a97591SLorenz Bauer __u32 data_size_in; 13464a97591SLorenz Bauer void *data_out; /* optional */ 13564a97591SLorenz Bauer __u32 data_size_out; /* in: max length of data_out 13664a97591SLorenz Bauer * out: length of data_out */ 13764a97591SLorenz Bauer __u32 retval; /* out: return code of the BPF program */ 13864a97591SLorenz Bauer __u32 duration; /* out: average per repetition in ns */ 1395e903c65SStanislav Fomichev const void *ctx_in; /* optional */ 1405e903c65SStanislav Fomichev __u32 ctx_size_in; 1415e903c65SStanislav Fomichev void *ctx_out; /* optional */ 1425e903c65SStanislav Fomichev __u32 ctx_size_out; /* in: max length of ctx_out 1435e903c65SStanislav Fomichev * out: length of cxt_out */ 14464a97591SLorenz Bauer }; 14564a97591SLorenz Bauer 14664a97591SLorenz Bauer LIBBPF_API int bpf_prog_test_run_xattr(struct bpf_prog_test_run_attr *test_attr); 14764a97591SLorenz Bauer 14864a97591SLorenz Bauer /* 14964a97591SLorenz Bauer * bpf_prog_test_run does not check that data_out is large enough. Consider 15064a97591SLorenz Bauer * using bpf_prog_test_run_xattr instead. 15164a97591SLorenz Bauer */ 152ab9e0848SAndrey Ignatov LIBBPF_API int bpf_prog_test_run(int prog_fd, int repeat, void *data, 153ab9e0848SAndrey Ignatov __u32 size, void *data_out, __u32 *size_out, 154ab9e0848SAndrey Ignatov __u32 *retval, __u32 *duration); 155ab9e0848SAndrey Ignatov LIBBPF_API int bpf_prog_get_next_id(__u32 start_id, __u32 *next_id); 156ab9e0848SAndrey Ignatov LIBBPF_API int bpf_map_get_next_id(__u32 start_id, __u32 *next_id); 157ab9e0848SAndrey Ignatov LIBBPF_API int bpf_prog_get_fd_by_id(__u32 id); 158ab9e0848SAndrey Ignatov LIBBPF_API int bpf_map_get_fd_by_id(__u32 id); 159ab9e0848SAndrey Ignatov LIBBPF_API int bpf_btf_get_fd_by_id(__u32 id); 160ab9e0848SAndrey Ignatov LIBBPF_API int bpf_obj_get_info_by_fd(int prog_fd, void *info, __u32 *info_len); 161ab9e0848SAndrey Ignatov LIBBPF_API int bpf_prog_query(int target_fd, enum bpf_attach_type type, 162ab9e0848SAndrey Ignatov __u32 query_flags, __u32 *attach_flags, 163ab9e0848SAndrey Ignatov __u32 *prog_ids, __u32 *prog_cnt); 164ab9e0848SAndrey Ignatov LIBBPF_API int bpf_raw_tracepoint_open(const char *name, int prog_fd); 165ab9e0848SAndrey Ignatov LIBBPF_API int bpf_load_btf(void *btf, __u32 btf_size, char *log_buf, 166ab9e0848SAndrey Ignatov __u32 log_buf_size, bool do_log); 167ab9e0848SAndrey Ignatov LIBBPF_API int bpf_task_fd_query(int pid, int fd, __u32 flags, char *buf, 168ab9e0848SAndrey Ignatov __u32 *buf_len, __u32 *prog_id, __u32 *fd_type, 169ab9e0848SAndrey Ignatov __u64 *probe_offset, __u64 *probe_addr); 1708c4905b9SStanislav Fomichev 1718c4905b9SStanislav Fomichev #ifdef __cplusplus 1728c4905b9SStanislav Fomichev } /* extern "C" */ 1738c4905b9SStanislav Fomichev #endif 1748c4905b9SStanislav Fomichev 175eff81908SAndrey Ignatov #endif /* __LIBBPF_BPF_H */ 176