[LatencyPriorityQueue] The LatencyPriorityQueue class is missing the implementation for the dump function

[stefanp]

Summary

Implement the dump function for LatencyPriorityQueue.

[echristo]

Sure. Feel free to just commit this sort of thing.

-eric

[nemanjai]

Just out of curiosity, do we want to separate out the declaration and definition so that no definition is available in NDEBUG builds? Namely, should the def be something along the lines of:

#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
LLVM_DUMP_METHOD void LatencyPriorityQueue::dump(ScheduleDAG *DAG) const {
  // ...
}
#endif

I know there has been some discussion recently about how we want to handle this debugging stuff, but I didn't really keep up with the discussion. So I asked Stefan to post this on Phabricator.
P.S. Is there any general guidance about providing dump() functions that take no parameters (for example if this one has a default nullptr argument)?

[stefanp]

@echristo
Hi Eric,
What is your opinion on this? Should I be adding the #if .. and #endif? Does it matter?

[stefanp]

Committed in rL330117.
Closing this item.

include/llvm/CodeGen/LatencyPriorityQueue.h

public:
     bool empty() const override { return Queue.empty(); }
 
     void push(SUnit *U) override;
 
     SUnit *pop() override;
 
     void remove(SUnit *SU) override;
 
+    void dump(ScheduleDAG *DAG) const {
+      dbgs() << "Latency Priority Queue\n";
+      dbgs() << "  Number of Queue Entries: " << Queue.size() << "\n";
+      for(auto const& SU: Queue) {
+        dbgs() << "    ";
+        SU->dump(DAG);
+      }
+    }
+
     // scheduledNode - As nodes are scheduled, we look to see if there are any
     // successor nodes that have a single unscheduled predecessor.  If so, that
     // single predecessor has a higher priority, since scheduling it will make
     // the node available.
     void scheduledNode(SUnit *Node) override;
 
 private:
     void AdjustPriorityOfUnscheduledPreds(SUnit *SU);
     SUnit *getSingleUnscheduledPred(SUnit *SU);
   };
 }
 
 #endif