1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/* sframe-stacktrace.c - The SFrame stacktracer.
Copyright (C) 2023 Free Software Foundation, Inc.
This file is part of libsframest.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "config.h"
#include <link.h>
#include <stdlib.h>
#include <stdio.h>
#include <inttypes.h>
#include <stdbool.h>
#include <assert.h>
#include <execinfo.h>
#include <unistd.h>
#include <fcntl.h>
#include <string.h>
#include <ucontext.h>
#include <stdarg.h>
#include "ansidecl.h"
#include "sframe-api.h"
#include "sframe-stacktrace-api.h"
#include "sframe-stacktrace-regs.h"
#include "sframe-state.h"
#define STACK_ELEM_SIZE sizeof(uint64_t)
/* Get the 8 bytes at ADDR from file descriptor FD. */
static int
get_contents_8b (int fd, uint64_t addr, uint64_t *data)
{
size_t sz = 0;
int err = 0;
if (!data)
return sframe_bt_ret_set_errno (&err, SFRAME_BT_ERR_ARG);
if (lseek (fd, addr, SEEK_SET) == -1)
return sframe_bt_ret_set_errno (&err, SFRAME_BT_ERR_LSEEK);
sz = read (fd, data, STACK_ELEM_SIZE);
if (sz != STACK_ELEM_SIZE)
return sframe_bt_ret_set_errno (&err, SFRAME_BT_ERR_READ);
return SFRAME_BT_OK;
}
/* Check if ADDR is valid in SF.
The address is considered invalid, with regards to SFrame, if it's not in
any address range of the main module or any of its DSO's.
Return 1 if valid, 0 otherwise. */
static bool
sframe_valid_addr_p (struct sframest_ctx *sf, uint64_t addr)
{
struct sframest_info *sfinfo;
if (!sf)
return 0;
sfinfo = sframe_find_context (sf, addr);
return sfinfo ? 1 : 0;
}
/* Unwind the stack and collect the stacktrace given SFrame unwind info SF.
If successful, store the return addresses in RA_LST. The RA_SIZE argument
specifies the maximum number of return addresses that can be stored in
RA_LST and contains the number of the addresses collected. */
static int
sframe_unwind (struct sframest_ctx *sf, void **ra_lst, int *ra_size)
{
uint64_t cfa, return_addr, ra_stack_loc, rfp_stack_loc;
struct sframest_info *sfinfo;
sframe_decoder_ctx *dctx;
int cfa_offset, rfp_offset, ra_offset, errnum, i, count;
sframe_frame_row_entry fred, *frep = &fred;
uint64_t pc, rfp, rsp, ra, sframe_vma;
ucontext_t context, *cp = &context;
int err = 0;
if (!sf || !ra_lst || !ra_size)
return sframe_bt_ret_set_errno (&err, SFRAME_BT_ERR_ARG);
/* Get the user context for its registers. */
if (getcontext (cp))
return sframe_bt_ret_set_errno (&err, SFRAME_BT_ERR_GETCONTEXT);
pc = get_context_pc (cp);
rsp = get_context_rsp (cp);
rfp = get_context_rfp (cp);
ra = get_context_ra (cp);
return_addr = ra;
/* Load and set up the SFrame stack trace info for pc. */
sfinfo = sframest_get_sfinfo (sf, pc);
if (!sfinfo || !sfinfo->dctx)
return sframe_bt_ret_set_errno (&err, SFRAME_BT_ERR_DECODE);
count = *ra_size;
for (i = 0; i < count; ++i)
{
dctx = sfinfo->dctx;
sframe_vma = sfinfo->sframe_vma;
pc -= sframe_vma;
errnum = sframe_find_fre (dctx, pc, frep);
if (!errnum)
{
cfa_offset = sframe_fre_get_cfa_offset (dctx, frep, &errnum);
if (errnum == SFRAME_ERR_FREOFFSET_NOPRESENT)
return sframe_bt_ret_set_errno (&err, SFRAME_BT_ERR_CFA_OFFSET);
cfa = ((sframe_fre_get_base_reg_id (frep, &errnum)
== SFRAME_BASE_REG_SP) ? rsp : rfp) + cfa_offset;
ra_offset = sframe_fre_get_ra_offset (dctx, frep, &errnum);
if (!errnum)
{
ra_stack_loc = cfa + ra_offset;
errnum = get_contents_8b (sf->fd, ra_stack_loc, &return_addr);
if (sframe_bt_errno (&errnum))
return sframe_bt_ret_set_errno (&err, SFRAME_BT_ERR_FRE_INVAL);
}
/* Validate and add return address to the list. */
if (!sframe_valid_addr_p (sf, return_addr))
{
i -= 1;
goto find_fre_ra_err;
}
if (i != 0) /* exclude self. */
ra_lst[i-1] = (void *)return_addr;
/* Set up for the next frame. */
rfp_offset = sframe_fre_get_fp_offset (dctx, frep, &errnum);
if (!errnum)
{
rfp_stack_loc = cfa + rfp_offset;
errnum = get_contents_8b (sf->fd, rfp_stack_loc, &rfp);
if (sframe_bt_errno (&errnum))
return sframe_bt_ret_set_errno (&err, SFRAME_BT_ERR_FRE_INVAL);
}
rsp = cfa;
pc = return_addr;
/* Check if need to update the SFrame stack trace info for the return
addr. */
if (!sframest_sfinfo_addr_range_p (sfinfo, return_addr))
{
sfinfo = sframest_get_sfinfo (sf, pc);
if (!sfinfo || !sfinfo->dctx)
return sframe_bt_ret_set_errno (&err, SFRAME_BT_ERR_DECODE);
}
}
else
{
i -= 1;
goto find_fre_ra_err;
}
}
find_fre_ra_err:
*ra_size = i;
return SFRAME_BT_OK;
}
/* Main API that user program calls to get a stacktrace.
The BUFFER argument provides space for the list of the return addresses
and the SIZE argument specifies the maximum number of addresses that
can be stored in the buffer.
Returns the number of return addresses collected or -1 if there is any
error. ERRP is set with the error code if any. */
int
sframe_stacktrace (void **buffer, int size, int *errp)
{
struct sframest_ctx sf_ctx;
sframe_unwind_init_debug ();
memset (&sf_ctx, 0, sizeof (struct sframest_ctx));
/* Find the .sframe sections and setup the SFrame state for generating stack
traces. */
(void) dl_iterate_phdr (sframe_callback, (void *)&sf_ctx);
if (!sf_ctx.fd)
{
sframe_bt_ret_set_errno (errp, SFRAME_BT_ERR_BAD_SFSTATE);
return -1;
}
/* Do the stack unwinding. */
*errp = sframe_unwind (&sf_ctx, buffer, &size);
if (sframe_bt_errno (errp))
size = -1;
sframest_ctx_free (&sf_ctx);
return size;
}
|
