Using each tools (i.e. OpenDB, RePlAce, OpenDP..) as a submodule #3033

ApeachM · 2023-03-18T11:26:42Z

ApeachM
Mar 18, 2023

Now I'd like to use OpenDB Framework and am searching for how to use each tool (i.e. OpenDB, OpenDB, etc) in the OpenROAD repository as a submodule for my open-source project.

For example, I'm using the OpenDB Framework as this repository.
In that repository, I only can know how to use the legacy one as a submodule, but couldn't find how to set the OpenROAD repository as a submodule.

I would be very appreciative if there is any recommended way to use each tool (like RePlAce, OpenDP, ..) in the OpenROAD repository which is now updated recently, and if you let me know them.

Thank you for reading my question.

Best regards.

Answered by maliberty

Mar 29, 2023

@QuantamHD what do you think about applying your library separation work to mpl2?

View full answer

maliberty · 2023-03-18T14:57:30Z

maliberty
Mar 18, 2023
Maintainer

We do not offer each tool as a submodule. It is a lot of overhead to manage submodules (we did that initially). You could make OR itself a submodule and link to the portions you wish.

1 reply

ApeachM Mar 18, 2023
Author

Thanks for your kind reply. Sorry for my ambiguous question.

Actually, I didn't want that each tool offered as a submodule.

But what you mentioned is the exact way that I tried; "Make OR itself a submodule and link to the portions.",
but I don't know how to link tools in that condition.

In other words, I am now straying about how to link OpenDB (or other tools like RePlAce) using CMake file, in the condition of making OR itself a submodule.

If you let me know simple hints or any solution that already exists, then I would very much appreciate you.

Thank you for reading my question.
Sincerely yours.

maliberty · 2023-03-18T21:08:56Z

maliberty
Mar 18, 2023
Maintainer

You should be able to reference our libraries from your app like

target_link_libraries(
PUBLIC
odb
)

you would need to include src/CMakeLists.txt

1 reply

ApeachM Mar 29, 2023
Author

Thanks! It really works well. I very much appreciate your kind instruction.

I have one more question about this.
Your instruction works well if I link only odb target.

But I want to use not only odb, but also mpl2 for my project.
If I add the link for mpl2, then the building is failed with the below message.

...
[ 93%] Building CXX object CMakeFiles/placer.dir/src/algorithm/normalPlace.cpp.o
[ 93%] Building CXX object CMakeFiles/placer.dir/src/algorithm/InitialPlacer.cpp.o
[100%] Building CXX object CMakeFiles/placer.dir/src/algorithm/NesterovPlacer.cpp.o
[100%] Building CXX object CMakeFiles/placer.dir/src/tool/fft.cpp.o
[100%] Building CXX object CMakeFiles/placer.dir/src/tool/fftsg.cpp.o
[100%] Building CXX object CMakeFiles/placer.dir/src/tool/fftsg2d.cpp.o
[100%] Building CXX object CMakeFiles/placer.dir/src/etc/dbTutorial.cpp.o
[100%] Linking CXX executable placer
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbSta.cc.o): in function `ord::initDbSta(ord::OpenRoad*)':
/home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/dbSta/src/dbSta.cc:88: undefined reference to `ord::OpenRoad::addObserver(ord::OpenRoad::Observer*)'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbSta.cc.o): in function `sta::dbSta::~dbSta()':
/home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/dbSta/src/dbSta.cc:230: undefined reference to `ord::OpenRoad::Observer::~Observer()'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbSta.cc.o): in function `ord::OpenRoad::Observer::Observer()':
/home/csdl/tmp/tmp.RyDNCP79ef/submodule/include/ord/OpenRoad.hh:240: undefined reference to `vtable for ord::OpenRoad::Observer'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbSta.cc.o):(.data.rel.ro._ZTIN3sta5dbStaE[_ZTIN3sta5dbStaE]+0x28): undefined reference to `typeinfo for ord::OpenRoad::Observer'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o): in function `make_block_sta(odb::dbBlock*)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7297: undefined reference to `ord::getOpenRoad()'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o): in function `find_logic_constants()':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7305: undefined reference to `ord::getOpenRoad()'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o): in function `highlight_path_cmd(sta::PathRef*)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7313: undefined reference to `ord::getOpenRoad()'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o): in function `find_all_clk_nets()':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7321: undefined reference to `ord::getOpenRoad()'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o): in function `find_clk_nets(sta::Clock const*)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7331: undefined reference to `ord::getOpenRoad()'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o):/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7341: more undefined references to `ord::getOpenRoad()' follow
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o): in function `sta_to_db_inst(sta::Instance*)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7342: undefined reference to `ord::OpenRoad::getDbNetwork()'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o): in function `sta_to_db_mterm(sta::LibertyPort*)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7355: undefined reference to `ord::getOpenRoad()'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7356: undefined reference to `ord::OpenRoad::getDbNetwork()'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o): in function `sta_to_db_port(sta::Port*)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7363: undefined reference to `ord::getOpenRoad()'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7364: undefined reference to `ord::OpenRoad::getDbNetwork()'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o): in function `sta_to_db_pin(sta::Pin*)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7375: undefined reference to `ord::getOpenRoad()'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7376: undefined reference to `ord::OpenRoad::getDbNetwork()'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o): in function `sta_to_db_net(sta::Net*)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7386: undefined reference to `ord::getOpenRoad()'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7387: undefined reference to `ord::OpenRoad::getDbNetwork()'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o): in function `sta_to_db_master(sta::LibertyCell*)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7394: undefined reference to `ord::getOpenRoad()'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7395: undefined reference to `ord::OpenRoad::getDbNetwork()'
/usr/bin/ld: submodule/src/dbSta/src/dbSta.a(dbStaTCL_wrap.cxx.o): in function `db_network_defined()':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7402: undefined reference to `ord::getOpenRoad()'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/dbSta/src/CMakeFiles/dbSta.dir/dbStaTCL_wrap.cxx:7403: undefined reference to `ord::OpenRoad::getDbNetwork()'
/usr/bin/ld: submodule/src/gui/gui.a(guiTCL_wrap.cxx.o): in function `check_gui(char const*)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/gui/CMakeFiles/gui.dir/guiTCL_wrap.cxx:1773: undefined reference to `ord::OpenRoad::openRoad()'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/gui/CMakeFiles/gui.dir/guiTCL_wrap.cxx:1779: undefined reference to `ord::OpenRoad::openRoad()'
/usr/bin/ld: submodule/src/gui/gui.a(guiTCL_wrap.cxx.o): in function `get_block()':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/gui/CMakeFiles/gui.dir/guiTCL_wrap.cxx:1789: undefined reference to `ord::OpenRoad::openRoad()'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/gui/CMakeFiles/gui.dir/guiTCL_wrap.cxx:1790: undefined reference to `ord::OpenRoad::openRoad()'
/usr/bin/ld: submodule/src/gui/gui.a(guiTCL_wrap.cxx.o): in function `design_created()':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/gui/CMakeFiles/gui.dir/guiTCL_wrap.cxx:2129: undefined reference to `ord::OpenRoad::openRoad()'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/gui/CMakeFiles/gui.dir/guiTCL_wrap.cxx:2129: undefined reference to `ord::OpenRoad::designCreated()'
/usr/bin/ld: submodule/src/gui/gui.a(guiTCL_wrap.cxx.o): in function `set_display_controls(char const*, char const*, bool)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/gui/CMakeFiles/gui.dir/guiTCL_wrap.cxx:2201: undefined reference to `ord::OpenRoad::openRoad()'
/usr/bin/ld: submodule/src/gui/gui.a(guiTCL_wrap.cxx.o): in function `check_display_controls(char const*, char const*)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/gui/CMakeFiles/gui.dir/guiTCL_wrap.cxx:2224: undefined reference to `ord::OpenRoad::openRoad()'
/usr/bin/ld: submodule/src/gui/gui.a(guiTCL_wrap.cxx.o): in function `get_selection_property(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)':
/home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/gui/CMakeFiles/gui.dir/guiTCL_wrap.cxx:2361: undefined reference to `ord::OpenRoad::openRoad()'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/cmake-build-debug/submodule/src/gui/CMakeFiles/gui.dir/guiTCL_wrap.cxx:2367: undefined reference to `ord::OpenRoad::openRoad()'
/usr/bin/ld: submodule/src/gui/gui.a(gui.cpp.o): in function `gui::message_handler(QtMsgType, QMessageLogContext const&, QString const&)':
/home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/gui/src/gui.cpp:69: undefined reference to `ord::OpenRoad::openRoad()'
/usr/bin/ld: submodule/src/gui/gui.a(gui.cpp.o): in function `gui::Gui::showGui(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, bool)':
/home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/gui/src/gui.cpp:1100: undefined reference to `cmd_argv'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/gui/src/gui.cpp:1100: undefined reference to `cmd_argc'
/usr/bin/ld: submodule/src/gui/gui.a(gui.cpp.o): in function `gui::startGui(int&, char**, Tcl_Interp*, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, bool)':
/home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/gui/src/gui.cpp:1136: undefined reference to `ord::OpenRoad::openRoad()'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/gui/src/gui.cpp:1141: undefined reference to `ord::OpenRoad::addObserver(ord::OpenRoad::Observer*)'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/gui/src/gui.cpp:1237: undefined reference to `ord::OpenRoad::removeObserver(ord::OpenRoad::Observer*)'
/usr/bin/ld: submodule/src/gui/gui.a(mocs_compilation.cpp.o):(.data.rel.ro._ZTIN3gui10MainWindowE[_ZTIN3gui10MainWindowE]+0x28): undefined reference to `typeinfo for ord::OpenRoad::Observer'
/usr/bin/ld: submodule/src/gui/gui.a(mainWindow.cpp.o): in function `gui::MainWindow::MainWindow(QWidget*)':
/home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/gui/src/mainWindow.cpp:104: undefined reference to `ord::OpenRoad::Observer::~Observer()'
/usr/bin/ld: submodule/src/gui/gui.a(mainWindow.cpp.o): in function `gui::MainWindow::~MainWindow()':
/home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/gui/src/mainWindow.cpp:401: undefined reference to `ord::OpenRoad::Observer::~Observer()'
/usr/bin/ld: submodule/src/gui/gui.a(mainWindow.cpp.o): in function `gui::MainWindow::openDesign()':
/home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/gui/src/mainWindow.cpp:1485: undefined reference to `ord::OpenRoad::openRoad()'
/usr/bin/ld: /home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/gui/src/mainWindow.cpp:1485: undefined reference to `ord::OpenRoad::readDb(char const*)'
/usr/bin/ld: submodule/src/gui/gui.a(tclCmdInputWidget.cpp.o): in function `gui::TclCmdInputWidget::setTclInterp(Tcl_Interp*, bool, std::function<void ()> const&)':
/home/csdl/tmp/tmp.RyDNCP79ef/submodule/src/gui/src/tclCmdInputWidget.cpp:111: undefined reference to `ord::tclAppInit(Tcl_Interp*)'
collect2: error: ld returned 1 exit status
make[3]: *** [CMakeFiles/placer.dir/build.make:480: placer] Error 1
make[2]: *** [CMakeFiles/Makefile2:1602: CMakeFiles/placer.dir/all] Error 2
make[1]: *** [CMakeFiles/Makefile2:1609: CMakeFiles/placer.dir/rule] Error 2
make: *** [Makefile:164: placer] Error 2

The CMakeFile what I made follows below.

cmake_minimum_required(VERSION 3.16)
project(3D-Placement)

set(CMAKE_CXX_STANDARD 17)
set(SOURCES
        src/main.cpp

        src/circuit/Chip.cpp
        src/circuit/Parser.cpp

        src/dataStructures/Die.cpp
        src/dataStructures/Instance.cpp
        src/dataStructures/Net.cpp
        src/dataStructures/Pin.cpp
        src/dataStructures/Bin.cpp

        src/algorithm/do3DPlace.cpp
        src/algorithm/normalPlace.cpp
        src/algorithm/InitialPlacer.cpp
        src/algorithm/NesterovPlacer.cpp

        src/tool/fft.cpp
        src/tool/fftsg.cpp
        src/tool/fftsg2d.cpp

        src/etc/dbTutorial.cpp
        )

set(INCLUDE_DIRS
        ${PROJECT_SOURCE_DIR}/include/algorithm
        ${PROJECT_SOURCE_DIR}/include/circuit
        ${PROJECT_SOURCE_DIR}/include/dataStructures
        ${PROJECT_SOURCE_DIR}/include/tool
        )

add_executable(placer ${SOURCES})
target_include_directories(placer PRIVATE ${INCLUDE_DIRS})

find_package(Eigen3 REQUIRED)
add_subdirectory(submodule)
target_link_libraries(placer
        PUBLIC
        odb
        mpl2
        Eigen3::Eigen
        )

If I delete the one line for mpl2 in the CMakeFile like below, then the building is not failed.

...
target_link_libraries(placer
        PUBLIC
        odb
        Eigen3::Eigen
        )

I’m very stuck in this situation, so if you give me any help that you know or any hint you can assume, then I’ll be very appreciative of you.

Thank you for reading my question.

Sincerely yours.

maliberty · 2023-03-29T05:32:34Z

maliberty
Mar 29, 2023
Maintainer

@QuantamHD what do you think about applying your library separation work to mpl2?

14 replies

QuantamHD Mar 30, 2023
Collaborator

Ah it looks like the OpenSTA submodule is out of date in your repo. If you run cd src/sta && git fetch && git checkout 882681a it should resolve the issues

maliberty Mar 30, 2023
Maintainer

git submodule update will fix it

ApeachM Mar 30, 2023
Author

I think it doesn't work..
The example repository is on here. I reproduced the problem in this repository.

If you can afford to do it, could you check it out with the below command?

git clone --recursive https://github.com/ApeachM/openROAD-embedding.git
cd openROAD-embedding
git submodule update --force --recursive --init --remote
cd submodule/OpenROAD/
git fetch
git checkout -b mpl2_library origin/mpl2_library
cd ../../

mkdir build
cd build
cmake ..
make -j openroad-embedding
./openroad-embedding

The building failing message of the above repository is below.

...
[ 92%] Building CXX object submodule/OpenROAD/src/odb/src/defin/CMakeFiles/defin.dir/definPropDefs.cpp.o
[ 92%] Building CXX object submodule/OpenROAD/src/odb/src/lefin/CMakeFiles/lefin.dir/lefMacroClassParser.cpp.o
[ 92%] Building CXX object submodule/OpenROAD/src/odb/src/lefin/CMakeFiles/lefin.dir/ArraySpacingParser.cpp.o
[ 92%] Building CXX object submodule/OpenROAD/src/odb/src/lefin/CMakeFiles/lefin.dir/WidthTableParser.cpp.o
[ 92%] Building CXX object submodule/OpenROAD/src/odb/src/lefin/CMakeFiles/lefin.dir/MetalWidthViaMapParser.cpp.o
[ 92%] Building CXX object submodule/OpenROAD/src/odb/src/lefin/CMakeFiles/lefin.dir/MinCutParser.cpp.o
[ 92%] Linking CXX static library libdefin.a
/usr/bin/ar qc libdefin.a CMakeFiles/defin.dir/definNet.cpp.o CMakeFiles/defin.dir/definSNet.cpp.o CMakeFiles/defin.dir/definComponent.cpp.o CMakeFiles/defin.dir/definVia.cpp.o CMakeFiles/defin.dir/definPin.cpp.o CMakeFiles/defin.dir/definBlockage.cpp.o CMakeFiles/defin.dir/definFill.cpp.o CMakeFiles/defin.dir/definTracks.cpp.o CMakeFiles/defin.dir/definGCell.cpp.o CMakeFiles/defin.dir/definRow.cpp.o CMakeFiles/defin.dir/definRegion.cpp.o CMakeFiles/defin.dir/definGroup.cpp.o CMakeFiles/defin.dir/definNonDefaultRule.cpp.o CMakeFiles/defin.dir/definReader.cpp.o CMakeFiles/defin.dir/definBase.cpp.o CMakeFiles/defin.dir/create_box.cpp.o CMakeFiles/defin.dir/defin.cpp.o CMakeFiles/defin.dir/definPolygon.cpp.o CMakeFiles/defin.dir/definPropDefs.cpp.o CMakeFiles/defin.dir/definPinProps.cpp.o
/usr/bin/ranlib libdefin.a
[ 92%] Built target defin
[ 92%] Linking CXX static library libcdl.a
/usr/bin/ar qc libcdl.a CMakeFiles/cdl.dir/cdl.cpp.o
/usr/bin/ranlib libcdl.a
[ 92%] Built target cdl
[ 92%] Linking CXX static library liblefin.a
/usr/bin/ar qc liblefin.a CMakeFiles/lefin.dir/lefin.cpp.o CMakeFiles/lefin.dir/reader.cpp.o CMakeFiles/lefin.dir/lefTechLayerSpacingEolParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerMinStepParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerCornerSpacingParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerSpacingTablePrlParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerRightWayOnGridOnlyParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerRectOnlyParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerCutClassParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerCutSpacingParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerCutSpacingTableParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerCutEnclosureParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerTypeParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerEolExtensionParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerEolKeepOutRuleParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerAreaRuleParser.cpp.o CMakeFiles/lefin.dir/lefTechLayerPitchRuleParser.cpp.o CMakeFiles/lefin.dir/lefMacroClassParser.cpp.o CMakeFiles/lefin.dir/ArraySpacingParser.cpp.o CMakeFiles/lefin.dir/WidthTableParser.cpp.o CMakeFiles/lefin.dir/MinCutParser.cpp.o CMakeFiles/lefin.dir/MetalWidthViaMapParser.cpp.o
/usr/bin/ranlib liblefin.a
[ 92%] Built target lefin
[ 92%] Building CXX object submodule/OpenROAD/src/dbSta/src/CMakeFiles/dbSta_lib.dir/dbNetwork.cc.o
[ 92%] Building CXX object submodule/OpenROAD/src/dbSta/src/CMakeFiles/dbSta_lib.dir/dbSdcNetwork.cc.o
[ 92%] Building CXX object submodule/OpenROAD/src/dbSta/src/CMakeFiles/dbSta_lib.dir/dbReadVerilog.cc.o
/home/csdl/tmp/test/openROAD-embedding/submodule/OpenROAD/src/dbSta/src/dbSdcNetwork.cc: In member function ‘virtual sta::InstanceSeq sta::dbSdcNetwork::findInstancesMatching(const sta::Instance*, const sta::PatternMatch*) const’:
/home/csdl/tmp/test/openROAD-embedding/submodule/OpenROAD/src/dbSta/src/dbSdcNetwork.cc:78:40: error: cannot convert ‘std::string’ {aka ‘std::__cxx11::basic_string<char>’} to ‘const char*’ in initialization
   78 |       const char* escaped = escapeChars(pattern->pattern(), divider_, '\0', escape_);
      |                             ~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      |                                        |
      |                                        std::string {aka std::__cxx11::basic_string<char>}
/home/csdl/tmp/test/openROAD-embedding/submodule/OpenROAD/src/dbSta/src/dbSdcNetwork.cc: In member function ‘virtual sta::NetSeq sta::dbSdcNetwork::findNetsMatching(const sta::Instance*, const sta::PatternMatch*) const’:
/home/csdl/tmp/test/openROAD-embedding/submodule/OpenROAD/src/dbSta/src/dbSdcNetwork.cc:117:40: error: cannot convert ‘std::string’ {aka ‘std::__cxx11::basic_string<char>’} to ‘const char*’ in initialization
  117 |       const char* escaped = escapeChars(pattern->pattern(), divider_, '\0', escape_);
      |                             ~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      |                                        |
      |                                        std::string {aka std::__cxx11::basic_string<char>}
/home/csdl/tmp/test/openROAD-embedding/submodule/OpenROAD/src/dbSta/src/dbSdcNetwork.cc: In function ‘const char* sta::escapeDividers(const char*, const sta::Network*)’:
/home/csdl/tmp/test/openROAD-embedding/submodule/OpenROAD/src/dbSta/src/dbSdcNetwork.cc:239:21: error: cannot convert ‘std::string’ {aka ‘std::__cxx11::basic_string<char>’} to ‘const char*’ in return
  239 |   return escapeChars(
      |          ~~~~~~~~~~~^
      |                     |
      |                     std::string {aka std::__cxx11::basic_string<char>}
  240 |       token,
      |       ~~~~~~         
  241 |       network->pathDivider(),
      |       ~~~~~~~~~~~~~~~~~~~~~~~
  242 |       '\0',
      |       ~~~~~          
  243 |       network->pathEscape());
      |       ~~~~~~~~~~~~~~~~~~~~~~
/home/csdl/tmp/test/openROAD-embedding/submodule/OpenROAD/src/dbSta/src/dbSdcNetwork.cc: In function ‘const char* sta::escapeBrackets(const char*, const sta::Network*)’:
/home/csdl/tmp/test/openROAD-embedding/submodule/OpenROAD/src/dbSta/src/dbSdcNetwork.cc:249:21: error: cannot convert ‘std::string’ {aka ‘std::__cxx11::basic_string<char>’} to ‘const char*’ in return
  249 |   return escapeChars(token, '[', ']', network->pathEscape());
      |          ~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      |                     |
      |                     std::string {aka std::__cxx11::basic_string<char>}
make[3]: *** [submodule/OpenROAD/src/dbSta/src/CMakeFiles/dbSta_lib.dir/build.make:93: submodule/OpenROAD/src/dbSta/src/CMakeFiles/dbSta_lib.dir/dbSdcNetwork.cc.o] Error 1
make[3]: *** Waiting for unfinished jobs....
make[2]: *** [CMakeFiles/Makefile2:3060: submodule/OpenROAD/src/dbSta/src/CMakeFiles/dbSta_lib.dir/all] Error 2
make[1]: *** [CMakeFiles/Makefile2:1417: CMakeFiles/openroad-embedding.dir/rule] Error 2
make: *** [Makefile:169: openroad-embedding] Error 2

Sincerely yours.

maliberty Mar 30, 2023
Maintainer

If you are working on a branch you may need to merge master into your branch. The problems clearly relate to having the sta submodule out of sync with OR.

ApeachM Mar 31, 2023
Author

Thanks for answering my question.
OK. Then it might seem to be fine for me to test when the PR is accepted.
(I wanna also help to review that PR together, but actually, I'm busy with my other schedules now...)
If there's a problem even after that, then I'll contact you again through this.

Thank you, everyone!
(I'll start to make the unit tests after my other schedule is finished.)

ApeachM · 2023-04-17T06:25:48Z

ApeachM
Apr 17, 2023
Author

@QuantamHD

@ApeachM I'll ask you for a favor back. If you do end up running mpl2 in your project can you contribute some C++ unit tests back to the project? https://github.com/The-OpenROAD-Project/OpenROAD/pull/3109/files#diff-24b9bab7be8fe0944c3ae7ccbd1d8700449a2e965d33d624fd7f8e3315ebdc9e

I'd like to do the favor that you mentioned, but I have a question for you.
Now I'm struggling to construct the unit test for mpl2, but there are several problems with making it.

1. The construction dependency exists.

At least calling void MacroPlacer2::init(sta::dbNetwork* network, odb::dbDatabase* db, sta::dbSta* sta, utl::Logger* logger, par::PartitionMgr* tritonpart) function, I need sta::dbNetwork and sta::dbSta in the test code like below.

#include <unistd.h>

#include <memory>

#include "gtest/gtest.h"
#include "mpl2/rtl_mp.h"
#include "db_sta/dbSta.hh"
#include "par/PartitionMgr.h"
#include "utl/Logger.h"

namespace mpl2 {

TEST(Mpl2, CanConstruct)
{
  MacroPlacer2();
}

TEST(Mpl2, init){
  MacroPlacer2 macro_placer_2{};

  sta::dbSta* db_sta = new sta::dbSta;
  sta::dbNetwork* db_network = db_sta->getDbNetwork();
  odb::dbDatabase* db_database = odb::dbDatabase::create();
  utl::Logger logger;
  par::PartitionMgr partition_mgr;

  /**
   * Construct some data in dbDatabase and dbSta by parsing or calling their methods..
   * */
  partition_mgr.init(db_database, db_network, db_sta, &logger);
  macro_placer_2.init(db_network, db_database, db_sta, &logger, &partition_mgr);
}
};  // namespace mpl2

But at line 21: sta::dbSta* db_sta = new sta::dbSta; an error occurs with the below message.

OpenROAD/src/mpl2/test/cpp/mpl2_test.cc:21: undefined reference to `sta::dbSta::dbSta()'

I think this problem is due to a linking issue; dbSta_lib library doesn’t link dbSta.cc, but links only dbSta.hh.

The DbSta.cc file is dependent on ord::OpenRoad::Observer::Observer(), so it’s a pretty tricky thing to link with mpl2_test library and sta::dbSta.

Is there any proposed method to use sta::dbSta in the OpenROAD/src/mpl2/test/cpp/mpl2_test.cc file? Unless, I think I can’t make unit test for the one after mpl2.init(sta::dbNetwork, ..., utl::Logger).

2. Unless editing code in mpl2/src/*.cpp, there aren’t many things to make unit test.

For making the unit test for MacroPlacer2, I can only call Constructor, Destructor, init(), and place().

Even though the assumption of linking the mpl2_test library and hier_rtlmp.h, hier_rtlmp.cpp, the HierRTLMP has public functions only for setters (setGlobalFence, …,setDebug) and the top interface (hierRTLMacroPlacer()).

To test whether the HierRTLMP is properly working, I think I need to make some accessors to private variables (like getGlobalFence …). But I can’t assure you that it’s okay for me to edit the codes in mpl2/src/*.cpp.

Conclusion

If the first problem is solved, the second problem says there are not so many things to make unit test unless I edit the codes.

I’d like to ask how I can solve problem 1 (the linking issue for sta::dbSta), and whether it’s okay or not to edit the code except the test code.

Thank you for reading my questions.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Using each tools (i.e. OpenDB, RePlAce, OpenDP..) as a submodule #3033

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 4 comments 16 replies

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Select a reply

Using each tools (i.e. OpenDB, RePlAce, OpenDP..) as a submodule #3033

ApeachM Mar 18, 2023

Replies: 4 comments · 16 replies

maliberty Mar 18, 2023 Maintainer

ApeachM Mar 18, 2023 Author

maliberty Mar 18, 2023 Maintainer

ApeachM Mar 29, 2023 Author

maliberty Mar 29, 2023 Maintainer

QuantamHD Mar 30, 2023 Collaborator

maliberty Mar 30, 2023 Maintainer

ApeachM Mar 30, 2023 Author

maliberty Mar 30, 2023 Maintainer

ApeachM Mar 31, 2023 Author

ApeachM Apr 17, 2023 Author

1. The construction dependency exists.

2. Unless editing code in mpl2/src/*.cpp, there aren’t many things to make unit test.

Conclusion

ApeachM
Mar 18, 2023

Replies: 4 comments 16 replies

maliberty
Mar 18, 2023
Maintainer

ApeachM Mar 18, 2023
Author

maliberty
Mar 18, 2023
Maintainer

ApeachM Mar 29, 2023
Author

maliberty
Mar 29, 2023
Maintainer

QuantamHD Mar 30, 2023
Collaborator

maliberty Mar 30, 2023
Maintainer

ApeachM Mar 30, 2023
Author

maliberty Mar 30, 2023
Maintainer

ApeachM Mar 31, 2023
Author

ApeachM
Apr 17, 2023
Author