#!/usr/bin/env bash # SPDX-License-Identifier: GPL-2.0 # A handy tool to launch CVD with local build or remote build. # Constants ACLOUD_PREBUILT="prebuilts/asuite/acloud/linux-x86/acloud" OPT_SKIP_PRERUNCHECK='--skip-pre-run-check' PRODUCT='aosp_cf_x86_64_phone' # Color constants #BOLD="$(tput bold)" # Unused END="$(tput sgr0)" GREEN="$(tput setaf 2)" RED="$(tput setaf 198)" YELLOW="$(tput setaf 3)" # BLUE="$(tput setaf 34)" # Unused SKIP_BUILD=false GCOV=false DEBUG=false KASAN=false EXTRA_OPTIONS=() function print_help() { echo "Usage: $0 [OPTIONS]" echo "" echo "This script will build images and launch a Cuttlefish device." echo "" echo "Available options:" echo " --skip-build Skip the image build step. Will build by default if in repo." echo " --gcov Launch CVD with gcov enabled kernel" echo " --debug Launch CVD with debug enabled kernel" echo " --kasan Launch CVD with kasan enabled kernel" echo " -pb , --platform-build=" echo " The platform build path. Can be a local path or a remote build" echo " as ab:////." echo " If not specified, it will use the platform build in the local" echo " repo, or the default compatible platform build for the kernel." echo " -sb , --system-build=" echo " The system build path for GSI testing. Can be a local path or" echo " remote build as ab:////." echo " If not specified, no system build will be used." echo " -kb , --kernel-build=" echo " The kernel build path. Can be a local path or a remote build" echo " as ab:////." echo " If not specified, it will use the kernel in the local repo." echo " --acloud-bin=" echo " The alternative alcoud binary path." echo " --cf-product=" echo " The alternative cuttlefish product type for local build." echo " Will use default aosp_cf_x86_64_phone if not specified." echo " --acloud-arg=" echo " Additional acloud command arg. Can be repeated." echo " For example --acloud-arg=--local-instance to launch a local cvd." echo " -h, --help Display this help message and exit" echo "" echo "Examples:" echo "$0" echo "$0 --acloud-arg=--local-instance" echo "$0 -pb ab://git_main/aosp_cf_x86_64_phone-userdebug/latest" echo "$0 -pb ~/aosp-main/out/target/product/vsoc_x86_64/" echo "$0 -kb ~/android-mainline/out/virtual_device_x86_64/" echo "" exit 0 } function parse_arg() { while test $# -gt 0; do case "$1" in -h|--help) print_help ;; --skip-build) SKIP_BUILD=true shift ;; -pb) shift if test $# -gt 0; then PLATFORM_BUILD=$1 else print_error "platform build is not specified" fi shift ;; --platform-build=*) PLATFORM_BUILD=$(echo "$1" | sed -e "s/^[^=]*=//g") shift ;; -sb) shift if test $# -gt 0; then SYSTEM_BUILD=$1 else print_error "system build is not specified" fi shift ;; --system-build=*) SYSTEM_BUILD=$(echo "$1" | sed -e "s/^[^=]*=//g") shift ;; -kb) shift if test $# -gt 0; then KERNEL_BUILD=$1 else print_error "kernel build path is not specified" fi shift ;; --kernel-build=*) KERNEL_BUILD=$(echo "$1" | sed -e "s/^[^=]*=//g") shift ;; --acloud-arg=*) EXTRA_OPTIONS+=("$(echo "$1" | sed -e "s/^[^=]*=//g")") # Use array append syntax shift ;; --acloud-bin=*) ACLOUD_BIN=$(echo "$1" | sed -e "s/^[^=]*=//g") shift ;; --cf-product=*) PRODUCT=$(echo "$1" | sed -e "s/^[^=]*=//g") shift ;; --gcov) GCOV=true shift ;; --debug) DEBUG=true shift ;; --kasan) KASAN=true shift ;; *) print_error "Unsupported flag: $1" >&2 ;; esac done } function adb_checker() { if ! which adb &> /dev/null; then print_error "adb not found!" fi } function go_to_repo_root() { current_dir="$1" while [ ! -d ".repo" ] && [ "$current_dir" != "/" ]; do current_dir=$(dirname "$current_dir") # Go up one directory cd "$current_dir" || print_error "Failed to cd to $current_dir" done } function print_info() { echo "[$MY_NAME]: ${GREEN}$1${END}" } function print_warn() { echo "[$MY_NAME]: ${YELLOW}$1${END}" } function print_error() { echo -e "[$MY_NAME]: ${RED}$1${END}" cd "$OLD_PWD" || echo "Failed to cd to $OLD_PWD" exit 1 } function set_platform_repo () { print_warn "Build target product '${TARGET_PRODUCT}' does not match expected '$1'" local lunch_cli="source build/envsetup.sh && lunch $1" if [ -f "build/release/release_configs/trunk_staging.textproto" ]; then lunch_cli+="-trunk_staging-userdebug" else lunch_cli+="-userdebug" fi print_info "Setup build environment with: $lunch_cli" eval "$lunch_cli" } function find_repo () { manifest_output=$(grep -e "superproject" -e "gs-pixel" -e "private/google-modules/soc/gs" \ -e "kernel/common" -e "common-modules/virtual-device" .repo/manifests/default.xml) case "$manifest_output" in *platform/superproject*) PLATFORM_REPO_ROOT="$PWD" PLATFORM_VERSION=$(grep -e "platform/superproject" .repo/manifests/default.xml | \ grep -oP 'revision="\K[^"]*') print_info "PLATFORM_REPO_ROOT=$PLATFORM_REPO_ROOT, PLATFORM_VERSION=$PLATFORM_VERSION" if [ -z "$PLATFORM_BUILD" ]; then PLATFORM_BUILD="$PLATFORM_REPO_ROOT" fi ;; *kernel/superproject*) if [[ "$manifest_output" == *common-modules/virtual-device* ]]; then CF_KERNEL_REPO_ROOT="$PWD" CF_KERNEL_VERSION=$(grep -e "common-modules/virtual-device" \ .repo/manifests/default.xml | grep -oP 'revision="\K[^"]*') print_info "CF_KERNEL_REPO_ROOT=$CF_KERNEL_REPO_ROOT, \ CF_KERNEL_VERSION=$CF_KERNEL_VERSION" if [ -z "$KERNEL_BUILD" ]; then KERNEL_BUILD="$CF_KERNEL_REPO_ROOT/out/virtual_device_x86_64/dist" fi fi ;; *) print_warn "Unexpected manifest output. Could not determine repository type." ;; esac } function rebuild_platform () { build_cmd="m -j12" print_warn "Flag --skip-build is not set. Rebuilt images at $PWD with: $build_cmd" eval "$build_cmd" exit_code=$? if [ $exit_code -eq 0 ]; then if [ -f "${ANDROID_PRODUCT_OUT}/system.img" ]; then print_info "$build_cmd succeeded" else print_error "${ANDROID_PRODUCT_OUT}/system.img doesn't exist" fi else print_warn "$build_cmd returned exit_code $exit_code or ${ANDROID_PRODUCT_OUT}/system.img is not found" print_error "$build_cmd failed" fi } adb_checker # LOCAL_REPO= $ Unused OLD_PWD=$PWD MY_NAME=$0 parse_arg "$@" FULL_COMMAND_PATH=$(dirname "$PWD/$0") REPO_LIST_OUT=$(repo list 2>&1) if [[ "$REPO_LIST_OUT" == "error"* ]]; then echo -e "[$MY_NAME]: ${RED}Current path $PWD is not in an Android repo. Change path to repo root.${END}" go_to_repo_root "$FULL_COMMAND_PATH" print_info "Changed path to $PWD" else go_to_repo_root "$PWD" fi # REPO_ROOT_PATH="$PWD" # unused find_repo if [ "$SKIP_BUILD" = false ] && [ -n "$PLATFORM_BUILD" ] && [[ "$PLATFORM_BUILD" != ab://* ]] \ && [ -d "$PLATFORM_BUILD" ]; then # Check if PLATFORM_BUILD is an Android platform repo, if yes rebuild cd "$PLATFORM_BUILD" || print_error "Failed to cd to $PLATFORM_BUILD" PLATFORM_REPO_LIST_OUT=$(repo list 2>&1) if [[ "$PLATFORM_REPO_LIST_OUT" != "error"* ]]; then go_to_repo_root "$PWD" if [ -z "${TARGET_PRODUCT}" ] || [[ "${TARGET_PRODUCT}" != "$PRODUCT" ]]; then set_platform_repo "$PRODUCT" rebuild_platform PLATFORM_BUILD=${ANDROID_PRODUCT_OUT} fi fi fi if [ "$SKIP_BUILD" = false ] && [ -n "$SYSTEM_BUILD" ] && [[ "$SYSTEM_BUILD" != ab://* ]] \ && [ -d "$SYSTEM_BUILD" ]; then # Get GSI build cd "$SYSTEM_BUILD" || print_error "Failed to cd to $SYSTEM_BUILD" SYSTEM_REPO_LIST_OUT=$(repo list 2>&1) if [[ "$SYSTEM_REPO_LIST_OUT" != "error"* ]]; then go_to_repo_root "$PWD" if [ -z "${TARGET_PRODUCT}" ] || [[ "${TARGET_PRODUCT}" != "aosp_x86_64" ]]; then set_platform_repo "aosp_x86_64" rebuild_platform SYSTEM_BUILD="${ANDROID_PRODUCT_OUT}/system.img" fi fi fi if [ "$SKIP_BUILD" = false ] && [ -n "$KERNEL_BUILD" ] && [[ "$KERNEL_BUILD" != ab://* ]] \ && [ -d "$KERNEL_BUILD" ]; then # Check if kernel repo is provided, if yes rebuild cd "$KERNEL_BUILD" || print_error "Failed to cd to $KERNEL_BUILD" KERNEL_REPO_LIST_OUT=$(repo list 2>&1) if [[ "$KERNEL_REPO_LIST_OUT" != "error"* ]]; then go_to_repo_root "$PWD" if [ ! -f "common-modules/virtual-device/BUILD.bazel" ]; then # TODO(b/365590299): Add build support to android12 and earlier kernels print_error "bazel build common-modules/virtual-device is not supported in this kernel tree" fi # KERNEL_VERSION=$(grep -e "common-modules/virtual-device" .repo/manifests/default.xml | grep -oP 'revision="\K[^"]*') # unused # Build a new kernel build_cmd="tools/bazel run --config=fast" if [ "$GCOV" = true ]; then build_cmd+=" --gcov" fi if [ "$DEBUG" = true ]; then build_cmd+=" --debug" fi if [ "$KASAN" = true ]; then build_cmd+=" --kasan" fi build_cmd+=" //common-modules/virtual-device:virtual_device_x86_64_dist" print_warn "Flag --skip-build is not set. Rebuild the kernel with: $build_cmd." eval "$build_cmd" exit_code=$? if [ $exit_code -eq 0 ]; then print_info "$build_cmd succeeded" else print_error "$build_cmd failed" fi KERNEL_BUILD="$PWD/out/virtual_device_x86_64/dist" fi fi if [ -z "$ACLOUD_BIN" ] || ! [ -x "$ACLOUD_BIN" ]; then output=$(which acloud 2>&1) if [ -z "$output" ]; then print_info "Use acloud binary from $ACLOUD_PREBUILT" ACLOUD_BIN="$ACLOUD_PREBUILT" else print_info "Use acloud binary from $output" ACLOUD_BIN="$output" fi # Check if the newly found or prebuilt ACLOUD_BIN is executable if ! [ -x "$ACLOUD_BIN" ]; then print_error "$ACLOUD_BIN is not executable" fi fi acloud_cli="$ACLOUD_BIN create" EXTRA_OPTIONS+=("$OPT_SKIP_PRERUNCHECK") # Add in branch if not specified if [ -z "$PLATFORM_BUILD" ]; then print_warn "Platform build is not specified, will use the latest aosp-main build." acloud_cli+=' --branch aosp-main' elif [[ "$PLATFORM_BUILD" == ab://* ]]; then IFS='/' read -ra array <<< "$PLATFORM_BUILD" acloud_cli+=" --branch ${array[2]}" # Check if array[3] exists before using it if [ ${#array[@]} -ge 3 ] && [ -n "${array[3]}" ]; then acloud_cli+=" --build-target ${array[3]}" # Check if array[4] exists and is not 'latest' before using it if [ ${#array[@]} -ge 4 ] && [ -n "${array[4]}" ] && [ "${array[4]}" != 'latest' ]; then acloud_cli+=" --build-id ${array[4]}" fi fi else acloud_cli+=" --local-image $PLATFORM_BUILD" fi if [ -z "$KERNEL_BUILD" ]; then print_warn "Flag --kernel-build is not set, will not launch Cuttlefish with different kernel." elif [[ "$KERNEL_BUILD" == ab://* ]]; then IFS='/' read -ra array <<< "$KERNEL_BUILD" acloud_cli+=" --kernel-branch ${array[2]}" # Check if array[3] exists before using it if [ ${#array[@]} -ge 3 ] && [ -n "${array[3]}" ]; then acloud_cli+=" --kernel-build-target ${array[3]}" # Check if array[4] exists and is not 'latest' before using it if [ ${#array[@]} -ge 4 ] && [ -n "${array[4]}" ] && [ "${array[4]}" != 'latest' ]; then acloud_cli+=" --kernel-build-id ${array[4]}" fi fi else acloud_cli+=" --local-kernel-image $KERNEL_BUILD" fi if [ -z "$SYSTEM_BUILD" ]; then print_warn "System build is not specified, will not launch Cuttlefish with GSI mixed build." elif [[ "$SYSTEM_BUILD" == ab://* ]]; then IFS='/' read -ra array <<< "$SYSTEM_BUILD" acloud_cli+=" --system-branch ${array[2]}" # Check if array[3] exists before using it if [ ${#array[@]} -ge 3 ] && [ -n "${array[3]}" ]; then acloud_cli+=" --system-build-target ${array[3]}" # Check if array[4] exists and is not 'latest' before using it if [ ${#array[@]} -ge 4 ] && [ -n "${array[4]}" ] && [ "${array[4]}" != 'latest' ]; then acloud_cli+=" --system-build-id ${array[4]}" fi fi else acloud_cli+=" --local-system-image $SYSTEM_BUILD" fi acloud_cli+=" ${EXTRA_OPTIONS[*]}" print_info "Launch CVD with command: $acloud_cli" eval "$acloud_cli"