How do I invoke ./build_openroad.sh to get debug information?

[oharboe]

I would like to do a local build with ./build_openroad.sh to run perf.

For this I'd like to have optimized code with debug information (line numbers).

Obviously line numbers with debug information isn't particularly precise, but then again, if I compile without debug information and line numbers the performance information is inaccurate.

[maliberty]

Fwiw I like vtune for profiling.

[oharboe]

I've used vtune in the past. Nice tool! It has a level of precision that's not necessary here(such as analyzing AVX code, etc.). perf is very convenient: free and available on all Linux installations.

They both need debug information...

[maliberty]

vtune is free (ie gratis not OSS).

[oharboe]

cd OpenROAD-flow-scripts
./build.sh --local
cd tools/OpenROAD
./etc/Build.sh -cmake="-DCMAKE_BUILD_TYPE=DEBUG -DCMAKE_INSTALL_PREFIX=`pwd`/install/OpenROAD"
cd build
make install

Then set up paths:

cd OpenROAD-flow-scripts
export PATH=`pwd`/tools/install/OpenROAD/bin:`pwd`/tools/install/yosys/bin:$PATH

On Ubuntu 22, I ran apt-get install klayout, but it crashes...

ERROR: Signal number: 11
Address: 0x8
Program Version: KLayout 0.26.2 (2022-01-13 rLatestSourcePackage)

Backtrace:
/usr/lib/klayout/libklayout_lay.so.0 +0x24b786 lay::SaltDownloadManager::execute(lay::SaltManagerDialog*, lay::Salt&) [??:?]
/lib/x86_64-linux-gnu/libc.so.6 +0x42520 __restore_rt [libc_sigaction.c:?]
/lib/x86_64-linux-gnu/libruby-3.0.so.3.0 +0xbf639 rb_obj_info_dump_loc [??:?]
/usr/lib/klayout/libklayout_rba.so.0 +0x43782 tl::Variant rba::ruby2c<tl::Variant>(unsigned long) [??:?]
/usr/lib/klayout/libklayout_rba.so.0 +0x47ce2 unsigned long rba::c2ruby<tl::Variant>(tl::Variant const&) [??:?]
/usr/lib/klayout/libklayout_rba.so.0 +0x2a78d rba::RubyInterpreter::load_file(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)

Also, I don't think the debug build worked, I don't get line numbers:

Signal 11 received
Stack trace:
 0# 0x000055B72FBF957B in /home/oyvind/ascenium/OpenROAD-flow-scripts/tools/install/OpenROAD/bin/openroad
 1# 0x00007F9031A52520 in /lib/x86_64-linux-gnu/libc.so.6
 2# odb::dbTechLayer::getName[abi:cxx11]() const in /home/oyvind/ascenium/OpenROAD-flow-scripts/tools/install/OpenROAD/bin/openroad
 3# ppl::HungarianMatching::assignMirroredPins(ppl::IOPin&, std::unordered_map<odb::dbBTerm*, odb::dbBTerm*, std::hash<odb::dbBTerm*>, std::equal_to<odb::dbBTerm*>, std::allocator<std::pair<odb::dbBTerm* const, odb::dbBTerm*> > >&, std::vector<ppl::IOPin, std::allocator<ppl::IOPin> >&) in /home/oyvind/ascenium/OpenROAD-flow-scripts/tools/install/OpenROAD/bin/openroad
 4# ppl::HungarianMatching::getFinalAssignment(std::vector<ppl::IOPin, std::allocator<ppl::IOPin> >&, std::unordered_map<odb::dbBTerm*, odb::dbBTerm*, std::hash<odb::dbBTerm*>, std::equal_to<odb::dbBTerm*>, std::allocator<std::pair<odb::dbBTerm* const, odb::dbBTerm*> > >&, bool) in /home/oyvind/ascenium/OpenROAD-flow-scripts/tools/install/OpenROAD/bin/openroad
 5# ppl::IOPlacer::findPinAssignment(std::vector<ppl::Section, std::allocator<ppl::Section> >&) in /home/oyvind/ascenium/OpenROAD-flow-scripts/tools/install/OpenROAD/bin/openroad
 6# ppl::IOPlacer::run(bool) in /home/oyvind/ascenium/OpenROAD-flow-scripts/tools/install/OpenROAD/bin/openroad
 7# 0x000055B72FD9DD37 in /home/oyvind/ascenium/OpenROAD-flow-scripts/tools/install/OpenROAD/bin/openroad
 8# TclNRRunCallbacks in /lib/x86_64-linux-gnu/libtcl8.6.so
 9# 0x00007F90358EB028 in /lib/x86_64-linux-gnu/libtcl8.6.so
10# Tcl_EvalEx in /lib/x86_64-linux-gnu/libtcl8.6.so
11# Tcl_Eval in /lib/x86_64-linux-gnu/libtcl8.6.so
12# sta::sourceTclFile(char const*, bool, bool, Tcl_Interp*) in /home/oyvind/ascenium/OpenROAD-flow-scripts/tools/install/OpenROAD/bin/openroad
13# ord::tclAppInit(Tcl_Interp*) in /home/oyvind/ascenium/OpenROAD-flow-scripts/tools/install/OpenROAD/bin/openroad
14# Tcl_MainEx in /lib/x86_64-linux-gnu/libtcl8.6.so
15# main in /home/oyvind/ascenium/OpenROAD-flow-scripts/tools/install/OpenROAD/bin/openroad
16# 0x00007F9031A39D90 in /lib/x86_64-linux-gnu/libc.so.6
17# __libc_start_main in /lib/x86_64-linux-gnu/libc.so.6
18# _start in /home/oyvind/ascenium/OpenROAD-flow-scripts/tools/install/OpenROAD/bin/openroad
Command terminated by signal 11
Elapsed time: 0:01.35[h:]min:sec. CPU time: user 1.23 sys 0.04 (94%). Peak memory: 193332KB.
make: *** [Makefile:500: results/asap7/ce-array_ALUCE/base/3_2_place_iop.odb] Error 139

[oharboe]

I know I built and installed correctly, because I was able to find and fix this problem: The-OpenROAD-Project/OpenROAD#3100

[maliberty]

It looks like boost backtrrace doesn't show line numbers by default. Perhaps we could set BOOST_STACKTRACE_USE_BACKTRACE but we would need to add libbacktrace as a dependency.