Documentation: livepatch: document reliable stacktrace
authorMark Rutland <mark.rutland@arm.com>
Wed, 20 Jan 2021 16:47:14 +0000 (16:47 +0000)
committerJiri Kosina <jkosina@suse.cz>
Tue, 26 Jan 2021 10:50:00 +0000 (11:50 +0100)
commitf89f20acff2d0f7a4801dc6ecde3de1ef0abe1d2
tree340198b44b0f35652dc2b6a7dd61451c7440d0b0
parent7af6fbddbd3379243f11367ca03e2635e42b89ba
Documentation: livepatch: document reliable stacktrace

Add documentation for reliable stacktrace. This is intended to describe
the semantics and to be an aid for implementing architecture support for
HAVE_RELIABLE_STACKTRACE.

Unwinding is a subtle area, and architectures vary greatly in both
implementation and the set of concerns that affect them, so I've tried
to avoid making this too specific to any given architecture. I've used
examples from both x86_64 and arm64 to explain corner cases in more
detail, but I've tried to keep the descriptions sufficient for those who
are unfamiliar with the particular architecture.

This document aims to give rationale for all the recommendations and
requirements, since that makes it easier to spot nearby issues, or when
a check happens to catch a few things at once.

Signed-off-by: Mark Rutland <mark.rutland@arm.com>
[Updates following review -- broonie]
Acked-by: Josh Poimboeuf <jpoimboe@redhat.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>
Documentation/livepatch/index.rst
Documentation/livepatch/reliable-stacktrace.rst [new file with mode: 0644]