Replace the swift-llvm-opt binary with a symlink to swift-frontend

rdar://76551283

Author: eeckstein

include/swift/Driver/Driver.h

@@ -172,6 +172,7 @@ class Driver {
     SILLLVMGen,      // sil-llvm-gen
     SILPassPipelineDumper, // sil-passpipeline-dumper
     SwiftDependencyTool,   // swift-dependency-tool
+    SwiftLLVMOpt,    // swift-llvm-opt
     AutolinkExtract, // swift-autolink-extract
     SwiftIndent,     // swift-indent
     SymbolGraph,     // swift-symbolgraph

lib/Driver/Driver.cpp

@@ -105,6 +105,7 @@ void Driver::parseDriverKind(ArrayRef<const char *> Args) {
           .Case("sil-llvm-gen", DriverKind::SILLLVMGen)
           .Case("sil-passpipeline-dumper", DriverKind::SILPassPipelineDumper)
           .Case("swift-dependency-tool", DriverKind::SwiftDependencyTool)
+          .Case("swift-llvm-opt", DriverKind::SwiftLLVMOpt)
           .Case("swift-autolink-extract", DriverKind::AutolinkExtract)
           .Case("swift-indent", DriverKind::SwiftIndent)
           .Case("swift-symbolgraph-extract", DriverKind::SymbolGraph)
@@ -3567,6 +3568,7 @@ void Driver::printHelp(bool ShowHidden) const {
   case DriverKind::SILLLVMGen:
   case DriverKind::SILPassPipelineDumper:
   case DriverKind::SwiftDependencyTool:
+  case DriverKind::SwiftLLVMOpt:
   case DriverKind::AutolinkExtract:
   case DriverKind::SwiftIndent:
   case DriverKind::SymbolGraph:

lib/DriverTool/CMakeLists.txt

@@ -6,6 +6,7 @@ set(driver_sources_and_options
                 sil_llvm_gen_main.cpp
                 sil_passpipeline_dumper_main.cpp
                 swift_dependency_tool_main.cpp
+                swift_llvm_opt_main.cpp
                 autolink_extract_main.cpp
                 modulewrap_main.cpp
                 swift_api_digester_main.cpp

lib/DriverTool/driver.cpp

@@ -81,6 +81,9 @@ extern int sil_passpipeline_dumper_main(ArrayRef<const char *> argv, void *MainA
 /// Run 'swift-dependency-tool'
 extern int swift_dependency_tool_main(ArrayRef<const char *> argv, void *MainAddr);
 
+/// Run 'swift-llvm-opt'
+extern int swift_llvm_opt_main(ArrayRef<const char *> argv, void *MainAddr);
+
 /// Run 'swift-autolink-extract'.
 extern int autolink_extract_main(ArrayRef<const char *> Args, const char *Argv0,
                                  void *MainAddr);
@@ -311,6 +314,8 @@ static int run_driver(StringRef ExecName,
     return sil_passpipeline_dumper_main(argv, (void *)(intptr_t)getExecutablePath);
   case Driver::DriverKind::SwiftDependencyTool:
     return swift_dependency_tool_main(argv, (void *)(intptr_t)getExecutablePath);
+  case Driver::DriverKind::SwiftLLVMOpt:
+    return swift_llvm_opt_main(argv, (void *)(intptr_t)getExecutablePath);
   case Driver::DriverKind::AutolinkExtract:
     return autolink_extract_main(
       TheDriver.getArgsWithoutProgramNameAndDriverMode(argv),

tools/swift-llvm-opt/LLVMOpt.cpp renamed to lib/DriverTool/swift_llvm_opt_main.cpp

@@ -1,4 +1,4 @@
-//===--- LLVMOpt.cpp ------------------------------------------------------===//
+//===--- swift_llvm_opt_main.cpp ------------------------------------------===//
 //
 // This source file is part of the Swift.org open source project
 //
@@ -74,59 +74,65 @@ static llvm::codegen::RegisterCodeGenFlags CGF;
 //                            Option Declarations
 //===----------------------------------------------------------------------===//
 
-// The OptimizationList is automatically populated with registered passes by the
-// PassNameParser.
-//
-static llvm::cl::list<const llvm::PassInfo *, bool, llvm::PassNameParser>
-    PassList(llvm::cl::desc("Optimizations available:"));
-
-static llvm::cl::opt<bool>
-    Optimized("O", llvm::cl::desc("Optimization level O. Similar to swift -O"));
-
-// TODO: I wanted to call this 'verify', but some other pass is using this
-// option.
-static llvm::cl::opt<bool> VerifyEach(
-    "verify-each",
-    llvm::cl::desc("Should we spend time verifying that the IR is well "
-                   "formed"));
-
-static llvm::cl::opt<std::string>
-    TargetTriple("mtriple",
-                 llvm::cl::desc("Override target triple for module"));
-
-static llvm::cl::opt<bool>
-    PrintStats("print-stats",
-               llvm::cl::desc("Should LLVM Statistics be printed"));
-
-static llvm::cl::opt<std::string> InputFilename(llvm::cl::Positional,
-                                          llvm::cl::desc("<input file>"),
-                                          llvm::cl::init("-"),
-                                          llvm::cl::value_desc("filename"));
-
-static llvm::cl::opt<std::string>
-    OutputFilename("o", llvm::cl::desc("Override output filename"),
-                   llvm::cl::value_desc("filename"));
-
-static llvm::cl::opt<std::string> DefaultDataLayout(
-    "default-data-layout",
-    llvm::cl::desc("data layout string to use if not specified by module"),
-    llvm::cl::value_desc("layout-string"), llvm::cl::init(""));
+struct SwiftLLVMOptOptions {
+  // The OptimizationList is automatically populated with registered passes by the
+  // PassNameParser.
+  //
+  llvm::cl::list<const llvm::PassInfo *, bool, llvm::PassNameParser>
+    PassList = llvm::cl::list<const llvm::PassInfo *, bool, llvm::PassNameParser>(llvm::cl::desc("Optimizations available:"));
+
+  llvm::cl::opt<bool>
+    Optimized = llvm::cl::opt<bool>("O", llvm::cl::desc("Optimization level O. Similar to swift -O"));
+
+  // TODO: I wanted to call this 'verify', but some other pass is using this
+  // option.
+  llvm::cl::opt<bool>
+    VerifyEach = llvm::cl::opt<bool>(
+      "verify-each",
+      llvm::cl::desc("Should we spend time verifying that the IR is well "
+                     "formed"));
+
+  llvm::cl::opt<std::string>
+    TargetTriple = llvm::cl::opt<std::string>("mtriple",
+                   llvm::cl::desc("Override target triple for module"));
+
+  llvm::cl::opt<bool>
+    PrintStats = llvm::cl::opt<bool>("print-stats",
+                 llvm::cl::desc("Should LLVM Statistics be printed"));
+
+  llvm::cl::opt<std::string>
+    InputFilename = llvm::cl::opt<std::string>(llvm::cl::Positional,
+                                            llvm::cl::desc("<input file>"),
+                                            llvm::cl::init("-"),
+                                            llvm::cl::value_desc("filename"));
+
+  llvm::cl::opt<std::string>
+    OutputFilename = llvm::cl::opt<std::string>("o", llvm::cl::desc("Override output filename"),
+                     llvm::cl::value_desc("filename"));
+
+  llvm::cl::opt<std::string>
+    DefaultDataLayout = llvm::cl::opt<std::string>(
+      "default-data-layout",
+      llvm::cl::desc("data layout string to use if not specified by module"),
+      llvm::cl::value_desc("layout-string"), llvm::cl::init(""));
+};
 
 //===----------------------------------------------------------------------===//
 //                               Helper Methods
 //===----------------------------------------------------------------------===//
 
-static llvm::CodeGenOpt::Level GetCodeGenOptLevel() {
+static llvm::CodeGenOpt::Level GetCodeGenOptLevel(const SwiftLLVMOptOptions &options) {
   // TODO: Is this the right thing to do here?
-  if (Optimized)
+  if (options.Optimized)
     return llvm::CodeGenOpt::Default;
   return llvm::CodeGenOpt::None;
 }
 
 // Returns the TargetMachine instance or zero if no triple is provided.
 static llvm::TargetMachine *
 getTargetMachine(llvm::Triple TheTriple, StringRef CPUStr,
-                 StringRef FeaturesStr, const llvm::TargetOptions &Options) {
+                 StringRef FeaturesStr, const llvm::TargetOptions &targetOptions,
+                 const SwiftLLVMOptOptions &options) {
   std::string Error;
   const auto *TheTarget = llvm::TargetRegistry::lookupTarget(
       llvm::codegen::getMArch(), TheTriple, Error);
@@ -136,9 +142,9 @@ getTargetMachine(llvm::Triple TheTriple, StringRef CPUStr,
   }
 
   return TheTarget->createTargetMachine(
-      TheTriple.getTriple(), CPUStr, FeaturesStr, Options,
+      TheTriple.getTriple(), CPUStr, FeaturesStr, targetOptions,
       Optional<llvm::Reloc::Model>(llvm::codegen::getExplicitRelocModel()),
-      llvm::codegen::getExplicitCodeModel(), GetCodeGenOptLevel());
+      llvm::codegen::getExplicitCodeModel(), GetCodeGenOptLevel(options));
 }
 
 static void dumpOutput(llvm::Module &M, llvm::raw_ostream &os) {
@@ -148,14 +154,8 @@ static void dumpOutput(llvm::Module &M, llvm::raw_ostream &os) {
   EmitPasses.run(M);
 }
 
-// This function isn't referenced outside its translation unit, but it
-// can't use the "static" keyword because its address is used for
-// getMainExecutable (since some platforms don't support taking the
-// address of main, and some platforms can't implement getMainExecutable
-// without being given the address of a function in the main executable).
-void anchorForGetMainExecutable() {}
-
-static inline void addPass(llvm::legacy::PassManagerBase &PM, llvm::Pass *P) {
+static inline void addPass(llvm::legacy::PassManagerBase &PM, llvm::Pass *P,
+                           const SwiftLLVMOptOptions &options) {
   // Add the pass to the pass manager...
   PM.add(P);
   if (P->getPassID() == &SwiftAAWrapperPass::ID) {
@@ -167,20 +167,21 @@ static inline void addPass(llvm::legacy::PassManagerBase &PM, llvm::Pass *P) {
   }
 
   // If we are verifying all of the intermediate steps, add the verifier...
-  if (VerifyEach)
+  if (options.VerifyEach)
     PM.add(llvm::createVerifierPass());
 }
 
 static void runSpecificPasses(StringRef Binary, llvm::Module *M,
                               llvm::TargetMachine *TM,
-                              llvm::Triple &ModuleTriple) {
+                              llvm::Triple &ModuleTriple,
+                              const SwiftLLVMOptOptions &options) {
   llvm::legacy::PassManager Passes;
   llvm::TargetLibraryInfoImpl TLII(ModuleTriple);
   Passes.add(new llvm::TargetLibraryInfoWrapperPass(TLII));
 
   const llvm::DataLayout &DL = M->getDataLayout();
-  if (DL.isDefault() && !DefaultDataLayout.empty()) {
-    M->setDataLayout(DefaultDataLayout);
+  if (DL.isDefault() && !options.DefaultDataLayout.empty()) {
+    M->setDataLayout(options.DefaultDataLayout);
   }
 
   // Add internal analysis passes from the target machine.
@@ -194,7 +195,7 @@ static void runSpecificPasses(StringRef Binary, llvm::Module *M,
     Passes.add(TPC);
   }
 
-  for (const llvm::PassInfo *PassInfo : PassList) {
+  for (const llvm::PassInfo *PassInfo : options.PassList) {
     llvm::Pass *P = nullptr;
     if (PassInfo->getNormalCtor())
       P = PassInfo->getNormalCtor()();
@@ -203,7 +204,7 @@ static void runSpecificPasses(StringRef Binary, llvm::Module *M,
                    << ": cannot create pass: " << PassInfo->getPassName()
                    << "\n";
     if (P) {
-      addPass(Passes, P);
+      addPass(Passes, P, options);
     }
   }
 
@@ -215,8 +216,7 @@ static void runSpecificPasses(StringRef Binary, llvm::Module *M,
 //                            Main Implementation
 //===----------------------------------------------------------------------===//
 
-int main(int argc, char **argv) {
-  PROGRAM_START(argc, argv);
+int swift_llvm_opt_main(ArrayRef<const char *> argv, void *MainAddr) {
   INITIALIZE_LLVM();
 
   // Initialize passes
@@ -247,42 +247,44 @@ int main(int argc, char **argv) {
   initializeInlineTreePrinterPass(Registry);
   initializeLegacySwiftMergeFunctionsPass(Registry);
 
-  llvm::cl::ParseCommandLineOptions(argc, argv, "Swift LLVM optimizer\n");
+  SwiftLLVMOptOptions options;
+
+  llvm::cl::ParseCommandLineOptions(argv.size(), argv.data(), "Swift LLVM optimizer\n");
 
-  if (PrintStats)
+  if (options.PrintStats)
     llvm::EnableStatistics();
 
   llvm::SMDiagnostic Err;
 
   // Load the input module...
   auto LLVMContext = std::make_unique<llvm::LLVMContext>();
   std::unique_ptr<llvm::Module> M =
-      parseIRFile(InputFilename, Err, *LLVMContext.get());
+      parseIRFile(options.InputFilename, Err, *LLVMContext.get());
 
   if (!M) {
     Err.print(argv[0], llvm::errs());
     return 1;
   }
 
   if (verifyModule(*M, &llvm::errs())) {
-    llvm::errs() << argv[0] << ": " << InputFilename
+    llvm::errs() << argv[0] << ": " << options.InputFilename
            << ": error: input module is broken!\n";
     return 1;
   }
 
   // If we are supposed to override the target triple, do so now.
-  if (!TargetTriple.empty())
-    M->setTargetTriple(llvm::Triple::normalize(TargetTriple));
+  if (!options.TargetTriple.empty())
+    M->setTargetTriple(llvm::Triple::normalize(options.TargetTriple));
 
   // Figure out what stream we are supposed to write to...
   std::unique_ptr<llvm::ToolOutputFile> Out;
   // Default to standard output.
-  if (OutputFilename.empty())
-    OutputFilename = "-";
+  if (options.OutputFilename.empty())
+    options.OutputFilename = "-";
 
   std::error_code EC;
   Out.reset(
-      new llvm::ToolOutputFile(OutputFilename, EC, llvm::sys::fs::OF_None));
+      new llvm::ToolOutputFile(options.OutputFilename, EC, llvm::sys::fs::OF_None));
   if (EC) {
     llvm::errs() << EC.message() << '\n';
     return 1;
@@ -291,13 +293,13 @@ int main(int argc, char **argv) {
   llvm::Triple ModuleTriple(M->getTargetTriple());
   std::string CPUStr, FeaturesStr;
   llvm::TargetMachine *Machine = nullptr;
-  const llvm::TargetOptions Options =
+  const llvm::TargetOptions targetOptions =
       llvm::codegen::InitTargetOptionsFromCodeGenFlags(ModuleTriple);
 
   if (ModuleTriple.getArch()) {
     CPUStr = llvm::codegen::getCPUStr();
     FeaturesStr = llvm::codegen::getFeaturesStr();
-    Machine = getTargetMachine(ModuleTriple, CPUStr, FeaturesStr, Options);
+    Machine = getTargetMachine(ModuleTriple, CPUStr, FeaturesStr, targetOptions, options);
   }
 
   std::unique_ptr<llvm::TargetMachine> TM(Machine);
@@ -306,15 +308,15 @@ int main(int argc, char **argv) {
   // flags.
   llvm::codegen::setFunctionAttributes(CPUStr, FeaturesStr, *M);
 
-  if (Optimized) {
+  if (options.Optimized) {
     IRGenOptions Opts;
     Opts.OptMode = OptimizationMode::ForSpeed;
     Opts.OutputKind = IRGenOutputKind::LLVMAssemblyAfterOptimization;
 
     // Then perform the optimizations.
     performLLVMOptimizations(Opts, M.get(), TM.get(), &Out->os());
   } else {
-    runSpecificPasses(argv[0], M.get(), TM.get(), ModuleTriple);
+    runSpecificPasses(argv[0], M.get(), TM.get(), ModuleTriple, options);
     // Finally dump the output.
     dumpOutput(*M, Out->os());
   }

test/CMakeLists.txt

@@ -56,7 +56,6 @@ function(get_test_dependencies SDK result_var_name)
       swift-demangle
       swift-demangle-yamldump
       swift-ide-test
-      swift-llvm-opt
       swift-refactor
       swift-reflection-dump
       swift-remoteast-test)

tools/CMakeLists.txt

@@ -22,7 +22,6 @@ add_swift_tool_subdirectory(swift-demangle)
 add_swift_tool_subdirectory(swift-demangle-yamldump)
 add_swift_tool_subdirectory(swift-def-to-strings-converter)
 add_swift_tool_subdirectory(swift-serialize-diagnostics)
-add_swift_tool_subdirectory(swift-llvm-opt)
 add_swift_tool_subdirectory(swift-ast-script)
 add_swift_tool_subdirectory(swift-refactor)
 add_swift_tool_subdirectory(libSwiftScan)

tools/driver/CMakeLists.txt

@@ -119,6 +119,11 @@ swift_create_post_build_symlink(swift-frontend
   DESTINATION "swift-dependency-tool${CMAKE_EXECUTABLE_SUFFIX}"
   WORKING_DIRECTORY "${SWIFT_RUNTIME_OUTPUT_INTDIR}")
 
+swift_create_post_build_symlink(swift-frontend
+  SOURCE "swift-frontend${CMAKE_EXECUTABLE_SUFFIX}"
+  DESTINATION "swift-llvm-opt${CMAKE_EXECUTABLE_SUFFIX}"
+  WORKING_DIRECTORY "${SWIFT_RUNTIME_OUTPUT_INTDIR}")
+
 swift_create_post_build_symlink(swift-frontend
   SOURCE "swift-frontend${CMAKE_EXECUTABLE_SUFFIX}"
   DESTINATION "swift-indent${CMAKE_EXECUTABLE_SUFFIX}"