initrd

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.

Index

• Constants
• Variables
• type InitrdConfig
  • func NewFromFile(workdir, path string) (*InitrdConfig, error)
  • func NewFromMapping(workdir, output string, maps ...string) (*InitrdConfig, error)
  • func NewFromPath(base string, prefix string, files ...string) (*InitrdConfig, error)
  • func (i *InitrdConfig) NewReader(w io.Reader) (*cpio.Reader, error)
  • func (i *InitrdConfig) NewWriter(w io.Writer) (*cpio.Writer, error)
• type InitrdFormat
  • func (d InitrdFormat) String() string

Constants

const InputDelimeter = ":"

Variables

var NameToType = map[string]InitrdFormat{
	"odc":   ODC,
	"newc":  NEWC,
	"ustar": USTAR,
}

Types

type InitrdConfig

type InitrdConfig struct {
	Output   string            `yaml:"output,omitempty"`
	Files    map[string]string `yaml:"files,omitempty"`
	Format   InitrdFormat      `yaml:"format,omitempty"`
	Compress bool              `yaml:"compress,omitempty"`
	// contains filtered or unexported fields
}

func NewFromFile

func NewFromFile(workdir, path string) (*InitrdConfig, error)

NewFromFile interprets a given path as a initramfs disk file and returns an instantiated InitrdConfig if successful.

func NewFromMapping

func NewFromMapping(workdir, output string, maps ...string) (*InitrdConfig, error)

NewFromMapping accepts a working directory base that represents the relative path of the files to serialize which are provided by a slice of mappings, each delimetered by the default delimeter `:` which separates the path on the host and the path inside of the iniramfs. A destination of the final archive is provided by the positional argument output.

func NewFromPath

func NewFromPath(base string, prefix string, files ...string) (*InitrdConfig, error)

NewFromPath accepts a positional argument base which is the directory that the provided files should be serialized from. The prefix positional argument is used to affix all embedded files to the provided location. Left empty, the defeault prefix is "/".

func (*InitrdConfig) NewReader

func (i *InitrdConfig) NewReader(w io.Reader) (*cpio.Reader, error)

func (*InitrdConfig) NewWriter

func (i *InitrdConfig) NewWriter(w io.Writer) (*cpio.Writer, error)

type InitrdFormat

type InitrdFormat int

const (
	ODC InitrdFormat = iota
	NEWC
	USTAR
)

func (InitrdFormat) String

func (d InitrdFormat) String() string