From 13ecae2f9a56dbf68a4ae9d302d4d53af1703e2b Mon Sep 17 00:00:00 2001 From: Jonas Devlieghere Date: Tue, 12 Mar 2019 16:44:18 +0000 Subject: [PATCH] [Reproducers] Support capturing a reproducer without an explicit path. Tablegen doesn't support options that are both flags and take values as an argument. I noticed this when doing the tablegen rewrite, but forgot that that affected the reproducer --capture flag. This patch makes --capture a flag and adds --capture-path to specify a path for the reproducer. In reality I expect this to be mostly used for testing, but it could be useful nonetheless. Differential revision: https://reviews.llvm.org/D59238 llvm-svn: 355936 --- lldb/include/lldb/API/SBReproducer.h | 1 + .../Functionalities/TestDataFormatter.test | 2 +- .../Functionalities/TestImageList.test | 2 +- .../Functionalities/TestStepping.test | 3 +- .../lit/Reproducer/Modules/TestModuleCXX.test | 3 +- lldb/lit/Reproducer/TestDriverOptions.test | 20 ++++++-- lldb/lit/Reproducer/TestFileRepro.test | 3 +- lldb/lit/Reproducer/TestGDBRemoteRepro.test | 3 +- lldb/source/API/SBReproducer.cpp | 9 ++++ lldb/tools/driver/Driver.cpp | 51 ++++++++++++------- lldb/tools/driver/Options.td | 6 ++- 11 files changed, 73 insertions(+), 30 deletions(-) diff --git a/lldb/include/lldb/API/SBReproducer.h b/lldb/include/lldb/API/SBReproducer.h index 97901a3bb6dd..0f1739d0c5bd 100644 --- a/lldb/include/lldb/API/SBReproducer.h +++ b/lldb/include/lldb/API/SBReproducer.h @@ -18,6 +18,7 @@ namespace lldb { /// in the interface or implementation of this class. class LLDB_API SBReproducer { public: + static const char *Capture(); static const char *Capture(const char *path); static const char *Replay(const char *path); }; diff --git a/lldb/lit/Reproducer/Functionalities/TestDataFormatter.test b/lldb/lit/Reproducer/Functionalities/TestDataFormatter.test index 370e67d12ef4..8ee181e80357 100644 --- a/lldb/lit/Reproducer/Functionalities/TestDataFormatter.test +++ b/lldb/lit/Reproducer/Functionalities/TestDataFormatter.test @@ -5,7 +5,7 @@ # RUN: rm -rf %t.repro # RUN: %clangxx %S/Inputs/foo.cpp -g -o %t.out -# RUN: %lldb -x -b -s %S/Inputs/DataFormatter.in --capture %t.repro %t.out | FileCheck %s +# RUN: %lldb -x -b -s %S/Inputs/DataFormatter.in --capture --capture-path %t.repro %t.out | FileCheck %s # RUN: %lldb --replay %t.repro | FileCheck %s # CHECK: stop reason = breakpoint 1.1 diff --git a/lldb/lit/Reproducer/Functionalities/TestImageList.test b/lldb/lit/Reproducer/Functionalities/TestImageList.test index fed24d1e81c7..d0abae164f00 100644 --- a/lldb/lit/Reproducer/Functionalities/TestImageList.test +++ b/lldb/lit/Reproducer/Functionalities/TestImageList.test @@ -8,7 +8,7 @@ # RUN: rm -rf %t.txt # RUN: echo "CAPTURE" >> %t.txt -# RUN: %lldb -x -b --capture %t.repro \ +# RUN: %lldb -x -b --capture --capture-path %t.repro \ # RUN: -o 'run' \ # RUN: -o 'image list' \ # RUN: -o 'reproducer generate' \ diff --git a/lldb/lit/Reproducer/Functionalities/TestStepping.test b/lldb/lit/Reproducer/Functionalities/TestStepping.test index 88c626dad4c4..f43680f3e22a 100644 --- a/lldb/lit/Reproducer/Functionalities/TestStepping.test +++ b/lldb/lit/Reproducer/Functionalities/TestStepping.test @@ -2,10 +2,11 @@ # This tests that stepping continues to work when replaying a reproducer. +# RUN: rm -rf %t.repro # RUN: %clang %S/Inputs/stepping.c -O0 -g -o %t.out # RUN: grep -v '#' %s > %t.in -# RUN: %lldb -x -b -s %t.in --capture %t.repro %t.out | FileCheck %s --check-prefix CHECK +# RUN: %lldb -x -b -s %t.in --capture --capture-path %t.repro %t.out | FileCheck %s --check-prefix CHECK # RUN: %lldb --replay %t.repro | FileCheck %s --check-prefix CHECK # Set breakpoints in a,b and c and verify we stop there when stepping. diff --git a/lldb/lit/Reproducer/Modules/TestModuleCXX.test b/lldb/lit/Reproducer/Modules/TestModuleCXX.test index b3a85bf5674a..843c7e6d1fff 100644 --- a/lldb/lit/Reproducer/Modules/TestModuleCXX.test +++ b/lldb/lit/Reproducer/Modules/TestModuleCXX.test @@ -1,6 +1,7 @@ # REQUIRES: system-darwin # Start fresh. +# RUN: rm -rf %t.repro # RUN: rm -rf %t.root # RUN: rm -rf %t.clang-cache # RUN: rm -rf %t.lldb-cache @@ -18,7 +19,7 @@ # RUN: %clang %t.root/main.cpp -g -fmodules -fcxx-modules -fmodules-cache-path=%t.clang-cache -o %t.root/a.out # Capture the debug session. -# RUN: %lldb -x -b -o 'settings set symbols.clang-modules-cache-path %t.lldb-cache' -s %S/Inputs/ModuleCXX.in --capture %t.repro %t.root/a.out | FileCheck %s --check-prefix CAPTURE +# RUN: %lldb -x -b -o 'settings set symbols.clang-modules-cache-path %t.lldb-cache' -s %S/Inputs/ModuleCXX.in --capture --capture-path %t.repro %t.root/a.out | FileCheck %s --check-prefix CAPTURE # CAPTURE: (success = 0) # RUN: cat %t.repro/files.yaml | FileCheck %s --check-prefix YAML diff --git a/lldb/lit/Reproducer/TestDriverOptions.test b/lldb/lit/Reproducer/TestDriverOptions.test index c0713295685d..4b5dfbf063ca 100644 --- a/lldb/lit/Reproducer/TestDriverOptions.test +++ b/lldb/lit/Reproducer/TestDriverOptions.test @@ -1,7 +1,17 @@ # Check that errors are propagated to the driver. +# +# RUN: not %lldb --capture --capture-path %t/bogus/bogus 2>&1 | FileCheck %s --check-prefix INVALID-CAPTURE +# RUN: not %lldb --replay %t/bogus/bogus 2>&1 | FileCheck %s --check-prefix INVALID-REPLAY +# +# INVALID-CAPTURE: unable to create reproducer directory +# INVALID-REPLAY: unable to load reproducer index -# RUN: not %lldb --capture %t/bogus/bogus 2>&1 | FileCheck %s --check-prefix CAPTURE -# RUN: not %lldb --replay %t/bogus/bogus 2>&1 | FileCheck %s --check-prefix REPLAY - -# CAPTURE: unable to create reproducer directory -# REPLAY: unable to load reproducer index +# Check that all option combination work as expected. +# +# RUN: %lldb --capture --capture-path %t.repro -b -o 'reproducer status' 2>&1 | FileCheck %s --check-prefix NO-WARNING --check-prefix STATUS-CAPTURE +# RUN: %lldb --capture -b -o 'reproducer status' 2>&1 | FileCheck %s --check-prefix NO-WARNING --check-prefix STATUS-CAPTURE +# RUN: %lldb --capture-path %t.repro -b -o 'reproducer status' 2>&1 | FileCheck %s --check-prefix WARNING --check-prefix STATUS-CAPTURE +# +# NO-WARNING-NOT: warning: -capture-path specified without -capture +# WARNING: warning: -capture-path specified without -capture +# STATUS-CAPTURE: Reproducer is in capture mode. diff --git a/lldb/lit/Reproducer/TestFileRepro.test b/lldb/lit/Reproducer/TestFileRepro.test index 281a01a5a854..788d77b88ea0 100644 --- a/lldb/lit/Reproducer/TestFileRepro.test +++ b/lldb/lit/Reproducer/TestFileRepro.test @@ -6,8 +6,9 @@ # process. To ensure we're not actually running the original binary we check # that the string "testing" is not printed. +# RUN: rm -rf %t.repro # RUN: %clang %S/Inputs/simple.c -g -o %t.out -# RUN: %lldb -x -b -s %S/Inputs/FileCapture.in --capture %t.repro %t.out | FileCheck %s --check-prefix CHECK --check-prefix CAPTURE +# RUN: %lldb -x -b -s %S/Inputs/FileCapture.in --capture --capture-path %t.repro %t.out | FileCheck %s --check-prefix CHECK --check-prefix CAPTURE # RUN: rm %t.out # RUN: %lldb --replay %t.repro | FileCheck %s --check-prefix CHECK --check-prefix REPLAY diff --git a/lldb/lit/Reproducer/TestGDBRemoteRepro.test b/lldb/lit/Reproducer/TestGDBRemoteRepro.test index 6fbda6c06178..e32890254240 100644 --- a/lldb/lit/Reproducer/TestGDBRemoteRepro.test +++ b/lldb/lit/Reproducer/TestGDBRemoteRepro.test @@ -6,8 +6,9 @@ # process. To ensure we're not actually running the original binary we check # that the string "testing" is not printed. +# RUN: rm -rf %t.repro # RUN: %clang %S/Inputs/simple.c -g -o %t.out -# RUN: %lldb -x -b -s %S/Inputs/GDBRemoteCapture.in --capture %t.repro %t.out | FileCheck %s --check-prefix CHECK --check-prefix CAPTURE +# RUN: %lldb -x -b -s %S/Inputs/GDBRemoteCapture.in --capture --capture-path %t.repro %t.out | FileCheck %s --check-prefix CHECK --check-prefix CAPTURE # RUN: %lldb --replay %t.repro | FileCheck %s --check-prefix CHECK --check-prefix REPLAY # CHECK: Breakpoint 1 diff --git a/lldb/source/API/SBReproducer.cpp b/lldb/source/API/SBReproducer.cpp index c3dad774d7f4..697878c8f3f1 100644 --- a/lldb/source/API/SBReproducer.cpp +++ b/lldb/source/API/SBReproducer.cpp @@ -2940,6 +2940,15 @@ SBRegistry::SBRegistry() { } } +const char *SBReproducer::Capture() { + static std::string error; + if (auto e = Reproducer::Initialize(ReproducerMode::Capture, llvm::None)) { + error = llvm::toString(std::move(e)); + return error.c_str(); + } + return nullptr; +} + const char *SBReproducer::Capture(const char *path) { static std::string error; if (auto e = diff --git a/lldb/tools/driver/Driver.cpp b/lldb/tools/driver/Driver.cpp index ad6114265609..465324305497 100644 --- a/lldb/tools/driver/Driver.cpp +++ b/lldb/tools/driver/Driver.cpp @@ -849,6 +849,38 @@ EXAMPLES: llvm::outs() << examples; } +llvm::Optional InitializeReproducer(opt::InputArgList &input_args) { + if (auto *replay_path = input_args.getLastArg(OPT_replay)) { + if (const char *error = SBReproducer::Replay(replay_path->getValue())) { + WithColor::error() << "reproducer replay failed: " << error << '\n'; + return 1; + } + return 0; + } + + bool capture = input_args.hasArg(OPT_capture); + auto *capture_path = input_args.getLastArg(OPT_capture_path); + + if (capture || capture_path) { + if (capture_path) { + if (!capture) + WithColor::warning() << "-capture-path specified without -capture\n"; + if (const char *error = SBReproducer::Capture(capture_path->getValue())) { + WithColor::error() << "reproducer capture failed: " << error << '\n'; + return 1; + } + } else { + const char *error = SBReproducer::Capture(); + if (error) { + WithColor::error() << "reproducer capture failed: " << error << '\n'; + return 1; + } + } + } + + return llvm::None; +} + int #ifdef _MSC_VER wmain(int argc, wchar_t const *wargv[]) @@ -889,23 +921,8 @@ main(int argc, char const *argv[]) << '\n'; } - if (auto *arg = input_args.getLastArg(OPT_capture)) { - auto arg_value = arg->getValue(); - const char *error = SBReproducer::Capture(arg_value); - if (error) { - WithColor::error() << "reproducer capture failed: " << error << '\n'; - return 1; - } - } - - if (auto *arg = input_args.getLastArg(OPT_replay)) { - auto arg_value = arg->getValue(); - const char *error = SBReproducer::Replay(arg_value); - if (error) { - WithColor::error() << "reproducer replay failed: " << error << '\n'; - return 1; - } - return 0; + if (auto exit_code = InitializeReproducer(input_args)) { + return *exit_code; } SBError error = SBDebugger::InitializeWithErrorHandling(); diff --git a/lldb/tools/driver/Options.td b/lldb/tools/driver/Options.td index 563c0b54fb98..0c99f82cca34 100644 --- a/lldb/tools/driver/Options.td +++ b/lldb/tools/driver/Options.td @@ -219,9 +219,11 @@ def: Flag<["-"], "d">, Alias, HelpText<"Alias for --debug">; -def capture: Separate<["--", "-"], "capture">, +def capture: F<"capture">, + HelpText<"Tells the debugger to capture a reproducer.">; +def capture_path: Separate<["--", "-"], "capture-path">, MetaVarName<"">, - HelpText<"Tells the debugger to capture a reproducer to .">; + HelpText<"Tells the debugger to use the given filename for the reproducer.">; def replay: Separate<["--", "-"], "replay">, MetaVarName<"">, HelpText<"Tells the debugger to replay a reproducer from .">;