1 // SPDX-License-Identifier: GPL-2.0-only
4 #include <linux/ethtool_netlink.h>
7 static struct genl_family ethtool_genl_family;
9 static bool ethnl_ok __read_mostly;
10 static u32 ethnl_bcast_seq;
12 static const struct nla_policy ethnl_header_policy[ETHTOOL_A_HEADER_MAX + 1] = {
13 [ETHTOOL_A_HEADER_UNSPEC] = { .type = NLA_REJECT },
14 [ETHTOOL_A_HEADER_DEV_INDEX] = { .type = NLA_U32 },
15 [ETHTOOL_A_HEADER_DEV_NAME] = { .type = NLA_NUL_STRING,
16 .len = ALTIFNAMSIZ - 1 },
17 [ETHTOOL_A_HEADER_FLAGS] = { .type = NLA_U32 },
21 * ethnl_parse_header_dev_get() - parse request header
22 * @req_info: structure to put results into
23 * @header: nest attribute with request header
25 * @extack: netlink extack for error reporting
26 * @require_dev: fail if no device identified in header
28 * Parse request header in nested attribute @nest and puts results into
29 * the structure pointed to by @req_info. Extack from @info is used for error
30 * reporting. If req_info->dev is not null on return, reference to it has
31 * been taken. If error is returned, *req_info is null initialized and no
34 * Return: 0 on success or negative error code
36 int ethnl_parse_header_dev_get(struct ethnl_req_info *req_info,
37 const struct nlattr *header, struct net *net,
38 struct netlink_ext_ack *extack, bool require_dev)
40 struct nlattr *tb[ETHTOOL_A_HEADER_MAX + 1];
41 const struct nlattr *devname_attr;
42 struct net_device *dev = NULL;
46 NL_SET_ERR_MSG(extack, "request header missing");
49 ret = nla_parse_nested(tb, ETHTOOL_A_HEADER_MAX, header,
50 ethnl_header_policy, extack);
53 devname_attr = tb[ETHTOOL_A_HEADER_DEV_NAME];
55 if (tb[ETHTOOL_A_HEADER_DEV_INDEX]) {
56 u32 ifindex = nla_get_u32(tb[ETHTOOL_A_HEADER_DEV_INDEX]);
58 dev = dev_get_by_index(net, ifindex);
60 NL_SET_ERR_MSG_ATTR(extack,
61 tb[ETHTOOL_A_HEADER_DEV_INDEX],
62 "no device matches ifindex");
65 /* if both ifindex and ifname are passed, they must match */
67 strncmp(dev->name, nla_data(devname_attr), IFNAMSIZ)) {
69 NL_SET_ERR_MSG_ATTR(extack, header,
70 "ifindex and name do not match");
73 } else if (devname_attr) {
74 dev = dev_get_by_name(net, nla_data(devname_attr));
76 NL_SET_ERR_MSG_ATTR(extack, devname_attr,
77 "no device matches name");
80 } else if (require_dev) {
81 NL_SET_ERR_MSG_ATTR(extack, header,
82 "neither ifindex nor name specified");
86 if (dev && !netif_device_present(dev)) {
88 NL_SET_ERR_MSG(extack, "device not present");
93 if (tb[ETHTOOL_A_HEADER_FLAGS])
94 req_info->flags = nla_get_u32(tb[ETHTOOL_A_HEADER_FLAGS]);
100 * ethnl_fill_reply_header() - Put common header into a reply message
101 * @skb: skb with the message
102 * @dev: network device to describe in header
103 * @attrtype: attribute type to use for the nest
105 * Create a nested attribute with attributes describing given network device.
107 * Return: 0 on success, error value (-EMSGSIZE only) on error
109 int ethnl_fill_reply_header(struct sk_buff *skb, struct net_device *dev,
116 nest = nla_nest_start(skb, attrtype);
120 if (nla_put_u32(skb, ETHTOOL_A_HEADER_DEV_INDEX, (u32)dev->ifindex) ||
121 nla_put_string(skb, ETHTOOL_A_HEADER_DEV_NAME, dev->name))
122 goto nla_put_failure;
123 /* If more attributes are put into reply header, ethnl_header_size()
124 * must be updated to account for them.
127 nla_nest_end(skb, nest);
131 nla_nest_cancel(skb, nest);
136 * ethnl_reply_init() - Create skb for a reply and fill device identification
137 * @payload: payload length (without netlink and genetlink header)
138 * @dev: device the reply is about (may be null)
139 * @cmd: ETHTOOL_MSG_* message type for reply
140 * @hdr_attrtype: attribute type for common header
141 * @info: genetlink info of the received packet we respond to
142 * @ehdrp: place to store payload pointer returned by genlmsg_new()
144 * Return: pointer to allocated skb on success, NULL on error
146 struct sk_buff *ethnl_reply_init(size_t payload, struct net_device *dev, u8 cmd,
147 u16 hdr_attrtype, struct genl_info *info,
152 skb = genlmsg_new(payload, GFP_KERNEL);
155 *ehdrp = genlmsg_put_reply(skb, info, ðtool_genl_family, 0, cmd);
162 ret = ethnl_fill_reply_header(skb, dev, hdr_attrtype);
172 GENL_SET_ERR_MSG(info, "failed to setup reply message");
176 static void *ethnl_bcastmsg_put(struct sk_buff *skb, u8 cmd)
178 return genlmsg_put(skb, 0, ++ethnl_bcast_seq, ðtool_genl_family, 0,
182 static int ethnl_multicast(struct sk_buff *skb, struct net_device *dev)
184 return genlmsg_multicast_netns(ðtool_genl_family, dev_net(dev), skb,
185 0, ETHNL_MCGRP_MONITOR, GFP_KERNEL);
188 /* GET request helpers */
191 * struct ethnl_dump_ctx - context structure for generic dumpit() callback
192 * @ops: request ops of currently processed message type
193 * @req_info: parsed request header of processed request
194 * @reply_data: data needed to compose the reply
195 * @pos_hash: saved iteration position - hashbucket
196 * @pos_idx: saved iteration position - index
198 * These parameters are kept in struct netlink_callback as context preserved
199 * between iterations. They are initialized by ethnl_default_start() and used
200 * in ethnl_default_dumpit() and ethnl_default_done().
202 struct ethnl_dump_ctx {
203 const struct ethnl_request_ops *ops;
204 struct ethnl_req_info *req_info;
205 struct ethnl_reply_data *reply_data;
210 static const struct ethnl_request_ops *
211 ethnl_default_requests[__ETHTOOL_MSG_USER_CNT] = {
212 [ETHTOOL_MSG_STRSET_GET] = ðnl_strset_request_ops,
213 [ETHTOOL_MSG_LINKINFO_GET] = ðnl_linkinfo_request_ops,
214 [ETHTOOL_MSG_LINKMODES_GET] = ðnl_linkmodes_request_ops,
215 [ETHTOOL_MSG_LINKSTATE_GET] = ðnl_linkstate_request_ops,
216 [ETHTOOL_MSG_DEBUG_GET] = ðnl_debug_request_ops,
217 [ETHTOOL_MSG_WOL_GET] = ðnl_wol_request_ops,
220 static struct ethnl_dump_ctx *ethnl_dump_context(struct netlink_callback *cb)
222 return (struct ethnl_dump_ctx *)cb->ctx;
226 * ethnl_default_parse() - Parse request message
227 * @req_info: pointer to structure to put data into
228 * @nlhdr: pointer to request message header
229 * @net: request netns
230 * @request_ops: struct request_ops for request type
231 * @extack: netlink extack for error reporting
232 * @require_dev: fail if no device identified in header
234 * Parse universal request header and call request specific ->parse_request()
235 * callback (if defined) to parse the rest of the message.
237 * Return: 0 on success or negative error code
239 static int ethnl_default_parse(struct ethnl_req_info *req_info,
240 const struct nlmsghdr *nlhdr, struct net *net,
241 const struct ethnl_request_ops *request_ops,
242 struct netlink_ext_ack *extack, bool require_dev)
247 tb = kmalloc_array(request_ops->max_attr + 1, sizeof(tb[0]),
252 ret = nlmsg_parse(nlhdr, GENL_HDRLEN, tb, request_ops->max_attr,
253 request_ops->request_policy, extack);
256 ret = ethnl_parse_header_dev_get(req_info, tb[request_ops->hdr_attr],
257 net, extack, require_dev);
261 if (request_ops->parse_request) {
262 ret = request_ops->parse_request(req_info, tb, extack);
274 * ethnl_init_reply_data() - Initialize reply data for GET request
275 * @reply_data: pointer to embedded struct ethnl_reply_data
276 * @ops: instance of struct ethnl_request_ops describing the layout
277 * @dev: network device to initialize the reply for
279 * Fills the reply data part with zeros and sets the dev member. Must be called
280 * before calling the ->fill_reply() callback (for each iteration when handling
283 static void ethnl_init_reply_data(struct ethnl_reply_data *reply_data,
284 const struct ethnl_request_ops *ops,
285 struct net_device *dev)
287 memset(reply_data, 0, ops->reply_data_size);
288 reply_data->dev = dev;
291 /* default ->doit() handler for GET type requests */
292 static int ethnl_default_doit(struct sk_buff *skb, struct genl_info *info)
294 struct ethnl_reply_data *reply_data = NULL;
295 struct ethnl_req_info *req_info = NULL;
296 const u8 cmd = info->genlhdr->cmd;
297 const struct ethnl_request_ops *ops;
298 struct sk_buff *rskb;
303 ops = ethnl_default_requests[cmd];
304 if (WARN_ONCE(!ops, "cmd %u has no ethnl_request_ops\n", cmd))
306 req_info = kzalloc(ops->req_info_size, GFP_KERNEL);
309 reply_data = kmalloc(ops->reply_data_size, GFP_KERNEL);
315 ret = ethnl_default_parse(req_info, info->nlhdr, genl_info_net(info), ops,
316 info->extack, !ops->allow_nodev_do);
319 ethnl_init_reply_data(reply_data, ops, req_info->dev);
322 ret = ops->prepare_data(req_info, reply_data, info);
326 ret = ops->reply_size(req_info, reply_data);
331 rskb = ethnl_reply_init(reply_len, req_info->dev, ops->reply_cmd,
332 ops->hdr_attr, info, &reply_payload);
335 ret = ops->fill_reply(rskb, req_info, reply_data);
338 if (ops->cleanup_data)
339 ops->cleanup_data(reply_data);
341 genlmsg_end(rskb, reply_payload);
343 dev_put(req_info->dev);
346 return genlmsg_reply(rskb, info);
349 WARN_ONCE(ret == -EMSGSIZE, "calculated message payload length (%d) not sufficient\n", reply_len);
352 if (ops->cleanup_data)
353 ops->cleanup_data(reply_data);
356 dev_put(req_info->dev);
362 static int ethnl_default_dump_one(struct sk_buff *skb, struct net_device *dev,
363 const struct ethnl_dump_ctx *ctx)
367 ethnl_init_reply_data(ctx->reply_data, ctx->ops, dev);
369 ret = ctx->ops->prepare_data(ctx->req_info, ctx->reply_data, NULL);
373 ret = ethnl_fill_reply_header(skb, dev, ctx->ops->hdr_attr);
376 ret = ctx->ops->fill_reply(skb, ctx->req_info, ctx->reply_data);
379 if (ctx->ops->cleanup_data)
380 ctx->ops->cleanup_data(ctx->reply_data);
381 ctx->reply_data->dev = NULL;
385 /* Default ->dumpit() handler for GET requests. Device iteration copied from
386 * rtnl_dump_ifinfo(); we have to be more careful about device hashtable
387 * persistence as we cannot guarantee to hold RTNL lock through the whole
388 * function as rtnetnlink does.
390 static int ethnl_default_dumpit(struct sk_buff *skb,
391 struct netlink_callback *cb)
393 struct ethnl_dump_ctx *ctx = ethnl_dump_context(cb);
394 struct net *net = sock_net(skb->sk);
395 int s_idx = ctx->pos_idx;
401 for (h = ctx->pos_hash; h < NETDEV_HASHENTRIES; h++, s_idx = 0) {
402 struct hlist_head *head;
403 struct net_device *dev;
406 head = &net->dev_index_head[h];
409 seq = net->dev_base_seq;
412 hlist_for_each_entry(dev, head, index_hlist) {
418 ehdr = genlmsg_put(skb, NETLINK_CB(cb->skb).portid,
420 ðtool_genl_family, 0,
421 ctx->ops->reply_cmd);
427 ret = ethnl_default_dump_one(skb, dev, ctx);
430 genlmsg_cancel(skb, ehdr);
431 if (ret == -EOPNOTSUPP)
433 if (likely(skb->len))
437 genlmsg_end(skb, ehdr);
440 if (net->dev_base_seq != seq) {
454 nl_dump_check_consistent(cb, nlmsg_hdr(skb));
459 /* generic ->start() handler for GET requests */
460 static int ethnl_default_start(struct netlink_callback *cb)
462 struct ethnl_dump_ctx *ctx = ethnl_dump_context(cb);
463 struct ethnl_reply_data *reply_data;
464 const struct ethnl_request_ops *ops;
465 struct ethnl_req_info *req_info;
466 struct genlmsghdr *ghdr;
469 BUILD_BUG_ON(sizeof(*ctx) > sizeof(cb->ctx));
471 ghdr = nlmsg_data(cb->nlh);
472 ops = ethnl_default_requests[ghdr->cmd];
473 if (WARN_ONCE(!ops, "cmd %u has no ethnl_request_ops\n", ghdr->cmd))
475 req_info = kzalloc(ops->req_info_size, GFP_KERNEL);
478 reply_data = kmalloc(ops->reply_data_size, GFP_KERNEL);
484 ret = ethnl_default_parse(req_info, cb->nlh, sock_net(cb->skb->sk), ops,
487 /* We ignore device specification in dump requests but as the
488 * same parser as for non-dump (doit) requests is used, it
489 * would take reference to the device if it finds one
491 dev_put(req_info->dev);
492 req_info->dev = NULL;
495 goto free_reply_data;
498 ctx->req_info = req_info;
499 ctx->reply_data = reply_data;
513 /* default ->done() handler for GET requests */
514 static int ethnl_default_done(struct netlink_callback *cb)
516 struct ethnl_dump_ctx *ctx = ethnl_dump_context(cb);
518 kfree(ctx->reply_data);
519 kfree(ctx->req_info);
524 static const struct ethnl_request_ops *
525 ethnl_default_notify_ops[ETHTOOL_MSG_KERNEL_MAX + 1] = {
526 [ETHTOOL_MSG_LINKINFO_NTF] = ðnl_linkinfo_request_ops,
527 [ETHTOOL_MSG_LINKMODES_NTF] = ðnl_linkmodes_request_ops,
528 [ETHTOOL_MSG_DEBUG_NTF] = ðnl_debug_request_ops,
529 [ETHTOOL_MSG_WOL_NTF] = ðnl_wol_request_ops,
532 /* default notification handler */
533 static void ethnl_default_notify(struct net_device *dev, unsigned int cmd,
536 struct ethnl_reply_data *reply_data;
537 const struct ethnl_request_ops *ops;
538 struct ethnl_req_info *req_info;
544 if (WARN_ONCE(cmd > ETHTOOL_MSG_KERNEL_MAX ||
545 !ethnl_default_notify_ops[cmd],
546 "unexpected notification type %u\n", cmd))
548 ops = ethnl_default_notify_ops[cmd];
549 req_info = kzalloc(ops->req_info_size, GFP_KERNEL);
552 reply_data = kmalloc(ops->reply_data_size, GFP_KERNEL);
559 req_info->flags |= ETHTOOL_FLAG_COMPACT_BITSETS;
561 ethnl_init_reply_data(reply_data, ops, dev);
562 ret = ops->prepare_data(req_info, reply_data, NULL);
565 ret = ops->reply_size(req_info, reply_data);
570 skb = genlmsg_new(reply_len, GFP_KERNEL);
573 reply_payload = ethnl_bcastmsg_put(skb, cmd);
576 ret = ethnl_fill_reply_header(skb, dev, ops->hdr_attr);
579 ret = ops->fill_reply(skb, req_info, reply_data);
582 if (ops->cleanup_data)
583 ops->cleanup_data(reply_data);
585 genlmsg_end(skb, reply_payload);
588 ethnl_multicast(skb, dev);
592 WARN_ONCE(ret == -EMSGSIZE,
593 "calculated message payload length (%d) not sufficient\n",
598 if (ops->cleanup_data)
599 ops->cleanup_data(reply_data);
607 typedef void (*ethnl_notify_handler_t)(struct net_device *dev, unsigned int cmd,
610 static const ethnl_notify_handler_t ethnl_notify_handlers[] = {
611 [ETHTOOL_MSG_LINKINFO_NTF] = ethnl_default_notify,
612 [ETHTOOL_MSG_LINKMODES_NTF] = ethnl_default_notify,
613 [ETHTOOL_MSG_DEBUG_NTF] = ethnl_default_notify,
614 [ETHTOOL_MSG_WOL_NTF] = ethnl_default_notify,
617 void ethtool_notify(struct net_device *dev, unsigned int cmd, const void *data)
619 if (unlikely(!ethnl_ok))
623 if (likely(cmd < ARRAY_SIZE(ethnl_notify_handlers) &&
624 ethnl_notify_handlers[cmd]))
625 ethnl_notify_handlers[cmd](dev, cmd, data);
627 WARN_ONCE(1, "notification %u not implemented (dev=%s)\n",
628 cmd, netdev_name(dev));
630 EXPORT_SYMBOL(ethtool_notify);
632 /* genetlink setup */
634 static const struct genl_ops ethtool_genl_ops[] = {
636 .cmd = ETHTOOL_MSG_STRSET_GET,
637 .doit = ethnl_default_doit,
638 .start = ethnl_default_start,
639 .dumpit = ethnl_default_dumpit,
640 .done = ethnl_default_done,
643 .cmd = ETHTOOL_MSG_LINKINFO_GET,
644 .doit = ethnl_default_doit,
645 .start = ethnl_default_start,
646 .dumpit = ethnl_default_dumpit,
647 .done = ethnl_default_done,
650 .cmd = ETHTOOL_MSG_LINKINFO_SET,
651 .flags = GENL_UNS_ADMIN_PERM,
652 .doit = ethnl_set_linkinfo,
655 .cmd = ETHTOOL_MSG_LINKMODES_GET,
656 .doit = ethnl_default_doit,
657 .start = ethnl_default_start,
658 .dumpit = ethnl_default_dumpit,
659 .done = ethnl_default_done,
662 .cmd = ETHTOOL_MSG_LINKMODES_SET,
663 .flags = GENL_UNS_ADMIN_PERM,
664 .doit = ethnl_set_linkmodes,
667 .cmd = ETHTOOL_MSG_LINKSTATE_GET,
668 .doit = ethnl_default_doit,
669 .start = ethnl_default_start,
670 .dumpit = ethnl_default_dumpit,
671 .done = ethnl_default_done,
674 .cmd = ETHTOOL_MSG_DEBUG_GET,
675 .doit = ethnl_default_doit,
676 .start = ethnl_default_start,
677 .dumpit = ethnl_default_dumpit,
678 .done = ethnl_default_done,
681 .cmd = ETHTOOL_MSG_DEBUG_SET,
682 .flags = GENL_UNS_ADMIN_PERM,
683 .doit = ethnl_set_debug,
686 .cmd = ETHTOOL_MSG_WOL_GET,
687 .flags = GENL_UNS_ADMIN_PERM,
688 .doit = ethnl_default_doit,
689 .start = ethnl_default_start,
690 .dumpit = ethnl_default_dumpit,
691 .done = ethnl_default_done,
694 .cmd = ETHTOOL_MSG_WOL_SET,
695 .flags = GENL_UNS_ADMIN_PERM,
696 .doit = ethnl_set_wol,
700 static const struct genl_multicast_group ethtool_nl_mcgrps[] = {
701 [ETHNL_MCGRP_MONITOR] = { .name = ETHTOOL_MCGRP_MONITOR_NAME },
704 static struct genl_family ethtool_genl_family = {
705 .name = ETHTOOL_GENL_NAME,
706 .version = ETHTOOL_GENL_VERSION,
708 .parallel_ops = true,
709 .ops = ethtool_genl_ops,
710 .n_ops = ARRAY_SIZE(ethtool_genl_ops),
711 .mcgrps = ethtool_nl_mcgrps,
712 .n_mcgrps = ARRAY_SIZE(ethtool_nl_mcgrps),
717 static int __init ethnl_init(void)
721 ret = genl_register_family(ðtool_genl_family);
722 if (WARN(ret < 0, "ethtool: genetlink family registration failed"))
729 subsys_initcall(ethnl_init);