Merge pull request #4593 from fidencio/2.4.3-branch-bump

# Kata Containers 2.4.3

.github/workflows/add-pr-sizing-label.yaml

@@ -1,40 +0,0 @@
-# Copyright (c) 2022 Intel Corporation
-#
-# SPDX-License-Identifier: Apache-2.0
-#
-
-name: Add PR sizing label
-
-on:
-  pull_request_target:
-    types:
-      - opened
-      - reopened
-      - synchronize
-
-jobs:
-  add-pr-size-label:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v1
-
-      - name: Install PR sizing label script
-        run: |
-          # Clone into a temporary directory to avoid overwriting
-          # any existing github directory.
-          pushd $(mktemp -d) &>/dev/null
-          git clone --single-branch --depth 1 "https://github.com/kata-containers/.github" && cd .github/scripts
-          sudo install pr-add-size-label.sh /usr/local/bin
-          popd &>/dev/null
-
-      - name: Add PR sizing label
-        env:
-          GITHUB_TOKEN: ${{ secrets.KATA_GITHUB_ACTIONS_PR_SIZE_TOKEN }}
-        run: |
-          pr=${{ github.event.number }}
-          # Removing man-db, workflow kept failing, fixes: #4480
-          sudo apt -y remove --purge man-db
-          sudo apt -y install diffstat patchutils
-
-          pr-add-size-label.sh -p "$pr"

.github/workflows/commit-message-check.yaml

@@ -10,7 +10,7 @@ env:
   error_msg: |+
     See the document below for help on formatting commits for the project.
 
-    https://github.com/kata-containers/community/blob/main/CONTRIBUTING.md#patch-format
+    https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md#patch-format
 
 jobs:
   commit-message-check:
@@ -63,8 +63,7 @@ jobs:
         #   the entire commit message.
         #
         # - Body lines *can* be longer than the maximum if they start
-        #   with a non-alphabetic character or if there is no whitespace in
-        #   the line.
+        #   with a non-alphabetic character.
         #
         #   This allows stack traces, log files snippets, emails, long URLs,
         #   etc to be specified. Some of these naturally "work" as they start
@@ -75,8 +74,8 @@ jobs:
         #
         # - A SoB comment can be any length (as it is unreasonable to penalise
         #   people with long names/email addresses :)
-        pattern: '^.+(\n([a-zA-Z].{0,150}|[^a-zA-Z\n].*|[^\s\n]*|Signed-off-by:.*|))+$'
-        error: 'Body line too long (max 150)'
+        pattern: '^.+(\n([a-zA-Z].{0,149}|[^a-zA-Z\n].*|Signed-off-by:.*|))+$'
+        error: 'Body line too long (max 72)'
         post_error: ${{ env.error_msg }}
 
     - name: Check Fixes

.github/workflows/docs-url-alive-check.yaml

@@ -1,41 +0,0 @@
-on:
-  schedule:
-    - cron:  '0 23 * * 0'
-
-name: Docs URL Alive Check
-jobs:
-  test:
-    strategy:
-      matrix:
-        go-version: [1.17.x]
-        os: [ubuntu-20.04]
-    runs-on: ${{ matrix.os }}
-    # don't run this action on forks
-    if: github.repository_owner == 'kata-containers'
-    env:
-      target_branch: ${{ github.base_ref }}
-    steps:
-    - name: Install Go
-      uses: actions/setup-go@v2
-      with:
-        go-version: ${{ matrix.go-version }}
-      env:
-        GOPATH: ${{ runner.workspace }}/kata-containers
-    - name: Set env
-      run: |
-        echo "GOPATH=${{ github.workspace }}" >> $GITHUB_ENV
-        echo "${{ github.workspace }}/bin" >> $GITHUB_PATH
-    - name: Checkout code
-      uses: actions/checkout@v2
-      with:
-        fetch-depth: 0
-        path: ./src/github.com/${{ github.repository }}
-    - name: Setup
-      run: |
-        cd ${GOPATH}/src/github.com/${{ github.repository }} && ./ci/setup.sh
-      env:
-        GOPATH: ${{ runner.workspace }}/kata-containers
-    # docs url alive check
-    - name: Docs URL Alive Check
-      run: |
-        cd ${GOPATH}/src/github.com/${{ github.repository }} && make docs-url-alive-check

.github/workflows/kata-deploy-push.yaml

@@ -24,7 +24,6 @@ jobs:
           - firecracker
           - rootfs-image
           - rootfs-initrd
-          - virtiofsd
     steps:
       - uses: actions/checkout@v2
       - name: Install docker

.github/workflows/kata-deploy-test.yaml

@@ -48,7 +48,6 @@ jobs:
           - rootfs-image
           - rootfs-initrd
           - shim-v2
-          - virtiofsd
     steps:
       - name: get-PR-ref
         id: get-PR-ref

.github/workflows/release.yaml

@@ -1,8 +1,8 @@
-name: Publish Kata release artifacts
+name: Publish Kata 2.x release artifacts
 on:
   push:
     tags:
-      - '[0-9]+.[0-9]+.[0-9]+*'
+     - '2.*'
 
 jobs:
   build-asset:
@@ -17,7 +17,6 @@ jobs:
           - rootfs-image
           - rootfs-initrd
           - shim-v2
-          - virtiofsd
     steps:
       - uses: actions/checkout@v2
       - name: Install docker

.github/workflows/snap-release.yaml

@@ -1,9 +1,8 @@
-name: Release Kata in snapcraft store
+name: Release Kata 2.x in snapcraft store
 on:
   push:
     tags:
-      - '[0-9]+.[0-9]+.[0-9]+*'
-
+      - '2.*'
 jobs:
   release-snap:
     runs-on: ubuntu-20.04
@@ -20,8 +19,6 @@ jobs:
 
       - name: Build snap
         run: |
-          # Removing man-db, workflow kept failing, fixes: #4480
-          sudo apt -y remove --purge man-db
           sudo apt-get install -y git git-extras
           kata_url="https://github.com/kata-containers/kata-containers"
           latest_version=$(git ls-remote --tags ${kata_url}  | egrep -o "refs.*" | egrep -v "\-alpha|\-rc|{}" | egrep -o "[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+" | sort -V -r | head -1)

.gitignore

@@ -10,5 +10,4 @@ src/agent/kata-agent.service
 src/agent/protocols/src/*.rs
 !src/agent/protocols/src/lib.rs
 build
-src/tools/log-parser/kata-log-parser
 

Makefile

@@ -6,23 +6,24 @@
 # List of available components
 COMPONENTS =
 
-COMPONENTS += libs
 COMPONENTS += agent
 COMPONENTS += runtime
-COMPONENTS += runtime-rs
 
 # List of available tools
 TOOLS =
 
 TOOLS += agent-ctl
 TOOLS += trace-forwarder
-TOOLS += runk
-TOOLS += log-parser
 
 STANDARD_TARGETS = build check clean install test vendor
 
 default: all
 
+all: logging-crate-tests build
+
+logging-crate-tests:
+	make -C src/libs/logging
+
 include utils.mk
 include ./tools/packaging/kata-deploy/local-build/Makefile
 
@@ -38,15 +39,10 @@ generate-protocols:
 static-checks: build
 	bash ci/static-checks.sh
 
-docs-url-alive-check:
-	bash ci/docs-url-alive-check.sh
-
 .PHONY: \
 	all \
 	binary-tarball \
 	default \
 	install-binary-tarball \
-	static-checks \
-	docs-url-alive-check
-
-
+	logging-crate-tests \
+	static-checks

README.md

@@ -71,7 +71,6 @@ See the [official documentation](docs) including:
 - [Developer guide](docs/Developer-Guide.md)
 - [Design documents](docs/design)
   - [Architecture overview](docs/design/architecture)
-  - [Architecture 3.0 overview](docs/design/architecture_3.0/)
 
 ## Configuration
 
@@ -118,10 +117,7 @@ The table below lists the core parts of the project:
 |-|-|-|
 | [runtime](src/runtime) | core | Main component run by a container manager and providing a containerd shimv2 runtime implementation. |
 | [agent](src/agent) | core | Management process running inside the virtual machine / POD that sets up the container environment. |
-| [libraries](src/libs) | core | Library crates shared by multiple Kata Container components or published to [`crates.io`](https://crates.io/index.html) |
-| [`dragonball`](src/dragonball) | core | An optional built-in VMM brings out-of-the-box Kata Containers experience with optimizations on container workloads |
 | [documentation](docs) | documentation | Documentation common to all components (such as design and install documentation). |
-| [libraries](src/libs) | core | Library crates shared by multiple Kata Container components or published to [`crates.io`](https://crates.io/index.html) |
 | [tests](https://github.com/kata-containers/tests) | tests | Excludes unit tests which live with the main code. |
 
 ### Additional components
@@ -135,7 +131,6 @@ The table below lists the remaining parts of the project:
 | [osbuilder](tools/osbuilder) | infrastructure | Tool to create "mini O/S" rootfs and initrd images and kernel for the hypervisor. |
 | [`agent-ctl`](src/tools/agent-ctl) | utility | Tool that provides low-level access for testing the agent. |
 | [`trace-forwarder`](src/tools/trace-forwarder) | utility | Agent tracing helper. |
-| [`runk`](src/tools/runk) | utility | Standard OCI container runtime based on the agent. |
 | [`ci`](https://github.com/kata-containers/ci) | CI | Continuous Integration configuration files and scripts. |
 | [`katacontainers.io`](https://github.com/kata-containers/www.katacontainers.io) | Source for the [`katacontainers.io`](https://www.katacontainers.io) site. |
 
@@ -143,7 +138,7 @@ The table below lists the remaining parts of the project:
 
 Kata Containers is now
 [available natively for most distributions](docs/install/README.md#packaged-installation-methods).
-However, packaging scripts and metadata are still used to generate [snap](snap/local) and GitHub releases. See
+However, packaging scripts and metadata are still used to generate snap and GitHub releases. See
 the [components](#components) section for further details.
 
 ## Glossary of Terms

VERSION

@@ -1 +1 @@
-3.0.0-alpha0
+2.4.3

ci/darwin-test.sh

@@ -11,10 +11,10 @@ runtimedir=$cidir/../src/runtime
 
 build_working_packages() {
 	# working packages:
-	device_api=$runtimedir/pkg/device/api
-	device_config=$runtimedir/pkg/device/config
-	device_drivers=$runtimedir/pkg/device/drivers
-	device_manager=$runtimedir/pkg/device/manager
+	device_api=$runtimedir/virtcontainers/device/api
+	device_config=$runtimedir/virtcontainers/device/config
+	device_drivers=$runtimedir/virtcontainers/device/drivers
+	device_manager=$runtimedir/virtcontainers/device/manager
 	rc_pkg_dir=$runtimedir/pkg/resourcecontrol/
 	utils_pkg_dir=$runtimedir/virtcontainers/utils
 

ci/go-test.sh

@@ -1,6 +1,6 @@
-#!/bin/bash
+#!/usr/bin/env bash
 #
-# Copyright (c) 2021 Easystack Inc.
+# Copyright (c) 2020 Intel Corporation
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -9,4 +9,4 @@ set -e
 cidir=$(dirname "$0")
 source "${cidir}/lib.sh"
 
-run_docs_url_alive_check
+run_go_test

ci/install_libseccomp.sh

@@ -19,7 +19,7 @@ source "${tests_repo_dir}/.ci/lib.sh"
 # fail. So let's ensure they are unset here.
 unset PREFIX DESTDIR
 
-arch=${ARCH:-$(uname -m)}
+arch=$(uname -m)
 workdir="$(mktemp -d --tmpdir build-libseccomp.XXXXX)"
 
 # Variables for libseccomp
@@ -70,8 +70,7 @@ build_and_install_gperf() {
     curl -sLO "${gperf_tarball_url}"
     tar -xf "${gperf_tarball}"
     pushd "gperf-${gperf_version}"
-    # Unset $CC for configure, we will always use native for gperf
-    CC= ./configure --prefix="${gperf_install_dir}"
+    ./configure --prefix="${gperf_install_dir}"
     make
     make install
     export PATH=$PATH:"${gperf_install_dir}"/bin
@@ -85,7 +84,7 @@ build_and_install_libseccomp() {
     curl -sLO "${libseccomp_tarball_url}"
     tar -xf "${libseccomp_tarball}"
     pushd "libseccomp-${libseccomp_version}"
-    ./configure --prefix="${libseccomp_install_dir}" CFLAGS="${cflags}" --enable-static --host="${arch}"
+    ./configure --prefix="${libseccomp_install_dir}" CFLAGS="${cflags}" --enable-static
     make
     make install
     popd

ci/install_musl.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+# Copyright (c) 2020 Ant Group
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+set -e
+
+install_aarch64_musl() {
+	local arch=$(uname -m)
+	if [ "${arch}" == "aarch64" ]; then
+		local musl_tar="${arch}-linux-musl-native.tgz"
+		local musl_dir="${arch}-linux-musl-native"
+		pushd /tmp
+		if curl -sLO --fail https://musl.cc/${musl_tar}; then
+			tar -zxf ${musl_tar}
+			mkdir -p /usr/local/musl/
+			cp -r ${musl_dir}/* /usr/local/musl/
+		fi
+		popd
+	fi
+}
+
+install_aarch64_musl

ci/lib.sh

@@ -18,13 +18,6 @@ clone_tests_repo()
 {
 	if [ -d "$tests_repo_dir" ]; then
 		[ -n "${CI:-}" ] && return
-		# git config --global --add safe.directory will always append
-		# the target to .gitconfig without checking the existence of
-		# the target, so it's better to check it before adding the target repo.
-		local sd="$(git config --global --get safe.directory ${tests_repo_dir} || true)"
-		if [ -z "${sd}" ]; then
-			git config --global --add safe.directory ${tests_repo_dir}
-		fi
 		pushd "${tests_repo_dir}"
 		git checkout "${branch}"
 		git pull
@@ -46,11 +39,8 @@ run_static_checks()
 	bash "$tests_repo_dir/.ci/static-checks.sh" "$@"
 }
 
-run_docs_url_alive_check()
+run_go_test()
 {
 	clone_tests_repo
-	# Make sure we have the targeting branch
-	git remote set-branches --add origin "${branch}"
-	git fetch -a
-	bash "$tests_repo_dir/.ci/static-checks.sh" --docs --all "github.com/kata-containers/kata-containers"
+	bash "$tests_repo_dir/.ci/go-test.sh"
 }

docs/Developer-Guide.md

@@ -116,7 +116,7 @@ detailed below.
 The Kata logs appear in the `containerd` log files, along with logs from `containerd` itself.
 
 For more information about `containerd` debug, please see the
-[`containerd` documentation](https://github.com/containerd/containerd/blob/main/docs/getting-started.md).
+[`containerd` documentation](https://github.com/containerd/containerd/blob/master/docs/getting-started.md).
 
 #### Enabling full `containerd` debug
 
@@ -425,7 +425,7 @@ To build utilizing the same options as Kata, you should make use of the `configu
 $ cd $your_qemu_directory
 $ $packaging_dir/scripts/configure-hypervisor.sh kata-qemu > kata.cfg
 $ eval ./configure "$(cat kata.cfg)"
-$ make -j $(nproc --ignore=1)
+$ make -j $(nproc)
 $ sudo -E make install
 ```
 
@@ -465,7 +465,7 @@ script and paste its output directly into a
 > [runtime](../src/runtime) repository.
 
 To perform analysis on Kata logs, use the
-[`kata-log-parser`](../src/tools/log-parser)
+[`kata-log-parser`](https://github.com/kata-containers/tests/tree/main/cmd/log-parser)
 tool, which can convert the logs into formats (e.g. JSON, TOML, XML, and YAML).
 
 See [Set up a debug console](#set-up-a-debug-console).
@@ -700,11 +700,11 @@ options to have the kernel boot messages logged into the system journal.
 For generic information on enabling debug in the configuration file, see the
 [Enable full debug](#enable-full-debug) section.
 
-The kernel boot messages will appear in the `kata` logs (and in the `containerd` or `CRI-O` log appropriately).
+The kernel boot messages will appear in the `containerd` or `CRI-O` log appropriately,
 such as:
 
 ```bash
-$ sudo journalctl -t kata
+$ sudo journalctl -t containerd
 -- Logs begin at Thu 2020-02-13 16:20:40 UTC, end at Thu 2020-02-13 16:30:23 UTC. --
 ...
 time="2020-09-15T14:56:23.095113803+08:00" level=debug msg="reading guest console" console-protocol=unix console-url=/run/vc/vm/ab9f633385d4987828d342e47554fc6442445b32039023eeddaa971c1bb56791/console.sock pid=107642 sandbox=ab9f633385d4987828d342e47554fc6442445b32039023eeddaa971c1bb56791 source=virtcontainers subsystem=sandbox vmconsole="[    0.395399] brd: module loaded"
@@ -714,4 +714,3 @@ time="2020-09-15T14:56:23.105268162+08:00" level=debug msg="reading guest consol
 time="2020-09-15T14:56:23.121121598+08:00" level=debug msg="reading guest console" console-protocol=unix console-url=/run/vc/vm/ab9f633385d4987828d342e47554fc6442445b32039023eeddaa971c1bb56791/console.sock pid=107642 sandbox=ab9f633385d4987828d342e47554fc6442445b32039023eeddaa971c1bb56791 source=virtcontainers subsystem=sandbox vmconsole="[    0.421324] memmap_init_zone_device initialised 32768 pages in 12ms"
 ...
 ```
-Refer to the [kata-log-parser documentation](../src/tools/log-parser/README.md) which is useful to fetch these.

docs/Limitations.md

@@ -46,7 +46,7 @@ The following link shows the latest list of limitations:
 # Contributing
 
 If you would like to work on resolving a limitation, please refer to the
-[contributors guide](https://github.com/kata-containers/community/blob/main/CONTRIBUTING.md).
+[contributors guide](https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md).
 If you wish to raise an issue for a new limitation, either
 [raise an issue directly on the runtime](https://github.com/kata-containers/kata-containers/issues/new)
 or see the
@@ -60,26 +60,17 @@ This section lists items that might be possible to fix.
 ## OCI CLI commands
 
 ### Docker and Podman support
-Currently Kata Containers does not support Podman.
+Currently Kata Containers does not support Docker or Podman.
 
 See issue https://github.com/kata-containers/kata-containers/issues/722 for more information.
 
-Docker supports Kata Containers since 22.06:
-
-```bash
-$ sudo docker run --runtime io.containerd.kata.v2
-```
-
-Kata Containers works perfectly with containerd, we recommend to use
-containerd's Docker-style command line tool [`nerdctl`](https://github.com/containerd/nerdctl).
-
 ## Runtime commands
 
 ### checkpoint and restore
 
 The runtime does not provide `checkpoint` and `restore` commands. There
 are discussions about using VM save and restore to give us a
-[`criu`](https://github.com/checkpoint-restore/criu)-like functionality,
+`[criu](https://github.com/checkpoint-restore/criu)`-like functionality,
 which might provide a solution.
 
 Note that the OCI standard does not specify `checkpoint` and `restore`
@@ -102,42 +93,6 @@ All other configurations are supported and are working properly.
 
 ## Networking
 
-### Host network
-
-Host network (`nerdctl/docker run --net=host`or [Kubernetes `HostNetwork`](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#hosts-namespaces)) is not supported.
-It is not possible to directly access the host networking configuration
-from within the VM.
-
-The `--net=host` option can still be used with `runc` containers and
-inter-mixed with running Kata Containers, thus enabling use of `--net=host`
-when necessary.
-
-It should be noted, currently passing the `--net=host` option into a
-Kata Container may result in the Kata Container networking setup
-modifying, re-configuring and therefore possibly breaking the host
-networking setup. Do not use `--net=host` with Kata Containers.
-
-### Support for joining an existing VM network
-
-Docker supports the ability for containers to join another containers
-namespace with the `docker run --net=containers` syntax. This allows
-multiple containers to share a common network namespace and the network
-interfaces placed in the network namespace. Kata Containers does not
-support network namespace sharing. If a Kata Container is setup to
-share the network namespace of a `runc` container, the runtime
-effectively takes over all the network interfaces assigned to the
-namespace and binds them to the VM. Consequently, the `runc` container loses
-its network connectivity.
-
-### docker run --link
-
-The runtime does not support the `docker run --link` command. This
-command is now deprecated by docker and we have no intention of adding support.
-Equivalent functionality can be achieved with the newer docker networking commands.
-
-See more documentation at
-[docs.docker.com](https://docs.docker.com/network/links/).
-
 ## Resource management
 
 Due to the way VMs differ in their CPU and memory allocation, and sharing

docs/README.md

@@ -30,6 +30,7 @@ See the [how-to documentation](how-to).
 * [GPU Passthrough with Kata](./use-cases/GPU-passthrough-and-Kata.md)
 * [SR-IOV with Kata](./use-cases/using-SRIOV-and-kata.md)
 * [Intel QAT with Kata](./use-cases/using-Intel-QAT-and-kata.md)
+* [VPP with Kata](./use-cases/using-vpp-and-kata.md)
 * [SPDK vhost-user with Kata](./use-cases/using-SPDK-vhostuser-and-kata.md)
 * [Intel SGX with Kata](./use-cases/using-Intel-SGX-and-kata.md)
 

docs/Unit-Test-Advice.md

@@ -277,9 +277,7 @@ mod tests {
 
 ## Temporary files
 
-Use `t.TempDir()` to create temporary directory. The directory created by
-`t.TempDir()` is automatically removed when the test and all its subtests
-complete.
+Always delete temporary files on success.
 
 ### Golang temporary files
 
@@ -288,7 +286,11 @@ func TestSomething(t *testing.T) {
     assert := assert.New(t)
 
     // Create a temporary directory
-    tmpdir := t.TempDir()
+    tmpdir, err := os.MkdirTemp("", "")
+    assert.NoError(err)
+
+    // Delete it at the end of the test
+    defer os.RemoveAll(tmpdir) 
 
     // Add test logic that will use the tmpdir here...
 }
@@ -320,7 +322,7 @@ mod tests {
 
 ## Test user
 
-[Unit tests are run *twice*](../src/runtime/go-test.sh):
+[Unit tests are run *twice*](https://github.com/kata-containers/tests/blob/main/.ci/go-test.sh):
 
 - as the current user
 - as the `root` user (if different to the current user)

docs/code-pr-advice.md

@@ -79,7 +79,7 @@ a "`BUG: feature X not implemented see {bug-url}`" type error.
 - Don't use multiple log calls when a single log call could be used.
 
 - Use structured logging where possible to allow
-  [standard tooling](../src/tools/log-parser)
+  [standard tooling](https://github.com/kata-containers/tests/tree/main/cmd/log-parser)
   be able to extract the log fields.
 
 ### Names

docs/design/README.md

@@ -11,8 +11,7 @@ Kata Containers design documents:
 - [`Inotify` support](inotify.md)
 - [Metrics(Kata 2.0)](kata-2-0-metrics.md)
 - [Design for Kata Containers `Lazyload` ability with `nydus`](kata-nydus-design.md)
-- [Design for direct-assigned volume](direct-blk-device-assignment.md)
-- [Design for core-scheduling](core-scheduling.md)
+
 ---
 
 - [Design proposals](proposals)

docs/design/VSocks.md

@@ -67,15 +67,22 @@ Using a proxy for multiplexing the connections between the VM and the host uses
 4.5MB per [POD][2]. In a high density deployment this could add up to GBs of
 memory that could have been used to host more PODs. When we talk about density
 each kilobyte matters and it might be the decisive factor between run another
-POD or not. Before making the decision not to use VSOCKs, you should ask
+POD or not. For example if you have 500 PODs running in a server, the same
+amount of [`kata-proxy`][3] processes will be running and consuming for around
+2250MB of RAM. Before making the decision not to use VSOCKs, you should ask
 yourself, how many more containers can run with the memory RAM consumed by the
 Kata proxies?
 
 ### Reliability
 
+[`kata-proxy`][3] is in charge of multiplexing the connections between virtual
+machine and host processes, if it dies all connections get broken. For example
+if you have a [POD][2] with 10 containers running, if `kata-proxy` dies it would
+be impossible to contact your containers, though they would still be running.
 Since communication via VSOCKs is direct, the only way to lose communication
 with the containers is if the VM itself or the `containerd-shim-kata-v2` dies, if this happens
 the containers are removed automatically.
 
 [1]: https://wiki.qemu.org/Features/VirtioVsock
 [2]: ./vcpu-handling.md#virtual-cpus-and-kubernetes-pods
+[3]: https://github.com/kata-containers/proxy

docs/design/architecture/kubernetes.md

@@ -17,7 +17,7 @@ Kubelet instance is responsible for managing the lifecycle of pods
 within the nodes and eventually relies on a container runtime to
 handle execution. The Kubelet architecture decouples lifecycle
 management from container execution through a dedicated gRPC based
-[Container Runtime Interface (CRI)](https://github.com/kubernetes/design-proposals-archive/blob/main/node/container-runtime-interface-v1.md).
+[Container Runtime Interface (CRI)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/node/container-runtime-interface-v1.md).
 
 In other words, a Kubelet is a CRI client and expects a CRI
 implementation to handle the server side of the interface.

docs/design/architecture/storage.md

@@ -1,17 +1,5 @@
 # Storage
 
-## Limits
-
-Kata Containers is [compatible](README.md#compatibility) with existing
-standards and runtime. From the perspective of storage, this means no
-limits are placed on the amount of storage a container
-[workload](README.md#workload) may use.
-
-Since cgroups are not able to set limits on storage allocation, if you
-wish to constrain the amount of storage a container uses, consider
-using an existing facility such as `quota(1)` limits or
-[device mapper](#devicemapper) limits.
-
 ## virtio SCSI
 
 If a block-based graph driver is [configured](README.md#configuration),
@@ -32,7 +20,7 @@ For virtio-fs, the [runtime](README.md#runtime) starts one `virtiofsd` daemon
 ## Devicemapper
 
 The
-[devicemapper `snapshotter`](https://github.com/containerd/containerd/tree/main/snapshots/devmapper)
+[devicemapper `snapshotter`](https://github.com/containerd/containerd/tree/master/snapshots/devmapper)
 is a special case. The `snapshotter` uses dedicated block devices
 rather than formatted filesystems, and operates at the block level
 rather than the file level. This knowledge is used to directly use the

docs/design/architecture_3.0/README.md

@@ -1,169 +0,0 @@
-# Kata 3.0 Architecture
-## Overview
-In cloud-native scenarios, there is an increased demand for container startup speed, resource consumption, stability, and security, areas where the present Kata Containers runtime is challenged relative to other runtimes. To achieve this, we propose a solid, field-tested and secure Rust version of the kata-runtime.
-
-Also, we provide the following designs:
-
-- Turn key solution with builtin `Dragonball` Sandbox
-- Async I/O to reduce resource consumption
-- Extensible framework for multiple services, runtimes and hypervisors
-- Lifecycle management for sandbox and container associated resources
-
-### Rationale for choosing Rust
-
-We chose Rust because it is designed as a system language with a focus on efficiency.
-In contrast to Go, Rust makes a variety of design trade-offs in order to obtain
-good execution performance, with innovative techniques that, in contrast to C or
-C++, provide reasonable protection against common memory errors (buffer
-overflow, invalid pointers, range errors), error checking (ensuring errors are
-dealt with), thread safety, ownership of resources, and more.
-
-These benefits were verified in our project when the Kata Containers guest agent
-was rewritten in Rust. We notably saw a significant reduction in memory usage
-with the Rust-based implementation.
-
-
-## Design
-### Architecture
-![architecture](./images/architecture.png)
-### Built-in VMM
-#### Current Kata 2.x architecture
-![not_builtin_vmm](./images/not_built_in_vmm.png)
-As shown in the figure, runtime and VMM are separate processes. The runtime process forks the VMM process and interacts through the inter-process RPC. Typically, process interaction consumes more resources than peers within the process, and it will result in relatively low efficiency. At the same time, the cost of resource operation and maintenance should be considered. For example, when performing resource recovery under abnormal conditions, the exception of any process must be detected by others and activate the appropriate resource recovery process. If there are additional processes, the recovery becomes even more difficult.
-#### How To Support Built-in VMM
-We provide `Dragonball` Sandbox to enable built-in VMM by integrating VMM's function into the Rust library. We could perform VMM-related functionalities by using the library. Because runtime and VMM  are in the same process, there is a benefit in terms of message processing speed and API synchronization. It can also guarantee the consistency of the runtime and the VMM life cycle, reducing resource recovery and exception handling maintenance, as shown in the figure:
-![builtin_vmm](./images/built_in_vmm.png)
-### Async Support
-#### Why Need Async
-**Async is already in stable Rust and allows us to write async code**
-
-- Async provides significantly reduced CPU and memory overhead, especially for workloads with a large amount of IO-bound tasks
-- Async is zero-cost in Rust, which means that you only pay for what you use. Specifically, you can use async without heap allocations and dynamic dispatch, which greatly improves efficiency
-- For more (see [Why Async?](https://rust-lang.github.io/async-book/01_getting_started/02_why_async.html) and [The State of Asynchronous Rust](https://rust-lang.github.io/async-book/01_getting_started/03_state_of_async_rust.html)).
-
-**There may be several problems if implementing kata-runtime with Sync Rust**
-
-- Too many threads with a new TTRPC connection
-   - TTRPC threads: reaper thread(1) + listener thread(1) + client handler(2)
-- Add 3 I/O threads with a new container
-- In Sync mode, implementing a timeout mechanism is challenging. For example, in TTRPC API interaction, the timeout mechanism is difficult to align with Golang
-#### How To Support Async
-The kata-runtime is controlled by TOKIO_RUNTIME_WORKER_THREADS to run the OS thread, which is 2 threads by default. For TTRPC and container-related threads run in the `tokio` thread in a unified manner, and related dependencies need to be switched to Async, such as Timer, File, Netlink, etc. With the help of Async, we can easily support no-block I/O and timer. Currently, we only utilize Async for kata-runtime. The built-in VMM keeps the OS thread because it can ensure that the threads are controllable.
-
-**For N tokio worker threads and M containers**
-
-- Sync runtime(both OS thread and `tokio` task are OS thread but without `tokio` worker thread)  OS thread number:  4 + 12*M
-- Async runtime(only OS thread is OS thread) OS thread number: 2 + N
-```shell
-├─ main(OS thread)
-├─ async-logger(OS thread)
-└─ tokio worker(N * OS thread)
-  ├─ agent log forwarder(1 * tokio task)
-  ├─ health check thread(1 * tokio task)
-  ├─ TTRPC reaper thread(M * tokio task)
-  ├─ TTRPC listener thread(M * tokio task)
-  ├─ TTRPC client handler thread(7 * M * tokio task)
-  ├─ container stdin io thread(M * tokio task)
-  ├─ container stdin io thread(M * tokio task)
-  └─ container stdin io thread(M * tokio task)
-```
-### Extensible Framework
-The Kata 3.x runtime is designed with the extension of service, runtime, and hypervisor, combined with configuration to meet the needs of different scenarios. At present, the service provides a register mechanism to support multiple services. Services could interact with runtime through messages. In addition, the runtime handler handles messages from services. To meet the needs of a binary that supports multiple runtimes and hypervisors, the startup must obtain the runtime handler type and hypervisor type through configuration.
-
-![framework](./images/framework.png)
-### Resource Manager
-In our case, there will be a variety of resources, and every resource has several subtypes. Especially for `Virt-Container`, every subtype of resource has different operations. And there may be dependencies, such as the share-fs rootfs and the share-fs volume will use share-fs resources to share files to the VM. Currently, network and share-fs are regarded as sandbox resources, while rootfs, volume, and cgroup are regarded as container resources. Also, we abstract a common interface for each resource and use subclass operations to evaluate the differences between different subtypes.
-![resource manager](./images/resourceManager.png)
-
-## Roadmap
-
-- Stage 1 (June): provide basic features (current delivered)
-- Stage 2 (September): support common features
-- Stage 3: support full features
-
-| **Class**                  | **Sub-Class**       | **Development Stage** |
-| -------------------------- | ------------------- | --------------------- |
-| Service                    | task service        | Stage 1               |
-|                            | extend service      | Stage 3               |
-|                            | image service       | Stage 3               |
-| Runtime handler            | `Virt-Container`    | Stage 1               |
-|                            | `Wasm-Container`    | Stage 3               |
-|                            | `Linux-Container`   | Stage 3               |
-| Endpoint                   | VETH Endpoint       | Stage 1               |
-|                            | Physical Endpoint   | Stage 2               |
-|                            | Tap Endpoint        | Stage 2               |
-|                            | `Tuntap` Endpoint   | Stage 2               |
-|                            | `IPVlan` Endpoint   | Stage 3               |
-|                            | `MacVlan` Endpoint  | Stage 3               |
-|                            | MACVTAP Endpoint    | Stage 3               |
-|                            | `VhostUserEndpoint` | Stage 3               |
-| Network Interworking Model | Tc filter           | Stage 1               |
-|                            | `MacVtap`           | Stage 3               |
-| Storage                    | Virtio-fs           | Stage 1               |
-|                            | `nydus`             | Stage 2               |
-| Hypervisor                 | `Dragonball`        | Stage 1               |
-|                            | QEMU                | Stage 2               |
-|                            | ACRN                | Stage 3               |
-|                            | Cloud Hypervisor    | Stage 3               |
-|                            | Firecracker         | Stage 3               |
-
-## FAQ
-
-- Are the "service", "message dispatcher" and "runtime handler" all part of the single Kata 3.x runtime binary?
-
-  Yes. They are components in Kata 3.x runtime. And they will be packed into one binary.
-  1. Service is an interface, which is responsible for handling multiple services like task service, image service and etc. 
-  2. Message dispatcher, it is used to match multiple requests from the service module. 
-  3. Runtime handler is used to deal with the operation for sandbox and container. 
-- What is the name of the Kata 3.x runtime binary?
-  
-  Apparently we can't use `containerd-shim-v2-kata` because it's already used. We are facing the hardest issue of "naming" again. Any suggestions are welcomed.
-  Internally we use `containerd-shim-v2-rund`.
-
-- Is the Kata 3.x design compatible with the containerd shimv2 architecture? 
-  
-  Yes. It is designed to follow the functionality of go version kata.  And it implements the `containerd shim v2` interface/protocol.
-
-- How will users migrate to the Kata 3.x architecture?
-  
-  The migration plan will be provided before the Kata 3.x is merging into the main branch.
-
-- Is `Dragonball` limited to its own built-in VMM? Can the `Dragonball` system be configured to work using an external `Dragonball` VMM/hypervisor?
-
-  The `Dragonball` could work as an external hypervisor. However, stability and performance is challenging in this case. Built in VMM could optimise the container overhead, and it's easy to maintain stability.
-
-  `runD` is the `containerd-shim-v2` counterpart of `runC` and can run a pod/containers. `Dragonball` is a `microvm`/VMM that is designed to run container workloads. Instead of `microvm`/VMM, we sometimes refer to it as secure sandbox.
-
-- QEMU, Cloud Hypervisor and Firecracker support are planned, but how that would work. Are they working in separate process?
- 
-  Yes. They are unable to work as built in VMM.
-
-- What is `upcall`?
-  
-    The `upcall` is used to hotplug CPU/memory/MMIO devices, and it solves two issues.
-    1. avoid dependency on PCI/ACPI
-    2. avoid dependency on `udevd` within guest and get deterministic results for hotplug operations. So `upcall` is an alternative to ACPI based CPU/memory/device hotplug. And we may cooperate with the community to add support for ACPI based CPU/memory/device hotplug if needed.
-   
-    `Dbs-upcall` is a `vsock-based` direct communication tool between VMM and guests. The server side of the `upcall` is a driver in guest kernel (kernel patches are needed for this feature) and it'll start to serve the requests once the kernel has started. And the client side is in VMM , it'll be a thread that communicates with VSOCK through `uds`. We have accomplished device hotplug / hot-unplug directly through `upcall` in order to avoid virtualization of ACPI  to minimize virtual machine's overhead. And there could be many other usage through this direct communication channel. It's already open source.
-   https://github.com/openanolis/dragonball-sandbox/tree/main/crates/dbs-upcall 
-
-- The URL below says the kernel patches work with 4.19, but do they also work with 5.15+ ?
-  
-  Forward compatibility should be achievable, we have ported it to 5.10 based kernel.
-
-- Are these patches platform-specific or would they work for any architecture that supports VSOCK?
-  
-  It's almost platform independent, but some message related to CPU hotplug are platform dependent.
-
-- Could the kernel driver be replaced with a userland daemon in the guest using loopback VSOCK?
-  
-  We need to create device nodes for hot-added CPU/memory/devices, so it's not easy for userspace daemon to do these tasks.
-
-- The fact that `upcall` allows communication between the VMM and the guest suggests that this architecture might be incompatible with https://github.com/confidential-containers where the VMM should have no knowledge of what happens inside the VM.
-  
-  1. `TDX` doesn't support CPU/memory hotplug yet.
-  2. For ACPI based device hotplug, it depends on ACPI `DSDT` table, and the guest kernel will execute `ASL` code to handle during handling those hotplug event. And it should be easier to audit VSOCK based communication than ACPI `ASL` methods.
-
-- What is the security boundary for the monolithic / "Built-in VMM" case?
-  
-  It has the security boundary of virtualization. More details will be provided in next stage.

docs/design/core-scheduling.md

@@ -1,12 +0,0 @@
-# Core scheduling
-
-Core scheduling is a Linux kernel feature that allows only trusted tasks to run concurrently on
-CPUs sharing compute resources (for example, hyper-threads on a core).
-
-Containerd versions >= 1.6.4 leverage this to treat all of the processes associated with a
-given pod or container to be a single group of trusted tasks. To indicate this should be carried
-out, containerd sets the `SCHED_CORE` environment variable for each shim it spawns. When this is
-set, the Kata Containers shim implementation uses the `prctl` syscall to create a new core scheduling
-domain for the shim process itself as well as future VMM processes it will start.
-
-For more details on the core scheduling feature, see the [Linux documentation](https://www.kernel.org/doc/html/latest/admin-guide/hw-vuln/core-scheduling.html).

docs/design/direct-blk-device-assignment.md

@@ -1,253 +0,0 @@
-# Motivation
-Today, there exist a few gaps between Container Storage Interface (CSI) and virtual machine (VM) based runtimes such as Kata Containers 
-that prevent them from working together smoothly.
-
-First, it’s cumbersome to use a persistent volume (PV) with Kata Containers. Today, for a PV with Filesystem volume mode, Virtio-fs
-is the only way to surface it inside a Kata Container guest VM. But often mounting the filesystem (FS) within the guest operating system (OS) is 
-desired due to performance benefits, availability of native FS features and security benefits over the Virtio-fs mechanism.
-
-Second, it’s difficult if not impossible to resize a PV online with Kata Containers. While a PV can be expanded on the host OS, 
-the updated metadata needs to be propagated to the guest OS in order for the application container to use the expanded volume. 
-Currently, there is not a way to propagate the PV metadata from the host OS to the guest OS without restarting the Pod sandbox.
-
-# Proposed Solution
-
-Because of the OS boundary, these features cannot be implemented in the CSI node driver plugin running on the host OS 
-as is normally done in the runc container. Instead, they can be done by the Kata Containers agent inside the guest OS, 
-but it requires the CSI driver to pass the relevant information to the Kata Containers runtime. 
-An ideal long term solution would be to have the `kubelet` coordinating the communication between the CSI driver and 
-the container runtime, as described in [KEP-2857](https://github.com/kubernetes/enhancements/pull/2893/files). 
-However, as the KEP is still under review, we would like to propose a short/medium term solution to unblock our use case.
-
-The proposed solution is built on top of a previous [proposal](https://github.com/egernst/kata-containers/blob/da-proposal/docs/design/direct-assign-volume.md) 
-described by Eric Ernst. The previous proposal has two gaps:
-
-1. Writing a `csiPlugin.json` file to the volume root path introduced a security risk. A malicious user can gain unauthorized 
-access to a block device by writing their own `csiPlugin.json` to the above location through an ephemeral CSI plugin.  
-
-2. The proposal didn't describe how to establish a mapping between a volume and a kata sandbox, which is needed for 
-implementing CSI volume resize and volume stat collection APIs.
-
-This document particularly focuses on how to address these two gaps.
-
-## Assumptions and Limitations
-1. The proposal assumes that a block device volume will only be used by one Pod on a node at a time, which we believe 
-is the most common pattern in Kata Containers use cases. It’s also unsafe to have the same block device attached to more than 
-one Kata pod. In the context of Kubernetes, the `PersistentVolumeClaim` (PVC) needs to have the `accessMode` as `ReadWriteOncePod`. 
-2. More advanced Kubernetes volume features such as, `fsGroup`, `fsGroupChangePolicy`, and `subPath` are not supported. 
-
-## End User Interface
-
-1. The user specifies a PV as a direct-assigned volume. How a PV is specified as a direct-assigned volume is left for each CSI implementation to decide.
-There are a few options for reference:
-   1. A storage class parameter specifies whether it's a direct-assigned volume. This avoids any lookups of PVC 
-   or Pod information from the CSI plugin (as external provisioner takes care of these). However, all PVs in the storage class with the parameter set 
-   will have host mounts skipped.
-   2. Use a PVC annotation. This approach requires the CSI plugins have `--extra-create-metadata` [set](https://kubernetes-csi.github.io/docs/external-provisioner.html#persistentvolumeclaim-and-persistentvolume-parameters)
-   to be able to perform a lookup of the PVC annotations from the API server. Pro: API server lookup of annotations only required during creation of PV. 
-   Con: The CSI plugin will always skip host mounting of the PV.
-   3. The CSI plugin can also lookup pod `runtimeclass` during `NodePublish`. This approach can be found in the [ALIBABA CSI plugin](https://github.com/kubernetes-sigs/alibaba-cloud-csi-driver/blob/master/pkg/disk/nodeserver.go#L248).
-2. The CSI node driver delegates the direct assigned volume to the Kata Containers runtime. The CSI node driver APIs need to 
-   be modified to pass the volume mount information and collect volume information to/from the Kata Containers runtime by invoking `kata-runtime` command line commands.
-   * **NodePublishVolume** -- It invokes `kata-runtime direct-volume add --volume-path [volumePath] --mount-info [mountInfo]` 
-   to propagate the volume mount information to the Kata Containers runtime for it to carry out the filesystem mount operation.
-   The `volumePath` is the [target_path](https://github.com/container-storage-interface/spec/blob/master/csi.proto#L1364) in the CSI `NodePublishVolumeRequest`.
-   The `mountInfo` is a serialized JSON string. 
-   * **NodeGetVolumeStats** -- It invokes `kata-runtime direct-volume stats --volume-path [volumePath]` to retrieve the filesystem stats of direct-assigned volume.
-   * **NodeExpandVolume** -- It invokes `kata-runtime direct-volume resize --volume-path [volumePath] --size [size]` to send a resize request to the Kata Containers runtime to
-   resize the direct-assigned volume.
-   * **NodeStageVolume/NodeUnStageVolume** -- It invokes `kata-runtime direct-volume remove --volume-path [volumePath]` to remove the persisted metadata of a direct-assigned volume.
-
-The `mountInfo` object is defined as follows:
-```Golang
-type MountInfo struct {
-    // The type of the volume (ie. block)
-    VolumeType string `json:"volume-type"`
-    // The device backing the volume.
-    Device string `json:"device"`
-    // The filesystem type to be mounted on the volume.
-    FsType string `json:"fstype"`
-    // Additional metadata to pass to the agent regarding this volume.
-    Metadata map[string]string `json:"metadata,omitempty"`
-    // Additional mount options.
-    Options []string `json:"options,omitempty"`
-}
-```
-Notes: given that the `mountInfo` is persisted to the disk by the Kata runtime, it shouldn't container any secrets (such as SMB mount password).
-
-## Implementation Details
-
-### Kata runtime
-Instead of the CSI node driver writing the mount info into a `csiPlugin.json` file under the volume root, 
-as described in the original proposal, here we propose that the CSI node driver passes the mount information to 
-the Kata Containers runtime through a new `kata-runtime` commandline command. The `kata-runtime` then writes the mount 
-information to a `mount-info.json` file in a predefined location (`/run/kata-containers/shared/direct-volumes/[volume_path]/`).
-
-When the Kata Containers runtime starts a container, it verifies whether a volume mount is a direct-assigned volume by checking 
-whether there is a `mountInfo` file under the computed Kata `direct-volumes` directory. If it is, the runtime parses the `mountInfo` file, 
-updates the mount spec with the data in `mountInfo`. The updated mount spec is then passed to the Kata agent in the guest VM together
-with other mounts. The Kata Containers runtime also creates a file named by the sandbox id under the `direct-volumes/[volume_path]/` 
-directory. The reason for adding a sandbox id file is to establish a mapping between the volume and the sandbox using it. 
-Later, when the Kata Containers runtime handles the `get-stats` and `resize` commands, it uses the sandbox id to identify 
-the endpoint of the corresponding `containerd-shim-kata-v2`.
-
-### containerd-shim-kata-v2 changes
-`containerd-shim-kata-v2` provides an API for sandbox management through a Unix domain socket. Two new handlers are proposed: `/direct-volume/stats` and `/direct-volume/resize`:
-
-Example:
-
-```bash
-$ curl --unix-socket "$shim_socket_path" -I -X GET 'http://localhost/direct-volume/stats/[urlSafeVolumePath]'
-$ curl --unix-socket "$shim_socket_path" -I -X POST 'http://localhost/direct-volume/resize' -d '{ "volumePath"": [volumePath], "Size": "123123" }'
-```
-
-The shim then forwards the corresponding request to the `kata-agent` to carry out the operations inside the guest VM. For `resize` operation, 
-the Kata runtime also needs to notify the hypervisor to resize the block device (e.g. call `block_resize` in QEMU). 
-
-### Kata agent changes
-
-The mount spec of a direct-assigned volume is passed to `kata-agent` through the existing `Storage` GRPC object. 
-Two new APIs and three new GRPC objects are added to GRPC protocol between the shim and agent for resizing and getting volume stats:
-```protobuf
-
-rpc GetVolumeStats(VolumeStatsRequest) returns (VolumeStatsResponse);
-rpc ResizeVolume(ResizeVolumeRequest) returns (google.protobuf.Empty);
-
-message VolumeStatsRequest {
-// The volume path on the guest outside the container
-    string volume_guest_path = 1;
-}
-
-message ResizeVolumeRequest {
-// Full VM guest path of the volume (outside the container)
-    string volume_guest_path = 1;
-    uint64 size = 2;
-}
-
-// This should be kept in sync with CSI NodeGetVolumeStatsResponse (https://github.com/container-storage-interface/spec/blob/v1.5.0/csi.proto)
-message VolumeStatsResponse {
-   // This field is OPTIONAL.
-   repeated VolumeUsage usage = 1;
-   // Information about the current condition of the volume.
-   // This field is OPTIONAL.
-   // This field MUST be specified if the VOLUME_CONDITION node
-   // capability is supported.
-   VolumeCondition volume_condition = 2;
-}
-message VolumeUsage {
-   enum Unit {
-      UNKNOWN = 0;
-      BYTES = 1;
-      INODES = 2;
-   }
-   // The available capacity in specified Unit. This field is OPTIONAL.
-   // The value of this field MUST NOT be negative.
-   uint64 available = 1;
-
-   // The total capacity in specified Unit. This field is REQUIRED.
-   // The value of this field MUST NOT be negative.
-   uint64 total = 2;
-
-   // The used capacity in specified Unit. This field is OPTIONAL.
-   // The value of this field MUST NOT be negative.
-   uint64 used = 3;
-
-   // Units by which values are measured. This field is REQUIRED.
-   Unit unit = 4;
-}
-
-// VolumeCondition represents the current condition of a volume.
-message VolumeCondition {
-
-   // Normal volumes are available for use and operating optimally.
-   // An abnormal volume does not meet these criteria.
-   // This field is REQUIRED.
-   bool abnormal = 1;
-
-   // The message describing the condition of the volume.
-   // This field is REQUIRED.
-   string message = 2;
-}
-
-```
-
-### Step by step walk-through
-
-Given the following definition:
-```YAML
----
-apiVersion: v1
-kind: Pod
-metadata:
-  name: app
-spec:
-  runtime-class: kata-qemu
-  containers:
-  - name: app
-    image: centos
-    command: ["/bin/sh"]
-    args: ["-c", "while true; do echo $(date -u) >> /data/out.txt; sleep 5; done"]
-    volumeMounts:
-    - name: persistent-storage
-      mountPath: /data
-  volumes:
-  - name: persistent-storage
-    persistentVolumeClaim:
-      claimName: ebs-claim
----
-apiVersion: v1
-kind: PersistentVolumeClaim
-metadata:
-  annotations:
-    skip-hostmount: "true"
-  name: ebs-claim
-spec:
-  accessModes:
-    - ReadWriteOncePod
-  volumeMode: Filesystem
-  storageClassName: ebs-sc
-  resources:
-    requests:
-      storage: 4Gi
----
-kind: StorageClass
-apiVersion: storage.k8s.io/v1
-metadata:
-  name: ebs-sc
-provisioner: ebs.csi.aws.com
-volumeBindingMode: WaitForFirstConsumer
-parameters:
-  csi.storage.k8s.io/fstype: ext4
-
-```
-Let’s assume that changes have been made in the `aws-ebs-csi-driver` node driver.
-
-**Node publish volume**
-1. In the node CSI driver, the `NodePublishVolume` API invokes: `kata-runtime direct-volume add --volume-path "/kubelet/a/b/c/d/sdf" --mount-info "{\"Device\": \"/dev/sdf\", \"fstype\": \"ext4\"}"`.
-2. The `Kata-runtime` writes the mount-info JSON to a file called `mountInfo.json` under `/run/kata-containers/shared/direct-volumes/kubelet/a/b/c/d/sdf`.
-
-**Node unstage volume**
-1. In the node CSI driver, the `NodeUnstageVolume` API invokes: `kata-runtime direct-volume remove --volume-path "/kubelet/a/b/c/d/sdf"`.
-2. Kata-runtime deletes the directory `/run/kata-containers/shared/direct-volumes/kubelet/a/b/c/d/sdf`.
-
-**Use the volume in sandbox**
-1. Upon the request to start a container, the `containerd-shim-kata-v2` examines the container spec,
-and iterates through the mounts. For each mount, if there is a `mountInfo.json` file under `/run/kata-containers/shared/direct-volumes/[mount source path]`,
-it generates a `storage` GRPC object after overwriting the mount spec with the information in `mountInfo.json`.
-2. The shim sends the storage objects to kata-agent through TTRPC.
-3. The shim writes a file with the sandbox id as the name under `/run/kata-containers/shared/direct-volumes/[mount source path]`.
-4. The kata-agent mounts the storage objects for the container.
-
-**Node expand volume**
-1. In the node CSI driver, the `NodeExpandVolume` API invokes: `kata-runtime direct-volume resize –-volume-path "/kubelet/a/b/c/d/sdf" –-size 8Gi`.
-2. The Kata runtime checks whether there is a sandbox id file under the directory `/run/kata-containers/shared/direct-volumes/kubelet/a/b/c/d/sdf`.
-3. The Kata runtime identifies the shim instance through the sandbox id, and sends a GRPC request to resize the volume.
-4. The shim handles the request, asks the hypervisor to resize the block device and sends a GRPC request to Kata agent to resize the filesystem.
-5. Kata agent receives the request and resizes the filesystem.
-
-**Node get volume stats**
-1. In the node CSI driver, the `NodeGetVolumeStats` API invokes: `kata-runtime direct-volume stats –-volume-path "/kubelet/a/b/c/d/sdf"`.
-2. The Kata runtime checks whether there is a sandbox id file under the directory `/run/kata-containers/shared/direct-volumes/kubelet/a/b/c/d/sdf`.
-3. The Kata runtime identifies the shim instance through the sandbox id, and sends a GRPC request to get the volume stats.
-4. The shim handles the request and forwards it to the Kata agent.
-5. Kata agent receives the request and returns the filesystem stats.

docs/design/host-cgroups.md

@@ -12,7 +12,7 @@ The OCI [runtime specification][linux-config] provides guidance on where the con
   > [`cgroupsPath`][cgroupspath]: (string, OPTIONAL) path to the cgroups. It can be used to either control the cgroups
   > hierarchy for containers or to run a new process in an existing container
 
-The cgroups are hierarchical, and this can be seen with the following pod example:
+Cgroups are hierarchical, and this can be seen with the following pod example:
 
 - Pod 1: `cgroupsPath=/kubepods/pod1`
   - Container 1: `cgroupsPath=/kubepods/pod1/container1`
@@ -247,14 +247,14 @@ cgroup size and constraints accordingly.
 
 # Supported cgroups
 
-Kata Containers currently supports cgroups `v1` and `v2`. 
+Kata Containers currently only supports cgroups `v1`. 
 
 In the following sections each cgroup is described briefly.
 
-## cgroups v1
+## Cgroups V1
 
-`cgroups v1` are under a [`tmpfs`][1] filesystem mounted at `/sys/fs/cgroup`, where each cgroup is
-mounted under a separate cgroup filesystem. A `cgroups v1` hierarchy may look like the following
+`Cgroups V1` are under a [`tmpfs`][1] filesystem mounted at `/sys/fs/cgroup`, where each cgroup is
+mounted under a separate cgroup filesystem. A `Cgroups v1` hierarchy may look like the following
 diagram:
 
 ```
@@ -301,12 +301,13 @@ diagram:
 A process can join a cgroup by writing its process id (`pid`) to `cgroup.procs` file,
 or join a cgroup partially by writing the task (thread) id (`tid`) to the `tasks` file.
 
+Kata Containers only supports `v1`.
 To know more about `cgroups v1`, see [cgroupsv1(7)][2].
 
-## cgroups v2
+## Cgroups V2
 
-`cgroups v2` are also known as unified cgroups, unlike `cgroups v1`, the cgroups are
-mounted under the same cgroup filesystem. A `cgroups v2` hierarchy may look like the following
+`Cgroups v2` are also known as unified cgroups, unlike `cgroups v1`, the cgroups are
+mounted under the same cgroup filesystem. A `Cgroups v2` hierarchy may look like the following
 diagram:
 
 ```
@@ -353,6 +354,8 @@ Same as `cgroups v1`, a process can join the cgroup by writing its process id (`
 `cgroup.procs` file, or join a cgroup partially by writing the task (thread) id (`tid`) to
 `cgroup.threads` file.
 
+Kata Containers does not support cgroups `v2` on the host.
+
 ### Distro Support
 
 Many Linux distributions do not yet support `cgroups v2`, as it is quite a recent addition.

docs/design/vcpu-handling.md

@@ -2,15 +2,24 @@
 
 ## Default number of virtual CPUs
 
-Before starting a container, the [runtime][4] reads the `default_vcpus` option
-from the [configuration file][5] to determine the number of virtual CPUs
+Before starting a container, the [runtime][6] reads the `default_vcpus` option
+from the [configuration file][7] to determine the number of virtual CPUs
 (vCPUs) needed to start the virtual machine. By default, `default_vcpus` is
 equal to 1 for fast boot time and a small memory footprint per virtual machine.
 Be aware that increasing this value negatively impacts the virtual machine's
 boot time and memory footprint.
 In general, we recommend that you do not edit this variable, unless you know
 what are you doing. If your container needs more than one vCPU, use
-[Kubernetes `cpu` limits][1] to assign more resources.
+[docker `--cpus`][1], [docker update][4], or [Kubernetes `cpu` limits][2] to
+assign more resources.
+
+*Docker*
+
+```sh
+$ docker run --name foo -ti --cpus 2 debian bash
+$ docker update --cpus 4 foo
+```
+
 
 *Kubernetes*
 
@@ -40,7 +49,7 @@ $ sudo -E kubectl create -f ~/cpu-demo.yaml
 ## Virtual CPUs and Kubernetes pods
 
 A Kubernetes pod is a group of one or more containers, with shared storage and
-network, and a specification for how to run the containers [[specification][2]].
+network, and a specification for how to run the containers [[specification][3]].
 In Kata Containers this group of containers, which is called a sandbox, runs inside
 the same virtual machine. If you do not specify a CPU constraint, the runtime does
 not add more vCPUs and the container is not placed inside a CPU cgroup.
@@ -64,7 +73,13 @@ constraints with each container trying to consume 100% of vCPU, the resources
 divide in two parts, 50% of vCPU for each container because your virtual
 machine does not have enough resources to satisfy containers needs. If you want
 to give access to a greater or lesser portion of vCPUs to a specific container,
-use [Kubernetes `cpu` requests][1].
+use [`docker --cpu-shares`][1] or [Kubernetes `cpu` requests][2].
+
+*Docker*
+
+```sh
+$ docker run -ti --cpus-shares=512 debian bash
+```
 
 *Kubernetes*
 
@@ -94,9 +109,10 @@ $ sudo -E kubectl create -f ~/cpu-demo.yaml
 Before running containers without CPU constraint, consider that your containers
 are not running alone. Since your containers run inside a virtual machine other
 processes use the vCPUs as well (e.g. `systemd` and the Kata Containers
-[agent][3]). In general, we recommend setting `default_vcpus` equal to 1 to
+[agent][5]). In general, we recommend setting `default_vcpus` equal to 1 to
 allow non-container processes to run on this vCPU and to specify a CPU
-constraint for each container.
+constraint for each container. If your container is already running and needs
+more vCPUs, you can add more using [docker update][4].
 
 ## Container with CPU constraint
 
@@ -105,7 +121,7 @@ constraints using the following formula: `vCPUs = ceiling( quota / period )`, wh
 `quota` specifies the number of microseconds per CPU Period that the container is
 guaranteed CPU access and `period` specifies the CPU CFS scheduler period of time
 in microseconds. The result determines the number of vCPU to hot plug into the
-virtual machine. Once the vCPUs have been added, the [agent][3] places the
+virtual machine. Once the vCPUs have been added, the [agent][5] places the
 container inside a CPU cgroup. This placement allows the container to use only
 its assigned resources.
 
@@ -122,6 +138,25 @@ the virtual machine starts with 8 vCPUs and 1 vCPUs is added and assigned
 to the container. Non-container processes might be able to use 8 vCPUs but they
 use a maximum 1 vCPU, hence 7 vCPUs might not be used.
 
+
+*Container without CPU constraint*
+
+```sh
+$ docker run -ti debian bash -c "nproc; cat /sys/fs/cgroup/cpu,cpuacct/cpu.cfs_*"
+1       # number of vCPUs
+100000  # cfs period
+-1      # cfs quota
+```
+
+*Container with CPU constraint*
+
+```sh
+docker run --cpus 4 -ti debian bash -c "nproc; cat /sys/fs/cgroup/cpu,cpuacct/cpu.cfs_*"
+5       # number of vCPUs
+100000  # cfs period
+400000  # cfs quota
+```
+
 ## Virtual CPU handling without hotplug
 
 In some cases, the hardware and/or software architecture being utilized does not support
@@ -148,8 +183,11 @@ the container's `spec` will provide the sizing information directly. If these ar
 calculate the number of CPUs required for the workload and augment this by `default_vcpus`
 configuration option, and use this for the virtual machine size.
 
-[1]: https://kubernetes.io/docs/tasks/configure-pod-container/assign-cpu-resource
-[2]: https://kubernetes.io/docs/concepts/workloads/pods/pod/
-[3]: ../../src/agent
-[4]: ../../src/runtime
-[5]: ../../src/runtime/README.md#configuration
+
+[1]: https://docs.docker.com/config/containers/resource_constraints/#cpu
+[2]: https://kubernetes.io/docs/tasks/configure-pod-container/assign-cpu-resource
+[3]: https://kubernetes.io/docs/concepts/workloads/pods/pod/
+[4]: https://docs.docker.com/engine/reference/commandline/update/
+[5]: ../../src/agent
+[6]: ../../src/runtime
+[7]: ../../src/runtime/README.md#configuration

docs/design/virtualization.md

@@ -39,7 +39,7 @@ Details of each solution and a summary are provided below.
 Kata Containers with QEMU has complete compatibility with Kubernetes.
 
 Depending on the host architecture, Kata Containers supports various machine types,
-for example `q35` on x86 systems, `virt` on ARM systems and `pseries` on IBM Power systems. The default Kata Containers
+for example `pc` and `q35` on x86 systems, `virt` on ARM systems and `pseries` on IBM Power systems. The default Kata Containers
 machine type is `q35`. The machine type and its [`Machine accelerators`](#machine-accelerators) can
 be changed by editing the runtime [`configuration`](architecture/README.md#configuration) file.
 
@@ -60,8 +60,9 @@ Machine accelerators are architecture specific and can be used to improve the pe
 and enable specific features of the machine types. The following machine accelerators
 are used in Kata Containers:
 
-- NVDIMM: This machine accelerator is x86 specific and only supported by `q35` machine types.
-`nvdimm` is used to provide the root filesystem as a persistent memory device to the Virtual Machine.
+- NVDIMM: This machine accelerator is x86 specific and only supported by `pc` and
+`q35` machine types. `nvdimm` is used to provide the root filesystem as a persistent
+memory device to the Virtual Machine.
 
 #### Hotplug devices
 

docs/how-to/README.md

@@ -5,7 +5,7 @@
 - [Run Kata containers with `crictl`](run-kata-with-crictl.md)
 - [Run Kata Containers with Kubernetes](run-kata-with-k8s.md)
 - [How to use Kata Containers and Containerd](containerd-kata.md)
-- [How to use Kata Containers and containerd with Kubernetes](how-to-use-k8s-with-containerd-and-kata.md)
+- [How to use Kata Containers and CRI (containerd) with Kubernetes](how-to-use-k8s-with-cri-containerd-and-kata.md)
 - [Kata Containers and service mesh for Kubernetes](service-mesh.md)
 - [How to import Kata Containers logs into Fluentd](how-to-import-kata-logs-with-fluentd.md)
 
@@ -15,11 +15,6 @@
 - `qemu`
 - `cloud-hypervisor`
 - `firecracker`
-
-   In the case of `firecracker` the use of a block device `snapshotter` is needed
-   for the VM rootfs. Refer to the following guide for additional configuration
-   steps:
-   - [Setup Kata containers with `firecracker`](how-to-use-kata-containers-with-firecracker.md)
 - `ACRN`
 
   While `qemu` , `cloud-hypervisor` and `firecracker` work out of the box with installation of Kata,

docs/how-to/containerd-kata.md

@@ -40,7 +40,7 @@ use `RuntimeClass` instead of the deprecated annotations.
 ### Containerd Runtime V2 API: Shim V2 API
 
 The [`containerd-shim-kata-v2` (short as `shimv2` in this documentation)](../../src/runtime/cmd/containerd-shim-kata-v2/)
-implements the [Containerd Runtime V2 (Shim API)](https://github.com/containerd/containerd/tree/main/runtime/v2) for Kata.
+implements the [Containerd Runtime V2 (Shim API)](https://github.com/containerd/containerd/tree/master/runtime/v2) for Kata.
 With `shimv2`, Kubernetes can launch Pod and OCI-compatible containers with one shim per Pod. Prior to `shimv2`, `2N+1` 
 shims (i.e. a `containerd-shim` and a `kata-shim` for each container and the Pod sandbox itself) and no standalone `kata-proxy` 
 process were used, even with VSOCK not available.
@@ -72,6 +72,7 @@ $ command -v containerd
 
 ### Install CNI plugins
 
+> **Note:** You do not need to install CNI plugins if you do not want to use containerd with Kubernetes.
 > If you have installed Kubernetes with `kubeadm`, you might have already installed the CNI plugins.
 
 You can manually install CNI plugins as follows:
@@ -93,8 +94,8 @@ $ popd
 You can install the `cri-tools` from source code:
 
 ```bash
-$ go get github.com/kubernetes-sigs/cri-tools
-$ pushd $GOPATH/src/github.com/kubernetes-sigs/cri-tools
+$ go get github.com/kubernetes-incubator/cri-tools
+$ pushd $GOPATH/src/github.com/kubernetes-incubator/cri-tools
 $ make
 $ sudo -E make install
 $ popd
@@ -130,42 +131,74 @@ For
 
 The `RuntimeClass` is suggested.
 
-The following configuration includes two runtime classes:
+The following configuration includes three runtime classes:
 - `plugins.cri.containerd.runtimes.runc`: the runc, and it is the default runtime.
-- `plugins.cri.containerd.runtimes.kata`: The function in containerd (reference [the document here](https://github.com/containerd/containerd/tree/main/runtime/v2#binary-naming)) 
+- `plugins.cri.containerd.runtimes.kata`: The function in containerd (reference [the document here](https://github.com/containerd/containerd/tree/master/runtime/v2#binary-naming)) 
   where the dot-connected string `io.containerd.kata.v2` is translated to `containerd-shim-kata-v2` (i.e. the 
-  binary name of the Kata implementation of [Containerd Runtime V2 (Shim API)](https://github.com/containerd/containerd/tree/main/runtime/v2)).
+  binary name of the Kata implementation of [Containerd Runtime V2 (Shim API)](https://github.com/containerd/containerd/tree/master/runtime/v2)).
+- `plugins.cri.containerd.runtimes.katacli`: the `containerd-shim-runc-v1` calls `kata-runtime`, which is the legacy process.
 
 ```toml
     [plugins.cri.containerd]
       no_pivot = false
     [plugins.cri.containerd.runtimes]
-      [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc]
-         privileged_without_host_devices = false
-         runtime_type = "io.containerd.runc.v2"
-        [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options]
-            BinaryName = ""
-            CriuImagePath = ""
-            CriuPath = ""
-            CriuWorkPath = ""
-            IoGid = 0
+      [plugins.cri.containerd.runtimes.runc]
+         runtime_type = "io.containerd.runc.v1"
+         [plugins.cri.containerd.runtimes.runc.options]
+           NoPivotRoot = false
+           NoNewKeyring = false
+           ShimCgroup = ""
+           IoUid = 0
+           IoGid = 0
+           BinaryName = "runc"
+           Root = ""
+           CriuPath = ""
+           SystemdCgroup = false
       [plugins.cri.containerd.runtimes.kata]
          runtime_type = "io.containerd.kata.v2"
-         privileged_without_host_devices = true
-         pod_annotations = ["io.katacontainers.*"]
-         container_annotations = ["io.katacontainers.*"]
-         [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.kata.options]
-            ConfigPath = "/opt/kata/share/defaults/kata-containers/configuration.toml"
+      [plugins.cri.containerd.runtimes.katacli]
+         runtime_type = "io.containerd.runc.v1"
+         [plugins.cri.containerd.runtimes.katacli.options]
+           NoPivotRoot = false
+           NoNewKeyring = false
+           ShimCgroup = ""
+           IoUid = 0
+           IoGid = 0
+           BinaryName = "/usr/bin/kata-runtime"
+           Root = ""
+           CriuPath = ""
+           SystemdCgroup = false
+```
+
+From Containerd v1.2.4 and Kata v1.6.0, there is a new runtime option supported, which allows you to specify a specific Kata configuration file as follows:
+
+```toml
+      [plugins.cri.containerd.runtimes.kata]
+         runtime_type = "io.containerd.kata.v2"
+	 privileged_without_host_devices = true
+	 [plugins.cri.containerd.runtimes.kata.options]
+	   ConfigPath = "/etc/kata-containers/config.toml"
 ```
 
 `privileged_without_host_devices` tells containerd that a privileged Kata container should not have direct access to all host devices. If unset, containerd will pass all host devices to Kata container, which may cause security issues.
 
-`pod_annotations` is the list of pod annotations passed to both the pod sandbox as well as container through the OCI config.
-
-`container_annotations` is the list of container annotations passed through to the OCI config of the containers.
-
 This `ConfigPath` option is optional. If you do not specify it, shimv2 first tries to get the configuration file from the environment variable `KATA_CONF_FILE`. If neither are set, shimv2 will use the default Kata configuration file paths (`/etc/kata-containers/configuration.toml` and `/usr/share/defaults/kata-containers/configuration.toml`).
 
+If you use Containerd older than v1.2.4 or a version of Kata older than v1.6.0  and also want to specify a configuration file, you can use the following workaround, since the shimv2 accepts an environment variable, `KATA_CONF_FILE` for the configuration file path. Then, you can create a
+shell script with the following:
+
+```bash
+#!/usr/bin/env bash
+KATA_CONF_FILE=/etc/kata-containers/firecracker.toml containerd-shim-kata-v2 $@
+```
+
+Name it as `/usr/local/bin/containerd-shim-katafc-v2` and reference it in the configuration of containerd:
+
+```toml
+      [plugins.cri.containerd.runtimes.kata-firecracker]
+         runtime_type = "io.containerd.katafc.v2"
+```
+
 #### Kata Containers as the runtime for untrusted workload
 
 For cases without `RuntimeClass` support, we can use the legacy annotation method to support using Kata Containers 
@@ -185,8 +218,28 @@ and then, run an untrusted workload with Kata Containers:
       runtime_type = "io.containerd.kata.v2"
 ```
 
+For the earlier versions of Kata Containers and containerd that do not support Runtime V2 (Shim API), you can use the following alternative configuration:
+
+```toml
+    [plugins.cri.containerd]
+  
+    # "plugins.cri.containerd.default_runtime" is the runtime to use in containerd.
+    [plugins.cri.containerd.default_runtime]
+      # runtime_type is the runtime type to use in containerd e.g. io.containerd.runtime.v1.linux
+      runtime_type = "io.containerd.runtime.v1.linux"
+
+    # "plugins.cri.containerd.untrusted_workload_runtime" is a runtime to run untrusted workloads on it.
+    [plugins.cri.containerd.untrusted_workload_runtime]
+      # runtime_type is the runtime type to use in containerd e.g. io.containerd.runtime.v1.linux
+      runtime_type = "io.containerd.runtime.v1.linux"
+
+      # runtime_engine is the name of the runtime engine used by containerd.
+      runtime_engine = "/usr/bin/kata-runtime"
+```
+
 You can find more information on the [Containerd config documentation](https://github.com/containerd/cri/blob/master/docs/config.md)
 
+
 #### Kata Containers as the default runtime
 
 If you want to set Kata Containers as the only runtime in the deployment, you can simply configure as follows:
@@ -197,6 +250,15 @@ If you want to set Kata Containers as the only runtime in the deployment, you ca
       runtime_type = "io.containerd.kata.v2"
 ```
 
+Alternatively, for the earlier versions of Kata Containers and containerd that do not support Runtime V2 (Shim API), you can use the following alternative configuration:
+
+```toml
+    [plugins.cri.containerd]
+    [plugins.cri.containerd.default_runtime]
+      runtime_type = "io.containerd.runtime.v1.linux"
+      runtime_engine = "/usr/bin/kata-runtime"
+```
+
 ### Configuration for `cri-tools`
 
 > **Note:** If you skipped the [Install `cri-tools`](#install-cri-tools) section, you can skip this section too.
@@ -250,12 +312,10 @@ To run a container with Kata Containers through the containerd command line, you
 
 ```bash
 $ sudo ctr image pull docker.io/library/busybox:latest
-$ sudo ctr run --cni --runtime io.containerd.run.kata.v2 -t --rm docker.io/library/busybox:latest hello sh
+$ sudo ctr run --runtime io.containerd.run.kata.v2 -t --rm docker.io/library/busybox:latest hello sh
 ```
 
 This launches a BusyBox container named `hello`, and it will be removed by `--rm` after it quits.
-The `--cni` flag enables CNI networking for the container. Without this flag, a container with just a
-loopback interface is created.
 
 ### Launch Pods with `crictl` command line
 

docs/how-to/data/kata-monitor-daemonset.yml

@@ -45,9 +45,6 @@ spec:
         - name: containerdsocket
           mountPath: /run/containerd/containerd.sock
           readOnly: true
-        - name: sbs
-          mountPath: /run/vc/sbs/
-          readOnly: true
       terminationGracePeriodSeconds: 30
       volumes:
       - name: containerdtask
@@ -56,6 +53,3 @@ spec:
       - name: containerdsocket
         hostPath:
           path: /run/containerd/containerd.sock
-      - name: sbs
-        hostPath:
-          path: /run/vc/sbs/

docs/how-to/how-to-import-kata-logs-with-fluentd.md

@@ -68,7 +68,7 @@ the Kata logs import to the EFK stack.
 > stack they are able to utilise in order to modify and test as necessary.
 
 Minikube by default
-[configures](https://github.com/kubernetes/minikube/blob/master/deploy/iso/minikube-iso/board/minikube/x86_64/rootfs-overlay/etc/systemd/journald.conf)
+[configures](https://github.com/kubernetes/minikube/blob/master/deploy/iso/minikube-iso/board/coreos/minikube/rootfs-overlay/etc/systemd/journald.conf)
  the `systemd-journald` with the
 [`Storage=volatile`](https://www.freedesktop.org/software/systemd/man/journald.conf.html) option,
 which results in the journal being stored in `/run/log/journal`. Unfortunately, the Minikube EFK
@@ -163,7 +163,7 @@ sub-filter on, for instance, the `SYSLOG_IDENTIFIER` to differentiate the Kata c
 on the `PRIORITY` to filter out critical issues etc.
 
 Kata generates a significant amount of Kata specific information, which can be seen as
-[`logfmt`](../../src/tools/log-parser/README.md#logfile-requirements).
+[`logfmt`](https://github.com/kata-containers/tests/tree/main/cmd/log-parser#logfile-requirements).
 data contained in the `MESSAGE` field. Imported as-is, there is no easy way to filter on that data
 in Kibana:
 

docs/how-to/how-to-run-docker-with-kata.md

@@ -48,9 +48,9 @@ Running Docker containers Kata Containers requires care because `VOLUME`s specif
 kataShared on / type virtiofs (rw,relatime,dax)
 ```
 
-`kataShared` mount types are powered by [`virtio-fs`](https://virtio-fs.gitlab.io/), a marked improvement over `virtio-9p`, thanks to [PR #1016](https://github.com/kata-containers/runtime/pull/1016). While `virtio-fs` is normally an excellent choice, in the case of DinD workloads `virtio-fs` causes an issue -- [it *cannot* be used as a "upper layer" of `overlayfs` without a custom patch](http://lists.katacontainers.io/pipermail/kata-dev/2020-January/001216.html).
+`kataShared` mount types are powered by [`virtio-fs`][virtio-fs], a marked improvement over `virtio-9p`, thanks to [PR #1016](https://github.com/kata-containers/runtime/pull/1016). While `virtio-fs` is normally an excellent choice, in the case of DinD workloads `virtio-fs` causes an issue -- [it *cannot* be used as a "upper layer" of `overlayfs` without a custom patch](http://lists.katacontainers.io/pipermail/kata-dev/2020-January/001216.html).
 
-As `/var/lib/docker` is a `VOLUME` specified by DinD (i.e. the `docker` images tagged `*-dind`/`*-dind-rootless`), `docker` will fail to start (or even worse, silently pick a worse storage driver like `vfs`) when started in a Kata Container. Special measures must be taken when running DinD-powered workloads in Kata Containers.
+As `/var/lib/docker` is a `VOLUME` specified by DinD (i.e. the `docker` images tagged `*-dind`/`*-dind-rootless`), `docker` fill fail to start (or even worse, silently pick a worse storage driver like `vfs`) when started in a Kata Container. Special measures must be taken when running DinD-powered workloads in Kata Containers.
 
 ## Workarounds/Solutions
 
@@ -58,7 +58,7 @@ Thanks to various community contributions (see [issue references below](#referen
 
 ### Use a memory backed volume
 
-For small workloads (small container images, without much generated filesystem load), a memory-backed volume is sufficient. Kubernetes supports a variant of  [the `EmptyDir` volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir), which allows for memdisk-backed storage -- the the `medium: Memory`. An example of a `Pod` using such a setup [was contributed](https://github.com/kata-containers/runtime/issues/1429#issuecomment-477385283), and is reproduced below:
+For small workloads (small container images, without much generated filesystem load), a memory-backed volume is sufficient. Kubernetes supports a variant of  [the `EmptyDir` volume][k8s-emptydir], which allows for memdisk-backed storage -- the [the `medium: Memory` ][k8s-memory-volume-type]. An example of a `Pod` using such a setup [was contributed](https://github.com/kata-containers/runtime/issues/1429#issuecomment-477385283), and is reproduced below:
 
 ```yaml
 apiVersion: v1

docs/how-to/how-to-set-prometheus-in-k8s.md

@@ -19,7 +19,7 @@ Also you should ensure that `kubectl` working correctly.
 > **Note**: More information about Kubernetes integrations:
 >   - [Run Kata Containers with Kubernetes](run-kata-with-k8s.md)
 >   - [How to use Kata Containers and Containerd](containerd-kata.md)
->   - [How to use Kata Containers and containerd with Kubernetes](how-to-use-k8s-with-containerd-and-kata.md)
+>   - [How to use Kata Containers and CRI (containerd plugin) with Kubernetes](how-to-use-k8s-with-cri-containerd-and-kata.md)
 
 ## Configure Prometheus
 

docs/how-to/how-to-set-sandbox-config-kata.md

@@ -91,7 +91,6 @@ There are several kinds of Kata configurations and they are listed below.
 | `io.katacontainers.config.hypervisor.virtio_fs_daemon` | string | virtio-fs `vhost-user` daemon path |
 | `io.katacontainers.config.hypervisor.virtio_fs_extra_args` | string | extra options passed to `virtiofs` daemon |
 | `io.katacontainers.config.hypervisor.enable_guest_swap` | `boolean` | enable swap in the guest |
-| `io.katacontainers.config.hypervisor.use_legacy_serial` | `boolean` | uses legacy serial device for guest's console (QEMU) |
 
 ## Container Options
 | Key | Value Type | Comments |
@@ -173,7 +172,7 @@ kind: Pod
 metadata:
   name: pod2
   annotations:
-    io.katacontainers.config.runtime.disable_guest_seccomp: "false"
+    io.katacontainers.config.runtime.disable_guest_seccomp: false
 spec:
   runtimeClassName: kata
   containers:

docs/how-to/how-to-use-k8s-with-cri-containerd-and-kata.md

@@ -1,15 +1,15 @@
-# How to use Kata Containers and containerd with Kubernetes
+# How to use Kata Containers and CRI (containerd plugin) with Kubernetes
 
 This document describes how to set up a single-machine Kubernetes (k8s) cluster.
 
 The Kubernetes cluster will use the
-[containerd](https://github.com/containerd/containerd/) and
-[Kata Containers](https://katacontainers.io) to launch workloads.
+[CRI containerd](https://github.com/containerd/containerd/) and
+[Kata Containers](https://katacontainers.io) to launch untrusted workloads.
 
 ## Requirements
 
 - Kubernetes, Kubelet, `kubeadm`
-- containerd
+- containerd with `cri` plug-in
 - Kata Containers
 
 > **Note:** For information about the supported versions of these components,
@@ -149,7 +149,7 @@ $ sudo -E kubectl taint nodes --all node-role.kubernetes.io/master-
 
 ## Create runtime class for Kata Containers
 
-By default, all pods are created with the default runtime configured in containerd.
+By default, all pods are created with the default runtime configured in CRI containerd plugin.
 From Kubernetes v1.12, users can use [`RuntimeClass`](https://kubernetes.io/docs/concepts/containers/runtime-class/#runtime-class) to specify a different runtime for Pods.
 
 ```bash
@@ -166,7 +166,7 @@ $ sudo -E kubectl apply -f runtime.yaml
 
 ## Run pod in Kata Containers
 
-If a pod has the `runtimeClassName` set to `kata`, the CRI runs the pod with the
+If a pod has the `runtimeClassName` set to `kata`, the CRI plugin runs the pod with the
 [Kata Containers runtime](../../src/runtime/README.md).
 
 - Create an pod configuration that using Kata Containers runtime

docs/how-to/how-to-use-kata-containers-with-acrn.md

@@ -101,7 +101,7 @@ Start an ACRN based Kata Container,
 $ sudo docker run -ti --runtime=kata-runtime busybox sh
 ```
 
-You will see ACRN(`acrn-dm`) is now running on your system, as well as a `kata-shim`. You should obtain an interactive shell prompt. Verify that all the Kata processes terminate once you exit the container.
+You will see ACRN(`acrn-dm`) is now running on your system, as well as a `kata-shim`, `kata-proxy`. You should obtain an interactive shell prompt. Verify that all the Kata processes terminate once you exit the container.
 
 ```bash
 $ ps -ef | grep -E "kata|acrn"

docs/how-to/how-to-use-kata-containers-with-firecracker.md

@@ -1,254 +0,0 @@
-# Configure Kata Containers to use Firecracker
-
-This document provides an overview on how to run Kata Containers with the AWS Firecracker hypervisor.
-
-## Introduction
-
-AWS Firecracker is an open source virtualization technology that is purpose-built for creating and managing secure, multi-tenant container and function-based services that provide serverless operational models. AWS Firecracker runs workloads in lightweight virtual machines, called `microVMs`, which combine the security and isolation properties provided by hardware virtualization technology with the speed and flexibility of Containers.
-
-Please refer to AWS Firecracker [documentation](https://github.com/firecracker-microvm/firecracker/blob/main/docs/getting-started.md) for more details.
-
-## Pre-requisites
-
-This document requires the presence of Kata Containers on your system. Install using the instructions available through the following links:
-
-- Kata Containers [automated installation](../install/README.md)
-
-- Kata Containers manual installation: Automated installation does not seem to be supported for Clear Linux, so please use [manual installation](../Developer-Guide.md) steps.
-> **Note:** Create rootfs image and not initrd image.
-
-## Install AWS Firecracker
-
-Kata Containers only support AWS Firecracker v0.23.4 ([yet](https://github.com/kata-containers/kata-containers/pull/1519)).
-To install Firecracker we need to get the `firecracker` and `jailer` binaries:
-
-```bash
-$ release_url="https://github.com/firecracker-microvm/firecracker/releases"
-$ version="v0.23.1"
-$ arch=`uname -m`
-$ curl ${release_url}/download/${version}/firecracker-${version}-${arch} -o firecracker
-$ curl ${release_url}/download/${version}/jailer-${version}-${arch} -o jailer
-$ chmod +x jailer firecracker
-```
-
-To make the binaries available from the default system `PATH` it is recommended to move them to `/usr/local/bin` or add a symbolic link:
-
-```bash
-$ sudo ln -s $(pwd)/firecracker /usr/local/bin
-$ sudo ln -s $(pwd)/jailer /usr/local/bin
-```
-
-More details can be found in [AWS Firecracker docs](https://github.com/firecracker-microvm/firecracker/blob/main/docs/getting-started.md)
-
-In order to run Kata with AWS Firecracker a block device as the backing store for a VM is required. To interact with `containerd` and Kata we use the `devmapper` `snapshotter`.
-
-## Configure `devmapper`
-
-To check support for your `containerd` installation, you can run:
-
-```
-$ ctr plugins ls |grep devmapper
-```
-
-if the output of the above command is:
-
-```
-io.containerd.snapshotter.v1    devmapper                linux/amd64    ok
-```
-then you can skip this section and move on to `Configure Kata Containers with AWS Firecracker`
-
-If the output of the above command is:
-
-```
-io.containerd.snapshotter.v1    devmapper                linux/amd64    error
-```
-
-then we need to setup `devmapper` `snapshotter`. Based on a [very useful
-guide](https://docs.docker.com/storage/storagedriver/device-mapper-driver/)
-from docker, we can set it up using the following scripts:
-
-> **Note:** The following scripts assume a 100G sparse file for storing container images, a 10G sparse file for the thin-provisioning pool and 10G base image files for any sandboxed container created. This means that we will need at least 10GB free space.
-
-```
-#!/bin/bash
-set -ex
-
-DATA_DIR=/var/lib/containerd/devmapper
-POOL_NAME=devpool
-
-mkdir -p ${DATA_DIR}
-
-# Create data file
-sudo touch "${DATA_DIR}/data"
-sudo truncate -s 100G "${DATA_DIR}/data"
-
-# Create metadata file
-sudo touch "${DATA_DIR}/meta"
-sudo truncate -s 10G "${DATA_DIR}/meta"
-
-# Allocate loop devices
-DATA_DEV=$(sudo losetup --find --show "${DATA_DIR}/data")
-META_DEV=$(sudo losetup --find --show "${DATA_DIR}/meta")
-
-# Define thin-pool parameters.
-# See https://www.kernel.org/doc/Documentation/device-mapper/thin-provisioning.txt for details.
-SECTOR_SIZE=512
-DATA_SIZE="$(sudo blockdev --getsize64 -q ${DATA_DEV})"
-LENGTH_IN_SECTORS=$(bc <<< "${DATA_SIZE}/${SECTOR_SIZE}")
-DATA_BLOCK_SIZE=128
-LOW_WATER_MARK=32768
-
-# Create a thin-pool device
-sudo dmsetup create "${POOL_NAME}" \
-    --table "0 ${LENGTH_IN_SECTORS} thin-pool ${META_DEV} ${DATA_DEV} ${DATA_BLOCK_SIZE} ${LOW_WATER_MARK}"
-
-cat << EOF
-#
-# Add this to your config.toml configuration file and restart `containerd` daemon
-#
-[plugins]
-  [plugins.devmapper]
-    pool_name = "${POOL_NAME}"
-    root_path = "${DATA_DIR}"
-    base_image_size = "10GB"
-    discard_blocks = true
-EOF
-```
-
-Make it executable and run it:
-
-```bash
-$ sudo chmod +x ~/scripts/devmapper/create.sh
-$ cd ~/scripts/devmapper/
-$ sudo ./create.sh
-```
-
-Now, we can add the `devmapper` configuration provided from the script to `/etc/containerd/config.toml`.
-> **Note:** If you are using the default `containerd` configuration (`containerd config default >> /etc/containerd/config.toml`), you may need to edit the existing `[plugins."io.containerd.snapshotter.v1.devmapper"]`configuration.
-Save and restart `containerd`:
-
-
-```bash
-$ sudo systemctl restart containerd
-```
-
-We can use `dmsetup` to verify that the thin-pool was created successfully.
-
-```bash
-$ sudo dmsetup ls
-```
-
- We should also check that `devmapper` is registered and running:
-
-```bash
-$ sudo ctr plugins ls | grep devmapper
-```
-
-This script needs to be run only once, while setting up the `devmapper` `snapshotter` for `containerd`. Afterwards, make sure that on each reboot, the thin-pool is initialized from the same data directory. Otherwise, all the fetched containers (or the ones that you have created) will be re-initialized. A simple script that re-creates the thin-pool from the same data directory is shown below:
-
-```
-#!/bin/bash
-set -ex
-
-DATA_DIR=/var/lib/containerd/devmapper
-POOL_NAME=devpool
-
-# Allocate loop devices
-DATA_DEV=$(sudo losetup --find --show "${DATA_DIR}/data")
-META_DEV=$(sudo losetup --find --show "${DATA_DIR}/meta")
-
-# Define thin-pool parameters.
-# See https://www.kernel.org/doc/Documentation/device-mapper/thin-provisioning.txt for details.
-SECTOR_SIZE=512
-DATA_SIZE="$(sudo blockdev --getsize64 -q ${DATA_DEV})"
-LENGTH_IN_SECTORS=$(bc <<< "${DATA_SIZE}/${SECTOR_SIZE}")
-DATA_BLOCK_SIZE=128
-LOW_WATER_MARK=32768
-
-# Create a thin-pool device
-sudo dmsetup create "${POOL_NAME}" \
-    --table "0 ${LENGTH_IN_SECTORS} thin-pool ${META_DEV} ${DATA_DEV} ${DATA_BLOCK_SIZE} ${LOW_WATER_MARK}"
-```
-
-We can create a systemd service to run the above script on each reboot:
-
-```bash
-$ sudo nano /lib/systemd/system/devmapper_reload.service
-```
-
-The service file:
-
-```
-[Unit]
-Description=Devmapper reload script
-
-[Service]
-ExecStart=/path/to/script/reload.sh
-
-[Install]
-WantedBy=multi-user.target
-```
-
-Enable the newly created service:
-
-```bash
-$ sudo systemctl daemon-reload
-$ sudo systemctl enable devmapper_reload.service
-$ sudo systemctl start devmapper_reload.service
-```
-
-## Configure Kata Containers with AWS Firecracker
-
-To configure Kata Containers with AWS Firecracker, copy the generated `configuration-fc.toml` file when building the `kata-runtime` to either `/etc/kata-containers/configuration-fc.toml` or `/usr/share/defaults/kata-containers/configuration-fc.toml`.
-
-The following command shows full paths to the `configuration.toml` files that the runtime loads. It will use the first path that exists. (Please make sure the kernel and image paths are set correctly in the `configuration.toml` file)
-
-```bash
-$ sudo kata-runtime --show-default-config-paths
-```
-
-## Configure `containerd`
-Next, we need to configure containerd. Add a file in your path (e.g. `/usr/local/bin/containerd-shim-kata-fc-v2`) with the following contents:
-
-```
-#!/bin/bash
-KATA_CONF_FILE=/etc/containers/configuration-fc.toml /usr/local/bin/containerd-shim-kata-v2 $@
-```
-> **Note:** You may need to edit the paths of the configuration file and the `containerd-shim-kata-v2` to correspond to your setup.
-
-Make it executable:
-
-```bash
-$ sudo chmod +x /usr/local/bin/containerd-shim-kata-fc-v2
-```
-
-Add the relevant section in `containerd`’s `config.toml` file (`/etc/containerd/config.toml`):
-
-```
-[plugins.cri.containerd.runtimes]
-  [plugins.cri.containerd.runtimes.kata-fc]
-    runtime_type = "io.containerd.kata-fc.v2"
-```
-
-> **Note:** If you are using the default `containerd` configuration (`containerd config default >> /etc/containerd/config.toml`),
-> the configuration should change to :
-```
-[plugins."io.containerd.grpc.v1.cri".containerd.runtimes]
-  [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.kata-fc]
-    runtime_type = "io.containerd.kata-fc.v2"
-```
-
-Restart `containerd`:
-
-```bash
-$ sudo systemctl restart containerd
-```
-
-## Verify the installation
-
-We are now ready to launch a container using Kata with Firecracker to verify that everything worked:
-
-```bash
-$ sudo ctr images pull --snapshotter devmapper docker.io/library/ubuntu:latest
-$ sudo ctr run --snapshotter devmapper --runtime io.containerd.run.kata-fc.v2 -t --rm docker.io/library/ubuntu
-```

docs/how-to/privileged.md

@@ -31,7 +31,7 @@ See below example config:
   [plugins.cri]
     [plugins.cri.containerd]
        [plugins.cri.containerd.runtimes.runc]
-         runtime_type = "io.containerd.runc.v2"
+         runtime_type = "io.containerd.runc.v1"
          privileged_without_host_devices = false
        [plugins.cri.containerd.runtimes.kata]
          runtime_type = "io.containerd.kata.v2"
@@ -40,7 +40,7 @@ See below example config:
            ConfigPath = "/opt/kata/share/defaults/kata-containers/configuration.toml"
 ```
 
- - [How to use Kata Containers and containerd with Kubernetes](how-to-use-k8s-with-containerd-and-kata.md)
+ - [Kata Containers with Containerd and CRI documentation](how-to-use-k8s-with-cri-containerd-and-kata.md)
  - [Containerd CRI config documentation](https://github.com/containerd/containerd/blob/main/docs/cri/config.md)
 
 #### CRI-O

docs/how-to/run-kata-with-k8s.md

@@ -15,7 +15,7 @@ After choosing one CRI implementation, you must make the appropriate configurati
 to ensure it integrates with Kata Containers.
 
 Kata Containers 1.5 introduced the `shimv2` for containerd 1.2.0, reducing the components
-required to spawn pods and containers, and this is the preferred way to run Kata Containers with Kubernetes ([as documented here](../how-to/how-to-use-k8s-with-containerd-and-kata.md#configure-containerd-to-use-kata-containers)).
+required to spawn pods and containers, and this is the preferred way to run Kata Containers with Kubernetes ([as documented here](../how-to/how-to-use-k8s-with-cri-containerd-and-kata.md#configure-containerd-to-use-kata-containers)).
 
 An equivalent shim implementation for CRI-O is planned.
 
@@ -57,7 +57,7 @@ content shown below:
 
 To customize containerd to select Kata Containers runtime, follow our
 "Configure containerd to use Kata Containers" internal documentation
-[here](../how-to/how-to-use-k8s-with-containerd-and-kata.md#configure-containerd-to-use-kata-containers).
+[here](../how-to/how-to-use-k8s-with-cri-containerd-and-kata.md#configure-containerd-to-use-kata-containers).
 
 ## Install Kubernetes
 
@@ -85,7 +85,7 @@ Environment="KUBELET_EXTRA_ARGS=--container-runtime=remote --runtime-request-tim
 Environment="KUBELET_EXTRA_ARGS=--container-runtime=remote --runtime-request-timeout=15m --container-runtime-endpoint=unix:///run/containerd/containerd.sock"
 ```
 For more information about containerd see the "Configure Kubelet to use containerd"
-documentation [here](../how-to/how-to-use-k8s-with-containerd-and-kata.md#configure-kubelet-to-use-containerd).
+documentation [here](../how-to/how-to-use-k8s-with-cri-containerd-and-kata.md#configure-kubelet-to-use-containerd).
 
 ## Run a Kubernetes pod with Kata Containers
 
@@ -99,18 +99,7 @@ $ sudo systemctl restart kubelet
 $ sudo kubeadm init --ignore-preflight-errors=all --cri-socket /var/run/crio/crio.sock --pod-network-cidr=10.244.0.0/16
 
 # If using containerd
-$ cat <<EOF | tee kubeadm-config.yaml
-apiVersion: kubeadm.k8s.io/v1beta3
-kind: InitConfiguration
-nodeRegistration:
-  criSocket: "/run/containerd/containerd.sock"
----
-kind: KubeletConfiguration
-apiVersion: kubelet.config.k8s.io/v1beta1
-cgroupDriver: cgroupfs
-podCIDR: "10.244.0.0/16"
-EOF
-$ sudo kubeadm init --ignore-preflight-errors=all --config kubeadm-config.yaml
+$ sudo kubeadm init --ignore-preflight-errors=all --cri-socket /run/containerd/containerd.sock --pod-network-cidr=10.244.0.0/16
 
 $ export KUBECONFIG=/etc/kubernetes/admin.conf
 ```

docs/hypervisors.md

@@ -33,7 +33,6 @@ are available, their default values and how each setting can be used.
 [Cloud Hypervisor] | rust | `aarch64`, `x86_64` | Type 2 ([KVM]) | `configuration-clh.toml` |
 [Firecracker] | rust | `aarch64`, `x86_64` | Type 2 ([KVM]) | `configuration-fc.toml` |
 [QEMU] | C | all | Type 2 ([KVM]) | `configuration-qemu.toml` |
-[`Dragonball`] | rust | `aarch64`, `x86_64` | Type 2 ([KVM]) | `configuration-dragonball.toml` |
 
 ## Determine currently configured hypervisor
 
@@ -53,7 +52,6 @@ the hypervisors:
 [Cloud Hypervisor] | Low latency, small memory footprint, small attack surface | Minimal | | excellent | excellent | High performance modern cloud workloads | |
 [Firecracker] | Very slimline | Extremely minimal | Doesn't support all device types | excellent | excellent | Serverless / FaaS | |
 [QEMU] | Lots of features | Lots | | good | good | Good option for most users | | All users |
-[`Dragonball`] | Built-in VMM,  low CPU and memory overhead| Minimal | | excellent | excellent | Optimized for most container workloads | `out-of-the-box` Kata Containers experience |
 
 For further details, see the [Virtualization in Kata Containers](design/virtualization.md) document and the official documentation for each hypervisor.
 
@@ -62,4 +60,3 @@ For further details, see the [Virtualization in Kata Containers](design/virtuali
 [Firecracker]: https://github.com/firecracker-microvm/firecracker
 [KVM]: https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine
 [QEMU]: http://www.qemu-project.org
-[`Dragonball`]: https://github.com/openanolis/dragonball-sandbox

docs/install/README.md

@@ -79,6 +79,3 @@ versions. This is not recommended for normal users.
 * [upgrading document](../Upgrading.md)
 * [developer guide](../Developer-Guide.md)
 * [runtime documentation](../../src/runtime/README.md)
-
-## Kata Containers 3.0 rust runtime installation
-* [installation guide](../install/kata-containers-3.0-rust-runtime-installation-guide.md)

docs/install/container-manager/containerd/containerd-install.md

@@ -19,6 +19,12 @@
 > - If you decide to proceed and install a Kata Containers release, you can
 >   still check for the latest version of Kata Containers by running
 >   `kata-runtime check --only-list-releases`.
+>
+> - These instructions will not work for Fedora 31 and higher since those
+>   distribution versions only support cgroups version 2 by default. However,
+>   Kata Containers currently requires cgroups version 1 (on the host side). See
+>   https://github.com/kata-containers/kata-containers/issues/927 for further
+>   details.
 
 ## Install Kata Containers
 
@@ -75,7 +81,7 @@
   - Download the standard `systemd(1)` service file and install to
     `/etc/systemd/system/`:
 
-    - https://raw.githubusercontent.com/containerd/containerd/main/containerd.service
+    - https://raw.githubusercontent.com/containerd/containerd/master/containerd.service
 
     > **Notes:**
     >

docs/install/kata-containers-3.0-rust-runtime-installation-guide.md

@@ -1,101 +0,0 @@
-# Kata Containers 3.0 rust runtime installation
-The following is an overview of the different installation methods available. 
-
-## Prerequisites
-
-Kata Containers 3.0 rust runtime requires nested virtualization or bare metal. Check 
-[hardware requirements](/src/runtime/README.md#hardware-requirements) to see if your system is capable of running Kata 
-Containers.
-
-### Platform support
-
-Kata Containers 3.0 rust runtime currently runs on 64-bit systems supporting the following
-architectures:
-
-> **Notes:**
-> For other architectures, see https://github.com/kata-containers/kata-containers/issues/4320
-
-| Architecture | Virtualization technology |
-|-|-|
-| `x86_64`| [Intel](https://www.intel.com) VT-x |
-| `aarch64` ("`arm64`")| [ARM](https://www.arm.com) Hyp |
-
-## Packaged installation methods
-
-| Installation method                                  | Description                                                                                  | Automatic updates | Use case                                                                                      | Availability
-|------------------------------------------------------|----------------------------------------------------------------------------------------------|-------------------|-----------------------------------------------------------------------------------------------|----------- |
-| [Using kata-deploy](#kata-deploy-installation)       | The preferred way to deploy the Kata Containers distributed binaries on a Kubernetes cluster | **No!**           | Best way to give it a try on kata-containers on an already up and running Kubernetes cluster. | No |
-| [Using official distro packages](#official-packages) | Kata packages provided by Linux distributions official repositories                          | yes               | Recommended for most users. | No |                                                                   
-| [Using snap](#snap-installation)                     | Easy to install                                                                              | yes               | Good alternative to official distro packages.                                                 | No |
-| [Automatic](#automatic-installation)                 | Run a single command to install a full system                                                | **No!**           | For those wanting the latest release quickly.                                                 | No |
-| [Manual](#manual-installation)                       | Follow a guide step-by-step to install a working system                                      | **No!**           | For those who want the latest release with more control.                                      | No |
-| [Build from source](#build-from-source-installation) | Build the software components manually                                                       | **No!**           | Power users and developers only.  | Yes |              
-
-### Kata Deploy Installation
-`ToDo`
-### Official packages
-`ToDo`
-### Snap Installation
-`ToDo`
-### Automatic Installation
-`ToDo`
-### Manual Installation
-`ToDo`
-
-## Build from source installation
-
-### Rust Environment Set Up
-
-* Download `Rustup` and install  `Rust`
-    > **Notes:**
-    > Rust version 1.58 is needed
-
-    Example for `x86_64`
-    ```
-    $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-    $ source $HOME/.cargo/env
-    $ rustup install 1.58
-    $ rustup default 1.58-x86_64-unknown-linux-gnu
-    ```
-
-* Musl support for fully static binary
-    
-    Example for `x86_64`
-    ```
-    $ rustup target add x86_64-unknown-linux-musl
-    ```
-* [Musl `libc`](http://musl.libc.org/) install
-
-    Example for musl 1.2.3
-    ```
-    $ curl -O https://git.musl-libc.org/cgit/musl/snapshot/musl-1.2.3.tar.gz
-    $ tar vxf musl-1.2.3.tar.gz
-    $ cd musl-1.2.3/
-    $ ./configure --prefix=/usr/local/
-    $ make && sudo make install
-    ```
-
-
-### Install Kata 3.0 Rust Runtime Shim
-
-```
-$ git clone https://github.com/kata-containers/kata-containers.git
-$ cd kata-containers/src/runtime-rs
-$ make && sudo make install
-```
-After running the command above, the default config file `configuration.toml` will be installed under `/usr/share/defaults/kata-containers/`,  the binary file `containerd-shim-kata-v2` will be installed under `/user/local/bin` .
-
-### Build Kata Containers Kernel
-Follow the [Kernel installation guide](/tools/packaging/kernel/README.md).
-
-### Build Kata Rootfs
-Follow the [Rootfs installation guide](../../tools/osbuilder/rootfs-builder/README.md).
-
-### Build Kata Image
-Follow the [Image installation guide](../../tools/osbuilder/image-builder/README.md).
-
-### Install Containerd
-
-Follow the [Containerd installation guide](container-manager/containerd/containerd-install.md).
-
-

docs/use-cases/GPU-passthrough-and-Kata.md

@@ -3,4 +3,4 @@
 Kata Containers supports passing certain GPUs from the host into the container. Select the GPU vendor for detailed information:
 
 - [Intel](Intel-GPU-passthrough-and-Kata.md)
-- [NVIDIA](NVIDIA-GPU-passthrough-and-Kata.md)
+- [Nvidia](Nvidia-GPU-passthrough-and-Kata.md)

docs/use-cases/NVIDIA-GPU-passthrough-and-Kata.md

@@ -1,592 +0,0 @@
-# Using NVIDIA GPU device with Kata Containers
-
-An NVIDIA GPU device can be passed to a Kata Containers container using GPU
-passthrough (NVIDIA GPU pass-through mode) as well as GPU mediated passthrough
-(NVIDIA `vGPU` mode).
-
-NVIDIA GPU pass-through mode, an entire physical GPU is directly assigned to one
-VM, bypassing the NVIDIA Virtual GPU Manager. In this mode of operation, the GPU
-is accessed exclusively by the NVIDIA driver running in the VM to which it is
-assigned. The GPU is not shared among VMs.
-
-NVIDIA Virtual GPU (`vGPU`) enables multiple virtual machines (VMs) to have
-simultaneous, direct access to a single physical GPU, using the same NVIDIA
-graphics drivers that are deployed on non-virtualized operating systems. By
-doing this, NVIDIA `vGPU` provides VMs with unparalleled graphics performance,
-compute performance, and application compatibility, together with the
-cost-effectiveness and scalability brought about by sharing a GPU among multiple
-workloads. A `vGPU` can be either time-sliced or Multi-Instance GPU (MIG)-backed
-with [MIG-slices](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/).
-
-| Technology | Description | Behavior | Detail |
-| --- | --- | --- | --- |
-| NVIDIA GPU pass-through mode | GPU passthrough | Physical GPU assigned to a single VM | Direct GPU assignment to VM without limitation |
-| NVIDIA vGPU time-sliced | GPU time-sliced | Physical GPU time-sliced for multiple VMs | Mediated passthrough |
-| NVIDIA vGPU MIG-backed | GPU with MIG-slices | Physical GPU MIG-sliced for multiple VMs | Mediated passthrough |
-
-## Hardware Requirements
-
-NVIDIA GPUs Recommended for Virtualization:
-
-- NVIDIA Tesla (T4, M10, P6, V100 or newer)
-- NVIDIA Quadro RTX 6000/8000
-
-## Host BIOS Requirements
-
-Some hardware requires a larger PCI BARs window, for example, NVIDIA Tesla P100,
-K40m
-
-```sh
-$ lspci -s d0:00.0 -vv | grep Region
-        Region 0: Memory at e7000000 (32-bit, non-prefetchable) [size=16M]
-        Region 1: Memory at 222800000000 (64-bit, prefetchable) [size=32G] # Above 4G
-        Region 3: Memory at 223810000000 (64-bit, prefetchable) [size=32M]
-```
-
-For large BARs devices, MMIO mapping above 4G address space should be `enabled`
-in the PCI configuration of the BIOS.
-
-Some hardware vendors use a different name in BIOS, such as:
-
-- Above 4G Decoding
-- Memory Hole for PCI MMIO
-- Memory Mapped I/O above 4GB
-
-If one is using a GPU based on the Ampere architecture and later additionally
-SR-IOV needs to be enabled for the `vGPU` use-case.
-
-The following steps outline the workflow for using an NVIDIA GPU with Kata.
-
-## Host Kernel Requirements
-
-The following configurations need to be enabled on your host kernel:
-
-- `CONFIG_VFIO`
-- `CONFIG_VFIO_IOMMU_TYPE1`
-- `CONFIG_VFIO_MDEV`
-- `CONFIG_VFIO_MDEV_DEVICE`
-- `CONFIG_VFIO_PCI`
-
-Your host kernel needs to be booted with `intel_iommu=on` on the kernel command
-line.
-
-## Install and configure Kata Containers
-
-To use non-large BARs devices (for example, NVIDIA Tesla T4), you need Kata
-version 1.3.0 or above. Follow the [Kata Containers setup
-instructions](../install/README.md) to install the latest version of Kata.
-
-To use large BARs devices (for example, NVIDIA Tesla P100), you need Kata
-version 1.11.0 or above.
-
-The following configuration in the Kata `configuration.toml` file as shown below
-can work:
-
-Hotplug for PCI devices with small BARs by `acpi_pcihp` (Linux's ACPI PCI
-Hotplug driver):
-
-```sh
-machine_type = "q35"
-
-hotplug_vfio_on_root_bus = false
-```
-
-Hotplug for PCIe devices with large BARs by `pciehp` (Linux's PCIe Hotplug
-driver):
-
-```sh
-machine_type = "q35"
-
-hotplug_vfio_on_root_bus = true
-pcie_root_port = 1
-```
-
-## Build Kata Containers kernel with GPU support
-
-The default guest kernel installed with Kata Containers does not provide GPU
-support. To use an NVIDIA GPU with Kata Containers, you need to build a kernel
-with the necessary GPU support.
-
-The following kernel config options need to be enabled:
-
-```sh
-# Support PCI/PCIe device hotplug (Required for large BARs device)
-CONFIG_HOTPLUG_PCI_PCIE=y
-
-# Support for loading modules (Required for load NVIDIA drivers)
-CONFIG_MODULES=y
-CONFIG_MODULE_UNLOAD=y
-
-# Enable the MMIO access method for PCIe devices (Required for large BARs device)
- CONFIG_PCI_MMCONFIG=y
-```
-
-The following kernel config options need to be disabled:
-
-```sh
-# Disable Open Source NVIDIA driver nouveau
-# It conflicts with NVIDIA official driver
-CONFIG_DRM_NOUVEAU=n
-```
-
-> **Note**: `CONFIG_DRM_NOUVEAU` is normally disabled by default.
-It is worth checking that it is not enabled in your kernel configuration to
-prevent any conflicts.
-
-Build the Kata Containers kernel with the previous config options, using the
-instructions described in [Building Kata Containers
-kernel](../../tools/packaging/kernel). For further details on building and
-installing guest kernels, see [the developer
-guide](../Developer-Guide.md#install-guest-kernel-images).
-
-There is an easy way to build a guest kernel that supports NVIDIA GPU:
-
-```sh
-## Build guest kernel with ../../tools/packaging/kernel
-
-# Prepare (download guest kernel source, generate .config)
-$ ./build-kernel.sh -v 5.15.23 -g nvidia -f setup
-
-# Build guest kernel
-$ ./build-kernel.sh -v 5.15.23 -g nvidia build
-
-# Install guest kernel
-$ sudo -E ./build-kernel.sh -v 5.15.23 -g nvidia install
-```
-
-To build NVIDIA Driver in Kata container, `linux-headers` are required.
-This is a way to generate deb packages for `linux-headers`:
-
-> **Note**:
-> Run `make rpm-pkg` to build the rpm package.
-> Run `make deb-pkg` to build the deb package.
->
-
-```sh
-$ cd kata-linux-5.15.23-89
-$ make deb-pkg
-```
-Before using the new guest kernel, please update the `kernel` parameters in
- `configuration.toml`.
-
-```sh
-kernel = "/usr/share/kata-containers/vmlinuz-nvidia-gpu.container"
-```
-
-## NVIDIA GPU pass-through mode with Kata Containers
-
-Use the following steps to pass an NVIDIA GPU device in pass-through mode with Kata:
-
-1. Find the Bus-Device-Function (BDF) for the GPU device on the host:
-
-   ```sh
-   $ sudo lspci -nn -D | grep -i nvidia
-   0000:d0:00.0 3D controller [0302]: NVIDIA Corporation Device [10de:20b9] (rev a1)
-   ```
-
-   > PCI address `0000:d0:00.0` is assigned to the hardware GPU device.
-   > `10de:20b9` is the device ID of the hardware GPU device.
-
-2. Find the IOMMU group for the GPU device:
-
-   ```sh
-   $ BDF="0000:d0:00.0"
-   $ readlink -e /sys/bus/pci/devices/$BDF/iommu_group
-   ```
-
-   The previous output shows that the GPU belongs to IOMMU group 192. The next
-   step is to bind the GPU to the VFIO-PCI driver.
-
-   ```sh
-   $ BDF="0000:d0:00.0"
-   $ DEV="/sys/bus/pci/devices/$BDF"
-   $ echo "vfio-pci" > $DEV/driver_override
-   $ echo $BDF > $DEV/driver/unbind
-   $ echo $BDF > /sys/bus/pci/drivers_probe
-   # To return the device to the standard driver, we simply clear the
-   # driver_override and reprobe the device, ex:
-   $ echo > $DEV/preferred_driver
-   $ echo $BDF > $DEV/driver/unbind
-   $ echo $BDF > /sys/bus/pci/drivers_probe
-   ```
-
-3. Check the IOMMU group number under `/dev/vfio`:
-
-   ```sh
-   $ ls -l /dev/vfio
-   total 0
-   crw------- 1 zvonkok zvonkok 243,   0 Mar 18 03:06 192
-   crw-rw-rw- 1 root    root     10, 196 Mar 18 02:27 vfio
-   ```
-
-4. Start a Kata container with the GPU device:
-
-   ```sh
-   # You may need to `modprobe vhost-vsock` if you get
-   # host system doesn't support vsock: stat /dev/vhost-vsock
-   $ sudo ctr --debug run --runtime "io.containerd.kata.v2"  --device /dev/vfio/192  --rm -t  "docker.io/library/archlinux:latest" arch uname -r
-   ```
-
-5. Run `lspci` within the container to verify the GPU device is seen in the list
-   of the PCI devices. Note the vendor-device id of the GPU (`10de:20b9`) in the `lspci` output.
-
-   ```sh
-   $ sudo ctr --debug run --runtime "io.containerd.kata.v2"  --device /dev/vfio/192  --rm -t  "docker.io/library/archlinux:latest" arch sh -c "lspci -nn | grep '10de:20b9'"
-   ```
-
-6. Additionally, you can check the PCI BARs space of ​​the NVIDIA GPU device in the container:
-
-   ```sh
-   $ sudo ctr --debug run --runtime "io.containerd.kata.v2"  --device /dev/vfio/192  --rm -t  "docker.io/library/archlinux:latest" arch sh -c "lspci -s 02:00.0 -vv | grep Region"
-   ```
-
-   > **Note**: If you see a message similar to the above, the BAR space of the NVIDIA
-   > GPU has been successfully allocated.
-
-## NVIDIA vGPU mode with Kata Containers
-
-NVIDIA vGPU is a licensed product on all supported GPU boards. A software license
-is required to enable all vGPU features within the guest VM. NVIDIA vGPU manager
-needs to be installed on the host to configure GPUs in vGPU mode. See [NVIDIA Virtual GPU Software Documentation v14.0 through 14.1](https://docs.nvidia.com/grid/14.0/) for more details.
-
-### NVIDIA vGPU time-sliced
-
-In the time-sliced mode, the GPU is not partitioned and the workload uses the
-whole GPU and shares access to the GPU engines. Processes are scheduled in
-series. The best effort scheduler is the default one and can be exchanged by
-other scheduling policies see the documentation above how to do that.
-
-Beware if you had `MIG` enabled before to disable `MIG` on the GPU if you want
-to use `time-sliced` `vGPU`.
-
-```sh
-$ sudo nvidia-smi -mig 0
-```
-
-Enable the virtual functions for the physical GPU in the `sysfs` file system.
-
-```sh
-$ sudo /usr/lib/nvidia/sriov-manage -e 0000:41:00.0
-```
-
-Get the `BDF` of the available virtual function on the GPU, and choose one for the
-following steps.
-
-```sh
-$ cd /sys/bus/pci/devices/0000:41:00.0/
-$ ls -l |  grep virtfn
-```
-
-#### List all available vGPU instances
-
-The following shell snippet will walk the `sysfs` and only print instances
-that are available, that can be created.
-
-```sh
-# The 00.0 is often the PF of the device the VFs will have the funciont in the
-# BDF incremented by some values so e.g. the very first VF is 0000:41:00.4
-
-cd /sys/bus/pci/devices/0000:41:00.0/
-
-for vf in $(ls -d virtfn*)
-do
-        BDF=$(basename $(readlink -f $vf))
-        for md in $(ls -d $vf/mdev_supported_types/*)
-        do
-                AVAIL=$(cat $md/available_instances)
-                NAME=$(cat $md/name)
-                DIR=$(basename $md)
-
-                if [ $AVAIL -gt 0 ]; then
-                        echo "| BDF          | INSTANCES | NAME           | DIR        |"
-                        echo "+--------------+-----------+----------------+------------+"
-                        printf "| %12s |%10d |%15s | %10s |\n\n" "$BDF" "$AVAIL" "$NAME" "$DIR"
-                fi
-
-        done
-done
-```
-
-If there are available instances you get something like this (for the first VF),
-beware that the output is highly dependent on the GPU you have, if there is no
-output check again if `MIG` is really disabled.
-
-```sh
-| BDF          | INSTANCES | NAME           | DIR        |
-+--------------+-----------+----------------+------------+
-| 0000:41:00.4 |         1 |  GRID A100D-4C | nvidia-692 |
-
-| BDF          | INSTANCES | NAME           | DIR        |
-+--------------+-----------+----------------+------------+
-| 0000:41:00.4 |         1 |  GRID A100D-8C | nvidia-693 |
-
-| BDF          | INSTANCES | NAME           | DIR        |
-+--------------+-----------+----------------+------------+
-| 0000:41:00.4 |         1 | GRID A100D-10C | nvidia-694 |
-
-| BDF          | INSTANCES | NAME           | DIR        |
-+--------------+-----------+----------------+------------+
-| 0000:41:00.4 |         1 | GRID A100D-16C | nvidia-695 |
-
-| BDF          | INSTANCES | NAME           | DIR        |
-+--------------+-----------+----------------+------------+
-| 0000:41:00.4 |         1 | GRID A100D-20C | nvidia-696 |
-
-| BDF          | INSTANCES | NAME           | DIR        |
-+--------------+-----------+----------------+------------+
-| 0000:41:00.4 |         1 | GRID A100D-40C | nvidia-697 |
-
-| BDF          | INSTANCES | NAME           | DIR        |
-+--------------+-----------+----------------+------------+
-| 0000:41:00.4 |         1 | GRID A100D-80C | nvidia-698 |
-
-```
-
-Change to the `mdev_supported_types` directory for the virtual function on which
-you want to create the `vGPU`. Taking the first output as an example:
-
-```sh
-$ cd virtfn0/mdev_supported_types/nvidia-692
-$ UUIDGEN=$(uuidgen)
-$ sudo bash -c "echo $UUIDGEN > create"
-```
-
-Confirm that the `vGPU` was created. You should see the `UUID` pointing to a
-subdirectory of the `sysfs` space.
-
-```sh
-$ ls -l /sys/bus/mdev/devices/
-```
-
-Get the `IOMMU` group number and verify there is a `VFIO` device created to use
-with Kata.
-
-```sh
-$ ls -l /sys/bus/mdev/devices/*/
-$ ls -l /dev/vfio
-```
-
-Use the `VFIO` device created in the same way as in the pass-through use-case.
-Beware that the guest needs the NVIDIA guest drivers, so one would need to build
-a new guest `OS` image.
-
-### NVIDIA vGPU MIG-backed
-
-We're not going into detail what `MIG` is but briefly it is a technology to
-partition the hardware into independent instances with guaranteed quality of
-service. For more details see [NVIDIA Multi-Instance GPU User Guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/).
-
-First enable `MIG` mode for a GPU, depending on the platform you're running
-a reboot would be necessary. Some platforms support GPU reset.
-
-```sh
-$ sudo nvidia-smi -mig 1
-```
-
-If the platform supports a GPU reset one can run, otherwise you will get a
-warning to reboot the server.
-
-```sh
-$ sudo nvidia-smi --gpu-reset
-```
-
-The driver per default provides a number of profiles that users can opt-in when
-configuring the MIG feature.
-
-```sh
-$ sudo nvidia-smi mig -lgip
-+-----------------------------------------------------------------------------+
-| GPU instance profiles:                                                      |
-| GPU   Name             ID    Instances   Memory     P2P    SM    DEC   ENC  |
-|                              Free/Total   GiB              CE    JPEG  OFA  |
-|=============================================================================|
-|   0  MIG 1g.10gb       19     7/7        9.50       No     14     0     0   |
-|                                                             1     0     0   |
-+-----------------------------------------------------------------------------+
-|   0  MIG 1g.10gb+me    20     1/1        9.50       No     14     1     0   |
-|                                                             1     1     1   |
-+-----------------------------------------------------------------------------+
-|   0  MIG 2g.20gb       14     3/3        19.50      No     28     1     0   |
-|                                                             2     0     0   |
-+-----------------------------------------------------------------------------+
-                              ...
-```
-
-Create the GPU instances that correspond to the `vGPU` types of the `MIG-backed`
-`vGPUs` that you will create [NVIDIA A100 PCIe 80GB Virtual GPU Types](https://docs.nvidia.com/grid/13.0/grid-vgpu-user-guide/index.html#vgpu-types-nvidia-a100-pcie-80gb).
-
-```sh
-# MIG 1g.10gb --> vGPU A100D-1-10C
-$ sudo nvidia-smi mig -cgi 19
-```
-
-List the GPU instances and get the GPU instance id to create the compute
-instance.
-
-```sh
-$ sudo nvidia-smi mig -lgi # list the created GPU instances
-$ sudo nvidia-smi mig -cci -gi 9 # each GPU instance can have several compute
-                                 # instances. Instance -> Workload
-```
-
-Verify that the compute instances were created within the GPU instance
-
-```sh
-$ nvidia-smi
-                              ... snip ...
-+-----------------------------------------------------------------------------+
-| MIG devices:                                                                |
-+------------------+----------------------+-----------+-----------------------+
-| GPU  GI  CI  MIG |         Memory-Usage |        Vol|         Shared        |
-|      ID  ID  Dev |           BAR1-Usage | SM     Unc| CE  ENC  DEC  OFA  JPG|
-|                  |                      |        ECC|                       |
-|==================+======================+===========+=======================|
-|  0    9   0   0  |      0MiB /  9728MiB | 14      0 |  1   0    0    0    0 |
-|                  |      0MiB /  4095MiB |           |                       |
-+------------------+----------------------+-----------+-----------------------+
-                              ... snip ...
-```
-
-We can use the [snippet](#list-all-available-vgpu-instances) from before to list
-the available `vGPU` instances, this time `MIG-backed`.
-
-```sh
-| BDF          | INSTANCES | NAME           | DIR        |
-+--------------+-----------+----------------+------------+
-| 0000:41:00.4 |         1 |GRID A100D-1-10C | nvidia-699 |
-
-| BDF          | INSTANCES | NAME           | DIR        |
-+--------------+-----------+----------------+------------+
-| 0000:41:00.5 |         1 |GRID A100D-1-10C | nvidia-699 |
-
-| BDF          | INSTANCES | NAME           | DIR        |
-+--------------+-----------+----------------+------------+
-| 0000:41:01.6 |         1 |GRID A100D-1-10C | nvidia-699 |
-                       ... snip ...
-```
-
-Repeat the steps after the [snippet](#list-all-available-vgpu-instances) listing
-to create the corresponding `mdev` device and use the guest `OS` created in the
-previous section with `time-sliced` `vGPUs`.
-
-## Install NVIDIA Driver + Toolkit in Kata Containers Guest OS
-
-Consult the [Developer-Guide](https://github.com/kata-containers/kata-containers/blob/main/docs/Developer-Guide.md#create-a-rootfs-image) on how to create a
-rootfs base image for a distribution of your choice. This is going to be used as
-a base for a NVIDIA enabled guest OS. Use the `EXTRA_PKGS` variable to install
-all the needed packages to compile the drivers. Also copy the kernel development
-packages from the previous `make deb-pkg` into `$ROOTFS_DIR`.
-
-```sh
-export EXTRA_PKGS="gcc make curl gnupg"
-```
-
-Having the `$ROOTFS_DIR` exported in the previous step we can now install all the
-needed parts in the guest OS. In this case, we have an Ubuntu based rootfs.
-
-First off all mount the special filesystems into the rootfs
-
-```sh
-$ sudo mount -t sysfs -o ro none ${ROOTFS_DIR}/sys
-$ sudo mount -t proc -o ro none ${ROOTFS_DIR}/proc
-$ sudo mount -t tmpfs none ${ROOTFS_DIR}/tmp
-$ sudo mount -o bind,ro /dev ${ROOTFS_DIR}/dev
-$ sudo mount -t devpts none ${ROOTFS_DIR}/dev/pts
-```
-
-Now we can enter `chroot`
-
-```sh
-$ sudo chroot ${ROOTFS_DIR}
-```
-
-Inside the rootfs one is going to install the drivers and toolkit to enable the
-easy creation of GPU containers with Kata. We can also use this rootfs for any
-other container not specifically only for GPUs.
-
-As a prerequisite install the copied kernel development packages
-
-```sh
-$ sudo dpkg -i *.deb
-```
-
-Get the driver run file, since we need to build the driver against a kernel that
-is not running on the host we need the ability to specify the exact version we
-want the driver to build against. Take the kernel version one used for building
-the NVIDIA kernel (`5.15.23-nvidia-gpu`).
-
-```sh
-$ wget https://us.download.nvidia.com/XFree86/Linux-x86_64/510.54/NVIDIA-Linux-x86_64-510.54.run
-$ chmod +x NVIDIA-Linux-x86_64-510.54.run
-# Extract the source files so we can run the installer with arguments
-$ ./NVIDIA-Linux-x86_64-510.54.run -x
-$ cd NVIDIA-Linux-x86_64-510.54
-$ ./nvidia-installer -k 5.15.23-nvidia-gpu
-```
-
-Having the drivers installed we need to install the toolkit which will take care
-of providing the right bits into the container.
-
-```sh
-$ distribution=$(. /etc/os-release;echo $ID$VERSION_ID)
-$ curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg
-$ curl -s -L https://nvidia.github.io/libnvidia-container/$distribution/libnvidia-container.list | sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list
-$ apt update
-$ apt install nvidia-container-toolkit
-```
-
-Create the hook execution file for Kata:
-
-```
-# Content of $ROOTFS_DIR/usr/share/oci/hooks/prestart/nvidia-container-toolkit.sh
-
-#!/bin/bash -x
-
-/usr/bin/nvidia-container-toolkit -debug $@
-```
-
-As the last step one can do some cleanup of files or package caches. Build the
-rootfs and configure it for use with Kata according to the development guide.
-
-Enable the `guest_hook_path` in Kata's `configuration.toml`
-
-```sh
-guest_hook_path = "/usr/share/oci/hooks"
-```
-
-One has built a NVIDIA rootfs, kernel and now we can run any GPU container
-without installing the drivers into the container. Check NVIDIA device status
-with `nvidia-smi`
-
-```sh
-$  sudo ctr --debug run --runtime "io.containerd.kata.v2"  --device /dev/vfio/192  --rm -t "docker.io/nvidia/cuda:11.6.0-base-ubuntu20.04" cuda nvidia-smi
-Fri Mar 18 10:36:59 2022
-+-----------------------------------------------------------------------------+
-| NVIDIA-SMI 510.54       Driver Version: 510.54       CUDA Version: 11.6     |
-|-------------------------------+----------------------+----------------------+
-| GPU  Name        Persistence-M| Bus-Id        Disp.A | Volatile Uncorr. ECC |
-| Fan  Temp  Perf  Pwr:Usage/Cap|         Memory-Usage | GPU-Util  Compute M. |
-|                               |                      |               MIG M. |
-|===============================+======================+======================|
-|   0  NVIDIA A30X         Off  | 00000000:02:00.0 Off |                    0 |
-| N/A   38C    P0    67W / 230W |      0MiB / 24576MiB |      0%      Default |
-|                               |                      |             Disabled |
-+-------------------------------+----------------------+----------------------+
-
-+-----------------------------------------------------------------------------+
-| Processes:                                                                  |
-|  GPU   GI   CI        PID   Type   Process name                  GPU Memory |
-|        ID   ID                                                   Usage      |
-|=============================================================================|
-|  No running processes found                                                 |
-+-----------------------------------------------------------------------------+
-```
-
-As the last step one can remove the additional packages and files that were added
-to the `$ROOTFS_DIR` to keep it as small as possible.
-
-## References
-
-- [Configuring a VM for GPU Pass-Through by Using the QEMU Command Line](https://docs.nvidia.com/grid/latest/grid-vgpu-user-guide/index.html#using-gpu-pass-through-red-hat-el-qemu-cli)
-- https://gitlab.com/nvidia/container-images/driver/-/tree/master
-- https://github.com/NVIDIA/nvidia-docker/wiki/Driver-containers

docs/use-cases/Nvidia-GPU-passthrough-and-Kata.md

@@ -0,0 +1,293 @@
+# Using Nvidia GPU device with Kata Containers
+
+An Nvidia GPU device can be passed to a Kata Containers container using GPU passthrough
+(Nvidia GPU pass-through mode) as well as GPU mediated passthrough (Nvidia vGPU mode). 
+
+Nvidia GPU pass-through mode, an entire physical GPU is directly assigned to one VM,
+bypassing the Nvidia Virtual GPU Manager. In this mode of operation, the GPU is accessed
+exclusively by the Nvidia driver running in the VM to which it is assigned.
+The GPU is not shared among VMs.
+
+Nvidia Virtual GPU (vGPU) enables multiple virtual machines (VMs) to have simultaneous,
+direct access to a single physical GPU, using the same Nvidia graphics drivers that are
+deployed on non-virtualized operating systems. By doing this, Nvidia vGPU provides VMs
+with unparalleled graphics performance, compute performance, and application compatibility,
+together with the cost-effectiveness and scalability brought about by sharing a GPU
+among multiple workloads.
+
+| Technology | Description | Behaviour | Detail |
+| --- | --- | --- | --- |
+| Nvidia GPU pass-through mode | GPU passthrough | Physical GPU assigned to a single VM | Direct GPU assignment to VM without limitation |
+| Nvidia vGPU mode | GPU sharing | Physical GPU shared by multiple VMs | Mediated passthrough |
+
+## Hardware Requirements
+Nvidia GPUs Recommended for Virtualization:
+
+- Nvidia Tesla (T4, M10, P6, V100 or newer)
+- Nvidia Quadro RTX 6000/8000
+
+## Host BIOS Requirements
+
+Some hardware requires a larger PCI BARs window, for example, Nvidia Tesla P100, K40m
+```
+$ lspci -s 04:00.0 -vv | grep Region
+      Region 0: Memory at c6000000 (32-bit, non-prefetchable) [size=16M]
+      Region 1: Memory at 383800000000 (64-bit, prefetchable) [size=16G] #above 4G
+      Region 3: Memory at 383c00000000 (64-bit, prefetchable) [size=32M]
+```
+
+For large BARs devices, MMIO mapping above 4G address space should be `enabled`
+in the PCI configuration of the BIOS.
+
+Some hardware vendors use different name in BIOS, such as:
+
+- Above 4G Decoding
+- Memory Hole for PCI MMIO
+- Memory Mapped I/O above 4GB
+
+The following steps outline the workflow for using an Nvidia GPU with Kata.
+
+## Host Kernel Requirements
+The following configurations need to be enabled on your host kernel:
+
+- `CONFIG_VFIO`
+- `CONFIG_VFIO_IOMMU_TYPE1`
+- `CONFIG_VFIO_MDEV`
+- `CONFIG_VFIO_MDEV_DEVICE`
+- `CONFIG_VFIO_PCI`
+
+Your host kernel needs to be booted with `intel_iommu=on` on the kernel command line.
+
+## Install and configure Kata Containers
+To use non-large BARs devices (for example, Nvidia Tesla T4), you need Kata version 1.3.0 or above.
+Follow the [Kata Containers setup instructions](../install/README.md)
+to install the latest version of Kata.
+
+To use large BARs devices (for example, Nvidia Tesla P100), you need Kata version 1.11.0 or above.
+
+The following configuration in the Kata `configuration.toml` file as shown below can work:
+
+Hotplug for PCI devices by `acpi_pcihp` (Linux's ACPI PCI Hotplug driver):
+```
+machine_type = "q35"
+
+hotplug_vfio_on_root_bus = false
+```
+
+Hotplug for PCIe devices by `pciehp` (Linux's PCIe Hotplug driver):
+```
+machine_type = "q35"
+
+hotplug_vfio_on_root_bus = true
+pcie_root_port = 1
+```
+
+## Build Kata Containers kernel with GPU support
+The default guest kernel installed with Kata Containers does not provide GPU support.
+To use an Nvidia GPU with Kata Containers, you need to build a kernel with the
+necessary GPU support.
+
+The following kernel config options need to be enabled:
+```
+# Support PCI/PCIe device hotplug (Required for large BARs device)
+CONFIG_HOTPLUG_PCI_PCIE=y
+
+# Support for loading modules (Required for load Nvidia drivers)
+CONFIG_MODULES=y
+CONFIG_MODULE_UNLOAD=y
+
+# Enable the MMIO access method for PCIe devices (Required for large BARs device)
+CONFIG_PCI_MMCONFIG=y
+```
+
+The following kernel config options need to be disabled:
+```
+# Disable Open Source Nvidia driver nouveau
+# It conflicts with Nvidia official driver
+CONFIG_DRM_NOUVEAU=n
+```
+> **Note**: `CONFIG_DRM_NOUVEAU` is normally disabled by default.
+It is worth checking that it is not enabled in your kernel configuration to prevent any conflicts.
+
+
+Build the Kata Containers kernel with the previous config options,
+using the instructions described in [Building Kata Containers kernel](../../tools/packaging/kernel).
+For further details on building and installing guest kernels,
+see [the developer guide](../Developer-Guide.md#install-guest-kernel-images).
+
+There is an easy way to build a guest kernel that supports Nvidia GPU:
+```
+## Build guest kernel with ../../tools/packaging/kernel
+
+# Prepare (download guest kernel source, generate .config)
+$ ./build-kernel.sh -v 4.19.86 -g nvidia -f setup
+
+# Build guest kernel
+$ ./build-kernel.sh -v 4.19.86 -g nvidia build
+
+# Install guest kernel
+$ sudo -E ./build-kernel.sh -v 4.19.86 -g nvidia install
+/usr/share/kata-containers/vmlinux-nvidia-gpu.container -> vmlinux-4.19.86-70-nvidia-gpu
+/usr/share/kata-containers/vmlinuz-nvidia-gpu.container -> vmlinuz-4.19.86-70-nvidia-gpu
+```
+
+To build Nvidia Driver in Kata container, `kernel-devel` is required.  
+This is a way to generate rpm packages for `kernel-devel`:
+```
+$ cd kata-linux-4.19.86-68
+$ make rpm-pkg
+Output RPMs:
+~/rpmbuild/RPMS/x86_64/kernel-devel-4.19.86_nvidia_gpu-1.x86_64.rpm
+```
+> **Note**:
+> - `kernel-devel` should be installed in Kata container before run Nvidia driver installer.
+> - Run `make deb-pkg` to build the deb package.
+
+Before using the new guest kernel, please update the `kernel` parameters in `configuration.toml`.
+```
+kernel = "/usr/share/kata-containers/vmlinuz-nvidia-gpu.container"
+```
+
+## Nvidia GPU pass-through mode with Kata Containers
+Use the following steps to pass an Nvidia GPU device in pass-through mode with Kata:
+
+1. Find the Bus-Device-Function (BDF) for GPU device on host:
+   ```
+   $ sudo lspci -nn -D | grep -i nvidia
+   0000:04:00.0 3D controller [0302]: NVIDIA Corporation Device [10de:15f8] (rev a1)
+   0000:84:00.0 3D controller [0302]: NVIDIA Corporation Device [10de:15f8] (rev a1)
+   ```
+   > PCI address `0000:04:00.0` is assigned to the hardware GPU device.
+   > `10de:15f8` is the device ID of the hardware GPU device.
+
+2. Find the IOMMU group for the GPU device:
+   ```
+   $ BDF="0000:04:00.0"
+   $ readlink -e /sys/bus/pci/devices/$BDF/iommu_group
+   /sys/kernel/iommu_groups/45
+   ```
+   The previous output shows that the GPU belongs to IOMMU group 45.
+
+3. Check the IOMMU group number under `/dev/vfio`:
+   ```
+   $ ls -l /dev/vfio
+   total 0
+   crw------- 1 root root 248,   0 Feb 28 09:57 45
+   crw------- 1 root root 248,   1 Feb 28 09:57 54
+   crw-rw-rw- 1 root root  10, 196 Feb 28 09:57 vfio
+   ```
+
+4. Start a Kata container with GPU device:
+   ```
+   $ sudo docker run -it --runtime=kata-runtime --cap-add=ALL --device /dev/vfio/45 centos /bin/bash
+   ```
+
+5. Run `lspci` within the container to verify the GPU device is seen in the list
+   of the PCI devices. Note the vendor-device id of the GPU (`10de:15f8`) in the `lspci` output.
+   ```
+   $ lspci -nn -D | grep '10de:15f8'
+   0000:01:01.0 3D controller [0302]: NVIDIA Corporation GP100GL [Tesla P100 PCIe 16GB] [10de:15f8] (rev a1)
+   ```
+
+6. Additionally, you can check the PCI BARs space of ​​the Nvidia GPU device in the container:
+   ```
+   $ lspci -s 01:01.0 -vv | grep Region
+		Region 0: Memory at c0000000 (32-bit, non-prefetchable) [disabled] [size=16M]
+		Region 1: Memory at 4400000000 (64-bit, prefetchable) [disabled] [size=16G]
+		Region 3: Memory at 4800000000 (64-bit, prefetchable) [disabled] [size=32M]
+   ```
+   > **Note**: If you see a message similar to the above, the BAR space of the Nvidia
+   > GPU has been successfully allocated.
+
+## Nvidia vGPU mode with Kata Containers
+
+Nvidia vGPU is a licensed product on all supported GPU boards. A software license
+is required to enable all vGPU features within the guest VM.
+
+> **Note**: There is no suitable test environment, so it is not written here.
+
+
+## Install Nvidia Driver in Kata Containers
+Download the official Nvidia driver from
+[https://www.nvidia.com/Download/index.aspx](https://www.nvidia.com/Download/index.aspx),
+for example `NVIDIA-Linux-x86_64-418.87.01.run`.
+
+Install the `kernel-devel`(generated in the previous steps) for guest kernel:
+```
+$ sudo rpm -ivh kernel-devel-4.19.86_gpu-1.x86_64.rpm
+```
+
+Here is an example to extract, compile and install Nvidia driver:
+```
+## Extract
+$ sh ./NVIDIA-Linux-x86_64-418.87.01.run -x
+
+## Compile and install (It will take some time)
+$ cd NVIDIA-Linux-x86_64-418.87.01
+$ sudo ./nvidia-installer -a -q --ui=none \
+ --no-cc-version-check \
+ --no-opengl-files --no-install-libglvnd \
+ --kernel-source-path=/usr/src/kernels/`uname -r`
+```
+
+Or just run one command line:
+```
+$ sudo sh ./NVIDIA-Linux-x86_64-418.87.01.run -a -q --ui=none \
+ --no-cc-version-check \
+ --no-opengl-files --no-install-libglvnd \
+ --kernel-source-path=/usr/src/kernels/`uname -r`
+```
+
+To view detailed logs of the installer:
+```
+$ tail -f /var/log/nvidia-installer.log
+```
+
+Load Nvidia driver module manually
+```
+# Optional（generate modules.dep and map files for Nvidia driver）
+$ sudo depmod
+
+# Load module
+$ sudo modprobe nvidia-drm
+
+# Check module
+$ lsmod | grep nvidia
+nvidia_drm             45056  0
+nvidia_modeset       1093632  1 nvidia_drm
+nvidia              18202624  1 nvidia_modeset
+drm_kms_helper        159744  1 nvidia_drm
+drm                   364544  3 nvidia_drm,drm_kms_helper
+i2c_core               65536  3 nvidia,drm_kms_helper,drm
+ipmi_msghandler        49152  1 nvidia
+```
+
+
+Check Nvidia device status with `nvidia-smi`
+```
+$ nvidia-smi
+Tue Mar  3 00:03:49 2020
++-----------------------------------------------------------------------------+
+| NVIDIA-SMI 418.87.01    Driver Version: 418.87.01    CUDA Version: 10.1     |
+|-------------------------------+----------------------+----------------------+
+| GPU  Name        Persistence-M| Bus-Id        Disp.A | Volatile Uncorr. ECC |
+| Fan  Temp  Perf  Pwr:Usage/Cap|         Memory-Usage | GPU-Util  Compute M. |
+|===============================+======================+======================|
+|   0  Tesla P100-PCIE...  Off  | 00000000:01:01.0 Off |                    0 |
+| N/A   27C    P0    25W / 250W |      0MiB / 16280MiB |      0%      Default |
++-------------------------------+----------------------+----------------------+
+
++-----------------------------------------------------------------------------+
+| Processes:                                                       GPU Memory |
+|  GPU       PID   Type   Process name                             Usage      |
+|=============================================================================|
+|  No running processes found                                                 |
++-----------------------------------------------------------------------------+
+
+```
+
+## References
+
+- [Configuring a VM for GPU Pass-Through by Using the QEMU Command Line](https://docs.nvidia.com/grid/latest/grid-vgpu-user-guide/index.html#using-gpu-pass-through-red-hat-el-qemu-cli)
+- https://gitlab.com/nvidia/container-images/driver/-/tree/master
+- https://github.com/NVIDIA/nvidia-docker/wiki/Driver-containers

docs/use-cases/using-Intel-QAT-and-kata.md

@@ -279,8 +279,8 @@ $ export KERNEL_EXTRAVERSION=$(awk '/^EXTRAVERSION =/{print $NF}' $GOPATH/$LINUX
 $ export KERNEL_ROOTFS_DIR=${KERNEL_MAJOR_VERSION}.${KERNEL_PATHLEVEL}.${KERNEL_SUBLEVEL}${KERNEL_EXTRAVERSION}
 $ cd $QAT_SRC
 $ KERNEL_SOURCE_ROOT=$GOPATH/$LINUX_VER ./configure --enable-icp-sriov=guest
-$ sudo -E make all -j $($(nproc ${CI:+--ignore 1}))
-$ sudo -E make INSTALL_MOD_PATH=$ROOTFS_DIR qat-driver-install -j $($(nproc ${CI:+--ignore 1}))
+$ sudo -E make all -j$(nproc)
+$ sudo -E make INSTALL_MOD_PATH=$ROOTFS_DIR qat-driver-install -j$(nproc)
 ```
 
 The `usdm_drv` module also needs to be copied into the rootfs modules path and
@@ -312,7 +312,7 @@ working properly with the Kata Containers VM.
 
 ### Build OpenSSL Intel® QAT engine container
 
-Use the OpenSSL Intel® QAT [Dockerfile](https://github.com/intel/intel-device-plugins-for-kubernetes/tree/main/demo/openssl-qat-engine) 
+Use the OpenSSL Intel® QAT [Dockerfile](https://github.com/intel/intel-device-plugins-for-kubernetes/tree/master/demo/openssl-qat-engine) 
 to build a container image with an optimized OpenSSL engine for 
 Intel® QAT. Using `docker build` with the Kata Containers runtime can sometimes
 have issues. Therefore, make sure that `runc` is the default Docker container 
@@ -444,7 +444,7 @@ $ sudo docker save -o openssl-qat-engine.tar openssl-qat-engine:latest
 $ sudo ctr -n=k8s.io images import openssl-qat-engine.tar
 ```
 
-The [Intel® QAT Plugin](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/main/cmd/qat_plugin/README.md)
+The [Intel® QAT Plugin](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/master/cmd/qat_plugin/README.md)
 needs to be started so that the virtual functions can be discovered and
 used by Kubernetes. 
 

docs/use-cases/using-Intel-SGX-and-kata.md

@@ -18,13 +18,16 @@ CONFIG_X86_SGX_KVM=y
 
 * Kubernetes cluster configured with:
    * [`kata-deploy`](../../tools/packaging/kata-deploy) based Kata Containers installation
-   * [Intel SGX Kubernetes device plugin](https://github.com/intel/intel-device-plugins-for-kubernetes/tree/main/cmd/sgx_plugin#deploying-with-pre-built-images) and associated components including [operator](https://github.com/intel/intel-device-plugins-for-kubernetes/blob/main/cmd/operator/README.md) and dependencies
+   * [Intel SGX Kubernetes device plugin](https://github.com/intel/intel-device-plugins-for-kubernetes/tree/main/cmd/sgx_plugin#deploying-with-pre-built-images)
 
 > Note: Kata Containers supports creating VM sandboxes with Intel® SGX enabled
 > using [cloud-hypervisor](https://github.com/cloud-hypervisor/cloud-hypervisor/) and [QEMU](https://www.qemu.org/) VMMs only.
 
 ### Kata Containers Configuration
 
+Before running a Kata Container make sure that your version of `crio` or `containerd`
+supports annotations.
+
 For `containerd` check in `/etc/containerd/config.toml` that the list of `pod_annotations` passed
 to the `sandbox` are: `["io.katacontainers.*", "sgx.intel.com/epc"]`.
 
@@ -96,4 +99,4 @@ because socket passthrough is not supported. An alternative is to deploy the `ae
 container.
 * Projects like [Gramine Shielded Containers (GSC)](https://gramine-gsc.readthedocs.io/en/latest/) are
 also known to work. For GSC specifically, the Kata guest kernel needs to have the `CONFIG_NUMA=y`
-enabled and at least one CPU online when running the GSC container. The Kata Containers guest kernel currently has `CONFIG_NUMA=y` enabled by default.
+enabled and at least one CPU online when running the GSC container.

docs/use-cases/using-vpp-and-kata.md

@@ -0,0 +1,76 @@
+# Setup to run VPP
+
+The Data Plane Development Kit (DPDK) is a set of libraries and drivers for
+fast packet processing. Vector Packet Processing (VPP) is a platform
+extensible framework that provides out-of-the-box production quality
+switch and router functionality. VPP is a high performance packet-processing
+stack that can run on commodity CPUs. Enabling VPP with DPDK support can
+yield significant performance improvements over a Linux\* bridge providing a
+switch with DPDK VHOST-USER ports.
+
+For more information about VPP visit their [wiki](https://wiki.fd.io/view/VPP).
+
+## Install and configure Kata Containers
+
+Follow  the [Kata Containers setup instructions](../Developer-Guide.md).
+
+In order to make use of VHOST-USER based interfaces, the container needs to be backed
+by huge pages. `HugePages` support is required for the large memory pool allocation used for
+DPDK packet buffers.  This is a feature which must be configured within the Linux Kernel. See
+[the DPDK documentation](https://doc.dpdk.org/guides/linux_gsg/sys_reqs.html#use-of-hugepages-in-the-linux-environment)
+for details on how to enable for the host. After enabling huge pages support on the host system,
+update the Kata configuration to enable huge page support in the guest kernel:
+
+```
+$ sudo sed -i -e 's/^# *\(enable_hugepages\).*=.*$/\1 = true/g' /usr/share/defaults/kata-containers/configuration.toml
+```
+
+
+## Install VPP
+
+Follow the [VPP installation instructions](https://wiki.fd.io/view/VPP/Installing_VPP_binaries_from_packages).
+
+After a successful installation, your host system is ready to start
+connecting Kata Containers with VPP bridges.
+
+### Install the VPP Docker\* plugin
+
+To create a Docker network and connect Kata Containers easily to that network through
+Docker, install a VPP Docker plugin.
+
+To install the plugin, follow the [plugin installation instructions](https://github.com/clearcontainers/vpp).
+
+This VPP plugin allows the creation of a VPP network. Every container added
+to this network is connected through an L2 bridge-domain provided by VPP.
+
+## Example: Launch two Kata Containers using VPP
+
+To use VPP, use Docker to create a network that makes use of VPP.
+For example:
+
+```
+$ sudo docker network create -d=vpp --ipam-driver=vpp --subnet=192.168.1.0/24 --gateway=192.168.1.1  vpp_net
+```
+
+Test connectivity by launching two containers:
+```
+$ sudo docker run --runtime=kata-runtime --net=vpp_net --ip=192.168.1.2 --mac-address=CA:FE:CA:FE:01:02 -it busybox bash -c "ip a; ip route; sleep 300"
+
+$ sudo docker run --runtime=kata-runtime --net=vpp_net --ip=192.168.1.3 --mac-address=CA:FE:CA:FE:01:03 -it busybox bash -c "ip a; ip route; ping 192.168.1.2"
+```
+
+These commands setup two Kata Containers connected via a VPP L2 bridge
+domain. The first of the two VMs displays the networking details and then
+sleeps providing a period of time for it to be pinged. The second
+VM displays its networking details and then pings the first VM, verifying
+connectivity between them.
+
+After verifying connectivity, cleanup with the following commands:
+
+```
+$ sudo docker kill $(sudo docker ps --no-trunc -aq)
+$ sudo docker rm $(sudo docker ps --no-trunc -aq)
+$ sudo docker network rm vpp_net
+$ sudo service vpp stop
+```
+

snap/README.md

@@ -22,35 +22,21 @@ $ sudo snap install kata-containers --classic
 
 ## Build and install snap image
 
-Run the command below which will use the packaging Makefile to build the snap image:
+Run next command at the root directory of the packaging repository.
 
 ```sh
-$ make -C tools/packaging snap
+$ make snap
 ```
 
-> **Warning:**
->
-> By default, `snapcraft` will create a clean virtual machine
-> environment to build the snap in using the `multipass` tool.
->
-> However, `multipass` is silently disabled when `--destructive-mode` is
-> used.
->
-> Since building the Kata Containers package currently requires
-> `--destructive-mode`, the snap will be built using the host
-> environment. To avoid parts of the build auto-detecting additional
-> features to enable (for example for QEMU), we recommend that you
-> only run the snap build in a minimal host environment.
-
 To install the resulting snap image, snap must be put in [classic mode][3] and the
-security confinement must be disabled (`--classic`). Also since the resulting snap
-has not been signed the verification of signature must be omitted (`--dangerous`).
+security confinement must be disabled (*--classic*). Also since the resulting snap
+has not been signed the verification of signature must be omitted (*--dangerous*).
 
 ```sh
-$ sudo snap install --classic --dangerous "kata-containers_${version}_${arch}.snap"
+$ sudo snap install --classic --dangerous kata-containers_[VERSION]_[ARCH].snap
 ```
 
-Replace `${version}` with the current version of Kata Containers and `${arch}` with
+Replace `VERSION` with the current version of Kata Containers and `ARCH` with
 the system architecture.
 
 ## Configure Kata Containers
@@ -90,12 +76,12 @@ then a new configuration file can be [created](#configure-kata-containers)
 and [configured][7].
 
 [1]: https://docs.snapcraft.io/snaps/intro
-[2]: ../../docs/design/architecture/README.md#root-filesystem-image
+[2]: ../docs/design/architecture/README.md#root-filesystem-image
 [3]: https://docs.snapcraft.io/reference/confinement#classic
-[4]: https://github.com/kata-containers/kata-containers/tree/main/src/runtime#configuration
+[4]: https://github.com/kata-containers/runtime#configuration
 [5]: https://docs.docker.com/engine/reference/commandline/dockerd
-[6]: ../../docs/install/docker/ubuntu-docker-install.md
-[7]: ../../docs/Developer-Guide.md#configure-to-use-initrd-or-rootfs-image
+[6]: ../docs/install/docker/ubuntu-docker-install.md
+[7]: ../docs/Developer-Guide.md#configure-to-use-initrd-or-rootfs-image
 [8]: https://snapcraft.io/kata-containers
-[9]: ../../docs/Developer-Guide.md#run-kata-containers-with-docker
-[10]: ../../docs/Developer-Guide.md#run-kata-containers-with-kubernetes
+[9]: ../docs/Developer-Guide.md#run-kata-containers-with-docker
+[10]: ../docs/Developer-Guide.md#run-kata-containers-with-kubernetes

snap/local/snap-common.sh

@@ -1,114 +0,0 @@
-#!/usr/bin/env bash
-#
-# Copyright (c) 2022 Intel Corporation
-#
-# SPDX-License-Identifier: Apache-2.0
-
-# Description: Idempotent script to be sourced by all parts in a
-#   snapcraft config file.
-
-set -o errexit
-set -o nounset
-set -o pipefail
-
-# XXX: Bash-specific code. zsh doesn't support this option and that *does*
-# matter if this script is run sourced... since it'll be using zsh! ;)
-[ -n "$BASH_VERSION" ] && set -o errtrace
-
-[ -n "${DEBUG:-}" ] && set -o xtrace
-
-die()
-{
-	echo >&2 "ERROR: $0: $*"
-}
-
-[ -n "${SNAPCRAFT_STAGE:-}" ] ||\
-	die "must be sourced from a snapcraft config file"
-
-snap_yq_version=3.4.1
-
-snap_common_install_yq()
-{
-      export yq="${SNAPCRAFT_STAGE}/bin/yq"
-
-      local yq_pkg
-      yq_pkg="github.com/mikefarah/yq"
-
-      local yq_url
-      yq_url="https://${yq_pkg}/releases/download/${snap_yq_version}/yq_${goos}_${goarch}"
-      curl -o "${yq}" -L "${yq_url}"
-      chmod +x "${yq}"
-}
-
-# Function that should be called for each snap "part" in
-# snapcraft.yaml.
-snap_common_main()
-{
-	# Architecture
-	arch="$(uname -m)"
-
-	case "${arch}" in
-		aarch64)
-			goarch="arm64"
-			qemu_arch="${arch}"
-			;;
-
-		ppc64le)
-			goarch="ppc64le"
-			qemu_arch="ppc64"
-			;;
-
-		s390x)
-			goarch="${arch}"
-			qemu_arch="${arch}"
-			;;
-
-		x86_64)
-			goarch="amd64"
-			qemu_arch="${arch}"
-			;;
-
-		*) die "unsupported architecture: ${arch}" ;;
-	esac
-
-	dpkg_arch=$(dpkg --print-architecture)
-
-	# golang
-	#
-	# We need the O/S name in golang format, but since we don't
-	# know if the godeps part has run, we don't know if golang is
-	# available yet, hence fall back to a standard system command.
-	goos="$(go env GOOS &>/dev/null || true)"
-	[ -z "$goos" ] && goos=$(uname -s|tr '[A-Z]' '[a-z]')
-
-	export GOROOT="${SNAPCRAFT_STAGE}"
-	export GOPATH="${GOROOT}/gopath"
-	export GO111MODULE="auto"
-
-	mkdir -p "${GOPATH}/bin"
-	export PATH="${GOPATH}/bin:${PATH}"
-
-	# Proxy
-	export http_proxy="${http_proxy:-}"
-	export https_proxy="${https_proxy:-}"
-
-	# Binaries
-	mkdir -p "${SNAPCRAFT_STAGE}/bin"
-
-	export PATH="$PATH:${SNAPCRAFT_STAGE}/bin"
-
-	# YAML query tool
-	export yq="${SNAPCRAFT_STAGE}/bin/yq"
-
-	# Kata paths
-	export kata_dir=$(printf "%s/src/github.com/%s/%s" \
-		"${GOPATH}" \
-		"${SNAPCRAFT_PROJECT_NAME}" \
-		"${SNAPCRAFT_PROJECT_NAME}")
-
-	export versions_file="${kata_dir}/versions.yaml"
-
-	[ -n "${yq:-}" ] && [ -x "${yq:-}" ] || snap_common_install_yq
-}
-
-snap_common_main

snap/snapcraft.yaml

@@ -1,5 +1,4 @@
 name: kata-containers
-website: https://github.com/kata-containers/kata-containers
 summary: Build lightweight VMs that seamlessly plug into the containers ecosystem
 description: |
   Kata Containers is an open source project and community working to build a
@@ -19,18 +18,20 @@ parts:
       - git
       - git-extras
     override-pull: |
-      source "${SNAPCRAFT_PROJECT_DIR}/snap/local/snap-common.sh"
-
       version="9999"
+      kata_url="https://github.com/kata-containers/kata-containers"
 
-      if echo "${GITHUB_REF:-}" | grep -q -E "^refs/tags"; then
-        version=$(echo ${GITHUB_REF:-} | cut -d/ -f3)
+      if echo "${GITHUB_REF}" | grep -q -E "^refs/tags"; then
+        version=$(echo ${GITHUB_REF} | cut -d/ -f3)
         git checkout ${version}
       fi
 
       snapcraftctl set-grade "stable"
       snapcraftctl set-version "${version}"
 
+      # setup GOPATH - this repo dir should be there
+      export GOPATH=${SNAPCRAFT_STAGE}/gopath
+      kata_dir=${GOPATH}/src/github.com/${SNAPCRAFT_PROJECT_NAME}/${SNAPCRAFT_PROJECT_NAME}
       mkdir -p $(dirname ${kata_dir})
       ln -sf $(realpath "${SNAPCRAFT_STAGE}/..") ${kata_dir}
 
@@ -42,46 +43,31 @@ parts:
     build-packages:
       - curl
     override-build: |
-      source "${SNAPCRAFT_PROJECT_DIR}/snap/local/snap-common.sh"
-
       # put everything in stage
-      cd "${SNAPCRAFT_STAGE}"
+      cd ${SNAPCRAFT_STAGE}
 
-      version="$(${yq} r ${kata_dir}/versions.yaml languages.golang.meta.newest-version)"
+      yq_path="./yq"
+      yq_pkg="github.com/mikefarah/yq"
+      goos="linux"
+      case "$(uname -m)" in
+        aarch64) goarch="arm64";;
+        ppc64le) goarch="ppc64le";;
+        x86_64) goarch="amd64";;
+        s390x) goarch="s390x";;
+        *) echo "unsupported architecture: $(uname -m)"; exit 1;;
+      esac
+
+      yq_version=3.4.1
+      yq_url="https://${yq_pkg}/releases/download/${yq_version}/yq_${goos}_${goarch}"
+      curl -o "${yq_path}" -L "${yq_url}"
+      chmod +x "${yq_path}"
+
+      kata_dir=gopath/src/github.com/${SNAPCRAFT_PROJECT_NAME}/${SNAPCRAFT_PROJECT_NAME}
+      version="$(${yq_path} r ${kata_dir}/versions.yaml languages.golang.meta.newest-version)"
       tarfile="go${version}.${goos}-${goarch}.tar.gz"
       curl -LO https://golang.org/dl/${tarfile}
       tar -xf ${tarfile} --strip-components=1
 
-  rustdeps:
-    after: [metadata]
-    plugin: nil
-    prime:
-      - -*
-    build-packages:
-      - curl
-    override-build: |
-      source "${SNAPCRAFT_PROJECT_DIR}/snap/local/snap-common.sh"
-
-      # put everything in stage
-      cd "${SNAPCRAFT_STAGE}"
-
-      version="$(${yq} r ${kata_dir}/versions.yaml languages.rust.meta.newest-version)"
-      if ! command -v rustup > /dev/null; then
-        curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain ${version}
-      fi
-
-      export PATH=${PATH}:${HOME}/.cargo/bin
-      rustup toolchain install ${version}
-      rustup default ${version}
-      if [ "${arch}" == "ppc64le" ] || [ "${arch}" == "s390x" ] ; then
-        [ "${arch}" == "ppc64le" ] && arch="powerpc64le"
-        rustup target add ${arch}-unknown-linux-gnu
-      else
-        rustup target add ${arch}-unknown-linux-musl
-        $([ "$(whoami)" != "root" ] && echo sudo) ln -sf /usr/bin/g++ /bin/musl-g++
-      fi
-      rustup component add rustfmt
-
   image:
     after: [godeps, qemu, kernel]
     plugin: nil
@@ -94,17 +80,28 @@ parts:
       - uidmap
       - gnupg2
     override-build: |
-      source "${SNAPCRAFT_PROJECT_DIR}/snap/local/snap-common.sh"
+      [ "$(uname -m)" = "ppc64le" ] || [ "$(uname -m)" = "s390x" ] && sudo apt-get --no-install-recommends install -y protobuf-compiler
 
-      [ "${arch}" = "ppc64le" ] || [ "${arch}" = "s390x" ] && sudo apt-get --no-install-recommends install -y protobuf-compiler
+      yq=${SNAPCRAFT_STAGE}/yq
 
+      # set GOPATH
+      export GOPATH=${SNAPCRAFT_STAGE}/gopath
+      kata_dir=${GOPATH}/src/github.com/${SNAPCRAFT_PROJECT_NAME}/${SNAPCRAFT_PROJECT_NAME}
+
+      export GOROOT=${SNAPCRAFT_STAGE}
+      export PATH="${GOROOT}/bin:${PATH}"
+      export GO111MODULE="auto"
+
+      http_proxy=${http_proxy:-""}
+      https_proxy=${https_proxy:-""}
       if [ -n "$http_proxy" ]; then
         echo "Setting proxy $http_proxy"
-        sudo -E systemctl set-environment http_proxy="$http_proxy" || true
-        sudo -E systemctl set-environment https_proxy="$https_proxy" || true
+        sudo -E systemctl set-environment http_proxy=$http_proxy || true
+        sudo -E systemctl set-environment https_proxy=$https_proxy || true
       fi
 
       # Copy yq binary. It's used in the container
+      mkdir -p "${GOPATH}/bin/"
       cp -a "${yq}" "${GOPATH}/bin/"
 
       echo "Unmasking docker service"
@@ -115,54 +112,63 @@ parts:
       echo "Starting docker"
       sudo -E systemctl start docker || true
 
-      cd "${kata_dir}/tools/osbuilder"
+      cd ${kata_dir}/tools/osbuilder
 
       # build image
       export AGENT_INIT=yes
       export USE_DOCKER=1
       export DEBUG=1
+      arch="$(uname -m)"
       initrd_distro=$(${yq} r -X ${kata_dir}/versions.yaml assets.initrd.architecture.${arch}.name)
       image_distro=$(${yq} r -X ${kata_dir}/versions.yaml assets.image.architecture.${arch}.name)
       case "$arch" in
         x86_64)
           # In some build systems it's impossible to build a rootfs image, try with the initrd image
-          sudo -E PATH=$PATH make image DISTRO="${image_distro}" || sudo -E PATH="$PATH" make initrd DISTRO="${initrd_distro}"
+          sudo -E PATH=$PATH make image DISTRO=${image_distro} || sudo -E PATH=$PATH make initrd DISTRO=${initrd_distro}
         ;;
 
         aarch64|ppc64le|s390x)
-          sudo -E PATH="$PATH" make initrd DISTRO="${initrd_distro}"
+          sudo -E PATH=$PATH make initrd DISTRO=${initrd_distro}
         ;;
 
-        *) die "unsupported architecture: ${arch}" ;;
+        *) echo "unsupported architecture: $(uname -m)"; exit 1;;
       esac
 
       # Install image
-      kata_image_dir="${SNAPCRAFT_PART_INSTALL}/usr/share/kata-containers"
-      mkdir -p "${kata_image_dir}"
-      cp kata-containers*.img "${kata_image_dir}"
+      kata_image_dir=${SNAPCRAFT_PART_INSTALL}/usr/share/kata-containers
+      mkdir -p ${kata_image_dir}
+      cp kata-containers*.img ${kata_image_dir}
 
   runtime:
     after: [godeps, image, cloud-hypervisor]
     plugin: nil
     build-attributes: [no-patchelf]
     override-build: |
-      source "${SNAPCRAFT_PROJECT_DIR}/snap/local/snap-common.sh"
+      # set GOPATH
+      export GOPATH=${SNAPCRAFT_STAGE}/gopath
+      export GOROOT=${SNAPCRAFT_STAGE}
+      export PATH="${GOROOT}/bin:${PATH}"
+      export GO111MODULE="auto"
+      kata_dir=${GOPATH}/src/github.com/${SNAPCRAFT_PROJECT_NAME}/${SNAPCRAFT_PROJECT_NAME}
 
-      cd "${kata_dir}/src/runtime"
+      cd ${kata_dir}/src/runtime
 
-      qemu_cmd="qemu-system-${qemu_arch}"
+      # setup arch
+      arch=$(uname -m)
+      if [ ${arch} = "ppc64le" ]; then
+        arch="ppc64"
+      fi
 
       # build and install runtime
       make \
-        PREFIX="/snap/${SNAPCRAFT_PROJECT_NAME}/current/usr" \
+        PREFIX=/snap/${SNAPCRAFT_PROJECT_NAME}/current/usr \
         SKIP_GO_VERSION_CHECK=1 \
-        QEMUCMD="${qemu_cmd}"
-
+        QEMUCMD=qemu-system-$arch
       make install \
         PREFIX=/usr \
-        DESTDIR="${SNAPCRAFT_PART_INSTALL}" \
+        DESTDIR=${SNAPCRAFT_PART_INSTALL} \
         SKIP_GO_VERSION_CHECK=1 \
-        QEMUCMD="${qemu_cmd}"
+        QEMUCMD=qemu-system-$arch
 
       if [ ! -f ${SNAPCRAFT_PART_INSTALL}/../../image/install/usr/share/kata-containers/kata-containers.img ]; then
         sed -i -e "s|^image =.*|initrd = \"/snap/${SNAPCRAFT_PROJECT_NAME}/current/usr/share/kata-containers/kata-containers-initrd.img\"|" \
@@ -179,37 +185,44 @@ parts:
       - bison
       - flex
     override-build: |
-      source "${SNAPCRAFT_PROJECT_DIR}/snap/local/snap-common.sh"
-
+      yq=${SNAPCRAFT_STAGE}/yq
+      export PATH="${PATH}:${SNAPCRAFT_STAGE}"
+      export GOPATH=${SNAPCRAFT_STAGE}/gopath
+      kata_dir=${GOPATH}/src/github.com/${SNAPCRAFT_PROJECT_NAME}/${SNAPCRAFT_PROJECT_NAME}
+      versions_file="${kata_dir}/versions.yaml"
       kernel_version="$(${yq} r $versions_file assets.kernel.version)"
       #Remove extra 'v'
-      kernel_version="${kernel_version#v}"
+      kernel_version=${kernel_version#v}
 
-      [ "${arch}" = "s390x" ] && sudo apt-get --no-install-recommends install -y libssl-dev
+      [ "$(uname -m)" = "s390x" ] && sudo apt-get --no-install-recommends install -y libssl-dev
 
-      cd "${kata_dir}/tools/packaging/kernel"
+      export GOPATH=${SNAPCRAFT_STAGE}/gopath
+      export GO111MODULE="auto"
+      kata_dir=${GOPATH}/src/github.com/${SNAPCRAFT_PROJECT_NAME}/${SNAPCRAFT_PROJECT_NAME}
+
+      cd ${kata_dir}/tools/packaging/kernel
       kernel_dir_prefix="kata-linux-"
 
       # Setup and build kernel
-      ./build-kernel.sh -v "${kernel_version}" -d setup
+      ./build-kernel.sh -v ${kernel_version} -d setup
       cd ${kernel_dir_prefix}*
-      make -j $(nproc ${CI:+--ignore 1}) EXTRAVERSION=".container"
+      make -j $(($(nproc)-1)) EXTRAVERSION=".container"
 
-      kernel_suffix="${kernel_version}.container"
-      kata_kernel_dir="${SNAPCRAFT_PART_INSTALL}/usr/share/kata-containers"
-      mkdir -p "${kata_kernel_dir}"
+      kernel_suffix=${kernel_version}.container
+      kata_kernel_dir=${SNAPCRAFT_PART_INSTALL}/usr/share/kata-containers
+      mkdir -p ${kata_kernel_dir}
 
       # Install bz kernel
-      make install INSTALL_PATH="${kata_kernel_dir}" EXTRAVERSION=".container" || true
-      vmlinuz_name="vmlinuz-${kernel_suffix}"
-      ln -sf "${vmlinuz_name}" "${kata_kernel_dir}/vmlinuz.container"
+      make install INSTALL_PATH=${kata_kernel_dir} EXTRAVERSION=".container" || true
+      vmlinuz_name=vmlinuz-${kernel_suffix}
+      ln -sf ${vmlinuz_name} ${kata_kernel_dir}/vmlinuz.container
 
       # Install raw kernel
-      vmlinux_path="vmlinux"
-      [ "${arch}" = "s390x" ] && vmlinux_path="arch/s390/boot/compressed/vmlinux"
-      vmlinux_name="vmlinux-${kernel_suffix}"
-      cp "${vmlinux_path}" "${kata_kernel_dir}/${vmlinux_name}"
-      ln -sf "${vmlinux_name}" "${kata_kernel_dir}/vmlinux.container"
+      vmlinux_path=vmlinux
+      [ "$(uname -m)" = "s390x" ] && vmlinux_path=arch/s390/boot/compressed/vmlinux
+      vmlinux_name=vmlinux-${kernel_suffix}
+      cp ${vmlinux_path} ${kata_kernel_dir}/${vmlinux_name}
+      ln -sf ${vmlinux_name} ${kata_kernel_dir}/vmlinux.container
 
   qemu:
     plugin: make
@@ -236,8 +249,12 @@ parts:
       - libselinux1-dev
       - ninja-build
     override-build: |
-      source "${SNAPCRAFT_PROJECT_DIR}/snap/local/snap-common.sh"
+      yq=${SNAPCRAFT_STAGE}/yq
+      export GOPATH=${SNAPCRAFT_STAGE}/gopath
+      export GO111MODULE="auto"
+      kata_dir=${GOPATH}/src/github.com/${SNAPCRAFT_PROJECT_NAME}/${SNAPCRAFT_PROJECT_NAME}
 
+      versions_file="${kata_dir}/versions.yaml"
       branch="$(${yq} r ${versions_file} assets.hypervisor.qemu.version)"
       url="$(${yq} r ${versions_file} assets.hypervisor.qemu.url)"
       commit=""
@@ -245,11 +262,11 @@ parts:
       patches_version_dir="${kata_dir}/tools/packaging/qemu/patches/tag_patches/${branch}"
 
       # download source
-      qemu_dir="${SNAPCRAFT_STAGE}/qemu"
+      qemu_dir=${SNAPCRAFT_STAGE}/qemu
       rm -rf "${qemu_dir}"
       git clone --depth 1 --branch ${branch} --single-branch ${url} "${qemu_dir}"
-      cd "${qemu_dir}"
-      [ -z "${commit}" ] || git checkout "${commit}"
+      cd ${qemu_dir}
+      [ -z "${commit}" ] || git checkout ${commit}
 
       [ -n "$(ls -A ui/keycodemapdb)" ] || git clone --depth 1 https://github.com/qemu/keycodemapdb ui/keycodemapdb/
       [ -n "$(ls -A capstone)" ] || git clone --depth 1 https://github.com/qemu/capstone capstone
@@ -260,10 +277,10 @@ parts:
       ${kata_dir}/tools/packaging/scripts/apply_patches.sh "${patches_version_dir}"
 
       # Only x86_64 supports libpmem
-      [ "${arch}" = "x86_64" ] && sudo apt-get --no-install-recommends install -y apt-utils ca-certificates libpmem-dev
+      [ "$(uname -m)" = "x86_64" ] && sudo apt-get --no-install-recommends install -y apt-utils ca-certificates libpmem-dev
 
-      configure_hypervisor="${kata_dir}/tools/packaging/scripts/configure-hypervisor.sh"
-      chmod +x "${configure_hypervisor}"
+      configure_hypervisor=${kata_dir}/tools/packaging/scripts/configure-hypervisor.sh
+      chmod +x ${configure_hypervisor}
       # static build. The --prefix, --libdir, --libexecdir, --datadir arguments are
       # based on PREFIX and set by configure-hypervisor.sh
       echo "$(PREFIX=/snap/${SNAPCRAFT_PROJECT_NAME}/current/usr ${configure_hypervisor} -s kata-qemu) \
@@ -273,17 +290,17 @@ parts:
       # Copy QEMU configurations (Kconfigs)
       case "${branch}" in
       "v5.1.0")
-        cp -a "${kata_dir}"/tools/packaging/qemu/default-configs/* default-configs
+        cp -a ${kata_dir}/tools/packaging/qemu/default-configs/* default-configs
         ;;
 
       *)
-        cp -a "${kata_dir}"/tools/packaging/qemu/default-configs/* configs/devices/
+        cp -a ${kata_dir}/tools/packaging/qemu/default-configs/* configs/devices/
         ;;
       esac
 
       # build and install
-      make -j $(nproc ${CI:+--ignore 1})
-      make install DESTDIR="${SNAPCRAFT_PART_INSTALL}"
+      make -j $(($(nproc)-1))
+      make install DESTDIR=${SNAPCRAFT_PART_INSTALL}
     prime:
       - -snap/
       - -usr/bin/qemu-ga
@@ -299,67 +316,26 @@ parts:
       # Hack: move qemu to /
       "snap/kata-containers/current/": "./"
 
-  virtiofsd:
-    plugin: nil
-    after: [godeps, rustdeps]
-    override-build: |
-      source "${SNAPCRAFT_PROJECT_DIR}/snap/local/snap-common.sh"
-
-      # Currently, powerpc makes use of the QEMU's C implementation.
-      # The other platforms make use of the new rust virtiofsd.
-      #
-      # See "tools/packaging/scripts/configure-hypervisor.sh".
-      if [ "${arch}" == "ppc64le" ]
-      then
-          echo "INFO: Building QEMU's C version of virtiofsd"
-          # Handled by the 'qemu' part, so nothing more to do here.
-          exit 0
-      else
-          echo "INFO: Building rust version of virtiofsd"
-      fi
-
-      cd "${kata_dir}"
-
-      export PATH=${PATH}:${HOME}/.cargo/bin
-      # Download the rust implementation of virtiofsd
-      tools/packaging/static-build/virtiofsd/build-static-virtiofsd.sh
-      sudo install \
-        --owner='root' \
-        --group='root' \
-        --mode=0755 \
-        -D \
-        --target-directory="${SNAPCRAFT_PART_INSTALL}/usr/libexec/" \
-        virtiofsd/virtiofsd
-
   cloud-hypervisor:
     plugin: nil
     after: [godeps]
     override-build: |
-      source "${SNAPCRAFT_PROJECT_DIR}/snap/local/snap-common.sh"
-
-      if [ "${arch}" == "aarch64" ] || [ "${arch}" == "x86_64" ]; then
+      arch=$(uname -m)
+      if [ "{$arch}" == "aarch64" ] || [ "${arch}" == "x64_64" ]; then 
           sudo apt-get -y update
           sudo apt-get -y install ca-certificates curl gnupg lsb-release
-          curl -fsSL https://download.docker.com/linux/ubuntu/gpg |\
-              sudo gpg --batch --yes --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
-          distro_codename=$(lsb_release -cs)
-          echo "deb [arch=${dpkg_arch} signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu ${distro_codename} stable" |\
-              sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+          curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --batch --yes --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
+          echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
           sudo apt-get -y update
           sudo apt-get -y install docker-ce docker-ce-cli containerd.io
           sudo systemctl start docker.socket
 
-          cd "${SNAPCRAFT_PROJECT_DIR}"
+          export GOPATH=${SNAPCRAFT_STAGE}/gopath
+          kata_dir=${GOPATH}/src/github.com/${SNAPCRAFT_PROJECT_NAME}/${SNAPCRAFT_PROJECT_NAME}
+          cd ${kata_dir}
           sudo -E NO_TTY=true make cloud-hypervisor-tarball
-
-          tarfile="${SNAPCRAFT_PROJECT_DIR}/tools/packaging/kata-deploy/local-build/build/kata-static-cloud-hypervisor.tar.xz"
-          tmpdir=$(mktemp -d)
-
-          tar -xvJpf "${tarfile}" -C "${tmpdir}"
-
-          install -D "${tmpdir}/opt/kata/bin/cloud-hypervisor" "${SNAPCRAFT_PART_INSTALL}/usr/bin/cloud-hypervisor"
-
-          rm -rf "${tmpdir}"
+          tar xvJpf build/kata-static-cloud-hypervisor.tar.xz -C /tmp/
+          install -D /tmp/opt/kata/bin/cloud-hypervisor ${SNAPCRAFT_PART_INSTALL}/usr/bin/cloud-hypervisor
       fi
 
 apps:

src/agent/Cargo.toml

@@ -7,20 +7,19 @@ edition = "2018"
 [dependencies]
 oci = { path = "../libs/oci" }
 rustjail = { path = "rustjail" }
-protocols = { path = "../libs/protocols", features = ["async"] }
+protocols = { path = "../libs/protocols" }
 lazy_static = "1.3.0"
-ttrpc = { version = "0.6.0", features = ["async"], default-features = false }
-protobuf = "2.27.0"
+ttrpc = { version = "0.5.0", features = ["async", "protobuf-codec"], default-features = false }
+protobuf = "=2.14.0"
 libc = "0.2.58"
-nix = "0.24.1"
+nix = "0.23.0"
 capctl = "0.2.0"
 serde_json = "1.0.39"
 scan_fmt = "0.2.3"
 scopeguard = "1.0.0"
 thiserror = "1.0.26"
-regex = "1.5.5"
+regex = "1.5.4"
 serial_test = "0.5.1"
-kata-sys-util = { path = "../libs/kata-sys-util" }
 sysinfo = "0.23.0"
 
 # Async helpers
@@ -33,7 +32,7 @@ tokio = { version = "1.14.0", features = ["full"] }
 tokio-vsock = "0.3.1"
 
 netlink-sys = { version = "0.7.0", features = ["tokio_socket",]}
-rtnetlink = "0.11.0"
+rtnetlink = "0.8.0"
 netlink-packet-utils = "0.4.1"
 ipnetwork = "0.17.0"
 
@@ -77,8 +76,3 @@ lto = true
 
 [features]
 seccomp = ["rustjail/seccomp"]
-standard-oci-runtime = ["rustjail/standard-oci-runtime"]
-
-[[bin]]
-name = "kata-agent"
-path = "src/main.rs"

src/agent/Makefile

@@ -14,6 +14,10 @@ PROJECT_COMPONENT = kata-agent
 
 TARGET = $(PROJECT_COMPONENT)
 
+SOURCES := \
+  $(shell find . 2>&1 | grep -E '.*\.rs$$') \
+  Cargo.toml
+
 VERSION_FILE := ./VERSION
 VERSION := $(shell grep -v ^\# $(VERSION_FILE))
 COMMIT_NO := $(shell git rev-parse HEAD 2>/dev/null || true)
@@ -33,16 +37,8 @@ ifeq ($(SECCOMP),yes)
     override EXTRA_RUSTFEATURES += seccomp
 endif
 
-##VAR STANDARD_OCI_RUNTIME=yes|no define if agent enables standard oci runtime feature
-STANDARD_OCI_RUNTIME := no
-
-# Enable standard oci runtime feature of rust build
-ifeq ($(STANDARD_OCI_RUNTIME),yes)
-    override EXTRA_RUSTFEATURES += standard-oci-runtime
-endif
-
 ifneq ($(EXTRA_RUSTFEATURES),)
-    override EXTRA_RUSTFEATURES := --features "$(EXTRA_RUSTFEATURES)"
+    override EXTRA_RUSTFEATURES := --features $(EXTRA_RUSTFEATURES)
 endif
 
 include ../../utils.mk
@@ -107,17 +103,20 @@ endef
 ##TARGET default: build code
 default: $(TARGET) show-header
 
-$(TARGET): $(GENERATED_CODE) $(TARGET_PATH)
+$(TARGET): $(GENERATED_CODE) logging-crate-tests $(TARGET_PATH)
 
-$(TARGET_PATH): show-summary
-	@RUSTFLAGS="$(EXTRA_RUSTFLAGS) --deny warnings" cargo build --target $(TRIPLE) $(if $(findstring release,$(BUILD_TYPE)),--release) $(EXTRA_RUSTFEATURES)
+logging-crate-tests:
+	make -C $(CWD)/../libs/logging
+
+$(TARGET_PATH): $(SOURCES) | show-summary
+	@RUSTFLAGS="$(EXTRA_RUSTFLAGS) --deny warnings" cargo build --target $(TRIPLE) --$(BUILD_TYPE) $(EXTRA_RUSTFEATURES)
 
 $(GENERATED_FILES): %: %.in
 	@sed $(foreach r,$(GENERATED_REPLACEMENTS),-e 's|@$r@|$($r)|g') "$<" > "$@"
 
 ##TARGET optimize: optimized  build
-optimize: show-summary show-header
-	@RUSTFLAGS="-C link-arg=-s $(EXTRA_RUSTFLAGS) --deny warnings" cargo build --target $(TRIPLE) $(if $(findstring release,$(BUILD_TYPE)),--release) $(EXTRA_RUSTFEATURES)
+optimize: $(SOURCES) | show-summary show-header
+	@RUSTFLAGS="-C link-arg=-s $(EXTRA_RUSTFLAGS) --deny warnings" cargo build --target $(TRIPLE) --$(BUILD_TYPE) $(EXTRA_RUSTFEATURES)
 
 ##TARGET install: install agent
 install: install-services
@@ -200,6 +199,7 @@ codecov-html: check_tarpaulin
 
 .PHONY: \
 	help \
+	logging-crate-tests \
 	optimize \
 	show-header \
 	show-summary \

src/agent/rustjail/Cargo.toml

@@ -16,18 +16,17 @@ scopeguard = "1.0.0"
 capctl = "0.2.0"
 lazy_static = "1.3.0"
 libc = "0.2.58"
-protobuf = "2.27.0"
+protobuf = "=2.14.0"
 slog = "2.5.2"
 slog-scope = "4.1.2"
 scan_fmt = "0.2.6"
-regex = "1.5.5"
+regex = "1.5.4"
 path-absolutize = "1.2.0"
 anyhow = "1.0.32"
 cgroups = { package = "cgroups-rs", version = "0.2.8" }
 rlimit = "0.5.3"
-cfg-if = "0.1.0"
 
-tokio = { version = "1.2.0", features = ["sync", "io-util", "process", "time", "macros", "rt"] }
+tokio = { version = "1.2.0", features = ["sync", "io-util", "process", "time", "macros"] }
 futures = "0.3.17"
 async-trait = "0.1.31"
 inotify = "0.9.2"
@@ -39,4 +38,3 @@ tempfile = "3.1.0"
 
 [features]
 seccomp = ["libseccomp"]
-standard-oci-runtime = []

src/agent/rustjail/src/cgroups/fs/mod.rs

@@ -911,8 +911,9 @@ pub fn get_paths() -> Result<HashMap<String, String>> {
     Ok(m)
 }
 
-pub fn get_mounts(paths: &HashMap<String, String>) -> Result<HashMap<String, String>> {
+pub fn get_mounts() -> Result<HashMap<String, String>> {
     let mut m = HashMap::new();
+    let paths = get_paths()?;
 
     for l in fs::read_to_string(MOUNTS)?.lines() {
         let p: Vec<&str> = l.splitn(2, " - ").collect();
@@ -950,7 +951,7 @@ impl Manager {
         let mut m = HashMap::new();
 
         let paths = get_paths()?;
-        let mounts = get_mounts(&paths)?;
+        let mounts = get_mounts()?;
 
         for key in paths.keys() {
             let mnt = mounts.get(key);

src/agent/rustjail/src/cgroups/notifier.rs

@@ -151,12 +151,12 @@ async fn register_memory_event(
     let eventfd = eventfd(0, EfdFlags::EFD_CLOEXEC)?;
 
     let event_control_path = Path::new(&cg_dir).join("cgroup.event_control");
-
-    let data = if arg.is_empty() {
-        format!("{} {}", eventfd, event_file.as_raw_fd())
+    let data;
+    if arg.is_empty() {
+        data = format!("{} {}", eventfd, event_file.as_raw_fd());
     } else {
-        format!("{} {} {}", eventfd, event_file.as_raw_fd(), arg)
-    };
+        data = format!("{} {} {}", eventfd, event_file.as_raw_fd(), arg);
+    }
 
     fs::write(&event_control_path, data)?;
 

src/agent/rustjail/src/console.rs

@@ -1,79 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-//
-// Copyright 2021 Sony Group Corporation
-//
-
-use anyhow::{anyhow, Result};
-use nix::errno::Errno;
-use nix::pty;
-use nix::sys::{socket, uio};
-use nix::unistd::{self, dup2};
-use std::os::unix::io::{AsRawFd, RawFd};
-use std::path::Path;
-
-pub fn setup_console_socket(csocket_path: &str) -> Result<Option<RawFd>> {
-    if csocket_path.is_empty() {
-        return Ok(None);
-    }
-
-    let socket_fd = socket::socket(
-        socket::AddressFamily::Unix,
-        socket::SockType::Stream,
-        socket::SockFlag::empty(),
-        None,
-    )?;
-
-    match socket::connect(
-        socket_fd,
-        &socket::SockAddr::Unix(socket::UnixAddr::new(Path::new(csocket_path))?),
-    ) {
-        Ok(()) => Ok(Some(socket_fd)),
-        Err(errno) => Err(anyhow!("failed to open console fd: {}", errno)),
-    }
-}
-
-pub fn setup_master_console(socket_fd: RawFd) -> Result<()> {
-    let pseudo = pty::openpty(None, None)?;
-
-    let pty_name: &[u8] = b"/dev/ptmx";
-    let iov = [uio::IoVec::from_slice(pty_name)];
-    let fds = [pseudo.master];
-    let cmsg = socket::ControlMessage::ScmRights(&fds);
-
-    socket::sendmsg(socket_fd, &iov, &[cmsg], socket::MsgFlags::empty(), None)?;
-
-    unistd::setsid()?;
-    let ret = unsafe { libc::ioctl(pseudo.slave, libc::TIOCSCTTY) };
-    Errno::result(ret).map_err(|e| anyhow!(e).context("ioctl TIOCSCTTY"))?;
-
-    dup2(pseudo.slave, std::io::stdin().as_raw_fd())?;
-    dup2(pseudo.slave, std::io::stdout().as_raw_fd())?;
-    dup2(pseudo.slave, std::io::stderr().as_raw_fd())?;
-
-    unistd::close(socket_fd)?;
-
-    Ok(())
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use std::os::unix::net::UnixListener;
-    use tempfile::{self, tempdir};
-
-    const CONSOLE_SOCKET: &str = "console-socket";
-
-    #[test]
-    fn test_setup_console_socket() {
-        let dir = tempdir()
-            .map_err(|e| anyhow!(e).context("tempdir failed"))
-            .unwrap();
-        let socket_path = dir.path().join(CONSOLE_SOCKET);
-
-        let _listener = UnixListener::bind(&socket_path).unwrap();
-
-        let ret = setup_console_socket(socket_path.to_str().unwrap());
-
-        assert!(ret.is_ok());
-    }
-}

src/agent/rustjail/src/container.rs

@@ -23,8 +23,6 @@ use crate::cgroups::fs::Manager as FsManager;
 #[cfg(test)]
 use crate::cgroups::mock::Manager as FsManager;
 use crate::cgroups::Manager;
-#[cfg(feature = "standard-oci-runtime")]
-use crate::console;
 use crate::log_child;
 use crate::process::Process;
 #[cfg(feature = "seccomp")]
@@ -42,7 +40,7 @@ use nix::pty;
 use nix::sched::{self, CloneFlags};
 use nix::sys::signal::{self, Signal};
 use nix::sys::stat::{self, Mode};
-use nix::unistd::{self, fork, ForkResult, Gid, Pid, Uid, User};
+use nix::unistd::{self, fork, ForkResult, Gid, Pid, Uid};
 use std::os::unix::fs::MetadataExt;
 use std::os::unix::io::AsRawFd;
 
@@ -64,7 +62,9 @@ use rlimit::{setrlimit, Resource, Rlim};
 use tokio::io::AsyncBufReadExt;
 use tokio::sync::Mutex;
 
-pub const EXEC_FIFO_FILENAME: &str = "exec.fifo";
+use crate::utils;
+
+const EXEC_FIFO_FILENAME: &str = "exec.fifo";
 
 const INIT: &str = "INIT";
 const NO_PIVOT: &str = "NO_PIVOT";
@@ -74,7 +74,6 @@ const CLOG_FD: &str = "CLOG_FD";
 const FIFO_FD: &str = "FIFO_FD";
 const HOME_ENV_KEY: &str = "HOME";
 const PIDNS_FD: &str = "PIDNS_FD";
-const CONSOLE_SOCKET_FD: &str = "CONSOLE_SOCKET_FD";
 
 #[derive(Debug)]
 pub struct ContainerStatus {
@@ -83,7 +82,7 @@ pub struct ContainerStatus {
 }
 
 impl ContainerStatus {
-    pub fn new() -> Self {
+    fn new() -> Self {
         ContainerStatus {
             pre_status: ContainerState::Created,
             cur_status: ContainerState::Created,
@@ -100,12 +99,6 @@ impl ContainerStatus {
     }
 }
 
-impl Default for ContainerStatus {
-    fn default() -> Self {
-        Self::new()
-    }
-}
-
 pub type Config = CreateOpts;
 type NamespaceType = String;
 
@@ -113,7 +106,7 @@ lazy_static! {
     // This locker ensures the child exit signal will be received by the right receiver.
     pub static ref WAIT_PID_LOCKER: Arc<Mutex<bool>> = Arc::new(Mutex::new(false));
 
-    pub static ref NAMESPACES: HashMap<&'static str, CloneFlags> = {
+    static ref NAMESPACES: HashMap<&'static str, CloneFlags> = {
         let mut m = HashMap::new();
         m.insert("user", CloneFlags::CLONE_NEWUSER);
         m.insert("ipc", CloneFlags::CLONE_NEWIPC);
@@ -126,7 +119,7 @@ lazy_static! {
     };
 
 // type to name hashmap, better to be in NAMESPACES
-    pub static ref TYPETONAME: HashMap<&'static str, &'static str> = {
+    static ref TYPETONAME: HashMap<&'static str, &'static str> = {
         let mut m = HashMap::new();
         m.insert("ipc", "ipc");
         m.insert("user", "user");
@@ -222,7 +215,7 @@ pub trait BaseContainer {
     async fn start(&mut self, p: Process) -> Result<()>;
     async fn run(&mut self, p: Process) -> Result<()>;
     async fn destroy(&mut self) -> Result<()>;
-    async fn exec(&mut self) -> Result<()>;
+    fn exec(&mut self) -> Result<()>;
 }
 
 // LinuxContainer protected by Mutex
@@ -243,8 +236,6 @@ pub struct LinuxContainer {
     pub status: ContainerStatus,
     pub created: SystemTime,
     pub logger: Logger,
-    #[cfg(feature = "standard-oci-runtime")]
-    pub console_socket: PathBuf,
 }
 
 #[derive(Serialize, Deserialize, Debug)]
@@ -368,6 +359,7 @@ fn do_init_child(cwfd: RawFd) -> Result<()> {
             )));
         }
     }
+
     log_child!(cfd_log, "child process start run");
     let buf = read_sync(crfd)?;
     let spec_str = std::str::from_utf8(&buf)?;
@@ -387,9 +379,6 @@ fn do_init_child(cwfd: RawFd) -> Result<()> {
 
     let cm: FsManager = serde_json::from_str(cm_str)?;
 
-    #[cfg(feature = "standard-oci-runtime")]
-    let csocket_fd = console::setup_console_socket(&std::env::var(CONSOLE_SOCKET_FD)?)?;
-
     let p = if spec.process.is_some() {
         spec.process.as_ref().unwrap()
     } else {
@@ -587,20 +576,14 @@ fn do_init_child(cwfd: RawFd) -> Result<()> {
 
     // only change stdio devices owner when user
     // isn't root.
-    if !uid.is_root() {
-        set_stdio_permissions(uid)?;
+    if guser.uid != 0 {
+        set_stdio_permissions(guser.uid)?;
     }
 
     setid(uid, gid)?;
 
     if !guser.additional_gids.is_empty() {
-        let gids: Vec<Gid> = guser
-            .additional_gids
-            .iter()
-            .map(|gid| Gid::from_raw(*gid))
-            .collect();
-
-        unistd::setgroups(&gids).map_err(|e| {
+        setgroups(guser.additional_gids.as_slice()).map_err(|e| {
             let _ = write_sync(
                 cwfd,
                 SYNC_FAILED,
@@ -640,6 +623,11 @@ fn do_init_child(cwfd: RawFd) -> Result<()> {
         capabilities::drop_privileges(cfd_log, c)?;
     }
 
+    if init {
+        // notify parent to run poststart hooks
+        write_sync(cwfd, SYNC_SUCCESS, "")?;
+    }
+
     let args = oci_process.args.to_vec();
     let env = oci_process.env.to_vec();
 
@@ -661,17 +649,12 @@ fn do_init_child(cwfd: RawFd) -> Result<()> {
         }
     }
 
+    // set the "HOME" env getting from "/etc/passwd", if
+    // there's no uid entry in /etc/passwd, set "/" as the
+    // home env.
     if env::var_os(HOME_ENV_KEY).is_none() {
-        // try to set "HOME" env by uid
-        if let Ok(Some(user)) = User::from_uid(Uid::from_raw(guser.uid)) {
-            if let Ok(user_home_dir) = user.dir.into_os_string().into_string() {
-                env::set_var(HOME_ENV_KEY, user_home_dir);
-            }
-        }
-        // set default home dir as "/" if "HOME" env is still empty
-        if env::var_os(HOME_ENV_KEY).is_none() {
-            env::set_var(HOME_ENV_KEY, String::from("/"));
-        }
+        let home_dir = utils::home_dir(guser.uid).unwrap_or_else(|_| String::from("/"));
+        env::set_var(HOME_ENV_KEY, home_dir);
     }
 
     let exec_file = Path::new(&args[0]);
@@ -687,19 +670,10 @@ fn do_init_child(cwfd: RawFd) -> Result<()> {
     let _ = unistd::close(crfd);
     let _ = unistd::close(cwfd);
 
+    unistd::setsid().context("create a new session")?;
     if oci_process.terminal {
-        cfg_if::cfg_if! {
-            if #[cfg(feature = "standard-oci-runtime")] {
-                if let Some(csocket_fd) = csocket_fd {
-                    console::setup_master_console(csocket_fd)?;
-                } else {
-                    return Err(anyhow!("failed to get console master socket fd"));
-                }
-            }
-            else {
-                unistd::setsid().context("create a new session")?;
-                unsafe { libc::ioctl(0, libc::TIOCSCTTY) };
-            }
+        unsafe {
+            libc::ioctl(0, libc::TIOCSCTTY);
         }
     }
 
@@ -731,7 +705,7 @@ fn do_init_child(cwfd: RawFd) -> Result<()> {
 // within the container to the specified user.
 // The ownership needs to match because it is created outside of
 // the container and needs to be localized.
-fn set_stdio_permissions(uid: Uid) -> Result<()> {
+fn set_stdio_permissions(uid: libc::uid_t) -> Result<()> {
     let meta = fs::metadata("/dev/null")?;
     let fds = [
         std::io::stdin().as_raw_fd(),
@@ -746,13 +720,19 @@ fn set_stdio_permissions(uid: Uid) -> Result<()> {
             continue;
         }
 
+        // According to the POSIX specification, -1 is used to indicate that owner and group
+        // are not to be changed.  Since uid_t and gid_t are unsigned types, we have to wrap
+        // around to get -1.
+        let gid = 0u32.wrapping_sub(1);
+
         // We only change the uid owner (as it is possible for the mount to
         // prefer a different gid, and there's no reason for us to change it).
         // The reason why we don't just leave the default uid=X mount setup is
         // that users expect to be able to actually use their console. Without
         // this code, you couldn't effectively run as a non-root user inside a
         // container and also have a console set up.
-        unistd::fchown(*fd, Some(uid), None).with_context(|| "set stdio permissions failed")?;
+        let res = unsafe { libc::fchown(*fd, uid, gid) };
+        Errno::result(res).map_err(|e| anyhow!(e).context("set stdio permissions failed"))?;
     }
 
     Ok(())
@@ -948,14 +928,6 @@ impl BaseContainer for LinuxContainer {
 
         let exec_path = std::env::current_exe()?;
         let mut child = std::process::Command::new(exec_path);
-
-        #[allow(unused_mut)]
-        let mut console_name = PathBuf::from("");
-        #[cfg(feature = "standard-oci-runtime")]
-        if !self.console_socket.as_os_str().is_empty() {
-            console_name = self.console_socket.clone();
-        }
-
         let mut child = child
             .arg("init")
             .stdin(child_stdin)
@@ -965,8 +937,7 @@ impl BaseContainer for LinuxContainer {
             .env(NO_PIVOT, format!("{}", self.config.no_pivot_root))
             .env(CRFD_FD, format!("{}", crfd))
             .env(CWFD_FD, format!("{}", cwfd))
-            .env(CLOG_FD, format!("{}", cfd_log))
-            .env(CONSOLE_SOCKET_FD, console_name);
+            .env(CLOG_FD, format!("{}", cfd_log));
 
         if p.init {
             child = child.env(FIFO_FD, format!("{}", fifofd));
@@ -1049,7 +1020,7 @@ impl BaseContainer for LinuxContainer {
         self.start(p).await?;
 
         if init {
-            self.exec().await?;
+            self.exec()?;
             self.status.transition(ContainerState::Running);
         }
 
@@ -1092,22 +1063,12 @@ impl BaseContainer for LinuxContainer {
         fs::remove_dir_all(&self.root)?;
 
         if let Some(cgm) = self.cgroup_manager.as_mut() {
-            // Kill all of the processes created in this container to prevent
-            // the leak of some daemon process when this container shared pidns
-            // with the sandbox.
-            let pids = cgm.get_pids().context("get cgroup pids")?;
-            for i in pids {
-                if let Err(e) = signal::kill(Pid::from_raw(i), Signal::SIGKILL) {
-                    warn!(self.logger, "kill the process {} error: {:?}", i, e);
-                }
-            }
-
             cgm.destroy().context("destroy cgroups")?;
         }
         Ok(())
     }
 
-    async fn exec(&mut self) -> Result<()> {
+    fn exec(&mut self) -> Result<()> {
         let fifo = format!("{}/{}", &self.root, EXEC_FIFO_FILENAME);
         let fd = fcntl::open(fifo.as_str(), OFlag::O_WRONLY, Mode::from_bits_truncate(0))?;
         let data: &[u8] = &[0];
@@ -1119,26 +1080,6 @@ impl BaseContainer for LinuxContainer {
             .as_secs();
 
         self.status.transition(ContainerState::Running);
-
-        let spec = self
-            .config
-            .spec
-            .as_ref()
-            .ok_or_else(|| anyhow!("OCI spec was not found"))?;
-        let st = self.oci_state()?;
-
-        // run poststart hook
-        if spec.hooks.is_some() {
-            info!(self.logger, "poststart hook");
-            let hooks = spec
-                .hooks
-                .as_ref()
-                .ok_or_else(|| anyhow!("OCI hooks were not found"))?;
-            for h in hooks.poststart.iter() {
-                execute_hook(&self.logger, h, &st).await?;
-            }
-        }
-
         unistd::close(fd)?;
 
         Ok(())
@@ -1181,7 +1122,7 @@ fn do_exec(args: &[String]) -> ! {
     unreachable!()
 }
 
-pub fn update_namespaces(logger: &Logger, spec: &mut Spec, init_pid: RawFd) -> Result<()> {
+fn update_namespaces(logger: &Logger, spec: &mut Spec, init_pid: RawFd) -> Result<()> {
     info!(logger, "updating namespaces");
     let linux = spec
         .linux
@@ -1360,6 +1301,20 @@ async fn join_namespaces(
         // notify child run prestart hooks completed
         info!(logger, "notify child run prestart hook completed!");
         write_async(pipe_w, SYNC_SUCCESS, "").await?;
+
+        info!(logger, "notify child parent ready to run poststart hook!");
+        // wait to run poststart hook
+        read_async(pipe_r).await?;
+        info!(logger, "get ready to run poststart hook!");
+
+        // run poststart hook
+        if spec.hooks.is_some() {
+            info!(logger, "poststart hook");
+            let hooks = spec.hooks.as_ref().unwrap();
+            for h in hooks.poststart.iter() {
+                execute_hook(&logger, h, st).await?;
+            }
+        }
     }
 
     info!(logger, "wait for child process ready to run exec");
@@ -1476,16 +1431,14 @@ impl LinuxContainer {
                 .unwrap()
                 .as_secs(),
             logger: logger.new(o!("module" => "rustjail", "subsystem" => "container", "cid" => id)),
-            #[cfg(feature = "standard-oci-runtime")]
-            console_socket: Path::new("").to_path_buf(),
         })
     }
+}
 
-    #[cfg(feature = "standard-oci-runtime")]
-    pub fn set_console_socket(&mut self, console_socket: &Path) -> Result<()> {
-        self.console_socket = console_socket.to_path_buf();
-        Ok(())
-    }
+fn setgroups(grps: &[libc::gid_t]) -> Result<()> {
+    let ret = unsafe { libc::setgroups(grps.len(), grps.as_ptr() as *const libc::gid_t) };
+    Errno::result(ret).map(drop)?;
+    Ok(())
 }
 
 use std::fs::OpenOptions;
@@ -1519,7 +1472,7 @@ use std::process::Stdio;
 use std::time::Duration;
 use tokio::io::{AsyncReadExt, AsyncWriteExt};
 
-pub async fn execute_hook(logger: &Logger, h: &Hook, st: &OCIState) -> Result<()> {
+async fn execute_hook(logger: &Logger, h: &Hook, st: &OCIState) -> Result<()> {
     let logger = logger.new(o!("action" => "execute-hook"));
 
     let binary = PathBuf::from(h.path.as_str());
@@ -1657,7 +1610,6 @@ mod tests {
     use super::*;
     use crate::process::Process;
     use crate::skip_if_not_root;
-    use nix::unistd::Uid;
     use std::fs;
     use std::os::unix::fs::MetadataExt;
     use std::os::unix::io::AsRawFd;
@@ -1803,7 +1755,7 @@ mod tests {
         let old_uid = meta.uid();
 
         let uid = 1000;
-        set_stdio_permissions(Uid::from_raw(uid)).unwrap();
+        set_stdio_permissions(uid).unwrap();
 
         let meta = fs::metadata("/dev/stdin").unwrap();
         assert_eq!(meta.uid(), uid);
@@ -1815,7 +1767,7 @@ mod tests {
         assert_eq!(meta.uid(), uid);
 
         // restore the uid
-        set_stdio_permissions(Uid::from_raw(old_uid)).unwrap();
+        set_stdio_permissions(old_uid).unwrap();
     }
 
     #[test]
@@ -2096,10 +2048,9 @@ mod tests {
         assert!(ret.is_ok(), "Expecting Ok, Got {:?}", ret);
     }
 
-    #[tokio::test]
-    async fn test_linuxcontainer_exec() {
-        let (c, _dir) = new_linux_container();
-        let ret = c.unwrap().exec().await;
+    #[test]
+    fn test_linuxcontainer_exec() {
+        let ret = new_linux_container_and_then(|mut c: LinuxContainer| c.exec());
         assert!(ret.is_err(), "Expecting Err, Got {:?}", ret);
     }
 

src/agent/rustjail/src/lib.rs

@@ -30,8 +30,6 @@ extern crate regex;
 
 pub mod capabilities;
 pub mod cgroups;
-#[cfg(feature = "standard-oci-runtime")]
-pub mod console;
 pub mod container;
 pub mod mount;
 pub mod pipestream;
@@ -41,6 +39,7 @@ pub mod seccomp;
 pub mod specconv;
 pub mod sync;
 pub mod sync_with_async;
+pub mod utils;
 pub mod validator;
 
 use std::collections::HashMap;
@@ -352,12 +351,13 @@ fn seccomp_grpc_to_oci(sec: &grpc::LinuxSeccomp) -> oci::LinuxSeccomp {
 
         for sys in sec.Syscalls.iter() {
             let mut args = Vec::new();
+            let errno_ret: u32;
 
-            let errno_ret: u32 = if sys.has_errnoret() {
-                sys.get_errnoret()
+            if sys.has_errnoret() {
+                errno_ret = sys.get_errnoret();
             } else {
-                libc::EPERM as u32
-            };
+                errno_ret = libc::EPERM as u32;
+            }
 
             for arg in sys.Args.iter() {
                 args.push(oci::LinuxSeccompArg {
@@ -513,7 +513,6 @@ pub fn grpc_to_oci(grpc: &grpc::Spec) -> oci::Spec {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
     #[macro_export]
     macro_rules! skip_if_not_root {
         () => {
@@ -523,595 +522,4 @@ mod tests {
             }
         };
     }
-
-    // Parameters:
-    //
-    // 1: expected Result
-    // 2: actual Result
-    // 3: string used to identify the test on error
-    #[macro_export]
-    macro_rules! assert_result {
-        ($expected_result:expr, $actual_result:expr, $msg:expr) => {
-            if $expected_result.is_ok() {
-                let expected_value = $expected_result.as_ref().unwrap();
-                let actual_value = $actual_result.unwrap();
-                assert!(*expected_value == actual_value, "{}", $msg);
-            } else {
-                assert!($actual_result.is_err(), "{}", $msg);
-
-                let expected_error = $expected_result.as_ref().unwrap_err();
-                let expected_error_msg = format!("{:?}", expected_error);
-
-                let actual_error_msg = format!("{:?}", $actual_result.unwrap_err());
-
-                assert!(expected_error_msg == actual_error_msg, "{}", $msg);
-            }
-        };
-    }
-
-    #[test]
-    fn test_process_grpc_to_oci() {
-        #[derive(Debug)]
-        struct TestData {
-            grpcproc: grpc::Process,
-            result: oci::Process,
-        }
-
-        let tests = &[
-            TestData {
-                // All fields specified
-                grpcproc: grpc::Process {
-                    Terminal: true,
-                    ConsoleSize: protobuf::SingularPtrField::<grpc::Box>::some(grpc::Box {
-                        Height: 123,
-                        Width: 456,
-                        ..Default::default()
-                    }),
-                    User: protobuf::SingularPtrField::<grpc::User>::some(grpc::User {
-                        UID: 1234,
-                        GID: 5678,
-                        AdditionalGids: Vec::from([910, 1112]),
-                        Username: String::from("username"),
-                        ..Default::default()
-                    }),
-                    Args: protobuf::RepeatedField::from(Vec::from([
-                        String::from("arg1"),
-                        String::from("arg2"),
-                    ])),
-                    Env: protobuf::RepeatedField::from(Vec::from([String::from("env")])),
-                    Cwd: String::from("cwd"),
-                    Capabilities: protobuf::SingularPtrField::some(grpc::LinuxCapabilities {
-                        Bounding: protobuf::RepeatedField::from(Vec::from([String::from("bnd")])),
-                        Effective: protobuf::RepeatedField::from(Vec::from([String::from("eff")])),
-                        Inheritable: protobuf::RepeatedField::from(Vec::from([String::from(
-                            "inher",
-                        )])),
-                        Permitted: protobuf::RepeatedField::from(Vec::from([String::from("perm")])),
-                        Ambient: protobuf::RepeatedField::from(Vec::from([String::from("amb")])),
-                        ..Default::default()
-                    }),
-                    Rlimits: protobuf::RepeatedField::from(Vec::from([
-                        grpc::POSIXRlimit {
-                            Type: String::from("r#type"),
-                            Hard: 123,
-                            Soft: 456,
-                            ..Default::default()
-                        },
-                        grpc::POSIXRlimit {
-                            Type: String::from("r#type2"),
-                            Hard: 789,
-                            Soft: 1011,
-                            ..Default::default()
-                        },
-                    ])),
-                    NoNewPrivileges: true,
-                    ApparmorProfile: String::from("apparmor profile"),
-                    OOMScoreAdj: 123456,
-                    SelinuxLabel: String::from("Selinux Label"),
-                    ..Default::default()
-                },
-                result: oci::Process {
-                    terminal: true,
-                    console_size: Some(oci::Box {
-                        height: 123,
-                        width: 456,
-                    }),
-                    user: oci::User {
-                        uid: 1234,
-                        gid: 5678,
-                        additional_gids: Vec::from([910, 1112]),
-                        username: String::from("username"),
-                    },
-                    args: Vec::from([String::from("arg1"), String::from("arg2")]),
-                    env: Vec::from([String::from("env")]),
-                    cwd: String::from("cwd"),
-                    capabilities: Some(oci::LinuxCapabilities {
-                        bounding: Vec::from([String::from("bnd")]),
-                        effective: Vec::from([String::from("eff")]),
-                        inheritable: Vec::from([String::from("inher")]),
-                        permitted: Vec::from([String::from("perm")]),
-                        ambient: Vec::from([String::from("amb")]),
-                    }),
-                    rlimits: Vec::from([
-                        oci::PosixRlimit {
-                            r#type: String::from("r#type"),
-                            hard: 123,
-                            soft: 456,
-                        },
-                        oci::PosixRlimit {
-                            r#type: String::from("r#type2"),
-                            hard: 789,
-                            soft: 1011,
-                        },
-                    ]),
-                    no_new_privileges: true,
-                    apparmor_profile: String::from("apparmor profile"),
-                    oom_score_adj: Some(123456),
-                    selinux_label: String::from("Selinux Label"),
-                },
-            },
-            TestData {
-                // None ConsoleSize
-                grpcproc: grpc::Process {
-                    ConsoleSize: protobuf::SingularPtrField::<grpc::Box>::none(),
-                    OOMScoreAdj: 0,
-                    ..Default::default()
-                },
-                result: oci::Process {
-                    console_size: None,
-                    oom_score_adj: Some(0),
-                    ..Default::default()
-                },
-            },
-            TestData {
-                // None User
-                grpcproc: grpc::Process {
-                    User: protobuf::SingularPtrField::<grpc::User>::none(),
-                    OOMScoreAdj: 0,
-                    ..Default::default()
-                },
-                result: oci::Process {
-                    user: oci::User {
-                        uid: 0,
-                        gid: 0,
-                        additional_gids: vec![],
-                        username: String::from(""),
-                    },
-                    oom_score_adj: Some(0),
-                    ..Default::default()
-                },
-            },
-            TestData {
-                // None Capabilities
-                grpcproc: grpc::Process {
-                    Capabilities: protobuf::SingularPtrField::none(),
-                    OOMScoreAdj: 0,
-                    ..Default::default()
-                },
-                result: oci::Process {
-                    capabilities: None,
-                    oom_score_adj: Some(0),
-                    ..Default::default()
-                },
-            },
-        ];
-
-        for (i, d) in tests.iter().enumerate() {
-            let msg = format!("test[{}]: {:?}", i, d);
-
-            let result = process_grpc_to_oci(&d.grpcproc);
-
-            let msg = format!("{}, result: {:?}", msg, result);
-
-            assert_eq!(d.result, result, "{}", msg);
-        }
-    }
-
-    #[test]
-    fn test_root_grpc_to_oci() {
-        #[derive(Debug)]
-        struct TestData {
-            grpcroot: grpc::Root,
-            result: oci::Root,
-        }
-
-        let tests = &[
-            TestData {
-                // Default fields
-                grpcroot: grpc::Root {
-                    ..Default::default()
-                },
-                result: oci::Root {
-                    ..Default::default()
-                },
-            },
-            TestData {
-                // Specified fields, readonly false
-                grpcroot: grpc::Root {
-                    Path: String::from("path"),
-                    Readonly: false,
-                    ..Default::default()
-                },
-                result: oci::Root {
-                    path: String::from("path"),
-                    readonly: false,
-                    ..Default::default()
-                },
-            },
-            TestData {
-                // Specified fields, readonly true
-                grpcroot: grpc::Root {
-                    Path: String::from("path"),
-                    Readonly: true,
-                    ..Default::default()
-                },
-                result: oci::Root {
-                    path: String::from("path"),
-                    readonly: true,
-                    ..Default::default()
-                },
-            },
-        ];
-
-        for (i, d) in tests.iter().enumerate() {
-            let msg = format!("test[{}]: {:?}", i, d);
-
-            let result = root_grpc_to_oci(&d.grpcroot);
-
-            let msg = format!("{}, result: {:?}", msg, result);
-
-            assert_eq!(d.result, result, "{}", msg);
-        }
-    }
-
-    #[test]
-    fn test_hooks_grpc_to_oci() {
-        #[derive(Debug)]
-        struct TestData {
-            grpchooks: grpc::Hooks,
-            result: oci::Hooks,
-        }
-
-        let tests = &[
-            TestData {
-                // Default fields
-                grpchooks: grpc::Hooks {
-                    ..Default::default()
-                },
-                result: oci::Hooks {
-                    ..Default::default()
-                },
-            },
-            TestData {
-                // All specified
-                grpchooks: grpc::Hooks {
-                    Prestart: protobuf::RepeatedField::from(Vec::from([
-                        grpc::Hook {
-                            Path: String::from("prestartpath"),
-                            Args: protobuf::RepeatedField::from(Vec::from([
-                                String::from("arg1"),
-                                String::from("arg2"),
-                            ])),
-                            Env: protobuf::RepeatedField::from(Vec::from([
-                                String::from("env1"),
-                                String::from("env2"),
-                            ])),
-                            Timeout: 10,
-                            ..Default::default()
-                        },
-                        grpc::Hook {
-                            Path: String::from("prestartpath2"),
-                            Args: protobuf::RepeatedField::from(Vec::from([
-                                String::from("arg3"),
-                                String::from("arg4"),
-                            ])),
-                            Env: protobuf::RepeatedField::from(Vec::from([
-                                String::from("env3"),
-                                String::from("env4"),
-                            ])),
-                            Timeout: 25,
-                            ..Default::default()
-                        },
-                    ])),
-                    Poststart: protobuf::RepeatedField::from(Vec::from([grpc::Hook {
-                        Path: String::from("poststartpath"),
-                        Args: protobuf::RepeatedField::from(Vec::from([
-                            String::from("arg1"),
-                            String::from("arg2"),
-                        ])),
-                        Env: protobuf::RepeatedField::from(Vec::from([
-                            String::from("env1"),
-                            String::from("env2"),
-                        ])),
-                        Timeout: 10,
-                        ..Default::default()
-                    }])),
-                    Poststop: protobuf::RepeatedField::from(Vec::from([grpc::Hook {
-                        Path: String::from("poststoppath"),
-                        Args: protobuf::RepeatedField::from(Vec::from([
-                            String::from("arg1"),
-                            String::from("arg2"),
-                        ])),
-                        Env: protobuf::RepeatedField::from(Vec::from([
-                            String::from("env1"),
-                            String::from("env2"),
-                        ])),
-                        Timeout: 10,
-                        ..Default::default()
-                    }])),
-                    ..Default::default()
-                },
-                result: oci::Hooks {
-                    prestart: Vec::from([
-                        oci::Hook {
-                            path: String::from("prestartpath"),
-                            args: Vec::from([String::from("arg1"), String::from("arg2")]),
-                            env: Vec::from([String::from("env1"), String::from("env2")]),
-                            timeout: Some(10),
-                        },
-                        oci::Hook {
-                            path: String::from("prestartpath2"),
-                            args: Vec::from([String::from("arg3"), String::from("arg4")]),
-                            env: Vec::from([String::from("env3"), String::from("env4")]),
-                            timeout: Some(25),
-                        },
-                    ]),
-                    poststart: Vec::from([oci::Hook {
-                        path: String::from("poststartpath"),
-                        args: Vec::from([String::from("arg1"), String::from("arg2")]),
-                        env: Vec::from([String::from("env1"), String::from("env2")]),
-                        timeout: Some(10),
-                    }]),
-                    poststop: Vec::from([oci::Hook {
-                        path: String::from("poststoppath"),
-                        args: Vec::from([String::from("arg1"), String::from("arg2")]),
-                        env: Vec::from([String::from("env1"), String::from("env2")]),
-                        timeout: Some(10),
-                    }]),
-                },
-            },
-            TestData {
-                // Prestart empty
-                grpchooks: grpc::Hooks {
-                    Prestart: protobuf::RepeatedField::from(Vec::from([])),
-                    Poststart: protobuf::RepeatedField::from(Vec::from([grpc::Hook {
-                        Path: String::from("poststartpath"),
-                        Args: protobuf::RepeatedField::from(Vec::from([
-                            String::from("arg1"),
-                            String::from("arg2"),
-                        ])),
-                        Env: protobuf::RepeatedField::from(Vec::from([
-                            String::from("env1"),
-                            String::from("env2"),
-                        ])),
-                        Timeout: 10,
-                        ..Default::default()
-                    }])),
-                    Poststop: protobuf::RepeatedField::from(Vec::from([grpc::Hook {
-                        Path: String::from("poststoppath"),
-                        Args: protobuf::RepeatedField::from(Vec::from([
-                            String::from("arg1"),
-                            String::from("arg2"),
-                        ])),
-                        Env: protobuf::RepeatedField::from(Vec::from([
-                            String::from("env1"),
-                            String::from("env2"),
-                        ])),
-                        Timeout: 10,
-                        ..Default::default()
-                    }])),
-                    ..Default::default()
-                },
-                result: oci::Hooks {
-                    prestart: Vec::from([]),
-                    poststart: Vec::from([oci::Hook {
-                        path: String::from("poststartpath"),
-                        args: Vec::from([String::from("arg1"), String::from("arg2")]),
-                        env: Vec::from([String::from("env1"), String::from("env2")]),
-                        timeout: Some(10),
-                    }]),
-                    poststop: Vec::from([oci::Hook {
-                        path: String::from("poststoppath"),
-                        args: Vec::from([String::from("arg1"), String::from("arg2")]),
-                        env: Vec::from([String::from("env1"), String::from("env2")]),
-                        timeout: Some(10),
-                    }]),
-                },
-            },
-        ];
-
-        for (i, d) in tests.iter().enumerate() {
-            let msg = format!("test[{}]: {:?}", i, d);
-
-            let result = hooks_grpc_to_oci(&d.grpchooks);
-
-            let msg = format!("{}, result: {:?}", msg, result);
-
-            assert_eq!(d.result, result, "{}", msg);
-        }
-    }
-
-    #[test]
-    fn test_mount_grpc_to_oci() {
-        #[derive(Debug)]
-        struct TestData {
-            grpcmount: grpc::Mount,
-            result: oci::Mount,
-        }
-
-        let tests = &[
-            TestData {
-                // Default fields
-                grpcmount: grpc::Mount {
-                    ..Default::default()
-                },
-                result: oci::Mount {
-                    ..Default::default()
-                },
-            },
-            TestData {
-                grpcmount: grpc::Mount {
-                    destination: String::from("destination"),
-                    source: String::from("source"),
-                    field_type: String::from("fieldtype"),
-                    options: protobuf::RepeatedField::from(Vec::from([
-                        String::from("option1"),
-                        String::from("option2"),
-                    ])),
-                    ..Default::default()
-                },
-                result: oci::Mount {
-                    destination: String::from("destination"),
-                    source: String::from("source"),
-                    r#type: String::from("fieldtype"),
-                    options: Vec::from([String::from("option1"), String::from("option2")]),
-                },
-            },
-            TestData {
-                grpcmount: grpc::Mount {
-                    destination: String::from("destination"),
-                    source: String::from("source"),
-                    field_type: String::from("fieldtype"),
-                    options: protobuf::RepeatedField::from(Vec::new()),
-                    ..Default::default()
-                },
-                result: oci::Mount {
-                    destination: String::from("destination"),
-                    source: String::from("source"),
-                    r#type: String::from("fieldtype"),
-                    options: Vec::new(),
-                },
-            },
-            TestData {
-                grpcmount: grpc::Mount {
-                    destination: String::new(),
-                    source: String::from("source"),
-                    field_type: String::from("fieldtype"),
-                    options: protobuf::RepeatedField::from(Vec::from([String::from("option1")])),
-                    ..Default::default()
-                },
-                result: oci::Mount {
-                    destination: String::new(),
-                    source: String::from("source"),
-                    r#type: String::from("fieldtype"),
-                    options: Vec::from([String::from("option1")]),
-                },
-            },
-            TestData {
-                grpcmount: grpc::Mount {
-                    destination: String::from("destination"),
-                    source: String::from("source"),
-                    field_type: String::new(),
-                    options: protobuf::RepeatedField::from(Vec::from([String::from("option1")])),
-                    ..Default::default()
-                },
-                result: oci::Mount {
-                    destination: String::from("destination"),
-                    source: String::from("source"),
-                    r#type: String::new(),
-                    options: Vec::from([String::from("option1")]),
-                },
-            },
-        ];
-
-        for (i, d) in tests.iter().enumerate() {
-            let msg = format!("test[{}]: {:?}", i, d);
-
-            let result = mount_grpc_to_oci(&d.grpcmount);
-
-            let msg = format!("{}, result: {:?}", msg, result);
-
-            assert_eq!(d.result, result, "{}", msg);
-        }
-    }
-
-    #[test]
-    fn test_hook_grpc_to_oci<'a>() {
-        #[derive(Debug)]
-        struct TestData<'a> {
-            grpchook: &'a [grpc::Hook],
-            result: Vec<oci::Hook>,
-        }
-
-        let tests = &[
-            TestData {
-                // Default fields
-                grpchook: &[
-                    grpc::Hook {
-                        Timeout: 0,
-                        ..Default::default()
-                    },
-                    grpc::Hook {
-                        Timeout: 0,
-                        ..Default::default()
-                    },
-                ],
-                result: vec![
-                    oci::Hook {
-                        timeout: Some(0),
-                        ..Default::default()
-                    },
-                    oci::Hook {
-                        timeout: Some(0),
-                        ..Default::default()
-                    },
-                ],
-            },
-            TestData {
-                // Specified fields
-                grpchook: &[
-                    grpc::Hook {
-                        Path: String::from("path"),
-                        Args: protobuf::RepeatedField::from(Vec::from([
-                            String::from("arg1"),
-                            String::from("arg2"),
-                        ])),
-                        Env: protobuf::RepeatedField::from(Vec::from([
-                            String::from("env1"),
-                            String::from("env2"),
-                        ])),
-                        Timeout: 10,
-                        ..Default::default()
-                    },
-                    grpc::Hook {
-                        Path: String::from("path2"),
-                        Args: protobuf::RepeatedField::from(Vec::from([
-                            String::from("arg3"),
-                            String::from("arg4"),
-                        ])),
-                        Env: protobuf::RepeatedField::from(Vec::from([
-                            String::from("env3"),
-                            String::from("env4"),
-                        ])),
-                        Timeout: 20,
-                        ..Default::default()
-                    },
-                ],
-                result: vec![
-                    oci::Hook {
-                        path: String::from("path"),
-                        args: Vec::from([String::from("arg1"), String::from("arg2")]),
-                        env: Vec::from([String::from("env1"), String::from("env2")]),
-                        timeout: Some(10),
-                    },
-                    oci::Hook {
-                        path: String::from("path2"),
-                        args: Vec::from([String::from("arg3"), String::from("arg4")]),
-                        env: Vec::from([String::from("env3"), String::from("env4")]),
-                        timeout: Some(20),
-                    },
-                ],
-            },
-        ];
-
-        for (i, d) in tests.iter().enumerate() {
-            let msg = format!("test[{}]: {:?}", i, d);
-
-            let result = hook_grpc_to_oci(d.grpchook);
-
-            let msg = format!("{}, result: {:?}", msg, result);
-
-            assert_eq!(d.result, result, "{}", msg);
-        }
-    }
 }

src/agent/rustjail/src/mount.rs

@@ -32,21 +32,16 @@ use crate::log_child;
 
 // Info reveals information about a particular mounted filesystem. This
 // struct is populated from the content in the /proc/<pid>/mountinfo file.
-#[derive(std::fmt::Debug, PartialEq)]
+#[derive(std::fmt::Debug)]
 pub struct Info {
     mount_point: String,
     optional: String,
     fstype: String,
 }
 
-const MOUNTINFO_FORMAT: &str = "{d} {d} {d}:{d} {} {} {} {}";
-const MOUNTINFO_PATH: &str = "/proc/self/mountinfo";
+const MOUNTINFOFORMAT: &str = "{d} {d} {d}:{d} {} {} {} {}";
 const PROC_PATH: &str = "/proc";
 
-const ERR_FAILED_PARSE_MOUNTINFO: &str = "failed to parse mountinfo file";
-const ERR_FAILED_PARSE_MOUNTINFO_FINAL_FIELDS: &str =
-    "failed to parse final fields in mountinfo file";
-
 // since libc didn't defined this const for musl, thus redefined it here.
 #[cfg(all(target_os = "linux", target_env = "gnu", not(target_arch = "s390x")))]
 const PROC_SUPER_MAGIC: libc::c_long = 0x00009fa0;
@@ -523,7 +518,7 @@ pub fn pivot_rootfs<P: ?Sized + NixPath + std::fmt::Debug>(path: &P) -> Result<(
 }
 
 fn rootfs_parent_mount_private(path: &str) -> Result<()> {
-    let mount_infos = parse_mount_table(MOUNTINFO_PATH)?;
+    let mount_infos = parse_mount_table()?;
 
     let mut max_len = 0;
     let mut mount_point = String::from("");
@@ -551,8 +546,8 @@ fn rootfs_parent_mount_private(path: &str) -> Result<()> {
 
 // Parse /proc/self/mountinfo because comparing Dev and ino does not work from
 // bind mounts
-fn parse_mount_table(mountinfo_path: &str) -> Result<Vec<Info>> {
-    let file = File::open(mountinfo_path)?;
+fn parse_mount_table() -> Result<Vec<Info>> {
+    let file = File::open("/proc/self/mountinfo")?;
     let reader = BufReader::new(file);
     let mut infos = Vec::new();
 
@@ -574,7 +569,7 @@ fn parse_mount_table(mountinfo_path: &str) -> Result<Vec<Info>> {
 
         let (_id, _parent, _major, _minor, _root, mount_point, _opts, optional) = scan_fmt!(
             &line,
-            MOUNTINFO_FORMAT,
+            MOUNTINFOFORMAT,
             i32,
             i32,
             i32,
@@ -583,17 +578,12 @@ fn parse_mount_table(mountinfo_path: &str) -> Result<Vec<Info>> {
             String,
             String,
             String
-        )
-        .map_err(|_| anyhow!(ERR_FAILED_PARSE_MOUNTINFO))?;
+        )?;
 
         let fields: Vec<&str> = line.split(" - ").collect();
         if fields.len() == 2 {
-            let final_fields: Vec<&str> = fields[1].split_whitespace().collect();
-
-            if final_fields.len() != 3 {
-                return Err(anyhow!(ERR_FAILED_PARSE_MOUNTINFO_FINAL_FIELDS));
-            }
-            let fstype = final_fields[0].to_string();
+            let (fstype, _source, _vfs_opts) =
+                scan_fmt!(fields[1], "{} {} {}", String, String, String)?;
 
             let mut optional_new = String::new();
             if optional != "-" {
@@ -608,7 +598,7 @@ fn parse_mount_table(mountinfo_path: &str) -> Result<Vec<Info>> {
 
             infos.push(info);
         } else {
-            return Err(anyhow!(ERR_FAILED_PARSE_MOUNTINFO));
+            return Err(anyhow!("failed to parse mount info file".to_string()));
         }
     }
 
@@ -629,7 +619,7 @@ fn chroot<P: ?Sized + NixPath>(_path: &P) -> Result<(), nix::Error> {
 
 pub fn ms_move_root(rootfs: &str) -> Result<bool> {
     unistd::chdir(rootfs)?;
-    let mount_infos = parse_mount_table(MOUNTINFO_PATH)?;
+    let mount_infos = parse_mount_table()?;
 
     let root_path = Path::new(rootfs);
     let abs_root_buf = root_path.absolutize()?;
@@ -780,31 +770,18 @@ fn mount_from(
             Path::new(&dest).parent().unwrap()
         };
 
-        fs::create_dir_all(&dir).map_err(|e| {
+        let _ = fs::create_dir_all(&dir).map_err(|e| {
             log_child!(
                 cfd_log,
                 "create dir {}: {}",
                 dir.to_str().unwrap(),
                 e.to_string()
-            );
-            e
-        })?;
+            )
+        });
 
         // make sure file exists so we can bind over it
         if !src.is_dir() {
-            let _ = OpenOptions::new()
-                .create(true)
-                .write(true)
-                .open(&dest)
-                .map_err(|e| {
-                    log_child!(
-                        cfd_log,
-                        "open/create dest error. {}: {:?}",
-                        dest.as_str(),
-                        e
-                    );
-                    e
-                })?;
+            let _ = OpenOptions::new().create(true).write(true).open(&dest);
         }
         src.to_str().unwrap().to_string()
     } else {
@@ -817,10 +794,8 @@ fn mount_from(
         }
     };
 
-    let _ = stat::stat(dest.as_str()).map_err(|e| {
-        log_child!(cfd_log, "dest stat error. {}: {:?}", dest.as_str(), e);
-        e
-    })?;
+    let _ = stat::stat(dest.as_str())
+        .map_err(|e| log_child!(cfd_log, "dest stat error. {}: {:?}", dest.as_str(), e));
 
     mount(
         Some(src.as_str()),
@@ -1071,12 +1046,10 @@ fn readonly_path(path: &str) -> Result<()> {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::assert_result;
     use crate::skip_if_not_root;
     use std::fs::create_dir;
     use std::fs::create_dir_all;
     use std::fs::remove_dir_all;
-    use std::io;
     use std::os::unix::fs;
     use std::os::unix::io::AsRawFd;
     use tempfile::tempdir;
@@ -1313,113 +1286,6 @@ mod tests {
         let ret = stat::stat(path);
         assert!(ret.is_ok(), "Should pass. Got: {:?}", ret);
     }
-
-    #[test]
-    fn test_mount_from() {
-        #[derive(Debug)]
-        struct TestData<'a> {
-            source: &'a str,
-            destination: &'a str,
-            r#type: &'a str,
-            flags: MsFlags,
-            error_contains: &'a str,
-
-            // if true, a directory will be created at path in source
-            make_source_directory: bool,
-            // if true, a file will be created at path in source
-            make_source_file: bool,
-        }
-
-        impl Default for TestData<'_> {
-            fn default() -> Self {
-                TestData {
-                    source: "tmp",
-                    destination: "dest",
-                    r#type: "tmpfs",
-                    flags: MsFlags::empty(),
-                    error_contains: "",
-                    make_source_directory: true,
-                    make_source_file: false,
-                }
-            }
-        }
-
-        let tests = &[
-            TestData {
-                ..Default::default()
-            },
-            TestData {
-                flags: MsFlags::MS_BIND,
-                ..Default::default()
-            },
-            TestData {
-                r#type: "bind",
-                ..Default::default()
-            },
-            TestData {
-                r#type: "cgroup2",
-                ..Default::default()
-            },
-            TestData {
-                r#type: "bind",
-                make_source_directory: false,
-                error_contains: &format!("{}", std::io::Error::from_raw_os_error(libc::ENOENT)),
-                ..Default::default()
-            },
-            TestData {
-                r#type: "bind",
-                make_source_directory: false,
-                make_source_file: true,
-                ..Default::default()
-            },
-        ];
-
-        for (i, d) in tests.iter().enumerate() {
-            let msg = format!("test[{}]: {:?}", i, d);
-            let tempdir = tempdir().unwrap();
-
-            let (rfd, wfd) = unistd::pipe2(OFlag::O_CLOEXEC).unwrap();
-            defer!({
-                unistd::close(rfd).unwrap();
-                unistd::close(wfd).unwrap();
-            });
-
-            let source_path = tempdir.path().join(d.source).to_str().unwrap().to_string();
-            if d.make_source_directory {
-                std::fs::create_dir_all(&source_path).unwrap();
-            } else if d.make_source_file {
-                std::fs::write(&source_path, []).unwrap();
-            }
-
-            let mount = Mount {
-                source: source_path,
-                destination: d.destination.to_string(),
-                r#type: d.r#type.to_string(),
-                options: vec![],
-            };
-
-            let result = mount_from(
-                wfd,
-                &mount,
-                tempdir.path().to_str().unwrap(),
-                d.flags,
-                "",
-                "",
-            );
-
-            let msg = format!("{}: result: {:?}", msg, result);
-
-            if d.error_contains.is_empty() {
-                assert!(result.is_ok(), "{}", msg);
-            } else {
-                assert!(result.is_err(), "{}", msg);
-
-                let error_msg = format!("{}", result.unwrap_err());
-                assert!(error_msg.contains(d.error_contains), "{}", msg);
-            }
-        }
-    }
-
     #[test]
     fn test_check_proc_mount() {
         let mount = oci::Mount {
@@ -1535,121 +1401,6 @@ mod tests {
         }
     }
 
-    #[test]
-    fn test_parse_mount_table() {
-        #[derive(Debug)]
-        struct TestData<'a> {
-            mountinfo_data: Option<&'a str>,
-            result: Result<Vec<Info>>,
-        }
-
-        let tests = &[
-            TestData {
-                mountinfo_data: Some(
-                    "22 933 0:20 / /sys rw,nodev shared:2 - sysfs sysfs rw,noexec",
-                ),
-                result: Ok(vec![Info {
-                    mount_point: "/sys".to_string(),
-                    optional: "shared:2".to_string(),
-                    fstype: "sysfs".to_string(),
-                }]),
-            },
-            TestData {
-                mountinfo_data: Some(
-                    r#"22 933 0:20 / /sys rw,nodev - sysfs sysfs rw,noexec
-                       81 13 1:2 / /tmp/dir rw shared:2 - tmpfs tmpfs rw"#,
-                ),
-                result: Ok(vec![
-                    Info {
-                        mount_point: "/sys".to_string(),
-                        optional: "".to_string(),
-                        fstype: "sysfs".to_string(),
-                    },
-                    Info {
-                        mount_point: "/tmp/dir".to_string(),
-                        optional: "shared:2".to_string(),
-                        fstype: "tmpfs".to_string(),
-                    },
-                ]),
-            },
-            TestData {
-                mountinfo_data: Some(
-                    "22 933 0:20 /foo\040-\040bar /sys rw,nodev shared:2 - sysfs sysfs rw,noexec",
-                ),
-                result: Ok(vec![Info {
-                    mount_point: "/sys".to_string(),
-                    optional: "shared:2".to_string(),
-                    fstype: "sysfs".to_string(),
-                }]),
-            },
-            TestData {
-                mountinfo_data: Some(""),
-                result: Ok(vec![]),
-            },
-            TestData {
-                mountinfo_data: Some("invalid line data - sysfs sysfs rw"),
-                result: Err(anyhow!(ERR_FAILED_PARSE_MOUNTINFO)),
-            },
-            TestData {
-                mountinfo_data: Some("22 96 0:21 / /sys rw,noexec - sysfs"),
-                result: Err(anyhow!(ERR_FAILED_PARSE_MOUNTINFO_FINAL_FIELDS)),
-            },
-            TestData {
-                mountinfo_data: Some("22 96 0:21 / /sys rw,noexec - sysfs sysfs rw rw"),
-                result: Err(anyhow!(ERR_FAILED_PARSE_MOUNTINFO_FINAL_FIELDS)),
-            },
-            TestData {
-                mountinfo_data: Some("22 96 0:21 / /sys rw,noexec shared:2 - x - x"),
-                result: Err(anyhow!(ERR_FAILED_PARSE_MOUNTINFO)),
-            },
-            TestData {
-                mountinfo_data: Some("-"),
-                result: Err(anyhow!(ERR_FAILED_PARSE_MOUNTINFO)),
-            },
-            TestData {
-                mountinfo_data: Some("--"),
-                result: Err(anyhow!(ERR_FAILED_PARSE_MOUNTINFO)),
-            },
-            TestData {
-                mountinfo_data: Some("- -"),
-                result: Err(anyhow!(ERR_FAILED_PARSE_MOUNTINFO)),
-            },
-            TestData {
-                mountinfo_data: Some(" - "),
-                result: Err(anyhow!(ERR_FAILED_PARSE_MOUNTINFO)),
-            },
-            TestData {
-                mountinfo_data: Some(
-                    r#"22 933 0:20 / /sys rw,nodev - sysfs sysfs rw,noexec
-                       invalid line
-                       81 13 1:2 / /tmp/dir rw shared:2 - tmpfs tmpfs rw"#,
-                ),
-                result: Err(anyhow!(ERR_FAILED_PARSE_MOUNTINFO)),
-            },
-            TestData {
-                mountinfo_data: None,
-                result: Err(anyhow!(io::Error::from_raw_os_error(libc::ENOENT))),
-            },
-        ];
-
-        for (i, d) in tests.iter().enumerate() {
-            let msg = format!("test[{}]: {:?}", i, d);
-
-            let tempdir = tempdir().unwrap();
-            let mountinfo_path = tempdir.path().join("mountinfo");
-
-            if let Some(mountinfo_data) = d.mountinfo_data {
-                std::fs::write(&mountinfo_path, mountinfo_data).unwrap();
-            }
-
-            let result = parse_mount_table(mountinfo_path.to_str().unwrap());
-
-            let msg = format!("{}: result: {:?}", msg, result);
-
-            assert_result!(d.result, result, msg);
-        }
-    }
-
     #[test]
     fn test_dev_rel_path() {
         // Valid device paths

src/agent/rustjail/src/process.rs

@@ -5,7 +5,7 @@
 
 use libc::pid_t;
 use std::fs::File;
-use std::os::unix::io::{AsRawFd, RawFd};
+use std::os::unix::io::RawFd;
 use tokio::sync::mpsc::Sender;
 
 use nix::errno::Errno;
@@ -28,6 +28,7 @@ macro_rules! close_process_stream {
     ($self: ident, $stream:ident, $stream_type: ident) => {
         if $self.$stream.is_some() {
             $self.close_stream(StreamType::$stream_type);
+            let _ = unistd::close($self.$stream.unwrap());
             $self.$stream = None;
         }
     };
@@ -136,25 +137,19 @@ impl Process {
         info!(logger, "before create console socket!");
 
         if !p.tty {
-            if cfg!(feature = "standard-oci-runtime") {
-                p.stdin = Some(std::io::stdin().as_raw_fd());
-                p.stdout = Some(std::io::stdout().as_raw_fd());
-                p.stderr = Some(std::io::stderr().as_raw_fd());
-            } else {
-                info!(logger, "created console socket!");
+            info!(logger, "created console socket!");
 
-                let (stdin, pstdin) = unistd::pipe2(OFlag::O_CLOEXEC)?;
-                p.parent_stdin = Some(pstdin);
-                p.stdin = Some(stdin);
+            let (stdin, pstdin) = unistd::pipe2(OFlag::O_CLOEXEC)?;
+            p.parent_stdin = Some(pstdin);
+            p.stdin = Some(stdin);
 
-                let (pstdout, stdout) = create_extended_pipe(OFlag::O_CLOEXEC, pipe_size)?;
-                p.parent_stdout = Some(pstdout);
-                p.stdout = Some(stdout);
+            let (pstdout, stdout) = create_extended_pipe(OFlag::O_CLOEXEC, pipe_size)?;
+            p.parent_stdout = Some(pstdout);
+            p.stdout = Some(stdout);
 
-                let (pstderr, stderr) = create_extended_pipe(OFlag::O_CLOEXEC, pipe_size)?;
-                p.parent_stderr = Some(pstderr);
-                p.stderr = Some(stderr);
-            }
+            let (pstderr, stderr) = create_extended_pipe(OFlag::O_CLOEXEC, pipe_size)?;
+            p.parent_stderr = Some(pstderr);
+            p.stderr = Some(stderr);
         }
         Ok(p)
     }
@@ -224,7 +219,7 @@ impl Process {
         Some(writer)
     }
 
-    fn close_stream(&mut self, stream_type: StreamType) {
+    pub fn close_stream(&mut self, stream_type: StreamType) {
         let _ = self.readers.remove(&stream_type);
         let _ = self.writers.remove(&stream_type);
     }
@@ -289,11 +284,5 @@ mod tests {
         // group of the calling process.
         process.pid = 0;
         assert!(process.signal(libc::SIGCONT).is_ok());
-
-        if cfg!(feature = "standard-oci-runtime") {
-            assert_eq!(process.stdin.unwrap(), std::io::stdin().as_raw_fd());
-            assert_eq!(process.stdout.unwrap(), std::io::stdout().as_raw_fd());
-            assert_eq!(process.stderr.unwrap(), std::io::stderr().as_raw_fd());
-        }
     }
 }

src/agent/rustjail/src/specconv.rs

@@ -5,7 +5,7 @@
 
 use oci::Spec;
 
-#[derive(Serialize, Deserialize, Debug, Default, Clone)]
+#[derive(Debug)]
 pub struct CreateOpts {
     pub cgroup_name: String,
     pub use_systemd_cgroup: bool,

src/agent/rustjail/src/utils.rs

@@ -0,0 +1,119 @@
+// Copyright (c) 2021 Ant Group
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+use anyhow::{anyhow, Context, Result};
+use libc::gid_t;
+use libc::uid_t;
+use std::fs::File;
+use std::io::{BufRead, BufReader};
+
+const PASSWD_FILE: &str = "/etc/passwd";
+
+// An entry from /etc/passwd
+#[derive(Debug, PartialEq, PartialOrd)]
+pub struct PasswdEntry {
+    // username
+    pub name: String,
+    // user password
+    pub passwd: String,
+    // user id
+    pub uid: uid_t,
+    // group id
+    pub gid: gid_t,
+    // user Information
+    pub gecos: String,
+    // home directory
+    pub dir: String,
+    // User's Shell
+    pub shell: String,
+}
+
+// get an entry for a given `uid` from `/etc/passwd`
+fn get_entry_by_uid(uid: uid_t, path: &str) -> Result<PasswdEntry> {
+    let file = File::open(path).with_context(|| format!("open file {}", path))?;
+    let mut reader = BufReader::new(file);
+
+    let mut line = String::new();
+    loop {
+        line.clear();
+        match reader.read_line(&mut line) {
+            Ok(0) => return Err(anyhow!(format!("file {} is empty", path))),
+            Ok(_) => (),
+            Err(e) => {
+                return Err(anyhow!(format!(
+                    "failed to read file {} with {:?}",
+                    path, e
+                )))
+            }
+        }
+
+        if line.starts_with('#') {
+            continue;
+        }
+
+        let parts: Vec<&str> = line.split(':').map(|part| part.trim()).collect();
+        if parts.len() != 7 {
+            continue;
+        }
+
+        match parts[2].parse() {
+            Err(_e) => continue,
+            Ok(new_uid) => {
+                if uid != new_uid {
+                    continue;
+                }
+
+                let entry = PasswdEntry {
+                    name: parts[0].to_string(),
+                    passwd: parts[1].to_string(),
+                    uid: new_uid,
+                    gid: parts[3].parse().unwrap_or(0),
+                    gecos: parts[4].to_string(),
+                    dir: parts[5].to_string(),
+                    shell: parts[6].to_string(),
+                };
+
+                return Ok(entry);
+            }
+        }
+    }
+}
+
+pub fn home_dir(uid: uid_t) -> Result<String> {
+    get_entry_by_uid(uid, PASSWD_FILE).map(|entry| entry.dir)
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use std::io::Write;
+    use tempfile::Builder;
+
+    #[test]
+    fn test_get_entry_by_uid() {
+        let tmpdir = Builder::new().tempdir().unwrap();
+        let tmpdir_path = tmpdir.path().to_str().unwrap();
+        let temp_passwd = format!("{}/passwd", tmpdir_path);
+
+        let mut tempf = File::create(temp_passwd.as_str()).unwrap();
+        writeln!(tempf, "root:x:0:0:root:/root0:/bin/bash").unwrap();
+        writeln!(tempf, "root:x:1:0:root:/root1:/bin/bash").unwrap();
+        writeln!(tempf, "#root:x:1:0:root:/rootx:/bin/bash").unwrap();
+        writeln!(tempf, "root:x:2:0:root:/root2:/bin/bash").unwrap();
+        writeln!(tempf, "root:x:3:0:root:/root3").unwrap();
+        writeln!(tempf, "root:x:3:0:root:/root3:/bin/bash").unwrap();
+
+        let entry = get_entry_by_uid(0, temp_passwd.as_str()).unwrap();
+        assert_eq!(entry.dir.as_str(), "/root0");
+
+        let entry = get_entry_by_uid(1, temp_passwd.as_str()).unwrap();
+        assert_eq!(entry.dir.as_str(), "/root1");
+
+        let entry = get_entry_by_uid(2, temp_passwd.as_str()).unwrap();
+        assert_eq!(entry.dir.as_str(), "/root2");
+
+        let entry = get_entry_by_uid(3, temp_passwd.as_str()).unwrap();
+        assert_eq!(entry.dir.as_str(), "/root3");
+    }
+}

src/agent/src/console.rs

@@ -9,7 +9,7 @@ use anyhow::{anyhow, Result};
 use nix::fcntl::{self, FcntlArg, FdFlag, OFlag};
 use nix::libc::{STDERR_FILENO, STDIN_FILENO, STDOUT_FILENO};
 use nix::pty::{openpty, OpenptyResult};
-use nix::sys::socket::{self, AddressFamily, SockFlag, SockType, VsockAddr};
+use nix::sys::socket::{self, AddressFamily, SockAddr, SockFlag, SockType};
 use nix::sys::stat::Mode;
 use nix::sys::wait;
 use nix::unistd::{self, close, dup2, fork, setsid, ForkResult, Pid};
@@ -67,7 +67,7 @@ pub async fn debug_console_handler(
             SockFlag::SOCK_CLOEXEC,
             None,
         )?;
-        let addr = VsockAddr::new(libc::VMADDR_CID_ANY, port);
+        let addr = SockAddr::new_vsock(libc::VMADDR_CID_ANY, port);
         socket::bind(listenfd, &addr)?;
         socket::listen(listenfd, 1)?;
 

src/agent/src/main.rs

@@ -22,11 +22,12 @@ extern crate slog;
 use anyhow::{anyhow, Context, Result};
 use clap::{AppSettings, Parser};
 use nix::fcntl::OFlag;
-use nix::sys::socket::{self, AddressFamily, SockFlag, SockType, VsockAddr};
+use nix::sys::socket::{self, AddressFamily, SockAddr, SockFlag, SockType};
 use nix::unistd::{self, dup, Pid};
 use std::env;
 use std::ffi::OsStr;
 use std::fs::{self, File};
+use std::os::unix::ffi::OsStrExt;
 use std::os::unix::fs as unixfs;
 use std::os::unix::io::AsRawFd;
 use std::path::Path;
@@ -110,6 +111,10 @@ enum SubCommand {
 fn announce(logger: &Logger, config: &AgentConfig) {
     info!(logger, "announce";
     "agent-commit" => version::VERSION_COMMIT,
+
+    // Avoid any possibility of confusion with the old agent
+    "agent-type" => "rust",
+
     "agent-version" =>  version::AGENT_VERSION,
     "api-version" => version::API_VERSION,
     "config" => format!("{:?}", config),
@@ -120,7 +125,9 @@ fn announce(logger: &Logger, config: &AgentConfig) {
 // output to the vsock port specified, or stdout.
 async fn create_logger_task(rfd: RawFd, vsock_port: u32, shutdown: Receiver<bool>) -> Result<()> {
     let mut reader = PipeStream::from_fd(rfd);
-    let mut writer: Box<dyn AsyncWrite + Unpin + Send> = if vsock_port > 0 {
+    let mut writer: Box<dyn AsyncWrite + Unpin + Send>;
+
+    if vsock_port > 0 {
         let listenfd = socket::socket(
             AddressFamily::Vsock,
             SockType::Stream,
@@ -128,14 +135,14 @@ async fn create_logger_task(rfd: RawFd, vsock_port: u32, shutdown: Receiver<bool
             None,
         )?;
 
-        let addr = VsockAddr::new(libc::VMADDR_CID_ANY, vsock_port);
+        let addr = SockAddr::new_vsock(libc::VMADDR_CID_ANY, vsock_port);
         socket::bind(listenfd, &addr)?;
         socket::listen(listenfd, 1)?;
 
-        Box::new(util::get_vsock_stream(listenfd).await?)
+        writer = Box::new(util::get_vsock_stream(listenfd).await?);
     } else {
-        Box::new(tokio::io::stdout())
-    };
+        writer = Box::new(tokio::io::stdout());
+    }
 
     let _ = util::interruptable_io_copier(&mut reader, &mut writer, shutdown).await;
 
@@ -209,7 +216,7 @@ async fn real_main() -> std::result::Result<(), Box<dyn std::error::Error>> {
 
     if config.log_level == slog::Level::Trace {
         // Redirect ttrpc log calls to slog iff full debug requested
-        ttrpc_log_guard = Ok(slog_stdlog::init()?);
+        ttrpc_log_guard = Ok(slog_stdlog::init().map_err(|e| e)?);
     }
 
     if config.tracing {
@@ -377,13 +384,27 @@ fn init_agent_as_init(logger: &Logger, unified_cgroup_hierarchy: bool) -> Result
     let contents_array: Vec<&str> = contents.split(' ').collect();
     let hostname = contents_array[0].trim();
 
-    if unistd::sethostname(OsStr::new(hostname)).is_err() {
+    if sethostname(OsStr::new(hostname)).is_err() {
         warn!(logger, "failed to set hostname");
     }
 
     Ok(())
 }
 
+#[instrument]
+fn sethostname(hostname: &OsStr) -> Result<()> {
+    let size = hostname.len() as usize;
+
+    let result =
+        unsafe { libc::sethostname(hostname.as_bytes().as_ptr() as *const libc::c_char, size) };
+
+    if result != 0 {
+        Err(anyhow!("failed to set hostname"))
+    } else {
+        Ok(())
+    }
+}
+
 // The Rust standard library had suppressed the default SIGPIPE behavior,
 // see https://github.com/rust-lang/rust/pull/13158.
 // Since the parent's signal handler would be inherited by it's child process,
@@ -397,59 +418,3 @@ fn reset_sigpipe() {
 
 use crate::config::AgentConfig;
 use std::os::unix::io::{FromRawFd, RawFd};
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use crate::test_utils::test_utils::TestUserType;
-
-    #[tokio::test]
-    async fn test_create_logger_task() {
-        #[derive(Debug)]
-        struct TestData {
-            vsock_port: u32,
-            test_user: TestUserType,
-            result: Result<()>,
-        }
-
-        let tests = &[
-            TestData {
-                // non-root user cannot use privileged vsock port
-                vsock_port: 1,
-                test_user: TestUserType::NonRootOnly,
-                result: Err(anyhow!(nix::errno::Errno::from_i32(libc::EACCES))),
-            },
-            TestData {
-                // passing vsock_port 0 causes logger task to write to stdout
-                vsock_port: 0,
-                test_user: TestUserType::Any,
-                result: Ok(()),
-            },
-        ];
-
-        for (i, d) in tests.iter().enumerate() {
-            if d.test_user == TestUserType::RootOnly {
-                skip_if_not_root!();
-            } else if d.test_user == TestUserType::NonRootOnly {
-                skip_if_root!();
-            }
-
-            let msg = format!("test[{}]: {:?}", i, d);
-            let (rfd, wfd) = unistd::pipe2(OFlag::O_CLOEXEC).unwrap();
-            defer!({
-                // rfd is closed by the use of PipeStream in the crate_logger_task function,
-                // but we will attempt to close in case of a failure
-                let _ = unistd::close(rfd);
-                unistd::close(wfd).unwrap();
-            });
-
-            let (shutdown_tx, shutdown_rx) = channel(true);
-
-            shutdown_tx.send(true).unwrap();
-            let result = create_logger_task(rfd, d.vsock_port, shutdown_rx).await;
-
-            let msg = format!("{}, result: {:?}", msg, result);
-            assert_result!(d.result, result, msg);
-        }
-    }
-}

src/agent/src/metrics.rs

@@ -344,25 +344,25 @@ fn set_gauge_vec_meminfo(gv: &prometheus::GaugeVec, meminfo: &procfs::Meminfo) {
 #[instrument]
 fn set_gauge_vec_cpu_time(gv: &prometheus::GaugeVec, cpu: &str, cpu_time: &procfs::CpuTime) {
     gv.with_label_values(&[cpu, "user"])
-        .set(cpu_time.user_ms() as f64);
+        .set(cpu_time.user as f64);
     gv.with_label_values(&[cpu, "nice"])
-        .set(cpu_time.nice_ms() as f64);
+        .set(cpu_time.nice as f64);
     gv.with_label_values(&[cpu, "system"])
-        .set(cpu_time.system_ms() as f64);
+        .set(cpu_time.system as f64);
     gv.with_label_values(&[cpu, "idle"])
-        .set(cpu_time.idle_ms() as f64);
+        .set(cpu_time.idle as f64);
     gv.with_label_values(&[cpu, "iowait"])
-        .set(cpu_time.iowait_ms().unwrap_or(0) as f64);
+        .set(cpu_time.iowait.unwrap_or(0) as f64);
     gv.with_label_values(&[cpu, "irq"])
-        .set(cpu_time.irq_ms().unwrap_or(0) as f64);
+        .set(cpu_time.irq.unwrap_or(0) as f64);
     gv.with_label_values(&[cpu, "softirq"])
-        .set(cpu_time.softirq_ms().unwrap_or(0) as f64);
+        .set(cpu_time.softirq.unwrap_or(0) as f64);
     gv.with_label_values(&[cpu, "steal"])
-        .set(cpu_time.steal_ms().unwrap_or(0) as f64);
+        .set(cpu_time.steal.unwrap_or(0) as f64);
     gv.with_label_values(&[cpu, "guest"])
-        .set(cpu_time.guest_ms().unwrap_or(0) as f64);
+        .set(cpu_time.guest.unwrap_or(0) as f64);
     gv.with_label_values(&[cpu, "guest_nice"])
-        .set(cpu_time.guest_nice_ms().unwrap_or(0) as f64);
+        .set(cpu_time.guest_nice.unwrap_or(0) as f64);
 }
 
 #[instrument]

src/agent/src/mount.rs

@@ -91,11 +91,11 @@ lazy_static! {
 }
 
 #[derive(Debug, PartialEq)]
-pub struct InitMount<'a> {
-    fstype: &'a str,
-    src: &'a str,
-    dest: &'a str,
-    options: Vec<&'a str>,
+pub struct InitMount {
+    fstype: &'static str,
+    src: &'static str,
+    dest: &'static str,
+    options: Vec<&'static str>,
 }
 
 #[rustfmt::skip]
@@ -121,7 +121,7 @@ lazy_static!{
 
 #[rustfmt::skip]
 lazy_static! {
-    pub static ref INIT_ROOTFS_MOUNTS: Vec<InitMount<'static>> = vec![
+    pub static ref INIT_ROOTFS_MOUNTS: Vec<InitMount> = vec![
         InitMount{fstype: "proc", src: "proc", dest: "/proc", options: vec!["nosuid", "nodev", "noexec"]},
         InitMount{fstype: "sysfs", src: "sysfs", dest: "/sys", options: vec!["nosuid", "nodev", "noexec"]},
         InitMount{fstype: "devtmpfs", src: "dev", dest: "/dev", options: vec!["nosuid"]},
@@ -840,13 +840,15 @@ pub fn get_mount_fs_type_from_file(mount_file: &str, mount_point: &str) -> Resul
         return Err(anyhow!("Invalid mount point {}", mount_point));
     }
 
-    let content = fs::read_to_string(mount_file)?;
+    let file = File::open(mount_file)?;
+    let reader = BufReader::new(file);
 
     let re = Regex::new(format!("device .+ mounted on {} with fstype (.+)", mount_point).as_str())?;
 
     // Read the file line by line using the lines() iterator from std::io::BufRead.
-    for (_index, line) in content.lines().enumerate() {
-        let capes = match re.captures(line) {
+    for (_index, line) in reader.lines().enumerate() {
+        let line = line?;
+        let capes = match re.captures(line.as_str()) {
             Some(c) => c,
             None => continue,
         };
@@ -857,9 +859,8 @@ pub fn get_mount_fs_type_from_file(mount_file: &str, mount_point: &str) -> Resul
     }
 
     Err(anyhow!(
-        "failed to find FS type for mount point {}, mount file content: {:?}",
-        mount_point,
-        content
+        "failed to find FS type for mount point {}",
+        mount_point
     ))
 }
 
@@ -868,7 +869,7 @@ pub fn get_cgroup_mounts(
     logger: &Logger,
     cg_path: &str,
     unified_cgroup_hierarchy: bool,
-) -> Result<Vec<InitMount<'static>>> {
+) -> Result<Vec<InitMount>> {
     // cgroup v2
     // https://github.com/kata-containers/agent/blob/8c9bbadcd448c9a67690fbe11a860aaacc69813c/agent.go#L1249
     if unified_cgroup_hierarchy {
@@ -1016,8 +1017,7 @@ fn parse_options(option_list: Vec<String>) -> HashMap<String, String> {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::test_utils::test_utils::TestUserType;
-    use crate::{skip_if_not_root, skip_loop_by_user, skip_loop_if_not_root, skip_loop_if_root};
+    use crate::{skip_if_not_root, skip_loop_if_not_root, skip_loop_if_root};
     use protobuf::RepeatedField;
     use protocols::agent::FSGroup;
     use std::fs::File;
@@ -1026,6 +1026,13 @@ mod tests {
     use std::path::PathBuf;
     use tempfile::tempdir;
 
+    #[derive(Debug, PartialEq)]
+    enum TestUserType {
+        RootOnly,
+        NonRootOnly,
+        Any,
+    }
+
     #[test]
     fn test_mount() {
         #[derive(Debug)]
@@ -1111,7 +1118,11 @@ mod tests {
         for (i, d) in tests.iter().enumerate() {
             let msg = format!("test[{}]: {:?}", i, d);
 
-            skip_loop_by_user!(msg, d.test_user);
+            if d.test_user == TestUserType::RootOnly {
+                skip_loop_if_not_root!(msg);
+            } else if d.test_user == TestUserType::NonRootOnly {
+                skip_loop_if_root!(msg);
+            }
 
             let src: PathBuf;
             let dest: PathBuf;
@@ -1120,7 +1131,7 @@ mod tests {
             let dest_filename: String;
 
             if !d.src.is_empty() {
-                src = dir.path().join(d.src);
+                src = dir.path().join(d.src.to_string());
                 src_filename = src
                     .to_str()
                     .expect("failed to convert src to filename")
@@ -1130,7 +1141,7 @@ mod tests {
             }
 
             if !d.dest.is_empty() {
-                dest = dir.path().join(d.dest);
+                dest = dir.path().join(d.dest.to_string());
                 dest_filename = dest
                     .to_str()
                     .expect("failed to convert dest to filename")
@@ -1581,226 +1592,6 @@ mod tests {
         assert!(testfile.is_file());
     }
 
-    #[test]
-    fn test_mount_storage() {
-        #[derive(Debug)]
-        struct TestData<'a> {
-            test_user: TestUserType,
-            storage: Storage,
-            error_contains: &'a str,
-
-            make_source_dir: bool,
-            make_mount_dir: bool,
-            deny_mount_permission: bool,
-        }
-
-        impl Default for TestData<'_> {
-            fn default() -> Self {
-                TestData {
-                    test_user: TestUserType::Any,
-                    storage: Storage {
-                        mount_point: "mnt".to_string(),
-                        source: "src".to_string(),
-                        fstype: "tmpfs".to_string(),
-                        ..Default::default()
-                    },
-                    make_source_dir: true,
-                    make_mount_dir: false,
-                    deny_mount_permission: false,
-                    error_contains: "",
-                }
-            }
-        }
-
-        let tests = &[
-            TestData {
-                test_user: TestUserType::NonRootOnly,
-                error_contains: "EPERM: Operation not permitted",
-                ..Default::default()
-            },
-            TestData {
-                test_user: TestUserType::RootOnly,
-                ..Default::default()
-            },
-            TestData {
-                storage: Storage {
-                    mount_point: "mnt".to_string(),
-                    source: "src".to_string(),
-                    fstype: "bind".to_string(),
-                    ..Default::default()
-                },
-                make_source_dir: false,
-                make_mount_dir: true,
-                error_contains: "Could not create mountpoint",
-                ..Default::default()
-            },
-            TestData {
-                test_user: TestUserType::NonRootOnly,
-                deny_mount_permission: true,
-                error_contains: "Could not create mountpoint",
-                ..Default::default()
-            },
-        ];
-
-        for (i, d) in tests.iter().enumerate() {
-            let msg = format!("test[{}]: {:?}", i, d);
-
-            skip_loop_by_user!(msg, d.test_user);
-
-            let drain = slog::Discard;
-            let logger = slog::Logger::root(drain, o!());
-
-            let tempdir = tempdir().unwrap();
-
-            let source = tempdir.path().join(&d.storage.source);
-            let mount_point = tempdir.path().join(&d.storage.mount_point);
-
-            let storage = Storage {
-                source: source.to_str().unwrap().to_string(),
-                mount_point: mount_point.to_str().unwrap().to_string(),
-                ..d.storage.clone()
-            };
-
-            if d.make_source_dir {
-                fs::create_dir_all(&storage.source).unwrap();
-            }
-            if d.make_mount_dir {
-                fs::create_dir_all(&storage.mount_point).unwrap();
-            }
-
-            if d.deny_mount_permission {
-                fs::set_permissions(
-                    mount_point.parent().unwrap(),
-                    fs::Permissions::from_mode(0o000),
-                )
-                .unwrap();
-            }
-
-            let result = mount_storage(&logger, &storage);
-
-            // restore permissions so tempdir can be cleaned up
-            if d.deny_mount_permission {
-                fs::set_permissions(
-                    mount_point.parent().unwrap(),
-                    fs::Permissions::from_mode(0o755),
-                )
-                .unwrap();
-            }
-
-            if result.is_ok() {
-                nix::mount::umount(&mount_point).unwrap();
-            }
-
-            let msg = format!("{}: result: {:?}", msg, result);
-            if d.error_contains.is_empty() {
-                assert!(result.is_ok(), "{}", msg);
-            } else {
-                assert!(result.is_err(), "{}", msg);
-                let error_msg = format!("{}", result.unwrap_err());
-                assert!(error_msg.contains(d.error_contains), "{}", msg);
-            }
-        }
-    }
-
-    #[test]
-    fn test_mount_to_rootfs() {
-        #[derive(Debug)]
-        struct TestData<'a> {
-            test_user: TestUserType,
-            src: &'a str,
-            options: Vec<&'a str>,
-            error_contains: &'a str,
-            deny_mount_dir_permission: bool,
-            // if true src will be prepended with a temporary directory
-            mask_src: bool,
-        }
-
-        impl Default for TestData<'_> {
-            fn default() -> Self {
-                TestData {
-                    test_user: TestUserType::Any,
-                    src: "src",
-                    options: vec![],
-                    error_contains: "",
-                    deny_mount_dir_permission: false,
-                    mask_src: true,
-                }
-            }
-        }
-
-        let tests = &[
-            TestData {
-                test_user: TestUserType::NonRootOnly,
-                error_contains: "EPERM: Operation not permitted",
-                ..Default::default()
-            },
-            TestData {
-                test_user: TestUserType::NonRootOnly,
-                src: "dev",
-                mask_src: false,
-                ..Default::default()
-            },
-            TestData {
-                test_user: TestUserType::RootOnly,
-                ..Default::default()
-            },
-            TestData {
-                test_user: TestUserType::NonRootOnly,
-                deny_mount_dir_permission: true,
-                error_contains: "could not create directory",
-                ..Default::default()
-            },
-        ];
-
-        for (i, d) in tests.iter().enumerate() {
-            let msg = format!("test[{}]: {:?}", i, d);
-            skip_loop_by_user!(msg, d.test_user);
-
-            let drain = slog::Discard;
-            let logger = slog::Logger::root(drain, o!());
-            let tempdir = tempdir().unwrap();
-
-            let src = if d.mask_src {
-                tempdir.path().join(&d.src)
-            } else {
-                Path::new(d.src).to_path_buf()
-            };
-            let dest = tempdir.path().join("mnt");
-            let init_mount = InitMount {
-                fstype: "tmpfs",
-                src: src.to_str().unwrap(),
-                dest: dest.to_str().unwrap(),
-                options: d.options.clone(),
-            };
-
-            if d.deny_mount_dir_permission {
-                fs::set_permissions(dest.parent().unwrap(), fs::Permissions::from_mode(0o000))
-                    .unwrap();
-            }
-
-            let result = mount_to_rootfs(&logger, &init_mount);
-
-            // restore permissions so tempdir can be cleaned up
-            if d.deny_mount_dir_permission {
-                fs::set_permissions(dest.parent().unwrap(), fs::Permissions::from_mode(0o755))
-                    .unwrap();
-            }
-
-            if result.is_ok() && d.mask_src {
-                nix::mount::umount(&dest).unwrap();
-            }
-
-            let msg = format!("{}: result: {:?}", msg, result);
-            if d.error_contains.is_empty() {
-                assert!(result.is_ok(), "{}", msg);
-            } else {
-                assert!(result.is_err(), "{}", msg);
-                let error_msg = format!("{}", result.unwrap_err());
-                assert!(error_msg.contains(d.error_contains), "{}", msg);
-            }
-        }
-    }
-
     #[test]
     fn test_get_pagesize_and_size_from_option() {
         let expected_pagesize = 2048;
@@ -1857,57 +1648,6 @@ mod tests {
         }
     }
 
-    #[test]
-    fn test_parse_mount_flags_and_options() {
-        #[derive(Debug)]
-        struct TestData<'a> {
-            options_vec: Vec<&'a str>,
-            result: (MsFlags, &'a str),
-        }
-
-        let tests = &[
-            TestData {
-                options_vec: vec![],
-                result: (MsFlags::empty(), ""),
-            },
-            TestData {
-                options_vec: vec!["ro"],
-                result: (MsFlags::MS_RDONLY, ""),
-            },
-            TestData {
-                options_vec: vec!["rw"],
-                result: (MsFlags::empty(), ""),
-            },
-            TestData {
-                options_vec: vec!["ro", "rw"],
-                result: (MsFlags::empty(), ""),
-            },
-            TestData {
-                options_vec: vec!["ro", "nodev"],
-                result: (MsFlags::MS_RDONLY | MsFlags::MS_NODEV, ""),
-            },
-            TestData {
-                options_vec: vec!["option1", "nodev", "option2"],
-                result: (MsFlags::MS_NODEV, "option1,option2"),
-            },
-            TestData {
-                options_vec: vec!["rbind", "", "ro"],
-                result: (MsFlags::MS_BIND | MsFlags::MS_REC | MsFlags::MS_RDONLY, ""),
-            },
-        ];
-
-        for (i, d) in tests.iter().enumerate() {
-            let msg = format!("test[{}]: {:?}", i, d);
-
-            let result = parse_mount_flags_and_options(d.options_vec.clone());
-
-            let msg = format!("{}: result: {:?}", msg, result);
-
-            let expected_result = (d.result.0, d.result.1.to_owned());
-            assert_eq!(expected_result, result, "{}", msg);
-        }
-    }
-
     #[test]
     fn test_set_ownership() {
         skip_if_not_root!();

src/agent/src/netlink.rs

@@ -4,7 +4,7 @@
 //
 
 use anyhow::{anyhow, Context, Result};
-use futures::{future, TryStreamExt};
+use futures::{future, StreamExt, TryStreamExt};
 use ipnetwork::{IpNetwork, Ipv4Network, Ipv6Network};
 use nix::errno::Errno;
 use protobuf::RepeatedField;
@@ -64,7 +64,7 @@ impl Handle {
     pub async fn update_interface(&mut self, iface: &Interface) -> Result<()> {
         // The reliable way to find link is using hardware address
         // as filter. However, hardware filter might not be supported
-        // by netlink, we may have to dump link list and then find the
+        // by netlink, we may have to dump link list and the find the
         // target link. filter using name or family is supported, but
         // we cannot use that to find target link.
         // let's try if hardware address filter works. -_-
@@ -164,7 +164,7 @@ impl Handle {
         let request = self.handle.link().get();
 
         let filtered = match filter {
-            LinkFilter::Name(name) => request.match_name(name.to_owned()),
+            LinkFilter::Name(name) => request.set_name_filter(name.to_owned()),
             LinkFilter::Index(index) => request.match_index(index),
             _ => request, // Post filters
         };
@@ -178,7 +178,7 @@ impl Handle {
                 .with_context(|| format!("Failed to parse MAC address: {}", addr))?;
 
             // Hardware filter might not be supported by netlink,
-            // we may have to dump link list and then find the target link.
+            // we may have to dump link list and the find the target link.
             stream
                 .try_filter(|f| {
                     let result = f.nlas.iter().any(|n| match n {
@@ -516,24 +516,70 @@ impl Handle {
     }
 
     /// Adds an ARP neighbor.
+    /// TODO: `rtnetlink` has no neighbours API, remove this after https://github.com/little-dude/netlink/pull/135
     async fn add_arp_neighbor(&mut self, neigh: &ARPNeighbor) -> Result<()> {
         let ip_address = neigh
             .toIPAddress
             .as_ref()
             .map(|to| to.address.as_str()) // Extract address field
             .and_then(|addr| if addr.is_empty() { None } else { Some(addr) }) // Make sure it's not empty
-            .ok_or_else(|| anyhow!(nix::Error::EINVAL))?;
+            .ok_or(anyhow!(nix::Error::EINVAL))?;
 
         let ip = IpAddr::from_str(ip_address)
             .map_err(|e| anyhow!("Failed to parse IP {}: {:?}", ip_address, e))?;
 
+        // Import rtnetlink objects that make sense only for this function
+        use packet::constants::{NDA_UNSPEC, NLM_F_ACK, NLM_F_CREATE, NLM_F_EXCL, NLM_F_REQUEST};
+        use packet::neighbour::{NeighbourHeader, NeighbourMessage};
+        use packet::nlas::neighbour::Nla;
+        use packet::{NetlinkMessage, NetlinkPayload, RtnlMessage};
+        use rtnetlink::Error;
+
+        const IFA_F_PERMANENT: u16 = 0x80; // See https://github.com/little-dude/netlink/blob/0185b2952505e271805902bf175fee6ea86c42b8/netlink-packet-route/src/rtnl/constants.rs#L770
+
         let link = self.find_link(LinkFilter::Name(&neigh.device)).await?;
 
-        self.handle
-            .neighbours()
-            .add(link.index(), ip)
-            .execute()
-            .await?;
+        let message = NeighbourMessage {
+            header: NeighbourHeader {
+                family: match ip {
+                    IpAddr::V4(_) => packet::AF_INET,
+                    IpAddr::V6(_) => packet::AF_INET6,
+                } as u8,
+                ifindex: link.index(),
+                state: if neigh.state != 0 {
+                    neigh.state as u16
+                } else {
+                    IFA_F_PERMANENT
+                },
+                flags: neigh.flags as u8,
+                ntype: NDA_UNSPEC as u8,
+            },
+            nlas: {
+                let mut nlas = vec![Nla::Destination(match ip {
+                    IpAddr::V4(v4) => v4.octets().to_vec(),
+                    IpAddr::V6(v6) => v6.octets().to_vec(),
+                })];
+
+                if !neigh.lladdr.is_empty() {
+                    nlas.push(Nla::LinkLocalAddress(
+                        parse_mac_address(&neigh.lladdr)?.to_vec(),
+                    ));
+                }
+
+                nlas
+            },
+        };
+
+        // Send request and ACK
+        let mut req = NetlinkMessage::from(RtnlMessage::NewNeighbour(message));
+        req.header.flags = NLM_F_REQUEST | NLM_F_ACK | NLM_F_EXCL | NLM_F_CREATE;
+
+        let mut response = self.handle.request(req)?;
+        while let Some(message) = response.next().await {
+            if let NetlinkPayload::Error(err) = message.payload {
+                return Err(anyhow!(Error::NetlinkError(err)));
+            }
+        }
 
         Ok(())
     }
@@ -566,7 +612,7 @@ fn parse_mac_address(addr: &str) -> Result<[u8; 6]> {
 
     // Parse single Mac address block
     let mut parse_next = || -> Result<u8> {
-        let v = u8::from_str_radix(split.next().ok_or_else(|| anyhow!(nix::Error::EINVAL))?, 16)?;
+        let v = u8::from_str_radix(split.next().ok_or(anyhow!(nix::Error::EINVAL))?, 16)?;
         Ok(v)
     };
 
@@ -904,7 +950,7 @@ mod tests {
             .expect("prepare: failed to delete neigh");
     }
 
-    fn prepare_env_for_test_add_one_arp_neighbor(dummy_name: &str, ip: &str, mac: &str) {
+    fn prepare_env_for_test_add_one_arp_neighbor(dummy_name: &str, ip: &str) {
         clean_env_for_test_add_one_arp_neighbor(dummy_name, ip);
         // modprobe dummy
         Command::new("modprobe")
@@ -918,12 +964,6 @@ mod tests {
             .output()
             .expect("failed to add dummy interface");
 
-        // ip link set dummy address 6a:92:3a:59:70:aa
-        Command::new("ip")
-            .args(&["link", "set", dummy_name, "address", mac])
-            .output()
-            .expect("failed to add dummy interface");
-
         // ip addr add 192.168.0.2/16 dev dummy
         Command::new("ip")
             .args(&["addr", "add", "192.168.0.2/16", "dev", dummy_name])
@@ -945,7 +985,7 @@ mod tests {
         let to_ip = "169.254.1.1";
         let dummy_name = "dummy_for_arp";
 
-        prepare_env_for_test_add_one_arp_neighbor(dummy_name, to_ip, mac);
+        prepare_env_for_test_add_one_arp_neighbor(dummy_name, to_ip);
 
         let mut ip_address = IPAddress::new();
         ip_address.set_address(to_ip.to_string());

src/agent/src/random.rs

@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
-use anyhow::{ensure, Result};
+use anyhow::Result;
 use nix::errno::Errno;
 use nix::fcntl::{self, OFlag};
 use nix::sys::stat::Mode;
@@ -13,7 +13,7 @@ use tracing::instrument;
 
 pub const RNGDEV: &str = "/dev/random";
 pub const RNDADDTOENTCNT: libc::c_int = 0x40045201;
-pub const RNDRESEEDCRNG: libc::c_int = 0x5207;
+pub const RNDRESEEDRNG: libc::c_int = 0x5207;
 
 // Handle the differing ioctl(2) request types for different targets
 #[cfg(target_env = "musl")]
@@ -24,9 +24,6 @@ type IoctlRequestType = libc::c_ulong;
 #[instrument]
 pub fn reseed_rng(data: &[u8]) -> Result<()> {
     let len = data.len() as libc::c_long;
-
-    ensure!(len > 0, "missing entropy data");
-
     fs::write(RNGDEV, data)?;
 
     let f = {
@@ -44,52 +41,8 @@ pub fn reseed_rng(data: &[u8]) -> Result<()> {
     };
     Errno::result(ret).map(drop)?;
 
-    let ret = unsafe { libc::ioctl(f.as_raw_fd(), RNDRESEEDCRNG as IoctlRequestType, 0) };
+    let ret = unsafe { libc::ioctl(f.as_raw_fd(), RNDRESEEDRNG as IoctlRequestType, 0) };
     Errno::result(ret).map(drop)?;
 
     Ok(())
 }
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use crate::skip_if_not_root;
-    use std::fs::File;
-    use std::io::prelude::*;
-
-    #[test]
-    fn test_reseed_rng() {
-        skip_if_not_root!();
-        const POOL_SIZE: usize = 512;
-        let mut f = File::open("/dev/urandom").unwrap();
-        let mut seed = [0; POOL_SIZE];
-        let n = f.read(&mut seed).unwrap();
-        // Ensure the buffer was filled.
-        assert!(n == POOL_SIZE);
-        let ret = reseed_rng(&seed);
-        assert!(ret.is_ok());
-    }
-
-    #[test]
-    fn test_reseed_rng_not_root() {
-        const POOL_SIZE: usize = 512;
-        let mut f = File::open("/dev/urandom").unwrap();
-        let mut seed = [0; POOL_SIZE];
-        let n = f.read(&mut seed).unwrap();
-        // Ensure the buffer was filled.
-        assert!(n == POOL_SIZE);
-        let ret = reseed_rng(&seed);
-        if nix::unistd::Uid::effective().is_root() {
-            assert!(ret.is_ok());
-        } else {
-            assert!(ret.is_err());
-        }
-    }
-
-    #[test]
-    fn test_reseed_rng_zero_data() {
-        let seed = [];
-        let ret = reseed_rng(&seed);
-        assert!(ret.is_err());
-    }
-}

src/agent/src/rpc.rs

@@ -23,9 +23,8 @@ use cgroups::freezer::FreezerState;
 use oci::{LinuxNamespace, Root, Spec};
 use protobuf::{Message, RepeatedField, SingularPtrField};
 use protocols::agent::{
-    AddSwapRequest, AgentDetails, CopyFileRequest, GetIPTablesRequest, GetIPTablesResponse,
-    GuestDetailsResponse, Interfaces, Metrics, OOMEvent, ReadStreamResponse, Routes,
-    SetIPTablesRequest, SetIPTablesResponse, StatsContainerResponse, VolumeStatsRequest,
+    AddSwapRequest, AgentDetails, CopyFileRequest, GuestDetailsResponse, Interfaces, Metrics,
+    OOMEvent, ReadStreamResponse, Routes, StatsContainerResponse, VolumeStatsRequest,
     WaitProcessResponse, WriteStreamResponse,
 };
 use protocols::csi::{VolumeCondition, VolumeStatsResponse, VolumeUsage, VolumeUsage_Unit};
@@ -34,7 +33,6 @@ use protocols::health::{
     HealthCheckResponse, HealthCheckResponse_ServingStatus, VersionCheckResponse,
 };
 use protocols::types::Interface;
-use protocols::{agent_ttrpc_async as agent_ttrpc, health_ttrpc_async as health_ttrpc};
 use rustjail::cgroups::notifier;
 use rustjail::container::{BaseContainer, Container, LinuxContainer};
 use rustjail::process::Process;
@@ -77,29 +75,18 @@ use std::time::Duration;
 
 use nix::unistd::{Gid, Uid};
 use std::fs::{File, OpenOptions};
-use std::io::{BufRead, BufReader, Write};
+use std::io::{BufRead, BufReader};
 use std::os::unix::fs::FileExt;
 use std::path::PathBuf;
 
 const CONTAINER_BASE: &str = "/run/kata-containers";
 const MODPROBE_PATH: &str = "/sbin/modprobe";
 
-const IPTABLES_SAVE: &str = "/sbin/iptables-save";
-const IPTABLES_RESTORE: &str = "/sbin/iptables-restore";
-const IP6TABLES_SAVE: &str = "/sbin/ip6tables-save";
-const IP6TABLES_RESTORE: &str = "/sbin/ip6tables-restore";
-
 const ERR_CANNOT_GET_WRITER: &str = "Cannot get writer";
 const ERR_INVALID_BLOCK_SIZE: &str = "Invalid block size";
 const ERR_NO_LINUX_FIELD: &str = "Spec does not contain linux field";
 const ERR_NO_SANDBOX_PIDNS: &str = "Sandbox does not have sandbox_pidns";
 
-// IPTABLES_RESTORE_WAIT_SEC is the timeout value provided to iptables-restore --wait. Since we
-// don't expect other writers to iptables, we don't expect contention for grabbing the iptables
-// filesystem lock. Based on this, 5 seconds seems a resonable timeout period in case the lock is
-// not available.
-const IPTABLES_RESTORE_WAIT_SEC: u64 = 5;
-
 // Convenience macro to obtain the scope logger
 macro_rules! sl {
     () => {
@@ -134,6 +121,30 @@ pub struct AgentService {
     sandbox: Arc<Mutex<Sandbox>>,
 }
 
+// A container ID must match this regex:
+//
+//     ^[a-zA-Z0-9][a-zA-Z0-9_.-]+$
+//
+fn verify_cid(id: &str) -> Result<()> {
+    let mut chars = id.chars();
+
+    let valid = match chars.next() {
+        Some(first)
+            if first.is_alphanumeric()
+                && id.len() > 1
+                && chars.all(|c| c.is_alphanumeric() || ['.', '-', '_'].contains(&c)) =>
+        {
+            true
+        }
+        _ => false,
+    };
+
+    match valid {
+        true => Ok(()),
+        false => Err(anyhow!("invalid container ID: {:?}", id)),
+    }
+}
+
 impl AgentService {
     #[instrument]
     async fn do_create_container(
@@ -142,7 +153,7 @@ impl AgentService {
     ) -> Result<()> {
         let cid = req.container_id.clone();
 
-        kata_sys_util::validate::verify_id(&cid)?;
+        verify_cid(&cid)?;
 
         let mut oci_spec = req.OCI.clone();
         let use_sandbox_pidns = req.get_sandbox_pidns();
@@ -246,7 +257,7 @@ impl AgentService {
             .get_container(&cid)
             .ok_or_else(|| anyhow!("Invalid container id"))?;
 
-        ctr.exec().await?;
+        ctr.exec()?;
 
         if sid == cid {
             return Ok(());
@@ -627,7 +638,7 @@ impl AgentService {
 }
 
 #[async_trait]
-impl agent_ttrpc::AgentService for AgentService {
+impl protocols::agent_ttrpc::AgentService for AgentService {
     async fn create_container(
         &self,
         ctx: &TtrpcContext,
@@ -983,140 +994,6 @@ impl agent_ttrpc::AgentService for AgentService {
         })
     }
 
-    async fn get_ip_tables(
-        &self,
-        ctx: &TtrpcContext,
-        req: GetIPTablesRequest,
-    ) -> ttrpc::Result<GetIPTablesResponse> {
-        trace_rpc_call!(ctx, "get_iptables", req);
-        is_allowed!(req);
-
-        info!(sl!(), "get_ip_tables: request received");
-
-        let cmd = if req.is_ipv6 {
-            IP6TABLES_SAVE
-        } else {
-            IPTABLES_SAVE
-        }
-        .to_string();
-
-        match Command::new(cmd.clone()).output() {
-            Ok(output) => Ok(GetIPTablesResponse {
-                data: output.stdout,
-                ..Default::default()
-            }),
-            Err(e) => {
-                warn!(sl!(), "failed to run {}: {:?}", cmd, e.kind());
-                return Err(ttrpc_error!(ttrpc::Code::INTERNAL, e));
-            }
-        }
-    }
-
-    async fn set_ip_tables(
-        &self,
-        ctx: &TtrpcContext,
-        req: SetIPTablesRequest,
-    ) -> ttrpc::Result<SetIPTablesResponse> {
-        trace_rpc_call!(ctx, "set_iptables", req);
-        is_allowed!(req);
-
-        info!(sl!(), "set_ip_tables request received");
-
-        let cmd = if req.is_ipv6 {
-            IP6TABLES_RESTORE
-        } else {
-            IPTABLES_RESTORE
-        }
-        .to_string();
-
-        let mut child = match Command::new(cmd.clone())
-            .arg("--wait")
-            .arg(IPTABLES_RESTORE_WAIT_SEC.to_string())
-            .stdin(Stdio::piped())
-            .stdout(Stdio::piped())
-            .stderr(Stdio::piped())
-            .spawn()
-        {
-            Ok(child) => child,
-            Err(e) => {
-                warn!(sl!(), "failure to spawn {}: {:?}", cmd, e.kind());
-                return Err(ttrpc_error!(ttrpc::Code::INTERNAL, e));
-            }
-        };
-
-        let mut stdin = match child.stdin.take() {
-            Some(si) => si,
-            None => {
-                println!("failed to get stdin from child");
-                return Err(ttrpc_error!(
-                    ttrpc::Code::INTERNAL,
-                    "failed to take stdin from child".to_string()
-                ));
-            }
-        };
-
-        let (tx, rx) = tokio::sync::oneshot::channel::<i32>();
-        let handle = tokio::spawn(async move {
-            let _ = match stdin.write_all(&req.data) {
-                Ok(o) => o,
-                Err(e) => {
-                    warn!(sl!(), "error writing stdin: {:?}", e.kind());
-                    return;
-                }
-            };
-            if tx.send(1).is_err() {
-                warn!(sl!(), "stdin writer thread receiver dropped");
-            };
-        });
-
-        if tokio::time::timeout(Duration::from_secs(IPTABLES_RESTORE_WAIT_SEC), rx)
-            .await
-            .is_err()
-        {
-            return Err(ttrpc_error!(
-                ttrpc::Code::INTERNAL,
-                "timeout waiting for stdin writer to complete".to_string()
-            ));
-        }
-
-        if handle.await.is_err() {
-            return Err(ttrpc_error!(
-                ttrpc::Code::INTERNAL,
-                "stdin writer thread failure".to_string()
-            ));
-        }
-
-        let output = match child.wait_with_output() {
-            Ok(o) => o,
-            Err(e) => {
-                warn!(
-                    sl!(),
-                    "failure waiting for spawned {} to complete: {:?}",
-                    cmd,
-                    e.kind()
-                );
-                return Err(ttrpc_error!(ttrpc::Code::INTERNAL, e));
-            }
-        };
-
-        if !output.status.success() {
-            warn!(sl!(), "{} failed: {:?}", cmd, output.stderr);
-            return Err(ttrpc_error!(
-                ttrpc::Code::INTERNAL,
-                format!(
-                    "{} failed: {:?}",
-                    cmd,
-                    String::from_utf8_lossy(&output.stderr)
-                )
-            ));
-        }
-
-        Ok(SetIPTablesResponse {
-            data: output.stdout,
-            ..Default::default()
-        })
-    }
-
     async fn list_interfaces(
         &self,
         ctx: &TtrpcContext,
@@ -1513,7 +1390,7 @@ impl agent_ttrpc::AgentService for AgentService {
 struct HealthService;
 
 #[async_trait]
-impl health_ttrpc::Health for HealthService {
+impl protocols::health_ttrpc::Health for HealthService {
     async fn check(
         &self,
         _ctx: &TtrpcContext,
@@ -1652,17 +1529,18 @@ async fn read_stream(reader: Arc<Mutex<ReadHalf<PipeStream>>>, l: usize) -> Resu
 }
 
 pub fn start(s: Arc<Mutex<Sandbox>>, server_address: &str) -> Result<TtrpcServer> {
-    let agent_service =
-        Box::new(AgentService { sandbox: s }) as Box<dyn agent_ttrpc::AgentService + Send + Sync>;
+    let agent_service = Box::new(AgentService { sandbox: s })
+        as Box<dyn protocols::agent_ttrpc::AgentService + Send + Sync>;
 
     let agent_worker = Arc::new(agent_service);
 
-    let health_service = Box::new(HealthService {}) as Box<dyn health_ttrpc::Health + Send + Sync>;
+    let health_service =
+        Box::new(HealthService {}) as Box<dyn protocols::health_ttrpc::Health + Send + Sync>;
     let health_worker = Arc::new(health_service);
 
-    let aservice = agent_ttrpc::create_agent_service(agent_worker);
+    let aservice = protocols::agent_ttrpc::create_agent_service(agent_worker);
 
-    let hservice = health_ttrpc::create_health(health_worker);
+    let hservice = protocols::health_ttrpc::create_health(health_worker);
 
     let server = TtrpcServer::new()
         .bind(server_address)?
@@ -1769,25 +1647,34 @@ fn is_signal_handled(proc_status_file: &str, signum: u32) -> bool {
     let sig_mask: u64 = 1 << shift_count;
     let reader = BufReader::new(file);
 
-    // read lines start with SigBlk/SigIgn/SigCgt and check any match the signal mask
-    reader
-        .lines()
-        .flatten()
-        .filter(|line| {
-            line.starts_with("SigBlk:")
-                || line.starts_with("SigIgn:")
-                || line.starts_with("SigCgt:")
-        })
-        .any(|line| {
-            let mask_vec: Vec<&str> = line.split(':').collect();
-            if mask_vec.len() == 2 {
-                let sig_str = mask_vec[1].trim();
-                if let Ok(sig) = u64::from_str_radix(sig_str, 16) {
-                    return sig & sig_mask == sig_mask;
-                }
+    // Read the file line by line using the lines() iterator from std::io::BufRead.
+    for (_index, line) in reader.lines().enumerate() {
+        let line = match line {
+            Ok(l) => l,
+            Err(_) => {
+                warn!(sl!(), "failed to read file {}", proc_status_file);
+                return false;
             }
-            false
-        })
+        };
+        if line.starts_with("SigCgt:") {
+            let mask_vec: Vec<&str> = line.split(':').collect();
+            if mask_vec.len() != 2 {
+                warn!(sl!(), "parse the SigCgt field failed");
+                return false;
+            }
+            let sig_cgt_str = mask_vec[1].trim();
+            let sig_cgt_mask = match u64::from_str_radix(sig_cgt_str, 16) {
+                Ok(h) => h,
+                Err(_) => {
+                    warn!(sl!(), "failed to parse the str {} to hex", sig_cgt_str);
+                    return false;
+                }
+            };
+
+            return (sig_cgt_mask & sig_mask) == sig_mask;
+        }
+    }
+    false
 }
 
 fn do_mem_hotplug_by_probe(addrs: &[u64]) -> Result<()> {
@@ -1895,7 +1782,7 @@ async fn do_add_swap(sandbox: &Arc<Mutex<Sandbox>>, req: &AddSwapRequest) -> Res
 // - config.json at /<CONTAINER_BASE>/<cid>/config.json
 // - container rootfs bind mounted at /<CONTAINER_BASE>/<cid>/rootfs
 // - modify container spec root to point to /<CONTAINER_BASE>/<cid>/rootfs
-pub fn setup_bundle(cid: &str, spec: &mut Spec) -> Result<PathBuf> {
+fn setup_bundle(cid: &str, spec: &mut Spec) -> Result<PathBuf> {
     let spec_root = if let Some(sr) = &spec.root {
         sr
     } else {
@@ -1988,11 +1875,10 @@ fn load_kernel_module(module: &protocols::agent::KernelModule) -> Result<()> {
 mod tests {
     use super::*;
     use crate::{
-        assert_result, namespace::Namespace, protocols::agent_ttrpc_async::AgentService as _,
+        assert_result, namespace::Namespace, protocols::agent_ttrpc::AgentService as _,
         skip_if_not_root,
     };
     use nix::mount;
-    use nix::sched::{unshare, CloneFlags};
     use oci::{Hook, Hooks, Linux, LinuxNamespace};
     use tempfile::{tempdir, TempDir};
     use ttrpc::{r#async::TtrpcContext, MessageHeader};
@@ -2238,7 +2124,6 @@ mod tests {
                     if d.has_fd {
                         Some(wfd)
                     } else {
-                        unistd::close(wfd).unwrap();
                         None
                     }
                 };
@@ -2273,14 +2158,13 @@ mod tests {
             if !d.break_pipe {
                 unistd::close(rfd).unwrap();
             }
-            // XXX: Do not close wfd.
-            // the fd will be closed on Process's dropping.
-            // unistd::close(wfd).unwrap();
+            unistd::close(wfd).unwrap();
 
             let msg = format!("{}, result: {:?}", msg, result);
             assert_result!(d.result, result, msg);
         }
     }
+
     #[tokio::test]
     async fn test_update_container_namespaces() {
         #[derive(Debug)]
@@ -2611,12 +2495,7 @@ OtherField:other
             TestData {
                 status_file_data: Some("SigBlk:0000000000000001"),
                 signum: 1,
-                result: true,
-            },
-            TestData {
-                status_file_data: Some("SigIgn:0000000000000001"),
-                signum: 1,
-                result: true,
+                result: false,
             },
             TestData {
                 status_file_data: None,
@@ -2648,6 +2527,233 @@ OtherField:other
         }
     }
 
+    #[tokio::test]
+    async fn test_verify_cid() {
+        #[derive(Debug)]
+        struct TestData<'a> {
+            id: &'a str,
+            expect_error: bool,
+        }
+
+        let tests = &[
+            TestData {
+                // Cannot be blank
+                id: "",
+                expect_error: true,
+            },
+            TestData {
+                // Cannot be a space
+                id: " ",
+                expect_error: true,
+            },
+            TestData {
+                // Must start with an alphanumeric
+                id: ".",
+                expect_error: true,
+            },
+            TestData {
+                // Must start with an alphanumeric
+                id: "-",
+                expect_error: true,
+            },
+            TestData {
+                // Must start with an alphanumeric
+                id: "_",
+                expect_error: true,
+            },
+            TestData {
+                // Must start with an alphanumeric
+                id: " a",
+                expect_error: true,
+            },
+            TestData {
+                // Must start with an alphanumeric
+                id: ".a",
+                expect_error: true,
+            },
+            TestData {
+                // Must start with an alphanumeric
+                id: "-a",
+                expect_error: true,
+            },
+            TestData {
+                // Must start with an alphanumeric
+                id: "_a",
+                expect_error: true,
+            },
+            TestData {
+                // Must start with an alphanumeric
+                id: "..",
+                expect_error: true,
+            },
+            TestData {
+                // Too short
+                id: "a",
+                expect_error: true,
+            },
+            TestData {
+                // Too short
+                id: "z",
+                expect_error: true,
+            },
+            TestData {
+                // Too short
+                id: "A",
+                expect_error: true,
+            },
+            TestData {
+                // Too short
+                id: "Z",
+                expect_error: true,
+            },
+            TestData {
+                // Too short
+                id: "0",
+                expect_error: true,
+            },
+            TestData {
+                // Too short
+                id: "9",
+                expect_error: true,
+            },
+            TestData {
+                // Must start with an alphanumeric
+                id: "-1",
+                expect_error: true,
+            },
+            TestData {
+                id: "/",
+                expect_error: true,
+            },
+            TestData {
+                id: "a/",
+                expect_error: true,
+            },
+            TestData {
+                id: "a/../",
+                expect_error: true,
+            },
+            TestData {
+                id: "../a",
+                expect_error: true,
+            },
+            TestData {
+                id: "../../a",
+                expect_error: true,
+            },
+            TestData {
+                id: "../../../a",
+                expect_error: true,
+            },
+            TestData {
+                id: "foo/../bar",
+                expect_error: true,
+            },
+            TestData {
+                id: "foo bar",
+                expect_error: true,
+            },
+            TestData {
+                id: "a.",
+                expect_error: false,
+            },
+            TestData {
+                id: "a..",
+                expect_error: false,
+            },
+            TestData {
+                id: "aa",
+                expect_error: false,
+            },
+            TestData {
+                id: "aa.",
+                expect_error: false,
+            },
+            TestData {
+                id: "hello..world",
+                expect_error: false,
+            },
+            TestData {
+                id: "hello/../world",
+                expect_error: true,
+            },
+            TestData {
+                id: "aa1245124sadfasdfgasdga.",
+                expect_error: false,
+            },
+            TestData {
+                id: "aAzZ0123456789_.-",
+                expect_error: false,
+            },
+            TestData {
+                id: "abcdefghijklmnopqrstuvwxyz0123456789.-_",
+                expect_error: false,
+            },
+            TestData {
+                id: "0123456789abcdefghijklmnopqrstuvwxyz.-_",
+                expect_error: false,
+            },
+            TestData {
+                id: " abcdefghijklmnopqrstuvwxyz0123456789.-_",
+                expect_error: true,
+            },
+            TestData {
+                id: ".abcdefghijklmnopqrstuvwxyz0123456789.-_",
+                expect_error: true,
+            },
+            TestData {
+                id: "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_",
+                expect_error: false,
+            },
+            TestData {
+                id: "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ.-_",
+                expect_error: false,
+            },
+            TestData {
+                id: " ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_",
+                expect_error: true,
+            },
+            TestData {
+                id: ".ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_",
+                expect_error: true,
+            },
+            TestData {
+                id: "/a/b/c",
+                expect_error: true,
+            },
+            TestData {
+                id: "a/b/c",
+                expect_error: true,
+            },
+            TestData {
+                id: "foo/../../../etc/passwd",
+                expect_error: true,
+            },
+            TestData {
+                id: "../../../../../../etc/motd",
+                expect_error: true,
+            },
+            TestData {
+                id: "/etc/passwd",
+                expect_error: true,
+            },
+        ];
+
+        for (i, d) in tests.iter().enumerate() {
+            let msg = format!("test[{}]: {:?}", i, d);
+
+            let result = verify_cid(d.id);
+
+            let msg = format!("{}, result: {:?}", msg, result);
+
+            if result.is_ok() {
+                assert!(!d.expect_error, "{}", msg);
+            } else {
+                assert!(d.expect_error, "{}", msg);
+            }
+        }
+    }
+
     #[tokio::test]
     async fn test_volume_capacity_stats() {
         skip_if_not_root!();
@@ -2709,162 +2815,4 @@ OtherField:other
         assert_eq!(stats.used, 3);
         assert_eq!(stats.available, available - 2);
     }
-
-    #[tokio::test]
-    async fn test_ip_tables() {
-        skip_if_not_root!();
-
-        let logger = slog::Logger::root(slog::Discard, o!());
-        let sandbox = Sandbox::new(&logger).unwrap();
-        let agent_service = Box::new(AgentService {
-            sandbox: Arc::new(Mutex::new(sandbox)),
-        });
-
-        let ctx = mk_ttrpc_context();
-
-        // Move to a new netns in order to ensure we don't trash the hosts' iptables
-        unshare(CloneFlags::CLONE_NEWNET).unwrap();
-
-        // Get initial iptables, we expect to be empty:
-        let result = agent_service
-            .get_ip_tables(
-                &ctx,
-                GetIPTablesRequest {
-                    is_ipv6: false,
-                    ..Default::default()
-                },
-            )
-            .await;
-        assert!(result.is_ok(), "get ip tables should succeed");
-        assert_eq!(
-            result.unwrap().data.len(),
-            0,
-            "ip tables should be empty initially"
-        );
-
-        // Initial ip6 ip tables should also be empty:
-        let result = agent_service
-            .get_ip_tables(
-                &ctx,
-                GetIPTablesRequest {
-                    is_ipv6: true,
-                    ..Default::default()
-                },
-            )
-            .await;
-        assert!(result.is_ok(), "get ip6 tables should succeed");
-        assert_eq!(
-            result.unwrap().data.len(),
-            0,
-            "ip tables should be empty initially"
-        );
-
-        // Verify that attempting to write 'empty' iptables results in no error:
-        let empty_rules = "";
-        let result = agent_service
-            .set_ip_tables(
-                &ctx,
-                SetIPTablesRequest {
-                    is_ipv6: false,
-                    data: empty_rules.as_bytes().to_vec(),
-                    ..Default::default()
-                },
-            )
-            .await;
-        assert!(result.is_ok(), "set ip tables with no data should succeed");
-
-        // Verify that attempting to write "garbage" iptables results in an error:
-        let garbage_rules = r#"
-this
-is
-just garbage
-"#;
-        let result = agent_service
-            .set_ip_tables(
-                &ctx,
-                SetIPTablesRequest {
-                    is_ipv6: false,
-                    data: garbage_rules.as_bytes().to_vec(),
-                    ..Default::default()
-                },
-            )
-            .await;
-        assert!(result.is_err(), "set iptables with garbage should fail");
-
-        // Verify setup of valid iptables:Setup  valid set of iptables:
-        let valid_rules = r#"
-*nat
--A PREROUTING -d 192.168.103.153/32 -j DNAT --to-destination 192.168.188.153
-
-COMMIT
-
-"#;
-        let result = agent_service
-            .set_ip_tables(
-                &ctx,
-                SetIPTablesRequest {
-                    is_ipv6: false,
-                    data: valid_rules.as_bytes().to_vec(),
-                    ..Default::default()
-                },
-            )
-            .await;
-        assert!(result.is_ok(), "set ip tables should succeed");
-
-        let result = agent_service
-            .get_ip_tables(
-                &ctx,
-                GetIPTablesRequest {
-                    is_ipv6: false,
-                    ..Default::default()
-                },
-            )
-            .await
-            .unwrap();
-        assert!(!result.data.is_empty(), "we should have non-zero output:");
-        assert!(
-            std::str::from_utf8(&*result.data).unwrap().contains(
-                "PREROUTING -d 192.168.103.153/32 -j DNAT --to-destination 192.168.188.153"
-            ),
-            "We should see the resulting rule"
-        );
-
-        // Verify setup of valid ip6tables:
-        let valid_ipv6_rules = r#"
-*filter
--A INPUT -s 2001:db8:100::1/128 -i sit+ -p tcp -m tcp --sport 512:65535
-
-COMMIT
-
-"#;
-        let result = agent_service
-            .set_ip_tables(
-                &ctx,
-                SetIPTablesRequest {
-                    is_ipv6: true,
-                    data: valid_ipv6_rules.as_bytes().to_vec(),
-                    ..Default::default()
-                },
-            )
-            .await;
-        assert!(result.is_ok(), "set ip6 tables should succeed");
-
-        let result = agent_service
-            .get_ip_tables(
-                &ctx,
-                GetIPTablesRequest {
-                    is_ipv6: true,
-                    ..Default::default()
-                },
-            )
-            .await
-            .unwrap();
-        assert!(!result.data.is_empty(), "we should have non-zero output:");
-        assert!(
-            std::str::from_utf8(&*result.data)
-                .unwrap()
-                .contains("INPUT -s 2001:db8:100::1/128 -i sit+ -p tcp -m tcp --sport 512:65535"),
-            "We should see the resulting rule"
-        );
-    }
 }

src/agent/src/sandbox.rs

@@ -470,7 +470,7 @@ fn online_memory(logger: &Logger) -> Result<()> {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
+    use super::Sandbox;
     use crate::{mount::baremount, skip_if_not_root};
     use anyhow::{anyhow, Error};
     use nix::mount::MsFlags;
@@ -480,7 +480,6 @@ mod tests {
     use rustjail::specconv::CreateOpts;
     use slog::Logger;
     use std::fs::{self, File};
-    use std::io::prelude::*;
     use std::os::unix::fs::PermissionsExt;
     use std::path::Path;
     use tempfile::{tempdir, Builder, TempDir};
@@ -848,259 +847,4 @@ mod tests {
         let p = s.find_container_process("not-exist-cid", "");
         assert!(p.is_err(), "Expecting Error, Got {:?}", p);
     }
-
-    #[tokio::test]
-    async fn test_find_process() {
-        let logger = slog::Logger::root(slog::Discard, o!());
-
-        let test_pids = [std::i32::MIN, -1, 0, 1, std::i32::MAX];
-
-        for test_pid in test_pids {
-            let mut s = Sandbox::new(&logger).unwrap();
-            let (mut linux_container, _root) = create_linuxcontainer();
-
-            let mut test_process = Process::new(
-                &logger,
-                &oci::Process::default(),
-                "this_is_a_test_process",
-                true,
-                1,
-            )
-            .unwrap();
-            // processes interally only have pids when manually set
-            test_process.pid = test_pid;
-
-            linux_container.processes.insert(test_pid, test_process);
-
-            s.add_container(linux_container);
-
-            let find_result = s.find_process(test_pid);
-
-            // test first if it finds anything
-            assert!(find_result.is_some(), "Should be able to find a process");
-
-            let found_process = find_result.unwrap();
-
-            // then test if it founds the correct process
-            assert_eq!(
-                found_process.pid, test_pid,
-                "Should be able to find correct process"
-            );
-        }
-
-        // to test for nonexistent pids, any pid that isn't the one set
-        // above should work, as linuxcontainer starts with no processes
-        let mut s = Sandbox::new(&logger).unwrap();
-
-        let nonexistent_test_pid = 1234;
-
-        let find_result = s.find_process(nonexistent_test_pid);
-
-        assert!(
-            find_result.is_none(),
-            "Shouldn't find a process for non existent pid"
-        );
-    }
-
-    #[tokio::test]
-    async fn test_online_resources() {
-        #[derive(Debug, Default)]
-        struct TestFile {
-            name: String,
-            content: String,
-        }
-
-        #[derive(Debug, Default)]
-        struct TestDirectory<'a> {
-            name: String,
-            files: &'a [TestFile],
-        }
-
-        #[derive(Debug)]
-        struct TestData<'a> {
-            directory_autogen_name: String,
-            number_autogen_directories: u32,
-
-            extra_directories: &'a [TestDirectory<'a>],
-            pattern: String,
-            to_enable: i32,
-
-            result: Result<i32>,
-        }
-
-        impl Default for TestData<'_> {
-            fn default() -> Self {
-                TestData {
-                    directory_autogen_name: Default::default(),
-                    number_autogen_directories: Default::default(),
-                    extra_directories: Default::default(),
-                    pattern: Default::default(),
-                    to_enable: Default::default(),
-                    result: Ok(Default::default()),
-                }
-            }
-        }
-
-        let tests = &[
-            // 4 well formed directories, request enabled 4,
-            // correct result 4 enabled, should pass
-            TestData {
-                directory_autogen_name: String::from("cpu"),
-                number_autogen_directories: 4,
-                pattern: String::from(r"cpu[0-9]+"),
-                to_enable: 4,
-                result: Ok(4),
-                ..Default::default()
-            },
-            // 0 well formed directories, request enabled 4,
-            // correct result 0 enabled, should pass
-            TestData {
-                number_autogen_directories: 0,
-                to_enable: 4,
-                result: Ok(0),
-                ..Default::default()
-            },
-            // 10 well formed directories, request enabled 4,
-            // correct result 4 enabled, should pass
-            TestData {
-                directory_autogen_name: String::from("cpu"),
-                number_autogen_directories: 10,
-                pattern: String::from(r"cpu[0-9]+"),
-                to_enable: 4,
-                result: Ok(4),
-                ..Default::default()
-            },
-            // 0 well formed directories, request enabled 0,
-            // correct result 0 enabled, should pass
-            TestData {
-                number_autogen_directories: 0,
-                pattern: String::from(r"cpu[0-9]+"),
-                to_enable: 0,
-                result: Ok(0),
-                ..Default::default()
-            },
-            // 4 well formed directories, 1 malformed (no online file),
-            // request enable 5, correct result 4
-            TestData {
-                directory_autogen_name: String::from("cpu"),
-                number_autogen_directories: 4,
-                pattern: String::from(r"cpu[0-9]+"),
-                extra_directories: &[TestDirectory {
-                    name: String::from("cpu4"),
-                    files: &[],
-                }],
-                to_enable: 5,
-                result: Ok(4),
-            },
-            // 3 malformed directories (no online files),
-            // request enable 3, correct result 0
-            TestData {
-                pattern: String::from(r"cpu[0-9]+"),
-                extra_directories: &[
-                    TestDirectory {
-                        name: String::from("cpu0"),
-                        files: &[],
-                    },
-                    TestDirectory {
-                        name: String::from("cpu1"),
-                        files: &[],
-                    },
-                    TestDirectory {
-                        name: String::from("cpu2"),
-                        files: &[],
-                    },
-                ],
-                to_enable: 3,
-                result: Ok(0),
-                ..Default::default()
-            },
-            // 1 malformed directories (online file with content "1"),
-            // request enable 1, correct result 0
-            TestData {
-                pattern: String::from(r"cpu[0-9]+"),
-                extra_directories: &[TestDirectory {
-                    name: String::from("cpu0"),
-                    files: &[TestFile {
-                        name: SYSFS_ONLINE_FILE.to_string(),
-                        content: String::from("1"),
-                    }],
-                }],
-                to_enable: 1,
-                result: Ok(0),
-                ..Default::default()
-            },
-            // 2 well formed directories, 1 malformed (online file with content "1"),
-            // request enable 3, correct result 2
-            TestData {
-                directory_autogen_name: String::from("cpu"),
-                number_autogen_directories: 2,
-                pattern: String::from(r"cpu[0-9]+"),
-                extra_directories: &[TestDirectory {
-                    name: String::from("cpu2"),
-                    files: &[TestFile {
-                        name: SYSFS_ONLINE_FILE.to_string(),
-                        content: String::from("1"),
-                    }],
-                }],
-                to_enable: 3,
-                result: Ok(2),
-            },
-        ];
-
-        let logger = slog::Logger::root(slog::Discard, o!());
-        let tmpdir = Builder::new().tempdir().unwrap();
-        let tmpdir_path = tmpdir.path().to_str().unwrap();
-
-        for (i, d) in tests.iter().enumerate() {
-            let current_test_dir_path = format!("{}/test_{}", tmpdir_path, i);
-            fs::create_dir(&current_test_dir_path).unwrap();
-
-            // create numbered directories and fill using root name
-            for j in 0..d.number_autogen_directories {
-                let subdir_path = format!(
-                    "{}/{}{}",
-                    current_test_dir_path, d.directory_autogen_name, j
-                );
-                let subfile_path = format!("{}/{}", subdir_path, SYSFS_ONLINE_FILE);
-                fs::create_dir(&subdir_path).unwrap();
-                let mut subfile = File::create(subfile_path).unwrap();
-                subfile.write_all(b"0").unwrap();
-            }
-            // create extra directories and fill to specification
-            for j in d.extra_directories {
-                let subdir_path = format!("{}/{}", current_test_dir_path, j.name);
-                fs::create_dir(&subdir_path).unwrap();
-                for file in j.files {
-                    let subfile_path = format!("{}/{}", subdir_path, file.name);
-                    let mut subfile = File::create(&subfile_path).unwrap();
-                    subfile.write_all(file.content.as_bytes()).unwrap();
-                }
-            }
-
-            // run created directory structure against online_resources
-            let result = online_resources(&logger, &current_test_dir_path, &d.pattern, d.to_enable);
-
-            let mut msg = format!(
-                "test[{}]: {:?}, expected {}, actual {}",
-                i,
-                d,
-                d.result.is_ok(),
-                result.is_ok()
-            );
-
-            assert_eq!(result.is_ok(), d.result.is_ok(), "{}", msg);
-
-            if d.result.is_ok() {
-                let test_result_val = *d.result.as_ref().ok().unwrap();
-                let result_val = result.ok().unwrap();
-
-                msg = format!(
-                    "test[{}]: {:?}, expected {}, actual {}",
-                    i, d, test_result_val, result_val
-                );
-
-                assert_eq!(test_result_val, result_val, "{}", msg);
-            }
-        }
-    }
 }

src/agent/src/signal.rs

@@ -58,16 +58,17 @@ async fn handle_sigchild(logger: Logger, sandbox: Arc<Mutex<Sandbox>>) -> Result
             }
 
             let mut p = process.unwrap();
+            let ret: i32;
 
-            let ret: i32 = match wait_status {
-                WaitStatus::Exited(_, c) => c,
-                WaitStatus::Signaled(_, sig, _) => sig as i32,
+            match wait_status {
+                WaitStatus::Exited(_, c) => ret = c,
+                WaitStatus::Signaled(_, sig, _) => ret = sig as i32,
                 _ => {
                     info!(logger, "got wrong status for process";
                                   "child-status" => format!("{:?}", wait_status));
                     continue;
                 }
-            };
+            }
 
             p.exit_code = ret;
             let _ = p.exit_tx.take();

src/agent/src/test_utils.rs

@@ -5,14 +5,7 @@
 #![allow(clippy::module_inception)]
 
 #[cfg(test)]
-pub mod test_utils {
-    #[derive(Debug, PartialEq)]
-    pub enum TestUserType {
-        RootOnly,
-        NonRootOnly,
-        Any,
-    }
-
+mod test_utils {
     #[macro_export]
     macro_rules! skip_if_root {
         () => {
@@ -85,15 +78,4 @@ pub mod test_utils {
             }
         };
     }
-
-    #[macro_export]
-    macro_rules! skip_loop_by_user {
-        ($msg:expr, $user:expr) => {
-            if $user == TestUserType::RootOnly {
-                skip_loop_if_not_root!($msg);
-            } else if $user == TestUserType::NonRootOnly {
-                skip_loop_if_root!($msg);
-            }
-        };
-    }
 }

src/agent/src/tracer.rs

@@ -69,8 +69,6 @@ macro_rules! trace_rpc_call {
             propagator.extract(&extract_carrier_from_ttrpc($ctx))
         });
 
-        info!(sl!(), "rpc call from shim to agent: {:?}", $name);
-
         // generate tracing span
         let rpc_span = span!(tracing::Level::INFO, $name, "mod"="rpc.rs", req=?$req);
 

src/agent/src/util.rs

@@ -237,6 +237,8 @@ mod tests {
                 JoinError,
             >;
 
+            let result: std::result::Result<u64, std::io::Error>;
+
             select! {
                 res = handle => spawn_result = res,
                 _ = &mut timeout => panic!("timed out"),
@@ -244,7 +246,7 @@ mod tests {
 
             assert!(spawn_result.is_ok());
 
-            let result: std::result::Result<u64, std::io::Error> = spawn_result.unwrap();
+            result = spawn_result.unwrap();
 
             assert!(result.is_ok());
 
@@ -276,6 +278,8 @@ mod tests {
 
         let spawn_result: std::result::Result<std::result::Result<u64, std::io::Error>, JoinError>;
 
+        let result: std::result::Result<u64, std::io::Error>;
+
         select! {
             res = handle => spawn_result = res,
             _ = &mut timeout => panic!("timed out"),
@@ -283,7 +287,7 @@ mod tests {
 
         assert!(spawn_result.is_ok());
 
-        let result: std::result::Result<u64, std::io::Error> = spawn_result.unwrap();
+        result = spawn_result.unwrap();
 
         assert!(result.is_ok());
 
@@ -316,6 +320,8 @@ mod tests {
 
         let spawn_result: std::result::Result<std::result::Result<u64, std::io::Error>, JoinError>;
 
+        let result: std::result::Result<u64, std::io::Error>;
+
         select! {
             res = handle => spawn_result = res,
             _ = &mut timeout => panic!("timed out"),
@@ -323,7 +329,7 @@ mod tests {
 
         assert!(spawn_result.is_ok());
 
-        let result: std::result::Result<u64, std::io::Error> = spawn_result.unwrap();
+        result = spawn_result.unwrap();
 
         assert!(result.is_ok());
 

src/agent/vsock-exporter/src/lib.rs

@@ -178,11 +178,13 @@ impl Builder {
     pub fn init(self) -> Exporter {
         let Builder { port, cid, logger } = self;
 
-        let cid_str: String = if self.cid == libc::VMADDR_CID_ANY {
-            ANY_CID.to_string()
+        let cid_str: String;
+
+        if self.cid == libc::VMADDR_CID_ANY {
+            cid_str = ANY_CID.to_string();
         } else {
-            format!("{}", self.cid)
-        };
+            cid_str = format!("{}", self.cid);
+        }
 
         Exporter {
             port,

src/dragonball/.gitignore

@@ -1,3 +0,0 @@
-target
-Cargo.lock
-.idea

src/dragonball/Cargo.toml

@@ -1,65 +0,0 @@
-[package]
-name = "dragonball"
-version = "0.1.0"
-authors = ["The Kata Containers community <kata-dev@lists.katacontainers.io>"]
-description = "A secure sandbox for Kata Containers"
-keywords = ["kata-containers", "sandbox", "vmm", "dragonball"]
-homepage = "https://katacontainers.io/"
-repository = "https://github.com/kata-containers/kata-containers.git"
-license = "Apache-2.0"
-edition = "2018"
-
-[dependencies]
-arc-swap = "1.5.0"
-bytes = "1.1.0"
-dbs-address-space = "0.1.0"
-dbs-allocator = "0.1.0"
-dbs-arch = "0.1.0"
-dbs-boot = "0.2.0"
-dbs-device = "0.1.0"
-dbs-interrupt = { version = "0.1.0", features = ["kvm-irq"] }
-dbs-legacy-devices = "0.1.0"
-dbs-upcall = { version = "0.1.0", optional = true }
-dbs-utils = "0.1.0"
-dbs-virtio-devices = { version = "0.1.0", optional = true, features = ["virtio-mmio"] }
-kvm-bindings = "0.5.0"
-kvm-ioctls = "0.11.0"
-lazy_static = "1.2"
-libc = "0.2.39"
-linux-loader = "0.4.0"
-log = "0.4.14"
-nix = "0.23.1"
-seccompiler = "0.2.0"
-serde = "1.0.27"
-serde_derive = "1.0.27"
-serde_json = "1.0.9"
-slog = "2.5.2"
-slog-scope = "4.4.0"
-thiserror = "1"
-vmm-sys-util = "0.9.0"
-virtio-queue = { version = "0.1.0", optional = true }
-vm-memory = { version = "0.7.0", features = ["backend-mmap"] }
-
-[dev-dependencies]
-slog-term = "2.9.0"
-slog-async = "2.7.0"
-
-[features]
-acpi = []
-atomic-guest-memory = []
-hotplug = ["virtio-vsock"]
-virtio-vsock = ["dbs-virtio-devices/virtio-vsock", "virtio-queue"]
-virtio-blk = ["dbs-virtio-devices/virtio-blk", "virtio-queue"]
-virtio-net = ["dbs-virtio-devices/virtio-net", "virtio-queue"]
-# virtio-fs only work on atomic-guest-memory
-virtio-fs = ["dbs-virtio-devices/virtio-fs", "virtio-queue", "atomic-guest-memory"]
-
-[patch.'crates-io']
-dbs-device = { git = "https://github.com/openanolis/dragonball-sandbox.git", rev = "7a8e832b53d66994d6a16f0513d69f540583dcd0" }
-dbs-interrupt = { git = "https://github.com/openanolis/dragonball-sandbox.git", rev = "7a8e832b53d66994d6a16f0513d69f540583dcd0" }
-dbs-legacy-devices = { git = "https://github.com/openanolis/dragonball-sandbox.git", rev = "7a8e832b53d66994d6a16f0513d69f540583dcd0" }
-dbs-upcall = { git = "https://github.com/openanolis/dragonball-sandbox.git", rev = "7a8e832b53d66994d6a16f0513d69f540583dcd0" }
-dbs-utils = { git = "https://github.com/openanolis/dragonball-sandbox.git", rev = "7a8e832b53d66994d6a16f0513d69f540583dcd0" }
-dbs-virtio-devices = { git = "https://github.com/openanolis/dragonball-sandbox.git", rev = "7a8e832b53d66994d6a16f0513d69f540583dcd0" }
-dbs-boot = { git = "https://github.com/openanolis/dragonball-sandbox.git", rev = "7a8e832b53d66994d6a16f0513d69f540583dcd0" }
-dbs-arch = { git = "https://github.com/openanolis/dragonball-sandbox.git", rev = "7a8e832b53d66994d6a16f0513d69f540583dcd0" }

src/dragonball/LICENSE

@@ -1 +0,0 @@
-../../LICENSE

src/dragonball/Makefile

@@ -1,29 +0,0 @@
-# Copyright (c) 2019-2022 Alibaba Cloud. All rights reserved.
-# Copyright (c) 2019-2022 Ant Group. All rights reserved.
-# SPDX-License-Identifier: Apache-2.0
-
-default: build
-
-build:
-	# FIXME: This line will be removed when we solve the vm-memory dependency problem in Dragonball Sandbox
-	cargo update -p vm-memory:0.8.0 --precise 0.7.0
-	cargo build --all-features
-
-check: clippy format
-
-clippy:
-	@echo "INFO: cargo clippy..."
-	cargo clippy --all-targets --all-features \
-		-- \
-		-D warnings
-
-format:
-	@echo "INFO: cargo fmt..."
-	cargo fmt -- --check
-
-clean:
-	cargo clean
-
-test:
-	@echo "INFO: testing dragonball for development build"
-	cargo test --all-features -- --nocapture

src/dragonball/README.md

@@ -1,40 +0,0 @@
-# Introduction
-`Dragonball Sandbox` is a light-weight virtual machine manager (VMM) based on Linux Kernel-based Virtual Machine (KVM),
-which is optimized for container workloads with:
-- container image management and acceleration service
-- flexible and high-performance virtual device drivers
-- low CPU and memory overhead
-- minimal startup time
-- optimized concurrent startup speed
-
-`Dragonball Sandbox` aims to provide a simple solution for the Kata Containers community. It is integrated into Kata 3.0
-runtime as a built-in VMM and gives users an out-of-the-box Kata Containers experience without complex environment setup
-and configuration process.
-
-# Getting Started
-[TODO](https://github.com/kata-containers/kata-containers/issues/4302)
-
-# Documentation
-
-Device: [Device Document](docs/device.md)
-vCPU: [vCPU Document](docs/vcpu.md)
-API: [API Document](docs/api.md)
-
-Currently, the documents are still actively adding.
-You could see the [official documentation](docs/) page for more details.
-
-# Supported Architectures
-- x86-64
-- aarch64
- 
-# Supported Kernel
-[TODO](https://github.com/kata-containers/kata-containers/issues/4303)
-
-# Acknowledgement
-Part of the code is based on the [Cloud Hypervisor](https://github.com/cloud-hypervisor/cloud-hypervisor) project, [`crosvm`](https://github.com/google/crosvm) project and [Firecracker](https://github.com/firecracker-microvm/firecracker) project. They are all rust written virtual machine managers with advantages on safety and security.
-
-`Dragonball sandbox` is designed to be a VMM that is customized for Kata Containers and we will focus on optimizing container workloads for Kata ecosystem. The focus on the Kata community is what differentiates us from other rust written virtual machines.
-
-# License
-
-`Dragonball` is licensed under [Apache License](http://www.apache.org/licenses/LICENSE-2.0), Version 2.0.

src/dragonball/THIRD-PARTY

@@ -1,27 +0,0 @@
-// Copyright 2017 The Chromium OS Authors. All rights reserved.
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-//    * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-//    * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-//    * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

src/dragonball/docs/api.md

@@ -1,27 +0,0 @@
-# API
-
-We provide plenty API for Kata runtime to interact with `Dragonball` virtual machine manager.
-This document provides the introduction for each of them.
-
-## `ConfigureBootSource`
-Configure the boot source of the VM using `BootSourceConfig`. This action can only be called before the VM has booted.
-
-### Boot Source Config
-1. `kernel_path`: Path of the kernel image. `Dragonball` only supports compressed kernel image for now.
-2. `initrd_path`: Path of the initrd (could be None)
-3. `boot_args`: Boot arguments passed to the kernel (could be None)
-
-## `SetVmConfiguration`
-Set virtual machine configuration using `VmConfigInfo` to initialize VM.
-
-### VM Config Info
-1. `vcpu_count`: Number of vCPU to start. Currently we only support up to 255 vCPUs.
-2. `max_vcpu_count`: Max number of vCPU can be added through CPU hotplug.
-3. `cpu_pm`: CPU power management.
-4. `cpu_topology`: CPU topology information (including `threads_per_core`, `cores_per_die`, `dies_per_socket` and `sockets`).
-5. `vpmu_feature`: `vPMU` feature level.
-6. `mem_type`: Memory type that can be either `hugetlbfs` or `shmem`, default is `shmem`.
-7. `mem_file_path` : Memory file path.
-8. `mem_size_mib`: The memory size in MiB. The maximum memory size is 1TB.
-9. `serial_path`: Optional sock path.
-

src/dragonball/docs/device.md

@@ -1,20 +0,0 @@
-# Device
-
-## Device Manager
-
-Currently we have following device manager:
-| Name | Description | 
-| --- | --- |
-| [address space manager](../src/address_space_manager.rs) | abstracts virtual machine's physical management and provide mapping for guest virtual memory and MMIO ranges of emulated virtual devices, pass-through devices and vCPU |
-| [config manager](../src/config_manager.rs) | provides abstractions for configuration information | 
-| [console manager](../src/device_manager/console_manager.rs) | provides management for all console devices | 
-| [resource manager](../src/resource_manager.rs) |provides resource management for `legacy_irq_pool`, `msi_irq_pool`, `pio_pool`, `mmio_pool`, `mem_pool`, `kvm_mem_slot_pool` with builder `ResourceManagerBuilder` | 
-| [VSOCK device manager](../src/device_manager/vsock_dev_mgr.rs) | provides configuration info for `VIRTIO-VSOCK` and management for all VSOCK devices | 
-   
-
-## Device supported
-`VIRTIO-VSOCK`
-`i8042`
-`COM1`
-`COM2`
-

src/dragonball/docs/vcpu.md

@@ -1,42 +0,0 @@
-# vCPU
-
-## vCPU Manager
-The vCPU manager is to manage all vCPU related actions, we will dive into some of the important structure members in this doc.
-
-For now, aarch64 vCPU support is still under development, we'll introduce it when we merge `runtime-rs` to the master branch. (issue: #4445)
-
-### vCPU config
-`VcpuConfig` is used to configure guest overall CPU info.
-
-`boot_vcpu_count` is used to define the initial vCPU number.
-
-`max_vcpu_count` is used to define the maximum vCPU number and it's used for the upper boundary for CPU hotplug feature
-
-`thread_per_core`, `cores_per_die`, `dies_per_socket` and `socket` are used to define CPU topology.
-
-`vpmu_feature` is used to define `vPMU` feature level.
-If `vPMU` feature is `Disabled`, it means `vPMU` feature is off (by default).
-If `vPMU` feature is `LimitedlyEnabled`, it means minimal `vPMU` counters are supported (cycles and instructions).
-If `vPMU` feature is `FullyEnabled`, it means all `vPMU` counters are supported
-
-## vCPU State
-
-There are four states for vCPU state machine: `running`, `paused`, `waiting_exit`, `exited`. There is a state machine to maintain the task flow.
-
-When the vCPU is created, it'll turn to `paused` state. After vCPU resource is ready at VMM, it'll send a `Resume` event to the vCPU thread, and then vCPU state will change to `running`.
-
-During the `running` state, VMM will catch vCPU exit and execute different logic according to the exit reason.
-
-If the VMM catch some exit reasons that it cannot handle, the state will change to `waiting_exit` and VMM will stop the virtual machine. 
-When the state switches to `waiting_exit`, an exit event will be sent to vCPU `exit_evt`, event manager will detect the change in `exit_evt` and set VMM `exit_evt_flag` as 1. A thread serving for VMM event loop will check `exit_evt_flag` and if the flag is 1, it'll stop the VMM.
-
-When the VMM is stopped / destroyed, the state will change to `exited`.
-   
-## vCPU Hot plug
-Since `Dragonball Sandbox` doesn't support virtualization of ACPI system, we use [`upcall`](https://github.com/openanolis/dragonball-sandbox/tree/main/crates/dbs-upcall) to establish a direct communication channel between `Dragonball` and Guest in order to trigger vCPU hotplug.
-
-To use `upcall`, kernel patches are needed, you can get the patches from [`upcall`](https://github.com/openanolis/dragonball-sandbox/tree/main/crates/dbs-upcall) page, and we'll provide a ready-to-use guest kernel binary for you to try.
-
-vCPU hot plug / hot unplug range is [1, `max_vcpu_count`]. Operations not in this range will be invalid.
-
-

src/dragonball/src/address_space_manager.rs

@@ -1,892 +0,0 @@
-// Copyright (C) 2019-2022 Alibaba Cloud. All rights reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-//! Address space abstraction to manage virtual machine's physical address space.
-//!
-//! The AddressSpace abstraction is introduced to manage virtual machine's physical address space.
-//! The regions in virtual machine's physical address space may be used to:
-//! 1) map guest virtual memory
-//! 2) map MMIO ranges for emulated virtual devices, such as virtio-fs DAX window.
-//! 3) map MMIO ranges for pass-through devices, such as PCI device BARs.
-//! 4) map MMIO ranges for to vCPU, such as local APIC.
-//! 5) not used/available
-//!
-//! A related abstraction, vm_memory::GuestMemory, is used to access guest virtual memory only.
-//! In other words, AddressSpace is the resource owner, and GuestMemory is an accessor for guest
-//! virtual memory.
-
-use std::collections::{BTreeMap, HashMap};
-use std::fs::File;
-use std::os::unix::io::{AsRawFd, FromRawFd};
-use std::sync::atomic::{AtomicBool, AtomicU8, Ordering};
-use std::sync::{Arc, Mutex};
-use std::thread;
-
-use dbs_address_space::{
-    AddressSpace, AddressSpaceError, AddressSpaceLayout, AddressSpaceRegion,
-    AddressSpaceRegionType, NumaNode, NumaNodeInfo, MPOL_MF_MOVE, MPOL_PREFERRED,
-};
-use dbs_allocator::Constraint;
-use kvm_bindings::kvm_userspace_memory_region;
-use kvm_ioctls::VmFd;
-use log::{debug, error, info, warn};
-use nix::sys::mman;
-use nix::unistd::dup;
-#[cfg(feature = "atomic-guest-memory")]
-use vm_memory::atomic::GuestMemoryAtomic;
-use vm_memory::{
-    Address, FileOffset, GuestAddress, GuestAddressSpace, GuestMemoryMmap, GuestMemoryRegion,
-    GuestRegionMmap, GuestUsize, MemoryRegionAddress, MmapRegion,
-};
-
-use crate::resource_manager::ResourceManager;
-use crate::vm::NumaRegionInfo;
-
-#[cfg(not(feature = "atomic-guest-memory"))]
-/// Concrete GuestAddressSpace type used by the VMM.
-pub type GuestAddressSpaceImpl = Arc<GuestMemoryMmap>;
-
-#[cfg(feature = "atomic-guest-memory")]
-/// Concrete GuestAddressSpace type used by the VMM.
-pub type GuestAddressSpaceImpl = GuestMemoryAtomic<GuestMemoryMmap>;
-
-/// Concrete GuestMemory type used by the VMM.
-pub type GuestMemoryImpl = <Arc<vm_memory::GuestMemoryMmap> as GuestAddressSpace>::M;
-/// Concrete GuestRegion type used by the VMM.
-pub type GuestRegionImpl = GuestRegionMmap;
-
-// Maximum number of working threads for memory pre-allocation.
-const MAX_PRE_ALLOC_THREAD: u64 = 16;
-
-// Control the actual number of pre-allocating threads. After several performance tests, we decide to use one thread to do pre-allocating for every 4G memory.
-const PRE_ALLOC_GRANULARITY: u64 = 32;
-
-// We don't have plan to support mainframe computer and only focus on PC servers.
-// 64 as max nodes should be enough for now.
-const MAX_NODE: u32 = 64;
-
-// We will split the memory region if it conflicts with the MMIO hole.
-// But if the space below the MMIO hole is smaller than the MINIMAL_SPLIT_SPACE, we won't split the memory region in order to enhance performance.
-const MINIMAL_SPLIT_SPACE: u64 = 128 << 20;
-
-/// Errors associated with virtual machine address space management.
-#[derive(Debug, thiserror::Error)]
-pub enum AddressManagerError {
-    /// Invalid address space operation.
-    #[error("invalid address space operation")]
-    InvalidOperation,
-
-    /// Invalid address range.
-    #[error("invalid address space region (0x{0:x}, 0x{1:x})")]
-    InvalidAddressRange(u64, GuestUsize),
-
-    /// No available mem address.
-    #[error("no available mem address")]
-    NoAvailableMemAddress,
-
-    /// No available kvm slotse.
-    #[error("no available kvm slots")]
-    NoAvailableKvmSlot,
-
-    /// Address manager failed to create memfd to map anonymous memory.
-    #[error("address manager failed to create memfd to map anonymous memory")]
-    CreateMemFd(#[source] nix::Error),
-
-    /// Address manager failed to open memory file.
-    #[error("address manager failed to open memory file")]
-    OpenFile(#[source] std::io::Error),
-
-    /// Memory file provided is invalid due to empty file path, non-existent file path and other possible mistakes.
-    #[error("memory file provided to address manager {0} is invalid")]
-    FileInvalid(String),
-
-    /// Memory file provided is invalid due to empty memory type
-    #[error("memory type provided to address manager {0} is invalid")]
-    TypeInvalid(String),
-
-    /// Failed to set size for memory file.
-    #[error("address manager failed to set size for memory file")]
-    SetFileSize(#[source] std::io::Error),
-
-    /// Failed to unlink memory file.
-    #[error("address manager failed to unlink memory file")]
-    UnlinkFile(#[source] nix::Error),
-
-    /// Failed to duplicate fd of memory file.
-    #[error("address manager failed to duplicate memory file descriptor")]
-    DupFd(#[source] nix::Error),
-
-    /// Failure in accessing the memory located at some address.
-    #[error("address manager failed to access guest memory located at 0x{0:x}")]
-    AccessGuestMemory(u64, #[source] vm_memory::mmap::Error),
-
-    /// Failed to create GuestMemory
-    #[error("address manager failed to create guest memory object")]
-    CreateGuestMemory(#[source] vm_memory::Error),
-
-    /// Failure in initializing guest memory.
-    #[error("address manager failed to initialize guest memory")]
-    GuestMemoryNotInitialized,
-
-    /// Failed to mmap() guest memory
-    #[error("address manager failed to mmap() guest memory into current process")]
-    MmapGuestMemory(#[source] vm_memory::mmap::MmapRegionError),
-
-    /// Failed to set KVM memory slot.
-    #[error("address manager failed to configure KVM memory slot")]
-    KvmSetMemorySlot(#[source] kvm_ioctls::Error),
-
-    /// Failed to set madvise on AddressSpaceRegion
-    #[error("address manager failed to set madvice() on guest memory region")]
-    Madvise(#[source] nix::Error),
-
-    /// join threads fail
-    #[error("address manager failed to join threads")]
-    JoinFail,
-
-    /// Failed to create Address Space Region
-    #[error("address manager failed to create Address Space Region {0}")]
-    CreateAddressSpaceRegion(#[source] AddressSpaceError),
-}
-
-type Result<T> = std::result::Result<T, AddressManagerError>;
-
-/// Parameters to configure address space creation operations.
-pub struct AddressSpaceMgrBuilder<'a> {
-    mem_type: &'a str,
-    mem_file: &'a str,
-    mem_index: u32,
-    mem_suffix: bool,
-    mem_prealloc: bool,
-    dirty_page_logging: bool,
-    vmfd: Option<Arc<VmFd>>,
-}
-
-impl<'a> AddressSpaceMgrBuilder<'a> {
-    /// Create a new [`AddressSpaceMgrBuilder`] object.
-    pub fn new(mem_type: &'a str, mem_file: &'a str) -> Result<Self> {
-        if mem_type.is_empty() {
-            return Err(AddressManagerError::TypeInvalid(mem_type.to_string()));
-        }
-        Ok(AddressSpaceMgrBuilder {
-            mem_type,
-            mem_file,
-            mem_index: 0,
-            mem_suffix: true,
-            mem_prealloc: false,
-            dirty_page_logging: false,
-            vmfd: None,
-        })
-    }
-
-    /// Enable/disable adding numbered suffix to memory file path.
-    /// This feature could be useful to generate hugetlbfs files with number suffix. (e.g. shmem0, shmem1)
-    pub fn toggle_file_suffix(&mut self, enabled: bool) {
-        self.mem_suffix = enabled;
-    }
-
-    /// Enable/disable memory pre-allocation.
-    /// Enable this feature could improve performance stability at the start of workload by avoiding page fault.
-    /// Disable this feature may influence performance stability but the cpu resource consumption and start-up time will decrease.
-    pub fn toggle_prealloc(&mut self, prealloc: bool) {
-        self.mem_prealloc = prealloc;
-    }
-
-    /// Enable/disable KVM dirty page logging.
-    pub fn toggle_dirty_page_logging(&mut self, logging: bool) {
-        self.dirty_page_logging = logging;
-    }
-
-    /// Set KVM [`VmFd`] handle to configure memory slots.
-    pub fn set_kvm_vm_fd(&mut self, vmfd: Arc<VmFd>) -> Option<Arc<VmFd>> {
-        let mut existing_vmfd = None;
-        if self.vmfd.is_some() {
-            existing_vmfd = self.vmfd.clone();
-        }
-        self.vmfd = Some(vmfd);
-        existing_vmfd
-    }
-
-    /// Build a ['AddressSpaceMgr'] using the configured parameters.
-    pub fn build(
-        self,
-        res_mgr: &ResourceManager,
-        numa_region_infos: &[NumaRegionInfo],
-    ) -> Result<AddressSpaceMgr> {
-        let mut mgr = AddressSpaceMgr::default();
-        mgr.create_address_space(res_mgr, numa_region_infos, self)?;
-        Ok(mgr)
-    }
-
-    fn get_next_mem_file(&mut self) -> String {
-        if self.mem_suffix {
-            let path = format!("{}{}", self.mem_file, self.mem_index);
-            self.mem_index += 1;
-            path
-        } else {
-            self.mem_file.to_string()
-        }
-    }
-}
-
-/// Struct to manage virtual machine's physical address space.
-pub struct AddressSpaceMgr {
-    address_space: Option<AddressSpace>,
-    vm_as: Option<GuestAddressSpaceImpl>,
-    base_to_slot: Arc<Mutex<HashMap<u64, u32>>>,
-    prealloc_handlers: Vec<thread::JoinHandle<()>>,
-    prealloc_exit: Arc<AtomicBool>,
-    numa_nodes: BTreeMap<u32, NumaNode>,
-}
-
-impl AddressSpaceMgr {
-    /// Query address space manager is initialized or not
-    pub fn is_initialized(&self) -> bool {
-        self.address_space.is_some()
-    }
-
-    /// Gets address space.
-    pub fn address_space(&self) -> Option<&AddressSpace> {
-        self.address_space.as_ref()
-    }
-
-    /// Create the address space for a virtual machine.
-    ///
-    /// This method is designed to be called when starting up a virtual machine instead of at
-    /// runtime, so it's expected the virtual machine will be tore down and no strict error recover.
-    pub fn create_address_space(
-        &mut self,
-        res_mgr: &ResourceManager,
-        numa_region_infos: &[NumaRegionInfo],
-        mut param: AddressSpaceMgrBuilder,
-    ) -> Result<()> {
-        let mut regions = Vec::new();
-        let mut start_addr = dbs_boot::layout::GUEST_MEM_START;
-
-        // Create address space regions.
-        for info in numa_region_infos.iter() {
-            info!("numa_region_info {:?}", info);
-            // convert size_in_mib to bytes
-            let size = info
-                .size
-                .checked_shl(20)
-                .ok_or_else(|| AddressManagerError::InvalidOperation)?;
-
-            // Guest memory does not intersect with the MMIO hole.
-            // TODO: make it work for ARM (issue #4307)
-            if start_addr > dbs_boot::layout::MMIO_LOW_END
-                || start_addr + size <= dbs_boot::layout::MMIO_LOW_START
-            {
-                let region = self.create_region(start_addr, size, info, &mut param)?;
-                regions.push(region);
-                start_addr = start_addr
-                    .checked_add(size)
-                    .ok_or_else(|| AddressManagerError::InvalidOperation)?;
-            } else {
-                // Add guest memory below the MMIO hole, avoid splitting the memory region
-                // if the available address region is small than MINIMAL_SPLIT_SPACE MiB.
-                let mut below_size = dbs_boot::layout::MMIO_LOW_START
-                    .checked_sub(start_addr)
-                    .ok_or_else(|| AddressManagerError::InvalidOperation)?;
-                if below_size < (MINIMAL_SPLIT_SPACE) {
-                    below_size = 0;
-                } else {
-                    let region = self.create_region(start_addr, below_size, info, &mut param)?;
-                    regions.push(region);
-                }
-
-                // Add guest memory above the MMIO hole
-                let above_start = dbs_boot::layout::MMIO_LOW_END + 1;
-                let above_size = size
-                    .checked_sub(below_size)
-                    .ok_or_else(|| AddressManagerError::InvalidOperation)?;
-                let region = self.create_region(above_start, above_size, info, &mut param)?;
-                regions.push(region);
-                start_addr = above_start
-                    .checked_add(above_size)
-                    .ok_or_else(|| AddressManagerError::InvalidOperation)?;
-            }
-        }
-
-        // Create GuestMemory object
-        let mut vm_memory = GuestMemoryMmap::new();
-        for reg in regions.iter() {
-            // Allocate used guest memory addresses.
-            // These addresses are statically allocated, resource allocation/update should not fail.
-            let constraint = Constraint::new(reg.len())
-                .min(reg.start_addr().raw_value())
-                .max(reg.last_addr().raw_value());
-            let _key = res_mgr
-                .allocate_mem_address(&constraint)
-                .ok_or(AddressManagerError::NoAvailableMemAddress)?;
-            let mmap_reg = self.create_mmap_region(reg.clone())?;
-
-            vm_memory = vm_memory
-                .insert_region(mmap_reg.clone())
-                .map_err(AddressManagerError::CreateGuestMemory)?;
-            self.map_to_kvm(res_mgr, &param, reg, mmap_reg)?;
-        }
-
-        #[cfg(feature = "atomic-guest-memory")]
-        {
-            self.vm_as = Some(AddressSpace::convert_into_vm_as(vm_memory));
-        }
-        #[cfg(not(feature = "atomic-guest-memory"))]
-        {
-            self.vm_as = Some(Arc::new(vm_memory));
-        }
-
-        let layout = AddressSpaceLayout::new(
-            *dbs_boot::layout::GUEST_PHYS_END,
-            dbs_boot::layout::GUEST_MEM_START,
-            *dbs_boot::layout::GUEST_MEM_END,
-        );
-        self.address_space = Some(AddressSpace::from_regions(regions, layout));
-
-        Ok(())
-    }
-
-    // size unit: Byte
-    fn create_region(
-        &mut self,
-        start_addr: u64,
-        size_bytes: u64,
-        info: &NumaRegionInfo,
-        param: &mut AddressSpaceMgrBuilder,
-    ) -> Result<Arc<AddressSpaceRegion>> {
-        let mem_file_path = param.get_next_mem_file();
-        let region = AddressSpaceRegion::create_default_memory_region(
-            GuestAddress(start_addr),
-            size_bytes,
-            info.host_numa_node_id,
-            param.mem_type,
-            &mem_file_path,
-            param.mem_prealloc,
-            false,
-        )
-        .map_err(AddressManagerError::CreateAddressSpaceRegion)?;
-        let region = Arc::new(region);
-
-        self.insert_into_numa_nodes(
-            &region,
-            info.guest_numa_node_id.unwrap_or(0),
-            &info.vcpu_ids,
-        );
-        info!(
-            "create new region: guest addr 0x{:x}-0x{:x} size {}",
-            start_addr,
-            start_addr + size_bytes,
-            size_bytes
-        );
-
-        Ok(region)
-    }
-
-    fn map_to_kvm(
-        &mut self,
-        res_mgr: &ResourceManager,
-        param: &AddressSpaceMgrBuilder,
-        reg: &Arc<AddressSpaceRegion>,
-        mmap_reg: Arc<GuestRegionImpl>,
-    ) -> Result<()> {
-        // Build mapping between GPA <-> HVA, by adding kvm memory slot.
-        let slot = res_mgr
-            .allocate_kvm_mem_slot(1, None)
-            .ok_or(AddressManagerError::NoAvailableKvmSlot)?;
-
-        if let Some(vmfd) = param.vmfd.as_ref() {
-            let host_addr = mmap_reg
-                .get_host_address(MemoryRegionAddress(0))
-                .map_err(|_e| AddressManagerError::InvalidOperation)?;
-            let flags = 0u32;
-
-            let mem_region = kvm_userspace_memory_region {
-                slot: slot as u32,
-                guest_phys_addr: reg.start_addr().raw_value(),
-                memory_size: reg.len() as u64,
-                userspace_addr: host_addr as u64,
-                flags,
-            };
-
-            info!(
-                "VM: guest memory region {:x} starts at {:x?}",
-                reg.start_addr().raw_value(),
-                host_addr
-            );
-            // Safe because the guest regions are guaranteed not to overlap.
-            unsafe { vmfd.set_user_memory_region(mem_region) }
-                .map_err(AddressManagerError::KvmSetMemorySlot)?;
-        }
-
-        self.base_to_slot
-            .lock()
-            .unwrap()
-            .insert(reg.start_addr().raw_value(), slot as u32);
-
-        Ok(())
-    }
-
-    /// Mmap the address space region into current process.
-    pub fn create_mmap_region(
-        &mut self,
-        region: Arc<AddressSpaceRegion>,
-    ) -> Result<Arc<GuestRegionImpl>> {
-        // Special check for 32bit host with 64bit virtual machines.
-        if region.len() > usize::MAX as u64 {
-            return Err(AddressManagerError::InvalidAddressRange(
-                region.start_addr().raw_value(),
-                region.len(),
-            ));
-        }
-        // The device MMIO regions may not be backed by memory files, so refuse to mmap them.
-        if region.region_type() == AddressSpaceRegionType::DeviceMemory {
-            return Err(AddressManagerError::InvalidOperation);
-        }
-
-        // The GuestRegionMmap/MmapRegion will take ownership of the FileOffset object,
-        // so we have to duplicate the fd here. It's really a dirty design.
-        let file_offset = match region.file_offset().as_ref() {
-            Some(fo) => {
-                let fd = dup(fo.file().as_raw_fd()).map_err(AddressManagerError::DupFd)?;
-                // Safe because we have just duplicated the raw fd.
-                let file = unsafe { File::from_raw_fd(fd) };
-                let file_offset = FileOffset::new(file, fo.start());
-                Some(file_offset)
-            }
-            None => None,
-        };
-        let perm_flags = if (region.perm_flags() & libc::MAP_POPULATE) != 0 && region.is_hugepage()
-        {
-            // mmap(MAP_POPULATE) conflicts with madive(MADV_HUGEPAGE) because mmap(MAP_POPULATE)
-            // will pre-fault in all memory with normal pages before madive(MADV_HUGEPAGE) gets
-            // called. So remove the MAP_POPULATE flag and memory will be faulted in by working
-            // threads.
-            region.perm_flags() & (!libc::MAP_POPULATE)
-        } else {
-            region.perm_flags()
-        };
-        let mmap_reg = MmapRegion::build(
-            file_offset,
-            region.len() as usize,
-            libc::PROT_READ | libc::PROT_WRITE,
-            perm_flags,
-        )
-        .map_err(AddressManagerError::MmapGuestMemory)?;
-
-        if region.is_anonpage() {
-            self.configure_anon_mem(&mmap_reg)?;
-        }
-        if let Some(node_id) = region.host_numa_node_id() {
-            self.configure_numa(&mmap_reg, node_id)?;
-        }
-        if region.is_hugepage() {
-            self.configure_thp_and_prealloc(&region, &mmap_reg)?;
-        }
-
-        let reg = GuestRegionImpl::new(mmap_reg, region.start_addr())
-            .map_err(AddressManagerError::CreateGuestMemory)?;
-        Ok(Arc::new(reg))
-    }
-
-    fn configure_anon_mem(&self, mmap_reg: &MmapRegion) -> Result<()> {
-        unsafe {
-            mman::madvise(
-                mmap_reg.as_ptr() as *mut libc::c_void,
-                mmap_reg.size(),
-                mman::MmapAdvise::MADV_DONTFORK,
-            )
-        }
-        .map_err(AddressManagerError::Madvise)
-    }
-
-    fn configure_numa(&self, mmap_reg: &MmapRegion, node_id: u32) -> Result<()> {
-        let nodemask = 1_u64
-            .checked_shl(node_id)
-            .ok_or_else(|| AddressManagerError::InvalidOperation)?;
-        let res = unsafe {
-            libc::syscall(
-                libc::SYS_mbind,
-                mmap_reg.as_ptr() as *mut libc::c_void,
-                mmap_reg.size(),
-                MPOL_PREFERRED,
-                &nodemask as *const u64,
-                MAX_NODE,
-                MPOL_MF_MOVE,
-            )
-        };
-        if res < 0 {
-            warn!(
-                "failed to mbind memory to host_numa_node_id {}: this may affect performance",
-                node_id
-            );
-        }
-        Ok(())
-    }
-
-    // We set Transparent Huge Page (THP) through mmap to increase performance.
-    // In order to reduce the impact of page fault on performance, we start several threads (up to MAX_PRE_ALLOC_THREAD) to touch every 4k page of the memory region to manually do memory pre-allocation.
-    // The reason why we don't use mmap to enable THP and pre-alloction is that THP setting won't take effect in this operation (tested in kernel 4.9)
-    fn configure_thp_and_prealloc(
-        &mut self,
-        region: &Arc<AddressSpaceRegion>,
-        mmap_reg: &MmapRegion,
-    ) -> Result<()> {
-        debug!(
-            "Setting MADV_HUGEPAGE on AddressSpaceRegion addr {:x?} len {:x?}",
-            mmap_reg.as_ptr(),
-            mmap_reg.size()
-        );
-
-        // Safe because we just create the MmapRegion
-        unsafe {
-            mman::madvise(
-                mmap_reg.as_ptr() as *mut libc::c_void,
-                mmap_reg.size(),
-                mman::MmapAdvise::MADV_HUGEPAGE,
-            )
-        }
-        .map_err(AddressManagerError::Madvise)?;
-
-        if region.perm_flags() & libc::MAP_POPULATE > 0 {
-            // Touch every 4k page to trigger allocation. The step is 4K instead of 2M to ensure
-            // pre-allocation when running out of huge pages.
-            const PAGE_SIZE: u64 = 4096;
-            const PAGE_SHIFT: u32 = 12;
-            let addr = mmap_reg.as_ptr() as u64;
-            // Here we use >> PAGE_SHIFT to calculate how many 4K pages in the memory region.
-            let npage = (mmap_reg.size() as u64) >> PAGE_SHIFT;
-
-            let mut touch_thread = ((mmap_reg.size() as u64) >> PRE_ALLOC_GRANULARITY) + 1;
-            if touch_thread > MAX_PRE_ALLOC_THREAD {
-                touch_thread = MAX_PRE_ALLOC_THREAD;
-            }
-
-            let per_npage = npage / touch_thread;
-            for n in 0..touch_thread {
-                let start_npage = per_npage * n;
-                let end_npage = if n == (touch_thread - 1) {
-                    npage
-                } else {
-                    per_npage * (n + 1)
-                };
-                let mut per_addr = addr + (start_npage * PAGE_SIZE);
-                let should_stop = self.prealloc_exit.clone();
-
-                let handler = thread::Builder::new()
-                    .name("PreallocThread".to_string())
-                    .spawn(move || {
-                        info!("PreallocThread start start_npage: {:?}, end_npage: {:?}, per_addr: {:?}, thread_number: {:?}",
-                              start_npage, end_npage, per_addr, touch_thread );
-                        for _ in start_npage..end_npage {
-                            if should_stop.load(Ordering::Acquire) {
-                                info!("PreallocThread stop start_npage: {:?}, end_npage: {:?}, per_addr: {:?}, thread_number: {:?}",
-                                      start_npage, end_npage, per_addr, touch_thread);
-                                break;
-                            }
-
-                            // Reading from a THP page may be served by the zero page, so only
-                            // write operation could ensure THP memory allocation. So use
-                            // the compare_exchange(old_val, old_val) trick to trigger allocation.
-                            let addr_ptr = per_addr as *mut u8;
-                            let read_byte = unsafe { std::ptr::read_volatile(addr_ptr) };
-                            let atomic_u8 : &AtomicU8 = unsafe {&*(addr_ptr as *mut AtomicU8)};
-                            let _ = atomic_u8.compare_exchange(read_byte, read_byte, Ordering::SeqCst, Ordering::SeqCst);
-                            per_addr += PAGE_SIZE;
-                        }
-
-                        info!("PreallocThread done start_npage: {:?}, end_npage: {:?}, per_addr: {:?}, thread_number: {:?}",
-                              start_npage, end_npage, per_addr, touch_thread );
-                    });
-
-                match handler {
-                    Err(e) => error!(
-                        "Failed to create working thread for async pre-allocation, {:?}. This may affect performance stability at the start of the workload.",
-                        e
-                    ),
-                    Ok(hdl) => self.prealloc_handlers.push(hdl),
-                }
-            }
-        }
-
-        Ok(())
-    }
-
-    /// Get the address space object
-    pub fn get_address_space(&self) -> Option<&AddressSpace> {
-        self.address_space.as_ref()
-    }
-
-    /// Get the default guest memory object, which will be used to access virtual machine's default
-    /// guest memory.
-    pub fn get_vm_as(&self) -> Option<&GuestAddressSpaceImpl> {
-        self.vm_as.as_ref()
-    }
-
-    /// Get the base to slot map
-    pub fn get_base_to_slot_map(&self) -> Arc<Mutex<HashMap<u64, u32>>> {
-        self.base_to_slot.clone()
-    }
-
-    /// get numa nodes infos from address space manager.
-    pub fn get_numa_nodes(&self) -> &BTreeMap<u32, NumaNode> {
-        &self.numa_nodes
-    }
-
-    /// add cpu and memory numa informations to BtreeMap
-    fn insert_into_numa_nodes(
-        &mut self,
-        region: &Arc<AddressSpaceRegion>,
-        guest_numa_node_id: u32,
-        vcpu_ids: &[u32],
-    ) {
-        let node = self
-            .numa_nodes
-            .entry(guest_numa_node_id)
-            .or_insert_with(NumaNode::new);
-        node.add_info(&NumaNodeInfo {
-            base: region.start_addr(),
-            size: region.len(),
-        });
-        node.add_vcpu_ids(vcpu_ids);
-    }
-
-    /// get address space layout from address space manager.
-    pub fn get_layout(&self) -> Result<AddressSpaceLayout> {
-        self.address_space
-            .as_ref()
-            .map(|v| v.layout())
-            .ok_or(AddressManagerError::GuestMemoryNotInitialized)
-    }
-
-    /// Wait for the pre-allocation working threads to finish work.
-    ///
-    /// Force all working threads to exit if `stop` is true.
-    pub fn wait_prealloc(&mut self, stop: bool) -> Result<()> {
-        if stop {
-            self.prealloc_exit.store(true, Ordering::Release);
-        }
-        while let Some(handlers) = self.prealloc_handlers.pop() {
-            if let Err(e) = handlers.join() {
-                error!("wait_prealloc join fail {:?}", e);
-                return Err(AddressManagerError::JoinFail);
-            }
-        }
-        Ok(())
-    }
-}
-
-impl Default for AddressSpaceMgr {
-    /// Create a new empty AddressSpaceMgr
-    fn default() -> Self {
-        AddressSpaceMgr {
-            address_space: None,
-            vm_as: None,
-            base_to_slot: Arc::new(Mutex::new(HashMap::new())),
-            prealloc_handlers: Vec::new(),
-            prealloc_exit: Arc::new(AtomicBool::new(false)),
-            numa_nodes: BTreeMap::new(),
-        }
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    use dbs_boot::layout::GUEST_MEM_START;
-    use std::ops::Deref;
-
-    use vm_memory::{Bytes, GuestAddressSpace, GuestMemory, GuestMemoryRegion};
-    use vmm_sys_util::tempfile::TempFile;
-
-    use super::*;
-
-    #[test]
-    fn test_create_address_space() {
-        let res_mgr = ResourceManager::new(None);
-        let mem_size = 128 << 20;
-        let numa_region_infos = vec![NumaRegionInfo {
-            size: mem_size >> 20,
-            host_numa_node_id: None,
-            guest_numa_node_id: Some(0),
-            vcpu_ids: vec![1, 2],
-        }];
-        let builder = AddressSpaceMgrBuilder::new("shmem", "").unwrap();
-        let as_mgr = builder.build(&res_mgr, &numa_region_infos).unwrap();
-        let vm_as = as_mgr.get_vm_as().unwrap();
-        let guard = vm_as.memory();
-        let gmem = guard.deref();
-        assert_eq!(gmem.num_regions(), 1);
-
-        let reg = gmem
-            .find_region(GuestAddress(GUEST_MEM_START + mem_size - 1))
-            .unwrap();
-        assert_eq!(reg.start_addr(), GuestAddress(GUEST_MEM_START));
-        assert_eq!(reg.len(), mem_size);
-        assert!(gmem
-            .find_region(GuestAddress(GUEST_MEM_START + mem_size))
-            .is_none());
-        assert!(reg.file_offset().is_some());
-
-        let buf = [0x1u8, 0x2u8, 0x3u8, 0x4u8, 0x5u8];
-        gmem.write_slice(&buf, GuestAddress(GUEST_MEM_START))
-            .unwrap();
-
-        // Update middle of mapped memory region
-        let mut val = 0xa5u8;
-        gmem.write_obj(val, GuestAddress(GUEST_MEM_START + 0x1))
-            .unwrap();
-        val = gmem.read_obj(GuestAddress(GUEST_MEM_START + 0x1)).unwrap();
-        assert_eq!(val, 0xa5);
-        val = gmem.read_obj(GuestAddress(GUEST_MEM_START)).unwrap();
-        assert_eq!(val, 1);
-        val = gmem.read_obj(GuestAddress(GUEST_MEM_START + 0x2)).unwrap();
-        assert_eq!(val, 3);
-        val = gmem.read_obj(GuestAddress(GUEST_MEM_START + 0x5)).unwrap();
-        assert_eq!(val, 0);
-
-        // Read ahead of mapped memory region
-        assert!(gmem
-            .read_obj::<u8>(GuestAddress(GUEST_MEM_START + mem_size))
-            .is_err());
-
-        let res_mgr = ResourceManager::new(None);
-        let mem_size = dbs_boot::layout::MMIO_LOW_START + (1 << 30);
-        let numa_region_infos = vec![NumaRegionInfo {
-            size: mem_size >> 20,
-            host_numa_node_id: None,
-            guest_numa_node_id: Some(0),
-            vcpu_ids: vec![1, 2],
-        }];
-        let builder = AddressSpaceMgrBuilder::new("shmem", "").unwrap();
-        let as_mgr = builder.build(&res_mgr, &numa_region_infos).unwrap();
-        let vm_as = as_mgr.get_vm_as().unwrap();
-        let guard = vm_as.memory();
-        let gmem = guard.deref();
-        #[cfg(target_arch = "x86_64")]
-        assert_eq!(gmem.num_regions(), 2);
-        #[cfg(target_arch = "aarch64")]
-        assert_eq!(gmem.num_regions(), 1);
-
-        // Test dropping GuestMemoryMmap object releases all resources.
-        for _ in 0..10000 {
-            let res_mgr = ResourceManager::new(None);
-            let mem_size = 1 << 20;
-            let numa_region_infos = vec![NumaRegionInfo {
-                size: mem_size >> 20,
-                host_numa_node_id: None,
-                guest_numa_node_id: Some(0),
-                vcpu_ids: vec![1, 2],
-            }];
-            let builder = AddressSpaceMgrBuilder::new("shmem", "").unwrap();
-            let _as_mgr = builder.build(&res_mgr, &numa_region_infos).unwrap();
-        }
-        let file = TempFile::new().unwrap().into_file();
-        let fd = file.as_raw_fd();
-        // fd should be small enough if there's no leaking of fds.
-        assert!(fd < 1000);
-    }
-
-    #[test]
-    fn test_address_space_mgr_get_boundary() {
-        let layout = AddressSpaceLayout::new(
-            *dbs_boot::layout::GUEST_PHYS_END,
-            dbs_boot::layout::GUEST_MEM_START,
-            *dbs_boot::layout::GUEST_MEM_END,
-        );
-        let res_mgr = ResourceManager::new(None);
-        let mem_size = 128 << 20;
-        let numa_region_infos = vec![NumaRegionInfo {
-            size: mem_size >> 20,
-            host_numa_node_id: None,
-            guest_numa_node_id: Some(0),
-            vcpu_ids: vec![1, 2],
-        }];
-        let builder = AddressSpaceMgrBuilder::new("shmem", "").unwrap();
-        let as_mgr = builder.build(&res_mgr, &numa_region_infos).unwrap();
-        assert_eq!(as_mgr.get_layout().unwrap(), layout);
-    }
-
-    #[test]
-    fn test_address_space_mgr_get_numa_nodes() {
-        let res_mgr = ResourceManager::new(None);
-        let mem_size = 128 << 20;
-        let cpu_vec = vec![1, 2];
-        let numa_region_infos = vec![NumaRegionInfo {
-            size: mem_size >> 20,
-            host_numa_node_id: None,
-            guest_numa_node_id: Some(0),
-            vcpu_ids: cpu_vec.clone(),
-        }];
-        let builder = AddressSpaceMgrBuilder::new("shmem", "").unwrap();
-        let as_mgr = builder.build(&res_mgr, &numa_region_infos).unwrap();
-        let mut numa_node = NumaNode::new();
-        numa_node.add_info(&NumaNodeInfo {
-            base: GuestAddress(GUEST_MEM_START),
-            size: mem_size,
-        });
-        numa_node.add_vcpu_ids(&cpu_vec);
-
-        assert_eq!(*as_mgr.get_numa_nodes().get(&0).unwrap(), numa_node);
-    }
-
-    #[test]
-    fn test_address_space_mgr_async_prealloc() {
-        let res_mgr = ResourceManager::new(None);
-        let mem_size = 2 << 20;
-        let cpu_vec = vec![1, 2];
-        let numa_region_infos = vec![NumaRegionInfo {
-            size: mem_size >> 20,
-            host_numa_node_id: None,
-            guest_numa_node_id: Some(0),
-            vcpu_ids: cpu_vec,
-        }];
-        let mut builder = AddressSpaceMgrBuilder::new("hugeshmem", "").unwrap();
-        builder.toggle_prealloc(true);
-        let mut as_mgr = builder.build(&res_mgr, &numa_region_infos).unwrap();
-        as_mgr.wait_prealloc(false).unwrap();
-    }
-
-    #[test]
-    fn test_address_space_mgr_builder() {
-        let mut builder = AddressSpaceMgrBuilder::new("shmem", "/tmp/shmem").unwrap();
-
-        assert_eq!(builder.mem_type, "shmem");
-        assert_eq!(builder.mem_file, "/tmp/shmem");
-        assert_eq!(builder.mem_index, 0);
-        assert!(builder.mem_suffix);
-        assert!(!builder.mem_prealloc);
-        assert!(!builder.dirty_page_logging);
-        assert!(builder.vmfd.is_none());
-
-        assert_eq!(&builder.get_next_mem_file(), "/tmp/shmem0");
-        assert_eq!(&builder.get_next_mem_file(), "/tmp/shmem1");
-        assert_eq!(&builder.get_next_mem_file(), "/tmp/shmem2");
-        assert_eq!(builder.mem_index, 3);
-
-        builder.toggle_file_suffix(false);
-        assert_eq!(&builder.get_next_mem_file(), "/tmp/shmem");
-        assert_eq!(&builder.get_next_mem_file(), "/tmp/shmem");
-        assert_eq!(builder.mem_index, 3);
-
-        builder.toggle_prealloc(true);
-        builder.toggle_dirty_page_logging(true);
-        assert!(builder.mem_prealloc);
-        assert!(builder.dirty_page_logging);
-    }
-
-    #[test]
-    fn test_configure_invalid_numa() {
-        let res_mgr = ResourceManager::new(None);
-        let mem_size = 128 << 20;
-        let numa_region_infos = vec![NumaRegionInfo {
-            size: mem_size >> 20,
-            host_numa_node_id: None,
-            guest_numa_node_id: Some(0),
-            vcpu_ids: vec![1, 2],
-        }];
-        let builder = AddressSpaceMgrBuilder::new("shmem", "").unwrap();
-        let as_mgr = builder.build(&res_mgr, &numa_region_infos).unwrap();
-        let mmap_reg = MmapRegion::new(8).unwrap();
-
-        assert!(as_mgr.configure_numa(&mmap_reg, u32::MAX).is_err());
-    }
-}

src/dragonball/src/api/mod.rs

@@ -1,6 +0,0 @@
-// Copyright (C) 2019-2022 Alibaba Cloud. All rights reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-//! API related data structures to configure the vmm.
-
-pub mod v1;

src/dragonball/src/api/v1/boot_source.rs

@@ -1,55 +0,0 @@
-// Copyright (C) 2022 Alibaba Cloud. All rights reserved.
-// Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-use serde_derive::{Deserialize, Serialize};
-
-/// Default guest kernel command line:
-/// - `reboot=k` shutdown the guest on reboot, instead of well... rebooting;
-/// - `panic=1` on panic, reboot after 1 second;
-/// - `pci=off` do not scan for PCI devices (ser boot time);
-/// - `nomodules` disable loadable kernel module support;
-/// - `8250.nr_uarts=0` disable 8250 serial interface;
-/// - `i8042.noaux` do not probe the i8042 controller for an attached mouse (ser boot time);
-/// - `i8042.nomux` do not probe i8042 for a multiplexing controller (ser boot time);
-/// - `i8042.nopnp` do not use ACPIPnP to discover KBD/AUX controllers (ser boot time);
-/// - `i8042.dumbkbd` do not attempt to control kbd state via the i8042 (ser boot time).
-pub const DEFAULT_KERNEL_CMDLINE: &str = "reboot=k panic=1 pci=off nomodules 8250.nr_uarts=0 \
-                                          i8042.noaux i8042.nomux i8042.nopnp i8042.dumbkbd";
-
-/// Strongly typed data structure used to configure the boot source of the microvm.
-#[derive(Clone, Debug, Deserialize, PartialEq, Serialize, Default)]
-#[serde(deny_unknown_fields)]
-pub struct BootSourceConfig {
-    /// Path of the kernel image.
-    /// We only support uncompressed kernel for Dragonball.
-    pub kernel_path: String,
-    /// Path of the initrd, if there is one.
-    /// ps. rootfs is set in BlockDeviceConfigInfo
-    pub initrd_path: Option<String>,
-    /// The boot arguments to pass to the kernel.
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub boot_args: Option<String>,
-}
-
-/// Errors associated with actions on `BootSourceConfig`.
-#[derive(Debug, thiserror::Error)]
-pub enum BootSourceConfigError {
-    /// The kernel file cannot be opened.
-    #[error(
-        "the kernel file cannot be opened due to invalid kernel path or invalid permissions: {0}"
-    )]
-    InvalidKernelPath(#[source] std::io::Error),
-
-    /// The initrd file cannot be opened.
-    #[error("the initrd file cannot be opened due to invalid path or invalid permissions: {0}")]
-    InvalidInitrdPath(#[source] std::io::Error),
-
-    /// The kernel command line is invalid.
-    #[error("the kernel command line is invalid: {0}")]
-    InvalidKernelCommandLine(#[source] linux_loader::cmdline::Error),
-
-    /// The boot source cannot be update post boot.
-    #[error("the update operation is not allowed after boot")]
-    UpdateNotAllowedPostBoot,
-}