LXR linux/net/ethtool/netlink.h

   1/* SPDX-License-Identifier: GPL-2.0-only */
   2
   3#ifndef _NET_ETHTOOL_NETLINK_H
   4#define _NET_ETHTOOL_NETLINK_H
   5
   6#include <linux/ethtool_netlink.h>
   7#include <linux/netdevice.h>
   8#include <net/genetlink.h>
   9#include <net/sock.h>
  10
  11struct ethnl_req_info;
  12
  13int ethnl_parse_header_dev_get(struct ethnl_req_info *req_info,
  14                               const struct nlattr *nest, struct net *net,
  15                               struct netlink_ext_ack *extack,
  16                               bool require_dev);
  17int ethnl_fill_reply_header(struct sk_buff *skb, struct net_device *dev,
  18                            u16 attrtype);
  19struct sk_buff *ethnl_reply_init(size_t payload, struct net_device *dev, u8 cmd,
  20                                 u16 hdr_attrtype, struct genl_info *info,
  21                                 void **ehdrp);
  22void *ethnl_dump_put(struct sk_buff *skb, struct netlink_callback *cb, u8 cmd);
  23void *ethnl_bcastmsg_put(struct sk_buff *skb, u8 cmd);
  24int ethnl_multicast(struct sk_buff *skb, struct net_device *dev);
  25
  26/**
  27 * ethnl_strz_size() - calculate attribute length for fixed size string
  28 * @s: ETH_GSTRING_LEN sized string (may not be null terminated)
  29 *
  30 * Return: total length of an attribute with null terminated string from @s
  31 */
  32static inline int ethnl_strz_size(const char *s)
  33{
  34        return nla_total_size(strnlen(s, ETH_GSTRING_LEN) + 1);
  35}
  36
  37/**
  38 * ethnl_put_strz() - put string attribute with fixed size string
  39 * @skb:      skb with the message
  40 * @attrtype: attribute type
  41 * @s:        ETH_GSTRING_LEN sized string (may not be null terminated)
  42 *
  43 * Puts an attribute with null terminated string from @s into the message.
  44 *
  45 * Return: 0 on success, negative error code on failure
  46 */
  47static inline int ethnl_put_strz(struct sk_buff *skb, u16 attrtype,
  48                                 const char *s)
  49{
  50        unsigned int len = strnlen(s, ETH_GSTRING_LEN);
  51        struct nlattr *attr;
  52
  53        attr = nla_reserve(skb, attrtype, len + 1);
  54        if (!attr)
  55                return -EMSGSIZE;
  56
  57        memcpy(nla_data(attr), s, len);
  58        ((char *)nla_data(attr))[len] = '\0';
  59        return 0;
  60}
  61
  62/**
  63 * ethnl_update_u32() - update u32 value from NLA_U32 attribute
  64 * @dst:  value to update
  65 * @attr: netlink attribute with new value or null
  66 * @mod:  pointer to bool for modification tracking
  67 *
  68 * Copy the u32 value from NLA_U32 netlink attribute @attr into variable
  69 * pointed to by @dst; do nothing if @attr is null. Bool pointed to by @mod
  70 * is set to true if this function changed the value of *dst, otherwise it
  71 * is left as is.
  72 */
  73static inline void ethnl_update_u32(u32 *dst, const struct nlattr *attr,
  74                                    bool *mod)
  75{
  76        u32 val;
  77
  78        if (!attr)
  79                return;
  80        val = nla_get_u32(attr);
  81        if (*dst == val)
  82                return;
  83
  84        *dst = val;
  85        *mod = true;
  86}
  87
  88/**
  89 * ethnl_update_u8() - update u8 value from NLA_U8 attribute
  90 * @dst:  value to update
  91 * @attr: netlink attribute with new value or null
  92 * @mod:  pointer to bool for modification tracking
  93 *
  94 * Copy the u8 value from NLA_U8 netlink attribute @attr into variable
  95 * pointed to by @dst; do nothing if @attr is null. Bool pointed to by @mod
  96 * is set to true if this function changed the value of *dst, otherwise it
  97 * is left as is.
  98 */
  99static inline void ethnl_update_u8(u8 *dst, const struct nlattr *attr,
 100                                   bool *mod)
 101{
 102        u8 val;
 103
 104        if (!attr)
 105                return;
 106        val = nla_get_u8(attr);
 107        if (*dst == val)
 108                return;
 109
 110        *dst = val;
 111        *mod = true;
 112}
 113
 114/**
 115 * ethnl_update_bool32() - update u32 used as bool from NLA_U8 attribute
 116 * @dst:  value to update
 117 * @attr: netlink attribute with new value or null
 118 * @mod:  pointer to bool for modification tracking
 119 *
 120 * Use the u8 value from NLA_U8 netlink attribute @attr to set u32 variable
 121 * pointed to by @dst to 0 (if zero) or 1 (if not); do nothing if @attr is
 122 * null. Bool pointed to by @mod is set to true if this function changed the
 123 * logical value of *dst, otherwise it is left as is.
 124 */
 125static inline void ethnl_update_bool32(u32 *dst, const struct nlattr *attr,
 126                                       bool *mod)
 127{
 128        u8 val;
 129
 130        if (!attr)
 131                return;
 132        val = !!nla_get_u8(attr);
 133        if (!!*dst == val)
 134                return;
 135
 136        *dst = val;
 137        *mod = true;
 138}
 139
 140/**
 141 * ethnl_update_binary() - update binary data from NLA_BINARY attribute
 142 * @dst:  value to update
 143 * @len:  destination buffer length
 144 * @attr: netlink attribute with new value or null
 145 * @mod:  pointer to bool for modification tracking
 146 *
 147 * Use the u8 value from NLA_U8 netlink attribute @attr to rewrite data block
 148 * of length @len at @dst by attribute payload; do nothing if @attr is null.
 149 * Bool pointed to by @mod is set to true if this function changed the logical
 150 * value of *dst, otherwise it is left as is.
 151 */
 152static inline void ethnl_update_binary(void *dst, unsigned int len,
 153                                       const struct nlattr *attr, bool *mod)
 154{
 155        if (!attr)
 156                return;
 157        if (nla_len(attr) < len)
 158                len = nla_len(attr);
 159        if (!memcmp(dst, nla_data(attr), len))
 160                return;
 161
 162        memcpy(dst, nla_data(attr), len);
 163        *mod = true;
 164}
 165
 166/**
 167 * ethnl_update_bitfield32() - update u32 value from NLA_BITFIELD32 attribute
 168 * @dst:  value to update
 169 * @attr: netlink attribute with new value or null
 170 * @mod:  pointer to bool for modification tracking
 171 *
 172 * Update bits in u32 value which are set in attribute's mask to values from
 173 * attribute's value. Do nothing if @attr is null or the value wouldn't change;
 174 * otherwise, set bool pointed to by @mod to true.
 175 */
 176static inline void ethnl_update_bitfield32(u32 *dst, const struct nlattr *attr,
 177                                           bool *mod)
 178{
 179        struct nla_bitfield32 change;
 180        u32 newval;
 181
 182        if (!attr)
 183                return;
 184        change = nla_get_bitfield32(attr);
 185        newval = (*dst & ~change.selector) | (change.value & change.selector);
 186        if (*dst == newval)
 187                return;
 188
 189        *dst = newval;
 190        *mod = true;
 191}
 192
 193/**
 194 * ethnl_reply_header_size() - total size of reply header
 195 *
 196 * This is an upper estimate so that we do not need to hold RTNL lock longer
 197 * than necessary (to prevent rename between size estimate and composing the
 198 * message). Accounts only for device ifindex and name as those are the only
 199 * attributes ethnl_fill_reply_header() puts into the reply header.
 200 */
 201static inline unsigned int ethnl_reply_header_size(void)
 202{
 203        return nla_total_size(nla_total_size(sizeof(u32)) +
 204                              nla_total_size(IFNAMSIZ));
 205}
 206
 207/* GET request handling */
 208
 209/* Unified processing of GET requests uses two data structures: request info
 210 * and reply data. Request info holds information parsed from client request
 211 * and its stays constant through all request processing. Reply data holds data
 212 * retrieved from ethtool_ops callbacks or other internal sources which is used
 213 * to compose the reply. When processing a dump request, request info is filled
 214 * only once (when the request message is parsed) but reply data is filled for
 215 * each reply message.
 216 *
 217 * Both structures consist of part common for all request types (struct
 218 * ethnl_req_info and struct ethnl_reply_data defined below) and optional
 219 * parts specific for each request type. Common part always starts at offset 0.
 220 */
 221
 222/**
 223 * struct ethnl_req_info - base type of request information for GET requests
 224 * @dev:   network device the request is for (may be null)
 225 * @flags: request flags common for all request types
 226 *
 227 * This is a common base for request specific structures holding data from
 228 * parsed userspace request. These always embed struct ethnl_req_info at
 229 * zero offset.
 230 */
 231struct ethnl_req_info {
 232        struct net_device       *dev;
 233        u32                     flags;
 234};
 235
 236/**
 237 * struct ethnl_reply_data - base type of reply data for GET requests
 238 * @dev:       device for current reply message; in single shot requests it is
 239 *             equal to &ethnl_req_info.dev; in dumps it's different for each
 240 *             reply message
 241 *
 242 * This is a common base for request specific structures holding data for
 243 * kernel reply message. These always embed struct ethnl_reply_data at zero
 244 * offset.
 245 */
 246struct ethnl_reply_data {
 247        struct net_device               *dev;
 248};
 249
 250int ethnl_ops_begin(struct net_device *dev);
 251void ethnl_ops_complete(struct net_device *dev);
 252
 253/**
 254 * struct ethnl_request_ops - unified handling of GET requests
 255 * @request_cmd:      command id for request (GET)
 256 * @reply_cmd:        command id for reply (GET_REPLY)
 257 * @hdr_attr:         attribute type for request header
 258 * @req_info_size:    size of request info
 259 * @reply_data_size:  size of reply data
 260 * @allow_nodev_do:   allow non-dump request with no device identification
 261 * @parse_request:
 262 *      Parse request except common header (struct ethnl_req_info). Common
 263 *      header is already filled on entry, the rest up to @repdata_offset
 264 *      is zero initialized. This callback should only modify type specific
 265 *      request info by parsed attributes from request message.
 266 * @prepare_data:
 267 *      Retrieve and prepare data needed to compose a reply message. Calls to
 268 *      ethtool_ops handlers are limited to this callback. Common reply data
 269 *      (struct ethnl_reply_data) is filled on entry, type specific part after
 270 *      it is zero initialized. This callback should only modify the type
 271 *      specific part of reply data. Device identification from struct
 272 *      ethnl_reply_data is to be used as for dump requests, it iterates
 273 *      through network devices while dev member of struct ethnl_req_info
 274 *      points to the device from client request.
 275 * @reply_size:
 276 *      Estimate reply message size. Returned value must be sufficient for
 277 *      message payload without common reply header. The callback may returned
 278 *      estimate higher than actual message size if exact calculation would
 279 *      not be worth the saved memory space.
 280 * @fill_reply:
 281 *      Fill reply message payload (except for common header) from reply data.
 282 *      The callback must not generate more payload than previously called
 283 *      ->reply_size() estimated.
 284 * @cleanup_data:
 285 *      Optional cleanup called when reply data is no longer needed. Can be
 286 *      used e.g. to free any additional data structures outside the main
 287 *      structure which were allocated by ->prepare_data(). When processing
 288 *      dump requests, ->cleanup() is called for each message.
 289 *
 290 * Description of variable parts of GET request handling when using the
 291 * unified infrastructure. When used, a pointer to an instance of this
 292 * structure is to be added to &ethnl_default_requests array and generic
 293 * handlers ethnl_default_doit(), ethnl_default_dumpit(),
 294 * ethnl_default_start() and ethnl_default_done() used in @ethtool_genl_ops;
 295 * ethnl_default_notify() can be used in @ethnl_notify_handlers to send
 296 * notifications of the corresponding type.
 297 */
 298struct ethnl_request_ops {
 299        u8                      request_cmd;
 300        u8                      reply_cmd;
 301        u16                     hdr_attr;
 302        unsigned int            req_info_size;
 303        unsigned int            reply_data_size;
 304        bool                    allow_nodev_do;
 305
 306        int (*parse_request)(struct ethnl_req_info *req_info,
 307                             struct nlattr **tb,
 308                             struct netlink_ext_ack *extack);
 309        int (*prepare_data)(const struct ethnl_req_info *req_info,
 310                            struct ethnl_reply_data *reply_data,
 311                            struct genl_info *info);
 312        int (*reply_size)(const struct ethnl_req_info *req_info,
 313                          const struct ethnl_reply_data *reply_data);
 314        int (*fill_reply)(struct sk_buff *skb,
 315                          const struct ethnl_req_info *req_info,
 316                          const struct ethnl_reply_data *reply_data);
 317        void (*cleanup_data)(struct ethnl_reply_data *reply_data);
 318};
 319
 320/* request handlers */
 321
 322extern const struct ethnl_request_ops ethnl_strset_request_ops;
 323extern const struct ethnl_request_ops ethnl_linkinfo_request_ops;
 324extern const struct ethnl_request_ops ethnl_linkmodes_request_ops;
 325extern const struct ethnl_request_ops ethnl_linkstate_request_ops;
 326extern const struct ethnl_request_ops ethnl_debug_request_ops;
 327extern const struct ethnl_request_ops ethnl_wol_request_ops;
 328extern const struct ethnl_request_ops ethnl_features_request_ops;
 329extern const struct ethnl_request_ops ethnl_privflags_request_ops;
 330extern const struct ethnl_request_ops ethnl_rings_request_ops;
 331extern const struct ethnl_request_ops ethnl_channels_request_ops;
 332extern const struct ethnl_request_ops ethnl_coalesce_request_ops;
 333extern const struct ethnl_request_ops ethnl_pause_request_ops;
 334extern const struct ethnl_request_ops ethnl_eee_request_ops;
 335extern const struct ethnl_request_ops ethnl_tsinfo_request_ops;
 336extern const struct ethnl_request_ops ethnl_fec_request_ops;
 337extern const struct ethnl_request_ops ethnl_module_eeprom_request_ops;
 338extern const struct ethnl_request_ops ethnl_stats_request_ops;
 339extern const struct ethnl_request_ops ethnl_phc_vclocks_request_ops;
 340
 341extern const struct nla_policy ethnl_header_policy[ETHTOOL_A_HEADER_FLAGS + 1];
 342extern const struct nla_policy ethnl_header_policy_stats[ETHTOOL_A_HEADER_FLAGS + 1];
 343extern const struct nla_policy ethnl_strset_get_policy[ETHTOOL_A_STRSET_COUNTS_ONLY + 1];
 344extern const struct nla_policy ethnl_linkinfo_get_policy[ETHTOOL_A_LINKINFO_HEADER + 1];
 345extern const struct nla_policy ethnl_linkinfo_set_policy[ETHTOOL_A_LINKINFO_TP_MDIX_CTRL + 1];
 346extern const struct nla_policy ethnl_linkmodes_get_policy[ETHTOOL_A_LINKMODES_HEADER + 1];
 347extern const struct nla_policy ethnl_linkmodes_set_policy[ETHTOOL_A_LINKMODES_LANES + 1];
 348extern const struct nla_policy ethnl_linkstate_get_policy[ETHTOOL_A_LINKSTATE_HEADER + 1];
 349extern const struct nla_policy ethnl_debug_get_policy[ETHTOOL_A_DEBUG_HEADER + 1];
 350extern const struct nla_policy ethnl_debug_set_policy[ETHTOOL_A_DEBUG_MSGMASK + 1];
 351extern const struct nla_policy ethnl_wol_get_policy[ETHTOOL_A_WOL_HEADER + 1];
 352extern const struct nla_policy ethnl_wol_set_policy[ETHTOOL_A_WOL_SOPASS + 1];
 353extern const struct nla_policy ethnl_features_get_policy[ETHTOOL_A_FEATURES_HEADER + 1];
 354extern const struct nla_policy ethnl_features_set_policy[ETHTOOL_A_FEATURES_WANTED + 1];
 355extern const struct nla_policy ethnl_privflags_get_policy[ETHTOOL_A_PRIVFLAGS_HEADER + 1];
 356extern const struct nla_policy ethnl_privflags_set_policy[ETHTOOL_A_PRIVFLAGS_FLAGS + 1];
 357extern const struct nla_policy ethnl_rings_get_policy[ETHTOOL_A_RINGS_HEADER + 1];
 358extern const struct nla_policy ethnl_rings_set_policy[ETHTOOL_A_RINGS_TX + 1];
 359extern const struct nla_policy ethnl_channels_get_policy[ETHTOOL_A_CHANNELS_HEADER + 1];
 360extern const struct nla_policy ethnl_channels_set_policy[ETHTOOL_A_CHANNELS_COMBINED_COUNT + 1];
 361extern const struct nla_policy ethnl_coalesce_get_policy[ETHTOOL_A_COALESCE_HEADER + 1];
 362extern const struct nla_policy ethnl_coalesce_set_policy[ETHTOOL_A_COALESCE_MAX + 1];
 363extern const struct nla_policy ethnl_pause_get_policy[ETHTOOL_A_PAUSE_HEADER + 1];
 364extern const struct nla_policy ethnl_pause_set_policy[ETHTOOL_A_PAUSE_TX + 1];
 365extern const struct nla_policy ethnl_eee_get_policy[ETHTOOL_A_EEE_HEADER + 1];
 366extern const struct nla_policy ethnl_eee_set_policy[ETHTOOL_A_EEE_TX_LPI_TIMER + 1];
 367extern const struct nla_policy ethnl_tsinfo_get_policy[ETHTOOL_A_TSINFO_HEADER + 1];
 368extern const struct nla_policy ethnl_cable_test_act_policy[ETHTOOL_A_CABLE_TEST_HEADER + 1];
 369extern const struct nla_policy ethnl_cable_test_tdr_act_policy[ETHTOOL_A_CABLE_TEST_TDR_CFG + 1];
 370extern const struct nla_policy ethnl_tunnel_info_get_policy[ETHTOOL_A_TUNNEL_INFO_HEADER + 1];
 371extern const struct nla_policy ethnl_fec_get_policy[ETHTOOL_A_FEC_HEADER + 1];
 372extern const struct nla_policy ethnl_fec_set_policy[ETHTOOL_A_FEC_AUTO + 1];
 373extern const struct nla_policy ethnl_module_eeprom_get_policy[ETHTOOL_A_MODULE_EEPROM_I2C_ADDRESS + 1];
 374extern const struct nla_policy ethnl_stats_get_policy[ETHTOOL_A_STATS_GROUPS + 1];
 375extern const struct nla_policy ethnl_phc_vclocks_get_policy[ETHTOOL_A_PHC_VCLOCKS_HEADER + 1];
 376
 377int ethnl_set_linkinfo(struct sk_buff *skb, struct genl_info *info);
 378int ethnl_set_linkmodes(struct sk_buff *skb, struct genl_info *info);
 379int ethnl_set_debug(struct sk_buff *skb, struct genl_info *info);
 380int ethnl_set_wol(struct sk_buff *skb, struct genl_info *info);
 381int ethnl_set_features(struct sk_buff *skb, struct genl_info *info);
 382int ethnl_set_privflags(struct sk_buff *skb, struct genl_info *info);
 383int ethnl_set_rings(struct sk_buff *skb, struct genl_info *info);
 384int ethnl_set_channels(struct sk_buff *skb, struct genl_info *info);
 385int ethnl_set_coalesce(struct sk_buff *skb, struct genl_info *info);
 386int ethnl_set_pause(struct sk_buff *skb, struct genl_info *info);
 387int ethnl_set_eee(struct sk_buff *skb, struct genl_info *info);
 388int ethnl_act_cable_test(struct sk_buff *skb, struct genl_info *info);
 389int ethnl_act_cable_test_tdr(struct sk_buff *skb, struct genl_info *info);
 390int ethnl_tunnel_info_doit(struct sk_buff *skb, struct genl_info *info);
 391int ethnl_tunnel_info_start(struct netlink_callback *cb);
 392int ethnl_tunnel_info_dumpit(struct sk_buff *skb, struct netlink_callback *cb);
 393int ethnl_set_fec(struct sk_buff *skb, struct genl_info *info);
 394
 395extern const char stats_std_names[__ETHTOOL_STATS_CNT][ETH_GSTRING_LEN];
 396extern const char stats_eth_phy_names[__ETHTOOL_A_STATS_ETH_PHY_CNT][ETH_GSTRING_LEN];
 397extern const char stats_eth_mac_names[__ETHTOOL_A_STATS_ETH_MAC_CNT][ETH_GSTRING_LEN];
 398extern const char stats_eth_ctrl_names[__ETHTOOL_A_STATS_ETH_CTRL_CNT][ETH_GSTRING_LEN];
 399extern const char stats_rmon_names[__ETHTOOL_A_STATS_RMON_CNT][ETH_GSTRING_LEN];
 400
 401#endif /* _NET_ETHTOOL_NETLINK_H */
 402