Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make cpuType a map instead of a single value #656

Merged
merged 1 commit into from
Feb 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions pkg/limayaml/default.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,6 @@ images:
- location: "https://cloud-images.ubuntu.com/impish/current/impish-server-cloudimg-arm64.img"
arch: "aarch64"

# Specify QEMU CPU emulation, e.g., "host", "qemu64", "Haswell".
# You can see what options are available for host emulation with: `qemu-system-$(arch) -cpu help`.
# Setting of instructions is supported like this: "qemu64,+ssse3".
# Default: "host" (native arch), "qemu64" (Intel on ARM), or "cortex-a72" (ARM on Intel)
cpuType: null

# CPUs: if you see performance issues, try limiting cpus to 1.
# Default: 4
cpus: null
Expand Down Expand Up @@ -141,6 +135,15 @@ containerd:
# FURTHER ADVANCED CONFIGURATION
# ===================================================================== #

# Specify desired QEMU CPU type for each arch.
# You can see what options are available for host emulation with: `qemu-system-$(arch) -cpu help`.
# Setting of instructions is supported like this: "qemu64,+ssse3".
cpuType:
# Default: "cortex-a72" (or "host" when running on arm64)
aarch64: null
# Default: "qemu64" (or "host" when running on amd64)
x86_64: null

firmware:
# Use legacy BIOS instead of UEFI.
# Default: false
Expand Down
40 changes: 24 additions & 16 deletions pkg/limayaml/defaults.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,24 +81,32 @@ func FillDefault(y, d, o *LimaYAML, filePath string) {
}
}

if y.CPUType == nil {
y.CPUType = d.CPUType
}
if o.CPUType != nil {
y.CPUType = o.CPUType
}
if y.CPUType == nil || *y.CPUType == "" {
if IsNativeArch(*y.Arch) {
y.CPUType = pointer.String("host")
} else if *y.Arch == X8664 {
// Intel on ARM
// Since https://github.com/lima-vm/lima/pull/494, we use qemu64 cpu for better emulation of x86_64.
y.CPUType = pointer.String("qemu64")
} else {
// ARM on Intel
y.CPUType = pointer.String("cortex-a72")
cpuType := map[Arch]string{
AARCH64: "cortex-a72",
// Since https://github.com/lima-vm/lima/pull/494, we use qemu64 cpu for better emulation of x86_64.
X8664: "qemu64",
}
for arch := range cpuType {
if IsNativeArch(arch) {
cpuType[arch] = "host"
}
}
for k, v := range d.CPUType {
if len(v) > 0 {
cpuType[k] = v
}
}
for k, v := range y.CPUType {
if len(v) > 0 {
cpuType[k] = v
}
}
for k, v := range o.CPUType {
if len(v) > 0 {
cpuType[k] = v
}
}
y.CPUType = cpuType

if y.CPUs == nil {
y.CPUs = d.CPUs
Expand Down
40 changes: 25 additions & 15 deletions pkg/limayaml/defaults_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,14 @@ func TestFillDefault(t *testing.T) {

// Builtin default values
builtin := LimaYAML{
Arch: pointer.String(arch),
CPUType: pointer.String("host"),
CPUs: pointer.Int(4),
Memory: pointer.String("4GiB"),
Disk: pointer.String("100GiB"),
Arch: pointer.String(arch),
CPUType: map[Arch]string{
AARCH64: "cortex-a72",
X8664: "qemu64",
},
CPUs: pointer.Int(4),
Memory: pointer.String("4GiB"),
Disk: pointer.String("100GiB"),
Containerd: Containerd{
System: pointer.Bool(false),
User: pointer.Bool(true),
Expand All @@ -74,6 +77,7 @@ func TestFillDefault(t *testing.T) {
},
PropagateProxyEnv: pointer.Bool(true),
}
builtin.CPUType[arch] = "host"

defaultPortForward := PortForward{
GuestIP: api.IPv4loopback1,
Expand Down Expand Up @@ -169,11 +173,14 @@ func TestFillDefault(t *testing.T) {

// Choose values that are different from the "builtin" defaults
d = LimaYAML{
Arch: pointer.String("unknown"),
CPUType: pointer.String("host"),
CPUs: pointer.Int(7),
Memory: pointer.String("5GiB"),
Disk: pointer.String("105GiB"),
Arch: pointer.String("unknown"),
CPUType: map[Arch]string{
AARCH64: "arm64",
X8664: "amd64",
},
CPUs: pointer.Int(7),
Memory: pointer.String("5GiB"),
Disk: pointer.String("105GiB"),
Containerd: Containerd{
System: pointer.Bool(true),
User: pointer.Bool(false),
Expand Down Expand Up @@ -282,11 +289,14 @@ func TestFillDefault(t *testing.T) {
// User-provided overrides should override user-provided config settings

o = LimaYAML{
Arch: pointer.String(arch),
CPUType: pointer.String("host"),
CPUs: pointer.Int(12),
Memory: pointer.String("7GiB"),
Disk: pointer.String("117GiB"),
Arch: pointer.String(arch),
CPUType: map[Arch]string{
AARCH64: "uber-arm",
jandubois marked this conversation as resolved.
Show resolved Hide resolved
X8664: "pentium",
},
CPUs: pointer.Int(12),
Memory: pointer.String("7GiB"),
Disk: pointer.String("117GiB"),
Containerd: Containerd{
System: pointer.Bool(true),
User: pointer.Bool(false),
Expand Down
2 changes: 1 addition & 1 deletion pkg/limayaml/limayaml.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
type LimaYAML struct {
Arch *Arch `yaml:"arch,omitempty" json:"arch,omitempty"`
Images []File `yaml:"images" json:"images"` // REQUIRED
CPUType *string `yaml:"cpuType,omitempty" json:"cpuType,omitempty"`
CPUType map[Arch]string `yaml:"cpuType,omitempty" json:"cpuType,omitempty"`
CPUs *int `yaml:"cpus,omitempty" json:"cpus,omitempty"`
Memory *string `yaml:"memory,omitempty" json:"memory,omitempty"` // go-units.RAMInBytes
Disk *string `yaml:"disk,omitempty" json:"disk,omitempty"` // go-units.RAMInBytes
Expand Down
9 changes: 7 additions & 2 deletions pkg/limayaml/validate.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,13 @@ func Validate(y LimaYAML, warn bool) error {
}
}

if *y.CPUType == "" {
return fmt.Errorf("field `cpuType` must be set")
for arch := range y.CPUType {
switch arch {
case AARCH64, X8664:
// these are the only supported architectures
default:
return fmt.Errorf("field `cpuType` uses unsupported arch %q", arch)
}
}

if *y.CPUs == 0 {
Expand Down
2 changes: 1 addition & 1 deletion pkg/qemu/qemu.go
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ func Cmdline(cfg Config) (string, []string, error) {
return "", nil, errors.New(errStr)
}

cpu := *y.CPUType
cpu := y.CPUType[*y.Arch]
args = appendArgsIfNoConflict(args, "-cpu", cpu)
switch *y.Arch {
case limayaml.X8664:
Expand Down
3 changes: 2 additions & 1 deletion pkg/store/instance.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ func Inspect(instName string) (*Instance, error) {
}
inst.Dir = instDir
inst.Arch = *y.Arch
inst.CPUType = *y.CPUType
inst.CPUType = y.CPUType[*y.Arch]

inst.CPUs = *y.CPUs
memory, err := units.RAMInBytes(*y.Memory)
if err == nil {
Expand Down