[lldb] Convert script native types to StructuredData counterpart

medismailben · medismailben · commit b74f58a6132f · 2023-07-25T23:01:43.000-07:00
This patch adds the ability to pass native types from the script interpreter to methods that use a {SB,}StructuredData argument. To do so, this patch changes the `ScriptedObject` struture that holds the pointer to the script object as well as the originating script interpreter language. It also exposes that to the SB API via a new class called `SBScriptObject`. This structure allows the debugger to parse the script object and convert it to a StructuredData object. If the type is not compatible with the StructuredData types, we will store its pointer in a `StructuredData::Generic` object. This patch also adds some SWIG typemaps that checks the input argument to ensure it's either an SBStructuredData object, in which case it just passes it throught, or a python object that is NOT another SB type, to provide some guardrails for the user. rdar://111467140 Differential Revision: https://reviews.llvm.org/D155161 Signed-off-by: Med Ismail Bennani <ismail@bennani.ma>
diff --git a/lldb/bindings/headers.swig b/lldb/bindings/headers.swig
@@ -49,6 +49,7 @@
 #include "lldb/API/SBQueue.h"
 #include "lldb/API/SBQueueItem.h"
 #include "lldb/API/SBReproducer.h"
+#include "lldb/API/SBScriptObject.h"
 #include "lldb/API/SBSection.h"
 #include "lldb/API/SBSourceManager.h"
 #include "lldb/API/SBStream.h"
diff --git a/lldb/bindings/interface/SBProcess.i b/lldb/bindings/interface/SBProcess.i
@@ -353,7 +353,7 @@ public:
     %feature("autodoc", "
     Returns the implementation object of the process plugin if available. None
     otherwise.") GetScriptedImplementation;
-    ScriptedObject
+    lldb::SBScriptObject
     GetScriptedImplementation();
 
     %feature("autodoc", "
diff --git a/lldb/bindings/interface/SBScriptObject.i b/lldb/bindings/interface/SBScriptObject.i
@@ -0,0 +1,51 @@
+//===-- SWIG Interface for SBScriptObject -----------------------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+namespace lldb {
+
+class SBScriptObject
+{
+public:
+  SBScriptObject(const ScriptObjectPtr ptr, lldb::ScriptLanguage lang);
+
+  SBScriptObject(const lldb::SBScriptObject &rhs);
+
+  ~SBScriptObject();
+
+  const lldb::SBScriptObject &operator=(const lldb::SBScriptObject &rhs);
+
+  explicit operator bool() const;
+
+  bool operator!=(const SBScriptObject &rhs) const;
+
+  bool IsValid() const;
+
+  lldb::ScriptObjectPtr GetPointer() const;
+
+  lldb::ScriptLanguage GetLanguage() const;
+
+#ifdef SWIGPYTHON
+    // operator== is a free function, which swig does not handle, so we inject
+    // our own equality operator here
+    %pythoncode%{
+    def __eq__(self, other):
+      return not self.__ne__(other)
+    %}
+#endif
+
+
+#ifdef SWIGPYTHON
+    %pythoncode %{
+        ptr = property(GetPointer, None, doc='''A read only property that returns the underlying script object.''')
+        lang = property(GetLanguage, None, doc='''A read only property that returns the script language associated with with this script object.''')
+    %}
+#endif
+
+};
+
+}
diff --git a/lldb/bindings/interface/SBStructuredData.i b/lldb/bindings/interface/SBStructuredData.i
@@ -22,6 +22,9 @@ This class wraps the event type generated by StructuredData features."
 
         SBStructuredData(const lldb::EventSP &event_sp);
 
+        SBStructuredData(const lldb::SBScriptObject obj,
+                         const lldb::SBDebugger &debugger);
+
         ~SBStructuredData();
 
         bool
@@ -50,6 +53,8 @@ This class wraps the event type generated by StructuredData features."
 
         size_t GetStringValue(char *dst, size_t dst_len) const;
 
+        lldb::SBScriptObject GetGenericValue() const;
+
         lldb::SBError
         GetAsJSON(lldb::SBStream &stream) const;
 
diff --git a/lldb/bindings/interfaces.swig b/lldb/bindings/interfaces.swig
@@ -53,6 +53,7 @@
 %include "./interface/SBQueue.i"
 %include "./interface/SBQueueItem.i"
 %include "./interface/SBReproducer.i"
+%include "./interface/SBScriptObject.i"
 %include "./interface/SBSection.i"
 %include "./interface/SBSourceManager.i"
 %include "./interface/SBStream.i"
diff --git a/lldb/bindings/python/python-typemaps.swig b/lldb/bindings/python/python-typemaps.swig
@@ -54,9 +54,78 @@
   free((char *) $1);
 }
 
-%typemap(out) lldb::ScriptedObject {
+%typecheck(SWIG_TYPECHECK_POINTER) lldb::ScriptObjectPtr {
+  PythonObject obj(PyRefType::Borrowed, $input);
+  if (!obj.IsValid()) {
+    PyErr_Clear();
+    $1 = 0;
+  } else {
+    $1 = 1;
+  }
+}
+
+%typemap(in) lldb::ScriptObjectPtr {
+  if ($input == Py_None) {
+    $1 = nullptr;
+  } else {
+    PythonObject obj(PyRefType::Borrowed, $input);
+    if (!obj.IsValid()) {
+      PyErr_SetString(PyExc_TypeError, "Script object is not valid");
+      SWIG_fail;
+    }
+
+    auto lldb_module = PythonModule::Import("lldb");
+    if (!lldb_module) {
+      std::string err_msg = llvm::toString(lldb_module.takeError());
+      PyErr_SetString(PyExc_TypeError, err_msg.c_str());
+      SWIG_fail;
+    }
+
+    auto sb_structured_data_class = lldb_module.get().Get("SBStructuredData");
+    if (!sb_structured_data_class) {
+      std::string err_msg = llvm::toString(sb_structured_data_class.takeError());
+      PyErr_SetString(PyExc_TypeError, err_msg.c_str());
+      SWIG_fail;
+    }
+
+    if (obj.IsInstance(sb_structured_data_class.get())) {
+      $1 = obj.get();
+    } else {
+      auto type = obj.GetType();
+      if (!type) {
+        std::string err_msg = llvm::toString(type.takeError());
+        PyErr_SetString(PyExc_TypeError, err_msg.c_str());
+        SWIG_fail;
+      }
+
+      auto type_name = As<std::string>(type.get().GetAttribute("__name__"));
+      if (!type_name) {
+        std::string err_msg = llvm::toString(type_name.takeError());
+        PyErr_SetString(PyExc_TypeError, err_msg.c_str());
+        SWIG_fail;
+      }
+
+      if (llvm::StringRef(type_name.get()).startswith("SB")) {
+        std::string error_msg = "Input type is invalid: " + type_name.get();
+        PyErr_SetString(PyExc_TypeError, error_msg.c_str());
+        SWIG_fail;
+      } else {
+        $1 = obj.get();
+      }
+    }
+  }
+}
+
+%typemap(out) lldb::ScriptObjectPtr {
+  $result = (PyObject*) $1;
+  if (!$result)
+    $result = Py_None;
+  Py_INCREF($result);
+}
+
+%typemap(out) lldb::SBScriptObject {
   $result = nullptr;
-  if (const void* impl = $1)
+  if (const void* impl = $1.GetPointer())
     $result = (PyObject*) impl;
   if (!$result) {
     $result = Py_None;
diff --git a/lldb/include/lldb/API/SBDebugger.h b/lldb/include/lldb/API/SBDebugger.h
@@ -430,6 +430,7 @@ class LLDB_API SBDebugger {
   friend class SBListener;
   friend class SBProcess;
   friend class SBSourceManager;
+  friend class SBStructuredData;
   friend class SBTarget;
   friend class SBTrace;
 
diff --git a/lldb/include/lldb/API/SBDefines.h b/lldb/include/lldb/API/SBDefines.h
@@ -73,10 +73,12 @@ class LLDB_API SBMemoryRegionInfoList;
 class LLDB_API SBModule;
 class LLDB_API SBModuleSpec;
 class LLDB_API SBModuleSpecList;
+class LLDB_API SBPlatform;
 class LLDB_API SBProcess;
 class LLDB_API SBProcessInfo;
 class LLDB_API SBQueue;
 class LLDB_API SBQueueItem;
+class LLDB_API SBScriptObject;
 class LLDB_API SBSection;
 class LLDB_API SBSourceManager;
 class LLDB_API SBStream;
@@ -112,7 +114,6 @@ class LLDB_API SBUnixSignals;
 typedef bool (*SBBreakpointHitCallback)(void *baton, SBProcess &process,
                                         SBThread &thread,
                                         lldb::SBBreakpointLocation &location);
-typedef void *ScriptedObject;
 }
 
 #endif // LLDB_API_SBDEFINES_H
diff --git a/lldb/include/lldb/API/SBProcess.h b/lldb/include/lldb/API/SBProcess.h
@@ -431,7 +431,7 @@ class LLDB_API SBProcess {
   ///
   lldb::SBError DeallocateMemory(lldb::addr_t ptr);
 
-  lldb::ScriptedObject GetScriptedImplementation();
+  lldb::SBScriptObject GetScriptedImplementation();
 
 protected:
   friend class SBAddress;
diff --git a/lldb/include/lldb/API/SBScriptObject.h b/lldb/include/lldb/API/SBScriptObject.h
@@ -0,0 +1,55 @@
+//===-- SBScriptObject.h ----------------------------------------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLDB_API_SBSCRIPTOBJECT_H
+#define LLDB_API_SBSCRIPTOBJECT_H
+
+#include "lldb/API/SBDefines.h"
+
+namespace lldb_private {
+class ScriptObject;
+}
+
+namespace lldb {
+
+class LLDB_API SBScriptObject {
+public:
+  SBScriptObject(const ScriptObjectPtr ptr, lldb::ScriptLanguage lang);
+
+  SBScriptObject(const lldb::SBScriptObject &rhs);
+
+  ~SBScriptObject();
+
+  const lldb::SBScriptObject &operator=(const lldb::SBScriptObject &rhs);
+
+  explicit operator bool() const;
+
+  bool operator!=(const SBScriptObject &rhs) const;
+
+  bool IsValid() const;
+
+  lldb::ScriptObjectPtr GetPointer() const;
+
+  lldb::ScriptLanguage GetLanguage() const;
+
+protected:
+  friend class SBStructuredData;
+
+  lldb_private::ScriptObject *get();
+
+  lldb_private::ScriptObject &ref();
+
+  const lldb_private::ScriptObject &ref() const;
+
+private:
+  std::unique_ptr<lldb_private::ScriptObject> m_opaque_up;
+};
+
+} // namespace lldb
+
+#endif // LLDB_API_SBSCRIPTOBJECT_H
diff --git a/lldb/include/lldb/API/SBStructuredData.h b/lldb/include/lldb/API/SBStructuredData.h
@@ -24,6 +24,9 @@ class SBStructuredData {
 
   SBStructuredData(const lldb_private::StructuredDataImpl &impl);
 
+  SBStructuredData(const lldb::SBScriptObject obj,
+                   const lldb::SBDebugger &debugger);
+
   ~SBStructuredData();
 
   lldb::SBStructuredData &operator=(const lldb::SBStructuredData &rhs);
@@ -89,6 +92,9 @@ class SBStructuredData {
   ///     \a dst in all cases.
   size_t GetStringValue(char *dst, size_t dst_len) const;
 
+  /// Return the generic pointer if this data structure is a generic type.
+  lldb::SBScriptObject GetGenericValue() const;
+
 protected:
   friend class SBAttachInfo;
   friend class SBLaunchInfo;
diff --git a/lldb/include/lldb/Core/StructuredDataImpl.h b/lldb/include/lldb/Core/StructuredDataImpl.h
@@ -155,6 +155,17 @@ class StructuredDataImpl {
     return (::snprintf(dst, dst_len, "%s", result.data()));
   }
 
+  void *GetGenericValue() const {
+    if (!m_data_sp)
+      return nullptr;
+
+    StructuredData::Generic *generic_data = m_data_sp->GetAsGeneric();
+    if (!generic_data)
+      return nullptr;
+
+    return generic_data->GetValue();
+  }
+
   StructuredData::ObjectSP GetObjectSP() const { return m_data_sp; }
 
 private:
diff --git a/lldb/include/lldb/Interpreter/ScriptInterpreter.h b/lldb/include/lldb/Interpreter/ScriptInterpreter.h
@@ -21,6 +21,7 @@
 #include "lldb/Core/StreamFile.h"
 #include "lldb/Core/ThreadedCommunication.h"
 #include "lldb/Host/PseudoTerminal.h"
+#include "lldb/Interpreter/ScriptObject.h"
 #include "lldb/Interpreter/ScriptedProcessInterface.h"
 #include "lldb/Utility/Broadcaster.h"
 #include "lldb/Utility/Status.h"
@@ -573,6 +574,10 @@ class ScriptInterpreter : public PluginInterface {
   virtual lldb::ScriptedProcessInterfaceUP CreateScriptedProcessInterface() {
     return std::make_unique<ScriptedProcessInterface>();
   }
+  virtual StructuredData::ObjectSP
+  CreateStructuredDataFromScriptObject(ScriptObject obj) {
+    return {};
+  }
 
   lldb::DataExtractorSP
   GetDataExtractorFromSBData(const lldb::SBData &data) const;
diff --git a/lldb/include/lldb/Interpreter/ScriptObject.h b/lldb/include/lldb/Interpreter/ScriptObject.h
@@ -0,0 +1,32 @@
+//===-- ScriptObject.h ------------------------------------ -*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLDB_INTERPRETER_SCRIPTOBJECT_H
+#define LLDB_INTERPRETER_SCRIPTOBJECT_H
+
+#include "lldb/lldb-types.h"
+
+namespace lldb_private {
+class ScriptObject {
+public:
+  ScriptObject(lldb::ScriptObjectPtr ptr, lldb::ScriptLanguage lang)
+      : m_ptr(ptr), m_language(lang) {}
+
+  operator bool() const { return m_ptr != nullptr; }
+
+  const void *GetPointer() const { return m_ptr; }
+
+  lldb::ScriptLanguage GetLanguage() const { return m_language; }
+
+private:
+  const void *m_ptr;
+  lldb::ScriptLanguage m_language;
+};
+} // namespace lldb_private
+
+#endif // LLDB_INTERPRETER_SCRIPTOBJECT_H
diff --git a/lldb/include/lldb/lldb-types.h b/lldb/include/lldb/lldb-types.h
@@ -80,6 +80,12 @@ typedef bool (*ExpressionCancelCallback)(ExpressionEvaluationPhase phase,
 #define LLDB_INVALID_PIPE ((lldb::pipe_t)-1)
 
 namespace lldb {
+typedef void (*LogOutputCallback)(const char *, void *baton);
+typedef bool (*CommandOverrideCallback)(void *baton, const char **argv);
+typedef bool (*ExpressionCancelCallback)(ExpressionEvaluationPhase phase,
+                                         void *baton);
+typedef void *ScriptObjectPtr;
+
 typedef uint64_t addr_t;
 typedef uint64_t user_id_t;
 typedef uint64_t pid_t;
diff --git a/lldb/source/API/CMakeLists.txt b/lldb/source/API/CMakeLists.txt
@@ -69,6 +69,7 @@ add_lldb_library(liblldb SHARED ${option_framework}
   SBQueue.cpp
   SBQueueItem.cpp
   SBReproducer.cpp
+  SBScriptObject.cpp
   SBSection.cpp
   SBSourceManager.cpp
   SBStream.cpp
diff --git a/lldb/source/API/SBProcess.cpp b/lldb/source/API/SBProcess.cpp
diff --git a/lldb/source/API/SBScriptObject.cpp b/lldb/source/API/SBScriptObject.cpp
diff --git a/lldb/source/API/SBStructuredData.cpp b/lldb/source/API/SBStructuredData.cpp
diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h b/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h
diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.cpp b/lldb/source/Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.cpp
diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/ScriptInterpreterPythonImpl.h b/lldb/source/Plugins/ScriptInterpreter/Python/ScriptInterpreterPythonImpl.h
diff --git a/lldb/test/API/python_api/sbstructureddata/TestStructuredDataAPI.py b/lldb/test/API/python_api/sbstructureddata/TestStructuredDataAPI.py
