decode_packet_trace.py revision 10132:894ec19274e9 
1#!/usr/bin/env python
2
3# Copyright (c) 2013-2014 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# Authors: Andreas Hansson
39
40# This script is used to dump protobuf packet traces to ASCII
41# format. It assumes that protoc has been executed and already
42# generated the Python package for the packet messages. This can
43# be done manually using:
44# protoc --python_out=. --proto_path=src/proto src/proto/packet.proto
45#
46# The ASCII trace format uses one line per request on the format cmd,
47# addr, size, tick,flags. For example:
48# r,128,64,4000,0
49# w,232123,64,500000,0
50
51import gzip
52import protolib
53import sys
54
55# Import the packet proto definitions. If they are not found, attempt
56# to generate them automatically. This assumes that the script is
57# executed from the gem5 root.
58try:
59    import packet_pb2
60except:
61    print "Did not find packet proto definitions, attempting to generate"
62    from subprocess import call
63    error = call(['protoc', '--python_out=util', '--proto_path=src/proto',
64                  'src/proto/packet.proto'])
65    if not error:
66        print "Generated packet proto definitions"
67
68        try:
69            import google.protobuf
70        except:
71            print "Please install Python protobuf module"
72            exit(-1)
73
74        import packet_pb2
75    else:
76        print "Failed to import packet proto definitions"
77        exit(-1)
78
79def main():
80    if len(sys.argv) != 3:
81        print "Usage: ", sys.argv[0], " <protobuf input> <ASCII output>"
82        exit(-1)
83
84    try:
85        # First see if this file is gzipped
86        try:
87            # Opening the file works even if it is not a gzip file
88            proto_in = gzip.open(sys.argv[1], 'rb')
89
90            # Force a check of the magic number by seeking in the
91            # file. If we do not do it here the error will occur when
92            # reading the first message.
93            proto_in.seek(1)
94            proto_in.seek(0)
95        except IOError:
96            proto_in = open(sys.argv[1], 'rb')
97    except IOError:
98        print "Failed to open ", sys.argv[1], " for reading"
99        exit(-1)
100
101    try:
102        ascii_out = open(sys.argv[2], 'w')
103    except IOError:
104        print "Failed to open ", sys.argv[2], " for writing"
105        exit(-1)
106
107    # Read the magic number in 4-byte Little Endian
108    magic_number = proto_in.read(4)
109
110    if magic_number != "gem5":
111        print "Unrecognized file", sys.argv[1]
112        exit(-1)
113
114    print "Parsing packet header"
115
116    # Add the packet header
117    header = packet_pb2.PacketHeader()
118    protolib.decodeMessage(proto_in, header)
119
120    print "Object id:", header.obj_id
121    print "Tick frequency:", header.tick_freq
122
123    print "Parsing packets"
124
125    num_packets = 0
126    packet = packet_pb2.Packet()
127
128    # Decode the packet messages until we hit the end of the file
129    while protolib.decodeMessage(proto_in, packet):
130        num_packets += 1
131        # ReadReq is 1 and WriteReq is 4 in src/mem/packet.hh Command enum
132        cmd = 'r' if packet.cmd == 1 else ('w' if packet.cmd == 4 else 'u')
133        if packet.HasField('pkt_id'):
134            ascii_out.write('%s,' % (packet.pkt_id))
135        if packet.HasField('flags'):
136            ascii_out.write('%s,%s,%s,%s,%s\n' % (cmd, packet.addr, packet.size,
137                            packet.flags, packet.tick))
138        else:
139            ascii_out.write('%s,%s,%s,%s\n' % (cmd, packet.addr, packet.size,
140                                           packet.tick))
141
142    print "Parsed packets:", num_packets
143
144    # We're done
145    ascii_out.close()
146    proto_in.close()
147
148if __name__ == "__main__":
149    main()
150