Commit | Line | Data |
---|---|---|
02ff58dc JK |
1 | /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */ |
2 | /* Copyright (C) 2017-2018 Netronome Systems, Inc. */ | |
71bb428f | 3 | |
71bb428f JK |
4 | #ifndef __BPF_TOOL_H |
5 | #define __BPF_TOOL_H | |
6 | ||
c9c35995 JK |
7 | /* BFD and kernel.h both define GCC_VERSION, differently */ |
8 | #undef GCC_VERSION | |
71bb428f JK |
9 | #include <stdbool.h> |
10 | #include <stdio.h> | |
11 | #include <linux/bpf.h> | |
7868620a | 12 | #include <linux/compiler.h> |
c9c35995 | 13 | #include <linux/kernel.h> |
4990f1f4 | 14 | #include <linux/hashtable.h> |
531b014e | 15 | #include <tools/libc_compat.h> |
71bb428f | 16 | |
8f184732 | 17 | #include <bpf/hashmap.h> |
6ae32b29 QM |
18 | #include <bpf/libbpf.h> |
19 | ||
d35efba9 QM |
20 | #include "json_writer.h" |
21 | ||
6e7e034e QM |
22 | /* Make sure we do not use kernel-only integer typedefs */ |
23 | #pragma GCC poison u8 u16 u32 u64 s8 s16 s32 s64 | |
24 | ||
09f44b75 AN |
25 | static inline __u64 ptr_to_u64(const void *ptr) |
26 | { | |
27 | return (__u64)(unsigned long)ptr; | |
28 | } | |
29 | ||
30 | static inline void *u64_to_ptr(__u64 ptr) | |
31 | { | |
32 | return (void *)(unsigned long)ptr; | |
33 | } | |
71bb428f | 34 | |
71bb428f JK |
35 | #define NEXT_ARG() ({ argc--; argv++; if (argc < 0) usage(); }) |
36 | #define NEXT_ARGP() ({ (*argc)--; (*argv)++; if (*argc < 0) usage(); }) | |
0d954eeb | 37 | #define BAD_ARG() ({ p_err("what is '%s'?", *argv); -1; }) |
8d1fc3de JK |
38 | #define GET_ARG() ({ argc--; *argv++; }) |
39 | #define REQ_ARGS(cnt) \ | |
40 | ({ \ | |
41 | int _cnt = (cnt); \ | |
42 | bool _res; \ | |
43 | \ | |
44 | if (argc < _cnt) { \ | |
45 | p_err("'%s' needs at least %d arguments, %d found", \ | |
46 | argv[-1], _cnt, argc); \ | |
47 | _res = false; \ | |
48 | } else { \ | |
49 | _res = true; \ | |
50 | } \ | |
51 | _res; \ | |
52 | }) | |
71bb428f | 53 | |
3fc27b71 QM |
54 | #define ERR_MAX_LEN 1024 |
55 | ||
2dc7c1fe | 56 | #define BPF_TAG_FMT "%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx" |
71bb428f JK |
57 | |
58 | #define HELP_SPEC_PROGRAM \ | |
a7d22ca2 | 59 | "PROG := { id PROG_ID | pinned FILE | tag PROG_TAG | name PROG_NAME }" |
0641c3c8 | 60 | #define HELP_SPEC_OPTIONS \ |
c07ba629 | 61 | "OPTIONS := { {-j|--json} [{-p|--pretty}] | {-d|--debug}" |
3ff5a4dc | 62 | #define HELP_SPEC_MAP \ |
99f9863a | 63 | "MAP := { id MAP_ID | pinned FILE | name MAP_NAME }" |
c5481f9a AN |
64 | #define HELP_SPEC_LINK \ |
65 | "LINK := { id LINK_ID | pinned FILE }" | |
71bb428f | 66 | |
9023497d TK |
67 | extern const char * const prog_type_name[]; |
68 | extern const size_t prog_type_name_size; | |
99a44bef | 69 | |
16d37ee3 | 70 | extern const char * const attach_type_name[__MAX_BPF_ATTACH_TYPE]; |
50325b17 | 71 | |
f99e1663 QM |
72 | extern const char * const map_type_name[]; |
73 | extern const size_t map_type_name_size; | |
74 | ||
d53dee3f | 75 | /* keep in sync with the definition in skeleton/pid_iter.bpf.c */ |
71bb428f JK |
76 | enum bpf_obj_type { |
77 | BPF_OBJ_UNKNOWN, | |
78 | BPF_OBJ_PROG, | |
79 | BPF_OBJ_MAP, | |
c5481f9a | 80 | BPF_OBJ_LINK, |
d53dee3f | 81 | BPF_OBJ_BTF, |
71bb428f JK |
82 | }; |
83 | ||
84 | extern const char *bin_name; | |
85 | ||
d35efba9 QM |
86 | extern json_writer_t *json_wtr; |
87 | extern bool json_output; | |
c541b734 | 88 | extern bool show_pinned; |
d53dee3f | 89 | extern bool show_pids; |
33221307 | 90 | extern bool block_mount; |
55d77807 | 91 | extern bool verifier_logs; |
32e3e58e | 92 | extern bool relaxed_maps; |
d510296d | 93 | extern bool use_loader; |
75fa1777 | 94 | extern struct btf *base_btf; |
d53dee3f | 95 | extern struct obj_refs_table refs_table; |
d35efba9 | 96 | |
8918dc42 QM |
97 | void __printf(1, 2) p_err(const char *fmt, ...); |
98 | void __printf(1, 2) p_info(const char *fmt, ...); | |
0b1c27db | 99 | |
71bb428f | 100 | bool is_prefix(const char *pfx, const char *str); |
ba95c745 | 101 | int detect_common_prefix(const char *arg, ...); |
9cbe1f58 | 102 | void fprint_hex(FILE *f, void *arg, unsigned int n, const char *sep); |
7868620a | 103 | void usage(void) __noreturn; |
71bb428f | 104 | |
8302b9bd QM |
105 | void set_max_rlimit(void); |
106 | ||
be3245e2 QM |
107 | int mount_tracefs(const char *target); |
108 | ||
d53dee3f AN |
109 | struct obj_refs_table { |
110 | DECLARE_HASHTABLE(table, 16); | |
111 | }; | |
112 | ||
113 | struct obj_ref { | |
114 | int pid; | |
115 | char comm[16]; | |
116 | }; | |
117 | ||
118 | struct obj_refs { | |
119 | struct hlist_node node; | |
120 | __u32 id; | |
121 | int ref_cnt; | |
122 | struct obj_ref *refs; | |
123 | }; | |
124 | ||
b053b439 MKL |
125 | struct btf; |
126 | struct bpf_line_info; | |
127 | ||
8f184732 | 128 | int build_pinned_obj_table(struct hashmap *table, |
4990f1f4 | 129 | enum bpf_obj_type type); |
8f184732 | 130 | void delete_pinned_obj_table(struct hashmap *table); |
d53dee3f AN |
131 | __weak int build_obj_refs_table(struct obj_refs_table *table, |
132 | enum bpf_obj_type type); | |
133 | __weak void delete_obj_refs_table(struct obj_refs_table *table); | |
134 | __weak void emit_obj_refs_json(struct obj_refs_table *table, __u32 id, | |
135 | json_writer_t *json_wtr); | |
136 | __weak void emit_obj_refs_plain(struct obj_refs_table *table, __u32 id, | |
137 | const char *prefix); | |
52262210 JK |
138 | void print_dev_plain(__u32 ifindex, __u64 ns_dev, __u64 ns_inode); |
139 | void print_dev_json(__u32 ifindex, __u64 ns_dev, __u64 ns_inode); | |
4990f1f4 | 140 | |
71bb428f JK |
141 | struct cmd { |
142 | const char *cmd; | |
143 | int (*func)(int argc, char **argv); | |
144 | }; | |
145 | ||
146 | int cmd_select(const struct cmd *cmds, int argc, char **argv, | |
147 | int (*help)(int argc, char **argv)); | |
148 | ||
149 | int get_fd_type(int fd); | |
150 | const char *get_fd_type_name(enum bpf_obj_type type); | |
151 | char *get_fdinfo(int fd, const char *key); | |
9165e1d7 TA |
152 | int open_obj_pinned(const char *path, bool quiet); |
153 | int open_obj_pinned_any(const char *path, enum bpf_obj_type exp_type); | |
77380998 | 154 | int mount_bpffs_for_pin(const char *name); |
75a1e792 | 155 | int do_pin_any(int argc, char **argv, int (*get_fd_by_id)(int *, char ***)); |
49a086c2 | 156 | int do_pin_fd(int fd, const char *name); |
71bb428f | 157 | |
16e9b187 | 158 | /* commands available in bootstrap mode */ |
985ead41 | 159 | int do_gen(int argc, char **argv); |
16e9b187 AN |
160 | int do_btf(int argc, char **argv); |
161 | ||
162 | /* non-bootstrap only commands */ | |
163 | int do_prog(int argc, char **arg) __weak; | |
164 | int do_map(int argc, char **arg) __weak; | |
165 | int do_link(int argc, char **arg) __weak; | |
166 | int do_event_pipe(int argc, char **argv) __weak; | |
167 | int do_cgroup(int argc, char **arg) __weak; | |
168 | int do_perf(int argc, char **arg) __weak; | |
169 | int do_net(int argc, char **arg) __weak; | |
170 | int do_tracelog(int argc, char **arg) __weak; | |
171 | int do_feature(int argc, char **argv) __weak; | |
172 | int do_struct_ops(int argc, char **argv) __weak; | |
173 | int do_iter(int argc, char **argv) __weak; | |
71bb428f | 174 | |
0b592b5a | 175 | int parse_u32_arg(int *argc, char ***argv, __u32 *val, const char *what); |
71bb428f | 176 | int prog_parse_fd(int *argc, char ***argv); |
a479b8ce | 177 | int prog_parse_fds(int *argc, char ***argv, int **fds); |
3ff5a4dc | 178 | int map_parse_fd(int *argc, char ***argv); |
a479b8ce | 179 | int map_parse_fds(int *argc, char ***argv, int **fds); |
f412eed9 | 180 | int map_parse_fd_and_info(int *argc, char ***argv, void *info, __u32 *info_len); |
71bb428f | 181 | |
b053b439 | 182 | struct bpf_prog_linfo; |
8c03ecf7 | 183 | #ifdef HAVE_LIBBFD_SUPPORT |
e6593596 | 184 | void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes, |
b053b439 MKL |
185 | const char *arch, const char *disassembler_options, |
186 | const struct btf *btf, | |
187 | const struct bpf_prog_linfo *prog_linfo, | |
188 | __u64 func_ksym, unsigned int func_idx, | |
189 | bool linum); | |
29a9c10e SF |
190 | int disasm_init(void); |
191 | #else | |
192 | static inline | |
193 | void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes, | |
b053b439 MKL |
194 | const char *arch, const char *disassembler_options, |
195 | const struct btf *btf, | |
196 | const struct bpf_prog_linfo *prog_linfo, | |
197 | __u64 func_ksym, unsigned int func_idx, | |
198 | bool linum) | |
29a9c10e SF |
199 | { |
200 | } | |
201 | static inline int disasm_init(void) | |
202 | { | |
203 | p_err("No libbfd support"); | |
204 | return -1; | |
205 | } | |
206 | #endif | |
f412eed9 | 207 | void print_data_json(uint8_t *data, size_t len); |
f05e2c32 | 208 | void print_hex_data_json(uint8_t *data, size_t len); |
71bb428f | 209 | |
f412eed9 | 210 | unsigned int get_page_size(void); |
e64d5256 | 211 | unsigned int get_possible_cpus(void); |
3ddeac67 JK |
212 | const char * |
213 | ifindex_to_bfd_params(__u32 ifindex, __u64 ns_dev, __u64 ns_ino, | |
214 | const char **opt); | |
e6593596 | 215 | |
b12d6ec0 OK |
216 | struct btf_dumper { |
217 | const struct btf *btf; | |
218 | json_writer_t *jw; | |
219 | bool is_plain_text; | |
d5ae04da | 220 | bool prog_id_as_func_ptr; |
b12d6ec0 OK |
221 | }; |
222 | ||
223 | /* btf_dumper_type - print data along with type information | |
224 | * @d: an instance containing context for dumping types | |
225 | * @type_id: index in btf->types array. this points to the type to be dumped | |
226 | * @data: pointer the actual data, i.e. the values to be printed | |
227 | * | |
228 | * Returns zero on success and negative error code otherwise | |
229 | */ | |
230 | int btf_dumper_type(const struct btf_dumper *d, __u32 type_id, | |
231 | const void *data); | |
254471e5 YS |
232 | void btf_dumper_type_only(const struct btf *btf, __u32 func_type_id, |
233 | char *func_only, int size); | |
f6f3bac0 | 234 | |
b053b439 MKL |
235 | void btf_dump_linfo_plain(const struct btf *btf, |
236 | const struct bpf_line_info *linfo, | |
237 | const char *prefix, bool linum); | |
238 | void btf_dump_linfo_json(const struct btf *btf, | |
239 | const struct bpf_line_info *linfo, bool linum); | |
240 | ||
f6f3bac0 YS |
241 | struct nlattr; |
242 | struct ifinfomsg; | |
243 | struct tcmsg; | |
244 | int do_xdp_dump(struct ifinfomsg *ifinfo, struct nlattr **tb); | |
7900efc1 YS |
245 | int do_filter_dump(struct tcmsg *ifinfo, struct nlattr **tb, const char *kind, |
246 | const char *devname, int ifindex); | |
6ae32b29 QM |
247 | |
248 | int print_all_levels(__maybe_unused enum libbpf_print_level level, | |
249 | const char *format, va_list args); | |
8f184732 QM |
250 | |
251 | size_t hash_fn_for_key_as_id(const void *key, void *ctx); | |
252 | bool equal_fn_for_key_as_id(const void *k1, const void *k2, void *ctx); | |
253 | ||
254 | static inline void *u32_as_hash_field(__u32 x) | |
255 | { | |
256 | return (void *)(uintptr_t)x; | |
257 | } | |
258 | ||
2828d0d7 QM |
259 | static inline __u32 hash_field_as_u32(const void *x) |
260 | { | |
261 | return (__u32)(uintptr_t)x; | |
262 | } | |
263 | ||
8f184732 QM |
264 | static inline bool hashmap__empty(struct hashmap *map) |
265 | { | |
266 | return map ? hashmap__size(map) == 0 : true; | |
267 | } | |
268 | ||
71bb428f | 269 | #endif |