xref: /linux/tools/lib/bpf/bpf.h (revision 2843ba2ec75948e274d2c4f0a9390980e68a6461)
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 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 #ifndef LIBBPF_API
35 #define LIBBPF_API __attribute__((visibility("default")))
36 #endif
37 
38 struct bpf_create_map_attr {
39 	const char *name;
40 	enum bpf_map_type map_type;
41 	__u32 map_flags;
42 	__u32 key_size;
43 	__u32 value_size;
44 	__u32 max_entries;
45 	__u32 numa_node;
46 	__u32 btf_fd;
47 	__u32 btf_key_type_id;
48 	__u32 btf_value_type_id;
49 	__u32 map_ifindex;
50 	__u32 inner_map_fd;
51 };
52 
53 LIBBPF_API int
54 bpf_create_map_xattr(const struct bpf_create_map_attr *create_attr);
55 LIBBPF_API int bpf_create_map_node(enum bpf_map_type map_type, const char *name,
56 				   int key_size, int value_size,
57 				   int max_entries, __u32 map_flags, int node);
58 LIBBPF_API int bpf_create_map_name(enum bpf_map_type map_type, const char *name,
59 				   int key_size, int value_size,
60 				   int max_entries, __u32 map_flags);
61 LIBBPF_API int bpf_create_map(enum bpf_map_type map_type, int key_size,
62 			      int value_size, int max_entries, __u32 map_flags);
63 LIBBPF_API int bpf_create_map_in_map_node(enum bpf_map_type map_type,
64 					  const char *name, int key_size,
65 					  int inner_map_fd, int max_entries,
66 					  __u32 map_flags, int node);
67 LIBBPF_API int bpf_create_map_in_map(enum bpf_map_type map_type,
68 				     const char *name, int key_size,
69 				     int inner_map_fd, int max_entries,
70 				     __u32 map_flags);
71 
72 struct bpf_load_program_attr {
73 	enum bpf_prog_type prog_type;
74 	enum bpf_attach_type expected_attach_type;
75 	const char *name;
76 	const struct bpf_insn *insns;
77 	size_t insns_cnt;
78 	const char *license;
79 	__u32 kern_version;
80 	__u32 prog_ifindex;
81 	__u32 prog_btf_fd;
82 	__u32 func_info_rec_size;
83 	const void *func_info;
84 	__u32 func_info_cnt;
85 	__u32 line_info_rec_size;
86 	const void *line_info;
87 	__u32 line_info_cnt;
88 	__u32 log_level;
89 };
90 
91 /* Flags to direct loading requirements */
92 #define MAPS_RELAX_COMPAT	0x01
93 
94 /* Recommend log buffer size */
95 #define BPF_LOG_BUF_SIZE (UINT32_MAX >> 8) /* verifier maximum in kernels <= 5.1 */
96 LIBBPF_API int
97 bpf_load_program_xattr(const struct bpf_load_program_attr *load_attr,
98 		       char *log_buf, size_t log_buf_sz);
99 LIBBPF_API int bpf_load_program(enum bpf_prog_type type,
100 				const struct bpf_insn *insns, size_t insns_cnt,
101 				const char *license, __u32 kern_version,
102 				char *log_buf, size_t log_buf_sz);
103 LIBBPF_API int bpf_verify_program(enum bpf_prog_type type,
104 				  const struct bpf_insn *insns,
105 				  size_t insns_cnt, __u32 prog_flags,
106 				  const char *license, __u32 kern_version,
107 				  char *log_buf, size_t log_buf_sz,
108 				  int log_level);
109 
110 LIBBPF_API int bpf_map_update_elem(int fd, const void *key, const void *value,
111 				   __u64 flags);
112 
113 LIBBPF_API int bpf_map_lookup_elem(int fd, const void *key, void *value);
114 LIBBPF_API int bpf_map_lookup_elem_flags(int fd, const void *key, void *value,
115 					 __u64 flags);
116 LIBBPF_API int bpf_map_lookup_and_delete_elem(int fd, const void *key,
117 					      void *value);
118 LIBBPF_API int bpf_map_delete_elem(int fd, const void *key);
119 LIBBPF_API int bpf_map_get_next_key(int fd, const void *key, void *next_key);
120 LIBBPF_API int bpf_map_freeze(int fd);
121 LIBBPF_API int bpf_obj_pin(int fd, const char *pathname);
122 LIBBPF_API int bpf_obj_get(const char *pathname);
123 LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,
124 			       enum bpf_attach_type type, unsigned int flags);
125 LIBBPF_API int bpf_prog_detach(int attachable_fd, enum bpf_attach_type type);
126 LIBBPF_API int bpf_prog_detach2(int prog_fd, int attachable_fd,
127 				enum bpf_attach_type type);
128 
129 struct bpf_prog_test_run_attr {
130 	int prog_fd;
131 	int repeat;
132 	const void *data_in;
133 	__u32 data_size_in;
134 	void *data_out;      /* optional */
135 	__u32 data_size_out; /* in: max length of data_out
136 			      * out: length of data_out */
137 	__u32 retval;        /* out: return code of the BPF program */
138 	__u32 duration;      /* out: average per repetition in ns */
139 	const void *ctx_in; /* optional */
140 	__u32 ctx_size_in;
141 	void *ctx_out;      /* optional */
142 	__u32 ctx_size_out; /* in: max length of ctx_out
143 			     * out: length of cxt_out */
144 };
145 
146 LIBBPF_API int bpf_prog_test_run_xattr(struct bpf_prog_test_run_attr *test_attr);
147 
148 /*
149  * bpf_prog_test_run does not check that data_out is large enough. Consider
150  * using bpf_prog_test_run_xattr instead.
151  */
152 LIBBPF_API int bpf_prog_test_run(int prog_fd, int repeat, void *data,
153 				 __u32 size, void *data_out, __u32 *size_out,
154 				 __u32 *retval, __u32 *duration);
155 LIBBPF_API int bpf_prog_get_next_id(__u32 start_id, __u32 *next_id);
156 LIBBPF_API int bpf_map_get_next_id(__u32 start_id, __u32 *next_id);
157 LIBBPF_API int bpf_prog_get_fd_by_id(__u32 id);
158 LIBBPF_API int bpf_map_get_fd_by_id(__u32 id);
159 LIBBPF_API int bpf_btf_get_fd_by_id(__u32 id);
160 LIBBPF_API int bpf_obj_get_info_by_fd(int prog_fd, void *info, __u32 *info_len);
161 LIBBPF_API int bpf_prog_query(int target_fd, enum bpf_attach_type type,
162 			      __u32 query_flags, __u32 *attach_flags,
163 			      __u32 *prog_ids, __u32 *prog_cnt);
164 LIBBPF_API int bpf_raw_tracepoint_open(const char *name, int prog_fd);
165 LIBBPF_API int bpf_load_btf(void *btf, __u32 btf_size, char *log_buf,
166 			    __u32 log_buf_size, bool do_log);
167 LIBBPF_API int bpf_task_fd_query(int pid, int fd, __u32 flags, char *buf,
168 				 __u32 *buf_len, __u32 *prog_id, __u32 *fd_type,
169 				 __u64 *probe_offset, __u64 *probe_addr);
170 
171 #ifdef __cplusplus
172 } /* extern "C" */
173 #endif
174 
175 #endif /* __LIBBPF_BPF_H */
176