util/decode_inst_trace.py

   1 #!/usr/bin/env python3
   2
   3 # Copyright (c) 2013-2014 ARM Limited
   4 # All rights reserved
   5 #
   6 # The license below extends only to copyright in the software and shall
   7 # not be construed as granting a license to any other intellectual
   8 # property including but not limited to intellectual property relating
   9 # to a hardware implementation of the functionality of the software
  10 # licensed hereunder.  You may use the software subject to the license
  11 # terms below provided that you ensure that this notice is replicated
  12 # unmodified and in its entirety in all distributions of the software,
  13 # modified or unmodified, in source code or in binary form.
  14 #
  15 # Redistribution and use in source and binary forms, with or without
  16 # modification, are permitted provided that the following conditions are
  17 # met: redistributions of source code must retain the above copyright
  18 # notice, this list of conditions and the following disclaimer;
  19 # redistributions in binary form must reproduce the above copyright
  20 # notice, this list of conditions and the following disclaimer in the
  21 # documentation and/or other materials provided with the distribution;
  22 # neither the name of the copyright holders nor the names of its
  23 # contributors may be used to endorse or promote products derived from
  24 # this software without specific prior written permission.
  25 #
  26 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  27 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  28 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  29 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  30 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  31 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  32 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  33 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  34 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  35 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  36 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37
  38 # This script is used to dump protobuf instruction traces to ASCII
  39 # format. It assumes that protoc has been executed and already
  40 # generated the Python package for the inst messages. This can
  41 # be done manually using:
  42 # protoc --python_out=. inst.proto
  43 # The ASCII trace format uses one line per request.
  44
  45 import protolib
  46 import sys
  47
  48 # Import the packet proto definitions
  49 try:
  50     import inst_pb2
  51 except:
  52     print("Did not find protobuf inst definitions, attempting to generate")
  53     from subprocess import call
  54     error = call(['protoc', '--python_out=util', '--proto_path=src/proto',
  55                   'src/proto/inst.proto'])
  56     if not error:
  57         print("Generated inst proto definitions")
  58
  59         try:
  60             import google.protobuf
  61         except:
  62             print("Please install Python protobuf module")
  63             exit(-1)
  64
  65         import inst_pb2
  66     else:
  67         print("Failed to import inst proto definitions")
  68         exit(-1)
  69
  70 def main():
  71     if len(sys.argv) != 3:
  72         print("Usage: ", sys.argv[0], " <protobuf input> <ASCII output>")
  73         exit(-1)
  74
  75     # Open the file in read mode
  76     proto_in = protolib.openFileRd(sys.argv[1])
  77
  78     try:
  79         ascii_out = open(sys.argv[2], 'w')
  80     except IOError:
  81         print("Failed to open ", sys.argv[2], " for writing")
  82         exit(-1)
  83
  84     # Read the magic number in 4-byte Little Endian
  85     magic_number = proto_in.read(4)
  86
  87     if magic_number != "gem5":
  88         print("Unrecognized file", sys.argv[1])
  89         exit(-1)
  90
  91     print("Parsing instruction header")
  92
  93     # Add the packet header
  94     header = inst_pb2.InstHeader()
  95     protolib.decodeMessage(proto_in, header)
  96
  97     print("Object id:", header.obj_id)
  98     print("Tick frequency:", header.tick_freq)
  99     print("Memory addresses included:", header.has_mem)
 100
 101     if header.ver != 0:
 102         print("Warning: file version newer than decoder:", header.ver)
 103         print("This decoder may not understand how to decode this file")
 104
 105
 106     print("Parsing instructions")
 107
 108     num_insts = 0
 109     inst = inst_pb2.Inst()
 110
 111     # Decode the inst messages until we hit the end of the file
 112     optional_fields = ('tick', 'type', 'inst_flags', 'addr', 'size', 'mem_flags')
 113     while protolib.decodeMessage(proto_in,  inst):
 114         # If we have a tick use it, otherwise count instructions
 115         if inst.HasField('tick'):
 116             tick = inst.tick
 117         else:
 118             tick = num_insts
 119
 120         if inst.HasField('nodeid'):
 121             node_id = inst.nodeid
 122         else:
 123             node_id = 0;
 124         if inst.HasField('cpuid'):
 125             cpu_id = inst.cpuid
 126         else:
 127             cpu_id = 0;
 128
 129         ascii_out.write('%-20d: (%03d/%03d) %#010x @ %#016x ' % (tick, node_id, cpu_id,
 130                                                   inst.inst, inst.pc))
 131
 132         if inst.HasField('type'):
 133             ascii_out.write(' : %10s' % inst_pb2._INST_INSTTYPE.values_by_number[inst.type].name)
 134
 135         for mem_acc in inst.mem_access:
 136             ascii_out.write(" %#x-%#x;" % (mem_acc.addr, mem_acc.addr + mem_acc.size))
 137
 138         ascii_out.write('\n')
 139         num_insts += 1
 140
 141     print("Parsed instructions:", num_insts)
 142
 143     # We're done
 144     ascii_out.close()
 145     proto_in.close()
 146
 147 if __name__ == "__main__":
 148     main()