1 /* 2 * Copyright (C) 2017-2018 Netronome Systems, Inc. 3 * 4 * This software is dual licensed under the GNU General License Version 2, 5 * June 1991 as shown in the file COPYING in the top-level directory of this 6 * source tree or the BSD 2-Clause License provided below. You have the 7 * option to license this software under the complete terms of either license. 8 * 9 * The BSD 2-Clause License: 10 * 11 * Redistribution and use in source and binary forms, with or 12 * without modification, are permitted provided that the following 13 * conditions are met: 14 * 15 * 1. Redistributions of source code must retain the above 16 * copyright notice, this list of conditions and the following 17 * disclaimer. 18 * 19 * 2. Redistributions in binary form must reproduce the above 20 * copyright notice, this list of conditions and the following 21 * disclaimer in the documentation and/or other materials 22 * provided with the distribution. 23 * 24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 31 * SOFTWARE. 32 */ 33 34 #ifndef __BPF_TOOL_H 35 #define __BPF_TOOL_H 36 37 /* BFD and kernel.h both define GCC_VERSION, differently */ 38 #undef GCC_VERSION 39 #include <stdbool.h> 40 #include <stdio.h> 41 #include <linux/bpf.h> 42 #include <linux/compiler.h> 43 #include <linux/kernel.h> 44 #include <linux/hashtable.h> 45 #include <tools/libc_compat.h> 46 47 #include "json_writer.h" 48 49 #define ptr_to_u64(ptr) ((__u64)(unsigned long)(ptr)) 50 51 #define NEXT_ARG() ({ argc--; argv++; if (argc < 0) usage(); }) 52 #define NEXT_ARGP() ({ (*argc)--; (*argv)++; if (*argc < 0) usage(); }) 53 #define BAD_ARG() ({ p_err("what is '%s'?", *argv); -1; }) 54 #define GET_ARG() ({ argc--; *argv++; }) 55 #define REQ_ARGS(cnt) \ 56 ({ \ 57 int _cnt = (cnt); \ 58 bool _res; \ 59 \ 60 if (argc < _cnt) { \ 61 p_err("'%s' needs at least %d arguments, %d found", \ 62 argv[-1], _cnt, argc); \ 63 _res = false; \ 64 } else { \ 65 _res = true; \ 66 } \ 67 _res; \ 68 }) 69 70 #define ERR_MAX_LEN 1024 71 72 #define BPF_TAG_FMT "%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx" 73 74 #define HELP_SPEC_PROGRAM \ 75 "PROG := { id PROG_ID | pinned FILE | tag PROG_TAG }" 76 #define HELP_SPEC_OPTIONS \ 77 "OPTIONS := { {-j|--json} [{-p|--pretty}] | {-f|--bpffs} | {-m|--mapcompat}" 78 #define HELP_SPEC_MAP \ 79 "MAP := { id MAP_ID | pinned FILE }" 80 81 static const char * const prog_type_name[] = { 82 [BPF_PROG_TYPE_UNSPEC] = "unspec", 83 [BPF_PROG_TYPE_SOCKET_FILTER] = "socket_filter", 84 [BPF_PROG_TYPE_KPROBE] = "kprobe", 85 [BPF_PROG_TYPE_SCHED_CLS] = "sched_cls", 86 [BPF_PROG_TYPE_SCHED_ACT] = "sched_act", 87 [BPF_PROG_TYPE_TRACEPOINT] = "tracepoint", 88 [BPF_PROG_TYPE_XDP] = "xdp", 89 [BPF_PROG_TYPE_PERF_EVENT] = "perf_event", 90 [BPF_PROG_TYPE_CGROUP_SKB] = "cgroup_skb", 91 [BPF_PROG_TYPE_CGROUP_SOCK] = "cgroup_sock", 92 [BPF_PROG_TYPE_LWT_IN] = "lwt_in", 93 [BPF_PROG_TYPE_LWT_OUT] = "lwt_out", 94 [BPF_PROG_TYPE_LWT_XMIT] = "lwt_xmit", 95 [BPF_PROG_TYPE_SOCK_OPS] = "sock_ops", 96 [BPF_PROG_TYPE_SK_SKB] = "sk_skb", 97 [BPF_PROG_TYPE_CGROUP_DEVICE] = "cgroup_device", 98 [BPF_PROG_TYPE_SK_MSG] = "sk_msg", 99 [BPF_PROG_TYPE_RAW_TRACEPOINT] = "raw_tracepoint", 100 [BPF_PROG_TYPE_CGROUP_SOCK_ADDR] = "cgroup_sock_addr", 101 [BPF_PROG_TYPE_LWT_SEG6LOCAL] = "lwt_seg6local", 102 [BPF_PROG_TYPE_LIRC_MODE2] = "lirc_mode2", 103 [BPF_PROG_TYPE_SK_REUSEPORT] = "sk_reuseport", 104 [BPF_PROG_TYPE_FLOW_DISSECTOR] = "flow_dissector", 105 }; 106 107 enum bpf_obj_type { 108 BPF_OBJ_UNKNOWN, 109 BPF_OBJ_PROG, 110 BPF_OBJ_MAP, 111 }; 112 113 extern const char *bin_name; 114 115 extern json_writer_t *json_wtr; 116 extern bool json_output; 117 extern bool show_pinned; 118 extern int bpf_flags; 119 extern struct pinned_obj_table prog_table; 120 extern struct pinned_obj_table map_table; 121 122 void p_err(const char *fmt, ...); 123 void p_info(const char *fmt, ...); 124 125 bool is_prefix(const char *pfx, const char *str); 126 void fprint_hex(FILE *f, void *arg, unsigned int n, const char *sep); 127 void usage(void) __noreturn; 128 129 void set_max_rlimit(void); 130 131 struct pinned_obj_table { 132 DECLARE_HASHTABLE(table, 16); 133 }; 134 135 struct pinned_obj { 136 __u32 id; 137 char *path; 138 struct hlist_node hash; 139 }; 140 141 int build_pinned_obj_table(struct pinned_obj_table *table, 142 enum bpf_obj_type type); 143 void delete_pinned_obj_table(struct pinned_obj_table *tab); 144 void print_dev_plain(__u32 ifindex, __u64 ns_dev, __u64 ns_inode); 145 void print_dev_json(__u32 ifindex, __u64 ns_dev, __u64 ns_inode); 146 147 struct cmd { 148 const char *cmd; 149 int (*func)(int argc, char **argv); 150 }; 151 152 int cmd_select(const struct cmd *cmds, int argc, char **argv, 153 int (*help)(int argc, char **argv)); 154 155 int get_fd_type(int fd); 156 const char *get_fd_type_name(enum bpf_obj_type type); 157 char *get_fdinfo(int fd, const char *key); 158 int open_obj_pinned(char *path, bool quiet); 159 int open_obj_pinned_any(char *path, enum bpf_obj_type exp_type); 160 int mount_bpffs_for_pin(const char *name); 161 int do_pin_any(int argc, char **argv, int (*get_fd_by_id)(__u32)); 162 int do_pin_fd(int fd, const char *name); 163 164 int do_prog(int argc, char **arg); 165 int do_map(int argc, char **arg); 166 int do_event_pipe(int argc, char **argv); 167 int do_cgroup(int argc, char **arg); 168 int do_perf(int argc, char **arg); 169 int do_net(int argc, char **arg); 170 int do_tracelog(int argc, char **arg); 171 172 int parse_u32_arg(int *argc, char ***argv, __u32 *val, const char *what); 173 int prog_parse_fd(int *argc, char ***argv); 174 int map_parse_fd(int *argc, char ***argv); 175 int map_parse_fd_and_info(int *argc, char ***argv, void *info, __u32 *info_len); 176 177 #ifdef HAVE_LIBBFD_SUPPORT 178 void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes, 179 const char *arch, const char *disassembler_options); 180 int disasm_init(void); 181 #else 182 static inline 183 void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes, 184 const char *arch, const char *disassembler_options) 185 { 186 } 187 static inline int disasm_init(void) 188 { 189 p_err("No libbfd support"); 190 return -1; 191 } 192 #endif 193 void print_data_json(uint8_t *data, size_t len); 194 void print_hex_data_json(uint8_t *data, size_t len); 195 196 unsigned int get_page_size(void); 197 unsigned int get_possible_cpus(void); 198 const char * 199 ifindex_to_bfd_params(__u32 ifindex, __u64 ns_dev, __u64 ns_ino, 200 const char **opt); 201 202 struct btf_dumper { 203 const struct btf *btf; 204 json_writer_t *jw; 205 bool is_plain_text; 206 }; 207 208 /* btf_dumper_type - print data along with type information 209 * @d: an instance containing context for dumping types 210 * @type_id: index in btf->types array. this points to the type to be dumped 211 * @data: pointer the actual data, i.e. the values to be printed 212 * 213 * Returns zero on success and negative error code otherwise 214 */ 215 int btf_dumper_type(const struct btf_dumper *d, __u32 type_id, 216 const void *data); 217 void btf_dumper_type_only(const struct btf *btf, __u32 func_type_id, 218 char *func_only, int size); 219 220 struct nlattr; 221 struct ifinfomsg; 222 struct tcmsg; 223 int do_xdp_dump(struct ifinfomsg *ifinfo, struct nlattr **tb); 224 int do_filter_dump(struct tcmsg *ifinfo, struct nlattr **tb, const char *kind, 225 const char *devname, int ifindex); 226 #endif 227