xref: /linux/tools/verification/rvgen/__main__.py (revision 4ff261e725d7376c12e745fdbe8a33cd6dbd5a83) 
1#!/usr/bin/env python3
2# SPDX-License-Identifier: GPL-2.0-only
3#
4# Copyright (C) 2019-2022 Red Hat, Inc. Daniel Bristot de Oliveira <bristot@kernel.org>
5#
6# dot2k: transform dot files into a monitor for the Linux kernel.
7#
8# For further information, see:
9#   Documentation/trace/rv/da_monitor_synthesis.rst
10
11if __name__ == '__main__':
12    from rvgen.dot2k import dot2k
13    from rvgen.generator import Monitor
14    from rvgen.container import Container
15    from rvgen.ltl2k import ltl2k
16    import argparse
17    import sys
18
19    parser = argparse.ArgumentParser(description='Generate kernel rv monitor')
20    parser.add_argument("-D", "--description", dest="description", required=False)
21    parser.add_argument("-a", "--auto_patch", dest="auto_patch",
22                        action="store_true", required=False,
23                        help="Patch the kernel in place")
24
25    subparsers = parser.add_subparsers(dest="subcmd", required=True)
26
27    monitor_parser = subparsers.add_parser("monitor")
28    monitor_parser.add_argument('-n', "--model_name", dest="model_name")
29    monitor_parser.add_argument("-p", "--parent", dest="parent",
30                                required=False, help="Create a monitor nested to parent")
31    monitor_parser.add_argument('-c', "--class", dest="monitor_class",
32                                help="Monitor class, either \"da\" or \"ltl\"")
33    monitor_parser.add_argument('-s', "--spec", dest="spec", help="Monitor specification file")
34    monitor_parser.add_argument('-t', "--monitor_type", dest="monitor_type",
35                                help=f"Available options: {', '.join(Monitor.monitor_types.keys())}")
36
37    container_parser = subparsers.add_parser("container")
38    container_parser.add_argument('-n', "--model_name", dest="model_name", required=True)
39
40    params = parser.parse_args()
41
42    try:
43        if params.subcmd == "monitor":
44            print("Opening and parsing the specification file %s" % params.spec)
45            if params.monitor_class == "da":
46                monitor = dot2k(params.spec, params.monitor_type, vars(params))
47            elif params.monitor_class == "ltl":
48                monitor = ltl2k(params.spec, params.monitor_type, vars(params))
49            else:
50                print("Unknown monitor class:", params.monitor_class)
51                sys.exit(1)
52        else:
53            monitor = Container(vars(params))
54    except Exception as e:
55        print('Error: '+ str(e))
56        print("Sorry : :-(")
57        sys.exit(1)
58
59    print("Writing the monitor into the directory %s" % monitor.name)
60    monitor.print_files()
61    print("Almost done, checklist")
62    if params.subcmd == "monitor":
63        print("  - Edit the %s/%s.c to add the instrumentation" % (monitor.name, monitor.name))
64        print(monitor.fill_tracepoint_tooltip())
65    print(monitor.fill_makefile_tooltip())
66    print(monitor.fill_kconfig_tooltip())
67    print(monitor.fill_monitor_tooltip())
68