Skip to content

Exception dump hook #10517

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
Draft
jsarha wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Exception dump hook #10517

jsarha wants to merge 2 commits into from

Conversation

@jsarha
Copy link
Contributor

@jsarha jsarha commented Feb 3, 2026

This is experimental debug_stream exception dump handler. It should be able to report fatal exceptions through debug_stream using debug window slot and debug_stream.py. To get it working one needs zephyrproject-rtos/zephyr#103449 too.

I tried to get backtrace dumpped too, but for some reason all my attempts so far rendered everything unusable, maybe I try again after my vacation.

Jyri Sarha added 2 commits February 4, 2026 00:51
debug: debug_stream_slot: Use spinlock instead of mutex for ISR
ba001a4 
Use spinlock instead of mutex to allow ISR context usage.

Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>
debug_stream: text_msg: Set exception dump hooks if available
fd97e52 
Set exception dump hooks if CONFIG_EXCEPTION_DUMP_HOOK=y. This enables
sending a simple text report of fatal exceptions. To get this working
one needs these config options:

CONFIG_EXCEPTION_DUMP_HOOK=y
CONFIG_SOF_DEBUG_STREAM_SLOT=y
CONFIG_SOF_DEBUG_STREAM_TEXT_MSG=y
CONFIG_SOF_DEBUG_STREAM_SLOT_NUMBER=2
CONFIG_SOF_TELEMETRY=n
CONFIG_SOF_TELEMETRY_PERFORMANCE_MEASUREMENTS=n
CONFIG_SOF_TELEMETRY_IO_PERFORMANCE_MEASUREMENTS=n

If system hangs and an the exception is reported successfully the
report can be seen with debug_stream.py (which should be installed in
the same directory with cavstool.py). It does matter if the too was
not running at the time. The report should be available there in the
debug slot window for debug_stream.py to decode as long as system
remains up. The report should looks something like this:

CPU 2:  ** FATAL EXCEPTION
 ** CPU 2 EXCCAUSE 63 (zephyr exception)
 **  PC 0xa00315db VADDR (nil)
 **  PS 0x60d20
 **    (INTLEVEL:0 EXCM: 0 UM:1 RING:0 WOE:1 OWB:13 CALLINC:2)
 **  A0 0xa0074680  SP 0xa00e7b60  A2 0x4  A3 0xa00e7b70
 **  A4 0xa00e7b50  A5 0x4  A6 0x1  A7 0x4
 **  A8 0xa007459a  A9 0xa00e7af0 A10 0xa00afe61 A11 0xa00e7b70
 ** A12 0xa00e7b50 A13 0x4 A14 0xffffff3c A15 0xa00fb740
 ** LBEG 0xa003ae05 LEND 0xa003ae14 LCOUNT 0xa0077bf3
 ** SAR 0x14
 **  THREADPTR (nil)

Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>
@jsarha jsarha force-pushed the exception_dump_hook branch from b3c5f35 to fd97e52 Compare February 3, 2026 23:00
lyakh
lyakh reviewed Feb 5, 2026
View reviewed changes
src/debug/debug_stream/debug_stream_slot.c
* in cached memory.
*
* sys_cache_data_flush_range(&cpu_mutex[i], sizeof(cpu_mutex[i]));
*/
Copy link
Collaborator

@lyakh lyakh Feb 5, 2026

Choose a reason for hiding this comment

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

k_spinlock_init()

src/debug/debug_stream/debug_stream_text_msg.c
static struct {
struct debug_stream_text_msg msg;
char text[768];
} __packed buf = { 0 };
Copy link
Collaborator

@lyakh lyakh Feb 5, 2026

Choose a reason for hiding this comment

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

static data is already 0. Also would be helpful to have a longer name with some context, at least ds_buf

src/debug/debug_stream/debug_stream_text_msg.c
struct debug_stream_text_msg msg;
char text[768];
} __packed buf = { 0 };
static int reports_sent_cpu[CONFIG_MP_MAX_NUM_CPUS] = { 0 };
Copy link
Collaborator

@lyakh lyakh Feb 5, 2026

Choose a reason for hiding this comment

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

ditto 0

src/debug/debug_stream/debug_stream_text_msg.c
buf.msg.hdr.id = DEBUG_STREAM_RECORD_ID_TEXT_MSG;
buf.msg.hdr.size_words = SOF_DIV_ROUND_UP(sizeof(buf.msg) + pos,
sizeof(buf.msg.hdr.data[0]));
memset(buf.text + pos, 0, buf.msg.hdr.size_words * sizeof(uint32_t) - pos);
Copy link
Collaborator

@lyakh lyakh Feb 5, 2026

Choose a reason for hiding this comment

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

buf.msg.hdr.size_words * sizeof(uint32_t) - pos can be replaced with sizeof(buf.msg)?

src/debug/debug_stream/debug_stream_text_msg.c
ds_exception_drain(false);
}

#if defined(CONFIG_EXCEPTION_DUMP_HOOK)
Copy link
Collaborator

@lyakh lyakh Feb 5, 2026

Choose a reason for hiding this comment

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

without CONFIG_EXCEPTION_DUMP_HOOK the functions above aren't needed either?

src/include/user/debug_stream_text_msg.h
#define __SOC_DEBUG_STREAM_TEXT_MSG_H__

#include <user/debug_stream_slot.h>
#include <stdarg.h>
Copy link
Collaborator

@lyakh lyakh Feb 5, 2026

Choose a reason for hiding this comment

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

does anything in the header need it? I guess you wanted this in .c

kv2019i
kv2019i reviewed Feb 6, 2026
View reviewed changes
Copy link
Collaborator

@kv2019i kv2019i left a comment •
edited
Loading

Choose a reason for hiding this comment

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

@jsarha This is missing something, CONFIG_EXCEPTION_DUMP_HOOK is not introduced anwhere (as a kconfig).
set_exception_dump_hook() is not implemented in this PR and I couldn't find it in SOF or Zephyr...?

@jsarha
Copy link
Contributor Author

jsarha commented Feb 9, 2026

@jsarha This is missing something, CONFIG_EXCEPTION_DUMP_HOOK is not introduced anwhere (as a kconfig). set_exception_dump_hook() is not implemented in this PR and I couldn't find it in SOF or Zephyr...?

@kv2019i its defined in zephyrproject-rtos/zephyr#103449 , without it this PR does not so much.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lyakh lyakh lyakh left review comments

@kv2019i kv2019i kv2019i left review comments

@lgirdwood lgirdwood Awaiting requested review from lgirdwood lgirdwood will be requested when the pull request is marked ready for review lgirdwood is a code owner

@plbossart plbossart Awaiting requested review from plbossart plbossart will be requested when the pull request is marked ready for review plbossart is a code owner

@mmaka1 mmaka1 Awaiting requested review from mmaka1 mmaka1 will be requested when the pull request is marked ready for review mmaka1 is a code owner

@lbetlej lbetlej Awaiting requested review from lbetlej lbetlej will be requested when the pull request is marked ready for review lbetlej is a code owner

@dbaluta dbaluta Awaiting requested review from dbaluta dbaluta will be requested when the pull request is marked ready for review dbaluta is a code owner

Copilot code review Copilot Awaiting requested review from Copilot Copilot will automatically review once the pull request is marked ready for review

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jsarha @lyakh @kv2019i