#! /bin/sh # Copyright (C) 2011 The Android Open Source Project # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # This script is used on host and device. It uses a common subset # shell dialect that should work on the host (e.g. bash), and # Android (e.g. mksh). Try to switch to bash if the shebang above # has launched a pessimal shell on host. if [ -z "$KSH_VERSION" -a -z "$BASH_VERSION" -a -n "$(which bash)" ]; then exec bash -c ". $0" -- "$@" fi ###################################### # Functions ###################################### function find_libdir() { # Get the actual file, $1 is the ART_BINARY_PATH and may be a symbolic link. # Use realpath instead of readlink because Android does not have a readlink. if [[ "$(realpath "$1")" == *dalvikvm64 ]]; then echo "lib64" else echo "lib" fi } function usage() { cat 1>&2 < Launch the Android Runtime in gdbserver using the supplied communication channel. --help Display usage message. --invoke-with Launch the Android Runtime in . --perf Launch the Android Runtime with perf recording. --perf-report Launch the Android Runtime with perf recording with report upon completion. --profile Run with profiling, then run using profile data. --verbose Run script verbosely. --no-clean Don't cleanup oat directories. --no-compile Don't invoke dex2oat before running. --allow-default-jdwp Don't automatically put in -XjdwpProvider:none. You probably do not want this. The ART_OPTIONS are passed directly to the Android Runtime. Example: art --32 -cp my_classes.dex MainClass Common errors: 1) Not having core.art available (see $ANDROID_BUILD_TOP/art/Android.mk). eg m -j32 build-art-host 2) Not having boot.art available (see $ANDROID_BUILD_TOP/build/make/core/dex_preopt_libart_boot.mk) eg m -j32 out/target/product/generic_x86_64/dex_bootjars/system/framework/x86_64/boot.art EOF } function clean_android_data() { if [ "$DELETE_ANDROID_DATA" = "yes" ]; then rm -rf $ANDROID_DATA fi } # Given 'VAR1=VAL VAR2=VAL2 ... cmd arg1 arg2 ... argN' run the 'cmd' with the args # with the modified environment {VAR1=VAL,VAL2=,...}. # # Also prints the command to be run if verbose mode is enabled. function verbose_run() { if [ "$VERBOSE" = "yes" ]; then echo "$@" fi env "$@" } # Parse a colon-separated list into an array (e.g. "foo.dex:bar.dex" -> (foo.dex bar.dex)) PARSE_CLASSPATH_RESULT=() # Return value will be here due to shell limitations. parse_classpath() { local cp="$1" local oldifs=$IFS local cp_array cp_array=() IFS=":" for part in $cp; do cp_array+=("$part") done IFS=$oldifs PARSE_CLASSPATH_RESULT=("${cp_array[@]}") } # Sets 'PARSE_CLASSPATH_RESULT' to an array of class path dex files. # e.g. (-cp foo/classes.dex:bar/classes.dex) -> (foo/classes.dex bar/classes.dex) find_cp_in_args() { local found="false" local index=0 local what while [[ $# -gt 0 ]]; do case "$1" in -cp|-classpath) parse_classpath "$2" # Sets 'PARSE_CLASSPATH_RESULT' to an array of class path dex files. # Subsequent parses will overwrite the preceding. shift ;; esac shift done } # Delete the 'oat' directories relative to the classpath's dex files. # e.g. (foo/classes.dex bar/classes.dex) would delete (foo/oat bar/oat) directories. cleanup_oat_directory() { local classpath classpath=("$@") local dirpath for path in "${classpath[@]}"; do dirpath="$(dirname "$path")" [[ -d "$dirpath" ]] && verbose_run rm -rf "$dirpath/oat" done } # Parse -cp , -classpath , and $CLASSPATH to find the dex files. # Each dex file's directory will have an 'oat' file directory, delete it. # Input: Command line arguments to the art script. # e.g. -cp foo/classes.dex:bar/classes.dex would delete (foo/oat bar/oat) directories. cleanup_oat_directory_for_classpath() { if [ "$CLEAN_OAT_FILES" = "yes" ]; then # First try: Use $CLASSPATH environment variable. parse_classpath "$CLASSPATH" # Second try: Look for latest -cp or -classpath arg which will take precedence. find_cp_in_args "$@" cleanup_oat_directory "${PARSE_CLASSPATH_RESULT[@]}" fi } # Attempt to find $ANDROID_ROOT/framework//core.art' without knowing what is. function check_if_boot_image_file_exists() { local image_location_dir="$1" local image_location_name="$2" # Expand image_files to a list of existing image files on the disk. # If no such files exist, it expands to single element 'dir/*/file' with a literal '*'. local image_files image_files=("$image_location_dir"/*/"$image_location_name") # avoid treating "*" as literal. # Array always has at least 1 element. Test explicitly whether the file exists. [[ -e "${image_files[0]}" ]] } # Automatically find the boot image location. It uses core.art by default. # On a real device, it might only have a boot.art, so use that instead when core.art does not exist. function detect_boot_image_location() { local image_location_dir="$ANDROID_ROOT/framework" local image_location_name="core.art" # If there are no existing core.art, try to find boot.art. # If there is no boot.art then leave it as-is, assumes -Ximage is explicitly used. # Otherwise let dalvikvm give the error message about an invalid image file. if ! check_if_boot_image_file_exists "$image_location_dir" "core.art" && \ check_if_boot_image_file_exists "$image_location_dir" "boot.art"; then image_location_name="boot.art" fi local image_location="$image_location_dir/$image_location_name" echo "$image_location" } function run_dex2oat() { local class_loader_context= for dex_file in "${DEX2OAT_CLASSPATH[@]}" do while [ -h "$dex_file" ]; do # On Mac OS, readlink -f doesn't work. dex_file="$(readlink "$dex_file")" done # Create oat file directory. verbose_run mkdir -p $(dirname "$dex_file")/oat/$ISA local oat_file=$(basename "$dex_file") local oat_file=$(dirname "$dex_file")/oat/$ISA/${oat_file%.*}.odex if [ "$GENERATE_APP_IMAGE" = "yes" ]; then local art_file=$(basename "$dex_file") local art_file=$(dirname "$dex_file")/oat/$ISA/${art_file%.*}.art DEX2OAT_FLAGS+=("--app-image-file=$art_file") fi # When running dex2oat use the exact same context as when running dalvikvm. # (see run_art function) verbose_run ANDROID_DATA=$ANDROID_DATA \ ANDROID_ROOT=$ANDROID_ROOT \ ANDROID_I18N_ROOT=$ANDROID_I18N_ROOT \ ANDROID_ART_ROOT=$ANDROID_ART_ROOT \ ANDROID_TZDATA_ROOT=$ANDROID_TZDATA_ROOT \ LD_LIBRARY_PATH=$LD_LIBRARY_PATH \ PATH=$ANDROID_ROOT/bin:$PATH \ LD_USE_LOAD_BIAS=1 \ ANDROID_LOG_TAGS=$ANDROID_LOG_TAGS \ $DEX2OAT_BINARY_PATH \ --runtime-arg -Xnorelocate \ --boot-image=$DEX2OAT_BOOT_IMAGE \ --instruction-set=$ISA \ --class-loader-context="PCL[$class_loader_context]" \ "${DEX2OAT_FLAGS[@]}" \ --dex-file=$dex_file \ --oat-file=$oat_file if [[ -n $class_loader_context ]]; then class_loader_context+=":" fi class_loader_context+="$dex_file" done } # Extract the dex2oat flags from the list of arguments. # -Xcompiler-options arguments are stored in DEX2OAT_FLAGS array # -cp argument is split by ':' and stored in DEX2OAT_CLASSPATH # -Ximage argument is stored in DEX2OAT_BOOT_IMAGE # -Xbootclasspath argument is stored in DEX2OAT_BCP # -Xbootclasspath-locations argument is stored in DEX2OAT_BCP_LOCS function extract_dex2oat_flags() { while [ $# -gt 0 ]; do case $1 in -Xcompiler-option) DEX2OAT_FLAGS+=("$2") # Enable app images for profile filters case $2 in --compiler-filter=speed-profile) GENERATE_APP_IMAGE="yes" ;; --compiler-filter=everything-profile) GENERATE_APP_IMAGE="yes" ;; esac shift ;; -Ximage:*) DEX2OAT_BOOT_IMAGE=$1 # Remove '-Ximage:' from the argument. DEX2OAT_BOOT_IMAGE=${DEX2OAT_BOOT_IMAGE##-Ximage:} ;; -Xbootclasspath:*) DEX2OAT_BCP=$1 # Remove '-Xbootclasspath:' from the argument. DEX2OAT_BCP=${DEX2OAT_BCP##-Xbootclasspath:} ;; -Xbootclasspath-locations:*) DEX2OAT_BCP_LOCS=$1 # Remove '-Xbootclasspath-locations:' from the argument. DEX2OAT_BCP_LOCS=${DEX2OAT_BCP_LOCS##-Xbootclasspath-locations:} ;; -cp) # Reset any previously parsed classpath, just like dalvikvm # only supports one -cp argument. DEX2OAT_CLASSPATH=() # TODO: support -classpath and CLASSPATH local oifs=$IFS IFS=':' for classpath_elem in $2 do DEX2OAT_CLASSPATH+=("$classpath_elem") done shift IFS=$oifs ;; esac shift done } # Runs dalvikvm, returns its exit code. # (Oat directories are cleaned up in between runs) function run_art() { local ret # Run dalvikvm. verbose_run ANDROID_DATA="$ANDROID_DATA" \ ANDROID_ROOT="$ANDROID_ROOT" \ ANDROID_I18N_ROOT="$ANDROID_I18N_ROOT" \ ANDROID_ART_ROOT="$ANDROID_ART_ROOT" \ ANDROID_TZDATA_ROOT="$ANDROID_TZDATA_ROOT" \ LD_LIBRARY_PATH="$LD_LIBRARY_PATH" \ PATH="$ANDROID_ROOT/bin:$PATH" \ LD_USE_LOAD_BIAS=1 \ ANDROID_LOG_TAGS="$ANDROID_LOG_TAGS" \ $LAUNCH_WRAPPER $ART_BINARY_PATH $lib \ -XXlib:"$LIBART" \ -Xnorelocate \ -Ximage:"$DEFAULT_IMAGE_LOCATION" \ "$@" ret=$? # Avoid polluting disk with 'oat' files after dalvikvm has finished. cleanup_oat_directory_for_classpath "$@" # Forward exit code of dalvikvm. return $ret } ###################################### # Globals ###################################### ART_BINARY=dalvikvm DEX2OAT_BINARY=dex2oat DEX2OAT_SUFFIX="" DELETE_ANDROID_DATA="no" LAUNCH_WRAPPER= LIBART=libart.so JIT_PROFILE="no" ALLOW_DEFAULT_JDWP="no" VERBOSE="no" CLEAN_OAT_FILES="yes" RUN_DEX2OAT="yes" EXTRA_OPTIONS=() DEX2OAT_FLAGS=() DEX2OAT_CLASSPATH=() GENERATE_APP_IMAGE="no" # Parse arguments while [[ "$1" = "-"* ]]; do case "$1" in --) # No more arguments for this script. shift break ;; --32) ART_BINARY=dalvikvm32 DEX2OAT_SUFFIX=32 ;; --64) ART_BINARY=dalvikvm64 DEX2OAT_SUFFIX=64 ;; -d) ;& # Fallthrough --debug) LIBART="libartd.so" DEX2OAT_BINARY="dex2oatd" # Expect that debug mode wants all checks. EXTRA_OPTIONS+=(-XX:SlowDebug=true) ;; --gdbserver) LAUNCH_WRAPPER="gdbserver $2" shift ;; --gdb) LIBART="libartd.so" LAUNCH_WRAPPER="gdb --args" ;; --help) usage exit 0 ;; --invoke-with) LAUNCH_WRAPPER=$2 shift ;; --perf) PERF="record" ;; --perf-report) PERF="report" ;; --profile) JIT_PROFILE="yes" ;; --verbose) VERBOSE="yes" ;; --no-clean) CLEAN_OAT_FILES="no" ;; --no-compile) CLEAN_OAT_FILES="no" RUN_DEX2OAT="no" ;; --allow-default-jdwp) ALLOW_DEFAULT_JDWP="yes" ;; --*) echo "unknown option: $1" 1>&2 usage exit 1 ;; *) break ;; esac shift done if [ $# -eq 0 ]; then usage exit 1 fi # Follow all sym links to get the program name. if [[ -n "$BASH_SOURCE" ]]; then PROG_NAME="$BASH_SOURCE" else PROG_NAME="$0" fi while [ -h "$PROG_NAME" ]; do # On Mac OS, readlink -f doesn't work. PROG_NAME="$(readlink "$PROG_NAME")" done PROG_DIR="$(cd "${PROG_NAME%/*}" ; pwd -P)" ANDROID_ROOT="$(cd $PROG_DIR/..; pwd -P)" # If ANDROID_I18N_ROOT is not set, try to detect whether we are running on # target or host and set that environment variable to the usual default value. if [ -z "$ANDROID_I18N_ROOT" ]; then # This script is used on host and target (device). However, the (expected) # default value `ANDROID_I18N_ROOT` is not the same on host and target: # - on host, `ANDROID_I18N_ROOT` is expected to be # "$ANDROID_ROOT/com.android.i18n"; # - on target, `ANDROID_I18N_ROOT` is expected to be # "/apex/com.android.i18n". # # We use the presence/absence of the `$ANDROID_ROOT/../apex` directory to # determine whether we are on target or host (this is brittle, but simple). if [ -d "$ANDROID_ROOT/../apex" ]; then # Target case. ANDROID_I18N_ROOT="/apex/com.android.i18n" else # Host case. ANDROID_I18N_ROOT="$ANDROID_ROOT/com.android.i18n" fi fi # If ANDROID_ART_ROOT is not set, try to detect whether we are running on # target or host and set that environment variable to the usual default value. if [ -z "$ANDROID_ART_ROOT" ]; then # This script is used on host and target (device). However, the (expected) # default value `ANDROID_ART_ROOT` is not the same on host and target: # - on host, `ANDROID_ART_ROOT` is expected to be # "$ANDROID_ROOT/com.android.art"; # - on target, `ANDROID_ART_ROOT` is expected to be # "/apex/com.android.art". # # We use the presence/absence of the `$ANDROID_ROOT/../apex` directory to # determine whether we are on target or host (this is brittle, but simple). if [ -d "$ANDROID_ROOT/../apex" ]; then # Target case. ANDROID_ART_ROOT="/apex/com.android.art" else # Host case. ANDROID_ART_ROOT="$ANDROID_ROOT/com.android.art" fi fi # If ANDROID_TZDATA_ROOT is not set, try to detect whether we are running on # target or host and set that environment variable to the usual default value. if [ -z "$ANDROID_TZDATA_ROOT" ]; then # This script is used on host and target (device). However, the (expected) # default value `ANDROID_TZDATA_ROOT` is not the same on host and target: # - on host, `ANDROID_TZDATA_ROOT` is expected to be # "$ANDROID_ROOT/com.android.tzdata"; # - on target, `ANDROID_TZDATA_ROOT` is expected to be # "/apex/com.android.tzdata". # # We use the presence/absence of the `$ANDROID_ROOT/../apex` directory to # determine whether we are on target or host (this is brittle, but simple). if [ -d "$ANDROID_ROOT/../apex" ]; then # Target case. ANDROID_TZDATA_ROOT="/apex/com.android.tzdata" else # Host case. ANDROID_TZDATA_ROOT="$ANDROID_ROOT/com.android.tzdata" fi fi ART_BINARY_PATH=$ANDROID_ROOT/bin/$ART_BINARY if [ ! -x "$ART_BINARY_PATH" ]; then cat 1>&2 < "$ANDROID_DATA/profile_gen.log" EXIT_STATUS=$? if [ $EXIT_STATUS != 0 ]; then echo "Profile run failed: " >&2 cat "$ANDROID_DATA/profile_gen.log" >&2 clean_android_data exit $EXIT_STATUS fi # Wipe dalvik-cache so that a subsequent run_art must regenerate it. # Leave $ANDROID_DATA intact since it contains our profile file. rm -rf "$ANDROID_DATA/dalvik-cache" # Append arguments so next invocation of run_art uses the profile. DEX2OAT_FLAGS+=(--profile-file="$PROFILE_PATH") fi if [ -x "$DEX2OAT_BINARY_PATH" ]; then if [ "$RUN_DEX2OAT" = "yes" ]; then # Run dex2oat before launching ART to generate the oat files for the classpath. run_dex2oat fi fi # Do not continue if the dex2oat failed. EXIT_STATUS=$? if [ $EXIT_STATUS != 0 ]; then echo "Failed dex2oat invocation" >&2 exit $EXIT_STATUS fi run_art "${EXTRA_OPTIONS[@]}" EXIT_STATUS=$? if [ "$PERF" != "" ]; then if [ "$PERF" = report ]; then perf report -i $ANDROID_DATA/perf.data fi echo "Perf data saved in: $ANDROID_DATA/perf.data" else # Perf output is placed under $ANDROID_DATA so not cleaned when perf options used. clean_android_data fi exit $EXIT_STATUS