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