Core: Initial addition of cache control

volatility/framework/constants/__init__.py

@@ -66,10 +66,13 @@ if sys.platform == 'windows':
 os.makedirs(CACHE_PATH, exist_ok = True)
 
 LINUX_BANNERS_PATH = os.path.join(CACHE_PATH, "linux_banners.cache")
-""""Default location to record information about available linux banners"""
+"""Default location to record information about available linux banners"""
 
 MAC_BANNERS_PATH = os.path.join(CACHE_PATH, "mac_banners.cache")
-""""Default location to record information about available mac banners"""
+"""Default location to record information about available mac banners"""
+
+CACHING = True
+"""Allows the disabling of caching for reads (which vastly speeds up object accesses and layer scanning)"""
 
 BUG_URL = "https://github.com/volatilityfoundation/volatility3/issues"
 

volatility/framework/contexts/__init__.py

@@ -12,7 +12,7 @@ import functools
 import hashlib
 from typing import Callable, Dict, Iterable, List, Optional, Set, Tuple, Union
 
-from volatility.framework import constants, interfaces, symbols, exceptions
+from volatility.framework import constants, interfaces, symbols, exceptions, caching
 from volatility.framework.objects import templates
 
 
@@ -277,7 +277,7 @@ class SizedModule(Module):
         return self._size
 
     @property  # type: ignore # FIXME: mypy #5107
-    @functools.lru_cache()
+    @caching.lru_cache()
     def hash(self) -> str:
         """Hashes the module for equality checks.
 

volatility/framework/interfaces/layers.py

@@ -18,7 +18,7 @@ import types
 from abc import ABCMeta, abstractmethod
 from typing import Any, Callable, Dict, Iterable, List, Mapping, Optional, Tuple, Union
 
-from volatility.framework import constants, exceptions, interfaces
+from volatility.framework import constants, exceptions, interfaces, caching
 
 vollog = logging.getLogger(__name__)
 
@@ -419,7 +419,7 @@ class TranslationLayerInterface(DataLayerInterface, metaclass = ABCMeta):
 
     # ## Read/Write functions for mapped pages
 
-    @functools.lru_cache(maxsize = 512)
+    @caching.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."""

volatility/framework/layers/intel.py

@@ -3,14 +3,13 @@
 #
 
 import collections
-import functools
 import logging
 import math
 import struct
 from typing import Any, Dict, Iterable, List, Optional, Tuple
 
 from volatility import classproperty
-from volatility.framework import exceptions, interfaces, constants
+from volatility.framework import exceptions, interfaces, constants, caching
 from volatility.framework.configuration import requirements
 from volatility.framework.layers import linear
 
@@ -156,7 +155,7 @@ class Intel(linear.LinearlyMappedLayer):
 
         return entry, position
 
-    @functools.lru_cache(1025)
+    @caching.lru_cache(1025)
     def _get_valid_table(self, base_address: int) -> Optional[bytes]:
         """Extracts the table, validates it and returns it if it's valid."""
         table = self._context.layers.read(self._base_layer, base_address, self.page_size)

volatility/framework/layers/linear.py

@@ -1,7 +1,6 @@
-import functools
 from typing import List, Optional, Tuple, Iterable
 
-from volatility.framework import exceptions, interfaces
+from volatility.framework import exceptions, interfaces, caching
 
 
 class LinearlyMappedLayer(interfaces.layers.TranslationLayerInterface):
@@ -28,7 +27,7 @@ class LinearlyMappedLayer(interfaces.layers.TranslationLayerInterface):
     # ## 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)
+    @caching.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."""

volatility/framework/layers/qemu.py

@@ -6,7 +6,7 @@ import json
 import math
 from typing import Optional, Dict, Any, Tuple, List, Set
 
-from volatility.framework import interfaces, exceptions, constants
+from volatility.framework import interfaces, exceptions, constants, caching
 from volatility.framework.layers import segmented
 from volatility.framework.symbols import intermed
 
@@ -212,7 +212,7 @@ class QemuSuspendLayer(segmented.NonLinearlySegmentedLayer):
             return (data * 0x1000)[:output_length]
         return data
 
-    @functools.lru_cache(maxsize = 512)
+    @caching.lru_cache(maxsize = 512)
     def read(self, offset: int, length: int, pad: bool = False) -> bytes:
         return super().read(offset, length, pad)
 

volatility/framework/symbols/windows/extensions/__init__.py

@@ -4,13 +4,11 @@
 
 import collections.abc
 import datetime
-import functools
 import logging
-import struct
 import math
-from typing import Iterable, Iterator, Optional, Union, Dict, Tuple, List
+from typing import Iterable, Iterator, Optional, Union, Tuple, List
 
-from volatility.framework import constants, exceptions, interfaces, objects, renderers, symbols
+from volatility.framework import constants, exceptions, interfaces, objects, renderers, symbols, caching
 from volatility.framework.layers import intel
 from volatility.framework.renderers import conversion
 from volatility.framework.symbols import generic
@@ -36,7 +34,7 @@ class MMVAD_SHORT(objects.StructType):
     by VadRoot.
     """
 
-    @functools.lru_cache(maxsize = None)
+    @caching.lru_cache(maxsize = None)
     def get_tag(self):
         vad_address = self.vol.offset
 
@@ -896,8 +894,8 @@ class CONTROL_AREA(objects.StructType):
                 return False
 
             # The first SubsectionBase should not be page aligned
-            #subsection = self.get_subsection()
-            #if subsection.SubsectionBase & self.PAGE_MASK == 0:
+            # subsection = self.get_subsection()
+            # if subsection.SubsectionBase & self.PAGE_MASK == 0:
             #    return False
         except exceptions.InvalidAddressException:
             return False
@@ -946,7 +944,7 @@ class CONTROL_AREA(objects.StructType):
             subsection_offset = starting_sector * 0x200
 
             # Similar to the check in is_valid(), make sure the SubsectionBase is not page aligned.
-            #if subsection.SubsectionBase & self.PAGE_MASK == 0:
+            # if subsection.SubsectionBase & self.PAGE_MASK == 0:
             #    break
 
             ptecount = 0

volatility/framework/symbols/windows/extensions/pool.py

@@ -1,9 +1,8 @@
-import functools
 import logging
 import struct
 from typing import Optional, Tuple, List, Dict, Union
 
-from volatility.framework import objects, interfaces, constants, symbols, exceptions, renderers
+from volatility.framework import objects, interfaces, constants, symbols, exceptions, renderers, caching
 from volatility.framework.renderers import conversion
 
 vollog = logging.getLogger(__name__)
@@ -165,7 +164,7 @@ class POOL_HEADER(objects.StructType):
         return None
 
     @classmethod
-    @functools.lru_cache()
+    @caching.lru_cache()
     def _calculate_optional_header_lengths(cls, context: interfaces.context.ContextInterface,
                                            symbol_table_name: str) -> Tuple[List[str], List[int]]:
         headers = []