1 #!/usr/bin/env python2.7
3 # Copyright (c) 2013 - 2015 ARM Limited
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.
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.
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.
38 # Copyright 2008 Google Inc. All rights reserved.
39 # http://code.google.com/p/protobuf/
41 # Redistribution and use in source and binary forms, with or without
42 # modification, are permitted provided that the following conditions are
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
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.
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.
67 # This script is used to dump protobuf traces of the instruction dependency
68 # graph to ASCII format.
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.
77 # seq_num,[pc],[weight,]type,[p_addr,size,flags,]comp_delay:[rob_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
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.
96 import inst_dep_record_pb2
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'])
103 import inst_dep_record_pb2
104 print "Generated proto definitions for instruction dependency record"
106 print "Failed to import proto definitions"
110 if len(sys
.argv
) != 3:
111 print "Usage: ", sys
.argv
[0], " <protobuf input> <ASCII output>"
114 # Open the file on read mode
115 proto_in
= protolib
.openFileRd(sys
.argv
[1])
118 ascii_out
= open(sys
.argv
[2], 'w')
120 print "Failed to open ", sys
.argv
[2], " for writing"
123 # Read the magic number in 4-byte Little Endian
124 magic_number
= proto_in
.read(4)
126 if magic_number
!= "gem5":
127 print "Unrecognized file"
130 print "Parsing packet header"
132 # Add the packet header
133 header
= inst_dep_record_pb2
.InstDepRecordHeader()
134 protolib
.decodeMessage(proto_in
, header
)
136 print "Object id:", header
.obj_id
137 print "Tick frequency:", header
.tick_freq
139 print "Parsing packets"
141 print "Creating enum value,name lookup from proto"
143 desc
= inst_dep_record_pb2
.InstDepRecord
.DESCRIPTOR
144 for namestr
, valdesc
in desc
.enum_values_by_name
.items():
145 print '\t', valdesc
.number
, namestr
146 enumNames
[valdesc
.number
] = namestr
151 packet
= inst_dep_record_pb2
.InstDepRecord()
153 # Decode the packet messages until we hit the end of the file
154 while protolib
.decodeMessage(proto_in
, packet
):
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
))
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
))
168 ascii_out
.write(',1')
169 # Write to file the type of the record
171 ascii_out
.write(',%s' % enumNames
[packet
.type])
173 print "Seq. num", packet
.seq_num
, "has unsupported type", \
178 # Write to file if it has the optional fields physical addr, size,
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
))
187 # Write to file the comp delay
188 ascii_out
.write(',%s' % (packet
.comp_delay
))
190 # Write to file the repeated field order dependency
194 for dep
in packet
.rob_dep
:
195 ascii_out
.write(',%s' % dep
)
196 # Write to file the repeated field register dependency
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
)
203 ascii_out
.write('\n')
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
213 if __name__
== "__main__":