util/encode_packet_trace.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2013 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 # Authors: Andreas Hansson
  68 #
  69
  70 # This script is used to migrate ASCII packet traces to the protobuf
  71 # format currently used in gem5. It assumes that protoc has been
  72 # executed and already generated the Python package for the packet
  73 # messages. This can be done manually using:
  74 # protoc --python_out=. --proto_path=src/proto src/proto/packet.proto
  75 #
  76 # The ASCII trace format uses one line per request on the format cmd,
  77 # addr, size, tick. For example:
  78 # r,128,64,4000
  79 # w,232123,64,500000
  80 # This trace reads 64 bytes from decimal address 128 at tick 4000,
  81 # then writes 64 bytes to address 232123 at tick 500000.
  82 #
  83 # This script can of course also be used as a template to convert
  84 # other trace formats into the gem5 protobuf format
  85
  86 import struct
  87 import sys
  88 import packet_pb2
  89
  90 def EncodeVarint(out_file, value):
  91   """
  92   The encoding of the Varint32 is copied from
  93   google.protobuf.internal.encoder and is only repeated here to
  94   avoid depending on the internal functions in the library.
  95   """
  96   bits = value & 0x7f
  97   value >>= 7
  98   while value:
  99     out_file.write(struct.pack('<B', 0x80|bits))
 100     bits = value & 0x7f
 101     value >>= 7
 102   out_file.write(struct.pack('<B', bits))
 103
 104 def encodeMessage(out_file, message):
 105     """
 106     Encoded a message with the length prepended as a 32-bit varint.
 107     """
 108     out = message.SerializeToString()
 109     EncodeVarint(out_file, len(out))
 110     out_file.write(out)
 111
 112 def main():
 113     if len(sys.argv) != 3:
 114         print "Usage: ", sys.argv[0], " <ASCII input> <protobuf output>"
 115         exit(-1)
 116
 117     try:
 118         ascii_in = open(sys.argv[1], 'r')
 119     except IOError:
 120         print "Failed to open ", sys.argv[1], " for reading"
 121         exit(-1)
 122
 123     try:
 124         proto_out = open(sys.argv[2], 'wb')
 125     except IOError:
 126         print "Failed to open ", sys.argv[2], " for writing"
 127         exit(-1)
 128
 129     # Write the magic number in 4-byte Little Endian, similar to what
 130     # is done in src/proto/protoio.cc
 131     proto_out.write("gem5")
 132
 133     # Add the packet header
 134     header = packet_pb2.PacketHeader()
 135     header.obj_id = "Converted ASCII trace " + sys.argv[1]
 136     # Assume the default tick rate
 137     header.tick_freq = 1000000000
 138     encodeMessage(proto_out, header)
 139
 140     # For each line in the ASCII trace, create a packet message and
 141     # write it to the encoded output
 142     for line in ascii_in:
 143         cmd, addr, size, tick = line.split(',')
 144         packet = packet_pb2.Packet()
 145         packet.tick = long(tick)
 146         # ReadReq is 1 and WriteReq is 4 in src/mem/packet.hh Command enum
 147         packet.cmd = 1 if cmd == 'r' else 4
 148         packet.addr = long(addr)
 149         packet.size = int(size)
 150         encodeMessage(proto_out, packet)
 151
 152     # We're done
 153     ascii_in.close()
 154     proto_out.close()
 155
 156 if __name__ == "__main__":
 157     main()