Extend D55859 symbols.enable-external-lookup=false for more testcases

[jankratochvil]

Summary

D55859 has no effect for some of the testcases so this patch extends it even for (all?) other testcases known to me. LLDB was failing when LLDB prints errors reading system debug infos (*-debuginfo.rpm, DWZ-optimized) which should never happen as LLDB testcases should not be affected by system debug infos.

lldb/packages/Python/lldbsuite/test/api/multithreaded/driver.cpp.template is using only SB API which does not expose ModuleList so I had to call HandleCommand() there.

lldb-test.cpp could also use HandleCommand and then there would be no need for ModuleListProperties::SetEnableExternalLookup() but I think it is cleaner with API and not on based on text commands.

[labath]

It looks like lldb-mi has the --source option. Could that be used to set this setting automatically via lit, as it is done with %lldb ?

[jankratochvil]

In D63339#1546076, @labath wrote:

It looks like lldb-mi has the --source option. Could that be used to set this setting automatically via lit, as it is done with %lldb ?

The problem is it generates additional ^done line

echo 'settings set symbols.enable-external-lookup false' >/tmp/1j;lldb-mi --source /tmp/1j
(gdb)
settings set symbols.enable-external-lookup false
^done
(gdb)

which the scripts do not expect. They already expect such "unexpected" response from a commandline parameter the scripts pass themselves (%t):

# RUN: %lldbmi %t < %s | FileCheck %s
# Check that we have a valid target created via '%lldbmi %t'.
# CHECK: ^done

This would mean adding additional one # CHECK: ^done for the settings set symbols.enable-external-lookup false command which is not present in the script which I hope you agree is worse than adding both that command+its response as I did.
Or did you mean it some different way? Thanks for the review.

[labath]

In D63339#1546091, @jankratochvil wrote:

In D63339#1546076, @labath wrote:

It looks like lldb-mi has the --source option. Could that be used to set this setting automatically via lit, as it is done with %lldb ?

The problem is it generates additional ^done line

echo 'settings set symbols.enable-external-lookup false' >/tmp/1j;lldb-mi --source /tmp/1j
(gdb)
settings set symbols.enable-external-lookup false
^done
(gdb)

which the scripts do not expect. They already expect such "unexpected" response from a commandline parameter the scripts pass themselves (%t):

# RUN: %lldbmi %t < %s | FileCheck %s
# Check that we have a valid target created via '%lldbmi %t'.
# CHECK: ^done

This would mean adding additional one # CHECK: ^done for the settings set symbols.enable-external-lookup false command which is not present in the script which I hope you agree is worse than adding both that command+its response as I did.
Or did you mean it some different way? Thanks for the review.

Nope, that's exactly what I meant. I think the fact that you're not able to do this is a pretty big flaw in these lldb-mi tests, but I've already kind of given up on lldb-mi, so I don't care either way..

The rest of the changes seem fine to me.

lldb/packages/Python/lldbsuite/test/lldbtest.py

736 ↗

(On Diff #204785)

if os.environ.get("NO_LLDBINIT") != "NO":

lldb/trunk/include/lldb/Core/ModuleList.h

 
 class ModuleListProperties : public Properties {
 public:
   ModuleListProperties();
 
   FileSpec GetClangModulesCachePath() const;
   bool SetClangModulesCachePath(llvm::StringRef path);
   bool GetEnableExternalLookup() const;
+  bool SetEnableExternalLookup(bool new_value);
 }; 
 
 /// \class ModuleList ModuleList.h "lldb/Core/ModuleList.h"
 /// A collection class for Module objects.
 ///
 /// Modules in the module collection class are stored as reference counted
 /// shared pointers to Module objects.
 class ModuleList {

lldb/trunk/lit/tools/lldb-mi/breakpoint/break-insert-enable-pending.test

 # XFAIL: system-windows
 # -> llvm.org/pr24452
 # XFAIL: system-netbsd
 #
 # RUN: %clang -o %t %p/inputs/break-insert-pending.c -g
 # RUN: %lldbmi %t < %s | FileCheck %s
 
 # Test for enabling pending breakpoints globally
 
+settings set symbols.enable-external-lookup false
+# CHECK: ^done
+
 -break-insert printf
 # CHECK: ^error,msg="Command 'break-insert'. Breakpoint location 'printf' not found
 
 -gdb-set breakpoint pending on
 # CHECK: ^done
 -gdb-show breakpoint pending
 # CHECK: ^done,value="on"
 -break-insert printf

lldb/trunk/lit/tools/lldb-mi/breakpoint/break-insert.test

 # XFAIL: system-netbsd
 # UNSUPPORTED: system-linux
 #
 # RUN: %build %p/inputs/break-insert.c --nodefaultlib -o a.exe
 # RUN: %lldbmi < %s | FileCheck %s
 
 # Test that a breakpoint can be inserted before creating a target.
 
+settings set symbols.enable-external-lookup false
+# CHECK: ^done
+
 -break-insert breakpoint
 # CHECK: ^done,bkpt={number="1"
 
 -file-exec-and-symbols a.exe
 # CHECK: ^done
 
 -exec-run
 # CHECK: ^running
 # CHECK: *stopped,reason="breakpoint-hit"
 

lldb/trunk/lit/tools/lldb-mi/data/data-info-line.test

 # XFAIL: system-netbsd
 #
 # RUN: %build %p/inputs/data-info-line.c --nodefaultlib -o %t
 # RUN: %lldbmi %t < %s | FileCheck %s
 
 # Test lldb-mi -data-info-line command.
 
 # Check that we have a valid target created via '%lldbmi %t'.
 # CHECK: ^done
 
+settings set symbols.enable-external-lookup false
+# CHECK: ^done
+
 -break-insert main
 # CHECK: ^done,bkpt={number="1"
 
 -exec-run
 # CHECK: ^running
 # CHECK: *stopped,reason="breakpoint-hit"
 
 -data-info-line *0x0

lldb/trunk/lit/tools/lldb-mi/exec/exec-continue.test

 # XFAIL: system-netbsd
 #
 # RUN: %build %p/inputs/main.c --nodefaultlib -o %t
 # RUN: %lldbmi %t < %s | FileCheck %s
 
 # Test lldb-mi -exec-continue command.
 
 # Check that we have a valid target created via '%lldbmi %t'.
 # CHECK: ^done
 
+settings set symbols.enable-external-lookup false
+# CHECK: ^done
+
 -break-insert main
 # CHECK: ^done,bkpt={number="1"
 
 -exec-run
 # CHECK: ^running
 # CHECK: *stopped,reason="breakpoint-hit"
 
 -exec-continue
 # CHECK: ^running

lldb/trunk/lit/tools/lldb-mi/exec/exec-finish.test

 # RUN: %build %p/inputs/main.c -o %t
 # RUN: %lldbmi %t < %s | FileCheck %s
 
 # Test lldb-mi -exec-finish command.
 
 # Check that we have a valid target created via '%lldbmi %t'.
 # CHECK: ^done
 
+settings set symbols.enable-external-lookup false
+# CHECK: ^done
+
 -break-insert main
 # CHECK: ^done,bkpt={number="1"
 
 -break-insert dummyFunction
 # CHECK: ^done,bkpt={number="2"
 
 -exec-run
 # CHECK: ^running

lldb/trunk/lit/tools/lldb-mi/exec/exec-interrupt.test

 # XFAIL: system-netbsd
 #
 # RUN: %build %p/inputs/main.c --nodefaultlib -o %t
 # RUN: %lldbmi %t < %s | FileCheck %s
 
 # Test lldb-mi -exec-interrupt command.
 
 # Check that we have a valid target created via '%lldbmi %t'.
 # CHECK: ^done
 
+settings set symbols.enable-external-lookup false
+# CHECK: ^done
+
 -break-insert main
 # CHECK: ^done,bkpt={number="1"
 
 -exec-run
 # CHECK: ^running
 # CHECK: *stopped,reason="breakpoint-hit"
 
 -exec-interrupt
 # CHECK: ^error,msg="Process is not running."

lldb/trunk/lit/tools/lldb-mi/exec/exec-next-instruction.test

 # XFAIL: system-netbsd
 #
 # RUN: %build %p/inputs/main.c --nodefaultlib -o %t
 # RUN: %lldbmi %t < %s | FileCheck %s
 
 # Test lldb-mi -exec-next-instruction command.
 
 # Check that we have a valid target created via '%lldbmi %t'.
 # CHECK: ^done
 
+settings set symbols.enable-external-lookup false
+# CHECK: ^done
+
 -break-insert main
 # CHECK: ^done,bkpt={number="1"
 
 -exec-run
 # CHECK: ^running
 # CHECK: *stopped,reason="breakpoint-hit"
 
 -exec-next-instruction --thread 0

lldb/trunk/lit/tools/lldb-mi/exec/exec-next.test

 # XFAIL: system-netbsd
 # UNSUPPORTED: system-linux
 #
 # RUN: %build %p/inputs/main.c --nodefaultlib -o %t
 # RUN: %lldbmi %t < %s | FileCheck %s
 
 # Test lldb-mi -exec-next command.
 
 # Check that we have a valid target created via '%lldbmi %t'.
 # CHECK: ^done
 
+settings set symbols.enable-external-lookup false
+# CHECK: ^done
+
 -break-insert main
 # CHECK: ^done,bkpt={number="1"
 
 -exec-run
 # CHECK: ^running
 # CHECK: *stopped,reason="breakpoint-hit"
 
 -exec-next --thread 0

lldb/trunk/lit/tools/lldb-mi/exec/exec-step-instruction.test

 # XFAIL: system-netbsd
 #
 # RUN: %build %p/inputs/main.c --nodefaultlib -o %t
 # RUN: %lldbmi %t < %s | FileCheck %s
 
 # Test lldb-mi -exec-step-instruction command.
 
 # Check that we have a valid target created via '%lldbmi %t'.
 # CHECK: ^done
 
+settings set symbols.enable-external-lookup false
+# CHECK: ^done
+
 -break-insert main
 # CHECK: ^done,bkpt={number="1"
 
 -exec-run
 # CHECK: ^running
 # CHECK: *stopped,reason="breakpoint-hit"
 
 -exec-step-instruction --thread 0

lldb/trunk/lit/tools/lldb-mi/exec/exec-step.test

 # XFAIL: system-netbsd
 #
 # RUN: %build %p/inputs/main.c --nodefaultlib -o %t
 # RUN: %lldbmi %t < %s | FileCheck %s
 
 # Test lldb-mi -exec-step command.
 
 # Check that we have a valid target created via '%lldbmi %t'.
 # CHECK: ^done
 
+settings set symbols.enable-external-lookup false
+# CHECK: ^done
+
 -break-insert main
 # CHECK: ^done,bkpt={number="1"
 
 -exec-run
 # CHECK: ^running
 # CHECK: *stopped,reason="breakpoint-hit"
 
 -exec-step --thread 0

lldb/trunk/packages/Python/lldbsuite/test/api/multithreaded/driver.cpp.template

 // Unixen that take the driver down.
 #if !defined(_MSC_VER)
   signal(SIGPIPE, SIG_IGN);
 #endif
   int code = 0;
 
   SBDebugger::Initialize();
   SBDebugger dbg = SBDebugger::Create();
+  dbg.HandleCommand("settings set symbols.enable-external-lookup false");
 
   try {
     if (!dbg.IsValid())
       throw Exception("invalid debugger");
     vector<string> args(argv + 1, argv + argc);
 
     test(dbg, args);
   } catch (Exception &e) {
     cout << "ERROR: " << e.what() << endl;
     code = 1;
   }
 
   SBDebugger::Destroy(dbg);
   return code;
 }

lldb/trunk/packages/Python/lldbsuite/test/lldbtest.py

def setUp(self):
         else:
             self.lldbMiExec = None
 
         if "LLDBVSCODE_EXEC" in os.environ:
             self.lldbVSCodeExec = os.environ["LLDBVSCODE_EXEC"]
         else:
             self.lldbVSCodeExec = None
 
+        self.lldbOption = "-o 'settings set symbols.enable-external-lookup false'"
+
         # If we spawn an lldb process for test (via pexpect), do not load the
         # init file unless told otherwise.
-        if "NO_LLDBINIT" in os.environ and "NO" == os.environ["NO_LLDBINIT"]:
-            self.lldbOption = ""
-        else:
-            self.lldbOption = "--no-lldbinit"
+        if os.environ.get("NO_LLDBINIT") != "NO":
+            self.lldbOption += " --no-lldbinit"
 
         # Assign the test method name to self.testMethodName.
         #
         # For an example of the use of this attribute, look at test/types dir.
         # There are a bunch of test cases under test/types and we don't want the
         # module cacheing subsystem to be confused with executable name "a.out"
         # used for all the test cases.
         self.testMethodName = self._testMethodName

lldb/trunk/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py

def request_attach(self, program=None, pid=None, waitFor=None, trace=None,
         if pid is not None:
             args_dict['pid'] = pid
         if program is not None:
             args_dict['program'] = program
         if waitFor is not None:
             args_dict['waitFor'] = waitFor
         if trace:
             args_dict['trace'] = trace
+        args_dict['initCommands'] = [
+            'settings set symbols.enable-external-lookup false']
         if initCommands:
-            args_dict['initCommands'] = initCommands
+            args_dict['initCommands'].extend(initCommands)
         if preRunCommands:
             args_dict['preRunCommands'] = preRunCommands
         if stopCommands:
             args_dict['stopCommands'] = stopCommands
         if exitCommands:
             args_dict['exitCommands'] = exitCommands
         if attachCommands:
             args_dict['attachCommands'] = attachCommands
def request_launch(self, program, args=None, cwd=None, env=None,
         if disableASLR:
             args_dict['disableASLR'] = disableASLR
         if disableSTDIO:
             args_dict['disableSTDIO'] = disableSTDIO
         if shellExpandArguments:
             args_dict['shellExpandArguments'] = shellExpandArguments
         if trace:
             args_dict['trace'] = trace
+        args_dict['initCommands'] = [
+            'settings set symbols.enable-external-lookup false']
         if initCommands:
-            args_dict['initCommands'] = initCommands
+            args_dict['initCommands'].extend(initCommands)
         if preRunCommands:
             args_dict['preRunCommands'] = preRunCommands
         if stopCommands:
             args_dict['stopCommands'] = stopCommands
         if exitCommands:
             args_dict['exitCommands'] = exitCommands
         if sourcePath:
             args_dict['sourcePath'] = sourcePath

lldb/trunk/source/Core/ModuleList.cpp

 }
 
 bool ModuleListProperties::GetEnableExternalLookup() const {
   const uint32_t idx = ePropertyEnableExternalLookup;
   return m_collection_sp->GetPropertyAtIndexAsBoolean(
       nullptr, idx, g_properties[idx].default_uint_value != 0);
 }
 
+bool ModuleListProperties::SetEnableExternalLookup(bool new_value) {
+  return m_collection_sp->SetPropertyAtIndexAsBoolean(
+      nullptr, ePropertyEnableExternalLookup, new_value);
+}
+
 FileSpec ModuleListProperties::GetClangModulesCachePath() const {
   return m_collection_sp
       ->GetPropertyAtIndexAsOptionValueFileSpec(nullptr, false,
                                                 ePropertyClangModulesCachePath)
       ->GetCurrentValue();
 }
 
 bool ModuleListProperties::SetClangModulesCachePath(llvm::StringRef path) {

lldb/trunk/tools/lldb-test/lldb-test.cpp

if (auto e = DebuggerLifetime.Initialize(
     WithColor::error() << "initialization failed: " << toString(std::move(e))
                        << '\n';
     return 1;
   }
 
   CleanUp TerminateDebugger([&] { DebuggerLifetime.Terminate(); });
 
   auto Dbg = lldb_private::Debugger::CreateInstance();
+  ModuleList::GetGlobalModuleListProperties().SetEnableExternalLookup(false);
 
   if (!opts::Log.empty())
     Dbg->EnableLog("lldb", {"all"}, opts::Log, 0, errs());
 
   if (opts::BreakpointSubcommand)
     return opts::breakpoint::evaluateBreakpoints(*Dbg);
   if (opts::ObjectFileSubcommand)
     return dumpObjectFiles(*Dbg);
   if (opts::SymbolsSubcommand)
     return opts::symbols::dumpSymbols(*Dbg);
   if (opts::IRMemoryMapSubcommand)
     return opts::irmemorymap::evaluateMemoryMapCommands(*Dbg);
 
   WithColor::error() << "No command specified.\n";
   return 1;
 }