decode_packet_trace.py revision 11437
19617Sandreas.hansson@arm.com#!/usr/bin/env python 29617Sandreas.hansson@arm.com 310065Sandreas.hansson@arm.com# Copyright (c) 2013-2014 ARM Limited 49617Sandreas.hansson@arm.com# All rights reserved 59617Sandreas.hansson@arm.com# 69617Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall 79617Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual 89617Sandreas.hansson@arm.com# property including but not limited to intellectual property relating 99617Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software 109617Sandreas.hansson@arm.com# licensed hereunder. You may use the software subject to the license 119617Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated 129617Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software, 139617Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form. 149617Sandreas.hansson@arm.com# 159617Sandreas.hansson@arm.com# Redistribution and use in source and binary forms, with or without 169617Sandreas.hansson@arm.com# modification, are permitted provided that the following conditions are 179617Sandreas.hansson@arm.com# met: redistributions of source code must retain the above copyright 189617Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer; 199617Sandreas.hansson@arm.com# redistributions in binary form must reproduce the above copyright 209617Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer in the 219617Sandreas.hansson@arm.com# documentation and/or other materials provided with the distribution; 229617Sandreas.hansson@arm.com# neither the name of the copyright holders nor the names of its 239617Sandreas.hansson@arm.com# contributors may be used to endorse or promote products derived from 249617Sandreas.hansson@arm.com# this software without specific prior written permission. 259617Sandreas.hansson@arm.com# 269617Sandreas.hansson@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 279617Sandreas.hansson@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 289617Sandreas.hansson@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 299617Sandreas.hansson@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 309617Sandreas.hansson@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 319617Sandreas.hansson@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 329617Sandreas.hansson@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 339617Sandreas.hansson@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 349617Sandreas.hansson@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 359617Sandreas.hansson@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 369617Sandreas.hansson@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 379617Sandreas.hansson@arm.com# 389617Sandreas.hansson@arm.com# Authors: Andreas Hansson 399617Sandreas.hansson@arm.com 409617Sandreas.hansson@arm.com# This script is used to dump protobuf packet traces to ASCII 419617Sandreas.hansson@arm.com# format. It assumes that protoc has been executed and already 429617Sandreas.hansson@arm.com# generated the Python package for the packet messages. This can 439617Sandreas.hansson@arm.com# be done manually using: 449617Sandreas.hansson@arm.com# protoc --python_out=. --proto_path=src/proto src/proto/packet.proto 459617Sandreas.hansson@arm.com# 469617Sandreas.hansson@arm.com# The ASCII trace format uses one line per request on the format cmd, 479617Sandreas.hansson@arm.com# addr, size, tick,flags. For example: 489617Sandreas.hansson@arm.com# r,128,64,4000,0 499617Sandreas.hansson@arm.com# w,232123,64,500000,0 509617Sandreas.hansson@arm.com 5110107Sradhika.jagtap@ARM.comimport protolib 529617Sandreas.hansson@arm.comimport sys 539706Sandreas.hansson@arm.com 549706Sandreas.hansson@arm.com# Import the packet proto definitions. If they are not found, attempt 559706Sandreas.hansson@arm.com# to generate them automatically. This assumes that the script is 569706Sandreas.hansson@arm.com# executed from the gem5 root. 579706Sandreas.hansson@arm.comtry: 589706Sandreas.hansson@arm.com import packet_pb2 599706Sandreas.hansson@arm.comexcept: 609706Sandreas.hansson@arm.com print "Did not find packet proto definitions, attempting to generate" 619706Sandreas.hansson@arm.com from subprocess import call 629706Sandreas.hansson@arm.com error = call(['protoc', '--python_out=util', '--proto_path=src/proto', 639706Sandreas.hansson@arm.com 'src/proto/packet.proto']) 649706Sandreas.hansson@arm.com if not error: 6510065Sandreas.hansson@arm.com print "Generated packet proto definitions" 6610065Sandreas.hansson@arm.com 6710065Sandreas.hansson@arm.com try: 6810065Sandreas.hansson@arm.com import google.protobuf 6910065Sandreas.hansson@arm.com except: 7010065Sandreas.hansson@arm.com print "Please install Python protobuf module" 7110065Sandreas.hansson@arm.com exit(-1) 7210065Sandreas.hansson@arm.com 739706Sandreas.hansson@arm.com import packet_pb2 749706Sandreas.hansson@arm.com else: 759706Sandreas.hansson@arm.com print "Failed to import packet proto definitions" 769706Sandreas.hansson@arm.com exit(-1) 779617Sandreas.hansson@arm.com 789617Sandreas.hansson@arm.comdef main(): 799617Sandreas.hansson@arm.com if len(sys.argv) != 3: 809617Sandreas.hansson@arm.com print "Usage: ", sys.argv[0], " <protobuf input> <ASCII output>" 819617Sandreas.hansson@arm.com exit(-1) 829617Sandreas.hansson@arm.com 8310269Sradhika.jagtap@ARM.com # Open the file in read mode 8410269Sradhika.jagtap@ARM.com proto_in = protolib.openFileRd(sys.argv[1]) 859617Sandreas.hansson@arm.com 869617Sandreas.hansson@arm.com try: 879617Sandreas.hansson@arm.com ascii_out = open(sys.argv[2], 'w') 889617Sandreas.hansson@arm.com except IOError: 899617Sandreas.hansson@arm.com print "Failed to open ", sys.argv[2], " for writing" 909617Sandreas.hansson@arm.com exit(-1) 919617Sandreas.hansson@arm.com 929617Sandreas.hansson@arm.com # Read the magic number in 4-byte Little Endian 939617Sandreas.hansson@arm.com magic_number = proto_in.read(4) 949617Sandreas.hansson@arm.com 959617Sandreas.hansson@arm.com if magic_number != "gem5": 9610132Sandreas.hansson@arm.com print "Unrecognized file", sys.argv[1] 979617Sandreas.hansson@arm.com exit(-1) 989617Sandreas.hansson@arm.com 999617Sandreas.hansson@arm.com print "Parsing packet header" 1009617Sandreas.hansson@arm.com 1019617Sandreas.hansson@arm.com # Add the packet header 1029617Sandreas.hansson@arm.com header = packet_pb2.PacketHeader() 10310107Sradhika.jagtap@ARM.com protolib.decodeMessage(proto_in, header) 1049617Sandreas.hansson@arm.com 1059617Sandreas.hansson@arm.com print "Object id:", header.obj_id 1069617Sandreas.hansson@arm.com print "Tick frequency:", header.tick_freq 1079617Sandreas.hansson@arm.com 1089617Sandreas.hansson@arm.com print "Parsing packets" 1099617Sandreas.hansson@arm.com 1109617Sandreas.hansson@arm.com num_packets = 0 1119617Sandreas.hansson@arm.com packet = packet_pb2.Packet() 1129617Sandreas.hansson@arm.com 1139617Sandreas.hansson@arm.com # Decode the packet messages until we hit the end of the file 11410107Sradhika.jagtap@ARM.com while protolib.decodeMessage(proto_in, packet): 1159617Sandreas.hansson@arm.com num_packets += 1 1169617Sandreas.hansson@arm.com # ReadReq is 1 and WriteReq is 4 in src/mem/packet.hh Command enum 1179617Sandreas.hansson@arm.com cmd = 'r' if packet.cmd == 1 else ('w' if packet.cmd == 4 else 'u') 11810107Sradhika.jagtap@ARM.com if packet.HasField('pkt_id'): 11910107Sradhika.jagtap@ARM.com ascii_out.write('%s,' % (packet.pkt_id)) 1209617Sandreas.hansson@arm.com if packet.HasField('flags'): 12111437Svictor.garcia@arm.com ascii_out.write('%s,%s,%s,%s,%s' % (cmd, packet.addr, packet.size, 12210107Sradhika.jagtap@ARM.com packet.flags, packet.tick)) 12310107Sradhika.jagtap@ARM.com else: 12411437Svictor.garcia@arm.com ascii_out.write('%s,%s,%s,%s' % (cmd, packet.addr, packet.size, 1259617Sandreas.hansson@arm.com packet.tick)) 12611437Svictor.garcia@arm.com if packet.HasField('pc'): 12711437Svictor.garcia@arm.com ascii_out.write(',%s\n' % (packet.pc)) 12811437Svictor.garcia@arm.com else: 12911437Svictor.garcia@arm.com ascii_out.write('\n') 1309617Sandreas.hansson@arm.com 1319617Sandreas.hansson@arm.com print "Parsed packets:", num_packets 1329617Sandreas.hansson@arm.com 1339617Sandreas.hansson@arm.com # We're done 1349617Sandreas.hansson@arm.com ascii_out.close() 1359617Sandreas.hansson@arm.com proto_in.close() 1369617Sandreas.hansson@arm.com 1379617Sandreas.hansson@arm.comif __name__ == "__main__": 1389617Sandreas.hansson@arm.com main() 139