util/decode_packet_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 packet traces to ASCII
  39 # format.
  40
  41 import os
  42 import protolib
  43 import subprocess
  44 import sys
  45
  46 util_dir = os.path.dirname(os.path.realpath(__file__))
  47 # Make sure the proto definitions are up to date.
  48 subprocess.check_call(['make', '--quiet', '-C', util_dir, 'packet_pb2.py'])
  49 import packet_pb2
  50
  51 def main():
  52     if len(sys.argv) != 3:
  53         print("Usage: ", sys.argv[0], " <protobuf input> <ASCII output>")
  54         exit(-1)
  55
  56     # Open the file in read mode
  57     proto_in = protolib.openFileRd(sys.argv[1])
  58
  59     try:
  60         ascii_out = open(sys.argv[2], 'w')
  61     except IOError:
  62         print("Failed to open ", sys.argv[2], " for writing")
  63         exit(-1)
  64
  65     # Read the magic number in 4-byte Little Endian
  66     magic_number = proto_in.read(4)
  67
  68     if magic_number != "gem5":
  69         print("Unrecognized file", sys.argv[1])
  70         exit(-1)
  71
  72     print("Parsing packet header")
  73
  74     # Add the packet header
  75     header = packet_pb2.PacketHeader()
  76     protolib.decodeMessage(proto_in, header)
  77
  78     print("Object id:", header.obj_id)
  79     print("Tick frequency:", header.tick_freq)
  80
  81     for id_string in header.id_strings:
  82         print('Master id %d: %s' % (id_string.key, id_string.value))
  83
  84     print("Parsing packets")
  85
  86     num_packets = 0
  87     packet = packet_pb2.Packet()
  88
  89     # Decode the packet messages until we hit the end of the file
  90     while protolib.decodeMessage(proto_in, packet):
  91         num_packets += 1
  92         # ReadReq is 1 and WriteReq is 4 in src/mem/packet.hh Command enum
  93         cmd = 'r' if packet.cmd == 1 else ('w' if packet.cmd == 4 else 'u')
  94         if packet.HasField('pkt_id'):
  95             ascii_out.write('%s,' % (packet.pkt_id))
  96         if packet.HasField('flags'):
  97             ascii_out.write('%s,%s,%s,%s,%s' % (cmd, packet.addr, packet.size,
  98                             packet.flags, packet.tick))
  99         else:
 100             ascii_out.write('%s,%s,%s,%s' % (cmd, packet.addr, packet.size,
 101                                            packet.tick))
 102         if packet.HasField('pc'):
 103             ascii_out.write(',%s\n' % (packet.pc))
 104         else:
 105             ascii_out.write('\n')
 106
 107     print("Parsed packets:", num_packets)
 108
 109     # We're done
 110     ascii_out.close()
 111     proto_in.close()
 112
 113 if __name__ == "__main__":
 114     main()