ethtool netlink interface, part 1
Subsystems (5)
v4 cover ethtool netlink interface, part 1
This is first part of netlink based alternative userspace interface for ethtool. The aim is to address some long known issues with the ioctl interface, mainly lack of extensibility, raciness, limited error reporting and absence of notifications. The goal is to allow userspace ethtool utility to provide all features it currently does but without using the ioctl interface.
The interface uses generic netlink family "ethtool"; it provides multicast group "monitor" which is used for notifications. Documentation for the interface is in Documentation/networking/ethtool-netlink.txt file. The netlink interface is optional, it is built when CONFIG_ETHTOOL_NETLINK (bool) option is enabled.
There are three types of requests distinguished by prefix "GET" (query for information), "SET" (modify parameters) and "ACT" (perform an action). The GET_* and SET_* messages are paired even if the data they deal with is read only because SET_* message is also used for reply to corresponding GET_* message. Notifications on parameter changes are also sent as SET_* messages in the same format as reply to corresponding GET request.
Basic concepts:
- make extensions easier not only by allowing new attributes but also by imposing as few artificial limits as possible, e.g. by using arbitrary size bit sets for most bitmap attributes or by not using fixed size strings
- use extack for error reporting and warnings
- send netlink notifications on changes (even if they were done using the ioctl interfaces)
- avoid the racy read/modify/write cycle between kernel and userspace by sending only attributes which userspace wants to change; there is still a read/modify/write cycle between generic kernel code and ethtool_ops handler in NIC driver but it is only in kernel and under a lock
- reduce the number of value lists that need to be kept in sync between kernel and userspace (e.g. recognized link modes)
- where feasible, allow dump requests to query specific information for all network devices
- as the lack of extensibility of the ioctl interface led to having too many commands, group some of these together to one netlink message but allow querying only part(s) of the information (using "info mask" bitmap) and modifying only some of the parameters (by providing only some attributes)
- as parsing and generating netlink messages is more complicated than simply copying data structures between userspace API and ethtool_ops handlers (which most ioctl commands do), split the code into multiple files in net/ethtool directory; move net/core/ethtool.c also to this directory and rename it to ioctl.c
The full (work in progress) series, together with the (userspace) ethtool counterpart can be found at https://github.com/mkubecek/ethnl
Main changes between RFC v3 and v4:
- use more kerneldoc style comments
- strict attribute policy checking
- use macros for tables of link mode names and parameters
- provide permanent hardware address in rtnetlink
- coding style cleanup
- split too long patches, reorder
- wrap more ETHA_SETTINGS_* attributes in nests
- add also some SET_* implementation into submitted part
Main changes between RFC v2 and RFC v3:
- do not allow building as a module (no netdev notifiers needed)
- drop some obsolete fields
- add permanent hw address, timestamping and private flags support
- rework bitset handling to get rid of variable length arrays
- notify monitor on device renames
- restructure GET_SETTINGS/SET_SETTINGS messages
- split too long patches and submit only first part of the series
Main changes between RFC v1 and RFC v2:
- support dumps for all "get" requests
- provide notifications for changes related to supported request types
- support getting string sets (both global and per device)
- support getting/setting device features
- get rid of family specific header, everything passed as attributes
- split netlink code into multiple files in net/ethtool/ directory
ToDo / open questions:
- some features provided by ethtool would rather belong to devlink (and some are already superseded by devlink); however, only few drivers provide devlink interface at the moment and as recent discussion on flashing revealed, we cannot rely on devlink's presence
- while the netlink interface allows easy future extensions, ethtool_ops interface does not; some settings could be implemented using tunables and accessed via relevant netlink messages (as well as tunables) from userspace but in the long term, something better will be needed
- currently, all communication with drivers via ethtool_ops is done under RTNL as this is what ioctl interface does and likely many ethtool_ops handlers rely on that; if we are going to rework ethtool_ops in the future ("phase two"), it would be nice to get rid of it
- ethtool_ops should pass extack pointer to allow drivers more meaningful error reporting; it's not clear, however, how to pass information about offending attribute
- notifications are sent whenever a change is done via netlink API or ioctl API and for netdev features also whenever they are updated using netdev_change_features(); it would be desirable to notify also about link state and negotiation result (speed/duplex and partner link modes) but it would be more tricky
Michal Kubecek (22):
rtnetlink: provide permanent hardware address in RTM_NEWLINK
netlink: introduce nla_put_bitfield32()
netlink: add strict version of nla_parse_nested()
ethtool: move to its own directory
ethtool: introduce ethtool netlink interface
ethtool: helper functions for netlink interface
ethtool: netlink bitset handling
ethtool: support for netlink notifications
ethtool: implement EVENT notifications
ethtool: generic handlers for GET requests
ethtool: move string arrays into common file
ethtool: provide string sets with GET_STRSET request
ethtool: provide driver/device information in GET_INFO request
ethtool: provide timestamping information in GET_INFO request
ethtool: provide link mode names as a string set
ethtool: provide link settings and link modes in GET_SETTINGS request
ethtool: set link settings and link modes with SET_SETTINGS request
ethtool: provide link state in GET_SETTINGS request
ethtool: provide WoL information in GET_SETTINGS request
ethtool: set WoL settings with SET_SETTINGS request
ethtool: provide message level in GET_SETTINGS request
ethtool: set message level with SET_SETTINGS request
Documentation/networking/ethtool-netlink.txt | 458 +++++++++++
include/linux/ethtool.h | 4 +
include/linux/ethtool_netlink.h | 17 +
include/linux/netdevice.h | 14 +
include/net/netlink.h | 24 +
include/uapi/linux/ethtool.h | 10 +
include/uapi/linux/ethtool_netlink.h | 274 ++++++
include/uapi/linux/if_link.h | 1 +
include/uapi/linux/net_tstamp.h | 13 +
net/Kconfig | 8 +
net/Makefile | 2 +-
net/core/Makefile | 2 +-
net/core/rtnetlink.c | 4 +
net/ethtool/Makefile | 7 +
net/ethtool/bitset.c | 597 ++++++++++++++
net/ethtool/bitset.h | 40 +
net/ethtool/common.c | 225 +++++
net/ethtool/common.h | 27 +
net/ethtool/info.c | 296 +++++++
net/{core/ethtool.c => ethtool/ioctl.c} | 237 +-----
net/ethtool/netlink.c | 705 ++++++++++++++++
net/ethtool/netlink.h | 296 +++++++
net/ethtool/settings.c | 823 +++++++++++++++++++
net/ethtool/strset.c | 471 +++++++++++
24 files changed, 4352 insertions(+), 203 deletions(-)
create mode 100644 Documentation/networking/ethtool-netlink.txt
create mode 100644 include/linux/ethtool_netlink.h
create mode 100644 include/uapi/linux/ethtool_netlink.h
create mode 100644 net/ethtool/Makefile
create mode 100644 net/ethtool/bitset.c
create mode 100644 net/ethtool/bitset.h
create mode 100644 net/ethtool/common.c
create mode 100644 net/ethtool/common.h
create mode 100644 net/ethtool/info.c
rename net/{core/ethtool.c => ethtool/ioctl.c} (91%)
create mode 100644 net/ethtool/netlink.c
create mode 100644 net/ethtool/netlink.h
create mode 100644 net/ethtool/settings.c
create mode 100644 net/ethtool/strset.cSignature · 1 line
2.21.0
I'm sorry, I'll have to resend the series. A comma was missing in the headers so that majordomo at vger.kernel.org discarded it. Sorry for the noise.
Michal
Quoted 3 lines · Michal Kubecek
I'm sorry, I'll have to resend the series. A comma was missing in the headers so that majordomo at vger.kernel.org discarded it. Sorry for the noise.
And this message shouldn't have been sent to netdev and LKML lists. :-(
Michal
PATCH v4 1/22 rtnetlink: provide permanent hardware address in RTM_NEWLINK
In reply to Michal KubecekPermanent hardware address of a network device was traditionally provided via ethtool ioctl interface but as Jiri Pirko pointed out in a review of ethtool netlink interface, rtnetlink is much more suitable for it so let's add it to the RTM_NEWLINK message.
As permanent address is not modifiable, reject userspace requests containing IFLA_PERM_ADDRESS attribute.
Note: we already provide permanent hardware address for bond slaves; unfortunately we cannot drop that attribute for backward compatibility reasons.
--- include/uapi/linux/if_link.h | 1 + net/core/rtnetlink.c | 4 ++++ 2 files changed, 5 insertions(+)
include/uapi/linux/if_link.h +1 -0
@@ -167,6 +167,7 @@ enum {IFLA_NEW_IFINDEX ,IFLA_MIN_MTU ,IFLA_MAX_MTU , +IFLA_PERM_ADDRESS , __IFLA_MAX };
net/core/rtnetlink.c +4 -0
@@ -1026,6 +1026,7 @@ static noinline size_t if_nlmsg_size(const struct net_device *dev, +nla_total_size (4 )/* IFLA_CARRIER_DOWN_COUNT */ +nla_total_size (4 )/* IFLA_MIN_MTU */ +nla_total_size (4 )/* IFLA_MAX_MTU */ + +nla_total_size (MAX_ADDR_LEN )/* IFLA_PERM_ADDRESS */ +0 ; }
@@ -1683,6 +1684,8 @@ static int rtnl_fill_ifinfo(struct sk_buff *skb, nla_put_s32(skb, IFLA_NEW_IFINDEX, new_ifindex) < 0) goto nla_put_failure; +if (nla_put (skb,IFLA_PERM_ADDRESS , dev->addr_len, dev->perm_addr)) + goto nla_put_failure;rcu_read_lock ();if (rtnl_fill_link_af (skb, dev, ext_filter_mask))
@@ -1742,6 +1745,7 @@ static const struct nla_policy ifla_policy[IFLA_MAX+1] = { [IFLA_CARRIER_DOWN_COUNT] = { .type = NLA_U32 }, [IFLA_MIN_MTU] = { .type = NLA_U32 }, [IFLA_MAX_MTU] = { .type = NLA_U32 }, + [IFLA_PERM_ADDRESS] = { .type = NLA_REJECT }, };static const struct nla_policy ifla_info_policy[IFLA_INFO_MAX +1 ] = {
Signature · 1 line
2.21.0
Re: [PATCH net-next v4 01/22] rtnetlink: provide permanent hardware address in RTM_NEWLINK
Quoted 52 lines · On Thu, 21 Mar 2019 14:40:21 +0100 (CET) Michal Kubecek <[email protected]>…
Permanent hardware address of a network device was traditionally provided via ethtool ioctl interface but as Jiri Pirko pointed out in a review of ethtool netlink interface, rtnetlink is much more suitable for it so let's add it to the
RTM_NEWLINKmessage.As permanent address is not modifiable, reject userspace requests containing
IFLA_PERM_ADDRESSattribute.Note: we already provide permanent hardware address for bond slaves; unfortunately we cannot drop that attribute for backward compatibility reasons.
Signed-off-by Michal Kubecek <[email protected]>--- include/uapi/linux/if_link.h | 1 + net/core/rtnetlink.c | 4 ++++ 2 files changed, 5 insertions(+)include/uapi/linux/if_link.h +1
-0@@ -167,6 +167,7 @@ enum {IFLA_NEW_IFINDEX ,IFLA_MIN_MTU ,IFLA_MAX_MTU , +IFLA_PERM_ADDRESS , __IFLA_MAX };net/core/rtnetlink.c +3
-0@@ -1026,6 +1026,7 @@ static noinline size_t if_nlmsg_size(const struct net_device *dev, +nla_total_size (4 )/* IFLA_CARRIER_DOWN_COUNT */ +nla_total_size (4 )/* IFLA_MIN_MTU */ +nla_total_size (4 )/* IFLA_MAX_MTU */ + +nla_total_size (MAX_ADDR_LEN )/* IFLA_PERM_ADDRESS */ +0 ; }@@ -1683,6 +1684,8 @@ static int rtnl_fill_ifinfo(struct sk_buff *skb, nla_put_s32(skb, IFLA_NEW_IFINDEX, new_ifindex) < 0) goto nla_put_failure; +if (nla_put (skb,IFLA_PERM_ADDRESS , dev->addr_len, dev->perm_addr)) + goto nla_put_failure;rcu_read_lock ();if (rtnl_fill_link_af (skb, dev, ext_filter_mask))
net/core/rtnetlink.c static const struct nla_policy ifla_policy[IFLA_MAX+1] = { · line 1751
Quoted 7 lines
net/core/rtnetlink.c +1
-0@@ -1742,6 +1745,7 @@ static const struct nla_policy ifla_policy[IFLA_MAX+1] = { [IFLA_CARRIER_DOWN_COUNT] = { .type = NLA_U32 }, [IFLA_MIN_MTU] = { .type = NLA_U32 }, [IFLA_MAX_MTU] = { .type = NLA_U32 }, + [IFLA_PERM_ADDRESS] = { .type = NLA_REJECT }, };static const struct nla_policy ifla_info_policy[IFLA_INFO_MAX +1 ] = {
+1 this looks good, please also send iproute2 patch to display it.
Re: [PATCH net-next v4 01/22] rtnetlink: provide permanent hardware address in RTM_NEWLINK
In reply to Michal KubecekQuoted 43 lines · Michal Kubecek
Permanent hardware address of a network device was traditionally provided via ethtool ioctl interface but as Jiri Pirko pointed out in a review of ethtool netlink interface, rtnetlink is much more suitable for it so let's add it to the
RTM_NEWLINKmessage.As permanent address is not modifiable, reject userspace requests containing
IFLA_PERM_ADDRESSattribute.Note: we already provide permanent hardware address for bond slaves; unfortunately we cannot drop that attribute for backward compatibility reasons.
Signed-off-by Michal Kubecek <[email protected]>--- include/uapi/linux/if_link.h | 1 + net/core/rtnetlink.c | 4 ++++ 2 files changed, 5 insertions(+)include/uapi/linux/if_link.h +1
-0@@ -167,6 +167,7 @@ enum {IFLA_NEW_IFINDEX ,IFLA_MIN_MTU ,IFLA_MAX_MTU , +IFLA_PERM_ADDRESS , __IFLA_MAX };net/core/rtnetlink.c +1
-0@@ -1026,6 +1026,7 @@ static noinline size_t if_nlmsg_size(const struct net_device *dev, +nla_total_size (4 )/* IFLA_CARRIER_DOWN_COUNT */ +nla_total_size (4 )/* IFLA_MIN_MTU */ +nla_total_size (4 )/* IFLA_MAX_MTU */ + +nla_total_size (MAX_ADDR_LEN )/* IFLA_PERM_ADDRESS */ +0 ; }
net/core/rtnetlink.c static int rtnl_fill_ifinfo(struct sk_buff *skb, · line 1687
Quoted 4 lines
net/core/rtnetlink.c +1
-0@@ -1683,6 +1684,8 @@ static int rtnl_fill_ifinfo(struct sk_buff *skb, nla_put_s32(skb, IFLA_NEW_IFINDEX, new_ifindex) < 0) goto nla_put_failure; +if (nla_put (skb,IFLA_PERM_ADDRESS , dev->addr_len, dev->perm_addr))
Should we check the perm_addr is non-zero, i.e. it has been filled in by the driver?
Quoted 12 lines
net/core/rtnetlink.c +2
-0+ goto nla_put_failure;rcu_read_lock ();if (rtnl_fill_link_af (skb, dev, ext_filter_mask))@@ -1742,6 +1745,7 @@ static const struct nla_policy ifla_policy[IFLA_MAX+1] = { [IFLA_CARRIER_DOWN_COUNT] = { .type = NLA_U32 }, [IFLA_MIN_MTU] = { .type = NLA_U32 }, [IFLA_MAX_MTU] = { .type = NLA_U32 }, + [IFLA_PERM_ADDRESS] = { .type = NLA_REJECT }, };static const struct nla_policy ifla_info_policy[IFLA_INFO_MAX +1 ] = {
Re: [PATCH net-next v4 01/22] rtnetlink: provide permanent hardware address in RTM_NEWLINK
Quoted 43 lines · Jakub Kicinski
Quoted 42 lines · Michal Kubecek
Permanent hardware address of a network device was traditionally provided via ethtool ioctl interface but as Jiri Pirko pointed out in a review of ethtool netlink interface, rtnetlink is much more suitable for it so let's add it to the
RTM_NEWLINKmessage.As permanent address is not modifiable, reject userspace requests containing
IFLA_PERM_ADDRESSattribute.Note: we already provide permanent hardware address for bond slaves; unfortunately we cannot drop that attribute for backward compatibility reasons.
Signed-off-by Michal Kubecek <[email protected]>--- include/uapi/linux/if_link.h | 1 + net/core/rtnetlink.c | 4 ++++ 2 files changed, 5 insertions(+)include/uapi/linux/if_link.h +1
-0@@ -167,6 +167,7 @@ enum {IFLA_NEW_IFINDEX ,IFLA_MIN_MTU ,IFLA_MAX_MTU , +IFLA_PERM_ADDRESS , __IFLA_MAX };net/core/rtnetlink.c +1
-0@@ -1026,6 +1026,7 @@ static noinline size_t if_nlmsg_size(const struct net_device *dev, +nla_total_size (4 )/* IFLA_CARRIER_DOWN_COUNT */ +nla_total_size (4 )/* IFLA_MIN_MTU */ +nla_total_size (4 )/* IFLA_MAX_MTU */ + +nla_total_size (MAX_ADDR_LEN )/* IFLA_PERM_ADDRESS */ +0 ; }
Quoted 8 lines
net/core/rtnetlink.c static int rtnl_fill_ifinfo(struct sk_buff *skb, · line 1687
Quoted 5 lines
net/core/rtnetlink.c +1
-0@@ -1683,6 +1684,8 @@ static int rtnl_fill_ifinfo(struct sk_buff *skb, nla_put_s32(skb, IFLA_NEW_IFINDEX, new_ifindex) < 0) goto nla_put_failure; +if (nla_put (skb,IFLA_PERM_ADDRESS , dev->addr_len, dev->perm_addr))Should we check the
perm_addris non-zero, i.e. it has been filled in by the driver?
It makes sense logically but there is IMHO one practical problem: if we omit the attribute when the address is zero (i.e. not set or maybe a device which does not have permanent address), userspace won't be able to distinguish this case from an older kernel not implementing the attribute.
For the iproute2 patch, I plan to show the permanent address in the output of "ip link show" only if it differs from current address. I think it would be desirable to distinguish "current address is the permanent one" from "no/unknown permanent address" but absence of the attribute could also mean "kernel does not provide the information".
Michal
David Miller
maintainerRe: [PATCH net-next v4 01/22] rtnetlink: provide permanent hardware address in RTM_NEWLINK
In reply to Michal KubecekFrom: Michal Kubecek <[email protected]>
Date: Thu, 21 Mar 2019 14:40:21 +0100 (CET)
Quoted 5 lines
Permanent hardware address of a network device was traditionally provided via ethtool ioctl interface but as Jiri Pirko pointed out in a review of ethtool netlink interface, rtnetlink is much more suitable for it so let's add it to the
RTM_NEWLINKmessage.
Quoted 8 lines
As permanent address is not modifiable, reject userspace requests containing
IFLA_PERM_ADDRESSattribute.Note: we already provide permanent hardware address for bond slaves; unfortunately we cannot drop that attribute for backward compatibility reasons.
Signed-off-by Michal Kubecek <[email protected]>
Jakub asked if we should check the perm_addr and if it is set.
I would say no, in order to be consistent with what ethtool does which is that it does not check.
PATCH v4 2/22 netlink: introduce nla_put_bitfield32()
In reply to Michal KubecekSimilar to other data types, this helper puts NLA_BITFIELD32 attribute into a netlink message. It takes separate value and selector arguments, if there is a struct nla_bitfield32 already, one can use nla_put().
--- include/net/netlink.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
include/net/netlink.h +15 -0
@@ -1211,6 +1211,21 @@ static inline int nla_put_in6_addr(struct sk_buff *skb, int attrtype,return nla_put (skb, attrtype,sizeof (*addr), addr); } +/** +* nla_put_bitfield32 - Add a bitfield32 value/selector attribute to +* a socket buffer +* @skb: socket buffer to add attribute to +* @value: 32-bit value bitmap +* @selector: 32-bit selector bitmap +*/ +static inline int nla_put_bitfield32 (struct sk_buff *skb,int attrtype, +u32 value,u32 selector) +{ +struct nla_bitfield32 tmp = { .value = value, .selector = selector }; + +return nla_put (skb, attrtype,sizeof (tmp), &tmp); +} +/** * nla_get_u32 - return payload of u32 attribute * @nla: u32 netlink attribute
Signature · 1 line
2.21.0
PATCH v4 3/22 netlink: add strict version of nla_parse_nested()
In reply to Michal KubecekSimilar to nla_parse_strict() and nlmsg_parse_strict(), add also nla_parse_nested_strict() as a version of nla_parse_nested() with strict policy checking.
--- include/net/netlink.h | 9 +++++++++ 1 file changed, 9 insertions(+)
include/net/netlink.h +9 -0
@@ -913,6 +913,15 @@ static inline int nla_parse_nested(struct nlattr *tb[], int maxtype, extack); } +static inline int nla_parse_nested_strict (struct nlattr *tb[],int maxtype, +const struct nlattr *nla, +const struct nla_policy *policy, +struct netlink_ext_ack *extack) +{ +return nla_parse_strict (tb, maxtype,nla_data (nla),nla_len (nla), + policy, extack); +} +/** * nla_put_u8 - Add a u8 netlink attribute to a socket buffer * @skb: socket buffer to add attribute to
Signature · 1 line
2.21.0
PATCH v4 4/22 ethtool: move to its own directory
In reply to Michal KubecekThe ethtool netlink interface is going to be split into multiple files so that it will be more convenient to put all of them in a separate directory net/ethtool. Start by moving current ethtool.c with ioctl interface into this directory and renaming it to ioctl.c.
---
net/Makefile | 2 +-
net/core/Makefile | 2 +-
net/ethtool/Makefile | 3 +++
net/{core/ethtool.c => ethtool/ioctl.c} | 0
4 files changed, 5 insertions(+), 2 deletions(-)
create mode 100644 net/ethtool/Makefile
rename net/{core/ethtool.c => ethtool/ioctl.c} (100%)net/Makefile +1 -1
@@ -13,7 +13,7 @@ obj-$(CONFIG_NET) += $(tmp-y) # LLC has to be linked before the files in net/802/ obj-$(CONFIG_LLC) += llc/ -obj-$(CONFIG_NET) += ethernet/ 802/ sched/ netlink/ bpf/ +obj-$(CONFIG_NET) += ethernet/ 802/ sched/ netlink/ bpf/ ethtool/ obj-$(CONFIG_NETFILTER) += netfilter/ obj-$(CONFIG_INET) += ipv4/ obj-$(CONFIG_TLS) += tls/
net/core/Makefile +1 -1
@@ -8,7 +8,7 @@ obj-y := sock.o request_sock.o skbuff.o datagram.o stream.o scm.o \ obj-$(CONFIG_SYSCTL) += sysctl_net_core.o -obj-y += dev.o ethtool.o dev_addr_lists.o dst.o netevent.o \ +obj-y += dev.o dev_addr_lists.o dst.o netevent.o \ neighbour.o rtnetlink.o utils.o link_watch.o filter.o \ sock_diag.o dev_ioctl.o tso.o sock_reuseport.o \ fib_notifier.o xdp.o flow_offload.o
net/ethtool/Makefile new file +3 -0
@@ -0,0 +1,3 @@ +# SPDX-License-Identifier: GPL-2.0 + +obj-y += ioctl.o
net/ethtool/ioctl.c renamed from net/core/ethtool.c +0 -0
Signature · 1 line
2.21.0
PATCH v4 5/22 ethtool: introduce ethtool netlink interface
In reply to Michal KubecekBasic genetlink and init infrastructure for the netlink interface, register genetlink family "ethtool". Introduce CONFIG_ETHTOOL_NETLINK Kconfig option. Add interface description into Documentation/networking.
--- Documentation/networking/ethtool-netlink.txt | 168 +++++++++++++++++++ include/linux/ethtool_netlink.h | 9 + include/uapi/linux/ethtool_netlink.h | 25 +++ net/Kconfig | 8 + net/ethtool/Makefile | 6 +- net/ethtool/netlink.c | 34 ++++ net/ethtool/netlink.h | 12 ++ 7 files changed, 261 insertions(+), 1 deletion(-) create mode 100644 Documentation/networking/ethtool-netlink.txt create mode 100644 include/linux/ethtool_netlink.h create mode 100644 include/uapi/linux/ethtool_netlink.h create mode 100644 net/ethtool/netlink.c create mode 100644 net/ethtool/netlink.h
Documentation/networking/ethtool-netlink.txt new file +168 -0
@@ -0,0 +1,168 @@ + Netlink interface for ethtool + ============================= + + +Basic information +----------------- + +Netlink interface for ethtool uses generic netlink family "ethtool" (userspace +application should use macros ETHTOOL_GENL_NAME and ETHTOOL_GENL_VERSION +defined in <linux/ethtool_netlink.h> uapi header). This family does not use +a specific header, all information in requests and replies is passed using +netlink attributes. + +In requests, device can be identified by ifindex or by name; if both are used, +they must match. In replies, kernel fills both. The meaning of flags, +info_mask and index fields depends on request type. + +The ethtool netlink interface uses extended ACK for error and warning +reporting, userspace application developers are encouraged to make these +messages available to user in a suitable way. + +Requests can be divided into three categories: "get" (retrieving information), +"set" (setting parameters) and "action" (invoking an action). + +All "set" and "action" type requests require admin privileges (CAP_NET_ADMIN +in the namespace). Most "get" type request are allowed for anyone but there +are exceptions (where the response contains sensitive information). In some +cases, the request as such is allowed for anyone but unprivileged users have +attributes with sensitive information (e.g. wake-on-lan password) omitted. + + +Conventions +----------- + +Attributes which represent a boolean value usually use u8 type so that we can +distinguish three states: "on", "off" and "not present" (meaning the +information is not available in "get" requests or value is not to be changed +in "set" requests). For these attributes, the "true" value should be passed as +number 1 but any non-zero value should be understood as "true" by recipient. + +Some request types allow passing an attribute named ETHA_*_INFOMASK with +a bitmask telling kernel that we are only interested in some parts of the +information. If info mask is omitted, all available information is returned. +Meaning of info mask bits depends on request type and is listed below. + + +Device identification +--------------------- + +When appropriate, network device is identified by a nested attribute named +ETHA_*_DEV. This attribute can contain + + ETHA_DEV_INDEX (u32) device ifindex + ETHA_DEV_NAME (string) device name + +In device related requests, one of these is sufficient; if both are used, they +must match (i.e. identify the same device). In device related replies both are +provided by kernel. In dump requests, device is not specified and kernel +replies with one message per network device (only those for which the request +is supported). + + +List of message types +--------------------- + +All constants use ETHNL_CMD_ prefix, usually followed by "GET", "SET" or "ACT" +to indicate the type. + +Messages of type "get" are used by userspace to request information and +usually do not contain any attributes (that may be added later for dump +filtering). Kernel response is in the form of corresponding "set" message; +the same message can be also used to set (some of) the parameters, except for +messages marked as "response only" in the table above. "Get" messages with +NLM_F_DUMP flags and no device identification dump the information for all +devices supporting the request. + +Later sections describe the format and semantics of these request messages. + + +Request translation +------------------- + +The following table maps iosctl commands to netlink commands providing their +functionality. Entries with "n/a" in right column are commands which do not +have their netlink replacement yet. + +ioctl command netlink command +--------------------------------------------------------------------- +ETHTOOL_GSET n/a +ETHTOOL_SSET n/a +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_NWAY_RST n/a +ETHTOOL_GLINK n/a +ETHTOOL_GEEPROM n/a +ETHTOOL_SEEPROM n/a +ETHTOOL_GCOALESCE n/a +ETHTOOL_SCOALESCE n/a +ETHTOOL_GRINGPARAM n/a +ETHTOOL_SRINGPARAM n/a +ETHTOOL_GPAUSEPARAM n/a +ETHTOOL_SPAUSEPARAM n/a +ETHTOOL_GRXCSUM n/a +ETHTOOL_SRXCSUM n/a +ETHTOOL_GTXCSUM n/a +ETHTOOL_STXCSUM n/a +ETHTOOL_GSG n/a +ETHTOOL_SSG n/a +ETHTOOL_TEST n/a +ETHTOOL_GSTRINGS n/a +ETHTOOL_PHYS_ID n/a +ETHTOOL_GSTATS n/a +ETHTOOL_GTSO n/a +ETHTOOL_STSO n/a +ETHTOOL_GPERMADDR rtnetlink RTM_GETLINK +ETHTOOL_GUFO n/a +ETHTOOL_SUFO n/a +ETHTOOL_GGSO n/a +ETHTOOL_SGSO n/a +ETHTOOL_GFLAGS n/a +ETHTOOL_SFLAGS n/a +ETHTOOL_GPFLAGS n/a +ETHTOOL_SPFLAGS n/a +ETHTOOL_GRXFH n/a +ETHTOOL_SRXFH n/a +ETHTOOL_GGRO n/a +ETHTOOL_SGRO n/a +ETHTOOL_GRXRINGS n/a +ETHTOOL_GRXCLSRLCNT n/a +ETHTOOL_GRXCLSRULE n/a +ETHTOOL_GRXCLSRLALL n/a +ETHTOOL_SRXCLSRLDEL n/a +ETHTOOL_SRXCLSRLINS n/a +ETHTOOL_FLASHDEV n/a +ETHTOOL_RESET n/a +ETHTOOL_SRXNTUPLE n/a +ETHTOOL_GRXNTUPLE n/a +ETHTOOL_GSSET_INFO n/a +ETHTOOL_GRXFHINDIR n/a +ETHTOOL_SRXFHINDIR n/a +ETHTOOL_GFEATURES n/a +ETHTOOL_SFEATURES n/a +ETHTOOL_GCHANNELS n/a +ETHTOOL_SCHANNELS n/a +ETHTOOL_SET_DUMP n/a +ETHTOOL_GET_DUMP_FLAG n/a +ETHTOOL_GET_DUMP_DATA n/a +ETHTOOL_GET_TS_INFO n/a +ETHTOOL_GMODULEINFO n/a +ETHTOOL_GMODULEEEPROM n/a +ETHTOOL_GEEE n/a +ETHTOOL_SEEE n/a +ETHTOOL_GRSSH n/a +ETHTOOL_SRSSH n/a +ETHTOOL_GTUNABLE n/a +ETHTOOL_STUNABLE n/a +ETHTOOL_GPHYSTATS n/a +ETHTOOL_PERQUEUE n/a +ETHTOOL_GLINKSETTINGS n/a +ETHTOOL_SLINKSETTINGS n/a +ETHTOOL_PHY_GTUNABLE n/a +ETHTOOL_PHY_STUNABLE n/a +ETHTOOL_GFECPARAM n/a +ETHTOOL_SFECPARAM n/a
include/linux/ethtool_netlink.h new file +9 -0
@@ -0,0 +1,9 @@ +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ + +#ifndef _LINUX_ETHTOOL_NETLINK_H_ +#define _LINUX_ETHTOOL_NETLINK_H_ + +#include <uapi/linux/ethtool_netlink.h> +#include <linux/ethtool.h> + +#endif /* _LINUX_ETHTOOL_NETLINK_H_ */
include/uapi/linux/ethtool_netlink.h new file +25 -0
@@ -0,0 +1,25 @@ +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ +/* +* include/uapi/linux/ethtool_netlink.h - netlink interface for ethtool +* +* See Documentation/networking/ethtool-netlink.txt in kernel source tree for +* doucumentation of the interface. +*/ + +#ifndef _UAPI_LINUX_ETHTOOL_NETLINK_H_ +#define _UAPI_LINUX_ETHTOOL_NETLINK_H_ + +#include <linux/ethtool.h> + +enum { +ETHNL_CMD_NOOP , + + __ETHNL_CMD_CNT, +ETHNL_CMD_MAX = (__ETHNL_CMD_CNT -1 ) +}; + +/* generic netlink info */ +#define ETHTOOL_GENL_NAME "ethtool" +#define ETHTOOL_GENL_VERSION 1 + +#endif /* _UAPI_LINUX_ETHTOOL_NETLINK_H_ */
net/Kconfig +8 -0
@@ -451,6 +451,14 @@ config FAILOVER migration of VMs with direct attached VFs by failing over to the paravirtual datapath when the VF is unplugged. +config ETHTOOL_NETLINK + bool "Netlink interface for ethtool" + default y + help + An alternative userspace interface for ethtool based on generic + netlink. It provides better extensibility and some new features, + e.g. notification messages. + endif # if NET # Used by archs to tell that they support BPF JIT compiler plus which flavour.
net/ethtool/Makefile +5 -1
@@ -1,3 +1,7 @@ # SPDX-License-Identifier: GPL-2.0 -obj-y += ioctl.o +obj-y += ioctl.o + +obj-$(CONFIG_ETHTOOL_NETLINK) += ethtool_nl.o + +ethtool_nl-y := netlink.o
net/ethtool/netlink.c new file +34 -0
@@ -0,0 +1,34 @@ +// SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note + +#include <linux/ethtool_netlink.h> +#include "netlink.h" + +/* genetlink setup */ + +static const struct genl_ops ethtool_genl_ops[] = { +}; + +struct genl_family ethtool_genl_family = { + .hdrsize =0 , + .name =ETHTOOL_GENL_NAME , + .version =ETHTOOL_GENL_VERSION , + .netnsok = true, + .parallel_ops = true, + .ops = ethtool_genl_ops, + .n_ops =ARRAY_SIZE (ethtool_genl_ops), +}; + +/* module setup */ + +static int __init ethnl_init (void ) +{ +int ret; + + ret =genl_register_family (ðtool_genl_family); +if (ret <0 ) +panic ("ethtool: could not register genetlink family\n" ); + +return 0 ; +} + +subsys_initcall (ethnl_init);
net/ethtool/netlink.h new file +12 -0
@@ -0,0 +1,12 @@ +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ + +#ifndef _NET_ETHTOOL_NETLINK_H +#define _NET_ETHTOOL_NETLINK_H + +#include <linux/ethtool_netlink.h> +#include <linux/netdevice.h> +#include <net/genetlink.h> + +extern struct genl_family ethtool_genl_family; + +#endif /* _NET_ETHTOOL_NETLINK_H */
Signature · 1 line
2.21.0
Andrew Lunn
maintainerRe: [PATCH net-next v4 05/22] ethtool: introduce ethtool netlink interface
net/ethtool/netlink.c line 29
Quoted 7 lines · Michal Kubecek
net/ethtool/netlink.c new file +7
-0+static int __init ethnl_init (void ) +{ +int ret; + + ret =genl_register_family (ðtool_genl_family); +if (ret <0 ) +panic ("ethtool: could not register genetlink family\n" );
Hi Michal
Panic seems a bit strong. Do we really want to kill the box because this fails?
Andrew
Re: [PATCH net-next v4 05/22] ethtool: introduce ethtool netlink interface
Quoted 11 lines · Andrew Lunn
net/ethtool/netlink.c line 29
Quoted 7 lines · Michal Kubecek
net/ethtool/netlink.c new file +7
-0+static int __init ethnl_init (void ) +{ +int ret; + + ret =genl_register_family (ðtool_genl_family); +if (ret <0 ) +panic ("ethtool: could not register genetlink family\n" );Panic seems a bit strong. Do we really want to kill the box because this fails?
When I switched CONFIG_ETHTOOL_NETLINK from tristate to bool, I checked some other non-modular subsystems to see what they do on failed initialization and each of them did handle it by panic() so I didn't think about it too much and did the same.
Thinking about it now, if the family registration fails, the only entry point to care about should be ethtool_notify() (I'll have to check more carefully to be sure) so that adding a check there should be sufficient to let everything work (except for the netlink interface, of course).
Michal
Andrew Lunn
maintainerRe: [PATCH net-next v4 05/22] ethtool: introduce ethtool netlink interface
Quoted 18 lines · Michal Kubecek
Quoted 11 lines · Andrew Lunn
net/ethtool/netlink.c line 29
Quoted 7 lines · Michal Kubecek
net/ethtool/netlink.c new file +7
-0+static int __init ethnl_init (void ) +{ +int ret; + + ret =genl_register_family (ðtool_genl_family); +if (ret <0 ) +panic ("ethtool: could not register genetlink family\n" );Panic seems a bit strong. Do we really want to kill the box because this fails?
When I switched
CONFIG_ETHTOOL_NETLINKfrom tristate to bool, I checked some other non-modular subsystems to see what they do on failed initialization and each of them did handle it bypanic()so I didn't think about it too much and did the same.
Quoted 4 lines
Thinking about it now, if the family registration fails, the only entry point to care about should be
ethtool_notify()(I'll have to check more carefully to be sure) so that adding a check there should be sufficient to let everything work (except for the netlink interface, of course).
Hi Michal
So maybe do a WARN_ON() and return the error code.
Linus has been quite vocal about killing the box when there is no real need...
Andrew
Re: [PATCH net-next v4 05/22] ethtool: introduce ethtool netlink interface
Quoted 19 lines · Thu, Mar 21, 2019 at 04:25:09PM CET, [email protected] wrote:
Quoted 18 lines · Michal Kubecek
Quoted 11 lines · Andrew Lunn
net/ethtool/netlink.c line 29
Quoted 7 lines · Michal Kubecek
net/ethtool/netlink.c new file +7
-0+static int __init ethnl_init (void ) +{ +int ret; + + ret =genl_register_family (ðtool_genl_family); +if (ret <0 ) +panic ("ethtool: could not register genetlink family\n" );Panic seems a bit strong. Do we really want to kill the box because this fails?
When I switched
CONFIG_ETHTOOL_NETLINKfrom tristate to bool, I checked some other non-modular subsystems to see what they do on failed initialization and each of them did handle it bypanic()so I didn't think about it too much and did the same.
Quoted 8 lines
Quoted 4 lines
Thinking about it now, if the family registration fails, the only entry point to care about should be
ethtool_notify()(I'll have to check more carefully to be sure) so that adding a check there should be sufficient to let everything work (except for the netlink interface, of course).Hi Michal
So maybe do a
WARN_ON()and return the error code.
+1
Quoted 5 lines
Linus has been quite vocal about killing the box when there is no real need...
Andrew
Re: [PATCH net-next v4 05/22] ethtool: introduce ethtool netlink interface
In reply to Andrew LunnQuoted 24 lines · Andrew Lunn
Quoted 18 lines · Michal Kubecek
Quoted 11 lines · Andrew Lunn
net/ethtool/netlink.c line 29
Quoted 7 lines · Michal Kubecek
net/ethtool/netlink.c new file +7
-0+static int __init ethnl_init (void ) +{ +int ret; + + ret =genl_register_family (ðtool_genl_family); +if (ret <0 ) +panic ("ethtool: could not register genetlink family\n" );Panic seems a bit strong. Do we really want to kill the box because this fails?
When I switched
CONFIG_ETHTOOL_NETLINKfrom tristate to bool, I checked some other non-modular subsystems to see what they do on failed initialization and each of them did handle it bypanic()so I didn't think about it too much and did the same.Quoted 4 lines
Thinking about it now, if the family registration fails, the only entry point to care about should be
ethtool_notify()(I'll have to check more carefully to be sure) so that adding a check there should be sufficient to let everything work (except for the netlink interface, of course).
Quoted 6 lines
Hi Michal
So maybe do a
WARN_ON()and return the error code.Linus has been quite vocal about killing the box when there is no real need...
Yes, WARN_ON() seems to be the right thing to do: it says clearly enough something went seriously wrong but doesn't make the system completely unusable. I'll do that in v5.
Michal
PATCH v4 6/22 ethtool: helper functions for netlink interface
In reply to Michal KubecekVarious helpers used by ethtool netlink code.
--- include/uapi/linux/ethtool_netlink.h | 11 ++ net/ethtool/netlink.c | 144 +++++++++++++++++++++++++++ net/ethtool/netlink.h | 144 +++++++++++++++++++++++++++ 3 files changed, 299 insertions(+)
include/uapi/linux/ethtool_netlink.h +11 -0
@@ -18,6 +18,17 @@ enum { ETHNL_CMD_MAX = (__ETHNL_CMD_CNT - 1) }; +/* device specification */ + +enum { +ETHA_DEV_UNSPEC , +ETHA_DEV_INDEX ,/* u32 */ +ETHA_DEV_NAME ,/* string */ + + __ETHA_DEV_CNT, +ETHA_DEV_MAX = (__ETHA_DEV_CNT -1 ) +}; +/* generic netlink info */ #define ETHTOOL_GENL_NAME "ethtool"#define ETHTOOL_GENL_VERSION 1
net/ethtool/netlink.c +144 -0
152 lines not on this page · raw message
net/ethtool/netlink.h +144 -0
151 lines not on this page · raw message
Signature · 1 line
2.21.0
PATCH v4 7/22 ethtool: netlink bitset handling
In reply to Michal KubecekDeclare attribute type constants and add helper functions to generate and parse arbitrary length bit sets.
--- Documentation/networking/ethtool-netlink.txt | 63 ++ include/uapi/linux/ethtool_netlink.h | 32 + net/ethtool/Makefile | 2 +- net/ethtool/bitset.c | 597 +++++++++++++++++++ net/ethtool/bitset.h | 40 ++ net/ethtool/netlink.h | 9 + 6 files changed, 742 insertions(+), 1 deletion(-) create mode 100644 net/ethtool/bitset.c create mode 100644 net/ethtool/bitset.h
Documentation/networking/ethtool-netlink.txt +63 -0
@@ -60,6 +60,69 @@ replies with one message per network device (only those for which the request is supported). +Bit sets +-------- + +For short bitmaps of (reasonably) fixed length, standard NLA_BITFIELD32 type +is used. For arbitrary length bitmaps, ethtool netlink uses a nested attribute +with contents of one of two forms: compact (two binary bitmaps representing +bit values and mask of affected bits) and bit-by-bit (list of bits identified +by either index or name). + +Compact form: nested (bitset) atrribute contents: + + ETHA_BITSET_LIST (flag) no mask, only a list + ETHA_BITSET_SIZE (u32) number of significant bits + ETHA_BITSET_VALUE (binary) bitmap of bit values + ETHA_BITSET_MASK (binary) bitmap of valid bits + +Value and mask must have length at least ETHA_BITSET_SIZE bits rounded up to +a multiple of 32 bits. They consist of 32-bit words in host byte order, words +ordered from least significant to most significant (i.e. the same way as +bitmaps are passed with ioctl interface). + +For compact form, ETHA_BITSET_SIZE and ETHA_BITSET_VALUE are mandatory. +Similar to BITFIELD32, a compact form bit set requests to set bits in the mask +to 1 (if the bit is set in value) or 0 (if not) and preserve the rest. If +ETHA_BITSET_LIST is present, there is no mask and bitset represents a simple +list of bits. + +Kernel bit set length may differ from userspace length if older application is +used on newer kernel or vice versa. If userspace bitmap is longer, an error is +issued only if the request actually tries to set values of some bits not +recognized by kernel. + +Bit-by-bit form: nested (bitset) attribute contents: + + ETHA_BITSET_LIST (flag) no mask, only a list + ETHA_BITSET_SIZE (u32) number of significant bits (optional) + ETHA_BITSET_BITS (nested) array of bits + ETHA_BITSET_BIT + ETHA_BIT_INDEX (u32) bit index (0 for LSB) + ETHA_BIT_NAME (string) bit name + ETHA_BIT_VALUE (flag) present if bit is set + ETHA_BITSET_BIT + ... + +Bit size is optional for bit-by-bit form. ETHA_BITSET_BITS nest can only +contain ETHA_BITS_BIT attributes but there can be an arbitrary number of them. +A bit may be identified by its index or by its name. When used in requests, +listed bits are set to 0 or 1 according to ETHA_BIT_VALUE, the rest is +preserved. A request fails if index exceeds kernel bit length or if name is +not recognized. + +When ETHA_BITSET_LIST flag is present, bitset is interpreted as a simple bit +list. ETHA_BIT_VALUE attributes are not used in such case. Bit list represents +a bitmap with listed bits set and the rest zero. + +In requests, application can use either form. Form used by kernel in reply is +determined by a flag in flags field of request header. Semantics of value and +mask depends on the attribute. General idea is that flags control request +processing, info_mask control which parts of the information are returned in +"get" request and index identifies a particular subcommand or an object to +which the request applies. + + List of message types ---------------------
include/uapi/linux/ethtool_netlink.h +32 -0
@@ -29,6 +29,38 @@ enum { ETHA_DEV_MAX = (__ETHA_DEV_CNT - 1) }; +/* bit sets */ + +enum { +ETHA_BIT_UNSPEC , +ETHA_BIT_INDEX ,/* u32 */ +ETHA_BIT_NAME ,/* string */ +ETHA_BIT_VALUE ,/* flag */ + + __ETHA_BIT_CNT, +ETHA_BIT_MAX = (__ETHA_BIT_CNT -1 ) +}; + +enum { +ETHA_BITS_UNSPEC , +ETHA_BITS_BIT , + + __ETHA_BITS_CNT, +ETHA_BITS_MAX = (__ETHA_BITS_CNT -1 ) +}; + +enum { +ETHA_BITSET_UNSPEC , +ETHA_BITSET_LIST ,/* flag */ +ETHA_BITSET_SIZE ,/* u32 */ +ETHA_BITSET_BITS ,/* nest - ETHA_BITS_* */ +ETHA_BITSET_VALUE ,/* binary */ +ETHA_BITSET_MASK ,/* binary */ + + __ETHA_BITSET_CNT, +ETHA_BITSET_MAX = (__ETHA_BITSET_CNT -1 ) +}; +/* generic netlink info */ #define ETHTOOL_GENL_NAME "ethtool"#define ETHTOOL_GENL_VERSION 1
net/ethtool/Makefile +1 -1
@@ -4,4 +4,4 @@ obj-y += ioctl.o obj-$(CONFIG_ETHTOOL_NETLINK) += ethtool_nl.o -ethtool_nl-y := netlink.o +ethtool_nl-y := netlink.o bitset.o
net/ethtool/bitset.c new file +597 -0
597 lines not on this page · raw message
net/ethtool/bitset.h new file +40 -0
@@ -0,0 +1,40 @@ +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ + +#ifndef _NET_ETHTOOL_BITSET_H +#define _NET_ETHTOOL_BITSET_H + +/* when set, value and mask bitmaps are arrays of u32, when not, arrays of +* unsigned long +*/ +#define ETHNL_BITSET_U32 BIT(0) +/* generate a compact format bitset */ +#define ETHNL_BITSET_COMPACT BIT(1) +/* generate a bit list */ +#define ETHNL_BITSET_LIST BIT(2) +/* when set, names are interpreted as legacy string set (an array of +* char[ETH_GSTRING_LEN]), when not, as a simple array of char * +*/ +#define ETHNL_BITSET_LEGACY_NAMES BIT(3) + +int ethnl_bitset_is_compact (const struct nlattr *bitset,bool *compact); +int ethnl_bitset_size (unsigned int size,const unsigned long *val, +const unsigned long *mask,const void *names, +unsigned int flags); +int ethnl_bitset32_size (unsigned int size,const u32 *val,const u32 *mask, +const void *names,unsigned int flags); +int ethnl_put_bitset (struct sk_buff *skb,int attrtype,unsigned int size, +const unsigned long *val,const unsigned long *mask, +const void *names,unsigned int flags); +int ethnl_put_bitset32 (struct sk_buff *skb,int attrtype,unsigned int size, +const u32 *val,const u32 *mask,const void *names, +unsigned int flags); +bool ethnl_update_bitset (unsigned long *bitmap,unsigned long *bitmask, +unsigned int nbits,const struct nlattr *attr, +int *err,const void *names,bool legacy, +struct genl_info *info); +bool ethnl_update_bitset32 (u32 *bitmap,u32 *bitmask,unsigned int nbits, +const struct nlattr *attr,int *err, +const void *names,bool legacy, +struct genl_info *info); + +#endif /* _NET_ETHTOOL_BITSET_H */
net/ethtool/netlink.h +9 -0
@@ -20,6 +20,15 @@ struct sk_buff *ethnl_reply_init(size_t payload, struct net_device *dev, u8 cmd, u16 dev_attrtype, struct genl_info *info, void **ehdrp); +#if BITS_PER_LONG ==64 && defined(__BIG_ENDIAN) +void ethnl_bitmap_to_u32 (unsigned long *bitmap,unsigned int nwords); +#else +static inline void ethnl_bitmap_to_u32 (unsigned long *bitmap, +unsigned int nwords) +{ +} +#endif +static inline int ethnl_str_size (const char *s) {return nla_total_size (strlen (s) +1 );
Signature · 1 line
2.21.0
PATCH v4 8/22 ethtool: support for netlink notifications
In reply to Michal KubecekAdd infrastructure for ethtool netlink notifications. There is only one multicast group "monitor" which is used to notify userspace about changes. Notifications are supposed to be broadcasted on every configuration change, whether it is done using the netlink interface or legacy ioctl one.
To trigger an ethtool notification, both ethtool netlink and external code use ethtool_notify() helper. This helper requires RTNL to be held and may sleep.
--- include/linux/ethtool_netlink.h | 5 +++++ include/linux/netdevice.h | 12 +++++++++++ include/uapi/linux/ethtool_netlink.h | 2 ++ net/ethtool/netlink.c | 32 ++++++++++++++++++++++++++++ net/ethtool/netlink.h | 2 ++ 5 files changed, 53 insertions(+)
include/linux/ethtool_netlink.h +5 -0
@@ -5,5 +5,10 @@#include <uapi/linux/ethtool_netlink.h> #include <linux/ethtool.h> +#include <linux/netdevice.h> + +enum ethtool_multicast_groups { +ETHNL_MCGRP_MONITOR , +};#endif /* _LINUX_ETHTOOL_NETLINK_H_ */
include/linux/netdevice.h +12 -0
@@ -4353,6 +4353,18 @@ struct netdev_notifier_bonding_info {void netdev_bonding_info_change (struct net_device *dev,struct netdev_bonding_info *bonding_info); +#if IS_ENABLED (CONFIG_ETHTOOL_NETLINK ) +void ethtool_notify (struct net_device *dev,struct netlink_ext_ack *extack, +unsigned int cmd,u32 req_mask,const void *data); +#else +static inline void ethtool_notify (struct net_device *dev, +struct netlink_ext_ack *extack, +unsigned int cmd,u32 req_mask, +const void *data) +{ +} +#endif +static inline struct sk_buff *skb_gso_segment (struct sk_buff *skb,netdev_features_t features) {
include/uapi/linux/ethtool_netlink.h +2 -0
@@ -65,4 +65,6 @@ enum {#define ETHTOOL_GENL_NAME "ethtool"#define ETHTOOL_GENL_VERSION 1 +#define ETHTOOL_MCGRP_MONITOR_NAME "monitor" +#endif /* _UAPI_LINUX_ETHTOOL_NETLINK_H_ */
net/ethtool/netlink.c +32 -0
@@ -4,6 +4,8 @@#include <linux/ethtool_netlink.h> #include "netlink.h" +u32 ethnl_bcast_seq; +static const struct nla_policy dev_policy[ETHA_DEV_MAX +1 ] = { [ETHA_DEV_UNSPEC ] = { .type =NLA_REJECT }, [ETHA_DEV_INDEX ] = { .type =NLA_U32 },
@@ -147,11 +149,39 @@ struct sk_buff *ethnl_reply_init(size_t payload, struct net_device *dev, u8 cmd,return NULL ; } +/* notifications */ + +typedef void (*ethnl_notify_handler_t )(struct net_device *dev, +struct netlink_ext_ack *extack, +unsigned int cmd,u32 req_mask, +const void *data); + +ethnl_notify_handler_t ethnl_notify_handlers[] = { +}; + +void ethtool_notify (struct net_device *dev,struct netlink_ext_ack *extack, +unsigned int cmd,u32 req_mask,const void *data) +{ +ASSERT_RTNL (); + +if (likely (cmd <ARRAY_SIZE (ethnl_notify_handlers) && + ethnl_notify_handlers[cmd])) + ethnl_notify_handlers[cmd](dev, extack, cmd, req_mask, data); +else +WARN_ONCE (1 ,"notification %u not implemented (dev=%s, req_mask=0x%x)\n" , + cmd,netdev_name (dev), req_mask); +} +EXPORT_SYMBOL (ethtool_notify); +/* genetlink setup */ static const struct genl_ops ethtool_genl_ops[] = { }; +static const struct genl_multicast_group ethtool_nl_mcgrps[] = { + [ETHNL_MCGRP_MONITOR ] = { .name =ETHTOOL_MCGRP_MONITOR_NAME }, +}; +struct genl_family ethtool_genl_family = { .hdrsize =0 , .name =ETHTOOL_GENL_NAME ,
@@ -160,6 +190,8 @@ struct genl_family ethtool_genl_family = { .parallel_ops = true, .ops = ethtool_genl_ops, .n_ops = ARRAY_SIZE(ethtool_genl_ops), + .mcgrps = ethtool_nl_mcgrps, + .n_mcgrps = ARRAY_SIZE(ethtool_nl_mcgrps), };/* module setup */
net/ethtool/netlink.h +2 -0
@@ -11,6 +11,8 @@#define ETHNL_SET_ERRMSG (info, msg) \ do { if (info) GENL_SET_ERR_MSG(info, msg); } while (0) +extern u32 ethnl_bcast_seq; +extern struct genl_family ethtool_genl_family;struct net_device *ethnl_dev_get (struct genl_info *info,struct nlattr *nest);
Signature · 1 line
2.21.0
PATCH v4 9/22 ethtool: implement EVENT notifications
In reply to Michal KubecekThree types of netlink notifications are introduced:
- ETHA_EVENT_NEWDEV to notify about newly registered network devices
- ETHA_EVENT_DELDEV to notify about unregistered network devices
- ETHA_EVENT_RENAMEDEV to notify about renamed network device
The notifications are triggered by NETDEV_REGISTER, NETDEV_UNREGISTER and NETDEV_CHANGENAME notifiers.
These notifications are intended for applications and daemons monitoring ethtool events to allow updating the list of existing devices without having to open another socket for rtnetlink.
--- Documentation/networking/ethtool-netlink.txt | 27 ++++++++ include/uapi/linux/ethtool_netlink.h | 37 +++++++++++ net/ethtool/netlink.c | 65 ++++++++++++++++++++ 3 files changed, 129 insertions(+)
Documentation/networking/ethtool-netlink.txt +27 -0
@@ -126,6 +126,8 @@ which the request applies. List of message types --------------------- + ETHNL_CMD_EVENT notification only + All constants use ETHNL_CMD_ prefix, usually followed by "GET", "SET" or "ACT" to indicate the type.
@@ -137,9 +139,34 @@ messages marked as "response only" in the table above. "Get" messages with NLM_F_DUMP flags and no device identification dump the information for all devices supporting the request. +Type ETHNL_CMD_EVENT is special, these messages are never used in userspace +requests or kernel replies. They are only sent by kernel to sockets listening +to "monitor" multicast group to inform userspace about certain events. + Later sections describe the format and semantics of these request messages. +EVENT +----- + +EVENT messages are only used in kernel multicast notifications. Atributes +correspond to specific event types, the same type can appear multiple times. + + ETHA_EVENT_NEWDEV (nested) new device was registered + ETHA_NEWDEV_DEV (nested) new device + ETHA_EVENT_DELDEV (nested) device was unregistered + ETHA_DELDEV_DEV (nested) removed device + ETHA_EVENT_RENAMEDEV (nested) device was renamed + ETHA_RENAMEDEV_DEV (nested) renamed device + +For ETHA_EVENT_RENAMEDEV, the name ETHA_RENAME_DEV/ETHA_DEV_NAME is the new +name after the rename. + +Userspace application must expect multiple events to be present in one message +and also multiple events of the same type (e.g. two or more newly registered +devices). + + Request translation -------------------
include/uapi/linux/ethtool_netlink.h +37 -0
@@ -13,6 +13,7 @@enum {ETHNL_CMD_NOOP , +ETHNL_CMD_EVENT ,/* only for notifications */ __ETHNL_CMD_CNT,ETHNL_CMD_MAX = (__ETHNL_CMD_CNT -1 )
@@ -61,6 +62,42 @@ enum { ETHA_BITSET_MAX = (__ETHA_BITSET_CNT - 1) }; +/* events */ + +enum { +ETHA_NEWDEV_UNSPEC , +ETHA_NEWDEV_DEV ,/* nest - ETHA_DEV_* */ + + __ETHA_NEWDEV_CNT, +ETHA_NEWDEV_MAX = (__ETHA_NEWDEV_CNT -1 ) +}; + +enum { +ETHA_DELDEV_UNSPEC , +ETHA_DELDEV_DEV ,/* nest - ETHA_DEV_* */ + + __ETHA_DELDEV_CNT, +ETHA_DELDEV_MAX = (__ETHA_DELDEV_CNT -1 ) +}; + +enum { +ETHA_RENAMEDEV_UNSPEC , +ETHA_RENAMEDEV_DEV ,/* nest - ETHA_DEV_* */ + + __ETHA_RENAMEDEV_CNT, +ETHA_RENAMEDEV_MAX = (__ETHA_RENAMEDEV_CNT -1 ) +}; + +enum { +ETHA_EVENT_UNSPEC , +ETHA_EVENT_NEWDEV ,/* nest - ETHA_NEWDEV_* */ +ETHA_EVENT_DELDEV ,/* nest - ETHA_DELDEV_* */ +ETHA_EVENT_RENAMEDEV ,/* nest - ETHA_RENAMEDEV_* */ + + __ETHA_EVENT_CNT, +ETHA_EVENT_MAX = (__ETHA_EVENT_CNT -1 ) +}; +/* generic netlink info */ #define ETHTOOL_GENL_NAME "ethtool"#define ETHTOOL_GENL_VERSION 1
net/ethtool/netlink.c +65 -0
77 lines not on this page · raw message
Signature · 1 line
2.21.0
PATCH v4 10/22 ethtool: generic handlers for GET requests
In reply to Michal KubecekSome parts of processing GET type requests and related notifications are independent of a command. Provide universal functions so that only four callbacks need to be defined for each command type:
parse_request() - parse incoming message
prepare_data() - retrieve data from driver or NIC reply_size() - estimate reply message size fill_reply() - compose reply message
These callback are defined in an instance of struct get_request_ops.
--- net/ethtool/netlink.c | 319 ++++++++++++++++++++++++++++++++++++++++++ net/ethtool/netlink.h | 111 +++++++++++++++ 2 files changed, 430 insertions(+)
net/ethtool/netlink.c +319 -0
@@ -149,6 +149,325 @@ struct sk_buff *ethnl_reply_init(size_t payload, struct net_device *dev, u8 cmd,return NULL ; } +/* GET request helpers */ + +const struct get_request_ops *get_requests[__ETHNL_CMD_CNT] = { +}; + +/** +* ethnl_alloc_get_data() - Allocate and initialize data for a GET request +* @ops: instance of struct get_request_ops describing size and layout +* +* This initializes only the first part (req_info), second part (reply_data) +* is initialized before filling the reply data into it (which is done for +* each iteration in dump requests). +* +* Return: pointer to allocated and initialized data, NULL on error +*/ +static struct common_req_info * +ethnl_alloc_get_data (const struct get_request_ops *ops) +{ +struct common_req_info *req_info; + + req_info =kmalloc (ops->data_size,GFP_KERNEL ); +if (!req_info) +return NULL ; + +memset (req_info,'\0' , ops->repdata_offset); + req_info->reply_data = + (struct common_reply_data *)((char *)req_info + + ops->repdata_offset); + +return req_info; +} + +/** +* ethnl_free_get_data() - free GET request data +* @ops: instance of struct get_request_ops describing the layout +* @req_info: pointer to embedded struct common_req_info (at offset 0) +* +* Calls ->cleanup() handler if defined and frees the data block. +*/ +static void ethnl_free_get_data (const struct get_request_ops *ops, +struct common_req_info *req_info) +{ +if (ops->cleanup) + ops->cleanup (req_info); +kfree (req_info); +} + +/** +* ethnl_init_reply_data() - Initialize reply data for GET request +* @req_info: pointer to embedded struct common_req_info +* @ops: instance of struct get_request_ops describing the layout +* @dev: network device to initialize the reply for +* +* Fills the reply data part with zeros and sets the dev member. Must be called +* before calling the ->fill_reply() callback (for each iteration when handling +* dump requests). +*/ +static void ethnl_init_reply_data (const struct common_req_info *req_info, +const struct get_request_ops *ops, +struct net_device *dev) +{ +memset (req_info->reply_data,'\0' , + ops->data_size - ops->repdata_offset); + req_info->reply_data->dev = dev; +} + +/* generic ->doit() handler for GET type requests */ +int ethnl_get_doit (struct sk_buff *skb,struct genl_info *info) +{ +const u8 cmd = info->genlhdr->cmd; +struct common_req_info *req_info; +const struct get_request_ops *ops; +struct sk_buff *rskb; +void *reply_payload; +int reply_len; +int ret; + + ops = get_requests[cmd]; +if (WARN_ONCE (!ops,"cmd %u has no get_request_ops\n" , cmd)) +return -EOPNOTSUPP ; + req_info =ethnl_alloc_get_data (ops); +if (!req_info) +return -ENOMEM ; + ret = ops->parse_request (req_info, skb, info, info->nlhdr); +if (!ops->allow_nodev_do && !req_info->dev) { +ETHNL_SET_ERRMSG (info,"device not specified in do request" ); + ret = -EINVAL ; + } +if (ret <0 ) + goto err_dev; +ethnl_init_reply_data (req_info, ops, req_info->dev); + +rtnl_lock (); + ret = ops->prepare_data (req_info, info); +if (ret <0 ) + goto err_rtnl; + reply_len = ops->reply_size (req_info); +if (ret <0 ) + goto err_rtnl; + ret = -ENOMEM ; + rskb =ethnl_reply_init (reply_len, req_info->dev, ops->reply_cmd, + ops->dev_attrtype, info, &reply_payload); +if (!rskb) + goto err_rtnl; + ret = ops->fill_reply (rskb, req_info); +if (ret <0 ) + goto err; +rtnl_unlock (); + +genlmsg_end (rskb, reply_payload); +if (req_info->dev) +dev_put (req_info->dev); +ethnl_free_get_data (ops, req_info); +return genlmsg_reply (rskb, info); + +err: +WARN_ONCE (ret == -EMSGSIZE , +"calculated message payload length (%d) not sufficient\n" , + reply_len); +nlmsg_free (rskb); +ethnl_free_get_data (ops, req_info); +err_rtnl: +rtnl_unlock (); +err_dev: +if (req_info->dev) +dev_put (req_info->dev); +return ret; +} + +static int ethnl_get_dump_one (struct sk_buff *skb, +struct net_device *dev, +const struct get_request_ops *ops, +struct common_req_info *req_info) +{ +int ret; + +ethnl_init_reply_data (req_info, ops, dev); +rtnl_lock (); + ret = ops->prepare_data (req_info,NULL ); +if (ret <0 ) +return ret; + ret =ethnl_fill_dev (skb, dev, ops->dev_attrtype); +if (ret <0 ) +return ret; + ret = ops->fill_reply (skb, req_info); +rtnl_unlock (); + + req_info->reply_data->dev =NULL ; +return ret; +} + +/* generic ->dumpit() handler for GET requests; device iteration copied from +* rtnl_dump_ifinfo() +* cb->args[0]: pointer to struct get_request_ops +* cb->args[1]: pointer to request data +* cb->args[2]: iteration position - hashbucket +* cb->args[3]: iteration position - ifindex +*/ +int ethnl_get_dumpit (struct sk_buff *skb,struct netlink_callback *cb) +{ +struct net *net =sock_net (skb->sk); +struct common_req_info *req_info; +const struct get_request_ops *ops; +int h, s_h, idx =0 , s_idx; +struct hlist_head *head; +struct net_device *dev; +int ret =0 ; +void *ehdr; + + ops = (const struct get_request_ops *)cb->args[0 ]; + req_info = (struct common_req_info *)cb->args[1 ]; + s_h = cb->args[2 ]; + s_idx = cb->args[3 ]; + +for (h = s_h; h <NETDEV_HASHENTRIES ; h++, s_idx =0 ) { + idx =0 ; + head = &net->dev_index_head[h]; +hlist_for_each_entry (dev, head, index_hlist) { +if (idx < s_idx) + goto cont; + ehdr =genlmsg_put (skb,NETLINK_CB (cb->skb).portid, + cb->nlh->nlmsg_seq, + ðtool_genl_family,0 , + ops->reply_cmd); + ret =ethnl_get_dump_one (skb, dev, ops, req_info); +if (ret <0 ) { +genlmsg_cancel (skb, ehdr); +if (ret == -EOPNOTSUPP ) + goto cont; +if (likely (skb->len)) + goto out; + goto out_err; + } +genlmsg_end (skb, ehdr); +cont: + idx++; + } + } +out: + ret = skb->len; +out_err: + cb->args[2 ] = h; + cb->args[3 ] = idx; + cb->seq = net->dev_base_seq; +nl_dump_check_consistent (cb,nlmsg_hdr (skb)); + +return ret; +} + +/* generic ->start() handler for GET requests */ +static int ethnl_get_start (struct netlink_callback *cb) +{ +struct common_req_info *req_info; +const struct get_request_ops *ops; +struct genlmsghdr *ghdr; +int ret; + + ghdr =nlmsg_data (cb->nlh); + ops = get_requests[ghdr->cmd]; +if (WARN_ONCE (!ops,"cmd %u has no get_request_ops\n" , ghdr->cmd)) +return -EOPNOTSUPP ; + req_info =ethnl_alloc_get_data (ops); +if (!req_info) +return -ENOMEM ; + + ret = ops->parse_request (req_info, cb->skb,NULL , cb->nlh); +if (req_info->dev) { +/* We ignore device specification in dump requests but as the +* same parser as for non-dump (doit) requests is used, it +* would take reference to the device if it finds one +*/ +dev_put (req_info->dev); + req_info->dev =NULL ; + } +if (ret <0 ) +return ret; + + cb->args[0 ] = (long )ops; + cb->args[1 ] = (long )req_info; + cb->args[2 ] =0 ; + cb->args[3 ] =0 ; + +return 0 ; +} + +/* generic ->done() handler for GET requests */ +static int ethnl_get_done (struct netlink_callback *cb) +{ +ethnl_free_get_data ((const struct get_request_ops *)cb->args[0 ], + (struct common_req_info *)cb->args[1 ]); + +return 0 ; +} + +/* generic notification handler */ +static void ethnl_std_notify (struct net_device *dev, +struct netlink_ext_ack *extack,unsigned int cmd, +u32 req_mask,const void *data) +{ +struct common_req_info *req_info; +const struct get_request_ops *ops; +struct sk_buff *skb; +void *reply_payload; +int reply_len; +int ret; + + ops = get_requests[cmd -1 ]; +if (WARN_ONCE (!ops,"cmd %u has no get_request_ops\n" , cmd -1 )) +return ; +/* when ethnl_std_notify() is used as notify handler, command id of +* corresponding GET request must be one less than cmd argument passed +* to ethnl_std_notify() +*/ +if (WARN_ONCE (ops->reply_cmd != cmd, +"reply_cmd for %u is %u, expected %u\n" , cmd -1 , + ops->reply_cmd, cmd)) +return ; + + req_info =ethnl_alloc_get_data (ops); +if (!req_info) +return ; + req_info->dev = dev; + req_info->req_mask = req_mask; + req_info->compact = true; + +ethnl_init_reply_data (req_info, ops, dev); + ret = ops->prepare_data (req_info,NULL ); +if (ret <0 ) + goto err_data; + reply_len = ops->reply_size (req_info); +if (reply_len <0 ) + goto err_data; + skb =genlmsg_new (reply_len,GFP_KERNEL ); +if (!skb) + goto err_data; + reply_payload =genlmsg_put (skb,0 , ++ethnl_bcast_seq, + ðtool_genl_family,0 , ops->reply_cmd); +if (!reply_payload) + goto err_skb; + + ret =ethnl_fill_dev (skb, dev, ops->dev_attrtype); +if (ret <0 ) + goto err_skb; + ret = ops->fill_reply (skb, req_info); +if (ret <0 ) + goto err_skb; +ethnl_free_get_data (ops, req_info); +genlmsg_end (skb, reply_payload); + +genlmsg_multicast (ðtool_genl_family, skb,0 ,ETHNL_MCGRP_MONITOR , +GFP_KERNEL ); +return ; + +err_skb: +nlmsg_free (skb); +err_data: +ethnl_free_get_data (ops, req_info); +} +/* notifications */ typedef void (*ethnl_notify_handler_t)(struct net_device *dev,
net/ethtool/netlink.h +111 -0
115 lines not on this page · raw message
Signature · 1 line
2.21.0
PATCH v4 11/22 ethtool: move string arrays into common file
In reply to Michal KubecekIntroduce file net/ethtool/common.c for code shared by ioctl and netlink ethtool interface. Move name tables of features, RSS hash functions, tunables and PHY tunables into this file.
--- net/ethtool/Makefile | 2 +- net/ethtool/common.c | 83 ++++++++++++++++++++++++++++++++++++++++++++ net/ethtool/common.h | 17 +++++++++ net/ethtool/ioctl.c | 82 ++----------------------------------------- 4 files changed, 103 insertions(+), 81 deletions(-) create mode 100644 net/ethtool/common.c create mode 100644 net/ethtool/common.h
net/ethtool/Makefile +1 -1
@@ -1,6 +1,6 @@ # SPDX-License-Identifier: GPL-2.0 -obj-y += ioctl.o +obj-y += ioctl.o common.o obj-$(CONFIG_ETHTOOL_NETLINK) += ethtool_nl.o
net/ethtool/common.c new file +83 -0
83 lines not on this page · raw message
net/ethtool/common.h new file +17 -0
@@ -0,0 +1,17 @@ +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ + +#ifndef _ETHTOOL_COMMON_H +#define _ETHTOOL_COMMON_H + +#include <linux/ethtool.h> + +extern const char +netdev_features_strings[NETDEV_FEATURE_COUNT ][ETH_GSTRING_LEN ]; +extern const char +rss_hash_func_strings[ETH_RSS_HASH_FUNCS_COUNT ][ETH_GSTRING_LEN ]; +extern const char +tunable_strings[__ETHTOOL_TUNABLE_COUNT][ETH_GSTRING_LEN ]; +extern const char +phy_tunable_strings[__ETHTOOL_PHY_TUNABLE_COUNT][ETH_GSTRING_LEN ]; + +#endif /* _ETHTOOL_COMMON_H */
net/ethtool/ioctl.c +2 -80
94 lines not on this page · raw message
Signature · 1 line
2.21.0
PATCH v4 12/22 ethtool: provide string sets with GET_STRSET request
In reply to Michal KubecekRequests 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. 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
It's possible to request all string sets of given type or only specific sets. With ETHA_STRSET_COUNTS flag, only set sizes (number of strings) are returned.
--- Documentation/networking/ethtool-netlink.txt | 46 +- include/uapi/linux/ethtool.h | 2 + include/uapi/linux/ethtool_netlink.h | 43 ++ net/ethtool/Makefile | 2 +- net/ethtool/netlink.c | 8 + net/ethtool/netlink.h | 4 + net/ethtool/strset.c | 447 +++++++++++++++++++ 7 files changed, 549 insertions(+), 3 deletions(-) create mode 100644 net/ethtool/strset.c
Documentation/networking/ethtool-netlink.txt +44 -2
@@ -127,6 +127,8 @@ List of message types --------------------- ETHNL_CMD_EVENT notification only + ETHNL_CMD_GET_STRSET + ETHNL_CMD_SET_STRSET response only All constants use ETHNL_CMD_ prefix, usually followed by "GET", "SET" or "ACT" to indicate the type.
@@ -167,6 +169,46 @@ and also multiple events of the same type (e.g. two or more newly registered devices). +GET_STRSET +---------- + +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 SET_STRSET 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: + + ETHA_STRSET_DEV (nested) device identification + ETHA_STRSET_COUNTS (flag) request only string counts + ETHA_STRSET_STRINGSET (nested) string set to request + ETHA_STRINGSET_ID (u32) set id + +Kernel response contents: + + ETHA_STRSET_DEV (nested) device identification + ETHA_STRSET_STRINGSET (nested) string set to request + ETHA_STRINGSET_ID (u32) set id + ETHA_STRINGSET_COUNT (u32) number of strings + ETHA_STRINGSET_STRINGS (nested) array of strings + ETHA_STRING_INDEX (u32) string index + ETHA_STRING_VALUE (string) string value + +ETHA_STRSET_DEV, if present, identifies the device to request device specific +string sets for. Depending on its presence a and NLM_F_DUMP flag, there are +three type of GET_STRSET 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 ETHA_STRSET_STRINGSET attribute, all string sets of requested +type are returned, otherwise only those specified in the request. Flag +ETHA_STRSET_COUNTS tells kernel to only return string counts of the sets, not +the actual strings. + + Request translation -------------------
@@ -201,7 +243,7 @@ ETHTOOL_STXCSUM n/a ETHTOOL_GSG n/a ETHTOOL_SSG n/a ETHTOOL_TEST n/a -ETHTOOL_GSTRINGS n/a +ETHTOOL_GSTRINGS ETHNL_CMD_GET_STRSET ETHTOOL_PHYS_ID n/a ETHTOOL_GSTATS n/a ETHTOOL_GTSO n/a
@@ -229,7 +271,7 @@ ETHTOOL_FLASHDEV n/a ETHTOOL_RESET n/a ETHTOOL_SRXNTUPLE n/a ETHTOOL_GRXNTUPLE n/a -ETHTOOL_GSSET_INFO n/a +ETHTOOL_GSSET_INFO ETHNL_CMD_GET_STRSET ETHTOOL_GRXFHINDIR n/a ETHTOOL_SRXFHINDIR n/a ETHTOOL_GFEATURES n/a
include/uapi/linux/ethtool.h +2 -0
@@ -574,6 +574,8 @@ enum ethtool_stringset {ETH_SS_TUNABLES ,ETH_SS_PHY_STATS ,ETH_SS_PHY_TUNABLES , + + ETH_SS_COUNT };/**
include/uapi/linux/ethtool_netlink.h +43 -0
55 lines not on this page · raw message
net/ethtool/Makefile +1 -1
@@ -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
@@ -152,6 +152,7 @@ struct sk_buff *ethnl_reply_init(size_t payload, struct net_device *dev, u8 cmd,/* GET request helpers */ const struct get_request_ops *get_requests[__ETHNL_CMD_CNT] = { + [ETHNL_CMD_GET_STRSET ] = &strset_request_ops, };/**
@@ -556,6 +557,13 @@ static struct notifier_block ethnl_netdev_notifier = {/* genetlink setup */ static const struct genl_ops ethtool_genl_ops[] = { + { + .cmd =ETHNL_CMD_GET_STRSET , + .doit = ethnl_get_doit, + .start = ethnl_get_start, + .dumpit = ethnl_get_dumpit, + .done = ethnl_get_done, + }, };static const struct genl_multicast_group ethtool_nl_mcgrps[] = {
net/ethtool/netlink.h +4 -0
@@ -275,4 +275,8 @@ struct get_request_ops { void (*cleanup)(struct common_req_info *req_info); }; +/* request handlers */ + +extern const struct get_request_ops strset_request_ops; +#endif /* _NET_ETHTOOL_NETLINK_H */
net/ethtool/strset.c new file +447 -0
447 lines not on this page · raw message
Signature · 1 line
2.21.0
PATCH v4 13/22 ethtool: provide driver/device information in GET_INFO request
In reply to Michal KubecekImplement GET_INFO request to get basic driver and device information as provided by ETHTOOL_GDRVINFO ioct command. The information is read only so that the corresponding SET_INFO message is only used in kernel replies.
Move most of ethtool_get_drvinfo() int common.c so that the code can be shared by both ioctl and netlink interface.
--- Documentation/networking/ethtool-netlink.txt | 43 ++++- include/uapi/linux/ethtool_netlink.h | 30 ++++ net/ethtool/Makefile | 2 +- net/ethtool/common.c | 52 ++++++ net/ethtool/common.h | 2 + net/ethtool/info.c | 158 +++++++++++++++++++ net/ethtool/ioctl.c | 50 +----- net/ethtool/netlink.c | 8 + net/ethtool/netlink.h | 1 + 9 files changed, 299 insertions(+), 47 deletions(-) create mode 100644 net/ethtool/info.c
Documentation/networking/ethtool-netlink.txt +42 -1
@@ -129,6 +129,8 @@ List of message types ETHNL_CMD_EVENT notification only ETHNL_CMD_GET_STRSET ETHNL_CMD_SET_STRSET response only + ETHNL_CMD_GET_INFO + ETHNL_CMD_SET_INFO response only All constants use ETHNL_CMD_ prefix, usually followed by "GET", "SET" or "ACT" to indicate the type.
@@ -209,6 +211,45 @@ ETHA_STRSET_COUNTS tells kernel to only return string counts of the sets, not the actual strings. +GET_INFO +-------- + +GET_INFO requests information provided by ioctl commands ETHTOOL_GDRVINFO, +ETHTOOL_GPERMADDR and ETHTOOL_GET_TS_INFO to provide basic device information. +Common pattern is that all information is read only so that SET_INFO message +exists but is only used by kernel for replies to GET_INFO requests. There is +also no corresponding notification. + +Request contents: + + ETHA_INFO_DEV (nested) device identification + ETHA_INFO_INFOMASK (u32) info mask + ETHA_INFO_COMPACT (flag) request compact bitsets + +Info mask bits meaning: + + ETH_INFO_IM_DRVINFO driver info (GDRVINFO) + ETH_INFO_IM_PERMADDR permanent HW address (GPERMADDR) + ETH_INFO_IM_TSINFO timestamping info (GET_TS_INFO) + +Kernel response contents: + + ETHA_INFO_DEV (nested) device identification + ETHA_INFO_DRVINFO (nested) driver information + ETHA_DRVINFO_DRIVER (string) driver name + ETHA_DRVINFO_FWVERSION (string) firmware version + ETHA_DRVINFO_BUSINFO (string) device bus address + ETHA_DRVINFO_EROM_VER (string) expansion ROM version + +The meaning of DRVINFO attributes follows the corresponding fields of +ETHTOOL_GDRVINFO response. Second part with various counts and sizes is +omitted as these are not really needed (and if they are, they can be easily +found by different means). Driver version is also omitted as it is rather +misleading in most cases. + +GET_INFO requests allow dumps. + + Request translation -------------------
@@ -220,7 +261,7 @@ ioctl command netlink command --------------------------------------------------------------------- ETHTOOL_GSET n/a ETHTOOL_SSET n/a -ETHTOOL_GDRVINFO n/a +ETHTOOL_GDRVINFO ETHNL_CMD_GET_INFO ETHTOOL_GREGS n/a ETHTOOL_GWOL n/a ETHTOOL_SWOL n/a
include/uapi/linux/ethtool_netlink.h +30 -0
@@ -16,6 +16,8 @@ enum {ETHNL_CMD_EVENT ,/* only for notifications */ ETHNL_CMD_GET_STRSET ,ETHNL_CMD_SET_STRSET ,/* only for reply */ +ETHNL_CMD_GET_INFO , +ETHNL_CMD_SET_INFO ,/* only for reply */ __ETHNL_CMD_CNT,ETHNL_CMD_MAX = (__ETHNL_CMD_CNT -1 )
@@ -141,6 +143,34 @@ enum { ETHA_STRSET_MAX = (__ETHA_STRSET_CNT - 1) }; +/* GET_INFO / SET_INFO */ + +enum { +ETHA_INFO_UNSPEC , +ETHA_INFO_DEV ,/* nest - ETHA_DEV_* */ +ETHA_INFO_INFOMASK ,/* u32 */ +ETHA_INFO_COMPACT ,/* flag */ +ETHA_INFO_DRVINFO ,/* nest - ETHA_DRVINFO_* */ + + __ETHA_INFO_CNT, +ETHA_INFO_MAX = (__ETHA_INFO_CNT -1 ) +}; + +#define ETH_INFO_IM_DRVINFO (1U << 0) + +#define ETH_INFO_IM_ALL (ETH_INFO_IM_DRVINFO) + +enum { +ETHA_DRVINFO_UNSPEC , +ETHA_DRVINFO_DRIVER ,/* string */ +ETHA_DRVINFO_FWVERSION ,/* string */ +ETHA_DRVINFO_BUSINFO ,/* string */ +ETHA_DRVINFO_EROM_VER ,/* string */ + + __ETHA_DRVINFO_CNT, +ETHA_DRVINFO_MAX = (__ETHA_DRVINFO_CNT -1 ) +}; +/* generic netlink info */ #define ETHTOOL_GENL_NAME "ethtool"#define ETHTOOL_GENL_VERSION 1
net/ethtool/Makefile +1 -1
@@ -4,4 +4,4 @@ obj-y += ioctl.o common.o obj-$(CONFIG_ETHTOOL_NETLINK) += ethtool_nl.o -ethtool_nl-y := netlink.o bitset.o strset.o +ethtool_nl-y := netlink.o bitset.o strset.o info.o
net/ethtool/common.c +52 -0
60 lines not on this page · raw message
net/ethtool/common.h +2 -0
@@ -3,6 +3,7 @@#ifndef _ETHTOOL_COMMON_H#define _ETHTOOL_COMMON_H +#include <linux/netdevice.h> #include <linux/ethtool.h> extern const char
@@ -14,4 +15,5 @@ tunable_strings[__ETHTOOL_TUNABLE_COUNT][ETH_GSTRING_LEN];extern const char phy_tunable_strings[__ETHTOOL_PHY_TUNABLE_COUNT][ETH_GSTRING_LEN ]; +int __ethtool_get_drvinfo (struct net_device *dev,struct ethtool_drvinfo *info);#endif /* _ETHTOOL_COMMON_H */
net/ethtool/info.c new file +158 -0
158 lines not on this page · raw message
net/ethtool/ioctl.c +5 -45
59 lines not on this page · raw message
net/ethtool/netlink.c +8 -0
@@ -153,6 +153,7 @@ struct sk_buff *ethnl_reply_init(size_t payload, struct net_device *dev, u8 cmd,const struct get_request_ops *get_requests[__ETHNL_CMD_CNT] = { [ETHNL_CMD_GET_STRSET ] = &strset_request_ops, + [ETHNL_CMD_GET_INFO ] = &info_request_ops, };/**
@@ -564,6 +565,13 @@ static const struct genl_ops ethtool_genl_ops[] = { .dumpit = ethnl_get_dumpit, .done = ethnl_get_done, }, + { + .cmd = ETHNL_CMD_GET_INFO, + .doit = ethnl_get_doit, + .start = ethnl_get_start, + .dumpit = ethnl_get_dumpit, + .done = ethnl_get_done, + }, };static const struct genl_multicast_group ethtool_nl_mcgrps[] = {
net/ethtool/netlink.h +1 -0
@@ -278,5 +278,6 @@ struct get_request_ops {/* request handlers */ extern const struct get_request_ops strset_request_ops; +extern const struct get_request_ops info_request_ops;#endif /* _NET_ETHTOOL_NETLINK_H */
Signature · 1 line
2.21.0
PATCH v4 14/22 ethtool: provide timestamping information in GET_INFO request
In reply to Michal KubecekAdd timestamping information as provided by ETHTOOL_GET_TS_INFO ioctl command in GET_INFO reply if ETH_INFO_IM_TSINFO flag is set in the request.
Add constants for counts of HWTSTAMP_TX_* and HWTSTAM_FILTER_* constants and provide symbolic names for timestamping related values so that they can be retrieved in GET_STRSET and GET_INFO requests.
--- Documentation/networking/ethtool-netlink.txt | 10 +- include/uapi/linux/ethtool.h | 6 + include/uapi/linux/ethtool_netlink.h | 16 ++- include/uapi/linux/net_tstamp.h | 13 ++ net/ethtool/common.c | 24 ++++ net/ethtool/common.h | 2 + net/ethtool/info.c | 138 +++++++++++++++++++ net/ethtool/ioctl.c | 20 +-- net/ethtool/netlink.h | 9 ++ net/ethtool/strset.c | 18 +++ 10 files changed, 236 insertions(+), 20 deletions(-)
Documentation/networking/ethtool-netlink.txt +9 -1
@@ -240,6 +240,11 @@ Kernel response contents: ETHA_DRVINFO_FWVERSION (string) firmware version ETHA_DRVINFO_BUSINFO (string) device bus address ETHA_DRVINFO_EROM_VER (string) expansion ROM version + ETHA_INFO_TSINFO (nested) timestamping information + ETHA_TSINFO_TIMESTAMPING (bitset) supported flags + ETHA_TSINFO_PHC_INDEX (u32) associated PHC + ETHA_TSINFO_TX_TYPES (bitset) Tx types + ETHA_TSINFO_RX_FILTERS (bitset) Rx filters The meaning of DRVINFO attributes follows the corresponding fields of ETHTOOL_GDRVINFO response. Second part with various counts and sizes is
@@ -247,6 +252,9 @@ omitted as these are not really needed (and if they are, they can be easily found by different means). Driver version is also omitted as it is rather misleading in most cases. +ETHA_TSINFO_PHC_INDEX can be unsigned as there is no need for special value; +if no PHC is associated, the attribute is not present. + GET_INFO requests allow dumps.
@@ -322,7 +330,7 @@ ETHTOOL_SCHANNELS n/a ETHTOOL_SET_DUMP n/a ETHTOOL_GET_DUMP_FLAG n/a ETHTOOL_GET_DUMP_DATA n/a -ETHTOOL_GET_TS_INFO n/a +ETHTOOL_GET_TS_INFO ETHNL_CMD_GET_INFO ETHTOOL_GMODULEINFO n/a ETHTOOL_GMODULEEEPROM n/a ETHTOOL_GEEE n/a
include/uapi/linux/ethtool.h +6 -0
@@ -563,6 +563,9 @@ struct ethtool_pauseparam {* @ETH_SS_RSS_HASH_FUNCS: RSS hush function names * @ETH_SS_PHY_STATS: Statistic names, for use with %ETHTOOL_GPHYSTATS * @ETH_SS_PHY_TUNABLES: PHY tunable names +* @ETH_SS_TSTAMP_SOF: timestamping flag names +* @ETH_SS_TSTAMP_TX_TYPE: timestamping Tx type names +* @ETH_SS_TSTAMP_RX_FILTER: timestamping Rx filter names */ enum ethtool_stringset {ETH_SS_TEST =0 ,
@@ -574,6 +577,9 @@ enum ethtool_stringset {ETH_SS_TUNABLES ,ETH_SS_PHY_STATS ,ETH_SS_PHY_TUNABLES , +ETH_SS_TSTAMP_SOF , +ETH_SS_TSTAMP_TX_TYPE , +ETH_SS_TSTAMP_RX_FILTER , ETH_SS_COUNT };
include/uapi/linux/ethtool_netlink.h +15 -1
@@ -151,14 +151,17 @@ enum {ETHA_INFO_INFOMASK ,/* u32 */ ETHA_INFO_COMPACT ,/* flag */ ETHA_INFO_DRVINFO ,/* nest - ETHA_DRVINFO_* */ +ETHA_INFO_TSINFO ,/* nest - ETHA_TSINFO_* */ __ETHA_INFO_CNT,ETHA_INFO_MAX = (__ETHA_INFO_CNT -1 ) };#define ETH_INFO_IM_DRVINFO (1U << 0) +#define ETH_INFO_IM_TSINFO (1U << 1) -#define ETH_INFO_IM_ALL (ETH_INFO_IM_DRVINFO) +#define ETH_INFO_IM_ALL (ETH_INFO_IM_DRVINFO | \ + ETH_INFO_IM_TSINFO)enum { ETHA_DRVINFO_UNSPEC,
@@ -171,6 +174,17 @@ enum { ETHA_DRVINFO_MAX = (__ETHA_DRVINFO_CNT - 1) }; +enum { +ETHA_TSINFO_UNSPEC , +ETHA_TSINFO_TIMESTAMPING ,/* bitset */ +ETHA_TSINFO_PHC_INDEX ,/* u32 */ +ETHA_TSINFO_TX_TYPES ,/* bitset */ +ETHA_TSINFO_RX_FILTERS ,/* bitset */ + + __ETHA_TSINFO_CNT, +ETHA_TSINFO_MAX = (__ETHA_TSINFO_CNT -1 ) +}; +/* generic netlink info */ #define ETHTOOL_GENL_NAME "ethtool"#define ETHTOOL_GENL_VERSION 1
include/uapi/linux/net_tstamp.h +13 -0
@@ -30,6 +30,9 @@ enum {SOF_TIMESTAMPING_OPT_STATS = (1 <<12 ),SOF_TIMESTAMPING_OPT_PKTINFO = (1 <<13 ),SOF_TIMESTAMPING_OPT_TX_SWHW = (1 <<14 ), +/* when adding a flag, please update so_timestamping_labels array +* in net/ethtool/info.c +*/ SOF_TIMESTAMPING_LAST =SOF_TIMESTAMPING_OPT_TX_SWHW , SOF_TIMESTAMPING_MASK = (SOF_TIMESTAMPING_LAST - 1) |
@@ -90,6 +93,11 @@ enum hwtstamp_tx_types {* queue. */ HWTSTAMP_TX_ONESTEP_SYNC , +/* when adding a value, please update tstamp_tx_type_labels array +* in net/ethtool/info.c +*/ + + HWTSTAMP_TX_LAST = HWTSTAMP_TX_ONESTEP_SYNC };/* possible values for hwtstamp_config->rx_filter */
@@ -132,6 +140,11 @@ enum hwtstamp_rx_filters {/* NTP, UDP, all versions and packet modes */ HWTSTAMP_FILTER_NTP_ALL , +/* when adding a value, please update tstamp_rx_filter_labels array +* in net/ethtool/info.c +*/ + + HWTSTAMP_FILTER_LAST = HWTSTAMP_FILTER_NTP_ALL };/* SCM_TIMESTAMPING_PKTINFO control message */
net/ethtool/common.c +24 -0
@@ -1,6 +1,8 @@// SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note #include <linux/rtnetlink.h> +#include <linux/phy.h> +#include <linux/net_tstamp.h> #include <net/devlink.h> #include "common.h"
@@ -133,3 +135,25 @@ int __ethtool_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)return 0 ; } + +int __ethtool_get_ts_info (struct net_device *dev,struct ethtool_ts_info *info) +{ +const struct ethtool_ops *ops = dev->ethtool_ops; +struct phy_device *phydev = dev->phydev; +int err =0 ; + +memset (info,0 ,sizeof (*info)); + info->cmd =ETHTOOL_GET_TS_INFO ; + +if (phydev && phydev->drv && phydev->drv->ts_info) { + err = phydev->drv->ts_info (phydev, info); + }else if (ops->get_ts_info) { + err = ops->get_ts_info (dev, info); + }else { + info->so_timestamping =SOF_TIMESTAMPING_RX_SOFTWARE | +SOF_TIMESTAMPING_SOFTWARE ; + info->phc_index =-1 ; + } + +return err; +}
net/ethtool/common.h +2 -0
@@ -16,4 +16,6 @@ extern const char phy_tunable_strings[__ETHTOOL_PHY_TUNABLE_COUNT][ETH_GSTRING_LEN ];int __ethtool_get_drvinfo (struct net_device *dev,struct ethtool_drvinfo *info); +int __ethtool_get_ts_info (struct net_device *dev,struct ethtool_ts_info *info); +#endif /* _ETHTOOL_COMMON_H */
net/ethtool/info.c +138 -0
189 lines not on this page · raw message
net/ethtool/ioctl.c +2 -18
@@ -2027,28 +2027,12 @@ static int ethtool_get_dump_data(struct net_device *dev,static int ethtool_get_ts_info (struct net_device *dev,void __user *useraddr) { -int err =0 ; +int err;struct ethtool_ts_info info; -const struct ethtool_ops *ops = dev->ethtool_ops; -struct phy_device *phydev = dev->phydev; - -memset (&info,0 ,sizeof (info)); - info.cmd =ETHTOOL_GET_TS_INFO ; - -if (phydev && phydev->drv && phydev->drv->ts_info) { - err = phydev->drv->ts_info (phydev, &info); - }else if (ops->get_ts_info) { - err = ops->get_ts_info (dev, &info); - }else { - info.so_timestamping = -SOF_TIMESTAMPING_RX_SOFTWARE | -SOF_TIMESTAMPING_SOFTWARE ; - info.phc_index =-1 ; - } + err =__ethtool_get_ts_info (dev, &info);if (err)return err; -if (copy_to_user (useraddr, &info,sizeof (info))) err = -EFAULT ;
net/ethtool/netlink.h +9 -0
@@ -7,14 +7,23 @@#include <linux/netdevice.h> #include <net/genetlink.h> #include <net/sock.h> +#include <linux/net_tstamp.h> #define ETHNL_SET_ERRMSG (info, msg) \ do { if (info) GENL_SET_ERR_MSG(info, msg); } while (0) +#define __SOF_TIMESTAMPING_COUNT (const_ilog2(SOF_TIMESTAMPING_LAST) + 1) +#define __HWTSTAMP_TX_COUNT (HWTSTAMP_TX_LAST + 1) +#define __HWTSTAMP_FILTER_COUNT (HWTSTAMP_FILTER_LAST + 1) +extern u32 ethnl_bcast_seq;extern struct genl_family ethtool_genl_family; +extern const char *const so_timestamping_labels[]; +extern const char *const tstamp_tx_type_labels[]; +extern const char *const tstamp_rx_filter_labels[]; +struct net_device *ethnl_dev_get (struct genl_info *info,struct nlattr *nest);int ethnl_fill_dev (struct sk_buff *msg,struct net_device *dev,u16 attrtype);
net/ethtool/strset.c +18 -0
@@ -67,6 +67,24 @@ static const struct strset_info info_template[] = { .count = ARRAY_SIZE(phy_tunable_strings), .data = { .legacy = phy_tunable_strings }, }, + [ETH_SS_TSTAMP_SOF] = { + .type = ETH_SS_TYPE_SIMPLE, + .per_dev = false, + .count = __SOF_TIMESTAMPING_COUNT, + .data = { .simple = so_timestamping_labels }, + }, + [ETH_SS_TSTAMP_TX_TYPE] = { + .type = ETH_SS_TYPE_SIMPLE, + .per_dev = false, + .count = __HWTSTAMP_TX_COUNT, + .data = { .simple = tstamp_tx_type_labels }, + }, + [ETH_SS_TSTAMP_RX_FILTER] = { + .type = ETH_SS_TYPE_SIMPLE, + .per_dev = false, + .count = __HWTSTAMP_FILTER_COUNT, + .data = { .simple = tstamp_rx_filter_labels }, + }, };struct strset_data {
Signature · 1 line
2.21.0
PATCH v4 15/22 ethtool: provide link mode names as a string set
In reply to Michal KubecekAdd table of ethernet link mode names and make it available as a string set to userspace GET_STRSET requests.
--- include/linux/ethtool.h | 4 ++ include/uapi/linux/ethtool.h | 2 + net/ethtool/netlink.c | 81 ++++++++++++++++++++++++++++++++++++ net/ethtool/netlink.h | 1 + net/ethtool/strset.c | 6 +++ 5 files changed, 94 insertions(+)
include/linux/ethtool.h +4 -0
@@ -102,6 +102,10 @@ static inline u32 ethtool_rxfh_indir_default(u32 index, u32 n_rx_rings)#define __ETHTOOL_DECLARE_LINK_MODE_MASK (name) \ DECLARE_BITMAP(name, __ETHTOOL_LINK_MODE_MASK_NBITS) +/* compose link mode index from speed, type and duplex */ +#define ETHTOOL_LINK_MODE (speed, type, duplex) \ + ETHTOOL_LINK_MODE_ ## speed ## base ## type ## _ ## duplex ## _BIT +/* drivers must ignore base.cmd and base.link_mode_masks_nwords * fields, but they are allowed to overwrite them (will be ignored). */
include/uapi/linux/ethtool.h +2 -0
@@ -566,6 +566,7 @@ struct ethtool_pauseparam {* @ETH_SS_TSTAMP_SOF: timestamping flag names * @ETH_SS_TSTAMP_TX_TYPE: timestamping Tx type names * @ETH_SS_TSTAMP_RX_FILTER: timestamping Rx filter names +* @ETH_SS_LINK_MODES: link mode names */ enum ethtool_stringset {ETH_SS_TEST =0 ,
@@ -580,6 +581,7 @@ enum ethtool_stringset {ETH_SS_TSTAMP_SOF ,ETH_SS_TSTAMP_TX_TYPE ,ETH_SS_TSTAMP_RX_FILTER , +ETH_SS_LINK_MODES , ETH_SS_COUNT };
net/ethtool/netlink.c +81 -0
93 lines not on this page · raw message
net/ethtool/netlink.h +1 -0
@@ -23,6 +23,7 @@ extern struct genl_family ethtool_genl_family;extern const char *const so_timestamping_labels[];extern const char *const tstamp_tx_type_labels[];extern const char *const tstamp_rx_filter_labels[]; +extern const char *const link_mode_names[];struct net_device *ethnl_dev_get (struct genl_info *info,struct nlattr *nest);int ethnl_fill_dev (struct sk_buff *msg,struct net_device *dev,u16 attrtype);
net/ethtool/strset.c +6 -0
@@ -85,6 +85,12 @@ static const struct strset_info info_template[] = { .count = __HWTSTAMP_FILTER_COUNT, .data = { .simple = tstamp_rx_filter_labels }, }, + [ETH_SS_LINK_MODES] = { + .type = ETH_SS_TYPE_SIMPLE, + .per_dev = false, + .count = __ETHTOOL_LINK_MODE_MASK_NBITS, + .data = { .simple = link_mode_names }, + }, };struct strset_data {
Signature · 1 line
2.21.0
PATCH v4 16/22 ethtool: provide link settings and link modes in GET_SETTINGS request
In reply to Michal KubecekImplement GET_SETTINGS netlink request to get link settings and link mode information provided by ETHTOOL_GLINKSETTINGS ioctl command.
The information in SET_SETTINGS message sent as reply is divided into two
parts: autonegotiation, speed, duplex and supported, advertised and peer advertised link modes when ETH_SETTINGS_IM_LINKMODES flag is set in the request and other settings when ETH_SETTINGS_IM_LINKINFO is set.
Send notification in the same format as the reply message when relevant fields are modified using the ioctl interface (ETHTOOL_SLINKSETTINGS or ETHTOOL_SSET command).
--- Documentation/networking/ethtool-netlink.txt | 50 +++- include/linux/ethtool_netlink.h | 3 + include/uapi/linux/ethtool_netlink.h | 46 +++ net/ethtool/Makefile | 2 +- net/ethtool/common.c | 48 ++++ net/ethtool/common.h | 4 + net/ethtool/ioctl.c | 64 +---- net/ethtool/netlink.c | 9 + net/ethtool/netlink.h | 1 + net/ethtool/settings.c | 277 +++++++++++++++++++ 10 files changed, 451 insertions(+), 53 deletions(-) create mode 100644 net/ethtool/settings.c
Documentation/networking/ethtool-netlink.txt +48 -2
@@ -131,6 +131,8 @@ List of message types ETHNL_CMD_SET_STRSET response only ETHNL_CMD_GET_INFO ETHNL_CMD_SET_INFO response only + ETHNL_CMD_GET_SETTINGS + ETHNL_CMD_SET_SETTINGS response only (for now) All constants use ETHNL_CMD_ prefix, usually followed by "GET", "SET" or "ACT" to indicate the type.
@@ -258,6 +260,50 @@ if no PHC is associated, the attribute is not present. GET_INFO requests allow dumps. +GET_SETTINGS +------------ + +GET_SETTINGS request retrieves information provided by ETHTOOL_GLINKSETTINGS, +ETHTOOL_GWOL, ETHTOOL_GMSGLVL and ETHTOOL_GLINK ioctl requests. The request +doesn't use any attributes. + +Request attributes: + + ETHA_SETTINGS_DEV (nested) device identification + ETHA_SETTINGS_INFOMASK (u32) info mask + ETHA_SETTINGS_COMPACT (flag) request compact bitsets + +Info mask bits meaning: + + ETH_SETTINGS_IM_LINKINFO link settings + ETH_SETTINGS_IM_LINKMODES link modes and related + +Response contents: + + ETHA_SETTINGS_DEV (nested) device identification + ETHA_SETTINGS_LINK_INFO (nested) link settings + ETHA_LINKINFO_PORT (u8) physical port + ETHA_LINKINFO_PHYADDR (u8) MDIO address of phy + ETHA_LINKINFO_TP_MDIX (u8) MDI(-X) status + ETHA_LINKINFO_TP_MDIX_CTRL (u8) MDI(-X) control + ETHA_LINKINFO_TRANSCEIVER (u8) transceiver + ETHA_SETTINGS_LINK_MODES (nested) link modes + ETHA_LINKMODES_AUTONEG (u8) autoneotiation status + ETHA_LINKMODES_OURS (bitset) advertised link modes + ETHA_LINKMODES_PEER (bitset) partner link modes + ETHA_LINKMODES_SPEED (u32) link speed (Mb/s) + ETHA_LINKMODES_DUPLEX (u8) duplex mode + +Most of the attributes and their values have the same meaning as matching +members of the corresponding ioctl structures. For ETHA_LINKMODES_OURS, +value represents advertised modes and mask represents supported modes. +ETHA_LINKMODES_PEER in the reply is a bit list. + +GET_SETTINGS requests allow dumps and messages in the same format as response +to them are broadcasted as notifications on change of these settings using +netlink or ioctl ethtool interface. + + Request translation -------------------
@@ -267,7 +313,7 @@ have their netlink replacement yet. ioctl command netlink command --------------------------------------------------------------------- -ETHTOOL_GSET n/a +ETHTOOL_GSET ETHNL_CMD_GET_SETTINGS ETHTOOL_SSET n/a ETHTOOL_GDRVINFO ETHNL_CMD_GET_INFO ETHTOOL_GREGS n/a
@@ -341,7 +387,7 @@ ETHTOOL_GTUNABLE n/a ETHTOOL_STUNABLE n/a ETHTOOL_GPHYSTATS n/a ETHTOOL_PERQUEUE n/a -ETHTOOL_GLINKSETTINGS n/a +ETHTOOL_GLINKSETTINGS ETHNL_CMD_GET_SETTINGS ETHTOOL_SLINKSETTINGS n/a ETHTOOL_PHY_GTUNABLE n/a ETHTOOL_PHY_STUNABLE n/a
include/linux/ethtool_netlink.h +3 -0
@@ -7,6 +7,9 @@#include <linux/ethtool.h> #include <linux/netdevice.h> +#define __ETHTOOL_LINK_MODE_MASK_NWORDS \ + DIV_ROUND_UP(__ETHTOOL_LINK_MODE_MASK_NBITS, 32) +enum ethtool_multicast_groups {ETHNL_MCGRP_MONITOR , };
include/uapi/linux/ethtool_netlink.h +46 -0
58 lines not on this page · raw message
net/ethtool/Makefile +1 -1
@@ -4,4 +4,4 @@ obj-y += ioctl.o common.o obj-$(CONFIG_ETHTOOL_NETLINK) += ethtool_nl.o -ethtool_nl-y := netlink.o bitset.o strset.o info.o +ethtool_nl-y := netlink.o bitset.o strset.o info.o settings.o
net/ethtool/common.c +48 -0
51 lines not on this page · raw message
net/ethtool/common.h +4 -0
@@ -18,4 +18,8 @@ phy_tunable_strings[__ETHTOOL_PHY_TUNABLE_COUNT][ETH_GSTRING_LEN];int __ethtool_get_drvinfo (struct net_device *dev,struct ethtool_drvinfo *info);int __ethtool_get_ts_info (struct net_device *dev,struct ethtool_ts_info *info); +bool convert_legacy_settings_to_link_ksettings ( +struct ethtool_link_ksettings *link_ksettings, +const struct ethtool_cmd *legacy_settings); +#endif /* _ETHTOOL_COMMON_H */
net/ethtool/ioctl.c +14 -50
94 lines not on this page · raw message
net/ethtool/netlink.c +9 -0
@@ -232,6 +232,7 @@ struct sk_buff *ethnl_reply_init(size_t payload, struct net_device *dev, u8 cmd,const struct get_request_ops *get_requests[__ETHNL_CMD_CNT] = { [ETHNL_CMD_GET_STRSET ] = &strset_request_ops, [ETHNL_CMD_GET_INFO ] = &info_request_ops, + [ETHNL_CMD_GET_SETTINGS ] = &settings_request_ops, };/**
@@ -556,6 +557,7 @@ typedef void (*ethnl_notify_handler_t)(struct net_device *dev, const void *data);ethnl_notify_handler_t ethnl_notify_handlers[] = { + [ETHNL_CMD_SET_SETTINGS ] = ethnl_std_notify, }; void ethtool_notify(struct net_device *dev, struct netlink_ext_ack *extack,
@@ -650,6 +652,13 @@ static const struct genl_ops ethtool_genl_ops[] = { .dumpit = ethnl_get_dumpit, .done = ethnl_get_done, }, + { + .cmd = ETHNL_CMD_GET_SETTINGS, + .doit = ethnl_get_doit, + .start = ethnl_get_start, + .dumpit = ethnl_get_dumpit, + .done = ethnl_get_done, + }, };static const struct genl_multicast_group ethtool_nl_mcgrps[] = {
net/ethtool/netlink.h +1 -0
@@ -289,5 +289,6 @@ struct get_request_ops {extern const struct get_request_ops strset_request_ops;extern const struct get_request_ops info_request_ops; +extern const struct get_request_ops settings_request_ops;#endif /* _NET_ETHTOOL_NETLINK_H */
net/ethtool/settings.c new file +277 -0
277 lines not on this page · raw message
Signature · 1 line
2.21.0
PATCH v4 17/22 ethtool: set link settings and link modes with SET_SETTINGS request
In reply to Michal KubecekImplement SET_SETTINGS netlink request allowing to set link settings and advertised link modes as an alternative to ETHTOOL_SLINKSETTINGS ioctl command.
ETHA_SETTINGS_LINK_MODES attribute is used to set (or modify) advertised link modes and related settings (autonegotiation, speed and duplex) and ETHA_SETTINGS_LINK_INFO to set other link settings.
--- Documentation/networking/ethtool-netlink.txt | 34 ++- net/ethtool/netlink.c | 5 + net/ethtool/netlink.h | 2 + net/ethtool/settings.c | 305 +++++++++++++++++++ 4 files changed, 343 insertions(+), 3 deletions(-)
Documentation/networking/ethtool-netlink.txt +31 -3
@@ -132,7 +132,7 @@ List of message types ETHNL_CMD_GET_INFO ETHNL_CMD_SET_INFO response only ETHNL_CMD_GET_SETTINGS - ETHNL_CMD_SET_SETTINGS response only (for now) + ETHNL_CMD_SET_SETTINGS All constants use ETHNL_CMD_ prefix, usually followed by "GET", "SET" or "ACT" to indicate the type.
@@ -304,6 +304,34 @@ to them are broadcasted as notifications on change of these settings using netlink or ioctl ethtool interface. +SET_SETTINGS +------------ + +SET_SETTINGS request allows setting some of the data reported by GET_SETTINGS. +Request flags, info_mask and index are ignored. These attributes are allowed +to be passed with SET_SETTINGS request: + + ETHA_SETTINGS_DEV (nested) device identification + ETHA_SETTINGS_LINK_INFO (nested) link settings + ETHA_LINKINFO_PORT (u8) physical port + ETHA_LINKINFO_PHYADDR (u8) MDIO address of phy + ETHA_LINKINFO_TP_MDIX_CTRL (u8) MDI(-X) control + ETHA_SETTINGS_LINK_MODES (nested) link modes + ETHA_LINKMODES_AUTONEG (u8) autonegotiation + ETHA_LINKMODES_OURS (bitset) advertised link modes + ETHA_LINKMODES_SPEED (u32) link speed (Mb/s) + ETHA_LINKMODES_DUPLEX (u8) duplex mode + +ETHA_LINKMODES_OURS bit set allows setting advertised link modes. If +autonegotiation is on (either set now or kept from before), advertised modes +are not changed (no ETHA_LINKMODES_OURS attribute) and at least one of speed +and duplex is specified, kernel adjusts advertised modes to all supported +modes matching speed, duplex or both (whatever is specified). This +autoselection is done on ethtool side with ioctl interface, netlink interface +is supposed to allow requesting changes without knowing what exactly kernel +supports. + + Request translation -------------------
@@ -314,7 +342,7 @@ have their netlink replacement yet. ioctl command netlink command --------------------------------------------------------------------- ETHTOOL_GSET ETHNL_CMD_GET_SETTINGS -ETHTOOL_SSET n/a +ETHTOOL_SSET ETHNL_CMD_SET_SETTINGS ETHTOOL_GDRVINFO ETHNL_CMD_GET_INFO ETHTOOL_GREGS n/a ETHTOOL_GWOL n/a
@@ -388,7 +416,7 @@ ETHTOOL_STUNABLE n/a ETHTOOL_GPHYSTATS n/a ETHTOOL_PERQUEUE n/a ETHTOOL_GLINKSETTINGS ETHNL_CMD_GET_SETTINGS -ETHTOOL_SLINKSETTINGS n/a +ETHTOOL_SLINKSETTINGS ETHNL_CMD_SET_SETTINGS ETHTOOL_PHY_GTUNABLE n/a ETHTOOL_PHY_STUNABLE n/a ETHTOOL_GFECPARAM n/a
net/ethtool/netlink.c +5 -0
@@ -659,6 +659,11 @@ static const struct genl_ops ethtool_genl_ops[] = { .dumpit = ethnl_get_dumpit, .done = ethnl_get_done, }, + { + .cmd = ETHNL_CMD_SET_SETTINGS, + .flags = GENL_UNS_ADMIN_PERM, + .doit = ethnl_set_settings, + }, };static const struct genl_multicast_group ethtool_nl_mcgrps[] = {
net/ethtool/netlink.h +2 -0
@@ -291,4 +291,6 @@ extern const struct get_request_ops strset_request_ops;extern const struct get_request_ops info_request_ops;extern const struct get_request_ops settings_request_ops; +int ethnl_set_settings (struct sk_buff *skb,struct genl_info *info); +#endif /* _NET_ETHTOOL_NETLINK_H */
net/ethtool/settings.c +305 -0
314 lines not on this page · raw message
Signature · 1 line
2.21.0
PATCH v4 18/22 ethtool: provide link state in GET_SETTINGS request
In reply to Michal KubecekAdd information about device link state (as provided by ETHTOOL_GLINK ioctl command) into the GET_SETTINGS reply when ETH_SETTINGS_IM_LINKSTATE flag is set in the request.
Note: we cannot use NLA_FLAG for link state as we need three states: off, on and unknown. The attribute is also encapsulated in a nest to allow future extensions.
--- Documentation/networking/ethtool-netlink.txt | 5 ++- include/uapi/linux/ethtool_netlink.h | 13 ++++++- net/ethtool/common.c | 8 +++++ net/ethtool/common.h | 1 + net/ethtool/ioctl.c | 8 ++--- net/ethtool/settings.c | 37 ++++++++++++++++++++ 6 files changed, 66 insertions(+), 6 deletions(-)
Documentation/networking/ethtool-netlink.txt +4 -1
@@ -277,6 +277,7 @@ Info mask bits meaning: ETH_SETTINGS_IM_LINKINFO link settings ETH_SETTINGS_IM_LINKMODES link modes and related + ETH_SETTINGS_IM_LINKSTATE link state Response contents:
@@ -293,6 +294,8 @@ Response contents: ETHA_LINKMODES_PEER (bitset) partner link modes ETHA_LINKMODES_SPEED (u32) link speed (Mb/s) ETHA_LINKMODES_DUPLEX (u8) duplex mode + ETHA_SETTINGS_LINK_STATE (nested) link state + ETHA_LINKSTATE_LINK (u8) link on/off/unknown Most of the attributes and their values have the same meaning as matching members of the corresponding ioctl structures. For ETHA_LINKMODES_OURS,
@@ -350,7 +353,7 @@ ETHTOOL_SWOL n/a ETHTOOL_GMSGLVL n/a ETHTOOL_SMSGLVL n/a ETHTOOL_NWAY_RST n/a -ETHTOOL_GLINK n/a +ETHTOOL_GLINK ETHNL_CMD_GET_SETTINGS ETHTOOL_GEEPROM n/a ETHTOOL_SEEPROM n/a ETHTOOL_GCOALESCE n/a
include/uapi/linux/ethtool_netlink.h +12 -1
@@ -196,6 +196,7 @@ enum {ETHA_SETTINGS_COMPACT ,/* flag */ ETHA_SETTINGS_LINK_INFO ,/* nest - ETHA_LINKINFO_* */ ETHA_SETTINGS_LINK_MODES ,/* nest - ETHA_LINKMODES_* */ +ETHA_SETTINGS_LINK_STATE ,/* nest - ETHA_LINKSTATE_* */ __ETHA_SETTINGS_CNT,ETHA_SETTINGS_MAX = (__ETHA_SETTINGS_CNT -1 )
@@ -203,9 +204,11 @@ enum {#define ETH_SETTINGS_IM_LINKINFO (1U << 0)#define ETH_SETTINGS_IM_LINKMODES (1U << 1) +#define ETH_SETTINGS_IM_LINKSTATE (1U << 2)#define ETH_SETTINGS_IM_ALL (ETH_SETTINGS_IM_LINKINFO | \ - ETH_SETTINGS_IM_LINKMODES) + ETH_SETTINGS_IM_LINKMODES | \ + ETH_SETTINGS_IM_LINKSTATE)enum {ETHA_LINKINFO_UNSPEC ,
@@ -231,6 +234,14 @@ enum { ETHA_LINKMODES_MAX = (__ETHA_LINKMODES_CNT - 1) }; +enum { +ETHA_LINKSTATE_UNSPEC , +ETHA_LINKSTATE_LINK ,/* u8 */ + + __ETHA_LINKSTATE_CNT, +ETHA_LINKSTATE_MAX = (__ETHA_LINKSTATE_CNT -1 ) +}; +/* generic netlink info */ #define ETHTOOL_GENL_NAME "ethtool"#define ETHTOOL_GENL_VERSION 1
net/ethtool/common.c +8 -0
@@ -205,3 +205,11 @@ convert_legacy_settings_to_link_ksettings( = legacy_settings->eth_tp_mdix_ctrl;return retval; } + +int __ethtool_get_link (struct net_device *dev) +{ +if (!dev->ethtool_ops->get_link) +return -EOPNOTSUPP ; + +return netif_running (dev) && dev->ethtool_ops->get_link (dev); +}
net/ethtool/common.h +1 -0
@@ -17,6 +17,7 @@ phy_tunable_strings[__ETHTOOL_PHY_TUNABLE_COUNT][ETH_GSTRING_LEN];int __ethtool_get_drvinfo (struct net_device *dev,struct ethtool_drvinfo *info);int __ethtool_get_ts_info (struct net_device *dev,struct ethtool_ts_info *info); +int __ethtool_get_link (struct net_device *dev); bool convert_legacy_settings_to_link_ksettings( struct ethtool_link_ksettings *link_ksettings,
net/ethtool/ioctl.c +4 -4
@@ -1318,12 +1318,12 @@ static int ethtool_nway_reset(struct net_device *dev)static int ethtool_get_link (struct net_device *dev,char __user *useraddr) {struct ethtool_value edata = { .cmd =ETHTOOL_GLINK }; +int link =__ethtool_get_link (dev); -if (!dev->ethtool_ops->get_link) -return -EOPNOTSUPP ; - - edata.data =netif_running (dev) && dev->ethtool_ops->get_link (dev); +if (link <0 ) +return link; + edata.data = link;if (copy_to_user (useraddr, &edata,sizeof (edata)))return -EFAULT ;return 0 ;
net/ethtool/settings.c +37 -0
@@ -11,6 +11,7 @@ struct settings_data {struct common_reply_data repdata_base;struct ethtool_link_ksettings ksettings;struct ethtool_link_settings *lsettings; +int link;bool lpm_empty; };
@@ -112,6 +113,7 @@ static const struct nla_policy get_settings_policy[ETHA_SETTINGS_MAX + 1] = { [ETHA_SETTINGS_COMPACT] = { .type = NLA_FLAG }, [ETHA_SETTINGS_LINK_INFO] = { .type = NLA_REJECT }, [ETHA_SETTINGS_LINK_MODES] = { .type = NLA_REJECT }, + [ETHA_SETTINGS_LINK_STATE] = { .type = NLA_REJECT }, }; static int parse_settings(struct common_req_info *req_info,
@@ -168,6 +170,7 @@ static int prepare_settings(struct common_req_info *req_info, data->lsettings = &data->ksettings.base; data->lpm_empty = true; + data->link = -EOPNOTSUPP ; ret =ethnl_before_ops (dev);if (ret <0 )
@@ -189,6 +192,8 @@ static int prepare_settings(struct common_req_info *req_info,ethnl_bitmap_to_u32 (data->ksettings.link_modes.lp_advertising, __ETHTOOL_LINK_MODE_MASK_NWORDS); } +if (req_mask Ð_SETTINGS_IM_LINKSTATE ) + data->link =__ethtool_get_link (dev);ethnl_after_ops (dev); data->repdata_base.info_mask = req_mask;
@@ -237,6 +242,13 @@ static int link_modes_size(const struct ethtool_link_ksettings *ksettings,return nla_total_size (len); } +static int link_state_size (int link) +{ +if (link <0 ) +return nla_total_size (0 ); +return nla_total_size (nla_total_size (sizeof (u8))); +} +/* To keep things simple, reserve space for some attributes which may not * be added to the message (e.g. ETHA_SETTINGS_SOPASS); therefore the length * returned may be bigger than the actual length of the message sent
@@ -258,6 +270,8 @@ static int settings_size(const struct common_req_info *req_info)return ret; len += ret; } +if (info_mask Ð_SETTINGS_IM_LINKSTATE ) + len +=link_state_size (data->link);return len; }
@@ -330,6 +344,23 @@ static int fill_link_modes(struct sk_buff *skb,return -EMSGSIZE ; } +static int fill_link_state (struct sk_buff *skb,u8 link) +{ +struct nlattr *nest; + + nest =ethnl_nest_start (skb,ETHA_SETTINGS_LINK_STATE ); +if (!nest) +return -EMSGSIZE ; +if (link >=0 &&nla_put_u8 (skb,ETHA_LINKSTATE_LINK , link)) + goto err; +nla_nest_end (skb, nest); +return 0 ; + +err: +nla_nest_cancel (skb, nest); +return -EMSGSIZE ; +} +static int fill_settings (struct sk_buff *skb,const struct common_req_info *req_info) {
@@ -350,6 +381,11 @@ static int fill_settings(struct sk_buff *skb,if (ret <0 )return ret; } +if (info_mask Ð_SETTINGS_IM_LINKSTATE ) { + ret =fill_link_state (skb, data->link); +if (ret <0 ) +return ret; + }return 0 ; }
@@ -394,6 +430,7 @@ static const struct nla_policy set_settings_policy[ETHA_SETTINGS_MAX + 1] = { [ETHA_SETTINGS_COMPACT] = { .type = NLA_FLAG }, [ETHA_SETTINGS_LINK_INFO] = { .type = NLA_NESTED }, [ETHA_SETTINGS_LINK_MODES] = { .type = NLA_NESTED }, + [ETHA_SETTINGS_LINK_STATE] = { .type = NLA_REJECT }, }; static int ethnl_set_link_ksettings(struct genl_info *info,
Signature · 1 line
2.21.0
PATCH v4 19/22 ethtool: provide WoL information in GET_SETTINGS request
In reply to Michal KubecekAdd information about supported and enabled wake on LAN modes into the GET_SETTINGS reply when ETH_SETTINGS_IM_WOL flag is set in the request.
The GET_SETTINGS request can be still sent by unprivileged users but in such case the SecureOn password (if any) is not included in the reply.
Send notification in the same format as reply SET_SETTINGS message when wake on LAN settings are modified using ioctl interface (ETHTOOL_SWOL command).
--- Documentation/networking/ethtool-netlink.txt | 13 +++- include/uapi/linux/ethtool_netlink.h | 14 ++++- net/ethtool/common.c | 10 ++++ net/ethtool/common.h | 1 + net/ethtool/ioctl.c | 10 ++-- net/ethtool/settings.c | 63 ++++++++++++++++++++ 6 files changed, 105 insertions(+), 6 deletions(-)
Documentation/networking/ethtool-netlink.txt +12 -1
@@ -278,6 +278,7 @@ Info mask bits meaning: ETH_SETTINGS_IM_LINKINFO link settings ETH_SETTINGS_IM_LINKMODES link modes and related ETH_SETTINGS_IM_LINKSTATE link state + ETH_SETTINGS_IM_WOL struct ethtool_wolinfo Response contents:
@@ -296,12 +297,22 @@ Response contents: ETHA_LINKMODES_DUPLEX (u8) duplex mode ETHA_SETTINGS_LINK_STATE (nested) link state ETHA_LINKSTATE_LINK (u8) link on/off/unknown + ETHA_SETTINGS_WOL (nested) wake on LAN settings + ETHA_WOL_MODES (bitfield32) wake on LAN modes + ETHA_WOL_SOPASS (binary) SecureOn(tm) password Most of the attributes and their values have the same meaning as matching members of the corresponding ioctl structures. For ETHA_LINKMODES_OURS, value represents advertised modes and mask represents supported modes. ETHA_LINKMODES_PEER in the reply is a bit list. +For ETHA_WOL_MODES, selector reports wake on LAN modes supported by the +device and value enabled modes. + +GET_SETTINGS request is allowed for unprivileged user but ETHA_WOL_SOPASS +is only provided by kernel in response to privileged (netns CAP_NET_ADMIN) +requests. + GET_SETTINGS requests allow dumps and messages in the same format as response to them are broadcasted as notifications on change of these settings using netlink or ioctl ethtool interface.
@@ -348,7 +359,7 @@ ETHTOOL_GSET ETHNL_CMD_GET_SETTINGS ETHTOOL_SSET ETHNL_CMD_SET_SETTINGS ETHTOOL_GDRVINFO ETHNL_CMD_GET_INFO ETHTOOL_GREGS n/a -ETHTOOL_GWOL n/a +ETHTOOL_GWOL ETHNL_CMD_GET_SETTINGS ETHTOOL_SWOL n/a ETHTOOL_GMSGLVL n/a ETHTOOL_SMSGLVL n/a
include/uapi/linux/ethtool_netlink.h +13 -1
@@ -197,6 +197,7 @@ enum {ETHA_SETTINGS_LINK_INFO ,/* nest - ETHA_LINKINFO_* */ ETHA_SETTINGS_LINK_MODES ,/* nest - ETHA_LINKMODES_* */ ETHA_SETTINGS_LINK_STATE ,/* nest - ETHA_LINKSTATE_* */ +ETHA_SETTINGS_WOL ,/* nest - ETHA_WOL_* */ __ETHA_SETTINGS_CNT,ETHA_SETTINGS_MAX = (__ETHA_SETTINGS_CNT -1 )
@@ -205,10 +206,12 @@ enum {#define ETH_SETTINGS_IM_LINKINFO (1U << 0)#define ETH_SETTINGS_IM_LINKMODES (1U << 1)#define ETH_SETTINGS_IM_LINKSTATE (1U << 2) +#define ETH_SETTINGS_IM_WOL (1U << 3)#define ETH_SETTINGS_IM_ALL (ETH_SETTINGS_IM_LINKINFO | \ ETH_SETTINGS_IM_LINKMODES | \ - ETH_SETTINGS_IM_LINKSTATE) + ETH_SETTINGS_IM_LINKSTATE | \ + ETH_SETTINGS_IM_WOL)enum {ETHA_LINKINFO_UNSPEC ,
@@ -242,6 +245,15 @@ enum { ETHA_LINKSTATE_MAX = (__ETHA_LINKSTATE_CNT - 1) }; +enum { +ETHA_WOL_UNSPEC , +ETHA_WOL_MODES ,/* bitfield32 */ +ETHA_WOL_SOPASS ,/* binary */ + + __ETHA_WOL_CNT, +ETHA_WOL_MAX = (__ETHA_WOL_CNT -1 ) +}; +/* generic netlink info */ #define ETHTOOL_GENL_NAME "ethtool"#define ETHTOOL_GENL_VERSION 1
net/ethtool/common.c +10 -0
@@ -213,3 +213,13 @@ int __ethtool_get_link(struct net_device *dev)return netif_running (dev) && dev->ethtool_ops->get_link (dev); } + +int __ethtool_get_wol (struct net_device *dev,struct ethtool_wolinfo *wol) +{ +if (!dev->ethtool_ops->get_wol) +return -EOPNOTSUPP ; + + dev->ethtool_ops->get_wol (dev, wol); + +return 0 ; +}
net/ethtool/common.h +1 -0
@@ -18,6 +18,7 @@ phy_tunable_strings[__ETHTOOL_PHY_TUNABLE_COUNT][ETH_GSTRING_LEN];int __ethtool_get_drvinfo (struct net_device *dev,struct ethtool_drvinfo *info);int __ethtool_get_ts_info (struct net_device *dev,struct ethtool_ts_info *info);int __ethtool_get_link (struct net_device *dev); +int __ethtool_get_wol (struct net_device *dev,struct ethtool_wolinfo *wol); bool convert_legacy_settings_to_link_ksettings( struct ethtool_link_ksettings *link_ksettings,
net/ethtool/ioctl.c +6 -4
@@ -1242,11 +1242,11 @@ static int ethtool_reset(struct net_device *dev, char __user *useraddr)static int ethtool_get_wol (struct net_device *dev,char __user *useraddr) {struct ethtool_wolinfo wol = { .cmd =ETHTOOL_GWOL }; +int rc; -if (!dev->ethtool_ops->get_wol) -return -EOPNOTSUPP ; - - dev->ethtool_ops->get_wol (dev, &wol); + rc =__ethtool_get_wol (dev, &wol); +if (rc <0 ) +return rc;if (copy_to_user (useraddr, &wol,sizeof (wol)))return -EFAULT ;
@@ -1269,6 +1269,8 @@ static int ethtool_set_wol(struct net_device *dev, char __user *useraddr)return ret; dev->wol_enabled = !!wol.wolopts; +ethtool_notify (dev,NULL ,ETHNL_CMD_SET_SETTINGS ,ETH_SETTINGS_IM_WOL , +NULL );return 0 ; }
net/ethtool/settings.c +63 -0
130 lines not on this page · raw message
Signature · 1 line
2.21.0
PATCH v4 20/22 ethtool: set WoL settings with SET_SETTINGS request
In reply to Michal KubecekAllow enabling and disabling wake on LAN modes using SET_SETTINGS request.
ETHA_SETTINGS_WOL nested attribute is used to set or modify enabled WoL modes and SecureOn(tm) password.
--- Documentation/networking/ethtool-netlink.txt | 12 +++- net/ethtool/settings.c | 60 +++++++++++++++++++- 2 files changed, 70 insertions(+), 2 deletions(-)
Documentation/networking/ethtool-netlink.txt +11 -1
@@ -335,6 +335,9 @@ to be passed with SET_SETTINGS request: ETHA_LINKMODES_OURS (bitset) advertised link modes ETHA_LINKMODES_SPEED (u32) link speed (Mb/s) ETHA_LINKMODES_DUPLEX (u8) duplex mode + ETHA_SETTINGS_WOL (nested) wake on LAN settings + ETHA_WOL_MODES (bitfield32) wake on LAN modes + ETHA_WOL_SOPASS (binary) SecureOn(tm) password ETHA_LINKMODES_OURS bit set allows setting advertised link modes. If autonegotiation is on (either set now or kept from before), advertised modes
@@ -345,6 +348,13 @@ autoselection is done on ethtool side with ioctl interface, netlink interface is supposed to allow requesting changes without knowing what exactly kernel supports. +ETHA_WOL_MODES bitfield is interpreted in the usual way, i.e. bits set in the +selector are set to 0 or 1 according to value. To allow the semantics of the +ioctl interface where the whole bitmap is set rather than only modified, +selectors may have also bits not supported by device set and an error is only +issued if any of them is also set in the value (i.e. if userspace tries to +enable mode not supported by device). + Request translation -------------------
@@ -360,7 +370,7 @@ ETHTOOL_SSET ETHNL_CMD_SET_SETTINGS ETHTOOL_GDRVINFO ETHNL_CMD_GET_INFO ETHTOOL_GREGS n/a ETHTOOL_GWOL ETHNL_CMD_GET_SETTINGS -ETHTOOL_SWOL n/a +ETHTOOL_SWOL ETHNL_CMD_SET_SETTINGS ETHTOOL_GMSGLVL n/a ETHTOOL_SMSGLVL n/a ETHTOOL_NWAY_RST n/a
net/ethtool/settings.c +59 -1
90 lines not on this page · raw message
Signature · 1 line
2.21.0
PATCH v4 21/22 ethtool: provide message level in GET_SETTINGS request
In reply to Michal KubecekAdd information about supported and enabled message levels to the GET_SETTINGS reply when ETH_SETTINGS_IM_DEBUG flag is set in the request.
Unlike in the ioctl interface, "message level" is called "message mask" as it is in fact interpreted as a bit mask. It is put into a nested attribute ETHA_SETTINGS_DEBUG to allow future extensions (e.g. an actual verbosity level).
Send notification in the same format as reply when message level is modified using the ioctl interface (ETHTOOL_SMSGLVL command).
--- Documentation/networking/ethtool-netlink.txt | 9 ++++- include/linux/netdevice.h | 2 + include/uapi/linux/ethtool_netlink.h | 13 ++++++- net/ethtool/ioctl.c | 3 ++ net/ethtool/settings.c | 40 ++++++++++++++++++++ 5 files changed, 65 insertions(+), 2 deletions(-)
Documentation/networking/ethtool-netlink.txt +8 -1
@@ -279,6 +279,7 @@ Info mask bits meaning: ETH_SETTINGS_IM_LINKMODES link modes and related ETH_SETTINGS_IM_LINKSTATE link state ETH_SETTINGS_IM_WOL struct ethtool_wolinfo + ETH_SETTINGS_IM_DEBUG debugging Response contents:
@@ -300,6 +301,8 @@ Response contents: ETHA_SETTINGS_WOL (nested) wake on LAN settings ETHA_WOL_MODES (bitfield32) wake on LAN modes ETHA_WOL_SOPASS (binary) SecureOn(tm) password + ETHA_SETTINGS_DEBUG (nested) debugging + ETHA_DEBUG_MSG_MASK (bitfield32) debug message mask Most of the attributes and their values have the same meaning as matching members of the corresponding ioctl structures. For ETHA_LINKMODES_OURS,
@@ -309,6 +312,10 @@ ETHA_LINKMODES_PEER in the reply is a bit list. For ETHA_WOL_MODES, selector reports wake on LAN modes supported by the device and value enabled modes. +ETHA_DEBUG_MSG_MASK corresponds to message level (which is actually a bitfield) +as reported by ETHTOOL_GMSGLVL. The selector reports all message types +recognized by kernel and value types enabled for the device. + GET_SETTINGS request is allowed for unprivileged user but ETHA_WOL_SOPASS is only provided by kernel in response to privileged (netns CAP_NET_ADMIN) requests.
@@ -371,7 +378,7 @@ ETHTOOL_GDRVINFO ETHNL_CMD_GET_INFO ETHTOOL_GREGS n/a ETHTOOL_GWOL ETHNL_CMD_GET_SETTINGS ETHTOOL_SWOL ETHNL_CMD_SET_SETTINGS -ETHTOOL_GMSGLVL n/a +ETHTOOL_GMSGLVL ETHNL_CMD_GET_SETTINGS ETHTOOL_SMSGLVL n/a ETHTOOL_NWAY_RST n/a ETHTOOL_GLINK ETHNL_CMD_GET_SETTINGS
include/linux/netdevice.h +2 -0
@@ -3859,6 +3859,8 @@ enum {NETIF_MSG_PKTDATA =0x1000 ,NETIF_MSG_HW =0x2000 ,NETIF_MSG_WOL =0x4000 , + + NETIF_MSG_ALL = 0x7fff, };#define netif_msg_drv (p) ((p)->msg_enable & NETIF_MSG_DRV)
include/uapi/linux/ethtool_netlink.h +12 -1
@@ -198,6 +198,7 @@ enum {ETHA_SETTINGS_LINK_MODES ,/* nest - ETHA_LINKMODES_* */ ETHA_SETTINGS_LINK_STATE ,/* nest - ETHA_LINKSTATE_* */ ETHA_SETTINGS_WOL ,/* nest - ETHA_WOL_* */ +ETHA_SETTINGS_DEBUG ,/* nest - ETHA_DEBUG_* */ __ETHA_SETTINGS_CNT,ETHA_SETTINGS_MAX = (__ETHA_SETTINGS_CNT -1 )
@@ -207,11 +208,13 @@ enum {#define ETH_SETTINGS_IM_LINKMODES (1U << 1)#define ETH_SETTINGS_IM_LINKSTATE (1U << 2)#define ETH_SETTINGS_IM_WOL (1U << 3) +#define ETH_SETTINGS_IM_DEBUG (1U << 4)#define ETH_SETTINGS_IM_ALL (ETH_SETTINGS_IM_LINKINFO | \ ETH_SETTINGS_IM_LINKMODES | \ ETH_SETTINGS_IM_LINKSTATE | \ - ETH_SETTINGS_IM_WOL) + ETH_SETTINGS_IM_WOL | \ + ETH_SETTINGS_IM_DEBUG)enum {ETHA_LINKINFO_UNSPEC ,
@@ -254,6 +257,14 @@ enum { ETHA_WOL_MAX = (__ETHA_WOL_CNT - 1) }; +enum { +ETHA_DEBUG_UNSPEC , +ETHA_DEBUG_MSG_MASK ,/* bitfield32 */ + + __ETHA_DEBUG_CNT, +ETHA_DEBUG_MAX = (__ETHA_DEBUG_CNT -1 ) +}; +/* generic netlink info */ #define ETHTOOL_GENL_NAME "ethtool"#define ETHTOOL_GENL_VERSION 1
net/ethtool/ioctl.c +3 -0
@@ -2464,6 +2464,9 @@ int dev_ethtool(struct net *net, struct ifreq *ifr)case ETHTOOL_SMSGLVL : rc =ethtool_set_value_void (dev, useraddr, dev->ethtool_ops->set_msglevel); +if (rc >=0 ) +ethtool_notify (dev,NULL ,ETHNL_CMD_SET_SETTINGS , +ETH_SETTINGS_IM_DEBUG ,NULL );break ;case ETHTOOL_GEEE : rc =ethtool_get_eee (dev, useraddr);
net/ethtool/settings.c +40 -0
@@ -14,6 +14,7 @@ struct settings_data {struct ethtool_wolinfo wolinfo;struct ethtool_link_settings *lsettings;int link; +u32 msglevel;bool lpm_empty; };
@@ -123,6 +124,7 @@ static const struct nla_policy get_settings_policy[ETHA_SETTINGS_MAX + 1] = { [ETHA_SETTINGS_LINK_MODES] = { .type = NLA_REJECT }, [ETHA_SETTINGS_LINK_STATE] = { .type = NLA_REJECT }, [ETHA_SETTINGS_WOL] = { .type = NLA_REJECT }, + [ETHA_SETTINGS_DEBUG] = { .type = NLA_REJECT }, }; static int parse_settings(struct common_req_info *req_info,
@@ -188,6 +190,7 @@ static int prepare_settings(struct common_req_info *req_info,struct settings_data *data = container_of(req_info, struct settings_data, reqinfo_base);struct net_device *dev = data->repdata_base.dev; +const struct ethtool_ops *eops = dev->ethtool_ops;u32 req_mask = req_info->req_mask;int ret;
@@ -222,6 +225,12 @@ static int prepare_settings(struct common_req_info *req_info,if (ret <0 ) req_mask &= ~ETH_SETTINGS_IM_WOL ; } +if (req_mask Ð_SETTINGS_IM_DEBUG ) { +if (eops->get_msglevel) + data->msglevel = eops->get_msglevel (dev); +else + req_mask &= ~ETH_SETTINGS_IM_DEBUG ; + }ethnl_after_ops (dev); data->repdata_base.info_mask = req_mask;
@@ -283,6 +292,11 @@ static int wol_size(void) nla_total_size(SOPASS_MAX)); } +static int debug_size (void ) +{ +return nla_total_size (nla_total_size (sizeof (struct nla_bitfield32 ))); +} +/* To keep things simple, reserve space for some attributes which may not * be added to the message (e.g. ETHA_SETTINGS_SOPASS); therefore the length * returned may be bigger than the actual length of the message sent
@@ -308,6 +322,8 @@ static int settings_size(const struct common_req_info *req_info) len +=link_state_size (data->link);if (info_mask Ð_SETTINGS_IM_WOL ) len +=wol_size (); +if (info_mask Ð_SETTINGS_IM_DEBUG ) + len +=debug_size ();return len; }
@@ -424,6 +440,24 @@ static int fill_wolinfo(struct sk_buff *skb,return -EMSGSIZE ; } +static int fill_debug (struct sk_buff *skb,u32 msglevel) +{ +struct nlattr *nest; + + nest =ethnl_nest_start (skb,ETHA_SETTINGS_DEBUG ); +if (!nest) +return -EMSGSIZE ; +if (nla_put_bitfield32 (skb,ETHA_DEBUG_MSG_MASK , msglevel, +NETIF_MSG_ALL )) + goto err; +nla_nest_end (skb, nest); +return 0 ; + +err: +nla_nest_cancel (skb, nest); +return -EMSGSIZE ; +} +static int fill_settings (struct sk_buff *skb,const struct common_req_info *req_info) {
@@ -454,6 +488,11 @@ static int fill_settings(struct sk_buff *skb,if (ret <0 )return ret; } +if (info_mask Ð_SETTINGS_IM_DEBUG ) { + ret =fill_debug (skb, data->msglevel); +if (ret <0 ) +return ret; + }return 0 ; }
@@ -508,6 +547,7 @@ static const struct nla_policy set_settings_policy[ETHA_SETTINGS_MAX + 1] = { [ETHA_SETTINGS_LINK_MODES] = { .type = NLA_NESTED }, [ETHA_SETTINGS_LINK_STATE] = { .type = NLA_REJECT }, [ETHA_SETTINGS_WOL] = { .type = NLA_NESTED }, + [ETHA_SETTINGS_DEBUG] = { .type = NLA_REJECT }, }; static int ethnl_set_link_ksettings(struct genl_info *info,
Signature · 1 line
2.21.0
PATCH v4 22/22 ethtool: set message level with SET_SETTINGS request
In reply to Michal KubecekAllow setting device message level using ETHA_SETTINGS_DEBUG nested attribute.
Unlike in ioctl interface "message level" is called "message mask" (as it is in fact used as a bit mask) and put inside a nested attribute to allow future extensions.
--- Documentation/networking/ethtool-netlink.txt | 8 +++- net/ethtool/settings.c | 45 +++++++++++++++++++- 2 files changed, 50 insertions(+), 3 deletions(-)
Documentation/networking/ethtool-netlink.txt +6 -2
@@ -345,6 +345,8 @@ to be passed with SET_SETTINGS request: ETHA_SETTINGS_WOL (nested) wake on LAN settings ETHA_WOL_MODES (bitfield32) wake on LAN modes ETHA_WOL_SOPASS (binary) SecureOn(tm) password + ETHA_SETTINGS_DEBUG (nested) debugging + ETHA_DEBUG_MSG_MASK (bitfield32) message mask ETHA_LINKMODES_OURS bit set allows setting advertised link modes. If autonegotiation is on (either set now or kept from before), advertised modes
@@ -360,7 +362,9 @@ selector are set to 0 or 1 according to value. To allow the semantics of the ioctl interface where the whole bitmap is set rather than only modified, selectors may have also bits not supported by device set and an error is only issued if any of them is also set in the value (i.e. if userspace tries to -enable mode not supported by device). +enable mode not supported by device). ETHA_SETTINGS_MSGLEVEL bitfield also +allows bits not recognized by kernel in selector as long as the request does +not attempt to enable them. Request translation
@@ -379,7 +383,7 @@ ETHTOOL_GREGS n/a ETHTOOL_GWOL ETHNL_CMD_GET_SETTINGS ETHTOOL_SWOL ETHNL_CMD_SET_SETTINGS ETHTOOL_GMSGLVL ETHNL_CMD_GET_SETTINGS -ETHTOOL_SMSGLVL n/a +ETHTOOL_SMSGLVL ETHNL_CMD_SET_SETTINGS ETHTOOL_NWAY_RST n/a ETHTOOL_GLINK ETHNL_CMD_GET_SETTINGS ETHTOOL_GEEPROM n/a
net/ethtool/settings.c +44 -1
69 lines not on this page · raw message
Signature · 1 line
2.21.0