Teach DependencyTracker to track Fingerprints of Incremental Dependencies

Author: CodaFi

include/swift/AST/ModuleLoader.h

@@ -19,12 +19,14 @@
 
 #include "swift/AST/Identifier.h"
 #include "swift/AST/Import.h"
+#include "swift/AST/ModuleDependencies.h"
+#include "swift/Basic/ArrayRefView.h"
+#include "swift/Basic/Fingerprint.h"
 #include "swift/Basic/LLVM.h"
 #include "swift/Basic/Located.h"
 #include "swift/Basic/SourceLoc.h"
 #include "llvm/ADT/SetVector.h"
 #include "llvm/ADT/TinyPtrVector.h"
-#include "swift/AST/ModuleDependencies.h"
 #include <system_error>
 
 namespace llvm {
@@ -74,8 +76,25 @@ enum class IntermoduleDepTrackingMode {
 /// Records dependencies on files outside of the current module;
 /// implemented in terms of a wrapped clang::DependencyCollector.
 class DependencyTracker {
+public:
+  /// A representation of a first-class incremental dependency known to the
+  /// Swift compiler.
+  struct IncrementalDependency {
+    std::string path;
+    Fingerprint fingerprint;
+
+    IncrementalDependency(std::string Path, Fingerprint FP)
+        : path(std::move(Path)), fingerprint(std::move(FP)) {}
+  };
+
+  inline static std::string getPath(const IncrementalDependency &id) {
+    return id.path;
+  }
+  typedef ArrayRefView<IncrementalDependency, std::string, getPath>
+      DependencyPathArrayRef;
+
   std::shared_ptr<clang::DependencyCollector> clangCollector;
-  SmallVector<std::string, 8> incrementalDeps;
+  SmallVector<IncrementalDependency, 8> incrementalDeps;
   llvm::StringSet<> incrementalDepsUniquer;
 
 public:
@@ -94,14 +113,20 @@ class DependencyTracker {
   ///
   /// No additional canonicalization or adulteration of the file path in
   /// \p File is performed.
-  void addIncrementalDependency(StringRef File);
+  void addIncrementalDependency(StringRef File, Fingerprint FP);
 
   /// Fetches the list of dependencies.
   ArrayRef<std::string> getDependencies() const;
 
   /// Fetches the list of dependencies that are known to have incremental swift
   /// dependency information embedded inside of them.
-  ArrayRef<std::string> getIncrementalDependencies() const;
+  ArrayRef<IncrementalDependency> getIncrementalDependencies() const;
+
+  /// A view of the paths of the dependencies known to have incremental swift
+  /// dependency information embedded inside of them.
+  DependencyPathArrayRef getIncrementalDependencyPaths() const {
+    return DependencyPathArrayRef(getIncrementalDependencies());
+  }
 
   /// Return the underlying clang::DependencyCollector that this
   /// class wraps.

lib/AST/ModuleLoader.cpp

@@ -50,9 +50,10 @@ DependencyTracker::addDependency(StringRef File, bool IsSystem) {
                                      /*IsMissing=*/false);
 }
 
-void DependencyTracker::addIncrementalDependency(StringRef File) {
+void DependencyTracker::addIncrementalDependency(StringRef File,
+                                                 Fingerprint FP) {
   if (incrementalDepsUniquer.insert(File).second) {
-    incrementalDeps.emplace_back(File.str());
+    incrementalDeps.emplace_back(File.str(), FP);
   }
 }
 
@@ -61,7 +62,7 @@ DependencyTracker::getDependencies() const {
   return clangCollector->getDependencies();
 }
 
-ArrayRef<std::string>
+ArrayRef<DependencyTracker::IncrementalDependency>
 DependencyTracker::getIncrementalDependencies() const {
   return incrementalDeps;
 }

lib/FrontendTool/MakeStyleDependencies.cpp

@@ -75,8 +75,9 @@ swift::frontend::utils::escapeForMake(StringRef raw,
 /// should appear in roughly the same order relative to other paths. Ultimately,
 /// this makes it easier to test the contents of the emitted files with tools
 /// like FileCheck.
+template <typename Container>
 static std::vector<std::string>
-reversePathSortedFilenames(const ArrayRef<std::string> elts) {
+reversePathSortedFilenames(const Container &elts) {
   std::vector<std::string> tmp(elts.begin(), elts.end());
   std::sort(tmp.begin(), tmp.end(),
             [](const std::string &a, const std::string &b) -> bool {
@@ -127,7 +128,7 @@ bool swift::emitMakeDependenciesIfNeeded(DiagnosticEngine &diags,
     dependencyString.append(frontend::utils::escapeForMake(path, buffer).str());
   }
   auto incrementalDependencyPaths =
-      reversePathSortedFilenames(depTracker->getIncrementalDependencies());
+      reversePathSortedFilenames(depTracker->getIncrementalDependencyPaths());
   for (auto const &path : incrementalDependencyPaths) {
     dependencyString.push_back(' ');
     dependencyString.append(frontend::utils::escapeForMake(path, buffer).str());

lib/IDE/CompletionInstance.cpp

@@ -199,7 +199,7 @@ forEachDependencyUntilTrue(CompilerInstance &CI, unsigned excludeBufferID,
     if (callback(dep))
       return true;
   }
-  for (auto &dep : CI.getDependencyTracker()->getIncrementalDependencies()) {
+  for (auto dep : CI.getDependencyTracker()->getIncrementalDependencyPaths()) {
     if (callback(dep))
       return true;
   }

lib/Serialization/SerializedModuleLoader.cpp

@@ -1001,7 +1001,8 @@ SerializedModuleLoaderBase::loadModule(SourceLoc importLoc,
     // Don't record cached artifacts as dependencies.
     if (!isCached(DepPath)) {
       if (M->hasIncrementalInfo()) {
-        dependencyTracker->addIncrementalDependency(DepPath);
+        dependencyTracker->addIncrementalDependency(DepPath,
+                                                    M->getFingerprint());
       } else {
         dependencyTracker->addDependency(DepPath, /*isSystem=*/false);
       }