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 ret = -ENODEV; 45 goto err; 46 } 47 48 if (dev->ethtool_ops->begin) { 49 ret = dev->ethtool_ops->begin(dev); 50 if (ret) 51 goto err; 52 } 53 54 return 0; 55 err: 56 if (dev->dev.parent) 57 pm_runtime_put(dev->dev.parent); 58 59 return ret; 60 } 61 62 void ethnl_ops_complete(struct net_device *dev) 63 { 64 if (dev->ethtool_ops->complete) 65 dev->ethtool_ops->complete(dev); 66 67 if (dev->dev.parent) 68 pm_runtime_put(dev->dev.parent); 69 } 70 71 /** 72 * ethnl_parse_header_dev_get() - parse request header 73 * @req_info: structure to put results into 74 * @header: nest attribute with request header 75 * @net: request netns 76 * @extack: netlink extack for error reporting 77 * @require_dev: fail if no device identified in header 78 * 79 * Parse request header in nested attribute @nest and puts results into 80 * the structure pointed to by @req_info. Extack from @info is used for error 81 * reporting. If req_info->dev is not null on return, reference to it has 82 * been taken. If error is returned, *req_info is null initialized and no 83 * reference is held. 84 * 85 * Return: 0 on success or negative error code 86 */ 87 int ethnl_parse_header_dev_get(struct ethnl_req_info *req_info, 88 const struct nlattr *header, struct net *net, 89 struct netlink_ext_ack *extack, bool require_dev) 90 { 91 struct nlattr *tb[ARRAY_SIZE(ethnl_header_policy)]; 92 const struct nlattr *devname_attr; 93 struct net_device *dev = NULL; 94 u32 flags = 0; 95 int ret; 96 97 if (!header) { 98 NL_SET_ERR_MSG(extack, "request header missing"); 99 return -EINVAL; 100 } 101 /* No validation here, command policy should have a nested policy set 102 * for the header, therefore validation should have already been done. 103 */ 104 ret = nla_parse_nested(tb, ARRAY_SIZE(ethnl_header_policy) - 1, header, 105 NULL, extack); 106 if (ret < 0) 107 return ret; 108 if (tb[ETHTOOL_A_HEADER_FLAGS]) 109 flags = nla_get_u32(tb[ETHTOOL_A_HEADER_FLAGS]); 110 111 devname_attr = tb[ETHTOOL_A_HEADER_DEV_NAME]; 112 if (tb[ETHTOOL_A_HEADER_DEV_INDEX]) { 113 u32 ifindex = nla_get_u32(tb[ETHTOOL_A_HEADER_DEV_INDEX]); 114 115 dev = dev_get_by_index(net, ifindex); 116 if (!dev) { 117 NL_SET_ERR_MSG_ATTR(extack, 118 tb[ETHTOOL_A_HEADER_DEV_INDEX], 119 "no device matches ifindex"); 120 return -ENODEV; 121 } 122 /* if both ifindex and ifname are passed, they must match */ 123 if (devname_attr && 124 strncmp(dev->name, nla_data(devname_attr), IFNAMSIZ)) { 125 dev_put(dev); 126 NL_SET_ERR_MSG_ATTR(extack, header, 127 "ifindex and name do not match"); 128 return -ENODEV; 129 } 130 } else if (devname_attr) { 131 dev = dev_get_by_name(net, nla_data(devname_attr)); 132 if (!dev) { 133 NL_SET_ERR_MSG_ATTR(extack, devname_attr, 134 "no device matches name"); 135 return -ENODEV; 136 } 137 } else if (require_dev) { 138 NL_SET_ERR_MSG_ATTR(extack, header, 139 "neither ifindex nor name specified"); 140 return -EINVAL; 141 } 142 143 req_info->dev = dev; 144 netdev_tracker_alloc(dev, &req_info->dev_tracker, GFP_KERNEL); 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_track(req_info->dev, &req_info->dev_tracker); 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_track(req_info->dev, &req_info->dev_tracker); 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_track(req_info->dev, &req_info->dev_tracker); 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 netdev_tracker_alloc(dev, &req_info->dev_tracker, GFP_KERNEL); 629 req_info->flags |= ETHTOOL_FLAG_COMPACT_BITSETS; 630 631 ethnl_init_reply_data(reply_data, ops, dev); 632 ret = ops->prepare_data(req_info, reply_data, NULL); 633 if (ret < 0) 634 goto err_cleanup; 635 ret = ops->reply_size(req_info, reply_data); 636 if (ret < 0) 637 goto err_cleanup; 638 reply_len = ret + ethnl_reply_header_size(); 639 ret = -ENOMEM; 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