mirror of
https://github.com/torvalds/linux.git
synced 2026-06-04 20:46:48 +02:00
d7ee96234b
Add required=True to the monitor subcommand arguments for class, spec, and monitor_type in rvgen. These arguments are essential for monitor generation and attempting to run without them would cause AttributeError exceptions later in the code when the script tries to access them. Making these arguments explicitly required provides clearer error messages to users at parse time rather than cryptic exceptions during execution. This improves the user experience by catching missing arguments early with helpful usage information. Signed-off-by: Wander Lairson Costa <wander@redhat.com> Reviewed-by: Gabriele Monaco <gmonaco@redhat.com> Reviewed-by: Nam Cao <namcao@linutronix.de> Link: https://lore.kernel.org/r/20260223162407.147003-15-wander@redhat.com Signed-off-by: Gabriele Monaco <gmonaco@redhat.com>
71 lines
3.1 KiB
Python
71 lines
3.1 KiB
Python
#!/usr/bin/env python3
|
|
# SPDX-License-Identifier: GPL-2.0-only
|
|
#
|
|
# Copyright (C) 2019-2022 Red Hat, Inc. Daniel Bristot de Oliveira <bristot@kernel.org>
|
|
#
|
|
# dot2k: transform dot files into a monitor for the Linux kernel.
|
|
#
|
|
# For further information, see:
|
|
# Documentation/trace/rv/da_monitor_synthesis.rst
|
|
|
|
if __name__ == '__main__':
|
|
from rvgen.dot2k import da2k, ha2k
|
|
from rvgen.generator import Monitor
|
|
from rvgen.container import Container
|
|
from rvgen.ltl2k import ltl2k
|
|
from rvgen.automata import AutomataError
|
|
import argparse
|
|
import sys
|
|
|
|
parser = argparse.ArgumentParser(description='Generate kernel rv monitor')
|
|
parser.add_argument("-D", "--description", dest="description", required=False)
|
|
parser.add_argument("-a", "--auto_patch", dest="auto_patch",
|
|
action="store_true", required=False,
|
|
help="Patch the kernel in place")
|
|
|
|
subparsers = parser.add_subparsers(dest="subcmd", required=True)
|
|
|
|
monitor_parser = subparsers.add_parser("monitor")
|
|
monitor_parser.add_argument('-n', "--model_name", dest="model_name")
|
|
monitor_parser.add_argument("-p", "--parent", dest="parent",
|
|
required=False, help="Create a monitor nested to parent")
|
|
monitor_parser.add_argument('-c', "--class", dest="monitor_class", required=True,
|
|
help="Monitor class, either \"da\", \"ha\" or \"ltl\"")
|
|
monitor_parser.add_argument('-s', "--spec", dest="spec", required=True,
|
|
help="Monitor specification file")
|
|
monitor_parser.add_argument('-t', "--monitor_type", dest="monitor_type", required=True,
|
|
help=f"Available options: {', '.join(Monitor.monitor_types.keys())}")
|
|
|
|
container_parser = subparsers.add_parser("container")
|
|
container_parser.add_argument('-n', "--model_name", dest="model_name", required=True)
|
|
|
|
params = parser.parse_args()
|
|
|
|
try:
|
|
if params.subcmd == "monitor":
|
|
print(f"Opening and parsing the specification file {params.spec}")
|
|
if params.monitor_class == "da":
|
|
monitor = da2k(params.spec, params.monitor_type, vars(params))
|
|
elif params.monitor_class == "ha":
|
|
monitor = ha2k(params.spec, params.monitor_type, vars(params))
|
|
elif params.monitor_class == "ltl":
|
|
monitor = ltl2k(params.spec, params.monitor_type, vars(params))
|
|
else:
|
|
print("Unknown monitor class:", params.monitor_class)
|
|
sys.exit(1)
|
|
else:
|
|
monitor = Container(vars(params))
|
|
except AutomataError as e:
|
|
print(f"There was an error processing {params.spec}: {e}", file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
print(f"Writing the monitor into the directory {monitor.name}")
|
|
monitor.print_files()
|
|
print("Almost done, checklist")
|
|
if params.subcmd == "monitor":
|
|
print(f" - Edit the {monitor.name}/{monitor.name}.c to add the instrumentation")
|
|
print(monitor.fill_tracepoint_tooltip())
|
|
print(monitor.fill_makefile_tooltip())
|
|
print(monitor.fill_kconfig_tooltip())
|
|
print(monitor.fill_monitor_tooltip())
|