[lldb] Improve breakpoint management for interactive scripted process

[mib]

Summary

This patch improves breakpoint management when doing interactive
scripted process debugging.

In other to know which process set a breakpoint, we need to do some book
keeping on the multiplexer scripted process. When initializing the
multiplexer, we will first copy breakpoints that are already set on the
driving target.

Everytime we launch or resume, we should copy breakpoints from the
multiplexer to the driving process.

When creating a breakpoint from a child process, it needs to be set both
on the multiplexer and on the driving process. We also tag the created
breakpoint with the name and pid of the originator process.

This patch also implements all the requirement to achieve proper
breakpoint management. That involves:

• Adding python interator for breakpoints and watchpoints in SBTarget
• Add a new ScriptedProcess.create_breakpoint python method

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

[mib]

Re-format

[bulbazord]

Seems okay to me, but it's a little messy that we're having to manage breakpoints like this.

lldb/bindings/interface/SBTargetExtensions.i

144–171

Are these used at all?

lldb/test/API/functionalities/interactive_scripted_process/interactive_scripted_process.py

310–319

It's interesting that we dump to a file. It'd be cool if we could dump it to a StructuredData or something instead of a file.

323

Why do we delete all of the breakpoints just to re-set them afterwards? Is there a difference between what we set and what was there before?

[mib]

In D148548#4275567, @bulbazord wrote:

Seems okay to me, but it's a little messy that we're having to manage breakpoints like this.

I don't think there is a better way to do this, as breakpoint are managed per target but we're actually trying to copy them from one target to another. Let me know if you can think of another of doing it

[mib]

lldb/bindings/interface/SBTargetExtensions.i

144–171

Not in this patch but I feel like it should be implemented already and this goes along with the breakpoint accessors and iterator.

lldb/test/API/functionalities/interactive_scripted_process/interactive_scripted_process.py

310–319

100% agree, I'll do that as a followup.

323

There could be: Let's say the user set a breakpoint on the driving target (A) and a different one on the multiplexer target (B). We need first to copy all the driving target breakpoints to the multiplexer target, delete them and copy back all the multiplexer target breakpoints (A + B) to the driving target, to keep them in sync.

[JDevlieghere]

LGTM but I'll hold off on accepting to give Alex a change to take another look as he had more significant comments.

lldb/source/Interpreter/ScriptInterpreter.cpp

78–91

NTBF for this patch but we should really be using templates here to avoid code duplication.

lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.cpp

124

return false

[bulbazord]

one nit but otherwise LGTM.

lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.cpp

124

+1

[mib]

Re-format python code with black

lldb/bindings/interface/SBTargetExtensions.i

%pythoncode %{
                             matching_modules.append(module)
                     return matching_modules
                 else:
                     print("error: unsupported item type: %s" % type(key))
                 return None
 
         def get_modules_access_object(self):
             '''An accessor function that returns a modules_access() object which allows lazy module access from a lldb.SBTarget object.'''
-            return self.modules_access (self)
+            return self.modules_access(self)
 
         def get_modules_array(self):
             '''An accessor function that returns a list() that contains all modules in a lldb.SBTarget object.'''
             modules = []
             for idx in range(self.GetNumModules()):
                 modules.append(self.GetModuleAtIndex(idx))
             return modules
 
         def module_iter(self):
             '''Returns an iterator over all modules in a lldb.SBTarget
             object.'''
             return lldb_iter(self, 'GetNumModules', 'GetModuleAtIndex')
 
         def breakpoint_iter(self):
             '''Returns an iterator over all breakpoints in a lldb.SBTarget
             object.'''
             return lldb_iter(self, 'GetNumBreakpoints', 'GetBreakpointAtIndex')
 
+        class bkpts_access(object):
+            '''A helper object that will lazily hand out bkpts for a target when supplied an index.'''
+            def __init__(self, sbtarget):
+                self.sbtarget = sbtarget
+
+            def __len__(self):
+                if self.sbtarget:
+                    return int(self.sbtarget.GetNumBreakpoints())
+                return 0
+
+            def __getitem__(self, key):
+                if isinstance(key, int):
+                    count = len(self)
+                    if -count <= key < count:
+                        key %= count
+                        return self.sbtarget.GetBreakpointAtIndex(key)
+                return None
+
+        def get_bkpts_access_object(self):
+            '''An accessor function that returns a bkpts_access() object which allows lazy bkpt access from a lldb.SBtarget object.'''
+            return self.bkpts_access(self)
+
+        def get_target_bkpts(self):
+            '''An accessor function that returns a list() that contains all bkpts in a lldb.SBtarget object.'''
+            bkpts = []
+            for idx in range(self.GetNumBreakpoints()):
+                bkpts.append(self.GetBreakpointAtIndex(idx))
+            return bkpts
+
         def watchpoint_iter(self):
             '''Returns an iterator over all watchpoints in a lldb.SBTarget
             object.'''
             return lldb_iter(self, 'GetNumWatchpoints', 'GetWatchpointAtIndex')
 
+        class watchpoints_access(object):
+            '''A helper object that will lazily hand out watchpoints for a target when supplied an index.'''
+            def __init__(self, sbtarget):
+                self.sbtarget = sbtarget
+
+            def __len__(self):
+                if self.sbtarget:
+                    return int(self.sbtarget.GetNumWatchpoints())
+                return 0
+
+            def __getitem__(self, key):
+                if isinstance(key, int):
+                    count = len(self)
+                    if -count <= key < count:
+                        key %= count
+                        return self.sbtarget.GetWatchpointAtIndex(key)
+                return None
+
+        def get_watchpoints_access_object(self):
+            '''An accessor function that returns a watchpoints_access() object which allows lazy watchpoint access from a lldb.SBtarget object.'''
+            return self.watchpoints_access(self)
+
+        def get_target_watchpoints(self):
+            '''An accessor function that returns a list() that contains all watchpoints in a lldb.SBtarget object.'''
+            watchpoints = []
+            for idx in range(self.GetNumWatchpoints()):
+                bkpts.append(self.GetWatchpointAtIndex(idx))
+            return watchpoints
+
         modules = property(get_modules_array, None, doc='''A read only property that returns a list() of lldb.SBModule objects contained in this target. This list is a list all modules that the target currently is tracking (the main executable and all dependent shared libraries).''')
         module = property(get_modules_access_object, None, doc=r'''A read only property that returns an object that implements python operator overloading with the square brackets().\n    target.module[<int>] allows array access to any modules.\n    target.module[<str>] allows access to modules by basename, full path, or uuid string value.\n    target.module[uuid.UUID()] allows module access by UUID.\n    target.module[re] allows module access using a regular expression that matches the module full path.''')
         process = property(GetProcess, None, doc='''A read only property that returns an lldb object that represents the process (lldb.SBProcess) that this target owns.''')
         executable = property(GetExecutable, None, doc='''A read only property that returns an lldb object that represents the main executable module (lldb.SBModule) for this target.''')
         debugger = property(GetDebugger, None, doc='''A read only property that returns an lldb object that represents the debugger (lldb.SBDebugger) that owns this target.''')
         num_breakpoints = property(GetNumBreakpoints, None, doc='''A read only property that returns the number of breakpoints that this target has as an integer.''')
+        breakpoints = property(get_target_bkpts, None, doc='''A read only property that returns a list() of lldb.SBBreakpoint objects for all breakpoints in this target.''')
+        breakpoint = property(get_bkpts_access_object, None, doc='''A read only property that returns an object that can be used to access breakpoints as an array ("bkpt_12 = lldb.target.bkpt[12]").''')
         num_watchpoints = property(GetNumWatchpoints, None, doc='''A read only property that returns the number of watchpoints that this target has as an integer.''')
+        watchpoints = property(get_target_watchpoints, None, doc='''A read only property that returns a list() of lldb.SBwatchpoint objects for all watchpoints in this target.''')
+        watchpoint = property(get_watchpoints_access_object, None, doc='''A read only property that returns an object that can be used to access watchpoints as an array ("watchpoint_12 = lldb.target.watchpoint[12]").''')
         broadcaster = property(GetBroadcaster, None, doc='''A read only property that an lldb object that represents the broadcaster (lldb.SBBroadcaster) for this target.''')
         byte_order = property(GetByteOrder, None, doc='''A read only property that returns an lldb enumeration value (lldb.eByteOrderLittle, lldb.eByteOrderBig, lldb.eByteOrderInvalid) that represents the byte order for this target.''')
         addr_size = property(GetAddressByteSize, None, doc='''A read only property that returns the size in bytes of an address for this target.''')
         triple = property(GetTriple, None, doc='''A read only property that returns the target triple (arch-vendor-os) for this target as a string.''')
         data_byte_size = property(GetDataByteSize, None, doc='''A read only property that returns the size in host bytes of a byte in the data address space for this target.''')
         code_byte_size = property(GetCodeByteSize, None, doc='''A read only property that returns the size in host bytes of a byte in the code address space for this target.''')
         platform = property(GetPlatform, None, doc='''A read only property that returns the platform associated with with this target.''')
     %}
 #endif
 }

lldb/bindings/python/python-wrapper.swig

int valid_cast =
       SWIG_ConvertPtr(data, (void **)&sb_ptr, SWIGTYPE_p_lldb__SBData, 0);
 
   if (valid_cast == -1)
     return NULL;
 
   return sb_ptr;
 }
 
+void *lldb_private::LLDBSWIGPython_CastPyObjectToSBBreakpoint(PyObject * data) {
+  lldb::SBBreakpoint *sb_ptr = nullptr;
+
+  int valid_cast =
+      SWIG_ConvertPtr(data, (void **)&sb_ptr, SWIGTYPE_p_lldb__SBBreakpoint, 0);
+
+  if (valid_cast == -1)
+    return NULL;
+
+  return sb_ptr;
+}
+
 void *lldb_private::LLDBSWIGPython_CastPyObjectToSBAttachInfo(PyObject * data) {
   lldb::SBAttachInfo *sb_ptr = nullptr;
 
   int valid_cast =
       SWIG_ConvertPtr(data, (void **)&sb_ptr, SWIGTYPE_p_lldb__SBAttachInfo, 0);
 
   if (valid_cast == -1)
     return NULL;

lldb/examples/python/scripted_process/scripted_process.py

def get_process_metadata(self):
         """ Get some metadata for the scripted process.
 
         Returns:
             Dict: A dictionary containing metadata for the scripted process.
                   None if the process as no metadata.
         """
         return self.metadata
 
+    def create_breakpoint(self, addr, error):
+        """ Create a breakpoint in the scripted process from an address.
+            This is mainly used with interactive scripted process debugging.
+
+        Args:
+            addr (int): Address at which the breakpoint should be set.
+            error (lldb.SBError): Error object.
+
+        Returns:
+            SBBreakpoint: A valid breakpoint object that was created a the specified
+                          address. None if the breakpoint creation failed.
+        """
+        error.SetErrorString("%s doesn't support creating breakpoints."
+                             % self.__class__.__name__)
+        return False
+
+
 class ScriptedThread(metaclass=ABCMeta):
 
     """
     The base class for a scripted thread.
 
     Most of the base class methods are `@abstractmethod` that need to be
     overwritten by the inheriting class.
 

lldb/include/lldb/API/SBBreakpoint.h

 //===-- SBBreakpoint.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_SBBREAKPOINT_H
 #define LLDB_API_SBBREAKPOINT_H
 
 #include "lldb/API/SBDefines.h"
 
 class SBBreakpointListImpl;
 
+namespace lldb_private {
+class ScriptInterpreter;
+}
+
 namespace lldb {
 
 class LLDB_API SBBreakpoint {
 public:
 
   SBBreakpoint();
 
   SBBreakpoint(const lldb::SBBreakpoint &rhs);
#endif
   SBStructuredData SerializeToStructuredData();
 
 private:
   friend class SBBreakpointList;
   friend class SBBreakpointLocation;
   friend class SBBreakpointName;
   friend class SBTarget;
 
+  friend class lldb_private::ScriptInterpreter;
+
   lldb::BreakpointSP GetSP() const;
 
   lldb::BreakpointWP m_opaque_wp;
 };
 
 class LLDB_API SBBreakpointList {
 public:
   SBBreakpointList(SBTarget &target);

lldb/include/lldb/Interpreter/ScriptInterpreter.h

 //===-- ScriptInterpreter.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_SCRIPTINTERPRETER_H
 #define LLDB_INTERPRETER_SCRIPTINTERPRETER_H
 
 #include "lldb/API/SBAttachInfo.h"
+#include "lldb/API/SBBreakpoint.h"
 #include "lldb/API/SBData.h"
 #include "lldb/API/SBError.h"
 #include "lldb/API/SBLaunchInfo.h"
 #include "lldb/API/SBMemoryRegionInfo.h"
 #include "lldb/Breakpoint/BreakpointOptions.h"
 #include "lldb/Core/PluginInterface.h"
 #include "lldb/Core/SearchFilter.h"
 #include "lldb/Core/StreamFile.h"
ScriptedPlatformInterface &GetScriptedPlatformInterface() {
     return *m_scripted_platform_interface_up;
   }
 
   lldb::DataExtractorSP
   GetDataExtractorFromSBData(const lldb::SBData &data) const;
 
   Status GetStatusFromSBError(const lldb::SBError &error) const;
 
+  lldb::BreakpointSP
+  GetOpaqueTypeFromSBBreakpoint(const lldb::SBBreakpoint &breakpoint) const;
+
   lldb::ProcessAttachInfoSP
   GetOpaqueTypeFromSBAttachInfo(const lldb::SBAttachInfo &attach_info) const;
 
   lldb::ProcessLaunchInfoSP
   GetOpaqueTypeFromSBLaunchInfo(const lldb::SBLaunchInfo &launch_info) const;
 
   std::optional<MemoryRegionInfo> GetOpaqueTypeFromSBMemoryRegionInfo(
       const lldb::SBMemoryRegionInfo &mem_region) const;

lldb/include/lldb/Interpreter/ScriptedProcessInterface.h

public:
   virtual std::optional<MemoryRegionInfo>
   GetMemoryRegionContainingAddress(lldb::addr_t address, Status &error) {
     error.SetErrorString("ScriptedProcess have no memory region.");
     return {};
   }
 
   virtual StructuredData::DictionarySP GetThreadsInfo() { return {}; }
 
+  virtual bool CreateBreakpoint(lldb::addr_t addr, Status &error) {
+    error.SetErrorString("ScriptedProcess don't support creating breakpoints.");
+    return {};
+  }
+
   virtual lldb::DataExtractorSP
   ReadMemoryAtAddress(lldb::addr_t address, size_t size, Status &error) {
     return {};
   }
 
   virtual lldb::offset_t WriteMemoryAtAddress(lldb::addr_t addr,
                                               lldb::DataExtractorSP data_sp,
                                               Status &error) {

lldb/source/Interpreter/ScriptInterpreter.cpp

std::string ScriptInterpreter::LanguageToString(lldb::ScriptLanguage language) {
   case eScriptLanguageLua:
     return "Lua";
   case eScriptLanguageUnknown:
     return "Unknown";
   }
   llvm_unreachable("Unhandled ScriptInterpreter!");
 }
 
 lldb::DataExtractorSP
 ScriptInterpreter::GetDataExtractorFromSBData(const lldb::SBData &data) const {
   return data.m_opaque_sp;
 }
 
+lldb::BreakpointSP ScriptInterpreter::GetOpaqueTypeFromSBBreakpoint(
+    const lldb::SBBreakpoint &breakpoint) const {
+  return breakpoint.m_opaque_wp.lock();
+}
+
 lldb::ProcessAttachInfoSP ScriptInterpreter::GetOpaqueTypeFromSBAttachInfo(
     const lldb::SBAttachInfo &attach_info) const {
   return attach_info.m_opaque_sp;
 }
 
 lldb::ProcessLaunchInfoSP ScriptInterpreter::GetOpaqueTypeFromSBLaunchInfo(
     const lldb::SBLaunchInfo &launch_info) const {
   return std::make_shared<ProcessLaunchInfo>(
       *reinterpret_cast<ProcessLaunchInfo *>(launch_info.m_opaque_sp.get()));
 }
 
 Status

lldb/source/Plugins/Process/scripted/ScriptedProcess.cpp

Status ScriptedProcess::EnableBreakpointSite(BreakpointSite *bp_site) {
   if (bp_site->IsEnabled()) {
     return {};
   }
 
   if (bp_site->HardwareRequired()) {
     return Status("Scripted Processes don't support hardware breakpoints");
   }
 
-  return EnableSoftwareBreakpoint(bp_site);
+  Status error;
+  GetInterface().CreateBreakpoint(bp_site->GetLoadAddress(), error);
+
+  return error;
 }
 
 ArchSpec ScriptedProcess::GetArchitecture() {
   return GetTarget().GetArchitecture();
 }
 
 Status ScriptedProcess::DoGetMemoryRegionInfo(lldb::addr_t load_addr,
                                               MemoryRegionInfo &region) {

lldb/source/Plugins/ScriptInterpreter/Python/SWIGPythonBridge.h

 
 python::ScopedPythonObject<lldb::SBCommandReturnObject>
 ToSWIGWrapper(CommandReturnObject &cmd_retobj);
 python::ScopedPythonObject<lldb::SBEvent> ToSWIGWrapper(Event *event);
 
 } // namespace python
 
 void *LLDBSWIGPython_CastPyObjectToSBData(PyObject *data);
+void *LLDBSWIGPython_CastPyObjectToSBBreakpoint(PyObject *data);
 void *LLDBSWIGPython_CastPyObjectToSBAttachInfo(PyObject *data);
 void *LLDBSWIGPython_CastPyObjectToSBLaunchInfo(PyObject *data);
 void *LLDBSWIGPython_CastPyObjectToSBError(PyObject *data);
 void *LLDBSWIGPython_CastPyObjectToSBValue(PyObject *data);
 void *LLDBSWIGPython_CastPyObjectToSBMemoryRegionInfo(PyObject *data);
 
 // These prototypes are the Pythonic implementations of the required callbacks.
 // Although these are scripting-language specific, their definition depends on

lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.h

public:
   Status Resume() override;
 
   std::optional<MemoryRegionInfo>
   GetMemoryRegionContainingAddress(lldb::addr_t address,
                                    Status &error) override;
 
   StructuredData::DictionarySP GetThreadsInfo() override;
 
+  bool CreateBreakpoint(lldb::addr_t addr, Status &error) override;
+
   lldb::DataExtractorSP ReadMemoryAtAddress(lldb::addr_t address, size_t size,
                                             Status &error) override;
 
   lldb::offset_t WriteMemoryAtAddress(lldb::addr_t addr,
                                       lldb::DataExtractorSP data_sp,
                                       Status &error) override;
 
   StructuredData::ArraySP GetLoadedImages() override;

lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.cpp

StructuredData::DictionarySP dict =
       Dispatch<StructuredData::DictionarySP>("get_threads_info", error);
 
   if (!CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, dict, error))
     return {};
 
   return dict;
 }
 
+bool ScriptedProcessPythonInterface::CreateBreakpoint(lldb::addr_t addr,
+                                                      Status &error) {
+  Status py_error;
+  StructuredData::ObjectSP obj =
+      Dispatch("create_breakpoint", py_error, addr, error);
+
+  // If there was an error on the python call, surface it to the user.
+  if (py_error.Fail())
+    error = py_error;
+
+  if (!CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj, error))
+    return {};
+
+  return obj->GetBooleanValue();
+}
+
 lldb::DataExtractorSP ScriptedProcessPythonInterface::ReadMemoryAtAddress(
     lldb::addr_t address, size_t size, Status &error) {
   Status py_error;
   lldb::DataExtractorSP data_sp = Dispatch<lldb::DataExtractorSP>(
       "read_memory_at_address", py_error, address, size, error);
 
   // If there was an error on the python call, surface it to the user.
   if (py_error.Fail())

lldb/source/Plugins/ScriptInterpreter/Python/ScriptedPythonInterface.h

 ScriptedPythonInterface::ExtractValueFromPythonObject<
     StructuredData::DictionarySP>(python::PythonObject &p, Status &error);
 
 template <>
 Status ScriptedPythonInterface::ExtractValueFromPythonObject<Status>(
     python::PythonObject &p, Status &error);
 
 template <>
+lldb::BreakpointSP
+ScriptedPythonInterface::ExtractValueFromPythonObject<lldb::BreakpointSP>(
+    python::PythonObject &p, Status &error);
+
+template <>
 lldb::ProcessAttachInfoSP ScriptedPythonInterface::ExtractValueFromPythonObject<
     lldb::ProcessAttachInfoSP>(python::PythonObject &p, Status &error);
 
 template <>
 lldb::ProcessLaunchInfoSP ScriptedPythonInterface::ExtractValueFromPythonObject<
     lldb::ProcessLaunchInfoSP>(python::PythonObject &p, Status &error);
 
 template <>

lldb/source/Plugins/ScriptInterpreter/Python/ScriptedPythonInterface.cpp

error.SetErrorString(
         "Couldn't cast lldb::SBData to lldb::DataExtractorSP.");
     return nullptr;
   }
 
   return m_interpreter.GetDataExtractorFromSBData(*sb_data);
 }
 
 template <>
+lldb::BreakpointSP
+ScriptedPythonInterface::ExtractValueFromPythonObject<lldb::BreakpointSP>(
+    python::PythonObject &p, Status &error) {
+  lldb::SBBreakpoint *sb_breakpoint = reinterpret_cast<lldb::SBBreakpoint *>(
+      LLDBSWIGPython_CastPyObjectToSBBreakpoint(p.get()));
+
+  if (!sb_breakpoint) {
+    error.SetErrorString(
+        "Couldn't cast lldb::SBBreakpoint to lldb::BreakpointSP.");
+    return nullptr;
+  }
+
+  return m_interpreter.GetOpaqueTypeFromSBBreakpoint(*sb_breakpoint);
+}
+
+template <>
 lldb::ProcessAttachInfoSP ScriptedPythonInterface::ExtractValueFromPythonObject<
     lldb::ProcessAttachInfoSP>(python::PythonObject &p, Status &error) {
   lldb::SBAttachInfo *sb_attach_info = reinterpret_cast<lldb::SBAttachInfo *>(
       LLDBSWIGPython_CastPyObjectToSBAttachInfo(p.get()));
 
   if (!sb_attach_info) {
     error.SetErrorString(
         "Couldn't cast lldb::SBAttachInfo to lldb::ProcessAttachInfoSP.");

lldb/test/API/functionalities/interactive_scripted_process/TestInteractiveScriptedProcess.py

def passthrough_launch(self):
             "Same number of threads",
         )
         for id in range(len(real_process.threads)):
             real_pc = real_process.threads[id].frame[0].pc
             mux_pc = mux_process.threads[id].frame[0].pc
             self.assertEqual(real_pc, mux_pc, f"PC's equal for {id}")
 
         lldbutil.run_break_set_by_source_regexp(self, "also break here")
-        self.assertEqual(mux_target.GetNumBreakpoints(), 1)
+        self.assertEqual(mux_target.GetNumBreakpoints(), 2)
         error = mux_process.Continue()
         self.assertSuccess(error, "Resuming multiplexer scripted process")
         self.assertTrue(mux_process.IsValid(), "Got a valid process")
 
         event = lldbutil.fetch_next_event(
             self, mux_process_listener, mux_process.GetBroadcaster()
         )
         self.assertState(lldb.SBProcess.GetStateFromEvent(event), lldb.eStateRunning)
         event = lldbutil.fetch_next_event(
             self, mux_process_listener, mux_process.GetBroadcaster()
         )
         self.assertState(lldb.SBProcess.GetStateFromEvent(event), lldb.eStateStopped)

lldb/test/API/functionalities/interactive_scripted_process/interactive_scripted_process.py

 # Usage:
 # ./bin/lldb $LLVM/lldb/test/API/functionalities/interactive_scripted_process/main \
 #   -o "br set -p 'Break here'" \
 #   -o "command script import $LLVM/lldb/test/API/functionalities/interactive_scripted_process/interactive_scripted_process.py" \
 #   -o "create_mux" \
 #   -o "create_sub" \
 #   -o "br set -p 'also break here'" -o 'continue'
 
-import os, json, struct, signal
+import os, json, struct, signal, tempfile
 
 from threading import Thread
 from typing import Any, Dict
 
 import lldb
 from lldb.plugins.scripted_process import ScriptedProcess
 from lldb.plugins.scripted_process import ScriptedThread
 
def get_threads_info(self) -> Dict[int, Any]:
         # Update the filtered thread class from PassthruScriptedThread to MultiplexedScriptedThread
         return dict(
             map(
                 lambda pair: (pair[0], MultiplexedScriptedThread(pair[1])),
                 filtered_threads.items(),
             )
         )
 
+    def create_breakpoint(self, addr, error, pid=None):
+        if not self.multiplexer:
+            error.SetErrorString("Multiplexer is not set.")
+        return self.multiplexer.create_breakpoint(addr, error, self.get_process_id())
+
     def get_scripted_thread_plugin(self) -> str:
         return f"{MultiplexedScriptedThread.__module__}.{MultiplexedScriptedThread.__name__}"
 
 
 class PassthruScriptedThread(ScriptedThread):
     def __init__(self, process, args):
         super().__init__(process, args)
         driving_target_idx = args.GetValueForKey("driving_target_idx")
class MultiplexerScriptedProcess(PassthruScriptedProcess):
     def __init__(self, exe_ctx: lldb.SBExecutionContext, args: lldb.SBStructuredData):
         super().__init__(exe_ctx, args, launched_driving_process=False)
         if isinstance(self.driving_target, lldb.SBTarget) and self.driving_target:
             self.listener = lldb.SBListener(
                 "lldb.listener.multiplexer-scripted-process"
             )
             self.multiplexed_processes = {}
 
+            # Copy breakpoints from real target to passthrough
+            with tempfile.NamedTemporaryFile() as tf:
+                bkpt_file = lldb.SBFileSpec(tf.name)
+                error = self.driving_target.BreakpointsWriteToFile(bkpt_file)
+                if error.Fail():
+                    log(
+                        "Failed to save breakpoints from driving target (%s)"
+                        % error.GetCString()
+                    )
+                bkpts_list = lldb.SBBreakpointList(self.target)
+                error = self.target.BreakpointsCreateFromFile(bkpt_file, bkpts_list)
+                if error.Fail():
+                    log(
+                        "Failed create breakpoints from driving target \
+                        (bkpt file: %s)"
+                        % tf.name
+                    )
+
+            # Copy breakpoint from passthrough to real target
+            if error.Success():
+                self.driving_target.DeleteAllBreakpoints()
+                for bkpt in self.target.breakpoints:
+                    if bkpt.IsValid():
+                        for bl in bkpt:
+                            real_bpkt = self.driving_target.BreakpointCreateBySBAddress(
+                                bl.GetAddress()
+                            )
+                            if not real_bpkt.IsValid():
+                                log(
+                                    "Failed to set breakpoint at address %s in \
+                                    driving target"
+                                    % hex(bl.GetLoadAddress())
+                                )
+
             self.listener_thread = Thread(
                 target=self.wait_for_driving_process_to_stop, daemon=True
             )
             self.listener_thread.start()
 
     def launch(self, should_stop: bool = True) -> lldb.SBError:
         if not self.driving_target:
             return lldb.SBError(
def resume(self, should_stop: bool = True) -> lldb.SBError:
         return self.driving_process.Continue()
 
     def get_threads_info(self, pid: int = None) -> Dict[int, Any]:
         if not pid:
             return super().get_threads_info()
         parity = pid % 2
         return dict(filter(lambda pair: pair[0] % 2 == parity, self.threads.items()))
 
+    def create_breakpoint(self, addr, error, pid=None):
+        if not self.driving_target:
+            error.SetErrorString("%s has no driving target." % self.__class__.__name__)
+            return False
+
+        def create_breakpoint_with_name(target, load_addr, name, error):
+            addr = lldb.SBAddress(load_addr, target)
+            if not addr.IsValid():
+                error.SetErrorString("Invalid breakpoint address %s" % hex(load_addr))
+                return False
+            bkpt = target.BreakpointCreateBySBAddress(addr)
+            if not bkpt.IsValid():
+                error.SetErrorString(
+                    "Failed to create breakpoint at address %s"
+                    % hex(addr.GetLoadAddress())
+                )
+                return False
+            error = bkpt.AddNameWithErrorHandling(name)
+            return error.Success()
+
+        name = (
+            "multiplexer_scripted_process"
+            if not pid
+            else f"multiplexed_scripted_process_{pid}"
+        )
+
+        if pid is not None:
+            # This means that this method has been called from one of the
+            # multiplexed scripted process. That also means that the multiplexer
+            # target doesn't have this breakpoint created.
+            mux_error = lldb.SBError()
+            bkpt = create_breakpoint_with_name(self.target, addr, name, mux_error)
+            if mux_error.Fail():
+                error.SetError(
+                    "Failed to create breakpoint in multiplexer \
+                               target: %s"
+                    % mux_error.GetCString()
+                )
+                return False
+        return create_breakpoint_with_name(self.driving_target, addr, name, error)
+
 
 def multiplex(mux_process, muxed_process):
     muxed_process.GetScriptedImplementation().multiplexer = (
         mux_process.GetScriptedImplementation()
     )
     mux_process.GetScriptedImplementation().multiplexed_processes[
         muxed_process.GetProcessID()
     ] = muxed_process

lldb/unittests/ScriptInterpreter/Python/PythonTestSuite.cpp

int lldb_private::LLDBSwigPython_GetIndexOfChildWithName(
     PyObject *implementor, const char *child_name) {
   return 0;
 }
 
 void *lldb_private::LLDBSWIGPython_CastPyObjectToSBData(PyObject *data) {
   return nullptr;
 }
 
+void *lldb_private::LLDBSWIGPython_CastPyObjectToSBBreakpoint(PyObject *data) {
+  return nullptr;
+}
+
 void *lldb_private::LLDBSWIGPython_CastPyObjectToSBAttachInfo(PyObject *data) {
   return nullptr;
 }
 
 void *lldb_private::LLDBSWIGPython_CastPyObjectToSBLaunchInfo(PyObject *data) {
   return nullptr;
 }