gui: add option to write a DEF for timing path

Adds a right click choice on a path in the timing viewer to write a DEF
for just the instances and nets on the path (including any instances
connected to those nets).

Mostly useful for developers to extract a path to investigate.

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

Author: maliberty

src/gui/src/mainWindow.cpp

@@ -1645,6 +1645,7 @@ void MainWindow::setLogger(utl::Logger* logger)
   drc_viewer_->setLogger(logger);
   clock_viewer_->setLogger(logger);
   charts_widget_->setLogger(logger);
+  timing_widget_->setLogger(logger);
 }
 
 void MainWindow::fit()

src/gui/src/timingWidget.cpp

@@ -20,6 +20,7 @@
 #include "db_sta/dbSta.hh"
 #include "gui_utils.h"
 #include "odb/db.h"
+#include "odb/defout.h"
 #include "sta/Liberty.hh"
 #include "staGui.h"
 
@@ -249,6 +250,11 @@ void TimingWidget::init(sta::dbSta* sta)
   clearPathDetails();
 }
 
+void TimingWidget::setLogger(utl::Logger* logger)
+{
+  logger_ = logger;
+}
+
 void TimingWidget::updatePaths()
 {
   update_button_->click();
@@ -336,6 +342,10 @@ void TimingWidget::addCommandsMenuActions()
           [this] {
             writePathReportCommand(timing_paths_table_index_, kFromStartToEnd);
           });
+
+  connect(commands_menu_->addAction("Write path DEF"),
+          &QAction::triggered,
+          [this] { writePathDef(timing_paths_table_index_, kFromStartToEnd); });
 }
 
 void TimingWidget::showCommandsMenu(const QPoint& pos)
@@ -349,6 +359,35 @@ void TimingWidget::showCommandsMenu(const QPoint& pos)
   commands_menu_->popup(focus_view_->viewport()->mapToGlobal(pos));
 }
 
+void TimingWidget::writePathDef(const QModelIndex& selected_index,
+                                const CommandType& type)
+{
+  TimingPathsModel* focus_model
+      = static_cast<TimingPathsModel*>(focus_view_->model());
+  TimingPath* path = focus_model->getPathAt(selected_index);
+
+  odb::dbBlock* block = nullptr;
+  odb::DefOut def_out(logger_);
+  auto add_path = [&](TimingNodeList* node_list) {
+    for (int i = 0; i < (node_list->size() - 1); i++) {
+      TimingPathNode* curr_node = (*node_list)[i].get();
+      odb::dbInst* curr_node_inst = curr_node->getInstance();
+      if (curr_node_inst) {
+        block = curr_node_inst->getBlock();
+        def_out.selectInst(curr_node_inst);
+      }
+      def_out.selectNet(curr_node->getNet());
+    }
+  };
+
+  add_path(&path->getPathNodes());
+  add_path(&path->getCaptureNodes());
+
+  const std::string file_name
+      = fmt::format("path{}.def", selected_index.row() + 1);
+  def_out.writeBlock(block, file_name.c_str());
+}
+
 // The nodes must be written within curly braces to
 // deal with characters like '$'
 void TimingWidget::writePathReportCommand(const QModelIndex& selected_index,

src/gui/src/timingWidget.h

@@ -54,6 +54,7 @@ class TimingWidget : public QDockWidget
   ~TimingWidget() override;
 
   void init(sta::dbSta* sta);
+  void setLogger(utl::Logger* logger);
 
   TimingPathRenderer* getTimingRenderer() { return path_renderer_.get(); }
   TimingConeRenderer* getConeRenderer() { return cone_renderer_.get(); }
@@ -101,6 +102,7 @@ class TimingWidget : public QDockWidget
 
   void writePathReportCommand(const QModelIndex& selected_index,
                               const CommandType& type);
+  void writePathDef(const QModelIndex& selected_index, const CommandType& type);
   void showCommandsMenu(const QPoint& pos);
 
  private slots:
@@ -127,6 +129,7 @@ class TimingWidget : public QDockWidget
   QString generateFromStartToEndString(TimingPath* path);
   QString generateClosestMatchString(CommandType type, TimingPath* path);
 
+  utl::Logger* logger_{nullptr};
   QMenu* commands_menu_;
 
   QModelIndex timing_paths_table_index_;