2023-01-31 10:33:54 +08:00
|
|
|
#!/usr/bin/env python3
|
2023-03-07 04:04:57 +08:00
|
|
|
# SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
|
2023-01-21 01:50:41 +08:00
|
|
|
|
|
|
|
import argparse
|
|
|
|
import json
|
|
|
|
import pprint
|
|
|
|
import time
|
|
|
|
|
2023-08-25 20:27:52 +08:00
|
|
|
from lib import YnlFamily, Netlink
|
2023-01-21 01:50:41 +08:00
|
|
|
|
|
|
|
|
2024-01-30 06:34:46 +08:00
|
|
|
class YnlEncoder(json.JSONEncoder):
|
|
|
|
def default(self, obj):
|
|
|
|
if isinstance(obj, bytes):
|
|
|
|
return bytes.hex(obj)
|
|
|
|
if isinstance(obj, set):
|
|
|
|
return list(obj)
|
|
|
|
return json.JSONEncoder.default(self, obj)
|
|
|
|
|
|
|
|
|
2023-01-21 01:50:41 +08:00
|
|
|
def main():
|
|
|
|
parser = argparse.ArgumentParser(description='YNL CLI sample')
|
|
|
|
parser.add_argument('--spec', dest='spec', type=str, required=True)
|
|
|
|
parser.add_argument('--schema', dest='schema', type=str)
|
2023-01-31 10:33:50 +08:00
|
|
|
parser.add_argument('--no-schema', action='store_true')
|
2023-01-21 01:50:41 +08:00
|
|
|
parser.add_argument('--json', dest='json_text', type=str)
|
|
|
|
parser.add_argument('--do', dest='do', type=str)
|
|
|
|
parser.add_argument('--dump', dest='dump', type=str)
|
|
|
|
parser.add_argument('--sleep', dest='sleep', type=int)
|
|
|
|
parser.add_argument('--subscribe', dest='ntf', type=str)
|
2023-08-25 20:27:52 +08:00
|
|
|
parser.add_argument('--replace', dest='flags', action='append_const',
|
|
|
|
const=Netlink.NLM_F_REPLACE)
|
|
|
|
parser.add_argument('--excl', dest='flags', action='append_const',
|
|
|
|
const=Netlink.NLM_F_EXCL)
|
|
|
|
parser.add_argument('--create', dest='flags', action='append_const',
|
|
|
|
const=Netlink.NLM_F_CREATE)
|
|
|
|
parser.add_argument('--append', dest='flags', action='append_const',
|
|
|
|
const=Netlink.NLM_F_APPEND)
|
tools: ynl: introduce option to process unknown attributes or types
In case the kernel sends message back containing attribute not defined
in family spec, following exception is raised to the user:
$ sudo ./tools/net/ynl/cli.py --spec Documentation/netlink/specs/devlink.yaml --do trap-get --json '{"bus-name": "netdevsim", "dev-name": "netdevsim1", "trap-name": "source_mac_is_multicast"}'
Traceback (most recent call last):
File "/home/jiri/work/linux/tools/net/ynl/lib/ynl.py", line 521, in _decode
attr_spec = attr_space.attrs_by_val[attr.type]
~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^
KeyError: 132
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "/home/jiri/work/linux/./tools/net/ynl/cli.py", line 61, in <module>
main()
File "/home/jiri/work/linux/./tools/net/ynl/cli.py", line 49, in main
reply = ynl.do(args.do, attrs, args.flags)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jiri/work/linux/tools/net/ynl/lib/ynl.py", line 731, in do
return self._op(method, vals, flags)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jiri/work/linux/tools/net/ynl/lib/ynl.py", line 719, in _op
rsp_msg = self._decode(decoded.raw_attrs, op.attr_set.name)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jiri/work/linux/tools/net/ynl/lib/ynl.py", line 525, in _decode
raise Exception(f"Space '{space}' has no attribute with value '{attr.type}'")
Exception: Space 'devlink' has no attribute with value '132'
Introduce a command line option "process-unknown" and pass it down to
YnlFamily class constructor to allow user to process unknown
attributes and types and print them as binaries.
$ sudo ./tools/net/ynl/cli.py --spec Documentation/netlink/specs/devlink.yaml --do trap-get --json '{"bus-name": "netdevsim", "dev-name": "netdevsim1", "trap-name": "source_mac_is_multicast"}' --process-unknown
{'UnknownAttr(129)': {'UnknownAttr(0)': b'\x00\x00\x00\x00\x00\x00\x00\x00',
'UnknownAttr(1)': b'\x00\x00\x00\x00\x00\x00\x00\x00',
'UnknownAttr(2)': b'\x0e\x00\x00\x00\x00\x00\x00\x00'},
'UnknownAttr(132)': b'\x00',
'UnknownAttr(133)': b'',
'UnknownAttr(134)': {'UnknownAttr(0)': b''},
'bus-name': 'netdevsim',
'dev-name': 'netdevsim1',
'trap-action': 'drop',
'trap-group-name': 'l2_drops',
'trap-name': 'source_mac_is_multicast'}
Signed-off-by: Jiri Pirko <jiri@nvidia.com>
Link: https://lore.kernel.org/r/20231027092525.956172-1-jiri@resnulli.us
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
2023-10-27 17:25:25 +08:00
|
|
|
parser.add_argument('--process-unknown', action=argparse.BooleanOptionalAction)
|
2024-01-30 06:34:46 +08:00
|
|
|
parser.add_argument('--output-json', action='store_true')
|
2023-01-21 01:50:41 +08:00
|
|
|
args = parser.parse_args()
|
|
|
|
|
2024-01-30 06:34:46 +08:00
|
|
|
def output(msg):
|
|
|
|
if args.output_json:
|
|
|
|
print(json.dumps(msg, cls=YnlEncoder))
|
|
|
|
else:
|
|
|
|
pprint.PrettyPrinter().pprint(msg)
|
|
|
|
|
2023-01-31 10:33:50 +08:00
|
|
|
if args.no_schema:
|
|
|
|
args.schema = ''
|
|
|
|
|
2023-01-21 01:50:41 +08:00
|
|
|
attrs = {}
|
|
|
|
if args.json_text:
|
|
|
|
attrs = json.loads(args.json_text)
|
|
|
|
|
tools: ynl: introduce option to process unknown attributes or types
In case the kernel sends message back containing attribute not defined
in family spec, following exception is raised to the user:
$ sudo ./tools/net/ynl/cli.py --spec Documentation/netlink/specs/devlink.yaml --do trap-get --json '{"bus-name": "netdevsim", "dev-name": "netdevsim1", "trap-name": "source_mac_is_multicast"}'
Traceback (most recent call last):
File "/home/jiri/work/linux/tools/net/ynl/lib/ynl.py", line 521, in _decode
attr_spec = attr_space.attrs_by_val[attr.type]
~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^
KeyError: 132
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "/home/jiri/work/linux/./tools/net/ynl/cli.py", line 61, in <module>
main()
File "/home/jiri/work/linux/./tools/net/ynl/cli.py", line 49, in main
reply = ynl.do(args.do, attrs, args.flags)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jiri/work/linux/tools/net/ynl/lib/ynl.py", line 731, in do
return self._op(method, vals, flags)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jiri/work/linux/tools/net/ynl/lib/ynl.py", line 719, in _op
rsp_msg = self._decode(decoded.raw_attrs, op.attr_set.name)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/jiri/work/linux/tools/net/ynl/lib/ynl.py", line 525, in _decode
raise Exception(f"Space '{space}' has no attribute with value '{attr.type}'")
Exception: Space 'devlink' has no attribute with value '132'
Introduce a command line option "process-unknown" and pass it down to
YnlFamily class constructor to allow user to process unknown
attributes and types and print them as binaries.
$ sudo ./tools/net/ynl/cli.py --spec Documentation/netlink/specs/devlink.yaml --do trap-get --json '{"bus-name": "netdevsim", "dev-name": "netdevsim1", "trap-name": "source_mac_is_multicast"}' --process-unknown
{'UnknownAttr(129)': {'UnknownAttr(0)': b'\x00\x00\x00\x00\x00\x00\x00\x00',
'UnknownAttr(1)': b'\x00\x00\x00\x00\x00\x00\x00\x00',
'UnknownAttr(2)': b'\x0e\x00\x00\x00\x00\x00\x00\x00'},
'UnknownAttr(132)': b'\x00',
'UnknownAttr(133)': b'',
'UnknownAttr(134)': {'UnknownAttr(0)': b''},
'bus-name': 'netdevsim',
'dev-name': 'netdevsim1',
'trap-action': 'drop',
'trap-group-name': 'l2_drops',
'trap-name': 'source_mac_is_multicast'}
Signed-off-by: Jiri Pirko <jiri@nvidia.com>
Link: https://lore.kernel.org/r/20231027092525.956172-1-jiri@resnulli.us
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
2023-10-27 17:25:25 +08:00
|
|
|
ynl = YnlFamily(args.spec, args.schema, args.process_unknown)
|
2023-01-21 01:50:41 +08:00
|
|
|
|
|
|
|
if args.ntf:
|
|
|
|
ynl.ntf_subscribe(args.ntf)
|
|
|
|
|
|
|
|
if args.sleep:
|
|
|
|
time.sleep(args.sleep)
|
|
|
|
|
2023-01-31 10:33:49 +08:00
|
|
|
if args.do:
|
2023-08-25 20:27:52 +08:00
|
|
|
reply = ynl.do(args.do, attrs, args.flags)
|
2024-01-30 06:34:46 +08:00
|
|
|
output(reply)
|
2023-01-31 10:33:49 +08:00
|
|
|
if args.dump:
|
|
|
|
reply = ynl.dump(args.dump, attrs)
|
2024-01-30 06:34:46 +08:00
|
|
|
output(reply)
|
2023-01-21 01:50:41 +08:00
|
|
|
|
|
|
|
if args.ntf:
|
|
|
|
ynl.check_ntf()
|
2024-01-30 06:34:46 +08:00
|
|
|
output(ynl.async_msg_queue)
|
2023-01-21 01:50:41 +08:00
|
|
|
|
|
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
main()
|