odb: add test_undo_mod_inst_destroy test and properly restore the group

Signed-off-by: Matt Liberty <mliberty@precisioninno.com>

Author: maliberty

src/odb/include/odb/db.h

@@ -8056,6 +8056,7 @@ class dbModInst : public dbObject
                            dbModule* masterModule,
                            const char* name);
 
+  // This destroys this modinst but does not destroy the master dbModule.
   static void destroy(dbModInst* modinst);
 
   static dbSet<dbModInst>::iterator destroy(dbSet<dbModInst>::iterator& itr);

src/odb/src/db/dbInst.cpp

@@ -1395,24 +1395,15 @@ void dbInst::destroy(dbInst* inst_)
       cb->inDbITermDestroy((dbITerm*) _iterm);
     }
 
-    dbModule* module = inst_->getModule();
-    if (module) {
-      ((_dbModule*) module)->_dbinst_hash.erase(inst_->getName());
-    }
-
     dbProperty::destroyProperties(_iterm);
     block->_iterm_tbl->destroy(_iterm);
     inst->_iterms.pop_back();
   }
 
-  //    Move this part after inDbInstDestroy
-  //    ----------------------------------------
-  //    _dbMaster * master = (_dbMaster *) inst_->getMaster();
-  //    _dbInstHdr * inst_hdr = block->_inst_hdr_hash.find(master->_id);
-  //    inst_hdr->_inst_cnt--;
-  //
-  //    if ( inst_hdr->_inst_cnt == 0 )
-  //        dbInstHdr::destroy( (dbInstHdr *) inst_hdr );
+  dbModule* module = inst_->getModule();
+  if (module) {
+    ((_dbModule*) module)->_dbinst_hash.erase(inst_->getName());
+  }
 
   if (block->_journal) {
     debugPrint(block->getImpl()->getLogger(),
@@ -1443,7 +1434,6 @@ void dbInst::destroy(dbInst* inst_)
     region->removeInst(inst_);
   }
 
-  dbModule* module = inst_->getModule();
   if (module) {
     ((_dbModule*) module)->removeInst(inst_);
   }

src/odb/src/db/dbJournal.cpp

@@ -1912,15 +1912,20 @@ void dbJournal::undo_deleteObject()
       uint obj_id;
       uint master_module_id;
       uint parent_module_id;
+      uint group_id;
       _log.pop(name);
       _log.pop(obj_id);
       _log.pop(parent_module_id);
       _log.pop(master_module_id);
+      _log.pop(group_id);
       dbModule* parent_module = dbModule::getModule(_block, parent_module_id);
       dbModule* master_module = dbModule::getModule(_block, master_module_id);
       auto mod_inst
           = dbModInst::create(parent_module, master_module, name.c_str());
-      (void) mod_inst;
+      if (group_id != 0) {
+        auto group = dbGroup::getGroup(_block, group_id);
+        group->addModInst(mod_inst);
+      }
       break;
     }
 

src/odb/src/db/dbModInst.cpp

@@ -269,10 +269,6 @@ void dbModInst::destroy(dbModInst* modinst)
     prev = c;
     cur = c->_module_next;
   }
-  // unlink from parent end
-  if (_modinst->_group) {
-    modinst->getGroup()->removeModInst(modinst);
-  }
 
   dbProperty::destroyProperties(_modinst);
 
@@ -284,9 +280,15 @@ void dbModInst::destroy(dbModInst* modinst)
     _block->_journal->pushParam(modinst->getId());
     _block->_journal->pushParam(_module->getId());
     _block->_journal->pushParam(_master->getId());
+    _block->_journal->pushParam(_modinst->_group);
     _block->_journal->endAction();
   }
 
+  // unlink from parent end
+  if (_modinst->_group) {
+    modinst->getGroup()->removeModInst(modinst);
+  }
+
   _dbModule* _parent = (_dbModule*) (modinst->getParent());
   _parent->_modinst_hash.erase(modinst->getName());
   _block->_modinst_tbl->destroy(_modinst);

src/odb/test/cpp/TestJournal.cpp

@@ -64,6 +64,46 @@ BOOST_FIXTURE_TEST_CASE(test_undo_inst_destroy, F_DEFAULT)
   BOOST_TEST(inst->getRegion() == region);
 }
 
+BOOST_FIXTURE_TEST_CASE(test_undo_mod_inst_destroy, F_DEFAULT)
+{
+  auto flat_net = dbNet::create(block, "n");
+  // Make module and contents
+  auto module = dbModule::create(block, "test");
+  auto mod_net = dbModNet::create(module, "lower_net");
+  auto mod_bterm = dbModBTerm::create(module, "bterm");
+  mod_bterm->connect(mod_net);
+  auto leaf_inst = dbInst::create(block, and2, "i1", false, module);
+  auto iterm = leaf_inst->findITerm("b");
+  iterm->connect(flat_net, mod_net);
+
+  // Instantiate the module and connect it
+  auto top = block->getTopModule();
+  dbModNet* top_net = dbModNet::create(top, "top_net");
+  auto inst = dbModInst::create(top, module, "mod_inst");
+  auto mod_iterm = dbModITerm::create(inst, "b", mod_bterm);
+  mod_iterm->connect(top_net);
+
+  auto group = dbGroup::create(block, "g");
+  group->addModInst(inst);
+
+  in_eco([&]() {
+    dbModInst::destroy(inst);
+    BOOST_TEST(block->getModInsts().size() == 0);
+  });
+
+  BOOST_TEST(block->findModInst("mod_inst") == inst);
+  BOOST_TEST(inst->getGroup() == group);
+  BOOST_TEST(inst->getParent() == top);
+  BOOST_TEST(inst->getMaster() == module);
+  BOOST_TEST(inst->getModITerms().size() == 1);
+  BOOST_TEST(*inst->getModITerms().begin() == mod_iterm);
+  BOOST_TEST(mod_iterm->getModNet() == top_net);
+  BOOST_TEST(block->getInsts().size() == 1);
+  BOOST_TEST(*block->getInsts().begin() == leaf_inst);
+  BOOST_TEST(block->getModInsts().size() == 1);
+  BOOST_TEST(*block->getModInsts().begin() == inst);
+}
+
 BOOST_FIXTURE_TEST_CASE(test_undo_net_create, F_DEFAULT)
 {
   in_eco([&]() {