1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __NET_RTNETLINK_H
3#define __NET_RTNETLINK_H
4
5#include <linux/rtnetlink.h>
6#include <net/netlink.h>
7
8typedef int (*rtnl_doit_func)(struct sk_buff *, struct nlmsghdr *,
9			      struct netlink_ext_ack *);
10typedef int (*rtnl_dumpit_func)(struct sk_buff *, struct netlink_callback *);
11
12enum rtnl_link_flags {
13	RTNL_FLAG_DOIT_UNLOCKED		= BIT(0),
14	RTNL_FLAG_BULK_DEL_SUPPORTED	= BIT(1),
15	RTNL_FLAG_DUMP_UNLOCKED		= BIT(2),
16};
17
18enum rtnl_kinds {
19	RTNL_KIND_NEW,
20	RTNL_KIND_DEL,
21	RTNL_KIND_GET,
22	RTNL_KIND_SET
23};
24#define RTNL_KIND_MASK 0x3
25
26static inline enum rtnl_kinds rtnl_msgtype_kind(int msgtype)
27{
28	return msgtype & RTNL_KIND_MASK;
29}
30
31void rtnl_register(int protocol, int msgtype,
32		   rtnl_doit_func, rtnl_dumpit_func, unsigned int flags);
33int rtnl_register_module(struct module *owner, int protocol, int msgtype,
34			 rtnl_doit_func, rtnl_dumpit_func, unsigned int flags);
35int rtnl_unregister(int protocol, int msgtype);
36void rtnl_unregister_all(int protocol);
37
38static inline int rtnl_msg_family(const struct nlmsghdr *nlh)
39{
40	if (nlmsg_len(nlh) >= sizeof(struct rtgenmsg))
41		return ((struct rtgenmsg *) nlmsg_data(nlh))->rtgen_family;
42	else
43		return AF_UNSPEC;
44}
45
46/**
47 *	struct rtnl_link_ops - rtnetlink link operations
48 *
49 *	@list: Used internally
50 *	@kind: Identifier
51 *	@netns_refund: Physical device, move to init_net on netns exit
52 *	@maxtype: Highest device specific netlink attribute number
53 *	@policy: Netlink policy for device specific attribute validation
54 *	@validate: Optional validation function for netlink/changelink parameters
55 *	@alloc: netdev allocation function, can be %NULL and is then used
56 *		in place of alloc_netdev_mqs(), in this case @priv_size
57 *		and @setup are unused. Returns a netdev or ERR_PTR().
58 *	@priv_size: sizeof net_device private space
59 *	@setup: net_device setup function
60 *	@newlink: Function for configuring and registering a new device
61 *	@changelink: Function for changing parameters of an existing device
62 *	@dellink: Function to remove a device
63 *	@get_size: Function to calculate required room for dumping device
64 *		   specific netlink attributes
65 *	@fill_info: Function to dump device specific netlink attributes
66 *	@get_xstats_size: Function to calculate required room for dumping device
67 *			  specific statistics
68 *	@fill_xstats: Function to dump device specific statistics
69 *	@get_num_tx_queues: Function to determine number of transmit queues
70 *			    to create when creating a new device.
71 *	@get_num_rx_queues: Function to determine number of receive queues
72 *			    to create when creating a new device.
73 *	@get_link_net: Function to get the i/o netns of the device
74 *	@get_linkxstats_size: Function to calculate the required room for
75 *			      dumping device-specific extended link stats
76 *	@fill_linkxstats: Function to dump device-specific extended link stats
77 */
78struct rtnl_link_ops {
79	struct list_head	list;
80
81	const char		*kind;
82
83	size_t			priv_size;
84	struct net_device	*(*alloc)(struct nlattr *tb[],
85					  const char *ifname,
86					  unsigned char name_assign_type,
87					  unsigned int num_tx_queues,
88					  unsigned int num_rx_queues);
89	void			(*setup)(struct net_device *dev);
90
91	bool			netns_refund;
92	unsigned int		maxtype;
93	const struct nla_policy	*policy;
94	int			(*validate)(struct nlattr *tb[],
95					    struct nlattr *data[],
96					    struct netlink_ext_ack *extack);
97
98	int			(*newlink)(struct net *src_net,
99					   struct net_device *dev,
100					   struct nlattr *tb[],
101					   struct nlattr *data[],
102					   struct netlink_ext_ack *extack);
103	int			(*changelink)(struct net_device *dev,
104					      struct nlattr *tb[],
105					      struct nlattr *data[],
106					      struct netlink_ext_ack *extack);
107	void			(*dellink)(struct net_device *dev,
108					   struct list_head *head);
109
110	size_t			(*get_size)(const struct net_device *dev);
111	int			(*fill_info)(struct sk_buff *skb,
112					     const struct net_device *dev);
113
114	size_t			(*get_xstats_size)(const struct net_device *dev);
115	int			(*fill_xstats)(struct sk_buff *skb,
116					       const struct net_device *dev);
117	unsigned int		(*get_num_tx_queues)(void);
118	unsigned int		(*get_num_rx_queues)(void);
119
120	unsigned int		slave_maxtype;
121	const struct nla_policy	*slave_policy;
122	int			(*slave_changelink)(struct net_device *dev,
123						    struct net_device *slave_dev,
124						    struct nlattr *tb[],
125						    struct nlattr *data[],
126						    struct netlink_ext_ack *extack);
127	size_t			(*get_slave_size)(const struct net_device *dev,
128						  const struct net_device *slave_dev);
129	int			(*fill_slave_info)(struct sk_buff *skb,
130						   const struct net_device *dev,
131						   const struct net_device *slave_dev);
132	struct net		*(*get_link_net)(const struct net_device *dev);
133	size_t			(*get_linkxstats_size)(const struct net_device *dev,
134						       int attr);
135	int			(*fill_linkxstats)(struct sk_buff *skb,
136						   const struct net_device *dev,
137						   int *prividx, int attr);
138};
139
140int __rtnl_link_register(struct rtnl_link_ops *ops);
141void __rtnl_link_unregister(struct rtnl_link_ops *ops);
142
143int rtnl_link_register(struct rtnl_link_ops *ops);
144void rtnl_link_unregister(struct rtnl_link_ops *ops);
145
146/**
147 * 	struct rtnl_af_ops - rtnetlink address family operations
148 *
149 *	@list: Used internally
150 * 	@family: Address family
151 * 	@fill_link_af: Function to fill IFLA_AF_SPEC with address family
152 * 		       specific netlink attributes.
153 * 	@get_link_af_size: Function to calculate size of address family specific
154 * 			   netlink attributes.
155 *	@validate_link_af: Validate a IFLA_AF_SPEC attribute, must check attr
156 *			   for invalid configuration settings.
157 * 	@set_link_af: Function to parse a IFLA_AF_SPEC attribute and modify
158 *		      net_device accordingly.
159 */
160struct rtnl_af_ops {
161	struct list_head	list;
162	int			family;
163
164	int			(*fill_link_af)(struct sk_buff *skb,
165						const struct net_device *dev,
166						u32 ext_filter_mask);
167	size_t			(*get_link_af_size)(const struct net_device *dev,
168						    u32 ext_filter_mask);
169
170	int			(*validate_link_af)(const struct net_device *dev,
171						    const struct nlattr *attr,
172						    struct netlink_ext_ack *extack);
173	int			(*set_link_af)(struct net_device *dev,
174					       const struct nlattr *attr,
175					       struct netlink_ext_ack *extack);
176	int			(*fill_stats_af)(struct sk_buff *skb,
177						 const struct net_device *dev);
178	size_t			(*get_stats_af_size)(const struct net_device *dev);
179};
180
181void rtnl_af_register(struct rtnl_af_ops *ops);
182void rtnl_af_unregister(struct rtnl_af_ops *ops);
183
184struct net *rtnl_link_get_net(struct net *src_net, struct nlattr *tb[]);
185struct net_device *rtnl_create_link(struct net *net, const char *ifname,
186				    unsigned char name_assign_type,
187				    const struct rtnl_link_ops *ops,
188				    struct nlattr *tb[],
189				    struct netlink_ext_ack *extack);
190int rtnl_delete_link(struct net_device *dev, u32 portid, const struct nlmsghdr *nlh);
191int rtnl_configure_link(struct net_device *dev, const struct ifinfomsg *ifm,
192			u32 portid, const struct nlmsghdr *nlh);
193
194int rtnl_nla_parse_ifinfomsg(struct nlattr **tb, const struct nlattr *nla_peer,
195			     struct netlink_ext_ack *exterr);
196struct net *rtnl_get_net_ns_capable(struct sock *sk, int netnsid);
197
198#define MODULE_ALIAS_RTNL_LINK(kind) MODULE_ALIAS("rtnl-link-" kind)
199
200#endif
201