encode_packet_trace.py revision 9616
19616Sandreas.hansson@arm.com#!/usr/bin/env python 29616Sandreas.hansson@arm.com 39616Sandreas.hansson@arm.com# Copyright (c) 2013 ARM Limited 49616Sandreas.hansson@arm.com# All rights reserved 59616Sandreas.hansson@arm.com# 69616Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall 79616Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual 89616Sandreas.hansson@arm.com# property including but not limited to intellectual property relating 99616Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software 109616Sandreas.hansson@arm.com# licensed hereunder. You may use the software subject to the license 119616Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated 129616Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software, 139616Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form. 149616Sandreas.hansson@arm.com# 159616Sandreas.hansson@arm.com# Redistribution and use in source and binary forms, with or without 169616Sandreas.hansson@arm.com# modification, are permitted provided that the following conditions are 179616Sandreas.hansson@arm.com# met: redistributions of source code must retain the above copyright 189616Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer; 199616Sandreas.hansson@arm.com# redistributions in binary form must reproduce the above copyright 209616Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer in the 219616Sandreas.hansson@arm.com# documentation and/or other materials provided with the distribution; 229616Sandreas.hansson@arm.com# neither the name of the copyright holders nor the names of its 239616Sandreas.hansson@arm.com# contributors may be used to endorse or promote products derived from 249616Sandreas.hansson@arm.com# this software without specific prior written permission. 259616Sandreas.hansson@arm.com# 269616Sandreas.hansson@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 279616Sandreas.hansson@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 289616Sandreas.hansson@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 299616Sandreas.hansson@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 309616Sandreas.hansson@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 319616Sandreas.hansson@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 329616Sandreas.hansson@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 339616Sandreas.hansson@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 349616Sandreas.hansson@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 359616Sandreas.hansson@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 369616Sandreas.hansson@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 379616Sandreas.hansson@arm.com# 389616Sandreas.hansson@arm.com# Copyright 2008 Google Inc. All rights reserved. 399616Sandreas.hansson@arm.com# http://code.google.com/p/protobuf/ 409616Sandreas.hansson@arm.com# 419616Sandreas.hansson@arm.com# Redistribution and use in source and binary forms, with or without 429616Sandreas.hansson@arm.com# modification, are permitted provided that the following conditions are 439616Sandreas.hansson@arm.com# met: 449616Sandreas.hansson@arm.com# 459616Sandreas.hansson@arm.com# * Redistributions of source code must retain the above copyright 469616Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer. 479616Sandreas.hansson@arm.com# * Redistributions in binary form must reproduce the above 489616Sandreas.hansson@arm.com# copyright notice, this list of conditions and the following disclaimer 499616Sandreas.hansson@arm.com# in the documentation and/or other materials provided with the 509616Sandreas.hansson@arm.com# distribution. 519616Sandreas.hansson@arm.com# * Neither the name of Google Inc. nor the names of its 529616Sandreas.hansson@arm.com# contributors may be used to endorse or promote products derived from 539616Sandreas.hansson@arm.com# this software without specific prior written permission. 549616Sandreas.hansson@arm.com# 559616Sandreas.hansson@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 569616Sandreas.hansson@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 579616Sandreas.hansson@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 589616Sandreas.hansson@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 599616Sandreas.hansson@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 609616Sandreas.hansson@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 619616Sandreas.hansson@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 629616Sandreas.hansson@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 639616Sandreas.hansson@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 649616Sandreas.hansson@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 659616Sandreas.hansson@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 669616Sandreas.hansson@arm.com# 679616Sandreas.hansson@arm.com# Authors: Andreas Hansson 689616Sandreas.hansson@arm.com# 699616Sandreas.hansson@arm.com 709616Sandreas.hansson@arm.com# This script is used to migrate ASCII packet traces to the protobuf 719616Sandreas.hansson@arm.com# format currently used in gem5. It assumes that protoc has been 729616Sandreas.hansson@arm.com# executed and already generated the Python package for the packet 739616Sandreas.hansson@arm.com# messages. This can be done manually using: 749616Sandreas.hansson@arm.com# protoc --python_out=. --proto_path=src/proto src/proto/packet.proto 759616Sandreas.hansson@arm.com# 769616Sandreas.hansson@arm.com# The ASCII trace format uses one line per request on the format cmd, 779616Sandreas.hansson@arm.com# addr, size, tick. For example: 789616Sandreas.hansson@arm.com# r,128,64,4000 799616Sandreas.hansson@arm.com# w,232123,64,500000 809616Sandreas.hansson@arm.com# This trace reads 64 bytes from decimal address 128 at tick 4000, 819616Sandreas.hansson@arm.com# then writes 64 bytes to address 232123 at tick 500000. 829616Sandreas.hansson@arm.com# 839616Sandreas.hansson@arm.com# This script can of course also be used as a template to convert 849616Sandreas.hansson@arm.com# other trace formats into the gem5 protobuf format 859616Sandreas.hansson@arm.com 869616Sandreas.hansson@arm.comimport struct 879616Sandreas.hansson@arm.comimport sys 889616Sandreas.hansson@arm.comimport packet_pb2 899616Sandreas.hansson@arm.com 909616Sandreas.hansson@arm.comdef EncodeVarint(out_file, value): 919616Sandreas.hansson@arm.com """ 929616Sandreas.hansson@arm.com The encoding of the Varint32 is copied from 939616Sandreas.hansson@arm.com google.protobuf.internal.encoder and is only repeated here to 949616Sandreas.hansson@arm.com avoid depending on the internal functions in the library. 959616Sandreas.hansson@arm.com """ 969616Sandreas.hansson@arm.com bits = value & 0x7f 979616Sandreas.hansson@arm.com value >>= 7 989616Sandreas.hansson@arm.com while value: 999616Sandreas.hansson@arm.com out_file.write(struct.pack('<B', 0x80|bits)) 1009616Sandreas.hansson@arm.com bits = value & 0x7f 1019616Sandreas.hansson@arm.com value >>= 7 1029616Sandreas.hansson@arm.com out_file.write(struct.pack('<B', bits)) 1039616Sandreas.hansson@arm.com 1049616Sandreas.hansson@arm.comdef encodeMessage(out_file, message): 1059616Sandreas.hansson@arm.com """ 1069616Sandreas.hansson@arm.com Encoded a message with the length prepended as a 32-bit varint. 1079616Sandreas.hansson@arm.com """ 1089616Sandreas.hansson@arm.com out = message.SerializeToString() 1099616Sandreas.hansson@arm.com EncodeVarint(out_file, len(out)) 1109616Sandreas.hansson@arm.com out_file.write(out) 1119616Sandreas.hansson@arm.com 1129616Sandreas.hansson@arm.comdef main(): 1139616Sandreas.hansson@arm.com if len(sys.argv) != 3: 1149616Sandreas.hansson@arm.com print "Usage: ", sys.argv[0], " <ASCII input> <protobuf output>" 1159616Sandreas.hansson@arm.com exit(-1) 1169616Sandreas.hansson@arm.com 1179616Sandreas.hansson@arm.com try: 1189616Sandreas.hansson@arm.com ascii_in = open(sys.argv[1], 'r') 1199616Sandreas.hansson@arm.com except IOError: 1209616Sandreas.hansson@arm.com print "Failed to open ", sys.argv[1], " for reading" 1219616Sandreas.hansson@arm.com exit(-1) 1229616Sandreas.hansson@arm.com 1239616Sandreas.hansson@arm.com try: 1249616Sandreas.hansson@arm.com proto_out = open(sys.argv[2], 'wb') 1259616Sandreas.hansson@arm.com except IOError: 1269616Sandreas.hansson@arm.com print "Failed to open ", sys.argv[2], " for writing" 1279616Sandreas.hansson@arm.com exit(-1) 1289616Sandreas.hansson@arm.com 1299616Sandreas.hansson@arm.com # Write the magic number in 4-byte Little Endian, similar to what 1309616Sandreas.hansson@arm.com # is done in src/proto/protoio.cc 1319616Sandreas.hansson@arm.com proto_out.write("gem5") 1329616Sandreas.hansson@arm.com 1339616Sandreas.hansson@arm.com # Add the packet header 1349616Sandreas.hansson@arm.com header = packet_pb2.PacketHeader() 1359616Sandreas.hansson@arm.com header.obj_id = "Converted ASCII trace " + sys.argv[1] 1369616Sandreas.hansson@arm.com # Assume the default tick rate 1379616Sandreas.hansson@arm.com header.tick_freq = 1000000000 1389616Sandreas.hansson@arm.com encodeMessage(proto_out, header) 1399616Sandreas.hansson@arm.com 1409616Sandreas.hansson@arm.com # For each line in the ASCII trace, create a packet message and 1419616Sandreas.hansson@arm.com # write it to the encoded output 1429616Sandreas.hansson@arm.com for line in ascii_in: 1439616Sandreas.hansson@arm.com cmd, addr, size, tick = line.split(',') 1449616Sandreas.hansson@arm.com packet = packet_pb2.Packet() 1459616Sandreas.hansson@arm.com packet.tick = long(tick) 1469616Sandreas.hansson@arm.com # ReadReq is 1 and WriteReq is 4 in src/mem/packet.hh Command enum 1479616Sandreas.hansson@arm.com packet.cmd = 1 if cmd == 'r' else 4 1489616Sandreas.hansson@arm.com packet.addr = long(addr) 1499616Sandreas.hansson@arm.com packet.size = int(size) 1509616Sandreas.hansson@arm.com encodeMessage(proto_out, packet) 1519616Sandreas.hansson@arm.com 1529616Sandreas.hansson@arm.com # We're done 1539616Sandreas.hansson@arm.com ascii_in.close() 1549616Sandreas.hansson@arm.com proto_out.close() 1559616Sandreas.hansson@arm.com 1569616Sandreas.hansson@arm.comif __name__ == "__main__": 1579616Sandreas.hansson@arm.com main() 158