1
2
3
4#ifndef __BPF_TOOL_H
5#define __BPF_TOOL_H
6
7
8#undef GCC_VERSION
9#include <stdbool.h>
10#include <stdio.h>
11#include <linux/bpf.h>
12#include <linux/compiler.h>
13#include <linux/kernel.h>
14#include <linux/hashtable.h>
15#include <tools/libc_compat.h>
16
17#include <bpf/libbpf.h>
18
19#include "json_writer.h"
20
21
22#pragma GCC poison u8 u16 u32 u64 s8 s16 s32 s64
23
24static inline __u64 ptr_to_u64(const void *ptr)
25{
26 return (__u64)(unsigned long)ptr;
27}
28
29static inline void *u64_to_ptr(__u64 ptr)
30{
31 return (void *)(unsigned long)ptr;
32}
33
34#define NEXT_ARG() ({ argc--; argv++; if (argc < 0) usage(); })
35#define NEXT_ARGP() ({ (*argc)--; (*argv)++; if (*argc < 0) usage(); })
36#define BAD_ARG() ({ p_err("what is '%s'?", *argv); -1; })
37#define GET_ARG() ({ argc--; *argv++; })
38#define REQ_ARGS(cnt) \
39 ({ \
40 int _cnt = (cnt); \
41 bool _res; \
42 \
43 if (argc < _cnt) { \
44 p_err("'%s' needs at least %d arguments, %d found", \
45 argv[-1], _cnt, argc); \
46 _res = false; \
47 } else { \
48 _res = true; \
49 } \
50 _res; \
51 })
52
53#define ERR_MAX_LEN 1024
54
55#define BPF_TAG_FMT "%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx"
56
57#define HELP_SPEC_PROGRAM \
58 "PROG := { id PROG_ID | pinned FILE | tag PROG_TAG | name PROG_NAME }"
59#define HELP_SPEC_OPTIONS \
60 "OPTIONS := { {-j|--json} [{-p|--pretty}] | {-d|--debug}"
61#define HELP_SPEC_MAP \
62 "MAP := { id MAP_ID | pinned FILE | name MAP_NAME }"
63#define HELP_SPEC_LINK \
64 "LINK := { id LINK_ID | pinned FILE }"
65
66extern const char * const prog_type_name[];
67extern const size_t prog_type_name_size;
68
69extern const char * const attach_type_name[__MAX_BPF_ATTACH_TYPE];
70
71extern const char * const map_type_name[];
72extern const size_t map_type_name_size;
73
74
75enum bpf_obj_type {
76 BPF_OBJ_UNKNOWN,
77 BPF_OBJ_PROG,
78 BPF_OBJ_MAP,
79 BPF_OBJ_LINK,
80 BPF_OBJ_BTF,
81};
82
83extern const char *bin_name;
84
85extern json_writer_t *json_wtr;
86extern bool json_output;
87extern bool show_pinned;
88extern bool show_pids;
89extern bool block_mount;
90extern bool verifier_logs;
91extern bool relaxed_maps;
92extern bool use_loader;
93extern struct btf *base_btf;
94extern struct pinned_obj_table prog_table;
95extern struct pinned_obj_table map_table;
96extern struct pinned_obj_table link_table;
97extern struct obj_refs_table refs_table;
98
99void __printf(1, 2) p_err(const char *fmt, ...);
100void __printf(1, 2) p_info(const char *fmt, ...);
101
102bool is_prefix(const char *pfx, const char *str);
103int detect_common_prefix(const char *arg, ...);
104void fprint_hex(FILE *f, void *arg, unsigned int n, const char *sep);
105void usage(void) __noreturn;
106
107void set_max_rlimit(void);
108
109int mount_tracefs(const char *target);
110
111struct pinned_obj_table {
112 DECLARE_HASHTABLE(table, 16);
113};
114
115struct pinned_obj {
116 __u32 id;
117 char *path;
118 struct hlist_node hash;
119};
120
121struct obj_refs_table {
122 DECLARE_HASHTABLE(table, 16);
123};
124
125struct obj_ref {
126 int pid;
127 char comm[16];
128};
129
130struct obj_refs {
131 struct hlist_node node;
132 __u32 id;
133 int ref_cnt;
134 struct obj_ref *refs;
135};
136
137struct btf;
138struct bpf_line_info;
139
140int build_pinned_obj_table(struct pinned_obj_table *table,
141 enum bpf_obj_type type);
142void delete_pinned_obj_table(struct pinned_obj_table *tab);
143__weak int build_obj_refs_table(struct obj_refs_table *table,
144 enum bpf_obj_type type);
145__weak void delete_obj_refs_table(struct obj_refs_table *table);
146__weak void emit_obj_refs_json(struct obj_refs_table *table, __u32 id,
147 json_writer_t *json_wtr);
148__weak void emit_obj_refs_plain(struct obj_refs_table *table, __u32 id,
149 const char *prefix);
150void print_dev_plain(__u32 ifindex, __u64 ns_dev, __u64 ns_inode);
151void print_dev_json(__u32 ifindex, __u64 ns_dev, __u64 ns_inode);
152
153struct cmd {
154 const char *cmd;
155 int (*func)(int argc, char **argv);
156};
157
158int cmd_select(const struct cmd *cmds, int argc, char **argv,
159 int (*help)(int argc, char **argv));
160
161int get_fd_type(int fd);
162const char *get_fd_type_name(enum bpf_obj_type type);
163char *get_fdinfo(int fd, const char *key);
164int open_obj_pinned(const char *path, bool quiet);
165int open_obj_pinned_any(const char *path, enum bpf_obj_type exp_type);
166int mount_bpffs_for_pin(const char *name);
167int do_pin_any(int argc, char **argv, int (*get_fd_by_id)(int *, char ***));
168int do_pin_fd(int fd, const char *name);
169
170
171int do_gen(int argc, char **argv);
172int do_btf(int argc, char **argv);
173
174
175int do_prog(int argc, char **arg) __weak;
176int do_map(int argc, char **arg) __weak;
177int do_link(int argc, char **arg) __weak;
178int do_event_pipe(int argc, char **argv) __weak;
179int do_cgroup(int argc, char **arg) __weak;
180int do_perf(int argc, char **arg) __weak;
181int do_net(int argc, char **arg) __weak;
182int do_tracelog(int argc, char **arg) __weak;
183int do_feature(int argc, char **argv) __weak;
184int do_struct_ops(int argc, char **argv) __weak;
185int do_iter(int argc, char **argv) __weak;
186
187int parse_u32_arg(int *argc, char ***argv, __u32 *val, const char *what);
188int prog_parse_fd(int *argc, char ***argv);
189int prog_parse_fds(int *argc, char ***argv, int **fds);
190int map_parse_fd(int *argc, char ***argv);
191int map_parse_fds(int *argc, char ***argv, int **fds);
192int map_parse_fd_and_info(int *argc, char ***argv, void *info, __u32 *info_len);
193
194struct bpf_prog_linfo;
195#ifdef HAVE_LIBBFD_SUPPORT
196void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes,
197 const char *arch, const char *disassembler_options,
198 const struct btf *btf,
199 const struct bpf_prog_linfo *prog_linfo,
200 __u64 func_ksym, unsigned int func_idx,
201 bool linum);
202int disasm_init(void);
203#else
204static inline
205void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes,
206 const char *arch, const char *disassembler_options,
207 const struct btf *btf,
208 const struct bpf_prog_linfo *prog_linfo,
209 __u64 func_ksym, unsigned int func_idx,
210 bool linum)
211{
212}
213static inline int disasm_init(void)
214{
215 p_err("No libbfd support");
216 return -1;
217}
218#endif
219void print_data_json(uint8_t *data, size_t len);
220void print_hex_data_json(uint8_t *data, size_t len);
221
222unsigned int get_page_size(void);
223unsigned int get_possible_cpus(void);
224const char *
225ifindex_to_bfd_params(__u32 ifindex, __u64 ns_dev, __u64 ns_ino,
226 const char **opt);
227
228struct btf_dumper {
229 const struct btf *btf;
230 json_writer_t *jw;
231 bool is_plain_text;
232 bool prog_id_as_func_ptr;
233};
234
235
236
237
238
239
240
241
242int btf_dumper_type(const struct btf_dumper *d, __u32 type_id,
243 const void *data);
244void btf_dumper_type_only(const struct btf *btf, __u32 func_type_id,
245 char *func_only, int size);
246
247void btf_dump_linfo_plain(const struct btf *btf,
248 const struct bpf_line_info *linfo,
249 const char *prefix, bool linum);
250void btf_dump_linfo_json(const struct btf *btf,
251 const struct bpf_line_info *linfo, bool linum);
252
253struct nlattr;
254struct ifinfomsg;
255struct tcmsg;
256int do_xdp_dump(struct ifinfomsg *ifinfo, struct nlattr **tb);
257int do_filter_dump(struct tcmsg *ifinfo, struct nlattr **tb, const char *kind,
258 const char *devname, int ifindex);
259
260int print_all_levels(__maybe_unused enum libbpf_print_level level,
261 const char *format, va_list args);
262#endif
263
