How to setup the Jet Brains IntelliJ IDEA and Jet Brains CLION IDE to code and debug StarRocks

[alberttwong]

So you want to code and debug StarRocks, here's what you need to do.

Prerequisites

For this tutorial you need to:

• Download Jet Brains IntelliJ IDEA and Jet Brains CLION IDE
• Have a VM to run StarRocks Front End in debug mode OR run this on your workstation
• Have another VM to run StarRocks Back End in debug mode
• Configure Jet Brains IntelliJ IDEA and Jet Brains CLION IDE to do remote debugging

Running StarRocks Front End in debug mode on your workstation

brew install alberttwong/thrift/[email protected]
brew install protobuf
brew install maven
brew install openjdk@11
export JAVA_HOME=xxxxx
export PYTHON=/usr/bin/python3

Personally I also install jenv and pyenv so I can switch versions. I also run jenv enable-plugin export so that my $JAVA_HOME is set correctly.

Running StarRocks Front End and/or Back End in debug mode on a remote VM

Using Ubuntu 22.04 LTS. This is similar to the tutorial on compiling StarRocks; it just has additional packages.

sudo apt update
sudo apt install gcc g++ maven openjdk-11-jdk python3 python-is-python3 unzip cmake bzip2 ccache byacc ccache flex automake libtool bison binutils-dev libiberty-dev build-essential ninja-build
export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64
cd starrocks/
./build.sh

Local StarRocks Front End Debugging

Since the frond end is a java application, just use debug it the same way as you would in any other java application.

Remote StarRocks Front End Debugging

On the Ubuntu VM, run ./start_fe.sh --debug, then use IDEA remote debug to connect it. The default port is 5005, you can change it in start_fe.sh scripts.

Debug java parameter: -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005

Remote StarRocks Back End Debugging

It is recommended to run mvn install -DskipTests first in fe folder to ensure that thrift and protobuf in the gensrc directory are compiled correctly.

Then you need to enter gensrc folder, run make clean and make commands respectively, otherwise Clion can't detect thrift's output files.

Use Clion to open be folder.

Enter Settings, add Toolchains. Add a remote server first, then setup Build Tool, C and C++ Compiler separately.

In Settings / Deployment. Change folder mappings.

In Settings / Cmake. Change Toolchain to be the remote toolchain just added. Add the following environment variables:

JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64
STARROCKS_GCC_HOME=/usr/
STARROCKS_THIRDPARTY=/root/starrocks/thirdparty

Warning: Be careful not to check Include system environment variables.

Setup is now complete. Just wait for Clion and the remote server are synchronized and the code jump will work.

To star debugging the back end, ou have to use gdb. Modify the start_backend.sh from

if [ ${RUN_BE} -eq 1 ]; then
    echo "start time: "$(date) >> $LOG_DIR/be.out
    if [ ${RUN_DAEMON} -eq 1 ]; then
        nohup ${STARROCKS_HOME}/lib/starrocks_be "$@" >> $LOG_DIR/be.out 2>&1 </dev/null &
    else
        ${STARROCKS_HOME}/lib/starrocks_be "$@" >> $LOG_DIR/be.out 2>&1 </dev/null
    fi
fi

to

if [ ${RUN_BE} -eq 1 ]; then
    echo "start time: "$(date) >> $LOG_DIR/be.out
    if [ ${RUN_DAEMON} -eq 1 ]; then
        nohup ${STARROCKS_HOME}/lib/starrocks_be "$@" >> $LOG_DIR/be.out 2>&1 </dev/null &
    else
        gdb -tui ${STARROCKS_HOME}/lib/starrocks_be
    fi
fi

Then just run ./bin/start_be.sh without any flag.

If you face the error report when debugging for lakehouse, just add handle SIGSEGV nostop noprint pass in ~/.gdbinit.