tools/bpf/bpftool/main.h

   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 enum bpf_obj_type {
  82         BPF_OBJ_UNKNOWN,
  83         BPF_OBJ_PROG,
  84         BPF_OBJ_MAP,
  85 };
  86
  87 extern const char *bin_name;
  88
  89 extern json_writer_t *json_wtr;
  90 extern bool json_output;
  91 extern bool show_pinned;
  92 extern int bpf_flags;
  93 extern struct pinned_obj_table prog_table;
  94 extern struct pinned_obj_table map_table;
  95
  96 void p_err(const char *fmt, ...);
  97 void p_info(const char *fmt, ...);
  98
  99 bool is_prefix(const char *pfx, const char *str);
 100 void fprint_hex(FILE *f, void *arg, unsigned int n, const char *sep);
 101 void usage(void) __noreturn;
 102
 103 struct pinned_obj_table {
 104         DECLARE_HASHTABLE(table, 16);
 105 };
 106
 107 struct pinned_obj {
 108         __u32 id;
 109         char *path;
 110         struct hlist_node hash;
 111 };
 112
 113 int build_pinned_obj_table(struct pinned_obj_table *table,
 114                            enum bpf_obj_type type);
 115 void delete_pinned_obj_table(struct pinned_obj_table *tab);
 116 void print_dev_plain(__u32 ifindex, __u64 ns_dev, __u64 ns_inode);
 117 void print_dev_json(__u32 ifindex, __u64 ns_dev, __u64 ns_inode);
 118
 119 struct cmd {
 120         const char *cmd;
 121         int (*func)(int argc, char **argv);
 122 };
 123
 124 int cmd_select(const struct cmd *cmds, int argc, char **argv,
 125                int (*help)(int argc, char **argv));
 126
 127 int get_fd_type(int fd);
 128 const char *get_fd_type_name(enum bpf_obj_type type);
 129 char *get_fdinfo(int fd, const char *key);
 130 int open_obj_pinned(char *path, bool quiet);
 131 int open_obj_pinned_any(char *path, enum bpf_obj_type exp_type);
 132 int do_pin_any(int argc, char **argv, int (*get_fd_by_id)(__u32));
 133 int do_pin_fd(int fd, const char *name);
 134
 135 int do_prog(int argc, char **arg);
 136 int do_map(int argc, char **arg);
 137 int do_event_pipe(int argc, char **argv);
 138 int do_cgroup(int argc, char **arg);
 139 int do_perf(int argc, char **arg);
 140 int do_net(int argc, char **arg);
 141
 142 int parse_u32_arg(int *argc, char ***argv, __u32 *val, const char *what);
 143 int prog_parse_fd(int *argc, char ***argv);
 144 int map_parse_fd(int *argc, char ***argv);
 145 int map_parse_fd_and_info(int *argc, char ***argv, void *info, __u32 *info_len);
 146
 147 void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes,
 148                        const char *arch, const char *disassembler_options);
 149 void print_data_json(uint8_t *data, size_t len);
 150 void print_hex_data_json(uint8_t *data, size_t len);
 151
 152 unsigned int get_page_size(void);
 153 unsigned int get_possible_cpus(void);
 154 const char *
 155 ifindex_to_bfd_params(__u32 ifindex, __u64 ns_dev, __u64 ns_ino,
 156                       const char **opt);
 157
 158 struct btf_dumper {
 159         const struct btf *btf;
 160         json_writer_t *jw;
 161         bool is_plain_text;
 162 };
 163
 164 /* btf_dumper_type - print data along with type information
 165  * @d: an instance containing context for dumping types
 166  * @type_id: index in btf->types array. this points to the type to be dumped
 167  * @data: pointer the actual data, i.e. the values to be printed
 168  *
 169  * Returns zero on success and negative error code otherwise
 170  */
 171 int btf_dumper_type(const struct btf_dumper *d, __u32 type_id,
 172                     const void *data);
 173
 174 struct nlattr;
 175 struct ifinfomsg;
 176 struct tcmsg;
 177 int do_xdp_dump(struct ifinfomsg *ifinfo, struct nlattr **tb);
 178 int do_filter_dump(struct tcmsg *ifinfo, struct nlattr **tb, const char *kind,
 179                    const char *devname, int ifindex);
 180 #endif