1 // SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
4 * common eBPF ELF operations.
8 * Copyright (C) 2015 Huawei Inc.
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!)
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.
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>
28 #include <asm/unistd.h>
29 #include <linux/bpf.h>
35 * When building perf, unistd.h is overridden. __NR_bpf is
36 * required to be defined explicitly.
39 # if defined(__i386__)
41 # elif defined(__x86_64__)
43 # elif defined(__aarch64__)
45 # elif defined(__sparc__)
47 # elif defined(__s390__)
50 # error __NR_bpf not defined. libbpf does not support your arch.
55 #define min(x, y) ((x) < (y) ? (x) : (y))
58 static inline __u64 ptr_to_u64(const void *ptr)
60 return (__u64) (unsigned long) ptr;
63 static inline int sys_bpf(enum bpf_cmd cmd, union bpf_attr *attr,
66 return syscall(__NR_bpf, cmd, attr, size);
69 static inline int sys_bpf_prog_load(union bpf_attr *attr, unsigned int size)
74 fd = sys_bpf(BPF_PROG_LOAD, attr, size);
75 } while (fd < 0 && errno == EAGAIN);
80 int bpf_create_map_xattr(const struct bpf_create_map_attr *create_attr)
82 __u32 name_len = create_attr->name ? strlen(create_attr->name) : 0;
85 memset(&attr, '\0', sizeof(attr));
87 attr.map_type = create_attr->map_type;
88 attr.key_size = create_attr->key_size;
89 attr.value_size = create_attr->value_size;
90 attr.max_entries = create_attr->max_entries;
91 attr.map_flags = create_attr->map_flags;
92 memcpy(attr.map_name, create_attr->name,
93 min(name_len, BPF_OBJ_NAME_LEN - 1));
94 attr.numa_node = create_attr->numa_node;
95 attr.btf_fd = create_attr->btf_fd;
96 attr.btf_key_type_id = create_attr->btf_key_type_id;
97 attr.btf_value_type_id = create_attr->btf_value_type_id;
98 attr.map_ifindex = create_attr->map_ifindex;
99 attr.inner_map_fd = create_attr->inner_map_fd;
101 return sys_bpf(BPF_MAP_CREATE, &attr, sizeof(attr));
104 int bpf_create_map_node(enum bpf_map_type map_type, const char *name,
105 int key_size, int value_size, int max_entries,
106 __u32 map_flags, int node)
108 struct bpf_create_map_attr map_attr = {};
110 map_attr.name = name;
111 map_attr.map_type = map_type;
112 map_attr.map_flags = map_flags;
113 map_attr.key_size = key_size;
114 map_attr.value_size = value_size;
115 map_attr.max_entries = max_entries;
117 map_attr.numa_node = node;
118 map_attr.map_flags |= BPF_F_NUMA_NODE;
121 return bpf_create_map_xattr(&map_attr);
124 int bpf_create_map(enum bpf_map_type map_type, int key_size,
125 int value_size, int max_entries, __u32 map_flags)
127 struct bpf_create_map_attr map_attr = {};
129 map_attr.map_type = map_type;
130 map_attr.map_flags = map_flags;
131 map_attr.key_size = key_size;
132 map_attr.value_size = value_size;
133 map_attr.max_entries = max_entries;
135 return bpf_create_map_xattr(&map_attr);
138 int bpf_create_map_name(enum bpf_map_type map_type, const char *name,
139 int key_size, int value_size, int max_entries,
142 struct bpf_create_map_attr map_attr = {};
144 map_attr.name = name;
145 map_attr.map_type = map_type;
146 map_attr.map_flags = map_flags;
147 map_attr.key_size = key_size;
148 map_attr.value_size = value_size;
149 map_attr.max_entries = max_entries;
151 return bpf_create_map_xattr(&map_attr);
154 int bpf_create_map_in_map_node(enum bpf_map_type map_type, const char *name,
155 int key_size, int inner_map_fd, int max_entries,
156 __u32 map_flags, int node)
158 __u32 name_len = name ? strlen(name) : 0;
161 memset(&attr, '\0', sizeof(attr));
163 attr.map_type = map_type;
164 attr.key_size = key_size;
166 attr.inner_map_fd = inner_map_fd;
167 attr.max_entries = max_entries;
168 attr.map_flags = map_flags;
169 memcpy(attr.map_name, name, min(name_len, BPF_OBJ_NAME_LEN - 1));
172 attr.map_flags |= BPF_F_NUMA_NODE;
173 attr.numa_node = node;
176 return sys_bpf(BPF_MAP_CREATE, &attr, sizeof(attr));
179 int bpf_create_map_in_map(enum bpf_map_type map_type, const char *name,
180 int key_size, int inner_map_fd, int max_entries,
183 return bpf_create_map_in_map_node(map_type, name, key_size,
184 inner_map_fd, max_entries, map_flags,
189 alloc_zero_tailing_info(const void *orecord, __u32 cnt,
190 __u32 actual_rec_size, __u32 expected_rec_size)
192 __u64 info_len = actual_rec_size * cnt;
193 void *info, *nrecord;
196 info = malloc(info_len);
200 /* zero out bytes kernel does not understand */
202 for (i = 0; i < cnt; i++) {
203 memcpy(nrecord, orecord, expected_rec_size);
204 memset(nrecord + expected_rec_size, 0,
205 actual_rec_size - expected_rec_size);
206 orecord += actual_rec_size;
207 nrecord += actual_rec_size;
213 int bpf_load_program_xattr(const struct bpf_load_program_attr *load_attr,
214 char *log_buf, size_t log_buf_sz)
216 void *finfo = NULL, *linfo = NULL;
222 if (!load_attr || !log_buf != !log_buf_sz)
225 log_level = load_attr->log_level;
226 if (log_level > 2 || (log_level && !log_buf))
229 name_len = load_attr->name ? strlen(load_attr->name) : 0;
231 memset(&attr, 0, sizeof(attr));
232 attr.prog_type = load_attr->prog_type;
233 attr.expected_attach_type = load_attr->expected_attach_type;
234 attr.insn_cnt = (__u32)load_attr->insns_cnt;
235 attr.insns = ptr_to_u64(load_attr->insns);
236 attr.license = ptr_to_u64(load_attr->license);
238 attr.log_level = log_level;
240 attr.log_buf = ptr_to_u64(log_buf);
241 attr.log_size = log_buf_sz;
243 attr.log_buf = ptr_to_u64(NULL);
247 attr.kern_version = load_attr->kern_version;
248 attr.prog_ifindex = load_attr->prog_ifindex;
249 attr.prog_btf_fd = load_attr->prog_btf_fd;
250 attr.func_info_rec_size = load_attr->func_info_rec_size;
251 attr.func_info_cnt = load_attr->func_info_cnt;
252 attr.func_info = ptr_to_u64(load_attr->func_info);
253 attr.line_info_rec_size = load_attr->line_info_rec_size;
254 attr.line_info_cnt = load_attr->line_info_cnt;
255 attr.line_info = ptr_to_u64(load_attr->line_info);
256 memcpy(attr.prog_name, load_attr->name,
257 min(name_len, BPF_OBJ_NAME_LEN - 1));
259 fd = sys_bpf_prog_load(&attr, sizeof(attr));
263 /* After bpf_prog_load, the kernel may modify certain attributes
264 * to give user space a hint how to deal with loading failure.
265 * Check to see whether we can make some changes and load again.
267 while (errno == E2BIG && (!finfo || !linfo)) {
268 if (!finfo && attr.func_info_cnt &&
269 attr.func_info_rec_size < load_attr->func_info_rec_size) {
270 /* try with corrected func info records */
271 finfo = alloc_zero_tailing_info(load_attr->func_info,
272 load_attr->func_info_cnt,
273 load_attr->func_info_rec_size,
274 attr.func_info_rec_size);
278 attr.func_info = ptr_to_u64(finfo);
279 attr.func_info_rec_size = load_attr->func_info_rec_size;
280 } else if (!linfo && attr.line_info_cnt &&
281 attr.line_info_rec_size <
282 load_attr->line_info_rec_size) {
283 linfo = alloc_zero_tailing_info(load_attr->line_info,
284 load_attr->line_info_cnt,
285 load_attr->line_info_rec_size,
286 attr.line_info_rec_size);
290 attr.line_info = ptr_to_u64(linfo);
291 attr.line_info_rec_size = load_attr->line_info_rec_size;
296 fd = sys_bpf_prog_load(&attr, sizeof(attr));
302 if (log_level || !log_buf)
305 /* Try again with log */
306 attr.log_buf = ptr_to_u64(log_buf);
307 attr.log_size = log_buf_sz;
310 fd = sys_bpf_prog_load(&attr, sizeof(attr));
317 int bpf_load_program(enum bpf_prog_type type, const struct bpf_insn *insns,
318 size_t insns_cnt, const char *license,
319 __u32 kern_version, char *log_buf,
322 struct bpf_load_program_attr load_attr;
324 memset(&load_attr, 0, sizeof(struct bpf_load_program_attr));
325 load_attr.prog_type = type;
326 load_attr.expected_attach_type = 0;
327 load_attr.name = NULL;
328 load_attr.insns = insns;
329 load_attr.insns_cnt = insns_cnt;
330 load_attr.license = license;
331 load_attr.kern_version = kern_version;
333 return bpf_load_program_xattr(&load_attr, log_buf, log_buf_sz);
336 int bpf_verify_program(enum bpf_prog_type type, const struct bpf_insn *insns,
337 size_t insns_cnt, __u32 prog_flags, const char *license,
338 __u32 kern_version, char *log_buf, size_t log_buf_sz,
343 memset(&attr, 0, sizeof(attr));
344 attr.prog_type = type;
345 attr.insn_cnt = (__u32)insns_cnt;
346 attr.insns = ptr_to_u64(insns);
347 attr.license = ptr_to_u64(license);
348 attr.log_buf = ptr_to_u64(log_buf);
349 attr.log_size = log_buf_sz;
350 attr.log_level = log_level;
352 attr.kern_version = kern_version;
353 attr.prog_flags = prog_flags;
355 return sys_bpf_prog_load(&attr, sizeof(attr));
358 int bpf_map_update_elem(int fd, const void *key, const void *value,
363 memset(&attr, 0, sizeof(attr));
365 attr.key = ptr_to_u64(key);
366 attr.value = ptr_to_u64(value);
369 return sys_bpf(BPF_MAP_UPDATE_ELEM, &attr, sizeof(attr));
372 int bpf_map_lookup_elem(int fd, const void *key, void *value)
376 memset(&attr, 0, sizeof(attr));
378 attr.key = ptr_to_u64(key);
379 attr.value = ptr_to_u64(value);
381 return sys_bpf(BPF_MAP_LOOKUP_ELEM, &attr, sizeof(attr));
384 int bpf_map_lookup_elem_flags(int fd, const void *key, void *value, __u64 flags)
388 memset(&attr, 0, sizeof(attr));
390 attr.key = ptr_to_u64(key);
391 attr.value = ptr_to_u64(value);
394 return sys_bpf(BPF_MAP_LOOKUP_ELEM, &attr, sizeof(attr));
397 int bpf_map_lookup_and_delete_elem(int fd, const void *key, void *value)
401 memset(&attr, 0, sizeof(attr));
403 attr.key = ptr_to_u64(key);
404 attr.value = ptr_to_u64(value);
406 return sys_bpf(BPF_MAP_LOOKUP_AND_DELETE_ELEM, &attr, sizeof(attr));
409 int bpf_map_delete_elem(int fd, const void *key)
413 memset(&attr, 0, sizeof(attr));
415 attr.key = ptr_to_u64(key);
417 return sys_bpf(BPF_MAP_DELETE_ELEM, &attr, sizeof(attr));
420 int bpf_map_get_next_key(int fd, const void *key, void *next_key)
424 memset(&attr, 0, sizeof(attr));
426 attr.key = ptr_to_u64(key);
427 attr.next_key = ptr_to_u64(next_key);
429 return sys_bpf(BPF_MAP_GET_NEXT_KEY, &attr, sizeof(attr));
432 int bpf_obj_pin(int fd, const char *pathname)
436 memset(&attr, 0, sizeof(attr));
437 attr.pathname = ptr_to_u64((void *)pathname);
440 return sys_bpf(BPF_OBJ_PIN, &attr, sizeof(attr));
443 int bpf_obj_get(const char *pathname)
447 memset(&attr, 0, sizeof(attr));
448 attr.pathname = ptr_to_u64((void *)pathname);
450 return sys_bpf(BPF_OBJ_GET, &attr, sizeof(attr));
453 int bpf_prog_attach(int prog_fd, int target_fd, enum bpf_attach_type type,
458 memset(&attr, 0, sizeof(attr));
459 attr.target_fd = target_fd;
460 attr.attach_bpf_fd = prog_fd;
461 attr.attach_type = type;
462 attr.attach_flags = flags;
464 return sys_bpf(BPF_PROG_ATTACH, &attr, sizeof(attr));
467 int bpf_prog_detach(int target_fd, enum bpf_attach_type type)
471 memset(&attr, 0, sizeof(attr));
472 attr.target_fd = target_fd;
473 attr.attach_type = type;
475 return sys_bpf(BPF_PROG_DETACH, &attr, sizeof(attr));
478 int bpf_prog_detach2(int prog_fd, int target_fd, enum bpf_attach_type type)
482 memset(&attr, 0, sizeof(attr));
483 attr.target_fd = target_fd;
484 attr.attach_bpf_fd = prog_fd;
485 attr.attach_type = type;
487 return sys_bpf(BPF_PROG_DETACH, &attr, sizeof(attr));
490 int bpf_prog_query(int target_fd, enum bpf_attach_type type, __u32 query_flags,
491 __u32 *attach_flags, __u32 *prog_ids, __u32 *prog_cnt)
496 memset(&attr, 0, sizeof(attr));
497 attr.query.target_fd = target_fd;
498 attr.query.attach_type = type;
499 attr.query.query_flags = query_flags;
500 attr.query.prog_cnt = *prog_cnt;
501 attr.query.prog_ids = ptr_to_u64(prog_ids);
503 ret = sys_bpf(BPF_PROG_QUERY, &attr, sizeof(attr));
505 *attach_flags = attr.query.attach_flags;
506 *prog_cnt = attr.query.prog_cnt;
510 int bpf_prog_test_run(int prog_fd, int repeat, void *data, __u32 size,
511 void *data_out, __u32 *size_out, __u32 *retval,
517 memset(&attr, 0, sizeof(attr));
518 attr.test.prog_fd = prog_fd;
519 attr.test.data_in = ptr_to_u64(data);
520 attr.test.data_out = ptr_to_u64(data_out);
521 attr.test.data_size_in = size;
522 attr.test.repeat = repeat;
524 ret = sys_bpf(BPF_PROG_TEST_RUN, &attr, sizeof(attr));
526 *size_out = attr.test.data_size_out;
528 *retval = attr.test.retval;
530 *duration = attr.test.duration;
534 int bpf_prog_test_run_xattr(struct bpf_prog_test_run_attr *test_attr)
539 if (!test_attr->data_out && test_attr->data_size_out > 0)
542 memset(&attr, 0, sizeof(attr));
543 attr.test.prog_fd = test_attr->prog_fd;
544 attr.test.data_in = ptr_to_u64(test_attr->data_in);
545 attr.test.data_out = ptr_to_u64(test_attr->data_out);
546 attr.test.data_size_in = test_attr->data_size_in;
547 attr.test.data_size_out = test_attr->data_size_out;
548 attr.test.repeat = test_attr->repeat;
550 ret = sys_bpf(BPF_PROG_TEST_RUN, &attr, sizeof(attr));
551 test_attr->data_size_out = attr.test.data_size_out;
552 test_attr->retval = attr.test.retval;
553 test_attr->duration = attr.test.duration;
557 int bpf_prog_get_next_id(__u32 start_id, __u32 *next_id)
562 memset(&attr, 0, sizeof(attr));
563 attr.start_id = start_id;
565 err = sys_bpf(BPF_PROG_GET_NEXT_ID, &attr, sizeof(attr));
567 *next_id = attr.next_id;
572 int bpf_map_get_next_id(__u32 start_id, __u32 *next_id)
577 memset(&attr, 0, sizeof(attr));
578 attr.start_id = start_id;
580 err = sys_bpf(BPF_MAP_GET_NEXT_ID, &attr, sizeof(attr));
582 *next_id = attr.next_id;
587 int bpf_prog_get_fd_by_id(__u32 id)
591 memset(&attr, 0, sizeof(attr));
594 return sys_bpf(BPF_PROG_GET_FD_BY_ID, &attr, sizeof(attr));
597 int bpf_map_get_fd_by_id(__u32 id)
601 memset(&attr, 0, sizeof(attr));
604 return sys_bpf(BPF_MAP_GET_FD_BY_ID, &attr, sizeof(attr));
607 int bpf_btf_get_fd_by_id(__u32 id)
611 memset(&attr, 0, sizeof(attr));
614 return sys_bpf(BPF_BTF_GET_FD_BY_ID, &attr, sizeof(attr));
617 int bpf_obj_get_info_by_fd(int prog_fd, void *info, __u32 *info_len)
622 memset(&attr, 0, sizeof(attr));
623 attr.info.bpf_fd = prog_fd;
624 attr.info.info_len = *info_len;
625 attr.info.info = ptr_to_u64(info);
627 err = sys_bpf(BPF_OBJ_GET_INFO_BY_FD, &attr, sizeof(attr));
629 *info_len = attr.info.info_len;
634 int bpf_raw_tracepoint_open(const char *name, int prog_fd)
638 memset(&attr, 0, sizeof(attr));
639 attr.raw_tracepoint.name = ptr_to_u64(name);
640 attr.raw_tracepoint.prog_fd = prog_fd;
642 return sys_bpf(BPF_RAW_TRACEPOINT_OPEN, &attr, sizeof(attr));
645 int bpf_load_btf(void *btf, __u32 btf_size, char *log_buf, __u32 log_buf_size,
648 union bpf_attr attr = {};
651 attr.btf = ptr_to_u64(btf);
652 attr.btf_size = btf_size;
655 if (do_log && log_buf && log_buf_size) {
656 attr.btf_log_level = 1;
657 attr.btf_log_size = log_buf_size;
658 attr.btf_log_buf = ptr_to_u64(log_buf);
661 fd = sys_bpf(BPF_BTF_LOAD, &attr, sizeof(attr));
662 if (fd == -1 && !do_log && log_buf && log_buf_size) {
670 int bpf_task_fd_query(int pid, int fd, __u32 flags, char *buf, __u32 *buf_len,
671 __u32 *prog_id, __u32 *fd_type, __u64 *probe_offset,
674 union bpf_attr attr = {};
677 attr.task_fd_query.pid = pid;
678 attr.task_fd_query.fd = fd;
679 attr.task_fd_query.flags = flags;
680 attr.task_fd_query.buf = ptr_to_u64(buf);
681 attr.task_fd_query.buf_len = *buf_len;
683 err = sys_bpf(BPF_TASK_FD_QUERY, &attr, sizeof(attr));
684 *buf_len = attr.task_fd_query.buf_len;
685 *prog_id = attr.task_fd_query.prog_id;
686 *fd_type = attr.task_fd_query.fd_type;
687 *probe_offset = attr.task_fd_query.probe_offset;
688 *probe_addr = attr.task_fd_query.probe_addr;