systracer

type Condition ¶

type Condition struct{}

Condition is common embed field for defining an extra condition for current field.

type Event ¶

type Event struct {
	TaskPID   uint32
	Timestamp time.Time
	// contains filtered or unexported fields
}

Event stores common event data made by all types of concrete tracing events. The format is defined by "<debugfs>/tracing/trace" file.

The comm field is ommitted out since it is always imcomplete (rendered as "<...>) and is not essentially required by all events.

type Manager ¶

type Manager interface {
	// TraceKProbe creates either a kprobe (when handled
	// event is ProbeEvent) or a kretprobe (when handled
	// event is ReturnEvent).
	TraceKProbe(
		location string, handler interface{},
	) (Trace, <-chan struct{}, error)

	// TraceUProbe creates either a uprobe (when handled
	// event is ProbeEvent) or a uretprobe (when handled
	// event is ReturnEvent).
	TraceUProbe(
		library, location string, handler interface{},
	) (Trace, <-chan struct{}, error)
}

Manager is the manager of traces.

The manager is the monolithic consumer to read from trace pipe "<tracefs>/instances/<namespace>/trace_pipe" and generate events per registered events.

func New(
	ctx context.Context, group *errgroup.Group, options ...Option,
) (Manager, error)

type Option ¶

type Option func(*option)

Option to initialize the systrace subsystem.

func WithInstanceName(name string) Option

func WithLimitInterval(dur time.Duration) Option

func WithLogger(logger *zap.Logger) Option

func WithOptions(opts ...Option) Option

func WithTraceFSPath(path string) Option

type ProbeEvent ¶

type ProbeEvent struct {
	Event
}

ProbeEvent is the event triggered when touching any of the breakpoint inside a function.

type ReturnEvent ¶

type ReturnEvent struct {
	Event
}

ReturnEvent is the event triggered when a return instruction in function is executed.

type StringAddr ¶

type StringAddr struct {
	String string
	Addr   uint64
}

StringAddr is the special type used in the place of the string to fetch the address canary when decoding the string, when it is meaningful.

type Trace ¶

type Trace interface {
	ID() uint64
	SetCondition(string) error
	SetEnabled(bool)
	GetDone() uint64
	GetLost() uint64
	Close()
}

Trace is a controlling handle for trace events.

The trace handle is initially not started to avoid deadlocking when used as collectors. The caller must manually activate them after their master thread has been initialized.

And the trace can be stopped at runtime, it is recommended to disable certain tracing when there's no subscribers and the master thread nned not to track the real time state with the trace.