Merge pull request #40107 from ahoppen/pr/load-stdlib-in-setup

[Frontend] Load standard libarary in CompilerInstance::setup

Author: ahoppen

include/swift/Frontend/Frontend.h

@@ -351,6 +351,9 @@ class CompilerInvocation {
     if (FrontendOpts.InputMode == FrontendOptions::ParseInputMode::SIL) {
       return ImplicitStdlibKind::None;
     }
+    if (FrontendOpts.InputsAndOutputs.shouldTreatAsLLVM()) {
+      return ImplicitStdlibKind::None;
+    }
     if (getParseStdlib()) {
       return ImplicitStdlibKind::Builtin;
     }
@@ -572,7 +575,7 @@ class CompilerInstance {
   }
 
   /// Returns true if there was an error during setup.
-  bool setup(const CompilerInvocation &Invocation);
+  bool setup(const CompilerInvocation &Invocation, std::string &Error);
 
   const CompilerInvocation &getInvocation() const { return Invocation; }
 

include/swift/Frontend/ModuleInterfaceLoader.h

@@ -313,6 +313,9 @@ struct ModuleInterfaceLoaderOptions {
     case FrontendOptions::ActionType::TypecheckModuleFromInterface:
       requestedAction = FrontendOptions::ActionType::Typecheck;
       break;
+    case FrontendOptions::ActionType::ScanDependencies:
+      requestedAction = Opts.RequestedAction;
+      break;
     default:
       requestedAction = FrontendOptions::ActionType::EmitModuleOnly;
       break;

include/swift/IDE/Utils.h

@@ -20,6 +20,7 @@
 #include "swift/AST/Effects.h"
 #include "swift/AST/Module.h"
 #include "swift/AST/ASTPrinter.h"
+#include "swift/Frontend/FrontendOptions.h"
 #include "swift/IDE/SourceEntityWalker.h"
 #include "swift/Parse/Token.h"
 #include "llvm/ADT/StringRef.h"
@@ -85,7 +86,8 @@ SourceCompleteResult isSourceInputComplete(StringRef Text, SourceFileKind SFKind
 
 bool initCompilerInvocation(
     CompilerInvocation &Invocation, ArrayRef<const char *> OrigArgs,
-    DiagnosticEngine &Diags, StringRef UnresolvedPrimaryFile,
+    FrontendOptions::ActionType Action, DiagnosticEngine &Diags,
+    StringRef UnresolvedPrimaryFile,
     llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FileSystem,
     const std::string &runtimeResourcePath,
     const std::string &diagnosticDocumentationPath, time_t sessionTimestamp,

lib/APIDigester/ModuleAnalyzerNodes.cpp

@@ -2247,8 +2247,9 @@ swift::ide::api::getSDKNodeRoot(SDKContext &SDKCtx,
   // The PrintDiags is only responsible compiler errors, we should remove the
   // consumer immediately after importing is done.
   SWIFT_DEFER { CI.getDiags().removeConsumer(PrintDiags); };
-  if (CI.setup(Invocation)) {
-    llvm::errs() << "Failed to setup the compiler instance\n";
+  std::string InstanceSetupError;
+  if (CI.setup(Invocation, InstanceSetupError)) {
+    llvm::errs() << InstanceSetupError << '\n';
     return nullptr;
   }
 

lib/DependencyScan/DependencyScanningTool.cpp

@@ -194,7 +194,10 @@ DependencyScanningTool::initCompilerInstanceForScan(
   }
 
   // Setup the instance
-  Instance->setup(Invocation);
+  std::string InstanceSetupError;
+  if (Instance->setup(Invocation, InstanceSetupError)) {
+    return std::make_error_code(std::errc::not_supported);
+  }
   (void)Instance->getMainModule();
 
   return Instance;

lib/DependencyScan/ScanDependencies.cpp

@@ -1093,7 +1093,8 @@ forEachBatchEntry(CompilerInstance &invocationInstance,
             SourceLoc(), diag::scanner_arguments_invalid, entry.arguments);
         return true;
       }
-      if (pInstance->setup(subInvok)) {
+      std::string InstanceSetupError;
+      if (pInstance->setup(subInvok, InstanceSetupError)) {
         invocationInstance.getDiags().diagnose(
             SourceLoc(), diag::scanner_arguments_invalid, entry.arguments);
         return true;

lib/DriverTool/swift_api_digester_main.cpp

@@ -1849,8 +1849,10 @@ static bool readBreakageAllowlist(SDKContext &Ctx, llvm::StringSet<> &lines,
   CompilerInstance instance;
   CompilerInvocation invok;
   invok.setModuleName("ForClangImporter");
-  if (instance.setup(invok))
+  std::string InstanceSetupError;
+  if (instance.setup(invok, InstanceSetupError)) {
     return 1;
+  }
   auto importer = ClangImporter::create(instance.getASTContext());
   SmallString<128> preprocessedFilePath;
   if (auto error = llvm::sys::fs::createTemporaryFile(

lib/DriverTool/swift_api_extract_main.cpp

@@ -197,8 +197,9 @@ class SwiftAPIExtractInvocation {
   }
 
   int extractAPI() {
-    if (Instance.setup(Invocation)) {
-      llvm::outs() << "Failed to setup compiler instance\n";
+    std::string InstanceSetupError;
+    if (Instance.setup(Invocation, InstanceSetupError)) {
+      llvm::outs() << InstanceSetupError << '\n';
       return 1;
     }
 

lib/DriverTool/swift_symbolgraph_extract_main.cpp

@@ -182,8 +182,9 @@ int swift_symbolgraph_extract_main(ArrayRef<const char *> Args,
             .Default(AccessLevel::Public);
   }
 
-  if (CI.setup(Invocation)) {
-    llvm::outs() << "Failed to setup compiler instance\n";
+  std::string InstanceSetupError;
+  if (CI.setup(Invocation, InstanceSetupError)) {
+    llvm::outs() << InstanceSetupError << '\n';
     return EXIT_FAILURE;
   }
 

lib/Frontend/Frontend.cpp

@@ -357,30 +357,49 @@ void CompilerInstance::setupDependencyTrackerIfNeeded() {
   DepTracker = std::make_unique<DependencyTracker>(*collectionMode);
 }
 
-bool CompilerInstance::setup(const CompilerInvocation &Invok) {
+bool CompilerInstance::setup(const CompilerInvocation &Invok,
+                             std::string &Error) {
   Invocation = Invok;
 
   setupDependencyTrackerIfNeeded();
 
   // If initializing the overlay file system fails there's no sense in
   // continuing because the compiler will read the wrong files.
-  if (setUpVirtualFileSystemOverlays())
+  if (setUpVirtualFileSystemOverlays()) {
+    Error = "Setting up virtual file system overlays failed";
     return true;
+  }
   setUpLLVMArguments();
   setUpDiagnosticOptions();
 
   assert(Lexer::isIdentifier(Invocation.getModuleName()));
 
-  if (setUpInputs())
+  if (setUpInputs()) {
+    Error = "Setting up inputs failed";
     return true;
+  }
 
-  if (setUpASTContextIfNeeded())
+  if (setUpASTContextIfNeeded()) {
+    Error = "Setting up ASTContext failed";
     return true;
+  }
 
   setupStatsReporter();
 
-  if (setupDiagnosticVerifierIfNeeded())
+  if (setupDiagnosticVerifierIfNeeded()) {
+    Error = "Setting up diagnostics verified failed";
     return true;
+  }
+
+  // If we expect an implicit stdlib import, load in the standard library. If we
+  // either fail to find it or encounter an error while loading it, bail early. Continuing will at best
+  // trigger a bunch of other errors due to the stdlib being missing, or at
+  // worst crash downstream as many call sites don't currently handle a missing
+  // stdlib.
+  if (loadStdlibIfNeeded()) {
+    Error = "Loading the standard library failed";
+    return true;
+  }
 
   return false;
 }
@@ -1101,6 +1120,10 @@ void CompilerInstance::performSema() {
 }
 
 bool CompilerInstance::loadStdlibIfNeeded() {
+  if (!FrontendOptions::doesActionRequireSwiftStandardLibrary(
+          Invocation.getFrontendOptions().RequestedAction)) {
+    return false;
+  }
   // If we aren't expecting an implicit stdlib import, there's nothing to do.
   if (getImplicitImportInfo().StdlibKind != ImplicitStdlibKind::Stdlib)
     return false;

lib/Frontend/ModuleInterfaceBuilder.cpp

@@ -218,13 +218,6 @@ bool ModuleInterfaceBuilder::buildSwiftModuleInternal(
     InputInfo.getPrimarySpecificPaths().SupplementaryOutputs;
     StringRef OutPath = OutputInfo.ModuleOutputPath;
 
-    // Bail out if we're going to use the standard library but can't load it. If
-    // we don't do this before we try to build the interface, we could end up
-    // trying to rebuild a broken standard library dozens of times due to
-    // multiple calls to `ASTContext::getStdlibModule()`.
-    if (SubInstance.loadStdlibIfNeeded())
-      return std::make_error_code(std::errc::not_supported);
-
     // Build the .swiftmodule; this is a _very_ abridged version of the logic
     // in performCompile in libFrontendTool, specialized, to just the one
     // module-serialization task we're trying to do here.

lib/Frontend/ModuleInterfaceLoader.cpp

@@ -1682,7 +1682,8 @@ InterfaceSubContextDelegateImpl::runInSubCompilerInstance(StringRef moduleName,
 
   ForwardingDiagnosticConsumer FDC(*Diags);
   subInstance.addDiagnosticConsumer(&FDC);
-  if (subInstance.setup(subInvocation)) {
+  std::string InstanceSetupError;
+  if (subInstance.setup(subInvocation, InstanceSetupError)) {
     return std::make_error_code(std::errc::not_supported);
   }
 

lib/FrontendTool/FrontendTool.cpp

@@ -1254,17 +1254,6 @@ static bool performCompile(CompilerInstance &Instance,
   if (opts.InputsAndOutputs.shouldTreatAsLLVM())
     return compileLLVMIR(Instance);
 
-  // If we aren't in a parse-only context and expect an implicit stdlib import,
-  // load in the standard library. If we either fail to find it or encounter an
-  // error while loading it, bail early. Continuing the compilation will at best
-  // trigger a bunch of other errors due to the stdlib being missing, or at
-  // worst crash downstream as many call sites don't currently handle a missing
-  // stdlib.
-  if (FrontendOptions::doesActionRequireSwiftStandardLibrary(Action)) {
-    if (Instance.loadStdlibIfNeeded())
-      return true;
-  }
-
   assert([&]() -> bool {
     if (FrontendOptions::shouldActionOnlyParse(Action)) {
       // Parsing gets triggered lazily, but let's make sure we have the right
@@ -2044,7 +2033,8 @@ int swift::performFrontend(ArrayRef<const char *> Args,
   const DiagnosticOptions &diagOpts = Invocation.getDiagnosticOptions();
   bool verifierEnabled = diagOpts.VerifyMode != DiagnosticOptions::NoVerify;
 
-  if (Instance->setup(Invocation)) {
+  std::string InstanceSetupError;
+  if (Instance->setup(Invocation, InstanceSetupError)) {
     return finishDiagProcessing(1, /*verifierEnabled*/ false);
   }
 

lib/IDE/CompletionInstance.cpp

@@ -561,23 +561,15 @@ void CompletionInstance::performNewOperation(
 
     Invocation.setCodeCompletionPoint(completionBuffer, Offset);
 
-    if (CI.setup(Invocation)) {
+    std::string InstanceSetupError;
+    if (CI.setup(Invocation, InstanceSetupError)) {
       Callback(CancellableResult<CompletionInstanceResult>::failure(
-          "failed to setup compiler instance"));
+          InstanceSetupError));
       return;
     }
     CI.getASTContext().CancellationFlag = CancellationFlag;
     registerIDERequestFunctions(CI.getASTContext().evaluator);
 
-    // If we're expecting a standard library, but there either isn't one, or it
-    // failed to load, let's bail early and hand back an empty completion
-    // result to avoid any downstream crashes.
-    if (CI.loadStdlibIfNeeded()) {
-      Callback(CancellableResult<CompletionInstanceResult>::failure(
-          "failed to load the standard library"));
-      return;
-    }
-
     CI.performParseAndResolveImportsOnly();
 
     bool DidFindCodeCompletionToken = CI.getCodeCompletionFile()

lib/IDE/Refactoring.cpp

@@ -1200,8 +1200,9 @@ getNotableRegions(StringRef SourceText, unsigned NameOffset, StringRef Name,
   Invocation.getLangOptions().DisablePoundIfEvaluation = true;
 
   auto Instance = std::make_unique<swift::CompilerInstance>();
-  if (Instance->setup(Invocation))
-    llvm_unreachable("Failed setup");
+  std::string InstanceSetupError;
+  if (Instance->setup(Invocation, InstanceSetupError))
+    llvm_unreachable(InstanceSetupError.c_str());
 
   unsigned BufferId = Instance->getPrimarySourceFile()->getBufferID().getValue();
   SourceManager &SM = Instance->getSourceMgr();

lib/IDE/Utils.cpp

@@ -273,7 +273,8 @@ class StreamDiagConsumer : public DiagnosticConsumer {
 
 bool ide::initCompilerInvocation(
     CompilerInvocation &Invocation, ArrayRef<const char *> OrigArgs,
-    DiagnosticEngine &Diags, StringRef UnresolvedPrimaryFile,
+    FrontendOptions::ActionType Action, DiagnosticEngine &Diags,
+    StringRef UnresolvedPrimaryFile,
     llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FileSystem,
     const std::string &runtimeResourcePath,
     const std::string &diagnosticDocumentationPath, time_t sessionTimestamp,

lib/Migrator/Migrator.cpp

@@ -152,7 +152,8 @@ Migrator::performAFixItMigration(version::Version SwiftLanguageVersion) {
   // rdar://78576743 - Reset LLVM global state for command-line arguments set
   // by prior calls to setup.
   llvm::cl::ResetAllOptionOccurrences();
-  if (Instance->setup(Invocation)) {
+  std::string InstanceSetupError;
+  if (Instance->setup(Invocation, InstanceSetupError)) {
     return nullptr;
   }
 

test/SourceKit/CodeComplete/complete_without_stdlib.swift

@@ -16,4 +16,4 @@ class Str {
 // RUN:   -req=complete -pos=4:1 %s -- %s -resource-dir %t/rsrc -sdk %t/sdk == \
 // RUN:   -req=complete -pos=4:1 %s -- %s -resource-dir %t/rsrc -sdk %t/sdk 2>&1 | %FileCheck %s
 
-// CHECK: error response (Request Failed): failed to load the standard library
+// CHECK: error response (Request Failed): Loading the standard library failed