decode_packet_trace.py revision 10107:524afa92d940
1#!/usr/bin/env python 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# Authors: Andreas Hansson 39 40# This script is used to dump protobuf packet traces to ASCII 41# format. It assumes that protoc has been executed and already 42# generated the Python package for the packet messages. This can 43# be done manually using: 44# protoc --python_out=. --proto_path=src/proto src/proto/packet.proto 45# 46# The ASCII trace format uses one line per request on the format cmd, 47# addr, size, tick,flags. For example: 48# r,128,64,4000,0 49# w,232123,64,500000,0 50 51import protolib 52import sys 53 54# Import the packet proto definitions. If they are not found, attempt 55# to generate them automatically. This assumes that the script is 56# executed from the gem5 root. 57try: 58 import packet_pb2 59except: 60 print "Did not find packet proto definitions, attempting to generate" 61 from subprocess import call 62 error = call(['protoc', '--python_out=util', '--proto_path=src/proto', 63 'src/proto/packet.proto']) 64 if not error: 65 print "Generated packet proto definitions" 66 67 try: 68 import google.protobuf 69 except: 70 print "Please install Python protobuf module" 71 exit(-1) 72 73 import packet_pb2 74 else: 75 print "Failed to import packet proto definitions" 76 exit(-1) 77 78def main(): 79 if len(sys.argv) != 3: 80 print "Usage: ", sys.argv[0], " <protobuf input> <ASCII output>" 81 exit(-1) 82 83 try: 84 proto_in = open(sys.argv[1], 'rb') 85 except IOError: 86 print "Failed to open ", sys.argv[1], " for reading" 87 exit(-1) 88 89 try: 90 ascii_out = open(sys.argv[2], 'w') 91 except IOError: 92 print "Failed to open ", sys.argv[2], " for writing" 93 exit(-1) 94 95 # Read the magic number in 4-byte Little Endian 96 magic_number = proto_in.read(4) 97 98 if magic_number != "gem5": 99 print "Unrecognized file" 100 exit(-1) 101 102 print "Parsing packet header" 103 104 # Add the packet header 105 header = packet_pb2.PacketHeader() 106 protolib.decodeMessage(proto_in, header) 107 108 print "Object id:", header.obj_id 109 print "Tick frequency:", header.tick_freq 110 111 print "Parsing packets" 112 113 num_packets = 0 114 packet = packet_pb2.Packet() 115 116 # Decode the packet messages until we hit the end of the file 117 while protolib.decodeMessage(proto_in, packet): 118 num_packets += 1 119 # ReadReq is 1 and WriteReq is 4 in src/mem/packet.hh Command enum 120 cmd = 'r' if packet.cmd == 1 else ('w' if packet.cmd == 4 else 'u') 121 if packet.HasField('pkt_id'): 122 ascii_out.write('%s,' % (packet.pkt_id)) 123 if packet.HasField('flags'): 124 ascii_out.write('%s,%s,%s,%s,%s\n' % (cmd, packet.addr, packet.size, 125 packet.flags, packet.tick)) 126 else: 127 ascii_out.write('%s,%s,%s,%s\n' % (cmd, packet.addr, packet.size, 128 packet.tick)) 129 130 print "Parsed packets:", num_packets 131 132 # We're done 133 ascii_out.close() 134 proto_in.close() 135 136if __name__ == "__main__": 137 main() 138