How to Debug OpenROAD?

[LD-FW]

*Hi, I'm trying to debug the mpl2 tool in OpenROAD. My OpenROAD build should be successful since I have the openroad executable, and I can run the full flow in the terminal. During my debugging attempts, I added some breakpoints in the file:

/workspace/OpenROAD-flow-scripts/tools/OpenROAD/src/mpl2/src/hier_rtlmp.cpp

These breakpoints are in lines of code that should definitely be executed. Then, in VSCode, I set up the launch.json like this:

{
"version": "0.2.0",
"configurations": [
{
"name": "Debug mpl2",
"type": "cppdbg",
"request": "launch",
"program": "/workspace/OpenROAD-flow-scripts/tools/OpenROAD/build/src/openroad",
"args": ["macro_only.tcl"],
"stopAtEntry": false,
"cwd": "/workspace/OpenROAD-flow-scripts/tools/OpenROAD/src/mpl2/test",
"environment": [],
"externalConsole": false,
"MIMode": "gdb",
"setupCommands": [
{
"description": "Enable pretty-printing for gdb",
"text": "-enable-pretty-printing",
"ignoreFailures": true
}
],
"miDebuggerPath": "/usr/bin/gdb"
}
]
}

But when I try to debug, it just runs through macro_only.tcl without stopping at the breakpoints. Here’s the macro_only.tcl file:

source "helpers.tcl"

read_lef "./Nangate45/Nangate45_tech.lef"
read_lef "./testcases/macro_only/macro_only.lef"
read_liberty "./testcases/macro_only/macro_only.lib"

read_verilog "./testcases/macro_only/macro_only.v"
link_design "macro_only"

read_def "./testcases/macro_only/macro_only.def" -floorplan_initialize

set_thread_count 1
rtl_macro_placer -report_directory results/macro_only -halo_width 4.0

set def_file [make_result_file macro_only.def]
write_def $def_file

puts "Finish!"

I want to know how to pause in the C++ code and check variables. Thank you all for your help!

[Pxx-X]

make as follow

cd OpenROAD
mkdir build_debug
cd build_debug
cmake .. -DCMAKE_BUILD_TYPE=DEBUG
#wait
make
#make  -j $thread_to_make

my lancun.json

{
    "configurations": [
    {
        "name": "(gdb) Launch",
        "type": "cppdbg",
        "request": "launch",
        "program": "/you/path/OpenROAD/build_debug/src/openroad",
        "args": [],
        "stopAtEntry": false,
        "cwd": "/you/path/OpenROAD/build_debug/src/",
        "environment": [],
        "externalConsole": false,
        "MIMode": "gdb",
        "setupCommands": [
            {
                "description": "Enable pretty-printing for gdb",
                "text": "-enable-pretty-printing",
                "ignoreFailures": true
            },
            {
                "description": "Set Disassembly Flavor to Intel",
                "text": "-gdb-set disassembly-flavor intel",
                "ignoreFailures": true
            }
        ]
    }
    ]
}

after add your breakpoints, click the triangle to debug
and you have to wait a minutes

then you can input you command to debug openroad in terminal

I just found out how to do that too, holp this help.

[LD-FW]

Thank you very much, it worked!