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