[Driver] Add command line option to allow loading local lldbinit file

[JDevlieghere]

Summary

This patch adds a command line flag that allows lldb to load local lldbinit files.

[labath]

lldb/tools/driver/Options.td

94–100 ↗

(On Diff #198214)

What's the interaction between these two flags?

[JDevlieghere]

lldb/tools/driver/Options.td

94–100 ↗

(On Diff #198214)

Good question: the no-lldbinit flag supersedes the allow-lldbinit flag. I'll update the description to make that clear.

[clayborg]

Just wanted to verify that we can put a:

settings set target.load-cwd-lldbinit true

in our ~/.lldbinit file and it will then load the local init file in the current working directory?

[JDevlieghere]

In D61578#1492086, @clayborg wrote:

Just wanted to verify that we can put a:

settings set target.load-cwd-lldbinit true

in our ~/.lldbinit file and it will then load the local init file in the current working directory?

Yep, that behavior remains unchanged.

[JDevlieghere]

Make it clear that --no-lldbinit supersedes the new flag.

[labath]

In D61578#1492422, @JDevlieghere wrote:

In D61578#1492086, @clayborg wrote:

Just wanted to verify that we can put a:

settings set target.load-cwd-lldbinit true

in our ~/.lldbinit file and it will then load the local init file in the current working directory?

Yep, that behavior remains unchanged.

Unfortunately, I guess that also means that if somebody does that (set this setting in the global config file), this test will fail for him. I think that means that one day we will have to add a flag to specifically disable reading of the global config file, or find some way to mock its contents.

lldb/tools/driver/Options.td

94–100 ↗

(On Diff #198214)

Ok, thanks for clarifying.

[jingham]

In D61578#1493452, @labath wrote:

In D61578#1492422, @JDevlieghere wrote:

In D61578#1492086, @clayborg wrote:

Just wanted to verify that we can put a:

settings set target.load-cwd-lldbinit true

in our ~/.lldbinit file and it will then load the local init file in the current working directory?

Yep, that behavior remains unchanged.

Unfortunately, I guess that also means that if somebody does that (set this setting in the global config file), this test will fail for him. I think that means that one day we will have to add a flag to specifically disable reading of the global config file, or find some way to mock its contents.

The dotest.py tests all disable reading the global .lldbinit file. Do the lit tests not do that as well? For tests that actually test reading the user's .lldbinit file we will need to do something fancy (can we change the HOME environment variable to some other place so that it gets read from there?)

[labath]

In D61578#1493863, @jingham wrote:

The dotest.py tests all disable reading the global .lldbinit file. Do the lit tests not do that as well? For tests that actually test reading the user's .lldbinit file we will need to do something fancy (can we change the HOME environment variable to some other place so that it gets read from there?)

Yes, they do. However, this test specifically disables that behavior because otherwise we wouldn't even read the CWD lldbinit. Changing the HOME variable might be enough to address this though (and I see Jonas already did that).

[jingham]

In D61578#1493875, @labath wrote:

In D61578#1493863, @jingham wrote:

The dotest.py tests all disable reading the global .lldbinit file. Do the lit tests not do that as well? For tests that actually test reading the user's .lldbinit file we will need to do something fancy (can we change the HOME environment variable to some other place so that it gets read from there?)

Yes, they do. However, this test specifically disables that behavior because otherwise we wouldn't even read the CWD lldbinit. Changing the HOME variable might be enough to address this though (and I see Jonas already did that).

Ah, excellent. That's probably good enough.

The notion of being able to specify to the driver where you store the global .lldbinit file is not 100% crazy - for instance if you had several different configurations you wanted to run lldb in, you could just switch global lldb dirs (e.g. using various shell aliases for the different global locations). So if this does cause problems adding that wouldn't be a totally silly way to fix the tests. But I'm not sure it's worth adding on its own.

lldb/trunk/lit/Driver/LocalLLDBInit.test

 # RUN: mkdir -p %t.root
+# RUN: mkdir -p %t.home
 # RUN: cp %S/Inputs/.lldbinit %t.root
 # RUN: cd %t.root
-# RUN: %lldb-init -o 'settings show frame-format' 2>&1 | FileCheck %s --check-prefix=INIT --check-prefix=CHECK
+# RUN: env HOME=%t.home %lldb-init -o 'settings show frame-format' 2>&1 | FileCheck %s --check-prefix=WARNINIT --check-prefix=CHECK
+# RUN: env HOME=%t.home %lldb-init -local-lldbinit -o 'settings show frame-format' 2>&1 | FileCheck %s --check-prefix=ALLOWINIT --check-prefix=NOINIT
 # RUN: %lldb -o 'settings show frame-format' 2>&1 | FileCheck %s --check-prefix=NOINIT --check-prefix=CHECK
 
-# INIT: There is a .lldbinit file in the current directory which is not being read.
+# WARNINIT: There is a .lldbinit file in the current directory which is not being read.
 # NOINIT-NOT: There is a .lldbinit file in the current directory which is not being read.
 # CHECK-NOT: bogus
+# ALLOWINIT: bogus

lldb/trunk/tools/driver/Driver.cpp

if (args.hasArg(OPT_editor)) {
     m_option_data.m_use_external_editor = true;
   }
 
   if (args.hasArg(OPT_no_lldbinit)) {
     m_debugger.SkipLLDBInitFiles(true);
     m_debugger.SkipAppInitFiles(true);
   }
 
+  if (args.hasArg(OPT_local_lldbinit)) {
+    lldb::SBDebugger::SetInternalVariable("target.load-cwd-lldbinit", "true",
+                                          m_debugger.GetInstanceName());
+  }
+
   if (args.hasArg(OPT_no_use_colors)) {
     m_debugger.SetUseColor(false);
   }
 
   if (auto *arg = args.getLastArg(OPT_file)) {
     auto arg_value = arg->getValue();
     SBFileSpec file(arg_value);
     if (file.Exists()) {

lldb/trunk/tools/driver/Options.td

 
 def no_lldbinit: F<"no-lldbinit">,
   HelpText<"Do not automatically parse any '.lldbinit' files.">,
   Group<grp_command>;
 def: Flag<["-"], "x">,
   Alias<no_lldbinit>,
   HelpText<"Alias for --no-lldbinit">,
   Group<grp_command>;
+def local_lldbinit: F<"local-lldbinit">,
+  HelpText<"Allow the debugger to parse the .lldbinit files in the current working directory, unless --no-lldbinit is passed.">,
+  Group<grp_command>;
 
 def batch: F<"batch">,
   HelpText<"Tells the debugger to run the commands from -s, -S, -o & -O, and then quit.">,
   Group<grp_command>;
 def: Flag<["-"], "b">,
   Alias<batch>,
   HelpText<"Alias for --batch">,
   Group<grp_command>;