[Driver][SYCL] Improve way sycld is pulled in for Linux based Windows… (#6974)

… driver

Update the way sycld is pulled in by matching if msvcrtd is brought in
via the command line. Cmake uses '-Xclang --dependent-lib=msvcrtd' when
there is the desire to link in with the debug libraries. Check for this
and use an equivalent '--dependent-lib=sycld' to pull in the SYCL
runtime library.

This is only done for the Linux based drivers on Windows. The MSVC based
driver behavior already pulls in the proper libraries given /MDd.

Author: mdtoguchi

clang/lib/Driver/ToolChains/Clang.cpp

@@ -6100,11 +6100,15 @@ void Clang::ConstructJob(Compilation &C, const JobAction &JA,
   if (D.IsCLMode())
     AddClangCLArgs(Args, InputType, CmdArgs, &DebugInfoKind, &EmitCodeView);
 
-  // Add debug macro for debug library usage when using non-cl driver on
-  // Windows as we are using the debug sycld.lib with -g
+  // Add the sycld debug library when --dependent-lib=msvcrtd is used from
+  // the command line.  This is to allow for CMake based builds using the
+  // Linux based driver on Windows to correctly pull in the expected debug
+  // library.
   if (!D.IsCLMode() && TC.getTriple().isWindowsMSVCEnvironment() &&
-      Args.hasArg(options::OPT_fsycl) && Args.hasArg(options::OPT_g_Flag))
-    CmdArgs.push_back("-D_DEBUG");
+      Args.hasArg(options::OPT_fsycl)) {
+    if (isDependentLibAdded(Args, "msvcrtd"))
+      CmdArgs.push_back("--dependent-lib=sycl" SYCL_MAJOR_VERSION "d");
+  }
 
   DwarfFissionKind DwarfFission = DwarfFissionKind::None;
   renderDebugOptions(TC, D, RawTriple, Args, EmitCodeView,

clang/lib/Driver/ToolChains/CommonArgs.cpp

@@ -1111,6 +1111,15 @@ bool tools::areOptimizationsEnabled(const ArgList &Args) {
   return false;
 }
 
+bool tools::isDependentLibAdded(const ArgList &Args, StringRef Lib) {
+  // Check if given Lib is added via --dependent-lib
+  SmallString<64> DepLib("--dependent-lib=");
+  DepLib += Lib;
+  return llvm::any_of(
+      Args.getAllArgValues(options::OPT_Xclang),
+      [&DepLib](StringRef Option) { return Option.equals(DepLib); });
+}
+
 const char *tools::SplitDebugName(const JobAction &JA, const ArgList &Args,
                                   const InputInfo &Input,
                                   const InputInfo &Output) {

clang/lib/Driver/ToolChains/CommonArgs.h

@@ -146,6 +146,8 @@ llvm::StringRef getLTOParallelism(const llvm::opt::ArgList &Args,
 
 bool areOptimizationsEnabled(const llvm::opt::ArgList &Args);
 
+bool isDependentLibAdded(const llvm::opt::ArgList &Args, StringRef Lib);
+
 bool isUseSeparateSections(const llvm::Triple &Triple);
 
 /// \p EnvVar is split by system delimiter for environment variables.

clang/lib/Driver/ToolChains/MSVC.cpp

@@ -124,10 +124,7 @@ void visualstudio::Linker::ConstructJob(Compilation &C, const JobAction &JA,
   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles) &&
       !C.getDriver().IsCLMode() && !C.getDriver().IsFlangMode()) {
     if (Args.hasArg(options::OPT_fsycl) && !Args.hasArg(options::OPT_nolibsycl))
-      if (Args.hasArg(options::OPT_g_Flag))
-        CmdArgs.push_back("-defaultlib:msvcrtd");
-      else
-        CmdArgs.push_back("-defaultlib:msvcrt");
+      CmdArgs.push_back("-defaultlib:msvcrt");
     else
       CmdArgs.push_back("-defaultlib:libcmt");
     CmdArgs.push_back("-defaultlib:oldnames");
@@ -138,9 +135,9 @@ void visualstudio::Linker::ConstructJob(Compilation &C, const JobAction &JA,
       Args.hasArg(options::OPT_fsycl_host_compiler_EQ)) {
     CmdArgs.push_back(Args.MakeArgString(std::string("-libpath:") +
                                          TC.getDriver().Dir + "/../lib"));
-    if (Args.hasArg(options::OPT_g_Flag))
-      CmdArgs.push_back("-defaultlib:sycl" SYCL_MAJOR_VERSION "d.lib");
-    else
+    // When msvcrtd is added via --dependent-lib, we add the sycld
+    // equivalent.  Do not add the -defaultlib as it conflicts.
+    if (!isDependentLibAdded(Args, "msvcrtd"))
       CmdArgs.push_back("-defaultlib:sycl" SYCL_MAJOR_VERSION ".lib");
     CmdArgs.push_back("-defaultlib:sycl-devicelib-host.lib");
   }

clang/test/Driver/sycl-offload.c

@@ -661,15 +661,14 @@
 // CHECK-LINK-NOSTDLIB: "{{.*}}link{{(.exe)?}}"
 // CHECK-LINK-NOSTDLIB: "-defaultlib:sycl{{[0-9]*}}.lib"
 
-/// Check sycld.lib is chosen with /MDd or -g
-// RUN:  %clang -fsycl -g -target x86_64-unknown-windows-msvc %s -o %t -### 2>&1 | FileCheck -check-prefix=CHECK-LINK-SYCL-DEBUG %s
-// RUN:  %clang_cl -fsycl /MDd %s -o %t -### 2>&1 | FileCheck -check-prefix=CHECK-LINK-SYCL-DEBUG-CL %s
-// CHECK-LINK-SYCL-DEBUG-CL: "--dependent-lib=sycl{{[0-9]*}}d"
-// CHECK-LINK-SYCL-DEBUG-CL-NOT: "-defaultlib:sycl{{[0-9]*}}d.lib"
-// CHECK-LINK-SYCL-DEBUG: "-D_DEBUG"
-// CHECK-LINK-SYCL-DEBUG: "-defaultlib:msvcrtd"
-// CHECK-LINK-SYCL-DEBUG: "-defaultlib:sycl{{[0-9]*}}d.lib"
-// CHECK-LINK-SYCL-DEBUG-NOT: "--dependent-lib=sycl{{[0-9]*}}d"
+/// Check sycld.lib is chosen with /MDd
+// RUN:  %clang_cl -fsycl /MDd %s -o %t -### 2>&1 | FileCheck -check-prefix=CHECK-LINK-SYCL-DEBUG %s
+/// Check sycld is pulled in when msvcrtd is used
+// RUN: %clangxx -fsycl -Xclang --dependent-lib=msvcrtd \
+// RUN:   -target x86_64-unknown-windows-msvc -### %s 2>&1 \
+// RUN:   | FileCheck -check-prefix=CHECK-LINK-SYCL-DEBUG %s
+// CHECK-LINK-SYCL-DEBUG: "--dependent-lib=sycl{{[0-9]*}}d"
+// CHECK-LINK-SYCL-DEBUG-NOT: "-defaultlib:sycl{{[0-9]*}}.lib"
 
 /// Check "-spirv-allow-unknown-intrinsics=llvm.genx." option is emitted for llvm-spirv tool
 // RUN: %clangxx %s -fsycl -### 2>&1 | FileCheck %s --check-prefix=CHK-ALLOW-INTRIN