// SPDX-License-Identifier: BSD-3-Clause // Copyright (c) 2023-2025, The OpenROAD Authors #include // NOLINT(modernize-deprecated-headers): for strdup() #include #include #include #include #include #include #include #include #include #include #include #include #include "base/abc/abc.h" #include "base/main/abcapis.h" #include "cut/abc_library_factory.h" #include "cut/logic_cut.h" #include "cut/logic_extractor.h" #include "db_sta/dbReadVerilog.hh" #include "db_sta/dbSta.hh" #include "gmock/gmock.h" #include "gtest/gtest.h" #include "map/mio/mio.h" #include "map/scl/sclLib.h" #include "misc/vec/vecPtr.h" #include "odb/db.h" #include "odb/dbSet.h" #include "odb/lefin.h" #include "sta/Graph.hh" #include "sta/Liberty.hh" #include "sta/NetworkClass.hh" #include "sta/SdcClass.hh" #include "sta/Sta.hh" #include "sta/Units.hh" #include "sta/VerilogReader.hh" #include "tst/fixture.h" #include "utl/deleter.h" #include "utl/unique_name.h" // Headers have duplicate declarations so we include // a forward one to get at this function without angering // gcc. namespace abc { void* Abc_FrameReadLibGen(); } namespace cut { using cut::AbcLibrary; using cut::AbcLibraryFactory; using cut::LogicCut; using cut::LogicExtractorFactory; using ::testing::Contains; static std::once_flag init_abc_flag; static const std::string kPrefix("_main/src/cut/test/"); class AbcTest : public tst::Fixture { protected: void SetUp() override { std::call_once(init_abc_flag, []() { abc::Abc_Start(); }); library_ = readLiberty(kPrefix + "Nangate45/Nangate45_typ.lib"); odb::dbTech* tech = loadTechLef("nangate45", kPrefix + "Nangate45/Nangate45_tech.lef"); loadLibaryLef( tech, "nangate45", kPrefix + "Nangate45/Nangate45_stdcell.lef"); sta::Units* units = library_->units(); power_unit_ = units->powerUnit(); } void LoadVerilog(const std::string& file_name, const std::string& top = "top") { // Assumes module name is "top" and clock name is "clk" sta::dbNetwork* network = sta_->getDbNetwork(); ord::dbVerilogNetwork verilog_network(sta_.get()); sta::VerilogReader verilog_reader(&verilog_network); verilog_reader.read(getFilePath(file_name).c_str()); ord::dbLinkDesign(top.c_str(), &verilog_network, db_.get(), &logger_, /*hierarchy = */ false); sta_->postReadDb(db_.get()); sta::Cell* top_cell = network->cell(network->topInstance()); sta::Port* clk_port = network->findPort(top_cell, "clk"); sta::Pin* clk_pin = network->findPin(network->topInstance(), clk_port); sta::PinSet pinset(network); pinset.insert(clk_pin); // 0.5ns double period = sta_->units()->timeUnit()->userToSta(0.5); sta::FloatSeq waveform; waveform.push_back(0); waveform.push_back(period / 2.0); sta_->makeClock("core_clock", pinset, /*add_to_pins=*/false, /*period=*/period, waveform, /*comment=*/"", /*mode=*/sta_->cmdMode()); sta_->ensureGraph(); sta_->ensureLevelized(); } std::map AbcLogicNetworkNameToPrimaryOutputIds( abc::Abc_Ntk_t* network) { std::map primary_output_name_to_index; for (int i = 0; i < abc::Abc_NtkPoNum(network); i++) { abc::Abc_Obj_t* po = abc::Abc_NtkPo(network, i); std::string po_name = abc::Abc_ObjName(po); primary_output_name_to_index[po_name] = i; } return primary_output_name_to_index; } sta::Unit* power_unit_; sta::LibertyLibrary* library_; }; class AbcTestSky130 : public AbcTest { void SetUp() override { std::call_once(init_abc_flag, []() { abc::Abc_Start(); }); library_ = readLiberty(kPrefix + "sky130/sky130_fd_sc_hd__ss_n40C_1v40.lib"); odb::dbTech* tech = loadTechLef("sky130", kPrefix + "sky130/sky130hd.tlef"); odb::dbLib* lib = loadLibaryLef( tech, "sky130", kPrefix + "sky130/sky130hd_std_cell.lef"); sta_->postReadLef(tech, lib); sta::Units* units = library_->units(); power_unit_ = units->powerUnit(); } }; class AbcTestAsap7 : public AbcTest { void SetUp() override { std::call_once(init_abc_flag, []() { abc::Abc_Start(); }); std::array liberty_paths = {"asap7/asap7sc7p5t_AO_RVT_FF_nldm_211120.lib.gz", "asap7/asap7sc7p5t_INVBUF_RVT_FF_nldm_220122.lib.gz", "asap7/asap7sc7p5t_OA_RVT_FF_nldm_211120.lib.gz", "asap7/asap7sc7p5t_SEQ_RVT_FF_nldm_220123.lib", "asap7/asap7sc7p5t_SIMPLE_RVT_FF_nldm_211120.lib.gz"}; for (const char* liberty_path : liberty_paths) { library_ = readLiberty(kPrefix + liberty_path); } odb::dbTech* tech = loadTechLef("asap7", kPrefix + "asap7/asap7_tech_1x_201209.lef"); odb::dbLib* lib = loadLibaryLef( tech, "asap7", kPrefix + "asap7/asap7sc7p5t_28_R_1x_220121a.lef"); sta_->postReadLef(tech, lib); sta::Units* units = library_->units(); power_unit_ = units->powerUnit(); } }; TEST_F(AbcTest, CellPropertiesMatchOpenSta) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); for (size_t i = 0; i < Vec_PtrSize(&abc_library.abc_library()->vCells); i++) { abc::SC_Cell* abc_cell = static_cast( abc::Vec_PtrEntry(&abc_library.abc_library()->vCells, i)); sta::LibertyCell* sta_cell = library_->findLibertyCell(abc_cell->pName); EXPECT_NE(nullptr, sta_cell); // Expect area matches EXPECT_FLOAT_EQ(abc_cell->area, sta_cell->area()); float leakage_power = -1; bool exists; sta_cell->leakagePower(leakage_power, exists); if (exists) { EXPECT_FLOAT_EQ(abc_cell->leakage, power_unit_->staToUser(leakage_power)); } } } TEST_F(AbcTest, DoesNotContainPhysicalCells) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); std::set abc_cells; using ::testing::Contains; using ::testing::Not; for (size_t i = 0; i < Vec_PtrSize(&abc_library.abc_library()->vCells); i++) { abc::SC_Cell* abc_cell = static_cast( abc::Vec_PtrEntry(&abc_library.abc_library()->vCells, i)); abc_cells.emplace(abc_cell->pName); } EXPECT_THAT(abc_cells, Not(Contains("ANTENNA_X1"))); EXPECT_THAT(abc_cells, Not(Contains("FILLCELL_X1"))); } TEST_F(AbcTestAsap7, ImportsWithoutErrors) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); EXPECT_NO_THROW(factory.Build()); } TEST_F(AbcTest, DoesNotContainSequentialCells) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); std::set abc_cells; using ::testing::Contains; using ::testing::Not; for (size_t i = 0; i < Vec_PtrSize(&abc_library.abc_library()->vCells); i++) { abc::SC_Cell* abc_cell = static_cast( abc::Vec_PtrEntry(&abc_library.abc_library()->vCells, i)); abc_cells.emplace(abc_cell->pName); } EXPECT_THAT(abc_cells, Not(Contains("DFFRS_X2"))); } TEST_F(AbcTest, ContainsLogicCells) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); std::set abc_cells; using ::testing::Contains; using ::testing::Not; for (size_t i = 0; i < Vec_PtrSize(&abc_library.abc_library()->vCells); i++) { abc::SC_Cell* abc_cell = static_cast( abc::Vec_PtrEntry(&abc_library.abc_library()->vCells, i)); abc_cells.emplace(abc_cell->pName); } EXPECT_THAT(abc_cells, Contains("AND2_X1")); EXPECT_THAT(abc_cells, Contains("AND2_X2")); EXPECT_THAT(abc_cells, Contains("AND2_X4")); EXPECT_THAT(abc_cells, Contains("AOI21_X1")); } // Create standard cell library from dbsta. Then create an // abc network with a single and gate, and make sure that it // simulates correctly. TEST_F(AbcTest, TestLibraryInstallation) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); // When you set these params to zero they are essentially turned off. abc::Abc_SclInstallGenlib(abc_library.abc_library(), /*Slew=*/0, /*Gain=*/0, /*fUseAll=*/0, /*nGatesMin=*/0); abc::Mio_LibraryTransferCellIds(); abc::Mio_Library_t* lib = static_cast(abc::Abc_FrameReadLibGen()); std::map gates; abc::Mio_Gate_t* gate = abc::Mio_LibraryReadGates(lib); while (gate) { gates[abc::Mio_GateReadName(gate)] = gate; gate = abc::Mio_GateReadNext(gate); } utl::UniquePtrWithDeleter network( abc::Abc_NtkAlloc(abc::Abc_NtkType_t::ABC_NTK_NETLIST, abc::Abc_NtkFunc_t::ABC_FUNC_MAP, /*fUseMemMan=*/1), &abc::Abc_NtkDelete); abc::Abc_NtkSetName(network.get(), strdup("test_module")); abc::Abc_Obj_t* input_1 = abc::Abc_NtkCreatePi(network.get()); abc::Abc_Obj_t* input_1_net = abc::Abc_NtkCreateNet(network.get()); abc::Abc_Obj_t* input_2 = abc::Abc_NtkCreatePi(network.get()); abc::Abc_Obj_t* input_2_net = abc::Abc_NtkCreateNet(network.get()); abc::Abc_Obj_t* output = abc::Abc_NtkCreatePo(network.get()); abc::Abc_Obj_t* output_net = abc::Abc_NtkCreateNet(network.get()); abc::Abc_Obj_t* and_gate = abc::Abc_NtkCreateNode(network.get()); abc::Abc_ObjSetData(and_gate, gates["AND2_X1"]); abc::Abc_ObjAddFanin(input_1_net, input_1); abc::Abc_ObjAddFanin(input_2_net, input_2); // Gate order is technically dependent on the order in which the port // appears in the Mio_Gate_t struct. In practice you should go a build // a port_name -> index map type thing to make sure the right ports // are connected. abc::Abc_ObjAddFanin(and_gate, input_1_net); // A abc::Abc_ObjAddFanin(and_gate, input_2_net); // B std::string output_name = "out"; abc::Abc_ObjAssignName(output_net, output_name.data(), /*pSuffix=*/nullptr); abc::Abc_ObjAddFanin(output_net, and_gate); abc::Abc_ObjAddFanin(output, output_net); utl::UniquePtrWithDeleter logic_network( abc::Abc_NtkToLogic(network.get()), &abc::Abc_NtkDelete); std::array input_vector = {1, 1}; utl::UniquePtrWithDeleter output_vector( abc::Abc_NtkVerifySimulatePattern(logic_network.get(), input_vector.data()), &free); EXPECT_EQ(output_vector.get()[0], 1); // Expect that 1 & 1 == 1 } TEST_F(AbcTest, ExtractsAndGateCorrectly) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); LoadVerilog(kPrefix + "simple_and_gate_extract.v"); sta::dbNetwork* network = sta_->getDbNetwork(); sta::Vertex* flop_input_vertex = nullptr; for (sta::Vertex* vertex : sta_->endpoints()) { if (std::string(vertex->name(network)) == "output_flop/D") { flop_input_vertex = vertex; } } EXPECT_NE(flop_input_vertex, nullptr); LogicExtractorFactory logic_extractor(sta_.get(), &logger_); logic_extractor.AppendEndpoint(flop_input_vertex); LogicCut cut = logic_extractor.BuildLogicCut(abc_library); EXPECT_EQ(cut.cut_instances().size(), 1); EXPECT_EQ(std::string(network->name(*cut.cut_instances().begin())), "_403_"); } TEST_F(AbcTest, ExtractsEmptyCutSetCorrectly) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); LoadVerilog(kPrefix + "empty_cut_set.v"); sta::dbNetwork* network = sta_->getDbNetwork(); sta::Vertex* flop_input_vertex = nullptr; for (sta::Vertex* vertex : sta_->endpoints()) { if (std::string(vertex->name(network)) == "output_flop/D") { flop_input_vertex = vertex; } } EXPECT_NE(flop_input_vertex, nullptr); LogicExtractorFactory logic_extractor(sta_.get(), &logger_); logic_extractor.AppendEndpoint(flop_input_vertex); LogicCut cut = logic_extractor.BuildLogicCut(abc_library); EXPECT_TRUE(cut.IsEmpty()); } TEST_F(AbcTest, ExtractSideOutputsCorrectly) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); LoadVerilog(kPrefix + "side_outputs_extract.v"); sta::dbNetwork* network = sta_->getDbNetwork(); sta::Vertex* flop_input_vertex = nullptr; for (sta::Vertex* vertex : sta_->endpoints()) { if (std::string(vertex->name(network)) == "output_flop/D") { flop_input_vertex = vertex; } } EXPECT_NE(flop_input_vertex, nullptr); LogicExtractorFactory logic_extractor(sta_.get(), &logger_); logic_extractor.AppendEndpoint(flop_input_vertex); LogicCut cut = logic_extractor.BuildLogicCut(abc_library); std::unordered_set primary_output_names; for (sta::Net* net : cut.primary_outputs()) { primary_output_names.insert(network->name(net)); } // Since a single net feeds both of these outputs should expect just 1 output EXPECT_EQ(cut.primary_outputs().size(), 1); EXPECT_THAT(primary_output_names, Contains("flop_net")); } TEST_F(AbcTest, BuildAbcMappedNetworkFromLogicCut) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); LoadVerilog(kPrefix + "side_outputs_extract_logic_depth.v"); sta::dbNetwork* network = sta_->getDbNetwork(); sta::Vertex* flop_input_vertex = nullptr; for (sta::Vertex* vertex : sta_->endpoints()) { if (std::string(vertex->name(network)) == "output_flop/D") { flop_input_vertex = vertex; } } EXPECT_NE(flop_input_vertex, nullptr); LogicExtractorFactory logic_extractor(sta_.get(), &logger_); logic_extractor.AppendEndpoint(flop_input_vertex); LogicCut cut = logic_extractor.BuildLogicCut(abc_library); utl::UniquePtrWithDeleter abc_network = cut.BuildMappedAbcNetwork(abc_library, network, &logger_); abc::Abc_NtkSetName(abc_network.get(), strdup("temp_network_name")); utl::UniquePtrWithDeleter logic_network( abc::Abc_NtkToLogic(abc_network.get()), &abc::Abc_NtkDelete); // Build map of primary output names to primary output indicies in ABC std::map primary_output_name_to_index = AbcLogicNetworkNameToPrimaryOutputIds(logic_network.get()); std::array input_vector = {1, 1}; utl::UniquePtrWithDeleter output_vector( abc::Abc_NtkVerifySimulatePattern(logic_network.get(), input_vector.data()), &free); // Both outputs are just the and gate. EXPECT_EQ(output_vector.get()[primary_output_name_to_index.at("flop_net")], 0); // Expect that !(1 & 1) == 0 EXPECT_EQ(output_vector.get()[primary_output_name_to_index.at("and_output")], 1); // Expect that (1 & 1) == 1 } TEST_F(AbcTest, BuildComplexLogicCone) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); LoadVerilog(kPrefix + "aes_nangate45.v", /*top=*/"aes_cipher_top"); sta::dbNetwork* network = sta_->getDbNetwork(); sta::Vertex* flop_input_vertex = nullptr; for (sta::Vertex* vertex : sta_->endpoints()) { if (std::string(vertex->name(network)) == "_32989_/D") { flop_input_vertex = vertex; } } EXPECT_NE(flop_input_vertex, nullptr); LogicExtractorFactory logic_extractor(sta_.get(), &logger_); logic_extractor.AppendEndpoint(flop_input_vertex); LogicCut cut = logic_extractor.BuildLogicCut(abc_library); EXPECT_NO_THROW(cut.BuildMappedAbcNetwork(abc_library, network, &logger_)); } TEST_F(AbcTest, InsertingMappedLogicCutDoesNotThrow) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); LoadVerilog(kPrefix + "aes_nangate45.v", /*top=*/"aes_cipher_top"); sta::dbNetwork* network = sta_->getDbNetwork(); sta::Vertex* flop_input_vertex = nullptr; for (sta::Vertex* vertex : sta_->endpoints()) { if (std::string(vertex->name(network)) == "_33122_/D") { flop_input_vertex = vertex; } } EXPECT_NE(flop_input_vertex, nullptr); LogicExtractorFactory logic_extractor(sta_.get(), &logger_); logic_extractor.AppendEndpoint(flop_input_vertex); LogicCut cut = logic_extractor.BuildLogicCut(abc_library); utl::UniquePtrWithDeleter mapped_abc_network = cut.BuildMappedAbcNetwork(abc_library, network, &logger_); utl::UniqueName unique_name; EXPECT_NO_THROW(cut.InsertMappedAbcNetwork( mapped_abc_network.get(), abc_library, network, unique_name, &logger_)); } TEST_F(AbcTest, AfterExtractingAndReinsertingCuttingAgainResultsInCorrectSimulation) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); LoadVerilog(kPrefix + "side_outputs_extract_logic_depth.v"); sta::dbNetwork* network = sta_->getDbNetwork(); sta::Vertex* flop_input_vertex = nullptr; for (sta::Vertex* vertex : sta_->endpoints()) { if (std::string(vertex->name(network)) == "output_flop/D") { flop_input_vertex = vertex; } } EXPECT_NE(flop_input_vertex, nullptr); LogicExtractorFactory logic_extractor(sta_.get(), &logger_); logic_extractor.AppendEndpoint(flop_input_vertex); LogicCut cut = logic_extractor.BuildLogicCut(abc_library); utl::UniquePtrWithDeleter mapped_abc_network = cut.BuildMappedAbcNetwork(abc_library, network, &logger_); utl::UniqueName unique_name; cut.InsertMappedAbcNetwork( mapped_abc_network.get(), abc_library, network, unique_name, &logger_); // Re-extract the same cone, and try to simulate it to make sure everything // still simulates correctly LogicExtractorFactory logic_extractor_post_insert(sta_.get(), &logger_); logic_extractor_post_insert.AppendEndpoint(flop_input_vertex); LogicCut cut_post_insert = logic_extractor_post_insert.BuildLogicCut(abc_library); utl::UniquePtrWithDeleter mapped_abc_network_post_insert = cut.BuildMappedAbcNetwork(abc_library, network, &logger_); abc::Abc_NtkSetName(mapped_abc_network_post_insert.get(), strdup("temp_network_name")); utl::UniquePtrWithDeleter logic_network( abc::Abc_NtkToLogic(mapped_abc_network_post_insert.get()), &abc::Abc_NtkDelete); // Build map of primary output names to primary output indicies in ABC std::map primary_output_name_to_index = AbcLogicNetworkNameToPrimaryOutputIds(logic_network.get()); std::array input_vector = {1, 1}; utl::UniquePtrWithDeleter output_vector( abc::Abc_NtkVerifySimulatePattern(logic_network.get(), input_vector.data()), &free); // Both outputs are just the and gate. EXPECT_EQ(output_vector.get()[primary_output_name_to_index.at("flop_net")], 0); // Expect that !(1 & 1) == 0 EXPECT_EQ(output_vector.get()[primary_output_name_to_index.at("and_output")], 1); // Expect that (1 & 1) == 1 } TEST_F(AbcTestSky130, EnsureThatSky130MultiOutputConstCellsAreMapped) { AbcLibraryFactory factory(&logger_); factory.AddDbSta(sta_.get()); AbcLibrary abc_library = factory.Build(); LoadVerilog(kPrefix + "sky130_const_cell.v"); sta::dbNetwork* network = sta_->getDbNetwork(); sta::Instance* flop_input_instance = network->findInstance("_403_"); EXPECT_NE(flop_input_instance, nullptr); sta::Net* flop_net = network->findNet("flop_net"); EXPECT_NE(flop_net, nullptr); std::vector primary_inputs = {}; std::vector primary_outputs = {flop_net}; sta::InstanceSet cut_instances(network); cut_instances.insert(flop_input_instance); LogicCut cut(std::move(primary_inputs), std::move(primary_outputs), std::move(cut_instances)); // Create abc network that matches the underlying LogicCut utl::UniquePtrWithDeleter abc_network( abc::Abc_NtkAlloc(abc::Abc_NtkType_t::ABC_NTK_NETLIST, abc::Abc_NtkFunc_t::ABC_FUNC_MAP, /*fUseMemMan=*/1), &abc::Abc_NtkDelete); abc::Abc_NtkSetName(abc_network.get(), strdup("test_module")); abc::Mio_Library_t* mio_library = abc::Abc_SclDeriveGenlibSimple(abc_library.abc_library()); abc_network->pManFunc = mio_library; abc::Abc_Obj_t* output = abc::Abc_NtkCreatePo(abc_network.get()); abc::Abc_Obj_t* output_net = abc::Abc_NtkCreateNet(abc_network.get()); abc::Abc_Obj_t* const_1 = abc::Abc_NtkCreateNode(abc_network.get()); abc::Abc_ObjSetData(const_1, abc::Mio_LibraryReadConst1(mio_library)); abc::Abc_ObjAddFanin(output, output_net); abc::Abc_ObjAddFanin(output_net, const_1); std::string output_name = "flop_net"; abc::Abc_ObjAssignName(output_net, output_name.data(), /*pSuffix=*/nullptr); utl::UniqueName unique_namer; // We want to make sure this thing correctly maps to the multi-output sky130 // cell. cut.InsertMappedAbcNetwork( abc_network.get(), abc_library, network, unique_namer, &logger_); // Go searching for our const cell. It has a random name now. odb::dbSet insts = db_->getChip()->getBlock()->getInsts(); std::vector constant_cells; for (odb::dbInst* inst : insts) { odb::dbMaster* master = inst->getMaster(); if (std::string(master->getName()) == "sky130_fd_sc_hd__conb_1") { constant_cells.push_back(inst); } } EXPECT_EQ(constant_cells.size(), 1); EXPECT_NE(std::string(constant_cells[0]->getName()), "_403_"); } } // namespace cut