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