util/decode_packet_trace.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2013 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 # Copyright 2008 Google Inc.  All rights reserved.
  39 # http://code.google.com/p/protobuf/
  40 #
  41 # Redistribution and use in source and binary forms, with or without
  42 # modification, are permitted provided that the following conditions are
  43 # met:
  44 #
  45 #     * Redistributions of source code must retain the above copyright
  46 # notice, this list of conditions and the following disclaimer.
  47 #     * Redistributions in binary form must reproduce the above
  48 # copyright notice, this list of conditions and the following disclaimer
  49 # in the documentation and/or other materials provided with the
  50 # distribution.
  51 #     * Neither the name of Google Inc. nor the names of its
  52 # contributors may be used to endorse or promote products derived from
  53 # this software without specific prior written permission.
  54 #
  55 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  56 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  57 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  58 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  59 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  60 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  61 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  62 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  63 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  64 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  65 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  66 #
  67 # Authors: Andreas Hansson
  68 #
  69
  70 # This script is used to dump protobuf packet traces to ASCII
  71 # format. It assumes that protoc has been executed and already
  72 # generated the Python package for the packet messages. This can
  73 # be done manually using:
  74 # protoc --python_out=. --proto_path=src/proto src/proto/packet.proto
  75 #
  76 # The ASCII trace format uses one line per request on the format cmd,
  77 # addr, size, tick,flags. For example:
  78 # r,128,64,4000,0
  79 # w,232123,64,500000,0
  80
  81 import struct
  82 import sys
  83
  84 # Import the packet proto definitions. If they are not found, attempt
  85 # to generate them automatically. This assumes that the script is
  86 # executed from the gem5 root.
  87 try:
  88     import packet_pb2
  89 except:
  90     print "Did not find packet proto definitions, attempting to generate"
  91     from subprocess import call
  92     error = call(['protoc', '--python_out=util', '--proto_path=src/proto',
  93                   'src/proto/packet.proto'])
  94     if not error:
  95         import packet_pb2
  96         print "Generated packet proto definitions"
  97     else:
  98         print "Failed to import packet proto definitions"
  99         exit(-1)
 100
 101 def DecodeVarint(in_file):
 102     """
 103     The decoding of the Varint32 is copied from
 104     google.protobuf.internal.decoder and is only repeated here to
 105     avoid depending on the internal functions in the library. If the
 106     end of file is reached, return (0, 0).
 107     """
 108     result = 0
 109     shift = 0
 110     pos = 0
 111     # Use a 32-bit mask
 112     mask = 0xffffffff
 113     while 1:
 114         c = in_file.read(1)
 115         if len(c) == 0:
 116             return (0, 0)
 117         b = struct.unpack('<B', c)[0]
 118         result |= ((b & 0x7f) << shift)
 119         pos += 1
 120         if not (b & 0x80):
 121             if result > 0x7fffffffffffffff:
 122                 result -= (1 << 64)
 123                 result |= ~mask
 124             else:
 125                 result &= mask
 126                 return (result, pos)
 127             shift += 7
 128             if shift >= 64:
 129                 raise IOError('Too many bytes when decoding varint.')
 130
 131 def decodeMessage(in_file, message):
 132     """
 133     Attempt to read a message from the file and decode it. Return
 134     False if no message could be read.
 135     """
 136     try:
 137         size, pos = DecodeVarint(in_file)
 138         if size == 0:
 139             return False
 140         buf = in_file.read(size)
 141         message.ParseFromString(buf)
 142         return True
 143     except IOError:
 144         return False
 145
 146 def main():
 147     if len(sys.argv) != 3:
 148         print "Usage: ", sys.argv[0], " <protobuf input> <ASCII output>"
 149         exit(-1)
 150
 151     try:
 152        proto_in = open(sys.argv[1], 'rb')
 153     except IOError:
 154         print "Failed to open ", sys.argv[1], " for reading"
 155         exit(-1)
 156
 157     try:
 158         ascii_out = open(sys.argv[2], 'w')
 159     except IOError:
 160         print "Failed to open ", sys.argv[2], " for writing"
 161         exit(-1)
 162
 163     # Read the magic number in 4-byte Little Endian
 164     magic_number = proto_in.read(4)
 165
 166     if magic_number != "gem5":
 167         print "Unrecognized file"
 168         exit(-1)
 169
 170     print "Parsing packet header"
 171
 172     # Add the packet header
 173     header = packet_pb2.PacketHeader()
 174     decodeMessage(proto_in, header)
 175
 176     print "Object id:", header.obj_id
 177     print "Tick frequency:", header.tick_freq
 178
 179     print "Parsing packets"
 180
 181     num_packets = 0
 182     ignored_flags = False
 183     packet = packet_pb2.Packet()
 184
 185     # Decode the packet messages until we hit the end of the file
 186     while decodeMessage(proto_in, packet):
 187         num_packets += 1
 188         # ReadReq is 1 and WriteReq is 4 in src/mem/packet.hh Command enum
 189         cmd = 'r' if packet.cmd == 1 else ('w' if packet.cmd == 4 else 'u')
 190         if packet.HasField('flags'):
 191             # Currently not printing flags
 192             ignored_flags = True
 193         ascii_out.write('%s,%s,%s,%s\n' % (cmd, packet.addr, packet.size,
 194                                            packet.tick))
 195
 196     print "Parsed packets:", num_packets
 197     if ignored_flags:
 198         print "Encountered packet flags that were ignored"
 199
 200     # We're done
 201     ascii_out.close()
 202     proto_in.close()
 203
 204 if __name__ == "__main__":
 205     main()