[lldb/test] Fix TestScriptedProcess.py timeout on x86_64

[mib]

Summary

This patch fixes a timeout issue on the ScriptedProcess test that was
happening on intel platforms. The timeout was due to a misreporting of
the StopInfo in the ScriptedThread that caused the ScriptedProcess to
never stop.

To solve this, this patch changes the way a ScriptedThread reports its
stop reason by making it more architecture specific. In order to do so,
this patch also refactors the ScriptedProcess & ScriptedThread
initializer methods to provide an easy access to the target architecture.

Signed-off-by: Med Ismail Bennani <[e-mail]>

[JDevlieghere]

lldb/examples/python/scripted_process/scripted_process.py

323–344

Since you're already modifying these lines, maybe it's worth moving this into a constant. That'll make the class itself a lot more readable.

lldb/test/API/functionalities/scripted_process/invalid_scripted_process.py

57

What's the motivation from switching from SIGINT to SIGTRAP?

lldb/test/API/functionalities/scripted_process/stack_core_scripted_process.py

128–137

Can you remind me why we can't read this information from the thread in the core file?

[mib]

lldb/test/API/functionalities/scripted_process/invalid_scripted_process.py

57

I don't think this is very important, but reporting it as a SIGTRAP is more in line with what debugserver does for breakpoints.

lldb/test/API/functionalities/scripted_process/stack_core_scripted_process.py

128–137

Besides on arm, we don't save any breakpoint info in the core file, so all of the core file threads reports a eStopReasonNone. So when I try to emulate the core file process from a Scripted Process, the scripted process never stops because none of its threads has a stop reason. That's why we have to fake a SIGTRAP for x86_64.

[mib]

Address @JDevlieghere comments

[mib]

Re-enabling a test function for intel.

[JDevlieghere]

LGTM modulo the test comment.

lldb/examples/python/scripted_process/scripted_process.py

395

Generally constants go at the top of the file, but this is rather bulky, so I don't mind it being at the bottom.

lldb/test/API/functionalities/scripted_process/stack_core_scripted_process.py

128–137

That sounds like something worth mentioning as a comment in the test.

[mib]

Add stop reason type test and comment explaining why it's different depending on the architecture.

[mib]

lldb/examples/python/scripted_process/scripted_process.py

395

Felt the same, so I put it here.

lldb/test/API/functionalities/scripted_process/TestScriptedProcess.py

202–212 ↗

(On Diff #404147)

@jingham This is also another reason why D118482 is "necessary":

On intel, the corefile threads all report an eStopReasonNone, so having a python lldb.ScriptedProcess.get_selected_thread_index allows me to create the signal stop reason, otherwise, all of the scripted process threads report eStopReasonNone and the process runs forever.

[mib]

Update following D118482 latest change

[mib]

Added a is_stopped member variable to StackCoreScriptedThread since I abandoned D118482

lldb/examples/python/scripted_process/scripted_process.py

def __init__(self, target, args):
 
         Args:
             target (lldb.SBTarget): The target launching the scripted process.
             args (lldb.SBStructuredData): A Dictionary holding arbitrary
                 key/value pairs used by the scripted process.
         """
         self.target = None
         self.args = None
+        self.arch = None
         if isinstance(target, lldb.SBTarget) and target.IsValid():
             self.target = target
+            triple = self.target.triple
+            if triple:
+                self.arch = triple.split('-')[0]
         if isinstance(args, lldb.SBStructuredData) and args.IsValid():
             self.args = args
 
     @abstractmethod
     def get_memory_region_containing_address(self, addr):
         """ Get the memory region for the scripted process, containing a
             specific address.
 
class ScriptedThread:
     Most of the base class methods are `@abstractmethod` that need to be
     overwritten by the inheriting class.
 
     DISCLAIMER: THIS INTERFACE IS STILL UNDER DEVELOPMENT AND NOT STABLE.
                 THE METHODS EXPOSED MIGHT CHANGE IN THE FUTURE.
     """
 
     @abstractmethod
-    def __init__(self, process, args):
+    def __init__(self, scripted_process, args):
         """ Construct a scripted thread.
 
         Args:
-            process (lldb.SBProcess): The scripted process owning this thread.
+            process (ScriptedProcess): The scripted process owning this thread.
             args (lldb.SBStructuredData): A Dictionary holding arbitrary
                 key/value pairs used by the scripted thread.
         """
         self.target = None
+        self.scripted_process = None
         self.process = None
         self.args = None
-        if isinstance(process, ScriptedProcess):
-            self.target = process.target
+        if isinstance(scripted_process, ScriptedProcess):
+            self.target = scripted_process.target
+            self.scripted_process = scripted_process
             self.process = self.target.GetProcess()
 
         self.id = None
         self.idx = None
         self.name = None
         self.queue = None
         self.state = None
         self.stop_reason = None
def get_stackframes(self):
                 and a symbol context.
                 None if the list is empty.
         """
         return 0
 
     def get_register_info(self):
         if self.register_info is None:
             self.register_info = dict()
-            triple = self.target.triple
-            if triple:
-                arch = triple.split('-')[0]
-                if arch == 'x86_64':
-                    self.register_info['sets'] = ['General Purpose Registers']
-                    self.register_info['registers'] = [
-                        {'name': 'rax', 'bitsize': 64, 'offset': 0, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 0, 'dwarf': 0},
-                        {'name': 'rbx', 'bitsize': 64, 'offset': 8, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 3, 'dwarf': 3},
-                        {'name': 'rcx', 'bitsize': 64, 'offset': 16, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 2, 'dwarf': 2, 'generic': 'arg4', 'alt-name': 'arg4'},
-                        {'name': 'rdx', 'bitsize': 64, 'offset': 24, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 1, 'dwarf': 1, 'generic': 'arg3', 'alt-name': 'arg3'},
-                        {'name': 'rdi', 'bitsize': 64, 'offset': 32, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 5, 'dwarf': 5, 'generic': 'arg1', 'alt-name': 'arg1'},
-                        {'name': 'rsi', 'bitsize': 64, 'offset': 40, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 4, 'dwarf': 4, 'generic': 'arg2', 'alt-name': 'arg2'},
-                        {'name': 'rbp', 'bitsize': 64, 'offset': 48, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 6, 'dwarf': 6, 'generic': 'fp', 'alt-name': 'fp'},
-                        {'name': 'rsp', 'bitsize': 64, 'offset': 56, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 7, 'dwarf': 7, 'generic': 'sp', 'alt-name': 'sp'},
-                        {'name': 'r8', 'bitsize': 64, 'offset': 64, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 8, 'dwarf': 8, 'generic': 'arg5', 'alt-name': 'arg5'},
-                        {'name': 'r9', 'bitsize': 64, 'offset': 72, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 9, 'dwarf': 9, 'generic': 'arg6', 'alt-name': 'arg6'},
-                        {'name': 'r10', 'bitsize': 64, 'offset': 80, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 10, 'dwarf': 10},
-                        {'name': 'r11', 'bitsize': 64, 'offset': 88, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 11, 'dwarf': 11},
-                        {'name': 'r12', 'bitsize': 64, 'offset': 96, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 12, 'dwarf': 12},
-                        {'name': 'r13', 'bitsize': 64, 'offset': 104, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 13, 'dwarf': 13},
-                        {'name': 'r14', 'bitsize': 64, 'offset': 112, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 14, 'dwarf': 14},
-                        {'name': 'r15', 'bitsize': 64, 'offset': 120, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 15, 'dwarf': 15},
-                        {'name': 'rip', 'bitsize': 64, 'offset': 128, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 16, 'dwarf': 16, 'generic': 'pc', 'alt-name': 'pc'},
-                        {'name': 'rflags', 'bitsize': 64, 'offset': 136, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'generic': 'flags', 'alt-name': 'flags'},
-                        {'name': 'cs', 'bitsize': 64, 'offset': 144, 'encoding': 'uint', 'format': 'hex', 'set': 0},
-                        {'name': 'fs', 'bitsize': 64, 'offset': 152, 'encoding': 'uint', 'format': 'hex', 'set': 0},
-                        {'name': 'gs', 'bitsize': 64, 'offset': 160, 'encoding': 'uint', 'format': 'hex', 'set': 0}
-                    ]
-                elif 'arm64' in arch:
-                    self.register_info['sets'] = ['General Purpose Registers']
-                    self.register_info['registers'] = [
-                        {'name': 'x0',   'bitsize': 64, 'offset': 0,   'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 0,  'dwarf': 0,  'generic': 'arg0', 'alt-name': 'arg0'},
-                        {'name': 'x1',   'bitsize': 64, 'offset': 8,   'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 1,  'dwarf': 1,  'generic': 'arg1', 'alt-name': 'arg1'},
-                        {'name': 'x2',   'bitsize': 64, 'offset': 16,  'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 2,  'dwarf': 2,  'generic': 'arg2', 'alt-name': 'arg2'},
-                        {'name': 'x3',   'bitsize': 64, 'offset': 24,  'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 3,  'dwarf': 3,  'generic': 'arg3', 'alt-name': 'arg3'},
-                        {'name': 'x4',   'bitsize': 64, 'offset': 32,  'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 4,  'dwarf': 4,  'generic': 'arg4', 'alt-name': 'arg4'},
-                        {'name': 'x5',   'bitsize': 64, 'offset': 40,  'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 5,  'dwarf': 5,  'generic': 'arg5', 'alt-name': 'arg5'},
-                        {'name': 'x6',   'bitsize': 64, 'offset': 48,  'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 6,  'dwarf': 6,  'generic': 'arg6', 'alt-name': 'arg6'},
-                        {'name': 'x7',   'bitsize': 64, 'offset': 56,  'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 7,  'dwarf': 7,  'generic': 'arg7', 'alt-name': 'arg7'},
-                        {'name': 'x8',   'bitsize': 64, 'offset': 64,  'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 8,  'dwarf': 8 },
-                        {'name': 'x9',   'bitsize': 64, 'offset': 72,  'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 9,  'dwarf': 9 },
-                        {'name': 'x10',  'bitsize': 64, 'offset': 80,  'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 10, 'dwarf': 10},
-                        {'name': 'x11',  'bitsize': 64, 'offset': 88,  'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 11, 'dwarf': 11},
-                        {'name': 'x12',  'bitsize': 64, 'offset': 96,  'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 12, 'dwarf': 12},
-                        {'name': 'x13',  'bitsize': 64, 'offset': 104, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 13, 'dwarf': 13},
-                        {'name': 'x14',  'bitsize': 64, 'offset': 112, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 14, 'dwarf': 14},
-                        {'name': 'x15',  'bitsize': 64, 'offset': 120, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 15, 'dwarf': 15},
-                        {'name': 'x16',  'bitsize': 64, 'offset': 128, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 16, 'dwarf': 16},
-                        {'name': 'x17',  'bitsize': 64, 'offset': 136, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 17, 'dwarf': 17},
-                        {'name': 'x18',  'bitsize': 64, 'offset': 144, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 18, 'dwarf': 18},
-                        {'name': 'x19',  'bitsize': 64, 'offset': 152, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 19, 'dwarf': 19},
-                        {'name': 'x20',  'bitsize': 64, 'offset': 160, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 20, 'dwarf': 20},
-                        {'name': 'x21',  'bitsize': 64, 'offset': 168, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 21, 'dwarf': 21},
-                        {'name': 'x22',  'bitsize': 64, 'offset': 176, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 22, 'dwarf': 22},
-                        {'name': 'x23',  'bitsize': 64, 'offset': 184, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 23, 'dwarf': 23},
-                        {'name': 'x24',  'bitsize': 64, 'offset': 192, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 24, 'dwarf': 24},
-                        {'name': 'x25',  'bitsize': 64, 'offset': 200, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 25, 'dwarf': 25},
-                        {'name': 'x26',  'bitsize': 64, 'offset': 208, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 26, 'dwarf': 26},
-                        {'name': 'x27',  'bitsize': 64, 'offset': 216, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 27, 'dwarf': 27},
-                        {'name': 'x28',  'bitsize': 64, 'offset': 224, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 28, 'dwarf': 28},
-                        {'name': 'x29',  'bitsize': 64, 'offset': 232, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 29, 'dwarf': 29, 'generic': 'fp', 'alt-name': 'fp'},
-                        {'name': 'x30',  'bitsize': 64, 'offset': 240, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 30, 'dwarf': 30, 'generic': 'lr', 'alt-name': 'lr'},
-                        {'name': 'sp',   'bitsize': 64, 'offset': 248, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 31, 'dwarf': 31, 'generic': 'sp', 'alt-name': 'sp'},
-                        {'name': 'pc',   'bitsize': 64, 'offset': 256, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 32, 'dwarf': 32, 'generic': 'pc', 'alt-name': 'pc'},
-                        {'name': 'cpsr', 'bitsize': 32, 'offset': 264, 'encoding': 'uint', 'format': 'hex', 'set': 0, 'gcc': 33, 'dwarf': 33}
-                    ]
-                else: raise ValueError('Unknown architecture', arch)
+            if self.scripted_process.arch == 'x86_64':
+            elif 'arm64' in self.scripted_process.arch:
+            else: raise ValueError('Unknown architecture', self.scripted_process.arch)
         return self.register_info
 
     @abstractmethod
     def get_register_context(self):
         """ Get the scripted thread register context
 
         Returns:
             str: A byte representing all register's value.
         """
         pass

lldb/test/API/functionalities/scripted_process/invalid_scripted_process.py

class InvalidScriptedThread(ScriptedThread):
     def get_name(self) -> str:
         return InvalidScriptedThread.__name__ + ".thread-1"
 
     def get_state(self) -> int:
         return lldb.eStateInvalid
 
     def get_stop_reason(self) -> Dict[str, Any]:
         return { "type": lldb.eStopReasonSignal, "data": {
-            "signal": signal.SIGINT
+            "signal": signal.SIGTRAP
         } }
 
     def get_stackframes(self):
         class ScriptedStackFrame:
             def __init__(idx, cfa, pc, symbol_ctx):
                 self.idx = idx
                 self.cfa = cfa
                 self.pc = pc

lldb/test/API/functionalities/scripted_process/stack_core_scripted_process.py

def get_thread_id(self) -> int:
         return self.id
 
     def get_name(self) -> str:
         return StackCoreScriptedThread.__name__ + ".thread-" + str(self.id)
 
     def get_stop_reason(self) -> Dict[str, Any]:
         stop_reason = { "type": lldb.eStopReasonInvalid, "data": {  }}
 
-        if self.corefile_thread and self.corefile_thread.IsValid:
-            stop_reason["type"] = self.corefile_thread.GetStopReason()
+        if self.corefile_thread and self.corefile_thread.IsValid():
+            stop_reason["type"] = lldb.eStopReasonNone
 
-            if self.corefile_thread.GetStopReasonDataCount() > 0:
-                if stop_reason["type"] == lldb.eStopReasonBreakpoint:
-                    stop_reason["data"]["break_id"] = self.corefile_thread.GetStopReasonDataAtIndex(0)
-                    stop_reason["data"]["break_loc_id"] = self.corefile_thread.GetStopReasonDataAtIndex(1)
-                elif stop_reason["type"] == lldb.eStopReasonSignal:
-                    stop_reason["data"]["signal"] = signal.SIGINT
-                elif stop_reason["type"] == lldb.eStopReasonException:
+            selected_thread_idx = self.scripted_process.get_selected_thread_index()
+            if selected_thread_idx == self.corefile_thread.GetIndexID():
+                if 'arm64' in self.scripted_process.arch:
+                    stop_reason["type"] = lldb.eStopReasonException
                     stop_reason["data"]["desc"] = self.corefile_thread.GetStopDescription(100)
+                elif self.scripted_process.arch == 'x86_64':
+                    stop_reason["type"] = lldb.eStopReasonSignal
+                    stop_reason["data"]["signal"] = signal.SIGTRAP
+                else:
+                    stop_reason["type"] = self.corefile_thread.GetStopReason()
 
         return stop_reason
 
     def get_stackframes(self):
         class ScriptedStackFrame:
             def __init__(idx, cfa, pc, symbol_ctx):
                 self.idx = idx
                 self.cfa = cfa