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 "json_writer.h" 18 19 #define ptr_to_u64(ptr) ((__u64)(unsigned long)(ptr)) 20 21 #define NEXT_ARG() ({ argc--; argv++; if (argc < 0) usage(); }) 22 #define NEXT_ARGP() ({ (*argc)--; (*argv)++; if (*argc < 0) usage(); }) 23 #define BAD_ARG() ({ p_err("what is '%s'?", *argv); -1; }) 24 #define GET_ARG() ({ argc--; *argv++; }) 25 #define REQ_ARGS(cnt) \ 26 ({ \ 27 int _cnt = (cnt); \ 28 bool _res; \ 29 \ 30 if (argc < _cnt) { \ 31 p_err("'%s' needs at least %d arguments, %d found", \ 32 argv[-1], _cnt, argc); \ 33 _res = false; \ 34 } else { \ 35 _res = true; \ 36 } \ 37 _res; \ 38 }) 39 40 #define ERR_MAX_LEN 1024 41 42 #define BPF_TAG_FMT "%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx" 43 44 #define HELP_SPEC_PROGRAM \ 45 "PROG := { id PROG_ID | pinned FILE | tag PROG_TAG }" 46 #define HELP_SPEC_OPTIONS \ 47 "OPTIONS := { {-j|--json} [{-p|--pretty}] | {-f|--bpffs} |\n" \ 48 "\t {-m|--mapcompat} | {-n|--nomount} }" 49 #define HELP_SPEC_MAP \ 50 "MAP := { id MAP_ID | pinned FILE }" 51 52 static const char * const prog_type_name[] = { 53 [BPF_PROG_TYPE_UNSPEC] = "unspec", 54 [BPF_PROG_TYPE_SOCKET_FILTER] = "socket_filter", 55 [BPF_PROG_TYPE_KPROBE] = "kprobe", 56 [BPF_PROG_TYPE_SCHED_CLS] = "sched_cls", 57 [BPF_PROG_TYPE_SCHED_ACT] = "sched_act", 58 [BPF_PROG_TYPE_TRACEPOINT] = "tracepoint", 59 [BPF_PROG_TYPE_XDP] = "xdp", 60 [BPF_PROG_TYPE_PERF_EVENT] = "perf_event", 61 [BPF_PROG_TYPE_CGROUP_SKB] = "cgroup_skb", 62 [BPF_PROG_TYPE_CGROUP_SOCK] = "cgroup_sock", 63 [BPF_PROG_TYPE_LWT_IN] = "lwt_in", 64 [BPF_PROG_TYPE_LWT_OUT] = "lwt_out", 65 [BPF_PROG_TYPE_LWT_XMIT] = "lwt_xmit", 66 [BPF_PROG_TYPE_SOCK_OPS] = "sock_ops", 67 [BPF_PROG_TYPE_SK_SKB] = "sk_skb", 68 [BPF_PROG_TYPE_CGROUP_DEVICE] = "cgroup_device", 69 [BPF_PROG_TYPE_SK_MSG] = "sk_msg", 70 [BPF_PROG_TYPE_RAW_TRACEPOINT] = "raw_tracepoint", 71 [BPF_PROG_TYPE_CGROUP_SOCK_ADDR] = "cgroup_sock_addr", 72 [BPF_PROG_TYPE_LWT_SEG6LOCAL] = "lwt_seg6local", 73 [BPF_PROG_TYPE_LIRC_MODE2] = "lirc_mode2", 74 [BPF_PROG_TYPE_SK_REUSEPORT] = "sk_reuseport", 75 [BPF_PROG_TYPE_FLOW_DISSECTOR] = "flow_dissector", 76 [BPF_PROG_TYPE_CGROUP_SYSCTL] = "cgroup_sysctl", 77 [BPF_PROG_TYPE_CGROUP_SOCKOPT] = "cgroup_sockopt", 78 }; 79 80 extern const char * const map_type_name[]; 81 extern const size_t map_type_name_size; 82 83 enum bpf_obj_type { 84 BPF_OBJ_UNKNOWN, 85 BPF_OBJ_PROG, 86 BPF_OBJ_MAP, 87 }; 88 89 extern const char *bin_name; 90 91 extern json_writer_t *json_wtr; 92 extern bool json_output; 93 extern bool show_pinned; 94 extern bool block_mount; 95 extern bool verifier_logs; 96 extern int bpf_flags; 97 extern struct pinned_obj_table prog_table; 98 extern struct pinned_obj_table map_table; 99 100 void p_err(const char *fmt, ...); 101 void p_info(const char *fmt, ...); 102 103 bool is_prefix(const char *pfx, const char *str); 104 int detect_common_prefix(const char *arg, ...); 105 void fprint_hex(FILE *f, void *arg, unsigned int n, const char *sep); 106 void usage(void) __noreturn; 107 108 void set_max_rlimit(void); 109 110 int mount_tracefs(const char *target); 111 112 struct pinned_obj_table { 113 DECLARE_HASHTABLE(table, 16); 114 }; 115 116 struct pinned_obj { 117 __u32 id; 118 char *path; 119 struct hlist_node hash; 120 }; 121 122 struct btf; 123 struct bpf_line_info; 124 125 int build_pinned_obj_table(struct pinned_obj_table *table, 126 enum bpf_obj_type type); 127 void delete_pinned_obj_table(struct pinned_obj_table *tab); 128 void print_dev_plain(__u32 ifindex, __u64 ns_dev, __u64 ns_inode); 129 void print_dev_json(__u32 ifindex, __u64 ns_dev, __u64 ns_inode); 130 131 struct cmd { 132 const char *cmd; 133 int (*func)(int argc, char **argv); 134 }; 135 136 int cmd_select(const struct cmd *cmds, int argc, char **argv, 137 int (*help)(int argc, char **argv)); 138 139 int get_fd_type(int fd); 140 const char *get_fd_type_name(enum bpf_obj_type type); 141 char *get_fdinfo(int fd, const char *key); 142 int open_obj_pinned(char *path, bool quiet); 143 int open_obj_pinned_any(char *path, enum bpf_obj_type exp_type); 144 int mount_bpffs_for_pin(const char *name); 145 int do_pin_any(int argc, char **argv, int (*get_fd_by_id)(__u32)); 146 int do_pin_fd(int fd, const char *name); 147 148 int do_prog(int argc, char **arg); 149 int do_map(int argc, char **arg); 150 int do_event_pipe(int argc, char **argv); 151 int do_cgroup(int argc, char **arg); 152 int do_perf(int argc, char **arg); 153 int do_net(int argc, char **arg); 154 int do_tracelog(int argc, char **arg); 155 int do_feature(int argc, char **argv); 156 int do_btf(int argc, char **argv); 157 158 int parse_u32_arg(int *argc, char ***argv, __u32 *val, const char *what); 159 int prog_parse_fd(int *argc, char ***argv); 160 int map_parse_fd(int *argc, char ***argv); 161 int map_parse_fd_and_info(int *argc, char ***argv, void *info, __u32 *info_len); 162 163 struct bpf_prog_linfo; 164 #ifdef HAVE_LIBBFD_SUPPORT 165 void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes, 166 const char *arch, const char *disassembler_options, 167 const struct btf *btf, 168 const struct bpf_prog_linfo *prog_linfo, 169 __u64 func_ksym, unsigned int func_idx, 170 bool linum); 171 int disasm_init(void); 172 #else 173 static inline 174 void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes, 175 const char *arch, const char *disassembler_options, 176 const struct btf *btf, 177 const struct bpf_prog_linfo *prog_linfo, 178 __u64 func_ksym, unsigned int func_idx, 179 bool linum) 180 { 181 } 182 static inline int disasm_init(void) 183 { 184 p_err("No libbfd support"); 185 return -1; 186 } 187 #endif 188 void print_data_json(uint8_t *data, size_t len); 189 void print_hex_data_json(uint8_t *data, size_t len); 190 191 unsigned int get_page_size(void); 192 unsigned int get_possible_cpus(void); 193 const char * 194 ifindex_to_bfd_params(__u32 ifindex, __u64 ns_dev, __u64 ns_ino, 195 const char **opt); 196 197 struct btf_dumper { 198 const struct btf *btf; 199 json_writer_t *jw; 200 bool is_plain_text; 201 }; 202 203 /* btf_dumper_type - print data along with type information 204 * @d: an instance containing context for dumping types 205 * @type_id: index in btf->types array. this points to the type to be dumped 206 * @data: pointer the actual data, i.e. the values to be printed 207 * 208 * Returns zero on success and negative error code otherwise 209 */ 210 int btf_dumper_type(const struct btf_dumper *d, __u32 type_id, 211 const void *data); 212 void btf_dumper_type_only(const struct btf *btf, __u32 func_type_id, 213 char *func_only, int size); 214 215 void btf_dump_linfo_plain(const struct btf *btf, 216 const struct bpf_line_info *linfo, 217 const char *prefix, bool linum); 218 void btf_dump_linfo_json(const struct btf *btf, 219 const struct bpf_line_info *linfo, bool linum); 220 221 struct nlattr; 222 struct ifinfomsg; 223 struct tcmsg; 224 int do_xdp_dump(struct ifinfomsg *ifinfo, struct nlattr **tb); 225 int do_filter_dump(struct tcmsg *ifinfo, struct nlattr **tb, const char *kind, 226 const char *devname, int ifindex); 227 #endif 228