blob: 8f8e6519714b8051570e25dd233c074cd9c1c2ce [file] [log] [blame]
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001#!/bin/bash
Chris Sosa2b736002012-02-12 16:16:08 -08002# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
rspangler@google.comd74220d2009-10-09 20:56:14 +00003# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5
rspangler@google.comd74220d2009-10-09 20:56:14 +00006# All scripts should die on error unless commands are specifically excepted
7# by prefixing with '!' or surrounded by 'set +e' / 'set -e'.
rspangler@google.comd74220d2009-10-09 20:56:14 +00008
9# The number of jobs to pass to tools that can run in parallel (such as make
10# and dpkg-buildpackage
Alex Deymo135faa12015-01-21 11:20:13 -080011if [[ -z ${NUM_JOBS:-} ]]; then
Brian Harring28bb01f2012-05-09 15:26:09 -070012 NUM_JOBS=$(grep -c "^processor" /proc/cpuinfo)
13fi
14# Ensure that any sub scripts we invoke get the max proc count.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -050015export NUM_JOBS
rspangler@google.comd74220d2009-10-09 20:56:14 +000016
Gilad Arnold8f861c02013-01-09 09:19:51 -080017# Returns the pv command if it's available, otherwise plain-old cat. Note that
18# this function echoes the command, rather than running it, so it can be used
19# as an argument to other commands (like sudo).
20pv_cat_cmd() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -050021 if type -P pv >&/dev/null; then
Gilad Arnold8f861c02013-01-09 09:19:51 -080022 # Limit pv's output to 80 columns, for readability.
23 local term_cols=$(stty size 2>/dev/null | cut -d' ' -f2)
Mike Frysingerbaae8eb2013-01-15 01:34:26 -050024 if [[ ${term_cols:-0} -gt 80 ]]; then
Seigo Nonaka89b7b592013-05-21 17:30:18 +090025 echo pv -w 80 -B 4m
Gilad Arnold8f861c02013-01-09 09:19:51 -080026 else
Seigo Nonaka89b7b592013-05-21 17:30:18 +090027 echo pv -B 4m
Gilad Arnold8f861c02013-01-09 09:19:51 -080028 fi
29 else
30 echo cat
31 fi
32}
Simon Glass142ca062011-02-09 13:39:43 -080033
Greg Spencer798d75f2011-02-01 22:04:49 -080034# Make sure we have the location and name of the calling script, using
35# the current value if it is already set.
Alex Deymo7ba56be2015-02-12 14:28:06 -080036: ${SCRIPT_LOCATION:=$(dirname "$(readlink -f -- "$0")")}
37: ${SCRIPT_NAME:=$(basename -- "$0")}
rspangler@google.comd74220d2009-10-09 20:56:14 +000038
Anton Staaf30acb0b2011-01-26 16:00:20 -080039# Detect whether we're inside a chroot or not
Vincent Palatin5ce24062014-02-26 12:08:23 -080040if [[ -e /etc/cros_chroot_version ]]; then
Anton Staaf30acb0b2011-01-26 16:00:20 -080041 INSIDE_CHROOT=1
rspangler@google.comd74220d2009-10-09 20:56:14 +000042else
Anton Staaf30acb0b2011-01-26 16:00:20 -080043 INSIDE_CHROOT=0
rspangler@google.comd74220d2009-10-09 20:56:14 +000044fi
45
Mike Frysinger669b28b2012-02-07 18:01:00 -050046# Determine and set up variables needed for fancy color output (if supported).
47V_BOLD_RED=
48V_BOLD_GREEN=
49V_BOLD_YELLOW=
50V_REVERSE=
51V_VIDOFF=
52
Steve Fungff6345d2014-02-04 16:14:55 -080053if [[ -t 1 ]] && tput colors >&/dev/null; then
Mike Frysinger669b28b2012-02-07 18:01:00 -050054 # order matters: we want VIDOFF last so that when we trace with `set -x`,
55 # our terminal doesn't bleed colors as bash dumps the values of vars.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -050056 V_BOLD_RED=$(tput bold; tput setaf 1)
57 V_BOLD_GREEN=$(tput bold; tput setaf 2)
58 V_BOLD_YELLOW=$(tput bold; tput setaf 3)
59 V_REVERSE=$(tput rev)
60 V_VIDOFF=$(tput sgr0)
Mike Frysinger669b28b2012-02-07 18:01:00 -050061fi
62
Mike Frysingerbaae8eb2013-01-15 01:34:26 -050063# Turn on bash debug support if available for backtraces.
64shopt -s extdebug 2>/dev/null
Brian Harring7f175a52012-03-02 05:37:00 -080065
Marc Herbertff9fa312015-01-16 17:18:53 -080066# Output a backtrace. Optional parameter allows hiding the last
67# frame(s) so functions like "die()" can hide their additional
68# frame(s) if they wish.
69dump_trace() {
70 # Default = 0 hidden frames: show everything except dump_trace
71 # frame itself.
72 local hidden_frames=${1:-0}
Mike Frysingerbaae8eb2013-01-15 01:34:26 -050073 local j n p func src line args
74 p=${#BASH_ARGV[@]}
Marc Herbertff9fa312015-01-16 17:18:53 -080075
Marc Herbertf51cf8f2015-01-20 13:56:00 -080076 error "$(date)"
77
Marc Herbertff9fa312015-01-16 17:18:53 -080078 # Frame 0 is ourselves so it's always suppressed / does not count.
79 for (( n = ${#FUNCNAME[@]}; n > hidden_frames; --n )); do
Mike Frysingerbaae8eb2013-01-15 01:34:26 -050080 func=${FUNCNAME[${n} - 1]}
Mike Frysingerbaae8eb2013-01-15 01:34:26 -050081 line=${BASH_LINENO[${n} - 1]}
82 args=
83 if [[ -z ${BASH_ARGC[${n} -1]} ]]; then
84 args='(args unknown, no debug available)'
Brian Harring7f175a52012-03-02 05:37:00 -080085 else
Mike Frysingerbaae8eb2013-01-15 01:34:26 -050086 for (( j = 0; j < ${BASH_ARGC[${n} -1]}; ++j )); do
87 args="${args:+${args} }'${BASH_ARGV[$(( p - j - 1 ))]}'"
88 done
89 ! (( p -= ${BASH_ARGC[${n} - 1]} ))
Brian Harring7f175a52012-03-02 05:37:00 -080090 fi
Mike Frysingerbaae8eb2013-01-15 01:34:26 -050091 if [[ ${n} == ${#FUNCNAME[@]} ]]; then
92 error "script called: ${0##/*} ${args}"
93 error "Backtrace: (most recent call is last)"
94 else
Marc Herbert2e8c5902015-01-15 20:17:31 -080095 src=${BASH_SOURCE[${n}]##*/}
Marc Herbertfa6cbe72015-01-20 14:09:09 -080096 curr_func=${FUNCNAME[${n}]}
97 error "$(printf ' %s:%s:%s(), called: %s %s ' \
98 "${src}" "${line}" "${curr_func}" "${func}" "${args}")"
Mike Frysingerbaae8eb2013-01-15 01:34:26 -050099 fi
100 done
101}
Brian Harring7f175a52012-03-02 05:37:00 -0800102
Mike Frysinger669b28b2012-02-07 18:01:00 -0500103# Declare these asap so that code below can safely assume they exist.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400104_message() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500105 local prefix=$1
Brian Harring7f175a52012-03-02 05:37:00 -0800106 shift
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500107 if [[ $# -eq 0 ]]; then
108 echo -e "${prefix}${CROS_LOG_PREFIX:-""}:${V_VIDOFF}" >&2
Brian Harring7f175a52012-03-02 05:37:00 -0800109 return
110 fi
111 (
112 # Handle newlines in the message, prefixing each chunk correctly.
113 # Do this in a subshell to avoid having to track IFS/set -f state.
114 IFS="
115"
116 set +f
117 set -- $*
118 IFS=' '
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500119 if [[ $# -eq 0 ]]; then
Brian Harring7f175a52012-03-02 05:37:00 -0800120 # Empty line was requested.
121 set -- ''
122 fi
123 for line in "$@"; do
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500124 echo -e "${prefix}${CROS_LOG_PREFIX:-}: ${line}${V_VIDOFF}" >&2
Brian Harring7f175a52012-03-02 05:37:00 -0800125 done
126 )
127}
128
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400129info() {
Brian Harring7f175a52012-03-02 05:37:00 -0800130 _message "${V_BOLD_GREEN}INFO " "$*"
Mike Frysinger669b28b2012-02-07 18:01:00 -0500131}
132
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400133warn() {
Brian Harring7f175a52012-03-02 05:37:00 -0800134 _message "${V_BOLD_YELLOW}WARNING " "$*"
Mike Frysinger669b28b2012-02-07 18:01:00 -0500135}
136
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400137error() {
Brian Harring7f175a52012-03-02 05:37:00 -0800138 _message "${V_BOLD_RED}ERROR " "$*"
Mike Frysinger669b28b2012-02-07 18:01:00 -0500139}
140
Brian Harring7f175a52012-03-02 05:37:00 -0800141
142# For all die functions, they must explicitly force set +eu;
Alex Deymof9235952015-01-15 11:15:09 -0800143# no reason to have them cause their own crash if we're in the middle
Brian Harring7f175a52012-03-02 05:37:00 -0800144# of reporting an error condition then exiting.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400145die_err_trap() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500146 local command=$1 result=$2
Brian Harring7f175a52012-03-02 05:37:00 -0800147 set +e +u
148
149 # Per the message, bash misreports 127 as 1 during err trap sometimes.
150 # Note this fact to ensure users don't place too much faith in the
151 # exit code in that case.
152 set -- "Command '${command}' exited with nonzero code: ${result}"
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500153 if [[ ${result} -eq 1 ]] && [[ -z $(type -t ${command}) ]]; then
154 set -- "$@" \
155 '(Note bash sometimes misreports "command not found" as exit code 1 '\
Brian Harring7f175a52012-03-02 05:37:00 -0800156'instead of 127)'
Brian Harring7f175a52012-03-02 05:37:00 -0800157 fi
Marc Herbertff9fa312015-01-16 17:18:53 -0800158 dump_trace 1
Brian Harring7f175a52012-03-02 05:37:00 -0800159 error
160 error "Command failed:"
161 DIE_PREFIX=' '
162 die_notrace "$@"
163}
164
165# Exit this script due to a failure, outputting a backtrace in the process.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400166die() {
Brian Harring7f175a52012-03-02 05:37:00 -0800167 set +e +u
Marc Herbertff9fa312015-01-16 17:18:53 -0800168 dump_trace 1
Brian Harring7f175a52012-03-02 05:37:00 -0800169 error
170 error "Error was:"
171 DIE_PREFIX=' '
172 die_notrace "$@"
173}
174
175# Exit this script w/out a backtrace.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400176die_notrace() {
Brian Harring7f175a52012-03-02 05:37:00 -0800177 set +e +u
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500178 if [[ $# -eq 0 ]]; then
Brian Harring7f175a52012-03-02 05:37:00 -0800179 set -- '(no error message given)'
180 fi
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500181 local line
Brian Harring7f175a52012-03-02 05:37:00 -0800182 for line in "$@"; do
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500183 error "${DIE_PREFIX}${line}"
Brian Harring7f175a52012-03-02 05:37:00 -0800184 done
Mike Frysinger669b28b2012-02-07 18:01:00 -0500185 exit 1
186}
187
David Jamesbf13ea82013-05-08 14:17:25 -0700188# Check for a single string in a list of space-separated strings.
189# e.g. has "foo" "foo bar baz" is true, but has "f" "foo bar baz" is not.
190has() { [[ " ${*:2} " == *" $1 "* ]]; }
191
Brian Harring9086a3f2013-01-14 01:43:16 -0800192# Directory locations inside the dev chroot; try the new default,
193# falling back to user specific paths if the upgrade has yet to
194# happen.
195_user="${USER}"
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500196[[ ${USER} == "root" ]] && _user="${SUDO_USER}"
Brian Harring9086a3f2013-01-14 01:43:16 -0800197_CHROOT_TRUNK_DIRS=( "/home/${_user}/trunk" /mnt/host/source )
198_DEPOT_TOOLS_DIRS=( "/home/${_user}/depot_tools" /mnt/host/depot_tools )
199unset _user
200
201_process_mount_pt() {
202 # Given 4 arguments; the root path, the variable to set,
203 # the old location, and the new; finally, forcing the upgrade is doable
204 # via if a 5th arg is provided.
205 # This will then try to migrate the old to new if we can do so right now
206 # (else leaving symlinks in place w/in the new), and will set $1 to the
207 # new location.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500208 local base=${1:-/} var=$2 old=$3 new=$4 force=${5:-false}
209 local _sudo=$([[ ${USER} != "root" ]] && echo sudo)
210 local val=${new}
Mike Frysinger2d9a97d2015-02-25 01:38:56 -0500211 if ${force} || [[ -L ${base}/${new} ]] || [[ ! -e ${base}/${new} ]]; then
Brian Harring9086a3f2013-01-14 01:43:16 -0800212 # Ok, it's either a symlink or this is the first run. Upgrade if we can-
213 # specifically, if we're outside the chroot and we can rmdir the old.
214 # If we cannot rmdir the old, that's due to a mount being bound to that
215 # point (even if we can't see it, it's there)- thus fallback to adding
216 # compat links.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500217 if ${force} || ( [[ ${INSIDE_CHROOT} -eq 0 ]] && \
218 ${_sudo} rmdir "${base}/${old}" 2>/dev/null ); then
Brian Harring9086a3f2013-01-14 01:43:16 -0800219 ${_sudo} rm -f "${base}/${new}" || :
220 ${_sudo} mkdir -p "${base}/${new}" "$(dirname "${base}/${old}" )"
221 ${_sudo} ln -s "${new}" "${base}/${old}"
222 else
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500223 if [[ ! -L ${base}/${new} ]]; then
Brian Harring9086a3f2013-01-14 01:43:16 -0800224 # We can't do the upgrade right now; install compatibility links.
225 ${_sudo} mkdir -p "$(dirname "${base}/${new}")" "${base}/${old}"
226 ${_sudo} ln -s "${old}" "${base}/${new}"
227 fi
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500228 val=${old}
Brian Harring9086a3f2013-01-14 01:43:16 -0800229 fi
230 fi
231 eval "${var}=\"${val}\""
232}
233
234set_chroot_trunk_dir() {
235 # This takes two optional arguments; the first being the path to the chroot
236 # base; this is only used by enter_chroot. The second argument is whether
237 # or not to force the new pathways; this is only used by make_chroot. Passing
238 # a non-null value for $2 forces the new paths.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500239 if [[ ${INSIDE_CHROOT} -eq 0 ]] && [[ -z ${1-} ]]; then
Brian Harring9086a3f2013-01-14 01:43:16 -0800240 # Can't do the upgrade, thus skip trying to do so.
241 CHROOT_TRUNK_DIR="${_CHROOT_TRUNK_DIRS[1]}"
242 DEPOT_TOOLS_DIR="${_DEPOT_TOOLS_DIRS[1]}"
243 return
244 fi
Alex Deymo76277de2015-01-22 11:02:13 -0800245 _process_mount_pt "${1:-}" CHROOT_TRUNK_DIR "${_CHROOT_TRUNK_DIRS[@]}" \
246 ${2:+true}
247 _process_mount_pt "${1:-}" DEPOT_TOOLS_DIR "${_DEPOT_TOOLS_DIRS[@]}" \
248 ${2:+true}
Brian Harring9086a3f2013-01-14 01:43:16 -0800249}
250
251set_chroot_trunk_dir
252
Anton Staaf30acb0b2011-01-26 16:00:20 -0800253# Construct a list of possible locations for the source tree. This list is
254# based on various environment variables and globals that may have been set
255# by the calling script.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400256get_gclient_root_list() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500257 if [[ ${INSIDE_CHROOT} -eq 1 ]]; then
Brian Harring2499bfb2012-12-18 16:23:31 -0800258 echo "${CHROOT_TRUNK_DIR}"
Anton Staaf30acb0b2011-01-26 16:00:20 -0800259 fi
260
Alex Deymo135faa12015-01-21 11:20:13 -0800261 if [[ -n ${COMMON_SH:-} ]]; then echo "$(dirname "${COMMON_SH}")/../.."; fi
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500262 if [[ -n ${BASH_SOURCE} ]]; then echo "$(dirname "${BASH_SOURCE}")/../.."; fi
Anton Staaf30acb0b2011-01-26 16:00:20 -0800263}
264
265# Based on the list of possible source locations we set GCLIENT_ROOT if it is
266# not already defined by looking for a src directory in each seach path
267# location. If we do not find a valid looking root we error out.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400268get_gclient_root() {
Alex Deymo135faa12015-01-21 11:20:13 -0800269 if [[ -n ${GCLIENT_ROOT:-} ]]; then
Anton Staaf30acb0b2011-01-26 16:00:20 -0800270 return
271 fi
272
273 for path in $(get_gclient_root_list); do
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500274 if [[ -d ${path}/src ]]; then
Anton Staaf30acb0b2011-01-26 16:00:20 -0800275 GCLIENT_ROOT=${path}
276 break
277 fi
278 done
279
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500280 if [[ -z ${GCLIENT_ROOT} ]]; then
Anton Staaf30acb0b2011-01-26 16:00:20 -0800281 # Using dash or sh, we don't know where we are. $0 refers to the calling
282 # script, not ourselves, so that doesn't help us.
283 echo "Unable to determine location for common.sh. If you are sourcing"
284 echo "common.sh from a script run via dash or sh, you must do it in the"
285 echo "following way:"
286 echo ' COMMON_SH="$(dirname "$0")/../../scripts/common.sh"'
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500287 echo ' . "${COMMON_SH}"'
Anton Staaf30acb0b2011-01-26 16:00:20 -0800288 echo "where the first line is the relative path from your script to"
289 echo "common.sh."
290 exit 1
291 fi
292}
293
David James76764882012-10-24 19:46:29 -0700294# Populate the ENVIRONMENT_WHITELIST array.
295load_environment_whitelist() {
296 set -f
297 ENVIRONMENT_WHITELIST=(
298 $("${GCLIENT_ROOT}/chromite/scripts/cros_env_whitelist")
299 )
300 set +f
301}
302
Anton Staaf30acb0b2011-01-26 16:00:20 -0800303# Find root of source tree
304get_gclient_root
305
rspangler@google.comd74220d2009-10-09 20:56:14 +0000306# Canonicalize the directories for the root dir and the calling script.
307# readlink is part of coreutils and should be present even in a bare chroot.
tedbo4f44d9e2010-01-08 17:26:11 -0800308# This is better than just using
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500309# FOO="$(cd ${FOO} ; pwd)"
tedbo4f44d9e2010-01-08 17:26:11 -0800310# since that leaves symbolic links intact.
rspangler@google.comd74220d2009-10-09 20:56:14 +0000311# Note that 'realpath' is equivalent to 'readlink -f'.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500312SCRIPT_LOCATION=$(readlink -f "${SCRIPT_LOCATION}")
313GCLIENT_ROOT=$(readlink -f "${GCLIENT_ROOT}")
rspangler@google.comd74220d2009-10-09 20:56:14 +0000314
315# Other directories should always be pathed down from GCLIENT_ROOT.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500316SRC_ROOT="${GCLIENT_ROOT}/src"
317SRC_INTERNAL="${GCLIENT_ROOT}/src-internal"
318SCRIPTS_DIR="${SRC_ROOT}/scripts"
319BUILD_LIBRARY_DIR="${SCRIPTS_DIR}/build_library"
rspangler@google.comd74220d2009-10-09 20:56:14 +0000320
321# Load developer's custom settings. Default location is in scripts dir,
322# since that's available both inside and outside the chroot. By convention,
323# settings from this file are variables starting with 'CHROMEOS_'
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500324: ${CHROMEOS_DEV_SETTINGS:=${SCRIPTS_DIR}/.chromeos_dev}
325if [[ -f ${CHROMEOS_DEV_SETTINGS} ]]; then
rspangler@google.comd74220d2009-10-09 20:56:14 +0000326 # Turn on exit-on-error during custom settings processing
Greg Spencer798d75f2011-02-01 22:04:49 -0800327 SAVE_OPTS=$(set +o)
Brian Harring7f175a52012-03-02 05:37:00 -0800328 switch_to_strict_mode
rspangler@google.comd74220d2009-10-09 20:56:14 +0000329
330 # Read settings
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500331 . "${CHROMEOS_DEV_SETTINGS}"
rspangler@google.comd74220d2009-10-09 20:56:14 +0000332
333 # Restore previous state of exit-on-error
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500334 eval "${SAVE_OPTS}"
rspangler@google.comd74220d2009-10-09 20:56:14 +0000335fi
336
337# Load shflags
Zdenek Behan07d24222011-11-02 00:46:25 +0000338# NOTE: This code snippet is in particular used by the au-generator (which
339# stores shflags in ./lib/shflags/) and should not be touched.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500340if [[ -f ${SCRIPTS_DIR}/lib/shflags/shflags ]]; then
Mike Frysinger77c674b2012-02-07 18:05:07 -0500341 . "${SCRIPTS_DIR}/lib/shflags/shflags" || die "Couldn't find shflags"
Zdenek Behan07d24222011-11-02 00:46:25 +0000342else
343 . ./lib/shflags/shflags || die "Couldn't find shflags"
344fi
rspangler@google.comd74220d2009-10-09 20:56:14 +0000345
Bill Richardson10d27c22010-01-20 13:38:50 -0800346# Our local mirror
347DEFAULT_CHROMEOS_SERVER=${CHROMEOS_SERVER:-"http://build.chromium.org/mirror"}
rspangler@google.comd74220d2009-10-09 20:56:14 +0000348
Bill Richardson10d27c22010-01-20 13:38:50 -0800349# Upstream mirrors and build suites come in 2 flavors
350# DEV - development chroot, used to build the chromeos image
351# IMG - bootable image, to run on actual hardware
rspangler@google.comd74220d2009-10-09 20:56:14 +0000352
Bill Richardson10d27c22010-01-20 13:38:50 -0800353DEFAULT_DEV_MIRROR=${CHROMEOS_DEV_MIRROR:-"${DEFAULT_CHROMEOS_SERVER}/ubuntu"}
354DEFAULT_DEV_SUITE=${CHROMEOS_DEV_SUITE:-"karmic"}
355
356DEFAULT_IMG_MIRROR=${CHROMEOS_IMG_MIRROR:-"${DEFAULT_CHROMEOS_SERVER}/ubuntu"}
357DEFAULT_IMG_SUITE=${CHROMEOS_IMG_SUITE:-"karmic"}
rspangler@google.comd74220d2009-10-09 20:56:14 +0000358
359# Default location for chroot
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500360DEFAULT_CHROOT_DIR=${CHROMEOS_CHROOT_DIR:-"${GCLIENT_ROOT}/chroot"}
rspangler@google.comd74220d2009-10-09 20:56:14 +0000361
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500362# All output files from build should go under ${DEFAULT_BUILD_ROOT}, so that
rspangler@google.comd74220d2009-10-09 20:56:14 +0000363# they don't pollute the source directory.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500364DEFAULT_BUILD_ROOT=${CHROMEOS_BUILD_ROOT:-"${SRC_ROOT}/build"}
rspangler@google.comd74220d2009-10-09 20:56:14 +0000365
David McMahon49302942010-02-18 16:55:35 -0800366# Set up a global ALL_BOARDS value
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500367if [[ -d ${SRC_ROOT}/overlays ]]; then
368 ALL_BOARDS=$(cd "${SRC_ROOT}/overlays"; \
Mike Frysingera1a06ab2011-08-10 11:40:30 -0400369 ls -1d overlay-* 2>&- | sed 's,overlay-,,g')
David Rochberg3b910702010-12-02 10:45:21 -0500370fi
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500371# Normalize whitespace.
372ALL_BOARDS=$(echo ${ALL_BOARDS})
Mike Frysingerc17a4932012-03-12 17:07:40 -0400373
374# Sets the default board variable for calling script.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500375if [[ -f ${GCLIENT_ROOT}/src/scripts/.default_board ]]; then
376 DEFAULT_BOARD=$(<"${GCLIENT_ROOT}/src/scripts/.default_board")
Mike Frysingerc17a4932012-03-12 17:07:40 -0400377 # Check for user typos like whitespace.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500378 if [[ -n ${DEFAULT_BOARD//[a-zA-Z0-9-_]} ]]; then
Mike Frysingerc17a4932012-03-12 17:07:40 -0400379 die ".default_board: invalid name detected; please fix:" \
380 "'${DEFAULT_BOARD}'"
381 fi
382fi
383# Stub to get people to upgrade.
384get_default_board() {
385 warn "please upgrade your script, and make sure to run build_packages"
386}
David McMahon49302942010-02-18 16:55:35 -0800387
David Jamesff072012010-11-30 13:22:05 -0800388# Enable --fast by default.
Greg Spencer798d75f2011-02-01 22:04:49 -0800389DEFAULT_FAST=${FLAGS_TRUE}
David James03668642010-07-28 17:08:29 -0700390
Chris Sosab0f57322011-10-25 03:07:23 +0000391# Directory to store built images. Should be set by sourcing script when used.
392BUILD_DIR=
Simon Glass142ca062011-02-09 13:39:43 -0800393
394# Standard filenames
Chris Sosab0f57322011-10-25 03:07:23 +0000395CHROMEOS_BASE_IMAGE_NAME="chromiumos_base_image.bin"
Simon Glass142ca062011-02-09 13:39:43 -0800396CHROMEOS_IMAGE_NAME="chromiumos_image.bin"
Chris Sosab0f57322011-10-25 03:07:23 +0000397CHROMEOS_DEVELOPER_IMAGE_NAME="chromiumos_image.bin"
Gilad Arnold08366272012-02-08 10:46:26 -0800398CHROMEOS_RECOVERY_IMAGE_NAME="recovery_image.bin"
Simon Glass142ca062011-02-09 13:39:43 -0800399CHROMEOS_TEST_IMAGE_NAME="chromiumos_test_image.bin"
Chris Sosab885b802011-02-16 15:33:11 -0800400CHROMEOS_FACTORY_TEST_IMAGE_NAME="chromiumos_factory_image.bin"
Chris Sosab0f57322011-10-25 03:07:23 +0000401CHROMEOS_FACTORY_INSTALL_SHIM_NAME="factory_install_shim.bin"
Simon Glass142ca062011-02-09 13:39:43 -0800402
Chris Sosaaa1a7fd2010-04-02 14:06:29 -0700403# Install make for portage ebuilds. Used by build_image and gmergefs.
Chris Masoned11ce172010-11-09 14:22:08 -0800404# TODO: Is /usr/local/autotest-chrome still used by anyone?
Hung-Te Lind32c59f2012-01-19 19:54:01 +0800405COMMON_INSTALL_MASK="
Daniel Erate82f07c2010-12-21 13:39:22 -0800406 *.a
Alex Deymo1856c4f2014-09-24 08:15:34 -0700407 *.c
408 *.cc
Daniel Erate82f07c2010-12-21 13:39:22 -0800409 *.la
Rene Bolldorf32228222012-07-21 14:18:22 -0400410 *.h
411 *.hpp
Mike Frysinger97c6ac92014-06-16 00:06:37 -0400412 */.keep*
Daniel Erate82f07c2010-12-21 13:39:22 -0800413 /etc/init.d
414 /etc/runlevels
Hung-Te Lin76272be2012-08-07 19:10:09 +0800415 /firmware
Mike Frysinger785f09d2013-09-25 22:11:21 -0400416 /lib/modules/*/vdso
Daniel Erate82f07c2010-12-21 13:39:22 -0800417 /lib/rc
Mike Frysinger2e4f3d42013-06-24 17:22:39 -0400418 /lib/systemd
Daniel Erate82f07c2010-12-21 13:39:22 -0800419 /usr/bin/Xnest
420 /usr/bin/Xvfb
Mike Frysinger10c56472013-03-01 00:58:10 -0500421 /usr/include/nspr/*
422 /usr/include/X11/*
Daniel Erate82f07c2010-12-21 13:39:22 -0800423 /usr/lib/debug
Mike Frysinger27b5edb2012-08-08 18:52:06 -0400424 /usr/lib*/pkgconfig
Mike Frysinger0916a022014-06-15 22:38:47 -0400425 /usr/lib/systemd
Daniel Erate82f07c2010-12-21 13:39:22 -0800426 /usr/local/autotest-chrome
427 /usr/man
428 /usr/share/aclocal
429 /usr/share/doc
430 /usr/share/gettext
431 /usr/share/gtk-2.0
432 /usr/share/gtk-doc
433 /usr/share/info
434 /usr/share/man
435 /usr/share/openrc
436 /usr/share/pkgconfig
Ryan Harrisonb8bd5942013-02-02 13:39:43 -0500437 /usr/share/profiling
Daniel Erate82f07c2010-12-21 13:39:22 -0800438 /usr/share/readline
Chris Wolfed13775f2011-07-26 16:34:38 -0400439 /usr/src
Daniel Erate82f07c2010-12-21 13:39:22 -0800440 "
Chris Sosaaa1a7fd2010-04-02 14:06:29 -0700441
Hung-Te Lind32c59f2012-01-19 19:54:01 +0800442# Mask for base, dev, and test images (build_image, build_image --test)
443DEFAULT_INSTALL_MASK="
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500444 ${COMMON_INSTALL_MASK}
Don Garrettac1cd0d2013-07-18 18:04:06 -0700445 /boot/config-*
446 /boot/System.map-*
Aviv Kesheta1838ba2013-07-23 10:58:23 -0700447 /usr/local/build/autotest
Olof Johansson1222b2e2012-08-08 15:27:35 -0700448 /lib/modules/*/build
449 /lib/modules/*/source
Kees Cook74f163b2012-12-18 15:46:51 -0800450 test_*.ko
Hung-Te Lind32c59f2012-01-19 19:54:01 +0800451 "
452
453# Mask for factory test image (build_image --factory)
454FACTORY_TEST_INSTALL_MASK="
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500455 ${COMMON_INSTALL_MASK}
Hung-Te Lind32c59f2012-01-19 19:54:01 +0800456 */.svn
457 */CVS
Hung-Te Lind32c59f2012-01-19 19:54:01 +0800458 /usr/local/autotest/conmux
Christopher Wileyca943ac2013-11-13 11:22:54 -0800459 /usr/local/build/autotest
Jon Salz8c8186c2012-08-29 05:40:51 +0800460 /usr/local/factory/bundle
Hung-Te Lind32c59f2012-01-19 19:54:01 +0800461 "
462
Chris Sosac9422fa2012-03-05 15:58:07 -0800463# Mask for factory install shim (build_image factory_install)
Hung-Te Lind32c59f2012-01-19 19:54:01 +0800464FACTORY_SHIM_INSTALL_MASK="
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500465 ${DEFAULT_INSTALL_MASK}
Hung-Te Lind32c59f2012-01-19 19:54:01 +0800466 /opt/[^g]*
Daniel Erate82f07c2010-12-21 13:39:22 -0800467 /opt/google/chrome
468 /opt/google/o3d
469 /opt/google/talkplugin
Daniel Erate82f07c2010-12-21 13:39:22 -0800470 /usr/lib/dri
471 /usr/lib/python2.6/test
Vic Yang982556a2012-12-11 11:41:54 +0800472 /usr/lib64/dri
Daniel Erate82f07c2010-12-21 13:39:22 -0800473 /usr/local/autotest-pkgs
474 /usr/share/X11
475 /usr/share/chewing
Vic Yang982556a2012-12-11 11:41:54 +0800476 /usr/share/chromeos-assets
Daniel Erate82f07c2010-12-21 13:39:22 -0800477 /usr/share/fonts
478 /usr/share/ibus-pinyin
479 /usr/share/libhangul
480 /usr/share/locale
481 /usr/share/m17n
482 /usr/share/mime
Vic Yang982556a2012-12-11 11:41:54 +0800483 /usr/share/oem
484 /usr/share/pyzy
Daniel Erate82f07c2010-12-21 13:39:22 -0800485 /usr/share/sounds
486 /usr/share/tts
487 /usr/share/zoneinfo
488 "
Tom Wai-Hong Tamf87a3672010-05-17 16:06:33 +0800489
rspangler@google.comd74220d2009-10-09 20:56:14 +0000490# -----------------------------------------------------------------------------
491# Functions
492
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400493setup_board_warning() {
tedbo373c3902010-04-12 10:52:40 -0700494 echo
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500495 echo "${V_REVERSE}================ WARNING =====================${V_VIDOFF}"
Chris Sosaacada732010-02-23 15:20:03 -0800496 echo
497 echo "*** No default board detected in " \
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500498 "${GCLIENT_ROOT}/src/scripts/.default_board"
Chris Sosaacada732010-02-23 15:20:03 -0800499 echo "*** Either run setup_board with default flag set"
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500500 echo "*** or echo |board_name| > ${GCLIENT_ROOT}/src/scripts/.default_board"
Chris Sosaacada732010-02-23 15:20:03 -0800501 echo
502}
503
David James22dc2ba2012-11-29 15:46:58 -0800504is_nfs() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500505 [[ $(stat -f -L -c %T "$1") == "nfs" ]]
David James22dc2ba2012-11-29 15:46:58 -0800506}
507
508warn_if_nfs() {
509 if is_nfs "$1"; then
Marc MERLINfcd84ef2013-03-07 14:34:43 -0800510 warn "$1 is on NFS. This is untested. You can send patches if it's broken."
David James22dc2ba2012-11-29 15:46:58 -0800511 fi
512}
513
Don Garrett640a0582010-05-04 16:54:28 -0700514# Enter a chroot and restart the current script if needed
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400515restart_in_chroot_if_needed() {
David Rochberg3b910702010-12-02 10:45:21 -0500516 # NB: Pass in ARGV: restart_in_chroot_if_needed "$@"
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500517 if [[ ${INSIDE_CHROOT} -ne 1 ]]; then
Chris Sosafd2cdec2011-03-24 16:06:59 -0700518 # Get inside_chroot path for script.
519 local chroot_path="$(reinterpret_path_for_chroot "$0")"
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500520 exec ${GCLIENT_ROOT}/chromite/bin/cros_sdk -- "${chroot_path}" "$@"
Don Garrett640a0582010-05-04 16:54:28 -0700521 fi
522}
523
rspangler@google.comd74220d2009-10-09 20:56:14 +0000524# Fail unless we're inside the chroot. This guards against messing up your
525# workstation.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400526assert_inside_chroot() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500527 if [[ ${INSIDE_CHROOT} -ne 1 ]]; then
rspangler@google.comd74220d2009-10-09 20:56:14 +0000528 echo "This script must be run inside the chroot. Run this first:"
Zdenek Behan2811c162011-08-13 00:47:38 +0200529 echo " cros_sdk"
rspangler@google.comd74220d2009-10-09 20:56:14 +0000530 exit 1
531 fi
532}
533
534# Fail if we're inside the chroot. This guards against creating or entering
535# nested chroots, among other potential problems.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400536assert_outside_chroot() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500537 if [[ ${INSIDE_CHROOT} -ne 0 ]]; then
rspangler@google.comd74220d2009-10-09 20:56:14 +0000538 echo "This script must be run outside the chroot."
539 exit 1
540 fi
541}
542
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400543assert_not_root_user() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500544 if [[ ${UID:-$(id -u)} == 0 ]]; then
derat@google.com86dcc8e2009-11-21 19:49:49 +0000545 echo "This script must be run as a non-root user."
546 exit 1
547 fi
548}
549
David James76764882012-10-24 19:46:29 -0700550assert_root_user() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500551 if [[ ${UID:-$(id -u)} != 0 ]] || [[ ${SUDO_USER:-root} == "root" ]]; then
David James76764882012-10-24 19:46:29 -0700552 die_notrace "This script must be run using sudo from a non-root user."
553 fi
554}
555
Luigi Semenzato1f82e122010-03-23 12:43:08 -0700556# Check that all arguments are flags; that is, there are no remaining arguments
557# after parsing from shflags. Allow (with a warning) a single empty-string
558# argument.
559#
560# TODO: fix buildbot so that it doesn't pass the empty-string parameter,
561# then change this function.
562#
563# Usage: check_flags_only_and_allow_null_arg "$@" && set --
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400564check_flags_only_and_allow_null_arg() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500565 local do_shift=1
566 if [[ $# -eq 1 ]] && [[ -z $1 ]]; then
Luigi Semenzato1f82e122010-03-23 12:43:08 -0700567 echo "$0: warning: ignoring null argument" >&2
568 shift
569 do_shift=0
570 fi
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500571 if [[ $# -gt 0 ]]; then
572 echo "error: invalid arguments: \"$*\"" >&2
Luigi Semenzato1f82e122010-03-23 12:43:08 -0700573 flags_help
574 exit 1
575 fi
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500576 return ${do_shift}
Luigi Semenzato1f82e122010-03-23 12:43:08 -0700577}
578
Chris Sosaaa1a7fd2010-04-02 14:06:29 -0700579# Removes single quotes around parameter
580# Arguments:
581# $1 - string which optionally has surrounding quotes
582# Returns:
583# None, but prints the string without quotes.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400584remove_quotes() {
Chris Sosaaa1a7fd2010-04-02 14:06:29 -0700585 echo "$1" | sed -e "s/^'//; s/'$//"
586}
tedbo373c3902010-04-12 10:52:40 -0700587
588# Writes stdin to the given file name as root using sudo in overwrite mode.
589#
590# $1 - The output file name.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400591sudo_clobber() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500592 sudo tee "$1" >/dev/null
tedbo373c3902010-04-12 10:52:40 -0700593}
594
595# Writes stdin to the given file name as root using sudo in append mode.
596#
597# $1 - The output file name.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400598sudo_append() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500599 sudo tee -a "$1" >/dev/null
tedbo373c3902010-04-12 10:52:40 -0700600}
robotboy98912212010-04-12 14:08:14 -0700601
Mike Frysinger286b5922011-09-28 11:59:53 -0400602# Execute multiple commands in a single sudo. Generally will speed things
603# up by avoiding multiple calls to `sudo`. If any commands fail, we will
604# call die with the failing command. We can handle a max of ~100 commands,
605# but hopefully no one will ever try that many at once.
606#
607# $@ - The commands to execute, one per arg.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400608sudo_multi() {
Mike Frysinger286b5922011-09-28 11:59:53 -0400609 local i cmds
610
611 # Construct the shell code to execute. It'll be of the form:
612 # ... && ( ( command ) || exit <command index> ) && ...
613 # This way we know which command exited. The exit status of
614 # the underlying command is lost, but we never cared about it
615 # in the first place (other than it is non zero), so oh well.
616 for (( i = 1; i <= $#; ++i )); do
617 cmds+=" && ( ( ${!i} ) || exit $(( i + 10 )) )"
618 done
619
620 # Execute our constructed shell code.
621 sudo -- sh -c ":${cmds[*]}" && i=0 || i=$?
622
623 # See if this failed, and if so, print out the failing command.
624 if [[ $i -gt 10 ]]; then
625 : $(( i -= 10 ))
626 die "sudo_multi failed: ${!i}"
627 elif [[ $i -ne 0 ]]; then
628 die "sudo_multi failed for unknown reason $i"
629 fi
630}
631
Chris Masonebbccc242014-02-08 16:23:53 -0800632# Clears out stale shadow-utils locks in the given target root.
633sudo_clear_shadow_locks() {
634 info "Clearing shadow utils lockfiles under $1"
635 sudo rm -f "$1/etc/"{passwd,group,shadow,gshadow}.lock*
636}
637
David James76764882012-10-24 19:46:29 -0700638# Writes stdin to the given file name as the sudo user in overwrite mode.
639#
640# $@ - The output file names.
641user_clobber() {
642 install -m644 -o ${SUDO_UID} -g ${SUDO_GID} /dev/stdin "$@"
643}
644
David James22dc2ba2012-11-29 15:46:58 -0800645# Copies the specified file owned by the user to the specified location.
646# If the copy fails as root (e.g. due to root_squash and NFS), retry the copy
647# with the user's account before failing.
648user_cp() {
649 cp -p "$@" 2>/dev/null || sudo -u ${SUDO_USER} -- cp -p "$@"
650}
651
David James76764882012-10-24 19:46:29 -0700652# Appends stdin to the given file name as the sudo user.
653#
654# $1 - The output file name.
655user_append() {
656 cat >> "$1"
657 chown ${SUDO_UID}:${SUDO_GID} "$1"
658}
659
660# Create the specified directory, along with parents, as the sudo user.
661#
662# $@ - The directories to create.
663user_mkdir() {
664 install -o ${SUDO_UID} -g ${SUDO_GID} -d "$@"
665}
666
667# Create the specified symlink as the sudo user.
668#
669# $1 - Link target
670# $2 - Link name
671user_symlink() {
672 ln -sfT "$1" "$2"
673 chown -h ${SUDO_UID}:${SUDO_GID} "$2"
674}
675
Mike Frysinger1aa61242011-09-15 17:46:44 -0400676# Locate all mounts below a specified directory.
677#
678# $1 - The root tree.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400679sub_mounts() {
Mike Frysinger1aa61242011-09-15 17:46:44 -0400680 # Assume that `mount` outputs a list of mount points in the order
681 # that things were mounted (since it always has and hopefully always
682 # will). As such, we have to unmount in reverse order to cleanly
683 # unmount submounts (think /dev/pts and /dev).
Alex Deymo7ba56be2015-02-12 14:28:06 -0800684 awk -v path="$1" -v len="${#1}" \
Zdenek Behan1d5d3b52012-05-01 01:58:48 +0200685 '(substr($2, 1, len) == path) { print $2 }' /proc/mounts | \
Zdenek Behan52970f42012-08-30 22:36:40 +0200686 tac | \
687 sed -e 's/\\040(deleted)$//'
688 # Hack(zbehan): If a bind mount's source is mysteriously removed,
689 # we'd end up with an orphaned mount with the above string in its name.
690 # It can only be seen through /proc/mounts and will stick around even
691 # when it should be gone already. crosbug.com/31250
Mike Frysinger1aa61242011-09-15 17:46:44 -0400692}
693
robotboy98912212010-04-12 14:08:14 -0700694# Unmounts a directory, if the unmount fails, warn, and then lazily unmount.
695#
696# $1 - The path to unmount.
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400697safe_umount_tree() {
Alex Deymo7ba56be2015-02-12 14:28:06 -0800698 local mount_point="$1"
robotboy98912212010-04-12 14:08:14 -0700699
Alex Deymo7ba56be2015-02-12 14:28:06 -0800700 local mounts=( $(sub_mounts "${mount_point}") )
701
702 # Silently return if the mount_point was already unmounted.
703 if [[ ${#mounts[@]} -eq 0 ]]; then
Mike Frysingere8aec372011-09-21 00:03:22 -0400704 return 0
705 fi
706
Mike Frysinger1aa61242011-09-15 17:46:44 -0400707 # First try to unmount in one shot to speed things up.
Alex Deymo7ba56be2015-02-12 14:28:06 -0800708 # Filter out the "filesystem was unmounted" messages to suppress failures to
709 # remove a loop device when the passed mount points are not loop devices. See
710 # crbug.com/458267 for details. Last "| cat" is to keep both exit codes.
711 LC_ALL=C safe_umount -d "${mounts[@]}" 2>&1 |
712 grep -v -F \
713 'filesystem was unmounted, but mount(8) failed: Invalid argument' |
714 cat
715 local umount_code="${PIPESTATUS[0]}"
716 local grep_code="${PIPESTATUS[1]}"
717 if [[ "${umount_code}" == "0" ]]; then
Mike Frysinger1aa61242011-09-15 17:46:44 -0400718 return 0
719 fi
robotboy98912212010-04-12 14:08:14 -0700720
Alex Deymo7ba56be2015-02-12 14:28:06 -0800721 # Check whether our mounts were successfully unmounted even if the umount
722 # command failed.
723 mounts=( $(sub_mounts "${mount_point}") )
724 if [[ ${#mounts[@]} -eq 0 ]]; then
725 # We only warn about the umount error code if there is there was an error
726 # printed in the output.
727 if [[ "${grep_code}" == "0" ]]; then
728 warn "umount failed (exit code ${umount_code}), but the tree was" \
729 "unmounted anyway. See umount errors above."
730 fi
David Jamesd9b67982012-10-26 09:46:50 -0700731 return 0
732 fi
733
734 # Well that didn't work, so lazy unmount remaining ones.
Alex Deymo7ba56be2015-02-12 14:28:06 -0800735 warn "Failed to unmount ${mounts[@]}, these are the processes using the" \
736 "mount points."
737 sudo fuser -vm "${mount_point}" || true
738
Mike Frysinger1aa61242011-09-15 17:46:44 -0400739 warn "Doing a lazy unmount"
Alex Deymo7ba56be2015-02-12 14:28:06 -0800740 if ! safe_umount -d -l "${mounts[@]}"; then
741 mounts=( $(sub_mounts "${mount_point}") )
742 die "Failed to lazily unmount ${mounts[@]}"
robotboy98912212010-04-12 14:08:14 -0700743 fi
744}
Chris Sosa702618f2010-05-14 12:52:32 -0700745
Brian Harringece65e02012-08-30 13:42:21 -0700746
David James76764882012-10-24 19:46:29 -0700747# Run umount as root.
Brian Harringece65e02012-08-30 13:42:21 -0700748safe_umount() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500749 $([[ ${UID:-$(id -u)} != 0 ]] && echo sudo) umount "$@"
Brian Harringece65e02012-08-30 13:42:21 -0700750}
751
Gabe Black6d261942014-10-04 02:30:46 -0700752# Sanity check the partition device nodes of a loopback device.
753#
754# $1 The loopback device to check.
755# $2 The backing file.
756loopback_check_parts() {
757 local dev="$1"
758 local image="$2"
759
760 local parts=$(shopt -s nullglob; echo "${dev}"p*)
761 local dev_name="${dev##/dev/}"
762
763 if [[ -z "${parts}" ]]; then
764 warn "No partition nodes found for ${dev}"
765 return 1
766 fi
767
768 # Check the start of all the partitions.
769 local part
770 for part in ${parts}; do
771 local pname="${part##/dev/}"
772 local pnum="${pname##*p}"
773 local cgpt_start sys_start
774
775 cgpt_start=$(cgpt show -n -i "${pnum}" -b "${image}")
776 sys_start=$(cat /sys/block/"${dev_name}"/"${pname}"/start)
777
778 if [[ ${cgpt_start} -ne ${sys_start} ]]; then
779 warn "Partition ${pnum} of ${image} starts at offset ${cgpt_start},"
780 warn "but the kernel thinks it starts at offset ${sys_start}."
781 return 1
782 fi
783 done
784
785 return 0
786}
787
Gabe Black0a68b202014-10-08 22:09:10 -0700788# Run a command with sudo in a way that still preferentially uses files
789# from au-generator.zip, but still finds things in /sbin and /usr/sbin when
790# not using au-generator.zip.
791au_generator_sudo() {
792 # When searching for env, the unmodified path is used and env is potentially
793 # found somewhere out in the system. env itself sees the modified PATH
794 # and will find the command where we're telling it to. Running the command
795 # directly without env will escape our constructed PATH.
796 sudo -E PATH="${PATH}:/sbin:/usr/sbin" env "$@"
797}
798
Gabe Blackfbdb1d52014-09-22 23:43:35 -0700799# Setup a loopback device for a file and scan for partitions, with retries.
800#
801# $1 - The file to back the new loopback device.
802# $2-$N - Additional arguments to pass to losetup.
803loopback_partscan() {
804 local lb_dev image="$1"
805 shift
Gabe Black0a68b202014-10-08 22:09:10 -0700806 lb_dev=$(au_generator_sudo losetup --show --partscan -f "$@" "${image}")
Gabe Blackfbdb1d52014-09-22 23:43:35 -0700807
808 # TODO Once we figure out why losetup -P doesn't always work
809 # (crbug.com/411693) we can get rid of this retry loop.
Gabe Black6dd099e2014-09-29 21:49:24 -0700810 local max_checks=11
Gabe Blackfbdb1d52014-09-22 23:43:35 -0700811 local i
812 for (( i = 1; i <= ${max_checks}; i++ )); do
813 # Did it work this time?
Gabe Black6d261942014-10-04 02:30:46 -0700814 if loopback_check_parts "${lb_dev}" "${image}"; then
Gabe Blackfbdb1d52014-09-22 23:43:35 -0700815 echo "${lb_dev}"
816 return 0
817 fi
818
819 if [[ ${i} -eq ${max_checks} ]]; then
820 # Scanning for partitions didn't work.
821 return 1
822 else
823 # warn should output to stderr, so it shouldn't pollute the output of
824 # this function.
Gabe Black6d261942014-10-04 02:30:46 -0700825 warn "Partition device files for ${image} are invalid on try ${i}. " \
Gabe Blackfbdb1d52014-09-22 23:43:35 -0700826 "Rescanning ${lb_dev}."
Gabe Black0a68b202014-10-08 22:09:10 -0700827 au_generator_sudo blockdev --rereadpt "${lb_dev}"
Gabe Blackfbdb1d52014-09-22 23:43:35 -0700828 sleep 5
829 fi
830 done
831}
832
833# Detach a loopback device set up earlier.
834#
835# $@ - loop device to detach, and additional arguments for losetup.
836loopback_detach() {
Gabe Black0a68b202014-10-08 22:09:10 -0700837 au_generator_sudo losetup --detach "$@"
Gabe Blackfbdb1d52014-09-22 23:43:35 -0700838}
839
Gabe Black067b3542014-09-23 01:15:14 -0700840# Get the size of a regular file or a block device.
841#
842# $1 - The regular file or block device to get the size of.
843bd_safe_size() {
844 local file="$1"
845 if [[ -b "${file}" ]]; then
846 sudo blockdev --getsize64 "${file}"
847 else
848 stat -c%s "${file}"
849 fi
850}
851
Matt Tennant298f61a2012-06-25 21:54:33 -0700852get_git_id() {
853 git var GIT_COMMITTER_IDENT | sed -e 's/^.*<\(\S\+\)>.*$/\1/'
854}
855
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500856# Fixes symlinks that are incorrectly prefixed with the build root $1
Chris Sosad4455022010-05-20 10:14:06 -0700857# rather than the real running root '/'.
858# TODO(sosa) - Merge setup - cleanup below with this method.
859fix_broken_symlinks() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500860 local build_root=$1
Chris Sosad4455022010-05-20 10:14:06 -0700861 local symlinks=$(find "${build_root}/usr/local" -lname "${build_root}/*")
Greg Spencer798d75f2011-02-01 22:04:49 -0800862 local symlink
Chris Sosad4455022010-05-20 10:14:06 -0700863 for symlink in ${symlinks}; do
864 echo "Fixing ${symlink}"
865 local target=$(ls -l "${symlink}" | cut -f 2 -d '>')
866 # Trim spaces from target (bashism).
867 target=${target/ /}
868 # Make new target (removes rootfs prefix).
869 new_target=$(echo ${target} | sed "s#${build_root}##")
870
871 echo "Fixing symlink ${symlink}"
872 sudo unlink "${symlink}"
873 sudo ln -sf "${new_target}" "${symlink}"
874 done
875}
876
Chris Sosa702618f2010-05-14 12:52:32 -0700877# Sets up symlinks for the developer root. It is necessary to symlink
878# usr and local since the developer root is mounted at /usr/local and
879# applications expect to be installed under /usr/local/bin, etc.
880# This avoids packages installing into /usr/local/usr/local/bin.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500881# $1 specifies the symlink target for the developer root.
882# $2 specifies the symlink target for the var directory.
883# $3 specifies the location of the stateful partition.
Chris Sosa702618f2010-05-14 12:52:32 -0700884setup_symlinks_on_root() {
885 # Give args better names.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500886 local dev_image_target=$1
887 local var_target=$2
888 local dev_image_root="$3/dev_image"
Chris Sosa702618f2010-05-14 12:52:32 -0700889
890 # If our var target is actually the standard var, we are cleaning up the
891 # symlinks (could also check for /usr/local for the dev_image_target).
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500892 if [[ ${var_target} == "/var" ]]; then
Chris Sosa702618f2010-05-14 12:52:32 -0700893 echo "Cleaning up /usr/local symlinks for ${dev_image_root}"
894 else
895 echo "Setting up symlinks for /usr/local for ${dev_image_root}"
896 fi
897
898 # Set up symlinks that should point to ${dev_image_target}.
Greg Spencer798d75f2011-02-01 22:04:49 -0800899 local path
Chris Sosa702618f2010-05-14 12:52:32 -0700900 for path in usr local; do
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500901 if [[ -h ${dev_image_root}/${path} ]]; then
Chris Sosa702618f2010-05-14 12:52:32 -0700902 sudo unlink "${dev_image_root}/${path}"
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500903 elif [[ -e ${dev_image_root}/${path} ]]; then
Chris Sosa702618f2010-05-14 12:52:32 -0700904 die "${dev_image_root}/${path} should be a symlink if exists"
905 fi
Mike Frysingera1a06ab2011-08-10 11:40:30 -0400906 sudo ln -s "${dev_image_target}" "${dev_image_root}/${path}"
Chris Sosa702618f2010-05-14 12:52:32 -0700907 done
908
909 # Setup var symlink.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500910 if [[ -h ${dev_image_root}/var ]]; then
Chris Sosa702618f2010-05-14 12:52:32 -0700911 sudo unlink "${dev_image_root}/var"
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500912 elif [[ -e ${dev_image_root}/var ]]; then
Chris Sosa702618f2010-05-14 12:52:32 -0700913 die "${dev_image_root}/var should be a symlink if it exists"
914 fi
915
916 sudo ln -s "${var_target}" "${dev_image_root}/var"
917}
Nick Sandersd2509272010-06-16 03:50:04 -0700918
Will Drewry55b42c92010-10-20 15:44:11 -0500919# These two helpers clobber the ro compat value in our root filesystem.
920#
921# When the system is built with --enable_rootfs_verification, bit-precise
922# integrity checking is performed. That precision poses a usability issue on
923# systems that automount partitions with recognizable filesystems, such as
924# ext2/3/4. When the filesystem is mounted 'rw', ext2 metadata will be
925# automatically updated even if no other writes are performed to the
926# filesystem. In addition, ext2+ does not support a "read-only" flag for a
927# given filesystem. That said, forward and backward compatibility of
928# filesystem features are supported by tracking if a new feature breaks r/w or
929# just write compatibility. We abuse the read-only compatibility flag[1] in
930# the filesystem header by setting the high order byte (le) to FF. This tells
931# the kernel that features R24-R31 are all enabled. Since those features are
932# undefined on all ext-based filesystem, all standard kernels will refuse to
933# mount the filesystem as read-write -- only read-only[2].
934#
935# [1] 32-bit flag we are modifying:
Aaron Gable5dde8482013-09-27 18:35:57 -0700936# https://chromium.googlesource.com/chromiumos/third_party/kernel.git/+/master/include/linux/ext2_fs.h#l417
Will Drewry55b42c92010-10-20 15:44:11 -0500937# [2] Mount behavior is enforced here:
Aaron Gable5dde8482013-09-27 18:35:57 -0700938# https://chromium.googlesource.com/chromiumos/third_party/kernel.git/+/master/ext2/super.c#l857
Will Drewry55b42c92010-10-20 15:44:11 -0500939#
940# N.B., if the high order feature bits are used in the future, we will need to
941# revisit this technique.
942disable_rw_mount() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500943 local rootfs=$1
Will Drewry55b42c92010-10-20 15:44:11 -0500944 local offset="${2-0}" # in bytes
Will Drewry9b7cb512010-10-20 18:11:24 -0500945 local ro_compat_offset=$((0x464 + 3)) # Set 'highest' byte
Alex Deymof6a527d2015-01-12 18:30:58 -0800946 is_ext_filesystem "${rootfs}" "${offset}" || return 0
Will Drewry9b7cb512010-10-20 18:11:24 -0500947 printf '\377' |
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500948 sudo dd of="${rootfs}" seek=$((offset + ro_compat_offset)) \
Will Drewry55b42c92010-10-20 15:44:11 -0500949 conv=notrunc count=1 bs=1
950}
951
952enable_rw_mount() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500953 local rootfs=$1
Will Drewry55b42c92010-10-20 15:44:11 -0500954 local offset="${2-0}"
Will Drewry9b7cb512010-10-20 18:11:24 -0500955 local ro_compat_offset=$((0x464 + 3)) # Set 'highest' byte
Alex Deymof6a527d2015-01-12 18:30:58 -0800956 is_ext_filesystem "${rootfs}" "${offset}" || return 0
Will Drewry9b7cb512010-10-20 18:11:24 -0500957 printf '\000' |
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500958 sudo dd of="${rootfs}" seek=$((offset + ro_compat_offset)) \
Will Drewry55b42c92010-10-20 15:44:11 -0500959 conv=notrunc count=1 bs=1
960}
961
Alex Deymof9235952015-01-15 11:15:09 -0800962# Returns whether the passed rootfs is an extended filesystem by checking the
Alex Deymof6a527d2015-01-12 18:30:58 -0800963# ext2 s_magic field in the superblock.
964is_ext_filesystem() {
965 local rootfs=$1
966 local offset="${2-0}"
967 local ext_magic_offset=$((0x400 + 56))
968 local ext_magic="$(sudo dd if="${rootfs}" \
969 skip=$((offset + ext_magic_offset)) bs=1 count=2 2>/dev/null |
970 hexdump -e '1/2 "%.4x"')"
971 test "${ext_magic}" = "ef53"
972}
973
Nick Sandersd2509272010-06-16 03:50:04 -0700974# Get current timestamp. Assumes common.sh runs at startup.
975start_time=$(date +%s)
976
Matt Tennant298f61a2012-06-25 21:54:33 -0700977# Get time elapsed since start_time in seconds.
978get_elapsed_seconds() {
Greg Spencer798d75f2011-02-01 22:04:49 -0800979 local end_time=$(date +%s)
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500980 local elapsed_seconds=$(( end_time - start_time ))
Matt Tennant298f61a2012-06-25 21:54:33 -0700981 echo ${elapsed_seconds}
982}
983
984# Print time elapsed since start_time.
985print_time_elapsed() {
986 # Optional first arg to specify elapsed_seconds. If not given, will
987 # recalculate elapsed time to now. Optional second arg to specify
988 # command name associated with elapsed time.
989 local elapsed_seconds=${1:-$(get_elapsed_seconds)}
990 local cmd_base=${2:-}
991
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500992 local minutes=$(( elapsed_seconds / 60 ))
993 local seconds=$(( elapsed_seconds % 60 ))
Matt Tennant298f61a2012-06-25 21:54:33 -0700994
Mike Frysingerbaae8eb2013-01-15 01:34:26 -0500995 if [[ -n ${cmd_base} ]]; then
Matt Tennant298f61a2012-06-25 21:54:33 -0700996 info "Elapsed time (${cmd_base}): ${minutes}m${seconds}s"
997 else
998 info "Elapsed time: ${minutes}m${seconds}s"
999 fi
1000}
1001
1002# Associative array for filling in extra command-specific stats before
1003# calling command_completed.
1004declare -A EXTRA_COMMAND_STATS
1005
1006# Save original command line.
1007command_line_arr=( "$0" "$@" )
1008
1009command_completed() {
1010 # Call print_elapsed_time regardless.
1011 local run_time=$(get_elapsed_seconds)
1012 local cmd_base=$(basename "${command_line_arr[0]}")
1013 print_time_elapsed ${run_time} ${cmd_base}
1014
Alex Deymof9235952015-01-15 11:15:09 -08001015 # Prepare command stats in an associative array. Additional command-specific
Matt Tennant298f61a2012-06-25 21:54:33 -07001016 # stats can be added through EXTRA_COMMAND_STATS associative array.
1017 declare -A stats
1018 stats=(
1019 [cmd_line]=${command_line_arr[*]}
1020 [cmd_base]=${cmd_base}
1021 [cmd_args]=${command_line_arr[*]:1}
1022 [run_time]=${run_time}
1023 [username]=$(get_git_id)
1024 [board]=${FLAGS_board}
1025 [host]=$(hostname -f)
1026 [cpu_count]=$(grep -c processor /proc/cpuinfo)
1027 [cpu_type]=$(uname -p)
1028 )
1029
1030 local attr
1031 for attr in "${!EXTRA_COMMAND_STATS[@]}"; do
1032 stats[${attr}]=${EXTRA_COMMAND_STATS[${attr}]}
1033 done
1034
1035 # Prepare temporary file for stats.
1036 local tmpfile=$(mktemp -t tmp.stats.XXXXXX)
1037 trap "rm -f '${tmpfile}'" EXIT
1038
1039 # Write stats out to temporary file.
1040 echo "Chromium OS Build Command Stats - Version 1" > "${tmpfile}"
1041 for attr in "${!stats[@]}"; do
1042 echo "${attr} ${stats[${attr}]}"
1043 done >> "${tmpfile}"
1044
1045 # Call upload_command_stats on the stats file. If it fails do not stop.
1046 "${GCLIENT_ROOT}"/chromite/bin/upload_command_stats "${tmpfile}" || true
1047
1048 rm "${tmpfile}"
1049 trap - EXIT
Nick Sandersd2509272010-06-16 03:50:04 -07001050}
Doug Anderson0c9e88d2010-10-19 14:49:39 -07001051
Anton Staaf9bcd8412011-01-24 15:27:14 -08001052# The board and variant command line options can be used in a number of ways
1053# to specify the board and variant. The board can encode both pieces of
1054# information separated by underscores. Or the variant can be passed using
1055# the separate variant option. This function extracts the canonical board and
1056# variant information and provides it in the BOARD, VARIANT and BOARD_VARIANT
1057# variables.
1058get_board_and_variant() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001059 local flags_board=$1
1060 local flags_variant=$2
Anton Staaf9bcd8412011-01-24 15:27:14 -08001061
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001062 BOARD=$(echo "${flags_board}" | cut -d '_' -f 1)
1063 VARIANT=${flags_variant:-$(echo "${flags_board}" | cut -s -d '_' -f 2)}
Anton Staaf9bcd8412011-01-24 15:27:14 -08001064
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001065 BOARD_VARIANT=${BOARD}
1066 if [[ -n ${VARIANT} ]]; then
1067 BOARD_VARIANT+="_${VARIANT}"
Anton Staaf9bcd8412011-01-24 15:27:14 -08001068 fi
1069}
Simon Glass142ca062011-02-09 13:39:43 -08001070
Albert Chaulk5d190f72013-07-12 11:42:18 -07001071# Load configuration files that allow board-specific overrides of default
1072# functionality to be specified in overlays.
1073# $1 - Board to match overlays to.
1074# $2 - File to load.
1075load_board_specific_script() {
1076 local board=$1 file=$2 overlay
1077 [[ $# -ne 2 ]] && die "load_board_specific_script requires exactly 2 params"
1078 for overlay in $(cros_list_overlays --board "${board}"); do
1079 local setup_sh="${overlay}/scripts/${file}"
1080 if [[ -e ${setup_sh} ]]; then
1081 source "${setup_sh}"
1082 fi
1083 done
1084}
1085
Anton Staaf6f5262d2011-03-02 09:35:54 -08001086# Check that the specified file exists. If the file path is empty or the file
1087# doesn't exist on the filesystem generate useful error messages. Otherwise
1088# show the user the name and path of the file that will be used. The padding
1089# parameter can be used to tabulate multiple name:path pairs. For example:
1090#
1091# check_for_file "really long name" "...:" "file.foo"
1092# check_for_file "short name" ".........:" "another.bar"
1093#
1094# Results in the following output:
1095#
1096# Using really long name...: file.foo
1097# Using short name.........: another.bar
1098#
1099# If tabulation is not required then passing "" for padding generates the
1100# output "Using <name> <path>"
1101check_for_file() {
1102 local name=$1
1103 local padding=$2
1104 local path=$3
1105
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001106 if [[ -z ${path} ]]; then
Anton Staaf6f5262d2011-03-02 09:35:54 -08001107 die "No ${name} file specified."
1108 fi
1109
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001110 if [[ ! -e ${path} ]]; then
Anton Staaf6f5262d2011-03-02 09:35:54 -08001111 die "No ${name} file found at: ${path}"
1112 else
1113 info "Using ${name}${padding} ${path}"
1114 fi
1115}
1116
1117# Check that the specified tool exists. If it does not exist in the PATH
1118# generate a useful error message indicating how to install the ebuild
1119# that contains the required tool.
1120check_for_tool() {
1121 local tool=$1
1122 local ebuild=$2
1123
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001124 if ! which "${tool}" >/dev/null; then
Anton Staaf6f5262d2011-03-02 09:35:54 -08001125 error "The ${tool} utility was not found in your path. Run the following"
1126 error "command in your chroot to install it: sudo -E emerge ${ebuild}"
1127 exit 1
1128 fi
1129}
Chris Sosafd2cdec2011-03-24 16:06:59 -07001130
1131# Reinterprets path from outside the chroot for use inside.
1132# Returns "" if "" given.
1133# $1 - The path to reinterpret.
Mike Frysinger6b1abb22012-05-11 13:44:06 -04001134reinterpret_path_for_chroot() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001135 if [[ ${INSIDE_CHROOT} -ne 1 ]]; then
1136 if [[ -z $1 ]]; then
Chris Sosafd2cdec2011-03-24 16:06:59 -07001137 echo ""
1138 else
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001139 local path_abs_path=$(readlink -f "$1")
Chris Sosafd2cdec2011-03-24 16:06:59 -07001140 local gclient_root_abs_path=$(readlink -f "${GCLIENT_ROOT}")
1141
1142 # Strip the repository root from the path.
1143 local relative_path=$(echo ${path_abs_path} \
Mike Frysingera1a06ab2011-08-10 11:40:30 -04001144 | sed "s:${gclient_root_abs_path}/::")
Chris Sosafd2cdec2011-03-24 16:06:59 -07001145
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001146 if [[ ${relative_path} == "${path_abs_path}" ]]; then
1147 die "Error reinterpreting path. Path $1 is not within source tree."
Chris Sosafd2cdec2011-03-24 16:06:59 -07001148 fi
1149
1150 # Prepend the chroot repository path.
Chris Sosaed2ff4b2013-08-30 12:58:41 -07001151 echo "/mnt/host/source/${relative_path}"
Chris Sosafd2cdec2011-03-24 16:06:59 -07001152 fi
1153 else
1154 # Path is already inside the chroot :).
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001155 echo "$1"
Chris Sosafd2cdec2011-03-24 16:06:59 -07001156 fi
1157}
Gabe Black83d8b822011-08-01 17:50:09 -07001158
Mike Frysinger6b1abb22012-05-11 13:44:06 -04001159emerge_custom_kernel() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001160 local install_root=$1
David Jamesdee866c2012-03-15 14:53:19 -07001161 local root=/build/${FLAGS_board}
David James0ea96e42011-08-03 11:53:50 -07001162 local tmp_pkgdir=${root}/custom-packages
1163
1164 # Clean up any leftover state in custom directories.
Mike Frysingera1a06ab2011-08-10 11:40:30 -04001165 sudo rm -rf "${tmp_pkgdir}"
David James0ea96e42011-08-03 11:53:50 -07001166
Aviv Keshet14373912014-06-27 14:34:06 +00001167 # Update chromeos-initramfs to contain the latest binaries from the build
1168 # tree. This is basically just packaging up already-built binaries from
1169 # ${root}. We are careful not to muck with the existing prebuilts so that
1170 # prebuilts can be uploaded in parallel.
1171 # TODO(davidjames): Implement ABI deps so that chromeos-initramfs will be
1172 # rebuilt automatically when its dependencies change.
1173 sudo -E PKGDIR="${tmp_pkgdir}" ${EMERGE_BOARD_CMD} -1 \
1174 chromeos-base/chromeos-initramfs || die "Cannot emerge chromeos-initramfs"
1175
David James0ea96e42011-08-03 11:53:50 -07001176 # Verify all dependencies of the kernel are installed. This should be a
1177 # no-op, but it's good to check in case a developer didn't run
Mike Frysinger0957a182012-03-21 23:17:14 -04001178 # build_packages. We need the expand_virtual call to workaround a bug
1179 # in portage where it only installs the virtual pkg.
1180 local kernel=$(portageq-${FLAGS_board} expand_virtual ${root} \
1181 virtual/linux-sources)
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001182 sudo -E PKGDIR="${tmp_pkgdir}" ${EMERGE_BOARD_CMD} --onlydeps \
David James0ea96e42011-08-03 11:53:50 -07001183 ${kernel} || die "Cannot emerge kernel dependencies"
1184
1185 # Build the kernel. This uses the standard root so that we can pick up the
1186 # initramfs from there. But we don't actually install the kernel to the
1187 # standard root, because that'll muck up the kernel debug symbols there,
1188 # which we want to upload in parallel.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001189 sudo -E PKGDIR="${tmp_pkgdir}" ${EMERGE_BOARD_CMD} --buildpkgonly \
David James0ea96e42011-08-03 11:53:50 -07001190 ${kernel} || die "Cannot emerge kernel"
1191
1192 # Install the custom kernel to the provided install root.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001193 sudo -E PKGDIR="${tmp_pkgdir}" ${EMERGE_BOARD_CMD} --usepkgonly \
David James0ea96e42011-08-03 11:53:50 -07001194 --root=${install_root} ${kernel} || die "Cannot emerge kernel to root"
1195}
Brian Harringfeb04f72012-02-03 21:22:50 -08001196
Mike Frysinger6b1abb22012-05-11 13:44:06 -04001197enable_strict_sudo() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001198 if [[ -z ${CROS_SUDO_KEEP_ALIVE} ]]; then
Brian Harringfeb04f72012-02-03 21:22:50 -08001199 echo "$0 was somehow invoked in a way that the sudo keep alive could"
1200 echo "not be found. Failing due to this. See crosbug.com/18393."
1201 exit 126
1202 fi
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001203 sudo() {
1204 $(type -P sudo) -n "$@"
Brian Harringfeb04f72012-02-03 21:22:50 -08001205 }
1206}
Gilad Arnold207a7c72012-02-09 10:19:16 -08001207
Chris Wolfe21a27b72012-02-27 13:00:51 -05001208# Checks that stdin and stderr are both terminals.
1209# If so, we assume that there is a live user we can interact with.
1210# This check can be overridden by setting the CROS_NO_PROMPT environment
1211# variable to a non-empty value.
Mike Frysinger6b1abb22012-05-11 13:44:06 -04001212is_interactive() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001213 [[ -z ${CROS_NO_PROMPT} && -t 0 && -t 2 ]]
Chris Wolfe21a27b72012-02-27 13:00:51 -05001214}
1215
Mike Frysinger6b1abb22012-05-11 13:44:06 -04001216assert_interactive() {
Chris Wolfe21a27b72012-02-27 13:00:51 -05001217 if ! is_interactive; then
1218 die "Script ${0##*/} tried to get user input on a non-interactive terminal."
1219 fi
1220}
1221
Gilad Arnold207a7c72012-02-09 10:19:16 -08001222# Selection menu with a default option: this is similar to bash's select
1223# built-in, only that in case of an empty selection it'll return the default
1224# choice. Like select, it uses PS3 as the prompt.
1225#
1226# $1: name of variable to be assigned the selected value; it better not be of
1227# the form choose_foo to avoid conflict with local variables.
1228# $2: default value to return in case of an empty user entry.
1229# $3: value to return in case of an invalid choice.
1230# $...: options for selection.
1231#
1232# Usage example:
1233#
1234# PS3="Select one [1]: "
1235# choose reply "foo" "ERROR" "foo" "bar" "foobar"
1236#
1237# This will present the following menu and prompt:
1238#
1239# 1) foo
1240# 2) bar
1241# 3) foobar
1242# Select one [1]:
1243#
1244# The return value will be stored in a variable named 'reply'. If the input is
1245# 1, 2 or 3, the return value will be "foo", "bar" or "foobar", respectively.
1246# If it is empty (i.e. the user clicked Enter) it will be "foo". Anything else
1247# will return "ERROR".
Mike Frysinger6b1abb22012-05-11 13:44:06 -04001248choose() {
Gilad Arnold207a7c72012-02-09 10:19:16 -08001249 typeset -i choose_i=1
1250
1251 # Retrieve output variable name and default return value.
1252 local choose_reply=$1
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001253 local choose_default=$2
1254 local choose_invalid=$3
Gilad Arnold207a7c72012-02-09 10:19:16 -08001255 shift 3
1256
1257 # Select a return value
1258 unset REPLY
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001259 if [[ $# -gt 0 ]]; then
Chris Wolfe21a27b72012-02-27 13:00:51 -05001260 assert_interactive
1261
Gilad Arnold207a7c72012-02-09 10:19:16 -08001262 # Actual options provided, present a menu and prompt for a choice.
1263 local choose_opt
1264 for choose_opt in "$@"; do
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001265 echo "${choose_i}) ${choose_opt}" >&2
1266 : $(( ++choose_i ))
Gilad Arnold207a7c72012-02-09 10:19:16 -08001267 done
1268 read -p "$PS3"
1269 fi
1270 # Filter out strings containing non-digits.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001271 if [[ ${REPLY} != "${REPLY%%[!0-9]*}" ]]; then
Gilad Arnold207a7c72012-02-09 10:19:16 -08001272 REPLY=0
1273 fi
1274 choose_i="${REPLY}"
1275
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001276 if [[ ${choose_i} -ge 1 && ${choose_i} -le $# ]]; then
Gilad Arnold207a7c72012-02-09 10:19:16 -08001277 # Valid choice, return the corresponding value.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001278 eval ${choose_reply}=\""${!choose_i}"\"
1279 elif [[ -z ${REPLY} ]]; then
Gilad Arnold207a7c72012-02-09 10:19:16 -08001280 # Empty choice, return default value.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001281 eval ${choose_reply}=\""${choose_default}"\"
Gilad Arnold207a7c72012-02-09 10:19:16 -08001282 else
1283 # Invalid choice, return corresponding value.
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001284 eval ${choose_reply}=\""${choose_invalid}\""
Gilad Arnold207a7c72012-02-09 10:19:16 -08001285 fi
1286}
David James855afb72012-03-14 20:04:59 -07001287
1288# Display --help if requested. This is used to hide options from help
1289# that are not intended for developer use.
1290#
1291# How to use:
1292# 1) Declare the options that you want to appear in help.
1293# 2) Call this function.
1294# 3) Declare the options that you don't want to appear in help.
1295#
1296# See build_packages for example usage.
Mike Frysinger6b1abb22012-05-11 13:44:06 -04001297show_help_if_requested() {
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001298 local opt
David James855afb72012-03-14 20:04:59 -07001299 for opt in "$@"; do
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001300 if [[ ${opt} == "-h" || ${opt} == "--help" ]]; then
David James855afb72012-03-14 20:04:59 -07001301 flags_help
1302 exit 0
1303 fi
1304 done
1305}
Brian Harring7f175a52012-03-02 05:37:00 -08001306
Mike Frysinger6b1abb22012-05-11 13:44:06 -04001307switch_to_strict_mode() {
Brian Harring7f175a52012-03-02 05:37:00 -08001308 # Set up strict execution mode; note that the trap
1309 # must follow switch_to_strict_mode, else it will have no effect.
1310 set -e
1311 trap 'die_err_trap "${BASH_COMMAND:-command unknown}" "$?"' ERR
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001312 if [[ $# -ne 0 ]]; then
Brian Harring7f175a52012-03-02 05:37:00 -08001313 set "$@"
1314 fi
1315}
1316
1317# TODO: Re-enable this once shflags is set -e safe.
1318#switch_to_strict_mode
Brian Harringf264b822012-09-01 01:39:03 -07001319
Kris Rambish44047912012-09-14 16:56:11 -07001320okboat() {
1321 # http://www.chris.com/ascii/index.php?art=transportation/nautical
1322 echo -e "${V_BOLD_GREEN}"
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001323 cat <<BOAT
Kris Rambish44047912012-09-14 16:56:11 -07001324 . o ..
1325 o . o o.o
1326 ...oo_
1327 _[__\___
1328 __|_o_o_o_o\__
1329 OK \' ' ' ' ' ' /
1330 ^^^^^^^^^^^^^^^^^^^^
1331BOAT
1332 echo -e "${V_VIDOFF}"
1333}
1334
1335failboat() {
1336 echo -e "${V_BOLD_RED}"
Mike Frysingerbaae8eb2013-01-15 01:34:26 -05001337 cat <<BOAT
Kris Rambish44047912012-09-14 16:56:11 -07001338 '
1339 ' )
1340 ) (
1341 ( .') __/\
1342 (. /o/` \
1343 __/o/` \
1344 FAIL / /o/` /
1345 ^^^^^^^^^^^^^^^^^^^^
1346BOAT
1347 echo -e "${V_VIDOFF}"
1348 die "$* failed"
1349}