| Message ID | 844bf6bf518640fbfc67b5dd7976d9e8683c2d2d.1580075977.git.mkubecek@suse.cz |
|---|---|
| State | Accepted |
| Delegated to: | David Miller |
| Headers | show |
| Series | ethtool netlink interface, part 2 | expand |
On Sun, Jan 26, 2020 at 11:11:07PM +0100, Michal Kubecek wrote: > Implement DEBUG_SET netlink request to set debugging settings for a device. > At the moment, only message mask corresponding to message level as set by > ETHTOOL_SMSGLVL ioctl request can be set. (It is called message level in > ioctl interface but almost all drivers interpret it as a bit mask.) > > Signed-off-by: Michal Kubecek <mkubecek@suse.cz> > +int ethnl_set_debug(struct sk_buff *skb, struct genl_info *info) > +{ > + struct nlattr *tb[ETHTOOL_A_DEBUG_MAX + 1]; > + struct ethnl_req_info req_info = {}; > + struct net_device *dev; > + bool mod = false; > + u32 msg_mask; > + int ret; > + > + ret = nlmsg_parse(info->nlhdr, GENL_HDRLEN, tb, > + ETHTOOL_A_DEBUG_MAX, debug_set_policy, > + info->extack); > + if (ret < 0) > + return ret; > + ret = ethnl_parse_header(&req_info, tb[ETHTOOL_A_DEBUG_HEADER], > + genl_info_net(info), info->extack, true); > + if (ret < 0) > + return ret; > + dev = req_info.dev; > + if (!dev->ethtool_ops->get_msglevel || !dev->ethtool_ops->set_msglevel) > + return -EOPNOTSUPP; This seems like a new requirement, that both get and set callbacks are implemented. However, A quick look thought the code suggests all drivers already do have both get and set. So i think this is safe. Reviewed-by: Andrew Lunn <andrew@lunn.ch> Andrew
> + ret = ethnl_parse_header(&req_info, tb[ETHTOOL_A_DEBUG_HEADER], > + genl_info_net(info), info->extack, true); > + dev_put(dev); Hi Michal While reviewing this patch i noticed this dev_put() and wondered where the dev_get() was. It is hiding inside ethnl_parse_header(). The documentation does make it clear it takes a reference on the device, but how many people read the documentation? I would not be too surprised if at some point in the future we have bugs from missing dev_put(). Could we make this a bit more explicit by calling it ethnl_parse_header_dev_get(). It is rather long though. Andrew
On Mon, Jan 27, 2020 at 01:22:06AM +0100, Andrew Lunn wrote: > On Sun, Jan 26, 2020 at 11:11:07PM +0100, Michal Kubecek wrote: > > Implement DEBUG_SET netlink request to set debugging settings for a device. > > At the moment, only message mask corresponding to message level as set by > > ETHTOOL_SMSGLVL ioctl request can be set. (It is called message level in > > ioctl interface but almost all drivers interpret it as a bit mask.) > > > > Signed-off-by: Michal Kubecek <mkubecek@suse.cz> > > +int ethnl_set_debug(struct sk_buff *skb, struct genl_info *info) > > +{ > > + struct nlattr *tb[ETHTOOL_A_DEBUG_MAX + 1]; > > + struct ethnl_req_info req_info = {}; > > + struct net_device *dev; > > + bool mod = false; > > + u32 msg_mask; > > + int ret; > > + > > + ret = nlmsg_parse(info->nlhdr, GENL_HDRLEN, tb, > > + ETHTOOL_A_DEBUG_MAX, debug_set_policy, > > + info->extack); > > + if (ret < 0) > > + return ret; > > + ret = ethnl_parse_header(&req_info, tb[ETHTOOL_A_DEBUG_HEADER], > > + genl_info_net(info), info->extack, true); > > + if (ret < 0) > > + return ret; > > + dev = req_info.dev; > > + if (!dev->ethtool_ops->get_msglevel || !dev->ethtool_ops->set_msglevel) > > + return -EOPNOTSUPP; > > This seems like a new requirement, that both get and set callbacks are > implemented. However, A quick look thought the code suggests all > drivers already do have both get and set. So i think this is safe. Technically it's a new requirement but as ethtool (userspace utility) always issues ETHTOOL_GMSGLVL before ETHTOOL_SMSGLVL and does so even for command lines like "ethtool -s eth0 msglvl 5" where it's not really needed, providing ->set_msglevel() without ->get_msglevel() wouldn't be of much use even now. Michal > > Reviewed-by: Andrew Lunn <andrew@lunn.ch> > > Andrew
On Mon, Jan 27, 2020 at 02:04:22AM +0100, Andrew Lunn wrote: > > + ret = ethnl_parse_header(&req_info, tb[ETHTOOL_A_DEBUG_HEADER], > > + genl_info_net(info), info->extack, true); > > > + dev_put(dev); > > Hi Michal > > While reviewing this patch i noticed this dev_put() and wondered where > the dev_get() was. It is hiding inside ethnl_parse_header(). The > documentation does make it clear it takes a reference on the device, > but how many people read the documentation? I would not be too > surprised if at some point in the future we have bugs from missing > dev_put(). > > Could we make this a bit more explicit by calling it > ethnl_parse_header_dev_get(). It is rather long though. Good point, I'll think about the name some more and send a cleanup patch when net-next reopens. Michal
diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst index 76a411d3102d..58473c05319f 100644 --- a/Documentation/networking/ethtool-netlink.rst +++ b/Documentation/networking/ethtool-netlink.rst @@ -186,6 +186,7 @@ Userspace to kernel: ``ETHTOOL_MSG_LINKMODES_SET`` set link modes info ``ETHTOOL_MSG_LINKSTATE_GET`` get link state ``ETHTOOL_MSG_DEBUG_GET`` get debugging settings + ``ETHTOOL_MSG_DEBUG_SET`` set debugging settings ===================================== ================================ Kernel to userspace: @@ -455,6 +456,23 @@ interface follows its actual use in practice. devices supporting the request). +DEBUG_SET +========= + +Set or update debugging settings of a device. At the moment, only message mask +is supported. + +Request contents: + + ==================================== ====== ========================== + ``ETHTOOL_A_DEBUG_HEADER`` nested request header + ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask + ==================================== ====== ========================== + +``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of +enabled debugging message types for the device. + + Request translation =================== @@ -474,7 +492,7 @@ have their netlink replacement yet. ``ETHTOOL_GWOL`` n/a ``ETHTOOL_SWOL`` n/a ``ETHTOOL_GMSGLVL`` ``ETHTOOL_MSG_DEBUG_GET`` - ``ETHTOOL_SMSGLVL`` n/a + ``ETHTOOL_SMSGLVL`` ``ETHTOOL_MSG_DEBUG_SET`` ``ETHTOOL_NWAY_RST`` n/a ``ETHTOOL_GLINK`` ``ETHTOOL_MSG_LINKSTATE_GET`` ``ETHTOOL_GEEPROM`` n/a diff --git a/include/uapi/linux/ethtool_netlink.h b/include/uapi/linux/ethtool_netlink.h index 0d39e04567cb..8f0b6fd277d5 100644 --- a/include/uapi/linux/ethtool_netlink.h +++ b/include/uapi/linux/ethtool_netlink.h @@ -21,6 +21,7 @@ enum { ETHTOOL_MSG_LINKMODES_SET, ETHTOOL_MSG_LINKSTATE_GET, ETHTOOL_MSG_DEBUG_GET, + ETHTOOL_MSG_DEBUG_SET, /* add new constants above here */ __ETHTOOL_MSG_USER_CNT, diff --git a/net/ethtool/debug.c b/net/ethtool/debug.c index cc121a23be5f..6fc3ef8113c0 100644 --- a/net/ethtool/debug.c +++ b/net/ethtool/debug.c @@ -78,3 +78,56 @@ const struct ethnl_request_ops ethnl_debug_request_ops = { .reply_size = debug_reply_size, .fill_reply = debug_fill_reply, }; + +/* DEBUG_SET */ + +static const struct nla_policy +debug_set_policy[ETHTOOL_A_DEBUG_MAX + 1] = { + [ETHTOOL_A_DEBUG_UNSPEC] = { .type = NLA_REJECT }, + [ETHTOOL_A_DEBUG_HEADER] = { .type = NLA_NESTED }, + [ETHTOOL_A_DEBUG_MSGMASK] = { .type = NLA_NESTED }, +}; + +int ethnl_set_debug(struct sk_buff *skb, struct genl_info *info) +{ + struct nlattr *tb[ETHTOOL_A_DEBUG_MAX + 1]; + struct ethnl_req_info req_info = {}; + struct net_device *dev; + bool mod = false; + u32 msg_mask; + int ret; + + ret = nlmsg_parse(info->nlhdr, GENL_HDRLEN, tb, + ETHTOOL_A_DEBUG_MAX, debug_set_policy, + info->extack); + if (ret < 0) + return ret; + ret = ethnl_parse_header(&req_info, tb[ETHTOOL_A_DEBUG_HEADER], + genl_info_net(info), info->extack, true); + if (ret < 0) + return ret; + dev = req_info.dev; + if (!dev->ethtool_ops->get_msglevel || !dev->ethtool_ops->set_msglevel) + return -EOPNOTSUPP; + + rtnl_lock(); + ret = ethnl_ops_begin(dev); + if (ret < 0) + goto out_rtnl; + + msg_mask = dev->ethtool_ops->get_msglevel(dev); + ret = ethnl_update_bitset32(&msg_mask, NETIF_MSG_CLASS_COUNT, + tb[ETHTOOL_A_DEBUG_MSGMASK], + netif_msg_class_names, info->extack, &mod); + if (ret < 0 || !mod) + goto out_ops; + + dev->ethtool_ops->set_msglevel(dev, msg_mask); + +out_ops: + ethnl_ops_complete(dev); +out_rtnl: + rtnl_unlock(); + dev_put(dev); + return ret; +} diff --git a/net/ethtool/netlink.c b/net/ethtool/netlink.c index bdaf583e392b..bcdc42e0bd14 100644 --- a/net/ethtool/netlink.c +++ b/net/ethtool/netlink.c @@ -672,6 +672,11 @@ static const struct genl_ops ethtool_genl_ops[] = { .dumpit = ethnl_default_dumpit, .done = ethnl_default_done, }, + { + .cmd = ETHTOOL_MSG_DEBUG_SET, + .flags = GENL_UNS_ADMIN_PERM, + .doit = ethnl_set_debug, + }, }; static const struct genl_multicast_group ethtool_nl_mcgrps[] = { diff --git a/net/ethtool/netlink.h b/net/ethtool/netlink.h index 9bd8ef671501..772723e536e8 100644 --- a/net/ethtool/netlink.h +++ b/net/ethtool/netlink.h @@ -338,5 +338,6 @@ extern const struct ethnl_request_ops ethnl_debug_request_ops; int ethnl_set_linkinfo(struct sk_buff *skb, struct genl_info *info); int ethnl_set_linkmodes(struct sk_buff *skb, struct genl_info *info); +int ethnl_set_debug(struct sk_buff *skb, struct genl_info *info); #endif /* _NET_ETHTOOL_NETLINK_H */
Implement DEBUG_SET netlink request to set debugging settings for a device. At the moment, only message mask corresponding to message level as set by ETHTOOL_SMSGLVL ioctl request can be set. (It is called message level in ioctl interface but almost all drivers interpret it as a bit mask.) Signed-off-by: Michal Kubecek <mkubecek@suse.cz> --- Documentation/networking/ethtool-netlink.rst | 20 +++++++- include/uapi/linux/ethtool_netlink.h | 1 + net/ethtool/debug.c | 53 ++++++++++++++++++++ net/ethtool/netlink.c | 5 ++ net/ethtool/netlink.h | 1 + 5 files changed, 79 insertions(+), 1 deletion(-)