bininfo.go 22.0 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 11 12 13
	"errors"
	"fmt"
	"io"
	"os"
14 15
	"sort"
	"strings"
16 17 18 19
	"sync"
	"time"

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

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

30
	GOOS   string
31 32 33 34 35
	closer io.Closer

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

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

45
	// Functions is a list of all DW_TAG_subprogram entries in debug_info, sorted by entry point
46 47 48 49 50 51
	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

52 53
	typeCache map[dwarf.Offset]godwarf.Type

54 55 56
	loadModuleDataOnce sync.Once
	moduleData         []moduleData
	nameOfRuntimeType  map[uintptr]nameOfRuntimeTypeEntry
57

58 59 60 61 62 63
	// 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

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

67 68
	loadErrMu sync.Mutex
	loadErr   error
69 70

	dwarfReader *dwarf.Reader
71 72 73 74 75 76
}

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")

77 78 79 80 81 82 83 84
const dwarfGoLanguage = 22 // DW_LANG_Go (from DWARF v5, section 7.12, page 231)

type compileUnit struct {
	entry         *dwarf.Entry        // debug_info entry describing this compile unit
	isgo          bool                // true if this is the go compile unit
	Name          string              // univocal name for non-go compile units
	lineInfo      *line.DebugLineInfo // debug_line segment associated with this compile unit
	LowPC, HighPC uint64
85 86
	optimized     bool   // this compile unit is optimized
	producer      string // producer attribute
87 88
}

89 90 91 92 93 94 95 96 97 98 99 100 101 102
type partialUnitConstant struct {
	name  string
	typ   dwarf.Offset
	value int64
}

type partialUnit struct {
	entry       *dwarf.Entry
	types       map[string]dwarf.Offset
	variables   []packageVar
	constants   []partialUnitConstant
	functions   []Function
}

103 104 105 106 107 108 109 110 111 112 113 114
// 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 {
115 116 117 118 119
	return packageName(fn.Name)
}

func packageName(name string) string {
	pathend := strings.LastIndex(name, "/")
120 121 122 123
	if pathend < 0 {
		pathend = 0
	}

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

155 156 157 158 159
// Optimized returns true if the function was optimized by the compiler.
func (fn *Function) Optimized() bool {
	return fn.cu.optimized
}

160 161 162 163 164 165 166 167 168 169 170 171 172 173
type constantsMap map[dwarf.Offset]*constantType

type constantType struct {
	initialized bool
	values      []constantValue
}

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

174 175 176 177 178 179 180 181 182
// 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
}

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
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
}

238 239 240 241 242
type runtimeTypeDIE struct {
	offset dwarf.Offset
	kind   int64
}

243 244 245 246
func (e *loclistEntry) BaseAddressSelection() bool {
	return e.lowpc == ^uint64(0)
}

247
func NewBinaryInfo(goos, goarch string) BinaryInfo {
248
	r := BinaryInfo{GOOS: goos, nameOfRuntimeType: make(map[uintptr]nameOfRuntimeTypeEntry), typeCache: make(map[dwarf.Offset]godwarf.Type)}
249 250 251 252

	// TODO: find better way to determine proc arch (perhaps use executable file info)
	switch goarch {
	case "amd64":
253
		r.Arch = AMD64Arch(goos)
254 255 256 257 258 259 260 261 262 263 264
	}

	return r
}

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

265
	switch bininfo.GOOS {
266 267 268 269 270 271 272 273 274 275
	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")
}

276 277 278 279 280 281
// GStructOffset returns the offset of the G
// struct in thread local storage.
func (bi *BinaryInfo) GStructOffset() uint64 {
	return bi.gStructOffset
}

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
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.
301 302 303 304 305
func (bi *BinaryInfo) PCToLine(pc uint64) (string, int, *Function) {
	fn := bi.PCToFunc(pc)
	if fn == nil {
		return "", 0, nil
	}
A
aarzilli 已提交
306
	f, ln := fn.cu.lineInfo.PCToLine(fn.Entry, pc)
307
	return f, ln, fn
308 309
}

310
// LineToPC converts a file:line into a memory address.
311 312 313 314 315
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)
			fn = bi.PCToFunc(pc)
316 317
			if fn != nil {
				return
318 319 320 321 322
			}
		}
	}
	err = fmt.Errorf("could not find %s:%d", filename, lineno)
	return
323 324
}

A
aarzilli 已提交
325 326 327 328 329 330 331 332 333 334 335
// 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
}

336
// PCToFunc returns the function containing the given PC address
337 338 339 340 341 342 343 344 345 346 347 348
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
349 350
}

351 352 353 354
func (bi *BinaryInfo) Close() error {
	return bi.closer.Close()
}

355 356 357 358 359 360 361 362 363 364
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
}

365 366 367 368
type nilCloser struct{}

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

369 370 371
// 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) {
372 373 374 375 376 377 378
	bi.closer = (*nilCloser)(nil)
	bi.dwarf = dwdata

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

379 380
	bi.loclistInit(debugLocBytes)

381
	bi.loadDebugInfoMaps(debugLineBytes, nil, nil)
382 383 384 385 386 387 388 389 390 391 392
}

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

// 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).
393
func (bi *BinaryInfo) Location(entry reader.Entry, attr dwarf.Attr, pc uint64, regs op.DwarfRegisters) (int64, []op.Piece, string, error) {
394 395
	a := entry.Val(attr)
	if a == nil {
396
		return 0, nil, "", fmt.Errorf("no location attribute %s", attr)
397 398
	}
	if instr, ok := a.([]byte); ok {
399 400 401 402 403
		var descr bytes.Buffer
		fmt.Fprintf(&descr, "[block] ")
		op.PrettyPrint(&descr, instr)
		addr, pieces, err := op.ExecuteStackProgram(regs, instr)
		return addr, pieces, descr.String(), err
404 405 406
	}
	off, ok := a.(int64)
	if !ok {
407
		return 0, nil, "", fmt.Errorf("could not interpret location attribute %s", attr)
408 409
	}
	if bi.loclist.data == nil {
410
		return 0, nil, "", fmt.Errorf("could not find loclist entry at %#x for address %#x (no debug_loc section found)", off, pc)
411 412 413
	}
	instr := bi.loclistEntry(off, pc)
	if instr == nil {
414
		return 0, nil, "", fmt.Errorf("could not find loclist entry at %#x for address %#x", off, pc)
415
	}
416 417 418 419 420
	var descr bytes.Buffer
	fmt.Fprintf(&descr, "[%#x:%#x] ", off, pc)
	op.PrettyPrint(&descr, instr)
	addr, pieces, err := op.ExecuteStackProgram(regs, instr)
	return addr, pieces, descr.String(), err
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
}

// 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
454 455
}

456 457 458 459 460 461 462 463 464
func (bi *BinaryInfo) Producer() string {
	for _, cu := range bi.compileUnits {
		if cu.isgo && cu.producer != "" {
			return cu.producer
		}
	}
	return ""
}

465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
// ELF ///////////////////////////////////////////////////////////////

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
	}
	bi.dwarf, err = elfFile.DWARF()
	if err != nil {
		return err
	}

485 486
	bi.dwarfReader = bi.dwarf.Reader()

487 488 489 490
	debugLineBytes, err := getDebugLineInfoElf(elfFile)
	if err != nil {
		return err
	}
491
	bi.loclistInit(getDebugLocElf(elfFile))
492 493

	wg.Add(3)
494
	go bi.parseDebugFrameElf(elfFile, wg)
495
	go bi.loadDebugInfoMaps(debugLineBytes, wg, nil)
496
	go bi.setGStructOffsetElf(elfFile, wg)
497 498 499 500 501 502 503 504 505 506 507 508
	return nil
}

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

	debugFrameSec := exe.Section(".debug_frame")
	debugInfoSec := exe.Section(".debug_info")

	if debugFrameSec != nil && debugInfoSec != nil {
		debugFrame, err := exe.Section(".debug_frame").Data()
		if err != nil {
509 510
			bi.setLoadError("could not get .debug_frame section: %v", err)
			return
511 512 513
		}
		dat, err := debugInfoSec.Data()
		if err != nil {
514 515
			bi.setLoadError("could not get .debug_frame section: %v", err)
			return
516 517 518
		}
		bi.frameEntries = frame.Parse(debugFrame, frame.DwarfEndian(dat))
	} else {
519 520
		bi.setLoadError("could not find .debug_frame section in binary")
		return
521 522 523
	}
}

524
func getDebugLineInfoElf(exe *elf.File) ([]byte, error) {
525 526 527
	if sec := exe.Section(".debug_line"); sec != nil {
		debugLine, err := exe.Section(".debug_line").Data()
		if err != nil {
528
			return nil, fmt.Errorf("could not get .debug_line section: %v", err)
529
		}
530
		return debugLine, nil
531
	}
532
	return nil, errors.New("could not find .debug_line section in binary")
533 534
}

535 536 537 538 539 540 541 542
func getDebugLocElf(exe *elf.File) []byte {
	if sec := exe.Section(".debug_loc"); sec != nil {
		debugLoc, _ := exe.Section(".debug_loc").Data()
		return debugLoc
	}
	return nil
}

543 544 545 546 547 548 549 550 551 552 553
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 {
554 555
		bi.setLoadError("could not parse ELF symbols: %v", err)
		return
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
	}
	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
}

581 582 583 584 585 586 587 588 589 590 591
// 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
	}
592
	bi.dwarf, err = peFile.DWARF()
593 594 595 596
	if err != nil {
		return err
	}

597 598
	bi.dwarfReader = bi.dwarf.Reader()

599 600 601 602
	debugLineBytes, err := getDebugLineInfoPE(peFile)
	if err != nil {
		return err
	}
603
	bi.loclistInit(getDebugLocPE(peFile))
604 605

	wg.Add(2)
606
	go bi.parseDebugFramePE(peFile, wg)
607
	go bi.loadDebugInfoMaps(debugLineBytes, wg, nil)
608 609 610 611 612 613

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

	bi.gStructOffset = 0x28
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
	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()

	debugFrameSec := exe.Section(".debug_frame")
	debugInfoSec := exe.Section(".debug_info")

	if debugFrameSec != nil && debugInfoSec != nil {
		debugFrame, err := debugFrameSec.Data()
		if err != nil && uint32(len(debugFrame)) < debugFrameSec.Size {
639 640
			bi.setLoadError("could not get .debug_frame section: %v", err)
			return
641 642 643 644 645 646
		}
		if 0 < debugFrameSec.VirtualSize && debugFrameSec.VirtualSize < debugFrameSec.Size {
			debugFrame = debugFrame[:debugFrameSec.VirtualSize]
		}
		dat, err := debugInfoSec.Data()
		if err != nil {
647 648
			bi.setLoadError("could not get .debug_info section: %v", err)
			return
649 650 651
		}
		bi.frameEntries = frame.Parse(debugFrame, frame.DwarfEndian(dat))
	} else {
652 653
		bi.setLoadError("could not find .debug_frame section in binary")
		return
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
	}
}

// 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)
}

// Borrowed from https://golang.org/src/cmd/internal/objfile/pe.go
func loadPETable(f *pe.File, sname, ename string) ([]byte, error) {
	ssym, err := findPESymbol(f, sname)
	if err != nil {
		return nil, err
	}
	esym, err := findPESymbol(f, ename)
	if err != nil {
		return nil, err
	}
	if ssym.SectionNumber != esym.SectionNumber {
		return nil, fmt.Errorf("%s and %s symbols must be in the same section", sname, ename)
	}
	sect := f.Sections[ssym.SectionNumber-1]
	data, err := sect.Data()
	if err != nil {
		return nil, err
	}
	return data[ssym.Value:esym.Value], nil
}

// Borrowed from https://golang.org/src/cmd/internal/objfile/pe.go
func pclnPE(exe *pe.File) (textStart uint64, symtab, pclntab []byte, err error) {
	var imageBase uint64
	switch oh := exe.OptionalHeader.(type) {
	case *pe.OptionalHeader32:
		imageBase = uint64(oh.ImageBase)
	case *pe.OptionalHeader64:
		imageBase = oh.ImageBase
	default:
		return 0, nil, nil, fmt.Errorf("pe file format not recognized")
	}
	if sect := exe.Section(".text"); sect != nil {
		textStart = imageBase + uint64(sect.VirtualAddress)
	}
	if pclntab, err = loadPETable(exe, "runtime.pclntab", "runtime.epclntab"); err != nil {
		// We didn't find the symbols, so look for the names used in 1.3 and earlier.
		// TODO: Remove code looking for the old symbols when we no longer care about 1.3.
		var err2 error
		if pclntab, err2 = loadPETable(exe, "pclntab", "epclntab"); err2 != nil {
			return 0, nil, nil, err
		}
	}
	if symtab, err = loadPETable(exe, "runtime.symtab", "runtime.esymtab"); err != nil {
		// Same as above.
		var err2 error
		if symtab, err2 = loadPETable(exe, "symtab", "esymtab"); err2 != nil {
			return 0, nil, nil, err
		}
	}
	return textStart, symtab, pclntab, nil
}

727
func getDebugLineInfoPE(exe *pe.File) ([]byte, error) {
728 729 730
	if sec := exe.Section(".debug_line"); sec != nil {
		debugLine, err := sec.Data()
		if err != nil && uint32(len(debugLine)) < sec.Size {
731
			return nil, fmt.Errorf("could not get .debug_line section: %v", err)
732 733 734 735
		}
		if 0 < sec.VirtualSize && sec.VirtualSize < sec.Size {
			debugLine = debugLine[:sec.VirtualSize]
		}
736
		return debugLine, nil
737
	}
738
	return nil, errors.New("could not find .debug_line section in binary")
739 740
}

741 742 743 744 745 746 747 748
func getDebugLocPE(exe *pe.File) []byte {
	if sec := exe.Section(".debug_loc"); sec != nil {
		debugLoc, _ := sec.Data()
		return debugLoc
	}
	return nil
}

749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
// 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
	}

765 766
	bi.dwarfReader = bi.dwarf.Reader()

767 768 769 770
	debugLineBytes, err := getDebugLineInfoMacho(exe)
	if err != nil {
		return err
	}
771
	bi.loclistInit(getDebugLocMacho(exe))
772 773

	wg.Add(2)
774
	go bi.parseDebugFrameMacho(exe, wg)
775
	go bi.loadDebugInfoMaps(debugLineBytes, wg, bi.setGStructOffsetMacho)
776 777 778
	return nil
}

779 780 781 782 783 784 785 786 787 788 789 790
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
}

791 792 793 794 795 796 797 798 799
func (bi *BinaryInfo) parseDebugFrameMacho(exe *macho.File, wg *sync.WaitGroup) {
	defer wg.Done()

	debugFrameSec := exe.Section("__debug_frame")
	debugInfoSec := exe.Section("__debug_info")

	if debugFrameSec != nil && debugInfoSec != nil {
		debugFrame, err := exe.Section("__debug_frame").Data()
		if err != nil {
800 801
			bi.setLoadError("could not get __debug_frame section: %v", err)
			return
802 803 804
		}
		dat, err := debugInfoSec.Data()
		if err != nil {
805 806
			bi.setLoadError("could not get .debug_info section: %v", err)
			return
807 808 809
		}
		bi.frameEntries = frame.Parse(debugFrame, frame.DwarfEndian(dat))
	} else {
810 811
		bi.setLoadError("could not find __debug_frame section in binary")
		return
812 813 814
	}
}

815
func getDebugLineInfoMacho(exe *macho.File) ([]byte, error) {
816 817 818
	if sec := exe.Section("__debug_line"); sec != nil {
		debugLine, err := exe.Section("__debug_line").Data()
		if err != nil {
819
			return nil, fmt.Errorf("could not get __debug_line section: %v", err)
820
		}
821
		return debugLine, nil
822
	}
823
	return nil, errors.New("could not find __debug_line section in binary")
824
}
825 826 827 828 829 830 831 832

func getDebugLocMacho(exe *macho.File) []byte {
	if sec := exe.Section("__debug_loc"); sec != nil {
		debugLoc, _ := sec.Data()
		return debugLoc
	}
	return nil
}