Skip to content

libdebug.data.breakpoint

Breakpoint dataclass

A breakpoint in the target process.

Attributes:

Name Type Description
address int

The address of the breakpoint in the target process.
symbol str

The symbol, if available, of the breakpoint in the target process.
hit_count int

The number of times this specific breakpoint has been hit.
hardware bool

Whether the breakpoint is a hardware breakpoint or not.
callback Callable[[ThreadContext, Breakpoint], None]

The callback defined by the user to execute when the breakpoint is hit.
condition str

The breakpoint condition. Available values are "X", "W", "RW". Supported only for hardware breakpoints.
length int

The length of the breakpoint area. Supported only for hardware breakpoints.
enabled bool

Whether the breakpoint is enabled or not.
Source code in libdebug/data/breakpoint.py 
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
70
71
72
73
74
75
76
77
@dataclass
class Breakpoint:
    """A breakpoint in the target process.

    Attributes:
        address (int): The address of the breakpoint in the target process.
        symbol (str): The symbol, if available, of the breakpoint in the target process.
        hit_count (int): The number of times this specific breakpoint has been hit.
        hardware (bool): Whether the breakpoint is a hardware breakpoint or not.
        callback (Callable[[ThreadContext, Breakpoint], None]): The callback defined by the user to execute when the breakpoint is hit.
        condition (str): The breakpoint condition. Available values are "X", "W", "RW". Supported only for hardware breakpoints.
        length (int): The length of the breakpoint area. Supported only for hardware breakpoints.
        enabled (bool): Whether the breakpoint is enabled or not.
    """

    address: int = 0
    symbol: str = ""
    hit_count: int = 0
    hardware: bool = False
    callback: None | Callable[[ThreadContext, Breakpoint], None] = None
    condition: str = "x"
    length: int = 1
    enabled: bool = True

    _linked_thread_ids: list[int] = field(default_factory=list)
    # The thread ID that hit the breakpoint

    _disabled_for_step: bool = False
    _changed: bool = False

    def enable(self: Breakpoint) -> None:
        """Enable the breakpoint."""
        provide_internal_debugger(self)._ensure_process_stopped()
        self.enabled = True
        self._changed = True

    def disable(self: Breakpoint) -> None:
        """Disable the breakpoint."""
        provide_internal_debugger(self)._ensure_process_stopped()
        self.enabled = False
        self._changed = True

    def hit_on(self: Breakpoint, thread_context: ThreadContext) -> bool:
        """Returns whether the breakpoint has been hit on the given thread context."""
        if not self.enabled:
            return False

        internal_debugger = provide_internal_debugger(self)
        internal_debugger._ensure_process_stopped()
        return internal_debugger.resume_context.event_hit_ref.get(thread_context.thread_id) == self

    def __hash__(self: Breakpoint) -> int:
        """Hash the breakpoint by its address, so that it can be used in sets and maps correctly."""
        return hash(self.address)

    def __eq__(self: Breakpoint, other: object) -> bool:
        """Check if two breakpoints are equal."""
        return id(self) == id(other)

__eq__(other)

Check if two breakpoints are equal.

Source code in libdebug/data/breakpoint.py 
75
76
77
def __eq__(self: Breakpoint, other: object) -> bool:
    """Check if two breakpoints are equal."""
    return id(self) == id(other)

__hash__()

Hash the breakpoint by its address, so that it can be used in sets and maps correctly.

Source code in libdebug/data/breakpoint.py 
71
72
73
def __hash__(self: Breakpoint) -> int:
    """Hash the breakpoint by its address, so that it can be used in sets and maps correctly."""
    return hash(self.address)

disable()

Disable the breakpoint.

Source code in libdebug/data/breakpoint.py 
56
57
58
59
60
def disable(self: Breakpoint) -> None:
    """Disable the breakpoint."""
    provide_internal_debugger(self)._ensure_process_stopped()
    self.enabled = False
    self._changed = True

enable()

Enable the breakpoint.

Source code in libdebug/data/breakpoint.py 
50
51
52
53
54
def enable(self: Breakpoint) -> None:
    """Enable the breakpoint."""
    provide_internal_debugger(self)._ensure_process_stopped()
    self.enabled = True
    self._changed = True

hit_on(thread_context)

Returns whether the breakpoint has been hit on the given thread context.

Source code in libdebug/data/breakpoint.py 
62
63
64
65
66
67
68
69
def hit_on(self: Breakpoint, thread_context: ThreadContext) -> bool:
    """Returns whether the breakpoint has been hit on the given thread context."""
    if not self.enabled:
        return False

    internal_debugger = provide_internal_debugger(self)
    internal_debugger._ensure_process_stopped()
    return internal_debugger.resume_context.event_hit_ref.get(thread_context.thread_id) == self