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 static const char * const prog_type_name[] = { 60 [BPF_PROG_TYPE_UNSPEC] = "unspec", 61 [BPF_PROG_TYPE_SOCKET_FILTER] = "socket_filter", 62 [BPF_PROG_TYPE_KPROBE] = "kprobe", 63 [BPF_PROG_TYPE_SCHED_CLS] = "sched_cls", 64 [BPF_PROG_TYPE_SCHED_ACT] = "sched_act", 65 [BPF_PROG_TYPE_TRACEPOINT] = "tracepoint", 66 [BPF_PROG_TYPE_XDP] = "xdp", 67 [BPF_PROG_TYPE_PERF_EVENT] = "perf_event", 68 [BPF_PROG_TYPE_CGROUP_SKB] = "cgroup_skb", 69 [BPF_PROG_TYPE_CGROUP_SOCK] = "cgroup_sock", 70 [BPF_PROG_TYPE_LWT_IN] = "lwt_in", 71 [BPF_PROG_TYPE_LWT_OUT] = "lwt_out", 72 [BPF_PROG_TYPE_LWT_XMIT] = "lwt_xmit", 73 [BPF_PROG_TYPE_SOCK_OPS] = "sock_ops", 74 [BPF_PROG_TYPE_SK_SKB] = "sk_skb", 75 [BPF_PROG_TYPE_CGROUP_DEVICE] = "cgroup_device", 76 [BPF_PROG_TYPE_SK_MSG] = "sk_msg", 77 [BPF_PROG_TYPE_RAW_TRACEPOINT] = "raw_tracepoint", 78 [BPF_PROG_TYPE_CGROUP_SOCK_ADDR] = "cgroup_sock_addr", 79 [BPF_PROG_TYPE_LWT_SEG6LOCAL] = "lwt_seg6local", 80 [BPF_PROG_TYPE_LIRC_MODE2] = "lirc_mode2", 81 [BPF_PROG_TYPE_SK_REUSEPORT] = "sk_reuseport", 82 [BPF_PROG_TYPE_FLOW_DISSECTOR] = "flow_dissector", 83 [BPF_PROG_TYPE_CGROUP_SYSCTL] = "cgroup_sysctl", 84 [BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE] = "raw_tracepoint_writable", 85 [BPF_PROG_TYPE_CGROUP_SOCKOPT] = "cgroup_sockopt", 86 [BPF_PROG_TYPE_TRACING] = "tracing", 87 [BPF_PROG_TYPE_STRUCT_OPS] = "struct_ops", 88 [BPF_PROG_TYPE_EXT] = "ext", 89 }; 90 91 static const char * const attach_type_name[__MAX_BPF_ATTACH_TYPE] = { 92 [BPF_CGROUP_INET_INGRESS] = "ingress", 93 [BPF_CGROUP_INET_EGRESS] = "egress", 94 [BPF_CGROUP_INET_SOCK_CREATE] = "sock_create", 95 [BPF_CGROUP_SOCK_OPS] = "sock_ops", 96 [BPF_CGROUP_DEVICE] = "device", 97 [BPF_CGROUP_INET4_BIND] = "bind4", 98 [BPF_CGROUP_INET6_BIND] = "bind6", 99 [BPF_CGROUP_INET4_CONNECT] = "connect4", 100 [BPF_CGROUP_INET6_CONNECT] = "connect6", 101 [BPF_CGROUP_INET4_POST_BIND] = "post_bind4", 102 [BPF_CGROUP_INET6_POST_BIND] = "post_bind6", 103 [BPF_CGROUP_INET4_GETPEERNAME] = "getpeername4", 104 [BPF_CGROUP_INET6_GETPEERNAME] = "getpeername6", 105 [BPF_CGROUP_INET4_GETSOCKNAME] = "getsockname4", 106 [BPF_CGROUP_INET6_GETSOCKNAME] = "getsockname6", 107 [BPF_CGROUP_UDP4_SENDMSG] = "sendmsg4", 108 [BPF_CGROUP_UDP6_SENDMSG] = "sendmsg6", 109 [BPF_CGROUP_SYSCTL] = "sysctl", 110 [BPF_CGROUP_UDP4_RECVMSG] = "recvmsg4", 111 [BPF_CGROUP_UDP6_RECVMSG] = "recvmsg6", 112 [BPF_CGROUP_GETSOCKOPT] = "getsockopt", 113 [BPF_CGROUP_SETSOCKOPT] = "setsockopt", 114 115 [BPF_SK_SKB_STREAM_PARSER] = "sk_skb_stream_parser", 116 [BPF_SK_SKB_STREAM_VERDICT] = "sk_skb_stream_verdict", 117 [BPF_SK_MSG_VERDICT] = "sk_msg_verdict", 118 [BPF_LIRC_MODE2] = "lirc_mode2", 119 [BPF_FLOW_DISSECTOR] = "flow_dissector", 120 [BPF_TRACE_RAW_TP] = "raw_tp", 121 [BPF_TRACE_FENTRY] = "fentry", 122 [BPF_TRACE_FEXIT] = "fexit", 123 [BPF_MODIFY_RETURN] = "mod_ret", 124 [BPF_LSM_MAC] = "lsm_mac", 125 }; 126 127 extern const char * const map_type_name[]; 128 extern const size_t map_type_name_size; 129 130 enum bpf_obj_type { 131 BPF_OBJ_UNKNOWN, 132 BPF_OBJ_PROG, 133 BPF_OBJ_MAP, 134 BPF_OBJ_LINK, 135 }; 136 137 extern const char *bin_name; 138 139 extern json_writer_t *json_wtr; 140 extern bool json_output; 141 extern bool show_pinned; 142 extern bool block_mount; 143 extern bool verifier_logs; 144 extern bool relaxed_maps; 145 extern struct pinned_obj_table prog_table; 146 extern struct pinned_obj_table map_table; 147 extern struct pinned_obj_table link_table; 148 149 void __printf(1, 2) p_err(const char *fmt, ...); 150 void __printf(1, 2) p_info(const char *fmt, ...); 151 152 bool is_prefix(const char *pfx, const char *str); 153 int detect_common_prefix(const char *arg, ...); 154 void fprint_hex(FILE *f, void *arg, unsigned int n, const char *sep); 155 void usage(void) __noreturn; 156 157 void set_max_rlimit(void); 158 159 int mount_tracefs(const char *target); 160 161 struct pinned_obj_table { 162 DECLARE_HASHTABLE(table, 16); 163 }; 164 165 struct pinned_obj { 166 __u32 id; 167 char *path; 168 struct hlist_node hash; 169 }; 170 171 struct btf; 172 struct bpf_line_info; 173 174 int build_pinned_obj_table(struct pinned_obj_table *table, 175 enum bpf_obj_type type); 176 void delete_pinned_obj_table(struct pinned_obj_table *tab); 177 void print_dev_plain(__u32 ifindex, __u64 ns_dev, __u64 ns_inode); 178 void print_dev_json(__u32 ifindex, __u64 ns_dev, __u64 ns_inode); 179 180 struct cmd { 181 const char *cmd; 182 int (*func)(int argc, char **argv); 183 }; 184 185 int cmd_select(const struct cmd *cmds, int argc, char **argv, 186 int (*help)(int argc, char **argv)); 187 188 int get_fd_type(int fd); 189 const char *get_fd_type_name(enum bpf_obj_type type); 190 char *get_fdinfo(int fd, const char *key); 191 int open_obj_pinned(char *path, bool quiet); 192 int open_obj_pinned_any(char *path, enum bpf_obj_type exp_type); 193 int mount_bpffs_for_pin(const char *name); 194 int do_pin_any(int argc, char **argv, int (*get_fd_by_id)(int *, char ***)); 195 int do_pin_fd(int fd, const char *name); 196 197 int do_prog(int argc, char **arg); 198 int do_map(int argc, char **arg); 199 int do_link(int argc, char **arg); 200 int do_event_pipe(int argc, char **argv); 201 int do_cgroup(int argc, char **arg); 202 int do_perf(int argc, char **arg); 203 int do_net(int argc, char **arg); 204 int do_tracelog(int argc, char **arg); 205 int do_feature(int argc, char **argv); 206 int do_btf(int argc, char **argv); 207 int do_gen(int argc, char **argv); 208 int do_struct_ops(int argc, char **argv); 209 int do_iter(int argc, char **argv); 210 211 int parse_u32_arg(int *argc, char ***argv, __u32 *val, const char *what); 212 int prog_parse_fd(int *argc, char ***argv); 213 int map_parse_fd(int *argc, char ***argv); 214 int map_parse_fd_and_info(int *argc, char ***argv, void *info, __u32 *info_len); 215 216 struct bpf_prog_linfo; 217 #ifdef HAVE_LIBBFD_SUPPORT 218 void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes, 219 const char *arch, const char *disassembler_options, 220 const struct btf *btf, 221 const struct bpf_prog_linfo *prog_linfo, 222 __u64 func_ksym, unsigned int func_idx, 223 bool linum); 224 int disasm_init(void); 225 #else 226 static inline 227 void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes, 228 const char *arch, const char *disassembler_options, 229 const struct btf *btf, 230 const struct bpf_prog_linfo *prog_linfo, 231 __u64 func_ksym, unsigned int func_idx, 232 bool linum) 233 { 234 } 235 static inline int disasm_init(void) 236 { 237 p_err("No libbfd support"); 238 return -1; 239 } 240 #endif 241 void print_data_json(uint8_t *data, size_t len); 242 void print_hex_data_json(uint8_t *data, size_t len); 243 244 unsigned int get_page_size(void); 245 unsigned int get_possible_cpus(void); 246 const char * 247 ifindex_to_bfd_params(__u32 ifindex, __u64 ns_dev, __u64 ns_ino, 248 const char **opt); 249 250 struct btf_dumper { 251 const struct btf *btf; 252 json_writer_t *jw; 253 bool is_plain_text; 254 bool prog_id_as_func_ptr; 255 }; 256 257 /* btf_dumper_type - print data along with type information 258 * @d: an instance containing context for dumping types 259 * @type_id: index in btf->types array. this points to the type to be dumped 260 * @data: pointer the actual data, i.e. the values to be printed 261 * 262 * Returns zero on success and negative error code otherwise 263 */ 264 int btf_dumper_type(const struct btf_dumper *d, __u32 type_id, 265 const void *data); 266 void btf_dumper_type_only(const struct btf *btf, __u32 func_type_id, 267 char *func_only, int size); 268 269 void btf_dump_linfo_plain(const struct btf *btf, 270 const struct bpf_line_info *linfo, 271 const char *prefix, bool linum); 272 void btf_dump_linfo_json(const struct btf *btf, 273 const struct bpf_line_info *linfo, bool linum); 274 275 struct nlattr; 276 struct ifinfomsg; 277 struct tcmsg; 278 int do_xdp_dump(struct ifinfomsg *ifinfo, struct nlattr **tb); 279 int do_filter_dump(struct tcmsg *ifinfo, struct nlattr **tb, const char *kind, 280 const char *devname, int ifindex); 281 282 int print_all_levels(__maybe_unused enum libbpf_print_level level, 283 const char *format, va_list args); 284 #endif 285