1 // SPDX-License-Identifier: GPL-2.0-only
4 #include <linux/ethtool_netlink.h>
5 #include <linux/pm_runtime.h>
8 static struct genl_family ethtool_genl_family
;
10 static bool ethnl_ok __read_mostly
;
11 static u32 ethnl_bcast_seq
;
13 #define ETHTOOL_FLAGS_BASIC (ETHTOOL_FLAG_COMPACT_BITSETS | \
14 ETHTOOL_FLAG_OMIT_REPLY)
15 #define ETHTOOL_FLAGS_STATS (ETHTOOL_FLAGS_BASIC | ETHTOOL_FLAG_STATS)
17 const struct nla_policy ethnl_header_policy
[] = {
18 [ETHTOOL_A_HEADER_DEV_INDEX
] = { .type
= NLA_U32
},
19 [ETHTOOL_A_HEADER_DEV_NAME
] = { .type
= NLA_NUL_STRING
,
20 .len
= ALTIFNAMSIZ
- 1 },
21 [ETHTOOL_A_HEADER_FLAGS
] = NLA_POLICY_MASK(NLA_U32
,
25 const struct nla_policy ethnl_header_policy_stats
[] = {
26 [ETHTOOL_A_HEADER_DEV_INDEX
] = { .type
= NLA_U32
},
27 [ETHTOOL_A_HEADER_DEV_NAME
] = { .type
= NLA_NUL_STRING
,
28 .len
= ALTIFNAMSIZ
- 1 },
29 [ETHTOOL_A_HEADER_FLAGS
] = NLA_POLICY_MASK(NLA_U32
,
33 int ethnl_ops_begin(struct net_device
*dev
)
41 pm_runtime_get_sync(dev
->dev
.parent
);
43 if (!netif_device_present(dev
) ||
44 dev
->reg_state
== NETREG_UNREGISTERING
) {
49 if (dev
->ethtool_ops
->begin
) {
50 ret
= dev
->ethtool_ops
->begin(dev
);
58 pm_runtime_put(dev
->dev
.parent
);
63 void ethnl_ops_complete(struct net_device
*dev
)
65 if (dev
->ethtool_ops
->complete
)
66 dev
->ethtool_ops
->complete(dev
);
69 pm_runtime_put(dev
->dev
.parent
);
73 * ethnl_parse_header_dev_get() - parse request header
74 * @req_info: structure to put results into
75 * @header: nest attribute with request header
77 * @extack: netlink extack for error reporting
78 * @require_dev: fail if no device identified in header
80 * Parse request header in nested attribute @nest and puts results into
81 * the structure pointed to by @req_info. Extack from @info is used for error
82 * reporting. If req_info->dev is not null on return, reference to it has
83 * been taken. If error is returned, *req_info is null initialized and no
86 * Return: 0 on success or negative error code
88 int ethnl_parse_header_dev_get(struct ethnl_req_info
*req_info
,
89 const struct nlattr
*header
, struct net
*net
,
90 struct netlink_ext_ack
*extack
, bool require_dev
)
92 struct nlattr
*tb
[ARRAY_SIZE(ethnl_header_policy
)];
93 const struct nlattr
*devname_attr
;
94 struct net_device
*dev
= NULL
;
101 NL_SET_ERR_MSG(extack
, "request header missing");
104 /* No validation here, command policy should have a nested policy set
105 * for the header, therefore validation should have already been done.
107 ret
= nla_parse_nested(tb
, ARRAY_SIZE(ethnl_header_policy
) - 1, header
,
111 if (tb
[ETHTOOL_A_HEADER_FLAGS
])
112 flags
= nla_get_u32(tb
[ETHTOOL_A_HEADER_FLAGS
]);
114 devname_attr
= tb
[ETHTOOL_A_HEADER_DEV_NAME
];
115 if (tb
[ETHTOOL_A_HEADER_DEV_INDEX
]) {
116 u32 ifindex
= nla_get_u32(tb
[ETHTOOL_A_HEADER_DEV_INDEX
]);
118 dev
= netdev_get_by_index(net
, ifindex
, &req_info
->dev_tracker
,
121 NL_SET_ERR_MSG_ATTR(extack
,
122 tb
[ETHTOOL_A_HEADER_DEV_INDEX
],
123 "no device matches ifindex");
126 /* if both ifindex and ifname are passed, they must match */
128 strncmp(dev
->name
, nla_data(devname_attr
), IFNAMSIZ
)) {
129 netdev_put(dev
, &req_info
->dev_tracker
);
130 NL_SET_ERR_MSG_ATTR(extack
, header
,
131 "ifindex and name do not match");
134 } else if (devname_attr
) {
135 dev
= netdev_get_by_name(net
, nla_data(devname_attr
),
136 &req_info
->dev_tracker
, GFP_KERNEL
);
138 NL_SET_ERR_MSG_ATTR(extack
, devname_attr
,
139 "no device matches name");
142 } else if (require_dev
) {
143 NL_SET_ERR_MSG_ATTR(extack
, header
,
144 "neither ifindex nor name specified");
149 req_info
->flags
= flags
;
154 * ethnl_fill_reply_header() - Put common header into a reply message
155 * @skb: skb with the message
156 * @dev: network device to describe in header
157 * @attrtype: attribute type to use for the nest
159 * Create a nested attribute with attributes describing given network device.
161 * Return: 0 on success, error value (-EMSGSIZE only) on error
163 int ethnl_fill_reply_header(struct sk_buff
*skb
, struct net_device
*dev
,
170 nest
= nla_nest_start(skb
, attrtype
);
174 if (nla_put_u32(skb
, ETHTOOL_A_HEADER_DEV_INDEX
, (u32
)dev
->ifindex
) ||
175 nla_put_string(skb
, ETHTOOL_A_HEADER_DEV_NAME
, dev
->name
))
176 goto nla_put_failure
;
177 /* If more attributes are put into reply header, ethnl_header_size()
178 * must be updated to account for them.
181 nla_nest_end(skb
, nest
);
185 nla_nest_cancel(skb
, nest
);
190 * ethnl_reply_init() - Create skb for a reply and fill device identification
191 * @payload: payload length (without netlink and genetlink header)
192 * @dev: device the reply is about (may be null)
193 * @cmd: ETHTOOL_MSG_* message type for reply
194 * @hdr_attrtype: attribute type for common header
195 * @info: genetlink info of the received packet we respond to
196 * @ehdrp: place to store payload pointer returned by genlmsg_new()
198 * Return: pointer to allocated skb on success, NULL on error
200 struct sk_buff
*ethnl_reply_init(size_t payload
, struct net_device
*dev
, u8 cmd
,
201 u16 hdr_attrtype
, struct genl_info
*info
,
206 skb
= genlmsg_new(payload
, GFP_KERNEL
);
209 *ehdrp
= genlmsg_put_reply(skb
, info
, ðtool_genl_family
, 0, cmd
);
216 ret
= ethnl_fill_reply_header(skb
, dev
, hdr_attrtype
);
226 GENL_SET_ERR_MSG(info
, "failed to setup reply message");
230 void *ethnl_dump_put(struct sk_buff
*skb
, struct netlink_callback
*cb
, u8 cmd
)
232 return genlmsg_put(skb
, NETLINK_CB(cb
->skb
).portid
, cb
->nlh
->nlmsg_seq
,
233 ðtool_genl_family
, 0, cmd
);
236 void *ethnl_bcastmsg_put(struct sk_buff
*skb
, u8 cmd
)
238 return genlmsg_put(skb
, 0, ++ethnl_bcast_seq
, ðtool_genl_family
, 0,
242 int ethnl_multicast(struct sk_buff
*skb
, struct net_device
*dev
)
244 return genlmsg_multicast_netns(ðtool_genl_family
, dev_net(dev
), skb
,
245 0, ETHNL_MCGRP_MONITOR
, GFP_KERNEL
);
248 /* GET request helpers */
251 * struct ethnl_dump_ctx - context structure for generic dumpit() callback
252 * @ops: request ops of currently processed message type
253 * @req_info: parsed request header of processed request
254 * @reply_data: data needed to compose the reply
255 * @pos_ifindex: saved iteration position - ifindex
257 * These parameters are kept in struct netlink_callback as context preserved
258 * between iterations. They are initialized by ethnl_default_start() and used
259 * in ethnl_default_dumpit() and ethnl_default_done().
261 struct ethnl_dump_ctx
{
262 const struct ethnl_request_ops
*ops
;
263 struct ethnl_req_info
*req_info
;
264 struct ethnl_reply_data
*reply_data
;
265 unsigned long pos_ifindex
;
268 static const struct ethnl_request_ops
*
269 ethnl_default_requests
[__ETHTOOL_MSG_USER_CNT
] = {
270 [ETHTOOL_MSG_STRSET_GET
] = ðnl_strset_request_ops
,
271 [ETHTOOL_MSG_LINKINFO_GET
] = ðnl_linkinfo_request_ops
,
272 [ETHTOOL_MSG_LINKINFO_SET
] = ðnl_linkinfo_request_ops
,
273 [ETHTOOL_MSG_LINKMODES_GET
] = ðnl_linkmodes_request_ops
,
274 [ETHTOOL_MSG_LINKMODES_SET
] = ðnl_linkmodes_request_ops
,
275 [ETHTOOL_MSG_LINKSTATE_GET
] = ðnl_linkstate_request_ops
,
276 [ETHTOOL_MSG_DEBUG_GET
] = ðnl_debug_request_ops
,
277 [ETHTOOL_MSG_DEBUG_SET
] = ðnl_debug_request_ops
,
278 [ETHTOOL_MSG_WOL_GET
] = ðnl_wol_request_ops
,
279 [ETHTOOL_MSG_WOL_SET
] = ðnl_wol_request_ops
,
280 [ETHTOOL_MSG_FEATURES_GET
] = ðnl_features_request_ops
,
281 [ETHTOOL_MSG_PRIVFLAGS_GET
] = ðnl_privflags_request_ops
,
282 [ETHTOOL_MSG_PRIVFLAGS_SET
] = ðnl_privflags_request_ops
,
283 [ETHTOOL_MSG_RINGS_GET
] = ðnl_rings_request_ops
,
284 [ETHTOOL_MSG_RINGS_SET
] = ðnl_rings_request_ops
,
285 [ETHTOOL_MSG_CHANNELS_GET
] = ðnl_channels_request_ops
,
286 [ETHTOOL_MSG_CHANNELS_SET
] = ðnl_channels_request_ops
,
287 [ETHTOOL_MSG_COALESCE_GET
] = ðnl_coalesce_request_ops
,
288 [ETHTOOL_MSG_COALESCE_SET
] = ðnl_coalesce_request_ops
,
289 [ETHTOOL_MSG_PAUSE_GET
] = ðnl_pause_request_ops
,
290 [ETHTOOL_MSG_PAUSE_SET
] = ðnl_pause_request_ops
,
291 [ETHTOOL_MSG_EEE_GET
] = ðnl_eee_request_ops
,
292 [ETHTOOL_MSG_EEE_SET
] = ðnl_eee_request_ops
,
293 [ETHTOOL_MSG_FEC_GET
] = ðnl_fec_request_ops
,
294 [ETHTOOL_MSG_FEC_SET
] = ðnl_fec_request_ops
,
295 [ETHTOOL_MSG_TSINFO_GET
] = ðnl_tsinfo_request_ops
,
296 [ETHTOOL_MSG_MODULE_EEPROM_GET
] = ðnl_module_eeprom_request_ops
,
297 [ETHTOOL_MSG_STATS_GET
] = ðnl_stats_request_ops
,
298 [ETHTOOL_MSG_PHC_VCLOCKS_GET
] = ðnl_phc_vclocks_request_ops
,
299 [ETHTOOL_MSG_MODULE_GET
] = ðnl_module_request_ops
,
300 [ETHTOOL_MSG_MODULE_SET
] = ðnl_module_request_ops
,
301 [ETHTOOL_MSG_PSE_GET
] = ðnl_pse_request_ops
,
302 [ETHTOOL_MSG_PSE_SET
] = ðnl_pse_request_ops
,
303 [ETHTOOL_MSG_RSS_GET
] = ðnl_rss_request_ops
,
304 [ETHTOOL_MSG_PLCA_GET_CFG
] = ðnl_plca_cfg_request_ops
,
305 [ETHTOOL_MSG_PLCA_SET_CFG
] = ðnl_plca_cfg_request_ops
,
306 [ETHTOOL_MSG_PLCA_GET_STATUS
] = ðnl_plca_status_request_ops
,
307 [ETHTOOL_MSG_MM_GET
] = ðnl_mm_request_ops
,
308 [ETHTOOL_MSG_MM_SET
] = ðnl_mm_request_ops
,
311 static struct ethnl_dump_ctx
*ethnl_dump_context(struct netlink_callback
*cb
)
313 return (struct ethnl_dump_ctx
*)cb
->ctx
;
317 * ethnl_default_parse() - Parse request message
318 * @req_info: pointer to structure to put data into
319 * @info: genl_info from the request
320 * @request_ops: struct request_ops for request type
321 * @require_dev: fail if no device identified in header
323 * Parse universal request header and call request specific ->parse_request()
324 * callback (if defined) to parse the rest of the message.
326 * Return: 0 on success or negative error code
328 static int ethnl_default_parse(struct ethnl_req_info
*req_info
,
329 const struct genl_info
*info
,
330 const struct ethnl_request_ops
*request_ops
,
333 struct nlattr
**tb
= info
->attrs
;
336 ret
= ethnl_parse_header_dev_get(req_info
, tb
[request_ops
->hdr_attr
],
337 genl_info_net(info
), info
->extack
,
342 if (request_ops
->parse_request
) {
343 ret
= request_ops
->parse_request(req_info
, tb
, info
->extack
);
352 * ethnl_init_reply_data() - Initialize reply data for GET request
353 * @reply_data: pointer to embedded struct ethnl_reply_data
354 * @ops: instance of struct ethnl_request_ops describing the layout
355 * @dev: network device to initialize the reply for
357 * Fills the reply data part with zeros and sets the dev member. Must be called
358 * before calling the ->fill_reply() callback (for each iteration when handling
361 static void ethnl_init_reply_data(struct ethnl_reply_data
*reply_data
,
362 const struct ethnl_request_ops
*ops
,
363 struct net_device
*dev
)
365 memset(reply_data
, 0, ops
->reply_data_size
);
366 reply_data
->dev
= dev
;
369 /* default ->doit() handler for GET type requests */
370 static int ethnl_default_doit(struct sk_buff
*skb
, struct genl_info
*info
)
372 struct ethnl_reply_data
*reply_data
= NULL
;
373 struct ethnl_req_info
*req_info
= NULL
;
374 const u8 cmd
= info
->genlhdr
->cmd
;
375 const struct ethnl_request_ops
*ops
;
376 int hdr_len
, reply_len
;
377 struct sk_buff
*rskb
;
381 ops
= ethnl_default_requests
[cmd
];
382 if (WARN_ONCE(!ops
, "cmd %u has no ethnl_request_ops\n", cmd
))
384 if (GENL_REQ_ATTR_CHECK(info
, ops
->hdr_attr
))
387 req_info
= kzalloc(ops
->req_info_size
, GFP_KERNEL
);
390 reply_data
= kmalloc(ops
->reply_data_size
, GFP_KERNEL
);
396 ret
= ethnl_default_parse(req_info
, info
, ops
, !ops
->allow_nodev_do
);
399 ethnl_init_reply_data(reply_data
, ops
, req_info
->dev
);
402 ret
= ops
->prepare_data(req_info
, reply_data
, info
);
406 ret
= ops
->reply_size(req_info
, reply_data
);
411 rskb
= ethnl_reply_init(reply_len
+ ethnl_reply_header_size(),
412 req_info
->dev
, ops
->reply_cmd
,
413 ops
->hdr_attr
, info
, &reply_payload
);
417 ret
= ops
->fill_reply(rskb
, req_info
, reply_data
);
420 WARN_ONCE(rskb
->len
- hdr_len
> reply_len
,
421 "ethnl cmd %d: calculated reply length %d, but consumed %d\n",
422 cmd
, reply_len
, rskb
->len
- hdr_len
);
423 if (ops
->cleanup_data
)
424 ops
->cleanup_data(reply_data
);
426 genlmsg_end(rskb
, reply_payload
);
427 netdev_put(req_info
->dev
, &req_info
->dev_tracker
);
430 return genlmsg_reply(rskb
, info
);
433 WARN_ONCE(ret
== -EMSGSIZE
, "calculated message payload length (%d) not sufficient\n", reply_len
);
436 if (ops
->cleanup_data
)
437 ops
->cleanup_data(reply_data
);
439 netdev_put(req_info
->dev
, &req_info
->dev_tracker
);
445 static int ethnl_default_dump_one(struct sk_buff
*skb
, struct net_device
*dev
,
446 const struct ethnl_dump_ctx
*ctx
,
447 const struct genl_info
*info
)
452 ehdr
= genlmsg_put(skb
, info
->snd_portid
, info
->snd_seq
,
453 ðtool_genl_family
, NLM_F_MULTI
,
454 ctx
->ops
->reply_cmd
);
458 ethnl_init_reply_data(ctx
->reply_data
, ctx
->ops
, dev
);
460 ret
= ctx
->ops
->prepare_data(ctx
->req_info
, ctx
->reply_data
, info
);
464 ret
= ethnl_fill_reply_header(skb
, dev
, ctx
->ops
->hdr_attr
);
467 ret
= ctx
->ops
->fill_reply(skb
, ctx
->req_info
, ctx
->reply_data
);
470 if (ctx
->ops
->cleanup_data
)
471 ctx
->ops
->cleanup_data(ctx
->reply_data
);
472 ctx
->reply_data
->dev
= NULL
;
474 genlmsg_cancel(skb
, ehdr
);
476 genlmsg_end(skb
, ehdr
);
480 /* Default ->dumpit() handler for GET requests. Device iteration copied from
481 * rtnl_dump_ifinfo(); we have to be more careful about device hashtable
482 * persistence as we cannot guarantee to hold RTNL lock through the whole
483 * function as rtnetnlink does.
485 static int ethnl_default_dumpit(struct sk_buff
*skb
,
486 struct netlink_callback
*cb
)
488 struct ethnl_dump_ctx
*ctx
= ethnl_dump_context(cb
);
489 struct net
*net
= sock_net(skb
->sk
);
490 struct net_device
*dev
;
494 for_each_netdev_dump(net
, dev
, ctx
->pos_ifindex
) {
498 ret
= ethnl_default_dump_one(skb
, dev
, ctx
, genl_info_dump(cb
));
503 if (ret
< 0 && ret
!= -EOPNOTSUPP
) {
504 if (likely(skb
->len
))
514 /* generic ->start() handler for GET requests */
515 static int ethnl_default_start(struct netlink_callback
*cb
)
517 const struct genl_dumpit_info
*info
= genl_dumpit_info(cb
);
518 struct ethnl_dump_ctx
*ctx
= ethnl_dump_context(cb
);
519 struct ethnl_reply_data
*reply_data
;
520 const struct ethnl_request_ops
*ops
;
521 struct ethnl_req_info
*req_info
;
522 struct genlmsghdr
*ghdr
;
525 BUILD_BUG_ON(sizeof(*ctx
) > sizeof(cb
->ctx
));
527 ghdr
= nlmsg_data(cb
->nlh
);
528 ops
= ethnl_default_requests
[ghdr
->cmd
];
529 if (WARN_ONCE(!ops
, "cmd %u has no ethnl_request_ops\n", ghdr
->cmd
))
531 req_info
= kzalloc(ops
->req_info_size
, GFP_KERNEL
);
534 reply_data
= kmalloc(ops
->reply_data_size
, GFP_KERNEL
);
540 ret
= ethnl_default_parse(req_info
, &info
->info
, ops
, false);
542 /* We ignore device specification in dump requests but as the
543 * same parser as for non-dump (doit) requests is used, it
544 * would take reference to the device if it finds one
546 netdev_put(req_info
->dev
, &req_info
->dev_tracker
);
547 req_info
->dev
= NULL
;
550 goto free_reply_data
;
553 ctx
->req_info
= req_info
;
554 ctx
->reply_data
= reply_data
;
555 ctx
->pos_ifindex
= 0;
567 /* default ->done() handler for GET requests */
568 static int ethnl_default_done(struct netlink_callback
*cb
)
570 struct ethnl_dump_ctx
*ctx
= ethnl_dump_context(cb
);
572 kfree(ctx
->reply_data
);
573 kfree(ctx
->req_info
);
578 static int ethnl_default_set_doit(struct sk_buff
*skb
, struct genl_info
*info
)
580 const struct ethnl_request_ops
*ops
;
581 struct ethnl_req_info req_info
= {};
582 const u8 cmd
= info
->genlhdr
->cmd
;
585 ops
= ethnl_default_requests
[cmd
];
586 if (WARN_ONCE(!ops
, "cmd %u has no ethnl_request_ops\n", cmd
))
588 if (GENL_REQ_ATTR_CHECK(info
, ops
->hdr_attr
))
591 ret
= ethnl_parse_header_dev_get(&req_info
, info
->attrs
[ops
->hdr_attr
],
592 genl_info_net(info
), info
->extack
,
597 if (ops
->set_validate
) {
598 ret
= ops
->set_validate(&req_info
, info
);
599 /* 0 means nothing to do */
605 ret
= ethnl_ops_begin(req_info
.dev
);
609 ret
= ops
->set(&req_info
, info
);
612 ethtool_notify(req_info
.dev
, ops
->set_ntf_cmd
, NULL
);
616 ethnl_ops_complete(req_info
.dev
);
620 ethnl_parse_header_dev_put(&req_info
);
624 static const struct ethnl_request_ops
*
625 ethnl_default_notify_ops
[ETHTOOL_MSG_KERNEL_MAX
+ 1] = {
626 [ETHTOOL_MSG_LINKINFO_NTF
] = ðnl_linkinfo_request_ops
,
627 [ETHTOOL_MSG_LINKMODES_NTF
] = ðnl_linkmodes_request_ops
,
628 [ETHTOOL_MSG_DEBUG_NTF
] = ðnl_debug_request_ops
,
629 [ETHTOOL_MSG_WOL_NTF
] = ðnl_wol_request_ops
,
630 [ETHTOOL_MSG_FEATURES_NTF
] = ðnl_features_request_ops
,
631 [ETHTOOL_MSG_PRIVFLAGS_NTF
] = ðnl_privflags_request_ops
,
632 [ETHTOOL_MSG_RINGS_NTF
] = ðnl_rings_request_ops
,
633 [ETHTOOL_MSG_CHANNELS_NTF
] = ðnl_channels_request_ops
,
634 [ETHTOOL_MSG_COALESCE_NTF
] = ðnl_coalesce_request_ops
,
635 [ETHTOOL_MSG_PAUSE_NTF
] = ðnl_pause_request_ops
,
636 [ETHTOOL_MSG_EEE_NTF
] = ðnl_eee_request_ops
,
637 [ETHTOOL_MSG_FEC_NTF
] = ðnl_fec_request_ops
,
638 [ETHTOOL_MSG_MODULE_NTF
] = ðnl_module_request_ops
,
639 [ETHTOOL_MSG_PLCA_NTF
] = ðnl_plca_cfg_request_ops
,
640 [ETHTOOL_MSG_MM_NTF
] = ðnl_mm_request_ops
,
643 /* default notification handler */
644 static void ethnl_default_notify(struct net_device
*dev
, unsigned int cmd
,
647 struct ethnl_reply_data
*reply_data
;
648 const struct ethnl_request_ops
*ops
;
649 struct ethnl_req_info
*req_info
;
650 struct genl_info info
;
656 genl_info_init_ntf(&info
, ðtool_genl_family
, cmd
);
658 if (WARN_ONCE(cmd
> ETHTOOL_MSG_KERNEL_MAX
||
659 !ethnl_default_notify_ops
[cmd
],
660 "unexpected notification type %u\n", cmd
))
662 ops
= ethnl_default_notify_ops
[cmd
];
663 req_info
= kzalloc(ops
->req_info_size
, GFP_KERNEL
);
666 reply_data
= kmalloc(ops
->reply_data_size
, GFP_KERNEL
);
673 req_info
->flags
|= ETHTOOL_FLAG_COMPACT_BITSETS
;
675 ethnl_init_reply_data(reply_data
, ops
, dev
);
676 ret
= ops
->prepare_data(req_info
, reply_data
, &info
);
679 ret
= ops
->reply_size(req_info
, reply_data
);
682 reply_len
= ret
+ ethnl_reply_header_size();
683 skb
= genlmsg_new(reply_len
, GFP_KERNEL
);
686 reply_payload
= ethnl_bcastmsg_put(skb
, cmd
);
689 ret
= ethnl_fill_reply_header(skb
, dev
, ops
->hdr_attr
);
692 ret
= ops
->fill_reply(skb
, req_info
, reply_data
);
695 if (ops
->cleanup_data
)
696 ops
->cleanup_data(reply_data
);
698 genlmsg_end(skb
, reply_payload
);
701 ethnl_multicast(skb
, dev
);
705 WARN_ONCE(ret
== -EMSGSIZE
,
706 "calculated message payload length (%d) not sufficient\n",
711 if (ops
->cleanup_data
)
712 ops
->cleanup_data(reply_data
);
720 typedef void (*ethnl_notify_handler_t
)(struct net_device
*dev
, unsigned int cmd
,
723 static const ethnl_notify_handler_t ethnl_notify_handlers
[] = {
724 [ETHTOOL_MSG_LINKINFO_NTF
] = ethnl_default_notify
,
725 [ETHTOOL_MSG_LINKMODES_NTF
] = ethnl_default_notify
,
726 [ETHTOOL_MSG_DEBUG_NTF
] = ethnl_default_notify
,
727 [ETHTOOL_MSG_WOL_NTF
] = ethnl_default_notify
,
728 [ETHTOOL_MSG_FEATURES_NTF
] = ethnl_default_notify
,
729 [ETHTOOL_MSG_PRIVFLAGS_NTF
] = ethnl_default_notify
,
730 [ETHTOOL_MSG_RINGS_NTF
] = ethnl_default_notify
,
731 [ETHTOOL_MSG_CHANNELS_NTF
] = ethnl_default_notify
,
732 [ETHTOOL_MSG_COALESCE_NTF
] = ethnl_default_notify
,
733 [ETHTOOL_MSG_PAUSE_NTF
] = ethnl_default_notify
,
734 [ETHTOOL_MSG_EEE_NTF
] = ethnl_default_notify
,
735 [ETHTOOL_MSG_FEC_NTF
] = ethnl_default_notify
,
736 [ETHTOOL_MSG_MODULE_NTF
] = ethnl_default_notify
,
737 [ETHTOOL_MSG_PLCA_NTF
] = ethnl_default_notify
,
738 [ETHTOOL_MSG_MM_NTF
] = ethnl_default_notify
,
741 void ethtool_notify(struct net_device
*dev
, unsigned int cmd
, const void *data
)
743 if (unlikely(!ethnl_ok
))
747 if (likely(cmd
< ARRAY_SIZE(ethnl_notify_handlers
) &&
748 ethnl_notify_handlers
[cmd
]))
749 ethnl_notify_handlers
[cmd
](dev
, cmd
, data
);
751 WARN_ONCE(1, "notification %u not implemented (dev=%s)\n",
752 cmd
, netdev_name(dev
));
754 EXPORT_SYMBOL(ethtool_notify
);
756 static void ethnl_notify_features(struct netdev_notifier_info
*info
)
758 struct net_device
*dev
= netdev_notifier_info_to_dev(info
);
760 ethtool_notify(dev
, ETHTOOL_MSG_FEATURES_NTF
, NULL
);
763 static int ethnl_netdev_event(struct notifier_block
*this, unsigned long event
,
767 case NETDEV_FEAT_CHANGE
:
768 ethnl_notify_features(ptr
);
775 static struct notifier_block ethnl_netdev_notifier
= {
776 .notifier_call
= ethnl_netdev_event
,
779 /* genetlink setup */
781 static const struct genl_ops ethtool_genl_ops
[] = {
783 .cmd
= ETHTOOL_MSG_STRSET_GET
,
784 .doit
= ethnl_default_doit
,
785 .start
= ethnl_default_start
,
786 .dumpit
= ethnl_default_dumpit
,
787 .done
= ethnl_default_done
,
788 .policy
= ethnl_strset_get_policy
,
789 .maxattr
= ARRAY_SIZE(ethnl_strset_get_policy
) - 1,
792 .cmd
= ETHTOOL_MSG_LINKINFO_GET
,
793 .doit
= ethnl_default_doit
,
794 .start
= ethnl_default_start
,
795 .dumpit
= ethnl_default_dumpit
,
796 .done
= ethnl_default_done
,
797 .policy
= ethnl_linkinfo_get_policy
,
798 .maxattr
= ARRAY_SIZE(ethnl_linkinfo_get_policy
) - 1,
801 .cmd
= ETHTOOL_MSG_LINKINFO_SET
,
802 .flags
= GENL_UNS_ADMIN_PERM
,
803 .doit
= ethnl_default_set_doit
,
804 .policy
= ethnl_linkinfo_set_policy
,
805 .maxattr
= ARRAY_SIZE(ethnl_linkinfo_set_policy
) - 1,
808 .cmd
= ETHTOOL_MSG_LINKMODES_GET
,
809 .doit
= ethnl_default_doit
,
810 .start
= ethnl_default_start
,
811 .dumpit
= ethnl_default_dumpit
,
812 .done
= ethnl_default_done
,
813 .policy
= ethnl_linkmodes_get_policy
,
814 .maxattr
= ARRAY_SIZE(ethnl_linkmodes_get_policy
) - 1,
817 .cmd
= ETHTOOL_MSG_LINKMODES_SET
,
818 .flags
= GENL_UNS_ADMIN_PERM
,
819 .doit
= ethnl_default_set_doit
,
820 .policy
= ethnl_linkmodes_set_policy
,
821 .maxattr
= ARRAY_SIZE(ethnl_linkmodes_set_policy
) - 1,
824 .cmd
= ETHTOOL_MSG_LINKSTATE_GET
,
825 .doit
= ethnl_default_doit
,
826 .start
= ethnl_default_start
,
827 .dumpit
= ethnl_default_dumpit
,
828 .done
= ethnl_default_done
,
829 .policy
= ethnl_linkstate_get_policy
,
830 .maxattr
= ARRAY_SIZE(ethnl_linkstate_get_policy
) - 1,
833 .cmd
= ETHTOOL_MSG_DEBUG_GET
,
834 .doit
= ethnl_default_doit
,
835 .start
= ethnl_default_start
,
836 .dumpit
= ethnl_default_dumpit
,
837 .done
= ethnl_default_done
,
838 .policy
= ethnl_debug_get_policy
,
839 .maxattr
= ARRAY_SIZE(ethnl_debug_get_policy
) - 1,
842 .cmd
= ETHTOOL_MSG_DEBUG_SET
,
843 .flags
= GENL_UNS_ADMIN_PERM
,
844 .doit
= ethnl_default_set_doit
,
845 .policy
= ethnl_debug_set_policy
,
846 .maxattr
= ARRAY_SIZE(ethnl_debug_set_policy
) - 1,
849 .cmd
= ETHTOOL_MSG_WOL_GET
,
850 .flags
= GENL_UNS_ADMIN_PERM
,
851 .doit
= ethnl_default_doit
,
852 .start
= ethnl_default_start
,
853 .dumpit
= ethnl_default_dumpit
,
854 .done
= ethnl_default_done
,
855 .policy
= ethnl_wol_get_policy
,
856 .maxattr
= ARRAY_SIZE(ethnl_wol_get_policy
) - 1,
859 .cmd
= ETHTOOL_MSG_WOL_SET
,
860 .flags
= GENL_UNS_ADMIN_PERM
,
861 .doit
= ethnl_default_set_doit
,
862 .policy
= ethnl_wol_set_policy
,
863 .maxattr
= ARRAY_SIZE(ethnl_wol_set_policy
) - 1,
866 .cmd
= ETHTOOL_MSG_FEATURES_GET
,
867 .doit
= ethnl_default_doit
,
868 .start
= ethnl_default_start
,
869 .dumpit
= ethnl_default_dumpit
,
870 .done
= ethnl_default_done
,
871 .policy
= ethnl_features_get_policy
,
872 .maxattr
= ARRAY_SIZE(ethnl_features_get_policy
) - 1,
875 .cmd
= ETHTOOL_MSG_FEATURES_SET
,
876 .flags
= GENL_UNS_ADMIN_PERM
,
877 .doit
= ethnl_set_features
,
878 .policy
= ethnl_features_set_policy
,
879 .maxattr
= ARRAY_SIZE(ethnl_features_set_policy
) - 1,
882 .cmd
= ETHTOOL_MSG_PRIVFLAGS_GET
,
883 .doit
= ethnl_default_doit
,
884 .start
= ethnl_default_start
,
885 .dumpit
= ethnl_default_dumpit
,
886 .done
= ethnl_default_done
,
887 .policy
= ethnl_privflags_get_policy
,
888 .maxattr
= ARRAY_SIZE(ethnl_privflags_get_policy
) - 1,
891 .cmd
= ETHTOOL_MSG_PRIVFLAGS_SET
,
892 .flags
= GENL_UNS_ADMIN_PERM
,
893 .doit
= ethnl_default_set_doit
,
894 .policy
= ethnl_privflags_set_policy
,
895 .maxattr
= ARRAY_SIZE(ethnl_privflags_set_policy
) - 1,
898 .cmd
= ETHTOOL_MSG_RINGS_GET
,
899 .doit
= ethnl_default_doit
,
900 .start
= ethnl_default_start
,
901 .dumpit
= ethnl_default_dumpit
,
902 .done
= ethnl_default_done
,
903 .policy
= ethnl_rings_get_policy
,
904 .maxattr
= ARRAY_SIZE(ethnl_rings_get_policy
) - 1,
907 .cmd
= ETHTOOL_MSG_RINGS_SET
,
908 .flags
= GENL_UNS_ADMIN_PERM
,
909 .doit
= ethnl_default_set_doit
,
910 .policy
= ethnl_rings_set_policy
,
911 .maxattr
= ARRAY_SIZE(ethnl_rings_set_policy
) - 1,
914 .cmd
= ETHTOOL_MSG_CHANNELS_GET
,
915 .doit
= ethnl_default_doit
,
916 .start
= ethnl_default_start
,
917 .dumpit
= ethnl_default_dumpit
,
918 .done
= ethnl_default_done
,
919 .policy
= ethnl_channels_get_policy
,
920 .maxattr
= ARRAY_SIZE(ethnl_channels_get_policy
) - 1,
923 .cmd
= ETHTOOL_MSG_CHANNELS_SET
,
924 .flags
= GENL_UNS_ADMIN_PERM
,
925 .doit
= ethnl_default_set_doit
,
926 .policy
= ethnl_channels_set_policy
,
927 .maxattr
= ARRAY_SIZE(ethnl_channels_set_policy
) - 1,
930 .cmd
= ETHTOOL_MSG_COALESCE_GET
,
931 .doit
= ethnl_default_doit
,
932 .start
= ethnl_default_start
,
933 .dumpit
= ethnl_default_dumpit
,
934 .done
= ethnl_default_done
,
935 .policy
= ethnl_coalesce_get_policy
,
936 .maxattr
= ARRAY_SIZE(ethnl_coalesce_get_policy
) - 1,
939 .cmd
= ETHTOOL_MSG_COALESCE_SET
,
940 .flags
= GENL_UNS_ADMIN_PERM
,
941 .doit
= ethnl_default_set_doit
,
942 .policy
= ethnl_coalesce_set_policy
,
943 .maxattr
= ARRAY_SIZE(ethnl_coalesce_set_policy
) - 1,
946 .cmd
= ETHTOOL_MSG_PAUSE_GET
,
947 .doit
= ethnl_default_doit
,
948 .start
= ethnl_default_start
,
949 .dumpit
= ethnl_default_dumpit
,
950 .done
= ethnl_default_done
,
951 .policy
= ethnl_pause_get_policy
,
952 .maxattr
= ARRAY_SIZE(ethnl_pause_get_policy
) - 1,
955 .cmd
= ETHTOOL_MSG_PAUSE_SET
,
956 .flags
= GENL_UNS_ADMIN_PERM
,
957 .doit
= ethnl_default_set_doit
,
958 .policy
= ethnl_pause_set_policy
,
959 .maxattr
= ARRAY_SIZE(ethnl_pause_set_policy
) - 1,
962 .cmd
= ETHTOOL_MSG_EEE_GET
,
963 .doit
= ethnl_default_doit
,
964 .start
= ethnl_default_start
,
965 .dumpit
= ethnl_default_dumpit
,
966 .done
= ethnl_default_done
,
967 .policy
= ethnl_eee_get_policy
,
968 .maxattr
= ARRAY_SIZE(ethnl_eee_get_policy
) - 1,
971 .cmd
= ETHTOOL_MSG_EEE_SET
,
972 .flags
= GENL_UNS_ADMIN_PERM
,
973 .doit
= ethnl_default_set_doit
,
974 .policy
= ethnl_eee_set_policy
,
975 .maxattr
= ARRAY_SIZE(ethnl_eee_set_policy
) - 1,
978 .cmd
= ETHTOOL_MSG_TSINFO_GET
,
979 .doit
= ethnl_default_doit
,
980 .start
= ethnl_default_start
,
981 .dumpit
= ethnl_default_dumpit
,
982 .done
= ethnl_default_done
,
983 .policy
= ethnl_tsinfo_get_policy
,
984 .maxattr
= ARRAY_SIZE(ethnl_tsinfo_get_policy
) - 1,
987 .cmd
= ETHTOOL_MSG_CABLE_TEST_ACT
,
988 .flags
= GENL_UNS_ADMIN_PERM
,
989 .doit
= ethnl_act_cable_test
,
990 .policy
= ethnl_cable_test_act_policy
,
991 .maxattr
= ARRAY_SIZE(ethnl_cable_test_act_policy
) - 1,
994 .cmd
= ETHTOOL_MSG_CABLE_TEST_TDR_ACT
,
995 .flags
= GENL_UNS_ADMIN_PERM
,
996 .doit
= ethnl_act_cable_test_tdr
,
997 .policy
= ethnl_cable_test_tdr_act_policy
,
998 .maxattr
= ARRAY_SIZE(ethnl_cable_test_tdr_act_policy
) - 1,
1001 .cmd
= ETHTOOL_MSG_TUNNEL_INFO_GET
,
1002 .doit
= ethnl_tunnel_info_doit
,
1003 .start
= ethnl_tunnel_info_start
,
1004 .dumpit
= ethnl_tunnel_info_dumpit
,
1005 .policy
= ethnl_tunnel_info_get_policy
,
1006 .maxattr
= ARRAY_SIZE(ethnl_tunnel_info_get_policy
) - 1,
1009 .cmd
= ETHTOOL_MSG_FEC_GET
,
1010 .doit
= ethnl_default_doit
,
1011 .start
= ethnl_default_start
,
1012 .dumpit
= ethnl_default_dumpit
,
1013 .done
= ethnl_default_done
,
1014 .policy
= ethnl_fec_get_policy
,
1015 .maxattr
= ARRAY_SIZE(ethnl_fec_get_policy
) - 1,
1018 .cmd
= ETHTOOL_MSG_FEC_SET
,
1019 .flags
= GENL_UNS_ADMIN_PERM
,
1020 .doit
= ethnl_default_set_doit
,
1021 .policy
= ethnl_fec_set_policy
,
1022 .maxattr
= ARRAY_SIZE(ethnl_fec_set_policy
) - 1,
1025 .cmd
= ETHTOOL_MSG_MODULE_EEPROM_GET
,
1026 .flags
= GENL_UNS_ADMIN_PERM
,
1027 .doit
= ethnl_default_doit
,
1028 .start
= ethnl_default_start
,
1029 .dumpit
= ethnl_default_dumpit
,
1030 .done
= ethnl_default_done
,
1031 .policy
= ethnl_module_eeprom_get_policy
,
1032 .maxattr
= ARRAY_SIZE(ethnl_module_eeprom_get_policy
) - 1,
1035 .cmd
= ETHTOOL_MSG_STATS_GET
,
1036 .doit
= ethnl_default_doit
,
1037 .start
= ethnl_default_start
,
1038 .dumpit
= ethnl_default_dumpit
,
1039 .done
= ethnl_default_done
,
1040 .policy
= ethnl_stats_get_policy
,
1041 .maxattr
= ARRAY_SIZE(ethnl_stats_get_policy
) - 1,
1044 .cmd
= ETHTOOL_MSG_PHC_VCLOCKS_GET
,
1045 .doit
= ethnl_default_doit
,
1046 .start
= ethnl_default_start
,
1047 .dumpit
= ethnl_default_dumpit
,
1048 .done
= ethnl_default_done
,
1049 .policy
= ethnl_phc_vclocks_get_policy
,
1050 .maxattr
= ARRAY_SIZE(ethnl_phc_vclocks_get_policy
) - 1,
1053 .cmd
= ETHTOOL_MSG_MODULE_GET
,
1054 .doit
= ethnl_default_doit
,
1055 .start
= ethnl_default_start
,
1056 .dumpit
= ethnl_default_dumpit
,
1057 .done
= ethnl_default_done
,
1058 .policy
= ethnl_module_get_policy
,
1059 .maxattr
= ARRAY_SIZE(ethnl_module_get_policy
) - 1,
1062 .cmd
= ETHTOOL_MSG_MODULE_SET
,
1063 .flags
= GENL_UNS_ADMIN_PERM
,
1064 .doit
= ethnl_default_set_doit
,
1065 .policy
= ethnl_module_set_policy
,
1066 .maxattr
= ARRAY_SIZE(ethnl_module_set_policy
) - 1,
1069 .cmd
= ETHTOOL_MSG_PSE_GET
,
1070 .doit
= ethnl_default_doit
,
1071 .start
= ethnl_default_start
,
1072 .dumpit
= ethnl_default_dumpit
,
1073 .done
= ethnl_default_done
,
1074 .policy
= ethnl_pse_get_policy
,
1075 .maxattr
= ARRAY_SIZE(ethnl_pse_get_policy
) - 1,
1078 .cmd
= ETHTOOL_MSG_PSE_SET
,
1079 .flags
= GENL_UNS_ADMIN_PERM
,
1080 .doit
= ethnl_default_set_doit
,
1081 .policy
= ethnl_pse_set_policy
,
1082 .maxattr
= ARRAY_SIZE(ethnl_pse_set_policy
) - 1,
1085 .cmd
= ETHTOOL_MSG_RSS_GET
,
1086 .doit
= ethnl_default_doit
,
1087 .policy
= ethnl_rss_get_policy
,
1088 .maxattr
= ARRAY_SIZE(ethnl_rss_get_policy
) - 1,
1091 .cmd
= ETHTOOL_MSG_PLCA_GET_CFG
,
1092 .doit
= ethnl_default_doit
,
1093 .start
= ethnl_default_start
,
1094 .dumpit
= ethnl_default_dumpit
,
1095 .done
= ethnl_default_done
,
1096 .policy
= ethnl_plca_get_cfg_policy
,
1097 .maxattr
= ARRAY_SIZE(ethnl_plca_get_cfg_policy
) - 1,
1100 .cmd
= ETHTOOL_MSG_PLCA_SET_CFG
,
1101 .flags
= GENL_UNS_ADMIN_PERM
,
1102 .doit
= ethnl_default_set_doit
,
1103 .policy
= ethnl_plca_set_cfg_policy
,
1104 .maxattr
= ARRAY_SIZE(ethnl_plca_set_cfg_policy
) - 1,
1107 .cmd
= ETHTOOL_MSG_PLCA_GET_STATUS
,
1108 .doit
= ethnl_default_doit
,
1109 .start
= ethnl_default_start
,
1110 .dumpit
= ethnl_default_dumpit
,
1111 .done
= ethnl_default_done
,
1112 .policy
= ethnl_plca_get_status_policy
,
1113 .maxattr
= ARRAY_SIZE(ethnl_plca_get_status_policy
) - 1,
1116 .cmd
= ETHTOOL_MSG_MM_GET
,
1117 .doit
= ethnl_default_doit
,
1118 .start
= ethnl_default_start
,
1119 .dumpit
= ethnl_default_dumpit
,
1120 .done
= ethnl_default_done
,
1121 .policy
= ethnl_mm_get_policy
,
1122 .maxattr
= ARRAY_SIZE(ethnl_mm_get_policy
) - 1,
1125 .cmd
= ETHTOOL_MSG_MM_SET
,
1126 .flags
= GENL_UNS_ADMIN_PERM
,
1127 .doit
= ethnl_default_set_doit
,
1128 .policy
= ethnl_mm_set_policy
,
1129 .maxattr
= ARRAY_SIZE(ethnl_mm_set_policy
) - 1,
1133 static const struct genl_multicast_group ethtool_nl_mcgrps
[] = {
1134 [ETHNL_MCGRP_MONITOR
] = { .name
= ETHTOOL_MCGRP_MONITOR_NAME
},
1137 static struct genl_family ethtool_genl_family __ro_after_init
= {
1138 .name
= ETHTOOL_GENL_NAME
,
1139 .version
= ETHTOOL_GENL_VERSION
,
1141 .parallel_ops
= true,
1142 .ops
= ethtool_genl_ops
,
1143 .n_ops
= ARRAY_SIZE(ethtool_genl_ops
),
1144 .resv_start_op
= ETHTOOL_MSG_MODULE_GET
+ 1,
1145 .mcgrps
= ethtool_nl_mcgrps
,
1146 .n_mcgrps
= ARRAY_SIZE(ethtool_nl_mcgrps
),
1151 static int __init
ethnl_init(void)
1155 ret
= genl_register_family(ðtool_genl_family
);
1156 if (WARN(ret
< 0, "ethtool: genetlink family registration failed"))
1160 ret
= register_netdevice_notifier(ðnl_netdev_notifier
);
1161 WARN(ret
< 0, "ethtool: net device notifier registration failed");
1165 subsys_initcall(ethnl_init
);