symbolizer

Documentation

Index

• Variables
• func CalculateBase(ei profile.ExecutableInfo, m profile.Mapping, addr uint64) (uint64, error)
• func NormalizeAddress(addr uint64, ei profile.ExecutableInfo, m profile.Mapping) (uint64, error)
• type BadgerCache
  • func NewBadgerCache(db *badger.DB) *BadgerCache
  • func (c *BadgerCache) Get(ctx context.Context, buildID string, addr uint64) ([]profile.LocationLine, bool, error)
  • func (c *BadgerCache) Set(ctx context.Context, buildID string, addr uint64, lines []profile.LocationLine) error
• type DebuginfoFetcher
• type DebuginfoMetadata
• type Option
  • func WithDemangleMode(mode string) Option
• type SymbolizationRequest
• type SymbolizationRequestMappingAddrs
• type Symbolizer
  • func New(logger log.Logger, metadata DebuginfoMetadata, cache SymbolizerCache, ...) *Symbolizer
  • func (s *Symbolizer) Symbolize(ctx context.Context, req SymbolizationRequest) error
• type SymbolizerCache

Variables

var (
	ErrNotValidElf = errors.New("not a valid ELF file")
	ErrNoDebuginfo = errors.New("no debug info found")
	ErrLinerFailed = errors.New("liner creation failed")
)

Functions

func CalculateBase

func CalculateBase(ei profile.ExecutableInfo, m profile.Mapping, addr uint64) (uint64, error)

Base determines the base address to subtract from virtual address to get symbol table address. For an executable, the base is 0. Otherwise, it's a shared library, and the base is the address where the mapping starts. The kernel needs special handling.

func NormalizeAddress

func NormalizeAddress(addr uint64, ei profile.ExecutableInfo, m profile.Mapping) (uint64, error)

Types

type BadgerCache

type BadgerCache struct {
	// contains filtered or unexported fields
}

func NewBadgerCache

func NewBadgerCache(db *badger.DB) *BadgerCache

func (*BadgerCache) Get

func (c *BadgerCache) Get(ctx context.Context, buildID string, addr uint64) ([]profile.LocationLine, bool, error)

func (*BadgerCache) Set

func (c *BadgerCache) Set(ctx context.Context, buildID string, addr uint64, lines []profile.LocationLine) error

type DebuginfoFetcher

type DebuginfoFetcher interface {
	// Fetch ensures that the debug info for the given build ID is available on
	// a local filesystem and returns a path to it.
	FetchDebuginfo(ctx context.Context, dbginfo *debuginfopb.Debuginfo) (io.ReadCloser, error)
}

type DebuginfoMetadata

type DebuginfoMetadata interface {
	SetQuality(ctx context.Context, buildID string, typ debuginfopb.DebuginfoType, quality *debuginfopb.DebuginfoQuality) error
	Fetch(ctx context.Context, buildID string, typ debuginfopb.DebuginfoType) (*debuginfopb.Debuginfo, error)
}

type Option

type Option func(*Symbolizer)

func WithDemangleMode

func WithDemangleMode(mode string) Option

type SymbolizationRequest

type SymbolizationRequest struct {
	BuildID  string
	Mappings []SymbolizationRequestMappingAddrs
}

type SymbolizationRequestMappingAddrs

type SymbolizationRequestMappingAddrs struct {
	// This slice is used to store the symbolization result directly.
	Locations []*profile.Location
}

type Symbolizer

type Symbolizer struct {
	// contains filtered or unexported fields
}

func New

func New(
	logger log.Logger,
	metadata DebuginfoMetadata,
	cache SymbolizerCache,
	debuginfo DebuginfoFetcher,
	tmpDir string,
	opts ...Option,
) *Symbolizer

func (*Symbolizer) Symbolize

func (s *Symbolizer) Symbolize(
	ctx context.Context,
	req SymbolizationRequest,
) error

type SymbolizerCache

type SymbolizerCache interface {
	Get(ctx context.Context, buildID string, addr uint64) ([]profile.LocationLine, bool, error)
	Set(ctx context.Context, buildID string, addr uint64, lines []profile.LocationLine) error
}