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