[3/3] doc: sframe: Clarify FDE/FRE function/range start address fields

Message ID 20250203135707.1300569-4-jremus@linux.ibm.com
State New
Headers
Series sframe: Cleanups an documentation improvement |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_binutils_build--master-arm success Build passed
linaro-tcwg-bot/tcwg_binutils_build--master-aarch64 success Build passed
linaro-tcwg-bot/tcwg_binutils_check--master-aarch64 success Test passed
linaro-tcwg-bot/tcwg_binutils_check--master-arm success Test passed

Commit Message

Jens Remus Feb. 3, 2025, 1:57 p.m. UTC
  The function start address in a SFrame FDE (sfde_func_start_address)
is encoded as a signed offset to the function start address from the
SFrame section.

The PC range start address in a SFrame FRE (sfre_start_address) is
encoded as an unsigned offset to the range from the function start
address.

Signed-off-by: Jens Remus <jremus@linux.ibm.com>
---
 libsframe/doc/sframe-spec.texi | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)
  

Patch

diff --git a/libsframe/doc/sframe-spec.texi b/libsframe/doc/sframe-spec.texi
index eb706901d7fd..ae115705ca73 100644
--- a/libsframe/doc/sframe-spec.texi
+++ b/libsframe/doc/sframe-spec.texi
@@ -459,7 +459,9 @@  Following table describes each component of the SFrame FDE structure:
 @tab @code{int32_t}
 @tab @code{sfde_func_start_address}
 @tab Signed 32-bit integral field denoting the virtual memory address of the
-described function.
+described function, for which the SFrame FDE applies.  The value encoded in
+the @code{sfde_func_start_address} field is the offset in bytes of the
+function's start address, from the SFrame section.
 
 @item 0x04
 @tab @code{uint32_t}
@@ -684,10 +686,10 @@  serializing and deserializing entities, if unaligned accesses need to be
 avoided.
 
 @code{sfre_start_address} is an unsigned 8-bit/16-bit/32-bit integral field
-identifies the start address of the range of program counters, for which the
+denoting the start address of a range of program counters, for which the
 SFrame FRE applies.  The value encoded in the @code{sfre_start_address} field
-is the offset in bytes of the start address of the SFrame FRE, from the start
-address of the function.
+is the offset in bytes of the range's start address, from the start address
+of the function.
 
 Further SFrame FRE types may be added in future.