3 Invoke ". build/envsetup.sh" from your shell to add the following functions to your environment:
4 - croot: Changes directory to the top of the tree.
5 - m: Makes from the top of the tree.
6 - mm: Builds all of the modules in the current directory.
7 - mmm: Builds all of the modules in the supplied directories.
8 - cgrep: Greps on all local C/C++ files.
9 - jgrep: Greps on all local Java files.
10 - resgrep: Greps on all local res/*.xml files.
11 - godir: Go to the directory containing a file.
13 Look at the source to view more functions. The complete list is:
18 for i in `cat $T/build/envsetup.sh | sed -n "/^function /s/function \([a-z_]*\).*/\1/p" | sort`; do
24 # Get the value of a build variable as an absolute path.
25 function get_abs_build_var()
29 echo "Couldn't locate the top of the tree. Try setting TOP." >&2
32 CALLED_FROM_SETUP=true BUILD_SYSTEM=build/core \
33 make --no-print-directory -C "$T" -f build/core/config.mk dumpvar-abs-$1
36 # Get the exact value of a build variable.
37 function get_build_var()
41 echo "Couldn't locate the top of the tree. Try setting TOP." >&2
44 CALLED_FROM_SETUP=true BUILD_SYSTEM=build/core \
45 make --no-print-directory -C "$T" -f build/core/config.mk dumpvar-$1
48 # check to see if the supplied product is one we can build
49 function check_product()
53 echo "Couldn't locate the top of the tree. Try setting TOP." >&2
56 CALLED_FROM_SETUP=true BUILD_SYSTEM=build/core \
57 TARGET_PRODUCT=$1 TARGET_BUILD_VARIANT= \
58 TARGET_SIMULATOR= TARGET_BUILD_TYPE= \
60 get_build_var TARGET_DEVICE > /dev/null
61 # hide successful answers, but allow the errors to show
64 VARIANT_CHOICES=(user userdebug eng)
66 # check to see if the supplied variant is valid
67 function check_variant()
69 for v in ${VARIANT_CHOICES[@]}
83 echo "Couldn't locate the top of the tree. Try setting TOP."
87 ##################################################################
89 # Read me before you modify this code #
91 # This function sets ANDROID_BUILD_PATHS to what it is adding #
92 # to PATH, and the next time it is run, it removes that from #
93 # PATH. This is required so lunch can be run more than once #
94 # and still have working paths. #
96 ##################################################################
99 if [ -n $ANDROID_BUILD_PATHS ] ; then
100 export PATH=${PATH/$ANDROID_BUILD_PATHS/}
103 # and in with the new
105 prebuiltdir=$(getprebuilt)
106 export ANDROID_EABI_TOOLCHAIN=$prebuiltdir/toolchain/arm-eabi-4.4.0/bin
107 export ANDROID_TOOLCHAIN=$ANDROID_EABI_TOOLCHAIN
108 export ANDROID_QTOOLS=$T/development/emulator/qtools
109 export ANDROID_BUILD_PATHS=:$(get_build_var ANDROID_BUILD_PATHS):$ANDROID_QTOOLS:$ANDROID_TOOLCHAIN:$ANDROID_EABI_TOOLCHAIN$CODE_REVIEWS
110 export PATH=$PATH$ANDROID_BUILD_PATHS
112 unset ANDROID_PRODUCT_OUT
113 export ANDROID_PRODUCT_OUT=$(get_abs_build_var PRODUCT_OUT)
114 export OUT=$ANDROID_PRODUCT_OUT
116 # needed for building linux on MacOS
118 #export HOST_EXTRACFLAGS="-I "$T/system/kernel_headers/host_include
120 # needed for OProfile to post-process collected samples
121 export OPROFILE_EVENTS_DIR=$prebuiltdir/oprofile
124 function printconfig()
128 echo "Couldn't locate the top of the tree. Try setting TOP." >&2
131 get_build_var report_config
134 function set_stuff_for_environment()
140 # Don't try to do preoptimization until it works better on OSX.
141 export DISABLE_DEXPREOPT=true
143 export ANDROID_BUILD_TOP=$(gettop)
146 function set_sequence_number()
148 export BUILD_ENV_SEQUENCE_NUMBER=9
153 if [ "$STAY_OFF_MY_LAWN" = "" ]; then
154 local product=$TARGET_PRODUCT
155 local variant=$TARGET_BUILD_VARIANT
156 local apps=$TARGET_BUILD_APPS
157 if [ -z "$apps" ]; then
158 export PROMPT_COMMAND="echo -ne \"\033]0;[${product}-${variant}] ${USER}@${HOSTNAME}: ${PWD}\007\""
160 export PROMPT_COMMAND="echo -ne \"\033]0;[$apps $variant] ${USER}@${HOSTNAME}: ${PWD}\007\""
169 echo "Build for the simulator or the device?"
174 export TARGET_SIMULATOR=
176 while [ -z $TARGET_SIMULATOR ]
178 echo -n "Which would you like? [1] "
179 if [ -z "$1" ] ; then
187 export TARGET_SIMULATOR=false
190 export TARGET_SIMULATOR=false
193 export TARGET_SIMULATOR=false
196 export TARGET_SIMULATOR=true
199 export TARGET_SIMULATOR=true
203 echo "I didn't understand your response. Please try again."
207 if [ -n "$1" ] ; then
212 set_stuff_for_environment
218 echo "Only device builds are supported for" `uname -s`
219 echo " Forcing TARGET_SIMULATOR=false"
223 echo -n "Press enter: "
227 export TARGET_SIMULATOR=false
228 set_stuff_for_environment
233 function choosetype()
235 echo "Build type choices are:"
240 local DEFAULT_NUM DEFAULT_VALUE
241 if [ $TARGET_SIMULATOR = "false" ] ; then
243 DEFAULT_VALUE=release
249 export TARGET_BUILD_TYPE=
251 while [ -z $TARGET_BUILD_TYPE ]
253 echo -n "Which would you like? ["$DEFAULT_NUM"] "
254 if [ -z "$1" ] ; then
262 export TARGET_BUILD_TYPE=$DEFAULT_VALUE
265 export TARGET_BUILD_TYPE=release
268 export TARGET_BUILD_TYPE=release
271 export TARGET_BUILD_TYPE=debug
274 export TARGET_BUILD_TYPE=debug
278 echo "I didn't understand your response. Please try again."
282 if [ -n "$1" ] ; then
287 set_stuff_for_environment
291 # This function isn't really right: It chooses a TARGET_PRODUCT
292 # based on the list of boards. Usually, that gets you something
293 # that kinda works with a generic product, but really, you should
294 # pick a product by name.
296 function chooseproduct()
298 if [ "x$TARGET_PRODUCT" != x ] ; then
299 default_value=$TARGET_PRODUCT
301 if [ "$TARGET_SIMULATOR" = true ] ; then
304 default_value=generic
308 export TARGET_PRODUCT=
310 while [ -z "$TARGET_PRODUCT" ]
312 echo -n "Which product would you like? [$default_value] "
313 if [ -z "$1" ] ; then
320 if [ -z "$ANSWER" ] ; then
321 export TARGET_PRODUCT=$default_value
323 if check_product $ANSWER
325 export TARGET_PRODUCT=$ANSWER
327 echo "** Not a valid product: $ANSWER"
330 if [ -n "$1" ] ; then
335 set_stuff_for_environment
338 function choosevariant()
340 echo "Variant choices are:"
343 for v in ${VARIANT_CHOICES[@]}
345 # The product name is the name of the directory containing
346 # the makefile we found, above.
351 local default_value=eng
354 export TARGET_BUILD_VARIANT=
355 while [ -z "$TARGET_BUILD_VARIANT" ]
357 echo -n "Which would you like? [$default_value] "
358 if [ -z "$1" ] ; then
365 if [ -z "$ANSWER" ] ; then
366 export TARGET_BUILD_VARIANT=$default_value
367 elif (echo -n $ANSWER | grep -q -e "^[0-9][0-9]*$") ; then
368 if [ "$ANSWER" -le "${#VARIANT_CHOICES[@]}" ] ; then
369 export TARGET_BUILD_VARIANT=${VARIANT_CHOICES[$(($ANSWER-$_arrayoffset))]}
372 if check_variant $ANSWER
374 export TARGET_BUILD_VARIANT=$ANSWER
376 echo "** Not a valid variant: $ANSWER"
379 if [ -n "$1" ] ; then
385 function choosecombo()
402 set_stuff_for_environment
406 # Clear this variable. It will be built up again when the vendorsetup.sh
407 # files are included at the end of this file.
408 unset LUNCH_MENU_CHOICES
409 function add_lunch_combo()
413 for c in ${LUNCH_MENU_CHOICES[@]} ; do
414 if [ "$new_combo" = "$c" ] ; then
418 LUNCH_MENU_CHOICES=(${LUNCH_MENU_CHOICES[@]} $new_combo)
421 # add the default one here
422 add_lunch_combo generic-eng
424 # if we're on linux, add the simulator. There is a special case
425 # in lunch to deal with the simulator
426 if [ "$(uname)" = "Linux" ] ; then
427 add_lunch_combo simulator
430 function print_lunch_menu()
434 echo "You're building on" $uname
436 echo "Lunch menu... pick a combo:"
440 for choice in ${LUNCH_MENU_CHOICES[@]}
457 echo -n "Which would you like? [generic-eng] "
465 selection=generic-eng
466 elif [ "$answer" = "simulator" ]
469 elif (echo -n $answer | grep -q -e "^[0-9][0-9]*$")
471 if [ $answer -le ${#LUNCH_MENU_CHOICES[@]} ]
473 selection=${LUNCH_MENU_CHOICES[$(($answer-$_arrayoffset))]}
475 elif (echo -n $answer | grep -q -e "^[^\-][^\-]*-[^\-][^\-]*$")
480 if [ -z "$selection" ]
483 echo "Invalid lunch combo: $answer"
487 export TARGET_BUILD_APPS=
489 # special case the simulator
490 if [ "$selection" = "simulator" ]
492 export TARGET_PRODUCT=sim
493 export TARGET_BUILD_VARIANT=eng
494 export TARGET_SIMULATOR=true
495 export TARGET_BUILD_TYPE=debug
497 local product=$(echo -n $selection | sed -e "s/-.*$//")
498 check_product $product
502 echo "** Don't have a product spec for: '$product'"
503 echo "** Do you have the right repo manifest?"
507 local variant=$(echo -n $selection | sed -e "s/^[^\-]*-//")
508 check_variant $variant
512 echo "** Invalid variant: '$variant'"
513 echo "** Must be one of ${VARIANT_CHOICES[@]}"
517 if [ -z "$product" -o -z "$variant" ]
523 export TARGET_PRODUCT=$product
524 export TARGET_BUILD_VARIANT=$variant
525 export TARGET_SIMULATOR=false
526 export TARGET_BUILD_TYPE=release
531 set_stuff_for_environment
535 # Configures the build to build unbundled apps.
536 # Run tapas with one ore more app names (from LOCAL_PACKAGE_NAME)
539 local variant=$(echo -n $(echo $* | xargs -n 1 echo | grep -E '^(user|userdebug|eng)$'))
540 local apps=$(echo -n $(echo $* | xargs -n 1 echo | grep -E -v '^(user|userdebug|eng)$'))
542 if [ $(echo $variant | wc -w) -gt 1 ]; then
543 echo "tapas: Error: Multiple build variants supplied: $variant"
546 if [ -z "$variant" ]; then
550 export TARGET_PRODUCT=generic
551 export TARGET_BUILD_VARIANT=$variant
552 export TARGET_SIMULATOR=false
553 export TARGET_BUILD_TYPE=release
554 export TARGET_BUILD_APPS=$apps
556 set_stuff_for_environment
562 local TOPFILE=build/core/envsetup.mk
563 if [ -n "$TOP" -a -f "$TOP/$TOPFILE" ] ; then
566 if [ -f $TOPFILE ] ; then
567 # The following circumlocution (repeated below as well) ensures
568 # that we record the true directory name and not one that is
569 # faked up with symlink names.
572 # We redirect cd to /dev/null in case it's aliased to
573 # a command that prints something as a side-effect
577 while [ \( ! \( -f $TOPFILE \) \) -a \( $PWD != "/" \) ]; do
582 if [ -f "$T/$TOPFILE" ]; then
595 echo "Couldn't locate the top of the tree. Try setting TOP."
599 function findmakefile()
601 TOPFILE=build/core/envsetup.mk
602 # We redirect cd to /dev/null in case it's aliased to
603 # a command that prints something as a side-effect
607 while [ \( ! \( -f $TOPFILE \) \) -a \( $PWD != "/" \) ]; do
609 if [ -f "$T/Android.mk" ]; then
621 # If we're sitting in the root of the build tree, just do a
623 if [ -f build/core/envsetup.mk -a -f Makefile ]; then
626 # Find the closest Android.mk file.
628 local M=$(findmakefile)
629 # Remove the path to top as the makefilepath needs to be relative
630 local M=`echo $M|sed 's:'$T'/::'`
632 echo "Couldn't locate the top of the tree. Try setting TOP."
633 elif [ ! "$M" ]; then
634 echo "Couldn't locate a makefile from the current directory."
636 ONE_SHOT_MAKEFILE=$M make -C $T files $@
648 local DASH_ARGS=$(echo "$@" | awk -v RS=" " -v ORS=" " '/^-.*$/')
649 local DIRS=$(echo "$@" | awk -v RS=" " -v ORS=" " '/^[^-].*$/')
650 for DIR in $DIRS ; do
651 DIR=`echo $DIR | sed -e 's:/$::'`
652 if [ -f $DIR/Android.mk ]; then
653 TO_CHOP=`echo $T | wc -c | tr -d ' '`
654 TO_CHOP=`expr $TO_CHOP + 1`
655 START=`PWD= /bin/pwd`
656 MFILE=`echo $START | cut -c${TO_CHOP}-`
657 if [ "$MFILE" = "" ] ; then
658 MFILE=$DIR/Android.mk
660 MFILE=$MFILE/$DIR/Android.mk
662 MAKEFILE="$MAKEFILE $MFILE"
664 if [ "$DIR" = snod ]; then
666 elif [ "$DIR" = showcommands ]; then
667 ARGS="$ARGS showcommands"
669 echo "No Android.mk in $DIR."
674 ONE_SHOT_MAKEFILE="$MAKEFILE" make -C $T $DASH_ARGS files $ARGS
676 echo "Couldn't locate the top of the tree. Try setting TOP."
686 echo "Couldn't locate the top of the tree. Try setting TOP."
692 TOPFILE=build/core/envsetup.mk
693 # We redirect cd to /dev/null in case it's aliased to
694 # a command that prints something as a side-effect
698 while [ \( ! \( -f $TOPFILE \) \) -a \( $PWD != "/" \) ]; do
700 if [ -f "$T/Android.mk" ]; then
707 echo "can't find Android.mk"
714 local PID=`adb shell ps | fgrep $1 | sed -e 's/[^ ]* *\([0-9]*\).*/\1/'`
717 echo "usage: pid name"
721 # systemstack - dump the current stack trace of all threads in the system process
722 # to the usual ANR traces file
723 function systemstack()
725 adb shell echo '""' '>>' /data/anr/traces.txt && adb shell chmod 776 /data/anr/traces.txt && adb shell kill -3 $(pid system_server)
730 local OUT_ROOT=$(get_abs_build_var PRODUCT_OUT)
731 local OUT_SYMBOLS=$(get_abs_build_var TARGET_OUT_UNSTRIPPED)
732 local OUT_SO_SYMBOLS=$(get_abs_build_var TARGET_OUT_SHARED_LIBRARIES_UNSTRIPPED)
733 local OUT_EXE_SYMBOLS=$(get_abs_build_var TARGET_OUT_EXECUTABLES_UNSTRIPPED)
734 local PREBUILTS=$(get_abs_build_var ANDROID_PREBUILTS)
735 if [ "$OUT_ROOT" -a "$PREBUILTS" ]; then
744 if [ "$PORT" ] ; then
752 if [ "$PROG" ] ; then
754 adb forward "tcp$PORT" "tcp$PORT"
755 adb shell gdbserver $PORT --attach $PID &
759 echo "If you haven't done so already, do this first on the device:"
760 echo " gdbserver $PORT /system/bin/$EXE"
762 echo " gdbserver $PORT --attach $PID"
766 echo >|"$OUT_ROOT/gdbclient.cmds" "set solib-absolute-prefix $OUT_SYMBOLS"
767 echo >>"$OUT_ROOT/gdbclient.cmds" "set solib-search-path $OUT_SO_SYMBOLS"
768 echo >>"$OUT_ROOT/gdbclient.cmds" "target remote $PORT"
769 echo >>"$OUT_ROOT/gdbclient.cmds" ""
771 arm-eabi-gdb -x "$OUT_ROOT/gdbclient.cmds" "$OUT_EXE_SYMBOLS/$EXE"
773 echo "Unable to determine build system output dir."
782 find -E . -type f -iregex '.*\.(c|h|cpp|S|java|xml|sh|mk)' -print0 | xargs -0 grep --color -n "$@"
789 find . -type f -iregex '.*\.\(c\|h\|cpp\|S\|java\|xml\|sh\|mk\)' -print0 | xargs -0 grep --color -n "$@"
796 find . -type f -name "*\.java" -print0 | xargs -0 grep --color -n "$@"
801 find . -type f \( -name '*.c' -o -name '*.cc' -o -name '*.cpp' -o -name '*.h' \) -print0 | xargs -0 grep --color -n "$@"
806 for dir in `find . -name res -type d`; do find $dir -type f -name '*\.xml' -print0 | xargs -0 grep --color -n "$@"; done;
813 find -E . -type f -iregex '.*/(Makefile|Makefile\..*|.*\.make|.*\.mak|.*\.mk)' -print0 | xargs -0 grep --color -n "$@"
818 find -E . -type f -iregex '.*\.(c|h|cpp|S|java|xml)' -print0 | xargs -0 grep --color -n -i "$@"
825 find . -regextype posix-egrep -iregex '(.*\/Makefile|.*\/Makefile\..*|.*\.make|.*\.mak|.*\.mk)' -type f -print0 | xargs -0 grep --color -n "$@"
830 find . -regextype posix-egrep -iregex '.*\.(c|h|cpp|S|java|xml)' -type f -print0 | xargs -0 grep --color -n -i "$@"
838 get_abs_build_var ANDROID_PREBUILTS
841 function tracedmdump()
845 echo "Couldn't locate the top of the tree. Try setting TOP."
848 local prebuiltdir=$(getprebuilt)
849 local KERNEL=$T/prebuilt/android-arm/kernel/vmlinux-qemu
852 if [ ! "$TRACE" ] ; then
853 echo "usage: tracedmdump tracename"
857 if [ ! -r "$KERNEL" ] ; then
858 echo "Error: cannot find kernel: '$KERNEL'"
862 local BASETRACE=$(basename $TRACE)
863 if [ "$BASETRACE" = "$TRACE" ] ; then
864 TRACE=$ANDROID_PRODUCT_OUT/traces/$TRACE
867 echo "post-processing traces..."
868 rm -f $TRACE/qtrace.dexlist
870 if [ $? -ne 0 ]; then
872 echo "*** Error: malformed trace. Did you remember to exit the emulator?"
876 echo "generating dexlist output..."
877 /bin/ls $ANDROID_PRODUCT_OUT/system/framework/*.jar $ANDROID_PRODUCT_OUT/system/app/*.apk $ANDROID_PRODUCT_OUT/data/app/*.apk 2>/dev/null | xargs dexlist > $TRACE/qtrace.dexlist
878 echo "generating dmtrace data..."
879 q2dm -r $ANDROID_PRODUCT_OUT/symbols $TRACE $KERNEL $TRACE/dmtrace || return
880 echo "generating html file..."
881 dmtracedump -h $TRACE/dmtrace >| $TRACE/dmtrace.html || return
882 echo "done, see $TRACE/dmtrace.html for details"
884 echo " traceview $TRACE/dmtrace"
887 # communicate with a running device or emulator, set up necessary state,
888 # and run the hat command.
891 # process standard adb options
893 if [ $1 = "-d" -o $1 = "-e" ]; then
896 elif [ $1 = "-s" ]; then
900 local adbOptions=${adbTarget}
901 echo adbOptions = ${adbOptions}
907 if [ "$targetPid" = "" ]; then
908 echo "Usage: runhat [ -d | -e | -s serial ] target-pid [output-file]"
912 # confirm hat is available
913 if [ -z $(which hat) ]; then
914 echo "hat is not available in this configuration."
918 adb ${adbOptions} shell >/dev/null mkdir /data/misc
919 adb ${adbOptions} shell chmod 777 /data/misc
921 # send a SIGUSR1 to cause the hprof dump
922 echo "Poking $targetPid and waiting for data..."
923 adb ${adbOptions} shell kill -10 $targetPid
924 echo "Press enter when logcat shows \"hprof: heap dump completed\""
928 local availFiles=( $(adb ${adbOptions} shell ls /data/misc | grep '^heap-dump' | sed -e 's/.*heap-dump-/heap-dump-/' | sort -r | tr '[:space:][:cntrl:]' ' ') )
929 local devFile=/data/misc/${availFiles[0]}
930 local localFile=/tmp/$$-hprof
932 echo "Retrieving file $devFile..."
933 adb ${adbOptions} pull $devFile $localFile
935 adb ${adbOptions} shell rm $devFile
937 echo "Running hat on $localFile"
938 echo "View the output by pointing your browser at http://localhost:7000/"
943 function getbugreports()
945 local reports=(`adb shell ls /sdcard/bugreports | tr -d '\r'`)
947 if [ ! "$reports" ]; then
948 echo "Could not locate any bugreports."
953 for report in ${reports[@]}
955 echo "/sdcard/bugreports/${report}"
956 adb pull /sdcard/bugreports/${report} ${report}
961 function startviewserver()
964 if [ $# -gt 0 ]; then
967 adb shell service call window 1 i32 $port
970 function stopviewserver()
972 adb shell service call window 2
975 function isviewserverstarted()
977 adb shell service call window 3
982 if [ ! "$ANDROID_PRODUCT_OUT" ]; then
983 echo "Couldn't locate output files. Try running 'lunch' first." >&2
988 echo "Couldn't locate the top of the tree. Try setting TOP." >&2
992 (cd "$T" && mmm tests/SmokeTest) &&
993 adb uninstall com.android.smoketest > /dev/null &&
994 adb uninstall com.android.smoketest.tests > /dev/null &&
995 adb install $ANDROID_PRODUCT_OUT/data/app/SmokeTestApp.apk &&
996 adb install $ANDROID_PRODUCT_OUT/data/app/SmokeTest.apk &&
997 adb shell am instrument -w com.android.smoketest.tests/android.test.InstrumentationTestRunner
1000 # simple shortcut to the runtest command
1005 echo "Couldn't locate the top of the tree. Try setting TOP." >&2
1008 ("$T"/development/testrunner/runtest.py $@)
1012 if [[ -z "$1" ]]; then
1013 echo "Usage: godir <regex>"
1017 if [[ ! -f $T/filelist ]]; then
1018 echo -n "Creating index..."
1019 (cd $T; find . -wholename ./out -prune -o -wholename ./.repo -prune -o -type f > filelist)
1024 lines=($(grep "$1" $T/filelist | sed -e 's/\/[^/]*$//' | sort | uniq))
1025 if [[ ${#lines[@]} = 0 ]]; then
1031 if [[ ${#lines[@]} > 1 ]]; then
1032 while [[ -z "$pathname" ]]; do
1035 for line in ${lines[@]}; do
1036 printf "%6s %s\n" "[$index]" $line
1037 index=$(($index + 1))
1040 echo -n "Select one: "
1043 if [[ $choice -gt ${#lines[@]} || $choice -lt 1 ]]; then
1044 echo "Invalid choice"
1047 pathname=${lines[$(($choice-$_arrayoffset))]}
1050 # even though zsh arrays are 1-based, $foo[0] is an alias for $foo[1]
1051 pathname=${lines[0]}
1056 # Force JAVA_HOME to point to java 1.5 if it isn't already set
1057 if [ "$STAY_OFF_MY_LAWN" = "" ]; then
1058 if [ ! "$JAVA_HOME" ]; then
1061 export JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/1.5/Home
1064 export JAVA_HOME=/usr/lib/jvm/java-1.5.0-sun
1070 # determine whether arrays are zero-based (bash) or one-based (zsh)
1072 if [ -z "${_xarray[${#_xarray[@]}]}" ]
1080 # Execute the contents of any vendorsetup.sh files we can find.
1081 for f in `/bin/ls vendor/*/vendorsetup.sh vendor/*/build/vendorsetup.sh device/*/*/vendorsetup.sh 2> /dev/null`