[PATCH] doc: sframe: mention errata 1 of SFrame version 2

With the changes of an added flag SFRAME_F_FDE_FUNC_START_PCREL, s390x
support and new section type SHT_GNU_SFRAME, indicate that this document
specifies the errata 1 of SFrame version 2.  This will help distinguish
the document / specification better from previous releases.

libsframe/doc/
	* sframe-spec.texi: Mention errata 1 of SFrame version 2.
This commit is contained in:
Indu Bhagat
2025-07-27 09:15:37 +01:00
committed by Nick Clifton
parent bb6b63d7b1
commit 4b28a4c542

View File

@@ -20,7 +20,7 @@ License''.
@titlepage
@title The SFrame Format
@subtitle Version 2
@subtitle Version 2 (Errata 1)
@sp 15
@center @today{}
@author Indu Bhagat
@@ -35,9 +35,9 @@ License''.
@node Top
@top The SFrame format
This manual describes version 2 of the SFrame file format. SFrame stands for
Simple Frame. The SFrame format keeps track of the minimal necessary
information needed for generating stack traces:
This manual describes version 2 (errata 1) of the SFrame file format. SFrame
stands for Simple Frame. The SFrame format keeps track of the minimal
necessary information needed for generating stack traces:
@itemize @minus
@item
@@ -130,9 +130,9 @@ the data structure.
The above two imply that each SFrame function descriptor entry has a fixed size
of 20 bytes instead of its size of 17 bytes in SFrame format version 1.
@item
Add a new flag SFRAME_F_FDE_FUNC_START_PCREL, as an erratum to SFrame
Version 2, to indicate the encoding of the SFrame FDE function start address
field:
[Errata 1] Add a new flag SFRAME_F_FDE_FUNC_START_PCREL, as an erratum to
SFrame Version 2, to indicate the encoding of the SFrame FDE function start
address field:
@itemize @minus
@item if set, @code{sfde_func_start_address} field contains the offset in
bytes to the start PC of the associated function from the field itself.
@@ -141,8 +141,8 @@ bytes to the start PC of the associated function from the start of the SFrame
section.
@end itemize
@item
Add a new ABI/arch identifier SFRAME_ABI_S390X_ENDIAN_BIG for the s390
architecture (64-bit) s390x ABI. Other s390x-specific backward compatible
[Errata 1] Add a new ABI/arch identifier SFRAME_ABI_S390X_ENDIAN_BIG for the
s390 architecture (64-bit) s390x ABI. Other s390x-specific backward compatible
changes including the following helper definitions have been incrementally
added to SFrame version 2 only:
@itemize @minus
@@ -165,6 +165,8 @@ CFA offset adjustment and then scale down by CFA offset alignment factor).
@item SFRAME_V2_S390X_CFA_OFFSET_DECODE: Decode CFA offset (i.e., scale up
by CFA offset alignment factor and then revert CFA offset adjustment).
@end itemize
@item
[Errata 1] An ELF SFrame section has the type SHT_GNU_SFRAME.
@end itemize
SFrame version 1 is now obsolete and should not be used.