skbtrace

type AggrFunc string

type AggregateCommonOptions struct {
	// Interval of aggregation map dumping
	Interval time.Duration

	// Truncate defines number of entries that should be printed when printing
	// the aggregation if set to positive value
	Truncate int
}

type BPFTraceVersionProvider struct{}

type Block struct {
	Preamble   string
	Statements []Statement
	// contains filtered or unexported fields
}

type BlockContext map[string]struct{}

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

type BuiltinType string

type CastTemplateArgs struct {
	// Variable the object is casted from
	Src string

	// Name of the variable object is assigned to
	Dst string
}

type CommonDumpOptions struct {
	FieldGroupRows []string

	// Extra printer parameters
	TimeMode TimeMode
	KStack   bool
	UStack   bool
}

type CommonOptions struct {
	Timeout time.Duration

	// Hints contains list of row names that are used for resolving weak aliases
	Hints []string

	// Time Unit for measuring times
	TimeUnit string
}

type DuplicateEventOptions struct {
	CommonOptions

	// Specification of the probe
	Spec TimeSpec

	// Specifies if exit() should be called on first duplicate
	Exit bool

	CommonDumpOptions
}

type Error interface {
	Level() ErrorLevel
	Ident() string

	NextError() error

	Message() string
}

type ErrorLevel string

type Expression string

type Feature struct {
	Component  FeatureComponent
	Name       string
	Help       string
	Commit     string
	MinVersion Version
	// contains filtered or unexported fields
}

type FeatureComponent int

type FeatureComponentSpec struct {
	Component FeatureComponent
	Provider  VersionProvider
}

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

type Field struct {
	// Name of struct field defined in header file
	Name string

	// Alias for using single-string shortcut without verbose object->field form
	// i.e. 'src' is '$iph->saddr'
	Alias string

	// If specified allows to specify an alias accessible from multiple paths
	// Whichever is more favorable wins
	WeakAlias bool

	// Format key which precedes value when printing. If omitted, Name is used
	FmtKey string

	// Format specifier for BPFTrace printf()
	FmtSpec string

	// Converter function which is used to retrieve field value (which returned as expression)
	// using statements from object obj and its field named field
	Converter FieldConverter

	// ConverterMask overrides contexts in which converter will be used
	ConverterMask uint

	// Preprocessor function is used to convert human-readable value used in filter
	// to machine value
	Preprocessor FieldPreprocessor

	// FilterOperator processes op specified in filter into an expression by filter
	FilterOperator func(expr Expression, op, value string) (Expression, error)

	// SanityFilter produces a template of filter which should be checked
	// when getting the object to avoid printing junk data
	SanityFilter *Filter

	// Help for fields helper subcommand
	Help string
}

type FieldConverter func(obj, field string) ([]Statement, Expression)

type FieldGroup struct {
	// Name of the row (might be non-unique, in this case multiple rows will be dumped)
	Row string

	// Object variable name to be dumped. Might be empty for objectless fields
	// taken from probe args or global variables, otherwise must refer to a valid
	// object registered by AddObjects
	Object string

	// List of fields in this group
	Fields []*Field

	// Name of the row for base group (used only for help)
	BaseFieldGroup string

	// Prefix for field aliases: if non empty, field copies will get different
	// aliases prefixed with this string and a dash. Useful for multiple instances
	// of header, or in/out interface logic
	FieldAliasPrefix string
}

type FieldPreprocessor func(op, value string) (string, error)

type Filter struct {
	Object string
	Field  string
	Op     string
	Value  string
}

type FilterOptions struct {
	RawFilters []string
	Filters    []*Filter
}

type KernelVersionProvider struct{}

type Object struct {
	// Name of the variable used for this object
	Variable string

	// List of include files which should be included in BPFTrace
	// script for this type to become available in BPFTrace
	HeaderFiles []string

	// Struct definitions to be embedded into codes
	StructDefs []string

	// SanityFilter allows to specify a filter referring an external object
	SanityFilter Filter

	// Maps object variable names this object is inferrable from to
	// templates (see CastTemplateArgs for template arguments)
	Casts map[string]string
}

type Probe struct {
	// Name of the probe in BPFTrace format of "provider:name"
	Name string

	// ReturnName contains explicit name that denotes end of the context probe execution
	ReturnName string

	// List of aliases which could be used in command line
	Aliases []string

	// Context contains initial mapping untyped variable names to probe raw arguments
	Args map[string]string

	// Help string dumped by probes command
	Help string
}

type ProcessedFilter struct {
	Filter
	// contains filtered or unexported fields
}

type Program struct {
	HeaderFiles map[string]struct{}
	StructDefs  map[string]*StructDef
	Blocks      []*Block
}

type RunnerOptions struct {
	DumpScript     bool
	BPFTraceBinary string
}

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

type StructDef struct {
	// Name of the structure
	TypeName string

	// Text of struct definition split by line
	Text []string
	// contains filtered or unexported fields
}

type TimeAggregateOptions struct {
	TimeCommonOptions
	AggregateCommonOptions

	// Aggregate Func for time and divisor for adjusting from nanoseconds
	Func AggrFunc

	// ToEventCount is a number of to probe firings before we start
	// measuring time delta. Useful for measuring longer handshakes
	// such as TLS handshake for each 2nd ACK is of interest
	ToEventCount int
}

type TimeCommonOptions struct {
	CommonOptions

	// Specification of the probe in which start time is collected.
	FromSpec TimeSpec

	// Specification of the probe in which time delta is computed.
	// If filters or keys are omitted in ToSpec, they are derived from FromSpec.
	ToSpec TimeSpec
}

type TimeMode string

type TimeOutlierDumpOptions struct {
	TimeCommonOptions

	// OutlierThreshold allows to dump events which time exceed specified threshold
	OutlierThreshold time.Duration

	// Specifies if exit() should be called on first outlier
	Exit bool

	CommonDumpOptions
}

type TimeSpec struct {
	// Name of the probe this probe is refers to
	Probe string

	// Lists of filters applied to this probe
	FilterOptions

	// List of keys used to map requests
	Keys []string

	// Hints for this probe
	Hints []string
}

type TraceAggregateOptions struct {
	TraceCommonOptions
	AggregateCommonOptions

	// Aggregation Func and its argument (optional)
	Func AggrFunc
	Arg  string

	// Keys for aggregation map entry. Optionally, probe name may be added
	Keys []string
}

type TraceCommonOptions struct {
	CommonOptions

	ContextProbeNames    []string
	ContextFilterOptions FilterOptions
	ContextKey           string

	ProbeNames []string
	FilterOptions
}

type TraceDumpOptions struct {
	TraceCommonOptions

	CommonDumpOptions
}

type Version struct {
	// Open-Source derived versions
	Major    int
	Submajor int
	Minor    int

	// NOTE: Yandex Cloud derivatives use build numbers and do not alter open-source versions
	Build int
	Date  int
}

type VersionProvider interface {
	Get() ([]byte, error)
	Parse(verBytes []byte) (Version, error)
	GetDefault() Version
}