1 #!/usr/bin/env python2.7
3 # Copyright (c) 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 ASCII traces of the instruction dependency
68 # graph to protobuf 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) physical 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"
109 DepRecord
= inst_dep_record_pb2
.InstDepRecord
112 if len(sys
.argv
) != 3:
113 print "Usage: ", sys
.argv
[0], " <ASCII input> <protobuf output>"
116 # Open the file in write mode
117 proto_out
= open(sys
.argv
[2], 'wb')
119 # Open the file in read mode
121 ascii_in
= open(sys
.argv
[1], 'r')
123 print "Failed to open ", sys
.argv
[1], " for reading"
126 # Write the magic number in 4-byte Little Endian, similar to what
127 # is done in src/proto/protoio.cc
128 proto_out
.write("gem5")
130 # Add the packet header
131 header
= inst_dep_record_pb2
.InstDepRecordHeader()
132 header
.obj_id
= "Converted ASCII trace " + sys
.argv
[1]
133 # Assume the default tick rate
134 header
.tick_freq
= 1000000000
135 header
.window_size
= 120
136 protolib
.encodeMessage(proto_out
, header
)
138 print "Creating enum name,value lookup from proto"
140 for namestr
, valdesc
in DepRecord
.DESCRIPTOR
.enum_values_by_name
.items():
141 print '\t', namestr
, valdesc
.number
142 enumValues
[namestr
] = valdesc
.number
145 # For each line in the ASCII trace, create a packet message and
146 # write it to the encoded output
147 for line
in ascii_in
:
148 inst_info_str
, rob_dep_str
, reg_dep_str
= (line
.strip()).split(':')
149 inst_info_list
= inst_info_str
.split(',')
150 dep_record
= DepRecord()
152 dep_record
.seq_num
= long(inst_info_list
[0])
153 dep_record
.pc
= long(inst_info_list
[1])
154 dep_record
.weight
= long(inst_info_list
[2])
155 # If the type is not one of the enum values, it should be a key error
157 dep_record
.type = enumValues
[inst_info_list
[3]]
159 print "Seq. num", dep_record
.seq_num
, "has unsupported type", \
163 if dep_record
.type == DepRecord
.INVALID
:
164 print "Seq. num", dep_record
.seq_num
, "is of INVALID type"
167 # If the instruction is a load or store record the physical addr,
168 # size flags in addition to recording the computation delay
169 if dep_record
.type in [DepRecord
.LOAD
, DepRecord
.STORE
]:
170 p_addr
, size
, flags
, comp_delay
= inst_info_list
[4:8]
171 dep_record
.p_addr
= long(p_addr
)
172 dep_record
.size
= int(size
)
173 dep_record
.flags
= int(flags
)
174 dep_record
.comp_delay
= long(comp_delay
)
176 comp_delay
= inst_info_list
[4]
177 dep_record
.comp_delay
= long(comp_delay
)
179 # Parse the register and order dependencies both of which are
180 # repeated fields. An empty list is valid.
181 rob_deps
= rob_dep_str
.strip().split(',')
182 for a_dep
in rob_deps
:
183 # if the string is empty, split(',') returns 1 item: ''
184 # if the string is ",4", split(',') returns 2 items: '', '4'
185 # long('') gives error, so check if the item is non-empty
187 dep_record
.rob_dep
.append(long(a_dep
))
189 reg_deps
= reg_dep_str
.split(',')
190 for a_dep
in reg_deps
:
192 dep_record
.reg_dep
.append(long(a_dep
))
194 protolib
.encodeMessage(proto_out
, dep_record
)
197 print "Converted", num_records
, "records."
202 if __name__
== "__main__":