| 1 | #!/usr/bin/env python3 |
| 2 | |
| 3 | """ |
| 4 | Command-line wrapper for the tracetool machinery. |
| 5 | """ |
| 6 | |
| 7 | __author__ = "Lluís Vilanova <vilanova@ac.upc.edu>" |
| 8 | __copyright__ = "Copyright 2012-2014, Lluís Vilanova <vilanova@ac.upc.edu>" |
| 9 | __license__ = "GPL version 2 or (at your option) any later version" |
| 10 | |
| 11 | __maintainer__ = "Stefan Hajnoczi" |
| 12 | __email__ = "stefanha@redhat.com" |
| 13 | |
| 14 | |
| 15 | import sys |
| 16 | import getopt |
| 17 | |
| 18 | from tracetool import error_write, out, out_open |
| 19 | import tracetool.backend |
| 20 | import tracetool.format |
| 21 | |
| 22 | |
| 23 | _SCRIPT = "" |
| 24 | |
| 25 | def error_opt(msg = None): |
| 26 | if msg is not None: |
| 27 | error_write("Error: " + msg + "\n") |
| 28 | |
| 29 | backend_descr = "\n".join([ " %-15s %s" % (n, d) |
| 30 | for n,d in tracetool.backend.get_list() ]) |
| 31 | format_descr = "\n".join([ " %-15s %s" % (n, d) |
| 32 | for n,d in tracetool.format.get_list() ]) |
| 33 | error_write("""\ |
| 34 | Usage: %(script)s --format=<format> --backends=<backends> [<options>] <trace-events> ... <output> |
| 35 | |
| 36 | Backends: |
| 37 | %(backends)s |
| 38 | |
| 39 | Formats: |
| 40 | %(formats)s |
| 41 | |
| 42 | Options: |
| 43 | --help This help message. |
| 44 | --list-backends Print list of available backends. |
| 45 | --check-backends Check if the given backend is valid. |
| 46 | --binary <path> Full path to QEMU binary (required for 'stap' backend). |
| 47 | --group <name> Name of the event group. |
| 48 | --probe-prefix <prefix> Prefix for dtrace probe names (required for 'stap' backend). |
| 49 | """ % { |
| 50 | "script" : _SCRIPT, |
| 51 | "backends" : backend_descr, |
| 52 | "formats" : format_descr, |
| 53 | }) |
| 54 | |
| 55 | if msg is None: |
| 56 | sys.exit(0) |
| 57 | else: |
| 58 | sys.exit(1) |
| 59 | |
| 60 | def main(args): |
| 61 | global _SCRIPT |
| 62 | _SCRIPT = args[0] |
| 63 | |
| 64 | long_opts = ["backends=", "format=", "help", "list-backends", |
| 65 | "check-backends", "group="] |
| 66 | long_opts += ["binary=", "probe-prefix="] |
| 67 | |
| 68 | try: |
| 69 | opts, args = getopt.getopt(args[1:], "", long_opts) |
| 70 | except getopt.GetoptError as err: |
| 71 | error_opt(str(err)) |
| 72 | |
| 73 | check_backends = False |
| 74 | arg_backends = [] |
| 75 | arg_format = "" |
| 76 | arg_group = None |
| 77 | binary = None |
| 78 | probe_prefix = None |
| 79 | for opt, arg in opts: |
| 80 | if opt == "--help": |
| 81 | error_opt() |
| 82 | |
| 83 | elif opt == "--backends": |
| 84 | arg_backends = arg.split(",") |
| 85 | elif opt == "--group": |
| 86 | arg_group = arg |
| 87 | elif opt == "--format": |
| 88 | arg_format = arg |
| 89 | |
| 90 | elif opt == "--list-backends": |
| 91 | public_backends = tracetool.backend.get_list(only_public = True) |
| 92 | out(", ".join([ b for b,_ in public_backends ])) |
| 93 | sys.exit(0) |
| 94 | elif opt == "--check-backends": |
| 95 | check_backends = True |
| 96 | |
| 97 | elif opt == "--binary": |
| 98 | binary = arg |
| 99 | elif opt == '--probe-prefix': |
| 100 | probe_prefix = arg |
| 101 | |
| 102 | else: |
| 103 | error_opt("unhandled option: %s" % opt) |
| 104 | |
| 105 | if len(arg_backends) == 0: |
| 106 | error_opt("no backends specified") |
| 107 | |
| 108 | if check_backends: |
| 109 | for backend in arg_backends: |
| 110 | if not tracetool.backend.exists(backend): |
| 111 | sys.exit(1) |
| 112 | sys.exit(0) |
| 113 | |
| 114 | if arg_group is None: |
| 115 | error_opt("group name is required") |
| 116 | |
| 117 | if arg_format == "stap": |
| 118 | if binary is None: |
| 119 | error_opt("--binary is required for SystemTAP tapset generator") |
| 120 | if probe_prefix is None: |
| 121 | error_opt("--probe-prefix is required for SystemTAP tapset generator") |
| 122 | |
| 123 | if len(args) < 2: |
| 124 | error_opt("missing trace-events and output filepaths") |
| 125 | events = [] |
| 126 | for arg in args[:-1]: |
| 127 | with open(arg, "r") as fh: |
| 128 | events.extend(tracetool.read_events(fh, arg)) |
| 129 | |
| 130 | out_open(args[-1]) |
| 131 | |
| 132 | try: |
| 133 | tracetool.generate(events, arg_group, arg_format, arg_backends, |
| 134 | binary=binary, probe_prefix=probe_prefix) |
| 135 | except tracetool.TracetoolError as e: |
| 136 | error_opt(str(e)) |
| 137 | |
| 138 | if __name__ == "__main__": |
| 139 | main(sys.argv) |