bininfo.go 22.2 KB
Newer Older
1 2 3
package proc

import (
4
	"bytes"
5 6 7
	"debug/dwarf"
	"debug/elf"
	"debug/macho"
8
	"debug/pe"
9
	"encoding/binary"
10
	"encoding/hex"
11 12 13 14
	"errors"
	"fmt"
	"io"
	"os"
15 16
	"sort"
	"strings"
17 18 19 20
	"sync"
	"time"

	"github.com/derekparker/delve/pkg/dwarf/frame"
21
	"github.com/derekparker/delve/pkg/dwarf/godwarf"
22
	"github.com/derekparker/delve/pkg/dwarf/line"
23
	"github.com/derekparker/delve/pkg/dwarf/op"
24
	"github.com/derekparker/delve/pkg/dwarf/reader"
25
	"github.com/derekparker/delve/pkg/goversion"
26 27 28 29 30
)

type BinaryInfo struct {
	lastModified time.Time // Time the executable of this process was last modified

31 32 33
	GOOS           string
	closer         io.Closer
	sepDebugCloser io.Closer
34 35 36 37

	// Maps package names to package paths, needed to lookup types inside DWARF info
	packageMap map[string]string

38 39 40
	Arch          Arch
	dwarf         *dwarf.Data
	frameEntries  frame.FrameDescriptionEntries
41
	loclist       loclistReader
42
	compileUnits  []*compileUnit
43
	types         map[string]dwarf.Offset
44
	packageVars   []packageVar // packageVars is a list of all global/package variables in debug_info, sorted by address
45
	gStructOffset uint64
46

47
	// Functions is a list of all DW_TAG_subprogram entries in debug_info, sorted by entry point
48 49 50 51 52 53
	Functions []Function
	// Sources is a list of all source files found in debug_line.
	Sources []string
	// LookupFunc maps function names to a description of the function.
	LookupFunc map[string]*Function

54 55
	typeCache map[dwarf.Offset]godwarf.Type

56 57 58
	loadModuleDataOnce sync.Once
	moduleData         []moduleData
	nameOfRuntimeType  map[uintptr]nameOfRuntimeTypeEntry
59

60 61 62 63 64 65
	// runtimeTypeToDIE maps between the offset of a runtime._type in
	// runtime.moduledata.types and the offset of the DIE in debug_info. This
	// map is filled by using the extended attribute godwarf.AttrGoRuntimeType
	// which was added in go 1.11.
	runtimeTypeToDIE map[uint64]runtimeTypeDIE

66 67 68
	// consts[off] lists all the constants with the type defined at offset off.
	consts constantsMap

69 70
	loadErrMu sync.Mutex
	loadErr   error
71 72

	dwarfReader *dwarf.Reader
73 74 75 76 77 78
}

var UnsupportedLinuxArchErr = errors.New("unsupported architecture - only linux/amd64 is supported")
var UnsupportedWindowsArchErr = errors.New("unsupported architecture of windows/386 - only windows/amd64 is supported")
var UnsupportedDarwinArchErr = errors.New("unsupported architecture - only darwin/amd64 is supported")

79 80 81
const dwarfGoLanguage = 22 // DW_LANG_Go (from DWARF v5, section 7.12, page 231)

type compileUnit struct {
82
	Name          string // univocal name for non-go compile units
83
	LowPC, HighPC uint64
84 85 86 87 88 89 90

	entry              *dwarf.Entry        // debug_info entry describing this compile unit
	isgo               bool                // true if this is the go compile unit
	lineInfo           *line.DebugLineInfo // debug_line segment associated with this compile unit
	concreteInlinedFns []inlinedFn         // list of concrete inlined functions within this compile unit
	optimized          bool                // this compile unit is optimized
	producer           string              // producer attribute
91 92
}

93 94 95 96 97 98 99
type partialUnitConstant struct {
	name  string
	typ   dwarf.Offset
	value int64
}

type partialUnit struct {
100 101 102 103 104
	entry     *dwarf.Entry
	types     map[string]dwarf.Offset
	variables []packageVar
	constants []partialUnitConstant
	functions []Function
105 106
}

107 108 109 110 111 112 113 114 115 116
// inlinedFn represents a concrete inlined function, e.g.
// an entry for the generated code of an inlined function.
type inlinedFn struct {
	Name          string    // Name of the function that was inlined
	LowPC, HighPC uint64    // Address range of the generated inlined instructions
	CallFile      string    // File of the call site of the inlined function
	CallLine      int64     // Line of the call site of the inlined function
	Parent        *Function // The function that contains this inlined function
}

117 118 119 120 121 122 123 124 125 126 127 128
// Function describes a function in the target program.
type Function struct {
	Name       string
	Entry, End uint64 // same as DW_AT_lowpc and DW_AT_highpc
	offset     dwarf.Offset
	cu         *compileUnit
}

// PackageName returns the package part of the symbol name,
// or the empty string if there is none.
// Borrowed from $GOROOT/debug/gosym/symtab.go
func (fn *Function) PackageName() string {
129 130 131 132 133
	return packageName(fn.Name)
}

func packageName(name string) string {
	pathend := strings.LastIndex(name, "/")
134 135 136 137
	if pathend < 0 {
		pathend = 0
	}

138 139
	if i := strings.Index(name[pathend:], "."); i != -1 {
		return name[:pathend+i]
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
	}
	return ""
}

// ReceiverName returns the receiver type name of this symbol,
// or the empty string if there is none.
// Borrowed from $GOROOT/debug/gosym/symtab.go
func (fn *Function) ReceiverName() string {
	pathend := strings.LastIndex(fn.Name, "/")
	if pathend < 0 {
		pathend = 0
	}
	l := strings.Index(fn.Name[pathend:], ".")
	r := strings.LastIndex(fn.Name[pathend:], ".")
	if l == -1 || r == -1 || l == r {
		return ""
	}
	return fn.Name[pathend+l+1 : pathend+r]
}

// BaseName returns the symbol name without the package or receiver name.
// Borrowed from $GOROOT/debug/gosym/symtab.go
func (fn *Function) BaseName() string {
	if i := strings.LastIndex(fn.Name, "."); i != -1 {
		return fn.Name[i+1:]
	}
	return fn.Name
}

169 170 171 172 173
// Optimized returns true if the function was optimized by the compiler.
func (fn *Function) Optimized() bool {
	return fn.cu.optimized
}

174 175 176 177 178 179 180 181 182 183 184 185 186 187
type constantsMap map[dwarf.Offset]*constantType

type constantType struct {
	initialized bool
	values      []constantValue
}

type constantValue struct {
	name      string
	fullName  string
	value     int64
	singleBit bool
}

188 189 190 191 192 193 194 195 196
// packageVar represents a package-level variable (or a C global variable).
// If a global variable does not have an address (for example it's stored in
// a register, or non-contiguously) addr will be 0.
type packageVar struct {
	name   string
	offset dwarf.Offset
	addr   uint64
}

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
type loclistReader struct {
	data  []byte
	cur   int
	ptrSz int
}

func (rdr *loclistReader) Seek(off int) {
	rdr.cur = off
}

func (rdr *loclistReader) read(sz int) []byte {
	r := rdr.data[rdr.cur : rdr.cur+sz]
	rdr.cur += sz
	return r
}

func (rdr *loclistReader) oneAddr() uint64 {
	switch rdr.ptrSz {
	case 4:
		addr := binary.LittleEndian.Uint32(rdr.read(rdr.ptrSz))
		if addr == ^uint32(0) {
			return ^uint64(0)
		}
		return uint64(addr)
	case 8:
		addr := uint64(binary.LittleEndian.Uint64(rdr.read(rdr.ptrSz)))
		return addr
	default:
		panic("bad address size")
	}
}

func (rdr *loclistReader) Next(e *loclistEntry) bool {
	e.lowpc = rdr.oneAddr()
	e.highpc = rdr.oneAddr()

	if e.lowpc == 0 && e.highpc == 0 {
		return false
	}

	if e.BaseAddressSelection() {
		e.instr = nil
		return true
	}

	instrlen := binary.LittleEndian.Uint16(rdr.read(2))
	e.instr = rdr.read(int(instrlen))
	return true
}

type loclistEntry struct {
	lowpc, highpc uint64
	instr         []byte
}

252 253 254 255 256
type runtimeTypeDIE struct {
	offset dwarf.Offset
	kind   int64
}

257 258 259 260
func (e *loclistEntry) BaseAddressSelection() bool {
	return e.lowpc == ^uint64(0)
}

261 262 263 264 265 266
type buildIdHeader struct {
	Namesz uint32
	Descsz uint32
	Type   uint32
}

267
func NewBinaryInfo(goos, goarch string) BinaryInfo {
268
	r := BinaryInfo{GOOS: goos, nameOfRuntimeType: make(map[uintptr]nameOfRuntimeTypeEntry), typeCache: make(map[dwarf.Offset]godwarf.Type)}
269 270 271 272

	// TODO: find better way to determine proc arch (perhaps use executable file info)
	switch goarch {
	case "amd64":
273
		r.Arch = AMD64Arch(goos)
274 275 276 277 278 279 280 281 282 283 284
	}

	return r
}

func (bininfo *BinaryInfo) LoadBinaryInfo(path string, wg *sync.WaitGroup) error {
	fi, err := os.Stat(path)
	if err == nil {
		bininfo.lastModified = fi.ModTime()
	}

285
	switch bininfo.GOOS {
286 287 288 289 290 291 292 293 294 295
	case "linux":
		return bininfo.LoadBinaryInfoElf(path, wg)
	case "windows":
		return bininfo.LoadBinaryInfoPE(path, wg)
	case "darwin":
		return bininfo.LoadBinaryInfoMacho(path, wg)
	}
	return errors.New("unsupported operating system")
}

296 297 298 299 300 301
// GStructOffset returns the offset of the G
// struct in thread local storage.
func (bi *BinaryInfo) GStructOffset() uint64 {
	return bi.gStructOffset
}

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
func (bi *BinaryInfo) LastModified() time.Time {
	return bi.lastModified
}

// DwarfReader returns a reader for the dwarf data
func (bi *BinaryInfo) DwarfReader() *reader.Reader {
	return reader.New(bi.dwarf)
}

// Types returns list of types present in the debugged program.
func (bi *BinaryInfo) Types() ([]string, error) {
	types := make([]string, 0, len(bi.types))
	for k := range bi.types {
		types = append(types, k)
	}
	return types, nil
}

// PCToLine converts an instruction address to a file/line/function.
321 322 323 324 325
func (bi *BinaryInfo) PCToLine(pc uint64) (string, int, *Function) {
	fn := bi.PCToFunc(pc)
	if fn == nil {
		return "", 0, nil
	}
A
aarzilli 已提交
326
	f, ln := fn.cu.lineInfo.PCToLine(fn.Entry, pc)
327
	return f, ln, fn
328 329
}

330
// LineToPC converts a file:line into a memory address.
331 332 333 334
func (bi *BinaryInfo) LineToPC(filename string, lineno int) (pc uint64, fn *Function, err error) {
	for _, cu := range bi.compileUnits {
		if cu.lineInfo.Lookup[filename] != nil {
			pc = cu.lineInfo.LineToPC(filename, lineno)
335 336 337 338 339 340 341 342 343 344 345
			if pc == 0 {
				// Check to see if this file:line belongs to the call site
				// of an inlined function.
				for _, ifn := range cu.concreteInlinedFns {
					if strings.Contains(ifn.CallFile, filename) && ifn.CallLine == int64(lineno) {
						pc = ifn.LowPC
						fn = ifn.Parent
						return
					}
				}
			}
346
			fn = bi.PCToFunc(pc)
347 348
			if fn != nil {
				return
349 350 351 352 353
			}
		}
	}
	err = fmt.Errorf("could not find %s:%d", filename, lineno)
	return
354 355
}

A
aarzilli 已提交
356 357 358 359 360 361 362 363 364 365 366
// AllPCsForFileLine returns all PC addresses for the given filename:lineno.
func (bi *BinaryInfo) AllPCsForFileLine(filename string, lineno int) []uint64 {
	r := make([]uint64, 0, 1)
	for _, cu := range bi.compileUnits {
		if cu.lineInfo.Lookup[filename] != nil {
			r = append(r, cu.lineInfo.AllPCsForFileLine(filename, lineno)...)
		}
	}
	return r
}

367
// PCToFunc returns the function containing the given PC address
368 369 370 371 372 373 374 375 376 377 378 379
func (bi *BinaryInfo) PCToFunc(pc uint64) *Function {
	i := sort.Search(len(bi.Functions), func(i int) bool {
		fn := bi.Functions[i]
		return pc <= fn.Entry || (fn.Entry <= pc && pc < fn.End)
	})
	if i != len(bi.Functions) {
		fn := &bi.Functions[i]
		if fn.Entry <= pc && pc < fn.End {
			return fn
		}
	}
	return nil
380 381
}

382
func (bi *BinaryInfo) Close() error {
383 384 385
	if bi.sepDebugCloser != nil {
		bi.sepDebugCloser.Close()
	}
386 387 388
	return bi.closer.Close()
}

389 390 391 392 393 394 395 396 397 398
func (bi *BinaryInfo) setLoadError(fmtstr string, args ...interface{}) {
	bi.loadErrMu.Lock()
	bi.loadErr = fmt.Errorf(fmtstr, args...)
	bi.loadErrMu.Unlock()
}

func (bi *BinaryInfo) LoadError() error {
	return bi.loadErr
}

399 400 401 402
type nilCloser struct{}

func (c *nilCloser) Close() error { return nil }

403 404 405
// LoadFromData creates a new BinaryInfo object using the specified data.
// This is used for debugging BinaryInfo, you should use LoadBinary instead.
func (bi *BinaryInfo) LoadFromData(dwdata *dwarf.Data, debugFrameBytes, debugLineBytes, debugLocBytes []byte) {
406
	bi.closer = (*nilCloser)(nil)
407
	bi.sepDebugCloser = (*nilCloser)(nil)
408 409 410 411 412 413
	bi.dwarf = dwdata

	if debugFrameBytes != nil {
		bi.frameEntries = frame.Parse(debugFrameBytes, frame.DwarfEndian(debugFrameBytes))
	}

414 415
	bi.loclistInit(debugLocBytes)

416
	bi.loadDebugInfoMaps(debugLineBytes, nil, nil)
417 418 419 420 421 422 423
}

func (bi *BinaryInfo) loclistInit(data []byte) {
	bi.loclist.data = data
	bi.loclist.ptrSz = bi.Arch.PtrSize()
}

424
func (bi *BinaryInfo) locationExpr(entry reader.Entry, attr dwarf.Attr, pc uint64) ([]byte, string, error) {
425 426
	a := entry.Val(attr)
	if a == nil {
427
		return nil, "", fmt.Errorf("no location attribute %s", attr)
428 429
	}
	if instr, ok := a.([]byte); ok {
430 431 432
		var descr bytes.Buffer
		fmt.Fprintf(&descr, "[block] ")
		op.PrettyPrint(&descr, instr)
433
		return instr, descr.String(), nil
434 435 436
	}
	off, ok := a.(int64)
	if !ok {
437
		return nil, "", fmt.Errorf("could not interpret location attribute %s", attr)
438 439
	}
	if bi.loclist.data == nil {
440
		return nil, "", fmt.Errorf("could not find loclist entry at %#x for address %#x (no debug_loc section found)", off, pc)
441 442 443
	}
	instr := bi.loclistEntry(off, pc)
	if instr == nil {
444
		return nil, "", fmt.Errorf("could not find loclist entry at %#x for address %#x", off, pc)
445
	}
446 447 448
	var descr bytes.Buffer
	fmt.Fprintf(&descr, "[%#x:%#x] ", off, pc)
	op.PrettyPrint(&descr, instr)
449 450 451 452 453 454 455 456 457 458 459 460
	return instr, descr.String(), nil
}

// Location returns the location described by attribute attr of entry.
// This will either be an int64 address or a slice of Pieces for locations
// that don't correspond to a single memory address (registers, composite
// locations).
func (bi *BinaryInfo) Location(entry reader.Entry, attr dwarf.Attr, pc uint64, regs op.DwarfRegisters) (int64, []op.Piece, string, error) {
	instr, descr, err := bi.locationExpr(entry, attr, pc)
	if err != nil {
		return 0, nil, "", err
	}
461
	addr, pieces, err := op.ExecuteStackProgram(regs, instr)
462
	return addr, pieces, descr, err
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
}

// loclistEntry returns the loclist entry in the loclist starting at off,
// for address pc.
func (bi *BinaryInfo) loclistEntry(off int64, pc uint64) []byte {
	var base uint64
	if cu := bi.findCompileUnit(pc); cu != nil {
		base = cu.LowPC
	}

	bi.loclist.Seek(int(off))
	var e loclistEntry
	for bi.loclist.Next(&e) {
		if e.BaseAddressSelection() {
			base = e.highpc
			continue
		}
		if pc >= e.lowpc+base && pc < e.highpc+base {
			return e.instr
		}
	}

	return nil
}

// findCompileUnit returns the compile unit containing address pc.
func (bi *BinaryInfo) findCompileUnit(pc uint64) *compileUnit {
	for _, cu := range bi.compileUnits {
		if pc >= cu.LowPC && pc < cu.HighPC {
			return cu
		}
	}
	return nil
496 497
}

498 499 500 501 502 503 504 505 506
func (bi *BinaryInfo) Producer() string {
	for _, cu := range bi.compileUnits {
		if cu.isgo && cu.producer != "" {
			return cu.producer
		}
	}
	return ""
}

507 508 509 510 511
// Type returns the Dwarf type entry at `offset`.
func (bi *BinaryInfo) Type(offset dwarf.Offset) (godwarf.Type, error) {
	return godwarf.ReadType(bi.dwarf, offset, bi.typeCache)
}

512 513
// ELF ///////////////////////////////////////////////////////////////

514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
// This error is used in openSeparateDebugInfo to signal there's no
// build-id note on the binary, so LoadBinaryInfoElf will return
// the error message coming from elfFile.DWARF() instead.
type NoBuildIdNoteError struct{}

func (e *NoBuildIdNoteError) Error() string {
	return "can't find build-id note on binary"
}

// openSeparateDebugInfo searches for a file containing the separate
// debug info for the binary using the "build ID" method as described
// in GDB's documentation [1], and if found returns two handles, one
// for the bare file, and another for its corresponding elf.File.
// [1] https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html
func (bi *BinaryInfo) openSeparateDebugInfo(exe *elf.File) (*os.File, *elf.File, error) {
	buildid := exe.Section(".note.gnu.build-id")
	if buildid == nil {
		return nil, nil, &NoBuildIdNoteError{}
	}

	br := buildid.Open()
	bh := new(buildIdHeader)
	if err := binary.Read(br, binary.LittleEndian, bh); err != nil {
		return nil, nil, errors.New("can't read build-id header: " + err.Error())
	}

	name := make([]byte, bh.Namesz)
	if err := binary.Read(br, binary.LittleEndian, name); err != nil {
		return nil, nil, errors.New("can't read build-id name: " + err.Error())
	}

	if strings.TrimSpace(string(name)) != "GNU\x00" {
		return nil, nil, errors.New("invalid build-id signature")
	}

	descBinary := make([]byte, bh.Descsz)
	if err := binary.Read(br, binary.LittleEndian, descBinary); err != nil {
		return nil, nil, errors.New("can't read build-id desc: " + err.Error())
	}
	desc := hex.EncodeToString(descBinary)

	debugPath := fmt.Sprintf("/usr/lib/debug/.build-id/%s/%s.debug", desc[:2], desc[2:])
	sepFile, err := os.OpenFile(debugPath, 0, os.ModePerm)
	if err != nil {
		return nil, nil, errors.New("can't open separate debug file: " + err.Error())
	}

	elfFile, err := elf.NewFile(sepFile)
	if err != nil {
		sepFile.Close()
		return nil, nil, errors.New(fmt.Sprintf("can't open separate debug file %q: %v", debugPath, err.Error()))
	}

	if elfFile.Machine != elf.EM_X86_64 {
		sepFile.Close()
		return nil, nil, errors.New(fmt.Sprintf("can't open separate debug file %q: %v", debugPath, UnsupportedLinuxArchErr.Error()))
	}

	return sepFile, elfFile, nil
}

575 576 577 578 579 580 581 582 583 584 585 586 587
func (bi *BinaryInfo) LoadBinaryInfoElf(path string, wg *sync.WaitGroup) error {
	exe, err := os.OpenFile(path, 0, os.ModePerm)
	if err != nil {
		return err
	}
	bi.closer = exe
	elfFile, err := elf.NewFile(exe)
	if err != nil {
		return err
	}
	if elfFile.Machine != elf.EM_X86_64 {
		return UnsupportedLinuxArchErr
	}
588
	dwarfFile := elfFile
589 590
	bi.dwarf, err = elfFile.DWARF()
	if err != nil {
591 592 593 594 595 596 597 598 599 600 601 602 603 604
		var sepFile *os.File
		var serr error
		sepFile, dwarfFile, serr = bi.openSeparateDebugInfo(elfFile)
		if serr != nil {
			if _, ok := serr.(*NoBuildIdNoteError); ok {
				return err
			}
			return serr
		}
		bi.sepDebugCloser = sepFile
		bi.dwarf, err = dwarfFile.DWARF()
		if err != nil {
			return err
		}
605 606
	}

607 608
	bi.dwarfReader = bi.dwarf.Reader()

609
	debugLineBytes, err := godwarf.GetDebugSectionElf(dwarfFile, "line")
610 611 612
	if err != nil {
		return err
	}
613 614
	debugLocBytes, _ := godwarf.GetDebugSectionElf(dwarfFile, "loc")
	bi.loclistInit(debugLocBytes)
615 616

	wg.Add(3)
617
	go bi.parseDebugFrameElf(dwarfFile, wg)
618
	go bi.loadDebugInfoMaps(debugLineBytes, wg, nil)
619
	go bi.setGStructOffsetElf(dwarfFile, wg)
620 621 622 623 624 625
	return nil
}

func (bi *BinaryInfo) parseDebugFrameElf(exe *elf.File, wg *sync.WaitGroup) {
	defer wg.Done()

626 627 628
	debugFrameData, err := godwarf.GetDebugSectionElf(exe, "frame")
	if err != nil {
		bi.setLoadError("could not get .debug_frame section: %v", err)
629
		return
630
	}
631 632 633 634
	debugInfoData, err := godwarf.GetDebugSectionElf(exe, "info")
	if err != nil {
		bi.setLoadError("could not get .debug_info section: %v", err)
		return
635 636
	}

637
	bi.frameEntries = frame.Parse(debugFrameData, frame.DwarfEndian(debugInfoData))
638 639
}

640 641 642 643 644 645 646 647 648 649 650
func (bi *BinaryInfo) setGStructOffsetElf(exe *elf.File, wg *sync.WaitGroup) {
	defer wg.Done()

	// This is a bit arcane. Essentially:
	// - If the program is pure Go, it can do whatever it wants, and puts the G
	//   pointer at %fs-8.
	// - Otherwise, Go asks the external linker to place the G pointer by
	//   emitting runtime.tlsg, a TLS symbol, which is relocated to the chosen
	//   offset in libc's TLS block.
	symbols, err := exe.Symbols()
	if err != nil {
651 652
		bi.setLoadError("could not parse ELF symbols: %v", err)
		return
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
	}
	var tlsg *elf.Symbol
	for _, symbol := range symbols {
		if symbol.Name == "runtime.tlsg" {
			s := symbol
			tlsg = &s
			break
		}
	}
	if tlsg == nil {
		bi.gStructOffset = ^uint64(8) + 1 // -8
		return
	}
	var tls *elf.Prog
	for _, prog := range exe.Progs {
		if prog.Type == elf.PT_TLS {
			tls = prog
			break
		}
	}
	// The TLS register points to the end of the TLS block, which is
	// tls.Memsz long. runtime.tlsg is an offset from the beginning of that block.
	bi.gStructOffset = ^(tls.Memsz) + 1 + tlsg.Value // -tls.Memsz + tlsg.Value
}

678 679 680 681 682 683 684 685 686 687 688
// PE ////////////////////////////////////////////////////////////////

func (bi *BinaryInfo) LoadBinaryInfoPE(path string, wg *sync.WaitGroup) error {
	peFile, closer, err := openExecutablePathPE(path)
	if err != nil {
		return err
	}
	bi.closer = closer
	if peFile.Machine != pe.IMAGE_FILE_MACHINE_AMD64 {
		return UnsupportedWindowsArchErr
	}
689
	bi.dwarf, err = peFile.DWARF()
690 691 692 693
	if err != nil {
		return err
	}

694 695
	bi.dwarfReader = bi.dwarf.Reader()

696
	debugLineBytes, err := godwarf.GetDebugSectionPE(peFile, "line")
697 698 699
	if err != nil {
		return err
	}
700 701
	debugLocBytes, _ := godwarf.GetDebugSectionPE(peFile, "loc")
	bi.loclistInit(debugLocBytes)
702 703

	wg.Add(2)
704
	go bi.parseDebugFramePE(peFile, wg)
705
	go bi.loadDebugInfoMaps(debugLineBytes, wg, nil)
706 707 708 709 710 711

	// Use ArbitraryUserPointer (0x28) as pointer to pointer
	// to G struct per:
	// https://golang.org/src/runtime/cgo/gcc_windows_amd64.c

	bi.gStructOffset = 0x28
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
	return nil
}

func openExecutablePathPE(path string) (*pe.File, io.Closer, error) {
	f, err := os.OpenFile(path, 0, os.ModePerm)
	if err != nil {
		return nil, nil, err
	}
	peFile, err := pe.NewFile(f)
	if err != nil {
		f.Close()
		return nil, nil, err
	}
	return peFile, f, nil
}

func (bi *BinaryInfo) parseDebugFramePE(exe *pe.File, wg *sync.WaitGroup) {
	defer wg.Done()

731 732 733
	debugFrameBytes, err := godwarf.GetDebugSectionPE(exe, "frame")
	if err != nil {
		bi.setLoadError("could not get .debug_frame section: %v", err)
734
		return
735
	}
736 737 738 739 740 741 742
	debugInfoBytes, err := godwarf.GetDebugSectionPE(exe, "info")
	if err != nil {
		bi.setLoadError("could not get .debug_info section: %v", err)
		return
	}

	bi.frameEntries = frame.Parse(debugFrameBytes, frame.DwarfEndian(debugInfoBytes))
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
}

// Borrowed from https://golang.org/src/cmd/internal/objfile/pe.go
func findPESymbol(f *pe.File, name string) (*pe.Symbol, error) {
	for _, s := range f.Symbols {
		if s.Name != name {
			continue
		}
		if s.SectionNumber <= 0 {
			return nil, fmt.Errorf("symbol %s: invalid section number %d", name, s.SectionNumber)
		}
		if len(f.Sections) < int(s.SectionNumber) {
			return nil, fmt.Errorf("symbol %s: section number %d is larger than max %d", name, s.SectionNumber, len(f.Sections))
		}
		return s, nil
	}
	return nil, fmt.Errorf("no %s symbol found", name)
}

// MACH-O ////////////////////////////////////////////////////////////

func (bi *BinaryInfo) LoadBinaryInfoMacho(path string, wg *sync.WaitGroup) error {
	exe, err := macho.Open(path)
	if err != nil {
		return err
	}
	bi.closer = exe
	if exe.Cpu != macho.CpuAmd64 {
		return UnsupportedDarwinArchErr
	}
	bi.dwarf, err = exe.DWARF()
	if err != nil {
		return err
	}

778 779
	bi.dwarfReader = bi.dwarf.Reader()

780
	debugLineBytes, err := godwarf.GetDebugSectionMacho(exe, "line")
781 782 783
	if err != nil {
		return err
	}
784 785
	debugLocBytes, _ := godwarf.GetDebugSectionMacho(exe, "loc")
	bi.loclistInit(debugLocBytes)
786 787

	wg.Add(2)
788
	go bi.parseDebugFrameMacho(exe, wg)
789
	go bi.loadDebugInfoMaps(debugLineBytes, wg, bi.setGStructOffsetMacho)
790 791 792
	return nil
}

793 794 795 796 797 798 799 800 801 802 803 804
func (bi *BinaryInfo) setGStructOffsetMacho() {
	// In go1.11 it's 0x30, before 0x8a0, see:
	// https://github.com/golang/go/issues/23617
	// and go commit b3a854c733257c5249c3435ffcee194f8439676a
	producer := bi.Producer()
	if producer != "" && goversion.ProducerAfterOrEqual(producer, 1, 11) {
		bi.gStructOffset = 0x30
		return
	}
	bi.gStructOffset = 0x8a0
}

805 806 807
func (bi *BinaryInfo) parseDebugFrameMacho(exe *macho.File, wg *sync.WaitGroup) {
	defer wg.Done()

808 809 810
	debugFrameBytes, err := godwarf.GetDebugSectionMacho(exe, "frame")
	if err != nil {
		bi.setLoadError("could not get __debug_frame section: %v", err)
811
		return
812
	}
813 814 815 816
	debugInfoBytes, err := godwarf.GetDebugSectionMacho(exe, "info")
	if err != nil {
		bi.setLoadError("could not get .debug_info section: %v", err)
		return
817
	}
818

819
	bi.frameEntries = frame.Parse(debugFrameBytes, frame.DwarfEndian(debugInfoBytes))
820
}