GNU Linux-libre 6.9.1-gnu
[releases.git] / tools / verification / dot2 / dot2k
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
11 if __name__ == '__main__':
12     from dot2.dot2k import dot2k
13     import argparse
14     import ntpath
15     import os
16     import platform
17     import sys
18
19     parser = argparse.ArgumentParser(description='transform .dot file into kernel rv monitor')
20     parser.add_argument('-d', "--dot", dest="dot_file", required=True)
21     parser.add_argument('-t', "--monitor_type", dest="monitor_type", required=True)
22     parser.add_argument('-n', "--model_name", dest="model_name", required=False)
23     parser.add_argument("-D", "--description", dest="description", required=False)
24     params = parser.parse_args()
25
26     print("Opening and parsing the dot file %s" % params.dot_file)
27     try:
28         monitor=dot2k(params.dot_file, params.monitor_type)
29     except Exception as e:
30         print('Error: '+ str(e))
31         print("Sorry : :-(")
32         sys.exit(1)
33
34     # easier than using argparse action.
35     if params.model_name != None:
36         print(params.model_name)
37
38     print("Writing the monitor into the directory %s" % monitor.name)
39     monitor.print_files()
40     print("Almost done, checklist")
41     print("  - Edit the %s/%s.c to add the instrumentation" % (monitor.name, monitor.name))
42     print("  - Edit include/trace/events/rv.h to add the tracepoint entry")
43     print("  - Move it to the kernel's monitor directory")
44     print("  - Edit kernel/trace/rv/Makefile")
45     print("  - Edit kernel/trace/rv/Kconfig")