CLion Debugging - Revision history

Unknown user: Removed SSH requirement

2023-01-09T16:18:01Z

Removed SSH requirement

← Older revision		Revision as of 16:18, 9 January 2023
Line 7:		Line 7:
	* 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]] (USB or 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 ==

Unknown user at 16:13, 9 January 2023

2023-01-09T16:13:59Z

@@ Line 47: / Line 47: @@
 [[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.
+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:
-=== Creating breakpoints ===
+=== Breakpoints ===
-Creating breakpoints in CLion is as easy as a single click. To set a breakpoint, hover over a line number within a file and a small red circle will appear. The specific line the program should stop at can be clicked:
+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]]

Unknown user at 18:32, 7 January 2023

2023-01-07T18:32:17Z

← Older revision		Revision as of 18:32, 7 January 2023
Line 40:		Line 40:

	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.

			=== Creating breakpoints ===

			Creating breakpoints in CLion is as easy as a single click. To set a breakpoint, hover over a line number within a file and a small red circle will appear. The specific line the program should stop at can be clicked:

			[[File:CLion Breakpoint.png\|frameless]]

Unknown user at 21:18, 6 January 2023

2023-01-06T21:18:02Z

← Older revision		Revision as of 21:18, 6 January 2023
Line 31:		Line 31:
	* ''''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

Unknown user at 21:17, 6 January 2023

2023-01-06T21:17:20Z

← Older revision		Revision as of 21:17, 6 January 2023
Line 19:		Line 19:
	[[File:Embedded GDB Server configuration.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.

	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)
	* '''~~Upload~~ Executable:''' Never		* '''Download 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]

Unknown user at 21:01, 6 January 2023

2023-01-06T21:01:52Z

← Older revision		Revision as of 21:01, 6 January 2023
Line 15:		Line 15:
	[[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 ==		== Remote 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 remote 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:
Line 44:		Line 28:
	* '''Executable:''' Your executable for your project		* '''Executable:''' 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
	* '''Upload 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)

Unknown user: /* Setup */

2023-01-06T20:58:30Z

Setup

← Older revision		Revision as of 20:58, 6 January 2023
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		* SSH must be configured for remote logins on the host system

Unknown user: 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: *..."

2023-01-06T19:30:59Z

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: *..."

New page

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:
* 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
* The target Dreamcast will need either a [[Broadband adapter]], [[LAN adapter]], or a [[Coder's Cable]] (serial cable) connected
* SSH must be configured for remote logins on the host system

== Creating a debug configuration ==

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

[[File:CLion Edit Configuration.png|frameless]]

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

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

== Remote GDB Server Settings ==

Now that the new configuration has been created, the specific settings can now be populated to enable remote 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:
* '''Name:''' Dreamcast Debug IP/Serial (really, it's up to the user)
* '''Target:''' Your project
* '''Executable:''' Your executable for your project
* '''GDB:''' Bundled GDB (This can handle SH-4 executables)
* '''Credentials:''' The credentials created in the previous section
* '''Upload 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 $CMakeProjectDir$ -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.