1 /* sframe-dump.c - Textual dump of .sframe.
3 Copyright (C) 2022-2023 Free Software Foundation, Inc.
5 This file is part of libsframe.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "sframe-impl.h"
26 #define SFRAME_HEADER_FLAGS_STR_MAX_LEN 50
28 /* Return TRUE if the SFrame section is associated with the aarch64 ABIs. */
31 is_sframe_abi_arch_aarch64 (sframe_decoder_ctx
*sfd_ctx
)
33 bool aarch64_p
= false;
35 unsigned char abi_arch
= sframe_decoder_get_abi_arch (sfd_ctx
);
36 if ((abi_arch
== SFRAME_ABI_AARCH64_ENDIAN_BIG
)
37 || (abi_arch
== SFRAME_ABI_AARCH64_ENDIAN_LITTLE
))
44 dump_sframe_header (sframe_decoder_ctx
*sfd_ctx
)
46 const char *verstr
= NULL
;
47 const sframe_header
*header
= &(sfd_ctx
->sfd_header
);
49 /* Prepare SFrame section version string. */
50 const char *version_names
[]
53 unsigned char ver
= header
->sfh_preamble
.sfp_version
;
54 if (ver
<= SFRAME_VERSION
)
55 verstr
= version_names
[ver
];
57 /* Prepare SFrame section flags string. */
58 unsigned char flags
= header
->sfh_preamble
.sfp_flags
;
60 = (char*) calloc (sizeof (char), SFRAME_HEADER_FLAGS_STR_MAX_LEN
);
63 const char *flag_names
[]
64 = { "SFRAME_F_FDE_SORTED",
65 "SFRAME_F_FRAME_POINTER" };
66 unsigned char flags
= header
->sfh_preamble
.sfp_flags
;
67 if (flags
& SFRAME_F_FDE_SORTED
)
68 strcpy (flags_str
, flag_names
[0]);
69 if (flags
& SFRAME_F_FRAME_POINTER
)
71 if (strlen (flags_str
) > 0)
72 strcpy (flags_str
, ",");
73 strcpy (flags_str
, flag_names
[1]);
77 strcpy (flags_str
, "NONE");
79 const char* subsec_name
= "Header";
81 printf (" %s :\n", subsec_name
);
83 printf (" Version: %s\n", verstr
);
84 printf (" Flags: %s\n", flags_str
);
85 printf (" Num FDEs: %d\n", header
->sfh_num_fdes
);
86 printf (" Num FREs: %d\n", header
->sfh_num_fres
);
92 dump_sframe_func_with_fres (sframe_decoder_ctx
*sfd_ctx
,
97 uint32_t num_fres
= 0;
98 uint32_t func_size
= 0;
99 int32_t func_start_address
= 0;
100 unsigned char func_info
= 0;
102 uint64_t func_start_pc_vma
= 0;
103 uint64_t fre_start_pc_vma
= 0;
104 const char *base_reg_str
[] = {"fp", "sp"};
105 int32_t cfa_offset
= 0;
106 int32_t fp_offset
= 0;
107 int32_t ra_offset
= 0;
108 unsigned int base_reg_id
= 0;
109 int err
[3] = {0, 0, 0};
111 sframe_frame_row_entry fre
;
113 /* Get the SFrame function descriptor. */
114 sframe_decoder_get_funcdesc (sfd_ctx
, funcidx
, &num_fres
,
115 &func_size
, &func_start_address
, &func_info
);
116 /* Calculate the virtual memory address for function start pc. */
117 func_start_pc_vma
= func_start_address
+ sec_addr
;
119 /* Mark FDEs with [m] where the FRE start address is interpreted as a
121 int fde_type_addrmask_p
= (SFRAME_V1_FUNC_FDE_TYPE (func_info
)
122 == SFRAME_FDE_TYPE_PCMASK
);
123 const char *fde_type_marker
124 = (fde_type_addrmask_p
? "[m]" : " ");
126 printf ("\n func idx [%d]: pc = 0x%"PRIx64
", size = %d bytes",
131 if (is_sframe_abi_arch_aarch64 (sfd_ctx
)
132 && (SFRAME_V1_FUNC_PAUTH_KEY (func_info
) == SFRAME_AARCH64_PAUTH_KEY_B
))
133 printf (", pauth = B key");
137 printf ("\n %-7s%-8s %-10s%-10s%-13s",
138 "STARTPC", fde_type_marker
, "CFA", "FP", "RA");
139 for (j
= 0; j
< num_fres
; j
++)
141 sframe_decoder_get_fre (sfd_ctx
, funcidx
, j
, &fre
);
143 fre_start_pc_vma
= (fde_type_addrmask_p
145 : func_start_pc_vma
+ fre
.fre_start_addr
);
147 /* FIXME - fixup the err caching in array.
148 assert no error for base reg id. */
149 base_reg_id
= sframe_fre_get_base_reg_id (&fre
, &err
[0]);
150 cfa_offset
= sframe_fre_get_cfa_offset (sfd_ctx
, &fre
, &err
[0]);
151 fp_offset
= sframe_fre_get_fp_offset (sfd_ctx
, &fre
, &err
[1]);
152 ra_offset
= sframe_fre_get_ra_offset (sfd_ctx
, &fre
, &err
[2]);
156 printf (" %016"PRIx64
, fre_start_pc_vma
);
157 sprintf (temp
, "%s+%d", base_reg_str
[base_reg_id
], cfa_offset
);
158 printf (" %-10s", temp
);
160 /* Dump SP/FP info. */
162 sprintf (temp
, "c%+d", fp_offset
);
165 printf ("%-10s", temp
);
168 If an ABI does not track RA offset, e.g., AMD64, display a 'u',
169 else display the offset d as 'c+-d'. */
170 if (sframe_decoder_get_fixed_ra_offset(sfd_ctx
)
171 != SFRAME_CFA_FIXED_RA_INVALID
)
173 else if (err
[2] == 0)
174 sprintf (temp
, "c%+d", ra_offset
);
176 /* Mark SFrame FRE's RA information with "[s]" if the RA is mangled
177 with signature bits. */
178 const char *ra_mangled_p_str
179 = ((sframe_fre_get_ra_mangled_p (sfd_ctx
, &fre
, &err
[2]))
181 strcat (temp
, ra_mangled_p_str
);
182 printf ("%-13s", temp
);
187 dump_sframe_functions (sframe_decoder_ctx
*sfd_ctx
, uint64_t sec_addr
)
192 const char* subsec_name
= "Function Index";
193 printf ("\n %s :\n", subsec_name
);
195 num_fdes
= sframe_decoder_get_num_fidx (sfd_ctx
);
196 for (i
= 0; i
< num_fdes
; i
++)
198 dump_sframe_func_with_fres (sfd_ctx
, i
, sec_addr
);
204 dump_sframe (sframe_decoder_ctx
*sfd_ctx
, uint64_t sec_addr
)
206 dump_sframe_header (sfd_ctx
);
207 dump_sframe_functions (sfd_ctx
, sec_addr
);