Merge pull request #78127 from rintaro/astgen-interfacehash

[ASTGen] Syntax-tree based interface hash

Author: rintaro

include/swift/AST/ASTBridging.h

@@ -42,6 +42,7 @@ class DeclNameLoc;
 class DeclNameRef;
 class DiagnosticArgument;
 class DiagnosticEngine;
+class Fingerprint;
 class Identifier;
 class IfConfigClauseRangeInfo;
 struct LabeledStmtInfo;
@@ -915,6 +916,8 @@ BridgedUnavailableFromAsyncAttr BridgedUnavailableFromAsyncAttr_createParsed(
 // MARK: Decls
 //===----------------------------------------------------------------------===//
 
+struct BridgedFingerprint;
+
 SWIFT_NAME("BridgedDecl.setAttrs(self:_:)")
 void BridgedDecl_setAttrs(BridgedDecl decl, BridgedDeclAttributes attrs);
 
@@ -1034,9 +1037,10 @@ BridgedTypeAliasDecl BridgedTypeAliasDecl_createParsed(
     BridgedSourceLoc cEqualLoc, BridgedTypeRepr underlyingType,
     BridgedNullableTrailingWhereClause genericWhereClause);
 
-SWIFT_NAME("BridgedExtensionDecl.setParsedMembers(self:_:)")
+SWIFT_NAME("BridgedExtensionDecl.setParsedMembers(self:_:fingerprint:)")
 void BridgedExtensionDecl_setParsedMembers(BridgedExtensionDecl decl,
-                                           BridgedArrayRef members);
+                                           BridgedArrayRef members,
+                                           BridgedFingerprint fingerprint);
 
 SWIFT_NAME(
     "BridgedEnumDecl.createParsed(_:declContext:enumKeywordLoc:name:nameLoc:"
@@ -1269,9 +1273,10 @@ SWIFT_NAME("BridgedNominalTypeDecl.isGenericAtAnyLevel(self:)")
 BRIDGED_INLINE
 bool BridgedNominalTypeDecl_isGenericAtAnyLevel(BridgedNominalTypeDecl decl);
 
-SWIFT_NAME("BridgedNominalTypeDecl.setParsedMembers(self:_:)")
+SWIFT_NAME("BridgedNominalTypeDecl.setParsedMembers(self:_:fingerprint:)")
 void BridgedNominalTypeDecl_setParsedMembers(BridgedNominalTypeDecl decl,
-                                             BridgedArrayRef members);
+                                             BridgedArrayRef members,
+                                             BridgedFingerprint fingerprint);
 
 SWIFT_NAME("BridgedNominalTypeDecl.getSourceLocation(self:)")
 BRIDGED_INLINE BridgedSourceLoc BridgedNominalTypeDecl_getSourceLocation(BridgedNominalTypeDecl decl);
@@ -2327,6 +2332,13 @@ struct BridgedSubstitutionMap {
   SWIFT_IMPORT_UNSAFE BRIDGED_INLINE BridgedConformance getConformance(SwiftInt index) const;
 };
 
+struct BridgedFingerprint {
+  uint64_t v1;
+  uint64_t v2;
+
+  BRIDGED_INLINE swift::Fingerprint unbridged() const;
+};
+
 //===----------------------------------------------------------------------===//
 // MARK: #if handling
 //===----------------------------------------------------------------------===//

include/swift/AST/ASTBridgingImpl.h

@@ -24,6 +24,7 @@
 #include "swift/AST/SourceFile.h"
 #include "swift/AST/Stmt.h"
 #include "swift/Basic/Assertions.h"
+#include "swift/Basic/Fingerprint.h"
 
 SWIFT_BEGIN_NULLABILITY_ANNOTATIONS
 
@@ -461,6 +462,14 @@ BridgedConformance BridgedSubstitutionMap::getConformance(SwiftInt index) const
   return unbridged().getConformances()[index];
 }
 
+//===----------------------------------------------------------------------===//
+// MARK: BridgedFingerprint
+//===----------------------------------------------------------------------===//
+
+swift::Fingerprint BridgedFingerprint::unbridged() const {
+  return swift::Fingerprint({this->v1, this->v2});
+}
+
 //===----------------------------------------------------------------------===//
 // MARK: BridgedIfConfigClauseRangeInfo
 //===----------------------------------------------------------------------===//

include/swift/AST/ParseRequests.h

@@ -88,7 +88,7 @@ class ParseAbstractFunctionBodyRequest
 struct SourceFileParsingResult {
   ArrayRef<ASTNode> TopLevelItems;
   std::optional<ArrayRef<Token>> CollectedTokens;
-  std::optional<StableHasher> InterfaceHasher;
+  std::optional<Fingerprint> Fingerprint;
 };
 
 /// Parse the top-level items of a SourceFile.

include/swift/AST/SourceFile.h

@@ -153,7 +153,7 @@ class SourceFile final : public FileUnit {
   /// this source file.
   ///
   /// We only collect interface hash for primary input files.
-  std::optional<StableHasher> InterfaceHasher;
+  std::optional<Fingerprint> InterfaceHash;
 
   /// The ID for the memory buffer containing this file's source.
   unsigned BufferID;
@@ -756,19 +756,14 @@ class SourceFile final : public FileUnit {
     return ParsingOpts.contains(ParsingFlags::EnableInterfaceHash);
   }
 
-  /// Retrieve a fingerprint value that summarizes the declarations in this
-  /// source file.
+  /// Retrieve a fingerprint value that summarizes the top-level declarations in
+  /// this source file.
   ///
   /// Note that the interface hash merely summarizes the top-level declarations
   /// in this file. Type body fingerprints are currently implemented such that
   /// they divert tokens away from the hasher used for fingerprints. That is,
   /// changes to the bodies of types and extensions will not result in a change
-  /// to the interface hash.
-  ///
-  /// In order for the interface hash to be enabled, this source file must be a
-  /// primary and the compiler must be set in incremental mode. If this is not
-  /// the case, this function will try to signal with an assert. It is useful
-  /// to guard requests for the interface hash with \c hasInterfaceHash().
+  /// to the source file interface hash.
   Fingerprint getInterfaceHash() const;
 
   void dumpInterfaceHash(llvm::raw_ostream &out) {

include/swift/Bridging/ASTGen.h

@@ -61,6 +61,10 @@ void swift_ASTGen_buildTopLevelASTNodes(
     void *_Nonnull outputContext,
     void (*_Nonnull)(BridgedASTNode, void *_Nonnull));
 
+BridgedFingerprint
+swift_ASTGen_getSourceFileFingerprint(void *_Nonnull sourceFile,
+                                      BridgedASTContext astContext);
+
 void swift_ASTGen_freeBridgedString(BridgedStringRef);
 
 // MARK: - Regex parsing

lib/AST/Bridging/DeclBridging.cpp

@@ -338,12 +338,14 @@ BridgedTypeAliasDecl BridgedTypeAliasDecl_createParsed(
   return decl;
 }
 
-static void setParsedMembers(IterableDeclContext *IDC,
-                             BridgedArrayRef bridgedMembers) {
+static void setParsedMembers(IterableDeclContext *IDC, BridgedArrayRef cMembers,
+                             BridgedFingerprint cFingerprint) {
   auto &ctx = IDC->getDecl()->getASTContext();
 
+  Fingerprint fp = cFingerprint.unbridged();
+
   SmallVector<Decl *> members;
-  for (auto *decl : bridgedMembers.unbridged<Decl *>()) {
+  for (auto *decl : cMembers.unbridged<Decl *>()) {
     members.push_back(decl);
 
     // Add any variables bound to the list of decls.
@@ -364,19 +366,22 @@ static void setParsedMembers(IterableDeclContext *IDC,
 
   IDC->setMaybeHasOperatorDeclarations();
   IDC->setMaybeHasNestedClassDeclarations();
+  // FIXME: Split requests. e.g. DeclMembersFingerprintRequest.
   ctx.evaluator.cacheOutput(
       ParseMembersRequest{IDC},
-      FingerprintAndMembers{std::nullopt, ctx.AllocateCopy(members)});
+      FingerprintAndMembers{fp, ctx.AllocateCopy(members)});
 }
 
-void BridgedNominalTypeDecl_setParsedMembers(BridgedNominalTypeDecl bridgedDecl,
-                                             BridgedArrayRef bridgedMembers) {
-  setParsedMembers(bridgedDecl.unbridged(), bridgedMembers);
+void BridgedNominalTypeDecl_setParsedMembers(BridgedNominalTypeDecl cDecl,
+                                             BridgedArrayRef cMembers,
+                                             BridgedFingerprint cFingerprint) {
+  setParsedMembers(cDecl.unbridged(), cMembers, cFingerprint);
 }
 
-void BridgedExtensionDecl_setParsedMembers(BridgedExtensionDecl bridgedDecl,
-                                           BridgedArrayRef bridgedMembers) {
-  setParsedMembers(bridgedDecl.unbridged(), bridgedMembers);
+void BridgedExtensionDecl_setParsedMembers(BridgedExtensionDecl cDecl,
+                                           BridgedArrayRef cMembers,
+                                           BridgedFingerprint cFingerprint) {
+  setParsedMembers(cDecl.unbridged(), cMembers, cFingerprint);
 }
 
 static ArrayRef<InheritedEntry>

lib/AST/Module.cpp

@@ -1551,10 +1551,8 @@ Fingerprint SourceFile::getInterfaceHash() const {
   assert(hasInterfaceHash() && "Interface hash not enabled");
   auto &eval = getASTContext().evaluator;
   auto *mutableThis = const_cast<SourceFile *>(this);
-  std::optional<StableHasher> interfaceHasher =
-      evaluateOrDefault(eval, ParseSourceFileRequest{mutableThis}, {})
-          .InterfaceHasher;
-  return Fingerprint{StableHasher{interfaceHasher.value()}.finalize()};
+  return evaluateOrDefault(eval, ParseSourceFileRequest{mutableThis}, {})
+      .Fingerprint.value();
 }
 
 Fingerprint SourceFile::getInterfaceHashIncludingTypeMembers() const {

lib/ASTGen/Sources/ASTGen/Bridge.swift

@@ -239,6 +239,12 @@ extension BridgedSourceRange {
   }
 }
 
+extension Fingerprint {
+  var bridged: BridgedFingerprint {
+    BridgedFingerprint(v1: self.core.0, v2: self.core.1)
+  }
+}
+
 /// Helper collection type that lazily concatenates two collections.
 struct ConcatCollection<C1: Collection, C2: Collection> where C1.Element == C2.Element {
   let c1: C1

lib/ASTGen/Sources/ASTGen/CMakeLists.txt

@@ -8,12 +8,14 @@ add_pure_swift_host_library(swiftASTGen STATIC CXX_INTEROP
   Diagnostics.swift
   DiagnosticsBridge.swift
   Exprs.swift
+  Fingerprint.swift
   Generics.swift
   Literals.swift
   ParameterClause.swift
   Patterns.swift
   Regex.swift
   SourceFile.swift
+  StableHasher.swift
   Stmts.swift
   TypeAttrs.swift
   Types.swift

lib/ASTGen/Sources/ASTGen/Decls.swift

@@ -131,9 +131,14 @@ extension ASTGenVisitor {
     )
     decl.asDecl.setAttrs(attrs.attributes)
 
-    self.withDeclContext(decl.asDeclContext) {
-      decl.setParsedMembers(self.generate(memberBlockItemList: node.memberBlock.members).lazy.bridgedArray(in: self))
+    let members = self.withDeclContext(decl.asDeclContext) {
+      self.generate(memberBlockItemList: node.memberBlock.members)
     }
+    let fp = self.generateFingerprint(declGroup: node)
+    decl.setParsedMembers(
+      members.lazy.bridgedArray(in: self),
+      fingerprint: fp.bridged
+    )
 
     return decl
   }
@@ -160,9 +165,14 @@ extension ASTGenVisitor {
     )
     decl.asDecl.setAttrs(attrs.attributes)
 
-    self.withDeclContext(decl.asDeclContext) {
-      decl.setParsedMembers(self.generate(memberBlockItemList: node.memberBlock.members).lazy.bridgedArray(in: self))
+    let members = self.withDeclContext(decl.asDeclContext) {
+      self.generate(memberBlockItemList: node.memberBlock.members)
     }
+    let fp = self.generateFingerprint(declGroup: node)
+    decl.setParsedMembers(
+      members.lazy.bridgedArray(in: self),
+      fingerprint: fp.bridged
+    )
 
     return decl
   }
@@ -190,9 +200,14 @@ extension ASTGenVisitor {
     )
     decl.asDecl.setAttrs(attrs.attributes)
 
-    self.withDeclContext(decl.asDeclContext) {
-      decl.setParsedMembers(self.generate(memberBlockItemList: node.memberBlock.members).lazy.bridgedArray(in: self))
+    let members = self.withDeclContext(decl.asDeclContext) {
+      self.generate(memberBlockItemList: node.memberBlock.members)
     }
+    let fp = self.generateFingerprint(declGroup: node)
+    decl.setParsedMembers(
+      members.lazy.bridgedArray(in: self),
+      fingerprint: fp.bridged
+    )
 
     return decl
   }
@@ -220,9 +235,14 @@ extension ASTGenVisitor {
     )
     decl.asDecl.setAttrs(attrs.attributes)
 
-    self.withDeclContext(decl.asDeclContext) {
-      decl.setParsedMembers(self.generate(memberBlockItemList: node.memberBlock.members).lazy.bridgedArray(in: self))
+    let members = self.withDeclContext(decl.asDeclContext) {
+      self.generate(memberBlockItemList: node.memberBlock.members)
     }
+    let fp = self.generateFingerprint(declGroup: node)
+    decl.setParsedMembers(
+      members.lazy.bridgedArray(in: self),
+      fingerprint: fp.bridged
+    )
 
     return decl
   }
@@ -252,9 +272,14 @@ extension ASTGenVisitor {
     )
     decl.asDecl.setAttrs(attrs.attributes)
 
-    self.withDeclContext(decl.asDeclContext) {
-      decl.setParsedMembers(self.generate(memberBlockItemList: node.memberBlock.members).lazy.bridgedArray(in: self))
+    let members = self.withDeclContext(decl.asDeclContext) {
+      self.generate(memberBlockItemList: node.memberBlock.members)
     }
+    let fp = self.generateFingerprint(declGroup: node)
+    decl.setParsedMembers(
+      members.lazy.bridgedArray(in: self),
+      fingerprint: fp.bridged
+    )
 
     return decl
   }
@@ -299,9 +324,14 @@ extension ASTGenVisitor {
     )
     decl.asDecl.setAttrs(attrs.attributes)
 
-    self.withDeclContext(decl.asDeclContext) {
-      decl.setParsedMembers(self.generate(memberBlockItemList: node.memberBlock.members).lazy.bridgedArray(in: self))
+    let members = self.withDeclContext(decl.asDeclContext) {
+      self.generate(memberBlockItemList: node.memberBlock.members)
     }
+    let fp = self.generateFingerprint(declGroup: node)
+    decl.setParsedMembers(
+      members.lazy.bridgedArray(in: self),
+      fingerprint: fp.bridged
+    )
 
     return decl
   }