blob: 8519d98a3ad3d928ac9e1a81a715d52703128dcc [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."
Brian Harring7b6f3772012-09-23 14:01:13 -070028DEFINE_string cache_dir "" "Directory to use for caching."
Hidehiko Abe63d6c462017-03-02 17:40:54 +090029DEFINE_string goma_dir "" "Goma installed directory."
30DEFINE_string goma_client_json "" "Service account json file for goma."
Yong Hong7dee2cc2018-02-06 16:02:56 +080031DEFINE_string working_dir "" \
32 "The working directory relative to ${CHROOT_TRUNK_DIR} for the command in \
33chroot, must start with '/' if set."
rspangler@google.comd74220d2009-10-09 20:56:14 +000034
Elly Jones7990a062010-09-02 09:23:23 -040035DEFINE_boolean ssh_agent $FLAGS_TRUE "Import ssh agent."
Brian Harring35767822012-02-01 23:50:45 -080036DEFINE_boolean early_make_chroot $FLAGS_FALSE \
37 "Internal flag. If set, the command is run as root without sudo."
Don Garrettad3f0592011-02-04 14:59:56 -080038DEFINE_boolean verbose $FLAGS_FALSE "Print out actions taken"
rspangler@google.comd74220d2009-10-09 20:56:14 +000039
40# More useful help
Doug Anderson9362fa82010-12-16 14:44:12 -080041FLAGS_HELP="USAGE: $0 [flags] [VAR=value] [-- command [arg1] [arg2] ...]
rspangler@google.comd74220d2009-10-09 20:56:14 +000042
43One or more VAR=value pairs can be specified to export variables into
44the chroot environment. For example:
45
46 $0 FOO=bar BAZ=bel
47
Doug Anderson9362fa82010-12-16 14:44:12 -080048If [-- command] is present, runs the command inside the chroot,
David James76764882012-10-24 19:46:29 -070049after changing directory to /${SUDO_USER}/trunk/src/scripts. Note that neither
Doug Anderson9362fa82010-12-16 14:44:12 -080050the command nor args should include single quotes. For example:
rspangler@google.comd74220d2009-10-09 20:56:14 +000051
Doug Anderson9362fa82010-12-16 14:44:12 -080052 $0 -- ./build_platform_packages.sh
rspangler@google.comd74220d2009-10-09 20:56:14 +000053
54Otherwise, provides an interactive shell.
55"
56
Peter Mayo4411efe2012-09-21 04:41:27 -040057CROS_LOG_PREFIX=cros_sdk:enter_chroot
David James76764882012-10-24 19:46:29 -070058SUDO_HOME=$(eval echo ~${SUDO_USER})
Peter Mayo4411efe2012-09-21 04:41:27 -040059
Don Garrettad3f0592011-02-04 14:59:56 -080060# Version of info from common.sh that only echos if --verbose is set.
Mike Frysinger6b1abb22012-05-11 13:44:06 -040061debug() {
Don Garrettad3f0592011-02-04 14:59:56 -080062 if [ $FLAGS_verbose -eq $FLAGS_TRUE ]; then
David Rochberg351a76f2011-02-16 11:14:00 -050063 info "$*"
Don Garrettad3f0592011-02-04 14:59:56 -080064 fi
65}
66
rspangler@google.comd74220d2009-10-09 20:56:14 +000067# Parse command line flags
68FLAGS "$@" || exit 1
69eval set -- "${FLAGS_ARGV}"
70
Brian Harring7b6f3772012-09-23 14:01:13 -070071[ -z "${FLAGS_cache_dir}" ] && \
72 die "--cache_dir is required"
Brian Harring7ee892d2012-02-02 09:33:10 -080073
rspangler@google.comd74220d2009-10-09 20:56:14 +000074# Only now can we die on error. shflags functions leak non-zero error codes,
Brian Harring7f175a52012-03-02 05:37:00 -080075# so will die prematurely if 'switch_to_strict_mode' is specified before now.
rspangler@google.comd74220d2009-10-09 20:56:14 +000076# TODO: replace shflags with something less error-prone, or contribute a fix.
Brian Harring7f175a52012-03-02 05:37:00 -080077switch_to_strict_mode
rspangler@google.comd74220d2009-10-09 20:56:14 +000078
Matt Tennant298f61a2012-06-25 21:54:33 -070079# These config files are to be copied into chroot if they exist in home dir.
Prathmesh Prabhu74ebbbd2015-03-17 13:50:29 -070080# Additionally, git relevant files are copied by setup_git.
Matt Tennant298f61a2012-06-25 21:54:33 -070081FILES_TO_COPY_TO_CHROOT=(
82 .gdata_cred.txt # User/password for Google Docs on chromium.org
83 .gdata_token # Auth token for Google Docs on chromium.org
84 .disable_build_stats_upload # Presence of file disables command stats upload
Peter Mayo45ebc4c2013-01-28 15:49:06 -050085 .netrc # May contain required source fetching credentials
Marc Herbert0c422062015-05-29 16:18:54 -070086 .inputrc # Preserve command line customizations
Matt Tennant298f61a2012-06-25 21:54:33 -070087)
88
Sean Parent2898f752010-05-25 15:06:33 -070089INNER_CHROME_ROOT=$FLAGS_chrome_root_mount # inside chroot
Andrew de los Reyes6d0ca162010-02-12 14:36:08 -080090CHROME_ROOT_CONFIG="/var/cache/chrome_root" # inside chroot
Chris Sosaaa1a7fd2010-04-02 14:06:29 -070091FUSE_DEVICE="/dev/fuse"
Andrew de los Reyes6d0ca162010-02-12 14:36:08 -080092
Mike Frysinger01c205d2013-03-22 00:59:58 -040093# We can't use /var/lock because that might be a symlink to /run/lock outside
94# of the chroot. Or /run on the host system might not exist.
95LOCKFILE="${FLAGS_chroot}/.enter_chroot.lock"
Mike Frysinger0a0e6ec2011-09-28 11:57:21 -040096MOUNTED_PATH=$(readlink -f "$FLAGS_chroot")
Mike Frysinger286b5922011-09-28 11:59:53 -040097
Brian Harring2499bfb2012-12-18 16:23:31 -080098# Reset the depot tools/internal trunk pathways to what they'll
99# be w/in the chroot.
100set_chroot_trunk_dir "${FLAGS_chroot}"
101
102
David James76764882012-10-24 19:46:29 -0700103setup_mount() {
David Rochberg351a76f2011-02-16 11:14:00 -0500104 # If necessary, mount $source in the host FS at $target inside the
David James76764882012-10-24 19:46:29 -0700105 # chroot directory with $mount_args. We don't write to /etc/mtab because
106 # these mounts are all contained within an unshare and are therefore
107 # inaccessible to other namespaces (e.g. the host desktop system).
David Rochberg351a76f2011-02-16 11:14:00 -0500108 local source="$1"
David James76764882012-10-24 19:46:29 -0700109 local mount_args="-n $2"
David Rochberg351a76f2011-02-16 11:14:00 -0500110 local target="$3"
111
Mike Frysinger0a0e6ec2011-09-28 11:57:21 -0400112 local mounted_path="${MOUNTED_PATH}$target"
David Rochberg351a76f2011-02-16 11:14:00 -0500113
Mike Frysinger9e5b0a42012-05-16 17:30:24 -0400114 case " ${MOUNT_CACHE} " in
115 *" ${mounted_path} "*)
Mike Frysinger2a970592011-09-20 22:49:01 -0400116 # Already mounted!
117 ;;
118 *)
Mike Frysingeradd99762014-03-27 13:17:58 -0400119 # If it doesn't exist, assume they want a dir. But don't blindly run
120 # it all the time in case they're trying to bind mount a file.
121 if [[ ! -e ${mounted_path} ]]; then
122 mkdir -p "${mounted_path}"
123 fi
Michael Krebs04c4f732012-09-07 18:31:46 -0700124 # The args are left unquoted on purpose.
125 if [[ -n ${source} ]]; then
David James76764882012-10-24 19:46:29 -0700126 mount ${mount_args} "${source}" "${mounted_path}"
Michael Krebs04c4f732012-09-07 18:31:46 -0700127 else
David James76764882012-10-24 19:46:29 -0700128 mount ${mount_args} "${mounted_path}"
Michael Krebs04c4f732012-09-07 18:31:46 -0700129 fi
Mike Frysinger2a970592011-09-20 22:49:01 -0400130 ;;
131 esac
David Rochberg351a76f2011-02-16 11:14:00 -0500132}
133
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400134copy_ssh_config() {
Vadim Bendebury0779f522011-06-12 12:09:16 -0700135 # Copy user .ssh/config into the chroot filtering out strings not supported
136 # by the chroot ssh. The chroot .ssh directory is passed in as the first
137 # parameter.
138
139 # ssh options to filter out. The entire strings containing these substrings
140 # will be deleted before copying.
141 local bad_options=(
Matt Tennant63c3cc52011-11-22 11:23:06 -0800142 'UseProxyIf'
143 'GSSAPIAuthentication'
144 'GSSAPIKeyExchange'
145 'ProxyUseFdpass'
Vadim Bendebury0779f522011-06-12 12:09:16 -0700146 )
David James76764882012-10-24 19:46:29 -0700147 local sshc="${SUDO_HOME}/.ssh/config"
Vadim Bendebury0779f522011-06-12 12:09:16 -0700148 local chroot_ssh_dir="${1}"
149 local filter
150 local option
151
David James22dc2ba2012-11-29 15:46:58 -0800152 if ! user_cp "${sshc}" "${chroot_ssh_dir}/config.orig" 2>/dev/null; then
Vadim Bendebury0779f522011-06-12 12:09:16 -0700153 return # Nothing to copy.
154 fi
155
156 for option in "${bad_options[@]}"
157 do
158 if [ -z "${filter}" ]; then
159 filter="${option}"
160 else
161 filter+="\\|${option}"
162 fi
163 done
164
David James22dc2ba2012-11-29 15:46:58 -0800165 sed "/^.*\(${filter}\).*$/d" "${chroot_ssh_dir}/config.orig" | \
David James76764882012-10-24 19:46:29 -0700166 user_clobber "${chroot_ssh_dir}/config"
Vadim Bendebury0779f522011-06-12 12:09:16 -0700167}
168
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400169copy_into_chroot_if_exists() {
Matt Tennantf7c9e772012-02-08 17:06:26 -0800170 # $1 is file path outside of chroot to copy to path $2 inside chroot.
Frank Henigman784e76c2013-08-30 10:30:12 -0400171 [ -e "$1" ] && user_cp -p "$1" "${FLAGS_chroot}/$2"
Matt Tennantf7c9e772012-02-08 17:06:26 -0800172}
173
Peter Mayo4411efe2012-09-21 04:41:27 -0400174# Usage: promote_api_keys
175# This takes care of getting the developer API keys into the chroot where
176# chrome can build with them. It needs to take it from the places a dev
177# is likely to put them, and recognize that older chroots may or may not
178# have been used since the concept of keys got added, as well as before
Thiemo Nagel3a4d23b2017-05-26 16:52:05 +0200179# and after the developer deciding to grab their own keys.
Peter Mayo4411efe2012-09-21 04:41:27 -0400180promote_api_keys() {
David James76764882012-10-24 19:46:29 -0700181 local destination="${FLAGS_chroot}/home/${SUDO_USER}/.googleapikeys"
Peter Mayo4411efe2012-09-21 04:41:27 -0400182 # Don't disturb existing keys. They could be set differently
183 if [[ -s "${destination}" ]]; then
184 return 0
185 fi
David James76764882012-10-24 19:46:29 -0700186 if [[ -r "${SUDO_HOME}/.googleapikeys" ]]; then
187 cp -p "${SUDO_HOME}/.googleapikeys" "${destination}"
Peter Mayo4411efe2012-09-21 04:41:27 -0400188 if [[ -s "${destination}" ]] ; then
189 info "Copied Google API keys into chroot."
190 fi
David James76764882012-10-24 19:46:29 -0700191 elif [[ -r "${SUDO_HOME}/.gyp/include.gypi" ]]; then
Peter Mayo4411efe2012-09-21 04:41:27 -0400192 local NAME="('google_(api_key|default_client_(id|secret))')"
193 local WS="[[:space:]]*"
194 local CONTENTS="('[^\\\\']*')"
195 sed -nr -e "/^${WS}${NAME}${WS}[:=]${WS}${CONTENTS}.*/{s//\1: \4,/;p;}" \
David James76764882012-10-24 19:46:29 -0700196 "${SUDO_HOME}/.gyp/include.gypi" | user_clobber "${destination}"
Peter Mayo4411efe2012-09-21 04:41:27 -0400197 if [[ -s "${destination}" ]]; then
198 info "Put discovered Google API keys into chroot."
199 fi
200 fi
201}
202
Mike Frysinger4f2d5cc2013-06-09 23:34:52 -0400203generate_locales() {
204 # Make sure user's requested locales are available
205 # http://crosbug.com/19139
206 # And make sure en_US{,.UTF-8} are always available as
207 # that what buildbot forces internally
208 local l locales gen_locales=()
209
210 locales=$(printf '%s\n' en_US en_US.UTF-8 ${LANG} \
211 $LC_{ADDRESS,ALL,COLLATE,CTYPE,IDENTIFICATION,MEASUREMENT,MESSAGES} \
212 $LC_{MONETARY,NAME,NUMERIC,PAPER,TELEPHONE,TIME} | \
213 sort -u | sed '/^C$/d')
214 for l in ${locales}; do
215 if [[ ${l} == *.* ]]; then
216 enc=${l#*.}
217 else
218 enc="ISO-8859-1"
219 fi
220 case $(echo ${enc//-} | tr '[:upper:]' '[:lower:]') in
221 utf8) enc="UTF-8";;
222 esac
223 gen_locales+=("${l} ${enc}")
224 done
225 if [[ ${#gen_locales[@]} -gt 0 ]] ; then
226 # Force LC_ALL=C to workaround slow string parsing in bash
227 # with long multibyte strings. Newer setups have this fixed,
228 # but locale-gen doesn't need to be run in any locale in the
229 # first place, so just go with C to keep it fast.
Brian Norrise83a1472017-08-31 16:24:45 -0700230 # Force jobs=1 to work around locale-gen weirdness where it simultaneously
231 # wants to and doesn't want to run multiple jobs (and complains about it).
232 # crbug.com/761153
Mike Frysinger4f2d5cc2013-06-09 23:34:52 -0400233 chroot "${FLAGS_chroot}" env LC_ALL=C locale-gen -q -u \
Brian Norrise83a1472017-08-31 16:24:45 -0700234 -j 1 -G "$(printf '%s\n' "${gen_locales[@]}")"
Mike Frysinger4f2d5cc2013-06-09 23:34:52 -0400235 fi
236}
237
Prathmesh Prabhu74ebbbd2015-03-17 13:50:29 -0700238setup_git() {
239 # Copy .gitconfig into chroot so repo and git can be used from inside.
240 # This is required for repo to work since it validates the email address.
241 copy_into_chroot_if_exists "${SUDO_HOME}/.gitconfig" \
242 "/home/${SUDO_USER}/.gitconfig"
243 local -r chroot_gitconfig="${FLAGS_chroot}/home/${SUDO_USER}/.gitconfig"
244
245 # If the user didn't set up their username in their gitconfig, look
246 # at the default git settings for the user.
247 if ! git config -f "${chroot_gitconfig}" user.email >& /dev/null; then
248 local ident=$(cd /; sudo -u ${SUDO_USER} -- git var GIT_COMMITTER_IDENT || \
249 :)
250 local ident_name=${ident%% <*}
251 local ident_email=${ident%%>*}; ident_email=${ident_email##*<}
252 git config -f "${chroot_gitconfig}" --replace-all user.name \
253 "${ident_name}" || :
254 git config -f "${chroot_gitconfig}" --replace-all user.email \
255 "${ident_email}" || :
256 fi
257
258 # Copy the gitcookies file, updating the user's gitconfig to point to it.
259 local gitcookies
260 gitcookies="$(git config -f "${chroot_gitconfig}" --get http.cookiefile)"
261 if [[ $? -ne 0 ]]; then
262 # Try the default location anyway.
263 gitcookies="${SUDO_HOME}/.gitcookies"
264 fi
265 copy_into_chroot_if_exists "${gitcookies}" "/home/${SUDO_USER}/.gitcookies"
266 local -r chroot_gitcookies="${FLAGS_chroot}/home/${SUDO_USER}/.gitcookies"
267 if [[ -e "${chroot_gitcookies}" ]]; then
268 git config -f "${chroot_gitconfig}" --replace-all http.cookiefile \
269 "/home/${SUDO_USER}/.gitcookies"
270 fi
271 # This line must be at the end because using `git config` changes ownership of
272 # the .gitconfig.
273 chown ${SUDO_UID}:${SUDO_GID} "${chroot_gitconfig}"
274}
275
Xiyuan Xiaa6e21ae2018-03-28 08:47:23 -0700276setup_gclient_cache_dir_mount() {
277 # Mount "cache_dir" if a glient checkout depends on it.
278 # Otherwise, git command inside chroot fails. See https://crbug.com/747349
279 local checkout_root="$1"
280
281 if [[ ! -e "${checkout_root}/.gclient" ]]; then
282 return 0
283 fi
284
285 local cache_dir=$(sed -n -E "s/^ *cache_dir *= *'(.*)'/\1/p" \
286 "${checkout_root}/.gclient")
287 if [[ -z "${cache_dir}" ]]; then
288 return 0
289 fi
290
Mike Frysingerd5a3e6d2019-08-07 15:23:15 -0400291 # See if the cache dir exists outside of the chroot.
Xiyuan Xiaa6e21ae2018-03-28 08:47:23 -0700292 if [[ ! -d "${cache_dir}" ]]; then
Mike Frysingerd5a3e6d2019-08-07 15:23:15 -0400293 # See if it exists inside the chroot (which can happen if the checkout was
294 # created in there).
295 if [[ ! -d "${FLAGS_chroot}/${cache_dir}" ]]; then
296 warn "Gclient cache dir \"${cache_dir}\" is not a directory."
297 fi
Xiyuan Xiaa6e21ae2018-03-28 08:47:23 -0700298 return 0
299 fi
300
301 setup_mount "${cache_dir}" "--bind" "${cache_dir}"
302}
303
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400304setup_env() {
Andrew de los Reyesc9317ea2010-02-10 13:16:36 -0800305 (
306 flock 200
rspangler@google.comd74220d2009-10-09 20:56:14 +0000307
David James76764882012-10-24 19:46:29 -0700308 # Make the lockfile writable for backwards compatibility.
309 chown ${SUDO_UID}:${SUDO_GID} "${LOCKFILE}"
310
311 # Refresh /etc/resolv.conf and /etc/hosts in the chroot.
312 install -C -m644 /etc/resolv.conf ${FLAGS_chroot}/etc/resolv.conf
313 install -C -m644 /etc/hosts ${FLAGS_chroot}/etc/hosts
David James412b9022011-07-15 19:54:16 -0700314
Don Garretta0e7ea12011-02-07 18:39:59 -0800315 debug "Mounting chroot environment."
Steev Klimaszewskia10974c2013-11-30 20:38:34 -0600316 mount --make-rslave /
Benjamin Gordon1d5afed2017-06-14 16:35:32 -0600317 if grep -q -e "${FLAGS_chroot}[[:space:]]" /proc/mounts; then
318 debug "Changing $FLAGS_chroot to a private subtree."
319 mount --make-private "$FLAGS_chroot"
320 fi
Mike Frysinger9e5b0a42012-05-16 17:30:24 -0400321 MOUNT_CACHE=$(echo $(awk '{print $2}' /proc/mounts))
David James76764882012-10-24 19:46:29 -0700322 setup_mount none "-t proc" /proc
323 setup_mount none "-t sysfs" /sys
Gaurav Shah365b7062013-12-03 18:12:58 -0800324 if grep -q binfmt_misc /proc/filesystems; then
325 setup_mount binfmt_misc "-t binfmt_misc" /proc/sys/fs/binfmt_misc
326 fi
Victor Dodonc34d4bc2016-05-09 12:09:21 -0700327 if grep -q configfs /proc/filesystems; then
328 setup_mount none "-t configfs" /sys/kernel/config
329 fi
Mike Frysingerb5080fb2019-03-19 04:13:02 -0400330 setup_mount /dev "--rbind" /dev
David James482fb292013-03-10 21:06:54 -0700331 if [[ -d /run ]]; then
David James76764882012-10-24 19:46:29 -0700332 setup_mount /run "--bind" /run
David James482fb292013-03-10 21:06:54 -0700333 if [[ -d /run/shm && ! -L /run/shm ]]; then
David James76764882012-10-24 19:46:29 -0700334 setup_mount /run/shm "--bind" /run/shm
Aaron Plattner130d3632011-10-18 08:54:57 -0700335 fi
336 fi
Brian Harring2499bfb2012-12-18 16:23:31 -0800337
Mike Frysinger4f2d5cc2013-06-09 23:34:52 -0400338 # Do this early as it's slow and only needs basic mounts (above).
339 generate_locales &
340
Michael Spang15144f42013-04-02 17:42:55 -0400341 setup_mount "${FLAGS_trunk}" "--rbind" "${CHROOT_TRUNK_DIR}"
Chris Sosa389634d2012-09-05 19:56:53 -0700342
Brian Harringdd7d7932011-12-23 04:21:33 -0800343 debug "Setting up referenced repositories if required."
344 REFERENCE_DIR=$(git config --file \
345 "${FLAGS_trunk}/.repo/manifests.git/config" \
346 repo.reference)
347 if [ -n "${REFERENCE_DIR}" ]; then
348
Brian Harring334050f2012-06-08 17:40:58 -0700349 ALTERNATES="${FLAGS_trunk}/.repo/alternates"
350
351 # Ensure this directory exists ourselves, and has the correct ownership.
David James76764882012-10-24 19:46:29 -0700352 user_mkdir "${ALTERNATES}"
Brian Harring334050f2012-06-08 17:40:58 -0700353
354 unset ALTERNATES
355
Brian Harringdd7d7932011-12-23 04:21:33 -0800356 IFS=$'\n';
David James76764882012-10-24 19:46:29 -0700357 required=( $( sudo -u "${SUDO_USER}" -- \
Mike Frysinger1658c3e2019-08-21 20:24:02 -0400358 "${FLAGS_trunk}/chromite/lib/rewrite_git_alternates" \
Brian Harringdd7d7932011-12-23 04:21:33 -0800359 "${FLAGS_trunk}" "${REFERENCE_DIR}" "${CHROOT_TRUNK_DIR}" ) )
360 unset IFS
361
David James76764882012-10-24 19:46:29 -0700362 setup_mount "${FLAGS_trunk}/.repo/chroot/alternates" --bind \
Brian Harringdd7d7932011-12-23 04:21:33 -0800363 "${CHROOT_TRUNK_DIR}/.repo/alternates"
364
365 # Note that as we're bringing up each referened repo, we also
366 # mount bind an empty directory over its alternates. This is
367 # required to suppress git from tracing through it- we already
368 # specify the required alternates for CHROOT_TRUNK_DIR, no point
369 # in having git try recursing through each on their own.
370 #
371 # Finally note that if you're unfamiliar w/ chroot/vfs semantics,
372 # the bind is visible only w/in the chroot.
David James76764882012-10-24 19:46:29 -0700373 user_mkdir ${FLAGS_trunk}/.repo/chroot/empty
Brian Harringdd7d7932011-12-23 04:21:33 -0800374 position=1
375 for x in "${required[@]}"; do
376 base="${CHROOT_TRUNK_DIR}/.repo/chroot/external${position}"
David James76764882012-10-24 19:46:29 -0700377 setup_mount "${x}" "--bind" "${base}"
Brian Harringdd7d7932011-12-23 04:21:33 -0800378 if [ -e "${x}/.repo/alternates" ]; then
David James76764882012-10-24 19:46:29 -0700379 setup_mount "${FLAGS_trunk}/.repo/chroot/empty" "--bind" \
Brian Harringdd7d7932011-12-23 04:21:33 -0800380 "${base}/.repo/alternates"
381 fi
382 position=$(( ${position} + 1 ))
383 done
384 unset required position base
385 fi
386 unset REFERENCE_DIR
387
Brian Harring7b6f3772012-09-23 14:01:13 -0700388 chroot_cache='/var/cache/chromeos-cache'
389 debug "Setting up shared cache dir directory."
David James76764882012-10-24 19:46:29 -0700390 user_mkdir "${FLAGS_cache_dir}"/distfiles/{target,host}
391 user_mkdir "${FLAGS_chroot}/${chroot_cache}"
392 setup_mount "${FLAGS_cache_dir}" "--bind" "${chroot_cache}"
Brian Harring7b6f3772012-09-23 14:01:13 -0700393 # TODO(build): remove this as of 12/01/12.
394 # Because of how distfiles -> cache_dir was deployed, if this isn't
395 # a symlink, we *know* the ondisk pathways aren't compatible- thus
396 # fix it now.
397 distfiles_path="${FLAGS_chroot}/var/cache/distfiles"
398 if [ ! -L "${distfiles_path}" ]; then
399 # While we're at it, ensure the var is exported w/in the chroot; it
400 # won't exist if distfiles isn't a symlink.
Paul Drewsb688cbe2012-10-08 15:33:43 -0700401 p="${FLAGS_chroot}/etc/profile.d/chromeos-cachedir.sh"
David James76764882012-10-24 19:46:29 -0700402 rm -rf "${distfiles_path}"
403 ln -s chromeos-cache/distfiles "${distfiles_path}"
404 mkdir -p -m 775 "${p%/*}"
405 echo 'export CHROMEOS_CACHEDIR=${chroot_cache}' > "${p}"
406 chmod 0644 "${p}"
Brian Harring7b6f3772012-09-23 14:01:13 -0700407 fi
Brian Harring7ee892d2012-02-02 09:33:10 -0800408
Aviv Keshet97a35f42014-07-24 12:11:10 -0700409 if [ -d "${SUDO_HOME}/.cidb_creds" ]; then
410 setup_mount "${SUDO_HOME}/.cidb_creds" --bind \
411 "/home/${SUDO_USER}/.cidb_creds"
412 fi
413
Elly Jones7990a062010-09-02 09:23:23 -0400414 if [ $FLAGS_ssh_agent -eq $FLAGS_TRUE ]; then
David James76764882012-10-24 19:46:29 -0700415 if [ -n "${SSH_AUTH_SOCK}" -a -d "${SUDO_HOME}/.ssh" ]; then
Mike Frysingeradd99762014-03-27 13:17:58 -0400416 local target_ssh="/home/${SUDO_USER}/.ssh"
417 TARGET_DIR="${FLAGS_chroot}${target_ssh}"
David James76764882012-10-24 19:46:29 -0700418 user_mkdir "${TARGET_DIR}"
Mike Frysingeradd99762014-03-27 13:17:58 -0400419
420 local known_hosts="${SUDO_HOME}/.ssh/known_hosts"
421 if [[ -e ${known_hosts} ]]; then
422 truncate -s 0 "${TARGET_DIR}/known_hosts"
423 setup_mount "${known_hosts}" --bind "${target_ssh}/known_hosts"
424 fi
David James22dc2ba2012-11-29 15:46:58 -0800425 (
Mike Frysingeradd99762014-03-27 13:17:58 -0400426 # Only copy ~/.ssh/*.pub if they exist. Since we set
David James22dc2ba2012-11-29 15:46:58 -0800427 # nullglob, this needs to happen within a subshell.
428 shopt -s nullglob
Mike Frysingeradd99762014-03-27 13:17:58 -0400429 files=("${SUDO_HOME}"/.ssh/*.pub)
David James22dc2ba2012-11-29 15:46:58 -0800430 if [[ ${#files[@]} -gt 0 ]]; then
431 user_cp "${files[@]}" "${TARGET_DIR}/"
432 fi
433 )
Vadim Bendebury0779f522011-06-12 12:09:16 -0700434 copy_ssh_config "${TARGET_DIR}"
David James76764882012-10-24 19:46:29 -0700435 chown -R ${SUDO_UID}:${SUDO_GID} "${TARGET_DIR}"
Mike Frysinger9de707f2011-12-12 14:21:44 -0500436
Kevin Cernekeea1718392016-10-16 19:54:57 -0700437 if [ -S "${SSH_AUTH_SOCK}" ]; then
438 touch "${FLAGS_chroot}/tmp/ssh-auth-sock"
439 setup_mount "${SSH_AUTH_SOCK}" "--bind" "/tmp/ssh-auth-sock"
Mike Frysinger9de707f2011-12-12 14:21:44 -0500440 fi
Elly Jones7990a062010-09-02 09:23:23 -0400441 fi
442 fi
443
Marc MERLINfcd84ef2013-03-07 14:34:43 -0800444 if [[ -d "$SUDO_HOME/.subversion" ]]; then
David James76764882012-10-24 19:46:29 -0700445 TARGET="/home/${SUDO_USER}/.subversion"
David James76764882012-10-24 19:46:29 -0700446 setup_mount "${SUDO_HOME}/.subversion" "--bind" "${TARGET}"
Paul Drewsb4605b42012-10-11 23:10:43 -0700447 # Symbolic-link the .subversion directory so sandboxed subversion.class
448 # clients can use it.
Paul Drewsb4605b42012-10-11 23:10:43 -0700449 for d in \
David James76764882012-10-24 19:46:29 -0700450 "${FLAGS_cache_dir}"/distfiles/{host,target}/svn-src/"${SUDO_USER}"; do
Paul Drewsb4605b42012-10-11 23:10:43 -0700451 if [[ ! -L "${d}/.subversion" ]]; then
David James76764882012-10-24 19:46:29 -0700452 rm -rf "${d}/.subversion"
453 user_mkdir "${d}"
454 user_symlink /home/${SUDO_USER}/.subversion "${d}/.subversion"
Paul Drewsb4605b42012-10-11 23:10:43 -0700455 fi
456 done
Mike Frysinger286b5922011-09-28 11:59:53 -0400457 fi
458
David James76764882012-10-24 19:46:29 -0700459 # A reference to the DEPOT_TOOLS path may be passed in by cros_sdk.
460 if [ -n "${DEPOT_TOOLS}" ]; then
Mike Frysinger286b5922011-09-28 11:59:53 -0400461 debug "Mounting depot_tools"
Brian Harring2499bfb2012-12-18 16:23:31 -0800462 setup_mount "${DEPOT_TOOLS}" --bind "${DEPOT_TOOLS_DIR}"
Mike Frysinger286b5922011-09-28 11:59:53 -0400463 fi
464
Hidehiko Abe63d6c462017-03-02 17:40:54 +0900465 if [[ -n "${FLAGS_goma_dir}" ]]; then
466 debug "Mounting goma"
467 # $HOME/goma is the default directory for goma.
468 # It is used by goma if GOMA_DIR is not provide.
469 setup_mount "${FLAGS_goma_dir}" --bind "/home/${SUDO_USER}/goma"
470 fi
471
472 if [[ -n "${FLAGS_goma_client_json}" ]]; then
473 debug "Mounting service-account-goma-client.json"
474 local dest_path="/creds/service_accounts/service-account-goma-client.json"
475 # setup_mount assumes the target is a directory by default.
476 # So here, touch the file in advance.
477 local mounted_path="${MOUNTED_PATH}${dest_path}"
Hidehiko Abe053a1992017-03-07 16:44:18 +0900478 mkdir -p "$(dirname "${mounted_path}")"
Hidehiko Abe63d6c462017-03-02 17:40:54 +0900479 touch "${mounted_path}"
Hidehiko Abe053a1992017-03-07 16:44:18 +0900480 # Note: Original UID:GID and permission should be inherited even after
Hidehiko Abe63d6c462017-03-02 17:40:54 +0900481 # mounting.
482 setup_mount "${FLAGS_goma_client_json}" --bind "${dest_path}"
483 fi
484
Michael Krebs04c4f732012-09-07 18:31:46 -0700485 # Mount additional directories as specified in .local_mounts file.
486 local local_mounts="${FLAGS_trunk}/src/scripts/.local_mounts"
487 if [[ -f ${local_mounts} ]]; then
Gaurav Shahe3cffca2013-11-26 14:45:10 -0800488 info "Mounting local folders"
Michael Krebs04c4f732012-09-07 18:31:46 -0700489 # format: mount_source
490 # or mount_source mount_point
491 # or # comments
492 local mount_source mount_point
493 while read mount_source mount_point; do
494 if [[ -z ${mount_source} ]]; then
495 continue
496 fi
497 # if only source is assigned, use source as mount point.
498 : ${mount_point:=${mount_source}}
499 debug " mounting ${mount_source} on ${mount_point}"
David James76764882012-10-24 19:46:29 -0700500 setup_mount "${mount_source}" "--bind" "${mount_point}"
Michael Krebs04c4f732012-09-07 18:31:46 -0700501 done < <(sed -e 's:#.*::' "${local_mounts}")
502 fi
503
Mike Frysinger9a50b642011-09-20 23:37:14 -0400504 CHROME_ROOT="$(readlink -f "$FLAGS_chrome_root" || :)"
505 if [ -z "$CHROME_ROOT" ]; then
506 CHROME_ROOT="$(cat "${FLAGS_chroot}${CHROME_ROOT_CONFIG}" \
507 2>/dev/null || :)"
508 CHROME_ROOT_AUTO=1
509 fi
510 if [[ -n "$CHROME_ROOT" ]]; then
511 if [[ ! -d "${CHROME_ROOT}/src" ]]; then
Mike Frysinger9d73a852013-12-02 19:47:08 -0500512 error "Not mounting chrome source: could not find CHROME_ROOT/src dir."
513 error "Full path we tried: ${CHROME_ROOT}/src"
David James76764882012-10-24 19:46:29 -0700514 rm -f "${FLAGS_chroot}${CHROME_ROOT_CONFIG}"
Mike Frysinger9a50b642011-09-20 23:37:14 -0400515 if [[ ! "$CHROME_ROOT_AUTO" ]]; then
516 exit 1
Don Garretta0e7ea12011-02-07 18:39:59 -0800517 fi
Mike Frysinger9a50b642011-09-20 23:37:14 -0400518 else
519 debug "Mounting chrome source at: $INNER_CHROME_ROOT"
David James76764882012-10-24 19:46:29 -0700520 echo $CHROME_ROOT > "${FLAGS_chroot}${CHROME_ROOT_CONFIG}"
521 setup_mount "$CHROME_ROOT" --bind "$INNER_CHROME_ROOT"
Xiyuan Xiaa6e21ae2018-03-28 08:47:23 -0700522 setup_gclient_cache_dir_mount "$CHROME_ROOT"
Andrew de los Reyes6d0ca162010-02-12 14:36:08 -0800523 fi
524 fi
Andrew de los Reyes5d0248f2010-02-12 16:12:31 -0800525
Mike Frysingeracc4c9b2011-09-15 18:06:25 -0400526 # Install fuse module. Skip modprobe when possible for slight
527 # speed increase when initializing the env.
528 if [ -c "${FUSE_DEVICE}" ] && ! grep -q fuse /proc/filesystems; then
David James76764882012-10-24 19:46:29 -0700529 modprobe fuse 2> /dev/null ||\
Sean Ocd8b1d12010-09-02 17:34:49 +0200530 warn "-- Note: modprobe fuse failed. gmergefs will not work"
Chris Sosa317d8eb2010-04-05 15:45:28 -0700531 fi
532
Mike Frysinger926a4b92012-06-27 15:22:28 -0400533 # Fix permissions on ccache tree. If this is a fresh chroot, then they
534 # might not be set up yet. Or if the user manually `rm -rf`-ed things,
535 # we need to reset it. Otherwise, gcc itself takes care of fixing things
536 # on demand, but only when it updates.
537 ccache_dir="${FLAGS_chroot}/var/cache/distfiles/ccache"
538 if [[ ! -d ${ccache_dir} ]]; then
David James76764882012-10-24 19:46:29 -0700539 mkdir -p -m 2775 "${ccache_dir}"
Mike Frysinger926a4b92012-06-27 15:22:28 -0400540 fi
Mike Frysingerba609912015-05-20 00:44:25 -0400541 (
542 find -H "${ccache_dir}" '(' -type d -a '!' -perm 2775 ')' \
543 -exec chmod 2775 {} +
544 find -H "${ccache_dir}" -gid 0 -exec chgrp 250 {} +
545 # These settings are kept in sync with the gcc ebuild.
546 chroot "${FLAGS_chroot}" env CCACHE_DIR=/var/cache/distfiles/ccache \
547 CCACHE_UMASK=002 ccache -F 0 -M 11G >/dev/null
548 ) &
David James342f1562011-07-15 15:21:18 -0700549
Matt Tennant298f61a2012-06-25 21:54:33 -0700550 # Certain files get copied into the chroot when entering.
551 for fn in "${FILES_TO_COPY_TO_CHROOT[@]}"; do
David James76764882012-10-24 19:46:29 -0700552 copy_into_chroot_if_exists "${SUDO_HOME}/${fn}" "/home/${SUDO_USER}/${fn}"
Matt Tennantf7c9e772012-02-08 17:06:26 -0800553 done
Prathmesh Prabhu74ebbbd2015-03-17 13:50:29 -0700554 setup_git
Peter Mayo4411efe2012-09-21 04:41:27 -0400555 promote_api_keys
Matt Tennantd4316fe2011-08-30 12:06:42 -0700556
Dale Curtis98631732011-05-05 16:16:59 -0700557 # Fix permissions on shared memory to allow non-root users access to POSIX
Josh McSavaney8477dad2016-04-05 13:43:26 -0700558 # semaphores. Take special care to only change the permissions on the
559 # directory and not all of its contents.
560 chmod 1777 "${FLAGS_chroot}/dev/shm"
Chris Wolfe916b1f12012-04-30 16:03:06 -0400561
Yu-Ju Hong22278a22014-01-16 12:46:53 -0800562 # gsutil uses boto config to store settings and credentials. Copy
563 # user's own boto file into the chroot if it exists. Also copy it
564 # to /root for sudoed invocations.
565 chroot_user_boto="${FLAGS_chroot}/home/${SUDO_USER}/.boto"
566 chroot_root_boto="${FLAGS_chroot}/root/.boto"
567 if [ -f ${SUDO_HOME}/.boto ]; then
568 # Pass --remote-destination to overwrite a symlink.
569 user_cp "--remove-destination" "${SUDO_HOME}/.boto" "$chroot_user_boto"
Frank Henigman696ce082014-03-27 21:21:55 -0400570 cp "--remove-destination" "$chroot_user_boto" "$chroot_root_boto"
David Rileyb6e9d862016-02-25 16:58:02 -0800571 elif [ -f "/etc/boto.cfg" ]; then
572 # For GCE instances, the non-chroot .boto file is not deployed so
573 # use the system /etc/boto.cfg if it exists.
574 user_cp "--remove-destination" "/etc/boto.cfg" "$chroot_user_boto"
575 cp "--remove-destination" "$chroot_user_boto" "$chroot_root_boto"
Yu-Ju Hong22278a22014-01-16 12:46:53 -0800576 fi
577
578 # If user doesn't have a boto file, check if the private overlays
579 # are installed and use those credentials.
Gilad Arnold264f64d2012-09-06 14:01:45 -0700580 boto='src/private-overlays/chromeos-overlay/googlestorage_account.boto'
581 if [ -s "${FLAGS_trunk}/${boto}" ]; then
Yu-Ju Hong22278a22014-01-16 12:46:53 -0800582 if [ ! -e "$chroot_user_boto" ]; then
583 user_symlink "trunk/${boto}" "$chroot_user_boto"
Chris Wolfe916b1f12012-04-30 16:03:06 -0400584 fi
Yu-Ju Hong22278a22014-01-16 12:46:53 -0800585 if [ ! -e "$chroot_root_boto" ]; then
586 ln -sf "${CHROOT_TRUNK_DIR}/${boto}" "$chroot_root_boto"
Gilad Arnold264f64d2012-09-06 14:01:45 -0700587 fi
Chris Wolfe916b1f12012-04-30 16:03:06 -0400588 fi
589
590 # Have found a few chroots where ~/.gsutil is owned by root:root, probably
591 # as a result of old gsutil or tools. This causes permission errors when
592 # gsutil cp tries to create its cache files, so ensure the user can
593 # actually write to their directory.
David James76764882012-10-24 19:46:29 -0700594 gsutil_dir="${FLAGS_chroot}/home/${SUDO_USER}/.gsutil"
595 if [ -d "${gsutil_dir}" ]; then
596 chown -R ${SUDO_UID}:${SUDO_GID} "${gsutil_dir}"
Chris Wolfe916b1f12012-04-30 16:03:06 -0400597 fi
David James546747b2010-03-23 15:19:43 -0700598 ) 200>>"$LOCKFILE" || die "setup_env failed"
rspangler@google.comd74220d2009-10-09 20:56:14 +0000599}
600
rspangler@google.comd74220d2009-10-09 20:56:14 +0000601setup_env
602
Brian Harring35767822012-02-01 23:50:45 -0800603CHROOT_PASSTHRU=(
604 "BUILDBOT_BUILD=$FLAGS_build_number"
Brian Harring35767822012-02-01 23:50:45 -0800605 "CHROMEOS_RELEASE_APPID=${CHROMEOS_RELEASE_APPID:-{DEV-BUILD}}"
Brian Harring35767822012-02-01 23:50:45 -0800606 "EXTERNAL_TRUNK_PATH=${FLAGS_trunk}"
Yong Hong7dee2cc2018-02-06 16:02:56 +0800607
608 # The default ~/.bash_profile in chroot will cd to $CHROOT_CWD instead of
609 # ~/trunk/src/script if that environment variable is set.
610 "CHROOT_CWD=${FLAGS_working_dir}"
Brian Harring35767822012-02-01 23:50:45 -0800611)
Liam McLoughlin3b11b452011-03-14 16:04:07 -0700612
Josh Triplettd6a13bf2014-06-13 15:36:52 -0700613# Translate C.UTF-8 into something we support. Remove this when our glibc
614# starts supporting C.UTF-8. https://bugzilla.redhat.com/show_bug.cgi?id=902094
615for var in LANG \
616 LC_{ADDRESS,ALL,COLLATE,CTYPE,IDENTIFICATION,MEASUREMENT,MESSAGES} \
617 LC_{MONETARY,NAME,NUMERIC,PAPER,TELEPHONE,TIME}; do
618 if [[ ${!var} =~ C\.[Uu][Tt][Ff]-?8 ]]; then
619 if [[ ${var} == LC_COLLATE ]]; then
620 export LC_COLLATE=C
621 else
622 export ${var}=en_US.UTF-8
623 fi
624 fi
625done
626
Kevin Cernekeea1718392016-10-16 19:54:57 -0700627# Needs to be set here because setup_env runs in a subshell.
628[ -S "${FLAGS_chroot}/tmp/ssh-auth-sock" ] && SSH_AUTH_SOCK=/tmp/ssh-auth-sock
629
David James76764882012-10-24 19:46:29 -0700630# Add the whitelisted environment variables to CHROOT_PASSTHRU.
631load_environment_whitelist
632for var in "${ENVIRONMENT_WHITELIST[@]}" ; do
Brian Harring06d3c2e2012-08-23 07:35:43 -0700633 [ "${!var+set}" = "set" ] && CHROOT_PASSTHRU+=( "${var}=${!var}" )
Mario Limonciello7052ae12011-05-05 12:00:49 -0500634done
635
Paul Drews67d9ef12013-03-20 08:47:47 -0700636# Set up GIT_PROXY_COMMAND so git:// URLs automatically work behind a proxy.
637if [[ -n "${all_proxy}" || -n "${https_proxy}" || -n "${http_proxy}" ]]; then
638 CHROOT_PASSTHRU+=(
639 "GIT_PROXY_COMMAND=${CHROOT_TRUNK_DIR}/src/scripts/bin/proxy-gw"
640 )
641fi
642
derat@google.com4e7a92b2009-11-21 23:44:14 +0000643# Run command or interactive shell. Also include the non-chrooted path to
644# the source trunk for scripts that may need to print it (e.g.
645# build_image.sh).
Brian Harring35767822012-02-01 23:50:45 -0800646
647if [ $FLAGS_early_make_chroot -eq $FLAGS_TRUE ]; then
648 cmd=( /bin/bash -l -c 'env "$@"' -- )
649elif [ ! -x "${FLAGS_chroot}/usr/bin/sudo" ]; then
650 # Complain that sudo is missing.
651 error "Failing since the chroot lacks sudo."
652 error "Requested enter_chroot command was: $@"
653 exit 127
654else
David James76764882012-10-24 19:46:29 -0700655 cmd=( sudo -i -u "${SUDO_USER}" )
Brian Harring35767822012-02-01 23:50:45 -0800656fi
657
David James76764882012-10-24 19:46:29 -0700658cmd+=( "${CHROOT_PASSTHRU[@]}" "$@" )
659exec chroot "${FLAGS_chroot}" "${cmd[@]}"