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 <stdlib.h> 12 #include <linux/bpf.h> 13 #include <linux/compiler.h> 14 #include <linux/kernel.h> 15 16 #include <bpf/hashmap.h> 17 #include <bpf/libbpf.h> 18 #include <bpf/bpf.h> 19 20 #include "json_writer.h" 21 22 /* Make sure we do not use kernel-only integer typedefs */ 23 #pragma GCC poison u8 u16 u32 u64 s8 s16 s32 s64 24 25 static inline __u64 ptr_to_u64(const void *ptr) 26 { 27 return (__u64)(unsigned long)ptr; 28 } 29 30 static inline void *u64_to_ptr(__u64 ptr) 31 { 32 return (void *)(unsigned long)ptr; 33 } 34 35 #define NEXT_ARG() ({ argc--; argv++; if (argc < 0) usage(); }) 36 #define NEXT_ARGP() ({ (*argc)--; (*argv)++; if (*argc < 0) usage(); }) 37 #define BAD_ARG() ({ p_err("what is '%s'?", *argv); -1; }) 38 #define GET_ARG() ({ argc--; *argv++; }) 39 #define REQ_ARGS(cnt) \ 40 ({ \ 41 int _cnt = (cnt); \ 42 bool _res; \ 43 \ 44 if (argc < _cnt) { \ 45 p_err("'%s' needs at least %d arguments, %d found", \ 46 argv[-1], _cnt, argc); \ 47 _res = false; \ 48 } else { \ 49 _res = true; \ 50 } \ 51 _res; \ 52 }) 53 54 #define ERR_MAX_LEN 1024 55 56 #define BPF_TAG_FMT "%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx" 57 58 #define HELP_SPEC_PROGRAM \ 59 "PROG := { id PROG_ID | pinned FILE | tag PROG_TAG | name PROG_NAME }" 60 #define HELP_SPEC_OPTIONS \ 61 "OPTIONS := { {-j|--json} [{-p|--pretty}] | {-d|--debug}" 62 #define HELP_SPEC_MAP \ 63 "MAP := { id MAP_ID | pinned FILE | name MAP_NAME }" 64 #define HELP_SPEC_LINK \ 65 "LINK := { id LINK_ID | pinned FILE }" 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 bool use_loader; 86 extern struct btf *base_btf; 87 extern struct hashmap *refs_table; 88 89 void __printf(1, 2) p_err(const char *fmt, ...); 90 void __printf(1, 2) p_info(const char *fmt, ...); 91 92 bool is_prefix(const char *pfx, const char *str); 93 int detect_common_prefix(const char *arg, ...); 94 void fprint_hex(FILE *f, void *arg, unsigned int n, const char *sep); 95 void usage(void) __noreturn; 96 97 void set_max_rlimit(void); 98 99 int mount_tracefs(const char *target); 100 101 struct obj_ref { 102 int pid; 103 char comm[16]; 104 }; 105 106 struct obj_refs { 107 int ref_cnt; 108 bool has_bpf_cookie; 109 struct obj_ref *refs; 110 __u64 bpf_cookie; 111 }; 112 113 struct btf; 114 struct bpf_line_info; 115 116 int build_pinned_obj_table(struct hashmap *table, 117 enum bpf_obj_type type); 118 void delete_pinned_obj_table(struct hashmap *table); 119 __weak int build_obj_refs_table(struct hashmap **table, 120 enum bpf_obj_type type); 121 __weak void delete_obj_refs_table(struct hashmap *table); 122 __weak void emit_obj_refs_json(struct hashmap *table, __u32 id, 123 json_writer_t *json_wtr); 124 __weak void emit_obj_refs_plain(struct hashmap *table, __u32 id, 125 const char *prefix); 126 void print_dev_plain(__u32 ifindex, __u64 ns_dev, __u64 ns_inode); 127 void print_dev_json(__u32 ifindex, __u64 ns_dev, __u64 ns_inode); 128 129 struct cmd { 130 const char *cmd; 131 int (*func)(int argc, char **argv); 132 }; 133 134 int cmd_select(const struct cmd *cmds, int argc, char **argv, 135 int (*help)(int argc, char **argv)); 136 137 #define MAX_PROG_FULL_NAME 128 138 void get_prog_full_name(const struct bpf_prog_info *prog_info, int prog_fd, 139 char *name_buff, size_t buff_len); 140 141 int get_fd_type(int fd); 142 const char *get_fd_type_name(enum bpf_obj_type type); 143 char *get_fdinfo(int fd, const char *key); 144 int open_obj_pinned(const char *path, bool quiet, 145 const struct bpf_obj_get_opts *opts); 146 int open_obj_pinned_any(const char *path, enum bpf_obj_type exp_type, 147 const struct bpf_obj_get_opts *opts); 148 int mount_bpffs_for_file(const char *file_name); 149 int create_and_mount_bpffs_dir(const char *dir_name); 150 int do_pin_any(int argc, char **argv, int (*get_fd_by_id)(int *, char ***)); 151 int do_pin_fd(int fd, const char *name); 152 153 /* commands available in bootstrap mode */ 154 int do_gen(int argc, char **argv); 155 int do_btf(int argc, char **argv); 156 157 /* non-bootstrap only commands */ 158 int do_prog(int argc, char **arg) __weak; 159 int do_map(int argc, char **arg) __weak; 160 int do_link(int argc, char **arg) __weak; 161 int do_event_pipe(int argc, char **argv) __weak; 162 int do_cgroup(int argc, char **arg) __weak; 163 int do_perf(int argc, char **arg) __weak; 164 int do_net(int argc, char **arg) __weak; 165 int do_tracelog(int argc, char **arg) __weak; 166 int do_feature(int argc, char **argv) __weak; 167 int do_struct_ops(int argc, char **argv) __weak; 168 int do_iter(int argc, char **argv) __weak; 169 170 int parse_u32_arg(int *argc, char ***argv, __u32 *val, const char *what); 171 int prog_parse_fd(int *argc, char ***argv); 172 int prog_parse_fds(int *argc, char ***argv, int **fds); 173 int map_parse_fd(int *argc, char ***argv, __u32 open_flags); 174 int map_parse_fds(int *argc, char ***argv, int **fds, __u32 open_flags); 175 int map_parse_fd_and_info(int *argc, char ***argv, struct bpf_map_info *info, 176 __u32 *info_len, __u32 open_flags); 177 178 struct bpf_prog_linfo; 179 #if defined(HAVE_LLVM_SUPPORT) || defined(HAVE_LIBBFD_SUPPORT) 180 int disasm_print_insn(unsigned char *image, ssize_t len, int opcodes, 181 const char *arch, const char *disassembler_options, 182 const struct btf *btf, 183 const struct bpf_prog_linfo *prog_linfo, 184 __u64 func_ksym, unsigned int func_idx, 185 bool linum); 186 int disasm_init(void); 187 #else 188 static inline 189 int disasm_print_insn(unsigned char *image, ssize_t len, int opcodes, 190 const char *arch, const char *disassembler_options, 191 const struct btf *btf, 192 const struct bpf_prog_linfo *prog_linfo, 193 __u64 func_ksym, unsigned int func_idx, 194 bool linum) 195 { 196 return 0; 197 } 198 static inline int disasm_init(void) 199 { 200 p_err("No JIT disassembly support"); 201 return -1; 202 } 203 #endif 204 void print_data_json(uint8_t *data, size_t len); 205 void print_hex_data_json(uint8_t *data, size_t len); 206 207 unsigned int get_page_size(void); 208 unsigned int get_possible_cpus(void); 209 const char * 210 ifindex_to_arch(__u32 ifindex, __u64 ns_dev, __u64 ns_ino, const char **opt); 211 212 struct btf_dumper { 213 const struct btf *btf; 214 json_writer_t *jw; 215 bool is_plain_text; 216 bool prog_id_as_func_ptr; 217 }; 218 219 /* btf_dumper_type - print data along with type information 220 * @d: an instance containing context for dumping types 221 * @type_id: index in btf->types array. this points to the type to be dumped 222 * @data: pointer the actual data, i.e. the values to be printed 223 * 224 * Returns zero on success and negative error code otherwise 225 */ 226 int btf_dumper_type(const struct btf_dumper *d, __u32 type_id, 227 const void *data); 228 void btf_dumper_type_only(const struct btf *btf, __u32 func_type_id, 229 char *func_only, int size); 230 231 void btf_dump_linfo_plain(const struct btf *btf, 232 const struct bpf_line_info *linfo, 233 const char *prefix, bool linum); 234 void btf_dump_linfo_json(const struct btf *btf, 235 const struct bpf_line_info *linfo, bool linum); 236 void btf_dump_linfo_dotlabel(const struct btf *btf, 237 const struct bpf_line_info *linfo, bool linum); 238 239 struct nlattr; 240 struct ifinfomsg; 241 struct tcmsg; 242 int do_xdp_dump(struct ifinfomsg *ifinfo, struct nlattr **tb); 243 int do_filter_dump(struct tcmsg *ifinfo, struct nlattr **tb, const char *kind, 244 const char *devname, int ifindex); 245 246 int print_all_levels(__maybe_unused enum libbpf_print_level level, 247 const char *format, va_list args); 248 249 size_t hash_fn_for_key_as_id(long key, void *ctx); 250 bool equal_fn_for_key_as_id(long k1, long k2, void *ctx); 251 252 /* bpf_attach_type_input_str - convert the provided attach type value into a 253 * textual representation that we accept for input purposes. 254 * 255 * This function is similar in nature to libbpf_bpf_attach_type_str, but 256 * recognizes some attach type names that have been used by the program in the 257 * past and which do not follow the string inference scheme that libbpf uses. 258 * These textual representations should only be used for user input. 259 * 260 * @t: The attach type 261 * Returns a pointer to a static string identifying the attach type. NULL is 262 * returned for unknown bpf_attach_type values. 263 */ 264 const char *bpf_attach_type_input_str(enum bpf_attach_type t); 265 266 static inline bool hashmap__empty(struct hashmap *map) 267 { 268 return map ? hashmap__size(map) == 0 : true; 269 } 270 271 int pathname_concat(char *buf, int buf_sz, const char *path, 272 const char *name); 273 274 /* print netfilter bpf_link info */ 275 void netfilter_dump_plain(const struct bpf_link_info *info); 276 void netfilter_dump_json(const struct bpf_link_info *info, json_writer_t *wtr); 277 #endif 278