• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: GPL-2.0-only
2 
3 #include <net/sock.h>
4 #include <linux/ethtool_netlink.h>
5 #include "netlink.h"
6 
7 static struct genl_family ethtool_genl_family;
8 
9 static bool ethnl_ok __read_mostly;
10 static u32 ethnl_bcast_seq;
11 
12 #define ETHTOOL_FLAGS_BASIC (ETHTOOL_FLAG_COMPACT_BITSETS |	\
13 			     ETHTOOL_FLAG_OMIT_REPLY)
14 #define ETHTOOL_FLAGS_STATS (ETHTOOL_FLAGS_BASIC | ETHTOOL_FLAG_STATS)
15 
16 const struct nla_policy ethnl_header_policy[] = {
17 	[ETHTOOL_A_HEADER_DEV_INDEX]	= { .type = NLA_U32 },
18 	[ETHTOOL_A_HEADER_DEV_NAME]	= { .type = NLA_NUL_STRING,
19 					    .len = ALTIFNAMSIZ - 1 },
20 	[ETHTOOL_A_HEADER_FLAGS]	= NLA_POLICY_MASK(NLA_U32,
21 							  ETHTOOL_FLAGS_BASIC),
22 };
23 
24 const struct nla_policy ethnl_header_policy_stats[] = {
25 	[ETHTOOL_A_HEADER_DEV_INDEX]	= { .type = NLA_U32 },
26 	[ETHTOOL_A_HEADER_DEV_NAME]	= { .type = NLA_NUL_STRING,
27 					    .len = ALTIFNAMSIZ - 1 },
28 	[ETHTOOL_A_HEADER_FLAGS]	= NLA_POLICY_MASK(NLA_U32,
29 							  ETHTOOL_FLAGS_STATS),
30 };
31 
32 /**
33  * ethnl_parse_header_dev_get() - parse request header
34  * @req_info:    structure to put results into
35  * @header:      nest attribute with request header
36  * @net:         request netns
37  * @extack:      netlink extack for error reporting
38  * @require_dev: fail if no device identified in header
39  *
40  * Parse request header in nested attribute @nest and puts results into
41  * the structure pointed to by @req_info. Extack from @info is used for error
42  * reporting. If req_info->dev is not null on return, reference to it has
43  * been taken. If error is returned, *req_info is null initialized and no
44  * reference is held.
45  *
46  * Return: 0 on success or negative error code
47  */
ethnl_parse_header_dev_get(struct ethnl_req_info * req_info,const struct nlattr * header,struct net * net,struct netlink_ext_ack * extack,bool require_dev)48 int ethnl_parse_header_dev_get(struct ethnl_req_info *req_info,
49 			       const struct nlattr *header, struct net *net,
50 			       struct netlink_ext_ack *extack, bool require_dev)
51 {
52 	struct nlattr *tb[ARRAY_SIZE(ethnl_header_policy)];
53 	const struct nlattr *devname_attr;
54 	struct net_device *dev = NULL;
55 	u32 flags = 0;
56 	int ret;
57 
58 	if (!header) {
59 		NL_SET_ERR_MSG(extack, "request header missing");
60 		return -EINVAL;
61 	}
62 	/* No validation here, command policy should have a nested policy set
63 	 * for the header, therefore validation should have already been done.
64 	 */
65 	ret = nla_parse_nested(tb, ARRAY_SIZE(ethnl_header_policy) - 1, header,
66 			       NULL, extack);
67 	if (ret < 0)
68 		return ret;
69 	if (tb[ETHTOOL_A_HEADER_FLAGS])
70 		flags = nla_get_u32(tb[ETHTOOL_A_HEADER_FLAGS]);
71 
72 	devname_attr = tb[ETHTOOL_A_HEADER_DEV_NAME];
73 	if (tb[ETHTOOL_A_HEADER_DEV_INDEX]) {
74 		u32 ifindex = nla_get_u32(tb[ETHTOOL_A_HEADER_DEV_INDEX]);
75 
76 		dev = dev_get_by_index(net, ifindex);
77 		if (!dev) {
78 			NL_SET_ERR_MSG_ATTR(extack,
79 					    tb[ETHTOOL_A_HEADER_DEV_INDEX],
80 					    "no device matches ifindex");
81 			return -ENODEV;
82 		}
83 		/* if both ifindex and ifname are passed, they must match */
84 		if (devname_attr &&
85 		    strncmp(dev->name, nla_data(devname_attr), IFNAMSIZ)) {
86 			dev_put(dev);
87 			NL_SET_ERR_MSG_ATTR(extack, header,
88 					    "ifindex and name do not match");
89 			return -ENODEV;
90 		}
91 	} else if (devname_attr) {
92 		dev = dev_get_by_name(net, nla_data(devname_attr));
93 		if (!dev) {
94 			NL_SET_ERR_MSG_ATTR(extack, devname_attr,
95 					    "no device matches name");
96 			return -ENODEV;
97 		}
98 	} else if (require_dev) {
99 		NL_SET_ERR_MSG_ATTR(extack, header,
100 				    "neither ifindex nor name specified");
101 		return -EINVAL;
102 	}
103 
104 	if (dev && !netif_device_present(dev)) {
105 		dev_put(dev);
106 		NL_SET_ERR_MSG(extack, "device not present");
107 		return -ENODEV;
108 	}
109 
110 	req_info->dev = dev;
111 	req_info->flags = flags;
112 	return 0;
113 }
114 
115 /**
116  * ethnl_fill_reply_header() - Put common header into a reply message
117  * @skb:      skb with the message
118  * @dev:      network device to describe in header
119  * @attrtype: attribute type to use for the nest
120  *
121  * Create a nested attribute with attributes describing given network device.
122  *
123  * Return: 0 on success, error value (-EMSGSIZE only) on error
124  */
ethnl_fill_reply_header(struct sk_buff * skb,struct net_device * dev,u16 attrtype)125 int ethnl_fill_reply_header(struct sk_buff *skb, struct net_device *dev,
126 			    u16 attrtype)
127 {
128 	struct nlattr *nest;
129 
130 	if (!dev)
131 		return 0;
132 	nest = nla_nest_start(skb, attrtype);
133 	if (!nest)
134 		return -EMSGSIZE;
135 
136 	if (nla_put_u32(skb, ETHTOOL_A_HEADER_DEV_INDEX, (u32)dev->ifindex) ||
137 	    nla_put_string(skb, ETHTOOL_A_HEADER_DEV_NAME, dev->name))
138 		goto nla_put_failure;
139 	/* If more attributes are put into reply header, ethnl_header_size()
140 	 * must be updated to account for them.
141 	 */
142 
143 	nla_nest_end(skb, nest);
144 	return 0;
145 
146 nla_put_failure:
147 	nla_nest_cancel(skb, nest);
148 	return -EMSGSIZE;
149 }
150 
151 /**
152  * ethnl_reply_init() - Create skb for a reply and fill device identification
153  * @payload:      payload length (without netlink and genetlink header)
154  * @dev:          device the reply is about (may be null)
155  * @cmd:          ETHTOOL_MSG_* message type for reply
156  * @hdr_attrtype: attribute type for common header
157  * @info:         genetlink info of the received packet we respond to
158  * @ehdrp:        place to store payload pointer returned by genlmsg_new()
159  *
160  * Return: pointer to allocated skb on success, NULL on error
161  */
ethnl_reply_init(size_t payload,struct net_device * dev,u8 cmd,u16 hdr_attrtype,struct genl_info * info,void ** ehdrp)162 struct sk_buff *ethnl_reply_init(size_t payload, struct net_device *dev, u8 cmd,
163 				 u16 hdr_attrtype, struct genl_info *info,
164 				 void **ehdrp)
165 {
166 	struct sk_buff *skb;
167 
168 	skb = genlmsg_new(payload, GFP_KERNEL);
169 	if (!skb)
170 		goto err;
171 	*ehdrp = genlmsg_put_reply(skb, info, &ethtool_genl_family, 0, cmd);
172 	if (!*ehdrp)
173 		goto err_free;
174 
175 	if (dev) {
176 		int ret;
177 
178 		ret = ethnl_fill_reply_header(skb, dev, hdr_attrtype);
179 		if (ret < 0)
180 			goto err_free;
181 	}
182 	return skb;
183 
184 err_free:
185 	nlmsg_free(skb);
186 err:
187 	if (info)
188 		GENL_SET_ERR_MSG(info, "failed to setup reply message");
189 	return NULL;
190 }
191 
ethnl_dump_put(struct sk_buff * skb,struct netlink_callback * cb,u8 cmd)192 void *ethnl_dump_put(struct sk_buff *skb, struct netlink_callback *cb, u8 cmd)
193 {
194 	return genlmsg_put(skb, NETLINK_CB(cb->skb).portid, cb->nlh->nlmsg_seq,
195 			   &ethtool_genl_family, 0, cmd);
196 }
197 
ethnl_bcastmsg_put(struct sk_buff * skb,u8 cmd)198 void *ethnl_bcastmsg_put(struct sk_buff *skb, u8 cmd)
199 {
200 	return genlmsg_put(skb, 0, ++ethnl_bcast_seq, &ethtool_genl_family, 0,
201 			   cmd);
202 }
203 
ethnl_multicast(struct sk_buff * skb,struct net_device * dev)204 int ethnl_multicast(struct sk_buff *skb, struct net_device *dev)
205 {
206 	return genlmsg_multicast_netns(&ethtool_genl_family, dev_net(dev), skb,
207 				       0, ETHNL_MCGRP_MONITOR, GFP_KERNEL);
208 }
209 
210 /* GET request helpers */
211 
212 /**
213  * struct ethnl_dump_ctx - context structure for generic dumpit() callback
214  * @ops:        request ops of currently processed message type
215  * @req_info:   parsed request header of processed request
216  * @reply_data: data needed to compose the reply
217  * @pos_hash:   saved iteration position - hashbucket
218  * @pos_idx:    saved iteration position - index
219  *
220  * These parameters are kept in struct netlink_callback as context preserved
221  * between iterations. They are initialized by ethnl_default_start() and used
222  * in ethnl_default_dumpit() and ethnl_default_done().
223  */
224 struct ethnl_dump_ctx {
225 	const struct ethnl_request_ops	*ops;
226 	struct ethnl_req_info		*req_info;
227 	struct ethnl_reply_data		*reply_data;
228 	int				pos_hash;
229 	int				pos_idx;
230 };
231 
232 static const struct ethnl_request_ops *
233 ethnl_default_requests[__ETHTOOL_MSG_USER_CNT] = {
234 	[ETHTOOL_MSG_STRSET_GET]	= &ethnl_strset_request_ops,
235 	[ETHTOOL_MSG_LINKINFO_GET]	= &ethnl_linkinfo_request_ops,
236 	[ETHTOOL_MSG_LINKMODES_GET]	= &ethnl_linkmodes_request_ops,
237 	[ETHTOOL_MSG_LINKSTATE_GET]	= &ethnl_linkstate_request_ops,
238 	[ETHTOOL_MSG_DEBUG_GET]		= &ethnl_debug_request_ops,
239 	[ETHTOOL_MSG_WOL_GET]		= &ethnl_wol_request_ops,
240 	[ETHTOOL_MSG_FEATURES_GET]	= &ethnl_features_request_ops,
241 	[ETHTOOL_MSG_PRIVFLAGS_GET]	= &ethnl_privflags_request_ops,
242 	[ETHTOOL_MSG_RINGS_GET]		= &ethnl_rings_request_ops,
243 	[ETHTOOL_MSG_CHANNELS_GET]	= &ethnl_channels_request_ops,
244 	[ETHTOOL_MSG_COALESCE_GET]	= &ethnl_coalesce_request_ops,
245 	[ETHTOOL_MSG_PAUSE_GET]		= &ethnl_pause_request_ops,
246 	[ETHTOOL_MSG_EEE_GET]		= &ethnl_eee_request_ops,
247 	[ETHTOOL_MSG_TSINFO_GET]	= &ethnl_tsinfo_request_ops,
248 };
249 
ethnl_dump_context(struct netlink_callback * cb)250 static struct ethnl_dump_ctx *ethnl_dump_context(struct netlink_callback *cb)
251 {
252 	return (struct ethnl_dump_ctx *)cb->ctx;
253 }
254 
255 /**
256  * ethnl_default_parse() - Parse request message
257  * @req_info:    pointer to structure to put data into
258  * @tb:		 parsed attributes
259  * @net:         request netns
260  * @request_ops: struct request_ops for request type
261  * @extack:      netlink extack for error reporting
262  * @require_dev: fail if no device identified in header
263  *
264  * Parse universal request header and call request specific ->parse_request()
265  * callback (if defined) to parse the rest of the message.
266  *
267  * Return: 0 on success or negative error code
268  */
ethnl_default_parse(struct ethnl_req_info * req_info,struct nlattr ** tb,struct net * net,const struct ethnl_request_ops * request_ops,struct netlink_ext_ack * extack,bool require_dev)269 static int ethnl_default_parse(struct ethnl_req_info *req_info,
270 			       struct nlattr **tb, struct net *net,
271 			       const struct ethnl_request_ops *request_ops,
272 			       struct netlink_ext_ack *extack, bool require_dev)
273 {
274 	int ret;
275 
276 	ret = ethnl_parse_header_dev_get(req_info, tb[request_ops->hdr_attr],
277 					 net, extack, require_dev);
278 	if (ret < 0)
279 		return ret;
280 
281 	if (request_ops->parse_request) {
282 		ret = request_ops->parse_request(req_info, tb, extack);
283 		if (ret < 0)
284 			return ret;
285 	}
286 
287 	return 0;
288 }
289 
290 /**
291  * ethnl_init_reply_data() - Initialize reply data for GET request
292  * @reply_data: pointer to embedded struct ethnl_reply_data
293  * @ops:        instance of struct ethnl_request_ops describing the layout
294  * @dev:        network device to initialize the reply for
295  *
296  * Fills the reply data part with zeros and sets the dev member. Must be called
297  * before calling the ->fill_reply() callback (for each iteration when handling
298  * dump requests).
299  */
ethnl_init_reply_data(struct ethnl_reply_data * reply_data,const struct ethnl_request_ops * ops,struct net_device * dev)300 static void ethnl_init_reply_data(struct ethnl_reply_data *reply_data,
301 				  const struct ethnl_request_ops *ops,
302 				  struct net_device *dev)
303 {
304 	memset(reply_data, 0, ops->reply_data_size);
305 	reply_data->dev = dev;
306 }
307 
308 /* default ->doit() handler for GET type requests */
ethnl_default_doit(struct sk_buff * skb,struct genl_info * info)309 static int ethnl_default_doit(struct sk_buff *skb, struct genl_info *info)
310 {
311 	struct ethnl_reply_data *reply_data = NULL;
312 	struct ethnl_req_info *req_info = NULL;
313 	const u8 cmd = info->genlhdr->cmd;
314 	const struct ethnl_request_ops *ops;
315 	struct sk_buff *rskb;
316 	void *reply_payload;
317 	int reply_len;
318 	int ret;
319 
320 	ops = ethnl_default_requests[cmd];
321 	if (WARN_ONCE(!ops, "cmd %u has no ethnl_request_ops\n", cmd))
322 		return -EOPNOTSUPP;
323 	req_info = kzalloc(ops->req_info_size, GFP_KERNEL);
324 	if (!req_info)
325 		return -ENOMEM;
326 	reply_data = kmalloc(ops->reply_data_size, GFP_KERNEL);
327 	if (!reply_data) {
328 		kfree(req_info);
329 		return -ENOMEM;
330 	}
331 
332 	ret = ethnl_default_parse(req_info, info->attrs, genl_info_net(info),
333 				  ops, info->extack, !ops->allow_nodev_do);
334 	if (ret < 0)
335 		goto err_dev;
336 	ethnl_init_reply_data(reply_data, ops, req_info->dev);
337 
338 	rtnl_lock();
339 	ret = ops->prepare_data(req_info, reply_data, info);
340 	rtnl_unlock();
341 	if (ret < 0)
342 		goto err_cleanup;
343 	ret = ops->reply_size(req_info, reply_data);
344 	if (ret < 0)
345 		goto err_cleanup;
346 	reply_len = ret + ethnl_reply_header_size();
347 	ret = -ENOMEM;
348 	rskb = ethnl_reply_init(reply_len, req_info->dev, ops->reply_cmd,
349 				ops->hdr_attr, info, &reply_payload);
350 	if (!rskb)
351 		goto err_cleanup;
352 	ret = ops->fill_reply(rskb, req_info, reply_data);
353 	if (ret < 0)
354 		goto err_msg;
355 	if (ops->cleanup_data)
356 		ops->cleanup_data(reply_data);
357 
358 	genlmsg_end(rskb, reply_payload);
359 	if (req_info->dev)
360 		dev_put(req_info->dev);
361 	kfree(reply_data);
362 	kfree(req_info);
363 	return genlmsg_reply(rskb, info);
364 
365 err_msg:
366 	WARN_ONCE(ret == -EMSGSIZE, "calculated message payload length (%d) not sufficient\n", reply_len);
367 	nlmsg_free(rskb);
368 err_cleanup:
369 	if (ops->cleanup_data)
370 		ops->cleanup_data(reply_data);
371 err_dev:
372 	if (req_info->dev)
373 		dev_put(req_info->dev);
374 	kfree(reply_data);
375 	kfree(req_info);
376 	return ret;
377 }
378 
ethnl_default_dump_one(struct sk_buff * skb,struct net_device * dev,const struct ethnl_dump_ctx * ctx,struct netlink_callback * cb)379 static int ethnl_default_dump_one(struct sk_buff *skb, struct net_device *dev,
380 				  const struct ethnl_dump_ctx *ctx,
381 				  struct netlink_callback *cb)
382 {
383 	void *ehdr;
384 	int ret;
385 
386 	ehdr = genlmsg_put(skb, NETLINK_CB(cb->skb).portid, cb->nlh->nlmsg_seq,
387 			   &ethtool_genl_family, NLM_F_MULTI,
388 			   ctx->ops->reply_cmd);
389 	if (!ehdr)
390 		return -EMSGSIZE;
391 
392 	ethnl_init_reply_data(ctx->reply_data, ctx->ops, dev);
393 	rtnl_lock();
394 	ret = ctx->ops->prepare_data(ctx->req_info, ctx->reply_data, NULL);
395 	rtnl_unlock();
396 	if (ret < 0)
397 		goto out;
398 	ret = ethnl_fill_reply_header(skb, dev, ctx->ops->hdr_attr);
399 	if (ret < 0)
400 		goto out;
401 	ret = ctx->ops->fill_reply(skb, ctx->req_info, ctx->reply_data);
402 
403 out:
404 	if (ctx->ops->cleanup_data)
405 		ctx->ops->cleanup_data(ctx->reply_data);
406 	ctx->reply_data->dev = NULL;
407 	if (ret < 0)
408 		genlmsg_cancel(skb, ehdr);
409 	else
410 		genlmsg_end(skb, ehdr);
411 	return ret;
412 }
413 
414 /* Default ->dumpit() handler for GET requests. Device iteration copied from
415  * rtnl_dump_ifinfo(); we have to be more careful about device hashtable
416  * persistence as we cannot guarantee to hold RTNL lock through the whole
417  * function as rtnetnlink does.
418  */
ethnl_default_dumpit(struct sk_buff * skb,struct netlink_callback * cb)419 static int ethnl_default_dumpit(struct sk_buff *skb,
420 				struct netlink_callback *cb)
421 {
422 	struct ethnl_dump_ctx *ctx = ethnl_dump_context(cb);
423 	struct net *net = sock_net(skb->sk);
424 	int s_idx = ctx->pos_idx;
425 	int h, idx = 0;
426 	int ret = 0;
427 
428 	rtnl_lock();
429 	for (h = ctx->pos_hash; h < NETDEV_HASHENTRIES; h++, s_idx = 0) {
430 		struct hlist_head *head;
431 		struct net_device *dev;
432 		unsigned int seq;
433 
434 		head = &net->dev_index_head[h];
435 
436 restart_chain:
437 		seq = net->dev_base_seq;
438 		cb->seq = seq;
439 		idx = 0;
440 		hlist_for_each_entry(dev, head, index_hlist) {
441 			if (idx < s_idx)
442 				goto cont;
443 			dev_hold(dev);
444 			rtnl_unlock();
445 
446 			ret = ethnl_default_dump_one(skb, dev, ctx, cb);
447 			dev_put(dev);
448 			if (ret < 0) {
449 				if (ret == -EOPNOTSUPP)
450 					goto lock_and_cont;
451 				if (likely(skb->len))
452 					ret = skb->len;
453 				goto out;
454 			}
455 lock_and_cont:
456 			rtnl_lock();
457 			if (net->dev_base_seq != seq) {
458 				s_idx = idx + 1;
459 				goto restart_chain;
460 			}
461 cont:
462 			idx++;
463 		}
464 
465 	}
466 	rtnl_unlock();
467 
468 out:
469 	ctx->pos_hash = h;
470 	ctx->pos_idx = idx;
471 	nl_dump_check_consistent(cb, nlmsg_hdr(skb));
472 
473 	return ret;
474 }
475 
476 /* generic ->start() handler for GET requests */
ethnl_default_start(struct netlink_callback * cb)477 static int ethnl_default_start(struct netlink_callback *cb)
478 {
479 	const struct genl_dumpit_info *info = genl_dumpit_info(cb);
480 	struct ethnl_dump_ctx *ctx = ethnl_dump_context(cb);
481 	struct ethnl_reply_data *reply_data;
482 	const struct ethnl_request_ops *ops;
483 	struct ethnl_req_info *req_info;
484 	struct genlmsghdr *ghdr;
485 	int ret;
486 
487 	BUILD_BUG_ON(sizeof(*ctx) > sizeof(cb->ctx));
488 
489 	ghdr = nlmsg_data(cb->nlh);
490 	ops = ethnl_default_requests[ghdr->cmd];
491 	if (WARN_ONCE(!ops, "cmd %u has no ethnl_request_ops\n", ghdr->cmd))
492 		return -EOPNOTSUPP;
493 	req_info = kzalloc(ops->req_info_size, GFP_KERNEL);
494 	if (!req_info)
495 		return -ENOMEM;
496 	reply_data = kmalloc(ops->reply_data_size, GFP_KERNEL);
497 	if (!reply_data) {
498 		ret = -ENOMEM;
499 		goto free_req_info;
500 	}
501 
502 	ret = ethnl_default_parse(req_info, info->attrs, sock_net(cb->skb->sk),
503 				  ops, cb->extack, false);
504 	if (req_info->dev) {
505 		/* We ignore device specification in dump requests but as the
506 		 * same parser as for non-dump (doit) requests is used, it
507 		 * would take reference to the device if it finds one
508 		 */
509 		dev_put(req_info->dev);
510 		req_info->dev = NULL;
511 	}
512 	if (ret < 0)
513 		goto free_reply_data;
514 
515 	ctx->ops = ops;
516 	ctx->req_info = req_info;
517 	ctx->reply_data = reply_data;
518 	ctx->pos_hash = 0;
519 	ctx->pos_idx = 0;
520 
521 	return 0;
522 
523 free_reply_data:
524 	kfree(reply_data);
525 free_req_info:
526 	kfree(req_info);
527 
528 	return ret;
529 }
530 
531 /* default ->done() handler for GET requests */
ethnl_default_done(struct netlink_callback * cb)532 static int ethnl_default_done(struct netlink_callback *cb)
533 {
534 	struct ethnl_dump_ctx *ctx = ethnl_dump_context(cb);
535 
536 	kfree(ctx->reply_data);
537 	kfree(ctx->req_info);
538 
539 	return 0;
540 }
541 
542 static const struct ethnl_request_ops *
543 ethnl_default_notify_ops[ETHTOOL_MSG_KERNEL_MAX + 1] = {
544 	[ETHTOOL_MSG_LINKINFO_NTF]	= &ethnl_linkinfo_request_ops,
545 	[ETHTOOL_MSG_LINKMODES_NTF]	= &ethnl_linkmodes_request_ops,
546 	[ETHTOOL_MSG_DEBUG_NTF]		= &ethnl_debug_request_ops,
547 	[ETHTOOL_MSG_WOL_NTF]		= &ethnl_wol_request_ops,
548 	[ETHTOOL_MSG_FEATURES_NTF]	= &ethnl_features_request_ops,
549 	[ETHTOOL_MSG_PRIVFLAGS_NTF]	= &ethnl_privflags_request_ops,
550 	[ETHTOOL_MSG_RINGS_NTF]		= &ethnl_rings_request_ops,
551 	[ETHTOOL_MSG_CHANNELS_NTF]	= &ethnl_channels_request_ops,
552 	[ETHTOOL_MSG_COALESCE_NTF]	= &ethnl_coalesce_request_ops,
553 	[ETHTOOL_MSG_PAUSE_NTF]		= &ethnl_pause_request_ops,
554 	[ETHTOOL_MSG_EEE_NTF]		= &ethnl_eee_request_ops,
555 };
556 
557 /* default notification handler */
ethnl_default_notify(struct net_device * dev,unsigned int cmd,const void * data)558 static void ethnl_default_notify(struct net_device *dev, unsigned int cmd,
559 				 const void *data)
560 {
561 	struct ethnl_reply_data *reply_data;
562 	const struct ethnl_request_ops *ops;
563 	struct ethnl_req_info *req_info;
564 	struct sk_buff *skb;
565 	void *reply_payload;
566 	int reply_len;
567 	int ret;
568 
569 	if (WARN_ONCE(cmd > ETHTOOL_MSG_KERNEL_MAX ||
570 		      !ethnl_default_notify_ops[cmd],
571 		      "unexpected notification type %u\n", cmd))
572 		return;
573 	ops = ethnl_default_notify_ops[cmd];
574 	req_info = kzalloc(ops->req_info_size, GFP_KERNEL);
575 	if (!req_info)
576 		return;
577 	reply_data = kmalloc(ops->reply_data_size, GFP_KERNEL);
578 	if (!reply_data) {
579 		kfree(req_info);
580 		return;
581 	}
582 
583 	req_info->dev = dev;
584 	req_info->flags |= ETHTOOL_FLAG_COMPACT_BITSETS;
585 
586 	ethnl_init_reply_data(reply_data, ops, dev);
587 	ret = ops->prepare_data(req_info, reply_data, NULL);
588 	if (ret < 0)
589 		goto err_cleanup;
590 	ret = ops->reply_size(req_info, reply_data);
591 	if (ret < 0)
592 		goto err_cleanup;
593 	reply_len = ret + ethnl_reply_header_size();
594 	ret = -ENOMEM;
595 	skb = genlmsg_new(reply_len, GFP_KERNEL);
596 	if (!skb)
597 		goto err_cleanup;
598 	reply_payload = ethnl_bcastmsg_put(skb, cmd);
599 	if (!reply_payload)
600 		goto err_skb;
601 	ret = ethnl_fill_reply_header(skb, dev, ops->hdr_attr);
602 	if (ret < 0)
603 		goto err_msg;
604 	ret = ops->fill_reply(skb, req_info, reply_data);
605 	if (ret < 0)
606 		goto err_msg;
607 	if (ops->cleanup_data)
608 		ops->cleanup_data(reply_data);
609 
610 	genlmsg_end(skb, reply_payload);
611 	kfree(reply_data);
612 	kfree(req_info);
613 	ethnl_multicast(skb, dev);
614 	return;
615 
616 err_msg:
617 	WARN_ONCE(ret == -EMSGSIZE,
618 		  "calculated message payload length (%d) not sufficient\n",
619 		  reply_len);
620 err_skb:
621 	nlmsg_free(skb);
622 err_cleanup:
623 	if (ops->cleanup_data)
624 		ops->cleanup_data(reply_data);
625 	kfree(reply_data);
626 	kfree(req_info);
627 	return;
628 }
629 
630 /* notifications */
631 
632 typedef void (*ethnl_notify_handler_t)(struct net_device *dev, unsigned int cmd,
633 				       const void *data);
634 
635 static const ethnl_notify_handler_t ethnl_notify_handlers[] = {
636 	[ETHTOOL_MSG_LINKINFO_NTF]	= ethnl_default_notify,
637 	[ETHTOOL_MSG_LINKMODES_NTF]	= ethnl_default_notify,
638 	[ETHTOOL_MSG_DEBUG_NTF]		= ethnl_default_notify,
639 	[ETHTOOL_MSG_WOL_NTF]		= ethnl_default_notify,
640 	[ETHTOOL_MSG_FEATURES_NTF]	= ethnl_default_notify,
641 	[ETHTOOL_MSG_PRIVFLAGS_NTF]	= ethnl_default_notify,
642 	[ETHTOOL_MSG_RINGS_NTF]		= ethnl_default_notify,
643 	[ETHTOOL_MSG_CHANNELS_NTF]	= ethnl_default_notify,
644 	[ETHTOOL_MSG_COALESCE_NTF]	= ethnl_default_notify,
645 	[ETHTOOL_MSG_PAUSE_NTF]		= ethnl_default_notify,
646 	[ETHTOOL_MSG_EEE_NTF]		= ethnl_default_notify,
647 };
648 
ethtool_notify(struct net_device * dev,unsigned int cmd,const void * data)649 void ethtool_notify(struct net_device *dev, unsigned int cmd, const void *data)
650 {
651 	if (unlikely(!ethnl_ok))
652 		return;
653 	ASSERT_RTNL();
654 
655 	if (likely(cmd < ARRAY_SIZE(ethnl_notify_handlers) &&
656 		   ethnl_notify_handlers[cmd]))
657 		ethnl_notify_handlers[cmd](dev, cmd, data);
658 	else
659 		WARN_ONCE(1, "notification %u not implemented (dev=%s)\n",
660 			  cmd, netdev_name(dev));
661 }
662 EXPORT_SYMBOL(ethtool_notify);
663 
ethnl_notify_features(struct netdev_notifier_info * info)664 static void ethnl_notify_features(struct netdev_notifier_info *info)
665 {
666 	struct net_device *dev = netdev_notifier_info_to_dev(info);
667 
668 	ethtool_notify(dev, ETHTOOL_MSG_FEATURES_NTF, NULL);
669 }
670 
ethnl_netdev_event(struct notifier_block * this,unsigned long event,void * ptr)671 static int ethnl_netdev_event(struct notifier_block *this, unsigned long event,
672 			      void *ptr)
673 {
674 	switch (event) {
675 	case NETDEV_FEAT_CHANGE:
676 		ethnl_notify_features(ptr);
677 		break;
678 	}
679 
680 	return NOTIFY_DONE;
681 }
682 
683 static struct notifier_block ethnl_netdev_notifier = {
684 	.notifier_call = ethnl_netdev_event,
685 };
686 
687 /* genetlink setup */
688 
689 static const struct genl_ops ethtool_genl_ops[] = {
690 	{
691 		.cmd	= ETHTOOL_MSG_STRSET_GET,
692 		.doit	= ethnl_default_doit,
693 		.start	= ethnl_default_start,
694 		.dumpit	= ethnl_default_dumpit,
695 		.done	= ethnl_default_done,
696 		.policy = ethnl_strset_get_policy,
697 		.maxattr = ARRAY_SIZE(ethnl_strset_get_policy) - 1,
698 	},
699 	{
700 		.cmd	= ETHTOOL_MSG_LINKINFO_GET,
701 		.doit	= ethnl_default_doit,
702 		.start	= ethnl_default_start,
703 		.dumpit	= ethnl_default_dumpit,
704 		.done	= ethnl_default_done,
705 		.policy = ethnl_linkinfo_get_policy,
706 		.maxattr = ARRAY_SIZE(ethnl_linkinfo_get_policy) - 1,
707 	},
708 	{
709 		.cmd	= ETHTOOL_MSG_LINKINFO_SET,
710 		.flags	= GENL_UNS_ADMIN_PERM,
711 		.doit	= ethnl_set_linkinfo,
712 		.policy = ethnl_linkinfo_set_policy,
713 		.maxattr = ARRAY_SIZE(ethnl_linkinfo_set_policy) - 1,
714 	},
715 	{
716 		.cmd	= ETHTOOL_MSG_LINKMODES_GET,
717 		.doit	= ethnl_default_doit,
718 		.start	= ethnl_default_start,
719 		.dumpit	= ethnl_default_dumpit,
720 		.done	= ethnl_default_done,
721 		.policy = ethnl_linkmodes_get_policy,
722 		.maxattr = ARRAY_SIZE(ethnl_linkmodes_get_policy) - 1,
723 	},
724 	{
725 		.cmd	= ETHTOOL_MSG_LINKMODES_SET,
726 		.flags	= GENL_UNS_ADMIN_PERM,
727 		.doit	= ethnl_set_linkmodes,
728 		.policy = ethnl_linkmodes_set_policy,
729 		.maxattr = ARRAY_SIZE(ethnl_linkmodes_set_policy) - 1,
730 	},
731 	{
732 		.cmd	= ETHTOOL_MSG_LINKSTATE_GET,
733 		.doit	= ethnl_default_doit,
734 		.start	= ethnl_default_start,
735 		.dumpit	= ethnl_default_dumpit,
736 		.done	= ethnl_default_done,
737 		.policy = ethnl_linkstate_get_policy,
738 		.maxattr = ARRAY_SIZE(ethnl_linkstate_get_policy) - 1,
739 	},
740 	{
741 		.cmd	= ETHTOOL_MSG_DEBUG_GET,
742 		.doit	= ethnl_default_doit,
743 		.start	= ethnl_default_start,
744 		.dumpit	= ethnl_default_dumpit,
745 		.done	= ethnl_default_done,
746 		.policy = ethnl_debug_get_policy,
747 		.maxattr = ARRAY_SIZE(ethnl_debug_get_policy) - 1,
748 	},
749 	{
750 		.cmd	= ETHTOOL_MSG_DEBUG_SET,
751 		.flags	= GENL_UNS_ADMIN_PERM,
752 		.doit	= ethnl_set_debug,
753 		.policy = ethnl_debug_set_policy,
754 		.maxattr = ARRAY_SIZE(ethnl_debug_set_policy) - 1,
755 	},
756 	{
757 		.cmd	= ETHTOOL_MSG_WOL_GET,
758 		.flags	= GENL_UNS_ADMIN_PERM,
759 		.doit	= ethnl_default_doit,
760 		.start	= ethnl_default_start,
761 		.dumpit	= ethnl_default_dumpit,
762 		.done	= ethnl_default_done,
763 		.policy = ethnl_wol_get_policy,
764 		.maxattr = ARRAY_SIZE(ethnl_wol_get_policy) - 1,
765 	},
766 	{
767 		.cmd	= ETHTOOL_MSG_WOL_SET,
768 		.flags	= GENL_UNS_ADMIN_PERM,
769 		.doit	= ethnl_set_wol,
770 		.policy = ethnl_wol_set_policy,
771 		.maxattr = ARRAY_SIZE(ethnl_wol_set_policy) - 1,
772 	},
773 	{
774 		.cmd	= ETHTOOL_MSG_FEATURES_GET,
775 		.doit	= ethnl_default_doit,
776 		.start	= ethnl_default_start,
777 		.dumpit	= ethnl_default_dumpit,
778 		.done	= ethnl_default_done,
779 		.policy = ethnl_features_get_policy,
780 		.maxattr = ARRAY_SIZE(ethnl_features_get_policy) - 1,
781 	},
782 	{
783 		.cmd	= ETHTOOL_MSG_FEATURES_SET,
784 		.flags	= GENL_UNS_ADMIN_PERM,
785 		.doit	= ethnl_set_features,
786 		.policy = ethnl_features_set_policy,
787 		.maxattr = ARRAY_SIZE(ethnl_features_set_policy) - 1,
788 	},
789 	{
790 		.cmd	= ETHTOOL_MSG_PRIVFLAGS_GET,
791 		.doit	= ethnl_default_doit,
792 		.start	= ethnl_default_start,
793 		.dumpit	= ethnl_default_dumpit,
794 		.done	= ethnl_default_done,
795 		.policy = ethnl_privflags_get_policy,
796 		.maxattr = ARRAY_SIZE(ethnl_privflags_get_policy) - 1,
797 	},
798 	{
799 		.cmd	= ETHTOOL_MSG_PRIVFLAGS_SET,
800 		.flags	= GENL_UNS_ADMIN_PERM,
801 		.doit	= ethnl_set_privflags,
802 		.policy = ethnl_privflags_set_policy,
803 		.maxattr = ARRAY_SIZE(ethnl_privflags_set_policy) - 1,
804 	},
805 	{
806 		.cmd	= ETHTOOL_MSG_RINGS_GET,
807 		.doit	= ethnl_default_doit,
808 		.start	= ethnl_default_start,
809 		.dumpit	= ethnl_default_dumpit,
810 		.done	= ethnl_default_done,
811 		.policy = ethnl_rings_get_policy,
812 		.maxattr = ARRAY_SIZE(ethnl_rings_get_policy) - 1,
813 	},
814 	{
815 		.cmd	= ETHTOOL_MSG_RINGS_SET,
816 		.flags	= GENL_UNS_ADMIN_PERM,
817 		.doit	= ethnl_set_rings,
818 		.policy = ethnl_rings_set_policy,
819 		.maxattr = ARRAY_SIZE(ethnl_rings_set_policy) - 1,
820 	},
821 	{
822 		.cmd	= ETHTOOL_MSG_CHANNELS_GET,
823 		.doit	= ethnl_default_doit,
824 		.start	= ethnl_default_start,
825 		.dumpit	= ethnl_default_dumpit,
826 		.done	= ethnl_default_done,
827 		.policy = ethnl_channels_get_policy,
828 		.maxattr = ARRAY_SIZE(ethnl_channels_get_policy) - 1,
829 	},
830 	{
831 		.cmd	= ETHTOOL_MSG_CHANNELS_SET,
832 		.flags	= GENL_UNS_ADMIN_PERM,
833 		.doit	= ethnl_set_channels,
834 		.policy = ethnl_channels_set_policy,
835 		.maxattr = ARRAY_SIZE(ethnl_channels_set_policy) - 1,
836 	},
837 	{
838 		.cmd	= ETHTOOL_MSG_COALESCE_GET,
839 		.doit	= ethnl_default_doit,
840 		.start	= ethnl_default_start,
841 		.dumpit	= ethnl_default_dumpit,
842 		.done	= ethnl_default_done,
843 		.policy = ethnl_coalesce_get_policy,
844 		.maxattr = ARRAY_SIZE(ethnl_coalesce_get_policy) - 1,
845 	},
846 	{
847 		.cmd	= ETHTOOL_MSG_COALESCE_SET,
848 		.flags	= GENL_UNS_ADMIN_PERM,
849 		.doit	= ethnl_set_coalesce,
850 		.policy = ethnl_coalesce_set_policy,
851 		.maxattr = ARRAY_SIZE(ethnl_coalesce_set_policy) - 1,
852 	},
853 	{
854 		.cmd	= ETHTOOL_MSG_PAUSE_GET,
855 		.doit	= ethnl_default_doit,
856 		.start	= ethnl_default_start,
857 		.dumpit	= ethnl_default_dumpit,
858 		.done	= ethnl_default_done,
859 		.policy = ethnl_pause_get_policy,
860 		.maxattr = ARRAY_SIZE(ethnl_pause_get_policy) - 1,
861 	},
862 	{
863 		.cmd	= ETHTOOL_MSG_PAUSE_SET,
864 		.flags	= GENL_UNS_ADMIN_PERM,
865 		.doit	= ethnl_set_pause,
866 		.policy = ethnl_pause_set_policy,
867 		.maxattr = ARRAY_SIZE(ethnl_pause_set_policy) - 1,
868 	},
869 	{
870 		.cmd	= ETHTOOL_MSG_EEE_GET,
871 		.doit	= ethnl_default_doit,
872 		.start	= ethnl_default_start,
873 		.dumpit	= ethnl_default_dumpit,
874 		.done	= ethnl_default_done,
875 		.policy = ethnl_eee_get_policy,
876 		.maxattr = ARRAY_SIZE(ethnl_eee_get_policy) - 1,
877 	},
878 	{
879 		.cmd	= ETHTOOL_MSG_EEE_SET,
880 		.flags	= GENL_UNS_ADMIN_PERM,
881 		.doit	= ethnl_set_eee,
882 		.policy = ethnl_eee_set_policy,
883 		.maxattr = ARRAY_SIZE(ethnl_eee_set_policy) - 1,
884 	},
885 	{
886 		.cmd	= ETHTOOL_MSG_TSINFO_GET,
887 		.doit	= ethnl_default_doit,
888 		.start	= ethnl_default_start,
889 		.dumpit	= ethnl_default_dumpit,
890 		.done	= ethnl_default_done,
891 		.policy = ethnl_tsinfo_get_policy,
892 		.maxattr = ARRAY_SIZE(ethnl_tsinfo_get_policy) - 1,
893 	},
894 	{
895 		.cmd	= ETHTOOL_MSG_CABLE_TEST_ACT,
896 		.flags	= GENL_UNS_ADMIN_PERM,
897 		.doit	= ethnl_act_cable_test,
898 		.policy = ethnl_cable_test_act_policy,
899 		.maxattr = ARRAY_SIZE(ethnl_cable_test_act_policy) - 1,
900 	},
901 	{
902 		.cmd	= ETHTOOL_MSG_CABLE_TEST_TDR_ACT,
903 		.flags	= GENL_UNS_ADMIN_PERM,
904 		.doit	= ethnl_act_cable_test_tdr,
905 		.policy = ethnl_cable_test_tdr_act_policy,
906 		.maxattr = ARRAY_SIZE(ethnl_cable_test_tdr_act_policy) - 1,
907 	},
908 	{
909 		.cmd	= ETHTOOL_MSG_TUNNEL_INFO_GET,
910 		.doit	= ethnl_tunnel_info_doit,
911 		.start	= ethnl_tunnel_info_start,
912 		.dumpit	= ethnl_tunnel_info_dumpit,
913 		.policy = ethnl_tunnel_info_get_policy,
914 		.maxattr = ARRAY_SIZE(ethnl_tunnel_info_get_policy) - 1,
915 	},
916 };
917 
918 static const struct genl_multicast_group ethtool_nl_mcgrps[] = {
919 	[ETHNL_MCGRP_MONITOR] = { .name = ETHTOOL_MCGRP_MONITOR_NAME },
920 };
921 
922 static struct genl_family ethtool_genl_family __ro_after_init = {
923 	.name		= ETHTOOL_GENL_NAME,
924 	.version	= ETHTOOL_GENL_VERSION,
925 	.netnsok	= true,
926 	.parallel_ops	= true,
927 	.ops		= ethtool_genl_ops,
928 	.n_ops		= ARRAY_SIZE(ethtool_genl_ops),
929 	.mcgrps		= ethtool_nl_mcgrps,
930 	.n_mcgrps	= ARRAY_SIZE(ethtool_nl_mcgrps),
931 };
932 
933 /* module setup */
934 
ethnl_init(void)935 static int __init ethnl_init(void)
936 {
937 	int ret;
938 
939 	ret = genl_register_family(&ethtool_genl_family);
940 	if (WARN(ret < 0, "ethtool: genetlink family registration failed"))
941 		return ret;
942 	ethnl_ok = true;
943 
944 	ret = register_netdevice_notifier(&ethnl_netdev_notifier);
945 	WARN(ret < 0, "ethtool: net device notifier registration failed");
946 	return ret;
947 }
948 
949 subsys_initcall(ethnl_init);
950