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