blob: 27d19c2d78a95aacb6d81e8a4ac8721608a6b261 [file] [log] [blame]
rspangler@google.comd74220d2009-10-09 20:56:14 +00001#!/bin/bash
2
Darin Petkov47974d42011-03-03 15:55:04 -08003# Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
rspangler@google.comd74220d2009-10-09 20:56:14 +00004# Use of this source code is governed by a BSD-style license that can be
5# found in the LICENSE file.
6
7# Script to enter the chroot environment
8
J. Richard Barnette8e6750d2011-08-22 12:35:52 -07009SCRIPT_ROOT=$(readlink -f $(dirname "$0")/..)
10. "${SCRIPT_ROOT}/common.sh" || exit 1
rspangler@google.comd74220d2009-10-09 20:56:14 +000011
David James76764882012-10-24 19:46:29 -070012# Script must be run outside the chroot and as root.
rspangler@google.comd74220d2009-10-09 20:56:14 +000013assert_outside_chroot
David James76764882012-10-24 19:46:29 -070014assert_root_user
rspangler@google.comd74220d2009-10-09 20:56:14 +000015
16# Define command line flags
17# See http://code.google.com/p/shflags/wiki/Documentation10x
18DEFINE_string chroot "$DEFAULT_CHROOT_DIR" \
19 "The destination dir for the chroot environment." "d"
20DEFINE_string trunk "$GCLIENT_ROOT" \
21 "The source trunk to bind mount within the chroot." "s"
David McMahon03aeb202009-12-08 12:47:08 -080022DEFINE_string build_number "" \
23 "The build-bot build number (when called by buildbot only)." "b"
Andrew de los Reyes6d0ca162010-02-12 14:36:08 -080024DEFINE_string chrome_root "" \
25 "The root of your chrome browser source. Should contain a 'src' subdir."
David James76764882012-10-24 19:46:29 -070026DEFINE_string chrome_root_mount "/home/${SUDO_USER}/chrome_root" \
Sean Parent2898f752010-05-25 15:06:33 -070027 "The mount point of the chrome broswer source in the chroot."
Don Garrett63b47d32015-03-09 16:18:58 -070028DEFINE_string workspace_root "" \
29 "The root of your workspace."
Brian Harring7b6f3772012-09-23 14:01:13 -070030DEFINE_string cache_dir "" "Directory to use for caching."
Hidehiko Abe63d6c462017-03-02 17:40:54 +090031DEFINE_string goma_dir "" "Goma installed directory."
32DEFINE_string goma_client_json "" "Service account json file for goma."
rspangler@google.comd74220d2009-10-09 20:56:14 +000033
Elly Jones7990a062010-09-02 09:23:23 -040034DEFINE_boolean ssh_agent $FLAGS_TRUE "Import ssh agent."
Brian Harring35767822012-02-01 23:50:45 -080035DEFINE_boolean early_make_chroot $FLAGS_FALSE \
36 "Internal flag. If set, the command is run as root without sudo."
Don Garrettad3f0592011-02-04 14:59:56 -080037DEFINE_boolean verbose $FLAGS_FALSE "Print out actions taken"
rspangler@google.comd74220d2009-10-09 20:56:14 +000038
39# More useful help
Doug Anderson9362fa82010-12-16 14:44:12 -080040FLAGS_HELP="USAGE: $0 [flags] [VAR=value] [-- command [arg1] [arg2] ...]
rspangler@google.comd74220d2009-10-09 20:56:14 +000041
42One or more VAR=value pairs can be specified to export variables into
43the chroot environment. For example:
44
45 $0 FOO=bar BAZ=bel
46
Doug Anderson9362fa82010-12-16 14:44:12 -080047If [-- command] is present, runs the command inside the chroot,
David James76764882012-10-24 19:46:29 -070048after changing directory to /${SUDO_USER}/trunk/src/scripts. Note that neither
Doug Anderson9362fa82010-12-16 14:44:12 -080049the command nor args should include single quotes. For example:
rspangler@google.comd74220d2009-10-09 20:56:14 +000050
Doug Anderson9362fa82010-12-16 14:44:12 -080051 $0 -- ./build_platform_packages.sh
rspangler@google.comd74220d2009-10-09 20:56:14 +000052
53Otherwise, provides an interactive shell.
54"
55
Peter Mayo4411efe2012-09-21 04:41:27 -040056CROS_LOG_PREFIX=cros_sdk:enter_chroot
David James76764882012-10-24 19:46:29 -070057SUDO_HOME=$(eval echo ~${SUDO_USER})
Peter Mayo4411efe2012-09-21 04:41:27 -040058
Don Garrettad3f0592011-02-04 14:59:56 -080059# Version of info from common.sh that only echos if --verbose is set.
Mike Frysinger6b1abb22012-05-11 13:44:06 -040060debug() {
Don Garrettad3f0592011-02-04 14:59:56 -080061 if [ $FLAGS_verbose -eq $FLAGS_TRUE ]; then
David Rochberg351a76f2011-02-16 11:14:00 -050062 info "$*"
Don Garrettad3f0592011-02-04 14:59:56 -080063 fi
64}
65
rspangler@google.comd74220d2009-10-09 20:56:14 +000066# Parse command line flags
67FLAGS "$@" || exit 1
68eval set -- "${FLAGS_ARGV}"
69
Brian Harring7b6f3772012-09-23 14:01:13 -070070[ -z "${FLAGS_cache_dir}" ] && \
71 die "--cache_dir is required"
Brian Harring7ee892d2012-02-02 09:33:10 -080072
rspangler@google.comd74220d2009-10-09 20:56:14 +000073# Only now can we die on error. shflags functions leak non-zero error codes,
Brian Harring7f175a52012-03-02 05:37:00 -080074# so will die prematurely if 'switch_to_strict_mode' is specified before now.
rspangler@google.comd74220d2009-10-09 20:56:14 +000075# TODO: replace shflags with something less error-prone, or contribute a fix.
Brian Harring7f175a52012-03-02 05:37:00 -080076switch_to_strict_mode
rspangler@google.comd74220d2009-10-09 20:56:14 +000077
Matt Tennant298f61a2012-06-25 21:54:33 -070078# These config files are to be copied into chroot if they exist in home dir.
Prathmesh Prabhu74ebbbd2015-03-17 13:50:29 -070079# Additionally, git relevant files are copied by setup_git.
Matt Tennant298f61a2012-06-25 21:54:33 -070080FILES_TO_COPY_TO_CHROOT=(
81 .gdata_cred.txt # User/password for Google Docs on chromium.org
82 .gdata_token # Auth token for Google Docs on chromium.org
83 .disable_build_stats_upload # Presence of file disables command stats upload
Peter Mayo45ebc4c2013-01-28 15:49:06 -050084 .netrc # May contain required source fetching credentials
Matt Tennant298f61a2012-06-25 21:54:33 -070085)
86
Sean Parent2898f752010-05-25 15:06:33 -070087INNER_CHROME_ROOT=$FLAGS_chrome_root_mount # inside chroot
Andrew de los Reyes6d0ca162010-02-12 14:36:08 -080088CHROME_ROOT_CONFIG="/var/cache/chrome_root" # inside chroot
Chris Sosaaa1a7fd2010-04-02 14:06:29 -070089FUSE_DEVICE="/dev/fuse"
Andrew de los Reyes6d0ca162010-02-12 14:36:08 -080090
Mike Frysinger01c205d2013-03-22 00:59:58 -040091# We can't use /var/lock because that might be a symlink to /run/lock outside
92# of the chroot. Or /run on the host system might not exist.
93LOCKFILE="${FLAGS_chroot}/.enter_chroot.lock"
Mike Frysinger0a0e6ec2011-09-28 11:57:21 -040094MOUNTED_PATH=$(readlink -f "$FLAGS_chroot")
Mike Frysinger286b5922011-09-28 11:59:53 -040095
Brian Harring2499bfb2012-12-18 16:23:31 -080096# Reset the depot tools/internal trunk pathways to what they'll
97# be w/in the chroot.
98set_chroot_trunk_dir "${FLAGS_chroot}"
99
100
David James76764882012-10-24 19:46:29 -0700101setup_mount() {
David Rochberg351a76f2011-02-16 11:14:00 -0500102 # If necessary, mount $source in the host FS at $target inside the
David James76764882012-10-24 19:46:29 -0700103 # chroot directory with $mount_args. We don't write to /etc/mtab because
104 # these mounts are all contained within an unshare and are therefore
105 # inaccessible to other namespaces (e.g. the host desktop system).
David Rochberg351a76f2011-02-16 11:14:00 -0500106 local source="$1"
David James76764882012-10-24 19:46:29 -0700107 local mount_args="-n $2"
David Rochberg351a76f2011-02-16 11:14:00 -0500108 local target="$3"
109
Mike Frysinger0a0e6ec2011-09-28 11:57:21 -0400110 local mounted_path="${MOUNTED_PATH}$target"
David Rochberg351a76f2011-02-16 11:14:00 -0500111
Mike Frysinger9e5b0a42012-05-16 17:30:24 -0400112 case " ${MOUNT_CACHE} " in
113 *" ${mounted_path} "*)
Mike Frysinger2a970592011-09-20 22:49:01 -0400114 # Already mounted!
115 ;;
116 *)
Mike Frysingeradd99762014-03-27 13:17:58 -0400117 # If it doesn't exist, assume they want a dir. But don't blindly run
118 # it all the time in case they're trying to bind mount a file.
119 if [[ ! -e ${mounted_path} ]]; then
120 mkdir -p "${mounted_path}"
121 fi
Michael Krebs04c4f732012-09-07 18:31:46 -0700122 # The args are left unquoted on purpose.
123 if [[ -n ${source} ]]; then
David James76764882012-10-24 19:46:29 -0700124 mount ${mount_args} "${source}" "${mounted_path}"
Michael Krebs04c4f732012-09-07 18:31:46 -0700125 else
David James76764882012-10-24 19:46:29 -0700126 mount ${mount_args} "${mounted_path}"
Michael Krebs04c4f732012-09-07 18:31:46 -0700127 fi
Mike Frysinger2a970592011-09-20 22:49:01 -0400128 ;;
129 esac
David Rochberg351a76f2011-02-16 11:14:00 -0500130}
131
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400132copy_ssh_config() {
Vadim Bendebury0779f522011-06-12 12:09:16 -0700133 # Copy user .ssh/config into the chroot filtering out strings not supported
134 # by the chroot ssh. The chroot .ssh directory is passed in as the first
135 # parameter.
136
137 # ssh options to filter out. The entire strings containing these substrings
138 # will be deleted before copying.
139 local bad_options=(
Matt Tennant63c3cc52011-11-22 11:23:06 -0800140 'UseProxyIf'
141 'GSSAPIAuthentication'
142 'GSSAPIKeyExchange'
143 'ProxyUseFdpass'
Vadim Bendebury0779f522011-06-12 12:09:16 -0700144 )
David James76764882012-10-24 19:46:29 -0700145 local sshc="${SUDO_HOME}/.ssh/config"
Vadim Bendebury0779f522011-06-12 12:09:16 -0700146 local chroot_ssh_dir="${1}"
147 local filter
148 local option
149
David James22dc2ba2012-11-29 15:46:58 -0800150 if ! user_cp "${sshc}" "${chroot_ssh_dir}/config.orig" 2>/dev/null; then
Vadim Bendebury0779f522011-06-12 12:09:16 -0700151 return # Nothing to copy.
152 fi
153
154 for option in "${bad_options[@]}"
155 do
156 if [ -z "${filter}" ]; then
157 filter="${option}"
158 else
159 filter+="\\|${option}"
160 fi
161 done
162
David James22dc2ba2012-11-29 15:46:58 -0800163 sed "/^.*\(${filter}\).*$/d" "${chroot_ssh_dir}/config.orig" | \
David James76764882012-10-24 19:46:29 -0700164 user_clobber "${chroot_ssh_dir}/config"
Vadim Bendebury0779f522011-06-12 12:09:16 -0700165}
166
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400167copy_into_chroot_if_exists() {
Matt Tennantf7c9e772012-02-08 17:06:26 -0800168 # $1 is file path outside of chroot to copy to path $2 inside chroot.
Frank Henigman784e76c2013-08-30 10:30:12 -0400169 [ -e "$1" ] && user_cp -p "$1" "${FLAGS_chroot}/$2"
Matt Tennantf7c9e772012-02-08 17:06:26 -0800170}
171
Peter Mayo4411efe2012-09-21 04:41:27 -0400172# Usage: promote_api_keys
173# This takes care of getting the developer API keys into the chroot where
174# chrome can build with them. It needs to take it from the places a dev
175# is likely to put them, and recognize that older chroots may or may not
176# have been used since the concept of keys got added, as well as before
177# and after the developer decding to grab his own keys.
178promote_api_keys() {
David James76764882012-10-24 19:46:29 -0700179 local destination="${FLAGS_chroot}/home/${SUDO_USER}/.googleapikeys"
Peter Mayo4411efe2012-09-21 04:41:27 -0400180 # Don't disturb existing keys. They could be set differently
181 if [[ -s "${destination}" ]]; then
182 return 0
183 fi
David James76764882012-10-24 19:46:29 -0700184 if [[ -r "${SUDO_HOME}/.googleapikeys" ]]; then
185 cp -p "${SUDO_HOME}/.googleapikeys" "${destination}"
Peter Mayo4411efe2012-09-21 04:41:27 -0400186 if [[ -s "${destination}" ]] ; then
187 info "Copied Google API keys into chroot."
188 fi
David James76764882012-10-24 19:46:29 -0700189 elif [[ -r "${SUDO_HOME}/.gyp/include.gypi" ]]; then
Peter Mayo4411efe2012-09-21 04:41:27 -0400190 local NAME="('google_(api_key|default_client_(id|secret))')"
191 local WS="[[:space:]]*"
192 local CONTENTS="('[^\\\\']*')"
193 sed -nr -e "/^${WS}${NAME}${WS}[:=]${WS}${CONTENTS}.*/{s//\1: \4,/;p;}" \
David James76764882012-10-24 19:46:29 -0700194 "${SUDO_HOME}/.gyp/include.gypi" | user_clobber "${destination}"
Peter Mayo4411efe2012-09-21 04:41:27 -0400195 if [[ -s "${destination}" ]]; then
196 info "Put discovered Google API keys into chroot."
197 fi
198 fi
199}
200
Mike Frysinger4f2d5cc2013-06-09 23:34:52 -0400201generate_locales() {
202 # Make sure user's requested locales are available
203 # http://crosbug.com/19139
204 # And make sure en_US{,.UTF-8} are always available as
205 # that what buildbot forces internally
206 local l locales gen_locales=()
207
208 locales=$(printf '%s\n' en_US en_US.UTF-8 ${LANG} \
209 $LC_{ADDRESS,ALL,COLLATE,CTYPE,IDENTIFICATION,MEASUREMENT,MESSAGES} \
210 $LC_{MONETARY,NAME,NUMERIC,PAPER,TELEPHONE,TIME} | \
211 sort -u | sed '/^C$/d')
212 for l in ${locales}; do
213 if [[ ${l} == *.* ]]; then
214 enc=${l#*.}
215 else
216 enc="ISO-8859-1"
217 fi
218 case $(echo ${enc//-} | tr '[:upper:]' '[:lower:]') in
219 utf8) enc="UTF-8";;
220 esac
221 gen_locales+=("${l} ${enc}")
222 done
223 if [[ ${#gen_locales[@]} -gt 0 ]] ; then
224 # Force LC_ALL=C to workaround slow string parsing in bash
225 # with long multibyte strings. Newer setups have this fixed,
226 # but locale-gen doesn't need to be run in any locale in the
227 # first place, so just go with C to keep it fast.
228 chroot "${FLAGS_chroot}" env LC_ALL=C locale-gen -q -u \
229 -G "$(printf '%s\n' "${gen_locales[@]}")"
230 fi
231}
232
Prathmesh Prabhu74ebbbd2015-03-17 13:50:29 -0700233setup_git() {
234 # Copy .gitconfig into chroot so repo and git can be used from inside.
235 # This is required for repo to work since it validates the email address.
236 copy_into_chroot_if_exists "${SUDO_HOME}/.gitconfig" \
237 "/home/${SUDO_USER}/.gitconfig"
238 local -r chroot_gitconfig="${FLAGS_chroot}/home/${SUDO_USER}/.gitconfig"
239
240 # If the user didn't set up their username in their gitconfig, look
241 # at the default git settings for the user.
242 if ! git config -f "${chroot_gitconfig}" user.email >& /dev/null; then
243 local ident=$(cd /; sudo -u ${SUDO_USER} -- git var GIT_COMMITTER_IDENT || \
244 :)
245 local ident_name=${ident%% <*}
246 local ident_email=${ident%%>*}; ident_email=${ident_email##*<}
247 git config -f "${chroot_gitconfig}" --replace-all user.name \
248 "${ident_name}" || :
249 git config -f "${chroot_gitconfig}" --replace-all user.email \
250 "${ident_email}" || :
251 fi
252
253 # Copy the gitcookies file, updating the user's gitconfig to point to it.
254 local gitcookies
255 gitcookies="$(git config -f "${chroot_gitconfig}" --get http.cookiefile)"
256 if [[ $? -ne 0 ]]; then
257 # Try the default location anyway.
258 gitcookies="${SUDO_HOME}/.gitcookies"
259 fi
260 copy_into_chroot_if_exists "${gitcookies}" "/home/${SUDO_USER}/.gitcookies"
261 local -r chroot_gitcookies="${FLAGS_chroot}/home/${SUDO_USER}/.gitcookies"
262 if [[ -e "${chroot_gitcookies}" ]]; then
263 git config -f "${chroot_gitconfig}" --replace-all http.cookiefile \
264 "/home/${SUDO_USER}/.gitcookies"
265 fi
266 # This line must be at the end because using `git config` changes ownership of
267 # the .gitconfig.
268 chown ${SUDO_UID}:${SUDO_GID} "${chroot_gitconfig}"
269}
270
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400271setup_env() {
Andrew de los Reyesc9317ea2010-02-10 13:16:36 -0800272 (
273 flock 200
rspangler@google.comd74220d2009-10-09 20:56:14 +0000274
David James76764882012-10-24 19:46:29 -0700275 # Make the lockfile writable for backwards compatibility.
276 chown ${SUDO_UID}:${SUDO_GID} "${LOCKFILE}"
277
278 # Refresh /etc/resolv.conf and /etc/hosts in the chroot.
279 install -C -m644 /etc/resolv.conf ${FLAGS_chroot}/etc/resolv.conf
280 install -C -m644 /etc/hosts ${FLAGS_chroot}/etc/hosts
David James412b9022011-07-15 19:54:16 -0700281
Don Garretta0e7ea12011-02-07 18:39:59 -0800282 debug "Mounting chroot environment."
Steev Klimaszewskia10974c2013-11-30 20:38:34 -0600283 mount --make-rslave /
Mike Frysinger9e5b0a42012-05-16 17:30:24 -0400284 MOUNT_CACHE=$(echo $(awk '{print $2}' /proc/mounts))
David James76764882012-10-24 19:46:29 -0700285 setup_mount none "-t proc" /proc
286 setup_mount none "-t sysfs" /sys
Gaurav Shah365b7062013-12-03 18:12:58 -0800287 if grep -q binfmt_misc /proc/filesystems; then
288 setup_mount binfmt_misc "-t binfmt_misc" /proc/sys/fs/binfmt_misc
289 fi
Victor Dodonc34d4bc2016-05-09 12:09:21 -0700290 if grep -q configfs /proc/filesystems; then
291 setup_mount none "-t configfs" /sys/kernel/config
292 fi
David James76764882012-10-24 19:46:29 -0700293 setup_mount /dev "--bind" /dev
Mike Frysingere22afc72013-04-12 13:47:01 -0400294 setup_mount /dev/pts "--bind" /dev/pts
David James482fb292013-03-10 21:06:54 -0700295 if [[ -d /run ]]; then
David James76764882012-10-24 19:46:29 -0700296 setup_mount /run "--bind" /run
David James482fb292013-03-10 21:06:54 -0700297 if [[ -d /run/shm && ! -L /run/shm ]]; then
David James76764882012-10-24 19:46:29 -0700298 setup_mount /run/shm "--bind" /run/shm
Aaron Plattner130d3632011-10-18 08:54:57 -0700299 fi
300 fi
Brian Harring2499bfb2012-12-18 16:23:31 -0800301
Mike Frysinger4f2d5cc2013-06-09 23:34:52 -0400302 # Do this early as it's slow and only needs basic mounts (above).
303 generate_locales &
304
Michael Spang15144f42013-04-02 17:42:55 -0400305 setup_mount "${FLAGS_trunk}" "--rbind" "${CHROOT_TRUNK_DIR}"
Chris Sosa389634d2012-09-05 19:56:53 -0700306
Brian Harringdd7d7932011-12-23 04:21:33 -0800307 debug "Setting up referenced repositories if required."
308 REFERENCE_DIR=$(git config --file \
309 "${FLAGS_trunk}/.repo/manifests.git/config" \
310 repo.reference)
311 if [ -n "${REFERENCE_DIR}" ]; then
312
Brian Harring334050f2012-06-08 17:40:58 -0700313 ALTERNATES="${FLAGS_trunk}/.repo/alternates"
314
315 # Ensure this directory exists ourselves, and has the correct ownership.
David James76764882012-10-24 19:46:29 -0700316 user_mkdir "${ALTERNATES}"
Brian Harring334050f2012-06-08 17:40:58 -0700317
318 unset ALTERNATES
319
Brian Harringdd7d7932011-12-23 04:21:33 -0800320 IFS=$'\n';
David James76764882012-10-24 19:46:29 -0700321 required=( $( sudo -u "${SUDO_USER}" -- \
322 "${FLAGS_trunk}/chromite/lib/rewrite_git_alternates.py" \
Brian Harringdd7d7932011-12-23 04:21:33 -0800323 "${FLAGS_trunk}" "${REFERENCE_DIR}" "${CHROOT_TRUNK_DIR}" ) )
324 unset IFS
325
David James76764882012-10-24 19:46:29 -0700326 setup_mount "${FLAGS_trunk}/.repo/chroot/alternates" --bind \
Brian Harringdd7d7932011-12-23 04:21:33 -0800327 "${CHROOT_TRUNK_DIR}/.repo/alternates"
328
329 # Note that as we're bringing up each referened repo, we also
330 # mount bind an empty directory over its alternates. This is
331 # required to suppress git from tracing through it- we already
332 # specify the required alternates for CHROOT_TRUNK_DIR, no point
333 # in having git try recursing through each on their own.
334 #
335 # Finally note that if you're unfamiliar w/ chroot/vfs semantics,
336 # the bind is visible only w/in the chroot.
David James76764882012-10-24 19:46:29 -0700337 user_mkdir ${FLAGS_trunk}/.repo/chroot/empty
Brian Harringdd7d7932011-12-23 04:21:33 -0800338 position=1
339 for x in "${required[@]}"; do
340 base="${CHROOT_TRUNK_DIR}/.repo/chroot/external${position}"
David James76764882012-10-24 19:46:29 -0700341 setup_mount "${x}" "--bind" "${base}"
Brian Harringdd7d7932011-12-23 04:21:33 -0800342 if [ -e "${x}/.repo/alternates" ]; then
David James76764882012-10-24 19:46:29 -0700343 setup_mount "${FLAGS_trunk}/.repo/chroot/empty" "--bind" \
Brian Harringdd7d7932011-12-23 04:21:33 -0800344 "${base}/.repo/alternates"
345 fi
346 position=$(( ${position} + 1 ))
347 done
348 unset required position base
349 fi
350 unset REFERENCE_DIR
351
Brian Harring7b6f3772012-09-23 14:01:13 -0700352 chroot_cache='/var/cache/chromeos-cache'
353 debug "Setting up shared cache dir directory."
David James76764882012-10-24 19:46:29 -0700354 user_mkdir "${FLAGS_cache_dir}"/distfiles/{target,host}
355 user_mkdir "${FLAGS_chroot}/${chroot_cache}"
356 setup_mount "${FLAGS_cache_dir}" "--bind" "${chroot_cache}"
Brian Harring7b6f3772012-09-23 14:01:13 -0700357 # TODO(build): remove this as of 12/01/12.
358 # Because of how distfiles -> cache_dir was deployed, if this isn't
359 # a symlink, we *know* the ondisk pathways aren't compatible- thus
360 # fix it now.
361 distfiles_path="${FLAGS_chroot}/var/cache/distfiles"
362 if [ ! -L "${distfiles_path}" ]; then
363 # While we're at it, ensure the var is exported w/in the chroot; it
364 # won't exist if distfiles isn't a symlink.
Paul Drewsb688cbe2012-10-08 15:33:43 -0700365 p="${FLAGS_chroot}/etc/profile.d/chromeos-cachedir.sh"
David James76764882012-10-24 19:46:29 -0700366 rm -rf "${distfiles_path}"
367 ln -s chromeos-cache/distfiles "${distfiles_path}"
368 mkdir -p -m 775 "${p%/*}"
369 echo 'export CHROMEOS_CACHEDIR=${chroot_cache}' > "${p}"
370 chmod 0644 "${p}"
Brian Harring7b6f3772012-09-23 14:01:13 -0700371 fi
Brian Harring7ee892d2012-02-02 09:33:10 -0800372
Aviv Keshet97a35f42014-07-24 12:11:10 -0700373 if [ -d "${SUDO_HOME}/.cidb_creds" ]; then
374 setup_mount "${SUDO_HOME}/.cidb_creds" --bind \
375 "/home/${SUDO_USER}/.cidb_creds"
376 fi
377
Elly Jones7990a062010-09-02 09:23:23 -0400378 if [ $FLAGS_ssh_agent -eq $FLAGS_TRUE ]; then
David James76764882012-10-24 19:46:29 -0700379 if [ -n "${SSH_AUTH_SOCK}" -a -d "${SUDO_HOME}/.ssh" ]; then
Mike Frysingeradd99762014-03-27 13:17:58 -0400380 local target_ssh="/home/${SUDO_USER}/.ssh"
381 TARGET_DIR="${FLAGS_chroot}${target_ssh}"
David James76764882012-10-24 19:46:29 -0700382 user_mkdir "${TARGET_DIR}"
Mike Frysingeradd99762014-03-27 13:17:58 -0400383
384 local known_hosts="${SUDO_HOME}/.ssh/known_hosts"
385 if [[ -e ${known_hosts} ]]; then
386 truncate -s 0 "${TARGET_DIR}/known_hosts"
387 setup_mount "${known_hosts}" --bind "${target_ssh}/known_hosts"
388 fi
David James22dc2ba2012-11-29 15:46:58 -0800389 (
Mike Frysingeradd99762014-03-27 13:17:58 -0400390 # Only copy ~/.ssh/*.pub if they exist. Since we set
David James22dc2ba2012-11-29 15:46:58 -0800391 # nullglob, this needs to happen within a subshell.
392 shopt -s nullglob
Mike Frysingeradd99762014-03-27 13:17:58 -0400393 files=("${SUDO_HOME}"/.ssh/*.pub)
David James22dc2ba2012-11-29 15:46:58 -0800394 if [[ ${#files[@]} -gt 0 ]]; then
395 user_cp "${files[@]}" "${TARGET_DIR}/"
396 fi
397 )
Vadim Bendebury0779f522011-06-12 12:09:16 -0700398 copy_ssh_config "${TARGET_DIR}"
David James76764882012-10-24 19:46:29 -0700399 chown -R ${SUDO_UID}:${SUDO_GID} "${TARGET_DIR}"
Mike Frysinger9de707f2011-12-12 14:21:44 -0500400
Kevin Cernekeea1718392016-10-16 19:54:57 -0700401 if [ -S "${SSH_AUTH_SOCK}" ]; then
402 touch "${FLAGS_chroot}/tmp/ssh-auth-sock"
403 setup_mount "${SSH_AUTH_SOCK}" "--bind" "/tmp/ssh-auth-sock"
Mike Frysinger9de707f2011-12-12 14:21:44 -0500404 fi
Elly Jones7990a062010-09-02 09:23:23 -0400405 fi
406 fi
407
Marc MERLINfcd84ef2013-03-07 14:34:43 -0800408 if [[ -d "$SUDO_HOME/.subversion" ]]; then
David James76764882012-10-24 19:46:29 -0700409 TARGET="/home/${SUDO_USER}/.subversion"
David James76764882012-10-24 19:46:29 -0700410 setup_mount "${SUDO_HOME}/.subversion" "--bind" "${TARGET}"
Paul Drewsb4605b42012-10-11 23:10:43 -0700411 # Symbolic-link the .subversion directory so sandboxed subversion.class
412 # clients can use it.
Paul Drewsb4605b42012-10-11 23:10:43 -0700413 for d in \
David James76764882012-10-24 19:46:29 -0700414 "${FLAGS_cache_dir}"/distfiles/{host,target}/svn-src/"${SUDO_USER}"; do
Paul Drewsb4605b42012-10-11 23:10:43 -0700415 if [[ ! -L "${d}/.subversion" ]]; then
David James76764882012-10-24 19:46:29 -0700416 rm -rf "${d}/.subversion"
417 user_mkdir "${d}"
418 user_symlink /home/${SUDO_USER}/.subversion "${d}/.subversion"
Paul Drewsb4605b42012-10-11 23:10:43 -0700419 fi
420 done
Mike Frysinger286b5922011-09-28 11:59:53 -0400421 fi
422
David James76764882012-10-24 19:46:29 -0700423 # A reference to the DEPOT_TOOLS path may be passed in by cros_sdk.
424 if [ -n "${DEPOT_TOOLS}" ]; then
Mike Frysinger286b5922011-09-28 11:59:53 -0400425 debug "Mounting depot_tools"
Brian Harring2499bfb2012-12-18 16:23:31 -0800426 setup_mount "${DEPOT_TOOLS}" --bind "${DEPOT_TOOLS_DIR}"
Mike Frysinger286b5922011-09-28 11:59:53 -0400427 fi
428
Don Garrett63b47d32015-03-09 16:18:58 -0700429 if [ -n "${FLAGS_workspace_root}" ]; then
430 debug "Mounting workspace"
431 setup_mount "${FLAGS_workspace_root}" --bind "${WORKSPACE_DIR}"
432 fi
433
Hidehiko Abe63d6c462017-03-02 17:40:54 +0900434 if [[ -n "${FLAGS_goma_dir}" ]]; then
435 debug "Mounting goma"
436 # $HOME/goma is the default directory for goma.
437 # It is used by goma if GOMA_DIR is not provide.
438 setup_mount "${FLAGS_goma_dir}" --bind "/home/${SUDO_USER}/goma"
439 fi
440
441 if [[ -n "${FLAGS_goma_client_json}" ]]; then
442 debug "Mounting service-account-goma-client.json"
443 local dest_path="/creds/service_accounts/service-account-goma-client.json"
444 # setup_mount assumes the target is a directory by default.
445 # So here, touch the file in advance.
446 local mounted_path="${MOUNTED_PATH}${dest_path}"
Hidehiko Abe053a1992017-03-07 16:44:18 +0900447 mkdir -p "$(dirname "${mounted_path}")"
Hidehiko Abe63d6c462017-03-02 17:40:54 +0900448 touch "${mounted_path}"
Hidehiko Abe053a1992017-03-07 16:44:18 +0900449 # Note: Original UID:GID and permission should be inherited even after
Hidehiko Abe63d6c462017-03-02 17:40:54 +0900450 # mounting.
451 setup_mount "${FLAGS_goma_client_json}" --bind "${dest_path}"
452 fi
453
Michael Krebs04c4f732012-09-07 18:31:46 -0700454 # Mount additional directories as specified in .local_mounts file.
455 local local_mounts="${FLAGS_trunk}/src/scripts/.local_mounts"
456 if [[ -f ${local_mounts} ]]; then
Gaurav Shahe3cffca2013-11-26 14:45:10 -0800457 info "Mounting local folders"
Michael Krebs04c4f732012-09-07 18:31:46 -0700458 # format: mount_source
459 # or mount_source mount_point
460 # or # comments
461 local mount_source mount_point
462 while read mount_source mount_point; do
463 if [[ -z ${mount_source} ]]; then
464 continue
465 fi
466 # if only source is assigned, use source as mount point.
467 : ${mount_point:=${mount_source}}
468 debug " mounting ${mount_source} on ${mount_point}"
David James76764882012-10-24 19:46:29 -0700469 setup_mount "${mount_source}" "--bind" "${mount_point}"
Michael Krebs04c4f732012-09-07 18:31:46 -0700470 done < <(sed -e 's:#.*::' "${local_mounts}")
471 fi
472
Mike Frysinger9a50b642011-09-20 23:37:14 -0400473 CHROME_ROOT="$(readlink -f "$FLAGS_chrome_root" || :)"
474 if [ -z "$CHROME_ROOT" ]; then
475 CHROME_ROOT="$(cat "${FLAGS_chroot}${CHROME_ROOT_CONFIG}" \
476 2>/dev/null || :)"
477 CHROME_ROOT_AUTO=1
478 fi
479 if [[ -n "$CHROME_ROOT" ]]; then
480 if [[ ! -d "${CHROME_ROOT}/src" ]]; then
Mike Frysinger9d73a852013-12-02 19:47:08 -0500481 error "Not mounting chrome source: could not find CHROME_ROOT/src dir."
482 error "Full path we tried: ${CHROME_ROOT}/src"
David James76764882012-10-24 19:46:29 -0700483 rm -f "${FLAGS_chroot}${CHROME_ROOT_CONFIG}"
Mike Frysinger9a50b642011-09-20 23:37:14 -0400484 if [[ ! "$CHROME_ROOT_AUTO" ]]; then
485 exit 1
Don Garretta0e7ea12011-02-07 18:39:59 -0800486 fi
Mike Frysinger9a50b642011-09-20 23:37:14 -0400487 else
488 debug "Mounting chrome source at: $INNER_CHROME_ROOT"
David James76764882012-10-24 19:46:29 -0700489 echo $CHROME_ROOT > "${FLAGS_chroot}${CHROME_ROOT_CONFIG}"
490 setup_mount "$CHROME_ROOT" --bind "$INNER_CHROME_ROOT"
Andrew de los Reyes6d0ca162010-02-12 14:36:08 -0800491 fi
492 fi
Andrew de los Reyes5d0248f2010-02-12 16:12:31 -0800493
Mike Frysingeracc4c9b2011-09-15 18:06:25 -0400494 # Install fuse module. Skip modprobe when possible for slight
495 # speed increase when initializing the env.
496 if [ -c "${FUSE_DEVICE}" ] && ! grep -q fuse /proc/filesystems; then
David James76764882012-10-24 19:46:29 -0700497 modprobe fuse 2> /dev/null ||\
Sean Ocd8b1d12010-09-02 17:34:49 +0200498 warn "-- Note: modprobe fuse failed. gmergefs will not work"
Chris Sosa317d8eb2010-04-05 15:45:28 -0700499 fi
500
Mike Frysinger926a4b92012-06-27 15:22:28 -0400501 # Fix permissions on ccache tree. If this is a fresh chroot, then they
502 # might not be set up yet. Or if the user manually `rm -rf`-ed things,
503 # we need to reset it. Otherwise, gcc itself takes care of fixing things
504 # on demand, but only when it updates.
505 ccache_dir="${FLAGS_chroot}/var/cache/distfiles/ccache"
506 if [[ ! -d ${ccache_dir} ]]; then
David James76764882012-10-24 19:46:29 -0700507 mkdir -p -m 2775 "${ccache_dir}"
Mike Frysinger926a4b92012-06-27 15:22:28 -0400508 fi
Mike Frysingerba609912015-05-20 00:44:25 -0400509 (
510 find -H "${ccache_dir}" '(' -type d -a '!' -perm 2775 ')' \
511 -exec chmod 2775 {} +
512 find -H "${ccache_dir}" -gid 0 -exec chgrp 250 {} +
513 # These settings are kept in sync with the gcc ebuild.
514 chroot "${FLAGS_chroot}" env CCACHE_DIR=/var/cache/distfiles/ccache \
515 CCACHE_UMASK=002 ccache -F 0 -M 11G >/dev/null
516 ) &
David James342f1562011-07-15 15:21:18 -0700517
Matt Tennant298f61a2012-06-25 21:54:33 -0700518 # Certain files get copied into the chroot when entering.
519 for fn in "${FILES_TO_COPY_TO_CHROOT[@]}"; do
David James76764882012-10-24 19:46:29 -0700520 copy_into_chroot_if_exists "${SUDO_HOME}/${fn}" "/home/${SUDO_USER}/${fn}"
Matt Tennantf7c9e772012-02-08 17:06:26 -0800521 done
Prathmesh Prabhu74ebbbd2015-03-17 13:50:29 -0700522 setup_git
Peter Mayo4411efe2012-09-21 04:41:27 -0400523 promote_api_keys
Matt Tennantd4316fe2011-08-30 12:06:42 -0700524
Dale Curtis98631732011-05-05 16:16:59 -0700525 # Fix permissions on shared memory to allow non-root users access to POSIX
Josh McSavaney8477dad2016-04-05 13:43:26 -0700526 # semaphores. Take special care to only change the permissions on the
527 # directory and not all of its contents.
528 chmod 1777 "${FLAGS_chroot}/dev/shm"
Chris Wolfe916b1f12012-04-30 16:03:06 -0400529
Yu-Ju Hong22278a22014-01-16 12:46:53 -0800530 # gsutil uses boto config to store settings and credentials. Copy
531 # user's own boto file into the chroot if it exists. Also copy it
532 # to /root for sudoed invocations.
533 chroot_user_boto="${FLAGS_chroot}/home/${SUDO_USER}/.boto"
534 chroot_root_boto="${FLAGS_chroot}/root/.boto"
535 if [ -f ${SUDO_HOME}/.boto ]; then
536 # Pass --remote-destination to overwrite a symlink.
537 user_cp "--remove-destination" "${SUDO_HOME}/.boto" "$chroot_user_boto"
Frank Henigman696ce082014-03-27 21:21:55 -0400538 cp "--remove-destination" "$chroot_user_boto" "$chroot_root_boto"
David Rileyb6e9d862016-02-25 16:58:02 -0800539 elif [ -f "/etc/boto.cfg" ]; then
540 # For GCE instances, the non-chroot .boto file is not deployed so
541 # use the system /etc/boto.cfg if it exists.
542 user_cp "--remove-destination" "/etc/boto.cfg" "$chroot_user_boto"
543 cp "--remove-destination" "$chroot_user_boto" "$chroot_root_boto"
Yu-Ju Hong22278a22014-01-16 12:46:53 -0800544 fi
545
546 # If user doesn't have a boto file, check if the private overlays
547 # are installed and use those credentials.
Gilad Arnold264f64d2012-09-06 14:01:45 -0700548 boto='src/private-overlays/chromeos-overlay/googlestorage_account.boto'
549 if [ -s "${FLAGS_trunk}/${boto}" ]; then
Yu-Ju Hong22278a22014-01-16 12:46:53 -0800550 if [ ! -e "$chroot_user_boto" ]; then
551 user_symlink "trunk/${boto}" "$chroot_user_boto"
Chris Wolfe916b1f12012-04-30 16:03:06 -0400552 fi
Yu-Ju Hong22278a22014-01-16 12:46:53 -0800553 if [ ! -e "$chroot_root_boto" ]; then
554 ln -sf "${CHROOT_TRUNK_DIR}/${boto}" "$chroot_root_boto"
Gilad Arnold264f64d2012-09-06 14:01:45 -0700555 fi
Chris Wolfe916b1f12012-04-30 16:03:06 -0400556 fi
557
558 # Have found a few chroots where ~/.gsutil is owned by root:root, probably
559 # as a result of old gsutil or tools. This causes permission errors when
560 # gsutil cp tries to create its cache files, so ensure the user can
561 # actually write to their directory.
David James76764882012-10-24 19:46:29 -0700562 gsutil_dir="${FLAGS_chroot}/home/${SUDO_USER}/.gsutil"
563 if [ -d "${gsutil_dir}" ]; then
564 chown -R ${SUDO_UID}:${SUDO_GID} "${gsutil_dir}"
Chris Wolfe916b1f12012-04-30 16:03:06 -0400565 fi
David James546747b2010-03-23 15:19:43 -0700566 ) 200>>"$LOCKFILE" || die "setup_env failed"
rspangler@google.comd74220d2009-10-09 20:56:14 +0000567}
568
rspangler@google.comd74220d2009-10-09 20:56:14 +0000569setup_env
570
Brian Harring35767822012-02-01 23:50:45 -0800571CHROOT_PASSTHRU=(
572 "BUILDBOT_BUILD=$FLAGS_build_number"
Brian Harring35767822012-02-01 23:50:45 -0800573 "CHROMEOS_RELEASE_APPID=${CHROMEOS_RELEASE_APPID:-{DEV-BUILD}}"
Brian Harring35767822012-02-01 23:50:45 -0800574 "EXTERNAL_TRUNK_PATH=${FLAGS_trunk}"
Brian Harring35767822012-02-01 23:50:45 -0800575)
Liam McLoughlin3b11b452011-03-14 16:04:07 -0700576
Josh Triplettd6a13bf2014-06-13 15:36:52 -0700577# Translate C.UTF-8 into something we support. Remove this when our glibc
578# starts supporting C.UTF-8. https://bugzilla.redhat.com/show_bug.cgi?id=902094
579for var in LANG \
580 LC_{ADDRESS,ALL,COLLATE,CTYPE,IDENTIFICATION,MEASUREMENT,MESSAGES} \
581 LC_{MONETARY,NAME,NUMERIC,PAPER,TELEPHONE,TIME}; do
582 if [[ ${!var} =~ C\.[Uu][Tt][Ff]-?8 ]]; then
583 if [[ ${var} == LC_COLLATE ]]; then
584 export LC_COLLATE=C
585 else
586 export ${var}=en_US.UTF-8
587 fi
588 fi
589done
590
Kevin Cernekeea1718392016-10-16 19:54:57 -0700591# Needs to be set here because setup_env runs in a subshell.
592[ -S "${FLAGS_chroot}/tmp/ssh-auth-sock" ] && SSH_AUTH_SOCK=/tmp/ssh-auth-sock
593
David James76764882012-10-24 19:46:29 -0700594# Add the whitelisted environment variables to CHROOT_PASSTHRU.
595load_environment_whitelist
596for var in "${ENVIRONMENT_WHITELIST[@]}" ; do
Brian Harring06d3c2e2012-08-23 07:35:43 -0700597 [ "${!var+set}" = "set" ] && CHROOT_PASSTHRU+=( "${var}=${!var}" )
Mario Limonciello7052ae12011-05-05 12:00:49 -0500598done
599
Paul Drews67d9ef12013-03-20 08:47:47 -0700600# Set up GIT_PROXY_COMMAND so git:// URLs automatically work behind a proxy.
601if [[ -n "${all_proxy}" || -n "${https_proxy}" || -n "${http_proxy}" ]]; then
602 CHROOT_PASSTHRU+=(
603 "GIT_PROXY_COMMAND=${CHROOT_TRUNK_DIR}/src/scripts/bin/proxy-gw"
604 )
605fi
606
derat@google.com4e7a92b2009-11-21 23:44:14 +0000607# Run command or interactive shell. Also include the non-chrooted path to
608# the source trunk for scripts that may need to print it (e.g.
609# build_image.sh).
Brian Harring35767822012-02-01 23:50:45 -0800610
611if [ $FLAGS_early_make_chroot -eq $FLAGS_TRUE ]; then
612 cmd=( /bin/bash -l -c 'env "$@"' -- )
613elif [ ! -x "${FLAGS_chroot}/usr/bin/sudo" ]; then
614 # Complain that sudo is missing.
615 error "Failing since the chroot lacks sudo."
616 error "Requested enter_chroot command was: $@"
617 exit 127
618else
David James76764882012-10-24 19:46:29 -0700619 cmd=( sudo -i -u "${SUDO_USER}" )
Brian Harring35767822012-02-01 23:50:45 -0800620fi
621
David James76764882012-10-24 19:46:29 -0700622cmd+=( "${CHROOT_PASSTHRU[@]}" "$@" )
623exec chroot "${FLAGS_chroot}" "${cmd[@]}"