[dwp][libtool-darwin][sancov] Enable llvm-driver

[avillega]

Summary

Enable llvm-driver for:
llvm-dwp
llvm-libtool-darwin
sancov

[phosek]

LGTM

[avillega]

Don't enable for dsymutil since it uses target_link_libraries
for APPLE.

[JDevlieghere]

In D156758#4550897, @avillega wrote:

Don't enable for dsymutil since it uses target_link_libraries
for APPLE.

Ah, because we link against CoreFoundation. I wonder if on Apple platforms, we should just link the driver against it too.

[avillega]

In D156758#4550942, @JDevlieghere wrote:

In D156758#4550897, @avillega wrote:

Don't enable for dsymutil since it uses target_link_libraries
for APPLE.

Ah, because we link against CoreFoundation. I wonder if on Apple platforms, we should just link the driver against it too.

Something like that is the plan. Most of the tools left to be added to the driver use target_link_libraries. Need to go through those and conditionally link the driver against those libs when LLVM_TOOL_LLVM_DRIVER_BUILD is enabled.

[JDevlieghere]

In D156758#4550965, @avillega wrote:

Something like that is the plan. Most of the tools left to be added to the driver use target_link_libraries. Need to go through those and conditionally link the driver against those libs when LLVM_TOOL_LLVM_DRIVER_BUILD is enabled.

👍

[phosek]

I think a better solution would be change the type of linkage from PRIVATE to PUBLIC. To give a concrete example, in https://github.com/llvm/llvm-project/blob/244fd4dfc56a0d59655c65adac6a7258114b8af2/llvm/tools/dsymutil/CMakeLists.txt#L42 you'd use:

target_link_libraries(dsymutil PUBLIC "-framework CoreFoundation")

When driver is not being used, add_llvm_tool bottoms out in add_executable and there's no difference to PRIVATE and PUBLIC, but when driver is enabled add_llvm_tool bottoms out in add_library(... OBJECT ...) and there PUBLIC is correct because it'll make sure that the link flags will be transitively propagated.

llvm/tools/dsymutil/CMakeLists.txt

add_llvm_tool(dsymutil
   MachOUtils.cpp
   Reproducer.cpp
   SymbolMap.cpp
 
   DEPENDS
   intrinsics_gen
   ${tablegen_deps}
   DsymutilTableGen
+  GENERATE_DRIVER
   )
 
 if(APPLE)
   target_link_libraries(dsymutil PRIVATE "-framework CoreFoundation")
 endif(APPLE)
 
 # target_link_libraries(dsymutil PRIVATE ${LLVM_ATOMIC_LIB})

llvm/tools/dsymutil/dsymutil.cpp

getOutputFileName(StringRef InputFile, const DsymutilOptions &Options) {
   }
 
   sys::path::append(Path, "Contents", "Resources");
   std::string ResourceDir = std::string(Path.str());
   sys::path::append(Path, "DWARF", sys::path::filename(DwarfFile));
   return OutputLocation(std::string(Path.str()), ResourceDir);
 }
 
-int main(int argc, char **argv) {
+int dsymutil_main(int argc, char **argv, const llvm::ToolContext &) {
   InitLLVM X(argc, argv);
 
   // Parse arguments.
   DsymutilOptTable T;
   unsigned MAI;
   unsigned MAC;
   ArrayRef<const char *> ArgsArr = ArrayRef(argv + 1, argc - 1);
   opt::InputArgList Args = T.ParseArgs(ArgsArr, MAI, MAC);

llvm/tools/llvm-dwp/CMakeLists.txt

 add_public_tablegen_target(DwpOptsTableGen)
 
 add_llvm_tool(llvm-dwp
   llvm-dwp.cpp
 
   DEPENDS
   intrinsics_gen
   DwpOptsTableGen
+  GENERATE_DRIVER
   )
 
 if(LLVM_INSTALL_BINUTILS_SYMLINKS)
   add_llvm_tool_symlink(dwp llvm-dwp)
 endif()

llvm/tools/llvm-dwp/llvm-dwp.cpp

 #include "llvm/MC/MCSubtargetInfo.h"
 #include "llvm/MC/MCTargetOptionsCommandFlags.h"
 #include "llvm/MC/TargetRegistry.h"
 #include "llvm/Option/ArgList.h"
 #include "llvm/Option/Option.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/InitLLVM.h"
+#include "llvm/Support/LLVMDriver.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/Support/TargetSelect.h"
 #include "llvm/Support/ToolOutputFile.h"
 #include <optional>
 
 using namespace llvm;
 using namespace llvm::object;
 

 static Expected<Triple> readTargetTriple(StringRef FileName) {
   auto ErrOrObj = object::ObjectFile::createObjectFile(FileName);
   if (!ErrOrObj)
     return ErrOrObj.takeError();
 
   return ErrOrObj->getBinary()->makeTriple();
 }
 
-int main(int argc, char **argv) {
+int llvm_dwp_main(int argc, char **argv, const llvm::ToolContext &) {
   InitLLVM X(argc, argv);
 
   DwpOptTable Tbl;
   llvm::BumpPtrAllocator A;
   llvm::StringSaver Saver{A};
   opt::InputArgList Args =
       Tbl.parseArgs(argc, argv, OPT_UNKNOWN, Saver, [&](StringRef Msg) {
         llvm::errs() << Msg << '\n';

llvm/tools/llvm-libtool-darwin/CMakeLists.txt

 tablegen(LLVM Opts.inc -gen-opt-parser-defs)
 add_public_tablegen_target(LibtoolDarwinOptsTableGen)
 
 add_llvm_tool(llvm-libtool-darwin
   llvm-libtool-darwin.cpp
 
   DEPENDS
   LibtoolDarwinOptsTableGen
+  GENERATE_DRIVER
 )
 
 if(LLVM_INSTALL_CCTOOLS_SYMLINKS)
   add_llvm_tool_symlink(libtool llvm-libtool-darwin)
 endif()

llvm/tools/llvm-libtool-darwin/llvm-libtool-darwin.cpp

 #include "llvm/Object/MachO.h"
 #include "llvm/Object/MachOUniversal.h"
 #include "llvm/Object/MachOUniversalWriter.h"
 #include "llvm/Object/ObjectFile.h"
 #include "llvm/Option/ArgList.h"
 #include "llvm/Option/Option.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/InitLLVM.h"
+#include "llvm/Support/LLVMDriver.h"
 #include "llvm/Support/LineIterator.h"
 #include "llvm/Support/TargetSelect.h"
 #include "llvm/Support/VirtualFileSystem.h"
 #include "llvm/Support/WithColor.h"
 #include "llvm/Support/YAMLTraits.h"
 #include "llvm/Support/raw_ostream.h"
 #include "llvm/TextAPI/Architecture.h"
+#include <cstdlib>
 #include <map>
 #include <type_traits>
 
 using namespace llvm;
 using namespace llvm::object;
 using namespace llvm::opt;
 
 // Command-line option boilerplate.
static Expected<Config> parseCommandLine(int Argc, char **Argv) {
   }
 
   GlobalDependencyInfo->write("llvm-libtool-darwin " LLVM_VERSION_STRING,
                               InputFiles, OutputFile);
 
   return C;
 }
 
-int main(int Argc, char **Argv) {
+int llvm_libtool_darwin_main(int Argc, char **Argv, const llvm::ToolContext &) {
   InitLLVM X(Argc, Argv);
   Expected<Config> ConfigOrErr = parseCommandLine(Argc, Argv);
   if (!ConfigOrErr) {
     WithColor::defaultErrorHandler(ConfigOrErr.takeError());
     return EXIT_FAILURE;
   }
 
   if (VersionOption)
case Operation::None:
     break;
   case Operation::Static:
     if (Error E = createStaticLibrary(LLVMCtx, C)) {
       WithColor::defaultErrorHandler(std::move(E));
       return EXIT_FAILURE;
     }
     break;
   }
+  return EXIT_SUCCESS;
 }

llvm/tools/sancov/CMakeLists.txt

 tablegen(LLVM Opts.inc -gen-opt-parser-defs)
 add_public_tablegen_target(SancovOptsTableGen)
 
 add_llvm_tool(sancov
   sancov.cpp
 
   DEPENDS
   SancovOptsTableGen
+  GENERATE_DRIVER
   )

llvm/tools/sancov/sancov.cpp

 #include "llvm/Option/Option.h"
 #include "llvm/Support/Casting.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/Errc.h"
 #include "llvm/Support/ErrorOr.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/InitLLVM.h"
 #include "llvm/Support/JSON.h"
+#include "llvm/Support/LLVMDriver.h"
 #include "llvm/Support/MD5.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/Support/Path.h"
 #include "llvm/Support/Regex.h"
 #include "llvm/Support/SHA1.h"
 #include "llvm/Support/SourceMgr.h"
 #include "llvm/Support/SpecialCaseList.h"
 #include "llvm/Support/TargetSelect.h"
static void parseArgs(int Argc, char **Argv) {
   ClSkipDeadFiles = Args.hasFlag(OPT_skipDeadFiles, OPT_no_skipDeadFiles, true);
   ClUseDefaultIgnorelist =
       Args.hasFlag(OPT_useDefaultIgnoreList, OPT_no_useDefaultIgnoreList, true);
 
   ClStripPathPrefix = Args.getLastArgValue(OPT_stripPathPrefix_EQ);
   ClIgnorelist = Args.getLastArgValue(OPT_ignorelist_EQ);
 }
 
-int main(int Argc, char **Argv) {
+int sancov_main(int Argc, char **Argv, const llvm::ToolContext &) {
   llvm::InitLLVM X(Argc, Argv);
 
   llvm::InitializeAllTargetInfos();
   llvm::InitializeAllTargetMCs();
   llvm::InitializeAllDisassemblers();
 
   parseArgs(Argc, Argv);
 
int sancov_main(int Argc, char **Argv, const llvm::ToolContext &) {
   case HtmlReportAction:
     errs() << "-html-report option is removed: "
               "use -symbolize & coverage-report-server.py instead\n";
     return 1;
   case PrintAction:
   case PrintCovPointsAction:
     llvm_unreachable("unsupported action");
   }
+
+  return 0;
 }