tools/bpf/bpftool/main.h

   1 /*
   2  * Copyright (C) 2017 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 /* Author: Jakub Kicinski <kubakici@wp.pl> */
  35
  36 #ifndef __BPF_TOOL_H
  37 #define __BPF_TOOL_H
  38
  39 /* BFD and kernel.h both define GCC_VERSION, differently */
  40 #undef GCC_VERSION
  41 #include <stdbool.h>
  42 #include <stdio.h>
  43 #include <linux/bpf.h>
  44 #include <linux/kernel.h>
  45 #include <linux/hashtable.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'?\n", *argv); -1; })
  54
  55 #define ERR_MAX_LEN     1024
  56
  57 #define BPF_TAG_FMT     "%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx"
  58
  59 #define HELP_SPEC_PROGRAM                                               \
  60         "PROG := { id PROG_ID | pinned FILE | tag PROG_TAG }"
  61 #define HELP_SPEC_OPTIONS                                               \
  62         "OPTIONS := { {-j|--json} [{-p|--pretty}] | {-f|--bpffs} }"
  63
  64 enum bpf_obj_type {
  65         BPF_OBJ_UNKNOWN,
  66         BPF_OBJ_PROG,
  67         BPF_OBJ_MAP,
  68 };
  69
  70 extern const char *bin_name;
  71
  72 extern json_writer_t *json_wtr;
  73 extern bool json_output;
  74 extern bool show_pinned;
  75 extern struct pinned_obj_table prog_table;
  76 extern struct pinned_obj_table map_table;
  77
  78 void p_err(const char *fmt, ...);
  79 void p_info(const char *fmt, ...);
  80
  81 bool is_prefix(const char *pfx, const char *str);
  82 void fprint_hex(FILE *f, void *arg, unsigned int n, const char *sep);
  83 void usage(void) __attribute__((noreturn));
  84
  85 struct pinned_obj_table {
  86         DECLARE_HASHTABLE(table, 16);
  87 };
  88
  89 struct pinned_obj {
  90         __u32 id;
  91         char *path;
  92         struct hlist_node hash;
  93 };
  94
  95 int build_pinned_obj_table(struct pinned_obj_table *table,
  96                            enum bpf_obj_type type);
  97 void delete_pinned_obj_table(struct pinned_obj_table *tab);
  98
  99 struct cmd {
 100         const char *cmd;
 101         int (*func)(int argc, char **argv);
 102 };
 103
 104 int cmd_select(const struct cmd *cmds, int argc, char **argv,
 105                int (*help)(int argc, char **argv));
 106
 107 int get_fd_type(int fd);
 108 const char *get_fd_type_name(enum bpf_obj_type type);
 109 char *get_fdinfo(int fd, const char *key);
 110 int open_obj_pinned(char *path);
 111 int open_obj_pinned_any(char *path, enum bpf_obj_type exp_type);
 112 int do_pin_any(int argc, char **argv, int (*get_fd_by_id)(__u32));
 113
 114 int do_prog(int argc, char **arg);
 115 int do_map(int argc, char **arg);
 116
 117 int prog_parse_fd(int *argc, char ***argv);
 118
 119 void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes);
 120 void print_hex_data_json(uint8_t *data, size_t len);
 121
 122 #endif