BasicCalleeAnalysis: add dump() functions for debugging

Author: eeckstein

include/swift/SILOptimizer/Analysis/BasicCalleeAnalysis.h

@@ -54,6 +54,11 @@ class CalleeList {
       : CalleeFunctions(llvm::makeArrayRef(List.begin(), List.end())),
         IsIncomplete(IsIncomplete) {}
 
+  LLVM_ATTRIBUTE_DEPRECATED(void dump() const LLVM_ATTRIBUTE_USED,
+                            "Only for use in the debugger");
+
+  void print(llvm::raw_ostream &os) const;
+
   /// Return an iterator for the beginning of the list.
   ArrayRef<SILFunction *>::iterator begin() const {
     return CalleeFunctions.begin();
@@ -67,7 +72,7 @@ class CalleeList {
   bool isIncomplete() const { return IsIncomplete; }
 
   /// Returns true if all callees are known and not external.
-  bool allCalleesVisible();
+  bool allCalleesVisible() const;
 };
 
 /// CalleeCache is a helper class that builds lists of potential
@@ -106,6 +111,8 @@ class CalleeCache {
   /// given instruction. E.g. it could be destructors.
   CalleeList getCalleeList(SILInstruction *I) const;
 
+  CalleeList getCalleeList(SILDeclRef Decl) const;
+
 private:
   void enumerateFunctionsInModule();
   void sortAndUniqueCallees();
@@ -115,7 +122,6 @@ class CalleeCache {
   void computeWitnessMethodCalleesForWitnessTable(SILWitnessTable &WT);
   void computeMethodCallees();
   SILFunction *getSingleCalleeForWitnessMethod(WitnessMethodInst *WMI) const;
-  CalleeList getCalleeList(SILDeclRef Decl) const;
   CalleeList getCalleeList(WitnessMethodInst *WMI) const;
   CalleeList getCalleeList(ClassMethodInst *CMI) const;
   CalleeList getCalleeListForCalleeKind(SILValue Callee) const;
@@ -162,17 +168,23 @@ class BasicCalleeAnalysis : public SILAnalysis {
     Cache.reset();
   }
 
-  CalleeList getCalleeList(FullApplySite FAS) {
+  LLVM_ATTRIBUTE_DEPRECATED(void dump() const LLVM_ATTRIBUTE_USED,
+                            "Only for use in the debugger");
+
+  void print(llvm::raw_ostream &os) const;
+
+  void updateCache() {
     if (!Cache)
       Cache = llvm::make_unique<CalleeCache>(M);
+  }
 
+  CalleeList getCalleeList(FullApplySite FAS) {
+    updateCache();
     return Cache->getCalleeList(FAS);
   }
 
   CalleeList getCalleeList(SILInstruction *I) {
-    if (!Cache)
-      Cache = llvm::make_unique<CalleeCache>(M);
-
+    updateCache();
     return Cache->getCalleeList(I);
   }
 };

lib/SILOptimizer/Analysis/BasicCalleeAnalysis.cpp

@@ -25,7 +25,24 @@
 
 using namespace swift;
 
-bool CalleeList::allCalleesVisible() {
+void CalleeList::dump() const {
+  print(llvm::errs());
+}
+
+void CalleeList::print(llvm::raw_ostream &os) const {
+  os << "Incomplete callee list? : "
+               << (isIncomplete() ? "Yes" : "No");
+  if (!allCalleesVisible())
+    os <<", not all callees visible";
+  os << '\n';
+  os << "Known callees:\n";
+  for (auto *CalleeFn : *this) {
+    os << "  " << CalleeFn->getName() << "\n";
+  }
+  os << "\n";
+}
+
+bool CalleeList::allCalleesVisible() const {
   if (isIncomplete())
     return false;
 
@@ -284,3 +301,22 @@ CalleeList CalleeCache::getCalleeList(SILInstruction *I) const {
   SILDeclRef Destructor = SILDeclRef(Class->getDestructor());
   return getCalleeList(Destructor);
 }
+
+void BasicCalleeAnalysis::dump() const {
+  print(llvm::errs());
+}
+
+void BasicCalleeAnalysis::print(llvm::raw_ostream &os) const {
+  if (!Cache) {
+    os << "<no cache>\n";
+  }
+  llvm::DenseSet<SILDeclRef> printed;
+  for (auto &VTable : M.getVTableList()) {
+    for (const SILVTable::Entry &entry : VTable.getEntries()) {
+      if (printed.insert(entry.Method).second) {
+        os << "callees for " << entry.Method << ":\n";
+        Cache->getCalleeList(entry.Method).print(os);
+      }
+    }
+  }
+}

lib/SILOptimizer/UtilityPasses/BasicCalleePrinter.cpp

@@ -40,12 +40,7 @@ class BasicCalleePrinterPass : public SILModuleTransform {
     llvm::outs() << *FAS.getInstruction();
 
     auto Callees = BCA->getCalleeList(FAS);
-    llvm::outs() << "Incomplete callee list? : "
-                 << (Callees.isIncomplete() ? "Yes" : "No") << "\n";
-    llvm::outs() << "Known callees:\n";
-    for (auto *CalleeFn : Callees)
-      llvm::outs() << CalleeFn->getName() << "\n";
-    llvm::outs() << "\n";
+    Callees.print(llvm::outs());
   }
 
   /// The entry point to the transformation.