Commit db038b1b authored by David S. Miller's avatar David S. Miller
Browse files

Merge branch 'ethtool-netlink-interface-part-2' 



Michal Kubecek says:

====================
ethtool netlink interface, part 2

This shorter series adds support for getting and setting of wake-on-lan
settings and message mask (originally message level). Together with the
code already in net-next, this will allow full implementation of
"ethtool <dev>" and "ethtool -s <dev> ...".

Older versions of the ethtool netlink series allowed getting WoL settings
by unprivileged users and only filtered out the password but this was
a source of controversy so for now, ETHTOOL_MSG_WOL_GET request always
requires CAP_NET_ADMIN as ETHTOOL_GWOL ioctl request does.
====================

Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parents 82bc2e4a 67bffa79

Documentation/networking/ethtool-netlink.rst

+104 −6
Original line number Diff line number Diff line
@@ -185,18 +185,26 @@ Userspace to kernel: 
  ``ETHTOOL_MSG_LINKMODES_GET``         get link modes info

  ``ETHTOOL_MSG_LINKMODES_SET``         set link modes info

  ``ETHTOOL_MSG_LINKSTATE_GET``         get link state

  ``ETHTOOL_MSG_DEBUG_GET``             get debugging settings

  ``ETHTOOL_MSG_DEBUG_SET``             set debugging settings

  ``ETHTOOL_MSG_WOL_GET``               get wake-on-lan settings

  ``ETHTOOL_MSG_WOL_SET``               set wake-on-lan settings

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



Kernel to userspace:



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

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

  ``ETHTOOL_MSG_STRSET_GET_REPLY``      string set contents

  ``ETHTOOL_MSG_LINKINFO_GET_REPLY``    link settings

  ``ETHTOOL_MSG_LINKINFO_NTF``          link settings notification

  ``ETHTOOL_MSG_LINKMODES_GET_REPLY``   link modes info

  ``ETHTOOL_MSG_LINKMODES_NTF``         link modes notification

  ``ETHTOOL_MSG_LINKSTATE_GET_REPLY``   link state info

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

  ``ETHTOOL_MSG_DEBUG_GET_REPLY``       debugging settings

  ``ETHTOOL_MSG_DEBUG_NTF``             debugging settings notification

  ``ETHTOOL_MSG_WOL_GET_REPLY``         wake-on-lan settings

  ``ETHTOOL_MSG_WOL_NTF``               wake-on-lan settings notification

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



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

information. They usually do not contain any message specific attributes.
@@ -423,6 +431,96 @@ define their own handler. 
devices supporting the request).





DEBUG_GET

=========



Requests debugging settings of a device. At the moment, only message mask is

provided.



Request contents:



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

  ``ETHTOOL_A_DEBUG_HEADER``            nested  request header

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



Kernel response contents:



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

  ``ETHTOOL_A_DEBUG_HEADER``            nested  reply header

  ``ETHTOOL_A_DEBUG_MSGMASK``           bitset  message mask

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



The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as

provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl

interface. While it is called message level there for historical reasons, most

drivers and almost all newer drivers use it as a mask of enabled message

classes (represented by ``NETIF_MSG_*`` constants); therefore netlink

interface follows its actual use in practice.



``DEBUG_GET`` allows dump requests (kernel returns reply messages for all

devices supporting the request).





DEBUG_SET

=========



Set or update debugging settings of a device. At the moment, only message mask

is supported.



Request contents:



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

  ``ETHTOOL_A_DEBUG_HEADER``            nested  request header

  ``ETHTOOL_A_DEBUG_MSGMASK``           bitset  message mask

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



``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of

enabled debugging message types for the device.





WOL_GET

=======



Query device wake-on-lan settings. Unlike most "GET" type requests,

``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it

(potentially) provides SecureOn(tm) password which is confidential.



Request contents:



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

  ``ETHTOOL_A_WOL_HEADER``              nested  request header

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



Kernel response contents:



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

  ``ETHTOOL_A_WOL_HEADER``              nested  reply header

  ``ETHTOOL_A_WOL_MODES``               bitset  mask of enabled WoL modes

  ``ETHTOOL_A_WOL_SOPASS``              binary  SecureOn(tm) password

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



In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the

device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only

included in reply if ``WAKE_MAGICSECURE`` mode is supported.





WOL_SET

=======



Set or update wake-on-lan settings.



Request contents:



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

  ``ETHTOOL_A_WOL_HEADER``              nested  request header

  ``ETHTOOL_A_WOL_MODES``               bitset  enabled WoL modes

  ``ETHTOOL_A_WOL_SOPASS``              binary  SecureOn(tm) password

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



``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting

``WAKE_MAGICSECURE`` mode.





Request translation

===================
@@ -439,10 +537,10 @@ have their netlink replacement yet. 
                                      ``ETHTOOL_MSG_LINKMODES_SET``

  ``ETHTOOL_GDRVINFO``                n/a

  ``ETHTOOL_GREGS``                   n/a

  ``ETHTOOL_GWOL``                    n/a

  ``ETHTOOL_SWOL``                    n/a

  ``ETHTOOL_GMSGLVL``                 n/a

  ``ETHTOOL_SMSGLVL``                 n/a

  ``ETHTOOL_GWOL``                    ``ETHTOOL_MSG_WOL_GET``

  ``ETHTOOL_SWOL``                    ``ETHTOOL_MSG_WOL_SET``

  ``ETHTOOL_GMSGLVL``                 ``ETHTOOL_MSG_DEBUG_GET``

  ``ETHTOOL_SMSGLVL``                 ``ETHTOOL_MSG_DEBUG_SET``

  ``ETHTOOL_NWAY_RST``                n/a

  ``ETHTOOL_GLINK``                   ``ETHTOOL_MSG_LINKSTATE_GET``

  ``ETHTOOL_GEEPROM``                 n/a

include/linux/netdevice.h

+41 −15
Original line number Diff line number Diff line
@@ -3913,22 +3913,48 @@ void netif_device_attach(struct net_device *dev); 
 */



enum {

	NETIF_MSG_DRV		= 0x0001,

	NETIF_MSG_PROBE		= 0x0002,

	NETIF_MSG_LINK		= 0x0004,

	NETIF_MSG_TIMER		= 0x0008,

	NETIF_MSG_IFDOWN	= 0x0010,

	NETIF_MSG_IFUP		= 0x0020,

	NETIF_MSG_RX_ERR	= 0x0040,

	NETIF_MSG_TX_ERR	= 0x0080,

	NETIF_MSG_TX_QUEUED	= 0x0100,

	NETIF_MSG_INTR		= 0x0200,

	NETIF_MSG_TX_DONE	= 0x0400,

	NETIF_MSG_RX_STATUS	= 0x0800,

	NETIF_MSG_PKTDATA	= 0x1000,

	NETIF_MSG_HW		= 0x2000,

	NETIF_MSG_WOL		= 0x4000,

	NETIF_MSG_DRV_BIT,

	NETIF_MSG_PROBE_BIT,

	NETIF_MSG_LINK_BIT,

	NETIF_MSG_TIMER_BIT,

	NETIF_MSG_IFDOWN_BIT,

	NETIF_MSG_IFUP_BIT,

	NETIF_MSG_RX_ERR_BIT,

	NETIF_MSG_TX_ERR_BIT,

	NETIF_MSG_TX_QUEUED_BIT,

	NETIF_MSG_INTR_BIT,

	NETIF_MSG_TX_DONE_BIT,

	NETIF_MSG_RX_STATUS_BIT,

	NETIF_MSG_PKTDATA_BIT,

	NETIF_MSG_HW_BIT,

	NETIF_MSG_WOL_BIT,



	/* When you add a new bit above, update netif_msg_class_names array

	 * in net/ethtool/common.c

	 */

	NETIF_MSG_CLASS_COUNT,

};

/* Both ethtool_ops interface and internal driver implementation use u32 */

static_assert(NETIF_MSG_CLASS_COUNT <= 32);



#define __NETIF_MSG_BIT(bit)	((u32)1 << (bit))

#define __NETIF_MSG(name)	__NETIF_MSG_BIT(NETIF_MSG_ ## name ## _BIT)



#define NETIF_MSG_DRV		__NETIF_MSG(DRV)

#define NETIF_MSG_PROBE		__NETIF_MSG(PROBE)

#define NETIF_MSG_LINK		__NETIF_MSG(LINK)

#define NETIF_MSG_TIMER		__NETIF_MSG(TIMER)

#define NETIF_MSG_IFDOWN	__NETIF_MSG(IFDOWN)

#define NETIF_MSG_IFUP		__NETIF_MSG(IFUP)

#define NETIF_MSG_RX_ERR	__NETIF_MSG(RX_ERR)

#define NETIF_MSG_TX_ERR	__NETIF_MSG(TX_ERR)

#define NETIF_MSG_TX_QUEUED	__NETIF_MSG(TX_QUEUED)

#define NETIF_MSG_INTR		__NETIF_MSG(INTR)

#define NETIF_MSG_TX_DONE	__NETIF_MSG(TX_DONE)

#define NETIF_MSG_RX_STATUS	__NETIF_MSG(RX_STATUS)

#define NETIF_MSG_PKTDATA	__NETIF_MSG(PKTDATA)

#define NETIF_MSG_HW		__NETIF_MSG(HW)

#define NETIF_MSG_WOL		__NETIF_MSG(WOL)



#define netif_msg_drv(p)	((p)->msg_enable & NETIF_MSG_DRV)

#define netif_msg_probe(p)	((p)->msg_enable & NETIF_MSG_PROBE)

include/uapi/linux/ethtool.h

+6 −0
Original line number Diff line number Diff line
@@ -594,6 +594,8 @@ struct ethtool_pauseparam { 
 * @ETH_SS_PHY_STATS: Statistic names, for use with %ETHTOOL_GPHYSTATS

 * @ETH_SS_PHY_TUNABLES: PHY tunable names

 * @ETH_SS_LINK_MODES: link mode names

 * @ETH_SS_MSG_CLASSES: debug message class names

 * @ETH_SS_WOL_MODES: wake-on-lan modes

 */

enum ethtool_stringset {

	ETH_SS_TEST		= 0,
@@ -606,6 +608,8 @@ enum ethtool_stringset { 
	ETH_SS_PHY_STATS,

	ETH_SS_PHY_TUNABLES,

	ETH_SS_LINK_MODES,

	ETH_SS_MSG_CLASSES,

	ETH_SS_WOL_MODES,



	/* add new constants above here */

	ETH_SS_COUNT
@@ -1693,6 +1697,8 @@ static inline int ethtool_validate_duplex(__u8 duplex) 
#define WAKE_MAGICSECURE	(1 << 6) /* only meaningful if WAKE_MAGIC */

#define WAKE_FILTER		(1 << 7)



#define WOL_MODE_COUNT		8



/* L2-L4 network traffic flow types */

#define	TCP_V4_FLOW	0x01	/* hash or spec (tcp_ip4_spec) */

#define	UDP_V4_FLOW	0x02	/* hash or spec (udp_ip4_spec) */

include/uapi/linux/ethtool_netlink.h

+33 −0
Original line number Diff line number Diff line
@@ -20,6 +20,10 @@ enum { 
	ETHTOOL_MSG_LINKMODES_GET,

	ETHTOOL_MSG_LINKMODES_SET,

	ETHTOOL_MSG_LINKSTATE_GET,

	ETHTOOL_MSG_DEBUG_GET,

	ETHTOOL_MSG_DEBUG_SET,

	ETHTOOL_MSG_WOL_GET,

	ETHTOOL_MSG_WOL_SET,



	/* add new constants above here */

	__ETHTOOL_MSG_USER_CNT,
@@ -35,6 +39,10 @@ enum { 
	ETHTOOL_MSG_LINKMODES_GET_REPLY,

	ETHTOOL_MSG_LINKMODES_NTF,

	ETHTOOL_MSG_LINKSTATE_GET_REPLY,

	ETHTOOL_MSG_DEBUG_GET_REPLY,

	ETHTOOL_MSG_DEBUG_NTF,

	ETHTOOL_MSG_WOL_GET_REPLY,

	ETHTOOL_MSG_WOL_NTF,



	/* add new constants above here */

	__ETHTOOL_MSG_KERNEL_CNT,
@@ -195,6 +203,31 @@ enum { 
	ETHTOOL_A_LINKSTATE_MAX = __ETHTOOL_A_LINKSTATE_CNT - 1

};



/* DEBUG */



enum {

	ETHTOOL_A_DEBUG_UNSPEC,

	ETHTOOL_A_DEBUG_HEADER,			/* nest - _A_HEADER_* */

	ETHTOOL_A_DEBUG_MSGMASK,		/* bitset */



	/* add new constants above here */

	__ETHTOOL_A_DEBUG_CNT,

	ETHTOOL_A_DEBUG_MAX = __ETHTOOL_A_DEBUG_CNT - 1

};



/* WOL */



enum {

	ETHTOOL_A_WOL_UNSPEC,

	ETHTOOL_A_WOL_HEADER,			/* nest - _A_HEADER_* */

	ETHTOOL_A_WOL_MODES,			/* bitset */

	ETHTOOL_A_WOL_SOPASS,			/* binary */



	/* add new constants above here */

	__ETHTOOL_A_WOL_CNT,

	ETHTOOL_A_WOL_MAX = __ETHTOOL_A_WOL_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
@@ -5,4 +5,4 @@ obj-y += ioctl.o common.o 
obj-$(CONFIG_ETHTOOL_NETLINK)	+= ethtool_nl.o



ethtool_nl-y	:= netlink.o bitset.o strset.o linkinfo.o linkmodes.o \

		   linkstate.o
 
		   linkstate.o debug.o wol.o

CRA Git | Maintained and supported by SUSTech CRA and CCSE