aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDouglas Raillard <douglas.raillard@arm.com>2018-08-21 12:54:45 +0100
committerAntonio Nino Diaz <antonio.ninodiaz@arm.com>2018-08-30 09:21:53 +0100
commit0c62883f7eed80f02c3585d7d0e408def0569f7c (patch)
treef6e80c7bf13499b6817299def7a498a5b8985c35 /docs
parent8fd9d4d58a2f1af37fd1e3e71ee9d81f50c67684 (diff)
downloadplatform_external_arm-trusted-firmware-0c62883f7eed80f02c3585d7d0e408def0569f7c.tar.gz
platform_external_arm-trusted-firmware-0c62883f7eed80f02c3585d7d0e408def0569f7c.tar.bz2
platform_external_arm-trusted-firmware-0c62883f7eed80f02c3585d7d0e408def0569f7c.zip
backtrace: Introduce backtrace function
This function diplays the backtrace, the current EL and security state to allow a post-processing tool to choose the right binary to interpret the dump. The output can be fed to GNU addr2line to resolve function names given an ELF binary compiled with debug information. The "-i" flag is recommended to improve display in case of inlined functions. The *.dump files generated during the build process can also be used. The function works in AArch64 and AArch32. In AArch32 it only works in A32 mode (without T32 interworking), which is enforced in the Makefile. Sample output of a backtrace at EL3: BACKTRACE: START: function_name 0: EL3: 0x798 1: EL3: 0x538 2: EL3: 0x550 3: EL3: 0x55c 4: EL3: 0x568 5: EL3: 0x5a8 6: EL3: 0xf4 BACKTRACE: END: function_name In order to enable it the new option ENABLE_BACKTRACE must be set to 1. This option is set to 1 by default only in AArch64 debug builds. As usual, it can be overridden by the platform makefile and in the build command line. Change-Id: Icaff39b0e5188329728be2f3c72b868b2368e794 Co-authored-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com> Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com> Signed-off-by: Douglas Raillard <douglas.raillard@arm.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/user-guide.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index b8baf4711..5ec932f93 100644
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -355,6 +355,16 @@ Common build options
that is only required for the assertion and does not fit in the assertion
itself.
+- ``ENABLE_BACKTRACE``: This option controls whether to enables backtrace
+ dumps or not. It is supported in both AArch64 and AArch32. However, in
+ AArch32 the format of the frame records are not defined in the AAPCS and they
+ are defined by the implementation. This implementation of backtrace only
+ supports the format used by GCC when T32 interworking is disabled. For this
+ reason enabling this option in AArch32 will force the compiler to only
+ generate A32 code. This option is enabled by default only in AArch64 debug
+ builds, but this behaviour can be overriden in each platform's Makefile or in
+ the build command line.
+
- ``ENABLE_MPAM_FOR_LOWER_ELS``: Boolean option to enable lower ELs to use MPAM
feature. MPAM is an optional Armv8.4 extension that enables various memory
system components and resources to define partitions; software running at