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