Add -gdb-set and -gdb-show support for non-stop to lldb-mi

[ted]

Summary

lldb-mi does not support "-gdb-set non-stop" or "-gdb-show non-stop".
This patch adds that support, setting and querying the setting
target.non-stop-mode. It also includes a simple test.

[ki.stfu]

lgtm

tools/lldb-mi/MICmdCmdGdbShow.cpp

350

I think clang-format will format it the different way.

packages/Python/lldbsuite/test/tools/lldb-mi/TestMiGdbSetShow.py

def test_lldbmi_gdb_set_disassembly_flavor(self):
         self.runCmd("-data-disassemble -s %d -e %d -- 0" % (s_addr, e_addr))
         self.expect("mov ")
 
         # Test AT&T style
         self.runCmd("-gdb-set disassembly-flavor intel")
         self.expect("\^done")
         self.runCmd("-data-disassemble -s %d -e %d -- 0" % (s_addr, e_addr))
         self.expect("movl ")
+
+    @expectedFailureAll(
+        oslist=["windows"],
+        bugnumber="llvm.org/pr22274: need a pexpect replacement for windows")
+    @skipIfFreeBSD  # llvm.org/pr22411: Failure presumably due to known thread races
+    def test_lldbmi_gdb_set_show_non_stop(self):
+        """Test that 'lldb-mi --interpreter' can turn on and off non-stop mode."""
+
+        self.spawnLldbMi(args=None)
+
+        # default is off
+        self.runCmd("-gdb-show non-stop")
+        self.expect("\^done,value=\"off\"")
+
+        # turn on non-stop mode
+        self.runCmd("-gdb-set non-stop on")
+        self.expect("\^done")
+        self.runCmd("-gdb-show non-stop")
+        self.expect("\^done,value=\"on\"")
+
+        # turn off non-stop mode
+        self.runCmd("-gdb-set non-stop off")
+        self.expect("\^done")
+        self.runCmd("-gdb-show non-stop")
+        self.expect("\^done,value=\"off\"")
+

tools/lldb-mi/MICmdCmdGdbSet.h

private:
   bool GetOptionFn(const CMIUtilString &vrGdbOptionName,
                    FnGdbOptionPtr &vrwpFn) const;
   bool OptionFnTargetAsync(const CMIUtilString::VecString_t &vrWords);
   bool OptionFnPrint(const CMIUtilString::VecString_t &vrWords);
   bool OptionFnSolibSearchPath(const CMIUtilString::VecString_t &vrWords);
   bool OptionFnOutputRadix(const CMIUtilString::VecString_t &vrWords);
   bool OptionFnDisassemblyFlavor(const CMIUtilString::VecString_t &vrWords);
   bool OptionFnFallback(const CMIUtilString::VecString_t &vrWords);
+  bool OptionFnNonStop(const CMIUtilString::VecString_t &vrWords);
 
   // Attributes:
 private:
   const static MapGdbOptionNameToFnGdbOptionPtr_t
       ms_mapGdbOptionNameToFnGdbOptionPtr;
   //
   const CMIUtilString m_constStrArgNamedGdbOption;
   bool m_bGdbOptionRecognised; // True = This command has a function with a name

tools/lldb-mi/MICmdCmdGdbSet.cpp

const CMICmdCmdGdbSet::MapGdbOptionNameToFnGdbOptionPtr_t
     CMICmdCmdGdbSet::ms_mapGdbOptionNameToFnGdbOptionPtr = {
         {"target-async", &CMICmdCmdGdbSet::OptionFnTargetAsync},
         {"print", &CMICmdCmdGdbSet::OptionFnPrint},
         // { "auto-solib-add", &CMICmdCmdGdbSet::OptionFnAutoSolibAdd },    //
         // Example code if need to implement GDB set other options
         {"output-radix", &CMICmdCmdGdbSet::OptionFnOutputRadix},
         {"solib-search-path", &CMICmdCmdGdbSet::OptionFnSolibSearchPath},
         {"disassembly-flavor", &CMICmdCmdGdbSet::OptionFnDisassemblyFlavor},
+        {"non-stop", &CMICmdCmdGdbSet::OptionFnNonStop},
         {"fallback", &CMICmdCmdGdbSet::OptionFnFallback}};
 
 //++
 //------------------------------------------------------------------------------------
 // Details: CMICmdCmdGdbSet constructor.
 // Type:    Method.
 // Args:    None.
 // Return:  None.
bool CMICmdCmdGdbSet::OptionFnFallback(
 
   // Do nothing - intentional. This is a fallback function to do nothing.
   // This allows the search for gdb-set options to always succeed when the
   // option is not
   // found (implemented).
 
   return MIstatus::success;
 }
+
+//++
+//------------------------------------------------------------------------------------
+// Details: Carry out work to complete the GDB set option 'non-stop' to
+//          prepare and send back information asked for.
+// Type:    Method.
+// Args:    vrWords - (R) List of additional parameters used by this option.
+// Return:  MIstatus::success - Function succeeded.
+//          MIstatus::failure - Function failed.
+// Throws:  None.
+//--
+bool CMICmdCmdGdbSet::OptionFnNonStop(
+    const CMIUtilString::VecString_t &vrWords) {
+  bool bOk = true;
+  const char *strValue;
+
+  if (vrWords.size() > 1)
+    // Too many arguments.
+    bOk = false;
+  else if (vrWords.size() == 0)
+    // If no arguments, default is "on".
+    strValue = "true";
+  else if (CMIUtilString::Compare(vrWords[0], "on"))
+    strValue = "true";
+  else if (CMIUtilString::Compare(vrWords[0], "off"))
+    strValue = "false";
+  else
+    // Unrecognized argument.
+    bOk = false;
+
+  if (!bOk) {
+    // Report error.
+    m_bGbbOptionFnHasError = true;
+    m_strGdbOptionFnError = MIRSRC(IDS_CMD_ERR_GDBSET_OPT_NONSTOP);
+    return MIstatus::failure;
+  }
+
+  lldb::SBDebugger &rDbgr = m_rLLDBDebugSessionInfo.GetDebugger();
+  lldb::SBError error = lldb::SBDebugger::SetInternalVariable(
+      "target.non-stop-mode", strValue, rDbgr.GetInstanceName());
+  if (error.Fail()) {
+    m_strGdbOptionFnError = error.GetCString();
+    return MIstatus::failure;
+  }
+  return MIstatus::success;
+}

tools/lldb-mi/MICmdCmdGdbShow.h

 private:
   bool GetOptionFn(const CMIUtilString &vrGdbOptionName,
                    FnGdbOptionPtr &vrwpFn) const;
   bool OptionFnTargetAsync(const CMIUtilString::VecString_t &vrWords);
   bool OptionFnPrint(const CMIUtilString::VecString_t &vrWords);
   bool OptionFnLanguage(const CMIUtilString::VecString_t &vrWords);
   bool OptionFnDisassemblyFlavor(const CMIUtilString::VecString_t &vrWords);
   bool OptionFnFallback(const CMIUtilString::VecString_t &vrWords);
+  bool OptionFnNonStop(const CMIUtilString::VecString_t &vrWords);
 
   // Attributes:
 private:
   const static MapGdbOptionNameToFnGdbOptionPtr_t
       ms_mapGdbOptionNameToFnGdbOptionPtr;
 
   const CMIUtilString m_constStrArgNamedGdbOption;
   bool m_bGdbOptionRecognised; // True = This command has a function with a name

tools/lldb-mi/MICmdCmdGdbShow.cpp

 #include "MICmdArgValListOfN.h"
 #include "MICmdArgValOptionLong.h"
 #include "MICmdArgValString.h"
 #include "MICmdCmdGdbShow.h"
 #include "MICmnLLDBDebugSessionInfo.h"
 #include "MICmnMIResultRecord.h"
 #include "MICmnMIValueConst.h"
 
+#include <cstring>
+
 // Instantiations:
 const CMICmdCmdGdbShow::MapGdbOptionNameToFnGdbOptionPtr_t
     CMICmdCmdGdbShow::ms_mapGdbOptionNameToFnGdbOptionPtr = {
         {"target-async", &CMICmdCmdGdbShow::OptionFnTargetAsync},
         {"print", &CMICmdCmdGdbShow::OptionFnPrint},
         {"language", &CMICmdCmdGdbShow::OptionFnLanguage},
         {"disassembly-flavor", &CMICmdCmdGdbShow::OptionFnDisassemblyFlavor},
+        {"non-stop", &CMICmdCmdGdbShow::OptionFnNonStop},
         {"fallback", &CMICmdCmdGdbShow::OptionFnFallback}};
 
 //++
 //------------------------------------------------------------------------------------
 // Details: CMICmdCmdGdbShow constructor.
 // Type:    Method.
 // Args:    None.
 // Return:  None.
bool CMICmdCmdGdbShow::OptionFnLanguage(
   const lldb::LanguageType eLanguageType = sbCompileUnit.GetLanguage();
 
   m_strValue = lldb::SBLanguageRuntime::GetNameForLanguageType(eLanguageType);
   return MIstatus::success;
 }
 
 //++
 //------------------------------------------------------------------------------------
-// Details: Carry out work to complete the GDB show option 'disassembly-flavor' to prepare
+// Details: Carry out work to complete the GDB show option 'disassembly-flavor'
+// to prepare
 //          and send back the requested information.
 // Type:    Method.
 // Args:    vrWords - (R) List of additional parameters used by this option.
 // Return:  MIstatus::success - Function succeeded.
 //          MIstatus::failure - Function failed.
 // Throws:  None.
 //--
-bool CMICmdCmdGdbShow::OptionFnDisassemblyFlavor(const CMIUtilString::VecString_t &vrWords) {
+bool CMICmdCmdGdbShow::OptionFnDisassemblyFlavor(
+    const CMIUtilString::VecString_t &vrWords) {
   MIunused(vrWords);
 
   // Get current disassembly flavor
   lldb::SBDebugger &rDbgr = m_rLLDBDebugSessionInfo.GetDebugger();
-  m_strValue = lldb::SBDebugger::GetInternalVariableValue("target.x86-disassembly-flavor",
-                                                          rDbgr.GetInstanceName()).GetStringAtIndex(0);
+  m_strValue = lldb::SBDebugger::GetInternalVariableValue(
+                   "target.x86-disassembly-flavor", rDbgr.GetInstanceName())
+                   .GetStringAtIndex(0);
+  return MIstatus::success;
+}
+
+//++
+//------------------------------------------------------------------------------------
+// Details: Carry out work to complete the GDB show option 'non-stop' to
+//          prepare and send back the requested information.
+// Type:    Method.
+// Args:    vrWords - (R) List of additional parameters used by this option.
+// Return:  MIstatus::success - Function succeeded.
+//          MIstatus::failure - Function failed.
+// Throws:  None.
+//--
+bool CMICmdCmdGdbShow::OptionFnNonStop(
+    const CMIUtilString::VecString_t &vrWords) {
+  MIunused(vrWords);
+
+  lldb::SBDebugger &rDbgr = m_rLLDBDebugSessionInfo.GetDebugger();
+  const char *strValue = lldb::SBDebugger::GetInternalVariableValue(
+                             "target.non-stop-mode", rDbgr.GetInstanceName())
+                             .GetStringAtIndex(0);
+
+  if (!::strcmp(strValue, "true"))
+    m_strValue = "on";
+  else
+    m_strValue = "off";
+
   return MIstatus::success;
 }
 
 //++
 //------------------------------------------------------------------------------------
 // Details: Carry out work to complete the GDB show option to prepare and send
 // back the
 //          requested information.

tools/lldb-mi/MICmnResources.h

enum {
   IDS_CMD_ERR_BRKPT_INFO_OBJ_NOT_FOUND,
   IDS_CMD_ERR_LLDB_ERR_WRITE_MEM_BYTES,
   IDS_CMD_ERR_LLDB_ERR_NOT_WRITE_WHOLEBLK,
   IDS_CMD_ERR_SET_NEW_DRIVER_STATE,
   IDS_CMD_ERR_INFO_PRINTFN_NOT_FOUND,
   IDS_CMD_ERR_INFO_PRINTFN_FAILED,
   IDS_CMD_ERR_GDBSET_OPT_TARGETASYNC,
   IDS_CMD_ERR_GDBSET_OPT_SOLIBSEARCHPATH,
+  IDS_CMD_ERR_GDBSET_OPT_NONSTOP,
   IDS_CMD_ERR_GDBSET_OPT_PRINT_BAD_ARGS,
   IDS_CMD_ERR_GDBSET_OPT_PRINT_UNKNOWN_OPTION,
   IDS_CMD_ERR_GDBSHOW_OPT_PRINT_BAD_ARGS,
   IDS_CMD_ERR_GDBSHOW_OPT_PRINT_UNKNOWN_OPTION,
   IDS_CMD_ERR_EXPR_INVALID,
   IDS_CMD_ERR_ATTACH_FAILED,
   IDS_CMD_ERR_ATTACH_BAD_ARGS
 };

tools/lldb-mi/MICmnResources.cpp

CMICmnResources::ms_pResourceId2TextData[] = {
                                            "failed. %s"},
         {IDS_CMD_ERR_INFO_PRINTFN_NOT_FOUND,
          "The request '%s' was not recognised, not implemented"},
         {IDS_CMD_ERR_INFO_PRINTFN_FAILED, "The request '%s' failed."},
         {IDS_CMD_ERR_GDBSET_OPT_TARGETASYNC,
          "'target-async' expects \"on\" or \"off\""},
         {IDS_CMD_ERR_GDBSET_OPT_SOLIBSEARCHPATH,
          "'solib-search-path' requires at least one argument"},
+        {IDS_CMD_ERR_GDBSET_OPT_NONSTOP,
+         "'non-stop' expects \"on\" or \"off\""},
         {IDS_CMD_ERR_GDBSET_OPT_PRINT_BAD_ARGS,
          "'print' expects option-name and \"on\" or \"off\""},
         {IDS_CMD_ERR_GDBSET_OPT_PRINT_UNKNOWN_OPTION,
          "'print' error. The option '%s' not found"},
         {IDS_CMD_ERR_GDBSHOW_OPT_PRINT_BAD_ARGS,
          "'print' expects option-name and \"on\" or \"off\""},
         {IDS_CMD_ERR_GDBSHOW_OPT_PRINT_UNKNOWN_OPTION,
          "'print' error. The option '%s' not found"},