add rocgdb how-to #3097

parbenc · 2024-05-08T12:23:44Z

No description provided.

randyh62 · 2024-05-08T13:25:14Z

docs/how-to/rocgdb.rst

Maybe provide a link to the ROCgdb repo?
https://rocm.docs.amd.com/projects/ROCgdb/en/latest/index.html

lpaoletti · 2024-05-08T18:24:12Z

docs/how-to/rocgdb.rst

+  :keywords: AMD, ROCm, HIP, ROCgdb, performance, debugging
+
+*******************************************************************************
+ROCgdb


Suggested change

ROCgdb

ROCgdb debugger for Linux targets

lpaoletti · 2024-05-08T18:25:18Z

docs/how-to/rocgdb.rst

+.. _rocgdb_introduction:
+Introduction
+===============================================================================
+This document introduces ROCgdb, the AMD ROCm debugger for Linux targets.


Suggested change

This document introduces ROCgdb, the AMD ROCm debugger for Linux targets.

ROCgdb is the AMD ROCm debugger for Linux targets.

lpaoletti · 2024-05-08T18:26:12Z

docs/how-to/rocgdb.rst

+This document introduces ROCgdb, the AMD ROCm debugger for Linux targets.
+
+ROCgdb is an extension to GDB, the GNU Project debugger. The tool provides developers
+with a mechanism for debugging CUDA applications running on actual hardware. This


Suggested change

with a mechanism for debugging CUDA applications running on actual hardware. This

with a mechanism for debugging CUDA applications running on actual hardware. This tool

lpaoletti · 2024-05-08T18:27:48Z

docs/how-to/rocgdb.rst

+with a mechanism for debugging CUDA applications running on actual hardware. This
+enables developers to debug applications without the potential variations introduced
+by simulation and emulation environments. It is meant to present a seamless debugging
+environment that allows simultaneous debugging of both GPU and CPU code within the


Suggested change

environment that allows simultaneous debugging of both GPU and CPU code within the

environment that allows simultaneous GPU and CPU code debugging within the

lpaoletti · 2024-05-08T18:28:35Z

docs/how-to/rocgdb.rst

+ROCgdb is an extension to GDB, the GNU Project debugger. The tool provides developers
+with a mechanism for debugging CUDA applications running on actual hardware. This
+enables developers to debug applications without the potential variations introduced
+by simulation and emulation environments. It is meant to present a seamless debugging


Suggested change

by simulation and emulation environments. It is meant to present a seamless debugging

by simulation and emulation environments. It presents a seamless debugging

lpaoletti · 2024-05-08T18:29:46Z

docs/how-to/rocgdb.rst

+enables developers to debug applications without the potential variations introduced
+by simulation and emulation environments. It is meant to present a seamless debugging
+environment that allows simultaneous debugging of both GPU and CPU code within the
+same application, just like programming in HIP is a seamless extension of C++


Suggested change

same application, just like programming in HIP is a seamless extension of C++

same application, just like programming in HIP, which is a seamless extension of C++

lpaoletti · 2024-05-08T18:31:54Z

docs/how-to/rocgdb.rst

+the host code, and additional features have been provided to support debugging ROCm
+device code.
+
+ROCgdb supports HIP kernel debugging. It allows the user to set breakpoints, to 


Perhaps this instead:
It allows you to set breakpoints, single-step ROCm applications, and inspect and modify the memory and variables of any given thread running on the hardware.

lpaoletti · 2024-05-08T18:35:02Z

docs/how-to/rocgdb.rst

+.. _rocgdb_setup:
+Setup
+===============================================================================
+Before debugging you have to compile your software with debug information. To do this


Consider this paragraph instead:
Before debugging, compile your software with debug information. Add the ‘-g’ flag to your compilation command to do this. This generates debug information even when optimizations are turned on. Notice that higher optimization levels make the debugging more difficult, so it might be helpful to turn off these optimizations using the ‘-O0’ compiler option.

lpaoletti · 2024-05-08T18:38:37Z

docs/how-to/rocgdb.rst

+.. _rocgdb_debugging:
+Debugging
+===============================================================================
+This section is a brief introduction on how to use ROCgdb. For a more information on the


Perhaps:
This section introduces how to use ROCgdb. For more information about GDB, see the GDB documentation.

Add a link for the bold.

lpaoletti · 2024-05-08T18:39:59Z

docs/how-to/rocgdb.rst

+console. Here you can use every gdb option for host debugging and you can use them and
+extra ROCgdb specific features for device debugging.
+
+Before you run your application with the debugger, you'll need to set a breakpoint.


Suggested change

Before you run your application with the debugger, you'll need to set a breakpoint.

You'll need to set a breakpoint before you run your application with the debugger.

lpaoletti · 2024-05-08T18:42:43Z

docs/how-to/rocgdb.rst

+
+``run``
+
+If the breakpoint is in device code the debugger will show the device and host threads as


Perhaps:
If the breakpoint is in the device code, the debugger will also show the device and host threads. The device threads will not be individual threads; instead, they represent a wavefront on the device. You can switch between the device wavefronts as you would between host threads.

By the way, is it "wavefront" or "warp"?

As far as I know they are the same thing, but warp is the word nvidia uses for cuda, and wavefront is used for opencl and by amd for its hardware

lpaoletti · 2024-05-08T18:43:36Z

docs/how-to/rocgdb.rst

+``layout asm``
+
+The `src` layout is the source code view, while the `asm` is the assembly view. There are
+further layouts you can look up on the gdb documentation.


Suggested change

further layouts you can look up on the gdb documentation.

further layouts you can look up in the GBD documentation. (Make this a link)

lpaoletti · 2024-05-08T18:44:48Z

docs/how-to/rocgdb.rst

+
+``i r``
+
+For further information on the usage of gdb, you can go to the `gdb documentation


This feels like it's been discussed multiple times.
Not sure needed again here. Perhaps it doesn't hurt.

I added some text about the command above it. Just ending on a command felt weird.

docs/how-to/rocgdb.rst

saadrahim

This belongs in the rocgdb docs repo.

yhuiYH · 2024-05-27T17:27:00Z

I agree with Saad. Can we move this to the rocgdb-docs repo instead of merging in here pls @neon60 @parbenc

parbenc · 2024-05-28T09:18:06Z

This belongs in the rocgdb docs repo.

moved to rocgdb-docs
PR: https://github.com/ROCm/ROCgdb-docs/pull/35

neon60 · 2024-05-30T07:01:30Z

This belongs in the rocgdb docs repo.

moved to rocgdb-docs PR: ROCm/ROCgdb-docs#35

The PR is merged in on rocgdb docs repository. Closing this PR.

parbenc requested review from amd-aakash, jlgreathouse, samjwu and a team as code owners May 8, 2024 12:23

parbenc force-pushed the rocgdb branch 2 times, most recently from c115022 to f35d561 Compare May 8, 2024 13:20

randyh62 previously approved these changes May 8, 2024

View reviewed changes

lpaoletti reviewed May 8, 2024

View reviewed changes

parbenc dismissed randyh62’s stale review via df5ca2d May 14, 2024 14:07

parbenc requested a review from yhuiYH as a code owner May 14, 2024 14:07

parbenc force-pushed the rocgdb branch from df5ca2d to 3312890 Compare May 14, 2024 14:10

parbenc requested review from randyh62 and lpaoletti May 14, 2024 14:14

add rocgdb how-to

50a17cd

parbenc force-pushed the rocgdb branch from 3312890 to 7553c9a Compare May 14, 2024 14:16

fix review comments

37ee287

parbenc force-pushed the rocgdb branch from 7553c9a to 37ee287 Compare May 14, 2024 14:24

neon60 reviewed May 15, 2024

View reviewed changes

change format for commands and remove accidental cuda reference

89be441

neon60 approved these changes May 16, 2024

View reviewed changes

saadrahim requested changes May 23, 2024

View reviewed changes

neon60 closed this May 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add rocgdb how-to #3097

add rocgdb how-to #3097

parbenc commented May 8, 2024

randyh62 May 8, 2024

lpaoletti May 8, 2024

lpaoletti May 8, 2024

lpaoletti May 8, 2024

lpaoletti May 8, 2024

lpaoletti May 8, 2024

lpaoletti May 8, 2024

lpaoletti May 8, 2024

lpaoletti May 8, 2024

lpaoletti May 8, 2024

lpaoletti May 8, 2024

lpaoletti May 8, 2024

parbenc May 14, 2024

lpaoletti May 8, 2024

lpaoletti May 8, 2024

parbenc May 14, 2024

saadrahim left a comment

yhuiYH commented May 27, 2024

parbenc commented May 28, 2024

neon60 commented May 30, 2024

	This document introduces ROCgdb, the AMD ROCm debugger for Linux targets.
	ROCgdb is the AMD ROCm debugger for Linux targets.

	with a mechanism for debugging CUDA applications running on actual hardware. This
	with a mechanism for debugging CUDA applications running on actual hardware. This tool

	environment that allows simultaneous debugging of both GPU and CPU code within the
	environment that allows simultaneous GPU and CPU code debugging within the

	by simulation and emulation environments. It is meant to present a seamless debugging
	by simulation and emulation environments. It presents a seamless debugging

	same application, just like programming in HIP is a seamless extension of C++
	same application, just like programming in HIP, which is a seamless extension of C++

	Before you run your application with the debugger, you'll need to set a breakpoint.
	You'll need to set a breakpoint before you run your application with the debugger.


		``run``

		If the breakpoint is in device code the debugger will show the device and host threads as

	further layouts you can look up on the gdb documentation.
	further layouts you can look up in the GBD documentation. (Make this a link)


		``i r``

		For further information on the usage of gdb, you can go to the `gdb documentation

add rocgdb how-to #3097

add rocgdb how-to #3097

Conversation

parbenc commented May 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saadrahim left a comment

Choose a reason for hiding this comment

yhuiYH commented May 27, 2024

parbenc commented May 28, 2024

neon60 commented May 30, 2024