Merge pull request firecracker-microvm#531 from kzys/arm

Make integration tests work in aarch64

Author: kzys

Makefile

@@ -32,8 +32,18 @@ FIRECRACKER_CONTAINERD_BUILDER_IMAGE?=golang:1.13-buster
 export FIRECRACKER_CONTAINERD_TEST_IMAGE?=localhost/firecracker-containerd-test
 export GO_CACHE_VOLUME_NAME?=gocache
 
+# This Makefile uses Firecracker's pre-build Linux kernels for x86_64 and aarch64.
+host_arch=$(shell arch)
+ifeq ($(host_arch),x86_64)
+	kernel_sha256sum="bc7e2dbf12cf7038937abf42056f6bcd405d3eef4d27aaa3016f0ba15069ae4b"
+else ifeq ($(host_arch),aarch64)
+	kernel_sha256sum="e2d7c3d6cc123de9e6052d1f434ca7b47635a1f630d63f7fcc1b7164958375e4"
+else
+$(error "$(host_arch) is not supported by Firecracker")
+endif
+FIRECRACKER_TARGET?=$(host_arch)-unknown-linux-musl
+
 FIRECRACKER_DIR=$(SUBMODULES)/firecracker
-FIRECRACKER_TARGET?=x86_64-unknown-linux-musl
 FIRECRACKER_BIN=$(FIRECRACKER_DIR)/build/cargo_target/$(FIRECRACKER_TARGET)/release/firecracker
 FIRECRACKER_BUILDER_NAME?=firecracker-builder
 CARGO_CACHE_VOLUME_NAME?=cargocache
@@ -171,8 +181,8 @@ $(FIRECRACKER_CONTAINERD_RUNTIME_DIR) $(ETC_CONTAINERD):
 DEFAULT_VMLINUX_NAME?=default-vmlinux.bin
 $(DEFAULT_VMLINUX_NAME):
 	curl --silent --show-error --retry 3 --max-time 30 --output $@ \
-		"https://s3.amazonaws.com/spec.ccfc.min/img/quickstart_guide/x86_64/kernels/vmlinux.bin"
-	echo "bc7e2dbf12cf7038937abf42056f6bcd405d3eef4d27aaa3016f0ba15069ae4b $@" | sha256sum -c -
+		"https://s3.amazonaws.com/spec.ccfc.min/img/quickstart_guide/$(host_arch)/kernels/vmlinux.bin"
+	echo "$(kernel_sha256sum) $@" | sha256sum -c -
 	chmod 0400 $@
 
 DEFAULT_VMLINUX_INSTALLPATH=$(FIRECRACKER_CONTAINERD_RUNTIME_DIR)/$(DEFAULT_VMLINUX_NAME)

config/config.go

@@ -20,6 +20,7 @@ import (
 
 	"github.com/pkg/errors"
 
+	"github.com/firecracker-microvm/firecracker-containerd/internal"
 	"github.com/firecracker-microvm/firecracker-containerd/internal/debug"
 	"github.com/firecracker-microvm/firecracker-containerd/proto"
 	models "github.com/firecracker-microvm/firecracker-go-sdk/client/models"
@@ -87,13 +88,20 @@ func LoadConfig(path string) (*Config, error) {
 		KernelArgs:      defaultKernelArgs,
 		KernelImagePath: defaultKernelPath,
 		RootDrive:       defaultRootfsPath,
-		CPUTemplate:     string(defaultCPUTemplate),
 		ShimBaseDir:     defaultShimBaseDir,
 		JailerConfig: JailerConfig{
 			RuncConfigPath: runcConfigPath,
 		},
 	}
 
+	flag, err := internal.SupportCPUTemplate()
+	if err != nil {
+		return nil, err
+	}
+	if flag {
+		cfg.CPUTemplate = string(defaultCPUTemplate)
+	}
+
 	if err := json.Unmarshal(data, cfg); err != nil {
 		return nil, errors.Wrapf(err, "failed to unmarshal config from %q", path)
 	}

internal/cpu_template.go

@@ -0,0 +1,71 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//	http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file is distributed
+// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+// express or implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+package internal
+
+import (
+	"bufio"
+	"io"
+	"os"
+	"regexp"
+	"runtime"
+	"sync"
+)
+
+var (
+	isIntel     bool
+	isIntelOnce sync.Once
+)
+
+// SupportCPUTemplate returns true if Firecracker supports CPU templates on
+// the current architecture.
+func SupportCPUTemplate() (bool, error) {
+	if runtime.GOARCH != "amd64" {
+		return false, nil
+	}
+
+	var err error
+	isIntelOnce.Do(func() {
+		isIntel, err = checkIsIntel()
+	})
+	return isIntel, err
+}
+
+var vendorID = regexp.MustCompile(`^vendor_id\s*:\s*(.+)$`)
+
+func checkIsIntel() (bool, error) {
+	f, err := os.Open("/proc/cpuinfo")
+	if err != nil {
+		return false, err
+	}
+	defer f.Close()
+
+	id, err := findFirstVendorID(f)
+	if err != nil {
+		return false, err
+	}
+
+	return id == "GenuineIntel", nil
+}
+
+func findFirstVendorID(r io.Reader) (string, error) {
+	s := bufio.NewScanner(r)
+	for s.Scan() {
+		line := s.Text()
+		matches := vendorID.FindStringSubmatch(line)
+		if len(matches) == 2 {
+			return matches[1], nil
+		}
+	}
+	return "", nil
+}

internal/cpu_template_test.go

@@ -0,0 +1,41 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//	http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file is distributed
+// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+// express or implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+package internal
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestFindFirstVendorID(t *testing.T) {
+	cases := []struct {
+		input    string
+		vendorID string
+	}{
+		{"vendor_id : GenuineIntel", "GenuineIntel"},
+		{"vendor_id : AuthenticAMD", "AuthenticAMD"},
+
+		// aarch64 doesn't have vendor IDs.
+		{"", ""},
+	}
+	for _, c := range cases {
+		r := strings.NewReader(c.input)
+		id, err := findFirstVendorID(r)
+		require.NoError(t, err)
+		assert.Equal(t, c.vendorID, id)
+	}
+}

runtime/integ_test.go

@@ -38,7 +38,6 @@ var defaultRuntimeConfig = config.Config{
 	KernelImagePath:       "/var/lib/firecracker-containerd/runtime/default-vmlinux.bin",
 	KernelArgs:            "ro console=ttyS0 noapic reboot=k panic=1 pci=off nomodules systemd.journald.forward_to_console systemd.log_color=false systemd.unit=firecracker.target init=/sbin/overlay-init",
 	RootDrive:             "/var/lib/firecracker-containerd/runtime/default-rootfs.img",
-	CPUTemplate:           "T2",
 	LogLevels:             []string{"debug"},
 	ShimBaseDir:           shimBaseDir(),
 	JailerConfig: config.JailerConfig{
@@ -47,6 +46,17 @@ var defaultRuntimeConfig = config.Config{
 	},
 }
 
+func init() {
+	flag, err := internal.SupportCPUTemplate()
+	if err != nil {
+		panic(err)
+	}
+
+	if flag {
+		defaultRuntimeConfig.CPUTemplate = "T2"
+	}
+}
+
 func shimBaseDir() string {
 	if v := os.Getenv(shimBaseDirEnvVar); v != "" {
 		return v

runtime/service.go

@@ -967,6 +967,14 @@ func (s *service) buildVMConfiguration(req *proto.CreateVMRequest) (*firecracker
 		VMID:       s.vmID,
 	}
 
+	flag, err := internal.SupportCPUTemplate()
+	if err != nil {
+		return nil, err
+	}
+	if !flag {
+		cfg.MachineCfg.CPUTemplate = ""
+	}
+
 	logPath := s.shimDir.FirecrackerLogFifoPath()
 	if req.LogFifoPath != "" {
 		logPath = req.LogFifoPath