Commit 71921690 authored by Michal Kubecek's avatar Michal Kubecek Committed by David S. Miller
Browse files

ethtool: provide string sets with STRSET_GET request 



Requests a contents of one or more string sets, i.e. indexed arrays of
strings; this information is provided by ETHTOOL_GSSET_INFO and
ETHTOOL_GSTRINGS commands of ioctl interface. Unlike ioctl interface, all
information can be retrieved with one request and mulitple string sets can
be requested at once.

There are three types of requests:

  - no NLM_F_DUMP, no device: get "global" stringsets
  - no NLM_F_DUMP, with device: get string sets related to the device
  - NLM_F_DUMP, no device: get device related string sets for all devices

Client can request either all string sets of given type (global or device
related) or only specific sets. With ETHTOOL_A_STRSET_COUNTS flag set, only
set sizes (numbers of strings) are returned.

Signed-off-by: default avatarMichal Kubecek <mkubecek@suse.cz>
Reviewed-by: default avatarFlorian Fainelli <f.fainelli@gmail.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 728480f1

Documentation/networking/ethtool-netlink.rst

+73 −2
Original line number Diff line number Diff line
@@ -176,6 +176,18 @@ according to message purpose: 
  ``_NTF``          kernel notification

  ==============    ======================================



Userspace to kernel:



  ===================================== ================================

  ``ETHTOOL_MSG_STRSET_GET``            get string set

  ===================================== ================================



Kernel to userspace:



  ===================================== ================================

  ``ETHTOOL_MSG_STRSET_GET_REPLY``      string set contents

  ===================================== ================================



``GET`` requests are sent by userspace applications to retrieve device

information. They usually do not contain any message specific attributes.

Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET``
@@ -207,6 +219,65 @@ an ``ACT_REPLY`` message. Performing an action also triggers a notification 
Later sections describe the format and semantics of these messages.





STRSET_GET

==========



Requests contents of a string set as provided by ioctl commands

``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user

writeable so that the corresponding ``STRSET_SET`` message is only used in

kernel replies. There are two types of string sets: global (independent of

a device, e.g. device feature names) and device specific (e.g. device private

flags).



Request contents:



 +---------------------------------------+--------+------------------------+

 | ``ETHTOOL_A_STRSET_HEADER``           | nested | request header         |

 +---------------------------------------+--------+------------------------+

 | ``ETHTOOL_A_STRSET_STRINGSETS``       | nested | string set to request  |

 +-+-------------------------------------+--------+------------------------+

 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set         |

 +-+-+-----------------------------------+--------+------------------------+

 | | | ``ETHTOOL_A_STRINGSET_ID``        | u32    | set id                 |

 +-+-+-----------------------------------+--------+------------------------+



Kernel response contents:



 +---------------------------------------+--------+-----------------------+

 | ``ETHTOOL_A_STRSET_HEADER``           | nested | reply header          |

 +---------------------------------------+--------+-----------------------+

 | ``ETHTOOL_A_STRSET_STRINGSETS``       | nested | array of string sets  |

 +-+-------------------------------------+--------+-----------------------+

 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set        |

 +-+-+-----------------------------------+--------+-----------------------+

 | | | ``ETHTOOL_A_STRINGSET_ID``        | u32    | set id                |

 +-+-+-----------------------------------+--------+-----------------------+

 | | | ``ETHTOOL_A_STRINGSET_COUNT``     | u32    | number of strings     |

 +-+-+-----------------------------------+--------+-----------------------+

 | | | ``ETHTOOL_A_STRINGSET_STRINGS``   | nested | array of strings      |

 +-+-+-+---------------------------------+--------+-----------------------+

 | | | | ``ETHTOOL_A_STRINGS_STRING+``   | nested | one string            |

 +-+-+-+-+-------------------------------+--------+-----------------------+

 | | | | | ``ETHTOOL_A_STRING_INDEX``    | u32    | string index          |

 +-+-+-+-+-------------------------------+--------+-----------------------+

 | | | | | ``ETHTOOL_A_STRING_VALUE``    | string | string value          |

 +-+-+-+-+-------------------------------+--------+-----------------------+

 | ``ETHTOOL_A_STRSET_COUNTS_ONLY``      | flag   | return only counts    |

 +---------------------------------------+--------+-----------------------+



Device identification in request header is optional. Depending on its presence

a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests:



 - no ``NLM_F_DUMP,`` no device: get "global" stringsets

 - no ``NLM_F_DUMP``, with device: get string sets related to the device

 - ``NLM_F_DUMP``, no device: get device related string sets for all devices



If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of

requested type are returned, otherwise only those specified in the request.

Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string

counts of the sets, not the actual strings.





Request translation

===================
@@ -242,7 +313,7 @@ have their netlink replacement yet. 
  ``ETHTOOL_GSG``                     n/a

  ``ETHTOOL_SSG``                     n/a

  ``ETHTOOL_TEST``                    n/a

  ``ETHTOOL_GSTRINGS``                n/a

  ``ETHTOOL_GSTRINGS``                ``ETHTOOL_MSG_STRSET_GET``

  ``ETHTOOL_PHYS_ID``                 n/a

  ``ETHTOOL_GSTATS``                  n/a

  ``ETHTOOL_GTSO``                    n/a
@@ -270,7 +341,7 @@ have their netlink replacement yet. 
  ``ETHTOOL_RESET``                   n/a

  ``ETHTOOL_SRXNTUPLE``               n/a

  ``ETHTOOL_GRXNTUPLE``               n/a

  ``ETHTOOL_GSSET_INFO``              n/a

  ``ETHTOOL_GSSET_INFO``              ``ETHTOOL_MSG_STRSET_GET``

  ``ETHTOOL_GRXFHINDIR``              n/a

  ``ETHTOOL_SRXFHINDIR``              n/a

  ``ETHTOOL_GFEATURES``               n/a

include/uapi/linux/ethtool.h

+3 −0
Original line number Diff line number Diff line
@@ -606,6 +606,9 @@ enum ethtool_stringset { 
	ETH_SS_PHY_STATS,

	ETH_SS_PHY_TUNABLES,

	ETH_SS_LINK_MODES,



	/* add new constants above here */

	ETH_SS_COUNT

};



/**

include/uapi/linux/ethtool_netlink.h

+56 −0
Original line number Diff line number Diff line
@@ -14,6 +14,7 @@ 
/* message types - userspace to kernel */

enum {

	ETHTOOL_MSG_USER_NONE,

	ETHTOOL_MSG_STRSET_GET,



	/* add new constants above here */

	__ETHTOOL_MSG_USER_CNT,
@@ -23,6 +24,7 @@ enum { 
/* message types - kernel to userspace */

enum {

	ETHTOOL_MSG_KERNEL_NONE,

	ETHTOOL_MSG_STRSET_GET_REPLY,



	/* add new constants above here */

	__ETHTOOL_MSG_KERNEL_CNT,
@@ -85,6 +87,60 @@ enum { 
	ETHTOOL_A_BITSET_MAX = __ETHTOOL_A_BITSET_CNT - 1

};



/* string sets */



enum {

	ETHTOOL_A_STRING_UNSPEC,

	ETHTOOL_A_STRING_INDEX,			/* u32 */

	ETHTOOL_A_STRING_VALUE,			/* string */



	/* add new constants above here */

	__ETHTOOL_A_STRING_CNT,

	ETHTOOL_A_STRING_MAX = __ETHTOOL_A_STRING_CNT - 1

};



enum {

	ETHTOOL_A_STRINGS_UNSPEC,

	ETHTOOL_A_STRINGS_STRING,		/* nest - _A_STRINGS_* */



	/* add new constants above here */

	__ETHTOOL_A_STRINGS_CNT,

	ETHTOOL_A_STRINGS_MAX = __ETHTOOL_A_STRINGS_CNT - 1

};



enum {

	ETHTOOL_A_STRINGSET_UNSPEC,

	ETHTOOL_A_STRINGSET_ID,			/* u32 */

	ETHTOOL_A_STRINGSET_COUNT,		/* u32 */

	ETHTOOL_A_STRINGSET_STRINGS,		/* nest - _A_STRINGS_* */



	/* add new constants above here */

	__ETHTOOL_A_STRINGSET_CNT,

	ETHTOOL_A_STRINGSET_MAX = __ETHTOOL_A_STRINGSET_CNT - 1

};



enum {

	ETHTOOL_A_STRINGSETS_UNSPEC,

	ETHTOOL_A_STRINGSETS_STRINGSET,		/* nest - _A_STRINGSET_* */



	/* add new constants above here */

	__ETHTOOL_A_STRINGSETS_CNT,

	ETHTOOL_A_STRINGSETS_MAX = __ETHTOOL_A_STRINGSETS_CNT - 1

};



/* STRSET */



enum {

	ETHTOOL_A_STRSET_UNSPEC,

	ETHTOOL_A_STRSET_HEADER,		/* nest - _A_HEADER_* */

	ETHTOOL_A_STRSET_STRINGSETS,		/* nest - _A_STRINGSETS_* */

	ETHTOOL_A_STRSET_COUNTS_ONLY,		/* flag */



	/* add new constants above here */

	__ETHTOOL_A_STRSET_CNT,

	ETHTOOL_A_STRSET_MAX = __ETHTOOL_A_STRSET_CNT - 1

};



/* generic netlink info */

#define ETHTOOL_GENL_NAME "ethtool"

#define ETHTOOL_GENL_VERSION 1

net/ethtool/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -4,4 +4,4 @@ obj-y += ioctl.o common.o 


obj-$(CONFIG_ETHTOOL_NETLINK)	+= ethtool_nl.o



ethtool_nl-y	:= netlink.o bitset.o
 
ethtool_nl-y	:= netlink.o bitset.o strset.o

net/ethtool/netlink.c

+8 −0
Original line number Diff line number Diff line
@@ -194,6 +194,7 @@ struct ethnl_dump_ctx { 


static const struct ethnl_request_ops *

ethnl_default_requests[__ETHTOOL_MSG_USER_CNT] = {

	[ETHTOOL_MSG_STRSET_GET]	= &ethnl_strset_request_ops,

};



static struct ethnl_dump_ctx *ethnl_dump_context(struct netlink_callback *cb)
@@ -518,6 +519,13 @@ EXPORT_SYMBOL(ethtool_notify); 
/* genetlink setup */



static const struct genl_ops ethtool_genl_ops[] = {

	{

		.cmd	= ETHTOOL_MSG_STRSET_GET,

		.doit	= ethnl_default_doit,

		.start	= ethnl_default_start,

		.dumpit	= ethnl_default_dumpit,

		.done	= ethnl_default_done,

	},

};



static const struct genl_multicast_group ethtool_nl_mcgrps[] = {

CRA Git | Maintained and supported by SUSTech CRA and CCSE