[lldb] fix --source-quietly

[lawrence_danna]

Summary

Jim says:

lldb has a -Q or --source-quietly option, which supposedly does:

--source-quietly     Tells the debugger to execute this one-line lldb command before any file has been loaded.

That seems like a weird description, since we don't generally use source for one line entries, but anyway, let's try it:

> $LLDB_LLVM/clean-mono/build/Debug/bin/lldb -Q "script print('I should be quiet')" a.out -O "script print('I should be before')" -o "script print('I should be after')"
(lldb) script print('I should be before')
I should be before
(lldb) target create "script print('I should be quiet')"
error: unable to find executable for 'script print('I should be quiet')'

That was weird. The first real -O gets sourced but not quietly, then the argument to the -Q gets treated as the target.

> $LLDB_LLVM/clean-mono/build/Debug/bin/lldb -Q a.out -O "script print('I should be before')" -o "script print('I should be after')"
(lldb) script print('I should be before')
I should be before
(lldb) target create "a.out"
Current executable set to '/tmp/a.out' (x86_64).
(lldb) script print('I should be after')
I should be after

Well, that's a little better, but the -Q option seems to have done nothing.

---

This fixes the description of --source-quietly, as well as causing it
to actually suppress echoing while executing the initialization
commands.

[jingham]

This is great, thanks!

There was one typo I pointed out, and it would be good to add a test. I'm sure this worked at some point, but wasn't tested so it was broken without anybody noticing. We want to make sure that doesn't happen again... It should be easy to write a Shell test case that just runs an lldb with the -Q option, sources a file and checks that you don't see output from it.

lldb/tools/driver/Options.td

113

filles -> files

[lawrence_danna]

fix typo

[lawrence_danna]

In D112988#3103463, @jingham wrote:

There was one typo I pointed out, and it would be good to add a test. I'm sure this worked at some point, but wasn't tested so it was broken without anybody noticing. We want to make sure that doesn't happen again... It should be easy to write a Shell test case that just runs an lldb with the -Q option, sources a file and checks that you don't see output from it.

I did, it's TestQuiet.test

[jingham]

Ha! It was apparently so easy to add the test that it wasn't noticeable (at least by me!).

This isn't directly relevant to your patch, since this wasn't behavior you changed, but it seems weird to me to suppress the commands but print their output? Is that really the behavior we want for -Q?

Anyway, that's more fuel for thought than something you need to address in this patch, where you're just making existing behavior work.

[lawrence_danna]

In D112988#3103574, @jingham wrote:

Ha! It was apparently so easy to add the test that it wasn't noticeable (at least by me!).

This isn't directly relevant to your patch, since this wasn't behavior you changed, but it seems weird to me to suppress the commands but print their output? Is that really the behavior we want for -Q?

I hadn't actually thought about it, as what i care about is getting lldb -Q -o 'script print(...)' to work without any extra output, but now that you mention it the behavior here is inconsistent. For sourcing files, all output is suppressed, but for onelines only echo is suppressed.

[JDevlieghere]

lldb/test/Shell/Driver/TestQuiet.test

8

No newline at end of file

[stella.stamenova]

It looks like some of the tests need to be updated after this change (at least on Windows, the Windows LLDB bot is broken now):

https://lab.llvm.org/buildbot/#/builders/83/builds/11623/steps/7/logs/stdio

[lawrence_danna]

In D112988#3103992, @stella.stamenova wrote:

It looks like some of the tests need to be updated after this change (at least on Windows, the Windows LLDB bot is broken now):

https://lab.llvm.org/buildbot/#/builders/83/builds/11623/steps/7/logs/stdio

sorry! Fix is here https://reviews.llvm.org/D113047

lldb/docs/man/lldb.rst

  Tells the debugger to read in and execute the lldb commands in the given file, before any file has been loaded.
 
 .. option:: --source-on-crash <file>
 
  When in batch mode, tells the debugger to source this file of lldb commands if the target crashes.
 
 .. option:: --source-quietly
 
- Tells the debugger to execute this one-line lldb command before any file has been loaded.
+ Tells the debugger not to echo commands while sourcing files or one-line commands provided on the command line.
 
 .. option:: --source <file>
 
  Tells the debugger to read in and execute the lldb commands in the given file, after any file has been loaded.
 
 .. option:: -S <value>
 
  Alias for --source-before-file

lldb/test/Shell/Driver/TestQuiet.test

+RUN: %lldb -b -Q -o "expr 40 + 2" | FileCheck %s
+RUN: %lldb -b -Q -O "expr 40 + 2" | FileCheck %s
+
+CHECK-NOT: expr
+CHECK-NOT: lldb
+CHECK-NOT: source
+CHECK: 42
 No newline at end of file

lldb/tools/driver/Driver.cpp

if ((commands_data != nullptr) && (commands_size != 0u)) {
     bool old_async = m_debugger.GetAsync();
     m_debugger.SetAsync(false);
 
     SBCommandInterpreterRunOptions options;
     options.SetAutoHandleEvents(true);
     options.SetSpawnThread(false);
     options.SetStopOnError(true);
     options.SetStopOnCrash(m_option_data.m_batch);
+    options.SetEchoCommands(!m_option_data.m_source_quietly);
 
     SBCommandInterpreterRunResult results =
         m_debugger.RunCommandInterpreter(options);
     if (results.GetResult() == lldb::eCommandInterpreterResultQuitRequested)
       go_interactive = false;
     if (m_option_data.m_batch &&
         results.GetResult() != lldb::eCommandInterpreterResultInferiorCrash)
       go_interactive = false;

lldb/tools/driver/Options.td

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>;
 
 def source_quietly: F<"source-quietly">,
-  HelpText<"Tells the debugger to execute this one-line lldb command before any file has been loaded.">,
+  HelpText<"Tells the debugger not to echo commands while sourcing files or one-line commands provided on the command line.">,
   Group<grp_command>;
 def: Flag<["-"], "Q">,
   Alias<source_quietly>,
   HelpText<"Alias for --source-quietly">,
   Group<grp_command>;
 
 def one_line_on_crash: Separate<["--", "-"], "one-line-on-crash">,
   MetaVarName<"<command>">,