libdebug.snapshots.memory.memory_map_snapshot

MemoryMapSnapshot dataclass

Bases: MemoryMap

A snapshot of the memory map of the target process.

Attributes:

Name	Type	Description
start	int	The start address of the memory map. You can access it also with the 'base' attribute.
end	int	The end address of the memory map.
permissions	str	The permissions of the memory map.
size	int	The size of the memory map.
offset	int	The relative offset of the memory map.
backing_file	str	The backing file of the memory map, or the symbolic name of the memory map.
content	bytes	The content of the memory map, used for snapshotted pages.

Source code in libdebug/snapshots/memory/memory_map_snapshot.py

@dataclass
class MemoryMapSnapshot(MemoryMap):
    """A snapshot of the memory map of the target process.

    Attributes:
        start (int): The start address of the memory map. You can access it also with the 'base' attribute.
        end (int): The end address of the memory map.
        permissions (str): The permissions of the memory map.
        size (int): The size of the memory map.
        offset (int): The relative offset of the memory map.
        backing_file (str): The backing file of the memory map, or the symbolic name of the memory map.
        content (bytes): The content of the memory map, used for snapshotted pages.
    """

    content: bytes = None
    """The content of the memory map, used for snapshotted pages."""

    def is_same_identity(self: MemoryMapSnapshot, other: MemoryMap) -> bool:
        """Check if the memory map corresponds to another memory map."""
        return self.start == other.start and self.backing_file == other.backing_file

    def __repr__(self: MemoryMapSnapshot) -> str:
        """Return the string representation of the memory map."""
        str_repr = super().__repr__()

        if self.content is not None:
            str_repr = str_repr[:-1] + ", content=...)"

        return str_repr

    def __eq__(self, value: object) -> bool:
        """Check if this MemoryMap is equal to another object.

        Args:
            value (object): The object to compare to.

        Returns:
            bool: True if the objects are equal, False otherwise.
        """
        if not isinstance(value, MemoryMap):
            return False

        is_snapshot_map = isinstance(value, MemoryMapSnapshot)

        is_content_map_1 = self.content is not None
        is_content_map_2 = is_snapshot_map and value.content is not None

        if is_content_map_1 != is_content_map_2:
            liblog.warning("Comparing a memory map snapshot with content with a memory map without content. Equality will not take into account the content.") 

        # Check if the content is available and if it is the same
        should_compare_content = is_snapshot_map and is_content_map_1 and is_content_map_2
        same_content = not should_compare_content or self.content == value.content

        return (
            self.start == value.start
            and self.end == value.end
            and self.permissions == value.permissions
            and self.size == value.size
            and self.offset == value.offset
            and self.backing_file == value.backing_file
            and same_content
        )

content = None class-attribute instance-attribute

The content of the memory map, used for snapshotted pages.

__eq__(value)

Check if this MemoryMap is equal to another object.

Parameters:

Name	Type	Description	Default
value	object	The object to compare to.	required

Returns:

Name	Type	Description
bool	bool	True if the objects are equal, False otherwise.

Source code in libdebug/snapshots/memory/memory_map_snapshot.py

def __eq__(self, value: object) -> bool:
    """Check if this MemoryMap is equal to another object.

    Args:
        value (object): The object to compare to.

    Returns:
        bool: True if the objects are equal, False otherwise.
    """
    if not isinstance(value, MemoryMap):
        return False

    is_snapshot_map = isinstance(value, MemoryMapSnapshot)

    is_content_map_1 = self.content is not None
    is_content_map_2 = is_snapshot_map and value.content is not None

    if is_content_map_1 != is_content_map_2:
        liblog.warning("Comparing a memory map snapshot with content with a memory map without content. Equality will not take into account the content.") 

    # Check if the content is available and if it is the same
    should_compare_content = is_snapshot_map and is_content_map_1 and is_content_map_2
    same_content = not should_compare_content or self.content == value.content

    return (
        self.start == value.start
        and self.end == value.end
        and self.permissions == value.permissions
        and self.size == value.size
        and self.offset == value.offset
        and self.backing_file == value.backing_file
        and same_content
    )

__repr__()

Return the string representation of the memory map.

Source code in libdebug/snapshots/memory/memory_map_snapshot.py

def __repr__(self: MemoryMapSnapshot) -> str:
    """Return the string representation of the memory map."""
    str_repr = super().__repr__()

    if self.content is not None:
        str_repr = str_repr[:-1] + ", content=...)"

    return str_repr

is_same_identity(other)

Check if the memory map corresponds to another memory map.

Source code in libdebug/snapshots/memory/memory_map_snapshot.py

def is_same_identity(self: MemoryMapSnapshot, other: MemoryMap) -> bool:
    """Check if the memory map corresponds to another memory map."""
    return self.start == other.start and self.backing_file == other.backing_file