types

Documentation

Index

• Constants
• func GetColumns() *columns.Columns[Event]
• func GetGadgetIdentByPrefix(spec *ebpf.CollectionSpec, prefix string) ([]string, error)
• func GetSetter[T FieldType | string](f *EventFactory, name string) func(*Event, T)
• func Populate(m *metadatav1.GadgetMetadata, spec *ebpf.CollectionSpec) error
• func Validate(m *metadatav1.GadgetMetadata, spec *ebpf.CollectionSpec) error
• type ColumnDesc
  • func FactoryAddField[T FieldType](f *EventFactory, name string) ColumnDesc
  • func FactoryAddString(f *EventFactory, name string) ColumnDesc
• type Event
  • func (ev *Event) GetEndpoints() []*eventtypes.L3Endpoint
  • func (ev *Event) GetMountNSID() uint64
  • func (ev *Event) GetNetNSID() uint64
• type EventFactory
  • func NewEventFactory() *EventFactory
  • func (f *EventFactory) NewEvent() *Event
• type FieldType
• type GadgetInfo
• type Kind
• type L3Endpoint
• type L4Endpoint
• type Printer
• type RunGadgetDesc
• type Type

Constants

const (
	// Name of the type that gadgets should use to store an L3 endpoint.
	L3EndpointTypeName = "gadget_l3endpoint_t"

	// Name of the type that gadgets should use to store an L4 endpoint.
	L4EndpointTypeName = "gadget_l4endpoint_t"

	// Name of the type to store a mount namespace inode id
	MntNsIdTypeName = "gadget_mntns_id"

	// Name of the type to store a timestamp
	TimestampTypeName = "gadget_timestamp"
)

Keep this aligned with include/gadget/types.h

const (
	IndexVirtual = -1
	IndexEBPF    = 0
	IndexFixed   = 1
)

const (
	GadgetHeapMapName = "gadget_heap"
)

Keep this aligned with include/gadget/buffer.h

const (
	// Name of the parameter that defins the network interface a TC program is attached to.
	IfaceParam = "iface"
)

const (

	// Prefix used to mark tracer map created with GADGET_TRACER_MAP() defined in
	// include/gadget/buffer.h.
	TracerMapPrefix = "gadget_map_tracer_"
)

Keep this aligned with include/gadget/macros.h

Functions

func GetColumns

func GetColumns() *columns.Columns[Event]

func GetGadgetIdentByPrefix

func GetGadgetIdentByPrefix(spec *ebpf.CollectionSpec, prefix string) ([]string, error)

GetGadgetIdentByPrefix returns the strings generated by GADGET_ macros.

func GetSetter

func GetSetter[T FieldType | string](f *EventFactory, name string) func(*Event, T)

func Populate

func Populate(m *metadatav1.GadgetMetadata, spec *ebpf.CollectionSpec) error

Populate fills the metadata from its ebpf spec

func Validate

func Validate(m *metadatav1.GadgetMetadata, spec *ebpf.CollectionSpec) error

Types

type ColumnDesc

type ColumnDesc struct {
	Name      string
	BlobIndex int // -1: virtual, 0: ebpf, 1: fixed length, 1+ strings
	Type      Type
	Offset    uintptr
}

ColumnDesc describes how a column is built. It's basically a serializable version of columns.DynamicField

func FactoryAddField

func FactoryAddField[T FieldType](f *EventFactory, name string) ColumnDesc

func FactoryAddString

func FactoryAddString(f *EventFactory, name string) ColumnDesc

type Event

type Event struct {
	// Do not use eventtypes.Event because we don't want to have the timestamp column.
	eventtypes.CommonData

	// Type indicates the kind of this event
	Type eventtypes.EventType `json:"type"`

	// Message when Type is ERR, WARN, DEBUG or INFO
	Message string `json:"message,omitempty"`

	L3Endpoints []L3Endpoint      `json:"l3endpoints,omitempty"`
	L4Endpoints []L4Endpoint      `json:"l4endpoints,omitempty"`
	Timestamps  []eventtypes.Time `json:"timestamps,omitempty"`

	MountNsID uint64 `json:"-"`
	NetNsID   uint64 `json:"-"`

	// Blob is used to save data to be sent to the client.
	// [0] is used for bpf event
	// [1] is used for fixed-size members
	// [1+] is used for variable size members
	Blob [][]byte `json:"blob,omitempty"`
}

func (*Event) GetEndpoints

func (ev *Event) GetEndpoints() []*eventtypes.L3Endpoint

func (*Event) GetMountNSID

func (ev *Event) GetMountNSID() uint64

func (*Event) GetNetNSID

func (ev *Event) GetNetNSID() uint64

type EventFactory

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

func NewEventFactory

func NewEventFactory() *EventFactory

func (*EventFactory) NewEvent

func (f *EventFactory) NewEvent() *Event

type FieldType

type FieldType interface {
	constraints.Integer | constraints.Float | bool
}

type GadgetInfo

type GadgetInfo struct {
	GadgetMetadata *metadatav1.GadgetMetadata
	Columns        []ColumnDesc
	ProgContent    []byte
	GadgetType     gadgets.GadgetType
	EventFactory   *EventFactory
}

type Kind

type Kind uint8

const (
	KindNone Kind = iota
	KindUint8
	KindUint16
	KindUint32
	KindUint64
	KindInt8
	KindInt16
	KindInt32
	KindInt64
	KindBool
	KindFloat32
	KindFloat64
	KindString
	KindArray

	// TODO: this should be made more generic to avoid coupling operators with this
	KindL3Endpoint
	KindL4Endpoint
	KindTimestamp
)

TODO: use reflect.Kind? (once we resolve TODO below)

type L3Endpoint

type L3Endpoint struct {
	eventtypes.L3Endpoint
	Name string
}

type L4Endpoint

type L4Endpoint struct {
	eventtypes.L4Endpoint
	Name string
}

type Printer

type Printer interface {
	Output(payload string)
	Logf(severity logger.Level, fmt string, params ...any)
}

Printer is implemented by objects that can print information, like frontends.

type RunGadgetDesc

type RunGadgetDesc interface {
	GetGadgetInfo(params *params.Params, args []string) (*GadgetInfo, error)
	CustomParser(info *GadgetInfo) (parser.Parser, error)
	JSONConverter(info *GadgetInfo, p Printer) func(ev any)
	JSONPrettyConverter(info *GadgetInfo, p Printer) func(ev any)
	YAMLConverter(info *GadgetInfo, p Printer) func(ev any)
}

RunGadgetDesc represents the different methods implemented by the run gadget descriptor.

type Type

type Type struct {
	Kind Kind

	// Fields only for KindArray
	ArrayNElements int // number of elements in the array
	ArrayType      *Type
}