1#!/usr/bin/env python2.7 2 3# Copyright (c) 2015 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: Radhika Jagtap 68# 69 70# This script is used to dump ASCII traces of the instruction dependency 71# graph to protobuf format. 72# 73# The ASCII trace format uses one line per instruction with the format 74# instruction sequence number, (optional) pc, (optional) weight, type, 75# (optional) flags, (optional) physical addr, (optional) size, comp delay, 76# (repeated) order dependencies comma-separated, and (repeated) register 77# dependencies comma-separated. 78# 79# examples: 80# seq_num,[pc],[weight,]type,[p_addr,size,flags,]comp_delay:[rob_dep]: 81# [reg_dep] 82# 1,35652,1,COMP,8500:: 83# 2,35656,1,COMP,0:,1: 84# 3,35660,1,LOAD,1748752,4,74,500:,2: 85# 4,35660,1,COMP,0:,3: 86# 5,35664,1,COMP,3000::,4 87# 6,35666,1,STORE,1748752,4,74,1000:,3:,4,5 88# 7,35666,1,COMP,3000::,4 89# 8,35670,1,STORE,1748748,4,74,0:,6,3:,7 90# 9,35670,1,COMP,500::,7 91 92import protolib 93import sys 94 95# Import the packet proto definitions. If they are not found, attempt 96# to generate them automatically. This assumes that the script is 97# executed from the gem5 root. 98try: 99 import inst_dep_record_pb2 100except: 101 print "Did not find proto definition, attempting to generate" 102 from subprocess import call 103 error = call(['protoc', '--python_out=util', '--proto_path=src/proto', 104 'src/proto/inst_dep_record.proto']) 105 if not error: 106 import inst_dep_record_pb2 107 print "Generated proto definitions for instruction dependency record" 108 else: 109 print "Failed to import proto definitions" 110 exit(-1) 111 112DepRecord = inst_dep_record_pb2.InstDepRecord 113 114def main(): 115 if len(sys.argv) != 3: 116 print "Usage: ", sys.argv[0], " <ASCII input> <protobuf output>" 117 exit(-1) 118 119 # Open the file in write mode 120 proto_out = open(sys.argv[2], 'wb') 121 122 # Open the file in read mode 123 try: 124 ascii_in = open(sys.argv[1], 'r') 125 except IOError: 126 print "Failed to open ", sys.argv[1], " for reading" 127 exit(-1) 128 129 # Write the magic number in 4-byte Little Endian, similar to what 130 # is done in src/proto/protoio.cc 131 proto_out.write("gem5") 132 133 # Add the packet header 134 header = inst_dep_record_pb2.InstDepRecordHeader() 135 header.obj_id = "Converted ASCII trace " + sys.argv[1] 136 # Assume the default tick rate 137 header.tick_freq = 1000000000 138 header.window_size = 120 139 protolib.encodeMessage(proto_out, header) 140 141 print "Creating enum name,value lookup from proto" 142 enumValues = {} 143 for namestr, valdesc in DepRecord.DESCRIPTOR.enum_values_by_name.items(): 144 print '\t', namestr, valdesc.number 145 enumValues[namestr] = valdesc.number 146 147 num_records = 0 148 # For each line in the ASCII trace, create a packet message and 149 # write it to the encoded output 150 for line in ascii_in: 151 inst_info_str, rob_dep_str, reg_dep_str = (line.strip()).split(':') 152 inst_info_list = inst_info_str.split(',') 153 dep_record = DepRecord() 154 155 dep_record.seq_num = long(inst_info_list[0]) 156 dep_record.pc = long(inst_info_list[1]) 157 dep_record.weight = long(inst_info_list[2]) 158 # If the type is not one of the enum values, it should be a key error 159 try: 160 dep_record.type = enumValues[inst_info_list[3]] 161 except KeyError: 162 print "Seq. num", dep_record.seq_num, "has unsupported type", \ 163 inst_info_list[3] 164 exit(-1) 165 166 if dep_record.type == DepRecord.INVALID: 167 print "Seq. num", dep_record.seq_num, "is of INVALID type" 168 exit(-1) 169 170 # If the instruction is a load or store record the physical addr, 171 # size flags in addition to recording the computation delay 172 if dep_record.type in [DepRecord.LOAD, DepRecord.STORE]: 173 p_addr, size, flags, comp_delay = inst_info_list[4:8] 174 dep_record.p_addr = long(p_addr) 175 dep_record.size = int(size) 176 dep_record.flags = int(flags) 177 dep_record.comp_delay = long(comp_delay) 178 else: 179 comp_delay = inst_info_list[4] 180 dep_record.comp_delay = long(comp_delay) 181 182 # Parse the register and order dependencies both of which are 183 # repeated fields. An empty list is valid. 184 rob_deps = rob_dep_str.strip().split(',') 185 for a_dep in rob_deps: 186 # if the string is empty, split(',') returns 1 item: '' 187 # if the string is ",4", split(',') returns 2 items: '', '4' 188 # long('') gives error, so check if the item is non-empty 189 if a_dep: 190 dep_record.rob_dep.append(long(a_dep)) 191 192 reg_deps = reg_dep_str.split(',') 193 for a_dep in reg_deps: 194 if a_dep: 195 dep_record.reg_dep.append(long(a_dep)) 196 197 protolib.encodeMessage(proto_out, dep_record) 198 num_records += 1 199 200 print "Converted", num_records, "records." 201 # We're done 202 ascii_in.close() 203 proto_out.close() 204 205if __name__ == "__main__": 206 main() 207