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