python_api/was_interrupted/interruptible.py

fe61b382SJim Inghamimport lldb
fe61b382SJim Inghamimport threading
fe61b382SJim Ingham
fe61b382SJim Inghamlocal_data = None
fe61b382SJim Ingham
2238dcc3SJonas Devlieghere
fe61b382SJim Inghamclass BarrierContainer(threading.local):
fe61b382SJim Ingham    def __init__(self, before_interrupt_barrier, after_interrupt_barrier, event):
fe61b382SJim Ingham        self.event = event
fe61b382SJim Ingham        self.before_interrupt_barrier = before_interrupt_barrier
fe61b382SJim Ingham        self.after_interrupt_barrier = after_interrupt_barrier
fe61b382SJim Ingham
fe61b382SJim Ingham
2238dcc3SJonas Devlieghereclass WelcomeCommand(object):
fe61b382SJim Ingham    def __init__(self, debugger, session_dict):
fe61b382SJim Ingham        return
fe61b382SJim Ingham
fe61b382SJim Ingham    def get_short_help(self):
fe61b382SJim Ingham        return "A command that waits for an interrupt before returning."
fe61b382SJim Ingham
fe61b382SJim Ingham    def check_was_interrupted(self, debugger, use_interpreter):
fe61b382SJim Ingham        if use_interpreter:
fe61b382SJim Ingham            self.was_interrupted = debugger.GetCommandInterpreter().WasInterrupted()
fe61b382SJim Ingham        else:
fe61b382SJim Ingham            self.was_interrupted = debugger.InterruptRequested()
fe61b382SJim Ingham        if local_data.event:
fe61b382SJim Ingham            self.was_canceled = local_data.event.is_set()
fe61b382SJim Ingham
fe61b382SJim Ingham    def __call__(self, debugger, args, exe_ctx, result):
fe61b382SJim Ingham        """Command arguments:
fe61b382SJim Ingham        {interp/debugger} - Whether to use SBCommandInterpreter::WasInterrupted
fe61b382SJim Ingham                            of SBDebugger::InterruptRequested().
fe61b382SJim Ingham        check - Don't do the rendevous, just check if an interrupt was requested.
fe61b382SJim Ingham                If check is not provided, we'll do the lock and then check.
fe61b382SJim Ingham        poll  - Should we poll once after the rendevous or spin waiting for the
fe61b382SJim Ingham                interruption to happen.
fe61b382SJim Ingham
fe61b382SJim Ingham        For the interrupt cases, the command waits serially on the barriers
fe61b382SJim Ingham        passed to it in local data, giving the test runner a chance to set the
fe61b382SJim Ingham        interrupt.  Once the barriers are passed, it waits for the interrupt
fe61b382SJim Ingham        or the event.
fe61b382SJim Ingham        If it finds an interrupt, it returns "Command was interrupted". If it gets an
fe61b382SJim Ingham        event before seeing the interrupt it returns "Command was not interrupted."
fe61b382SJim Ingham        For the "poll" case, it waits on the rendevous, then checks once.
fe61b382SJim Ingham        For the "check" case, it doesn't wait, but just returns whether there was
fe61b382SJim Ingham        an interrupt in force or not."""
fe61b382SJim Ingham
*58611451SEisuke Kawashima        if local_data is None:
fe61b382SJim Ingham            result.SetError("local data was not set.")
fe61b382SJim Ingham            result.SetStatus(lldb.eReturnStatusFailed)
fe61b382SJim Ingham            return
fe61b382SJim Ingham
fe61b382SJim Ingham        use_interpreter = "interp" in args
fe61b382SJim Ingham        if not use_interpreter:
fe61b382SJim Ingham            if not "debugger" in args:
fe61b382SJim Ingham                result.SetError("Must pass either 'interp' or 'debugger'")
fe61b382SJim Ingham                result.SetStatus(lldb.eReturnStatusFailed)
fe61b382SJim Ingham                return
fe61b382SJim Ingham
fe61b382SJim Ingham        self.was_interrupted = False
fe61b382SJim Ingham        self.was_canceled = False
fe61b382SJim Ingham
fe61b382SJim Ingham        if "check" in args:
fe61b382SJim Ingham            self.check_was_interrupted(debugger, use_interpreter)
fe61b382SJim Ingham            if self.was_interrupted:
fe61b382SJim Ingham                result.Print("Command was interrupted")
fe61b382SJim Ingham            else:
fe61b382SJim Ingham                result.Print("Command was not interrupted")
fe61b382SJim Ingham        else:
fe61b382SJim Ingham            # Wait here to rendevous in the test before it sets the interrupt.
fe61b382SJim Ingham            local_data.before_interrupt_barrier.wait()
fe61b382SJim Ingham            # Now the test will set the interrupt, and we can continue:
fe61b382SJim Ingham            local_data.after_interrupt_barrier.wait()
fe61b382SJim Ingham
fe61b382SJim Ingham            if "poll" in args:
fe61b382SJim Ingham                self.check_was_interrupted(debugger, use_interpreter)
fe61b382SJim Ingham            else:
fe61b382SJim Ingham                while not self.was_interrupted and not self.was_canceled:
fe61b382SJim Ingham                    self.check_was_interrupted(debugger, use_interpreter)
fe61b382SJim Ingham
fe61b382SJim Ingham            if self.was_interrupted:
fe61b382SJim Ingham                result.Print("Command was interrupted")
fe61b382SJim Ingham            else:
fe61b382SJim Ingham                result.Print("Command was not interrupted")
fe61b382SJim Ingham
fe61b382SJim Ingham            if self.was_canceled:
fe61b382SJim Ingham                result.Print("Command was canceled")
fe61b382SJim Ingham        result.SetStatus(lldb.eReturnStatusSuccessFinishResult)
fe61b382SJim Ingham        return True