xref: /linux/tools/lib/bpf/bpf.h (revision 81fa7a69c2174ed8de314b9c231ef30a8718e5e1)
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 #ifndef LIBBPF_API
31 #define LIBBPF_API __attribute__((visibility("default")))
32 #endif
33 
34 struct bpf_create_map_attr {
35 	const char *name;
36 	enum bpf_map_type map_type;
37 	__u32 map_flags;
38 	__u32 key_size;
39 	__u32 value_size;
40 	__u32 max_entries;
41 	__u32 numa_node;
42 	__u32 btf_fd;
43 	__u32 btf_key_type_id;
44 	__u32 btf_value_type_id;
45 	__u32 map_ifindex;
46 	__u32 inner_map_fd;
47 };
48 
49 LIBBPF_API int
50 bpf_create_map_xattr(const struct bpf_create_map_attr *create_attr);
51 LIBBPF_API int bpf_create_map_node(enum bpf_map_type map_type, const char *name,
52 				   int key_size, int value_size,
53 				   int max_entries, __u32 map_flags, int node);
54 LIBBPF_API int bpf_create_map_name(enum bpf_map_type map_type, const char *name,
55 				   int key_size, int value_size,
56 				   int max_entries, __u32 map_flags);
57 LIBBPF_API int bpf_create_map(enum bpf_map_type map_type, int key_size,
58 			      int value_size, int max_entries, __u32 map_flags);
59 LIBBPF_API int bpf_create_map_in_map_node(enum bpf_map_type map_type,
60 					  const char *name, int key_size,
61 					  int inner_map_fd, int max_entries,
62 					  __u32 map_flags, int node);
63 LIBBPF_API int bpf_create_map_in_map(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);
67 
68 struct bpf_load_program_attr {
69 	enum bpf_prog_type prog_type;
70 	enum bpf_attach_type expected_attach_type;
71 	const char *name;
72 	const struct bpf_insn *insns;
73 	size_t insns_cnt;
74 	const char *license;
75 	__u32 kern_version;
76 	__u32 prog_ifindex;
77 };
78 
79 /* Flags to direct loading requirements */
80 #define MAPS_RELAX_COMPAT	0x01
81 
82 /* Recommend log buffer size */
83 #define BPF_LOG_BUF_SIZE (256 * 1024)
84 LIBBPF_API int
85 bpf_load_program_xattr(const struct bpf_load_program_attr *load_attr,
86 		       char *log_buf, size_t log_buf_sz);
87 LIBBPF_API int bpf_load_program(enum bpf_prog_type type,
88 				const struct bpf_insn *insns, size_t insns_cnt,
89 				const char *license, __u32 kern_version,
90 				char *log_buf, size_t log_buf_sz);
91 LIBBPF_API int bpf_verify_program(enum bpf_prog_type type,
92 				  const struct bpf_insn *insns,
93 				  size_t insns_cnt, int strict_alignment,
94 				  const char *license, __u32 kern_version,
95 				  char *log_buf, size_t log_buf_sz,
96 				  int log_level);
97 
98 LIBBPF_API int bpf_map_update_elem(int fd, const void *key, const void *value,
99 				   __u64 flags);
100 
101 LIBBPF_API int bpf_map_lookup_elem(int fd, const void *key, void *value);
102 LIBBPF_API int bpf_map_lookup_and_delete_elem(int fd, const void *key,
103 					      void *value);
104 LIBBPF_API int bpf_map_delete_elem(int fd, const void *key);
105 LIBBPF_API int bpf_map_get_next_key(int fd, const void *key, void *next_key);
106 LIBBPF_API int bpf_obj_pin(int fd, const char *pathname);
107 LIBBPF_API int bpf_obj_get(const char *pathname);
108 LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,
109 			       enum bpf_attach_type type, unsigned int flags);
110 LIBBPF_API int bpf_prog_detach(int attachable_fd, enum bpf_attach_type type);
111 LIBBPF_API int bpf_prog_detach2(int prog_fd, int attachable_fd,
112 				enum bpf_attach_type type);
113 LIBBPF_API int bpf_prog_test_run(int prog_fd, int repeat, void *data,
114 				 __u32 size, void *data_out, __u32 *size_out,
115 				 __u32 *retval, __u32 *duration);
116 LIBBPF_API int bpf_prog_get_next_id(__u32 start_id, __u32 *next_id);
117 LIBBPF_API int bpf_map_get_next_id(__u32 start_id, __u32 *next_id);
118 LIBBPF_API int bpf_prog_get_fd_by_id(__u32 id);
119 LIBBPF_API int bpf_map_get_fd_by_id(__u32 id);
120 LIBBPF_API int bpf_btf_get_fd_by_id(__u32 id);
121 LIBBPF_API int bpf_obj_get_info_by_fd(int prog_fd, void *info, __u32 *info_len);
122 LIBBPF_API int bpf_prog_query(int target_fd, enum bpf_attach_type type,
123 			      __u32 query_flags, __u32 *attach_flags,
124 			      __u32 *prog_ids, __u32 *prog_cnt);
125 LIBBPF_API int bpf_raw_tracepoint_open(const char *name, int prog_fd);
126 LIBBPF_API int bpf_load_btf(void *btf, __u32 btf_size, char *log_buf,
127 			    __u32 log_buf_size, bool do_log);
128 LIBBPF_API int bpf_task_fd_query(int pid, int fd, __u32 flags, char *buf,
129 				 __u32 *buf_len, __u32 *prog_id, __u32 *fd_type,
130 				 __u64 *probe_offset, __u64 *probe_addr);
131 #endif /* __LIBBPF_BPF_H */
132