Cross-compiling Raspberry Pi and building a remote debugging development environment with VS Code

About this article

Previously, in this article (https://qiita.com/take-iwiw/items/46119bb7d41c6030d34f), I easily built a C / C ++ development environment for Raspberry Pi. At this time, all build and debug was done on Raspberry Pi.

This time, I will describe cross-compilation on Ubuntu and remote debugging method using gdbserver. Finally, you will be able to debug the Raspberry Pi by GUI operation from VS Code on the host PC. Debugging is now possible from both Ubuntu and Windows.

Although this article targets Raspberry Pi, I think it can also be applied to general embedded Linux cross-development.

environment

Cross-compile (on Ubuntu)

Getting a cross-compiler

Basically, you only have to do it once.

Terminal on Ubuntu


sudo apt-get update
sudo apt-get install build-essential libncurses-dev git git-core
mkdir ~/raspberry
cd ~/raspberry
git clone https://github.com/raspberrypi/tools

Build

Try to build ~ / work / pi / sample01 / sample01.cpp as below.

sample01.cpp


#include <stdio.h>
int main()
{
	printf("Hello World\n");
	for (int i = 0; i < 10; i++)
		printf("i = %d\n", i);
	return 0;
}

Terminal on Ubuntu


mkdir ~/work/pi/sample01 && cd ~/work/pi/sample01
code sample01.cpp &
ARCH=arm ~/raspberry/tools/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian-x64/bin/arm-linux-gnueabihf-g++ sample01.cpp
# ARCH=arm ~/raspberry/tools/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian/bin/arm-linux-gnueabihf-g++ sample01.cpp
scp a.out [email protected]:.

You can execute the a.out transferred by the last scp command on the Raspberry Pi. For 32-bit environment, raspberry / tools / arm-bcm2708 / gcc-linaro-arm-linux-gnueabihf-raspbian / bin may be better.

Remote debugging

I have referred to this article very much. (https://qiita.com/tetsu_koba/items/ebbac47e3fb43c86f412). Thank you very much.

Preparation

Basically, you only have to do it once.

Install gdbserver (on Raspberry Pi)

Terminal on Raspberry Pi


sudo apt-get install gdbserver

Creating gdb binaries for ARM (on Ubuntu)

Terminal on Ubuntu


mkdir ~/temp && cd ~/temp
wget http://ftp.jaist.ac.jp/pub/GNU/gdb/gdb-8.0.1.tar.gz
tar xf gdb-8.0.1.tar.gz
cd gdb-8.0.1
mkdir build && cd build
sudo apt-get install libexpat1-dev expat
../configure --target=arm-buildroot-linux-gnueabi  --with-expat
make -j4
sudo make install

Remote debug

Start gdbserver (on Raspberry Pi)

Terminal on Raspberry Pi


gdbserver --multi :5555

gdb execution (on Ubuntu)

Create the following file (~ / work / pi / sample01 / gdb_load) in the same place as the executable file you want to debug.

gdb autorun script


target extended-remote 192.168.1.89:5555
file ./a.out
remote put ./a.out /home/pi/a.out
set remote exec-file /home/pi/a.out
start

Execute the following command with the same path as gdb_load and a.out to start debugging. Debug information is output to the terminal on the Ubuntu side, and output such as printf is output to the terminal on the Raspberry Pi side.

Terminal on Ubuntu


arm-buildroot-linux-gnueabi-gdb -x gdb_load
#↓ is the prompt in gdb
>>> n

When debugging again (on Ubuntu)

Basically, gdbserver started on the Raspberry Pi side can always be started. Therefore, no operation is required on the Raspberry Pi side. In the gdb terminal on the Ubuntu side, do q and run gdb again to restart.

Remote debugging from VS Code (on Ubuntu)

Debugging with the gdb command is inefficient unless you are very familiar with it. Allows you to debug with GUI from Visual Studio Code. As with general application development, step execution and break pointer settings can be made from the GUI so that variables in the scope can be referenced automatically.

Visual Studio Code settings (on Ubuntu)

Open the ~ / work / pi / sample01 / directory from VS Code and press F5 to try to debug. After that, you will be asked to create debug settings, so select C ++ (GDB / LLDB).

01.jpg

Since launch.json is opened, edit it as follows.

launch.json


{
	"version": "0.2.0",
	"configurations": [
		{
			"name": "(gdb) Launch",
			"type": "cppdbg",
			"request": "launch",
			"program": "${workspaceFolder}/a.out",	//★ Edit
			"args": [],
			"stopAtEntry": true,					//★ Edit(as you like)
			"cwd": "${workspaceFolder}",
			"environment": [],
			"externalConsole": false,
			"MIMode": "gdb",
			"miDebuggerPath": "arm-buildroot-linux-gnueabi-gdb",		//★ Addition
			"setupCommands": [											//★ Addition
				{"text": "target extended-remote 192.168.1.89:5555"},
				{"text": "file a.out"},
				{"text": "remote put a.out /home/pi/a.out"},
				{"text": "set remote exec-file /home/pi/a.out"}
			]
		}
	]
}

Debug from Visual Studio Code (on Ubuntu)

Press F5 again to start debugging. After that, when debugging the project in this directory, just press the F5 key. The output of printf etc. is output to the terminal on the Raspberry Pi side.

02.jpg

Remote debugging from Windows

Generally, if the target is Linux, I think the development HOST environment is also Linux. However, for some reason you often want to edit or debug your code on a Windows PC. (For example, I think it's a common practice to build on a Linux build server, download the binary built on the developer's Windows PC, and write it to the target). In such an environment, I think it is troublesome to put Ubuntu only for debugging, so I will make it possible on Windows as well. Use MSYS2 for terminal operation.

Creating gdb binaries for ARM (on Windows (MSYS2))

Create a gdb binary for ARM with the following command.

Terminal on MSYS


mkdir ~/temp && cd ~/temp
wget http://ftp.jaist.ac.jp/pub/GNU/gdb/gdb-8.0.1.tar.gz
tar xf gdb-8.0.1.tar.gz
cd gdb-8.0.1
mkdir build && cd build
../configure --target=arm-buildroot-linux-gnueabi  --with-expat
make -j4
make install

_ Note The build was successful once, but after installing python (pacman -S python2) and doing various things, I couldn't rebuild. .. .. _

Visual Studio Code settings (on Windows)

It's basically exactly the same as I did on Ubuntu. Suppose you have the source code and pre-built ARM binaries in C: / Users / tak / Desktop / win_share / sample01 /.

Edit launch.json as below.

launch.json


{
	"version": "0.2.0",
	"configurations": [
		{
			"name": "(gdb) Launch",
			"type": "cppdbg",
			"request": "launch",
			"program": "${workspaceFolder}/a.out",		//★ Edit
			"args": [],
			"stopAtEntry": true,						//★ Edit(as you like)
			"cwd": "${workspaceFolder}",
			"environment": [],
			"externalConsole": false,
			"MIMode": "gdb",
			"miDebuggerPath": "C:/msys64/mingw64/bin/arm-buildroot-linux-gnueabi-gdb.exe",	//★ Addition
			"setupCommands": [														//★ Addition
				{"text": "target extended-remote 192.168.1.89:5555"},
				{"text": "file C:/Users/tak/Desktop/win_share/sample01/a.out"},
				{"text": "remote put C:/Users/tak/Desktop/win_share/sample01/a.out /home/pi/a.out"},
				{"text": "set remote exec-file /home/pi/a.out"}
			]
		}
	]
}

Note that the ARM gdb you built yourself does not have a path on Windows, so you need to specify the full path. I also had to specify the full path of the binary file to load. I tried using $ {workspaceFolder} to see if it could be omitted, but it didn't work.

Remote debug from VS Code (on Windows)

You can debug as below by pressing F5 again.

03.jpg

My operation for Raspberry Pi

Since my main PC is Windows, I only build with Raspberry Pi and debug with VS Code on Windows.

  1. Write code in VS Code on Windows
  2. With VS Code on Windows, upload the code to Raspberry Pi with the sftp extension function
  3. Build (create ./a.out) on Raspberry Pi
    • g++ -O0 -g3 sample01.cpp
  4. With VS Code on Windows, download the binary (./a.out) with the sftp extension feature
  5. Debug with VS Code on Windows

Other

--When exiting gdbserver, use the monitor exit from the gdb prompt on the host side. --When specifying the location of the shared library, set sysroot ./ --If the source configuration and path are different between the build environment and the gdb execution environment, set substitute-path from-path to-path ――Even if the environment is different, it worked well for the time being. If there is a relative path, it seems to be a little okay.

Recommended Posts

Cross-compiling Raspberry Pi and building a remote debugging development environment with VS Code
Create a simple Python development environment with VS Code and Docker
Build a Go development environment with VS Code's Remote Containers
Get the strongest environment with VS Code, Remote-Containers and remote docker-daemon
Build a Tensorflow environment with Raspberry Pi [2020]
Building a distributed environment with the Raspberry PI series (Part 2: PiServer analysis and alternative system design)
Building a python environment with virtualenv and direnv
Build a Python development environment on Raspberry Pi
Build a python execution environment with VS Code
Build a development environment using Jupyter and Flask with Python in Docker (supports both VS Code / code-server)
Introduce VS Code and Remote Development to an offline environment to make linux development comfortable
Build a distributed environment with Raspberry PI series (Part 3: Install and configure dnsmasq)
Remote debug Django environment created with docker-compose with VS Code
Edit and debug the code in the Raspberry Pi with VS Code's SSH connection feature
[Django] Use VS Code + Remote Containers to quickly build a Django container (Docker) development environment.
Set up a Python development environment with Visual Studio Code
Create a web surveillance camera with Raspberry Pi and OpenCV
Create a VS Code + Docker development environment on a Linux VM
Build a comfortable development environment with VSCode x Remote Development x Pipenv
Build a Python environment with WSL + Pyenv + Jupyter + VS Code
[No venv required] The strongest Python development environment created with Remote Containers [VS Code / Docker]
Building a kubernetes environment with ansible 2
Building a virtual environment with Python 3
Building a kubernetes environment with ansible 1
Using a webcam with Raspberry Pi
Christmas classic (?) Lighting a Christmas tree with Raspberry Pi and Philips Hue
Make a thermometer with Raspberry Pi and make it viewable with a browser Part 4
Make a Kanji display compass with Raspberry Pi and Sense Hat
Building a development environment with Maven on Google App Engine [Java]
How to build Python and Jupyter execution environment with VS Code
[DynamoDB] [Docker] Build a development environment for DynamoDB and Django with docker-compose
[Pyenv] Building a python environment with ubuntu 16.04
Prepare a Python virtual environment for your project with venv with VS Code
Pet monitoring with Rekognition and Raspberry pi
Building a Python3 environment with Amazon Linux2
Easily build a development environment with Laragon
[Raspberry Pi] Add a thermometer and a hygrometer
I was addicted to creating a Python venv environment with VS Code
Building a Python 3.6 environment with Windows + PowerShell
Create a Python development environment on Windows (Visual Studio Code remote WSL).
Make a wireless LAN Ethernet converter and simple router with Raspberry Pi
Steps to create a Python virtual environment with VS Code on Windows
Make a wash-drying timer with a Raspberry Pi
Operate an oscilloscope with a Raspberry Pi
Create a car meter with raspberry pi
Building a Python development environment for AI development
Building a distributed environment with the Raspberry PI series (Part 1: Summary of availability of diskless clients by model)
Let's do Linux System Programming with Visual Studio Code and Azure! (From helloworld to nginx development and remote debugging)
Make a thermometer with Raspberry Pi and make it visible on the browser Part 3
Source compile Apache2.4 + PHP7.4 with Raspberry Pi and build a Web server --2 PHP introduction
Source compile Apache2.4 + PHP7.4 with Raspberry Pi and build a Web server ―― 1. Apache introduction
Creating a temperature control system with Raspberry Pi and ESP32 (3) Recipient Python file
[For beginners] I made a motion sensor with Raspberry Pi and notified LINE!
Python local development environment construction template [Flask / Django / Jupyter with Docker + VS Code]
Build a TensorFlow development environment on Amazon EC2 with command copy and paste
Build a C language development environment with a container
Build Python development environment with Visual Studio Code
Build a Django environment on Raspberry Pi (MySQL)
Try using a QR code on a Raspberry Pi
Building a Python environment with WLS2 + Anaconda + PyCharm
Python (Windows 10) Virtual Environment / Package with VS Code