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