Merge pull request #4380 from Tim-0731-Hzt/rund/makefile

runtime-rs: makefile for dragonball

src/runtime-rs/.gitignore

@@ -1,2 +1,3 @@
 target
 crates/shim/src/config.rs
+/config/*.toml

src/runtime-rs/Makefile

@@ -8,14 +8,252 @@
 # Use the following format:
 # '##VAR VARIABLE_NAME: help about variable'
 # '##TARGET TARGET_NAME: help about target'
-
+PROJECT_TYPE = kata
 PROJECT_NAME = Kata Containers
+PROJECT_TAG = kata-containers
 PROJECT_URL = https://github.com/kata-containers
 PROJECT_COMPONENT = containerd-shim-kata-v2
 CONTAINERD_RUNTIME_NAME = io.containerd.kata.v2
 
+include ../../utils.mk
+
+ARCH_DIR = arch
+ARCH_FILE_SUFFIX = -options.mk
+ARCH_FILE = $(ARCH_DIR)/$(ARCH)$(ARCH_FILE_SUFFIX)
+
+ifeq (,$(realpath $(ARCH_FILE)))
+    $(error "ERROR: invalid architecture: '$(ARCH)'")
+else
+    # Load architecture-dependent settings
+    include $(ARCH_FILE)
+endif
+
+ifeq ($(PREFIX),)
+    PREFIX := /usr
+endif
+
+PREFIXDEPS    := $(PREFIX)
+DBBINDIR    := $(PREFIXDEPS)/bin
+LIBEXECDIR := $(PREFIXDEPS)/libexec
+SHAREDIR := $(PREFIX)/share
+DEFAULTSDIR := $(SHAREDIR)/defaults
+PROJECT_DIR = $(PROJECT_TAG)
+IMAGENAME = $(PROJECT_TAG).img
 TARGET = $(PROJECT_COMPONENT)
 
+CONFIG_FILE = configuration.toml
+HYPERVISOR_DB = dragonball
+
+
+DEFAULT_HYPERVISOR ?= $(HYPERVISOR_DB)
+
+HYPERVISORS := $(HYPERVISOR_DB)
+
+DBPATH := $(DBBINDIR)/$(QEMUCMD)
+DBVALIDHYPERVISORPATHS := [\"$(DBPATH)\"]
+
+PKGDATADIR := $(PREFIXDEPS)/share/$(PROJECT_DIR)
+KERNELDIR := $(PKGDATADIR)
+IMAGEPATH := $(PKGDATADIR)/$(IMAGENAME)
+FIRMWAREPATH :=
+FIRMWAREVOLUMEPATH :=
+
+# Default number of vCPUs
+DEFVCPUS := 1
+# Default maximum number of vCPUs
+DEFMAXVCPUS := 0
+# Default memory size in MiB
+DEFMEMSZ := 2048
+# Default memory slots
+# Cases to consider :
+# - nvdimm rootfs image
+# - preallocated memory
+# - vm template memory
+# - hugepage memory
+DEFMEMSLOTS := 10
+#Default number of bridges
+DEFBRIDGES := 1
+DEFENABLEANNOTATIONS := []
+DEFDISABLEGUESTSECCOMP := true
+DEFDISABLEGUESTEMPTYDIR := false
+#Default experimental features enabled
+DEFAULTEXPFEATURES := []
+DEFDISABLESELINUX := false
+#Default entropy source
+DEFENTROPYSOURCE := /dev/urandom
+DEFVALIDENTROPYSOURCES := [\"/dev/urandom\",\"/dev/random\",\"\"]
+DEFDISABLEBLOCK := false
+DEFSHAREDFS_CLH_VIRTIOFS := virtio-fs
+DEFSHAREDFS_QEMU_VIRTIOFS := virtio-fs
+DEFVIRTIOFSDAEMON := $(LIBEXECDIR)/kata-qemu/virtiofsd
+ifeq ($(ARCH),x86_64)
+DEFVIRTIOFSDAEMON := $(LIBEXECDIR)/virtiofsd
+endif
+DEFVALIDVIRTIOFSDAEMONPATHS := [\"$(DEFVIRTIOFSDAEMON)\"]
+# Default DAX mapping cache size in MiB
+#if value is 0, DAX is not enabled
+DEFVIRTIOFSCACHESIZE ?= 0
+DEFVIRTIOFSCACHE ?= auto
+# Format example:
+#   [\"-o\", \"arg1=xxx,arg2\", \"-o\", \"hello world\", \"--arg3=yyy\"]
+#
+# see `virtiofsd -h` for possible options.
+# Make sure you quote args.
+DEFVIRTIOFSEXTRAARGS ?= [\"--thread-pool-size=1\", \"-o\", \"announce_submounts\"]
+DEFENABLEIOTHREADS := false
+DEFENABLEVHOSTUSERSTORE := false
+DEFVHOSTUSERSTOREPATH := $(PKGRUNDIR)/vhost-user
+DEFVALIDVHOSTUSERSTOREPATHS := [\"$(DEFVHOSTUSERSTOREPATH)\"]
+DEFFILEMEMBACKEND := ""
+DEFVALIDFILEMEMBACKENDS := [\"$(DEFFILEMEMBACKEND)\"]
+DEFMSIZE9P := 8192
+DEFVFIOMODE := guest-kernel
+# Default cgroup model
+DEFSANDBOXCGROUPONLY ?= false
+DEFSTATICRESOURCEMGMT ?= false
+DEFBINDMOUNTS := []
+SED = sed
+CLI_DIR = cmd
+SHIMV2 = containerd-shim-kata-v2
+SHIMV2_OUTPUT = $(CURDIR)/$(SHIMV2)
+SHIMV2_DIR = $(CLI_DIR)/$(SHIMV2)
+MONITOR = kata-monitor
+MONITOR_OUTPUT = $(CURDIR)/$(MONITOR)
+MONITOR_DIR = $(CLI_DIR)/kata-monitor
+SOURCES := $(shell find . 2>&1 | grep -E '.*\.(c|h|go)$$')
+VERSION := ${shell cat ./VERSION}
+# List of configuration files to build and install
+CONFIGS =
+CONFIG_PATHS =
+SYSCONFIG_PATHS =
+# List of hypervisors known for the current architecture
+KNOWN_HYPERVISORS =
+# List of hypervisors known for the current architecture
+KNOWN_HYPERVISORS =
+
+CONFDIR := $(DEFAULTSDIR)/$(PROJECT_DIR)
+SYSCONFDIR := $(SYSCONFDIR)/$(PROJECT_DIR)
+# Main configuration file location for stateless systems
+CONFIG_PATH := $(abspath $(CONFDIR)/$(CONFIG_FILE))
+# Secondary configuration file location. Note that this takes precedence
+# over CONFIG_PATH.
+SYSCONFIG := $(abspath $(SYSCONFDIR)/$(CONFIG_FILE))
+SHAREDIR := $(SHAREDIR)
+
+ifneq (,$(DBCMD))
+    KNOWN_HYPERVISORS += $(HYPERVISOR_DB)
+    CONFIG_FILE_DB = configuration-dragonball.toml
+    CONFIG_DB = config/$(CONFIG_FILE_DB)
+    CONFIG_DB_IN = $(CONFIG_DB).in
+    CONFIG_PATH_DB = $(abspath $(CONFDIR)/$(CONFIG_FILE_DB))
+    CONFIG_PATHS += $(CONFIG_PATH_DB)
+    SYSCONFIG_DB = $(abspath $(SYSCONFDIR)/$(CONFIG_FILE_DB))
+    SYSCONFIG_PATHS += $(SYSCONFIG_DB)
+    CONFIGS += $(CONFIG_DB)
+    # dragonball-specific options (all should be suffixed by "_dragonball")
+    DEFMAXVCPUS_DB := 1
+    DEFBLOCKSTORAGEDRIVER_DB := virtio-blk
+    DEFNETWORKMODEL_DB := tcfilter
+    KERNELPARAMS = console=ttyS1 agent.log_vport=1025
+	KERNELTYPE_DB = uncompressed
+    KERNEL_NAME_DB = $(call MAKE_KERNEL_NAME,$(KERNELTYPE_DB))
+    KERNELPATH_DB = $(KERNELDIR)/$(KERNEL_NAME_DB)
+    DEFSANDBOXCGROUPONLY = true
+    RUNTIMENAME := virt_container
+    PIPESIZE := 1
+	DBSHAREDFS := inline-virtio-fs
+endif
+
+ifeq ($(DEFAULT_HYPERVISOR),$(HYPERVISOR_DB))
+    DEFAULT_HYPERVISOR_CONFIG = $(CONFIG_FILE_DB)
+endif
+# list of variables the user may wish to override
+USER_VARS += ARCH
+USER_VARS += BINDIR
+USER_VARS += CONFIG_DB_IN
+USER_VARS += CONFIG_PATH
+USER_VARS += DESTDIR
+USER_VARS += DEFAULT_HYPERVISOR
+USER_VARS += DBCMD
+USER_VARS += DBCTLCMD
+USER_VARS += DBPATH
+USER_VARS += DBVALIDHYPERVISORPATHS
+USER_VARS += DBCTLPATH
+USER_VARS += DBVALIDCTLPATHS
+USER_VARS += SYSCONFIG
+USER_VARS += IMAGENAME
+USER_VARS += IMAGEPATH
+USER_VARS += MACHINETYPE
+USER_VARS += KERNELDIR
+USER_VARS += KERNELTYPE
+USER_VARS += KERNELPATH_DB
+USER_VARS += KERNELPATH
+USER_VARS += KERNELVIRTIOFSPATH
+USER_VARS += FIRMWAREPATH
+USER_VARS += FIRMWAREVOLUMEPATH
+USER_VARS += MACHINEACCELERATORS
+USER_VARS += CPUFEATURES
+USER_VARS += DEFMACHINETYPE_CLH
+USER_VARS += KERNELPARAMS
+USER_VARS += LIBEXECDIR
+USER_VARS += LOCALSTATEDIR
+USER_VARS += PKGDATADIR
+USER_VARS += PKGLIBEXECDIR
+USER_VARS += PKGRUNDIR
+USER_VARS += PREFIX
+USER_VARS += PROJECT_BUG_URL
+USER_VARS += PROJECT_NAME
+USER_VARS += PROJECT_ORG
+USER_VARS += PROJECT_PREFIX
+USER_VARS += PROJECT_TAG
+USER_VARS += PROJECT_TYPE
+USER_VARS += RUNTIME_NAME
+USER_VARS += SHAREDIR
+USER_VARS += SYSCONFDIR
+USER_VARS += DEFVCPUS
+USER_VARS += DEFMAXVCPUS
+USER_VARS += DEFMAXVCPUS_ACRN
+USER_VARS += DEFMAXVCPUS_DB
+USER_VARS += DEFMEMSZ
+USER_VARS += DEFMEMSLOTS
+USER_VARS += DEFBRIDGES
+USER_VARS += DEFNETWORKMODEL_DB
+USER_VARS += DEFDISABLEGUESTEMPTYDIR
+USER_VARS += DEFDISABLEGUESTSECCOMP
+USER_VARS += DEFDISABLESELINUX
+USER_VARS += DEFAULTEXPFEATURES
+USER_VARS += DEFDISABLEBLOCK
+USER_VARS += DEFBLOCKSTORAGEDRIVER_DB
+USER_VARS += DEFSHAREDFS_CLH_VIRTIOFS
+USER_VARS += DEFSHAREDFS_QEMU_VIRTIOFS
+USER_VARS += DEFVIRTIOFSDAEMON
+USER_VARS += DEFVALIDVIRTIOFSDAEMONPATHS
+USER_VARS += DEFVIRTIOFSCACHESIZE
+USER_VARS += DEFVIRTIOFSCACHE
+USER_VARS += DEFVIRTIOFSEXTRAARGS
+USER_VARS += DEFENABLEANNOTATIONS
+USER_VARS += DEFENABLEIOTHREADS
+USER_VARS += DEFENABLEVHOSTUSERSTORE
+USER_VARS += DEFVHOSTUSERSTOREPATH
+USER_VARS += DEFVALIDVHOSTUSERSTOREPATHS
+USER_VARS += DEFFILEMEMBACKEND
+USER_VARS += DEFVALIDFILEMEMBACKENDS
+USER_VARS += DEFMSIZE9P
+USER_VARS += DEFENTROPYSOURCE
+USER_VARS += DEFVALIDENTROPYSOURCES
+USER_VARS += DEFSANDBOXCGROUPONLY
+USER_VARS += DEFSTATICRESOURCEMGMT
+USER_VARS += DEFBINDMOUNTS
+USER_VARS += DEFVFIOMODE
+USER_VARS += BUILDFLAGS
+USER_VARS += RUNTIMENAME
+USER_VARS += HYPERVISOR_DB
+USER_VARS += PIPESIZE
+USER_VARS += DBSHAREDFS
+USER_VARS += KATA_INSTALL_GROUP
+USER_VARS += KATA_INSTALL_OWNER
+USER_VARS += KATA_INSTALL_CFG_PERMS
+
 SOURCES := \
   $(shell find . 2>&1 | grep -E '.*\.rs$$') \
   Cargo.toml
@@ -35,7 +273,6 @@ ifneq ($(EXTRA_RUSTFEATURES),)
     override EXTRA_RUSTFEATURES := --features $(EXTRA_RUSTFEATURES)
 endif
 
-include ../../utils.mk
 
 TARGET_PATH = target/$(TRIPLE)/$(BUILD_TYPE)/$(TARGET)
 
@@ -49,6 +286,12 @@ GENERATED_CODE = crates/shim/src/config.rs
 RUNTIME_NAME=$(TARGET)
 RUNTIME_VERSION=$(VERSION)
 
+GENERATED_VARS = \
+		VERSION \
+		CONFIG_DB_IN \
+		$(USER_VARS)
+
+
 GENERATED_REPLACEMENTS= \
     PROJECT_NAME \
     RUNTIME_NAME \
@@ -78,6 +321,12 @@ define INSTALL_FILE
 	install -D -m 644 $1 $(DESTDIR)$2/$1 || exit 1;
 endef
 
+# Returns the name of the kernel file to use based on the provided KERNELTYPE.
+# $1 : KERNELTYPE (compressed or uncompressed)
+define MAKE_KERNEL_NAME
+$(if $(findstring uncompressed,$1),vmlinux.container,vmlinuz.container)
+endef
+
 .DEFAULT_GOAL := default
 
 ##TARGET default: build code
@@ -88,8 +337,13 @@ $(TARGET): $(GENERATED_CODE) $(TARGET_PATH)
 $(TARGET_PATH): $(SOURCES) | show-summary
 	@RUSTFLAGS="$(EXTRA_RUSTFLAGS) --deny warnings" cargo build --target $(TRIPLE) --$(BUILD_TYPE) $(EXTRA_RUSTFEATURES)
 
+GENERATED_FILES += $(CONFIGS)
+
 $(GENERATED_FILES): %: %.in
-	@sed $(foreach r,$(GENERATED_REPLACEMENTS),-e 's|@$r@|$($r)|g') "$<" > "$@"
+	@sed \
+        $(foreach r,$(GENERATED_REPLACEMENTS),-e 's|@$r@|$($r)|g') \
+        $(foreach v,$(GENERATED_VARS),-e "s|@$v@|$($v)|g") \
+        $< > $@
 
 ##TARGET optimize: optimized  build
 optimize: $(SOURCES) | show-summary show-header
@@ -100,6 +354,7 @@ clean:
 	@cargo clean
 	@rm -f $(GENERATED_FILES)
 	@rm -f tarpaulin-report.html
+	@rm -f $(CONFIGS)
 
 vendor:
 	@cargo vendor
@@ -163,6 +418,10 @@ codecov: check_tarpaulin
 codecov-html: check_tarpaulin
 	cargo tarpaulin $(TARPAULIN_ARGS) -o Html
 
+install-configs: $(CONFIGS)
+	$(foreach f,$(CONFIGS),$(call INSTALL_CONFIG,$f,$(dir $(CONFIG_PATH)))) \
+    sudo ln -sf $(DEFAULT_HYPERVISOR_CONFIG) $(DESTDIR)/$(CONFIG_PATH)
+
 .PHONY: \
 	help \
 	optimize \

src/runtime-rs/arch/x86_64-options.mk

@@ -0,0 +1,15 @@
+# Copyright (c) 2019-2022 Alibaba Cloud
+# Copyright (c) 2019-2022 Ant Group
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+MACHINETYPE := q35
+KERNELPARAMS :=
+MACHINEACCELERATORS :=
+CPUFEATURES := pmu=off
+
+QEMUCMD := qemu-system-x86_64
+
+# dragonball binary name
+DBCMD := dragonball