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 }; 290 291 static struct ethnl_dump_ctx *ethnl_dump_context(struct netlink_callback *cb) 292 { 293 return (struct ethnl_dump_ctx *)cb->ctx; 294 } 295 296 /** 297 * ethnl_default_parse() - Parse request message 298 * @req_info: pointer to structure to put data into 299 * @tb: parsed attributes 300 * @net: request netns 301 * @request_ops: struct request_ops for request type 302 * @extack: netlink extack for error reporting 303 * @require_dev: fail if no device identified in header 304 * 305 * Parse universal request header and call request specific ->parse_request() 306 * callback (if defined) to parse the rest of the message. 307 * 308 * Return: 0 on success or negative error code 309 */ 310 static int ethnl_default_parse(struct ethnl_req_info *req_info, 311 struct nlattr **tb, struct net *net, 312 const struct ethnl_request_ops *request_ops, 313 struct netlink_ext_ack *extack, bool require_dev) 314 { 315 int ret; 316 317 ret = ethnl_parse_header_dev_get(req_info, tb[request_ops->hdr_attr], 318 net, extack, require_dev); 319 if (ret < 0) 320 return ret; 321 322 if (request_ops->parse_request) { 323 ret = request_ops->parse_request(req_info, tb, extack); 324 if (ret < 0) 325 return ret; 326 } 327 328 return 0; 329 } 330 331 /** 332 * ethnl_init_reply_data() - Initialize reply data for GET request 333 * @reply_data: pointer to embedded struct ethnl_reply_data 334 * @ops: instance of struct ethnl_request_ops describing the layout 335 * @dev: network device to initialize the reply for 336 * 337 * Fills the reply data part with zeros and sets the dev member. Must be called 338 * before calling the ->fill_reply() callback (for each iteration when handling 339 * dump requests). 340 */ 341 static void ethnl_init_reply_data(struct ethnl_reply_data *reply_data, 342 const struct ethnl_request_ops *ops, 343 struct net_device *dev) 344 { 345 memset(reply_data, 0, ops->reply_data_size); 346 reply_data->dev = dev; 347 } 348 349 /* default ->doit() handler for GET type requests */ 350 static int ethnl_default_doit(struct sk_buff *skb, struct genl_info *info) 351 { 352 struct ethnl_reply_data *reply_data = NULL; 353 struct ethnl_req_info *req_info = NULL; 354 const u8 cmd = info->genlhdr->cmd; 355 const struct ethnl_request_ops *ops; 356 int hdr_len, reply_len; 357 struct sk_buff *rskb; 358 void *reply_payload; 359 int ret; 360 361 ops = ethnl_default_requests[cmd]; 362 if (WARN_ONCE(!ops, "cmd %u has no ethnl_request_ops\n", cmd)) 363 return -EOPNOTSUPP; 364 if (GENL_REQ_ATTR_CHECK(info, ops->hdr_attr)) 365 return -EINVAL; 366 367 req_info = kzalloc(ops->req_info_size, GFP_KERNEL); 368 if (!req_info) 369 return -ENOMEM; 370 reply_data = kmalloc(ops->reply_data_size, GFP_KERNEL); 371 if (!reply_data) { 372 kfree(req_info); 373 return -ENOMEM; 374 } 375 376 ret = ethnl_default_parse(req_info, info->attrs, genl_info_net(info), 377 ops, info->extack, !ops->allow_nodev_do); 378 if (ret < 0) 379 goto err_dev; 380 ethnl_init_reply_data(reply_data, ops, req_info->dev); 381 382 rtnl_lock(); 383 ret = ops->prepare_data(req_info, reply_data, info); 384 rtnl_unlock(); 385 if (ret < 0) 386 goto err_cleanup; 387 ret = ops->reply_size(req_info, reply_data); 388 if (ret < 0) 389 goto err_cleanup; 390 reply_len = ret; 391 ret = -ENOMEM; 392 rskb = ethnl_reply_init(reply_len + ethnl_reply_header_size(), 393 req_info->dev, ops->reply_cmd, 394 ops->hdr_attr, info, &reply_payload); 395 if (!rskb) 396 goto err_cleanup; 397 hdr_len = rskb->len; 398 ret = ops->fill_reply(rskb, req_info, reply_data); 399 if (ret < 0) 400 goto err_msg; 401 WARN_ONCE(rskb->len - hdr_len > reply_len, 402 "ethnl cmd %d: calculated reply length %d, but consumed %d\n", 403 cmd, reply_len, rskb->len - hdr_len); 404 if (ops->cleanup_data) 405 ops->cleanup_data(reply_data); 406 407 genlmsg_end(rskb, reply_payload); 408 netdev_put(req_info->dev, &req_info->dev_tracker); 409 kfree(reply_data); 410 kfree(req_info); 411 return genlmsg_reply(rskb, info); 412 413 err_msg: 414 WARN_ONCE(ret == -EMSGSIZE, "calculated message payload length (%d) not sufficient\n", reply_len); 415 nlmsg_free(rskb); 416 err_cleanup: 417 if (ops->cleanup_data) 418 ops->cleanup_data(reply_data); 419 err_dev: 420 netdev_put(req_info->dev, &req_info->dev_tracker); 421 kfree(reply_data); 422 kfree(req_info); 423 return ret; 424 } 425 426 static int ethnl_default_dump_one(struct sk_buff *skb, struct net_device *dev, 427 const struct ethnl_dump_ctx *ctx, 428 struct netlink_callback *cb) 429 { 430 void *ehdr; 431 int ret; 432 433 ehdr = genlmsg_put(skb, NETLINK_CB(cb->skb).portid, cb->nlh->nlmsg_seq, 434 ðtool_genl_family, NLM_F_MULTI, 435 ctx->ops->reply_cmd); 436 if (!ehdr) 437 return -EMSGSIZE; 438 439 ethnl_init_reply_data(ctx->reply_data, ctx->ops, dev); 440 rtnl_lock(); 441 ret = ctx->ops->prepare_data(ctx->req_info, ctx->reply_data, NULL); 442 rtnl_unlock(); 443 if (ret < 0) 444 goto out; 445 ret = ethnl_fill_reply_header(skb, dev, ctx->ops->hdr_attr); 446 if (ret < 0) 447 goto out; 448 ret = ctx->ops->fill_reply(skb, ctx->req_info, ctx->reply_data); 449 450 out: 451 if (ctx->ops->cleanup_data) 452 ctx->ops->cleanup_data(ctx->reply_data); 453 ctx->reply_data->dev = NULL; 454 if (ret < 0) 455 genlmsg_cancel(skb, ehdr); 456 else 457 genlmsg_end(skb, ehdr); 458 return ret; 459 } 460 461 /* Default ->dumpit() handler for GET requests. Device iteration copied from 462 * rtnl_dump_ifinfo(); we have to be more careful about device hashtable 463 * persistence as we cannot guarantee to hold RTNL lock through the whole 464 * function as rtnetnlink does. 465 */ 466 static int ethnl_default_dumpit(struct sk_buff *skb, 467 struct netlink_callback *cb) 468 { 469 struct ethnl_dump_ctx *ctx = ethnl_dump_context(cb); 470 struct net *net = sock_net(skb->sk); 471 int s_idx = ctx->pos_idx; 472 int h, idx = 0; 473 int ret = 0; 474 475 rtnl_lock(); 476 for (h = ctx->pos_hash; h < NETDEV_HASHENTRIES; h++, s_idx = 0) { 477 struct hlist_head *head; 478 struct net_device *dev; 479 unsigned int seq; 480 481 head = &net->dev_index_head[h]; 482 483 restart_chain: 484 seq = net->dev_base_seq; 485 cb->seq = seq; 486 idx = 0; 487 hlist_for_each_entry(dev, head, index_hlist) { 488 if (idx < s_idx) 489 goto cont; 490 dev_hold(dev); 491 rtnl_unlock(); 492 493 ret = ethnl_default_dump_one(skb, dev, ctx, cb); 494 dev_put(dev); 495 if (ret < 0) { 496 if (ret == -EOPNOTSUPP) 497 goto lock_and_cont; 498 if (likely(skb->len)) 499 ret = skb->len; 500 goto out; 501 } 502 lock_and_cont: 503 rtnl_lock(); 504 if (net->dev_base_seq != seq) { 505 s_idx = idx + 1; 506 goto restart_chain; 507 } 508 cont: 509 idx++; 510 } 511 512 } 513 rtnl_unlock(); 514 515 out: 516 ctx->pos_hash = h; 517 ctx->pos_idx = idx; 518 nl_dump_check_consistent(cb, nlmsg_hdr(skb)); 519 520 return ret; 521 } 522 523 /* generic ->start() handler for GET requests */ 524 static int ethnl_default_start(struct netlink_callback *cb) 525 { 526 const struct genl_dumpit_info *info = genl_dumpit_info(cb); 527 struct ethnl_dump_ctx *ctx = ethnl_dump_context(cb); 528 struct ethnl_reply_data *reply_data; 529 const struct ethnl_request_ops *ops; 530 struct ethnl_req_info *req_info; 531 struct genlmsghdr *ghdr; 532 int ret; 533 534 BUILD_BUG_ON(sizeof(*ctx) > sizeof(cb->ctx)); 535 536 ghdr = nlmsg_data(cb->nlh); 537 ops = ethnl_default_requests[ghdr->cmd]; 538 if (WARN_ONCE(!ops, "cmd %u has no ethnl_request_ops\n", ghdr->cmd)) 539 return -EOPNOTSUPP; 540 req_info = kzalloc(ops->req_info_size, GFP_KERNEL); 541 if (!req_info) 542 return -ENOMEM; 543 reply_data = kmalloc(ops->reply_data_size, GFP_KERNEL); 544 if (!reply_data) { 545 ret = -ENOMEM; 546 goto free_req_info; 547 } 548 549 ret = ethnl_default_parse(req_info, info->attrs, sock_net(cb->skb->sk), 550 ops, cb->extack, false); 551 if (req_info->dev) { 552 /* We ignore device specification in dump requests but as the 553 * same parser as for non-dump (doit) requests is used, it 554 * would take reference to the device if it finds one 555 */ 556 netdev_put(req_info->dev, &req_info->dev_tracker); 557 req_info->dev = NULL; 558 } 559 if (ret < 0) 560 goto free_reply_data; 561 562 ctx->ops = ops; 563 ctx->req_info = req_info; 564 ctx->reply_data = reply_data; 565 ctx->pos_hash = 0; 566 ctx->pos_idx = 0; 567 568 return 0; 569 570 free_reply_data: 571 kfree(reply_data); 572 free_req_info: 573 kfree(req_info); 574 575 return ret; 576 } 577 578 /* default ->done() handler for GET requests */ 579 static int ethnl_default_done(struct netlink_callback *cb) 580 { 581 struct ethnl_dump_ctx *ctx = ethnl_dump_context(cb); 582 583 kfree(ctx->reply_data); 584 kfree(ctx->req_info); 585 586 return 0; 587 } 588 589 static const struct ethnl_request_ops * 590 ethnl_default_notify_ops[ETHTOOL_MSG_KERNEL_MAX + 1] = { 591 [ETHTOOL_MSG_LINKINFO_NTF] = ðnl_linkinfo_request_ops, 592 [ETHTOOL_MSG_LINKMODES_NTF] = ðnl_linkmodes_request_ops, 593 [ETHTOOL_MSG_DEBUG_NTF] = ðnl_debug_request_ops, 594 [ETHTOOL_MSG_WOL_NTF] = ðnl_wol_request_ops, 595 [ETHTOOL_MSG_FEATURES_NTF] = ðnl_features_request_ops, 596 [ETHTOOL_MSG_PRIVFLAGS_NTF] = ðnl_privflags_request_ops, 597 [ETHTOOL_MSG_RINGS_NTF] = ðnl_rings_request_ops, 598 [ETHTOOL_MSG_CHANNELS_NTF] = ðnl_channels_request_ops, 599 [ETHTOOL_MSG_COALESCE_NTF] = ðnl_coalesce_request_ops, 600 [ETHTOOL_MSG_PAUSE_NTF] = ðnl_pause_request_ops, 601 [ETHTOOL_MSG_EEE_NTF] = ðnl_eee_request_ops, 602 [ETHTOOL_MSG_FEC_NTF] = ðnl_fec_request_ops, 603 [ETHTOOL_MSG_MODULE_NTF] = ðnl_module_request_ops, 604 }; 605 606 /* default notification handler */ 607 static void ethnl_default_notify(struct net_device *dev, unsigned int cmd, 608 const void *data) 609 { 610 struct ethnl_reply_data *reply_data; 611 const struct ethnl_request_ops *ops; 612 struct ethnl_req_info *req_info; 613 struct sk_buff *skb; 614 void *reply_payload; 615 int reply_len; 616 int ret; 617 618 if (WARN_ONCE(cmd > ETHTOOL_MSG_KERNEL_MAX || 619 !ethnl_default_notify_ops[cmd], 620 "unexpected notification type %u\n", cmd)) 621 return; 622 ops = ethnl_default_notify_ops[cmd]; 623 req_info = kzalloc(ops->req_info_size, GFP_KERNEL); 624 if (!req_info) 625 return; 626 reply_data = kmalloc(ops->reply_data_size, GFP_KERNEL); 627 if (!reply_data) { 628 kfree(req_info); 629 return; 630 } 631 632 req_info->dev = dev; 633 req_info->flags |= ETHTOOL_FLAG_COMPACT_BITSETS; 634 635 ethnl_init_reply_data(reply_data, ops, dev); 636 ret = ops->prepare_data(req_info, reply_data, NULL); 637 if (ret < 0) 638 goto err_cleanup; 639 ret = ops->reply_size(req_info, reply_data); 640 if (ret < 0) 641 goto err_cleanup; 642 reply_len = ret + ethnl_reply_header_size(); 643 skb = genlmsg_new(reply_len, GFP_KERNEL); 644 if (!skb) 645 goto err_cleanup; 646 reply_payload = ethnl_bcastmsg_put(skb, cmd); 647 if (!reply_payload) 648 goto err_skb; 649 ret = ethnl_fill_reply_header(skb, dev, ops->hdr_attr); 650 if (ret < 0) 651 goto err_msg; 652 ret = ops->fill_reply(skb, req_info, reply_data); 653 if (ret < 0) 654 goto err_msg; 655 if (ops->cleanup_data) 656 ops->cleanup_data(reply_data); 657 658 genlmsg_end(skb, reply_payload); 659 kfree(reply_data); 660 kfree(req_info); 661 ethnl_multicast(skb, dev); 662 return; 663 664 err_msg: 665 WARN_ONCE(ret == -EMSGSIZE, 666 "calculated message payload length (%d) not sufficient\n", 667 reply_len); 668 err_skb: 669 nlmsg_free(skb); 670 err_cleanup: 671 if (ops->cleanup_data) 672 ops->cleanup_data(reply_data); 673 kfree(reply_data); 674 kfree(req_info); 675 return; 676 } 677 678 /* notifications */ 679 680 typedef void (*ethnl_notify_handler_t)(struct net_device *dev, unsigned int cmd, 681 const void *data); 682 683 static const ethnl_notify_handler_t ethnl_notify_handlers[] = { 684 [ETHTOOL_MSG_LINKINFO_NTF] = ethnl_default_notify, 685 [ETHTOOL_MSG_LINKMODES_NTF] = ethnl_default_notify, 686 [ETHTOOL_MSG_DEBUG_NTF] = ethnl_default_notify, 687 [ETHTOOL_MSG_WOL_NTF] = ethnl_default_notify, 688 [ETHTOOL_MSG_FEATURES_NTF] = ethnl_default_notify, 689 [ETHTOOL_MSG_PRIVFLAGS_NTF] = ethnl_default_notify, 690 [ETHTOOL_MSG_RINGS_NTF] = ethnl_default_notify, 691 [ETHTOOL_MSG_CHANNELS_NTF] = ethnl_default_notify, 692 [ETHTOOL_MSG_COALESCE_NTF] = ethnl_default_notify, 693 [ETHTOOL_MSG_PAUSE_NTF] = ethnl_default_notify, 694 [ETHTOOL_MSG_EEE_NTF] = ethnl_default_notify, 695 [ETHTOOL_MSG_FEC_NTF] = ethnl_default_notify, 696 [ETHTOOL_MSG_MODULE_NTF] = ethnl_default_notify, 697 }; 698 699 void ethtool_notify(struct net_device *dev, unsigned int cmd, const void *data) 700 { 701 if (unlikely(!ethnl_ok)) 702 return; 703 ASSERT_RTNL(); 704 705 if (likely(cmd < ARRAY_SIZE(ethnl_notify_handlers) && 706 ethnl_notify_handlers[cmd])) 707 ethnl_notify_handlers[cmd](dev, cmd, data); 708 else 709 WARN_ONCE(1, "notification %u not implemented (dev=%s)\n", 710 cmd, netdev_name(dev)); 711 } 712 EXPORT_SYMBOL(ethtool_notify); 713 714 static void ethnl_notify_features(struct netdev_notifier_info *info) 715 { 716 struct net_device *dev = netdev_notifier_info_to_dev(info); 717 718 ethtool_notify(dev, ETHTOOL_MSG_FEATURES_NTF, NULL); 719 } 720 721 static int ethnl_netdev_event(struct notifier_block *this, unsigned long event, 722 void *ptr) 723 { 724 switch (event) { 725 case NETDEV_FEAT_CHANGE: 726 ethnl_notify_features(ptr); 727 break; 728 } 729 730 return NOTIFY_DONE; 731 } 732 733 static struct notifier_block ethnl_netdev_notifier = { 734 .notifier_call = ethnl_netdev_event, 735 }; 736 737 /* genetlink setup */ 738 739 static const struct genl_ops ethtool_genl_ops[] = { 740 { 741 .cmd = ETHTOOL_MSG_STRSET_GET, 742 .doit = ethnl_default_doit, 743 .start = ethnl_default_start, 744 .dumpit = ethnl_default_dumpit, 745 .done = ethnl_default_done, 746 .policy = ethnl_strset_get_policy, 747 .maxattr = ARRAY_SIZE(ethnl_strset_get_policy) - 1, 748 }, 749 { 750 .cmd = ETHTOOL_MSG_LINKINFO_GET, 751 .doit = ethnl_default_doit, 752 .start = ethnl_default_start, 753 .dumpit = ethnl_default_dumpit, 754 .done = ethnl_default_done, 755 .policy = ethnl_linkinfo_get_policy, 756 .maxattr = ARRAY_SIZE(ethnl_linkinfo_get_policy) - 1, 757 }, 758 { 759 .cmd = ETHTOOL_MSG_LINKINFO_SET, 760 .flags = GENL_UNS_ADMIN_PERM, 761 .doit = ethnl_set_linkinfo, 762 .policy = ethnl_linkinfo_set_policy, 763 .maxattr = ARRAY_SIZE(ethnl_linkinfo_set_policy) - 1, 764 }, 765 { 766 .cmd = ETHTOOL_MSG_LINKMODES_GET, 767 .doit = ethnl_default_doit, 768 .start = ethnl_default_start, 769 .dumpit = ethnl_default_dumpit, 770 .done = ethnl_default_done, 771 .policy = ethnl_linkmodes_get_policy, 772 .maxattr = ARRAY_SIZE(ethnl_linkmodes_get_policy) - 1, 773 }, 774 { 775 .cmd = ETHTOOL_MSG_LINKMODES_SET, 776 .flags = GENL_UNS_ADMIN_PERM, 777 .doit = ethnl_set_linkmodes, 778 .policy = ethnl_linkmodes_set_policy, 779 .maxattr = ARRAY_SIZE(ethnl_linkmodes_set_policy) - 1, 780 }, 781 { 782 .cmd = ETHTOOL_MSG_LINKSTATE_GET, 783 .doit = ethnl_default_doit, 784 .start = ethnl_default_start, 785 .dumpit = ethnl_default_dumpit, 786 .done = ethnl_default_done, 787 .policy = ethnl_linkstate_get_policy, 788 .maxattr = ARRAY_SIZE(ethnl_linkstate_get_policy) - 1, 789 }, 790 { 791 .cmd = ETHTOOL_MSG_DEBUG_GET, 792 .doit = ethnl_default_doit, 793 .start = ethnl_default_start, 794 .dumpit = ethnl_default_dumpit, 795 .done = ethnl_default_done, 796 .policy = ethnl_debug_get_policy, 797 .maxattr = ARRAY_SIZE(ethnl_debug_get_policy) - 1, 798 }, 799 { 800 .cmd = ETHTOOL_MSG_DEBUG_SET, 801 .flags = GENL_UNS_ADMIN_PERM, 802 .doit = ethnl_set_debug, 803 .policy = ethnl_debug_set_policy, 804 .maxattr = ARRAY_SIZE(ethnl_debug_set_policy) - 1, 805 }, 806 { 807 .cmd = ETHTOOL_MSG_WOL_GET, 808 .flags = GENL_UNS_ADMIN_PERM, 809 .doit = ethnl_default_doit, 810 .start = ethnl_default_start, 811 .dumpit = ethnl_default_dumpit, 812 .done = ethnl_default_done, 813 .policy = ethnl_wol_get_policy, 814 .maxattr = ARRAY_SIZE(ethnl_wol_get_policy) - 1, 815 }, 816 { 817 .cmd = ETHTOOL_MSG_WOL_SET, 818 .flags = GENL_UNS_ADMIN_PERM, 819 .doit = ethnl_set_wol, 820 .policy = ethnl_wol_set_policy, 821 .maxattr = ARRAY_SIZE(ethnl_wol_set_policy) - 1, 822 }, 823 { 824 .cmd = ETHTOOL_MSG_FEATURES_GET, 825 .doit = ethnl_default_doit, 826 .start = ethnl_default_start, 827 .dumpit = ethnl_default_dumpit, 828 .done = ethnl_default_done, 829 .policy = ethnl_features_get_policy, 830 .maxattr = ARRAY_SIZE(ethnl_features_get_policy) - 1, 831 }, 832 { 833 .cmd = ETHTOOL_MSG_FEATURES_SET, 834 .flags = GENL_UNS_ADMIN_PERM, 835 .doit = ethnl_set_features, 836 .policy = ethnl_features_set_policy, 837 .maxattr = ARRAY_SIZE(ethnl_features_set_policy) - 1, 838 }, 839 { 840 .cmd = ETHTOOL_MSG_PRIVFLAGS_GET, 841 .doit = ethnl_default_doit, 842 .start = ethnl_default_start, 843 .dumpit = ethnl_default_dumpit, 844 .done = ethnl_default_done, 845 .policy = ethnl_privflags_get_policy, 846 .maxattr = ARRAY_SIZE(ethnl_privflags_get_policy) - 1, 847 }, 848 { 849 .cmd = ETHTOOL_MSG_PRIVFLAGS_SET, 850 .flags = GENL_UNS_ADMIN_PERM, 851 .doit = ethnl_set_privflags, 852 .policy = ethnl_privflags_set_policy, 853 .maxattr = ARRAY_SIZE(ethnl_privflags_set_policy) - 1, 854 }, 855 { 856 .cmd = ETHTOOL_MSG_RINGS_GET, 857 .doit = ethnl_default_doit, 858 .start = ethnl_default_start, 859 .dumpit = ethnl_default_dumpit, 860 .done = ethnl_default_done, 861 .policy = ethnl_rings_get_policy, 862 .maxattr = ARRAY_SIZE(ethnl_rings_get_policy) - 1, 863 }, 864 { 865 .cmd = ETHTOOL_MSG_RINGS_SET, 866 .flags = GENL_UNS_ADMIN_PERM, 867 .doit = ethnl_set_rings, 868 .policy = ethnl_rings_set_policy, 869 .maxattr = ARRAY_SIZE(ethnl_rings_set_policy) - 1, 870 }, 871 { 872 .cmd = ETHTOOL_MSG_CHANNELS_GET, 873 .doit = ethnl_default_doit, 874 .start = ethnl_default_start, 875 .dumpit = ethnl_default_dumpit, 876 .done = ethnl_default_done, 877 .policy = ethnl_channels_get_policy, 878 .maxattr = ARRAY_SIZE(ethnl_channels_get_policy) - 1, 879 }, 880 { 881 .cmd = ETHTOOL_MSG_CHANNELS_SET, 882 .flags = GENL_UNS_ADMIN_PERM, 883 .doit = ethnl_set_channels, 884 .policy = ethnl_channels_set_policy, 885 .maxattr = ARRAY_SIZE(ethnl_channels_set_policy) - 1, 886 }, 887 { 888 .cmd = ETHTOOL_MSG_COALESCE_GET, 889 .doit = ethnl_default_doit, 890 .start = ethnl_default_start, 891 .dumpit = ethnl_default_dumpit, 892 .done = ethnl_default_done, 893 .policy = ethnl_coalesce_get_policy, 894 .maxattr = ARRAY_SIZE(ethnl_coalesce_get_policy) - 1, 895 }, 896 { 897 .cmd = ETHTOOL_MSG_COALESCE_SET, 898 .flags = GENL_UNS_ADMIN_PERM, 899 .doit = ethnl_set_coalesce, 900 .policy = ethnl_coalesce_set_policy, 901 .maxattr = ARRAY_SIZE(ethnl_coalesce_set_policy) - 1, 902 }, 903 { 904 .cmd = ETHTOOL_MSG_PAUSE_GET, 905 .doit = ethnl_default_doit, 906 .start = ethnl_default_start, 907 .dumpit = ethnl_default_dumpit, 908 .done = ethnl_default_done, 909 .policy = ethnl_pause_get_policy, 910 .maxattr = ARRAY_SIZE(ethnl_pause_get_policy) - 1, 911 }, 912 { 913 .cmd = ETHTOOL_MSG_PAUSE_SET, 914 .flags = GENL_UNS_ADMIN_PERM, 915 .doit = ethnl_set_pause, 916 .policy = ethnl_pause_set_policy, 917 .maxattr = ARRAY_SIZE(ethnl_pause_set_policy) - 1, 918 }, 919 { 920 .cmd = ETHTOOL_MSG_EEE_GET, 921 .doit = ethnl_default_doit, 922 .start = ethnl_default_start, 923 .dumpit = ethnl_default_dumpit, 924 .done = ethnl_default_done, 925 .policy = ethnl_eee_get_policy, 926 .maxattr = ARRAY_SIZE(ethnl_eee_get_policy) - 1, 927 }, 928 { 929 .cmd = ETHTOOL_MSG_EEE_SET, 930 .flags = GENL_UNS_ADMIN_PERM, 931 .doit = ethnl_set_eee, 932 .policy = ethnl_eee_set_policy, 933 .maxattr = ARRAY_SIZE(ethnl_eee_set_policy) - 1, 934 }, 935 { 936 .cmd = ETHTOOL_MSG_TSINFO_GET, 937 .doit = ethnl_default_doit, 938 .start = ethnl_default_start, 939 .dumpit = ethnl_default_dumpit, 940 .done = ethnl_default_done, 941 .policy = ethnl_tsinfo_get_policy, 942 .maxattr = ARRAY_SIZE(ethnl_tsinfo_get_policy) - 1, 943 }, 944 { 945 .cmd = ETHTOOL_MSG_CABLE_TEST_ACT, 946 .flags = GENL_UNS_ADMIN_PERM, 947 .doit = ethnl_act_cable_test, 948 .policy = ethnl_cable_test_act_policy, 949 .maxattr = ARRAY_SIZE(ethnl_cable_test_act_policy) - 1, 950 }, 951 { 952 .cmd = ETHTOOL_MSG_CABLE_TEST_TDR_ACT, 953 .flags = GENL_UNS_ADMIN_PERM, 954 .doit = ethnl_act_cable_test_tdr, 955 .policy = ethnl_cable_test_tdr_act_policy, 956 .maxattr = ARRAY_SIZE(ethnl_cable_test_tdr_act_policy) - 1, 957 }, 958 { 959 .cmd = ETHTOOL_MSG_TUNNEL_INFO_GET, 960 .doit = ethnl_tunnel_info_doit, 961 .start = ethnl_tunnel_info_start, 962 .dumpit = ethnl_tunnel_info_dumpit, 963 .policy = ethnl_tunnel_info_get_policy, 964 .maxattr = ARRAY_SIZE(ethnl_tunnel_info_get_policy) - 1, 965 }, 966 { 967 .cmd = ETHTOOL_MSG_FEC_GET, 968 .doit = ethnl_default_doit, 969 .start = ethnl_default_start, 970 .dumpit = ethnl_default_dumpit, 971 .done = ethnl_default_done, 972 .policy = ethnl_fec_get_policy, 973 .maxattr = ARRAY_SIZE(ethnl_fec_get_policy) - 1, 974 }, 975 { 976 .cmd = ETHTOOL_MSG_FEC_SET, 977 .flags = GENL_UNS_ADMIN_PERM, 978 .doit = ethnl_set_fec, 979 .policy = ethnl_fec_set_policy, 980 .maxattr = ARRAY_SIZE(ethnl_fec_set_policy) - 1, 981 }, 982 { 983 .cmd = ETHTOOL_MSG_MODULE_EEPROM_GET, 984 .flags = GENL_UNS_ADMIN_PERM, 985 .doit = ethnl_default_doit, 986 .start = ethnl_default_start, 987 .dumpit = ethnl_default_dumpit, 988 .done = ethnl_default_done, 989 .policy = ethnl_module_eeprom_get_policy, 990 .maxattr = ARRAY_SIZE(ethnl_module_eeprom_get_policy) - 1, 991 }, 992 { 993 .cmd = ETHTOOL_MSG_STATS_GET, 994 .doit = ethnl_default_doit, 995 .start = ethnl_default_start, 996 .dumpit = ethnl_default_dumpit, 997 .done = ethnl_default_done, 998 .policy = ethnl_stats_get_policy, 999 .maxattr = ARRAY_SIZE(ethnl_stats_get_policy) - 1, 1000 }, 1001 { 1002 .cmd = ETHTOOL_MSG_PHC_VCLOCKS_GET, 1003 .doit = ethnl_default_doit, 1004 .start = ethnl_default_start, 1005 .dumpit = ethnl_default_dumpit, 1006 .done = ethnl_default_done, 1007 .policy = ethnl_phc_vclocks_get_policy, 1008 .maxattr = ARRAY_SIZE(ethnl_phc_vclocks_get_policy) - 1, 1009 }, 1010 { 1011 .cmd = ETHTOOL_MSG_MODULE_GET, 1012 .doit = ethnl_default_doit, 1013 .start = ethnl_default_start, 1014 .dumpit = ethnl_default_dumpit, 1015 .done = ethnl_default_done, 1016 .policy = ethnl_module_get_policy, 1017 .maxattr = ARRAY_SIZE(ethnl_module_get_policy) - 1, 1018 }, 1019 { 1020 .cmd = ETHTOOL_MSG_MODULE_SET, 1021 .flags = GENL_UNS_ADMIN_PERM, 1022 .doit = ethnl_set_module, 1023 .policy = ethnl_module_set_policy, 1024 .maxattr = ARRAY_SIZE(ethnl_module_set_policy) - 1, 1025 }, 1026 }; 1027 1028 static const struct genl_multicast_group ethtool_nl_mcgrps[] = { 1029 [ETHNL_MCGRP_MONITOR] = { .name = ETHTOOL_MCGRP_MONITOR_NAME }, 1030 }; 1031 1032 static struct genl_family ethtool_genl_family __ro_after_init = { 1033 .name = ETHTOOL_GENL_NAME, 1034 .version = ETHTOOL_GENL_VERSION, 1035 .netnsok = true, 1036 .parallel_ops = true, 1037 .ops = ethtool_genl_ops, 1038 .n_ops = ARRAY_SIZE(ethtool_genl_ops), 1039 .resv_start_op = ETHTOOL_MSG_MODULE_GET + 1, 1040 .mcgrps = ethtool_nl_mcgrps, 1041 .n_mcgrps = ARRAY_SIZE(ethtool_nl_mcgrps), 1042 }; 1043 1044 /* module setup */ 1045 1046 static int __init ethnl_init(void) 1047 { 1048 int ret; 1049 1050 ret = genl_register_family(ðtool_genl_family); 1051 if (WARN(ret < 0, "ethtool: genetlink family registration failed")) 1052 return ret; 1053 ethnl_ok = true; 1054 1055 ret = register_netdevice_notifier(ðnl_netdev_notifier); 1056 WARN(ret < 0, "ethtool: net device notifier registration failed"); 1057 return ret; 1058 } 1059 1060 subsys_initcall(ethnl_init); 1061