util: Add a unit test for the m5 utility's "readfile" command.

[gem5.git] / util / encode_packet_trace.py

diff --git a/util/encode_packet_trace.py b/util/encode_packet_trace.py
index cbfc7d9213f9eae69e64f93de4277140c8adfde3..7ba80227ccb58ea0ee25e7121da00e0ec06bd0a1 100755 (executable)
--- a/util/encode_packet_trace.py
+++ b/util/encode_packet_trace.py
@@ -1,6 +1,6 @@
-#!/usr/bin/env python
+#!/usr/bin/env python2.7
 
-# Copyright (c) 2013 ARM Limited
+# Copyright (c) 2013-2014 ARM Limited
 # All rights reserved
 #
 # The license below extends only to copyright in the software and shall
@@ -34,38 +34,6 @@
 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-#
-# Copyright 2008 Google Inc.  All rights reserved.
-# http://code.google.com/p/protobuf/
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met:
-#
-#     * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-#     * Redistributions in binary form must reproduce the above
-# copyright notice, this list of conditions and the following disclaimer
-# in the documentation and/or other materials provided with the
-# distribution.
-#     * Neither the name of Google Inc. nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-#
-# Authors: Andreas Hansson
-#
 
 # This script is used to migrate ASCII packet traces to the protobuf
 # format currently used in gem5. It assumes that protoc has been
@@ -83,31 +51,32 @@
 # This script can of course also be used as a template to convert
 # other trace formats into the gem5 protobuf format
 
-import struct
+import protolib
 import sys
-import packet_pb2
 
-def EncodeVarint(out_file, value):
-  """
-  The encoding of the Varint32 is copied from
-  google.protobuf.internal.encoder and is only repeated here to
-  avoid depending on the internal functions in the library.
-  """
-  bits = value & 0x7f
-  value >>= 7
-  while value:
-    out_file.write(struct.pack('<B', 0x80|bits))
-    bits = value & 0x7f
-    value >>= 7
-  out_file.write(struct.pack('<B', bits))
+# Import the packet proto definitions. If they are not found, attempt
+# to generate them automatically. This assumes that the script is
+# executed from the gem5 root.
+try:
+    import packet_pb2
+except:
+    print "Did not find packet proto definitions, attempting to generate"
+    from subprocess import call
+    error = call(['protoc', '--python_out=util', '--proto_path=src/proto',
+                  'src/proto/packet.proto'])
+    if not error:
+        print "Generated packet proto definitions"
 
-def encodeMessage(out_file, message):
-    """
-    Encoded a message with the length prepended as a 32-bit varint.
-    """
-    out = message.SerializeToString()
-    EncodeVarint(out_file, len(out))
-    out_file.write(out)
+        try:
+            import google.protobuf
+        except:
+            print "Please install the Python protobuf module"
+            exit(-1)
+
+        import packet_pb2
+    else:
+        print "Failed to import packet proto definitions"
+        exit(-1)
 
 def main():
     if len(sys.argv) != 3:
@@ -134,8 +103,8 @@ def main():
     header = packet_pb2.PacketHeader()
     header.obj_id = "Converted ASCII trace " + sys.argv[1]
     # Assume the default tick rate
-    header.tick_freq = 1000000000
-    encodeMessage(proto_out, header)
+    header.tick_freq = 1000000000000
+    protolib.encodeMessage(proto_out, header)
 
     # For each line in the ASCII trace, create a packet message and
     # write it to the encoded output
@@ -147,7 +116,7 @@ def main():
         packet.cmd = 1 if cmd == 'r' else 4
         packet.addr = long(addr)
         packet.size = int(size)
-        encodeMessage(proto_out, packet)
+        protolib.encodeMessage(proto_out, packet)
 
     # We're done
     ascii_in.close()