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_bool() - updateb bool used as bool from NLA_U8 attribute 142 * @dst: value to update 143 * @attr: netlink attribute with new value or null 144 * @mod: pointer to bool for modification tracking 145 * 146 * Use the bool value from NLA_U8 netlink attribute @attr to set bool variable 147 * pointed to by @dst to 0 (if zero) or 1 (if not); do nothing if @attr is 148 * null. Bool pointed to by @mod is set to true if this function changed the 149 * logical value of *dst, otherwise it is left as is. 150 */ 151static inline void ethnl_update_bool(bool *dst, const struct nlattr *attr, 152 bool *mod) 153{ 154 u8 val; 155 156 if (!attr) 157 return; 158 val = !!nla_get_u8(attr); 159 if (!!*dst == val) 160 return; 161 162 *dst = val; 163 *mod = true; 164} 165 166/** 167 * ethnl_update_binary() - update binary data from NLA_BINARY attribute 168 * @dst: value to update 169 * @len: destination buffer length 170 * @attr: netlink attribute with new value or null 171 * @mod: pointer to bool for modification tracking 172 * 173 * Use the u8 value from NLA_U8 netlink attribute @attr to rewrite data block 174 * of length @len at @dst by attribute payload; do nothing if @attr is null. 175 * Bool pointed to by @mod is set to true if this function changed the logical 176 * value of *dst, otherwise it is left as is. 177 */ 178static inline void ethnl_update_binary(void *dst, unsigned int len, 179 const struct nlattr *attr, bool *mod) 180{ 181 if (!attr) 182 return; 183 if (nla_len(attr) < len) 184 len = nla_len(attr); 185 if (!memcmp(dst, nla_data(attr), len)) 186 return; 187 188 memcpy(dst, nla_data(attr), len); 189 *mod = true; 190} 191 192/** 193 * ethnl_update_bitfield32() - update u32 value from NLA_BITFIELD32 attribute 194 * @dst: value to update 195 * @attr: netlink attribute with new value or null 196 * @mod: pointer to bool for modification tracking 197 * 198 * Update bits in u32 value which are set in attribute's mask to values from 199 * attribute's value. Do nothing if @attr is null or the value wouldn't change; 200 * otherwise, set bool pointed to by @mod to true. 201 */ 202static inline void ethnl_update_bitfield32(u32 *dst, const struct nlattr *attr, 203 bool *mod) 204{ 205 struct nla_bitfield32 change; 206 u32 newval; 207 208 if (!attr) 209 return; 210 change = nla_get_bitfield32(attr); 211 newval = (*dst & ~change.selector) | (change.value & change.selector); 212 if (*dst == newval) 213 return; 214 215 *dst = newval; 216 *mod = true; 217} 218 219/** 220 * ethnl_reply_header_size() - total size of reply header 221 * 222 * This is an upper estimate so that we do not need to hold RTNL lock longer 223 * than necessary (to prevent rename between size estimate and composing the 224 * message). Accounts only for device ifindex and name as those are the only 225 * attributes ethnl_fill_reply_header() puts into the reply header. 226 */ 227static inline unsigned int ethnl_reply_header_size(void) 228{ 229 return nla_total_size(nla_total_size(sizeof(u32)) + 230 nla_total_size(IFNAMSIZ)); 231} 232 233/* GET request handling */ 234 235/* Unified processing of GET requests uses two data structures: request info 236 * and reply data. Request info holds information parsed from client request 237 * and its stays constant through all request processing. Reply data holds data 238 * retrieved from ethtool_ops callbacks or other internal sources which is used 239 * to compose the reply. When processing a dump request, request info is filled 240 * only once (when the request message is parsed) but reply data is filled for 241 * each reply message. 242 * 243 * Both structures consist of part common for all request types (struct 244 * ethnl_req_info and struct ethnl_reply_data defined below) and optional 245 * parts specific for each request type. Common part always starts at offset 0. 246 */ 247 248/** 249 * struct ethnl_req_info - base type of request information for GET requests 250 * @dev: network device the request is for (may be null) 251 * @dev_tracker: refcount tracker for @dev reference 252 * @flags: request flags common for all request types 253 * 254 * This is a common base for request specific structures holding data from 255 * parsed userspace request. These always embed struct ethnl_req_info at 256 * zero offset. 257 */ 258struct ethnl_req_info { 259 struct net_device *dev; 260 netdevice_tracker dev_tracker; 261 u32 flags; 262}; 263 264static inline void ethnl_parse_header_dev_put(struct ethnl_req_info *req_info) 265{ 266 netdev_put(req_info->dev, &req_info->dev_tracker); 267} 268 269/** 270 * struct ethnl_reply_data - base type of reply data for GET requests 271 * @dev: device for current reply message; in single shot requests it is 272 * equal to ðnl_req_info.dev; in dumps it's different for each 273 * reply message 274 * 275 * This is a common base for request specific structures holding data for 276 * kernel reply message. These always embed struct ethnl_reply_data at zero 277 * offset. 278 */ 279struct ethnl_reply_data { 280 struct net_device *dev; 281}; 282 283int ethnl_ops_begin(struct net_device *dev); 284void ethnl_ops_complete(struct net_device *dev); 285 286/** 287 * struct ethnl_request_ops - unified handling of GET and SET requests 288 * @request_cmd: command id for request (GET) 289 * @reply_cmd: command id for reply (GET_REPLY) 290 * @hdr_attr: attribute type for request header 291 * @req_info_size: size of request info 292 * @reply_data_size: size of reply data 293 * @allow_nodev_do: allow non-dump request with no device identification 294 * @set_ntf_cmd: notification to generate on changes (SET) 295 * @parse_request: 296 * Parse request except common header (struct ethnl_req_info). Common 297 * header is already filled on entry, the rest up to @repdata_offset 298 * is zero initialized. This callback should only modify type specific 299 * request info by parsed attributes from request message. 300 * @prepare_data: 301 * Retrieve and prepare data needed to compose a reply message. Calls to 302 * ethtool_ops handlers are limited to this callback. Common reply data 303 * (struct ethnl_reply_data) is filled on entry, type specific part after 304 * it is zero initialized. This callback should only modify the type 305 * specific part of reply data. Device identification from struct 306 * ethnl_reply_data is to be used as for dump requests, it iterates 307 * through network devices while dev member of struct ethnl_req_info 308 * points to the device from client request. 309 * @reply_size: 310 * Estimate reply message size. Returned value must be sufficient for 311 * message payload without common reply header. The callback may returned 312 * estimate higher than actual message size if exact calculation would 313 * not be worth the saved memory space. 314 * @fill_reply: 315 * Fill reply message payload (except for common header) from reply data. 316 * The callback must not generate more payload than previously called 317 * ->reply_size() estimated. 318 * @cleanup_data: 319 * Optional cleanup called when reply data is no longer needed. Can be 320 * used e.g. to free any additional data structures outside the main 321 * structure which were allocated by ->prepare_data(). When processing 322 * dump requests, ->cleanup() is called for each message. 323 * @set_validate: 324 * Check if set operation is supported for a given device, and perform 325 * extra input checks. Expected return values: 326 * - 0 if the operation is a noop for the device (rare) 327 * - 1 if operation should proceed to calling @set 328 * - negative errno on errors 329 * Called without any locks, just a reference on the netdev. 330 * @set: 331 * Execute the set operation. The implementation should return 332 * - 0 if no configuration has changed 333 * - 1 if configuration changed and notification should be generated 334 * - negative errno on errors 335 * 336 * Description of variable parts of GET request handling when using the 337 * unified infrastructure. When used, a pointer to an instance of this 338 * structure is to be added to ðnl_default_requests array and generic 339 * handlers ethnl_default_doit(), ethnl_default_dumpit(), 340 * ethnl_default_start() and ethnl_default_done() used in @ethtool_genl_ops; 341 * ethnl_default_notify() can be used in @ethnl_notify_handlers to send 342 * notifications of the corresponding type. 343 */ 344struct ethnl_request_ops { 345 u8 request_cmd; 346 u8 reply_cmd; 347 u16 hdr_attr; 348 unsigned int req_info_size; 349 unsigned int reply_data_size; 350 bool allow_nodev_do; 351 u8 set_ntf_cmd; 352 353 int (*parse_request)(struct ethnl_req_info *req_info, 354 struct nlattr **tb, 355 struct netlink_ext_ack *extack); 356 int (*prepare_data)(const struct ethnl_req_info *req_info, 357 struct ethnl_reply_data *reply_data, 358 const struct genl_info *info); 359 int (*reply_size)(const struct ethnl_req_info *req_info, 360 const struct ethnl_reply_data *reply_data); 361 int (*fill_reply)(struct sk_buff *skb, 362 const struct ethnl_req_info *req_info, 363 const struct ethnl_reply_data *reply_data); 364 void (*cleanup_data)(struct ethnl_reply_data *reply_data); 365 366 int (*set_validate)(struct ethnl_req_info *req_info, 367 struct genl_info *info); 368 int (*set)(struct ethnl_req_info *req_info, 369 struct genl_info *info); 370}; 371 372/* request handlers */ 373 374extern const struct ethnl_request_ops ethnl_strset_request_ops; 375extern const struct ethnl_request_ops ethnl_linkinfo_request_ops; 376extern const struct ethnl_request_ops ethnl_linkmodes_request_ops; 377extern const struct ethnl_request_ops ethnl_linkstate_request_ops; 378extern const struct ethnl_request_ops ethnl_debug_request_ops; 379extern const struct ethnl_request_ops ethnl_wol_request_ops; 380extern const struct ethnl_request_ops ethnl_features_request_ops; 381extern const struct ethnl_request_ops ethnl_privflags_request_ops; 382extern const struct ethnl_request_ops ethnl_rings_request_ops; 383extern const struct ethnl_request_ops ethnl_channels_request_ops; 384extern const struct ethnl_request_ops ethnl_coalesce_request_ops; 385extern const struct ethnl_request_ops ethnl_pause_request_ops; 386extern const struct ethnl_request_ops ethnl_eee_request_ops; 387extern const struct ethnl_request_ops ethnl_tsinfo_request_ops; 388extern const struct ethnl_request_ops ethnl_fec_request_ops; 389extern const struct ethnl_request_ops ethnl_module_eeprom_request_ops; 390extern const struct ethnl_request_ops ethnl_stats_request_ops; 391extern const struct ethnl_request_ops ethnl_phc_vclocks_request_ops; 392extern const struct ethnl_request_ops ethnl_module_request_ops; 393extern const struct ethnl_request_ops ethnl_pse_request_ops; 394extern const struct ethnl_request_ops ethnl_rss_request_ops; 395extern const struct ethnl_request_ops ethnl_plca_cfg_request_ops; 396extern const struct ethnl_request_ops ethnl_plca_status_request_ops; 397extern const struct ethnl_request_ops ethnl_mm_request_ops; 398 399extern const struct nla_policy ethnl_header_policy[ETHTOOL_A_HEADER_FLAGS + 1]; 400extern const struct nla_policy ethnl_header_policy_stats[ETHTOOL_A_HEADER_FLAGS + 1]; 401extern const struct nla_policy ethnl_strset_get_policy[ETHTOOL_A_STRSET_COUNTS_ONLY + 1]; 402extern const struct nla_policy ethnl_linkinfo_get_policy[ETHTOOL_A_LINKINFO_HEADER + 1]; 403extern const struct nla_policy ethnl_linkinfo_set_policy[ETHTOOL_A_LINKINFO_TP_MDIX_CTRL + 1]; 404extern const struct nla_policy ethnl_linkmodes_get_policy[ETHTOOL_A_LINKMODES_HEADER + 1]; 405extern const struct nla_policy ethnl_linkmodes_set_policy[ETHTOOL_A_LINKMODES_LANES + 1]; 406extern const struct nla_policy ethnl_linkstate_get_policy[ETHTOOL_A_LINKSTATE_HEADER + 1]; 407extern const struct nla_policy ethnl_debug_get_policy[ETHTOOL_A_DEBUG_HEADER + 1]; 408extern const struct nla_policy ethnl_debug_set_policy[ETHTOOL_A_DEBUG_MSGMASK + 1]; 409extern const struct nla_policy ethnl_wol_get_policy[ETHTOOL_A_WOL_HEADER + 1]; 410extern const struct nla_policy ethnl_wol_set_policy[ETHTOOL_A_WOL_SOPASS + 1]; 411extern const struct nla_policy ethnl_features_get_policy[ETHTOOL_A_FEATURES_HEADER + 1]; 412extern const struct nla_policy ethnl_features_set_policy[ETHTOOL_A_FEATURES_WANTED + 1]; 413extern const struct nla_policy ethnl_privflags_get_policy[ETHTOOL_A_PRIVFLAGS_HEADER + 1]; 414extern const struct nla_policy ethnl_privflags_set_policy[ETHTOOL_A_PRIVFLAGS_FLAGS + 1]; 415extern const struct nla_policy ethnl_rings_get_policy[ETHTOOL_A_RINGS_HEADER + 1]; 416extern const struct nla_policy ethnl_rings_set_policy[ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN_MAX + 1]; 417extern const struct nla_policy ethnl_channels_get_policy[ETHTOOL_A_CHANNELS_HEADER + 1]; 418extern const struct nla_policy ethnl_channels_set_policy[ETHTOOL_A_CHANNELS_COMBINED_COUNT + 1]; 419extern const struct nla_policy ethnl_coalesce_get_policy[ETHTOOL_A_COALESCE_HEADER + 1]; 420extern const struct nla_policy ethnl_coalesce_set_policy[ETHTOOL_A_COALESCE_MAX + 1]; 421extern const struct nla_policy ethnl_pause_get_policy[ETHTOOL_A_PAUSE_STATS_SRC + 1]; 422extern const struct nla_policy ethnl_pause_set_policy[ETHTOOL_A_PAUSE_TX + 1]; 423extern const struct nla_policy ethnl_eee_get_policy[ETHTOOL_A_EEE_HEADER + 1]; 424extern const struct nla_policy ethnl_eee_set_policy[ETHTOOL_A_EEE_TX_LPI_TIMER + 1]; 425extern const struct nla_policy ethnl_tsinfo_get_policy[ETHTOOL_A_TSINFO_HEADER + 1]; 426extern const struct nla_policy ethnl_cable_test_act_policy[ETHTOOL_A_CABLE_TEST_HEADER + 1]; 427extern const struct nla_policy ethnl_cable_test_tdr_act_policy[ETHTOOL_A_CABLE_TEST_TDR_CFG + 1]; 428extern const struct nla_policy ethnl_tunnel_info_get_policy[ETHTOOL_A_TUNNEL_INFO_HEADER + 1]; 429extern const struct nla_policy ethnl_fec_get_policy[ETHTOOL_A_FEC_HEADER + 1]; 430extern const struct nla_policy ethnl_fec_set_policy[ETHTOOL_A_FEC_AUTO + 1]; 431extern const struct nla_policy ethnl_module_eeprom_get_policy[ETHTOOL_A_MODULE_EEPROM_I2C_ADDRESS + 1]; 432extern const struct nla_policy ethnl_stats_get_policy[ETHTOOL_A_STATS_SRC + 1]; 433extern const struct nla_policy ethnl_phc_vclocks_get_policy[ETHTOOL_A_PHC_VCLOCKS_HEADER + 1]; 434extern const struct nla_policy ethnl_module_get_policy[ETHTOOL_A_MODULE_HEADER + 1]; 435extern const struct nla_policy ethnl_module_set_policy[ETHTOOL_A_MODULE_POWER_MODE_POLICY + 1]; 436extern const struct nla_policy ethnl_pse_get_policy[ETHTOOL_A_PSE_HEADER + 1]; 437extern const struct nla_policy ethnl_pse_set_policy[ETHTOOL_A_PSE_MAX + 1]; 438extern const struct nla_policy ethnl_rss_get_policy[ETHTOOL_A_RSS_CONTEXT + 1]; 439extern const struct nla_policy ethnl_plca_get_cfg_policy[ETHTOOL_A_PLCA_HEADER + 1]; 440extern const struct nla_policy ethnl_plca_set_cfg_policy[ETHTOOL_A_PLCA_MAX + 1]; 441extern const struct nla_policy ethnl_plca_get_status_policy[ETHTOOL_A_PLCA_HEADER + 1]; 442extern const struct nla_policy ethnl_mm_get_policy[ETHTOOL_A_MM_HEADER + 1]; 443extern const struct nla_policy ethnl_mm_set_policy[ETHTOOL_A_MM_MAX + 1]; 444 445int ethnl_set_features(struct sk_buff *skb, struct genl_info *info); 446int ethnl_act_cable_test(struct sk_buff *skb, struct genl_info *info); 447int ethnl_act_cable_test_tdr(struct sk_buff *skb, struct genl_info *info); 448int ethnl_tunnel_info_doit(struct sk_buff *skb, struct genl_info *info); 449int ethnl_tunnel_info_start(struct netlink_callback *cb); 450int ethnl_tunnel_info_dumpit(struct sk_buff *skb, struct netlink_callback *cb); 451 452extern const char stats_std_names[__ETHTOOL_STATS_CNT][ETH_GSTRING_LEN]; 453extern const char stats_eth_phy_names[__ETHTOOL_A_STATS_ETH_PHY_CNT][ETH_GSTRING_LEN]; 454extern const char stats_eth_mac_names[__ETHTOOL_A_STATS_ETH_MAC_CNT][ETH_GSTRING_LEN]; 455extern const char stats_eth_ctrl_names[__ETHTOOL_A_STATS_ETH_CTRL_CNT][ETH_GSTRING_LEN]; 456extern const char stats_rmon_names[__ETHTOOL_A_STATS_RMON_CNT][ETH_GSTRING_LEN]; 457 458#endif /* _NET_ETHTOOL_NETLINK_H */ 459