/
unwind_table.go
307 lines (265 loc) · 9.06 KB
/
unwind_table.go
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
// Copyright 2022-2024 The Parca Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
package unwind
import (
"debug/elf"
"errors"
"fmt"
"io"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/parca-dev/parca-agent/internal/dwarf/frame"
)
var (
ErrNoFDEsFound = errors.New("no FDEs found")
ErrEhFrameSectionNotFound = errors.New("failed to find .eh_frame section")
ErrNoRegisterFound = errors.New("architecture not supported")
)
type UnwindTableBuilder struct {
logger log.Logger
}
func NewUnwindTableBuilder(logger log.Logger) *UnwindTableBuilder {
return &UnwindTableBuilder{logger: logger}
}
// From 3.6.2 DWARF Register Number Mapping for x86_64, Fig 3.36
// https://refspecs.linuxbase.org/elf/x86_64-abi-0.99.pdf
var x86_64Regs = []string{
"rax", "rdx", "rcx", "rbx", "rsi", "rdi", "rbp", "rsp", "r8", "r9", "r10", "r11",
"r12", "r13", "r14", "r15", "rip", "xmm0", "xmm1", "xmm2", "xmm3", "xmm4", "xmm5",
"xmm6", "xmm7", "xmm8", "xmm9", "xmm10", "xmm11", "xmm12", "xmm13", "xmm14", "xmm15",
"st0", "st1", "st2", "st3", "st4", "st5", "st6", "st7", "mm0", "mm1", "mm2", "mm3",
"mm4", "mm5", "mm6", "mm7", "rflags", "es", "cs", "ss", "ds", "fs", "gs",
"unused1", "unused2", "fs.base", "gs.base", "unused3", "unused4", "tr", "ldtr",
"mxcsr", "fcw", "fsw",
}
// From 4.1 DWARF Register Names for Aarch64/Arm64
// https://github.com/ARM-software/abi-aa/blob/2023q1-release/aadwarf64/aadwarf64.rst#dwarf-register-names
// maybe r0...r30 will also work, but x0..x30 preferred for 64 bit archs and
// what `gdb` shows on passing `info all-registers`:
// x29 -> fp
// x30 -> lr
// x31 -> sp
// x32 -> pc
// x33 -> cpsr.
var arm64Regs = []string{
"x0", "x1", "x2", "x3", "x4", "x5", "x6", "x7", "x8", "x9", "x10", "x11",
"x12", "x13", "x14", "x15", "x16", "x17", "x18", "x18", "x19", "x20",
"x21", "x22", "x23", "x24", "x25", "x26", "x27", "x28", "x29", "x30",
"sp", "pc", "cpsr",
}
func registerToString(reg uint64, arch elf.Machine) string {
if arch == elf.EM_X86_64 {
return x86_64Regs[reg]
} else if arch == elf.EM_AARCH64 {
return arm64Regs[reg]
}
return ErrNoRegisterFound.Error()
}
// PrintTable is a debugging helper that prints the unwinding table to the given io.Writer.
func (ptb *UnwindTableBuilder) PrintTable(writer io.Writer, path string, compact bool, pc *uint64) error {
fdes, arch, err := ReadFDEs(path)
if err != nil {
return err
}
// The frame package can raise in case of malformed unwind data.
defer func() {
if r := recover(); r != nil {
level.Info(ptb.logger).Log("msg", "recovered a panic in PrintTable", "stack", r)
}
}()
unwindContext := frame.NewContext()
for _, fde := range fdes {
if pc != nil {
if fde.Begin() > *pc || *pc > fde.End() {
continue
}
}
fmt.Fprintf(writer, "=> Function start: %x, Function end: %x\n", fde.Begin(), fde.End())
frameContext, err := frame.ExecuteDWARFProgram(fde, unwindContext)
if err != nil {
return err
}
for {
insCtx, err := frameContext.Next()
if err != nil {
return err
}
if !frameContext.HasNext() {
break
}
unwindRow := unwindTableRow(insCtx)
if unwindRow == nil {
break
}
if compact {
compactRow, err := rowToCompactRow(unwindRow, arch)
if err != nil {
return err
}
showLr := arch == elf.EM_AARCH64
fmt.Fprintf(writer, "\t%s\n", compactRow.ToString(showLr))
} else {
//nolint:exhaustive
switch unwindRow.CFA.Rule {
case frame.RuleCFA:
CFAReg := registerToString(unwindRow.CFA.Reg, arch)
fmt.Fprintf(writer, "\tLoc: %x CFA: $%s=%-4d", unwindRow.Loc, CFAReg, unwindRow.CFA.Offset)
case frame.RuleExpression:
expressionID := ExpressionIdentifier(unwindRow.CFA.Expression, arch)
if expressionID == ExpressionUnknown {
fmt.Fprintf(writer, "\tLoc: %x CFA: exp ", unwindRow.Loc)
} else {
fmt.Fprintf(writer, "\tLoc: %x CFA: exp (plt %d)", unwindRow.Loc, expressionID)
}
default:
return errors.New("CFA rule is not valid. This should never happen")
}
// RuleRegister
//nolint:exhaustive
switch unwindRow.RBP.Rule {
case frame.RuleUndefined, frame.RuleUnknown:
fmt.Fprintf(writer, "\tRBP: u")
case frame.RuleRegister:
RBPReg := registerToString(unwindRow.RBP.Reg, arch)
fmt.Fprintf(writer, "\tRBP: $%s", RBPReg)
case frame.RuleOffset:
// Interesting we end up here and register is not assigned
// TODO(sylfrena): verify if this is expected
fmt.Fprintf(writer, "\tRBP: c%-4d", unwindRow.RBP.Offset)
case frame.RuleExpression:
fmt.Fprintf(writer, "\tRBP: exp")
default:
panic(fmt.Sprintf("Got rule %d for RBP, which wasn't expected", unwindRow.RBP.Rule))
}
//nolint:exhaustive
switch unwindRow.RA.Rule {
case frame.RuleUndefined, frame.RuleUnknown:
// RA is ideally always defined for arm64
if arch == elf.EM_AARCH64 {
fmt.Fprintf(writer, "\tRA($%s): u", arch.String())
}
case frame.RuleRegister:
RAReg := registerToString(unwindRow.RA.Reg, arch)
if arch == elf.EM_AARCH64 {
fmt.Fprintf(writer, "\tRA: $%s", RAReg)
}
case frame.RuleOffset:
// Note: This condition is also executed(with offset 0 -> c0) when it is the last frame for an FDE
// `readelf` shows RA as undefined here but clearly the offset is considered 0 here in arm64
if arch == elf.EM_AARCH64 {
fmt.Fprintf(writer, "\tRA: c%-4d", unwindRow.RA.Offset)
}
case frame.RuleExpression:
if arch == elf.EM_AARCH64 {
fmt.Fprintf(writer, "\tRA: exp")
}
default:
panic(fmt.Sprintf("Got rule %d for RA, which wasn't expected", unwindRow.RA.Rule))
}
fmt.Fprintf(writer, "\n")
}
}
}
return nil
}
func ReadFDEs(path string) (frame.FrameDescriptionEntries, elf.Machine, error) {
// TODO(kakkoyun): Migrate objectfile and pool.
obj, err := elf.Open(path)
if err != nil {
return nil, elf.EM_NONE, fmt.Errorf("failed to open elf: %w", err)
}
defer obj.Close()
arch := obj.Machine
sec := obj.Section(".eh_frame")
if sec == nil {
return nil, arch, ErrEhFrameSectionNotFound
}
// TODO: Consider using the debug_frame section as a fallback.
// TODO: Needs to support DWARF64 as well.
ehFrame, err := sec.Data()
if err != nil {
return nil, arch, fmt.Errorf("failed to read .eh_frame section: %w", err)
}
// TODO: Byte order of a DWARF section can be different.
fdes, err := frame.Parse(ehFrame, obj.ByteOrder, 0, pointerSize(obj.Machine), sec.Addr)
if err != nil {
return nil, arch, fmt.Errorf("failed to parse frame data: %w", err)
}
if len(fdes) == 0 {
return nil, arch, ErrNoFDEsFound
}
return fdes, arch, nil
}
func BuildUnwindTable(fdes frame.FrameDescriptionEntries) (UnwindTable, error) {
// The frame package can raise in case of malformed unwind data.
table := make(UnwindTable, 0, 4*len(fdes)) // heuristic
for _, fde := range fdes {
frameContext, err := frame.ExecuteDWARFProgram(fde, nil)
if err != nil {
return UnwindTable{}, err
}
for {
insCtx, err := frameContext.Next()
if err != nil {
return UnwindTable{}, err
}
if !frameContext.HasNext() {
break
}
table = append(table, *unwindTableRow(insCtx))
}
}
return table, nil
}
// UnwindTableRow represents a single row in the unwind table.
// x86_64: rip (instruction pointer register), rsp (stack pointer register), rbp (base pointer/frame pointer register)
// aarch64: lr(link register), sp(stack pointer register), fp(frame pointer register)
type UnwindTableRow struct {
// The address of the machine instruction.
// Each row covers a range of machine instruction, from its address (Loc) to that of the row below.
Loc uint64
// CFA, the value of the stack pointer in the previous frame.
CFA frame.DWRule
// The value of the RBP register.
RBP frame.DWRule
// The value of the saved return address. This is not needed in x86_64 as it's part of the ABI but is necessary
// in arm64.
RA frame.DWRule
}
type UnwindTable []UnwindTableRow
func (t UnwindTable) Len() int { return len(t) }
func (t UnwindTable) Less(i, j int) bool { return t[i].Loc < t[j].Loc }
func (t UnwindTable) Swap(i, j int) { t[i], t[j] = t[j], t[i] }
func unwindTableRow(instructionContext *frame.InstructionContext) *UnwindTableRow {
if instructionContext == nil {
return nil
}
return &UnwindTableRow{
Loc: instructionContext.Loc(),
CFA: instructionContext.CFA,
RA: instructionContext.Regs.SavedReturn,
RBP: instructionContext.Regs.FramePointer,
}
}
func pointerSize(arch elf.Machine) int {
//nolint:exhaustive
switch arch {
case elf.EM_386:
return 4
case elf.EM_AARCH64, elf.EM_X86_64:
return 8
default:
return 0
}
}