Move storage for VFS into editor document

The invocation options are not an appropriate place to put this state, since it can change between requests. This moves it to the editor document, allowing us to change the specific VFS instance without causing a rebuild (unless the contents/timestamps for a dependency change).
2025-12-14 20:36:38 +01:00 · 2019-06-25 14:27:56 -07:00
parent 78a7d95f07
commit 205371c886
9 changed files with 205 additions and 132 deletions
--- a/tools/SourceKit/lib/SwiftLang/SwiftASTManager.cpp
+++ b/tools/SourceKit/lib/SwiftLang/SwiftASTManager.cpp
@@ -77,16 +77,10 @@ struct InvocationOptions {
  const std::string PrimaryFile;
  const CompilerInvocation Invok;

-  /// All filesystem operations resulting from this invocation should use this
-  /// filesystem.
-  const llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FileSystem;
-
  InvocationOptions(ArrayRef<const char *> CArgs, StringRef PrimaryFile,
-                    CompilerInvocation Invok,
-                    llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FileSystem)
+                    CompilerInvocation Invok)
      : Args(_convertArgs(CArgs)), PrimaryFile(PrimaryFile),
-        Invok(std::move(Invok)), FileSystem(FileSystem) {
-    assert(FileSystem);
+        Invok(std::move(Invok)) {
    // Assert invocation with a primary file. We want to avoid full typechecking
    // for all files.
    assert(!this->PrimaryFile.empty());
@@ -168,7 +162,6 @@ void InvocationOptions::profile(llvm::FoldingSetNodeID &ID) const {
  for (auto &Arg : Args)
    ID.AddString(Arg);
  ID.AddString(PrimaryFile);
-  ID.AddPointer(FileSystem.get());
 }

 //===----------------------------------------------------------------------===//
@@ -298,10 +291,13 @@ public:
    return AST;
  }

-  void getASTUnitAsync(std::shared_ptr<SwiftASTManager> Mgr,
-                       ArrayRef<ImmutableTextSnapshotRef> Snapshots,
-                std::function<void(ASTUnitRef Unit, StringRef Error)> Receiver);
+  void getASTUnitAsync(
+      std::shared_ptr<SwiftASTManager> Mgr,
+      llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fileSystem,
+      ArrayRef<ImmutableTextSnapshotRef> Snapshots,
+      std::function<void(ASTUnitRef Unit, StringRef Error)> Receiver);
  bool shouldRebuild(SwiftASTManager::Implementation &MgrImpl,
+                     llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fileSystem,
                     ArrayRef<ImmutableTextSnapshotRef> Snapshots);

  void enqueueConsumer(SwiftASTConsumerRef Consumer,
@@ -320,18 +316,23 @@ public:
  }

 private:
-  ASTUnitRef getASTUnitImpl(SwiftASTManager::Implementation &MgrImpl,
-                            ArrayRef<ImmutableTextSnapshotRef> Snapshots,
-                            std::string &Error);
+  ASTUnitRef
+  getASTUnitImpl(SwiftASTManager::Implementation &MgrImpl,
+                 llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fileSystem,
+                 ArrayRef<ImmutableTextSnapshotRef> Snapshots,
+                 std::string &Error);

-  ASTUnitRef createASTUnit(SwiftASTManager::Implementation &MgrImpl,
-                           ArrayRef<ImmutableTextSnapshotRef> Snapshots,
-                           std::string &Error);
+  ASTUnitRef
+  createASTUnit(SwiftASTManager::Implementation &MgrImpl,
+                llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fileSystem,
+                ArrayRef<ImmutableTextSnapshotRef> Snapshots,
+                std::string &Error);

-  void findSnapshotAndOpenFiles(SwiftASTManager::Implementation &MgrImpl,
-                                ArrayRef<ImmutableTextSnapshotRef> Snapshots,
-                                SmallVectorImpl<FileContent> &Contents,
-                                std::string &Error) const;
+  void findSnapshotAndOpenFiles(
+      SwiftASTManager::Implementation &MgrImpl,
+      llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fileSystem,
+      ArrayRef<ImmutableTextSnapshotRef> Snapshots,
+      SmallVectorImpl<FileContent> &Contents, std::string &Error) const;
 };

 typedef IntrusiveRefCntPtr<ASTProducer> ASTProducerRef;
@@ -598,15 +599,17 @@ SwiftInvocationRef SwiftASTManager::getInvocation(
    return nullptr;
  }

-  InvocationOptions Opts(OrigArgs, PrimaryFile, CompInvok, FileSystem);
+  InvocationOptions Opts(OrigArgs, PrimaryFile, CompInvok);
  return new SwiftInvocation(
      *new SwiftInvocation::Implementation(std::move(Opts)));
 }

-void SwiftASTManager::processASTAsync(SwiftInvocationRef InvokRef,
-                                      SwiftASTConsumerRef ASTConsumer,
-                                      const void *OncePerASTToken,
-                                 ArrayRef<ImmutableTextSnapshotRef> Snapshots) {
+void SwiftASTManager::processASTAsync(
+    SwiftInvocationRef InvokRef, SwiftASTConsumerRef ASTConsumer,
+    const void *OncePerASTToken,
+    llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fileSystem,
+    ArrayRef<ImmutableTextSnapshotRef> Snapshots) {
+  assert(fileSystem);
  ASTProducerRef Producer = Impl.getASTProducer(InvokRef);

  if (ASTUnitRef Unit = Producer->getExistingAST()) {
@@ -619,13 +622,13 @@ void SwiftASTManager::processASTAsync(SwiftInvocationRef InvokRef,

  Producer->enqueueConsumer(ASTConsumer, Snapshots, OncePerASTToken);

-  auto handleAST = [this, Producer, ASTConsumer](ASTUnitRef unit,
-                                                 StringRef error) {
+  auto handleAST = [this, Producer, ASTConsumer, fileSystem](ASTUnitRef unit,
+                                                             StringRef error) {
    auto consumers = Producer->takeConsumers(
        [&](SwiftASTConsumer *consumer,
            ArrayRef<ImmutableTextSnapshotRef> snapshots) {
          return consumer == ASTConsumer.get() ||
-                 !Producer->shouldRebuild(Impl, snapshots) ||
+                 !Producer->shouldRebuild(Impl, fileSystem, snapshots) ||
                 (unit && consumer->canUseASTWithSnapshots(snapshots));
        });

@@ -637,7 +640,8 @@ void SwiftASTManager::processASTAsync(SwiftInvocationRef InvokRef,
    }
  };

-  Producer->getASTUnitAsync(shared_from_this(), Snapshots, std::move(handleAST));
+  Producer->getASTUnitAsync(shared_from_this(), fileSystem, Snapshots,
+                            std::move(handleAST));
 }

 void SwiftASTManager::removeCachedAST(SwiftInvocationRef Invok) {
@@ -714,25 +718,31 @@ SwiftASTManager::Implementation::getMemoryBuffer(
  return nullptr;
 }

-void ASTProducer::getASTUnitAsync(std::shared_ptr<SwiftASTManager> Mgr,
-                                  ArrayRef<ImmutableTextSnapshotRef> Snaps,
-               std::function<void(ASTUnitRef Unit, StringRef Error)> Receiver) {
+void ASTProducer::getASTUnitAsync(
+    std::shared_ptr<SwiftASTManager> Mgr,
+    llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fileSystem,
+    ArrayRef<ImmutableTextSnapshotRef> Snaps,
+    std::function<void(ASTUnitRef Unit, StringRef Error)> Receiver) {

  ASTProducerRef ThisProducer = this;
  SmallVector<ImmutableTextSnapshotRef, 4> Snapshots;
  Snapshots.append(Snaps.begin(), Snaps.end());

-  Mgr->Impl.ASTBuildQueue.dispatch([ThisProducer, Mgr, Snapshots, Receiver] {
-    std::string Error;
-    ASTUnitRef Unit = ThisProducer->getASTUnitImpl(Mgr->Impl, Snapshots, Error);
-    Receiver(Unit, Error);
-  }, /*isStackDeep=*/true);
+  Mgr->Impl.ASTBuildQueue.dispatch(
+      [ThisProducer, Mgr, fileSystem, Snapshots, Receiver] {
+        std::string Error;
+        ASTUnitRef Unit = ThisProducer->getASTUnitImpl(Mgr->Impl, fileSystem,
+                                                       Snapshots, Error);
+        Receiver(Unit, Error);
+      },
+      /*isStackDeep=*/true);
 }

-ASTUnitRef ASTProducer::getASTUnitImpl(SwiftASTManager::Implementation &MgrImpl,
-                                   ArrayRef<ImmutableTextSnapshotRef> Snapshots,
-                                   std::string &Error) {
-  if (!AST || shouldRebuild(MgrImpl, Snapshots)) {
+ASTUnitRef ASTProducer::getASTUnitImpl(
+    SwiftASTManager::Implementation &MgrImpl,
+    llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fileSystem,
+    ArrayRef<ImmutableTextSnapshotRef> Snapshots, std::string &Error) {
+  if (!AST || shouldRebuild(MgrImpl, fileSystem, Snapshots)) {
    bool IsRebuild = AST != nullptr;
    const InvocationOptions &Opts = InvokRef->Impl.Opts;

@@ -746,7 +756,7 @@ ASTUnitRef ASTProducer::getASTUnitImpl(SwiftASTManager::Implementation &MgrImpl,
      Log->getOS() << Opts.Invok.getModuleName() << '/' << Opts.PrimaryFile;
    }

-    auto NewAST = createASTUnit(MgrImpl, Snapshots, Error);
+    auto NewAST = createASTUnit(MgrImpl, fileSystem, Snapshots, Error);
    {
      // FIXME: ThreadSafeRefCntPtr is racy.
      llvm::sys::ScopedLock L(Mtx);
@@ -799,8 +809,10 @@ ASTProducer::takeConsumers(ConsumerPredicate predicate) {
  return consumers;
 }

-bool ASTProducer::shouldRebuild(SwiftASTManager::Implementation &MgrImpl,
-                                ArrayRef<ImmutableTextSnapshotRef> Snapshots) {
+bool ASTProducer::shouldRebuild(
+    SwiftASTManager::Implementation &MgrImpl,
+    llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fileSystem,
+    ArrayRef<ImmutableTextSnapshotRef> Snapshots) {
  const SwiftInvocation::Implementation &Invok = InvokRef->Impl;

  // Check if the inputs changed.
@@ -819,8 +831,7 @@ bool ASTProducer::shouldRebuild(SwiftASTManager::Implementation &MgrImpl,
      }
    }
    if (!FoundSnapshot)
-      InputStamps.push_back(
-          MgrImpl.getBufferStamp(File, Invok.Opts.FileSystem));
+      InputStamps.push_back(MgrImpl.getBufferStamp(File, fileSystem));
  }
  assert(InputStamps.size() ==
         Invok.Opts.Invok.getFrontendOptions().InputsAndOutputs.inputCount());
@@ -829,7 +840,7 @@ bool ASTProducer::shouldRebuild(SwiftASTManager::Implementation &MgrImpl,

  for (auto &Dependency : DependencyStamps) {
    if (Dependency.second !=
-        MgrImpl.getBufferStamp(Dependency.first, Invok.Opts.FileSystem))
+        MgrImpl.getBufferStamp(Dependency.first, fileSystem))
      return true;
  }

@@ -895,16 +906,17 @@ static void collectModuleDependencies(ModuleDecl *TopMod,

 static std::atomic<uint64_t> ASTUnitGeneration{ 0 };

-ASTUnitRef ASTProducer::createASTUnit(SwiftASTManager::Implementation &MgrImpl,
-                                      ArrayRef<ImmutableTextSnapshotRef> Snapshots,
-                                      std::string &Error) {
+ASTUnitRef ASTProducer::createASTUnit(
+    SwiftASTManager::Implementation &MgrImpl,
+    llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fileSystem,
+    ArrayRef<ImmutableTextSnapshotRef> Snapshots, std::string &Error) {
  ++MgrImpl.Stats->numASTBuilds;

  Stamps.clear();
  DependencyStamps.clear();

  SmallVector<FileContent, 8> Contents;
-  findSnapshotAndOpenFiles(MgrImpl, Snapshots, Contents, Error);
+  findSnapshotAndOpenFiles(MgrImpl, fileSystem, Snapshots, Contents, Error);

  for (auto &Content : Contents)
    Stamps.push_back(Content.Stamp);
@@ -936,7 +948,7 @@ ASTUnitRef ASTProducer::createASTUnit(SwiftASTManager::Implementation &MgrImpl,

  Invocation.getLangOptions().CollectParsedToken = true;

-  CompIns.getSourceMgr().setFileSystem(InvokRef->Impl.Opts.FileSystem);
+  CompIns.getSourceMgr().setFileSystem(fileSystem);
  if (CompIns.setup(Invocation)) {
    // FIXME: Report the diagnostic.
    LOG_WARN_FUNC("Compilation setup failed!!!");
@@ -959,9 +971,8 @@ ASTUnitRef ASTProducer::createASTUnit(SwiftASTManager::Implementation &MgrImpl,
  // FIXME: There exists a small window where the module file may have been
  // modified after compilation finished and before we get its stamp.
  for (auto &Filename : Filenames) {
-    DependencyStamps.push_back(std::make_pair(
-        Filename,
-        MgrImpl.getBufferStamp(Filename, InvokRef->Impl.Opts.FileSystem)));
+    DependencyStamps.push_back(
+        std::make_pair(Filename, MgrImpl.getBufferStamp(Filename, fileSystem)));
  }

  // Since we only typecheck the primary file (plus referenced constructs
@@ -995,6 +1006,7 @@ ASTUnitRef ASTProducer::createASTUnit(SwiftASTManager::Implementation &MgrImpl,

 void ASTProducer::findSnapshotAndOpenFiles(
    SwiftASTManager::Implementation &MgrImpl,
+    llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fileSystem,
    ArrayRef<ImmutableTextSnapshotRef> Snapshots,
    SmallVectorImpl<FileContent> &Contents, std::string &Error) const {
  const InvocationOptions &Opts = InvokRef->Impl.Opts;
@@ -1013,8 +1025,7 @@ void ASTProducer::findSnapshotAndOpenFiles(
    if (FoundSnapshot)
      continue;

-    auto Content =
-        MgrImpl.getFileContent(File, IsPrimary, Opts.FileSystem, Error);
+    auto Content = MgrImpl.getFileContent(File, IsPrimary, fileSystem, Error);
    if (!Content.Buffer) {
      LOG_WARN_FUNC("failed getting file contents for " << File << ": "
                                                        << Error);