Skip to content

libdebug.data.memory_map

MemoryMap dataclass

A 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.
Source code in libdebug/data/memory_map.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
@dataclass(frozen=True)
class MemoryMap:
    """A 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.
    """

    start: int = 0
    end: int = 0
    permissions: str = ""
    size: int = 0

    offset: int = 0
    """The relative offset of the memory map inside the backing file, if any."""

    backing_file: str = ""
    """The backing file of the memory map, such as 'libc.so.6', or the symbolic name of the memory map, such as '[stack]'."""

    @staticmethod
    def parse(vmap: str) -> MemoryMap:
        """Parses a memory map from a /proc/pid/maps string representation.

        Args:
            vmap (str): The string containing the memory map.

        Returns:
            MemoryMap: The parsed memory map.
        """
        try:
            address, permissions, offset, *_, backing_file = vmap.split(" ", 6)
            start = int(address.split("-")[0], 16)
            end = int(address.split("-")[1], 16)
            size = end - start
            int_offset = int(offset, 16)
            backing_file = backing_file.strip()
            if not backing_file:
                backing_file = f"anon_{start:x}"
        except ValueError as e:
            raise ValueError(
                f"Invalid memory map: {vmap}. Please specify a valid memory map.",
            ) from e

        return MemoryMap(start, end, permissions, size, int_offset, backing_file)

    @property
    def base(self: MemoryMap) -> int:
        """Alias for the start address of the memory map."""
        return self.start

    def __repr__(self: MemoryMap) -> str:
        """Return the string representation of the memory map."""
        return f"MemoryMap(start={hex(self.start)}, end={hex(self.end)}, permissions={self.permissions}, size={hex(self.size)}, offset={hex(self.offset)}, backing_file={self.backing_file})"

backing_file: str = '' class-attribute instance-attribute

The backing file of the memory map, such as 'libc.so.6', or the symbolic name of the memory map, such as '[stack]'.

base: int property

Alias for the start address of the memory map.

offset: int = 0 class-attribute instance-attribute

The relative offset of the memory map inside the backing file, if any.

__repr__()

Return the string representation of the memory map.

Source code in libdebug/data/memory_map.py 
67
68
69
def __repr__(self: MemoryMap) -> str:
    """Return the string representation of the memory map."""
    return f"MemoryMap(start={hex(self.start)}, end={hex(self.end)}, permissions={self.permissions}, size={hex(self.size)}, offset={hex(self.offset)}, backing_file={self.backing_file})"

parse(vmap) staticmethod

Parses a memory map from a /proc/pid/maps string representation.

Parameters:

Name Type Description Default
vmap str

The string containing the memory map.

 required

Returns:

Name Type Description
MemoryMap MemoryMap

The parsed memory map.
Source code in libdebug/data/memory_map.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
@staticmethod
def parse(vmap: str) -> MemoryMap:
    """Parses a memory map from a /proc/pid/maps string representation.

    Args:
        vmap (str): The string containing the memory map.

    Returns:
        MemoryMap: The parsed memory map.
    """
    try:
        address, permissions, offset, *_, backing_file = vmap.split(" ", 6)
        start = int(address.split("-")[0], 16)
        end = int(address.split("-")[1], 16)
        size = end - start
        int_offset = int(offset, 16)
        backing_file = backing_file.strip()
        if not backing_file:
            backing_file = f"anon_{start:x}"
    except ValueError as e:
        raise ValueError(
            f"Invalid memory map: {vmap}. Please specify a valid memory map.",
        ) from e

    return MemoryMap(start, end, permissions, size, int_offset, backing_file)