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