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