1#!/bin/bash 2 3# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. 4# Copyright © 2020 Intel Corporation 5# SPDX-License-Identifier: Apache-2.0 6 7CLI_NAME="Cloud Hypervisor" 8 9CTR_IMAGE_TAG="cloudhypervisor/dev" 10CTR_IMAGE_VERSION="latest" 11CTR_IMAGE="${CTR_IMAGE_TAG}:${CTR_IMAGE_VERSION}" 12 13DOCKER_RUNTIME="docker" 14 15# Host paths 16CLH_SCRIPTS_DIR=$(cd "$(dirname "$0")" && pwd) 17CLH_ROOT_DIR=$(cd "${CLH_SCRIPTS_DIR}/.." && pwd) 18CLH_BUILD_DIR="${CLH_ROOT_DIR}/build" 19CLH_CARGO_TARGET="${CLH_BUILD_DIR}/cargo_target" 20CLH_DOCKERFILE="${CLH_SCRIPTS_DIR}/../resources/Dockerfile" 21CLH_CTR_BUILD_DIR="/tmp/cloud-hypervisor/ctr-build" 22CLH_INTEGRATION_WORKLOADS="${HOME}/workloads" 23 24# Container paths 25CTR_CLH_ROOT_DIR="/cloud-hypervisor" 26CTR_CLH_CARGO_BUILT_DIR="${CTR_CLH_ROOT_DIR}/build" 27CTR_CLH_CARGO_TARGET="${CTR_CLH_CARGO_BUILT_DIR}/cargo_target" 28CTR_CLH_INTEGRATION_WORKLOADS="/root/workloads" 29 30# Container networking option 31CTR_CLH_NET="bridge" 32 33# Cargo paths 34# Full path to the cargo registry dir on the host. This appears on the host 35# because we want to persist the cargo registry across container invocations. 36# Otherwise, any rust crates from crates.io would be downloaded again each time 37# we build or test. 38CARGO_REGISTRY_DIR="${CLH_BUILD_DIR}/cargo_registry" 39 40# Full path to the cargo git registry on the host. This serves the same purpose 41# as CARGO_REGISTRY_DIR, for crates downloaded from GitHub repos instead of 42# crates.io. 43CARGO_GIT_REGISTRY_DIR="${CLH_BUILD_DIR}/cargo_git_registry" 44 45# Full path to the cargo target dir on the host. 46CARGO_TARGET_DIR="${CLH_BUILD_DIR}/cargo_target" 47 48# Send a decorated message to stdout, followed by a new line 49# 50say() { 51 [ -t 1 ] && [ -n "$TERM" ] \ 52 && echo "$(tput setaf 2)[$CLI_NAME]$(tput sgr0) $*" \ 53 || echo "[$CLI_NAME] $*" 54} 55 56# Send a decorated message to stdout, without a trailing new line 57# 58say_noln() { 59 [ -t 1 ] && [ -n "$TERM" ] \ 60 && echo -n "$(tput setaf 2)[$CLI_NAME]$(tput sgr0) $*" \ 61 || echo "[$CLI_NAME] $*" 62} 63 64# Send a text message to stderr 65# 66say_err() { 67 [ -t 2 ] && [ -n "$TERM" ] \ 68 && echo "$(tput setaf 1)[$CLI_NAME] $*$(tput sgr0)" 1>&2 \ 69 || echo "[$CLI_NAME] $*" 1>&2 70} 71 72# Send a warning-highlighted text to stdout 73say_warn() { 74 [ -t 1 ] && [ -n "$TERM" ] \ 75 && echo "$(tput setaf 3)[$CLI_NAME] $*$(tput sgr0)" \ 76 || echo "[$CLI_NAME] $*" 77} 78 79# Exit with an error message and (optional) code 80# Usage: die [-c <error code>] <error message> 81# 82die() { 83 code=1 84 [[ "$1" = "-c" ]] && { 85 code="$2" 86 shift 2 87 } 88 say_err "$@" 89 exit $code 90} 91 92# Exit with an error message if the last exit code is not 0 93# 94ok_or_die() { 95 code=$? 96 [[ $code -eq 0 ]] || die -c $code "$@" 97} 98 99# Make sure the build/ dirs are available. Exit if we can't create them. 100# Upon returning from this call, the caller can be certain the build/ dirs exist. 101# 102ensure_build_dir() { 103 for dir in "$CLH_BUILD_DIR" \ 104 "$CLH_INTEGRATION_WORKLOADS" \ 105 "$CLH_CTR_BUILD_DIR" \ 106 "$CARGO_TARGET_DIR" \ 107 "$CARGO_REGISTRY_DIR" \ 108 "$CARGO_GIT_REGISTRY_DIR"; do 109 mkdir -p "$dir" || die "Error: cannot create dir $dir" 110 [ -x "$dir" ] && [ -w "$dir" ] || \ 111 { 112 say "Wrong permissions for $dir. Attempting to fix them ..." 113 chmod +x+w "$dir" 114 } || \ 115 die "Error: wrong permissions for $dir. Should be +x+w" 116 done 117} 118 119# Make sure we're using the latest dev container, by just pulling it. 120ensure_latest_ctr() { 121 $DOCKER_RUNTIME pull "$CTR_IMAGE" 122 123 ok_or_die "Error pulling container image. Aborting." 124} 125 126# Fix main directory permissions after a container ran as root. 127# Since the container ran as root, any files it creates will be owned by root. 128# This fixes that by recursively changing the ownership of /cloud-hypervisor to the 129# current user. 130# 131fix_dir_perms() { 132 # Yes, running Docker to get elevated privileges, just to chown some files 133 # is a dirty hack. 134 $DOCKER_RUNTIME run \ 135 --workdir "$CTR_CLH_ROOT_DIR" \ 136 --rm \ 137 --volume /dev:/dev \ 138 --volume "$CLH_ROOT_DIR:$CTR_CLH_ROOT_DIR" $exported_volumes \ 139 "$CTR_IMAGE" \ 140 chown -R "$(id -u):$(id -g)" "$CTR_CLH_ROOT_DIR" 141 142 return $1 143} 144# Process exported volumes argument, separate the volumes and make docker compatible 145# Sample input: --volumes /a:/a#/b:/b 146# Sample output: --volume /a:/a --volume /b:/b 147# 148process_volumes_args() { 149 if [ -z "$arg_vols" ]; then 150 return 151 fi 152 exported_volumes="" 153 arr_vols=(${arg_vols//#/ }) 154 for var in "${arr_vols[@]}" 155 do 156 parts=(${var//:/ }) 157 if [[ ! -e "${parts[0]}" ]]; then 158 echo "The volume ${parts[0]} does not exist." 159 exit 1 160 fi 161 exported_volumes="$exported_volumes --volume $var" 162 done 163} 164cmd_help() { 165 echo "" 166 echo "Cloud Hypervisor $(basename $0)" 167 echo "Usage: $(basename $0) <command> [<command args>]" 168 echo "" 169 echo "Available commands:" 170 echo "" 171 echo " build [--debug|--release] [--libc musl|gnu] [-- [<cargo args>]]" 172 echo " Build the Cloud Hypervisor binaries." 173 echo " --debug Build the debug binaries. This is the default." 174 echo " --release Build the release binaries." 175 echo " --libc Select the C library Cloud Hypervisor will be built against. Default is gnu" 176 echo " --volumes Hash separated volumes to be exported. Example --volumes /mnt:/mnt#/myvol:/myvol" 177 echo " --hypervisor Underlying hypervisor. Options kvm, mshv" 178 echo "" 179 echo " tests [--unit|--cargo|--all] [--libc musl|gnu] [-- [<cargo test args>]]" 180 echo " Run the Cloud Hypervisor tests." 181 echo " --unit Run the unit tests." 182 echo " --cargo Run the cargo tests." 183 echo " --integration Run the integration tests." 184 echo " --integration-sgx Run the SGX integration tests." 185 echo " --integration-vfio Run the VFIO integration tests." 186 echo " --integration-windows Run the Windows guest integration tests." 187 echo " --libc Select the C library Cloud Hypervisor will be built against. Default is gnu" 188 echo " --volumes Hash separated volumes to be exported. Example --volumes /mnt:/mnt#/myvol:/myvol" 189 echo " --hypervisor Underlying hypervisor. Options kvm, mshv" 190 echo " --all Run all tests." 191 echo "" 192 echo " build-container [--type]" 193 echo " Build the Cloud Hypervisor container." 194 echo " --dev Build dev container. This is the default." 195 echo "" 196 echo " clean [<cargo args>]]" 197 echo " Remove the Cloud Hypervisor artifacts." 198 echo "" 199 echo " shell" 200 echo " Run the development container into an interactive, privileged BASH shell." 201 echo " --volumes Hash separated volumes to be exported. Example --volumes /mnt:/mnt#/myvol:/myvol" 202 echo "" 203 echo " help" 204 echo " Display this help message." 205 echo "" 206} 207 208cmd_build() { 209 build="debug" 210 libc="gnu" 211 hypervisor="kvm" 212 features_build="" 213 exported_device="/dev/kvm" 214 while [ $# -gt 0 ]; do 215 case "$1" in 216 "-h"|"--help") { cmd_help; exit 1; } ;; 217 "--debug") { build="debug"; } ;; 218 "--release") { build="release"; } ;; 219 "--libc") 220 shift 221 [[ "$1" =~ ^(musl|gnu)$ ]] || \ 222 die "Invalid libc: $1. Valid options are \"musl\" and \"gnu\"." 223 libc="$1" 224 ;; 225 "--volumes") 226 shift 227 arg_vols="$1" 228 ;; 229 "--hypervisor") 230 shift 231 hypervisor="$1" 232 ;; 233 "--") { shift; break; } ;; 234 *) 235 die "Unknown build argument: $1. Please use --help for help." 236 ;; 237 esac 238 shift 239 done 240 241 ensure_build_dir 242 ensure_latest_ctr 243 244 process_volumes_args 245 if [[ "$hypervisor" != "kvm" ]]; then 246 die "Hypervisor value must be kvm" 247 fi 248 if [[ "$hypervisor" = "mshv" ]]; then 249 exported_device="/dev/mshv" 250 fi 251 target="$(uname -m)-unknown-linux-${libc}" 252 253 cargo_args=("$@") 254 [ $build = "release" ] && cargo_args+=("--release") 255 cargo_args+=(--target "$target") 256 [ $(uname -m) = "aarch64" ] && cargo_args+=("--no-default-features") 257 [ $(uname -m) = "aarch64" ] && cargo_args+=(--features $hypervisor) 258 259 rustflags="" 260 if [ $(uname -m) = "aarch64" ] && [ $libc = "musl" ] ; then 261 rustflags="-C link-arg=-lgcc -C link_arg=-specs -C link_arg=/usr/lib/aarch64-linux-musl/musl-gcc.specs" 262 fi 263 264 $DOCKER_RUNTIME run \ 265 --user "$(id -u):$(id -g)" \ 266 --workdir "$CTR_CLH_ROOT_DIR" \ 267 --rm \ 268 --volume $exported_device \ 269 --volume "$CLH_ROOT_DIR:$CTR_CLH_ROOT_DIR" $exported_volumes \ 270 --env RUSTFLAGS="$rustflags" \ 271 "$CTR_IMAGE" \ 272 cargo build --all $features_build \ 273 --target-dir "$CTR_CLH_CARGO_TARGET" \ 274 "${cargo_args[@]}" && say "Binaries placed under $CLH_CARGO_TARGET/$target/$build" 275} 276 277cmd_clean() { 278 cargo_args=("$@") 279 280 ensure_build_dir 281 ensure_latest_ctr 282 283 $DOCKER_RUNTIME run \ 284 --user "$(id -u):$(id -g)" \ 285 --workdir "$CTR_CLH_ROOT_DIR" \ 286 --rm \ 287 --volume "$CLH_ROOT_DIR:$CTR_CLH_ROOT_DIR" $exported_volumes \ 288 "$CTR_IMAGE" \ 289 cargo clean \ 290 --target-dir "$CTR_CLH_CARGO_TARGET" \ 291 "${cargo_args[@]}" 292 } 293 294cmd_tests() { 295 unit=false 296 cargo=false 297 integration=false 298 integration_sgx=false 299 integration_vfio=false 300 integration_windows=false 301 libc="gnu" 302 arg_vols="" 303 hypervisor="kvm" 304 exported_device="/dev/kvm" 305 while [ $# -gt 0 ]; do 306 case "$1" in 307 "-h"|"--help") { cmd_help; exit 1; } ;; 308 "--unit") { unit=true; } ;; 309 "--cargo") { cargo=true; } ;; 310 "--integration") { integration=true; } ;; 311 "--integration-sgx") { integration_sgx=true; } ;; 312 "--integration-vfio") { integration_vfio=true; } ;; 313 "--integration-windows") { integration_windows=true; } ;; 314 "--libc") 315 shift 316 [[ "$1" =~ ^(musl|gnu)$ ]] || \ 317 die "Invalid libc: $1. Valid options are \"musl\" and \"gnu\"." 318 libc="$1" 319 ;; 320 "--volumes") 321 shift 322 arg_vols="$1" 323 ;; 324 "--hypervisor") 325 shift 326 hypervisor="$1" 327 ;; 328 "--all") { cargo=true; unit=true; integration=true; } ;; 329 "--") { shift; break; } ;; 330 *) 331 die "Unknown tests argument: $1. Please use --help for help." 332 ;; 333 esac 334 shift 335 done 336 if [[ "$hypervisor" != "kvm" ]]; then 337 die "Hypervisor value must be kvm" 338 fi 339 if [[ "$hypervisor" = "mshv" ]]; then 340 exported_device="/dev/mshv" 341 fi 342 set -- "$@" '--hypervisor' $hypervisor 343 344 ensure_build_dir 345 ensure_latest_ctr 346 347 process_volumes_args 348 target="$(uname -m)-unknown-linux-${libc}" 349 cflags="" 350 target_cc="" 351 if [[ "$target" == "x86_64-unknown-linux-musl" ]]; then 352 target_cc="musl-gcc" 353 cflags="-I /usr/include/x86_64-linux-musl/ -idirafter /usr/include/" 354 fi 355 356 if [[ "$unit" = true ]] ; then 357 say "Running unit tests for $target..." 358 $DOCKER_RUNTIME run \ 359 --workdir "$CTR_CLH_ROOT_DIR" \ 360 --rm \ 361 --device $exported_device \ 362 --device /dev/net/tun \ 363 --cap-add net_admin \ 364 --volume "$CLH_ROOT_DIR:$CTR_CLH_ROOT_DIR" $exported_volumes \ 365 --env BUILD_TARGET="$target" \ 366 --env CFLAGS="$cflags" \ 367 --env TARGET_CC="$target_cc" \ 368 "$CTR_IMAGE" \ 369 ./scripts/run_unit_tests.sh "$@" || fix_dir_perms $? || exit $? 370 fi 371 372 if [ "$cargo" = true ] ; then 373 say "Running cargo tests..." 374 $DOCKER_RUNTIME run \ 375 --workdir "$CTR_CLH_ROOT_DIR" \ 376 --rm \ 377 --volume "$CLH_ROOT_DIR:$CTR_CLH_ROOT_DIR" $exported_volumes \ 378 "$CTR_IMAGE" \ 379 ./scripts/run_cargo_tests.sh "$@" || fix_dir_perms $? || exit $? 380 fi 381 382 if [ "$integration" = true ] ; then 383 say "Running integration tests for $target..." 384 $DOCKER_RUNTIME run \ 385 --workdir "$CTR_CLH_ROOT_DIR" \ 386 --rm \ 387 --privileged \ 388 --security-opt seccomp=unconfined \ 389 --ipc=host \ 390 --net="$CTR_CLH_NET" \ 391 --mount type=tmpfs,destination=/tmp \ 392 --volume /dev:/dev \ 393 --volume "$CLH_ROOT_DIR:$CTR_CLH_ROOT_DIR" $exported_volumes \ 394 --volume "$CLH_INTEGRATION_WORKLOADS:$CTR_CLH_INTEGRATION_WORKLOADS" \ 395 --env USER="root" \ 396 --env CH_LIBC="${libc}" \ 397 "$CTR_IMAGE" \ 398 ./scripts/run_integration_tests_$(uname -m).sh "$@" || fix_dir_perms $? || exit $? 399 fi 400 401 if [ "$integration_sgx" = true ] ; then 402 say "Running SGX integration tests for $target..." 403 $DOCKER_RUNTIME run \ 404 --workdir "$CTR_CLH_ROOT_DIR" \ 405 --rm \ 406 --privileged \ 407 --security-opt seccomp=unconfined \ 408 --ipc=host \ 409 --net="$CTR_CLH_NET" \ 410 --mount type=tmpfs,destination=/tmp \ 411 --volume /dev:/dev \ 412 --volume "$CLH_ROOT_DIR:$CTR_CLH_ROOT_DIR" $exported_volumes \ 413 --volume "$CLH_INTEGRATION_WORKLOADS:$CTR_CLH_INTEGRATION_WORKLOADS" \ 414 --env USER="root" \ 415 --env CH_LIBC="${libc}" \ 416 "$CTR_IMAGE" \ 417 ./scripts/run_integration_tests_sgx.sh "$@" || fix_dir_perms $? || exit $? 418 fi 419 420 if [ "$integration_vfio" = true ] ; then 421 say "Running VFIO integration tests for $target..." 422 $DOCKER_RUNTIME run \ 423 --workdir "$CTR_CLH_ROOT_DIR" \ 424 --rm \ 425 --privileged \ 426 --security-opt seccomp=unconfined \ 427 --ipc=host \ 428 --net="$CTR_CLH_NET" \ 429 --mount type=tmpfs,destination=/tmp \ 430 --volume /dev:/dev \ 431 --volume "$CLH_ROOT_DIR:$CTR_CLH_ROOT_DIR" $exported_volumes \ 432 --volume "$CLH_INTEGRATION_WORKLOADS:$CTR_CLH_INTEGRATION_WORKLOADS" \ 433 --env USER="root" \ 434 --env CH_LIBC="${libc}" \ 435 "$CTR_IMAGE" \ 436 ./scripts/run_integration_tests_vfio.sh "$@" || fix_dir_perms $? || exit $? 437 fi 438 439 if [ "$integration_windows" = true ] ; then 440 say "Running Windows integration tests for $target..." 441 $DOCKER_RUNTIME run \ 442 --workdir "$CTR_CLH_ROOT_DIR" \ 443 --rm \ 444 --privileged \ 445 --security-opt seccomp=unconfined \ 446 --ipc=host \ 447 --net="$CTR_CLH_NET" \ 448 --mount type=tmpfs,destination=/tmp \ 449 --volume /dev:/dev \ 450 --volume "$CLH_ROOT_DIR:$CTR_CLH_ROOT_DIR" $exported_volumes \ 451 --volume "$CLH_INTEGRATION_WORKLOADS:$CTR_CLH_INTEGRATION_WORKLOADS" \ 452 --env USER="root" \ 453 --env CH_LIBC="${libc}" \ 454 "$CTR_IMAGE" \ 455 ./scripts/run_integration_tests_windows.sh "$@" || fix_dir_perms $? || exit $? 456 fi 457 fix_dir_perms $? 458} 459 460cmd_build-container() { 461 container_type="dev" 462 463 while [ $# -gt 0 ]; do 464 case "$1" in 465 "-h"|"--help") { cmd_help; exit 1; } ;; 466 "--dev") { container_type="dev"; } ;; 467 "--") { shift; break; } ;; 468 *) 469 die "Unknown build-container argument: $1. Please use --help for help." 470 ;; 471 esac 472 shift 473 done 474 475 ensure_build_dir 476 ensure_latest_ctr 477 478 BUILD_DIR=/tmp/cloud-hypervisor/container/ 479 480 mkdir -p $BUILD_DIR 481 cp $CLH_DOCKERFILE $BUILD_DIR 482 483 [ $(uname -m) = "aarch64" ] && TARGETARCH="arm64" 484 [ $(uname -m) = "x86_64" ] && TARGETARCH="amd64" 485 486 $DOCKER_RUNTIME build \ 487 --target $container_type \ 488 -t $CTR_IMAGE \ 489 -f $BUILD_DIR/Dockerfile \ 490 --build-arg TARGETARCH=$TARGETARCH \ 491 $BUILD_DIR 492} 493 494cmd_shell() { 495 while [ $# -gt 0 ]; do 496 case "$1" in 497 "-h"|"--help") { cmd_help; exit 1; } ;; 498 "--volumes") 499 shift 500 arg_vols="$1" 501 ;; 502 "--") { shift; break; } ;; 503 *) 504 ;; 505 esac 506 shift 507 done 508 ensure_build_dir 509 ensure_latest_ctr 510 process_volumes_args 511 say_warn "Starting a privileged shell prompt as root ..." 512 say_warn "WARNING: Your $CLH_ROOT_DIR folder will be bind-mounted in the container under $CTR_CLH_ROOT_DIR" 513 $DOCKER_RUNTIME run \ 514 -ti \ 515 --workdir "$CTR_CLH_ROOT_DIR" \ 516 --rm \ 517 --privileged \ 518 --security-opt seccomp=unconfined \ 519 --ipc=host \ 520 --net="$CTR_CLH_NET" \ 521 --tmpfs /tmp:exec \ 522 --volume /dev:/dev \ 523 --volume "$CLH_ROOT_DIR:$CTR_CLH_ROOT_DIR" $exported_volumes \ 524 --volume "$CLH_INTEGRATION_WORKLOADS:$CTR_CLH_INTEGRATION_WORKLOADS" \ 525 --env USER="root" \ 526 --entrypoint bash \ 527 "$CTR_IMAGE" 528 529 fix_dir_perms $? 530} 531 532# Parse main command line args. 533# 534while [ $# -gt 0 ]; do 535 case "$1" in 536 -h|--help) { cmd_help; exit 1; } ;; 537 -y|--unattended) { OPT_UNATTENDED=true; } ;; 538 -*) 539 die "Unknown arg: $1. Please use \`$0 help\` for help." 540 ;; 541 *) 542 break 543 ;; 544 esac 545 shift 546done 547 548# $1 is now a command name. Check if it is a valid command and, if so, 549# run it. 550# 551declare -f "cmd_$1" > /dev/null 552ok_or_die "Unknown command: $1. Please use \`$0 help\` for help." 553 554cmd=cmd_$1 555shift 556 557 558$cmd "$@" 559