Allow .dSYM's to be directly placed in an alternate directory

[dsanders]

Summary

Once available in the relevant toolchains this will allow us to implement
LLVM_EXTERNALIZE_DEBUGINFO_OUTPUT_DIR after D84127 by directly placing the dSYM
in the desired location instead of emitting next to the output file and moving
it.

[dsanders]

Attempt to fix the windows-specific failure by using posix-style path::append()

That feels wrong but it's consistent with a test in the same file that already
passes because the path manipulation is an extension append
(bar/foo->bar/foo.dSYM) rather than a path component append (external->external/foo.dSYM)

[JDevlieghere]

clang/include/clang/Driver/Options.td

705

Could we drop the external prefix or did you pick this for consistency with other flags? It seems rather specific for the externalize debug info scenario while the functionality seems generic enough by itself.

[dsanders]

clang/include/clang/Driver/Options.td

705

Sure, I wasn't terribly keen on the name and I didn't find any precedent to work from

[dsanders]

Remove external- prefix

[JDevlieghere]

Thanks!

[hctim]

Hi folks, looks like this patch broke check-clang under ASan/MSan, would you mind taking a look? Thanks.

FAIL: Clang :: Driver/darwin-dsymutil.c (6208 of 24675)
******************** TEST 'Clang :: Driver/darwin-dsymutil.c' FAILED ********************
Script:
--
: 'RUN: at line 3';   /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/bin/clang -target x86_64-apple-darwin10 -ccc-print-phases    -arch i386 -arch x86_64 /b/sanitizer-x86_64-linux-fast/build/llvm-project/clang/test/Driver/darwin-dsymutil.c -g 2> /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp
: 'RUN: at line 5';   /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/bin/FileCheck -check-prefix=CHECK-MULTIARCH-ACTIONS < /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp /b/sanitizer-x86_64-linux-fast/build/llvm-project/clang/test/Driver/darwin-dsymutil.c
: 'RUN: at line 18';   /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/bin/clang -target x86_64-apple-darwin10 -ccc-print-bindings    -arch i386 -arch x86_64 /b/sanitizer-x86_64-linux-fast/build/llvm-project/clang/test/Driver/darwin-dsymutil.c -g 2> /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp
: 'RUN: at line 20';   /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/bin/FileCheck -check-prefix=CHECK-MULTIARCH-BINDINGS < /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp /b/sanitizer-x86_64-linux-fast/build/llvm-project/clang/test/Driver/darwin-dsymutil.c
: 'RUN: at line 27';   /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/bin/clang -target x86_64-apple-darwin10 -ccc-print-bindings    -o foo /b/sanitizer-x86_64-linux-fast/build/llvm-project/clang/test/Driver/darwin-dsymutil.c -g 2> /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp
: 'RUN: at line 29';   /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/bin/FileCheck -Doutfile=foo -Ddsymfile=foo.dSYM           -check-prefix=CHECK-OUTPUT-NAME < /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp /b/sanitizer-x86_64-linux-fast/build/llvm-project/clang/test/Driver/darwin-dsymutil.c
: 'RUN: at line 32';   /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/bin/clang -target x86_64-apple-darwin10 -ccc-print-bindings    -o bar/foo /b/sanitizer-x86_64-linux-fast/build/llvm-project/clang/test/Driver/darwin-dsymutil.c -g 2> /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp
: 'RUN: at line 34';   /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/bin/FileCheck -Doutfile=bar/foo -Ddsymfile=bar/foo.dSYM            -check-prefix=CHECK-OUTPUT-NAME < /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp /b/sanitizer-x86_64-linux-fast/build/llvm-project/clang/test/Driver/darwin-dsymutil.c
: 'RUN: at line 37';   /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/bin/clang -target x86_64-apple-darwin10 -ccc-print-bindings    -o bar/foo -dsym-dir external /b/sanitizer-x86_64-linux-fast/build/llvm-project/clang/test/Driver/darwin-dsymutil.c -g 2> /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp
: 'RUN: at line 39';   /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/bin/FileCheck -Doutfile=bar/foo -Ddsymfile=external/foo.dSYM            -check-prefix=CHECK-OUTPUT-NAME < /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp /b/sanitizer-x86_64-linux-fast/build/llvm-project/clang/test/Driver/darwin-dsymutil.c
: 'RUN: at line 47';   touch /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp.o
: 'RUN: at line 48';   /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/bin/clang -target x86_64-apple-darwin10 -ccc-print-bindings    -o foo /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp.o -g 2> /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp
: 'RUN: at line 50';   not grep "Dsymutil" /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/tools/clang/test/Driver/Output/darwin-dsymutil.c.tmp
: 'RUN: at line 53';   /b/sanitizer-x86_64-linux-fast/build/llvm_build_asan/bin/clang -m32 -arch x86_64 -g /b/sanitizer-x86_64-linux-fast/build/llvm-project/clang/test/Driver/darwin-dsymutil.c -###
--
Exit Code: 1

http://lab.llvm.org:8011/builders/sanitizer-x86_64-linux-fast/builds/44506

clang/include/clang/Driver/Options.td

def dM : Flag<["-"], "dM">, Group<d_Group>, Flags<[CC1Option]>,
   HelpText<"Print macro definitions in -E mode instead of normal output">;
 def dead__strip : Flag<["-"], "dead_strip">;
 def dependency_file : Separate<["-"], "dependency-file">, Flags<[CC1Option]>,
   HelpText<"Filename (or -) to write dependency output to">;
 def dependency_dot : Separate<["-"], "dependency-dot">, Flags<[CC1Option]>,
   HelpText<"Filename to write DOT-formatted header dependencies to">;
 def module_dependency_dir : Separate<["-"], "module-dependency-dir">,
   Flags<[CC1Option]>, HelpText<"Directory to dump module dependencies to">;
+def dsym_dir : JoinedOrSeparate<["-"], "dsym-dir">,
+  Flags<[DriverOption, RenderAsInput]>,
+  HelpText<"Directory to output dSYM's (if any) to">, MetaVarName<"<dir>">;
 def dumpmachine : Flag<["-"], "dumpmachine">;
 def dumpspecs : Flag<["-"], "dumpspecs">, Flags<[Unsupported]>;
 def dumpversion : Flag<["-"], "dumpversion">;
 def dylib__file : Separate<["-"], "dylib_file">;
 def dylinker__install__name : JoinedOrSeparate<["-"], "dylinker_install_name">;
 def dylinker : Flag<["-"], "dylinker">;
 def dynamiclib : Flag<["-"], "dynamiclib">;
 def dynamic : Flag<["-"], "dynamic">, Flags<[NoArgumentUnused]>;
 def d_Flag : Flag<["-"], "d">, Group<d_Group>;
 def d_Joined : Joined<["-"], "d">, Group<d_Group>;
 def emit_ast : Flag<["-"], "emit-ast">,
   HelpText<"Emit Clang AST files for source inputs">;
 def emit_llvm : Flag<["-"], "emit-llvm">, Flags<[CC1Option]>, Group<Action_Group>,
   HelpText<"Use the LLVM representation for assembler and object files">;
 def emit_interface_stubs : Flag<["-"], "emit-interface-stubs">, Flags<[CC1Option]>, Group<Action_Group>,
   HelpText<"Generate Inteface Stub Files.">;
 def emit_merged_ifs : Flag<["-"], "emit-merged-ifs">,
   Flags<[CC1Option]>, Group<Action_Group>,
   HelpText<"Generate Interface Stub Files, emit merged text not binary.">;
 def interface_stub_version_EQ : JoinedOrSeparate<["-"], "interface-stub-version=">, Flags<[CC1Option]>;
 def exported__symbols__list : Separate<["-"], "exported_symbols_list">;
 def e : JoinedOrSeparate<["-"], "e">, Flags<[LinkerInput]>, Group<Link_Group>;
 def fmax_tokens_EQ : Joined<["-"], "fmax-tokens=">, Group<f_Group>, Flags<[CC1Option]>,
   HelpText<"Max total number of preprocessed tokens for -Wmax-tokens.">;
 def fPIC : Flag<["-"], "fPIC">, Group<f_Group>;
 def fno_PIC : Flag<["-"], "fno-PIC">, Group<f_Group>;
 def fPIE : Flag<["-"], "fPIE">, Group<f_Group>;
 def fno_PIE : Flag<["-"], "fno-PIE">, Group<f_Group>;
 defm access_control : OptOutFFlag<"no-access-control", "", "Disable C++ access control">;
 def falign_functions : Flag<["-"], "falign-functions">, Group<f_Group>;
 def falign_functions_EQ : Joined<["-"], "falign-functions=">, Group<f_Group>;

clang/lib/Driver/Driver.cpp

if ((!AtTopLevel && !isSaveTempsEnabled() &&
     }
     return C.addTempFile(C.getArgs().MakeArgString(TmpName));
   }
 
   SmallString<128> BasePath(BaseInput);
   StringRef BaseName;
 
   // Dsymutil actions should use the full path.
-  if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
+  if (isa<DsymutilJobAction>(JA) && C.getArgs().hasArg(options::OPT_dsym_dir)) {
+    SmallString<128> ExternalPath(
+        C.getArgs().getLastArg(options::OPT_dsym_dir)->getValue());
+    // We use posix style here because the tests (specifically
+    // darwin-dsymutil.c) demonstrate that posix style paths are acceptable
+    // even on Windows and if we don't then the similar test covering this
+    // fails.
+    llvm::sys::path::append(ExternalPath, llvm::sys::path::Style::posix,
+                            llvm::sys::path::filename(BasePath));
+    BaseName = ExternalPath;
+  } else if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
     BaseName = BasePath;
   else
     BaseName = llvm::sys::path::filename(BasePath);
 
   // Determine what the derived output name should be.
   const char *NamedOutput;
 
   if ((JA.getType() == types::TY_Object || JA.getType() == types::TY_LTO_BC) &&

clang/test/Driver/darwin-dsymutil.c

 //
 // CHECK-MULTIARCH-BINDINGS: "x86_64-apple-darwin10" - "darwin::Lipo", inputs: [{{.*}}, {{.*}}], output: "a.out"
 // CHECK-MULTIARCH-BINDINGS: # "x86_64-apple-darwin10" - "darwin::Dsymutil", inputs: ["a.out"], output: "a.out.dSYM"
 
 // Check output name derivation.
 //
 // RUN: %clang -target x86_64-apple-darwin10 -ccc-print-bindings \
 // RUN:   -o foo %s -g 2> %t
-// RUN: FileCheck -check-prefix=CHECK-OUTPUT-NAME < %t %s
+// RUN: FileCheck -Doutfile=foo -Ddsymfile=foo.dSYM \
+// RUN:          -check-prefix=CHECK-OUTPUT-NAME < %t %s
 //
-// CHECK-OUTPUT-NAME: "x86_64-apple-darwin10" - "darwin::Linker", inputs: [{{.*}}], output: "foo"
-// CHECK-OUTPUT-NAME: "x86_64-apple-darwin10" - "darwin::Dsymutil", inputs: ["foo"], output: "foo.dSYM"
+// RUN: %clang -target x86_64-apple-darwin10 -ccc-print-bindings \
+// RUN:   -o bar/foo %s -g 2> %t
+// RUN: FileCheck -Doutfile=bar/foo -Ddsymfile=bar/foo.dSYM \
+// RUN:           -check-prefix=CHECK-OUTPUT-NAME < %t %s
+//
+// RUN: %clang -target x86_64-apple-darwin10 -ccc-print-bindings \
+// RUN:   -o bar/foo -dsym-dir external %s -g 2> %t
+// RUN: FileCheck -Doutfile=bar/foo -Ddsymfile=external/foo.dSYM \
+// RUN:           -check-prefix=CHECK-OUTPUT-NAME < %t %s
+//
+// CHECK-OUTPUT-NAME: "x86_64-apple-darwin10" - "darwin::Linker", inputs: [{{.*}}], output: "[[outfile]]"
+// CHECK-OUTPUT-NAME: "x86_64-apple-darwin10" - "darwin::Dsymutil", inputs: ["[[outfile]]"], output: "[[dsymfile]]"
 
 // Check that we only use dsymutil when needed.
 //
 // RUN: touch %t.o
 // RUN: %clang -target x86_64-apple-darwin10 -ccc-print-bindings \
 // RUN:   -o foo %t.o -g 2> %t
 // RUN: not grep "Dsymutil" %t
 
-// Check that we put the .dSYM in the right place.
-// RUN: %clang -target x86_64-apple-darwin10 -ccc-print-bindings \
-// RUN:   -o bar/foo %s -g 2> %t
-// RUN: FileCheck -check-prefix=CHECK-LOCATION < %t %s
-
-// CHECK-LOCATION: "x86_64-apple-darwin10" - "darwin::Dsymutil", inputs: ["bar/foo"], output: "bar/foo.dSYM"
-
 // Check that we don't crash when translating arguments for dsymutil.
 // RUN: %clang -m32 -arch x86_64 -g %s -###