macos

package
v0.10.0 Latest Latest
Warning

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

 Go to latest Published: Jun 20, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package macos provides macOS native virtualization.

Package macos provides macOS native virtualization backends.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultVMImage 

func DefaultVMImage(arch string) string

func GenerateSandboxProfile 

func GenerateSandboxProfile(rootfs string, readOnly bool, network string) string

Types

type Backend 

type Backend interface {
	Name() string
	Available() bool
	MinVersion() string
	CreateVM(cfg *VMConfig) error
	StartVM(id string) error
	StopVM(id string, timeoutSec int) error
	DeleteVM(id string) error
	VMStatus(id string) (string, error)
	ShareHostDir(hostPath, guestPath, tag string, readOnly bool) error
	UnshareHostDir(tag string) error
	ForwardPort(hostPort, guestPort int, proto string) error
	RemoveForwardPort(hostPort int, proto string) error
	Stats(id string) (*VMStats, error)
}

func SelectBackend 

func SelectBackend(caps *Capabilities) Backend

type Capabilities 

type Capabilities struct {
	Version        string
	Arch           string
	IsTahoe        bool
	IsAppleSilicon bool
	ASIF           bool
	NFSv41         bool
	VZ             bool
	VirtioFS       bool
	Rosetta        bool
	Hypervisor     bool
	QEMU           bool
	Sandbox        bool
	BestBackend    string
}

func DetectCapabilities 

func DetectCapabilities() *Capabilities

type FSShare 

type FSShare struct {
	HostPath  string
	GuestPath string
	ReadOnly  bool
	Tag       string
}

type PortForward 

type PortForward struct {
	HostPort  int
	GuestPort int
	Protocol  string
	HostIP    string
}

type QEMUBackend 

type QEMUBackend struct{}

QEMUBackend is a stub for the QEMU-based macOS virtualization backend.

func NewQEMUBackend 

func NewQEMUBackend() *QEMUBackend

NewQEMUBackend returns nil on non-darwin platforms.

func (*QEMUBackend) Available 

func (b *QEMUBackend) Available() bool

Available reports that the backend is not available on this platform.

func (*QEMUBackend) CreateVM 

func (b *QEMUBackend) CreateVM(_ *VMConfig) error

CreateVM is a no-op stub.

func (*QEMUBackend) DeleteVM 

func (b *QEMUBackend) DeleteVM(_ string) error

DeleteVM is a no-op stub.

func (*QEMUBackend) ForwardPort 

func (b *QEMUBackend) ForwardPort(_, _ int, _ string) error

ForwardPort is a no-op stub.

func (*QEMUBackend) MinVersion 

func (b *QEMUBackend) MinVersion() string

MinVersion returns "N/A" as the backend is unavailable.

func (*QEMUBackend) Name 

func (b *QEMUBackend) Name() string

Name returns "qemu".

func (*QEMUBackend) RemoveForwardPort 

func (b *QEMUBackend) RemoveForwardPort(_ int, _ string) error

RemoveForwardPort is a no-op stub.

func (*QEMUBackend) ShareHostDir 

func (b *QEMUBackend) ShareHostDir(_, _, _ string, _ bool) error

ShareHostDir is a no-op stub.

func (*QEMUBackend) StartVM 

func (b *QEMUBackend) StartVM(_ string) error

StartVM is a no-op stub.

func (*QEMUBackend) Stats 

func (b *QEMUBackend) Stats(_ string) (*VMStats, error)

Stats returns nil stats on unsupported platforms.

func (*QEMUBackend) StopVM 

func (b *QEMUBackend) StopVM(_ string, _ int) error

StopVM is a no-op stub.

func (*QEMUBackend) UnshareHostDir 

func (b *QEMUBackend) UnshareHostDir(_ string) error

UnshareHostDir is a no-op stub.

func (*QEMUBackend) VMStatus 

func (b *QEMUBackend) VMStatus(_ string) (string, error)

VMStatus returns empty state on unsupported platforms.

type SandboxBackend 

type SandboxBackend struct{}

func NewSandboxBackend 

func NewSandboxBackend() *SandboxBackend

func (*SandboxBackend) Available 

func (b *SandboxBackend) Available() bool

func (*SandboxBackend) CreateVM 

func (b *SandboxBackend) CreateVM(_ *VMConfig) error

func (*SandboxBackend) DeleteVM 

func (b *SandboxBackend) DeleteVM(_ string) error

func (*SandboxBackend) ForwardPort 

func (b *SandboxBackend) ForwardPort(_, _ int, _ string) error

func (*SandboxBackend) MinVersion 

func (b *SandboxBackend) MinVersion() string

func (*SandboxBackend) Name 

func (b *SandboxBackend) Name() string

func (*SandboxBackend) RemoveForwardPort 

func (b *SandboxBackend) RemoveForwardPort(_ int, _ string) error

func (*SandboxBackend) ShareHostDir 

func (b *SandboxBackend) ShareHostDir(_, _, _ string, _ bool) error

func (*SandboxBackend) StartVM 

func (b *SandboxBackend) StartVM(_ string) error

func (*SandboxBackend) Stats 

func (b *SandboxBackend) Stats(_ string) (*VMStats, error)

func (*SandboxBackend) StopVM 

func (b *SandboxBackend) StopVM(_ string, _ int) error

func (*SandboxBackend) UnshareHostDir 

func (b *SandboxBackend) UnshareHostDir(_ string) error

func (*SandboxBackend) VMStatus 

func (b *SandboxBackend) VMStatus(_ string) (string, error)

type VMConfig 

type VMConfig struct {
	ID         string
	CPUs       int
	MemoryMB   int64
	DiskSizeGB int64
	DiskPath   string
	KernelPath string
	InitrdPath string
	Shares     []FSShare
	Ports      []PortForward
	Rosetta    bool
	Network    string
	Backend    string
}

type VMStats 

type VMStats struct {
	CPUUsage    float64
	MemoryUsage int64
	MemoryTotal int64
	DiskRead    int64
	DiskWrite   int64
	NetRx       int64
	NetTx       int64
	State       string
}

type VZBackend 

type VZBackend struct{}

VZBackend is a stub for the macOS Virtualization framework backend.

func NewVZBackend 

func NewVZBackend() *VZBackend

NewVZBackend returns nil on non-darwin platforms.

func (*VZBackend) Available 

func (b *VZBackend) Available() bool

Available reports that the backend is not available on this platform.

func (*VZBackend) CreateVM 

func (b *VZBackend) CreateVM(_ *VMConfig) error

CreateVM is a no-op stub.

func (*VZBackend) DeleteVM 

func (b *VZBackend) DeleteVM(_ string) error

DeleteVM is a no-op stub.

func (*VZBackend) ForwardPort 

func (b *VZBackend) ForwardPort(_, _ int, _ string) error

ForwardPort is a no-op stub.

func (*VZBackend) MinVersion 

func (b *VZBackend) MinVersion() string

MinVersion returns "N/A" as the backend is unavailable.

func (*VZBackend) Name 

func (b *VZBackend) Name() string

Name returns "vz".

func (*VZBackend) RemoveForwardPort 

func (b *VZBackend) RemoveForwardPort(_ int, _ string) error

RemoveForwardPort is a no-op stub.

func (*VZBackend) ShareHostDir 

func (b *VZBackend) ShareHostDir(_, _, _ string, _ bool) error

ShareHostDir is a no-op stub.

func (*VZBackend) StartVM 

func (b *VZBackend) StartVM(_ string) error

StartVM is a no-op stub.

func (*VZBackend) Stats 

func (b *VZBackend) Stats(_ string) (*VMStats, error)

Stats returns nil stats on unsupported platforms.

func (*VZBackend) StopVM 

func (b *VZBackend) StopVM(_ string, _ int) error

StopVM is a no-op stub.

func (*VZBackend) UnshareHostDir 

func (b *VZBackend) UnshareHostDir(_ string) error

UnshareHostDir is a no-op stub.

func (*VZBackend) VMStatus 

func (b *VZBackend) VMStatus(_ string) (string, error)

VMStatus returns empty state on unsupported platforms.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.