mem: Edit proto Packet and enhance the python script

This patch changes the decode script to output the optional fields of
the proto message Packet, namely id and flags. The flags field is set
by the communication monitor.

The id field is useful for CPU trace experiments, e.g. linking the
fetch side to decode side. It had to be renamed because it clashes
with a built in python function id() for getting the "identity" of an
object.

This patch also takes a few common function definitions out from the
multiple scripts and adds them to a protolib python module.

4 files changed, 154 insertions, 140 deletions

diff --git a/src/proto/packet.proto b/src/proto/packet.proto
index 957b494ab..a98df7efe 100644
--- a/src/proto/packet.proto
+++ b/src/proto/packet.proto
@@ -61,5 +61,5 @@ message Packet {
   required uint64 addr = 3;
   required uint32 size = 4;
   optional uint32 flags = 5;
-  optional uint64 id = 6;
+  optional uint64 pkt_id = 6;
 }
diff --git a/util/decode_packet_trace.py b/util/decode_packet_trace.py
index da9a7aa83..61a4c34ac 100755
--- a/util/decode_packet_trace.py
+++ b/util/decode_packet_trace.py
@@ -35,37 +35,7 @@
 # (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 dump protobuf packet traces to ASCII
 # format. It assumes that protoc has been executed and already
@@ -78,7 +48,7 @@
 # r,128,64,4000,0
 # w,232123,64,500000,0
 
-import struct
+import protolib
 import sys
 
 # Import the packet proto definitions. If they are not found, attempt
@@ -105,51 +75,6 @@ except:
         print "Failed to import packet proto definitions"
         exit(-1)
 
-def DecodeVarint(in_file):
-    """
-    The decoding of the Varint32 is copied from
-    google.protobuf.internal.decoder and is only repeated here to
-    avoid depending on the internal functions in the library. If the
-    end of file is reached, return (0, 0).
-    """
-    result = 0
-    shift = 0
-    pos = 0
-    # Use a 32-bit mask
-    mask = 0xffffffff
-    while 1:
-        c = in_file.read(1)
-        if len(c) == 0:
-            return (0, 0)
-        b = struct.unpack('<B', c)[0]
-        result |= ((b & 0x7f) << shift)
-        pos += 1
-        if not (b & 0x80):
-            if result > 0x7fffffffffffffff:
-                result -= (1 << 64)
-                result |= ~mask
-            else:
-                result &= mask
-                return (result, pos)
-            shift += 7
-            if shift >= 64:
-                raise IOError('Too many bytes when decoding varint.')
-
-def decodeMessage(in_file, message):
-    """
-    Attempt to read a message from the file and decode it. Return
-    False if no message could be read.
-    """
-    try:
-        size, pos = DecodeVarint(in_file)
-        if size == 0:
-            return False
-        buf = in_file.read(size)
-        message.ParseFromString(buf)
-        return True
-    except IOError:
-        return False
-
 def main():
     if len(sys.argv) != 3:
         print "Usage: ", sys.argv[0], " <protobuf input> <ASCII output>"
@@ -178,7 +103,7 @@ def main():
 
     # Add the packet header
     header = packet_pb2.PacketHeader()
-    decodeMessage(proto_in, header)
+    protolib.decodeMessage(proto_in, header)
 
     print "Object id:", header.obj_id
     print "Tick frequency:", header.tick_freq
@@ -186,23 +111,23 @@ def main():
     print "Parsing packets"
 
     num_packets = 0
-    ignored_flags = False
     packet = packet_pb2.Packet()
 
     # Decode the packet messages until we hit the end of the file
-    while decodeMessage(proto_in, packet):
+    while protolib.decodeMessage(proto_in, packet):
         num_packets += 1
         # ReadReq is 1 and WriteReq is 4 in src/mem/packet.hh Command enum
         cmd = 'r' if packet.cmd == 1 else ('w' if packet.cmd == 4 else 'u')
+        if packet.HasField('pkt_id'):
+            ascii_out.write('%s,' % (packet.pkt_id))
         if packet.HasField('flags'):
-            # Currently not printing flags
-            ignored_flags = True
-        ascii_out.write('%s,%s,%s,%s\n' % (cmd, packet.addr, packet.size,
+            ascii_out.write('%s,%s,%s,%s,%s\n' % (cmd, packet.addr, packet.size,
+                            packet.flags, packet.tick))
+        else:
+            ascii_out.write('%s,%s,%s,%s\n' % (cmd, packet.addr, packet.size,
                                            packet.tick))
 
     print "Parsed packets:", num_packets
-    if ignored_flags:
-        print "Encountered packet flags that were ignored"
 
     # We're done
     ascii_out.close()
diff --git a/util/encode_packet_trace.py b/util/encode_packet_trace.py
index 13057a13d..bee26f01c 100755
--- a/util/encode_packet_trace.py
+++ b/util/encode_packet_trace.py
@@ -35,37 +35,7 @@
 # (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,7 +53,7 @@
 # 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 the packet proto definitions. If they are not found, attempt
@@ -110,28 +80,6 @@ except:
         print "Failed to import packet proto definitions"
         exit(-1)
 
-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))
-
-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)
-
 def main():
     if len(sys.argv) != 3:
         print "Usage: ", sys.argv[0], " <ASCII input> <protobuf output>"
@@ -158,7 +106,7 @@ def main():
     header.obj_id = "Converted ASCII trace " + sys.argv[1]
     # Assume the default tick rate
     header.tick_freq = 1000000000
-    encodeMessage(proto_out, header)
+    protolib.encodeMessage(proto_out, header)
 
     # For each line in the ASCII trace, create a packet message and
     # write it to the encoded output
@@ -170,7 +118,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()
diff --git a/util/protolib.py b/util/protolib.py
new file mode 100644
index 000000000..e085a90f2
--- /dev/null
+++ b/util/protolib.py
@@ -0,0 +1,141 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2013 ARM Limited
+# All rights reserved
+#
+# The license below extends only to copyright in the software and shall
+# not be construed as granting a license to any other intellectual
+# property including but not limited to intellectual property relating
+# to a hardware implementation of the functionality of the software
+# licensed hereunder.  You may use the software subject to the license
+# terms below provided that you ensure that this notice is replicated
+# unmodified and in its entirety in all distributions of the software,
+# modified or unmodified, in source code or in binary form.
+#
+# 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 the copyright holders 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.
+#
+# 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
+#          Radhika Jagtap
+
+# This file is a library of commonly used functions used when interfacing
+# with protobuf python messages. For eg, the decode scripts for different
+# types of proto objects can use the same function to decode a single message
+
+import struct
+
+def DecodeVarint(in_file):
+    """
+    The decoding of the Varint32 is copied from
+    google.protobuf.internal.decoder and is only repeated here to
+    avoid depending on the internal functions in the library. If the
+    end of file is reached, return (0, 0).
+    """
+    result = 0
+    shift = 0
+    pos = 0
+    # Use a 32-bit mask
+    mask = 0xffffffff
+    while 1:
+        c = in_file.read(1)
+        if len(c) == 0:
+            return (0, 0)
+        b = struct.unpack('<B', c)[0]
+        result |= ((b & 0x7f) << shift)
+        pos += 1
+        if not (b & 0x80):
+            if result > 0x7fffffffffffffff:
+                result -= (1 << 64)
+                result |= ~mask
+            else:
+                result &= mask
+                return (result, pos)
+            shift += 7
+            if shift >= 64:
+                raise IOError('Too many bytes when decoding varint.')
+
+def decodeMessage(in_file, message):
+    """
+    Attempt to read a message from the file and decode it. Return
+    False if no message could be read.
+    """
+    try:
+        size, pos = DecodeVarint(in_file)
+        if size == 0:
+            return False
+        buf = in_file.read(size)
+        message.ParseFromString(buf)
+        return True
+    except IOError:
+        return False
+
+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))
+
+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)