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 /* 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/compiler.h> 45 #include <linux/kernel.h> 46 #include <linux/hashtable.h> 47 48 #include "json_writer.h" 49 50 #define ptr_to_u64(ptr) ((__u64)(unsigned long)(ptr)) 51 52 #define NEXT_ARG() ({ argc--; argv++; if (argc < 0) usage(); }) 53 #define NEXT_ARGP() ({ (*argc)--; (*argv)++; if (*argc < 0) usage(); }) 54 #define BAD_ARG() ({ p_err("what is '%s'?", *argv); -1; }) 55 56 #define ERR_MAX_LEN 1024 57 58 #define BPF_TAG_FMT "%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx" 59 60 #define HELP_SPEC_PROGRAM \ 61 "PROG := { id PROG_ID | pinned FILE | tag PROG_TAG }" 62 #define HELP_SPEC_OPTIONS \ 63 "OPTIONS := { {-j|--json} [{-p|--pretty}] | {-f|--bpffs} }" 64 65 enum bpf_obj_type { 66 BPF_OBJ_UNKNOWN, 67 BPF_OBJ_PROG, 68 BPF_OBJ_MAP, 69 }; 70 71 extern const char *bin_name; 72 73 extern json_writer_t *json_wtr; 74 extern bool json_output; 75 extern bool show_pinned; 76 extern struct pinned_obj_table prog_table; 77 extern struct pinned_obj_table map_table; 78 79 void p_err(const char *fmt, ...); 80 void p_info(const char *fmt, ...); 81 82 bool is_prefix(const char *pfx, const char *str); 83 void fprint_hex(FILE *f, void *arg, unsigned int n, const char *sep); 84 void usage(void) __noreturn; 85 86 struct pinned_obj_table { 87 DECLARE_HASHTABLE(table, 16); 88 }; 89 90 struct pinned_obj { 91 __u32 id; 92 char *path; 93 struct hlist_node hash; 94 }; 95 96 int build_pinned_obj_table(struct pinned_obj_table *table, 97 enum bpf_obj_type type); 98 void delete_pinned_obj_table(struct pinned_obj_table *tab); 99 void print_dev_plain(__u32 ifindex, __u64 ns_dev, __u64 ns_inode); 100 void print_dev_json(__u32 ifindex, __u64 ns_dev, __u64 ns_inode); 101 102 struct cmd { 103 const char *cmd; 104 int (*func)(int argc, char **argv); 105 }; 106 107 int cmd_select(const struct cmd *cmds, int argc, char **argv, 108 int (*help)(int argc, char **argv)); 109 110 int get_fd_type(int fd); 111 const char *get_fd_type_name(enum bpf_obj_type type); 112 char *get_fdinfo(int fd, const char *key); 113 int open_obj_pinned(char *path); 114 int open_obj_pinned_any(char *path, enum bpf_obj_type exp_type); 115 int do_pin_any(int argc, char **argv, int (*get_fd_by_id)(__u32)); 116 int do_pin_fd(int fd, const char *name); 117 118 int do_prog(int argc, char **arg); 119 int do_map(int argc, char **arg); 120 int do_event_pipe(int argc, char **argv); 121 int do_cgroup(int argc, char **arg); 122 int do_perf(int argc, char **arg); 123 124 int prog_parse_fd(int *argc, char ***argv); 125 int map_parse_fd_and_info(int *argc, char ***argv, void *info, __u32 *info_len); 126 127 void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes, 128 const char *arch); 129 void print_data_json(uint8_t *data, size_t len); 130 void print_hex_data_json(uint8_t *data, size_t len); 131 132 unsigned int get_page_size(void); 133 unsigned int get_possible_cpus(void); 134 const char *ifindex_to_bfd_name_ns(__u32 ifindex, __u64 ns_dev, __u64 ns_ino); 135 136 #endif 137