Merge pull request #6279 from medismailben/stable/20221013

Various Scripted Process fixes and improvements

Author: medismailben

lldb/bindings/interface/SBProcess.i

@@ -344,6 +344,12 @@ public:
     bool
     GetDescription (lldb::SBStream &description);
 
+    %feature("autodoc", "
+    Returns the implementation object of the process plugin if available. None
+    otherwise.") GetScriptedImplementation;
+    ScriptedObject
+    GetScriptedImplementation();
+
     %feature("autodoc", "
     Returns the process' extended crash information.") GetExtendedCrashInformation;
     lldb::SBStructuredData

lldb/bindings/python/python-swigsafecast.swig

@@ -5,28 +5,6 @@ PythonObject ToSWIGHelper(void *obj, swig_type_info *info) {
   return {PyRefType::Owned, SWIG_NewPointerObj(obj, info, SWIG_POINTER_OWN)};
 }
 
-/// A class that automatically clears an SB object when it goes out of scope.
-/// Use for cases where the SB object points to a temporary/unowned entity.
-template <typename T> class ScopedPythonObject : PythonObject {
-public:
-  ScopedPythonObject(T *sb, swig_type_info *info)
-      : PythonObject(ToSWIGHelper(sb, info)), m_sb(sb) {}
-  ~ScopedPythonObject() {
-    if (m_sb)
-      *m_sb = T();
-  }
-  ScopedPythonObject(ScopedPythonObject &&rhs)
-      : PythonObject(std::move(rhs)), m_sb(std::exchange(rhs.m_sb, nullptr)) {}
-  ScopedPythonObject(const ScopedPythonObject &) = delete;
-  ScopedPythonObject &operator=(const ScopedPythonObject &) = delete;
-  ScopedPythonObject &operator=(ScopedPythonObject &&) = delete;
-
-  const PythonObject &obj() const { return *this; }
-
-private:
-  T *m_sb;
-};
-
 PythonObject ToSWIGWrapper(std::unique_ptr<lldb::SBValue> value_sb) {
   return ToSWIGHelper(value_sb.release(), SWIGTYPE_p_lldb__SBValue);
 }
@@ -55,6 +33,10 @@ PythonObject ToSWIGWrapper(lldb::BreakpointSP breakpoint_sp) {
                       SWIGTYPE_p_lldb__SBBreakpoint);
 }
 
+PythonObject ToSWIGWrapper(const Status& status) {
+  return ToSWIGHelper(new lldb::SBError(status), SWIGTYPE_p_lldb__SBError);
+}
+
 PythonObject ToSWIGWrapper(std::unique_ptr<lldb::SBStream> stream_sb) {
   return ToSWIGHelper(stream_sb.release(), SWIGTYPE_p_lldb__SBStream);
 }

lldb/bindings/python/python-typemaps.swig

@@ -54,6 +54,16 @@
   free((char *) $1);
 }
 
+%typemap(out) lldb::ScriptedObject {
+  $result = nullptr;
+  if (const void* impl = $1)
+    $result = (PyObject*) impl;
+  if (!$result) {
+    $result = Py_None;
+    Py_INCREF(Py_None);
+  }
+}
+
 %typemap(out) char** {
   int len;
   int i;

lldb/bindings/python/static-binding/LLDBWrapPython.cpp

@@ -744,6 +744,12 @@ def lldb_iter(obj, getsize, getelem):
 
 eDynamicDontRunTarget = _lldb.eDynamicDontRunTarget
 
+eBindAuto = _lldb.eBindAuto
+
+eBind = _lldb.eBind
+
+eDontBind = _lldb.eDontBind
+
 eStopShowColumnAnsiOrCaret = _lldb.eStopShowColumnAnsiOrCaret
 
 eStopShowColumnAnsi = _lldb.eStopShowColumnAnsi
@@ -952,6 +958,8 @@ def lldb_iter(obj, getsize, getelem):
 
 eArgTypeStopHookID = _lldb.eArgTypeStopHookID
 
+eArgTypeBindGenTypeParamValue = _lldb.eArgTypeBindGenTypeParamValue
+
 eArgTypeLastArg = _lldb.eArgTypeLastArg
 
 eSymbolTypeAny = _lldb.eSymbolTypeAny
@@ -1616,6 +1624,12 @@ def lldb_iter(obj, getsize, getelem):
 
 eTraceCursorSeekTypeEnd = _lldb.eTraceCursorSeekTypeEnd
 
+eDWIMPrintVerbosityNone = _lldb.eDWIMPrintVerbosityNone
+
+eDWIMPrintVerbosityExpression = _lldb.eDWIMPrintVerbosityExpression
+
+eDWIMPrintVerbosityFull = _lldb.eDWIMPrintVerbosityFull
+
 class SBAddress(object):
     r"""
     A section + offset based address class.
@@ -8841,6 +8855,14 @@ def GetDescription(self, description):
         r"""GetDescription(SBProcess self, SBStream description) -> bool"""
         return _lldb.SBProcess_GetDescription(self, description)
 
+    def GetScriptedImplementation(self):
+        r"""
+
+        Returns the implementation object of the process plugin if available. None
+        otherwise.
+        """
+        return _lldb.SBProcess_GetScriptedImplementation(self)
+
     def GetExtendedCrashInformation(self):
         r"""
 

lldb/bindings/python/static-binding/lldb.py

@@ -1503,19 +1503,19 @@ def __lldb_init_module(debugger, internal_dict):
     malloc_info.__doc__ = get_malloc_info_options().format_help()
     objc_refs.__doc__ = get_objc_refs_options().format_help()
     debugger.HandleCommand(
-        'command script add -f %s.ptr_refs ptr_refs' %
+        'command script add -o -f %s.ptr_refs ptr_refs' %
         __name__)
     debugger.HandleCommand(
-        'command script add -f %s.cstr_refs cstr_refs' %
+        'command script add -o -f %s.cstr_refs cstr_refs' %
         __name__)
     debugger.HandleCommand(
-        'command script add -f %s.malloc_info malloc_info' %
+        'command script add -o -f %s.malloc_info malloc_info' %
         __name__)
     debugger.HandleCommand(
-        'command script add -f %s.find_variable find_variable' %
+        'command script add -o -f %s.find_variable find_variable' %
         __name__)
-    # debugger.HandleCommand('command script add -f %s.section_ptr_refs section_ptr_refs' % package_name)
+    # debugger.HandleCommand('command script add -o -f %s.section_ptr_refs section_ptr_refs' % package_name)
     debugger.HandleCommand(
-        'command script add -f %s.objc_refs objc_refs' %
+        'command script add -o -f %s.objc_refs objc_refs' %
         __name__)
     print('"malloc_info", "ptr_refs", "cstr_refs", "find_variable", and "objc_refs" commands have been installed, use the "--help" options on these commands for detailed help.')

lldb/examples/darwin/heap_find/heap.py

@@ -558,7 +558,7 @@ def __lldb_init_module(debugger, dict):
     # interpreter.
     # Add any commands contained in this module to LLDB
     debugger.HandleCommand(
-        'command script add -c %s.VerifyDebugMapCommand %s' % (
+        'command script add -o -c %s.VerifyDebugMapCommand %s' % (
             __name__, VerifyDebugMapCommand.name))
     print('The "%s" command has been installed, type "help %s" for detailed '
           'help.' % (VerifyDebugMapCommand.name, VerifyDebugMapCommand.name))

lldb/examples/python/bsd.py

@@ -24,7 +24,7 @@ def register_lldb_command(cls, debugger, module_name):
         parser = cls.create_options()
         cls.__doc__ = parser.format_help()
         # Add any commands contained in this module to LLDB
-        command = 'command script add -c %s.%s %s' % (module_name,
+        command = 'command script add -o -c %s.%s %s' % (module_name,
                                                       cls.__name__,
                                                       cls.program)
         debugger.HandleCommand(command)

lldb/examples/python/cmdtemplate.py

@@ -417,15 +417,15 @@ class InteractiveCrashLogException(Exception):
     pass
 
 class CrashLogParser:
-    "CrashLog parser base class and factory."
-    def __new__(cls, debugger, path, verbose):
+    @staticmethod
+    def create(debugger, path, verbose):
         data = JSONCrashLogParser.is_valid_json(path)
         if data:
-            self = object.__new__(JSONCrashLogParser)
-            self.data = data
-            return self
+            parser = JSONCrashLogParser(debugger, path, verbose)
+            parser.data = data
+            return parser
         else:
-            return object.__new__(TextCrashLogParser)
+            return TextCrashLogParser(debugger, path, verbose)
 
     def __init__(self, debugger, path, verbose):
         self.path = os.path.expanduser(path)
@@ -1076,7 +1076,7 @@ def load_crashlog_in_scripted_process(debugger, crash_log_file, options, result)
     if not os.path.exists(crashlog_path):
         raise InteractiveCrashLogException("crashlog file %s does not exist" % crashlog_path)
 
-    crashlog = CrashLogParser(debugger, crashlog_path, False).parse()
+    crashlog = CrashLogParser.create(debugger, crashlog_path, False).parse()
 
     target = lldb.SBTarget()
     # 1. Try to use the user-provided target
@@ -1332,7 +1332,7 @@ def should_run_in_interactive_mode(options, ci):
                 except InteractiveCrashLogException as e:
                     result.SetError(str(e))
             else:
-                crash_log = CrashLogParser(debugger, crash_log_file, options.verbose).parse()
+                crash_log = CrashLogParser.create(debugger, crash_log_file, options.verbose).parse()
                 SymbolicateCrashLog(crash_log, options)
 
 if __name__ == '__main__':
@@ -1344,8 +1344,8 @@ def should_run_in_interactive_mode(options, ci):
 
 def __lldb_init_module(debugger, internal_dict):
     debugger.HandleCommand(
-        'command script add -c lldb.macosx.crashlog.Symbolicate crashlog')
+        'command script add -o -c lldb.macosx.crashlog.Symbolicate crashlog')
     debugger.HandleCommand(
-        'command script add -f lldb.macosx.crashlog.save_crashlog save_crashlog')
+        'command script add -o -f lldb.macosx.crashlog.save_crashlog save_crashlog')
     print('"crashlog" and "save_crashlog" commands have been installed, use '
           'the "--help" options on these commands for detailed help.')

lldb/examples/python/crashlog.py

@@ -128,5 +128,5 @@ def __lldb_init_module(debugger, internal_dict):
         # This initializer is being run from LLDB in the embedded command interpreter
         # Add any commands contained in this module to LLDB
         debugger.HandleCommand(
-            'command script add -f delta.parse_time_log parse_time_log')
+            'command script add -o -f delta.parse_time_log parse_time_log')
         print('The "parse_time_log" command is now installed and ready for use, type "parse_time_log --help" for more information')