core

Documentation

Overview

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

Index

• Constants
• func TransformFromSchema(ctx context.Context, props interface{}) (interface{}, error)
• type MakeArgs
• type Unikraft
  • func NewUnikraftFromOptions(opts ...UnikraftOption) (Unikraft, error)
• type UnikraftConfig
  • func (uk UnikraftConfig) CONFIG() (string, error)
  • func (uk UnikraftConfig) CONFIGLIB() (string, error)
  • func (uk UnikraftConfig) CONFIG_CONFIG_IN() (string, error)
  • func (uk UnikraftConfig) CONFIG_UK_LIB() (string, error)
  • func (uk UnikraftConfig) CONFIG_UK_PLAT() (string, error)
  • func (uc UnikraftConfig) IsUnpacked() bool
  • func (uc UnikraftConfig) KConfig() kconfig.KeyValueMap
  • func (uc UnikraftConfig) KConfigTree(ctx context.Context, extra ...*kconfig.KeyValue) (*kconfig.KConfigFile, error)
  • func (uk UnikraftConfig) Libraries(ctx context.Context) (lib.Libraries, error)
  • func (uc UnikraftConfig) MarshalYAML() (interface{}, error)
  • func (uc UnikraftConfig) Name() string
  • func (uc UnikraftConfig) Path() string
  • func (uc UnikraftConfig) PrintInfo(ctx context.Context) string
  • func (uc UnikraftConfig) Source() string
  • func (uc UnikraftConfig) Type() unikraft.ComponentType
  • func (uc UnikraftConfig) Version() string
• type UnikraftOption
  • func WithKConfig(kconfig kconfig.KeyValueMap) UnikraftOption
  • func WithPath(path string) UnikraftOption
  • func WithSource(source string) UnikraftOption
  • func WithVersion(version string) UnikraftOption
• type Verbosity

Constants

const (
	CONFIG_UK_PLAT = "plat"
	CONFIG_UK_LIB  = "lib"
	CONFIG         = "support/kconfig"
	CONFIGLIB      = "support/kconfiglib"
)

Functions

func TransformFromSchema

func TransformFromSchema(ctx context.Context, props interface{}) (interface{}, error)

TransformFromSchema parses an input schema and returns an instantiated UnikraftConfig

Types

type MakeArgs

type MakeArgs struct {
	OutputDir      string `export:"O,omitempty"`
	ApplicationDir string `export:"A"`
	PlatformDirs   string `export:"P,omitempty"`
	LibraryDirs    string `export:"L,omitempty"`
	Name           string `export:"N,omitempty"`
	// Verbosity      Verbosity `export:"V,omitempty" default:"0"`
	ConfigPath string `export:"C,omitempty"`
}

type Unikraft

type Unikraft interface {
	component.Component

	// Libraries returns the application libraries' configurations
	Libraries(ctx context.Context) (lib.Libraries, error)
}

func NewUnikraftFromOptions

func NewUnikraftFromOptions(opts ...UnikraftOption) (Unikraft, error)

NewUnikraftFromOptions is a constructor that configures a core configuration.

type UnikraftConfig

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

func (UnikraftConfig) CONFIG

func (uk UnikraftConfig) CONFIG() (string, error)

func (UnikraftConfig) CONFIGLIB

func (uk UnikraftConfig) CONFIGLIB() (string, error)

func (UnikraftConfig) CONFIG_CONFIG_IN

func (uk UnikraftConfig) CONFIG_CONFIG_IN() (string, error)

func (UnikraftConfig) CONFIG_UK_LIB

func (uk UnikraftConfig) CONFIG_UK_LIB() (string, error)

func (UnikraftConfig) CONFIG_UK_PLAT

func (uk UnikraftConfig) CONFIG_UK_PLAT() (string, error)

func (UnikraftConfig) IsUnpacked

func (uc UnikraftConfig) IsUnpacked() bool

func (UnikraftConfig) KConfig

func (uc UnikraftConfig) KConfig() kconfig.KeyValueMap

func (UnikraftConfig) KConfigTree

func (uc UnikraftConfig) KConfigTree(ctx context.Context, extra ...*kconfig.KeyValue) (*kconfig.KConfigFile, error)

func (UnikraftConfig) Libraries

func (uk UnikraftConfig) Libraries(ctx context.Context) (lib.Libraries, error)

func (UnikraftConfig) MarshalYAML

func (uc UnikraftConfig) MarshalYAML() (interface{}, error)

MarshalYAML makes UnikraftConfig implement yaml.Marshaller

func (UnikraftConfig) Name

func (uc UnikraftConfig) Name() string

func (UnikraftConfig) Path

func (uc UnikraftConfig) Path() string

func (UnikraftConfig) PrintInfo

func (uc UnikraftConfig) PrintInfo(ctx context.Context) string

func (UnikraftConfig) Source

func (uc UnikraftConfig) Source() string

func (UnikraftConfig) Type

func (uc UnikraftConfig) Type() unikraft.ComponentType

func (UnikraftConfig) Version

func (uc UnikraftConfig) Version() string

type UnikraftOption

type UnikraftOption func(*UnikraftConfig) error

UnikraftOption is a function that modifies a UnikraftConfig.

func WithKConfig

func WithKConfig(kconfig kconfig.KeyValueMap) UnikraftOption

WithKConfig sets the kconfig of the unikraft.

func WithPath

func WithPath(path string) UnikraftOption

WithPath sets the path of the unikraft.

func WithSource

func WithSource(source string) UnikraftOption

WithSource sets the source of the unikraft.

func WithVersion

func WithVersion(version string) UnikraftOption

WithName sets the name of the unikraft.

type Verbosity

type Verbosity string

const (
	VerboseQuiet Verbosity = "0"
	VerboseBuild Verbosity = "1"
	VerboseExtra Verbosity = "2"

	// The delimeter used within Unikraft's build system
	MakeDelimeter = ":"
)