Merge pull request #9146 from gadfort/odb-callbacks

odb: add callback for bpin placement status

Author: maliberty

src/gui/src/search.cpp

@@ -76,6 +76,12 @@ void Search::inDbBPinDestroy(odb::dbBPin* pin)
   clearShapes();
 }
 
+void Search::inDbBPinPlacementStatusBefore(odb::dbBPin* pin,
+                                           const odb::dbPlacementStatus& status)
+{
+  clearShapes();
+}
+
 void Search::inDbFillCreate(odb::dbFill* fill)
 {
   clearFills();

src/gui/src/search.h

@@ -229,6 +229,9 @@ class Search : public QObject, public odb::dbBlockCallBackObj
   void inDbBPinAddBox(odb::dbBox* box) override;
   void inDbBPinRemoveBox(odb::dbBox* box) override;
   void inDbBPinDestroy(odb::dbBPin* pin) override;
+  void inDbBPinPlacementStatusBefore(
+      odb::dbBPin* pin,
+      const odb::dbPlacementStatus& status) override;
   void inDbFillCreate(odb::dbFill* fill) override;
   void inDbWireCreate(odb::dbWire* wire) override;
   void inDbWireDestroy(odb::dbWire* wire) override;

src/odb/include/odb/dbBlockCallBackObj.h

@@ -127,6 +127,9 @@ class dbBlockCallBackObj
   virtual void inDbBPinAddBox(dbBox*) {}
   virtual void inDbBPinRemoveBox(dbBox*) {}
   virtual void inDbBPinDestroy(dbBPin*) {}
+  virtual void inDbBPinPlacementStatusBefore(dbBPin*, const dbPlacementStatus&)
+  {
+  }
   // dbBPin End
 
   // dbBlockage Start

src/odb/src/db/dbBPin.cpp

@@ -154,8 +154,18 @@ dbPlacementStatus dbBPin::getPlacementStatus() const
 void dbBPin::setPlacementStatus(dbPlacementStatus status)
 {
   _dbBPin* bpin = (_dbBPin*) this;
-  bpin->flags_.status = status.getValue();
+
+  if (bpin->flags_.status == status) {
+    return;
+  }
+
   _dbBlock* block = (_dbBlock*) bpin->getOwner();
+
+  for (auto callback : block->callbacks_) {
+    callback->inDbBPinPlacementStatusBefore(this, status);
+  }
+
+  bpin->flags_.status = status.getValue();
   block->flags_.valid_bbox = 0;
 }
 

src/odb/test/cpp/CallBack.h

@@ -66,6 +66,18 @@ class CallBack : public dbBlockCallBackObj
       events.push_back("PostMove inst " + inst->getName());
     }
   }
+  void inDbInstPlacementStatusBefore(dbInst* inst,
+                                     const dbPlacementStatus& status) override
+  {
+    if (!_pause) {
+      char buffer[100];
+      sprintf(buffer,
+              "Change inst status: %s -> %s",
+              inst->getConstName(),
+              status.getString());
+      events.emplace_back(buffer);
+    }
+  }
   // dbInst End
 
   // dbNet Start
@@ -203,6 +215,20 @@ class CallBack : public dbBlockCallBackObj
       events.emplace_back("Destroy BPin");
     }
   }
+
+  void inDbBPinPlacementStatusBefore(dbBPin* pin,
+                                     const dbPlacementStatus& status) override
+  {
+    if (!_pause) {
+      char buffer[100];
+      const std::string name = pin->getName();
+      sprintf(buffer,
+              "Change BPin status: %s -> %s",
+              name.c_str(),
+              status.getString());
+      events.emplace_back(buffer);
+    }
+  }
   // dbBPin End
 
   // dbBlockage Start

src/odb/test/cpp/TestCallBacks.cpp

@@ -51,6 +51,16 @@ TEST_F(CallbackFixture, test_inst_and_iterm)
   EXPECT_EQ(cb_.events[0], "PreMove inst i1");
   EXPECT_EQ(cb_.events[1], "PostMove inst i1");
   cb_.clearEvents();
+  i1->setPlacementStatus(dbPlacementStatus::FIRM);
+  EXPECT_EQ(cb_.events.size(), 1);
+  EXPECT_EQ(cb_.events[0], "Change inst status: i1 -> FIRM");
+  cb_.clearEvents();
+  i1->setPlacementStatus(dbPlacementStatus::FIRM);
+  EXPECT_EQ(cb_.events.size(), 0);
+  i1->setPlacementStatus(dbPlacementStatus::NONE);
+  EXPECT_EQ(cb_.events.size(), 1);
+  EXPECT_EQ(cb_.events[0], "Change inst status: i1 -> NONE");
+  cb_.clearEvents();
   i1->findITerm("a")->connect(n1);
   EXPECT_EQ(cb_.events.size(), 2);
   EXPECT_EQ(cb_.events[0], "PreConnect iterm to net n1");
@@ -122,6 +132,17 @@ TEST_F(CallbackFixture, test_bpin)
   EXPECT_EQ(cb_.events.size(), 1);
   EXPECT_EQ(cb_.events[0], "Create BPin for IN1");
   cb_.clearEvents();
+  pin->setPlacementStatus(dbPlacementStatus::FIRM);
+  EXPECT_EQ(cb_.events.size(), 1);
+  EXPECT_EQ(cb_.events[0], "Change BPin status: <dbBPin:1> -> FIRM");
+  cb_.clearEvents();
+  pin->setPlacementStatus(dbPlacementStatus::FIRM);
+  EXPECT_EQ(cb_.events.size(), 0);
+  cb_.clearEvents();
+  pin->setPlacementStatus(dbPlacementStatus::NONE);
+  EXPECT_EQ(cb_.events.size(), 1);
+  EXPECT_EQ(cb_.events[0], "Change BPin status: <dbBPin:1> -> NONE");
+  cb_.clearEvents();
   dbBox* box
       = dbBox::create(pin, db_->getTech()->findLayer("L1"), 0, 0, 100, 100);
   EXPECT_EQ(cb_.events.size(), 1);