Merge pull request swiftlang#30167 from davidungar/ref-name-tracker-factor-3-2-20

[NFC, Incremental] Factor used Decl enumeration in preparation for dependency verifier

Author: CodaFi

include/swift/AST/Decl.h

@@ -920,6 +920,9 @@ class alignas(1 << DeclAlignInBits) Decl {
   /// If this returns true, the decl can be safely casted to ValueDecl.
   bool isPotentiallyOverridable() const;
 
+  /// Returns true if this Decl cannot be seen by any other source file
+  bool isPrivateToEnclosingFile() const;
+
   /// If an alternative module name is specified for this decl, e.g. using
   /// @_originalDefinedIn attribute, this function returns this module name.
   StringRef getAlternateModuleName() const;

include/swift/AST/FineGrainedDependencies.h

@@ -17,6 +17,7 @@
 #include "swift/Basic/LLVM.h"
 #include "swift/Basic/NullablePtr.h"
 #include "swift/Basic/Range.h"
+#include "swift/Basic/ReferenceDependencyKeys.h"
 #include "llvm/ADT/Hashing.h"
 #include "llvm/Support/MD5.h"
 #include "llvm/Support/MemoryBuffer.h"
@@ -350,33 +351,6 @@ bool emitReferenceDependencies(DiagnosticEngine &diags, SourceFile *SF,
 // MARK: Enums
 //==============================================================================
 
-/// Encode the current sorts of dependencies as kinds of nodes in the dependency
-/// graph, splitting the current *member* into \ref member and \ref
-/// potentialMember and adding \ref sourceFileProvide.
-
-enum class NodeKind {
-  topLevel,
-  nominal,
-  /// In the status quo scheme, *member* dependencies could have blank names
-  /// for the member, to indicate that the provider might add members.
-  /// This code uses a separate kind, \ref potentialMember. The holder field is
-  /// unused.
-  potentialMember,
-  /// Corresponding to the status quo *member* dependency with a non-blank
-  /// member.
-  member,
-  dynamicLookup,
-  externalDepend,
-  sourceFileProvide,
-  /// For iterating through the NodeKinds.
-  kindCount
-};
-
-/// Used for printing out NodeKinds to dot files, and dumping nodes for
-/// debugging.
-const std::string NodeKindNames[]{
-    "topLevel",      "nominal",        "potentialMember",  "member",
-    "dynamicLookup", "externalDepend", "sourceFileProvide"};
 
 /// Instead of the status quo scheme of two kinds of "Depends", cascading and
 /// non-cascading this code represents each entity ("Provides" in the status

include/swift/AST/ReferencedNameTracker.h

@@ -14,23 +14,33 @@
 #define SWIFT_REFERENCEDNAMETRACKER_H
 
 #include "swift/AST/Identifier.h"
+#include "swift/Basic/ReferenceDependencyKeys.h"
 #include "llvm/ADT/DenseMap.h"
 
+#include <unordered_set>
+
 namespace swift {
 
 class NominalTypeDecl;
+class DependencyTracker;
 
 class ReferencedNameTracker {
-#define TRACKED_SET(KIND, NAME) \
-private: \
-  llvm::DenseMap<KIND, bool> NAME##s; \
-public: \
-  void add##NAME(KIND new##NAME, bool isCascadingUse) { \
-    NAME##s[new##NAME] |= isCascadingUse; \
-  } \
-  const decltype(NAME##s) &get##NAME##s() const { \
-    return NAME##s; \
-  }
+public:
+  using EnumerateUsedDecl = function_ref<void(
+      fine_grained_dependencies::NodeKind kind, StringRef context,
+      StringRef name, bool isCascadingUse)>;
+
+private:
+#define TRACKED_SET(KIND, NAME)                                                \
+private:                                                                       \
+  llvm::DenseMap<KIND, bool> NAME##s;                                          \
+                                                                               \
+public:                                                                        \
+  void add##NAME(KIND new##NAME, bool isCascadingUse) {                        \
+    NAME##s[new##NAME] |= isCascadingUse;                                      \
+  }                                                                            \
+  /* make private once ReferenceDependencies.cpp is gone */                    \
+  const decltype(NAME##s) &get##NAME##s() const { return NAME##s; }
 
   TRACKED_SET(DeclBaseName, TopLevelName)
   TRACKED_SET(DeclBaseName, DynamicLookupName)
@@ -39,6 +49,33 @@ public: \
   TRACKED_SET(MemberPair, UsedMember)
 
 #undef TRACKED_SET
+public:
+  // Pushing the DependencyTracker through unifies external dependency
+  // enumeration.
+  void enumerateAllUses(bool includeIntrafileDeps,
+                        const DependencyTracker &depTracker,
+                        EnumerateUsedDecl enumerateUsedDecl) const;
+
+private:
+  template <fine_grained_dependencies::NodeKind kind>
+  void enumerateSimpleUses(llvm::DenseMap<DeclBaseName, bool> cascadesByName,
+                           EnumerateUsedDecl enumerateUsedDecl) const;
+
+  void enumerateExternalUses(const DependencyTracker &,
+                             EnumerateUsedDecl enumerateUsedDecl) const;
+
+  void enumerateCompoundUses(bool includeIntrafileDeps,
+                             EnumerateUsedDecl enumerateUsedDecl) const;
+
+  std::unordered_set<std::string>
+  computeHoldersOfCascadingMembers(bool includeIntrafileDeps) const;
+
+  void enumerateNominalUses(
+      bool includeIntrafileDeps,
+      const std::unordered_set<std::string> &&holdersOfCascadingMembers,
+      EnumerateUsedDecl enumerateUsedDecl) const;
+
+  void enumerateMemberUses(EnumerateUsedDecl enumerateUsedDecl) const;
 };
 
 } // end namespace swift

include/swift/Basic/ReferenceDependencyKeys.h

@@ -33,6 +33,36 @@ static constexpr StringLiteral dependsExternal("depends-external");
 
 static constexpr StringLiteral interfaceHash("interface-hash");
 } // end namespace reference_dependency_keys
+
+namespace fine_grained_dependencies {
+/// Encode the current sorts of dependencies as kinds of nodes in the dependency
+/// graph, splitting the current *member* into \ref member and \ref
+/// potentialMember and adding \ref sourceFileProvide.
+
+enum class NodeKind {
+  topLevel,
+  nominal,
+  /// In the status quo scheme, *member* dependencies could have blank names
+  /// for the member, to indicate that the provider might add members.
+  /// This code uses a separate kind, \ref potentialMember. The holder field is
+  /// unused.
+  potentialMember,
+  /// Corresponding to the status quo *member* dependency with a non-blank
+  /// member.
+  member,
+  dynamicLookup,
+  externalDepend,
+  sourceFileProvide,
+  /// For iterating through the NodeKinds.
+  kindCount
+};
+
+/// Used for printing out NodeKinds to dot files, and dumping nodes for
+/// debugging.
+const std::string NodeKindNames[]{
+    "topLevel",      "nominal",        "potentialMember",  "member",
+    "dynamicLookup", "externalDepend", "sourceFileProvide"};
+} // end namespace fine_grained_dependencies
 } // end namespace swift
 
 #endif

lib/AST/CMakeLists.txt

@@ -66,6 +66,7 @@ add_swift_host_library(swiftAST STATIC
   PrettyStackTrace.cpp
   ProtocolConformance.cpp
   RawComment.cpp
+  ReferencedNameTracker.cpp
   RequirementEnvironment.cpp
   SyntaxASTMap.cpp
   SILLayout.cpp

lib/AST/Decl.cpp

@@ -8068,3 +8068,26 @@ void swift::simple_display(llvm::raw_ostream &out, AnyFunctionRef fn) {
   else
     out << "closure";
 }
+
+bool Decl::isPrivateToEnclosingFile() const {
+  if (auto *VD = dyn_cast<ValueDecl>(this))
+    return VD->getFormalAccess() <= AccessLevel::FilePrivate;
+  switch (getKind()) {
+  case DeclKind::Import:
+  case DeclKind::PatternBinding:
+  case DeclKind::EnumCase:
+  case DeclKind::TopLevelCode:
+  case DeclKind::IfConfig:
+  case DeclKind::PoundDiagnostic:
+    return true;
+
+  case DeclKind::Extension:
+  case DeclKind::InfixOperator:
+  case DeclKind::PrefixOperator:
+  case DeclKind::PostfixOperator:
+    return false;
+
+  default:
+    llvm_unreachable("everything else is a ValueDecl");
+  }
+}