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