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 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
|
package proc
import (
"bytes"
"debug/elf"
"encoding/binary"
"errors"
"fmt"
"runtime"
"sync"
"github.com/go-delve/delve/pkg/elfwriter"
"github.com/go-delve/delve/pkg/version"
)
var (
ErrMemoryMapNotSupported = errors.New("MemoryMap not supported")
)
// DumpState represents the current state of a core dump in progress.
type DumpState struct {
Mutex sync.Mutex
Dumping bool
AllDone bool
Canceled bool
DoneChan chan struct{}
ThreadsDone, ThreadsTotal int
MemDone, MemTotal uint64
Err error
}
// DumpFlags is used to configure (*Target).Dump
type DumpFlags uint16
const (
DumpPlatformIndependent DumpFlags = 1 << iota // always use platform-independent notes format
)
// MemoryMapEntry represent a memory mapping in the target process.
type MemoryMapEntry struct {
Addr uint64
Size uint64
Read, Write, Exec bool
Filename string
Offset uint64
}
func (state *DumpState) setErr(err error) {
if err == nil {
return
}
state.Mutex.Lock()
if state.Err == nil {
state.Err = err
}
state.Mutex.Unlock()
}
func (state *DumpState) setThreadsTotal(n int) {
state.Mutex.Lock()
state.ThreadsTotal = n
state.ThreadsDone = 0
state.Mutex.Unlock()
}
func (state *DumpState) threadDone() {
state.Mutex.Lock()
state.ThreadsDone++
state.Mutex.Unlock()
}
func (state *DumpState) setMemTotal(n uint64) {
state.Mutex.Lock()
state.MemTotal = n
state.Mutex.Unlock()
}
func (state *DumpState) memDone(delta uint64) {
state.Mutex.Lock()
state.MemDone += delta
state.Mutex.Unlock()
}
func (state *DumpState) isCanceled() bool {
state.Mutex.Lock()
defer state.Mutex.Unlock()
return state.Canceled
}
// Dump writes a core dump to out. State is updated as the core dump is written.
func (t *Target) Dump(out elfwriter.WriteCloserSeeker, flags DumpFlags, state *DumpState) {
defer func() {
state.Mutex.Lock()
if ierr := recover(); ierr != nil {
state.Err = newInternalError(ierr, 2)
}
err := out.Close()
if state.Err == nil && err != nil {
state.Err = fmt.Errorf("error writing output file: %v", err)
}
state.Dumping = false
state.Mutex.Unlock()
if state.DoneChan != nil {
close(state.DoneChan)
}
}()
bi := t.BinInfo()
var fhdr elf.FileHeader
fhdr.Class = elf.ELFCLASS64
fhdr.Data = elf.ELFDATA2LSB
fhdr.Version = elf.EV_CURRENT
switch bi.GOOS {
case "linux":
fhdr.OSABI = elf.ELFOSABI_LINUX
case "freebsd":
fhdr.OSABI = elf.ELFOSABI_FREEBSD
default:
// There is no OSABI value for windows or macOS because nobody generates ELF core dumps on those systems.
fhdr.OSABI = 0xff
}
fhdr.Type = elf.ET_CORE
switch bi.Arch.Name {
case "amd64":
fhdr.Machine = elf.EM_X86_64
case "386":
fhdr.Machine = elf.EM_386
case "arm64":
fhdr.Machine = elf.EM_AARCH64
case "ppc64le":
fhdr.Machine = elf.EM_PPC64
case "riscv64":
fhdr.Machine = elf.EM_RISCV
default:
panic("not implemented")
}
fhdr.Entry = 0
w := elfwriter.New(out, &fhdr)
notes := []elfwriter.Note{}
entryPoint, err := t.EntryPoint()
if err != nil {
state.setErr(err)
return
}
notes = append(notes, elfwriter.Note{
Type: elfwriter.DelveHeaderNoteType,
Name: "Delve Header",
Data: []byte(fmt.Sprintf("%s/%s\n%s\n%s%d\n%s%#x\n", bi.GOOS, bi.Arch.Name, version.DelveVersion.String(), elfwriter.DelveHeaderTargetPidPrefix, t.pid, elfwriter.DelveHeaderEntryPointPrefix, entryPoint)),
})
threads := t.ThreadList()
state.setThreadsTotal(len(threads))
var threadsDone bool
if flags&DumpPlatformIndependent == 0 {
threadsDone, notes, err = t.proc.DumpProcessNotes(notes, state.threadDone)
if err != nil {
state.setErr(err)
return
}
}
if !threadsDone {
for _, th := range threads {
if w.Err != nil {
state.setErr(fmt.Errorf("error writing to output file: %v", w.Err))
return
}
if state.isCanceled() {
return
}
notes = t.dumpThreadNotes(notes, state, th)
state.threadDone()
}
}
memmap, err := t.proc.MemoryMap()
if err != nil {
state.setErr(err)
return
}
memmapFilter := make([]MemoryMapEntry, 0, len(memmap))
memtot := uint64(0)
for i := range memmap {
mme := &memmap[i]
if t.shouldDumpMemory(mme) {
memmapFilter = append(memmapFilter, *mme)
memtot += mme.Size
}
}
state.setMemTotal(memtot)
for i := range memmapFilter {
mme := &memmapFilter[i]
if w.Err != nil {
state.setErr(fmt.Errorf("error writing to output file: %v", w.Err))
return
}
if state.isCanceled() {
return
}
t.dumpMemory(state, w, mme)
}
notesProg := w.WriteNotes(notes)
w.Progs = append(w.Progs, notesProg)
w.WriteProgramHeaders()
if w.Err != nil {
state.setErr(fmt.Errorf("error writing to output file: %v", w.Err))
}
state.Mutex.Lock()
state.AllDone = true
state.Mutex.Unlock()
}
// dumpThreadNotes appends notes describing a thread (thread id and its
// registers) using a platform-independent format.
func (t *Target) dumpThreadNotes(notes []elfwriter.Note, state *DumpState, th Thread) []elfwriter.Note {
// If the backend doesn't provide a way to dump a thread we use a custom format for the note:
// - thread_id (8 bytes)
// - pc value (8 bytes)
// - sp value (8 bytes)
// - bp value (8 bytes)
// - tls value (8 bytes)
// - has_gaddr (1 byte)
// - gaddr value (8 bytes)
// - num_registers (4 bytes)
// Followed by a list of num_register, each as follows:
// - register_name_len (2 bytes)
// - register_name (register_name_len bytes)
// - register_data_len (2 bytes)
// - register_data (register_data_len bytes)
buf := new(bytes.Buffer)
_ = binary.Write(buf, binary.LittleEndian, uint64(th.ThreadID()))
regs, err := th.Registers()
if err != nil {
state.setErr(err)
return notes
}
for _, specialReg := range []uint64{regs.PC(), regs.SP(), regs.BP(), regs.TLS()} {
binary.Write(buf, binary.LittleEndian, specialReg)
}
gaddr, hasGaddr := regs.GAddr()
binary.Write(buf, binary.LittleEndian, hasGaddr)
binary.Write(buf, binary.LittleEndian, gaddr)
regsv, err := regs.Slice(true)
if err != nil {
state.setErr(err)
return notes
}
binary.Write(buf, binary.LittleEndian, uint32(len(regsv)))
for _, reg := range regsv {
binary.Write(buf, binary.LittleEndian, uint16(len(reg.Name)))
buf.WriteString(reg.Name)
if reg.Reg.Bytes != nil {
binary.Write(buf, binary.LittleEndian, uint16(len(reg.Reg.Bytes)))
buf.Write(reg.Reg.Bytes)
} else {
binary.Write(buf, binary.LittleEndian, uint16(8))
binary.Write(buf, binary.LittleEndian, reg.Reg.Uint64Val)
}
}
return append(notes, elfwriter.Note{
Type: elfwriter.DelveThreadNodeType,
Name: "",
Data: buf.Bytes(),
})
}
func (t *Target) dumpMemory(state *DumpState, w *elfwriter.Writer, mme *MemoryMapEntry) {
var flags elf.ProgFlag
if mme.Read {
flags |= elf.PF_R
}
if mme.Write {
flags |= elf.PF_W
}
if mme.Exec {
flags |= elf.PF_X
}
w.Progs = append(w.Progs, &elf.ProgHeader{
Type: elf.PT_LOAD,
Flags: flags,
Off: uint64(w.Here()),
Vaddr: mme.Addr,
Paddr: 0,
Filesz: mme.Size,
Memsz: mme.Size,
Align: 0,
})
buf := make([]byte, 1024*1024)
addr := mme.Addr
sz := mme.Size
mem := t.Memory()
for sz > 0 {
if w.Err != nil {
state.setErr(fmt.Errorf("error writing to output file: %v", w.Err))
return
}
if state.isCanceled() {
return
}
chunk := buf
if uint64(len(chunk)) > sz {
chunk = chunk[:sz]
}
n, err := mem.ReadMemory(chunk, addr)
for i := n; i < len(chunk); i++ {
chunk[i] = 0
}
// Errors and short reads are ignored, the most likely reason is that
// (*ProcessInternal).MemoryMap gave us a bad mapping that can't be read
// and the behavior that's maximally useful to the user is to generate an
// incomplete dump.
w.Write(chunk)
addr += uint64(len(chunk))
sz -= uint64(len(chunk))
if err == nil {
state.memDone(uint64(len(chunk)))
}
}
}
func (t *Target) shouldDumpMemory(mme *MemoryMapEntry) bool {
if !mme.Read {
return false
}
exeimg := t.BinInfo().Images[0]
if mme.Write || mme.Filename == "" || mme.Filename != exeimg.Path {
return true
}
isgo := false
for _, cu := range exeimg.compileUnits {
if cu.isgo {
isgo = true
break
}
}
if !isgo {
return true
}
exe, err := elf.Open(exeimg.Path)
if err != nil {
return true
}
if exe.Type != elf.ET_EXEC {
return true
}
for _, prog := range exe.Progs {
if prog.Type == elf.PT_LOAD && (prog.Flags&elf.PF_W == 0) && (prog.Flags&elf.PF_R != 0) && (prog.Vaddr == mme.Addr) && (prog.Memsz == mme.Size) && (prog.Off == mme.Offset) {
return false
}
}
return true
}
type internalError struct {
Err interface{}
Stack []internalErrorFrame
}
type internalErrorFrame struct {
Pc uintptr
Func string
File string
Line int
}
func newInternalError(ierr interface{}, skip int) *internalError {
r := &internalError{ierr, nil}
for i := skip; ; i++ {
pc, file, line, ok := runtime.Caller(i)
if !ok {
break
}
fname := "<unknown>"
fn := runtime.FuncForPC(pc)
if fn != nil {
fname = fn.Name()
}
r.Stack = append(r.Stack, internalErrorFrame{pc, fname, file, line})
}
return r
}
func (err *internalError) Error() string {
var out bytes.Buffer
fmt.Fprintf(&out, "Internal debugger error: %v\n", err.Err)
for _, frame := range err.Stack {
fmt.Fprintf(&out, "%s (%#x)\n\t%s:%d\n", frame.Func, frame.Pc, frame.File, frame.Line)
}
return out.String()
}
|