debugger

Documentation

Index

• type AddrLocationSpec
  • func (loc *AddrLocationSpec) Find(d *Debugger, scope *proc.EvalScope, locStr string) ([]api.Location, error)
• type AmbiguousLocationError
  • func (ale AmbiguousLocationError) Error() string
• type Config
• type Debugger
  • func New(config *Config) (*Debugger, error)
  • func (d *Debugger) Breakpoints() []*api.Breakpoint
  • func (d *Debugger) ClearBreakpoint(requestedBp *api.Breakpoint) (*api.Breakpoint, error)
  • func (d *Debugger) Command(command *api.DebuggerCommand) (*api.DebuggerState, error)
  • func (d *Debugger) CreateBreakpoint(requestedBp *api.Breakpoint) (*api.Breakpoint, error)
  • func (d *Debugger) Detach(kill bool) error
  • func (d *Debugger) EvalVariableInScope(scope api.EvalScope, symbol string) (*api.Variable, error)
  • func (d *Debugger) FindBreakpoint(id int) *api.Breakpoint
  • func (d *Debugger) FindLocation(scope api.EvalScope, locStr string) ([]api.Location, error)
  • func (d *Debugger) FindThread(id int) *api.Thread
  • func (d *Debugger) FunctionArguments(scope api.EvalScope) ([]api.Variable, error)
  • func (d *Debugger) Functions(filter string) ([]string, error)
  • func (d *Debugger) Goroutines() ([]*api.Goroutine, error)
  • func (d *Debugger) LocalVariables(scope api.EvalScope) ([]api.Variable, error)
  • func (d *Debugger) PackageVariables(threadID int, filter string) ([]api.Variable, error)
  • func (d *Debugger) ProcessPid() int
  • func (d *Debugger) Registers(threadID int) (string, error)
  • func (d *Debugger) Restart() error
  • func (d *Debugger) SetVariableInScope(scope api.EvalScope, symbol, value string) error
  • func (d *Debugger) Sources(filter string) ([]string, error)
  • func (d *Debugger) Stacktrace(goroutineID, depth int, full bool) ([]api.Stackframe, error)
  • func (d *Debugger) State() (*api.DebuggerState, error)
  • func (d *Debugger) Threads() []*api.Thread
• type FuncLocationSpec
  • func (spec *FuncLocationSpec) Match(sym *gosym.Sym) bool
• type LineLocationSpec
  • func (loc *LineLocationSpec) Find(d *Debugger, scope *proc.EvalScope, locStr string) ([]api.Location, error)
• type LocationSpec
• type NormalLocationSpec
  • func (loc *NormalLocationSpec) FileMatch(path string) bool
  • func (loc *NormalLocationSpec) Find(d *Debugger, scope *proc.EvalScope, locStr string) ([]api.Location, error)
• type OffsetLocationSpec
  • func (loc *OffsetLocationSpec) Find(d *Debugger, scope *proc.EvalScope, locStr string) ([]api.Location, error)
• type RegexLocationSpec
  • func (loc *RegexLocationSpec) Find(d *Debugger, scope *proc.EvalScope, locStr string) ([]api.Location, error)

Types

type AddrLocationSpec

type AddrLocationSpec struct {
	AddrExpr string
}

func (*AddrLocationSpec) Find

func (loc *AddrLocationSpec) Find(d *Debugger, scope *proc.EvalScope, locStr string) ([]api.Location, error)

type AmbiguousLocationError

type AmbiguousLocationError struct {
	Location           string
	CandidatesString   []string
	CandidatesLocation []api.Location
}

func (AmbiguousLocationError) Error

func (ale AmbiguousLocationError) Error() string

type Config

type Config struct {
	// ProcessArgs are the arguments to launch a new process.
	ProcessArgs []string
	// AttachPid is the PID of an existing process to which the debugger should
	// attach.
	AttachPid int
}

Config provides the configuration to start a Debugger.

Only one of ProcessArgs or AttachPid should be specified. If ProcessArgs is provided, a new process will be launched. Otherwise, the debugger will try to attach to an existing process with AttachPid.

type Debugger

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

Debugger service.

Debugger provides a higher level of abstraction over proc.Process. It handles converting from internal types to the types expected by clients. It also handles functionality needed by clients, but not needed in lower lever packages such as proc.

func New

func New(config *Config) (*Debugger, error)

New creates a new Debugger.

func (*Debugger) Breakpoints

func (d *Debugger) Breakpoints() []*api.Breakpoint

Breakpoints returns the list of current breakpoints.

func (*Debugger) ClearBreakpoint

func (d *Debugger) ClearBreakpoint(requestedBp *api.Breakpoint) (*api.Breakpoint, error)

ClearBreakpoint clears a breakpoint.

func (*Debugger) Command

func (d *Debugger) Command(command *api.DebuggerCommand) (*api.DebuggerState, error)

Command handles commands which control the debugger lifecycle

func (*Debugger) CreateBreakpoint

func (d *Debugger) CreateBreakpoint(requestedBp *api.Breakpoint) (*api.Breakpoint, error)

CreateBreakpoint creates a breakpoint.

func (*Debugger) Detach

func (d *Debugger) Detach(kill bool) error

Detach detaches from the target process. If `kill` is true we will kill the process after detaching.

func (*Debugger) EvalVariableInScope

func (d *Debugger) EvalVariableInScope(scope api.EvalScope, symbol string) (*api.Variable, error)

EvalVariableInScope will attempt to evaluate the variable represented by 'symbol' in the scope provided.

func (*Debugger) FindBreakpoint

func (d *Debugger) FindBreakpoint(id int) *api.Breakpoint

FindBreakpoint returns the breakpoint specified by 'id'.

func (*Debugger) FindLocation

func (d *Debugger) FindLocation(scope api.EvalScope, locStr string) ([]api.Location, error)

FindLocation will find the location specified by 'locStr'.

func (*Debugger) FindThread

func (d *Debugger) FindThread(id int) *api.Thread

FindThread returns the thread for the given 'id'.

func (*Debugger) FunctionArguments

func (d *Debugger) FunctionArguments(scope api.EvalScope) ([]api.Variable, error)

FunctionArguments returns the arguments to the current function.

func (*Debugger) Functions

func (d *Debugger) Functions(filter string) ([]string, error)

Functions returns a list of functions in the target process.

func (*Debugger) Goroutines

func (d *Debugger) Goroutines() ([]*api.Goroutine, error)

Goroutines will return a list of goroutines in the target process.

func (*Debugger) LocalVariables

func (d *Debugger) LocalVariables(scope api.EvalScope) ([]api.Variable, error)

LocalVariables returns a list of the local variables.

func (*Debugger) PackageVariables

func (d *Debugger) PackageVariables(threadID int, filter string) ([]api.Variable, error)

PackageVariables returns a list of package variables for the thread, optionally regexp filtered using regexp described in 'filter'.

func (*Debugger) ProcessPid

func (d *Debugger) ProcessPid() int

ProcessPid returns the PID of the process the debugger is debugging.

func (*Debugger) Registers

func (d *Debugger) Registers(threadID int) (string, error)

Registers returns string representation of the CPU registers.

func (*Debugger) Restart

func (d *Debugger) Restart() error

Restart will restart the target process, first killing and then exec'ing it again.

func (*Debugger) SetVariableInScope

func (d *Debugger) SetVariableInScope(scope api.EvalScope, symbol, value string) error

SetVariableInScope will set the value of the variable represented by 'symbol' to the value given, in the given scope.

func (*Debugger) Sources

func (d *Debugger) Sources(filter string) ([]string, error)

Sources returns a list of the source files for target binary.

func (*Debugger) Stacktrace

func (d *Debugger) Stacktrace(goroutineID, depth int, full bool) ([]api.Stackframe, error)

Stacktrace returns a list of Stackframes for the given goroutine. The length of the returned list will be min(stack_len, depth). If 'full' is true, then local vars, function args, etc will be returned as well.

func (*Debugger) State

func (d *Debugger) State() (*api.DebuggerState, error)

State returns the current state of the debugger.

func (*Debugger) Threads

func (d *Debugger) Threads() []*api.Thread

Threads returns the threads of the target process.

type FuncLocationSpec

type FuncLocationSpec struct {
	PackageName           string
	AbsolutePackage       bool
	ReceiverName          string
	PackageOrReceiverName string
	BaseName              string
}

func (*FuncLocationSpec) Match

func (spec *FuncLocationSpec) Match(sym *gosym.Sym) bool

type LineLocationSpec

type LineLocationSpec struct {
	Line int
}

func (*LineLocationSpec) Find

func (loc *LineLocationSpec) Find(d *Debugger, scope *proc.EvalScope, locStr string) ([]api.Location, error)

type LocationSpec

type LocationSpec interface {
	Find(d *Debugger, scope *proc.EvalScope, locStr string) ([]api.Location, error)
}

type NormalLocationSpec

type NormalLocationSpec struct {
	Base       string
	FuncBase   *FuncLocationSpec
	LineOffset int
}

func (*NormalLocationSpec) FileMatch

func (loc *NormalLocationSpec) FileMatch(path string) bool

func (*NormalLocationSpec) Find

func (loc *NormalLocationSpec) Find(d *Debugger, scope *proc.EvalScope, locStr string) ([]api.Location, error)

type OffsetLocationSpec

type OffsetLocationSpec struct {
	Offset int
}

func (*OffsetLocationSpec) Find

func (loc *OffsetLocationSpec) Find(d *Debugger, scope *proc.EvalScope, locStr string) ([]api.Location, error)

type RegexLocationSpec

type RegexLocationSpec struct {
	FuncRegex string
}

func (*RegexLocationSpec) Find

func (loc *RegexLocationSpec) Find(d *Debugger, scope *proc.EvalScope, locStr string) ([]api.Location, error)