core

package
v0.8.7-198-gb872719a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 5, 2024 License: BSD-3-Clause Imports: 9 Imported by: 0

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

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

Variables

This section is empty.

Functions

func TransformFromSchema added in v0.4.0

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) (map[string]*lib.LibraryConfig, error)
}

type UnikraftConfig

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

func NewUnikraftFromOptions added in v0.5.1

func NewUnikraftFromOptions(ctx context.Context, opts ...UnikraftOption) (*UnikraftConfig, error)

NewUnikraftFromOptions is a constructor that configures a core configuration.

func (UnikraftConfig) CONFIG added in v0.4.0

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

func (UnikraftConfig) CONFIGLIB added in v0.4.0

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

func (UnikraftConfig) CONFIG_CONFIG_IN added in v0.4.0

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

func (UnikraftConfig) CONFIG_UK_LIB added in v0.4.0

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

func (UnikraftConfig) CONFIG_UK_PLAT added in v0.4.0

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

func (UnikraftConfig) CompileDate added in v0.7.1

func (uc UnikraftConfig) CompileDate() string

func (UnikraftConfig) CompiledBy added in v0.7.1

func (uc UnikraftConfig) CompiledBy() string

func (UnikraftConfig) CompiledByAssoc added in v0.7.1

func (uc UnikraftConfig) CompiledByAssoc() string

func (UnikraftConfig) Compiler added in v0.7.1

func (uc UnikraftConfig) Compiler() string

func (UnikraftConfig) IsUnpacked added in v0.4.0

func (uc UnikraftConfig) IsUnpacked() bool

func (UnikraftConfig) KConfig added in v0.4.0

func (uc UnikraftConfig) KConfig() kconfig.KeyValueMap

func (UnikraftConfig) KConfigTree added in v0.4.0

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

func (UnikraftConfig) Libraries added in v0.4.0

func (uk UnikraftConfig) Libraries(ctx context.Context) (map[string]*lib.LibraryConfig, error)

func (UnikraftConfig) License added in v0.7.1

func (uc UnikraftConfig) License() string

func (UnikraftConfig) MarshalYAML added in v0.6.4

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

MarshalYAML makes UnikraftConfig implement yaml.Marshaller

func (UnikraftConfig) Name

func (uc UnikraftConfig) Name() string

func (UnikraftConfig) Path added in v0.4.0

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) String added in v0.7.0

func (uc UnikraftConfig) String() string

func (UnikraftConfig) Type

func (UnikraftConfig) Version

func (uc UnikraftConfig) Version() string

type UnikraftOption added in v0.5.1

type UnikraftOption func(*UnikraftConfig) error

UnikraftOption is a function that modifies a UnikraftConfig.

func WithCompileDate added in v0.7.1

func WithCompileDate(compileDate string) UnikraftOption

WithCompileDate sets the compile date of the unikraft.

func WithCompiledBy added in v0.7.1

func WithCompiledBy(compiledBy string) UnikraftOption

WithCompiledBy sets the user who compiled unikraft.

func WithCompiledByAssoc added in v0.7.1

func WithCompiledByAssoc(compiledByAssoc string) UnikraftOption

WithCompiledByAssoc sets the association of the user who compiled unikraft.

func WithCompiler added in v0.7.1

func WithCompiler(compiler string) UnikraftOption

WithCompiler sets the compiler of the unikraft.

func WithKConfig added in v0.5.1

func WithKConfig(kconfig kconfig.KeyValueMap) UnikraftOption

WithKConfig sets the kconfig of the unikraft.

func WithLicense added in v0.7.1

func WithLicense(license string) UnikraftOption

WithLicense sets the license of the unikraft.

func WithPath added in v0.5.1

func WithPath(path string) UnikraftOption

WithPath sets the path of the unikraft.

func WithSource added in v0.5.1

func WithSource(source string) UnikraftOption

WithSource sets the source of the unikraft.

func WithVersion added in v0.5.1

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 = ":"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL