vm

package

v0.0.0-...-af24b05 Latest Latest Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 25 Imported by: 119

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/google/syzkaller

Links

Open Source Insights

Documentation ¶

Overview ¶

Package vm provides an abstract test machine (VM, physical machine, etc) interface for the rest of the system. For convenience test machines are subsequently collectively called VMs. Package wraps vmimpl package interface with some common functionality and higher-level interface.

Index ¶

Constants
Variables
func AllowsOvercommit(typ string) bool
func UseNetCompression(typ string) bool
type BootErrorer
type ExitCondition
type InfraErrorer
type InjectOutput
type Instance
type OutputSize
type Pool
- func Create(cfg *mgrconfig.Config, debug bool) (*Pool, error)
type StopChan

Constants ¶

View Source

const (
	// The program is allowed to exit after timeout.
	ExitTimeout = ExitCondition(1 << iota)
	// The program is allowed to exit with no errors.
	ExitNormal
	// The program is allowed to exit with errors.
	ExitError
)

Variables ¶

View Source

var (
	Shutdown   = vmimpl.Shutdown
	ErrTimeout = vmimpl.ErrTimeout
)

Functions ¶

func AllowsOvercommit ¶

func AllowsOvercommit(typ string) bool

AllowsOvercommit returns if the instance type allows overcommit of instances (i.e. creation of instances out-of-thin-air). Overcommit is used during image and patch testing in syz-ci when it just asks for more than specified in config instances. Generally virtual machines (qemu, gce) support overcommit, while physical machines (adb, isolated) do not. Strictly speaking, we should never use overcommit and use only what's specified in config, because we override resource limits specified in config (e.g. can OOM). But it works and makes lots of things much simpler.

func UseNetCompression ¶

func UseNetCompression(typ string) bool

UseNetCompression says if it's beneficial to use network compression for this VM type. Local VMs (qemu) generally don't benefit from compression, while remote machines may benefit.

Types ¶

type BootErrorer ¶

type BootErrorer interface {
	BootError() (string, []byte)
}

type ExitCondition ¶

type ExitCondition int

type InfraErrorer ¶

type InfraErrorer interface {
	InfraError() (string, []byte)
}

type InjectOutput ¶

type InjectOutput <-chan []byte

type Instance ¶

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

func (*Instance) Close ¶

func (inst *Instance) Close()

func (*Instance) Copy ¶

func (inst *Instance) Copy(hostSrc string) (string, error)

func (*Instance) Forward ¶

func (inst *Instance) Forward(port int) (string, error)

func (*Instance) Info ¶

func (inst *Instance) Info() ([]byte, error)

func (*Instance) PprofPort ¶

func (inst *Instance) PprofPort() int

func (*Instance) Run ¶

func (inst *Instance) Run(timeout time.Duration, reporter *report.Reporter, command string, opts ...any) (
	[]byte, *report.Report, error)

Run runs cmd inside of the VM (think of ssh cmd) and monitors command execution and the kernel console output. It detects kernel oopses in output, lost connections, hangs, etc. Returns command+kernel output and a non-symbolized crash report (nil if no error happens). Accepted options:

StopChan: stop channel can be used to prematurely stop the command
ExitCondition: says which exit modes should be considered as errors/OK
OutputSize: how much output to keep/return

type OutputSize ¶

type OutputSize int

type Pool ¶

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

func Create ¶

func Create(cfg *mgrconfig.Config, debug bool) (*Pool, error)

Create creates a VM pool that can be used to create individual VMs.

func (*Pool) Close ¶

func (pool *Pool) Close() error

TODO: Integration or end-to-end testing is needed.

https://github.com/google/syzkaller/pull/3269#discussion_r967650801

func (*Pool) Count ¶

func (pool *Pool) Count() int

func (*Pool) Create ¶

func (pool *Pool) Create(index int) (*Instance, error)

type StopChan ¶

type StopChan <-chan bool

Source Files ¶

View all Source files

vm.go

Directories ¶

Path	Synopsis
adb
bhyve
cuttlefish Package cuttlefish allows to use Cuttlefish Android emulators hosted on Google Compute Engine (GCE) virtual machines as VMs.	Package cuttlefish allows to use Cuttlefish Android emulators hosted on Google Compute Engine (GCE) virtual machines as VMs.
gce Package gce allows to use Google Compute Engine (GCE) virtual machines as VMs.	Package gce allows to use Google Compute Engine (GCE) virtual machines as VMs.
gvisor Package gvisor provides support for gVisor, user-space kernel, testing.	Package gvisor provides support for gVisor, user-space kernel, testing.
isolated
proxyapp Package proxyapp package implements the experimental plugins support.	Package proxyapp package implements the experimental plugins support.
mocks
proxyrpc
qemu
starnix
vmimpl Package vmimpl provides an abstract test machine (VM, physical machine, etc) interface for the rest of the system.	Package vmimpl provides an abstract test machine (VM, physical machine, etc) interface for the rest of the system.
vmm Package vmm provides VMs based on OpenBSD vmm virtualization.	Package vmm provides VMs based on OpenBSD vmm virtualization.
vmware

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