CLion Debugging: Difference between revisions

From dreamcast.wiki
Jump to navigation Jump to search
(Created page with "This guide will help with setting up CLion for remote debugging through dcload's GDB feature. == Setup == The following criteria must be met before following this guide: *...")
 
m (Removed SSH requirement)
 
(6 intermediate revisions by the same user not shown)
Line 6: Line 6:
* The specific project must be [[Dreamcast_CMake_Project_In_CLion|setup within CLion]]
* The specific project must be [[Dreamcast_CMake_Project_In_CLion|setup within CLion]]
* A working version of [[dcload-ip]] or [[dcload-serial]] must be available on the host system
* A working version of [[dcload-ip]] or [[dcload-serial]] must be available on the host system
* The target Dreamcast will need either a [[Broadband adapter]], [[LAN adapter]], or a [[Coder's Cable]] (serial cable) connected
* The target Dreamcast will need either a [[Broadband adapter]], [[LAN adapter]], or a [[Coder's cable]] (USB or serial cable) connected
* SSH must be configured for remote logins on the host system


== Creating a debug configuration ==
== Creating a debug configuration ==
Line 15: Line 14:
[[File:CLion Edit Configuration.png|frameless]]
[[File:CLion Edit Configuration.png|frameless]]


In the configuration editor window, select the + icon to create a new configuration and select "Remote GDB Debugger":
In the configuration editor window, select the + icon to create a new configuration and select "Embedded GDB Debugger":


[[File:Remote GDB Server.png|frameless]]
[[File:Embedded GDB Server configuration.png|frameless]]


== Remote GDB Server Settings ==
== Embedded GDB Server Settings ==


Now that the new configuration has been created, the specific settings can now be populated to enable remote debugging sessions.
Now that the new configuration has been created, the specific settings can now be populated to enable debugging sessions.
 
=== Setup SSH credentials ===
 
CLion handles setting up and running the remote GDB server instance. Unfortunately, it requires running the executable through SSH which means CLion will have to "remotely" login to the same computer to run the dcload session. Once the host system is configured for SSH access, it's as simple as creating a new set of credentials within the debug configuration setup window to allow CLion to access your computer over SSH.
 
First, select the settings cog beside Credentials in the debug configuration:
 
[[File:SSH Credentials.png|frameless]]
 
Create a new set of credentials using the + button and fill in the information to be able to remotely connect to the host system:
 
[[File:SSH Credentials Page.png|frameless]]
 
If dcload will be run from the same system, it should be enough to enter "localhost" as the host and then fill in the user credentials for the user account on the host system. Using the "Test Connection" button should be an indication of whether the host system or credentials have been setup correctly. After saving the new SSH credentials, select them from the "Credentials" dropdown in the debug configuration page.
 
=== GDB Configuration Settings ===


Use the following settings in the debug configuration page:
Use the following settings in the debug configuration page:
* '''Name:''' Dreamcast Debug IP/Serial (really, it's up to the user)
* '''Name:''' Dreamcast Debug IP/Serial (really, it's up to the user)
* '''Target:''' Your project
* '''Target:''' Your project
* '''Executable:''' Your executable for your project
* '''Executable binary:''' Your executable for your project
* '''GDB:''' Bundled GDB (This can handle SH-4 executables)
* '''GDB:''' Bundled GDB (This can handle SH-4 executables)
* '''Credentials:''' The credentials created in the previous section
* '''Download Executable:''' Never
* '''Upload Executable:''' Never
* ''''target remote' args:''' localhost:2159 (default port for dcload's GDB instance)
* ''''target remote' args:''' localhost:2159 (default port for dcload's GDB instance)
* '''GDB Server:''' /path/to/dc-tool-[ip|serial]
* '''GDB Server:''' /path/to/dc-tool-[ip|serial]
* '''GDB Server args:''' -g -x $CMakeCurrentBuildDir$/<your executable name>.elf -c $CMakeProjectDir$ -t <IP address or /dev/tty device>
* '''GDB Server args:''' -g -x $CMakeCurrentBuildDir$/<your executable name>.elf -c $ContentRoot$ -t <IP address or /dev/tty device>
:* -g: Starts dcload with GDB
:* -g: Starts dcload with GDB
:* -x: Uploads and executes your binary
:* -x: Uploads and executes your binary
Line 57: Line 39:


Once all settings have been configured, click "Apply" and the configuration should be ready.
Once all settings have been configured, click "Apply" and the configuration should be ready.
== Using the Debugger ==
Now that the Embedded GDB Server has been configured, the executable can be launched. To launch a binary on the Dreamcast, make sure it is powered on and dcload-ip/serial has been booted and connected to the computer. Once the Dreamcast is ready to receive a new binary, click on the "bug" icon in the toolbar of CLion:
[[File:CLion Debug Icon.png|frameless]]
This will compile any changes and generate a new .elf file and launch dc-tool-[ip/ser] with the correct flags. The desired binary should be deployed to and launched on the Dreamcast at this point. The dc-tool-* binary should now be waiting for a GDB connection. CLion will launch GDB and connect to the waiting GDB server. Once CLion connects, a debug session will be started in the CLion user interface. Below are some of the features supported by CLion's debugger:
=== Breakpoints ===
To set a breakpoint, hover over a line number within a file and a small red circle will appear. The breakpoint can be enabled or disabled by clicking the red circle:
[[File:CLion Breakpoint.png|frameless]]
=== Stdout capturing ===
The debug view within can show the output of dc-tool:
[[File:Stdout capture.png|frameless]]
=== Memory viewer ===
CLion can take a memory location as an input and display the data at that point in memory:
[[File:CLion memory viewer.png|frameless]]
=== Display type data on hover ===
While debugging in a breakpoint, the user can hover over variables within a method to display their contents:
[[File:Hover variable.png|frameless]]
=== View pointers as arrays ===
Pointers can be displayed as arrays by right-clicking on the specific variable in the variable viewer and selecting "View as Array...":
[[File:View as Array.png|frameless]]
The user interface will ask for the size of the array. Once the size has been input, CLion will display the variable as an array of that type:
[[File:View as array output.png|frameless]]

Latest revision as of 16:18, 9 January 2023

This guide will help with setting up CLion for remote debugging through dcload's GDB feature.

Setup

The following criteria must be met before following this guide:

Creating a debug configuration

After opening your project in CLion, click the dropdown for the current debug/run configuration and select "Edit Configurations...":

CLion Edit Configuration.png

In the configuration editor window, select the + icon to create a new configuration and select "Embedded GDB Debugger":

Embedded GDB Server configuration.png

Embedded GDB Server Settings

Now that the new configuration has been created, the specific settings can now be populated to enable debugging sessions.

Use the following settings in the debug configuration page:

  • Name: Dreamcast Debug IP/Serial (really, it's up to the user)
  • Target: Your project
  • Executable binary: Your executable for your project
  • GDB: Bundled GDB (This can handle SH-4 executables)
  • Download Executable: Never
  • 'target remote' args: localhost:2159 (default port for dcload's GDB instance)
  • GDB Server: /path/to/dc-tool-[ip|serial]
  • GDB Server args: -g -x $CMakeCurrentBuildDir$/<your executable name>.elf -c $ContentRoot$ -t <IP address or /dev/tty device>
  • -g: Starts dcload with GDB
  • -x: Uploads and executes your binary
  • -c: Points dcload to your project directory to be able to load files with "/pc/" (requires superuser)
  • -t: The device dcload should target
  • Advanced GDB Server Options
  • Run with root privileges: Checked

Once all settings have been configured, click "Apply" and the configuration should be ready.

Using the Debugger

Now that the Embedded GDB Server has been configured, the executable can be launched. To launch a binary on the Dreamcast, make sure it is powered on and dcload-ip/serial has been booted and connected to the computer. Once the Dreamcast is ready to receive a new binary, click on the "bug" icon in the toolbar of CLion:

CLion Debug Icon.png

This will compile any changes and generate a new .elf file and launch dc-tool-[ip/ser] with the correct flags. The desired binary should be deployed to and launched on the Dreamcast at this point. The dc-tool-* binary should now be waiting for a GDB connection. CLion will launch GDB and connect to the waiting GDB server. Once CLion connects, a debug session will be started in the CLion user interface. Below are some of the features supported by CLion's debugger:

Breakpoints

To set a breakpoint, hover over a line number within a file and a small red circle will appear. The breakpoint can be enabled or disabled by clicking the red circle:

CLion Breakpoint.png

Stdout capturing

The debug view within can show the output of dc-tool:

Stdout capture.png

Memory viewer

CLion can take a memory location as an input and display the data at that point in memory:

CLion memory viewer.png

Display type data on hover

While debugging in a breakpoint, the user can hover over variables within a method to display their contents:

Hover variable.png

View pointers as arrays

Pointers can be displayed as arrays by right-clicking on the specific variable in the variable viewer and selecting "View as Array...":

View as Array.png

The user interface will ask for the size of the array. Once the size has been input, CLion will display the variable as an array of that type:

View as array output.png

Retrieved from "https://dreamcast.wiki/wiki/index.php?title=CLion_Debugging&oldid=1859"