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 "json_writer.h"
 18
 19#define ptr_to_u64(ptr)	((__u64)(unsigned long)(ptr))
 20
 21#define NEXT_ARG()	({ argc--; argv++; if (argc < 0) usage(); })
 22#define NEXT_ARGP()	({ (*argc)--; (*argv)++; if (*argc < 0) usage(); })
 23#define BAD_ARG()	({ p_err("what is '%s'?", *argv); -1; })
 24#define GET_ARG()	({ argc--; *argv++; })
 25#define REQ_ARGS(cnt)							\
 26	({								\
 27		int _cnt = (cnt);					\
 28		bool _res;						\
 29									\
 30		if (argc < _cnt) {					\
 31			p_err("'%s' needs at least %d arguments, %d found", \
 32			      argv[-1], _cnt, argc);			\
 33			_res = false;					\
 34		} else {						\
 35			_res = true;					\
 36		}							\
 37		_res;							\
 38	})
 39
 40#define ERR_MAX_LEN	1024
 41
 42#define BPF_TAG_FMT	"%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx"
 43
 44#define HELP_SPEC_PROGRAM						\
 45	"PROG := { id PROG_ID | pinned FILE | tag PROG_TAG }"
 46#define HELP_SPEC_OPTIONS						\
 47	"OPTIONS := { {-j|--json} [{-p|--pretty}] | {-f|--bpffs} |\n"	\
 48	"\t            {-m|--mapcompat} | {-n|--nomount} }"
 49#define HELP_SPEC_MAP							\
 50	"MAP := { id MAP_ID | pinned FILE }"
 51
 52static const char * const prog_type_name[] = {
 53	[BPF_PROG_TYPE_UNSPEC]			= "unspec",
 54	[BPF_PROG_TYPE_SOCKET_FILTER]		= "socket_filter",
 55	[BPF_PROG_TYPE_KPROBE]			= "kprobe",
 56	[BPF_PROG_TYPE_SCHED_CLS]		= "sched_cls",
 57	[BPF_PROG_TYPE_SCHED_ACT]		= "sched_act",
 58	[BPF_PROG_TYPE_TRACEPOINT]		= "tracepoint",
 59	[BPF_PROG_TYPE_XDP]			= "xdp",
 60	[BPF_PROG_TYPE_PERF_EVENT]		= "perf_event",
 61	[BPF_PROG_TYPE_CGROUP_SKB]		= "cgroup_skb",
 62	[BPF_PROG_TYPE_CGROUP_SOCK]		= "cgroup_sock",
 63	[BPF_PROG_TYPE_LWT_IN]			= "lwt_in",
 64	[BPF_PROG_TYPE_LWT_OUT]			= "lwt_out",
 65	[BPF_PROG_TYPE_LWT_XMIT]		= "lwt_xmit",
 66	[BPF_PROG_TYPE_SOCK_OPS]		= "sock_ops",
 67	[BPF_PROG_TYPE_SK_SKB]			= "sk_skb",
 68	[BPF_PROG_TYPE_CGROUP_DEVICE]		= "cgroup_device",
 69	[BPF_PROG_TYPE_SK_MSG]			= "sk_msg",
 70	[BPF_PROG_TYPE_RAW_TRACEPOINT]		= "raw_tracepoint",
 71	[BPF_PROG_TYPE_CGROUP_SOCK_ADDR]	= "cgroup_sock_addr",
 72	[BPF_PROG_TYPE_LWT_SEG6LOCAL]		= "lwt_seg6local",
 73	[BPF_PROG_TYPE_LIRC_MODE2]		= "lirc_mode2",
 74	[BPF_PROG_TYPE_SK_REUSEPORT]		= "sk_reuseport",
 75	[BPF_PROG_TYPE_FLOW_DISSECTOR]		= "flow_dissector",
 76	[BPF_PROG_TYPE_CGROUP_SYSCTL]		= "cgroup_sysctl",
 77	[BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE]	= "raw_tracepoint_writable",
 78	[BPF_PROG_TYPE_CGROUP_SOCKOPT]		= "cgroup_sockopt",
 79};
 80
 81extern const char * const map_type_name[];
 82extern const size_t map_type_name_size;
 83
 84enum bpf_obj_type {
 85	BPF_OBJ_UNKNOWN,
 86	BPF_OBJ_PROG,
 87	BPF_OBJ_MAP,
 88};
 89
 90extern const char *bin_name;
 91
 92extern json_writer_t *json_wtr;
 93extern bool json_output;
 94extern bool show_pinned;
 95extern bool block_mount;
 96extern bool verifier_logs;
 97extern int bpf_flags;
 98extern struct pinned_obj_table prog_table;
 99extern struct pinned_obj_table map_table;
100
101void __printf(1, 2) p_err(const char *fmt, ...);
102void __printf(1, 2) p_info(const char *fmt, ...);
103
104bool is_prefix(const char *pfx, const char *str);
105int detect_common_prefix(const char *arg, ...);
106void fprint_hex(FILE *f, void *arg, unsigned int n, const char *sep);
107void usage(void) __noreturn;
108
109void set_max_rlimit(void);
110
111int mount_tracefs(const char *target);
112
113struct pinned_obj_table {
114	DECLARE_HASHTABLE(table, 16);
115};
116
117struct pinned_obj {
118	__u32 id;
119	char *path;
120	struct hlist_node hash;
121};
122
123struct btf;
124struct bpf_line_info;
125
126int build_pinned_obj_table(struct pinned_obj_table *table,
127			   enum bpf_obj_type type);
128void delete_pinned_obj_table(struct pinned_obj_table *tab);
129void print_dev_plain(__u32 ifindex, __u64 ns_dev, __u64 ns_inode);
130void print_dev_json(__u32 ifindex, __u64 ns_dev, __u64 ns_inode);
131
132struct cmd {
133	const char *cmd;
134	int (*func)(int argc, char **argv);
135};
136
137int cmd_select(const struct cmd *cmds, int argc, char **argv,
138	       int (*help)(int argc, char **argv));
139
140int get_fd_type(int fd);
141const char *get_fd_type_name(enum bpf_obj_type type);
142char *get_fdinfo(int fd, const char *key);
143int open_obj_pinned(char *path, bool quiet);
144int open_obj_pinned_any(char *path, enum bpf_obj_type exp_type);
145int mount_bpffs_for_pin(const char *name);
146int do_pin_any(int argc, char **argv, int (*get_fd_by_id)(__u32));
147int do_pin_fd(int fd, const char *name);
148
149int do_prog(int argc, char **arg);
150int do_map(int argc, char **arg);
151int do_event_pipe(int argc, char **argv);
152int do_cgroup(int argc, char **arg);
153int do_perf(int argc, char **arg);
154int do_net(int argc, char **arg);
155int do_tracelog(int argc, char **arg);
156int do_feature(int argc, char **argv);
157int do_btf(int argc, char **argv);
158
159int parse_u32_arg(int *argc, char ***argv, __u32 *val, const char *what);
160int prog_parse_fd(int *argc, char ***argv);
161int map_parse_fd(int *argc, char ***argv);
162int map_parse_fd_and_info(int *argc, char ***argv, void *info, __u32 *info_len);
163
164struct bpf_prog_linfo;
165#ifdef HAVE_LIBBFD_SUPPORT
166void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes,
167		       const char *arch, const char *disassembler_options,
168		       const struct btf *btf,
169		       const struct bpf_prog_linfo *prog_linfo,
170		       __u64 func_ksym, unsigned int func_idx,
171		       bool linum);
172int disasm_init(void);
173#else
174static inline
175void disasm_print_insn(unsigned char *image, ssize_t len, int opcodes,
176		       const char *arch, const char *disassembler_options,
177		       const struct btf *btf,
178		       const struct bpf_prog_linfo *prog_linfo,
179		       __u64 func_ksym, unsigned int func_idx,
180		       bool linum)
181{
182}
183static inline int disasm_init(void)
184{
185	p_err("No libbfd support");
186	return -1;
187}
188#endif
189void print_data_json(uint8_t *data, size_t len);
190void print_hex_data_json(uint8_t *data, size_t len);
191
192unsigned int get_page_size(void);
193unsigned int get_possible_cpus(void);
194const char *
195ifindex_to_bfd_params(__u32 ifindex, __u64 ns_dev, __u64 ns_ino,
196		      const char **opt);
197
198struct btf_dumper {
199	const struct btf *btf;
200	json_writer_t *jw;
201	bool is_plain_text;
202};
203
204/* btf_dumper_type - print data along with type information
205 * @d: an instance containing context for dumping types
206 * @type_id: index in btf->types array. this points to the type to be dumped
207 * @data: pointer the actual data, i.e. the values to be printed
208 *
209 * Returns zero on success and negative error code otherwise
210 */
211int btf_dumper_type(const struct btf_dumper *d, __u32 type_id,
212		    const void *data);
213void btf_dumper_type_only(const struct btf *btf, __u32 func_type_id,
214			  char *func_only, int size);
215
216void btf_dump_linfo_plain(const struct btf *btf,
217			  const struct bpf_line_info *linfo,
218			  const char *prefix, bool linum);
219void btf_dump_linfo_json(const struct btf *btf,
220			 const struct bpf_line_info *linfo, bool linum);
221
222struct nlattr;
223struct ifinfomsg;
224struct tcmsg;
225int do_xdp_dump(struct ifinfomsg *ifinfo, struct nlattr **tb);
226int do_filter_dump(struct tcmsg *ifinfo, struct nlattr **tb, const char *kind,
227		   const char *devname, int ifindex);
228#endif