build: Allow stratovirt to be built in an openeuler container

Add a `tools` directory at root, and initialize it with a stratovirt
docker-build script and Dockerfile, which allows users to build
stratovirt in isolated environment.

It also can be used for automated build.

Signed-off-by: Liu Wenyuan <[email protected]>

Author: WenyuanLau

docs/build_guide.ch.md

@@ -63,3 +63,31 @@ $ cargo build --release --target ${arch}-unknown-linux-musl
 ```shell
 $ cargo build --release --features "scream_alsa"
 ```
+
+# 通过容器构建StratoVirt静态链接二进制
+
+## 1. 检查docker环境
+
+为了通过容器构建StratoVirt，需保证已经安装了docker软件。可通过下面的命令检查：
+
+```shell
+$ docker -v
+Docker version 18.09.0
+```
+
+如果你想部署docker环境，下面的链接可以帮助你：
+
+<https://docs.docker.com/get-docker/>
+
+## 2. 使用tools下提供的构建工具
+
+运行tools/build_stratovirt_static下的脚本，自动拉起docker容器构建静态链接的StratoVirt。
+
+```shell
+$ cd tools/build_stratovirt_static
+# 自定义一个镜像名称，构建StratoVirt静态链接二进制
+$ sh build_stratovirt_from_docker.sh custom_image_name
+```
+
+构建完成后，可找到StratoVirt构建静态链接二进制的路径在 `target/${arch}-unknown-linux-musl/release/stratovirt`.
+

docs/build_guide.md

@@ -64,3 +64,31 @@ List of optional features:
 ```shell
 $ cargo build --release --features "scream_alsa"
 ```
+
+# Build static StratoVirt in containers
+
+## 1. Check docker environment
+
+In order to build StratoVirt in containers, ensure that the docker software is installed. This can be checked with the following command:
+
+```shell
+$ docker -v
+Docker version 18.09.0
+```
+
+If you want to deploy a docker environment, the following link can help you:
+
+<https://docs.docker.com/get-docker/>
+
+## 2. Run the build script
+
+Run the script under tools/build_stratovirt_static directory to automatically run a docker container to build a statically linked StratoVirt.
+
+```shell
+$ cd tools/build_stratovirt_static
+# Build StratoVirt with your custom_image_name
+$ sh build_stratovirt_from_docker.sh custom_image_name
+```
+
+After the build is complete, you can find the statically linked binary StratoVirt in the path: `target/${arch}-unknown-linux-musl/release/stratovirt`.
+

tools/build_stratovirt_static/Dockerfile

@@ -0,0 +1,23 @@
+# Copyright (c) 2023 Huawei Technologies Co.,Ltd. All rights reserved.
+#
+# StratoVirt is licensed under Mulan PSL v2.
+# You can use this software according to the terms and conditions of the Mulan
+# PSL v2.
+# You may obtain a copy of Mulan PSL v2 at:
+#         http://license.coscl.org.cn/MulanPSL2
+# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY
+# KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+# NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+# See the Mulan PSL v2 for more details.
+
+from openeuler/openeuler:22.03-lts-sp2
+
+ARG ARCH
+
+RUN yum update -y && \
+    yum upgrade -y && \
+    yum install -y cargo musl-gcc cyrus-sasl-devel && \
+    yum install -y libcap-devel libcap-ng-devel libseccomp-devel && \
+    if [ "${ARCH}" == aarch64 ]; then yum install -y dtc-devel; fi && \
+    yum clean all
+

tools/build_stratovirt_static/build-stratovirt-from-docker.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+#
+# Copyright (c) 2023 Huawei Technologies Co.,Ltd. All rights reserved.
+#
+# StratoVirt is licensed under Mulan PSL v2.
+# You can use this software according to the terms and conditions of the Mulan
+# PSL v2.
+# You may obtain a copy of Mulan PSL v2 at:
+#         http://license.coscl.org.cn/MulanPSL2
+# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY
+# KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+# NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+# See the Mulan PSL v2 for more details.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+build_stratovirt() {
+	sudo "${container_engine}" run \
+		--rm -i \
+		--env ARCH="${ARCH}" \
+		-v "${repo_root_dir}:/root/stratovirt" \
+		"${container_image}" \
+		bash -c "cd /root/stratovirt && ${CARGO} build --workspace --bin stratovirt --release --target=${RUST_TARGET}"
+}
+
+script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+repo_root_dir="$(cd ${script_dir}/../.. && pwd)"
+
+ARCH=${ARCH:-$(uname -m)}
+CARGO="/usr/bin/env CARGO_HOME=.cargo RUSTC_BOOTSTRAP=1 /usr/bin/cargo"
+container_engine="${container_engine:-docker}"
+container_image="${container_image:-$1}"
+
+if [ "${ARCH}" == "x86_64" ]; then RUST_TARGET="x86_64-unknown-linux-musl"; fi
+if [ "${ARCH}" == "aarch64" ]; then RUST_TARGET="aarch64-unknown-linux-musl"; fi
+
+echo "Building StratoVirt with ${RUST_TARGET}"
+
+sudo "${container_engine}" build \
+	--build-arg ARCH="${ARCH}" \
+	"${repo_root_dir}" \
+	-f "${script_dir}/Dockerfile" \
+	-t "${container_image}" && \
+
+build_stratovirt
+