blob: af7cd92a13858c7b513f7350aa1e767a06856c0a [file] [log] [blame]
David McMahon49302942010-02-18 16:55:35 -08001# Copyright (c) 2010 The Chromium OS Authors. All rights reserved.
rspangler@google.comd74220d2009-10-09 20:56:14 +00002# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
5# Common constants for build scripts
6# This must evaluate properly for both /bin/bash and /bin/sh
7
8# All scripts should die on error unless commands are specifically excepted
9# by prefixing with '!' or surrounded by 'set +e' / 'set -e'.
10# TODO: Re-enable this once shflags is less prone to dying.
11#set -e
12
13# The number of jobs to pass to tools that can run in parallel (such as make
14# and dpkg-buildpackage
Greg Spencer798d75f2011-02-01 22:04:49 -080015NUM_JOBS=$(grep -c "^processor" /proc/cpuinfo)
rspangler@google.comd74220d2009-10-09 20:56:14 +000016
Simon Glass142ca062011-02-09 13:39:43 -080017# True if we have the 'pv' utility - also set up COMMON_PV_CAT for convenience
18COMMON_PV_OK=1
19COMMON_PV_CAT=pv
20pv -V >/dev/null 2>&1 || COMMON_PV_OK=0
21if [ $COMMON_PV_OK -eq 0 ]; then
22 COMMON_PV_CAT=cat
23fi
24
Greg Spencer798d75f2011-02-01 22:04:49 -080025# Make sure we have the location and name of the calling script, using
26# the current value if it is already set.
27SCRIPT_LOCATION=${SCRIPT_LOCATION:-$(dirname "$(readlink -f "$0")")}
28SCRIPT_NAME=${SCRIPT_NAME:-$(basename "$0")}
rspangler@google.comd74220d2009-10-09 20:56:14 +000029
Anton Staaf30acb0b2011-01-26 16:00:20 -080030# Detect whether we're inside a chroot or not
31if [ -e /etc/debian_chroot ]
rspangler@google.comd74220d2009-10-09 20:56:14 +000032then
Anton Staaf30acb0b2011-01-26 16:00:20 -080033 INSIDE_CHROOT=1
rspangler@google.comd74220d2009-10-09 20:56:14 +000034else
Anton Staaf30acb0b2011-01-26 16:00:20 -080035 INSIDE_CHROOT=0
rspangler@google.comd74220d2009-10-09 20:56:14 +000036fi
37
Anton Staaf30acb0b2011-01-26 16:00:20 -080038# Construct a list of possible locations for the source tree. This list is
39# based on various environment variables and globals that may have been set
40# by the calling script.
41function get_gclient_root_list() {
42 if [ $INSIDE_CHROOT -eq 1 ]; then
43 echo "/home/${USER}/trunk"
44
45 if [ -n "${SUDO_USER}" ]; then echo "/home/${SUDO_USER}/trunk"; fi
46 fi
47
48 if [ -n "${COMMON_SH}" ]; then echo "$(dirname "$COMMON_SH")/../.."; fi
49 if [ -n "${BASH_SOURCE}" ]; then echo "$(dirname "$BASH_SOURCE")/../.."; fi
50}
51
52# Based on the list of possible source locations we set GCLIENT_ROOT if it is
53# not already defined by looking for a src directory in each seach path
54# location. If we do not find a valid looking root we error out.
55function get_gclient_root() {
56 if [ -n "${GCLIENT_ROOT}" ]; then
57 return
58 fi
59
60 for path in $(get_gclient_root_list); do
61 if [ -d "${path}/src" ]; then
62 GCLIENT_ROOT=${path}
63 break
64 fi
65 done
66
67 if [ -z "${GCLIENT_ROOT}" ]; then
68 # Using dash or sh, we don't know where we are. $0 refers to the calling
69 # script, not ourselves, so that doesn't help us.
70 echo "Unable to determine location for common.sh. If you are sourcing"
71 echo "common.sh from a script run via dash or sh, you must do it in the"
72 echo "following way:"
73 echo ' COMMON_SH="$(dirname "$0")/../../scripts/common.sh"'
74 echo ' . "$COMMON_SH"'
75 echo "where the first line is the relative path from your script to"
76 echo "common.sh."
77 exit 1
78 fi
79}
80
81# Find root of source tree
82get_gclient_root
83
rspangler@google.comd74220d2009-10-09 20:56:14 +000084# Canonicalize the directories for the root dir and the calling script.
85# readlink is part of coreutils and should be present even in a bare chroot.
tedbo4f44d9e2010-01-08 17:26:11 -080086# This is better than just using
rspangler@google.comd74220d2009-10-09 20:56:14 +000087# FOO = "$(cd $FOO ; pwd)"
tedbo4f44d9e2010-01-08 17:26:11 -080088# since that leaves symbolic links intact.
rspangler@google.comd74220d2009-10-09 20:56:14 +000089# Note that 'realpath' is equivalent to 'readlink -f'.
Greg Spencer798d75f2011-02-01 22:04:49 -080090SCRIPT_LOCATION=$(readlink -f $SCRIPT_LOCATION)
91GCLIENT_ROOT=$(readlink -f $GCLIENT_ROOT)
rspangler@google.comd74220d2009-10-09 20:56:14 +000092
93# Other directories should always be pathed down from GCLIENT_ROOT.
94SRC_ROOT="$GCLIENT_ROOT/src"
95SRC_INTERNAL="$GCLIENT_ROOT/src-internal"
96SCRIPTS_DIR="$SRC_ROOT/scripts"
97
98# Load developer's custom settings. Default location is in scripts dir,
99# since that's available both inside and outside the chroot. By convention,
100# settings from this file are variables starting with 'CHROMEOS_'
101CHROMEOS_DEV_SETTINGS="${CHROMEOS_DEV_SETTINGS:-$SCRIPTS_DIR/.chromeos_dev}"
Greg Spencer798d75f2011-02-01 22:04:49 -0800102if [ -f $CHROMEOS_DEV_SETTINGS ]; then
rspangler@google.comd74220d2009-10-09 20:56:14 +0000103 # Turn on exit-on-error during custom settings processing
Greg Spencer798d75f2011-02-01 22:04:49 -0800104 SAVE_OPTS=$(set +o)
rspangler@google.comd74220d2009-10-09 20:56:14 +0000105 set -e
106
107 # Read settings
108 . $CHROMEOS_DEV_SETTINGS
109
110 # Restore previous state of exit-on-error
111 eval "$SAVE_OPTS"
112fi
113
114# Load shflags
Anush Elangovan56de1dd2010-08-02 23:56:07 -0700115if [[ -f /usr/lib/shflags ]]; then
116 . /usr/lib/shflags
Raja Aluric6e23cd2010-11-02 15:55:57 -0700117elif [ -f ./lib/shflags/shflags ]; then
Greg Spencer798d75f2011-02-01 22:04:49 -0800118 . ./lib/shflags/shflags
Anush Elangovan56de1dd2010-08-02 23:56:07 -0700119else
120 . "${SRC_ROOT}/scripts/lib/shflags/shflags"
121fi
rspangler@google.comd74220d2009-10-09 20:56:14 +0000122
Bill Richardson10d27c22010-01-20 13:38:50 -0800123# Our local mirror
124DEFAULT_CHROMEOS_SERVER=${CHROMEOS_SERVER:-"http://build.chromium.org/mirror"}
rspangler@google.comd74220d2009-10-09 20:56:14 +0000125
Bill Richardson10d27c22010-01-20 13:38:50 -0800126# Upstream mirrors and build suites come in 2 flavors
127# DEV - development chroot, used to build the chromeos image
128# IMG - bootable image, to run on actual hardware
rspangler@google.comd74220d2009-10-09 20:56:14 +0000129
Bill Richardson10d27c22010-01-20 13:38:50 -0800130DEFAULT_DEV_MIRROR=${CHROMEOS_DEV_MIRROR:-"${DEFAULT_CHROMEOS_SERVER}/ubuntu"}
131DEFAULT_DEV_SUITE=${CHROMEOS_DEV_SUITE:-"karmic"}
132
133DEFAULT_IMG_MIRROR=${CHROMEOS_IMG_MIRROR:-"${DEFAULT_CHROMEOS_SERVER}/ubuntu"}
134DEFAULT_IMG_SUITE=${CHROMEOS_IMG_SUITE:-"karmic"}
rspangler@google.comd74220d2009-10-09 20:56:14 +0000135
136# Default location for chroot
137DEFAULT_CHROOT_DIR=${CHROMEOS_CHROOT_DIR:-"$GCLIENT_ROOT/chroot"}
138
139# All output files from build should go under $DEFAULT_BUILD_ROOT, so that
140# they don't pollute the source directory.
141DEFAULT_BUILD_ROOT=${CHROMEOS_BUILD_ROOT:-"$SRC_ROOT/build"}
142
David McMahon49302942010-02-18 16:55:35 -0800143# Set up a global ALL_BOARDS value
Raja Alurid44bcf92010-11-11 17:46:53 -0800144if [ -d $SRC_ROOT/overlays ]; then
145 ALL_BOARDS=$(cd $SRC_ROOT/overlays;ls -1d overlay-* 2>&-|sed 's,overlay-,,g')
David Rochberg3b910702010-12-02 10:45:21 -0500146fi
David McMahon49302942010-02-18 16:55:35 -0800147# Strip CR
148ALL_BOARDS=$(echo $ALL_BOARDS)
149# Set a default BOARD
150#DEFAULT_BOARD=x86-generic # or...
151DEFAULT_BOARD=$(echo $ALL_BOARDS | awk '{print $NF}')
152
David Jamesff072012010-11-30 13:22:05 -0800153# Enable --fast by default.
Greg Spencer798d75f2011-02-01 22:04:49 -0800154DEFAULT_FAST=${FLAGS_TRUE}
David James03668642010-07-28 17:08:29 -0700155
Simon Glass142ca062011-02-09 13:39:43 -0800156
157# Standard filenames
158CHROMEOS_IMAGE_NAME="chromiumos_image.bin"
159CHROMEOS_TEST_IMAGE_NAME="chromiumos_test_image.bin"
Chris Sosab885b802011-02-16 15:33:11 -0800160CHROMEOS_FACTORY_TEST_IMAGE_NAME="chromiumos_factory_image.bin"
Simon Glass142ca062011-02-09 13:39:43 -0800161
rspangler@google.comd74220d2009-10-09 20:56:14 +0000162# Directory locations inside the dev chroot
163CHROOT_TRUNK_DIR="/home/$USER/trunk"
164
Chris Sosaaa1a7fd2010-04-02 14:06:29 -0700165# Install make for portage ebuilds. Used by build_image and gmergefs.
Chris Masoned11ce172010-11-09 14:22:08 -0800166# TODO: Is /usr/local/autotest-chrome still used by anyone?
Daniel Erate82f07c2010-12-21 13:39:22 -0800167DEFAULT_INSTALL_MASK="
168 *.a
169 *.la
170 /etc/init.d
171 /etc/runlevels
172 /lib/rc
173 /usr/bin/Xnest
174 /usr/bin/Xvfb
175 /usr/include
176 /usr/lib/debug
177 /usr/lib/gcc
178 /usr/lib/gtk-2.0/include
179 /usr/lib/pkgconfig
180 /usr/local/autotest
181 /usr/local/autotest-chrome
182 /usr/man
183 /usr/share/aclocal
184 /usr/share/doc
185 /usr/share/gettext
186 /usr/share/gtk-2.0
187 /usr/share/gtk-doc
188 /usr/share/info
189 /usr/share/man
190 /usr/share/openrc
191 /usr/share/pkgconfig
192 /usr/share/readline
Chris Wolfed13775f2011-07-26 16:34:38 -0400193 /usr/src
Daniel Erate82f07c2010-12-21 13:39:22 -0800194 "
Chris Sosaaa1a7fd2010-04-02 14:06:29 -0700195
Daniel Erate82f07c2010-12-21 13:39:22 -0800196FACTORY_INSTALL_MASK="
197 /opt/Qualcomm
198 /opt/Synaptics
199 /opt/google/chrome
200 /opt/google/o3d
201 /opt/google/talkplugin
202 /opt/netscape
203 /usr/lib/debug
204 /usr/lib/dri
205 /usr/lib/python2.6/test
206 /usr/local/autotest
207 /usr/local/autotest-chrome
208 /usr/local/autotest-pkgs
209 /usr/share/X11
210 /usr/share/chewing
211 /usr/share/fonts
212 /usr/share/ibus-pinyin
213 /usr/share/libhangul
214 /usr/share/locale
215 /usr/share/m17n
216 /usr/share/mime
217 /usr/share/sounds
218 /usr/share/tts
219 /usr/share/zoneinfo
220 "
Tom Wai-Hong Tamf87a3672010-05-17 16:06:33 +0800221
Gaurav Shah786ceeb2011-07-26 15:03:37 -0700222# Determine and set up variables needed for fancy color output (if supported).
Gaurav Shah786ceeb2011-07-26 15:03:37 -0700223V_BOLD_RED=
224V_BOLD_GREEN=
225V_BOLD_YELLOW=
Mike Frysingerc2474ae2011-08-11 18:27:44 -0400226V_REVERSE=
227V_VIDOFF=
Gaurav Shah786ceeb2011-07-26 15:03:37 -0700228
229if tput colors >/dev/null 2>&1; then
Mike Frysingerc2474ae2011-08-11 18:27:44 -0400230 # order matters: we want VIDOFF last so that when we trace with `set -x`,
231 # our terminal doesn't bleed colors as bash dumps the values of vars.
Gaurav Shah786ceeb2011-07-26 15:03:37 -0700232 V_BOLD_RED="$(tput bold; tput setaf 1)"
233 V_BOLD_GREEN="$(tput bold; tput setaf 2)"
234 V_BOLD_YELLOW="$(tput bold; tput setaf 3)"
Mike Frysingerc2474ae2011-08-11 18:27:44 -0400235 V_REVERSE="$(tput rev)"
236 V_VIDOFF="$(tput sgr0)"
Gaurav Shah786ceeb2011-07-26 15:03:37 -0700237fi
David McMahonb7eb3a22010-02-09 14:07:40 -0800238
rspangler@google.comd74220d2009-10-09 20:56:14 +0000239# -----------------------------------------------------------------------------
240# Functions
241
Chris Sosaacada732010-02-23 15:20:03 -0800242function setup_board_warning {
tedbo373c3902010-04-12 10:52:40 -0700243 echo
244 echo "$V_REVERSE================= WARNING ======================$V_VIDOFF"
Chris Sosaacada732010-02-23 15:20:03 -0800245 echo
246 echo "*** No default board detected in " \
247 "$GCLIENT_ROOT/src/scripts/.default_board"
248 echo "*** Either run setup_board with default flag set"
249 echo "*** or echo |board_name| > $GCLIENT_ROOT/src/scripts/.default_board"
250 echo
251}
252
253
254# Sets the default board variable for calling script
255function get_default_board {
tedbo373c3902010-04-12 10:52:40 -0700256 DEFAULT_BOARD=
257
Chris Sosaacada732010-02-23 15:20:03 -0800258 if [ -f "$GCLIENT_ROOT/src/scripts/.default_board" ] ; then
Greg Spencer798d75f2011-02-01 22:04:49 -0800259 DEFAULT_BOARD=$(cat "$GCLIENT_ROOT/src/scripts/.default_board")
Chris Sosaacada732010-02-23 15:20:03 -0800260 fi
261}
262
263
Don Garrett640a0582010-05-04 16:54:28 -0700264# Enter a chroot and restart the current script if needed
265function restart_in_chroot_if_needed {
David Rochberg3b910702010-12-02 10:45:21 -0500266 # NB: Pass in ARGV: restart_in_chroot_if_needed "$@"
Greg Spencer798d75f2011-02-01 22:04:49 -0800267 if [ $INSIDE_CHROOT -ne 1 ]; then
Chris Sosafd2cdec2011-03-24 16:06:59 -0700268 # Get inside_chroot path for script.
269 local chroot_path="$(reinterpret_path_for_chroot "$0")"
Don Garrett640a0582010-05-04 16:54:28 -0700270 exec $SCRIPTS_DIR/enter_chroot.sh -- \
Chris Sosafd2cdec2011-03-24 16:06:59 -0700271 "$chroot_path" "$@"
Don Garrett640a0582010-05-04 16:54:28 -0700272 fi
273}
274
rspangler@google.comd74220d2009-10-09 20:56:14 +0000275# Fail unless we're inside the chroot. This guards against messing up your
276# workstation.
277function assert_inside_chroot {
Greg Spencer798d75f2011-02-01 22:04:49 -0800278 if [ $INSIDE_CHROOT -ne 1 ]; then
rspangler@google.comd74220d2009-10-09 20:56:14 +0000279 echo "This script must be run inside the chroot. Run this first:"
280 echo " $SCRIPTS_DIR/enter_chroot.sh"
281 exit 1
282 fi
283}
284
285# Fail if we're inside the chroot. This guards against creating or entering
286# nested chroots, among other potential problems.
287function assert_outside_chroot {
Greg Spencer798d75f2011-02-01 22:04:49 -0800288 if [ $INSIDE_CHROOT -ne 0 ]; then
rspangler@google.comd74220d2009-10-09 20:56:14 +0000289 echo "This script must be run outside the chroot."
290 exit 1
291 fi
292}
293
derat@google.com86dcc8e2009-11-21 19:49:49 +0000294function assert_not_root_user {
Greg Spencer798d75f2011-02-01 22:04:49 -0800295 if [ $(id -u) = 0 ]; then
derat@google.com86dcc8e2009-11-21 19:49:49 +0000296 echo "This script must be run as a non-root user."
297 exit 1
298 fi
299}
300
Luigi Semenzato1f82e122010-03-23 12:43:08 -0700301# Check that all arguments are flags; that is, there are no remaining arguments
302# after parsing from shflags. Allow (with a warning) a single empty-string
303# argument.
304#
305# TODO: fix buildbot so that it doesn't pass the empty-string parameter,
306# then change this function.
307#
308# Usage: check_flags_only_and_allow_null_arg "$@" && set --
309function check_flags_only_and_allow_null_arg {
310 do_shift=1
311 if [[ $# == 1 && -z "$@" ]]; then
312 echo "$0: warning: ignoring null argument" >&2
313 shift
314 do_shift=0
315 fi
316 if [[ $# -gt 0 ]]; then
317 echo "error: invalid arguments: \"$@\"" >&2
318 flags_help
319 exit 1
320 fi
321 return $do_shift
322}
323
Chris Sosad9798522010-06-16 14:29:50 -0700324function info {
Anton Staaf6adf1a32011-03-02 10:13:14 -0800325 echo -e >&2 "${V_BOLD_GREEN}INFO ${CROS_LOG_PREFIX:-""}: $1${V_VIDOFF}"
Will Drewry55b42c92010-10-20 15:44:11 -0500326}
Chris Sosad9798522010-06-16 14:29:50 -0700327
robotboy2ea03ac2010-02-11 15:30:55 -0800328function warn {
Anton Staaf6adf1a32011-03-02 10:13:14 -0800329 echo -e >&2 "${V_BOLD_YELLOW}WARNING ${CROS_LOG_PREFIX:-""}: $1${V_VIDOFF}"
robotboy2ea03ac2010-02-11 15:30:55 -0800330}
331
332function error {
Anton Staaf6adf1a32011-03-02 10:13:14 -0800333 echo -e >&2 "${V_BOLD_RED}ERROR ${CROS_LOG_PREFIX:-""}: $1${V_VIDOFF}"
robotboy2ea03ac2010-02-11 15:30:55 -0800334}
David James546747b2010-03-23 15:19:43 -0700335
336function die {
337 error "$1"
338 exit 1
339}
Chris Sosaaa1a7fd2010-04-02 14:06:29 -0700340
341# Retry an emerge command according to $FLAGS_retries
David Jamesfd7403a2010-07-09 12:00:17 -0700342# The $EMERGE_JOBS flags will only be added the first time the command is run
Chris Sosaaa1a7fd2010-04-02 14:06:29 -0700343function eretry () {
Greg Spencer798d75f2011-02-01 22:04:49 -0800344 local i
Chris Sosaaa1a7fd2010-04-02 14:06:29 -0700345 for i in $(seq $FLAGS_retries); do
Greg Spencer798d75f2011-02-01 22:04:49 -0800346 echo "Retrying $@"
347 "$@" $EMERGE_JOBS && return 0
Chris Sosaaa1a7fd2010-04-02 14:06:29 -0700348 done
Greg Spencer798d75f2011-02-01 22:04:49 -0800349 "$@" && return 0
Chris Sosaaa1a7fd2010-04-02 14:06:29 -0700350 return 1
351}
352
353# Removes single quotes around parameter
354# Arguments:
355# $1 - string which optionally has surrounding quotes
356# Returns:
357# None, but prints the string without quotes.
358function remove_quotes() {
359 echo "$1" | sed -e "s/^'//; s/'$//"
360}
tedbo373c3902010-04-12 10:52:40 -0700361
362# Writes stdin to the given file name as root using sudo in overwrite mode.
363#
364# $1 - The output file name.
365function sudo_clobber() {
366 sudo tee "$1" > /dev/null
367}
368
369# Writes stdin to the given file name as root using sudo in append mode.
370#
371# $1 - The output file name.
372function sudo_append() {
373 sudo tee -a "$1" > /dev/null
374}
robotboy98912212010-04-12 14:08:14 -0700375
376# Unmounts a directory, if the unmount fails, warn, and then lazily unmount.
377#
378# $1 - The path to unmount.
379function safe_umount {
380 path=${1:?}
381 shift
382
383 if ! sudo umount -d "${path}"; then
384 warn "Failed to unmount ${path}"
385 warn "Doing a lazy unmount"
386
387 sudo umount -d -l "${path}" || die "Failed to lazily unmount ${path}"
388 fi
389}
Chris Sosa702618f2010-05-14 12:52:32 -0700390
Chris Sosad4455022010-05-20 10:14:06 -0700391# Fixes symlinks that are incorrectly prefixed with the build root ${1}
392# rather than the real running root '/'.
393# TODO(sosa) - Merge setup - cleanup below with this method.
394fix_broken_symlinks() {
395 local build_root="${1}"
396 local symlinks=$(find "${build_root}/usr/local" -lname "${build_root}/*")
Greg Spencer798d75f2011-02-01 22:04:49 -0800397 local symlink
Chris Sosad4455022010-05-20 10:14:06 -0700398 for symlink in ${symlinks}; do
399 echo "Fixing ${symlink}"
400 local target=$(ls -l "${symlink}" | cut -f 2 -d '>')
401 # Trim spaces from target (bashism).
402 target=${target/ /}
403 # Make new target (removes rootfs prefix).
404 new_target=$(echo ${target} | sed "s#${build_root}##")
405
406 echo "Fixing symlink ${symlink}"
407 sudo unlink "${symlink}"
408 sudo ln -sf "${new_target}" "${symlink}"
409 done
410}
411
Chris Sosa702618f2010-05-14 12:52:32 -0700412# Sets up symlinks for the developer root. It is necessary to symlink
413# usr and local since the developer root is mounted at /usr/local and
414# applications expect to be installed under /usr/local/bin, etc.
415# This avoids packages installing into /usr/local/usr/local/bin.
416# ${1} specifies the symlink target for the developer root.
417# ${2} specifies the symlink target for the var directory.
418# ${3} specifies the location of the stateful partition.
419setup_symlinks_on_root() {
420 # Give args better names.
421 local dev_image_target=${1}
422 local var_target=${2}
423 local dev_image_root="${3}/dev_image"
424
425 # If our var target is actually the standard var, we are cleaning up the
426 # symlinks (could also check for /usr/local for the dev_image_target).
427 if [ ${var_target} = "/var" ]; then
428 echo "Cleaning up /usr/local symlinks for ${dev_image_root}"
429 else
430 echo "Setting up symlinks for /usr/local for ${dev_image_root}"
431 fi
432
433 # Set up symlinks that should point to ${dev_image_target}.
Greg Spencer798d75f2011-02-01 22:04:49 -0800434 local path
Chris Sosa702618f2010-05-14 12:52:32 -0700435 for path in usr local; do
436 if [ -h "${dev_image_root}/${path}" ]; then
437 sudo unlink "${dev_image_root}/${path}"
438 elif [ -e "${dev_image_root}/${path}" ]; then
439 die "${dev_image_root}/${path} should be a symlink if exists"
440 fi
441 sudo ln -s ${dev_image_target} "${dev_image_root}/${path}"
442 done
443
444 # Setup var symlink.
445 if [ -h "${dev_image_root}/var" ]; then
446 sudo unlink "${dev_image_root}/var"
447 elif [ -e "${dev_image_root}/var" ]; then
448 die "${dev_image_root}/var should be a symlink if it exists"
449 fi
450
451 sudo ln -s "${var_target}" "${dev_image_root}/var"
452}
Nick Sandersd2509272010-06-16 03:50:04 -0700453
Will Drewry55b42c92010-10-20 15:44:11 -0500454# These two helpers clobber the ro compat value in our root filesystem.
455#
456# When the system is built with --enable_rootfs_verification, bit-precise
457# integrity checking is performed. That precision poses a usability issue on
458# systems that automount partitions with recognizable filesystems, such as
459# ext2/3/4. When the filesystem is mounted 'rw', ext2 metadata will be
460# automatically updated even if no other writes are performed to the
461# filesystem. In addition, ext2+ does not support a "read-only" flag for a
462# given filesystem. That said, forward and backward compatibility of
463# filesystem features are supported by tracking if a new feature breaks r/w or
464# just write compatibility. We abuse the read-only compatibility flag[1] in
465# the filesystem header by setting the high order byte (le) to FF. This tells
466# the kernel that features R24-R31 are all enabled. Since those features are
467# undefined on all ext-based filesystem, all standard kernels will refuse to
468# mount the filesystem as read-write -- only read-only[2].
469#
470# [1] 32-bit flag we are modifying:
471# http://git.chromium.org/cgi-bin/gitweb.cgi?p=kernel.git;a=blob;f=include/linux/ext2_fs.h#l417
472# [2] Mount behavior is enforced here:
473# http://git.chromium.org/cgi-bin/gitweb.cgi?p=kernel.git;a=blob;f=fs/ext2/super.c#l857
474#
475# N.B., if the high order feature bits are used in the future, we will need to
476# revisit this technique.
477disable_rw_mount() {
478 local rootfs="$1"
479 local offset="${2-0}" # in bytes
Will Drewry9b7cb512010-10-20 18:11:24 -0500480 local ro_compat_offset=$((0x464 + 3)) # Set 'highest' byte
481 printf '\377' |
Will Drewry55b42c92010-10-20 15:44:11 -0500482 sudo dd of="$rootfs" seek=$((offset + ro_compat_offset)) \
483 conv=notrunc count=1 bs=1
484}
485
486enable_rw_mount() {
487 local rootfs="$1"
488 local offset="${2-0}"
Will Drewry9b7cb512010-10-20 18:11:24 -0500489 local ro_compat_offset=$((0x464 + 3)) # Set 'highest' byte
490 printf '\000' |
Will Drewry55b42c92010-10-20 15:44:11 -0500491 sudo dd of="$rootfs" seek=$((offset + ro_compat_offset)) \
492 conv=notrunc count=1 bs=1
493}
494
Nick Sandersd2509272010-06-16 03:50:04 -0700495# Get current timestamp. Assumes common.sh runs at startup.
496start_time=$(date +%s)
497
498# Print time elsapsed since start_time.
499print_time_elapsed() {
Greg Spencer798d75f2011-02-01 22:04:49 -0800500 local end_time=$(date +%s)
501 local elapsed_seconds=$(($end_time - $start_time))
502 local minutes=$(($elapsed_seconds / 60))
503 local seconds=$(($elapsed_seconds % 60))
Olof Johansson6d491382010-08-09 16:05:50 -0500504 echo "Elapsed time: ${minutes}m${seconds}s"
Nick Sandersd2509272010-06-16 03:50:04 -0700505}
Doug Anderson0c9e88d2010-10-19 14:49:39 -0700506
Anton Staaf9bcd8412011-01-24 15:27:14 -0800507# The board and variant command line options can be used in a number of ways
508# to specify the board and variant. The board can encode both pieces of
509# information separated by underscores. Or the variant can be passed using
510# the separate variant option. This function extracts the canonical board and
511# variant information and provides it in the BOARD, VARIANT and BOARD_VARIANT
512# variables.
513get_board_and_variant() {
514 local flags_board="${1}"
515 local flags_variant="${2}"
516
517 BOARD=$(echo "$flags_board" | cut -d '_' -f 1)
518 VARIANT=${flags_variant:-$(echo "$flags_board" | cut -s -d '_' -f 2)}
519
520 if [ -n "$VARIANT" ]; then
521 BOARD_VARIANT="${BOARD}_${VARIANT}"
522 else
523 BOARD_VARIANT="${BOARD}"
524 fi
525}
Simon Glass142ca062011-02-09 13:39:43 -0800526
527# This function converts a chromiumos image into a test image, either
528# in place or by copying to a new test image filename first. It honors
529# the following flags (see mod_image_for_test.sh)
530#
531# --factory
532# --factory_install
533# --force_copy
534#
535# On entry, pass the directory containing the image, and the image filename
536# On exit, it puts the pathname of the resulting test image into
537# CHROMEOS_RETURN_VAL
538# (yes this is ugly, but perhaps less ugly than the alternatives)
539#
540# Usage:
541# SRC_IMAGE=$(prepare_test_image "directory" "imagefile")
542prepare_test_image() {
543 # If we're asked to modify the image for test, then let's make a copy and
544 # modify that instead.
545 # Check for manufacturing image.
546 local args
547
548 if [ ${FLAGS_factory} -eq ${FLAGS_TRUE} ]; then
549 args="--factory"
550 fi
551
552 # Check for install shim.
553 if [ ${FLAGS_factory_install} -eq ${FLAGS_TRUE} ]; then
554 args="--factory_install"
555 fi
556
557 # Check for forcing copy of image
558 if [ ${FLAGS_force_copy} -eq ${FLAGS_TRUE} ]; then
559 args="${args} --force_copy"
560 fi
561
562 # Modify the image for test, creating a new test image
563 "${SCRIPTS_DIR}/mod_image_for_test.sh" --board=${FLAGS_board} \
564 --image="$1/$2" --noinplace ${args}
565
566 # From now on we use the just-created test image
Simon Glass6e448ae2011-03-03 11:20:54 -0800567 if [ ${FLAGS_factory} -eq ${FLAGS_TRUE} ]; then
568 CHROMEOS_RETURN_VAL="$1/${CHROMEOS_FACTORY_TEST_IMAGE_NAME}"
569 else
570 CHROMEOS_RETURN_VAL="$1/${CHROMEOS_TEST_IMAGE_NAME}"
571 fi
Simon Glass142ca062011-02-09 13:39:43 -0800572}
Anton Staaf6f5262d2011-03-02 09:35:54 -0800573
574# Check that the specified file exists. If the file path is empty or the file
575# doesn't exist on the filesystem generate useful error messages. Otherwise
576# show the user the name and path of the file that will be used. The padding
577# parameter can be used to tabulate multiple name:path pairs. For example:
578#
579# check_for_file "really long name" "...:" "file.foo"
580# check_for_file "short name" ".........:" "another.bar"
581#
582# Results in the following output:
583#
584# Using really long name...: file.foo
585# Using short name.........: another.bar
586#
587# If tabulation is not required then passing "" for padding generates the
588# output "Using <name> <path>"
589check_for_file() {
590 local name=$1
591 local padding=$2
592 local path=$3
593
594 if [ -z "${path}" ]; then
595 die "No ${name} file specified."
596 fi
597
598 if [ ! -e "${path}" ]; then
599 die "No ${name} file found at: ${path}"
600 else
601 info "Using ${name}${padding} ${path}"
602 fi
603}
604
605# Check that the specified tool exists. If it does not exist in the PATH
606# generate a useful error message indicating how to install the ebuild
607# that contains the required tool.
608check_for_tool() {
609 local tool=$1
610 local ebuild=$2
611
612 if ! which "${tool}" >/dev/null ; then
613 error "The ${tool} utility was not found in your path. Run the following"
614 error "command in your chroot to install it: sudo -E emerge ${ebuild}"
615 exit 1
616 fi
617}
Chris Sosafd2cdec2011-03-24 16:06:59 -0700618
619# Reinterprets path from outside the chroot for use inside.
620# Returns "" if "" given.
621# $1 - The path to reinterpret.
622function reinterpret_path_for_chroot() {
623 if [ $INSIDE_CHROOT -ne 1 ]; then
624 if [ -z "${1}" ]; then
625 echo ""
626 else
627 local path_abs_path=$(readlink -f "${1}")
628 local gclient_root_abs_path=$(readlink -f "${GCLIENT_ROOT}")
629
630 # Strip the repository root from the path.
631 local relative_path=$(echo ${path_abs_path} \
632 | sed s:${gclient_root_abs_path}/::)
633
634 if [ "${relative_path}" = "${path_abs_path}" ]; then
635 die "Error reinterpreting path. Path ${1} is not within source tree."
636 fi
637
638 # Prepend the chroot repository path.
639 echo "/home/${USER}/trunk/${relative_path}"
640 fi
641 else
642 # Path is already inside the chroot :).
643 echo "${1}"
644 fi
645}
Gabe Black83d8b822011-08-01 17:50:09 -0700646
647# Find a firmware component using one of a set of prefixes, or an override if
648# one is given.
649# The first argument is a list of path prefixes which are prepended to the
650# component name, relative to the current board's build directory.
651# The second argument is the name of the component to look for.
652# The third argument is an optional override. If it's a non-empty string, that
653# value is returned instead of searching. This makes it a little easier to
654# accept overrides in calling scripts.
655# The return value is the override if one is set, the first path at which a
656# component is found, or the last path searched if none is found. Later checks
657# in the calling scripts can identify that the file doesn't exist and handle
658# the error appropriately.
659function find_fw_component() {
660 local prefixes=$1
661 local component=$2
662 local override=$3
663 if [ ! -z "${override}" ]; then
664 echo "${override}"
665 exit 0
666 fi
667 local path=""
668 for prefix in ${prefixes}; do
669 path="/build/${BOARD_VARIANT}/${prefix}/${component}"
670 if [ -e "${path}" ]; then
671 break
672 fi
673 done
674 echo "${path}"
675}
676
677# A wrapper for find_fw_component which provides a set of prefixes which make
678# sense for u-boot.
679function find_u_boot_component () {
680 local component=$1
681 local override=$2
682 find_fw_component "firmware u-boot" "${component}" "${override}"
683}
684
685# A wrapper for find_fw_component which provides a set of prefixes which make
686# sense for coreboot.
687function find_coreboot_component () {
688 local component=$1
689 local override=$2
690 find_fw_component "firmware coreboot" "${component}" "${override}"
691}
David James0ea96e42011-08-03 11:53:50 -0700692
693function emerge_custom_kernel() {
694 local install_root="$1"
695 local root=${FLAGS_build_root}/${FLAGS_board}
696 local tmp_pkgdir=${root}/custom-packages
697
698 # Clean up any leftover state in custom directories.
699 sudo rm -rf ${tmp_pkgdir}
700
701 # Update chromeos-initramfs to contain the latest binaries from the build
702 # tree. This is basically just packaging up already-built binaries from
703 # $root. We are careful not to muck with the existing prebuilts so that
704 # prebuilts can be uploaded in parallel.
705 # TODO(davidjames): Implement ABI deps so that chromeos-initramfs will be
706 # rebuilt automatically when its dependencies change.
707 sudo -E PKGDIR=${tmp_pkgdir} $EMERGE_BOARD_CMD -1 \
708 chromeos-base/chromeos-initramfs || die "Cannot emerge chromeos-initramfs"
709
710 # Verify all dependencies of the kernel are installed. This should be a
711 # no-op, but it's good to check in case a developer didn't run
712 # build_packages.
713 local kernel=$(portageq-${FLAGS_board} expand_virtual ${root} virtual/kernel)
714 sudo -E PKGDIR=${tmp_pkgdir} $EMERGE_BOARD_CMD --onlydeps \
715 ${kernel} || die "Cannot emerge kernel dependencies"
716
717 # Build the kernel. This uses the standard root so that we can pick up the
718 # initramfs from there. But we don't actually install the kernel to the
719 # standard root, because that'll muck up the kernel debug symbols there,
720 # which we want to upload in parallel.
721 sudo -E PKGDIR=${tmp_pkgdir} $EMERGE_BOARD_CMD --buildpkgonly \
722 ${kernel} || die "Cannot emerge kernel"
723
724 # Install the custom kernel to the provided install root.
725 sudo -E PKGDIR=${tmp_pkgdir} $EMERGE_BOARD_CMD --usepkgonly \
726 --root=${install_root} ${kernel} || die "Cannot emerge kernel to root"
727}