builder

Documentation

Index

• Constants
• Variables
• func Script(b Builder, c Config, kr kernelrelease.KernelRelease) (string, error)
• type Build
  • func (b *Build) GetBuilderImage() string
  • func (b *Build) KernelReleaseFromBuildConfig() kernelrelease.KernelRelease
  • func (b *Build) LoadImages()
  • func (b *Build) ToConfig() Config
• type Builder
  • func Factory(target Type) (Builder, error)
• type Config
• type GCCVersionRequestor
• type Image
• type ImageKey
• type ImagesMap
• type MinimumURLsBuilder
• type Targets
  • func (t Targets) Targets() []string
• type Type
  • func (t Type) String() string

Constants

const DriverDirectory = "/tmp/driver"

DriverDirectory is the directory the processor uses to store the driver.

const ModuleFileName = "module.ko"

ModuleFileName is the standard file name for the kernel module.

const ProbeFileName = "probe.o"

ProbeFileName is the standard file name for the eBPF probe.

Variables

var BuilderByTarget = Targets{}

BuilderByTarget maps targets to their builder.

var HeadersNotFoundErr = errors.New("kernel headers not found")

var ModuleFullPath = path.Join(DriverDirectory, ModuleFileName)

ModuleFullPath is the standard path for the kernel module. Builders must place the compiled module at this location.

var ProbeFullPath = path.Join(DriverDirectory, "bpf", ProbeFileName)

ProbeFullPath is the standard path for the eBPF probe. Builders must place the compiled probe at this location.

Functions

func Script

func Script(b Builder, c Config, kr kernelrelease.KernelRelease) (string, error)

Types

type Build

type Build struct {
	TargetType       Type
	KernelConfigData string
	KernelRelease    string
	KernelVersion    string
	DriverVersion    string
	Architecture     string
	ModuleFilePath   string
	ProbeFilePath    string
	ModuleDriverName string
	ModuleDeviceName string
	BuilderImage     string
	BuilderRepos     []string
	KernelUrls       []string
	GCCVersion       string
	RepoOrg          string
	RepoName         string
	Images           ImagesMap
}

Build contains the info about the on-going build.

func (*Build) GetBuilderImage

func (b *Build) GetBuilderImage() string

func (*Build) KernelReleaseFromBuildConfig

func (b *Build) KernelReleaseFromBuildConfig() kernelrelease.KernelRelease

func (*Build) LoadImages

func (b *Build) LoadImages()

func (*Build) ToConfig

func (b *Build) ToConfig() Config

type Builder

type Builder interface {
	Name() string
	TemplateScript() string
	URLs(c Config, kr kernelrelease.KernelRelease) ([]string, error)
	TemplateData(c Config, kr kernelrelease.KernelRelease, urls []string) interface{} // error return type is managed
}

Builder represents a builder capable of generating a script for a driverkit target.

func Factory

func Factory(target Type) (Builder, error)

Factory returns a builder for the given target.

type Config

type Config struct {
	DriverName      string
	DeviceName      string
	DownloadBaseURL string
	*Build
}

Config contains all the configurations needed to build the kernel module or the eBPF probe.

type GCCVersionRequestor

type GCCVersionRequestor interface {
	// GCCVersion returns the GCC version to be used.
	// If the returned value is empty, the default algorithm will be enforced.
	GCCVersion(kr kernelrelease.KernelRelease) semver.Version
}

type Image

type Image struct {
	Target     Type
	GCCVersion semver.Version // we expect images to internally link eg: gcc5 to gcc5.0.0
	Name       string
}

type ImageKey

type ImageKey string

type ImagesMap

type ImagesMap map[ImageKey]Image

type MinimumURLsBuilder

type MinimumURLsBuilder interface {
	MinimumURLs() int
}

MinimumURLsBuilder is an optional interface to specify minimum number of requested headers urls

type Targets

type Targets map[Type]Builder

Targets is a type representing the list of the supported targets.

func (Targets) Targets

func (t Targets) Targets() []string

Targets returns the list of all the supported targets.

type Type

type Type string

Type is a type representing targets.

const TargetTypeAlma Type = "almalinux"

TargetTypeAlma identifies the AlmaLinux target.

const TargetTypeAmazonLinux Type = "amazonlinux"

TargetTypeAmazonLinux identifies the AmazonLinux target.

const TargetTypeAmazonLinux2 Type = "amazonlinux2"

TargetTypeAmazonLinux2 identifies the AmazonLinux2 target.

const TargetTypeAmazonLinux2022 Type = "amazonlinux2022"

TargetTypeAmazonLinux2022 identifies the AmazonLinux2022 target.

const TargetTypeArchlinux Type = "arch"

TargetTypeArchlinux identifies the Archlinux target.

const TargetTypeBottlerocket Type = "bottlerocket"

TargetTypeBottlerocket identifies the Bottlerocket target.

const TargetTypeCentos Type = "centos"

TargetTypeCentos identifies the Centos target.

const TargetTypeDebian Type = "debian"

TargetTypeDebian identifies the Debian target.

const TargetTypeFedora Type = "fedora"

TargetTypeFedora identifies the Fedora target.

const TargetTypeFlatcar Type = "flatcar"

TargetTypeFlatcar identifies the Flatcar target.

const TargetTypeMinikube Type = "minikube"

TargetTypeMinikube identifies the Minikube target.

const TargetTypeOpenSUSE Type = "opensuse"

TargetTypeOpenSUSE identifies the OpenSUSE target.

const TargetTypePhoton Type = "photon"

TargetTypePhoton identifies the Photon target.

const TargetTypeRedhat Type = "redhat"

TargetTypeRedhat identifies the redhat target.

const TargetTypeRocky Type = "rocky"

TargetTypeRocky identifies the Rocky target.

const TargetTypeUbuntu Type = "ubuntu"

TargetTypeUbuntu identifies the Ubuntu target.

const TargetTypeVanilla Type = "vanilla"

TargetTypeVanilla identifies the Vanilla target.

func (Type) String

func (t Type) String() string