util/decode_inst_dep_trace.py

   1 #!/usr/bin/env python3
   2
   3 # Copyright (c) 2013 - 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 # This script is used to dump protobuf traces of the instruction dependency
  68 # graph to ASCII format.
  69 #
  70 # The ASCII trace format uses one line per instruction with the format
  71 # instruction sequence number, (optional) pc, (optional) weight, type
  72 # (optional) flags, (optional) phys addr, (optional) size, comp delay,
  73 # (repeated) order dependencies comma-separated, and (repeated) register
  74 # dependencies comma-separated.
  75 #
  76 # examples:
  77 # seq_num,[pc],[weight,]type,[p_addr,size,flags,]comp_delay:[rob_dep]:
  78 # [reg_dep]
  79 # 1,35652,1,COMP,8500::
  80 # 2,35656,1,COMP,0:,1:
  81 # 3,35660,1,LOAD,1748752,4,74,500:,2:
  82 # 4,35660,1,COMP,0:,3:
  83 # 5,35664,1,COMP,3000::,4
  84 # 6,35666,1,STORE,1748752,4,74,1000:,3:,4,5
  85 # 7,35666,1,COMP,3000::,4
  86 # 8,35670,1,STORE,1748748,4,74,0:,6,3:,7
  87 # 9,35670,1,COMP,500::,7
  88
  89 import protolib
  90 import sys
  91
  92 # Import the packet proto definitions. If they are not found, attempt
  93 # to generate them automatically. This assumes that the script is
  94 # executed from the gem5 root.
  95 try:
  96     import inst_dep_record_pb2
  97 except:
  98     print("Did not find proto definition, attempting to generate")
  99     from subprocess import call
 100     error = call(['protoc', '--python_out=util', '--proto_path=src/proto',
 101                   'src/proto/inst_dep_record.proto'])
 102     if not error:
 103         import inst_dep_record_pb2
 104         print("Generated proto definitions for instruction dependency record")
 105     else:
 106         print("Failed to import proto definitions")
 107         exit(-1)
 108
 109 def main():
 110     if len(sys.argv) != 3:
 111         print("Usage: ", sys.argv[0], " <protobuf input> <ASCII output>")
 112         exit(-1)
 113
 114     # Open the file on read mode
 115     proto_in = protolib.openFileRd(sys.argv[1])
 116
 117     try:
 118         ascii_out = open(sys.argv[2], 'w')
 119     except IOError:
 120         print("Failed to open ", sys.argv[2], " for writing")
 121         exit(-1)
 122
 123     # Read the magic number in 4-byte Little Endian
 124     magic_number = proto_in.read(4)
 125
 126     if magic_number != "gem5":
 127         print("Unrecognized file")
 128         exit(-1)
 129
 130     print("Parsing packet header")
 131
 132     # Add the packet header
 133     header = inst_dep_record_pb2.InstDepRecordHeader()
 134     protolib.decodeMessage(proto_in, header)
 135
 136     print("Object id:", header.obj_id)
 137     print("Tick frequency:", header.tick_freq)
 138
 139     print("Parsing packets")
 140
 141     print("Creating enum value,name lookup from proto")
 142     enumNames = {}
 143     desc = inst_dep_record_pb2.InstDepRecord.DESCRIPTOR
 144     for namestr, valdesc in list(desc.enum_values_by_name.items()):
 145         print('\t', valdesc.number, namestr)
 146         enumNames[valdesc.number] = namestr
 147
 148     num_packets = 0
 149     num_regdeps = 0
 150     num_robdeps = 0
 151     packet = inst_dep_record_pb2.InstDepRecord()
 152
 153     # Decode the packet messages until we hit the end of the file
 154     while protolib.decodeMessage(proto_in, packet):
 155         num_packets += 1
 156
 157         # Write to file the seq num
 158         ascii_out.write('%s' % (packet.seq_num))
 159         # Write to file the pc of the instruction, default is 0
 160         if packet.HasField('pc'):
 161             ascii_out.write(',%s' % (packet.pc))
 162         else:
 163             ascii_out.write(',0')
 164         # Write to file the weight, default is 1
 165         if packet.HasField('weight'):
 166             ascii_out.write(',%s' % (packet.weight))
 167         else:
 168             ascii_out.write(',1')
 169         # Write to file the type of the record
 170         try:
 171             ascii_out.write(',%s' % enumNames[packet.type])
 172         except KeyError:
 173             print("Seq. num", packet.seq_num, "has unsupported type", \
 174                 packet.type)
 175             exit(-1)
 176
 177
 178         # Write to file if it has the optional fields physical addr, size,
 179         # flags
 180         if packet.HasField('p_addr'):
 181             ascii_out.write(',%s' % (packet.p_addr))
 182         if packet.HasField('size'):
 183             ascii_out.write(',%s' % (packet.size))
 184         if packet.HasField('flags'):
 185             ascii_out.write(',%s' % (packet.flags))
 186
 187         # Write to file the comp delay
 188         ascii_out.write(',%s' % (packet.comp_delay))
 189
 190         # Write to file the repeated field order dependency
 191         ascii_out.write(':')
 192         if packet.rob_dep:
 193             num_robdeps += 1
 194             for dep in packet.rob_dep:
 195                 ascii_out.write(',%s' % dep)
 196         # Write to file the repeated field register dependency
 197         ascii_out.write(':')
 198         if packet.reg_dep:
 199             num_regdeps += 1 # No. of packets with atleast 1 register dependency
 200             for dep in packet.reg_dep:
 201                 ascii_out.write(',%s' % dep)
 202         # New line
 203         ascii_out.write('\n')
 204
 205     print("Parsed packets:", num_packets)
 206     print("Packets with at least 1 reg dep:", num_regdeps)
 207     print("Packets with at least 1 rob dep:", num_robdeps)
 208
 209     # We're done
 210     ascii_out.close()
 211     proto_in.close()
 212
 213 if __name__ == "__main__":
 214     main()