1#!/usr/bin/env python2.7
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.
42
43import os
44import protolib
45import subprocess
46import sys
47
48util_dir = os.path.dirname(os.path.realpath(__file__))
49# Make sure the proto definitions are up to date.
50subprocess.check_call(['make', '--quiet', '-C', util_dir, 'packet_pb2.py'])
51import packet_pb2
52
53def main():
54    if len(sys.argv) != 3:
55        print "Usage: ", sys.argv[0], " <protobuf input> <ASCII output>"
56        exit(-1)
57
58    # Open the file in read mode
59    proto_in = protolib.openFileRd(sys.argv[1])
60
61    try:
62        ascii_out = open(sys.argv[2], 'w')
63    except IOError:
64        print "Failed to open ", sys.argv[2], " for writing"
65        exit(-1)
66
67    # Read the magic number in 4-byte Little Endian
68    magic_number = proto_in.read(4)
69
70    if magic_number != "gem5":
71        print "Unrecognized file", sys.argv[1]
72        exit(-1)
73
74    print "Parsing packet header"
75
76    # Add the packet header
77    header = packet_pb2.PacketHeader()
78    protolib.decodeMessage(proto_in, header)
79
80    print "Object id:", header.obj_id
81    print "Tick frequency:", header.tick_freq
82
83    for id_string in header.id_strings:
84        print 'Master id %d: %s' % (id_string.key, id_string.value)
85
86    print "Parsing packets"
87
88    num_packets = 0
89    packet = packet_pb2.Packet()
90
91    # Decode the packet messages until we hit the end of the file
92    while protolib.decodeMessage(proto_in, packet):
93        num_packets += 1
94        # ReadReq is 1 and WriteReq is 4 in src/mem/packet.hh Command enum
95        cmd = 'r' if packet.cmd == 1 else ('w' if packet.cmd == 4 else 'u')
96        if packet.HasField('pkt_id'):
97            ascii_out.write('%s,' % (packet.pkt_id))
98        if packet.HasField('flags'):
99            ascii_out.write('%s,%s,%s,%s,%s' % (cmd, packet.addr, packet.size,
100                            packet.flags, packet.tick))
101        else:
102            ascii_out.write('%s,%s,%s,%s' % (cmd, packet.addr, packet.size,
103                                           packet.tick))
104        if packet.HasField('pc'):
105            ascii_out.write(',%s\n' % (packet.pc))
106        else:
107            ascii_out.write('\n')
108
109    print "Parsed packets:", num_packets
110
111    # We're done
112    ascii_out.close()
113    proto_in.close()
114
115if __name__ == "__main__":
116    main()
117