net/ethtool/netlink.c

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