Merge pull request #9239 from github/redsun82/swift-visitors

Swift: transfer all visitors

Author: redsun82

swift/codegen/schema.yml

@@ -38,15 +38,6 @@ class SwiftDispatcher {
     emit(ElementIsUnknownTrap{label});
   }
 
- private:
-  // types to be supported by assignNewLabel/fetchLabel need to be listed here
-  using Store = TrapLabelStore<swift::Decl,
-                               swift::Stmt,
-                               swift::Expr,
-                               swift::Pattern,
-                               swift::TypeRepr,
-                               swift::TypeBase>;
-
   // This method gives a TRAP label for already emitted AST node.
   // If the AST node was not emitted yet, then the emission is dispatched to a corresponding
   // visitor (see `visit(T *)` methods below).
@@ -72,52 +63,109 @@ class SwiftDispatcher {
     return {};
   }
 
+  // convenience `fetchLabel` overload for `swift::Type` (which is just a wrapper for
+  // `swift::TypeBase*`)
+  TrapLabel<TypeTag> fetchLabel(swift::Type t) { return fetchLabel(t.getPointer()); }
+
+  TrapLabel<AstNodeTag> fetchLabel(swift::ASTNode node) {
+    return fetchLabelFromUnion<AstNodeTag>(node);
+  }
+
   // Due to the lazy emission approach, we must assign a label to a corresponding AST node before
   // it actually gets emitted to handle recursive cases such as recursive calls, or recursive type
   // declarations
   template <typename E>
   TrapLabelOf<E> assignNewLabel(E* e) {
     assert(waitingForNewLabel == Store::Handle{e} && "assignNewLabel called on wrong entity");
-    auto label = getLabel<TrapTagOf<E>>();
-    trap.assignStar(label);
+    auto label = createLabel<TrapTagOf<E>>();
     store.insert(e, label);
     waitingForNewLabel = std::monostate{};
     return label;
   }
 
   template <typename Tag>
-  TrapLabel<Tag> getLabel() {
-    return arena.allocateLabel<Tag>();
+  TrapLabel<Tag> createLabel() {
+    auto ret = arena.allocateLabel<Tag>();
+    trap.assignStar(ret);
+    return ret;
+  }
+
+  template <typename Tag, typename... Args>
+  TrapLabel<Tag> createLabel(Args&&... args) {
+    auto ret = arena.allocateLabel<Tag>();
+    trap.assignKey(ret, std::forward<Args>(args)...);
+    return ret;
   }
 
   template <typename Locatable>
   void attachLocation(Locatable locatable, TrapLabel<LocatableTag> locatableLabel) {
     attachLocation(&locatable, locatableLabel);
   }
 
-  // Emits a Location TRAP entry and attaches it to an AST node
+  // Emits a Location TRAP entry and attaches it to a `Locatable` trap label
   template <typename Locatable>
   void attachLocation(Locatable* locatable, TrapLabel<LocatableTag> locatableLabel) {
-    auto start = locatable->getStartLoc();
-    auto end = locatable->getEndLoc();
+    attachLocation(locatable->getStartLoc(), locatable->getEndLoc(), locatableLabel);
+  }
+
+  // Emits a Location TRAP entry for a list of swift entities and attaches it to a `Locatable` trap
+  // label
+  template <typename Locatable>
+  void attachLocation(llvm::MutableArrayRef<Locatable>* locatables,
+                      TrapLabel<LocatableTag> locatableLabel) {
+    if (locatables->empty()) {
+      return;
+    }
+    attachLocation(locatables->front().getStartLoc(), locatables->back().getEndLoc(),
+                   locatableLabel);
+  }
+
+ private:
+  // types to be supported by assignNewLabel/fetchLabel need to be listed here
+  using Store = TrapLabelStore<swift::Decl,
+                               swift::Stmt,
+                               swift::StmtCondition,
+                               swift::CaseLabelItem,
+                               swift::Expr,
+                               swift::Pattern,
+                               swift::TypeRepr,
+                               swift::TypeBase>;
+
+  void attachLocation(swift::SourceLoc start,
+                      swift::SourceLoc end,
+                      TrapLabel<LocatableTag> locatableLabel) {
     if (!start.isValid() || !end.isValid()) {
       // invalid locations seem to come from entities synthesized by the compiler
       return;
     }
     std::string filepath = getFilepath(start);
-    auto fileLabel = arena.allocateLabel<FileTag>();
-    trap.assignKey(fileLabel, filepath);
+    auto fileLabel = createLabel<FileTag>(filepath);
     // TODO: do not emit duplicate trap entries for Files
     trap.emit(FilesTrap{fileLabel, filepath});
     auto [startLine, startColumn] = sourceManager.getLineAndColumnInBuffer(start);
     auto [endLine, endColumn] = sourceManager.getLineAndColumnInBuffer(end);
-    auto locLabel = arena.allocateLabel<LocationTag>();
-    trap.assignKey(locLabel, '{', fileLabel, "}:", startLine, ':', startColumn, ':', endLine, ':',
-                   endColumn);
+    auto locLabel = createLabel<LocationTag>('{', fileLabel, "}:", startLine, ':', startColumn, ':',
+                                             endLine, ':', endColumn);
     trap.emit(LocationsTrap{locLabel, fileLabel, startLine, startColumn, endLine, endColumn});
     trap.emit(LocatablesTrap{locatableLabel, locLabel});
   }
 
+  template <typename Tag, typename... Ts>
+  TrapLabel<Tag> fetchLabelFromUnion(const llvm::PointerUnion<Ts...> u) {
+    TrapLabel<Tag> ret{};
+    assert((... || fetchLabelFromUnionCase<Tag, Ts>(u, ret)) && "llvm::PointerUnion not set");
+    return ret;
+  }
+
+  template <typename Tag, typename T, typename... Ts>
+  bool fetchLabelFromUnionCase(const llvm::PointerUnion<Ts...> u, TrapLabel<Tag>& output) {
+    if (auto e = u.template dyn_cast<T>()) {
+      output = fetchLabel(e);
+      return true;
+    }
+    return false;
+  }
+
   std::string getFilepath(swift::SourceLoc loc) {
     // TODO: this needs more testing
     // TODO: check canonicaliztion of names on a case insensitive filesystems
@@ -135,6 +183,8 @@ class SwiftDispatcher {
   // which are to be introduced in follow-up PRs
   virtual void visit(swift::Decl* decl) = 0;
   virtual void visit(swift::Stmt* stmt) = 0;
+  virtual void visit(swift::StmtCondition* cond) = 0;
+  virtual void visit(swift::CaseLabelItem* item) = 0;
   virtual void visit(swift::Expr* expr) = 0;
   virtual void visit(swift::Pattern* pattern) = 0;
   virtual void visit(swift::TypeRepr* type) = 0;

swift/extractor/SwiftDispatcher.h

@@ -35,6 +35,8 @@ using SILBoxTypeReprTag = SilBoxTypeReprTag;
   static_assert(std::is_base_of_v<TYPE##Tag, TAG>, "override is not a subtag");
 
 MAP_TAG(Stmt);
+MAP_TAG(StmtCondition);
+MAP_TAG(CaseLabelItem);
 #define ABSTRACT_STMT(CLASS, PARENT) MAP_SUBTAG(CLASS##Stmt, PARENT)
 #define STMT(CLASS, PARENT) ABSTRACT_STMT(CLASS, PARENT)
 #include "swift/AST/StmtNodes.def"

swift/extractor/SwiftTagTraits.h

@@ -22,6 +22,8 @@ class SwiftVisitor : private SwiftDispatcher {
  private:
   void visit(swift::Decl* decl) override { declVisitor.visit(decl); }
   void visit(swift::Stmt* stmt) override { stmtVisitor.visit(stmt); }
+  void visit(swift::StmtCondition* cond) override { stmtVisitor.visitStmtCondition(cond); }
+  void visit(swift::CaseLabelItem* item) override { stmtVisitor.visitCaseLabelItem(item); }
   void visit(swift::Expr* expr) override { exprVisitor.visit(expr); }
   void visit(swift::Pattern* pattern) override { patternVisitor.visit(pattern); }
   void visit(swift::TypeRepr* type) override { typeReprVisitor.visit(type); }

swift/extractor/SwiftVisitor.h

@@ -13,12 +13,18 @@ class UntypedTrapLabel {
   template <typename Tag>
   friend class TrapLabel;
 
+  static constexpr uint64_t undefined = 0xffffffffffffffff;
+
  protected:
-  UntypedTrapLabel() : id_{0xffffffffffffffff} {}
+  UntypedTrapLabel() : id_{undefined} {}
   UntypedTrapLabel(uint64_t id) : id_{id} {}
 
  public:
   friend std::ostream& operator<<(std::ostream& out, UntypedTrapLabel l) {
+    // TODO: this is a temporary fix to catch us from outputting undefined labels to trap
+    // this should be moved to a validity check, probably aided by code generation and carried out
+    // by `SwiftDispatcher`
+    assert(l.id_ != undefined && "outputting an undefined label!");
     out << '#' << std::hex << l.id_ << std::dec;
     return out;
   }