[clang][Driver] Default to /usr/bin/ld on Solaris

[ro]

Summary

clang currently requires the native linker on Solaris:

• • It passes -C to ld which GNU ld doesn't understand.
• To use gld, one needs to pass the correct -m EMU option to select the right emulation. Solaris ld cannot handle that option.

So far I've worked around this by passing -DCLANG_DEFAULT_LINKER=/usr/bin/ld
to cmake. However, if someone forgets this, it depends on the user's PATH whether
or not clang finds the correct linker, which doesn't make for a good user experience.

While it would be nice to detect the linker flavor at runtime, this is more involved.
Instead, this patch defaults to /usr/bin/ld on Solaris. This doesn't work on its own,
however: a link fails with

clang-12: error: unable to execute command: Executable "x86_64-pc-solaris2.11-/usr/bin/ld" doesn't exist!

I avoid this by leaving absolute paths alone in ToolChain::GetLinkerPath.

Tested on amd64-pc-solaris2.11.

Ok for master?

[ro]

Rebased after D83015.

[MaskRay]

Can you add a test to test/Driver/solaris-ld.c?

However, if someone forgets this, it depends on the user's PATH whether or not clang finds the correct linker, which doesn't make for a good user experience.

Not very sure about this. The last resort of GetProgramPath is PATH. On FreeBSD and Linux, this is how /usr/bin/ld gets selected. PATH can affect ld choice.

[ro]

Add testcase.

[ro]

In D84029#2170105, @MaskRay wrote:

Can you add a test to test/Driver/solaris-ld.c?

No, this needs a separate testcase: the -C option unconditionally passed to the linker is only understood by the native ld.

I've added solaris-ld-sld.c instead, and also need a system-solaris feature to restrict it. Since /usr/gnu/bin/ld isn't necessarily installed, there should be a way to mark the test UNSUPPORTED if it's missing. I couldn't find how to do so, though.

Tested on amd64-pc-solaris2.11 (FAILs without the patch, PASSes with it) and x86_64-pc-linux-gnu (comes up UNSUPPORTED).

However, if someone forgets this, it depends on the user's PATH whether or not clang finds the correct linker, which doesn't make for a good user experience.

Not very sure about this. The last resort of GetProgramPath is PATH. On FreeBSD and Linux, this is how /usr/bin/ld gets selected. PATH can affect ld choice.

True, but all possible linkers strive to be GNU ld compatible on those systems. OTOH, on proprietary systems (Solaris, HP-UX, AIX, previsously IRIX, Tru64 UNIX) there was a native linker years if not decades before GNU ld started. Sometimes gld has added some options for compatibility with the native linker, sometimes native linkers (like the Solaris one later in the Solaris 11 cycle) added some options for gld compatiblity.

However, they usually have different options apart from the very basic ones (-L, -l, -o) and one needs to select the right one to avoid mismatches. Alternatively, one could detect the linker flavour at runtime and adapt accordingly. However, the native linkers are usually more featureful/better integrated with the system and thus the primary choice.

[ro]

Ping? It's been a week...

[ro]

Ping^2? It's been two weeks now and with having to specify -DCLANG_DEFAULT_LINKER=/usr/bin/ld as a workaround, many tests FAIL on Solaris.

[MaskRay]

clang/lib/Driver/ToolChain.cpp

573

swap then and else branches to avoid !

clang/test/Driver/solaris-ld-sld.c

7

!test -f /usr/gnu/bin/ld || env PATH=/usr/gnu/bin %clang %s -o /dev/null

clang/lib/Driver/ToolChain.cpp

if (!Path.empty()) {
       if (llvm::sys::fs::can_execute(Path))
         return std::string(Path);
     }
     getDriver().Diag(diag::err_drv_invalid_linker_name) << A->getAsString(Args);
     return GetProgramPath(getDefaultLinker());
   }
   // If we're passed -fuse-ld= with no argument, or with the argument ld,
   // then use whatever the default system linker is.
-  if (UseLinker.empty() || UseLinker == "ld")
-    return GetProgramPath(getDefaultLinker());
+  if (UseLinker.empty() || UseLinker == "ld") {
+    const char *DefaultLinker = getDefaultLinker();
+    if (llvm::sys::path::is_absolute(DefaultLinker))
+      return std::string(DefaultLinker);
+    else
+      return GetProgramPath(DefaultLinker);
+  }
 
   // Extending -fuse-ld= to an absolute or relative path is unexpected. Checking
   // for the linker flavor is brittle. In addition, prepending "ld." or "ld64."
   // to a relative path is surprising. This is more complex due to priorities
   // among -B, COMPILER_PATH and PATH. --ld-path= should be used instead.
   if (UseLinker.find('/') != StringRef::npos)
     getDriver().Diag(diag::warn_drv_use_ld_non_word);
 

clang/lib/Driver/ToolChains/Solaris.h

public:
 
   void
   addLibStdCxxIncludePaths(const llvm::opt::ArgList &DriverArgs,
                            llvm::opt::ArgStringList &CC1Args) const override;
 
   SanitizerMask getSupportedSanitizers() const override;
   unsigned GetDefaultDwarfVersion() const override { return 2; }
 
+  const char *getDefaultLinker() const override {
+    // clang currently uses Solaris ld-only options.
+    return "/usr/bin/ld";
+  }
+
 protected:
   Tool *buildAssembler() const override;
   Tool *buildLinker() const override;
 };
 
 } // end namespace toolchains
 } // end namespace driver
 } // end namespace clang
 
 #endif // LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_SOLARIS_H

clang/test/Driver/solaris-ld-sld.c

+// REQUIRES: system-solaris
+
+// Check that clang invokes the native ld.
+
+// RUN: test -f /usr/gnu/bin/ld && env PATH=/usr/gnu/bin %clang -o %t.o %s
+
+int main() { return 0; }

llvm/utils/lit/lit/llvm/config.py

def __init__(self, lit_config, config):
         elif platform.system() == 'Linux':
             features.add('system-linux')
         elif platform.system() in ['FreeBSD']:
             features.add('system-freebsd')
         elif platform.system() == 'NetBSD':
             features.add('system-netbsd')
         elif platform.system() == 'AIX':
             features.add('system-aix')
+        elif platform.system() == 'SunOS':
+            features.add('system-solaris')
 
         # Native compilation: host arch == default triple arch
         # Both of these values should probably be in every site config (e.g. as
         # part of the standard header.  But currently they aren't)
         host_triple = getattr(config, 'host_triple', None)
         target_triple = getattr(config, 'target_triple', None)
         if host_triple and host_triple == target_triple:
             features.add('native')