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