Add in support for non-linear mapping.

volatility/framework/layers/segmented.py

@@ -17,7 +17,7 @@
 # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
 # specific language governing rights and limitations under the License.
 #
-
+import functools
 from abc import ABCMeta, abstractmethod
 from bisect import bisect_right
 from typing import Any, Dict, Iterable, List, Optional, Tuple
@@ -26,6 +26,68 @@ from volatility.framework import exceptions, interfaces
 from volatility.framework.configuration import requirements
 
 
+class LinearlyMappedLayer(interfaces.layers.TranslationLayerInterface):
+    """Class to differentiate Linearly Mapped layers (where a => b implies that a + c => b + c)"""
+
+    ### Translation layer convenience function
+
+    def translate(self, offset: int, ignore_errors: bool = False) -> Tuple[Optional[int], Optional[str]]:
+        mapping = list(self.mapping(offset, 0, ignore_errors))
+        if len(mapping) == 1:
+            original_offset, mapped_offset, _, layer = mapping[0]
+            if original_offset != offset:
+                raise exceptions.LayerException(self.name,
+                                                "Layer {} claims to map linearly but does not".format(self.name))
+        else:
+            if ignore_errors:
+                # We should only hit this if we ignored errors, but check anyway
+                return None, None
+            raise exceptions.InvalidAddressException(self.name, offset,
+                                                     "Cannot translate {} in layer {}".format(offset, self.name))
+        return mapped_offset, layer
+
+    # ## Read/Write functions for mapped pages
+    # Redefine read here for speed reasons (so we don't call a processing method
+
+    @functools.lru_cache(maxsize = 512)
+    def read(self, offset: int, length: int, pad: bool = False) -> bytes:
+        """Reads an offset for length bytes and returns 'bytes' (not 'str') of length size"""
+        current_offset = offset
+        output = []  # type: List[bytes]
+        for (offset, mapped_offset, mapped_length, layer) in self.mapping(offset, length, ignore_errors = pad):
+            if not pad and offset > current_offset:
+                raise exceptions.InvalidAddressException(
+                    self.name, current_offset, "Layer {} cannot map offset: {}".format(self.name, current_offset))
+            elif offset > current_offset:
+                output += [b"\x00" * (offset - current_offset)]
+                current_offset = offset
+            elif offset < current_offset:
+                raise exceptions.LayerException(self.name, "Mapping returned an overlapping element")
+            if mapped_length > 0:
+                output += [self._context.layers.read(layer, mapped_offset, mapped_length, pad)]
+            current_offset += mapped_length
+        recovered_data = b"".join(output)
+        return recovered_data + b"\x00" * (length - len(recovered_data))
+
+    def write(self, offset: int, value: bytes) -> None:
+        """Writes a value at offset, distributing the writing across any underlying mapping"""
+        current_offset = offset
+        length = len(value)
+        for (offset, mapped_offset, length, layer) in self.mapping(offset, length):
+            if offset > current_offset:
+                raise exceptions.InvalidAddressException(
+                    self.name, current_offset, "Layer {} cannot map offset: {}".format(self.name, current_offset))
+            elif offset < current_offset:
+                raise exceptions.LayerException(self.name, "Mapping returned an overlapping element")
+            self._context.layers.write(layer, mapped_offset, value[:length])
+            value = value[length:]
+            current_offset += length
+
+
+class NonLinearlyMappedLayer(interfaces.layers.TranslationLayerInterface):
+    """Class to allow layers which don't map linearly to exist"""
+
+
 class SegmentedLayer(interfaces.layers.TranslationLayerInterface, metaclass = ABCMeta):
     """A class to handle a single run-based layer-to-layer mapping