[mirror_iproute2.git] / rdma / rdma.h

/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
/*
 * rdma.c	RDMA tool
 * Authors:     Leon Romanovsky <leonro@mellanox.com>
 */
#ifndef _RDMA_TOOL_H_
#define _RDMA_TOOL_H_

#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <getopt.h>
#include <netinet/in.h>
#include <libmnl/libmnl.h>
#include <rdma/rdma_netlink.h>
#include <rdma/rdma_user_cm.h>
#include <time.h>
#include <net/if_arp.h>

#include "list.h"
#include "utils.h"
#include "json_writer.h"

#define pr_err(args...) fprintf(stderr, ##args)
#define pr_out(args...) fprintf(stdout, ##args)

#define RDMA_BITMAP_ENUM(name, bit_no) RDMA_BITMAP_##name = BIT(bit_no),
#define RDMA_BITMAP_NAMES(name, bit_no) [bit_no] = #name,

#define MAX_NUMBER_OF_FILTERS 64
struct filters {
	const char *name;
	uint8_t is_number:1;
	uint8_t is_doit:1;
};

struct filter_entry {
	struct list_head list;
	char *key;
	char *value;
	/*
	 * This field menas that we can try to issue .doit calback
	 * on value above. This value can be converted to integer
	 * with simple atoi(). Otherwise "is_doit" will be false.
	 */
	uint8_t is_doit:1;
};

struct dev_map {
	struct list_head list;
	char *dev_name;
	uint32_t num_ports;
	uint32_t idx;
};

struct rd {
	int argc;
	char **argv;
	char *filename;
	bool show_details;
	bool show_driver_details;
	struct list_head dev_map_list;
	uint32_t dev_idx;
	uint32_t port_idx;
	struct mnl_socket *nl;
	struct nlmsghdr *nlh;
	char *buff;
	json_writer_t *jw;
	bool json_output;
	bool pretty_output;
	struct list_head filter_list;
};

struct rd_cmd {
	const char *cmd;
	int (*func)(struct rd *rd);
};

/*
 * Parser interface
 */
bool rd_no_arg(struct rd *rd);
void rd_arg_inc(struct rd *rd);

char *rd_argv(struct rd *rd);

/*
 * Commands interface
 */
int cmd_dev(struct rd *rd);
int cmd_link(struct rd *rd);
int cmd_res(struct rd *rd);
int rd_exec_cmd(struct rd *rd, const struct rd_cmd *c, const char *str);
int rd_exec_dev(struct rd *rd, int (*cb)(struct rd *rd));
int rd_exec_require_dev(struct rd *rd, int (*cb)(struct rd *rd));
int rd_exec_link(struct rd *rd, int (*cb)(struct rd *rd), bool strict_port);
void rd_free(struct rd *rd);
int rd_set_arg_to_devname(struct rd *rd);
int rd_argc(struct rd *rd);

int strcmpx(const char *str1, const char *str2);

/*
 * Device manipulation
 */
struct dev_map *dev_map_lookup(struct rd *rd, bool allow_port_index);

/*
 * Filter manipulation
 */
bool rd_doit_index(struct rd *rd, uint32_t *idx);
int rd_build_filter(struct rd *rd, const struct filters valid_filters[]);
bool rd_is_filtered_attr(struct rd *rd, const char *key, uint32_t val,
			 struct nlattr *attr);
bool rd_is_string_filtered_attr(struct rd *rd, const char *key, const char *val,
				struct nlattr *attr);
/*
 * Netlink
 */
int rd_send_msg(struct rd *rd);
int rd_recv_msg(struct rd *rd, mnl_cb_t callback, void *data, uint32_t seq);
void rd_prepare_msg(struct rd *rd, uint32_t cmd, uint32_t *seq, uint16_t flags);
int rd_dev_init_cb(const struct nlmsghdr *nlh, void *data);
int rd_attr_cb(const struct nlattr *attr, void *data);
int rd_attr_check(const struct nlattr *attr, int *typep);

/*
 * Print helpers
 */
void print_driver_table(struct rd *rd, struct nlattr *tb);
void newline(struct rd *rd);
void newline_indent(struct rd *rd);
#define MAX_LINE_LENGTH 80

#endif /* _RDMA_TOOL_H_ */
Commit	Line	Data
835d8321	1	/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
74bd75c2 LR	2	/*
74bd75c2 LR	3	* rdma.c RDMA tool
74bd75c2 LR	4	* Authors: Leon Romanovsky <leonro@mellanox.com>
	5	*/
	6	#ifndef _RDMA_TOOL_H_
	7	#define _RDMA_TOOL_H_
	8
	9	#include <stdlib.h>
	10	#include <string.h>
	11	#include <errno.h>
	12	#include <getopt.h>
5887ff09	13	#include <netinet/in.h>
74bd75c2 LR	14	#include <libmnl/libmnl.h>
74bd75c2 LR	15	#include <rdma/rdma_netlink.h>
9a362cc7	16	#include <rdma/rdma_user_cm.h>
74bd75c2	17	#include <time.h>
9a362cc7	18	#include <net/if_arp.h>
74bd75c2 LR	19
74bd75c2 LR	20	#include "list.h"
40df8263	21	#include "utils.h"
ab6e2b7b	22	#include "json_writer.h"
74bd75c2 LR	23
	24	#define pr_err(args...) fprintf(stderr, ##args)
	25	#define pr_out(args...) fprintf(stdout, ##args)
	26
40df8263 LR	27	#define RDMA_BITMAP_ENUM(name, bit_no) RDMA_BITMAP_##name = BIT(bit_no),
	28	#define RDMA_BITMAP_NAMES(name, bit_no) [bit_no] = #name,
	29
1174be72 LR	30	#define MAX_NUMBER_OF_FILTERS 64
1174be72 LR	31	struct filters {
3b0070f6	32	const char *name;
5a823593 LR	33	uint8_t is_number:1;
5a823593 LR	34	uint8_t is_doit:1;
1174be72 LR	35	};
	36
	37	struct filter_entry {
	38	struct list_head list;
	39	char *key;
	40	char *value;
5a823593 LR	41	/*
	42	* This field menas that we can try to issue .doit calback
	43	* on value above. This value can be converted to integer
	44	* with simple atoi(). Otherwise "is_doit" will be false.
	45	*/
	46	uint8_t is_doit:1;
1174be72 LR	47	};
1174be72 LR	48
74bd75c2 LR	49	struct dev_map {
	50	struct list_head list;
	51	char *dev_name;
	52	uint32_t num_ports;
	53	uint32_t idx;
	54	};
	55
	56	struct rd {
	57	int argc;
	58	char **argv;
	59	char *filename;
	60	bool show_details;
33115275	61	bool show_driver_details;
74bd75c2	62	struct list_head dev_map_list;
40df8263 LR	63	uint32_t dev_idx;
40df8263 LR	64	uint32_t port_idx;
74bd75c2 LR	65	struct mnl_socket *nl;
	66	struct nlmsghdr *nlh;
	67	char *buff;
ab6e2b7b LR	68	json_writer_t *jw;
	69	bool json_output;
	70	bool pretty_output;
1174be72	71	struct list_head filter_list;
74bd75c2 LR	72	};
	73
	74	struct rd_cmd {
	75	const char *cmd;
	76	int (func)(struct rd rd);
	77	};
	78
6ae54b13 DA	79	/*
	80	* Parser interface
	81	*/
	82	bool rd_no_arg(struct rd *rd);
	83	void rd_arg_inc(struct rd *rd);
	84
	85	char rd_argv(struct rd rd);
40df8263	86
40df8263 LR	87	/*
	88	* Commands interface
	89	*/
	90	int cmd_dev(struct rd *rd);
	91	int cmd_link(struct rd *rd);
923aa825	92	int cmd_res(struct rd *rd);
74bd75c2	93	int rd_exec_cmd(struct rd rd, const struct rd_cmd c, const char *str);
8b92a2c9	94	int rd_exec_dev(struct rd rd, int (cb)(struct rd *rd));
a14ceed3	95	int rd_exec_require_dev(struct rd rd, int (cb)(struct rd *rd));
6416d1a0	96	int rd_exec_link(struct rd rd, int (cb)(struct rd *rd), bool strict_port);
5fc17280	97	void rd_free(struct rd *rd);
6e0de6e8	98	int rd_set_arg_to_devname(struct rd *rd);
5f4892e2	99	int rd_argc(struct rd *rd);
74bd75c2	100
6ae54b13 DA	101	int strcmpx(const char str1, const char str2);
6ae54b13 DA	102
74bd75c2 LR	103	/*
	104	* Device manipulation
	105	*/
40df8263	106	struct dev_map dev_map_lookup(struct rd rd, bool allow_port_index);
74bd75c2	107
1174be72 LR	108	/*
	109	* Filter manipulation
	110	*/
5a823593	111	bool rd_doit_index(struct rd rd, uint32_t idx);
1174be72	112	int rd_build_filter(struct rd *rd, const struct filters valid_filters[]);
78728b7e LR	113	bool rd_is_filtered_attr(struct rd rd, const char key, uint32_t val,
	114	struct nlattr *attr);
	115	bool rd_is_string_filtered_attr(struct rd rd, const char key, const char *val,
	116	struct nlattr *attr);
74bd75c2 LR	117	/*
	118	* Netlink
	119	*/
	120	int rd_send_msg(struct rd *rd);
	121	int rd_recv_msg(struct rd rd, mnl_cb_t callback, void data, uint32_t seq);
	122	void rd_prepare_msg(struct rd rd, uint32_t cmd, uint32_t seq, uint16_t flags);
	123	int rd_dev_init_cb(const struct nlmsghdr nlh, void data);
	124	int rd_attr_cb(const struct nlattr attr, void data);
6ae54b13	125	int rd_attr_check(const struct nlattr attr, int typep);
33115275 SW	126
	127	/*
	128	* Print helpers
	129	*/
	130	void print_driver_table(struct rd rd, struct nlattr tb);
	131	void newline(struct rd *rd);
6ae54b13	132	void newline_indent(struct rd *rd);
33115275 SW	133	#define MAX_LINE_LENGTH 80
33115275 SW	134
74bd75c2	135	#endif /* _RDMA_TOOL_H_ */