[NFC] Traffic in Fingerprints

CodaFi · CodaFi · commit 27d29262b0bb · 2020-11-18T12:20:14.000-08:00
diff --git a/include/swift/AST/ASTTypeIDZone.def b/include/swift/AST/ASTTypeIDZone.def
@@ -21,6 +21,7 @@ SWIFT_TYPEID(BodyInitKind)
 SWIFT_TYPEID(BodyInitKindAndExpr)
 SWIFT_TYPEID(CtorInitializerKind)
 SWIFT_TYPEID(ResultBuilderBodyPreCheck)
+SWIFT_TYPEID(Fingerprint)
 SWIFT_TYPEID(GenericSignature)
 SWIFT_TYPEID(ImplicitImportList)
 SWIFT_TYPEID(ImplicitMemberAction)
diff --git a/include/swift/AST/ASTTypeIDs.h b/include/swift/AST/ASTTypeIDs.h
@@ -34,6 +34,7 @@ class ConstructorDecl;
 class CustomAttr;
 class Decl;
 class EnumDecl;
+class Fingerprint;
 class FuncDecl;
 enum class ResultBuilderBodyPreCheck : uint8_t;
 class GenericParamList;
diff --git a/include/swift/AST/AbstractSourceFileDepGraphFactory.h b/include/swift/AST/AbstractSourceFileDepGraphFactory.h
@@ -71,33 +71,30 @@ class AbstractSourceFileDepGraphFactory {
   template <NodeKind kind, typename ContentsT>
   void addAllDefinedDeclsOfAGivenType(std::vector<ContentsT> &contentsVec) {
     for (const auto &declOrPair : contentsVec) {
-      Optional<std::string> fp =
+      auto fp =
           AbstractSourceFileDepGraphFactory::getFingerprintIfAny(declOrPair);
       addADefinedDecl(
           DependencyKey::createForProvidedEntityInterface<kind>(declOrPair),
-          fp ? StringRef(fp.getValue()) : Optional<StringRef>());
+          fp);
     }
   }
 
   /// Add an pair of interface, implementation nodes to the graph, which
   /// represent some \c Decl defined in this source file. \param key the
   /// interface key of the pair
   void addADefinedDecl(const DependencyKey &key,
-                       Optional<StringRef> fingerprint);
+                       Optional<Fingerprint> fingerprint);
 
   void addAUsedDecl(const DependencyKey &def, const DependencyKey &use);
 
-  static Optional<std::string> getFingerprintIfAny(
-      std::pair<const NominalTypeDecl *, const ValueDecl *>) {
+  static Optional<Fingerprint>
+  getFingerprintIfAny(std::pair<const NominalTypeDecl *, const ValueDecl *>) {
     return None;
   }
 
-  static Optional<std::string> getFingerprintIfAny(const Decl *d) {
+  static Optional<Fingerprint> getFingerprintIfAny(const Decl *d) {
     if (const auto *idc = dyn_cast<IterableDeclContext>(d)) {
-      auto result = idc->getBodyFingerprint();
-      assert((!result || !result->empty()) &&
-             "Fingerprint should never be empty");
-      return result;
+      return idc->getBodyFingerprint();
     }
     return None;
   }
diff --git a/include/swift/AST/DeclContext.h b/include/swift/AST/DeclContext.h
@@ -24,6 +24,7 @@
 #include "swift/AST/ResilienceExpansion.h"
 #include "swift/AST/TypeAlignments.h"
 #include "swift/Basic/Debug.h"
+#include "swift/Basic/Fingerprint.h"
 #include "swift/Basic/LLVM.h"
 #include "swift/Basic/STLExtras.h"
 #include "swift/Basic/SourceLoc.h"
@@ -871,7 +872,7 @@ class IterableDeclContext {
 
   /// Return a hash of all tokens in the body for dependency analysis, if
   /// available.
-  Optional<std::string> getBodyFingerprint() const;
+  Optional<Fingerprint> getBodyFingerprint() const;
 
 private:
   /// Add a member to the list for iteration purposes, but do not notify the
diff --git a/include/swift/AST/FineGrainedDependencies.h b/include/swift/AST/FineGrainedDependencies.h
@@ -14,6 +14,7 @@
 #define SWIFT_AST_FINE_GRAINED_DEPENDENCIES_H
 
 #include "swift/Basic/Debug.h"
+#include "swift/Basic/Fingerprint.h"
 #include "swift/Basic/LLVM.h"
 #include "swift/Basic/NullablePtr.h"
 #include "swift/Basic/Range.h"
@@ -599,22 +600,15 @@ class DepGraphNode {
   /// frontend creates an interface node,
   //  it adds a dependency to it from the implementation source file node (which
   //  has the intefaceHash as its fingerprint).
-  Optional<std::string> fingerprint;
+  Optional<Fingerprint> fingerprint;
 
   friend ::llvm::yaml::MappingTraits<DepGraphNode>;
 
 public:
   /// See \ref SourceFileDepGraphNode::SourceFileDepGraphNode().
   DepGraphNode() : key(), fingerprint() {}
 
-  /// See SourceFileDepGraphNode::SourceFileDepGraphNode(...) and
-  /// ModuleDepGraphNode::ModuleDepGraphNode(...) Don't set swiftDeps on
-  /// creation because this field can change if a node is moved.
-  DepGraphNode(DependencyKey key, Optional<StringRef> fingerprint)
-      : DepGraphNode(key, fingerprint ? fingerprint->str()
-                                      : Optional<std::string>()) {}
-
-  DepGraphNode(DependencyKey key, Optional<std::string> fingerprint)
+  DepGraphNode(DependencyKey key, Optional<Fingerprint> fingerprint)
       : key(key), fingerprint(fingerprint) {}
   DepGraphNode(const DepGraphNode &other) = default;
 
@@ -630,12 +624,7 @@ class DepGraphNode {
     this->key = key;
   }
 
-  const Optional<StringRef> getFingerprint() const {
-    if (fingerprint) {
-      return StringRef(fingerprint.getValue());
-    }
-    return None;
-  }
+  const Optional<Fingerprint> getFingerprint() const { return fingerprint; }
   /// When driver reads a SourceFileDepGraphNode, it may be a node that was
   /// created to represent a name-lookup (a.k.a a "depend") in the frontend. In
   /// that case, the node represents an entity that resides in some other file
@@ -644,9 +633,7 @@ class DepGraphNode {
   /// (someday) have a fingerprint. In order to preserve the
   /// ModuleDepGraphNode's identity but bring its fingerprint up to date, it
   /// needs to set the fingerprint *after* the node has been created.
-  void setFingerprint(Optional<StringRef> fp) {
-    fingerprint = fp ? fp->str() : Optional<std::string>();
-  }
+  void setFingerprint(Optional<Fingerprint> fp) { fingerprint = fp; }
 
   SWIFT_DEBUG_DUMP;
   void dump(llvm::raw_ostream &os) const;
@@ -693,7 +680,7 @@ class SourceFileDepGraphNode : public DepGraphNode {
   SourceFileDepGraphNode() : DepGraphNode() {}
 
   /// Used by the frontend to build nodes.
-  SourceFileDepGraphNode(DependencyKey key, Optional<StringRef> fingerprint,
+  SourceFileDepGraphNode(DependencyKey key, Optional<Fingerprint> fingerprint,
                          bool isProvides)
       : DepGraphNode(key, fingerprint), isProvides(isProvides) {
     assert(key.verify());
@@ -827,14 +814,14 @@ class SourceFileDepGraph {
   /// file itself.
   InterfaceAndImplementationPair<SourceFileDepGraphNode>
   findExistingNodePairOrCreateAndAddIfNew(const DependencyKey &interfaceKey,
-                                          Optional<StringRef> fingerprint);
+                                          Optional<Fingerprint> fingerprint);
 
   NullablePtr<SourceFileDepGraphNode>
   findExistingNode(const DependencyKey &key);
 
   SourceFileDepGraphNode *
   findExistingNodeOrCreateIfNew(const DependencyKey &key,
-                                const Optional<StringRef> fingerprint,
+                                const Optional<Fingerprint> fingerprint,
                                 bool isProvides);
 
   /// \p Use is the Node that must be rebuilt when \p def changes.
diff --git a/include/swift/AST/LazyResolver.h b/include/swift/AST/LazyResolver.h
@@ -86,7 +86,7 @@ class alignas(void*) LazyMemberLoader {
 
   /// Returns the fingerprint associated with the given iterable decl context,
   /// or \c None if no such fingerprint is available.
-  virtual Optional<std::string>
+  virtual Optional<Fingerprint>
   loadFingerprint(const IterableDeclContext *IDC) = 0;
 
   /// Populates the given vector with all conformances for \p D.
diff --git a/include/swift/AST/ParseRequests.h b/include/swift/AST/ParseRequests.h
@@ -19,6 +19,7 @@
 #include "swift/AST/ASTTypeIDs.h"
 #include "swift/AST/EvaluatorDependencies.h"
 #include "swift/AST/SimpleRequest.h"
+#include "swift/Basic/Fingerprint.h"
 #include "swift/Syntax/SyntaxNodes.h"
 
 namespace swift {
@@ -30,7 +31,7 @@ void reportEvaluatedRequest(UnifiedStatsReporter &stats,
                             const Request &request);
 
 struct FingerprintAndMembers {
-  Optional<std::string> fingerprint = None;
+  Optional<Fingerprint> fingerprint = None;
   ArrayRef<Decl *> members = {};
   bool operator==(const FingerprintAndMembers &x) const {
     return fingerprint == x.fingerprint && members == x.members;
diff --git a/include/swift/Driver/FineGrainedDependencyDriverGraph.h b/include/swift/Driver/FineGrainedDependencyDriverGraph.h
@@ -15,6 +15,7 @@
 
 #include "swift/AST/FineGrainedDependencies.h"
 #include "swift/Basic/Debug.h"
+#include "swift/Basic/Fingerprint.h"
 #include "swift/Basic/LLVM.h"
 #include "swift/Basic/OptionSet.h"
 #include "swift/Driver/Job.h"
@@ -55,7 +56,8 @@ class ModuleDepGraphNode : public DepGraphNode {
   bool hasBeenTracedAsADependent = false;
 
 public:
-  ModuleDepGraphNode(const DependencyKey &key, Optional<StringRef> fingerprint,
+  ModuleDepGraphNode(const DependencyKey &key,
+                     Optional<Fingerprint> fingerprint,
                      Optional<std::string> swiftDeps)
       : DepGraphNode(key, fingerprint), swiftDeps(swiftDeps) {}
 
diff --git a/include/swift/Parse/Parser.h b/include/swift/Parse/Parser.h
@@ -941,7 +941,7 @@ class Parser {
                                bool IsAtStartOfLineOrPreviousHadSemi,
                                llvm::function_ref<void(Decl*)> Handler);
 
-  std::pair<std::vector<Decl *>, Optional<std::string>>
+  std::pair<std::vector<Decl *>, Optional<Fingerprint>>
   parseDeclListDelayed(IterableDeclContext *IDC);
 
   bool parseMemberDeclList(SourceLoc &LBLoc, SourceLoc &RBLoc,
@@ -1085,7 +1085,7 @@ class Parser {
   ParserStatus parseDeclItem(bool &PreviousHadSemi,
                              ParseDeclOptions Options,
                              llvm::function_ref<void(Decl*)> handler);
-  std::pair<std::vector<Decl *>, Optional<std::string>>
+  std::pair<std::vector<Decl *>, Optional<Fingerprint>>
   parseDeclList(SourceLoc LBLoc, SourceLoc &RBLoc, Diag<> ErrorDiag,
                 ParseDeclOptions Options, IterableDeclContext *IDC,
                 bool &hadError);
diff --git a/lib/AST/AbstractSourceFileDepGraphFactory.cpp b/lib/AST/AbstractSourceFileDepGraphFactory.cpp
@@ -60,11 +60,11 @@ void AbstractSourceFileDepGraphFactory::addSourceFileNodesToGraph() {
   g.findExistingNodePairOrCreateAndAddIfNew(
       DependencyKey::createKeyForWholeSourceFile(DeclAspect::interface,
                                                  swiftDeps),
-      StringRef(fileFingerprint));
+      Fingerprint{fileFingerprint});
 }
 
 void AbstractSourceFileDepGraphFactory::addADefinedDecl(
-    const DependencyKey &interfaceKey, Optional<StringRef> fingerprint) {
+    const DependencyKey &interfaceKey, Optional<Fingerprint> fingerprint) {
 
   auto nodePair =
       g.findExistingNodePairOrCreateAndAddIfNew(interfaceKey, fingerprint);
diff --git a/lib/AST/DeclContext.cpp b/lib/AST/DeclContext.cpp
@@ -1011,7 +1011,7 @@ IterableDeclContext::castDeclToIterableDeclContext(const Decl *D) {
   }
 }
 
-Optional<std::string> IterableDeclContext::getBodyFingerprint() const {
+Optional<Fingerprint> IterableDeclContext::getBodyFingerprint() const {
   auto &ctx = getASTContext();
   // If this decl comes from a serialized module, grab its fingerprint from
   // the file.
diff --git a/lib/AST/FineGrainedDependencies.cpp b/lib/AST/FineGrainedDependencies.cpp
@@ -109,7 +109,7 @@ void SourceFileDepGraph::forEachArc(
 
 InterfaceAndImplementationPair<SourceFileDepGraphNode>
 SourceFileDepGraph::findExistingNodePairOrCreateAndAddIfNew(
-    const DependencyKey &interfaceKey, Optional<StringRef> fingerprint) {
+    const DependencyKey &interfaceKey, Optional<Fingerprint> fingerprint) {
 
   // Optimization for whole-file users:
   if (interfaceKey.getKind() == NodeKind::sourceFileProvide &&
@@ -145,7 +145,7 @@ SourceFileDepGraph::findExistingNodePairOrCreateAndAddIfNew(
 }
 
 SourceFileDepGraphNode *SourceFileDepGraph::findExistingNodeOrCreateIfNew(
-    const DependencyKey &key, const Optional<StringRef> fingerprint,
+    const DependencyKey &key, const Optional<Fingerprint> fingerprint,
     const bool isProvides) {
   SourceFileDepGraphNode *result = memoizedNodes.findExistingOrCreateIfNew(
       key, [&](DependencyKey key) -> SourceFileDepGraphNode * {
diff --git a/lib/AST/FineGrainedDependencyFormat.cpp b/lib/AST/FineGrainedDependencyFormat.cpp
@@ -232,7 +232,7 @@ bool Deserializer::readFineGrainedDependencyGraph(SourceFileDepGraph &g,
       if (node == nullptr)
         llvm::report_fatal_error("Unexpected FINGERPRINT_NODE record");
 
-      node->setFingerprint(BlobData);
+      node->setFingerprint(Fingerprint{BlobData.str()});
       break;
     }
 
@@ -450,7 +450,7 @@ Serializer::writeFineGrainedDependencyGraph(const SourceFileDepGraph &g,
     if (auto fingerprint = node->getFingerprint()) {
       FingerprintNodeLayout::emitRecord(Out, ScratchRecord,
                                         AbbrCodes[FingerprintNodeLayout::Code],
-                                        *fingerprint);
+                                        fingerprint->getRawValue());
     }
 
     node->forEachDefIDependUpon([&](size_t defIDependOn) {
diff --git a/lib/ClangImporter/ClangImporter.cpp b/lib/ClangImporter/ClangImporter.cpp
@@ -3831,7 +3831,7 @@ void ClangImporter::Implementation::lookupAllObjCMembers(
   }
 }
 
-Optional<std::string>
+Optional<Fingerprint>
 ClangImporter::Implementation::loadFingerprint(const IterableDeclContext *) {
   // Clang decls are not fingerprinted in Swift.
   return None;
diff --git a/lib/ClangImporter/ImporterImpl.h b/lib/ClangImporter/ImporterImpl.h
@@ -1247,7 +1247,7 @@ class LLVM_LIBRARY_VISIBILITY ClangImporter::Implementation
   loadNamedMembers(const IterableDeclContext *IDC, DeclBaseName N,
                    uint64_t contextData) override;
 
-  virtual Optional<std::string>
+  virtual Optional<Fingerprint>
   loadFingerprint(const IterableDeclContext *IDC) override;
 
 private:
diff --git a/lib/IDE/CompletionInstance.cpp b/lib/IDE/CompletionInstance.cpp
@@ -305,7 +305,7 @@ void getInterfaceHashIncludingTypeMembers(SourceFile *SF,
   std::function<void(IterableDeclContext *)> hashTypeBodyFingerprints =
       [&](IterableDeclContext *IDC) {
         if (auto fp = IDC->getBodyFingerprint())
-          hash.update(*fp);
+          hash.update(fp->getRawValue());
         for (auto *member : IDC->getParsedMembers())
           if (auto *childIDC = dyn_cast<IterableDeclContext>(member))
             hashTypeBodyFingerprints(childIDC);
diff --git a/lib/Parse/ParseDecl.cpp b/lib/Parse/ParseDecl.cpp
@@ -4280,7 +4280,7 @@ static Parser::ParseDeclOptions getMemberParseDeclOptions(
   }
 }
 
-std::pair<std::vector<Decl *>, Optional<std::string>>
+std::pair<std::vector<Decl *>, Optional<Fingerprint>>
 Parser::parseDeclListDelayed(IterableDeclContext *IDC) {
   Decl *D = const_cast<Decl*>(IDC->getDecl());
   DeclContext *DC = cast<DeclContext>(D);
@@ -4737,7 +4737,7 @@ bool Parser::parseMemberDeclList(SourceLoc &LBLoc, SourceLoc &RBLoc,
 /// \verbatim
 ///    decl* '}'
 /// \endverbatim
-std::pair<std::vector<Decl *>, Optional<std::string>>
+std::pair<std::vector<Decl *>, Optional<Fingerprint>>
 Parser::parseDeclList(SourceLoc LBLoc, SourceLoc &RBLoc, Diag<> ErrorDiag,
                       ParseDeclOptions Options, IterableDeclContext *IDC,
                       bool &hadError) {
@@ -4779,9 +4779,7 @@ Parser::parseDeclList(SourceLoc LBLoc, SourceLoc &RBLoc, Diag<> ErrorDiag,
 
   llvm::MD5::MD5Result result;
   CurrentTokenHash->final(result);
-  llvm::SmallString<32> tokenHashString;
-  llvm::MD5::stringifyResult(result, tokenHashString);
-  return std::make_pair(decls, tokenHashString.str().str());
+  return std::make_pair(decls, Fingerprint{std::move(result)});
 }
 
 bool Parser::canDelayMemberDeclParsing(bool &HasOperatorDeclarations,
diff --git a/lib/Parse/ParseRequests.cpp b/lib/Parse/ParseRequests.cpp
@@ -39,7 +39,7 @@ namespace swift {
 void swift::simple_display(llvm::raw_ostream &out,
                            const FingerprintAndMembers &value) {
   if (value.fingerprint)
-    simple_display(out, value.fingerprint.getValue());
+    simple_display(out, *value.fingerprint);
   else
     out << "<no fingerprint>";
   out << ", ";
diff --git a/lib/Serialization/ModuleFile.cpp b/lib/Serialization/ModuleFile.cpp
@@ -650,7 +650,7 @@ void ModuleFile::loadDerivativeFunctionConfigurations(
   }
 }
 
-Optional<std::string>
+Optional<Fingerprint>
 ModuleFile::loadFingerprint(const IterableDeclContext *IDC) {
   PrettyStackTraceDecl trace("loading fingerprints for", IDC->getDecl());
 
diff --git a/lib/Serialization/ModuleFile.h b/lib/Serialization/ModuleFile.h
@@ -653,7 +653,7 @@ class ModuleFile
   loadNamedMembers(const IterableDeclContext *IDC, DeclBaseName N,
                    uint64_t contextData) override;
 
-  virtual Optional<std::string>
+  virtual Optional<Fingerprint>
   loadFingerprint(const IterableDeclContext *IDC) override;
 
   virtual void
diff --git a/lib/Serialization/ModuleFileCoreTableInfo.h b/lib/Serialization/ModuleFileCoreTableInfo.h
@@ -570,7 +570,7 @@ class ModuleFileSharedCore::DeclFingerprintsTableInfo {
 public:
   using internal_key_type = uint32_t;
   using external_key_type = DeclID;
-  using data_type = std::string;
+  using data_type = swift::Fingerprint;
   using hash_value_type = uint32_t;
   using offset_type = unsigned;
 
@@ -586,8 +586,8 @@ class ModuleFileSharedCore::DeclFingerprintsTableInfo {
 
   static std::pair<unsigned, unsigned> ReadKeyDataLength(const uint8_t *&data) {
     using namespace llvm::support;
-    unsigned dataLength = endian::readNext<uint16_t, little, unaligned>(data);
-    return {sizeof(uint32_t), dataLength};
+    const unsigned dataLen = Fingerprint::DIGEST_LENGTH;
+    return {sizeof(uint32_t), dataLen};
   }
 
   static internal_key_type ReadKey(const uint8_t *data, unsigned length) {
@@ -598,7 +598,9 @@ class ModuleFileSharedCore::DeclFingerprintsTableInfo {
   static data_type ReadData(internal_key_type key, const uint8_t *data,
                             unsigned length) {
     using namespace llvm::support;
-    return std::string{reinterpret_cast<const char *>(data), length};
+    auto str = std::string{reinterpret_cast<const char *>(data),
+                           Fingerprint::DIGEST_LENGTH};
+    return Fingerprint{str};
   }
 };
 
diff --git a/lib/Serialization/Serialization.cpp b/lib/Serialization/Serialization.cpp
diff --git a/lib/Serialization/Serialization.h b/lib/Serialization/Serialization.h
diff --git a/tools/swift-dependency-tool/swift-dependency-tool.cpp b/tools/swift-dependency-tool/swift-dependency-tool.cpp
