Merge pull request #10865 from The-OpenROAD-Project-staging/odb-test-minimal-deps

Trim odb test binary bloat: minimal deps, fixture split, debug compression

Author: maliberty

.bazelrc

@@ -111,6 +111,9 @@ build:asan --copt=-DADDRESS_SANITIZER
 build:asan --copt=-O1
 build:asan --copt=-g
 build:asan --copt=-fno-omit-frame-pointer
+# Compress the DWARF debug sections (transparent to gdb/perf/addr2line).
+build:asan --copt=-gz=zlib
+build:asan --linkopt=-gz=zlib
 build:asan --linkopt=-fsanitize=address
 # TCMalloc is incompatible with ASan: __asan_init's interceptor setup calls
 # dlsym -> malloc before TCMalloc is initialized, segfaulting at startup.
@@ -123,6 +126,9 @@ build:profile --strip=never
 build:profile --copt -g --host_copt -g
 build:profile --copt -gmlt --host_copt -gmlt
 build:profile --copt -fno-omit-frame-pointer --host_copt -fno-omit-frame-pointer
+# Compress the DWARF debug sections (transparent to gdb/perf/addr2line).
+build:profile --copt=-gz=zlib --host_copt=-gz=zlib
+build:profile --linkopt=-gz=zlib
 
 # Improve hermeticity by disallowing user envars and network access
 build --incompatible_strict_action_env

CMakeLists.txt

@@ -183,6 +183,25 @@ if (LINK_TIME_OPTIMIZATION AND NOT LTO_UNSUPPORTED_OS)
 endif()
 message(STATUS "LTO/IPO is ${LTO_STATUS}")
 
+# Compress DWARF debug sections in builds that emit debug info. This is a
+# large on-disk win for template-heavy C++ (debug info dominates these
+# binaries) and is transparent to gdb/readelf/addr2line/lldb. It is a no-op
+# for builds without -g (e.g. Release), so it is safe to apply globally.
+# Excluded on Apple platforms: Mach-O does not support -gz=zlib and AppleClang
+# (which CMAKE_CXX_COMPILER_ID matches as "Clang") would fail the build.
+# The compile flag is scoped to C/C++: -gz is a GCC/Clang host-compiler flag
+# that nvcc does not accept (it would need explicit -Xcompiler forwarding), so
+# applying it directory-wide would break CUDA (ENABLE_GPU) debug builds where
+# gpl marks GPU sources as LANGUAGE CUDA. The link flag needs no such guard:
+# linking is driven by the host C++ compiler.
+if((CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+   AND NOT APPLE)
+  set(DEBUG_CONFIG_GENEX "$<OR:$<CONFIG:Debug>,$<CONFIG:RelWithDebInfo>>")
+  add_compile_options(
+    "$<$<AND:${DEBUG_CONFIG_GENEX},$<COMPILE_LANGUAGE:CXX,C>>:-gz=zlib>")
+  add_link_options("$<${DEBUG_CONFIG_GENEX}:-gz=zlib>")
+endif()
+
 # configure a header file to pass some of the CMake settings
 configure_file(
   ${OPENROAD_HOME}/include/ord/Version.hh.cmake

src/CMakeLists.txt

@@ -255,7 +255,11 @@ if (NOT USE_SYSTEM_OPENSTA)
 endif()
 add_subdirectory(dbSta)
 add_subdirectory(rsz)
-add_subdirectory(tst)
+if(ENABLE_TESTS)
+  # tst provides gtest-based fixture libraries used only by test targets, and
+  # links GTest::gtest, which only exists when ENABLE_TESTS is on.
+  add_subdirectory(tst)
+endif()
 add_subdirectory(stt)
 add_subdirectory(gpl)
 add_subdirectory(dpl)

src/dbSta/src/CMakeLists.txt

@@ -22,7 +22,7 @@ target_include_directories(dbSta_lib
 
 target_link_libraries(dbSta_lib
   PUBLIC
-    odb
+    db
     OpenSTA
   PRIVATE
     utl_lib

src/dbSta/test/cpp/CMakeLists.txt

@@ -38,7 +38,7 @@ target_link_libraries(TestDbSta
         dpl_lib
         stt_lib
         odb
-        tst
+        tst_integrated_fixture
         ${TCL_LIBRARY}
 )
 
@@ -67,7 +67,7 @@ target_link_libraries(TestReadVerilog
         dpl_lib
         stt_lib
         odb
-        tst
+        tst_integrated_fixture
         ${TCL_LIBRARY}
 )
 
@@ -96,7 +96,7 @@ target_link_libraries(TestWriteVerilog
         dpl_lib
         stt_lib
         odb
-        tst
+        tst_integrated_fixture
         ${TCL_LIBRARY}
 )
 

src/est/test/CMakeLists.txt

@@ -26,7 +26,7 @@ target_link_libraries(TestEstimateParasitics
         dpl_lib
         stt_lib
         odb
-        tst
+        tst_integrated_fixture
         ${TCL_LIBRARY}
 )
 

src/odb/src/3dblox/CMakeLists.txt

@@ -23,6 +23,11 @@ target_link_libraries(3dblox
     utl_lib
     yaml-cpp
     OpenSTA
+  PRIVATE
+    defin
+    defout
+    lefin
+    lefout
 )
 
 target_include_directories(3dblox

src/odb/test/cpp/BUILD

@@ -47,7 +47,7 @@ cc_test(
     deps = [
         "//src/odb/src/db",
         "//src/odb/test/cpp/helper",
-        "//src/tst",
+        "//src/tst:db_fixture",
         "@googletest//:gtest",
         "@googletest//:gtest_main",
         "@spdlog",
@@ -102,7 +102,7 @@ cc_test(
         "//src/odb/src/db",
         "//src/odb/src/gdsin",
         "//src/odb/src/gdsout",
-        "//src/tst",
+        "//src/tst:db_fixture",
         "//src/utl",
         "@googletest//:gtest",
         "@googletest//:gtest_main",
@@ -235,7 +235,7 @@ cc_test(
     srcs = ["TestObjectType.cpp"],
     deps = [
         "//src/odb/src/db",
-        "//src/tst",
+        "//src/tst:db_fixture",
         "@googletest//:gtest",
         "@googletest//:gtest_main",
     ],
@@ -271,7 +271,7 @@ cc_test(
         "//src/odb/src/3dblox",
         "//src/odb/src/db",
         "//src/odb/test/cpp/helper",
-        "//src/tst",
+        "//src/tst:db_fixture",
         "@googletest//:gtest",
         "@googletest//:gtest_main",
     ],
@@ -292,7 +292,7 @@ cc_test(
     deps = [
         "//src/odb/src/3dblox",
         "//src/odb/src/db",
-        "//src/tst",
+        "//src/tst:db_fixture",
         "@googletest//:gtest",
         "@googletest//:gtest_main",
     ],
@@ -309,7 +309,7 @@ cc_test(
     deps = [
         "//src/odb/src/3dblox",
         "//src/odb/src/db",
-        "//src/tst",
+        "//src/tst:db_fixture",
         "@googletest//:gtest",
         "@googletest//:gtest_main",
     ],

src/odb/test/cpp/CMakeLists.txt

@@ -1,23 +1,11 @@
 include(openroad)
 
-set(TEST_LIBS
-        odb
-        lef
-        defin
-        defout
-        lefin
-        lefout
-        cdl
-        3dblox
-        ${TCL_LIBRARY}
-        Boost::boost
-        utl_lib
-        odb_test_helper
-        gdsin
-        tst
+# Each executable links only the libraries it actually needs to avoid bloated
+# binaries. src/odb/test/cpp/BUILD is the reference for the minimal dependency
+# set of each test. GTEST_LIBS is the one group shared by every test.
+set(GTEST_LIBS
         GTest::gtest
         GTest::gtest_main
-        GTest::gmock
 )
 
 add_executable(OdbGTests TestDbWire.cc TestDbNet.cpp TestDesignIsRouted.cpp TestAbstractLef.cc TestPolygonalFloorplan.cc)
@@ -42,27 +30,132 @@ add_executable(TestSwapMasterUnusedPort TestSwapMasterUnusedPort.cpp)
 add_executable(TestWriteReadDbHier TestWriteReadDbHier.cpp)
 add_executable(TestObjectType TestObjectType.cpp)
 
-target_link_libraries(OdbGTests ${TEST_LIBS})
-target_link_libraries(TestCallBacks ${TEST_LIBS})
-target_link_libraries(TestGeom ${TEST_LIBS})
-target_link_libraries(TestModule ${TEST_LIBS})
-target_link_libraries(TestLef58Properties ${TEST_LIBS})
-target_link_libraries(TestGroup ${TEST_LIBS})
-target_link_libraries(TestGCellGrid ${TEST_LIBS})
-target_link_libraries(TestJournal ${TEST_LIBS})
-target_link_libraries(TestAccessPoint ${TEST_LIBS})
-target_link_libraries(TestGuide ${TEST_LIBS})
-target_link_libraries(TestNetTrack ${TEST_LIBS})
-target_link_libraries(TestMaster ${TEST_LIBS})
-target_link_libraries(TestGDSIn ${TEST_LIBS})
-target_link_libraries(TestChips ${TEST_LIBS})
-target_link_libraries(Test3DBloxParser ${TEST_LIBS})
-target_link_libraries(Test3DBloxChecker ${TEST_LIBS})
-target_link_libraries(Test3DBloxVerilogWriter ${TEST_LIBS})
-target_link_libraries(TestSwapMaster ${TEST_LIBS})
-target_link_libraries(TestSwapMasterUnusedPort ${TEST_LIBS})
-target_link_libraries(TestWriteReadDbHier ${TEST_LIBS})
-target_link_libraries(TestObjectType ${TEST_LIBS})
+target_link_libraries(OdbGTests
+        db
+        defin
+        lefin
+        lefout
+        OpenSTA
+        tst
+        utl_lib
+        GTest::gmock
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestCallBacks
+        db
+        odb_test_helper
+        tst_base
+        spdlog::spdlog
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestGeom
+        db
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestModule
+        db
+        odb_test_helper
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestLef58Properties
+        db
+        defin
+        defout
+        lefin
+        lefout
+        tst
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestGroup
+        db
+        odb_test_helper
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestGCellGrid
+        db
+        odb_test_helper
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestJournal
+        db
+        odb_test_helper
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestAccessPoint
+        db
+        odb_test_helper
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestGuide
+        db
+        odb_test_helper
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestNetTrack
+        db
+        odb_test_helper
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestMaster
+        db
+        odb_test_helper
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestGDSIn
+        db
+        gdsin
+        gdsout
+        tst_base
+        utl_lib
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestChips
+        db
+        odb_test_helper
+        ${GTEST_LIBS}
+)
+target_link_libraries(Test3DBloxParser
+        3dblox
+        db
+        odb_test_helper
+        tst_base
+        ${GTEST_LIBS}
+)
+target_link_libraries(Test3DBloxChecker
+        3dblox
+        db
+        tst_base
+        ${GTEST_LIBS}
+)
+target_link_libraries(Test3DBloxVerilogWriter
+        3dblox
+        db
+        tst_base
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestSwapMaster
+        db
+        dbSta_lib
+        tst
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestSwapMasterUnusedPort
+        db
+        dbSta_lib
+        tst
+        utl_lib
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestWriteReadDbHier
+        db
+        tst_integrated_fixture
+        ${GTEST_LIBS}
+)
+target_link_libraries(TestObjectType
+        db
+        tst_base
+        ${GTEST_LIBS}
+)
 
 # Skip the tests from being registered here, since they are called via
 # cpp_tests.tcl and don't need to be executed twice. The cpp_tests.tcl

src/odb/test/cpp/Test3DBloxCheckerFixture.h

@@ -9,10 +9,10 @@
 #include "odb/db.h"
 #include "odb/dbWireCodec.h"
 #include "odb/geom.h"
-#include "tst/fixture.h"
+#include "tst/db_fixture.h"
 
 namespace odb {
-class CheckerFixture : public tst::Fixture
+class CheckerFixture : public tst::DbFixture
 {
  protected:
   CheckerFixture()