Merge pull request #14230 from davidungar/PR-18-5-lldb-interface

[Batch Mode] Pass PrimarySpecificPaths through compiler. (4)

Author: David Ungar

include/swift/AST/IRGenOptions.h

@@ -64,9 +64,6 @@ enum class IRGenEmbedMode : unsigned {
 /// The set of options supported by IR generation.
 class IRGenOptions {
 public:
-  /// The name of the first input file, used by the debug info.
-  std::string MainInputFilename;
-  std::vector<std::string> OutputFilenames;
   std::string ModuleName;
 
   /// The compilation directory for the debug info.
@@ -188,19 +185,6 @@ class IRGenOptions {
         UseSwiftCall(false), GenerateProfile(false), CmdArgs(),
         SanitizeCoverage(llvm::SanitizerCoverageOptions()) {}
 
-  /// Gets the name of the specified output filename.
-  /// If multiple files are specified, the last one is returned.
-  /// This function is used by (at least)
-  /// lldb/source/Symbol/SwiftASTContext.cpp:4603
-  /// FIXME: This function should go away in favor of
-  /// Instance.getFrontendOptions().InputsAndOutputs.getSingleOutputFilename
-  /// when batch mode handles all contingencies.
-  StringRef getSingleOutputFilename() const {
-    if (OutputFilenames.size() >= 1)
-      return OutputFilenames.back();
-    return StringRef();
-  }
-
   // Get a hash of all options which influence the llvm compilation but are not
   // reflected in the llvm module itself.
   unsigned getLLVMCodeGenOptionsHash() {

include/swift/Basic/PrimarySpecificPaths.h

@@ -0,0 +1,41 @@
+//===--- PrimarySpecificPaths.h ---------------------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_BASIC_PRIMARYSPECIFICPATHS_H
+#define SWIFT_BASIC_PRIMARYSPECIFICPATHS_H
+
+#include "swift/Basic/LLVM.h"
+#include "swift/Basic/SupplementaryOutputPaths.h"
+
+#include <string>
+
+namespace swift {
+class PrimarySpecificPaths {
+public:
+  std::string OutputFilename;
+  SupplementaryOutputPaths SupplementaryOutputs;
+
+  /// The name of the "main" input file, used by the debug info.
+  std::string MainInputFilenameForDebugInfo;
+
+  PrimarySpecificPaths(
+      std::string OutputFilename = std::string(),
+      std::string MainInputFilenameForDebugInfo = std::string(),
+      SupplementaryOutputPaths SupplementaryOutputs =
+          SupplementaryOutputPaths())
+      : OutputFilename(OutputFilename),
+        SupplementaryOutputs(SupplementaryOutputs),
+        MainInputFilenameForDebugInfo(MainInputFilenameForDebugInfo) {}
+};
+} // namespace swift
+
+#endif /* SWIFT_BASIC_PRIMARYSPECIFICPATHS_H */

include/swift/Frontend/SupplementaryOutputPaths.h renamed to include/swift/Basic/SupplementaryOutputPaths.h

@@ -47,6 +47,14 @@ struct SupplementaryOutputPaths {
 
   SupplementaryOutputPaths() = default;
   SupplementaryOutputPaths(const SupplementaryOutputPaths &) = default;
+
+  bool empty() const {
+    return ObjCHeaderOutputPath.empty() && ModuleOutputPath.empty() &&
+           ModuleDocOutputPath.empty() && DependenciesFilePath.empty() &&
+           ReferenceDependenciesFilePath.empty() &&
+           SerializedDiagnosticsPath.empty() && LoadedModuleTracePath.empty() &&
+           TBDPath.empty();
+  }
 };
 } // namespace swift
 

include/swift/Frontend/ArgsToFrontendOutputsConverter.h

@@ -16,8 +16,8 @@
 #include "swift/AST/DiagnosticConsumer.h"
 #include "swift/AST/DiagnosticEngine.h"
 #include "swift/Basic/LLVM.h"
+#include "swift/Basic/SupplementaryOutputPaths.h"
 #include "swift/Frontend/FrontendOptions.h"
-#include "swift/Frontend/SupplementaryOutputPaths.h"
 #include "swift/Option/Options.h"
 #include "llvm/Option/ArgList.h"
 

include/swift/Frontend/Frontend.h

@@ -301,6 +301,9 @@ class CompilerInvocation {
   bool hasSerializedAST() {
     return FrontendOpts.InputKind == InputFileKind::IFK_Swift_Library;
   }
+
+  PrimarySpecificPaths getPrimarySpecificPathsForAtMostOnePrimary();
+  PrimarySpecificPaths getPrimarySpecificPathsForPrimary(StringRef filename);
 };
 
 /// A class which manages the state and execution of the compiler.
@@ -578,6 +581,11 @@ class CompilerInstance {
                                  OptionSet<TypeCheckingFlags> TypeCheckOptions);
 
   void finishTypeChecking(OptionSet<TypeCheckingFlags> TypeCheckOptions);
+
+public:
+  PrimarySpecificPaths getPrimarySpecificPathsForWholeModuleOptimizationMode();
+  PrimarySpecificPaths getPrimarySpecificPathsForPrimary(StringRef filename);
+  PrimarySpecificPaths getPrimarySpecificPathsForAtMostOnePrimary();
 };
 
 } // namespace swift

include/swift/Frontend/FrontendInputsAndOutputs.h

@@ -14,8 +14,9 @@
 #define SWIFT_FRONTEND_FRONTENDINPUTS_H
 
 #include "swift/AST/Module.h"
+#include "swift/Basic/PrimarySpecificPaths.h"
+#include "swift/Basic/SupplementaryOutputPaths.h"
 #include "swift/Frontend/InputFile.h"
-#include "swift/Frontend/SupplementaryOutputPaths.h"
 #include "llvm/ADT/Hashing.h"
 #include "llvm/ADT/MapVector.h"
 
@@ -57,6 +58,12 @@ class FrontendInputsAndOutputs {
     return SupplementaryOutputs;
   }
 
+  /// When performing a compilation for zero or one primary input file,
+  /// this will hold the PrimarySpecificPaths.
+  /// In a future PR, each InputFile will hold its own PrimarySpecificPaths and
+  /// this will go away.
+  PrimarySpecificPaths PrimarySpecificPathsForAtMostOnePrimary;
+
   FrontendInputsAndOutputs() = default;
   FrontendInputsAndOutputs(const FrontendInputsAndOutputs &other);
   FrontendInputsAndOutputs &operator=(const FrontendInputsAndOutputs &other);
@@ -181,6 +188,10 @@ class FrontendInputsAndOutputs {
 public:
   unsigned countOfInputsProducingMainOutputs() const;
 
+  bool hasInputsProducingMainOutputs() const {
+    return countOfInputsProducingMainOutputs() != 0;
+  }
+
   const InputFile &firstInputProducingOutput() const;
   const InputFile &lastInputProducingOutput() const;
 
@@ -210,6 +221,17 @@ class FrontendInputsAndOutputs {
   void forEachInputProducingSupplementaryOutput(
       llvm::function_ref<void(const InputFile &)> fn) const;
 
+  /// Assumes there is not more than one primary input file, if any.
+  /// Otherwise, you would need to call getPrimarySpecificPathsForPrimary
+  /// to tell it which primary input you wanted the outputs for.
+  ///
+  /// Must not be constructed on-the-fly because some parts of the compiler
+  /// receive StringRefs to its components, so it must live as long as the
+  /// compiler.
+  PrimarySpecificPaths &getPrimarySpecificPathsForAtMostOnePrimary();
+
+  PrimarySpecificPaths &getPrimarySpecificPathsForPrimary(StringRef filename);
+
   bool hasDependenciesPath() const;
   bool hasReferenceDependenciesPath() const;
   bool hasObjCHeaderOutputPath() const;

include/swift/Frontend/FrontendOptions.h

@@ -275,6 +275,9 @@ class FrontendOptions {
            InputsAndOutputs.hasSingleInput();
   }
 
+  PrimarySpecificPaths getPrimarySpecificPathsForAtMostOnePrimary();
+  PrimarySpecificPaths getPrimarySpecificPathsForPrimary(StringRef);
+
 private:
   static bool canActionEmitDependencies(ActionType);
   static bool canActionEmitObjCHeader(ActionType);

include/swift/IRGen/IRGenPublic.h

@@ -26,7 +26,9 @@ class IRGenModule;
 
 /// Create an IRGen module.
 std::pair<IRGenerator *, IRGenModule *>
-createIRGenModule(SILModule *SILMod, llvm::LLVMContext &LLVMContext);
+createIRGenModule(SILModule *SILMod, StringRef OutputFilename,
+                  StringRef MainInputFilenameForDebugInfo,
+                  llvm::LLVMContext &LLVMContext);
 
 /// Delete the IRGenModule and IRGenerator obtained by the above call.
 void deleteIRGenModule(std::pair<IRGenerator *, IRGenModule *> &Module);

include/swift/Subsystems.h

@@ -19,6 +19,7 @@
 
 #include "swift/Basic/LLVM.h"
 #include "swift/Basic/OptionSet.h"
+#include "swift/Basic/PrimarySpecificPaths.h"
 #include "swift/Basic/Version.h"
 #include "llvm/IR/LLVMContext.h"
 #include "llvm/ADT/ArrayRef.h"
@@ -259,7 +260,9 @@ namespace swift {
   std::unique_ptr<llvm::Module>
   performIRGeneration(IRGenOptions &Opts, ModuleDecl *M,
                       std::unique_ptr<SILModule> SILMod,
-                      StringRef ModuleName, llvm::LLVMContext &LLVMContext,
+                      StringRef ModuleName, const PrimarySpecificPaths &PSPs,
+                      llvm::LLVMContext &LLVMContext,
+                      ArrayRef<std::string> parallelOutputFilenames,
                       llvm::GlobalVariable **outModuleHash = nullptr);
 
   /// Turn the given Swift module into either LLVM IR or native code
@@ -268,7 +271,8 @@ namespace swift {
   std::unique_ptr<llvm::Module>
   performIRGeneration(IRGenOptions &Opts, SourceFile &SF,
                       std::unique_ptr<SILModule> SILMod,
-                      StringRef ModuleName, llvm::LLVMContext &LLVMContext,
+                      StringRef ModuleName, const PrimarySpecificPaths &PSPs,
+                      llvm::LLVMContext &LLVMContext,
                       unsigned StartElem = 0,
                       llvm::GlobalVariable **outModuleHash = nullptr);
 
@@ -283,8 +287,8 @@ namespace swift {
                                    StringRef OutputPath);
 
   /// Turn the given LLVM module into native code and return true on error.
-  bool performLLVM(IRGenOptions &Opts, ASTContext &Ctx,
-                   llvm::Module *Module,
+  bool performLLVM(IRGenOptions &Opts, ASTContext &Ctx, llvm::Module *Module,
+                   StringRef OutputFilename,
                    UnifiedStatsReporter *Stats=nullptr);
 
   /// Run the LLVM passes. In multi-threaded compilation this will be done for

lib/Frontend/CompilerInvocation.cpp

@@ -829,18 +829,6 @@ static bool ParseIRGenArgs(IRGenOptions &Opts, ArgList &Args,
   if (Args.hasArg(OPT_autolink_force_load))
     Opts.ForceLoadSymbolName = Args.getLastArgValue(OPT_module_link_name);
 
-  // TODO: investigate whether these should be removed, in favor of definitions
-  // in other classes.
-  if (!SILOpts.SILOutputFileNameForDebugging.empty()) {
-    Opts.MainInputFilename = SILOpts.SILOutputFileNameForDebugging;
-  } else if (const InputFile *input =
-                 FrontendOpts.InputsAndOutputs.getUniquePrimaryInput()) {
-    Opts.MainInputFilename = input->file();
-  } else if (FrontendOpts.InputsAndOutputs.hasSingleInput()) {
-    Opts.MainInputFilename =
-        FrontendOpts.InputsAndOutputs.getFilenameOfFirstInput();
-  }
-  Opts.OutputFilenames = FrontendOpts.InputsAndOutputs.copyOutputFilenames();
   Opts.ModuleName = FrontendOpts.ModuleName;
 
   if (Args.hasArg(OPT_use_jit))

lib/Frontend/Frontend.cpp

@@ -53,6 +53,16 @@ std::string CompilerInvocation::getPCHHash() const {
   return llvm::APInt(64, Code).toString(36, /*Signed=*/false);
 }
 
+PrimarySpecificPaths
+CompilerInvocation::getPrimarySpecificPathsForAtMostOnePrimary() {
+  return getFrontendOptions().getPrimarySpecificPathsForAtMostOnePrimary();
+}
+
+PrimarySpecificPaths
+CompilerInvocation::getPrimarySpecificPathsForPrimary(StringRef filename) {
+  return getFrontendOptions().getPrimarySpecificPathsForPrimary(filename);
+}
+
 void CompilerInstance::createSILModule() {
   assert(MainModule && "main module not created yet");
   // Assume WMO if a -primary-file option was not provided.
@@ -825,3 +835,16 @@ void CompilerInstance::freeASTContext() {
 }
 
 void CompilerInstance::freeSILModule() { TheSILModule.reset(); }
+
+PrimarySpecificPaths
+CompilerInstance::getPrimarySpecificPathsForWholeModuleOptimizationMode() {
+  return getPrimarySpecificPathsForAtMostOnePrimary();
+}
+PrimarySpecificPaths
+CompilerInstance::getPrimarySpecificPathsForAtMostOnePrimary() {
+  return Invocation.getPrimarySpecificPathsForAtMostOnePrimary();
+}
+PrimarySpecificPaths
+CompilerInstance::getPrimarySpecificPathsForPrimary(StringRef filename) {
+  return Invocation.getPrimarySpecificPathsForPrimary(filename);
+}

lib/Frontend/FrontendInputsAndOutputs.cpp

@@ -13,6 +13,7 @@
 #include "swift/Frontend/FrontendInputsAndOutputs.h"
 
 #include "swift/AST/DiagnosticsFrontend.h"
+#include "swift/Basic/PrimarySpecificPaths.h"
 #include "swift/Frontend/FrontendOptions.h"
 #include "swift/Option/Options.h"
 #include "swift/Parse/Lexer.h"
@@ -36,6 +37,8 @@ FrontendInputsAndOutputs::FrontendInputsAndOutputs(
     addInput(input);
   IsSingleThreadedWMO = other.IsSingleThreadedWMO;
   SupplementaryOutputs = other.SupplementaryOutputs;
+  PrimarySpecificPathsForAtMostOnePrimary =
+      other.PrimarySpecificPathsForAtMostOnePrimary;
 }
 
 FrontendInputsAndOutputs &FrontendInputsAndOutputs::
@@ -45,6 +48,8 @@ operator=(const FrontendInputsAndOutputs &other) {
     addInput(input);
   IsSingleThreadedWMO = other.IsSingleThreadedWMO;
   SupplementaryOutputs = other.SupplementaryOutputs;
+  PrimarySpecificPathsForAtMostOnePrimary =
+      other.PrimarySpecificPathsForAtMostOnePrimary;
   return *this;
 }
 
@@ -303,6 +308,18 @@ void FrontendInputsAndOutputs::setMainAndSupplementaryOutputs(
       AllInputs[i].setOutputFilename(outputFiles[i]);
   }
   SupplementaryOutputs = supplementaryOutputs;
+
+  if (hasUniquePrimaryInput() || (hasInputs() && isWholeModule())) {
+    // When batch mode is fully implemented, each InputFile will own
+    // a PrimarySpecificPaths.
+    PrimarySpecificPathsForAtMostOnePrimary.OutputFilename =
+        getSingleOutputFilename();
+    PrimarySpecificPathsForAtMostOnePrimary.MainInputFilenameForDebugInfo =
+        hasInputsProducingMainOutputs() ? firstInputProducingOutput().file()
+                                        : StringRef();
+    PrimarySpecificPathsForAtMostOnePrimary.SupplementaryOutputs =
+        supplementaryOutputs;
+  }
 }
 
 std::vector<std::string> FrontendInputsAndOutputs::copyOutputFilenames() const {
@@ -379,3 +396,14 @@ bool FrontendInputsAndOutputs::hasDependencyTrackerPath() const {
   return hasDependenciesPath() || hasReferenceDependenciesPath() ||
          hasLoadedModuleTracePath();
 }
+
+PrimarySpecificPaths &
+FrontendInputsAndOutputs::getPrimarySpecificPathsForAtMostOnePrimary() {
+  return PrimarySpecificPathsForAtMostOnePrimary;
+}
+
+PrimarySpecificPaths &
+FrontendInputsAndOutputs::getPrimarySpecificPathsForPrimary(
+    StringRef filename) {
+  return getPrimarySpecificPathsForAtMostOnePrimary(); // just a stub for now
+}

lib/Frontend/FrontendOptions.cpp

@@ -386,3 +386,13 @@ bool FrontendOptions::doesActionProduceTextualOutput(ActionType action) {
     return true;
   }
 }
+
+PrimarySpecificPaths
+FrontendOptions::getPrimarySpecificPathsForAtMostOnePrimary() {
+  return InputsAndOutputs.getPrimarySpecificPathsForAtMostOnePrimary();
+}
+
+PrimarySpecificPaths
+FrontendOptions::getPrimarySpecificPathsForPrimary(StringRef filename) {
+  return InputsAndOutputs.getPrimarySpecificPathsForPrimary(filename);
+}