[llvm-driver] Add lld

[abrachet]

Summary

The llvm-driver, enabled with LLVM_TOOL_LLVM_DRIVER_BUILD combines many llvm executables
into one to save overall toolchain size. This patch adds the capability for lld to be part of the
llvm-driver.

[MaskRay]

Please add -DLLVM_TOOL_LLVM_DRIVER_BUILD=on to the summary. [llvm-driver] isn't clear.

Note: by using this, we lose the property to make clang and lld separately profile-guided optimized.

Since you work at Google, can I request that you fix llvm-project-overlay/lld/BUILD.bazel similar to llvm-project-overlay/clang/BUILD.bazel clang_main?
Otherwise it would cause some integration trouble...

llvm/test/tools/llvm-driver/passthrough-lld.test

5

may not be necessary to test -15 variants.

[MaskRay]

Ping

[abrachet]

I was considering holding off on this patch till after D127800 so that the diff would be simpler there. Or would you rather move ahead here first?

[abrachet]

In D127472#3575182, @MaskRay wrote:

Please add -DLLVM_TOOL_LLVM_DRIVER_BUILD=on to the summary. [llvm-driver] isn't clear.

Done

Note: by using this, we lose the property to make clang and lld separately profile-guided optimized.

Yeah, that's a good observation I hadn't thought about. Likely the way clang and lld utilize libObject is very different for example. I can look into adding something along the lines of a LLVM_DRIVER_EXCLUDE_TOOLS list so it can chosen if some tools should be omitted.

Since you work at Google, can I request that you fix llvm-project-overlay/lld/BUILD.bazel similar to llvm-project-overlay/clang/BUILD.bazel clang_main?
Otherwise it would cause some integration trouble...

Done

In D127472#3610252, @abrachet wrote:

I was considering holding off on this patch till after D127800 so that the diff would be simpler there. Or would you rather move ahead here first?

It actually didn't complicate things at all...

[MaskRay]

lld/include/lld/Common/Driver.h

28

Seem unnecessary?

[abrachet]

lld/include/lld/Common/Driver.h

28

I don't understand why, but T** doesn't implicitly convert to const T **, and the only way I could find to add the const qualifier to the inner pointer was through const_cast so I can either keep this as const char ** and const_cast in from lld_main or keep this as char **. WDYT?

[MaskRay]

lld/include/lld/Common/Driver.h

28

This should be fine. const is the preferred one (I just want to decouple unrelated changes....)

lld/include/lld/Common/Driver.h

 };
 
 // Generic entry point when using LLD as a library, safe for re-entry, supports
 // crash recovery. Returns a general completion code and a boolean telling
 // whether it can be called again. In some cases, a crash could corrupt memory
 // and re-entry would not be possible anymore. Use exitLld() in that case to
 // properly exit your application and avoid intermittent crashes on exit caused
 // by cleanup.
-SafeReturn safeLldMain(int argc, const char **argv, llvm::raw_ostream &stdoutOS,
+SafeReturn safeLldMain(int argc, char **argv, llvm::raw_ostream &stdoutOS,
                        llvm::raw_ostream &stderrOS);
 
 namespace coff {
 bool link(llvm::ArrayRef<const char *> args, llvm::raw_ostream &stdoutOS,
           llvm::raw_ostream &stderrOS, bool exitEarly, bool disableOutput);
 }
 
 namespace mingw {

lld/tools/lld/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS
   Support
   )
 
 add_lld_tool(lld
   lld.cpp
 
   SUPPORT_PLUGINS
+  GENERATE_DRIVER
   )
 export_executable_symbols_for_plugins(lld)
 
-target_link_libraries(lld
+function(lld_target_link_libraries target type)
+  target_link_libraries(${target} ${type} ${ARGN})
+  if (TARGET obj.${target})
+    target_link_libraries(obj.${target} ${ARGN})
+  endif()
+endfunction()
+
+lld_target_link_libraries(lld
   PRIVATE
   lldCommon
   lldCOFF
   lldELF
   lldMachO
   lldMinGW
   lldWasm
   )

lld/tools/lld/lld.cpp

if (arg0.endswith_insensitive(".exe"))
     arg0 = arg0.drop_back(4);
   return parseProgname(arg0);
 }
 
 bool inTestOutputDisabled = false;
 
 /// Universal linker main(). This linker emulates the gnu, darwin, or
 /// windows linker based on the argv[0] or -flavor option.
-static int lldMain(int argc, const char **argv, llvm::raw_ostream &stdoutOS,
+static int lldMain(int argc, char **argv, llvm::raw_ostream &stdoutOS,
                    llvm::raw_ostream &stderrOS, bool exitEarly = true) {
   std::vector<const char *> args(argv, argv + argc);
   auto link = [&args]() {
     Flavor f = parseFlavor(args);
     if (f == Gnu && isPETarget(args))
       return mingw::link;
     else if (f == Gnu)
       return elf::link;
static int lldMain(int argc, char **argv, llvm::raw_ostream &stdoutOS,
   // Delete the global context and clear the global context pointer, so that it
   // cannot be accessed anymore.
   CommonLinkerContext::destroy();
 
   return !r ? 1 : 0;
 }
 
 // Similar to lldMain except that exceptions are caught.
-SafeReturn lld::safeLldMain(int argc, const char **argv,
-                            llvm::raw_ostream &stdoutOS,
+SafeReturn lld::safeLldMain(int argc, char **argv, llvm::raw_ostream &stdoutOS,
                             llvm::raw_ostream &stderrOS) {
   int r = 0;
   {
     // The crash recovery is here only to be able to recover from arbitrary
     // control flow when fatal() is called (through setjmp/longjmp or
     // __try/__except).
     llvm::CrashRecoveryContext crc;
     if (!crc.RunSafely([&]() {

 // signifies that LLD shall not release any memory after execution, to speed up
 // process destruction.
 static unsigned inTestVerbosity() {
   unsigned v = 0;
   StringRef(getenv("LLD_IN_TEST")).getAsInteger(10, v);
   return v;
 }
 
-int main(int argc, const char **argv) {
+int lld_main(int argc, char **argv) {
   InitLLVM x(argc, argv);
   sys::Process::UseANSIEscapeCodes(true);
 
   if (::getenv("FORCE_LLD_DIAGNOSTICS_CRASH")) {
     llvm::errs()
         << "crashing due to environment variable FORCE_LLD_DIAGNOSTICS_CRASH\n";
     LLVM_BUILTIN_TRAP;
   }

llvm/test/tools/llvm-driver/lit.local.cfg

+from lit.llvm import llvm_config
+
+if llvm_config.use_lld(required=False):
+    config.available_features.add('lld')

llvm/test/tools/llvm-driver/passthrough-lld.test

+# REQUIRES: lld
+
+# RUN: %llvm ld.lld --help | FileCheck %s
+# RUN: %llvm lld -flavor ld.lld --help | FileCheck %s
+
+# CHECK: supported targets: elf

llvm/tools/llvm-driver/llvm-driver.cpp

static int findTool(int Argc, char **Argv) {
 
   if (ToolName == "--help") {
     printHelpMessage();
     return 0;
   }
 
   StringRef Stem = sys::path::stem(ToolName);
   auto Is = [=](StringRef Tool) {
+    auto IsImpl = [=](StringRef Stem) {
       auto I = Stem.rfind_insensitive(Tool);
       return I != StringRef::npos && (I + Tool.size() == Stem.size() ||
                                       !llvm::isAlnum(Stem[I + Tool.size()]));
     };
+    for (StringRef S : {Stem, ToolName})
+      if (IsImpl(S))
+        return true;
+    return false;
+  };
 
 #define LLVM_DRIVER_TOOL(tool, entry)                                          \
   if (Is(tool))                                                                \
     return entry##_main(Argc, Argv);
 #include "LLVMDriverTools.def"
 
   if (Is("llvm"))
     return findTool(Argc - 1, Argv + 1);

utils/bazel/llvm-project-overlay/lld/BUILD.bazel

 # This file is licensed under the Apache License v2.0 with LLVM Exceptions.
 # See https://llvm.org/LICENSE.txt for license information.
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
+load("@bazel_skylib//rules:expand_template.bzl", "expand_template")
 load("//llvm:tblgen.bzl", "gentbl")
 
 package(
     default_visibility = ["//visibility:public"],
 )
 
 licenses(["notice"])
 
deps = [
         "//llvm:Core",
         "//llvm:LTO",
         "//llvm:Object",
         "//llvm:Option",
         "//llvm:Support",
     ],
 )
 
+expand_template(
+    name = "lld_main",
+    out = "lld-driver.cpp",
+    substitutions = {
+        "@TOOL_NAME@": "lld",
+    },
+    template = "//llvm:cmake/modules/llvm-driver-template.cpp.in",
+)
+
 cc_binary(
     name = "lld",
     srcs = glob([
         "tools/lld/*.cpp",
         "tools/lld/*.h",
-    ]),
+    ]) + ["lld-driver.cpp"],
     deps = [
         ":COFF",
         ":Common",
         ":ELF",
         ":MachO",
         ":MinGW",
         ":Wasm",
         "//llvm:Support",