tools/bpf/bpftool/main.h

   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 static inline __u64 ptr_to_u64(const void *ptr)
  25 {
  26         return (__u64)(unsigned long)ptr;
  27 }
  28
  29 static inline void *u64_to_ptr(__u64 ptr)
  30 {
  31         return (void *)(unsigned long)ptr;
  32 }
  33
  34 #define NEXT_ARG()      ({ argc--; argv++; if (argc < 0) usage(); })
  35 #define NEXT_ARGP()     ({ (*argc)--; (*argv)++; if (*argc < 0) usage(); })
  36 #define BAD_ARG()       ({ p_err("what is '%s'?", *argv); -1; })
  37 #define GET_ARG()       ({ argc--; *argv++; })
  38 #define REQ_ARGS(cnt)                                                   \
  39         ({                                                              \
  40                 int _cnt = (cnt);                                       \
  41                 bool _res;                                              \
  42                                                                         \
  43                 if (argc < _cnt) {                                      \
  44                         p_err("'%s' needs at least %d arguments, %d found", \
  45                               argv[-1], _cnt, argc);                    \
  46                         _res = false;                                   \
  47                 } else {                                                \
  48                         _res = true;                                    \
  49                 }                                                       \
  50                 _res;                                                   \
  51         })
  52
  53 #define ERR_MAX_LEN     1024
  54
  55 #define BPF_TAG_FMT     "%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx"
  56
  57 #define HELP_SPEC_PROGRAM                                               \
  58         "PROG := { id PROG_ID | pinned FILE | tag PROG_TAG | name PROG_NAME }"
  59 #define HELP_SPEC_OPTIONS                                               \
  60         "OPTIONS := { {-j|--json} [{-p|--pretty}] | {-f|--bpffs} |\n"   \
  61         "\t            {-m|--mapcompat} | {-n|--nomount} }"
  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 extern const char * const prog_type_name[];
  68 extern const size_t prog_type_name_size;
  69
  70 extern const char * const attach_type_name[__MAX_BPF_ATTACH_TYPE];
  71
  72 extern const char * const map_type_name[];
  73 extern const size_t map_type_name_size;
  74
  75 /* keep in sync with the definition in skeleton/pid_iter.bpf.c */
  76 enum bpf_obj_type {
  77         BPF_OBJ_UNKNOWN,
  78         BPF_OBJ_PROG,
  79         BPF_OBJ_MAP,
  80         BPF_OBJ_LINK,
  81         BPF_OBJ_BTF,
  82 };
  83
  84 extern const char *bin_name;
  85
  86 extern json_writer_t *json_wtr;
  87 extern bool json_output;
  88 extern bool show_pinned;
  89 extern bool show_pids;
  90 extern bool block_mount;
  91 extern bool verifier_logs;
  92 extern bool relaxed_maps;
  93 extern struct btf *base_btf;
  94 extern struct pinned_obj_table prog_table;
  95 extern struct pinned_obj_table map_table;
  96 extern struct pinned_obj_table link_table;
  97 extern struct obj_refs_table refs_table;
  98
  99 void __printf(1, 2) p_err(const char *fmt, ...);
 100 void __printf(1, 2) p_info(const char *fmt, ...);
 101
 102 bool is_prefix(const char *pfx, const char *str);
 103 int detect_common_prefix(const char *arg, ...);
 104 void fprint_hex(FILE *f, void *arg, unsigned int n, const char *sep);
 105 void usage(void) __noreturn;
 106
 107 void set_max_rlimit(void);
 108
 109 int mount_tracefs(const char *target);
 110
 111 struct pinned_obj_table {
 112         DECLARE_HASHTABLE(table, 16);
 113 };
 114
 115 struct pinned_obj {
 116         __u32 id;
 117         char *path;
 118         struct hlist_node hash;
 119 };
 120
 121 struct obj_refs_table {
 122         DECLARE_HASHTABLE(table, 16);
 123 };
 124
 125 struct obj_ref {
 126         int pid;
 127         char comm[16];
 128 };
 129
 130 struct obj_refs {
 131         struct hlist_node node;
 132         __u32 id;
 133         int ref_cnt;
 134         struct obj_ref *refs;
 135 };
 136
 137 struct btf;
 138 struct bpf_line_info;
 139
 140 int build_pinned_obj_table(struct pinned_obj_table *table,
 141                            enum bpf_obj_type type);
 142 void delete_pinned_obj_table(struct pinned_obj_table *tab);
 143 __weak int build_obj_refs_table(struct obj_refs_table *table,
 144                                 enum bpf_obj_type type);
 145 __weak void delete_obj_refs_table(struct obj_refs_table *table);
 146 __weak void emit_obj_refs_json(struct obj_refs_table *table, __u32 id,
 147                                json_writer_t *json_wtr);
 148 __weak void emit_obj_refs_plain(struct obj_refs_table *table, __u32 id,
 149                                 const char *prefix);
 150 void print_dev_plain(__u32 ifindex, __u64 ns_dev, __u64 ns_inode);
 151 void print_dev_json(__u32 ifindex, __u64 ns_dev, __u64 ns_inode);
 152
 153 struct cmd {
 154         const char *cmd;
 155         int (*func)(int argc, char **argv);
 156 };
 157
 158 int cmd_select(const struct cmd *cmds, int argc, char **argv,
 159                int (*help)(int argc, char **argv));
 160
 161 int get_fd_type(int fd);
 162 const char *get_fd_type_name(enum bpf_obj_type type);
 163 char *get_fdinfo(int fd, const char *key);
 164 int open_obj_pinned(const char *path, bool quiet);
 165 int open_obj_pinned_any(const char *path, enum bpf_obj_type exp_type);
 166 int mount_bpffs_for_pin(const char *name);
 167 int do_pin_any(int argc, char **argv, int (*get_fd_by_id)(int *, char ***));
 168 int do_pin_fd(int fd, const char *name);
 169
 170 /* commands available in bootstrap mode */
 171 int do_gen(int argc, char **argv);
 172 int do_btf(int argc, char **argv);
 173
 174 /* non-bootstrap only commands */
 175 int do_prog(int argc, char **arg) __weak;
 176 int do_map(int argc, char **arg) __weak;
 177 int do_link(int argc, char **arg) __weak;
 178 int do_event_pipe(int argc, char **argv) __weak;
 179 int do_cgroup(int argc, char **arg) __weak;
 180 int do_perf(int argc, char **arg) __weak;
 181 int do_net(int argc, char **arg) __weak;
 182 int do_tracelog(int argc, char **arg) __weak;
 183 int do_feature(int argc, char **argv) __weak;
 184 int do_struct_ops(int argc, char **argv) __weak;
 185 int do_iter(int argc, char **argv) __weak;
 186
 187 int parse_u32_arg(int *argc, char ***argv, __u32 *val, const char *what);
 188 int prog_parse_fd(int *argc, char ***argv);
 189 int prog_parse_fds(int *argc, char ***argv, int **fds);
 190 int map_parse_fd(int *argc, char ***argv);
 191 int map_parse_fds(int *argc, char ***argv, int **fds);
 192 int map_parse_fd_and_info(int *argc, char ***argv, void *info, __u32 *info_len);
 193
 194 struct bpf_prog_linfo;
 195 #ifdef HAVE_LIBBFD_SUPPORT
 196 void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes,
 197                        const char *arch, const char *disassembler_options,
 198                        const struct btf *btf,
 199                        const struct bpf_prog_linfo *prog_linfo,
 200                        __u64 func_ksym, unsigned int func_idx,
 201                        bool linum);
 202 int disasm_init(void);
 203 #else
 204 static inline
 205 void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes,
 206                        const char *arch, const char *disassembler_options,
 207                        const struct btf *btf,
 208                        const struct bpf_prog_linfo *prog_linfo,
 209                        __u64 func_ksym, unsigned int func_idx,
 210                        bool linum)
 211 {
 212 }
 213 static inline int disasm_init(void)
 214 {
 215         p_err("No libbfd support");
 216         return -1;
 217 }
 218 #endif
 219 void print_data_json(uint8_t *data, size_t len);
 220 void print_hex_data_json(uint8_t *data, size_t len);
 221
 222 unsigned int get_page_size(void);
 223 unsigned int get_possible_cpus(void);
 224 const char *
 225 ifindex_to_bfd_params(__u32 ifindex, __u64 ns_dev, __u64 ns_ino,
 226                       const char **opt);
 227
 228 struct btf_dumper {
 229         const struct btf *btf;
 230         json_writer_t *jw;
 231         bool is_plain_text;
 232         bool prog_id_as_func_ptr;
 233 };
 234
 235 /* btf_dumper_type - print data along with type information
 236  * @d: an instance containing context for dumping types
 237  * @type_id: index in btf->types array. this points to the type to be dumped
 238  * @data: pointer the actual data, i.e. the values to be printed
 239  *
 240  * Returns zero on success and negative error code otherwise
 241  */
 242 int btf_dumper_type(const struct btf_dumper *d, __u32 type_id,
 243                     const void *data);
 244 void btf_dumper_type_only(const struct btf *btf, __u32 func_type_id,
 245                           char *func_only, int size);
 246
 247 void btf_dump_linfo_plain(const struct btf *btf,
 248                           const struct bpf_line_info *linfo,
 249                           const char *prefix, bool linum);
 250 void btf_dump_linfo_json(const struct btf *btf,
 251                          const struct bpf_line_info *linfo, bool linum);
 252
 253 struct nlattr;
 254 struct ifinfomsg;
 255 struct tcmsg;
 256 int do_xdp_dump(struct ifinfomsg *ifinfo, struct nlattr **tb);
 257 int do_filter_dump(struct tcmsg *ifinfo, struct nlattr **tb, const char *kind,
 258                    const char *devname, int ifindex);
 259
 260 int print_all_levels(__maybe_unused enum libbpf_print_level level,
 261                      const char *format, va_list args);
 262 #endif