mpl: add debug chart for cost components vs iteration

Only drawing area, outline, and wire length for clarity.  Points are only
added where pauses occur to limit the number of updates.

Signed-off-by: Matt Liberty <[email protected]>

Author: maliberty

src/gui/include/gui/gui.h

@@ -591,6 +591,7 @@ class Chart
   virtual void setYAxisMin(const std::vector<std::optional<double>>& mins) = 0;
   // One y per series.  The order matches y_labels in addChart
   virtual void addPoint(double x, const std::vector<double>& ys) = 0;
+  virtual void clearPoints() = 0;
 
   virtual void addVerticalMarker(double x, const Painter::Color& color) = 0;
 

src/gui/src/chartsWidget.cpp

@@ -37,6 +37,7 @@ class GuiChart : public Chart
   void setYAxisFormats(const std::vector<std::string>& formats) override;
   void setYAxisMin(const std::vector<std::optional<double>>& mins) override;
   void addPoint(double x, const std::vector<double>& ys) override;
+  void clearPoints() override;
 
   void addVerticalMarker(double x, const Painter::Color& color) override;
 
@@ -48,6 +49,14 @@ class GuiChart : public Chart
     double y_min{std::numeric_limits<double>::max()};
     double y_max{std::numeric_limits<double>::lowest()};
     bool has_min{false};
+
+    void clear()
+    {
+      series->clear();
+      y_min = std::numeric_limits<double>::max();
+      y_max = std::numeric_limits<double>::lowest();
+      has_min = false;
+    }
   };
 
   void addSeries(const std::string& label);
@@ -144,6 +153,15 @@ void GuiChart::addPoint(const double x, const std::vector<double>& ys)
   }
 }
 
+void GuiChart::clearPoints()
+{
+  for (Series& series : series_) {
+    series.clear();
+  }
+  x_min_ = std::numeric_limits<double>::max();
+  x_max_ = std::numeric_limits<double>::lowest();
+}
+
 void GuiChart::addVerticalMarker(const double x, const Painter::Color& color)
 {
   QLineSeries* vline = new QLineSeries();
@@ -1047,4 +1065,4 @@ void HistogramView::contextMenuEvent(QContextMenuEvent* event)
   }
 }
 
-}  // namespace gui
+}  // namespace gui

src/mpl/src/MplObserver.h

@@ -24,7 +24,11 @@ class MplObserver
   virtual void startCoarse() {}
   virtual void startFine() {}
 
-  virtual void startSA() {}
+  virtual void startSA(const char* type,
+                       int max_num_step,
+                       int num_perturb_per_step)
+  {
+  }
   virtual void saStep(const std::vector<SoftMacro>& macros) {}
   virtual void saStep(const std::vector<HardMacro>& macros) {}
   virtual void endSA(float norm_cost) {}

src/mpl/src/SACoreHardMacro.cpp

@@ -60,7 +60,7 @@ SACoreHardMacro::SACoreHardMacro(PhysicalHierarchy* tree,
 void SACoreHardMacro::run()
 {
   if (graphics_) {
-    graphics_->startSA();
+    graphics_->startSA("hard", max_num_step_, num_perturb_per_step_);
   }
 
   fastSA();

src/mpl/src/SACoreSoftMacro.cpp

@@ -80,7 +80,7 @@ SACoreSoftMacro::SACoreSoftMacro(PhysicalHierarchy* tree,
 void SACoreSoftMacro::run()
 {
   if (graphics_) {
-    graphics_->startSA();
+    graphics_->startSA("soft", max_num_step_, num_perturb_per_step_);
   }
 
   fastSA();

src/mpl/src/graphics.cpp

@@ -36,7 +36,14 @@ Graphics::Graphics(bool coarse,
       block_(block),
       logger_(logger)
 {
-  gui::Gui::get()->registerRenderer(this);
+  gui::Gui* gui = gui::Gui::get();
+  gui->registerRenderer(this);
+
+  // Setup the chart
+  chart_ = gui->addChart("MPL", "Iteration", {"Area", "Outline", "WireLength"});
+  chart_->setXAxisFormat("%d");
+  chart_->setYAxisFormats({"%.2e", "%.2e", "%.2e"});
+  chart_->setYAxisMin({0, 0, 0});
 }
 
 void Graphics::startCoarse()
@@ -49,7 +56,9 @@ void Graphics::startFine()
   active_ = fine_;
 }
 
-void Graphics::startSA()
+void Graphics::startSA(const char* type,
+                       const int max_num_step,
+                       const int num_perturb_per_step)
 {
   if (!active_) {
     return;
@@ -63,9 +72,14 @@ void Graphics::startSA()
     return;
   }
 
-  logger_->report("------ Start ------");
+  logger_->report("------ Start {} ------", type);
+  logger_->report("max_num_step = {} num_perturb_per_step = {}",
+                  max_num_step,
+                  num_perturb_per_step);
   best_norm_cost_ = std::numeric_limits<float>::max();
   skipped_ = 0;
+  chart_->clearPoints();
+  iter_ = 0;
 }
 
 void Graphics::endSA(const float norm_cost)
@@ -85,7 +99,7 @@ void Graphics::endSA(const float norm_cost)
   if (skipped_ > 0) {
     logger_->report("Skipped to end: {}", skipped_);
   }
-  logger_->report("------ End ------");
+  logger_->report("------ End (Iter {}) ------", iter_);
   report(norm_cost);
   gui::Gui::get()->pause();
 }
@@ -195,6 +209,7 @@ void Graphics::penaltyCalculated(float norm_cost)
   if (!active_) {
     return;
   }
+  iter_++;
 
   if (is_skipping_) {
     return;
@@ -207,7 +222,13 @@ void Graphics::penaltyCalculated(float norm_cost)
   bool drawing_last_step = skip_steps_ && !is_skipping_;
 
   if (norm_cost < best_norm_cost_ || drawing_last_step) {
-    logger_->report("------ Penalty ------");
+    const float area = area_penalty_ ? area_penalty_.value().value : 0;
+    const float outline = outline_penalty_ ? outline_penalty_.value().value : 0;
+    const float wirelength
+        = wirelength_penalty_ ? wirelength_penalty_.value().value : 0;
+    chart_->addPoint(iter_, {area, outline, wirelength});
+
+    logger_->report("------ Penalty (Iter {}) ------", iter_);
     report(norm_cost);
 
     if (skipped_ > 0) {

src/mpl/src/graphics.h

@@ -30,7 +30,9 @@ class Graphics : public gui::Renderer, public MplObserver
   void startCoarse() override;
   void startFine() override;
 
-  void startSA() override;
+  void startSA(const char* type,
+               int max_num_step,
+               int num_perturb_per_step) override;
   void saStep(const std::vector<SoftMacro>& macros) override;
   void saStep(const std::vector<HardMacro>& macros) override;
   void endSA(float norm_cost) override;
@@ -117,6 +119,7 @@ class Graphics : public gui::Renderer, public MplObserver
   std::vector<odb::Rect> blocked_regions_for_pins_;
   BoundaryRegionList available_regions_for_unconstrained_pins_;
   ClusterToBoundaryRegionMap io_cluster_to_constraint_;
+  gui::Chart* chart_{nullptr};
 
   // In Soft SA, we're shaping/placing the children of a certain parent,
   // so for this case, the current cluster is actually the current parent.
@@ -149,6 +152,7 @@ class Graphics : public gui::Renderer, public MplObserver
 
   float best_norm_cost_ = 0;
   int skipped_ = 0;
+  int iter_ = 0;
 
   Cluster* root_ = nullptr;
 };