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