Update flag name to -debug-info-store-invocation.

Author: allevato

include/swift/Driver/ToolChain.h

@@ -197,9 +197,11 @@ class ToolChain {
                                           const llvm::opt::ArgList &args,
                                           StringRef extraEntry = "") const;
 
-  /// Specific toolchains should override this to indicate whether the
-  /// compilation flags should be written into DWARF debug info.
-  virtual bool usesDWARFDebugFlags() const { return false; }
+  /// Specific toolchains should override this to provide additional conditions
+  /// under which the compiler invocation should be written into debug info. For
+  /// example, Darwin does this if the RC_DEBUG_OPTIONS environment variable is
+  /// set to match the behavior of Clang.
+  virtual bool shouldStoreInvocationInDebugInfo() const { return false; }
 
 public:
   virtual ~ToolChain() = default;

include/swift/Option/FrontendOptions.td

@@ -486,7 +486,4 @@ def disable_verify_exclusivity : Flag<["-"], "disable-verify-exclusivity">,
 def enable_key_path_resilience : Flag<["-"], "enable-key-path-resilience">,
   HelpText<"Enable key path resilience.">;
 
-def use_dwarf_debug_flags : Flag<["-"], "use-dwarf-debug-flags">,
-  HelpText<"Write the compilation flags into the DWARF debug info.">;
-
 } // end let Flags = [FrontendOption, NoDriverOption, HelpHidden]

include/swift/Option/Options.td

@@ -473,6 +473,10 @@ def verify_debug_info : Flag<["-"], "verify-debug-info">,
   Flags<[NoInteractiveOption, DoesNotAffectIncrementalBuild]>,
   HelpText<"Verify the binary representation of debug output.">;
 
+def debug_info_store_invocation : Flag<["-"], "debug-info-store-invocation">,
+  Flags<[FrontendOption]>,
+  HelpText<"Emit the compiler invocation in the debug info.">;
+
 // Assert configuration identifiers.
 def AssertConfig : Separate<["-"], "assert-config">,
   Flags<[FrontendOption]>,

lib/Driver/DarwinToolChains.cpp

@@ -452,7 +452,7 @@ toolchains::Darwin::constructInvocation(const LinkJobAction &job,
   return II;
 }
 
-bool toolchains::Darwin::usesDWARFDebugFlags() const {
+bool toolchains::Darwin::shouldStoreInvocationInDebugInfo() const {
   // This matches the behavior in Clang (see
   // clang/lib/driver/ToolChains/Darwin.cpp).
   if (const char *S = ::getenv("RC_DEBUG_OPTIONS"))

lib/Driver/ToolChains.cpp

@@ -360,9 +360,9 @@ ToolChain::constructInvocation(const CompileJobAction &job,
       Arguments.push_back("-index-system-modules");
   }
 
-  // Request whether the compilation flags should be written into DWARF info.
-  if (usesDWARFDebugFlags()) {
-    Arguments.push_back("-use-dwarf-debug-flags");
+  if (context.Args.hasArg(options::OPT_debug_info_store_invocation) ||
+      shouldStoreInvocationInDebugInfo()) {
+    Arguments.push_back("-debug-info-store-invocation");
   }
 
   return II;

lib/Driver/ToolChains.h

@@ -30,7 +30,7 @@ class LLVM_LIBRARY_VISIBILITY Darwin : public ToolChain {
 
   std::string findProgramRelativeToSwiftImpl(StringRef name) const override;
 
-  bool usesDWARFDebugFlags() const override;
+  bool shouldStoreInvocationInDebugInfo() const override;
 
 public:
   Darwin(const Driver &D, const llvm::Triple &Triple) : ToolChain(D, Triple) {}

lib/Frontend/CompilerInvocation.cpp

@@ -769,7 +769,7 @@ static bool ParseIRGenArgs(IRGenOptions &Opts, ArgList &Args,
              "unknown -g<kind> option");
 
     if (Opts.DebugInfoKind > IRGenDebugInfoKind::LineTables) {
-      if (Args.hasArg(options::OPT_use_dwarf_debug_flags)) {
+      if (Args.hasArg(options::OPT_debug_info_store_invocation)) {
         ArgStringList RenderedArgs;
         for (auto A : Args)
           A->render(Args, RenderedArgs);

test/DebugInfo/compiler-flags.swift

@@ -1,8 +1,8 @@
 // Check that the sdk and resource dirs end up in the debug info if we pass the
 // frontend flag. This tests the general functionality; we test the macosx
 // specific toolchain logic in compiler-flags-macosx.swift.
-// RUN: %target-swiftc_driver %s -emit-ir -Xfrontend -use-dwarf-debug-flags -g -o - | %FileCheck %s
-// RUN: %target-swiftc_driver %s -emit-ir -Xfrontend -use-dwarf-debug-flags -sdk "/Weird Location/SDK" -g -o - | %FileCheck --check-prefix CHECK-EXPLICIT %s
+// RUN: %target-swiftc_driver %s -emit-ir -debug-info-store-invocation -g -o - | %FileCheck %s
+// RUN: %target-swiftc_driver %s -emit-ir -debug-info-store-invocation -sdk "/Weird Location/SDK" -g -o - | %FileCheck --check-prefix CHECK-EXPLICIT %s
 // CHECK:          !DICompileUnit({{.*}}producer: "{{(Apple )?Swift version [^"]+}}"
 // CHECK-SAME:                    flags: "
 // CHECK-NOT:                     "
@@ -15,6 +15,6 @@
 // CHECK-EXPLICIT-SAME:           -resource-dir 
 
 // Check that we don't write temporary file names in the debug info
-// RUN: TMPDIR=abc/def %target-swift-frontend %s -I abc/def/xyz -g -emit-ir -use-dwarf-debug-flags -o - | %FileCheck --check-prefix CHECK-TEMP %s
+// RUN: TMPDIR=abc/def %target-swift-frontend %s -I abc/def/xyz -g -emit-ir -debug-info-store-invocation -o - | %FileCheck --check-prefix CHECK-TEMP %s
 // CHECK-TEMP: !DICompileUnit({{.*}} flags: "{{.*}} -I <temporary-file>