encode_packet_trace.py revision 11351:bfc1285c61eb
111308Santhony.gutierrez@amd.com#!/usr/bin/env python 211308Santhony.gutierrez@amd.com 311308Santhony.gutierrez@amd.com# Copyright (c) 2013-2014 ARM Limited 411308Santhony.gutierrez@amd.com# All rights reserved 511308Santhony.gutierrez@amd.com# 611308Santhony.gutierrez@amd.com# The license below extends only to copyright in the software and shall 711308Santhony.gutierrez@amd.com# not be construed as granting a license to any other intellectual 811308Santhony.gutierrez@amd.com# property including but not limited to intellectual property relating 911308Santhony.gutierrez@amd.com# to a hardware implementation of the functionality of the software 1011308Santhony.gutierrez@amd.com# licensed hereunder. You may use the software subject to the license 1111308Santhony.gutierrez@amd.com# terms below provided that you ensure that this notice is replicated 1211308Santhony.gutierrez@amd.com# unmodified and in its entirety in all distributions of the software, 1311308Santhony.gutierrez@amd.com# modified or unmodified, in source code or in binary form. 1411308Santhony.gutierrez@amd.com# 1511308Santhony.gutierrez@amd.com# Redistribution and use in source and binary forms, with or without 1611308Santhony.gutierrez@amd.com# modification, are permitted provided that the following conditions are 1711308Santhony.gutierrez@amd.com# met: redistributions of source code must retain the above copyright 1811308Santhony.gutierrez@amd.com# notice, this list of conditions and the following disclaimer; 1911308Santhony.gutierrez@amd.com# redistributions in binary form must reproduce the above copyright 2011308Santhony.gutierrez@amd.com# notice, this list of conditions and the following disclaimer in the 2111308Santhony.gutierrez@amd.com# documentation and/or other materials provided with the distribution; 2211308Santhony.gutierrez@amd.com# neither the name of the copyright holders nor the names of its 2311308Santhony.gutierrez@amd.com# contributors may be used to endorse or promote products derived from 2411308Santhony.gutierrez@amd.com# this software without specific prior written permission. 2511308Santhony.gutierrez@amd.com# 2611308Santhony.gutierrez@amd.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2711308Santhony.gutierrez@amd.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2811308Santhony.gutierrez@amd.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2911308Santhony.gutierrez@amd.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 3011308Santhony.gutierrez@amd.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3111308Santhony.gutierrez@amd.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3211308Santhony.gutierrez@amd.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3311308Santhony.gutierrez@amd.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3411308Santhony.gutierrez@amd.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3511308Santhony.gutierrez@amd.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3611308Santhony.gutierrez@amd.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3711308Santhony.gutierrez@amd.com# 3811856Sbrandon.potter@amd.com# Authors: Andreas Hansson 3911856Sbrandon.potter@amd.com 4011308Santhony.gutierrez@amd.com# This script is used to migrate ASCII packet traces to the protobuf 4111308Santhony.gutierrez@amd.com# format currently used in gem5. It assumes that protoc has been 4211308Santhony.gutierrez@amd.com# executed and already generated the Python package for the packet 4311308Santhony.gutierrez@amd.com# messages. This can be done manually using: 4411308Santhony.gutierrez@amd.com# protoc --python_out=. --proto_path=src/proto src/proto/packet.proto 4511308Santhony.gutierrez@amd.com# 4611308Santhony.gutierrez@amd.com# The ASCII trace format uses one line per request on the format cmd, 4711308Santhony.gutierrez@amd.com# addr, size, tick. For example: 4811308Santhony.gutierrez@amd.com# r,128,64,4000 4911308Santhony.gutierrez@amd.com# w,232123,64,500000 5011308Santhony.gutierrez@amd.com# This trace reads 64 bytes from decimal address 128 at tick 4000, 5111308Santhony.gutierrez@amd.com# then writes 64 bytes to address 232123 at tick 500000. 5211308Santhony.gutierrez@amd.com# 5311308Santhony.gutierrez@amd.com# This script can of course also be used as a template to convert 5411308Santhony.gutierrez@amd.com# other trace formats into the gem5 protobuf format 5511308Santhony.gutierrez@amd.com 5611308Santhony.gutierrez@amd.comimport protolib 5711308Santhony.gutierrez@amd.comimport sys 5811308Santhony.gutierrez@amd.com 5911308Santhony.gutierrez@amd.com# Import the packet proto definitions. If they are not found, attempt 6011308Santhony.gutierrez@amd.com# to generate them automatically. This assumes that the script is 6111308Santhony.gutierrez@amd.com# executed from the gem5 root. 6211308Santhony.gutierrez@amd.comtry: 6311308Santhony.gutierrez@amd.com import packet_pb2 6411308Santhony.gutierrez@amd.comexcept: 6511308Santhony.gutierrez@amd.com print "Did not find packet proto definitions, attempting to generate" 6611308Santhony.gutierrez@amd.com from subprocess import call 6711308Santhony.gutierrez@amd.com error = call(['protoc', '--python_out=util', '--proto_path=src/proto', 6811308Santhony.gutierrez@amd.com 'src/proto/packet.proto']) 6911308Santhony.gutierrez@amd.com if not error: 7011308Santhony.gutierrez@amd.com print "Generated packet proto definitions" 7111308Santhony.gutierrez@amd.com 7211308Santhony.gutierrez@amd.com try: 7311308Santhony.gutierrez@amd.com import google.protobuf 7411308Santhony.gutierrez@amd.com except: 7511308Santhony.gutierrez@amd.com print "Please install the Python protobuf module" 7611308Santhony.gutierrez@amd.com exit(-1) 7711308Santhony.gutierrez@amd.com 7811308Santhony.gutierrez@amd.com import packet_pb2 7911308Santhony.gutierrez@amd.com else: 8011308Santhony.gutierrez@amd.com print "Failed to import packet proto definitions" 8111308Santhony.gutierrez@amd.com exit(-1) 8211308Santhony.gutierrez@amd.com 8311308Santhony.gutierrez@amd.comdef main(): 8411697Santhony.gutierrez@amd.com if len(sys.argv) != 3: 8511308Santhony.gutierrez@amd.com print "Usage: ", sys.argv[0], " <ASCII input> <protobuf output>" 8611308Santhony.gutierrez@amd.com exit(-1) 8711308Santhony.gutierrez@amd.com 8811308Santhony.gutierrez@amd.com try: 8911308Santhony.gutierrez@amd.com ascii_in = open(sys.argv[1], 'r') 9011308Santhony.gutierrez@amd.com except IOError: 9111308Santhony.gutierrez@amd.com print "Failed to open ", sys.argv[1], " for reading" 9211308Santhony.gutierrez@amd.com exit(-1) 9311308Santhony.gutierrez@amd.com 9411308Santhony.gutierrez@amd.com try: 9511308Santhony.gutierrez@amd.com proto_out = open(sys.argv[2], 'wb') 9613995Sbrandon.potter@amd.com except IOError: 9711308Santhony.gutierrez@amd.com print "Failed to open ", sys.argv[2], " for writing" 9813995Sbrandon.potter@amd.com exit(-1) 9911856Sbrandon.potter@amd.com 10011856Sbrandon.potter@amd.com # Write the magic number in 4-byte Little Endian, similar to what 10111856Sbrandon.potter@amd.com # is done in src/proto/protoio.cc 10211856Sbrandon.potter@amd.com proto_out.write("gem5") 10311308Santhony.gutierrez@amd.com 10411308Santhony.gutierrez@amd.com # Add the packet header 10511308Santhony.gutierrez@amd.com header = packet_pb2.PacketHeader() 10613995Sbrandon.potter@amd.com header.obj_id = "Converted ASCII trace " + sys.argv[1] 10711308Santhony.gutierrez@amd.com # Assume the default tick rate 10811308Santhony.gutierrez@amd.com header.tick_freq = 1000000000000 10913995Sbrandon.potter@amd.com protolib.encodeMessage(proto_out, header) 11011308Santhony.gutierrez@amd.com 11111308Santhony.gutierrez@amd.com # For each line in the ASCII trace, create a packet message and 11211308Santhony.gutierrez@amd.com # write it to the encoded output 11311308Santhony.gutierrez@amd.com for line in ascii_in: 11411308Santhony.gutierrez@amd.com cmd, addr, size, tick = line.split(',') 11511308Santhony.gutierrez@amd.com packet = packet_pb2.Packet() 11611308Santhony.gutierrez@amd.com packet.tick = long(tick) 11711308Santhony.gutierrez@amd.com # ReadReq is 1 and WriteReq is 4 in src/mem/packet.hh Command enum 11811308Santhony.gutierrez@amd.com packet.cmd = 1 if cmd == 'r' else 4 11911308Santhony.gutierrez@amd.com packet.addr = long(addr) 12011308Santhony.gutierrez@amd.com packet.size = int(size) 12111308Santhony.gutierrez@amd.com protolib.encodeMessage(proto_out, packet) 12211308Santhony.gutierrez@amd.com 12311308Santhony.gutierrez@amd.com # We're done 12411308Santhony.gutierrez@amd.com ascii_in.close() 12511308Santhony.gutierrez@amd.com proto_out.close() 12611308Santhony.gutierrez@amd.com 12711308Santhony.gutierrez@amd.comif __name__ == "__main__": 12811308Santhony.gutierrez@amd.com main() 12911308Santhony.gutierrez@amd.com