Skip to content

GDB stub support #10000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
kv2019i merged 5 commits into from
Jul 30, 2025
Merged

GDB stub support #10000

kv2019i merged 5 commits into from
Jul 30, 2025

Conversation

@lyakh
Copy link
Collaborator

@lyakh lyakh commented May 12, 2025

This respins nklayman@cbb3f4d to add GDB stub support to SOF. With this an IPC can be sent to SOF to enter the GDB stub, after which a Linux driver debugging interface from thesofproject/linux#5411 can be used to communicate with the stub over a memory window. Both IPC3 and IPC4 are supported. So far only cAVS 2.5 is supported.

@lyakh
Copy link
Collaborator Author

lyakh commented May 12, 2025

CI failure https://github.com/thesofproject/sof/actions/runs/14970782671/job/42051045218?pr=10000 should be fixed by #10001

lgirdwood
lgirdwood reviewed May 19, 2025
View reviewed changes
src/ipc/ipc-common.c Outdated
#if CONFIG_GDBSTUB
if (ipc_enter_gdb) {
ipc_enter_gdb = false;
k_msleep(5);
Copy link
Member

@lgirdwood lgirdwood May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why sleep and why 5 ms ?

src/ipc/ipc4/handler.c
static int ipc_glb_gdb_debug(struct ipc4_message_request *ipc4)
{
#if CONFIG_GDBSTUB
ipc_enter_gdb = true;
Copy link
Member

@lgirdwood lgirdwood May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should log this entry as it comes from host IPC

@lyakh lyakh marked this pull request as ready for review June 25, 2025 13:26
@lyakh lyakh changed the title [DRAFT][DNM] GDB stub support GDB stub support Jun 25, 2025
@marcinszkudlinski
Copy link
Contributor

marcinszkudlinski commented Jun 25, 2025

You have PR number 10000 !!!!

@lyakh
Copy link
Collaborator Author

lyakh commented Jun 25, 2025

You have PR number 10000 !!!!

@marcinszkudlinski I do (since more than a month ;-) )! Am I getting a prize? ;-)

@lyakh lyakh requested a review from abonislawski as a code owner June 26, 2025 11:01
@kv2019i kv2019i changed the title GDB stub support GDB stub support (include Zephry west update) Jun 30, 2025
@kv2019i kv2019i changed the title GDB stub support (include Zephry west update) GDB stub support (includes Zephyr west update) Jun 30, 2025
kv2019i
kv2019i approved these changes Jun 30, 2025
View reviewed changes
Copy link
Collaborator

@kv2019i kv2019i left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

app/debug_overlay.conf

# GDB stub

CONFIG_GDBSTUB=y
Copy link
Collaborator

@kv2019i kv2019i Jun 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This overlay is used in our SOF driver CI, so gdb stub will be enabled. Probably ok and even preferred as this will get a minimal coverage in CI for the gdb build.

Copy link
Collaborator Author

@lyakh lyakh Jul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, that's the intension

@kv2019i
Copy link
Collaborator

kv2019i commented Jul 2, 2025

@lyakh This seems ready to go except for the mandatory CI check fail. Any idea why that is failing? I don't see anything in the PR that would break existing tests.

@lgirdwood
Copy link
Member

lgirdwood commented Jul 2, 2025

@lyakh This seems ready to go except for the mandatory CI check fail. Any idea why that is failing? I don't see anything in the PR that would break existing tests.

-- west build: generating a build system
Loading Zephyr default modules (Zephyr base).
-- Application: /srv/home/jenkins/workspace/sof_config_build@2/sof/app
-- CMake version: 3.31.4
CMake Error at /srv/home/jenkins/.local/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Modules/FindPackageHandleStandardArgs.cmake:233 (message):
  Could NOT find Python3: Found unsuitable version "3.10.16", but required is
  at least "3.12" (found /usr/bin/python3, found components: Interpreter)

Python versions.

@lgirdwood
Copy link
Member

lgirdwood commented Jul 3, 2025

@lyakh can you rebase - btw not seen the Python failure in other PRs.

@lyakh
Copy link
Collaborator Author

lyakh commented Jul 4, 2025

@lyakh can you rebase - btw not seen the Python failure in other PRs.

@lgirdwood Python failures aren't seen in most other PRs because they don't update the Zephyr version. So we need to fix that issue first, then I can rebase and we can merge

lyakh and others added 2 commits July 11, 2025 09:59
@lyakh
IPC4: add a GDB entry command
c0a6906 
Add an IPC4 message type to instruct the firmware to enter the GDB
stub.

Signed-off-by: Guennadi Liakhovetski <[email protected]>
@nklayman @lyakh
debug: enter Zephyr GDB stub on ipc_glb_gdb_debug command
f3d77c5 
Need to decide if old XTOS GDB stub should be removed and add support
for IPC4.

Signed-off-by: Noah Klayman <[email protected]>
lyakh added 3 commits July 11, 2025 09:59
@lyakh
ipc: gdb: initialise GDB after IPC completion
86421f6 
To avoid timed out IPC on the host side, enter the GDB stub only
after replying to the IPC.

Signed-off-by: Guennadi Liakhovetski <[email protected]>
@lyakh
ipc4: add support for GDB
a96173c 
Add suppoprt for the new IPC4 GDB enter message.

Signed-off-by: Guennadi Liakhovetski <[email protected]>
@lyakh
debug: gdb: enable GDB stub in debug builds
5f5dab6 
By default enable the GDB stub when building the debug configuration.

Signed-off-by: Guennadi Liakhovetski <[email protected]>
@lyakh lyakh force-pushed the gdb branch 2 times, most recently from 2824d1e to dd938e1 Compare July 11, 2025 08:43
@lyakh lyakh added the DNM Do Not Merge tag label Jul 11, 2025
@lyakh lyakh removed the DNM Do Not Merge tag label Jul 30, 2025
@lyakh lyakh changed the title GDB stub support (includes Zephyr west update) GDB stub support Jul 30, 2025
@kv2019i kv2019i merged commit 9a52302 into thesofproject:main Jul 30, 2025
35 of 45 checks passed
@lyakh lyakh deleted the gdb branch July 31, 2025 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lgirdwood lgirdwood lgirdwood approved these changes

@kv2019i kv2019i kv2019i approved these changes

@bardliao bardliao Awaiting requested review from bardliao bardliao is a code owner

@marcinszkudlinski marcinszkudlinski Awaiting requested review from marcinszkudlinski marcinszkudlinski is a code owner

@pblaszko pblaszko Awaiting requested review from pblaszko pblaszko is a code owner

@RanderWang RanderWang Awaiting requested review from RanderWang RanderWang is a code owner

@plbossart plbossart Awaiting requested review from plbossart plbossart is a code owner

@mmaka1 mmaka1 Awaiting requested review from mmaka1 mmaka1 is a code owner

@lbetlej lbetlej Awaiting requested review from lbetlej lbetlej is a code owner

@dbaluta dbaluta Awaiting requested review from dbaluta dbaluta is a code owner

@abonislawski abonislawski Awaiting requested review from abonislawski abonislawski is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@lyakh @marcinszkudlinski @kv2019i @lgirdwood @nklayman