version: 1.10

package gosym

import "debug/gosym"

Overview

Package gosym implements access to the Go symbol and line number tables embedded
in Go binaries generated by the gc compilers.

Index

Package files

pclntab.go symtab.go

type DecodingError

  1. type DecodingError struct {
  2.     // contains filtered or unexported fields
  3. }

DecodingError represents an error during the decoding of the symbol table.

func (*DecodingError) Error

  1. func (e *DecodingError) Error() string

type Func

  1. type Func struct {
  2.     Entry uint64
  3.     *Sym
  4.     End       uint64
  5.     Params    []*Sym // nil for Go 1.3 and later binaries
  6.     Locals    []*Sym // nil for Go 1.3 and later binaries
  7.     FrameSize int
  8.     LineTable *LineTable
  9.     Obj       *Obj
  10. }

A Func collects information about a single function.

type LineTable

  1. type LineTable struct {
  2.     Data []byte
  3.     PC   uint64
  4.     Line int
  5.     // contains filtered or unexported fields
  6. }

A LineTable is a data structure mapping program counters to line numbers.

In Go 1.1 and earlier, each function (represented by a Func) had its own
LineTable, and the line number corresponded to a numbering of all source lines
in the program, across all files. That absolute line number would then have to
be converted separately to a file name and line number within the file.

In Go 1.2, the format of the data changed so that there is a single LineTable
for the entire program, shared by all Funcs, and there are no absolute line
numbers, just line numbers within specific files.

For the most part, LineTable’s methods should be treated as an internal detail
of the package; callers should use the methods on Table instead.

func NewLineTable

  1. func NewLineTable(data []byte, text uint64) *LineTable

NewLineTable returns a new PC/line table corresponding to the encoded data. Text
must be the start address of the corresponding text segment.

func (*LineTable) LineToPC

  1. func (t *LineTable) LineToPC(line int, maxpc uint64) uint64

LineToPC returns the program counter for the given line number, considering only
program counters before maxpc. Callers should use Table’s LineToPC method
instead.

func (*LineTable) PCToLine

  1. func (t *LineTable) PCToLine(pc uint64) int

PCToLine returns the line number for the given program counter. Callers should
use Table’s PCToLine method instead.

type Obj

  1. type Obj struct {
  2.     // Funcs is a list of functions in the Obj.
  3.     Funcs []Func
  4.  
  5.     // In Go 1.1 and earlier, Paths is a list of symbols corresponding
  6.     // to the source file names that produced the Obj.
  7.     // In Go 1.2, Paths is nil.
  8.     // Use the keys of Table.Files to obtain a list of source files.
  9.     Paths []Sym // meta
  10. }

An Obj represents a collection of functions in a symbol table.

The exact method of division of a binary into separate Objs is an internal
detail of the symbol table format.

In early versions of Go each source file became a different Obj.

In Go 1 and Go 1.1, each package produced one Obj for all Go sources and one Obj
per C source file.

In Go 1.2, there is a single Obj for the entire program.

type Sym

  1. type Sym struct {
  2.     Value  uint64
  3.     Type   byte
  4.     Name   string
  5.     GoType uint64
  6.     // If this symbol is a function symbol, the corresponding Func
  7.     Func *Func
  8. }

A Sym represents a single symbol table entry.

func (*Sym) BaseName

  1. func (s *Sym) BaseName() string

BaseName returns the symbol name without the package or receiver name.

func (*Sym) PackageName

  1. func (s *Sym) PackageName() string

PackageName returns the package part of the symbol name, or the empty string if
there is none.

func (*Sym) ReceiverName

  1. func (s *Sym) ReceiverName() string

ReceiverName returns the receiver type name of this symbol, or the empty string
if there is none.

func (*Sym) Static

  1. func (s *Sym) Static() bool

Static reports whether this symbol is static (not visible outside its file).

type Table

  1. type Table struct {
  2.     Syms  []Sym // nil for Go 1.3 and later binaries
  3.     Funcs []Func
  4.     Files map[string]*Obj // nil for Go 1.2 and later binaries
  5.     Objs  []Obj           // nil for Go 1.2 and later binaries
  6.     // contains filtered or unexported fields
  7. }

Table represents a Go symbol table. It stores all of the symbols decoded from
the program and provides methods to translate between symbols, names, and
addresses.

func NewTable

  1. func NewTable(symtab []byte, pcln *LineTable) (*Table, error)

NewTable decodes the Go symbol table (the “.gosymtab” section in ELF), returning
an in-memory representation. Starting with Go 1.3, the Go symbol table no longer
includes symbol data.

func (*Table) LineToPC

  1. func (t *Table) LineToPC(file string, line int) (pc uint64, fn *Func, err error)

LineToPC looks up the first program counter on the given line in the named file.
It returns UnknownPathError or UnknownLineError if there is an error looking up
this line.

func (*Table) LookupFunc

  1. func (t *Table) LookupFunc(name string) *Func

LookupFunc returns the text, data, or bss symbol with the given name, or nil if
no such symbol is found.

func (*Table) LookupSym

  1. func (t *Table) LookupSym(name string) *Sym

LookupSym returns the text, data, or bss symbol with the given name, or nil if
no such symbol is found.

func (*Table) PCToFunc

  1. func (t *Table) PCToFunc(pc uint64) *Func

PCToFunc returns the function containing the program counter pc, or nil if there
is no such function.

func (*Table) PCToLine

  1. func (t *Table) PCToLine(pc uint64) (file string, line int, fn *Func)

PCToLine looks up line number information for a program counter. If there is no
information, it returns fn == nil.

func (*Table) SymByAddr

  1. func (t *Table) SymByAddr(addr uint64) *Sym

SymByAddr returns the text, data, or bss symbol starting at the given address.

type UnknownFileError

  1. type UnknownFileError string

UnknownFileError represents a failure to find the specific file in the symbol
table.

func (UnknownFileError) Error

  1. func (e UnknownFileError) Error() string

type UnknownLineError

  1. type UnknownLineError struct {
  2.     File string
  3.     Line int
  4. }

UnknownLineError represents a failure to map a line to a program counter, either
because the line is beyond the bounds of the file or because there is no code on
the given line.

func (*UnknownLineError) Error

  1. func (e *UnknownLineError) Error() string