Integrating latest 47acbe8

Tools/EventLogTools/EventLogger/Reader.py

@@ -0,0 +1,100 @@
+#
+# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
+# its licensors.
+#
+# For complete copyright and license terms please see the LICENSE at the root of this
+# distribution (the "License"). All use of this software is governed by the License,
+# or, if provided, by the license below or the license accompanying this file. Do not
+# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#
+
+from EventLogger.Utils import EventBoundary, EventHeader, EventNameHash, LogHeader, Prolog, PrologId
+
+
+def size_align_up(size, align):
+    return (size + (align - 1)) & ~(align - 1)
+
+
+class Reader(object):
+
+    ReadStatus_Success = 0
+    ReadStatus_InsufficientFileSize = -1
+    ReadStatus_InvalidFormat = -2
+    ReadStatus_NoEvents = -3
+
+    def __init__(self):
+        self.log_header = LogHeader()
+
+        self.current_event = EventHeader()
+        self.current_thread_id = None
+
+        self.buffer = None
+        self.buffer_size = 0
+        self.buffer_pos = 0
+
+    def read_log_file(self, file_path):
+        with open(file_path, mode='rb') as log_file:
+            self.buffer = log_file.read()
+            self.buffer_size = len(self.buffer)
+
+        if self.buffer_size < LogHeader.size():
+            return Reader.ReadStatus_InsufficientFileSize
+
+        self.log_header.unpack(self.buffer)
+        self.buffer_pos = LogHeader.size()
+
+        if self.log_header.get_format() not in LogHeader.accepted_formats():
+            return Reader.ReadStatus_InvalidFormat
+
+        if self.buffer_pos + EventHeader.size() > self.buffer_size:
+            return Reader.ReadStatus_NoEvents
+
+        self.current_event.unpack(self._get_next(EventHeader.size()))
+        self._update_thread_id()
+
+        return Reader.ReadStatus_Success
+
+    def get_log_header(self):
+        return self.log_header
+
+    def get_thread_id(self):
+        return self.current_thread_id
+
+    def get_event_name(self):
+        return EventNameHash(self.current_event.event_id)
+
+    def get_event_size(self):
+        return self.current_event.size
+
+    def get_event_flags(self):
+        return self.current_event.flags
+
+    def get_event_data(self):
+        start = self.buffer_pos + EventHeader.size()
+        return self._get_next(self.get_event_size(), override_start=start)
+
+    def get_event_string(self):
+        string_data = self.get_event_data()
+        return string_data.decode('utf-8')
+
+    def next(self):
+        real_size = EventHeader.size() + self.get_event_size()
+        self.buffer_pos += size_align_up(real_size, EventBoundary)
+        if self.buffer_pos < self.buffer_size:
+            self.current_event.unpack(self._get_next(EventHeader.size()))
+            self._update_thread_id()
+            return True
+        return False
+
+    def _get_next(self, size, override_start=None):
+        start = override_start or self.buffer_pos
+        end = start + size
+        return self.buffer[start:end]
+
+    def _update_thread_id(self):
+        if self.get_event_name() == PrologId:
+            prolog = Prolog()
+            prolog.unpack(self._get_next(Prolog.size()))
+            self.current_thread_id = prolog.thread_id
+

Tools/EventLogTools/EventLogger/Utils.py

@@ -0,0 +1,121 @@
+#
+# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
+# its licensors.
+#
+# For complete copyright and license terms please see the LICENSE at the root of this
+# distribution (the "License"). All use of this software is governed by the License,
+# or, if provided, by the license below or the license accompanying this file. Do not
+# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#
+
+import struct
+import sys
+
+# Simple hash structure based on DJB2a
+class EventNameHash(object):
+
+    def __init__(self, name):
+        if isinstance(name, int):
+            self.hash = name
+        else:
+            value = 5381
+            for i in range(len(name)):
+                value = ((value << 5) + value) ^ ord(name[i])
+            self.hash = value & 0xFFFFFFFF
+
+    def __hash__(self):
+        return self.hash
+
+    def __eq__(self, rhs):
+        if isinstance(rhs, EventNameHash):
+            return self.hash == rhs.hash
+        else:
+            return self.hash == rhs
+
+
+PrologId = EventNameHash("Prolog")
+EventBoundary = 8
+
+
+class LogStructBase(object):
+
+    def _unpack(self, member_info, data):
+        pos = 0
+        for (member, data_format, data_size) in member_info:
+            pos_end = pos + data_size
+            unpacked_value = struct.unpack(data_format, data[pos:pos_end])
+            setattr(self, member, unpacked_value[0])
+            pos = pos_end
+
+
+class LogHeader(LogStructBase):
+
+    @staticmethod
+    def size():
+        return 16
+
+    @staticmethod
+    def accepted_formats():
+        return ['AZEL']
+
+    def __init__(self):
+        self.four_cc = None
+        self.major_version = None
+        self.minor_version = None
+        self.user_version = None
+
+    def unpack(self, data):
+        member_info = [
+            ('four_cc', '@4s', 4),
+            ('major_version', '@I', 4),
+            ('minor_version', '@I', 4),
+            ('user_version', '@I', 4),
+        ]
+        self._unpack(member_info, data)
+
+    def get_format(self):
+        return self.four_cc.decode('utf-8')
+
+    def get_version(self):
+        return f'{self.major_version}.{self.minor_version} ({self.user_version})'
+
+
+class EventHeader(LogStructBase):
+
+    @staticmethod
+    def size():
+        return 8
+
+    def __init__(self):
+        self.event_id = None
+        self.size = None
+        self.flags = None
+
+    def unpack(self, data):
+        member_info = [
+            ('event_id', '@I', 4),
+            ('size', '@H', 2),
+            ('flags', '@H', 2),
+        ]
+        self._unpack(member_info, data)
+
+
+class Prolog(EventHeader):
+
+    @staticmethod
+    def size():
+        return 16
+
+    def __init__(self):
+        super().__init__()
+        self.thread_id = None
+
+    def unpack(self, data):
+        member_info = [
+            ('event_id', '@I', 4),
+            ('size', '@H', 2),
+            ('flags', '@H', 2),
+            ('thread_id', '@Q', 8)
+        ]
+        self._unpack(member_info, data)

Tools/EventLogTools/EventLogger/__init__.py

@@ -0,0 +1,10 @@
+#
+# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
+# its licensors.
+#
+# For complete copyright and license terms please see the LICENSE at the root of this
+# distribution (the "License"). All use of this software is governed by the License,
+# or, if provided, by the license below or the license accompanying this file. Do not
+# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#