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