From: Jakub Kicinski <kuba@kernel.org>
To: netdev@vger.kernel.org, davem@davemloft.net, edumazet@google.com,
pabeni@redhat.com
Cc: sdf@google.com, jacob.e.keller@intel.com, vadfed@fb.com,
johannes@sipsolutions.net, jiri@resnulli.us, dsahern@kernel.org,
stephen@networkplumber.org, fw@strlen.de,
linux-doc@vger.kernel.org, Jakub Kicinski <kuba@kernel.org>
Subject: [RFC net-next 4/4] ynl: add a sample user for ethtool
Date: Wed, 10 Aug 2022 19:23:04 -0700 [thread overview]
Message-ID: <20220811022304.583300-5-kuba@kernel.org> (raw)
In-Reply-To: <20220811022304.583300-1-kuba@kernel.org>
A sample schema describing ethtool channels and a script showing
that it works. The script is called like this:
./tools/net/ynl/samples/ethtool.py \
--spec Documentation/netlink/bindings/ethtool.yaml \
--device eth0
I have schemas for genetlink, FOU and the proposed DPLL subsystem,
to validate that the concept has wide applicability, but ethtool
feels like the best demo of the 4.
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
Documentation/netlink/bindings/ethtool.yaml | 115 ++++++++++++++++++++
tools/net/ynl/samples/ethtool.py | 30 +++++
2 files changed, 145 insertions(+)
create mode 100644 Documentation/netlink/bindings/ethtool.yaml
create mode 100755 tools/net/ynl/samples/ethtool.py
diff --git a/Documentation/netlink/bindings/ethtool.yaml b/Documentation/netlink/bindings/ethtool.yaml
new file mode 100644
index 000000000000..b4540d60b4b3
--- /dev/null
+++ b/Documentation/netlink/bindings/ethtool.yaml
@@ -0,0 +1,115 @@
+# SPDX-License-Identifier: BSD-3-Clause
+
+name: ethtool
+
+description: |
+ Ethernet device configuration interface.
+
+attr-cnt-suffix: CNT
+
+attribute-spaces:
+ -
+ name: header
+ name-prefix: ETHTOOL_A_HEADER_
+ attributes:
+ -
+ name: dev_index
+ val: 1
+ type: u32
+ -
+ name: dev_name
+ type: nul-string
+ len: ALTIFNAMSIZ - 1
+ -
+ name: flags
+ type: u32
+ -
+ name: channels
+ name-prefix: ETHTOOL_A_CHANNELS_
+ attributes:
+ -
+ name: header
+ val: 1
+ type: nest
+ nested-attributes: header
+ -
+ name: rx_max
+ type: u32
+ -
+ name: tx_max
+ type: u32
+ -
+ name: other_max
+ type: u32
+ -
+ name: combined_max
+ type: u32
+ -
+ name: rx_count
+ type: u32
+ -
+ name: tx_count
+ type: u32
+ -
+ name: other_count
+ type: u32
+ -
+ name: combined_count
+ type: u32
+
+headers:
+ user: linux/if.h
+ uapi: linux/ethtool_netlink.h
+
+operations:
+ name-prefix: ETHTOOL_MSG_
+ async-prefix: ETHTOOL_MSG_
+ list:
+ -
+ name: channels_get
+ val: 17
+ description: Get current and max supported number of channels.
+ attribute-space: channels
+ do:
+ request:
+ attributes:
+ - header
+ reply: &channel_reply
+ attributes:
+ - header
+ - rx_max
+ - tx_max
+ - other_max
+ - combined_max
+ - rx_count
+ - tx_count
+ - other_count
+ - combined_count
+ dump:
+ reply: *channel_reply
+
+ -
+ name: channels_ntf
+ description: Notification for device changing its number of channels.
+ notify: channels_get
+ mcgrp: monitor
+
+ -
+ name: channels_set
+ description: Set number of channels.
+ attribute-space: channels
+ do:
+ request:
+ attributes:
+ - header
+ - rx_count
+ - tx_count
+ - other_count
+ - combined_count
+
+mcast-groups:
+ name-prefix: ETHTOOL_MCGRP_
+ name-suffix: _NAME
+ list:
+ -
+ name: monitor
diff --git a/tools/net/ynl/samples/ethtool.py b/tools/net/ynl/samples/ethtool.py
new file mode 100755
index 000000000000..63c8e29f8e5d
--- /dev/null
+++ b/tools/net/ynl/samples/ethtool.py
@@ -0,0 +1,30 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: BSD-3-Clause
+
+import argparse
+
+from ynl import YnlFamily
+
+
+def main():
+ parser = argparse.ArgumentParser(description='YNL ethtool sample')
+ parser.add_argument('--spec', dest='spec', type=str, required=True)
+ parser.add_argument('--schema', dest='schema', type=str)
+ parser.add_argument('--device', dest='dev_name', type=str)
+ parser.add_argument('--ifindex', dest='ifindex', type=str)
+ args = parser.parse_args()
+
+ ynl = YnlFamily(args.spec)
+
+ if args.dev_name:
+ channels = ynl.channels_get({'header': {'dev_name': args.dev_name}})
+ elif args.ifindex:
+ channels = ynl.channels_get({'header': {'dev_index': args.ifindex}})
+ else:
+ return
+ print('Netlink responded with:')
+ print(channels)
+
+
+if __name__ == "__main__":
+ main()
--
2.37.1
next prev parent reply other threads:[~2022-08-11 2:23 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-11 2:23 [RFC net-next 0/4] ynl: YAML netlink protocol descriptions Jakub Kicinski
2022-08-11 2:23 ` [RFC net-next 1/4] ynl: add intro docs for the concept Jakub Kicinski
2022-08-11 20:17 ` Edward Cree
2022-08-12 22:23 ` Jakub Kicinski
2022-08-15 20:09 ` Johannes Berg
2022-08-16 0:32 ` Jakub Kicinski
2022-08-16 7:07 ` Johannes Berg
2022-08-11 2:23 ` [RFC net-next 2/4] ynl: add the schema for the schemas Jakub Kicinski
2022-08-15 20:03 ` Johannes Berg
2022-08-15 20:09 ` Johannes Berg
2022-08-16 0:47 ` Jakub Kicinski
2022-08-16 7:21 ` Johannes Berg
2022-08-16 15:53 ` Jakub Kicinski
2022-08-16 19:30 ` Johannes Berg
2022-09-26 16:10 ` Rob Herring
2022-09-27 21:56 ` Jakub Kicinski
2022-09-28 12:32 ` Rob Herring
2022-08-11 2:23 ` [RFC net-next 3/4] ynl: add a sample python library Jakub Kicinski
2022-08-11 5:48 ` Benjamin Poirier
2022-08-11 15:50 ` Jakub Kicinski
2022-08-11 20:09 ` Stephen Hemminger
2022-08-12 22:53 ` Jakub Kicinski
2022-08-15 20:00 ` Johannes Berg
2022-08-12 1:04 ` Stephen Hemminger
2022-08-12 15:42 ` Edward Cree
2022-08-12 23:07 ` Jakub Kicinski
2022-08-18 21:26 ` Keller, Jacob E
2022-08-11 2:23 ` Jakub Kicinski [this message]
2022-08-11 16:18 ` [RFC net-next 4/4] ynl: add a sample user for ethtool sdf
2022-08-11 19:35 ` Jakub Kicinski
2022-08-11 22:55 ` Stanislav Fomichev
2022-08-11 23:31 ` Jakub Kicinski
2022-08-12 16:26 ` Stanislav Fomichev
2022-08-12 22:48 ` Jakub Kicinski
2022-08-14 12:27 ` Ido Schimmel
2022-08-11 4:15 ` [RFC net-next 0/4] ynl: YAML netlink protocol descriptions Stephen Hemminger
2022-08-11 4:47 ` Jakub Kicinski
2022-08-11 15:01 ` Stephen Hemminger
2022-08-11 15:34 ` Jakub Kicinski
2022-08-11 16:28 ` sdf
2022-08-11 19:42 ` Jakub Kicinski
2022-08-12 17:00 ` Florian Fainelli
2022-08-12 22:26 ` Jakub Kicinski
2022-08-19 19:56 ` Jakub Kicinski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220811022304.583300-5-kuba@kernel.org \
--to=kuba@kernel.org \
--cc=davem@davemloft.net \
--cc=dsahern@kernel.org \
--cc=edumazet@google.com \
--cc=fw@strlen.de \
--cc=jacob.e.keller@intel.com \
--cc=jiri@resnulli.us \
--cc=johannes@sipsolutions.net \
--cc=linux-doc@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=sdf@google.com \
--cc=stephen@networkplumber.org \
--cc=vadfed@fb.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).