Skip to content

libdebug.data.signal_catcher

SignalCatcher dataclass

Catch a signal raised by the target process.

Attributes:

Name Type Description
signal_number int

The signal number to catch.
callback Callable[[ThreadContext, CaughtSignal], None]

The callback defined by the user to execute when the signal is caught.
recursive bool

Whether, when the signal is hijacked with another one, the signal catcher associated with the new signal should be considered as well. Defaults to False.
enabled bool

Whether the signal will be caught or not.
hit_count int

The number of times the signal has been caught.
Source code in libdebug/data/signal_catcher.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
@dataclass
class SignalCatcher:
    """Catch a signal raised by the target process.

    Attributes:
        signal_number (int): The signal number to catch.
        callback (Callable[[ThreadContext, CaughtSignal], None]): The callback defined by the user to execute when the signal is caught.
        recursive (bool): Whether, when the signal is hijacked with another one, the signal catcher associated with the new signal should be considered as well. Defaults to False.
        enabled (bool): Whether the signal will be caught or not.
        hit_count (int): The number of times the signal has been caught.
    """

    signal_number: int
    callback: Callable[[ThreadContext, SignalCatcher], None]
    recursive: bool = True
    enabled: bool = True
    hit_count: int = 0

    def enable(self: SignalCatcher) -> None:
        """Enable the signal catcher."""
        provide_internal_debugger(self)._ensure_process_stopped()
        self.enabled = True

    def disable(self: SignalCatcher) -> None:
        """Disable the signal catcher."""
        provide_internal_debugger(self)._ensure_process_stopped()
        self.enabled = False

    def hit_on(self: SignalCatcher, thread_context: ThreadContext) -> bool:
        """Returns whether the signal catcher has been hit on the given thread context."""
        return self.enabled and thread_context.signal_number == self.signal_number

    def __hash__(self: SignalCatcher) -> int:
        """Return the hash of the signal catcher, based just on the signal number."""
        return hash(self.signal_number)

__hash__()

Return the hash of the signal catcher, based just on the signal number.

Source code in libdebug/data/signal_catcher.py 
52
53
54
def __hash__(self: SignalCatcher) -> int:
    """Return the hash of the signal catcher, based just on the signal number."""
    return hash(self.signal_number)

disable()

Disable the signal catcher.

Source code in libdebug/data/signal_catcher.py 
43
44
45
46
def disable(self: SignalCatcher) -> None:
    """Disable the signal catcher."""
    provide_internal_debugger(self)._ensure_process_stopped()
    self.enabled = False

enable()

Enable the signal catcher.

Source code in libdebug/data/signal_catcher.py 
38
39
40
41
def enable(self: SignalCatcher) -> None:
    """Enable the signal catcher."""
    provide_internal_debugger(self)._ensure_process_stopped()
    self.enabled = True

hit_on(thread_context)

Returns whether the signal catcher has been hit on the given thread context.

Source code in libdebug/data/signal_catcher.py 
48
49
50
def hit_on(self: SignalCatcher, thread_context: ThreadContext) -> bool:
    """Returns whether the signal catcher has been hit on the given thread context."""
    return self.enabled and thread_context.signal_number == self.signal_number