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 netdev_put(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 netdev_put(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 netdev_put(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 req_info->flags |= ETHTOOL_FLAG_COMPACT_BITSETS; 631 632 ethnl_init_reply_data(reply_data, ops, dev); 633 ret = ops->prepare_data(req_info, reply_data, NULL); 634 if (ret < 0) 635 goto err_cleanup; 636 ret = ops->reply_size(req_info, reply_data); 637 if (ret < 0) 638 goto err_cleanup; 639 reply_len = ret + ethnl_reply_header_size(); 640 skb = genlmsg_new(reply_len, GFP_KERNEL); 641 if (!skb) 642 goto err_cleanup; 643 reply_payload = ethnl_bcastmsg_put(skb, cmd); 644 if (!reply_payload) 645 goto err_skb; 646 ret = ethnl_fill_reply_header(skb, dev, ops->hdr_attr); 647 if (ret < 0) 648 goto err_msg; 649 ret = ops->fill_reply(skb, req_info, reply_data); 650 if (ret < 0) 651 goto err_msg; 652 if (ops->cleanup_data) 653 ops->cleanup_data(reply_data); 654 655 genlmsg_end(skb, reply_payload); 656 kfree(reply_data); 657 kfree(req_info); 658 ethnl_multicast(skb, dev); 659 return; 660 661 err_msg: 662 WARN_ONCE(ret == -EMSGSIZE, 663 "calculated message payload length (%d) not sufficient\n", 664 reply_len); 665 err_skb: 666 nlmsg_free(skb); 667 err_cleanup: 668 if (ops->cleanup_data) 669 ops->cleanup_data(reply_data); 670 kfree(reply_data); 671 kfree(req_info); 672 return; 673 } 674 675 /* notifications */ 676 677 typedef void (*ethnl_notify_handler_t)(struct net_device *dev, unsigned int cmd, 678 const void *data); 679 680 static const ethnl_notify_handler_t ethnl_notify_handlers[] = { 681 [ETHTOOL_MSG_LINKINFO_NTF] = ethnl_default_notify, 682 [ETHTOOL_MSG_LINKMODES_NTF] = ethnl_default_notify, 683 [ETHTOOL_MSG_DEBUG_NTF] = ethnl_default_notify, 684 [ETHTOOL_MSG_WOL_NTF] = ethnl_default_notify, 685 [ETHTOOL_MSG_FEATURES_NTF] = ethnl_default_notify, 686 [ETHTOOL_MSG_PRIVFLAGS_NTF] = ethnl_default_notify, 687 [ETHTOOL_MSG_RINGS_NTF] = ethnl_default_notify, 688 [ETHTOOL_MSG_CHANNELS_NTF] = ethnl_default_notify, 689 [ETHTOOL_MSG_COALESCE_NTF] = ethnl_default_notify, 690 [ETHTOOL_MSG_PAUSE_NTF] = ethnl_default_notify, 691 [ETHTOOL_MSG_EEE_NTF] = ethnl_default_notify, 692 [ETHTOOL_MSG_FEC_NTF] = ethnl_default_notify, 693 [ETHTOOL_MSG_MODULE_NTF] = ethnl_default_notify, 694 }; 695 696 void ethtool_notify(struct net_device *dev, unsigned int cmd, const void *data) 697 { 698 if (unlikely(!ethnl_ok)) 699 return; 700 ASSERT_RTNL(); 701 702 if (likely(cmd < ARRAY_SIZE(ethnl_notify_handlers) && 703 ethnl_notify_handlers[cmd])) 704 ethnl_notify_handlers[cmd](dev, cmd, data); 705 else 706 WARN_ONCE(1, "notification %u not implemented (dev=%s)\n", 707 cmd, netdev_name(dev)); 708 } 709 EXPORT_SYMBOL(ethtool_notify); 710 711 static void ethnl_notify_features(struct netdev_notifier_info *info) 712 { 713 struct net_device *dev = netdev_notifier_info_to_dev(info); 714 715 ethtool_notify(dev, ETHTOOL_MSG_FEATURES_NTF, NULL); 716 } 717 718 static int ethnl_netdev_event(struct notifier_block *this, unsigned long event, 719 void *ptr) 720 { 721 switch (event) { 722 case NETDEV_FEAT_CHANGE: 723 ethnl_notify_features(ptr); 724 break; 725 } 726 727 return NOTIFY_DONE; 728 } 729 730 static struct notifier_block ethnl_netdev_notifier = { 731 .notifier_call = ethnl_netdev_event, 732 }; 733 734 /* genetlink setup */ 735 736 static const struct genl_ops ethtool_genl_ops[] = { 737 { 738 .cmd = ETHTOOL_MSG_STRSET_GET, 739 .doit = ethnl_default_doit, 740 .start = ethnl_default_start, 741 .dumpit = ethnl_default_dumpit, 742 .done = ethnl_default_done, 743 .policy = ethnl_strset_get_policy, 744 .maxattr = ARRAY_SIZE(ethnl_strset_get_policy) - 1, 745 }, 746 { 747 .cmd = ETHTOOL_MSG_LINKINFO_GET, 748 .doit = ethnl_default_doit, 749 .start = ethnl_default_start, 750 .dumpit = ethnl_default_dumpit, 751 .done = ethnl_default_done, 752 .policy = ethnl_linkinfo_get_policy, 753 .maxattr = ARRAY_SIZE(ethnl_linkinfo_get_policy) - 1, 754 }, 755 { 756 .cmd = ETHTOOL_MSG_LINKINFO_SET, 757 .flags = GENL_UNS_ADMIN_PERM, 758 .doit = ethnl_set_linkinfo, 759 .policy = ethnl_linkinfo_set_policy, 760 .maxattr = ARRAY_SIZE(ethnl_linkinfo_set_policy) - 1, 761 }, 762 { 763 .cmd = ETHTOOL_MSG_LINKMODES_GET, 764 .doit = ethnl_default_doit, 765 .start = ethnl_default_start, 766 .dumpit = ethnl_default_dumpit, 767 .done = ethnl_default_done, 768 .policy = ethnl_linkmodes_get_policy, 769 .maxattr = ARRAY_SIZE(ethnl_linkmodes_get_policy) - 1, 770 }, 771 { 772 .cmd = ETHTOOL_MSG_LINKMODES_SET, 773 .flags = GENL_UNS_ADMIN_PERM, 774 .doit = ethnl_set_linkmodes, 775 .policy = ethnl_linkmodes_set_policy, 776 .maxattr = ARRAY_SIZE(ethnl_linkmodes_set_policy) - 1, 777 }, 778 { 779 .cmd = ETHTOOL_MSG_LINKSTATE_GET, 780 .doit = ethnl_default_doit, 781 .start = ethnl_default_start, 782 .dumpit = ethnl_default_dumpit, 783 .done = ethnl_default_done, 784 .policy = ethnl_linkstate_get_policy, 785 .maxattr = ARRAY_SIZE(ethnl_linkstate_get_policy) - 1, 786 }, 787 { 788 .cmd = ETHTOOL_MSG_DEBUG_GET, 789 .doit = ethnl_default_doit, 790 .start = ethnl_default_start, 791 .dumpit = ethnl_default_dumpit, 792 .done = ethnl_default_done, 793 .policy = ethnl_debug_get_policy, 794 .maxattr = ARRAY_SIZE(ethnl_debug_get_policy) - 1, 795 }, 796 { 797 .cmd = ETHTOOL_MSG_DEBUG_SET, 798 .flags = GENL_UNS_ADMIN_PERM, 799 .doit = ethnl_set_debug, 800 .policy = ethnl_debug_set_policy, 801 .maxattr = ARRAY_SIZE(ethnl_debug_set_policy) - 1, 802 }, 803 { 804 .cmd = ETHTOOL_MSG_WOL_GET, 805 .flags = GENL_UNS_ADMIN_PERM, 806 .doit = ethnl_default_doit, 807 .start = ethnl_default_start, 808 .dumpit = ethnl_default_dumpit, 809 .done = ethnl_default_done, 810 .policy = ethnl_wol_get_policy, 811 .maxattr = ARRAY_SIZE(ethnl_wol_get_policy) - 1, 812 }, 813 { 814 .cmd = ETHTOOL_MSG_WOL_SET, 815 .flags = GENL_UNS_ADMIN_PERM, 816 .doit = ethnl_set_wol, 817 .policy = ethnl_wol_set_policy, 818 .maxattr = ARRAY_SIZE(ethnl_wol_set_policy) - 1, 819 }, 820 { 821 .cmd = ETHTOOL_MSG_FEATURES_GET, 822 .doit = ethnl_default_doit, 823 .start = ethnl_default_start, 824 .dumpit = ethnl_default_dumpit, 825 .done = ethnl_default_done, 826 .policy = ethnl_features_get_policy, 827 .maxattr = ARRAY_SIZE(ethnl_features_get_policy) - 1, 828 }, 829 { 830 .cmd = ETHTOOL_MSG_FEATURES_SET, 831 .flags = GENL_UNS_ADMIN_PERM, 832 .doit = ethnl_set_features, 833 .policy = ethnl_features_set_policy, 834 .maxattr = ARRAY_SIZE(ethnl_features_set_policy) - 1, 835 }, 836 { 837 .cmd = ETHTOOL_MSG_PRIVFLAGS_GET, 838 .doit = ethnl_default_doit, 839 .start = ethnl_default_start, 840 .dumpit = ethnl_default_dumpit, 841 .done = ethnl_default_done, 842 .policy = ethnl_privflags_get_policy, 843 .maxattr = ARRAY_SIZE(ethnl_privflags_get_policy) - 1, 844 }, 845 { 846 .cmd = ETHTOOL_MSG_PRIVFLAGS_SET, 847 .flags = GENL_UNS_ADMIN_PERM, 848 .doit = ethnl_set_privflags, 849 .policy = ethnl_privflags_set_policy, 850 .maxattr = ARRAY_SIZE(ethnl_privflags_set_policy) - 1, 851 }, 852 { 853 .cmd = ETHTOOL_MSG_RINGS_GET, 854 .doit = ethnl_default_doit, 855 .start = ethnl_default_start, 856 .dumpit = ethnl_default_dumpit, 857 .done = ethnl_default_done, 858 .policy = ethnl_rings_get_policy, 859 .maxattr = ARRAY_SIZE(ethnl_rings_get_policy) - 1, 860 }, 861 { 862 .cmd = ETHTOOL_MSG_RINGS_SET, 863 .flags = GENL_UNS_ADMIN_PERM, 864 .doit = ethnl_set_rings, 865 .policy = ethnl_rings_set_policy, 866 .maxattr = ARRAY_SIZE(ethnl_rings_set_policy) - 1, 867 }, 868 { 869 .cmd = ETHTOOL_MSG_CHANNELS_GET, 870 .doit = ethnl_default_doit, 871 .start = ethnl_default_start, 872 .dumpit = ethnl_default_dumpit, 873 .done = ethnl_default_done, 874 .policy = ethnl_channels_get_policy, 875 .maxattr = ARRAY_SIZE(ethnl_channels_get_policy) - 1, 876 }, 877 { 878 .cmd = ETHTOOL_MSG_CHANNELS_SET, 879 .flags = GENL_UNS_ADMIN_PERM, 880 .doit = ethnl_set_channels, 881 .policy = ethnl_channels_set_policy, 882 .maxattr = ARRAY_SIZE(ethnl_channels_set_policy) - 1, 883 }, 884 { 885 .cmd = ETHTOOL_MSG_COALESCE_GET, 886 .doit = ethnl_default_doit, 887 .start = ethnl_default_start, 888 .dumpit = ethnl_default_dumpit, 889 .done = ethnl_default_done, 890 .policy = ethnl_coalesce_get_policy, 891 .maxattr = ARRAY_SIZE(ethnl_coalesce_get_policy) - 1, 892 }, 893 { 894 .cmd = ETHTOOL_MSG_COALESCE_SET, 895 .flags = GENL_UNS_ADMIN_PERM, 896 .doit = ethnl_set_coalesce, 897 .policy = ethnl_coalesce_set_policy, 898 .maxattr = ARRAY_SIZE(ethnl_coalesce_set_policy) - 1, 899 }, 900 { 901 .cmd = ETHTOOL_MSG_PAUSE_GET, 902 .doit = ethnl_default_doit, 903 .start = ethnl_default_start, 904 .dumpit = ethnl_default_dumpit, 905 .done = ethnl_default_done, 906 .policy = ethnl_pause_get_policy, 907 .maxattr = ARRAY_SIZE(ethnl_pause_get_policy) - 1, 908 }, 909 { 910 .cmd = ETHTOOL_MSG_PAUSE_SET, 911 .flags = GENL_UNS_ADMIN_PERM, 912 .doit = ethnl_set_pause, 913 .policy = ethnl_pause_set_policy, 914 .maxattr = ARRAY_SIZE(ethnl_pause_set_policy) - 1, 915 }, 916 { 917 .cmd = ETHTOOL_MSG_EEE_GET, 918 .doit = ethnl_default_doit, 919 .start = ethnl_default_start, 920 .dumpit = ethnl_default_dumpit, 921 .done = ethnl_default_done, 922 .policy = ethnl_eee_get_policy, 923 .maxattr = ARRAY_SIZE(ethnl_eee_get_policy) - 1, 924 }, 925 { 926 .cmd = ETHTOOL_MSG_EEE_SET, 927 .flags = GENL_UNS_ADMIN_PERM, 928 .doit = ethnl_set_eee, 929 .policy = ethnl_eee_set_policy, 930 .maxattr = ARRAY_SIZE(ethnl_eee_set_policy) - 1, 931 }, 932 { 933 .cmd = ETHTOOL_MSG_TSINFO_GET, 934 .doit = ethnl_default_doit, 935 .start = ethnl_default_start, 936 .dumpit = ethnl_default_dumpit, 937 .done = ethnl_default_done, 938 .policy = ethnl_tsinfo_get_policy, 939 .maxattr = ARRAY_SIZE(ethnl_tsinfo_get_policy) - 1, 940 }, 941 { 942 .cmd = ETHTOOL_MSG_CABLE_TEST_ACT, 943 .flags = GENL_UNS_ADMIN_PERM, 944 .doit = ethnl_act_cable_test, 945 .policy = ethnl_cable_test_act_policy, 946 .maxattr = ARRAY_SIZE(ethnl_cable_test_act_policy) - 1, 947 }, 948 { 949 .cmd = ETHTOOL_MSG_CABLE_TEST_TDR_ACT, 950 .flags = GENL_UNS_ADMIN_PERM, 951 .doit = ethnl_act_cable_test_tdr, 952 .policy = ethnl_cable_test_tdr_act_policy, 953 .maxattr = ARRAY_SIZE(ethnl_cable_test_tdr_act_policy) - 1, 954 }, 955 { 956 .cmd = ETHTOOL_MSG_TUNNEL_INFO_GET, 957 .doit = ethnl_tunnel_info_doit, 958 .start = ethnl_tunnel_info_start, 959 .dumpit = ethnl_tunnel_info_dumpit, 960 .policy = ethnl_tunnel_info_get_policy, 961 .maxattr = ARRAY_SIZE(ethnl_tunnel_info_get_policy) - 1, 962 }, 963 { 964 .cmd = ETHTOOL_MSG_FEC_GET, 965 .doit = ethnl_default_doit, 966 .start = ethnl_default_start, 967 .dumpit = ethnl_default_dumpit, 968 .done = ethnl_default_done, 969 .policy = ethnl_fec_get_policy, 970 .maxattr = ARRAY_SIZE(ethnl_fec_get_policy) - 1, 971 }, 972 { 973 .cmd = ETHTOOL_MSG_FEC_SET, 974 .flags = GENL_UNS_ADMIN_PERM, 975 .doit = ethnl_set_fec, 976 .policy = ethnl_fec_set_policy, 977 .maxattr = ARRAY_SIZE(ethnl_fec_set_policy) - 1, 978 }, 979 { 980 .cmd = ETHTOOL_MSG_MODULE_EEPROM_GET, 981 .flags = GENL_UNS_ADMIN_PERM, 982 .doit = ethnl_default_doit, 983 .start = ethnl_default_start, 984 .dumpit = ethnl_default_dumpit, 985 .done = ethnl_default_done, 986 .policy = ethnl_module_eeprom_get_policy, 987 .maxattr = ARRAY_SIZE(ethnl_module_eeprom_get_policy) - 1, 988 }, 989 { 990 .cmd = ETHTOOL_MSG_STATS_GET, 991 .doit = ethnl_default_doit, 992 .start = ethnl_default_start, 993 .dumpit = ethnl_default_dumpit, 994 .done = ethnl_default_done, 995 .policy = ethnl_stats_get_policy, 996 .maxattr = ARRAY_SIZE(ethnl_stats_get_policy) - 1, 997 }, 998 { 999 .cmd = ETHTOOL_MSG_PHC_VCLOCKS_GET, 1000 .doit = ethnl_default_doit, 1001 .start = ethnl_default_start, 1002 .dumpit = ethnl_default_dumpit, 1003 .done = ethnl_default_done, 1004 .policy = ethnl_phc_vclocks_get_policy, 1005 .maxattr = ARRAY_SIZE(ethnl_phc_vclocks_get_policy) - 1, 1006 }, 1007 { 1008 .cmd = ETHTOOL_MSG_MODULE_GET, 1009 .doit = ethnl_default_doit, 1010 .start = ethnl_default_start, 1011 .dumpit = ethnl_default_dumpit, 1012 .done = ethnl_default_done, 1013 .policy = ethnl_module_get_policy, 1014 .maxattr = ARRAY_SIZE(ethnl_module_get_policy) - 1, 1015 }, 1016 { 1017 .cmd = ETHTOOL_MSG_MODULE_SET, 1018 .flags = GENL_UNS_ADMIN_PERM, 1019 .doit = ethnl_set_module, 1020 .policy = ethnl_module_set_policy, 1021 .maxattr = ARRAY_SIZE(ethnl_module_set_policy) - 1, 1022 }, 1023 }; 1024 1025 static const struct genl_multicast_group ethtool_nl_mcgrps[] = { 1026 [ETHNL_MCGRP_MONITOR] = { .name = ETHTOOL_MCGRP_MONITOR_NAME }, 1027 }; 1028 1029 static struct genl_family ethtool_genl_family __ro_after_init = { 1030 .name = ETHTOOL_GENL_NAME, 1031 .version = ETHTOOL_GENL_VERSION, 1032 .netnsok = true, 1033 .parallel_ops = true, 1034 .ops = ethtool_genl_ops, 1035 .n_ops = ARRAY_SIZE(ethtool_genl_ops), 1036 .mcgrps = ethtool_nl_mcgrps, 1037 .n_mcgrps = ARRAY_SIZE(ethtool_nl_mcgrps), 1038 }; 1039 1040 /* module setup */ 1041 1042 static int __init ethnl_init(void) 1043 { 1044 int ret; 1045 1046 ret = genl_register_family(ðtool_genl_family); 1047 if (WARN(ret < 0, "ethtool: genetlink family registration failed")) 1048 return ret; 1049 ethnl_ok = true; 1050 1051 ret = register_netdevice_notifier(ðnl_netdev_notifier); 1052 WARN(ret < 0, "ethtool: net device notifier registration failed"); 1053 return ret; 1054 } 1055 1056 subsys_initcall(ethnl_init); 1057