blob: 6f9888ae439a6b9ba1729d0256528fbecf13f2a6 [file] [log] [blame]
Brian Harringf539bc32012-02-06 00:18:37 -08001#!/bin/bash
2
Matt Tennant0a9d32d2012-07-30 16:51:37 -07003# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
Brian Harringf539bc32012-02-06 00:18:37 -08004# Use of this source code is governed by a BSD-style license that can be
5# found in the LICENSE file.
6
7# This script sets up a Gentoo chroot environment. The script is passed the
8# path to an empty folder, which will be populated with a Gentoo stage3 and
9# setup for development. Once created, the password is set to PASSWORD (below).
10# One can enter the chrooted environment for work by running enter_chroot.sh.
11
12SCRIPT_ROOT=$(readlink -f $(dirname "$0")/..)
13. "${SCRIPT_ROOT}/common.sh" || exit 1
14
Brian Harring35767822012-02-01 23:50:45 -080015ENTER_CHROOT=$(readlink -f $(dirname "$0")/enter_chroot.sh)
16
Zdenek Behan4d21a292012-08-17 04:02:29 +020017if [ -n "${USE}" ]; then
18 echo "$SCRIPT_NAME: Building with a non-empty USE: ${USE}"
19 echo "This modifies the expected behaviour and can fail."
20fi
21
Brian Harringf539bc32012-02-06 00:18:37 -080022# Check if the host machine architecture is supported.
23ARCHITECTURE="$(uname -m)"
24if [[ "$ARCHITECTURE" != "x86_64" ]]; then
25 echo "$SCRIPT_NAME: $ARCHITECTURE is not supported as a host machine architecture."
26 exit 1
27fi
28
David James76764882012-10-24 19:46:29 -070029# Script must be run outside the chroot and as root.
Brian Harringf539bc32012-02-06 00:18:37 -080030assert_outside_chroot
David James76764882012-10-24 19:46:29 -070031assert_root_user
Brian Harringf539bc32012-02-06 00:18:37 -080032
Brian Harring35767822012-02-01 23:50:45 -080033# Define command line flags.
Brian Harringf539bc32012-02-06 00:18:37 -080034# See http://code.google.com/p/shflags/wiki/Documentation10x
35
36DEFINE_string chroot "$DEFAULT_CHROOT_DIR" \
37 "Destination dir for the chroot environment."
38DEFINE_boolean usepkg $FLAGS_TRUE "Use binary packages to bootstrap."
39DEFINE_boolean delete $FLAGS_FALSE "Delete an existing chroot."
40DEFINE_boolean replace $FLAGS_FALSE "Overwrite existing chroot, if any."
41DEFINE_integer jobs -1 "How many packages to build in parallel at maximum."
Brian Harringf539bc32012-02-06 00:18:37 -080042DEFINE_string stage3_path "" \
43 "Use the stage3 located on this path."
Brian Harring7b6f3772012-09-23 14:01:13 -070044DEFINE_string cache_dir "" "Directory to store caches within."
Benjamin Gordon1d5afed2017-06-14 16:35:32 -060045DEFINE_boolean useimage $FLAGS_FALSE "Mount the chroot on a loopback image."
Allen Webb8bdcfd52021-04-23 16:54:28 -050046DEFINE_boolean eclean "${FLAGS_TRUE}" "Run eclean to delete old binpkgs."
Brian Harringf539bc32012-02-06 00:18:37 -080047
Brian Harring35767822012-02-01 23:50:45 -080048# Parse command line flags.
Brian Harringf539bc32012-02-06 00:18:37 -080049FLAGS_HELP="usage: $SCRIPT_NAME [flags]"
50FLAGS "$@" || exit 1
51eval set -- "${FLAGS_ARGV}"
Brian Harringf539bc32012-02-06 00:18:37 -080052
Peter Mayo4411efe2012-09-21 04:41:27 -040053CROS_LOG_PREFIX=cros_sdk:make_chroot
David Purselld35d7af2015-05-04 16:37:08 -070054SUDO_HOME=$(eval echo ~"${SUDO_USER}")
Brian Harringf539bc32012-02-06 00:18:37 -080055
Brian Harringf539bc32012-02-06 00:18:37 -080056# Set the right umask for chroot creation.
57umask 022
58
59# Only now can we die on error. shflags functions leak non-zero error codes,
Brian Harring7f175a52012-03-02 05:37:00 -080060# so will die prematurely if 'switch_to_strict_mode' is specified before now.
Brian Harringf539bc32012-02-06 00:18:37 -080061# TODO: replace shflags with something less error-prone, or contribute a fix.
Brian Harring7f175a52012-03-02 05:37:00 -080062switch_to_strict_mode
Brian Harringf539bc32012-02-06 00:18:37 -080063
Brian Harring7b6f3772012-09-23 14:01:13 -070064[[ "${FLAGS_delete}" == "${FLAGS_FALSE}" ]] && \
65 [[ -z "${FLAGS_cache_dir}" ]] && \
66 die "--cache_dir is required"
67
J. Richard Barnettee80f6de2012-02-24 14:08:34 -080068. "${SCRIPT_ROOT}"/sdk_lib/make_conf_util.sh
69
David Purselld35d7af2015-05-04 16:37:08 -070070PRIMARY_GROUP=$(id -g -n "${SUDO_USER}")
71PRIMARY_GROUP_ID=$(id -g "${SUDO_USER}")
72
Brian Harringf539bc32012-02-06 00:18:37 -080073FULLNAME="ChromeOS Developer"
David Purselld35d7af2015-05-04 16:37:08 -070074DEFGROUPS="${PRIMARY_GROUP},adm,cdrom,floppy,audio,video,portage"
75
Brian Harringf539bc32012-02-06 00:18:37 -080076USEPKG=""
Manoj Gupta51880b82019-06-19 13:50:57 -070077USEPKGONLY=""
Brian Harringf539bc32012-02-06 00:18:37 -080078if [[ $FLAGS_usepkg -eq $FLAGS_TRUE ]]; then
79 # Use binary packages. Include all build-time dependencies,
80 # so as to avoid unnecessary differences between source
81 # and binary builds.
82 USEPKG="--getbinpkg --usepkg --with-bdeps y"
Manoj Gupta51880b82019-06-19 13:50:57 -070083 # Use --usepkgonly to avoid building toolchain packages from source.
84 USEPKGONLY="--usepkgonly"
Brian Harringf539bc32012-02-06 00:18:37 -080085fi
86
Bertrand SIMONNET4dda4f52015-03-19 13:40:58 -070087EMERGE_CMD="${CHROOT_TRUNK_DIR}/chromite/bin/parallel_emerge"
Brian Harringf539bc32012-02-06 00:18:37 -080088
Brian Harring35767822012-02-01 23:50:45 -080089ENTER_CHROOT_ARGS=(
90 CROS_WORKON_SRCROOT="$CHROOT_TRUNK"
David James76764882012-10-24 19:46:29 -070091 PORTAGE_USERNAME="${SUDO_USER}"
Brian Harring35767822012-02-01 23:50:45 -080092 IGNORE_PREFLIGHT_BINHOST="$IGNORE_PREFLIGHT_BINHOST"
93)
94
95# Invoke enter_chroot. This can only be used after sudo has been installed.
Mike Frysinger6b1abb22012-05-11 13:44:06 -040096enter_chroot() {
Mike Frysingerca7cd942019-09-08 04:40:45 -040097 echo "$(date +%H:%M:%S) [enter_chroot] $*"
Brian Harring7b6f3772012-09-23 14:01:13 -070098 "$ENTER_CHROOT" --cache_dir "${FLAGS_cache_dir}" --chroot "$FLAGS_chroot" \
99 -- "${ENTER_CHROOT_ARGS[@]}" "$@"
Brian Harringf539bc32012-02-06 00:18:37 -0800100}
101
Brian Harring35767822012-02-01 23:50:45 -0800102# Invoke enter_chroot running the command as root, and w/out sudo.
103# This should be used prior to sudo being merged.
Mike Frysingerba758452012-04-02 13:28:31 -0400104early_env=()
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400105early_enter_chroot() {
Mike Frysingerca7cd942019-09-08 04:40:45 -0400106 echo "$(date +%H:%M:%S) [early_enter_chroot] $*"
Brian Harring35767822012-02-01 23:50:45 -0800107 "$ENTER_CHROOT" --chroot "$FLAGS_chroot" --early_make_chroot \
Brian Harring7b6f3772012-09-23 14:01:13 -0700108 --cache_dir "${FLAGS_cache_dir}" \
Mike Frysingerba758452012-04-02 13:28:31 -0400109 -- "${ENTER_CHROOT_ARGS[@]}" "${early_env[@]}" "$@"
Brian Harringf539bc32012-02-06 00:18:37 -0800110}
111
Mike Frysinger4bb86452013-08-02 13:44:18 -0400112# Run a command within the chroot. The main usage of this is to avoid the
113# overhead of enter_chroot. It's when we do not need access to the source
114# tree, don't need the actual chroot profile env, and can run the command as
115# root. We do have to make sure PATH includes all the right programs as
116# found inside of the chroot since the environment outside of the chroot
117# might be insufficient (like distros with merged /bin /sbin and /usr).
David James76764882012-10-24 19:46:29 -0700118bare_chroot() {
David Purselld35d7af2015-05-04 16:37:08 -0700119 PATH="/bin:/sbin:/usr/bin:/usr/sbin:${PATH}" \
Mike Frysinger4bb86452013-08-02 13:44:18 -0400120 chroot "${FLAGS_chroot}" "$@"
Brian Harringf539bc32012-02-06 00:18:37 -0800121}
122
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400123cleanup() {
Brian Harringf539bc32012-02-06 00:18:37 -0800124 # Clean up mounts
125 safe_umount_tree "${FLAGS_chroot}"
Benjamin Gordon1d5afed2017-06-14 16:35:32 -0600126
127 # Destroy LVM loopback setup if we can find a VG associated with our path.
128 local chroot_img="${FLAGS_chroot}.img"
129 [[ -f "$chroot_img" ]] || return 0
130
131 local chroot_dev=$(losetup -j "$chroot_img" | cut -f1 -d:)
132 local chroot_vg=$(find_vg_name "$FLAGS_chroot" "$chroot_dev")
133 if [ -n "$chroot_vg" ] && vgs "$chroot_vg" >&/dev/null; then
134 info "Removing VG $chroot_vg."
135 vgremove -f "$chroot_vg" --noudevsync
136 fi
137 if [ -n "$chroot_dev" ]; then
138 info "Detaching $chroot_dev."
139 losetup -d "$chroot_dev"
140 fi
Brian Harringf539bc32012-02-06 00:18:37 -0800141}
142
Mike Frysingereab3f072019-08-21 22:57:49 -0400143# Appends stdin to the given file name as the sudo user.
144#
145# $1 - The output file name.
146user_append() {
147 cat >> "$1"
148 chown ${SUDO_UID}:${SUDO_GID} "$1"
149}
150
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400151delete_existing() {
Brian Harring35767822012-02-01 23:50:45 -0800152 # Delete old chroot dir.
Benjamin Gordon1d5afed2017-06-14 16:35:32 -0600153 local chroot_img="${FLAGS_chroot}.img"
154 if [[ ! -e "$FLAGS_chroot" && ! -f "$chroot_img" ]]; then
Brian Harring35767822012-02-01 23:50:45 -0800155 return
Brian Harringf539bc32012-02-06 00:18:37 -0800156 fi
Benjamin Gordon1d5afed2017-06-14 16:35:32 -0600157 info "Cleaning up old mount points and loopback device..."
Brian Harring35767822012-02-01 23:50:45 -0800158 cleanup
159 info "Deleting $FLAGS_chroot..."
David James76764882012-10-24 19:46:29 -0700160 rm -rf "$FLAGS_chroot"
Benjamin Gordon1d5afed2017-06-14 16:35:32 -0600161 if [[ -f "$chroot_img" ]]; then
162 info "Deleting $chroot_img..."
163 rm -f "$chroot_img"
164 fi
Brian Harring35767822012-02-01 23:50:45 -0800165 info "Done."
Brian Harringf539bc32012-02-06 00:18:37 -0800166}
167
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400168init_users () {
Brian Harring35767822012-02-01 23:50:45 -0800169 info "Set timezone..."
170 # date +%Z has trouble with daylight time, so use host's info.
David James76764882012-10-24 19:46:29 -0700171 rm -f "${FLAGS_chroot}/etc/localtime"
Brian Harringf539bc32012-02-06 00:18:37 -0800172 if [ -f /etc/localtime ] ; then
David James76764882012-10-24 19:46:29 -0700173 cp /etc/localtime "${FLAGS_chroot}/etc"
Brian Harringf539bc32012-02-06 00:18:37 -0800174 else
David James76764882012-10-24 19:46:29 -0700175 ln -sf /usr/share/zoneinfo/PST8PDT "${FLAGS_chroot}/etc/localtime"
Brian Harringf539bc32012-02-06 00:18:37 -0800176 fi
Brian Harring35767822012-02-01 23:50:45 -0800177 info "Adding user/group..."
David Purselld35d7af2015-05-04 16:37:08 -0700178 # Add the necessary groups to the chroot.
179 # Duplicate GIDs are allowed here in order to ensure that the required
180 # groups are the same inside and outside the chroot.
181 # TODO(dpursell): Handle when PRIMARY_GROUP exists in the chroot already
182 # with a different GID; groupadd will not create the new GID in that case.
183 bare_chroot groupadd -f -o -g "${PRIMARY_GROUP_ID}" "${PRIMARY_GROUP}"
Brian Harringf539bc32012-02-06 00:18:37 -0800184 # Add ourselves as a user inside the chroot.
Brian Harringf539bc32012-02-06 00:18:37 -0800185 # We need the UID to match the host user's. This can conflict with
186 # a particular chroot UID. At the same time, the added user has to
187 # be a primary user for the given UID for sudo to work, which is
188 # determined by the order in /etc/passwd. Let's put ourselves on top
189 # of the file.
David Purselld35d7af2015-05-04 16:37:08 -0700190 bare_chroot useradd -o -G "${DEFGROUPS}" -g "${PRIMARY_GROUP}" \
191 -u "${SUDO_UID}" -s /bin/bash -m -c "${FULLNAME}" "${SUDO_USER}"
Brian Harringf539bc32012-02-06 00:18:37 -0800192 # Because passwd generally isn't sorted and the entry ended up at the
193 # bottom, it is safe to just take it and move it to top instead.
David James76764882012-10-24 19:46:29 -0700194 sed -e '1{h;d};$!{H;d};$G' -i "${FLAGS_chroot}/etc/passwd"
Brian Harringf539bc32012-02-06 00:18:37 -0800195}
196
Mike Frysinger6b1abb22012-05-11 13:44:06 -0400197init_setup () {
Brian Harring35767822012-02-01 23:50:45 -0800198 info "Running init_setup()..."
David James76764882012-10-24 19:46:29 -0700199 mkdir -p -m 755 "${FLAGS_chroot}/usr" \
Mike Frysingerb45dbb52013-12-13 21:14:09 -0500200 "${FLAGS_chroot}${OVERLAYS_ROOT}" \
Mike Frysinger36beaaa2014-09-25 15:52:27 -0400201 "${FLAGS_chroot}"/"${CROSSDEV_OVERLAY}/metadata"
202 # Newer portage complains about bare overlays. Create the file that crossdev
203 # will also create later on.
204 cat <<EOF > "${FLAGS_chroot}/${CROSSDEV_OVERLAY}/metadata/layout.conf"
205# Autogenerated and managed by crossdev
206# Delete the above line if you want to manage this file yourself
207masters = portage-stable chromiumos
208repo-name = crossdev
209use-manifests = true
210thin-manifests = true
211EOF
Mike Frysingerb45dbb52013-12-13 21:14:09 -0500212 ln -sf "${CHROOT_TRUNK_DIR}/src/third_party/eclass-overlay" \
213 "${FLAGS_chroot}"/"${ECLASS_OVERLAY}"
Brian Harring2499bfb2012-12-18 16:23:31 -0800214 ln -sf "${CHROOT_TRUNK_DIR}/src/third_party/chromiumos-overlay" \
Brian Harringf539bc32012-02-06 00:18:37 -0800215 "${FLAGS_chroot}"/"${CHROOT_OVERLAY}"
Brian Harring2499bfb2012-12-18 16:23:31 -0800216 ln -sf "${CHROOT_TRUNK_DIR}/src/third_party/portage-stable" \
Brian Harringf539bc32012-02-06 00:18:37 -0800217 "${FLAGS_chroot}"/"${PORTAGE_STABLE_OVERLAY}"
Brian Harringf539bc32012-02-06 00:18:37 -0800218
Brian Harring35767822012-02-01 23:50:45 -0800219 # Some operations need an mtab.
Mike Frysingerb47a4ff2013-02-20 17:29:05 -0500220 ln -sfT /proc/mounts "${FLAGS_chroot}/etc/mtab"
Brian Harringf539bc32012-02-06 00:18:37 -0800221
222 # Set up sudoers. Inside the chroot, the user can sudo without a password.
223 # (Safe enough, since the only way into the chroot is to 'sudo chroot', so
224 # the user's already typed in one sudo password...)
225 # Make sure the sudoers.d subdir exists as older stage3 base images lack it.
David James76764882012-10-24 19:46:29 -0700226 mkdir -p "${FLAGS_chroot}/etc/sudoers.d"
Brian Harring06d3c2e2012-08-23 07:35:43 -0700227
228 # Use the standardized upgrade script to setup proxied vars.
David James76764882012-10-24 19:46:29 -0700229 load_environment_whitelist
Mike Frysinger930aeef2020-01-29 18:05:46 -0500230 "${SCRIPT_ROOT}/sdk_lib/rewrite-sudoers.d.sh" \
David James76764882012-10-24 19:46:29 -0700231 "${FLAGS_chroot}" "${SUDO_USER}" "${ENVIRONMENT_WHITELIST[@]}"
Brian Harring06d3c2e2012-08-23 07:35:43 -0700232
David James76764882012-10-24 19:46:29 -0700233 find "${FLAGS_chroot}/etc/"sudoers* -type f -exec chmod 0440 {} +
Brian Harring35767822012-02-01 23:50:45 -0800234 # Fix bad group for some.
David James76764882012-10-24 19:46:29 -0700235 chown -R root:root "${FLAGS_chroot}/etc/"sudoers*
Brian Harringf539bc32012-02-06 00:18:37 -0800236
Brian Harring35767822012-02-01 23:50:45 -0800237 info "Setting up hosts/resolv..."
238 # Copy config from outside chroot into chroot.
David James76764882012-10-24 19:46:29 -0700239 cp /etc/{hosts,resolv.conf} "$FLAGS_chroot/etc/"
240 chmod 0644 "$FLAGS_chroot"/etc/{hosts,resolv.conf}
Brian Harringf539bc32012-02-06 00:18:37 -0800241
242 # Setup host make.conf. This includes any overlay that we may be using
243 # and a pointer to pre-built packages.
Brian Harring35767822012-02-01 23:50:45 -0800244 # TODO: This should really be part of a profile in the portage.
245 info "Setting up /etc/make.*..."
Mike Frysinger53f79bb2014-04-05 22:27:52 -0400246 rm -f "${FLAGS_chroot}"/etc/{,portage/}make.{conf,profile}{,.catalyst}
Mike Frysingerc6e1ace2013-03-22 00:49:30 -0400247 mkdir -p "${FLAGS_chroot}/etc/portage"
David James76764882012-10-24 19:46:29 -0700248 ln -sf "${CHROOT_CONFIG}/make.conf.amd64-host" \
Brian Harringf539bc32012-02-06 00:18:37 -0800249 "${FLAGS_chroot}/etc/make.conf"
Mike Frysinger411b2422014-06-04 11:49:17 -0400250 ln -sf "${CHROOT_OVERLAY}/profiles/default/linux/amd64/10.0/sdk" \
Mike Frysingere9b40072015-05-19 05:07:04 -0400251 "${FLAGS_chroot}/etc/portage/make.profile"
Brian Harringf539bc32012-02-06 00:18:37 -0800252
Brian Harring35767822012-02-01 23:50:45 -0800253 # Create make.conf.user .
Mike Frysingerbc1f57d2020-03-06 04:44:30 -0500254 cat <<\EOF > "${FLAGS_chroot}"/etc/make.conf.user
Alex Kleina28439c2019-01-14 14:48:30 -0700255# This file is useful for doing global (chroot and all board) changes.
256# Tweak emerge settings, ebuild env, etc...
257#
258# Make sure to append variables unless you really want to clobber all
259# existing settings. e.g. You most likely want:
260# FEATURES="${FEATURES} ..."
261# USE="${USE} foo"
262# and *not*:
263# USE="foo"
264#
265# This also is a good place to setup ACCEPT_LICENSE.
266EOF
David James76764882012-10-24 19:46:29 -0700267 chmod 0644 "${FLAGS_chroot}"/etc/make.conf.user
Brian Harringf539bc32012-02-06 00:18:37 -0800268
269 # Create directories referred to by our conf files.
David James76764882012-10-24 19:46:29 -0700270 mkdir -p -m 775 "${FLAGS_chroot}/var/lib/portage/pkgs" \
Brian Harring7b6f3772012-09-23 14:01:13 -0700271 "${FLAGS_chroot}/var/cache/"chromeos-{cache,chrome} \
272 "${FLAGS_chroot}/etc/profile.d"
273
David James76764882012-10-24 19:46:29 -0700274 echo "export CHROMEOS_CACHEDIR=/var/cache/chromeos-cache" > \
275 "${FLAGS_chroot}/etc/profile.d/chromeos-cachedir.sh"
276 chmod 0644 "${FLAGS_chroot}/etc/profile.d/chromeos-cachedir.sh"
277 rm -rf "${FLAGS_chroot}/var/cache/distfiles"
278 ln -s chromeos-cache/distfiles "${FLAGS_chroot}/var/cache/distfiles"
Brian Harring36b102b2012-02-06 23:34:25 -0800279
280 # Run this from w/in the chroot so we use whatever uid/gid
281 # these are defined as w/in the chroot.
David James76764882012-10-24 19:46:29 -0700282 bare_chroot chown "${SUDO_USER}:portage" /var/cache/chromeos-chrome
Brian Harring7ee892d2012-02-02 09:33:10 -0800283
Brian Harringf539bc32012-02-06 00:18:37 -0800284 # Add chromite/bin and depot_tools into the path globally; note that the
285 # chromite wrapper itself might also be found in depot_tools.
286 # We rely on 'env-update' getting called below.
287 target="${FLAGS_chroot}/etc/env.d/99chromiumos"
David James76764882012-10-24 19:46:29 -0700288 cat <<EOF > "${target}"
David Purselld35d7af2015-05-04 16:37:08 -0700289PATH="${CHROOT_TRUNK_DIR}/chromite/bin:${DEPOT_TOOLS_DIR}"
Brian Harring2499bfb2012-12-18 16:23:31 -0800290CROS_WORKON_SRCROOT="${CHROOT_TRUNK_DIR}"
David Purselld35d7af2015-05-04 16:37:08 -0700291PORTAGE_USERNAME="${SUDO_USER}"
Brian Harringf539bc32012-02-06 00:18:37 -0800292EOF
293
294 # TODO(zbehan): Configure stuff that is usually configured in postinst's,
Mike Frysingereb1a9b42012-03-28 16:21:04 -0400295 # but wasn't. Fix the postinst's.
Brian Harring35767822012-02-01 23:50:45 -0800296 info "Running post-inst configuration hacks"
297 early_enter_chroot env-update
Brian Harringf539bc32012-02-06 00:18:37 -0800298
Brian Harring35767822012-02-01 23:50:45 -0800299 # This is basically a sanity check of our chroot. If any of these
300 # don't exist, then either bind mounts have failed, an invocation
301 # from above is broke, or some assumption about the stage3 is no longer
302 # true.
Mike Frysingere9b40072015-05-19 05:07:04 -0400303 early_enter_chroot ls -l /etc/make.conf /etc/portage/make.profile \
Brian Harring35767822012-02-01 23:50:45 -0800304 /usr/local/portage/chromiumos/profiles/default/linux/amd64/10.0
Brian Harringf539bc32012-02-06 00:18:37 -0800305
306 target="${FLAGS_chroot}/etc/profile.d"
David James76764882012-10-24 19:46:29 -0700307 mkdir -p "${target}"
Mike Frysinger93cce812021-03-25 20:11:36 -0400308 ln -sfT \
309 "/mnt/host/source/chromite/sdk/etc/profile.d/50-chromiumos-niceties.sh" \
310 "${target}/50-chromiumos-niceties.sh"
Brian Harringf539bc32012-02-06 00:18:37 -0800311
312 # Select a small set of locales for the user if they haven't done so
313 # already. This makes glibc upgrades cheap by only generating a small
314 # set of locales. The ones listed here are basically for the buildbots
315 # which always assume these are available. This works in conjunction
316 # with `cros_sdk --enter`.
317 # http://crosbug.com/20378
318 local localegen="$FLAGS_chroot/etc/locale.gen"
319 if ! grep -q -v -e '^#' -e '^$' "${localegen}" ; then
David James76764882012-10-24 19:46:29 -0700320 cat <<EOF >> "${localegen}"
Brian Harringf539bc32012-02-06 00:18:37 -0800321en_US ISO-8859-1
322en_US.UTF-8 UTF-8
323EOF
324 fi
325
Brian Harring35767822012-02-01 23:50:45 -0800326 # Automatically change to scripts directory.
Brian Harringf539bc32012-02-06 00:18:37 -0800327 echo 'cd ${CHROOT_CWD:-~/trunk/src/scripts}' \
David Purselld35d7af2015-05-04 16:37:08 -0700328 | user_append "${FLAGS_chroot}/home/${SUDO_USER}/.bash_profile"
Brian Harringf539bc32012-02-06 00:18:37 -0800329
Brian Harring35767822012-02-01 23:50:45 -0800330 # Enable bash completion for build scripts.
Andrew02104f82019-12-13 08:42:30 -0800331 printf '%s\n' "# Set up bash autocompletion." \
332 ". ~/trunk/src/scripts/bash_completion" \
David Purselld35d7af2015-05-04 16:37:08 -0700333 | user_append "${FLAGS_chroot}/home/${SUDO_USER}/.bashrc"
Brian Harringf539bc32012-02-06 00:18:37 -0800334
David Purselld35d7af2015-05-04 16:37:08 -0700335 if [[ -f "${SUDO_HOME}/.cros_chroot_init" ]]; then
Mike Frysinger8cdf3862019-12-13 15:03:22 -0500336 warn "~/.cros_chroot_init is no longer supported"
Luigi Semenzato2443fdd2012-05-29 10:34:04 -0700337 fi
Brian Harringf539bc32012-02-06 00:18:37 -0800338}
339
Gilad Arnold01d458b2015-05-28 06:41:08 -0700340unpack_tarball() {
341 local tarball_path="$1"
342 local dest_dir="$2"
343 local decompress
344 case "${tarball_path}" in
345 *.tbz2|*.tar.bz2) decompress=$(type -p pbzip2 || echo bzip2) ;;
Mike Frysinger978efbf2018-12-20 16:43:26 -0500346 *.tar.xz) decompress=$(type -p pixz || echo xz) ;;
Gilad Arnold01d458b2015-05-28 06:41:08 -0700347 *) die "Unknown tarball compression: ${tarball_path}" ;;
348 esac
Mike Frysinger978efbf2018-12-20 16:43:26 -0500349 ${decompress} -dc <"${tarball_path}" | tar -xp -C "${dest_dir}"
Gilad Arnold01d458b2015-05-28 06:41:08 -0700350}
351
Benjamin Gordon1d5afed2017-06-14 16:35:32 -0600352# Find a usable VG name for a given path and device. If there is an existing
353# VG associated with the device, it will be returned. If not, find an unused
354# name in the format cros_<safe_path>_NNN, where safe_path is an escaped version
355# of the last 90 characters of the path and NNN is a counter. Example:
356# /home/user/chromiumos/chroot/ -> cros_home+user+chromiumos+chroot_000.
357# If no unused name with this pattern can be found, return an empty string.
358find_vg_name() {
359 local chroot_path="$1"
360 local chroot_dev="$2"
361 chroot_path=${chroot_path##/}
362 chroot_path=${chroot_path%%/}
363 chroot_path=${chroot_path//[^A-Za-z0-9_+.-]/+}
364 chroot_path=${chroot_path: -$((${#chroot_path} < 90 ? ${#chroot_path} : 90))}
365 local vg_name=""
366 if [ -n "$chroot_dev" ]; then
367 vg_name=$(pvs -q --noheadings -o vg_name "$chroot_dev" 2>/dev/null | \
368 sed -e 's/^ *//')
369 fi
370 if [ -z "$vg_name" ]; then
371 local counter=0
372 vg_name=$(printf "cros_%s_%03d" "$chroot_path" "$counter")
373 while [ "$counter" -lt 1000 ] && vgs "$vg_name" >&/dev/null; do
374 counter=$((counter + 1))
375 vg_name=$(printf "cros_%s_%03d" "$chroot_path" "$counter")
376 done
377 if [ "$counter" -gt 999 ]; then
378 vg_name=""
379 fi
380 fi
381 echo "$vg_name"
382}
383
384# Create a loopback image and mount it on the chroot path so that we can take
385# snapshots before building. If an image already exists, try to mount it. The
386# chroot is initially mounted inside a temporary shared chroot.build subtree
387# that should have already been set up by the parent process, and then bind
388# mounted into the correct final location. The purpose of this indirection is
389# so that processes outside our mount namespace can see the top-level chroot
390# after we finish.
391mount_chroot_image() {
392 local chroot_image="$1"
393 local mount_path="$2"
394
395 # Make sure there's an image.
396 local existing_chroot=0
397 local chroot_dev=""
398 if [ -f "$chroot_image" ]; then
399 info "Attempting to reuse existing image file ${chroot_image}"
400 chroot_dev=$(losetup -j "$chroot_image" | cut -f1 -d:)
401 existing_chroot=1
402 else
403 dd if=/dev/null of="$chroot_image" bs=1G seek=500 >&/dev/null
404 fi
405
406 # Get/scan a loopback device attached to our image.
407 if [ -n "$chroot_dev" ]; then
408 pvscan -q "$chroot_dev" >&/dev/null
409 else
410 chroot_dev=$(losetup -f "$chroot_image" --show)
411 fi
412
413 # Find/create a VG on the loopback device.
414 chroot_vg=$(find_vg_name "$mount_path" "$chroot_dev")
415 if [ -z "$chroot_vg" ]; then
416 die_notrace "Unable to find usable VG name for ${mount_path}."
417 fi
418 if vgs "$chroot_vg" >&/dev/null; then
Benjamin Gordonf68aa942017-07-21 17:00:20 -0600419 vgchange -q -a y --noudevsync "$chroot_vg" >/dev/null || :
Benjamin Gordon1d5afed2017-06-14 16:35:32 -0600420 else
421 vgcreate -q "$chroot_vg" "$chroot_dev" >/dev/null
422 fi
423
424 # Find/create an LV inside our VG. If the LV is new, also create the FS.
425 # We need to pass --noudevsync to lvcreate because we're running inside
426 # a separate IPC namespace from the udev process.
427 if lvs "$chroot_vg/chroot" >&/dev/null; then
Benjamin Gordonf68aa942017-07-21 17:00:20 -0600428 lvchange -q -ay "$chroot_vg/chroot" --noudevsync >/dev/null || :
Benjamin Gordon1d5afed2017-06-14 16:35:32 -0600429 else
430 lvcreate -q -L 499G -T "${chroot_vg}/thinpool" -V500G -n chroot \
431 --noudevsync >/dev/null
432 mke2fs -q -m 0 -t ext4 "/dev/${chroot_vg}/chroot"
433 fi
434
435 # Mount the FS into a directory that should have been set up as a shared
436 # subtree by our parent process, then bind mount it into the place where
437 # it belongs. The parent will take care of moving the mount to the correct
438 # final place on the outside of our mount namespace after we exit.
439 local temp_chroot="${FLAGS_chroot}.build/chroot"
440 if ! mount -text4 -onoatime "/dev/${chroot_vg}/chroot" "$temp_chroot"; then
441 local chroot_example_opt=""
442 if [[ "$mount_path" != "$DEFAULT_CHROOT_DIR" ]]; then
443 chroot_example_opt="--chroot=$FLAGS_chroot"
444 fi
445
446 die_notrace <<EOF
447
448Unable to mount ${chroot_vg}/chroot on ${temp_chroot}. Check for corrupted
449image ${chroot_image}, or run
450
451cros_sdk --delete $chroot_example_opt
452
453to clean up an old chroot first.
454
455EOF
456 fi
457 mount --make-private "$temp_chroot"
458 mount --bind "$temp_chroot" "$mount_path"
459 mount --make-private "$mount_path"
460 if [ "$existing_chroot" = "1" ]; then
461 info "Mounted existing chroot image."
462 fi
463}
464
Brian Harring35767822012-02-01 23:50:45 -0800465# Handle deleting an existing environment.
Brian Harringf539bc32012-02-06 00:18:37 -0800466if [[ $FLAGS_delete -eq $FLAGS_TRUE || \
Brian Harring35767822012-02-01 23:50:45 -0800467 $FLAGS_replace -eq $FLAGS_TRUE ]]; then
Brian Harringf539bc32012-02-06 00:18:37 -0800468 delete_existing
469 [[ $FLAGS_delete -eq $FLAGS_TRUE ]] && exit 0
470fi
471
472CHROOT_TRUNK="${CHROOT_TRUNK_DIR}"
473PORTAGE="${SRC_ROOT}/third_party/portage"
474OVERLAY="${SRC_ROOT}/third_party/chromiumos-overlay"
475CONFIG_DIR="${OVERLAY}/chromeos/config"
Brian Harring2499bfb2012-12-18 16:23:31 -0800476CHROOT_CONFIG="${CHROOT_TRUNK_DIR}/src/third_party/chromiumos-overlay/chromeos/config"
Mike Frysingerb45dbb52013-12-13 21:14:09 -0500477OVERLAYS_ROOT="/usr/local/portage"
478ECLASS_OVERLAY="${OVERLAYS_ROOT}/eclass-overlay"
479PORTAGE_STABLE_OVERLAY="${OVERLAYS_ROOT}/stable"
480CROSSDEV_OVERLAY="${OVERLAYS_ROOT}/crossdev"
481CHROOT_OVERLAY="${OVERLAYS_ROOT}/chromiumos"
Brian Harringf539bc32012-02-06 00:18:37 -0800482CHROOT_STATE="${FLAGS_chroot}/etc/debian_chroot"
Vincent Palatin5ce24062014-02-26 12:08:23 -0800483CHROOT_VERSION="${FLAGS_chroot}/etc/cros_chroot_version"
Benjamin Gordon1d5afed2017-06-14 16:35:32 -0600484CHROOT_IMAGE="${FLAGS_chroot}.img"
Brian Harringf539bc32012-02-06 00:18:37 -0800485
486# Pass proxy variables into the environment.
487for type in http ftp all; do
David Purselld35d7af2015-05-04 16:37:08 -0700488 value=$(env | grep "${type}_proxy" || true)
Brian Harringf539bc32012-02-06 00:18:37 -0800489 if [ -n "${value}" ]; then
490 CHROOT_PASSTHRU+=("$value")
491 fi
492done
493
Brian Harring35767822012-02-01 23:50:45 -0800494# Create the destination directory.
Brian Harringf539bc32012-02-06 00:18:37 -0800495mkdir -p "$FLAGS_chroot"
496
Benjamin Gordon1d5afed2017-06-14 16:35:32 -0600497[[ $FLAGS_useimage -eq $FLAGS_TRUE ]] && \
498 mount_chroot_image "$CHROOT_IMAGE" "$FLAGS_chroot"
499
500# If the version contains something non-zero, we were already created and this
501# is just a re-mount.
502[[ -f "$CHROOT_VERSION" && "$(<$CHROOT_VERSION)" != "0" ]] && exit 0
503
Brian Harringf539bc32012-02-06 00:18:37 -0800504echo
David Purselld35d7af2015-05-04 16:37:08 -0700505if [[ -f "${CHROOT_STATE}" ]]; then
Mike Frysinger51930072014-04-05 13:01:45 -0400506 info "stage3 already set up. Skipping..."
David Purselld35d7af2015-05-04 16:37:08 -0700507elif [[ -z "${FLAGS_stage3_path}" ]]; then
Mike Frysinger51930072014-04-05 13:01:45 -0400508 die_notrace "Please use --stage3_path when bootstrapping"
Brian Harringf539bc32012-02-06 00:18:37 -0800509else
Mike Frysinger51930072014-04-05 13:01:45 -0400510 info "Unpacking stage3..."
Gilad Arnold01d458b2015-05-28 06:41:08 -0700511 unpack_tarball "${FLAGS_stage3_path}" "${FLAGS_chroot}"
David James76764882012-10-24 19:46:29 -0700512 rm -f "$FLAGS_chroot/etc/"make.{globals,conf.user}
Brian Harringf539bc32012-02-06 00:18:37 -0800513fi
514
Vincent Palatin5ce24062014-02-26 12:08:23 -0800515# Ensure that we properly detect when we are inside the chroot.
516# We'll force this to the latest version at the end as needed.
David Purselld35d7af2015-05-04 16:37:08 -0700517if [[ ! -e "${CHROOT_VERSION}" ]]; then
Vincent Palatin5ce24062014-02-26 12:08:23 -0800518 echo "0" > "${CHROOT_VERSION}"
519fi
520
Brian Harring35767822012-02-01 23:50:45 -0800521# Set up users, if needed, before mkdir/mounts below.
Brian Harringf539bc32012-02-06 00:18:37 -0800522[ -f $CHROOT_STATE ] || init_users
523
Brian Harring2499bfb2012-12-18 16:23:31 -0800524# Reset internal vars to force them to the 'inside the chroot' value;
525# since user directories now exist, this can do the upgrade in place.
526set_chroot_trunk_dir "${FLAGS_chroot}" poppycock
527
Brian Harringf539bc32012-02-06 00:18:37 -0800528echo
Brian Harring35767822012-02-01 23:50:45 -0800529info "Setting up mounts..."
530# Set up necessary mounts and make sure we clean them up on exit.
Brian Harring2499bfb2012-12-18 16:23:31 -0800531mkdir -p "${FLAGS_chroot}/${CHROOT_TRUNK_DIR}" \
532 "${FLAGS_chroot}/${DEPOT_TOOLS_DIR}" "${FLAGS_chroot}/run"
Brian Harring35767822012-02-01 23:50:45 -0800533
J. Richard Barnettee80f6de2012-02-24 14:08:34 -0800534# Create a special /etc/make.conf.host_setup that we use to bootstrap
535# the chroot. The regular content for the file will be generated the
536# first time we invoke update_chroot (further down in this script).
537create_bootstrap_host_setup "${FLAGS_chroot}"
Brian Harringf539bc32012-02-06 00:18:37 -0800538
539if ! [ -f "$CHROOT_STATE" ];then
540 INITIALIZE_CHROOT=1
541fi
542
Mike Frysingerba758452012-04-02 13:28:31 -0400543if ! early_enter_chroot bash -c 'type -P pbzip2' >/dev/null ; then
544 # This chroot lacks pbzip2 early on, so we need to disable it.
545 early_env+=(
546 PORTAGE_BZIP2_COMMAND="bzip2"
547 PORTAGE_BUNZIP2_COMMAND="bunzip2"
548 )
549fi
550
Brian Harringf539bc32012-02-06 00:18:37 -0800551if [ -z "${INITIALIZE_CHROOT}" ];then
Brian Harring35767822012-02-01 23:50:45 -0800552 info "chroot already initialized. Skipping..."
Brian Harringf539bc32012-02-06 00:18:37 -0800553else
Brian Harring35767822012-02-01 23:50:45 -0800554 # Run all the init stuff to setup the env.
Brian Harringf539bc32012-02-06 00:18:37 -0800555 init_setup
556fi
557
Brian Harring35767822012-02-01 23:50:45 -0800558# Add file to indicate that it is a chroot.
Mike Frysinger51930072014-04-05 13:01:45 -0400559# Add version of stage3 for update checks.
560echo "STAGE3=${FLAGS_stage3_path}" > "${CHROOT_STATE}"
Brian Harringf539bc32012-02-06 00:18:37 -0800561
Allen Webb8bdcfd52021-04-23 16:54:28 -0500562# Clean out any stale binpkgs that might be in a warm cache. This is done
563# immediately after unpacking the tarball in case ebuilds have been removed
564# (e.g. from a revert).
565if [[ "${FLAGS_eclean}" -eq "${FLAGS_TRUE}" ]]; then
566 info "Cleaning stale binpkgs"
567 early_enter_chroot eclean packages
568fi
569
Mike Frysingerdc036602019-08-17 13:29:28 -0400570# Switch SDK python to Python 3 by default.
571early_enter_chroot eselect python update
Daniel Kurtz51244842017-07-25 01:32:04 +0800572
Brian Harring35767822012-02-01 23:50:45 -0800573info "Updating portage"
Chris McDonald82bd7fc2019-11-20 11:29:36 -0700574early_enter_chroot emerge -uNv --quiet --ignore-world portage
Brian Harringf539bc32012-02-06 00:18:37 -0800575
Bertrand SIMONNET85c96c72014-08-20 12:10:48 -0700576# Add chromite into python path.
Mike Frysingerdc036602019-08-17 13:29:28 -0400577for python_path in "${FLAGS_chroot}/usr/lib/"python*.*; do
Bertrand SIMONNET85c96c72014-08-20 12:10:48 -0700578 python_path+="/site-packages"
579 sudo mkdir -p "${python_path}"
580 sudo ln -s -fT "${CHROOT_TRUNK_DIR}"/chromite "${python_path}"/chromite
581done
582
Mike Frysingeraf95b612018-12-20 17:08:19 -0500583# Now that many of the fundamental packages should be in a good state, update
584# the host toolchain. We have to do this step by step ourselves to avoid races
585# when building tools that are actively used (e.g. updating the assembler while
586# also compiling other packages that use the assembler).
587# https://crbug.com/715788
Zdenek Behan2fbd5af2012-03-12 19:38:50 +0100588info "Updating host toolchain"
Zdenek Behan2fbd5af2012-03-12 19:38:50 +0100589TOOLCHAIN_ARGS=( --deleteold )
David Purselld35d7af2015-05-04 16:37:08 -0700590if [[ "${FLAGS_usepkg}" == "${FLAGS_FALSE}" ]]; then
Zdenek Behan2fbd5af2012-03-12 19:38:50 +0100591 TOOLCHAIN_ARGS+=( --nousepkg )
592fi
Mike Frysingeraf95b612018-12-20 17:08:19 -0500593# First the low level compiler tools. These should be fairly independent of
594# the C library, so we can do it first.
Manoj Gupta51880b82019-06-19 13:50:57 -0700595early_enter_chroot ${EMERGE_CMD} -uNv ${USEPKG} ${USEPKGONLY} ${EMERGE_JOBS} \
Mike Frysingeraf95b612018-12-20 17:08:19 -0500596 sys-devel/binutils
597# Next the C library. The compilers often use newer features, but the C library
598# is often designed to work with older compilers.
Manoj Gupta51880b82019-06-19 13:50:57 -0700599early_enter_chroot ${EMERGE_CMD} -uNv ${USEPKG} ${USEPKGONLY} ${EMERGE_JOBS} \
Mike Frysingeraf95b612018-12-20 17:08:19 -0500600 sys-kernel/linux-headers sys-libs/glibc
601# Now we can let the rest of the compiler packages build in parallel as they
602# don't generally rely on each other.
Zdenek Behan2fbd5af2012-03-12 19:38:50 +0100603# Note: early_enter_chroot executes as root.
Brian Harring2499bfb2012-12-18 16:23:31 -0800604early_enter_chroot "${CHROOT_TRUNK_DIR}/chromite/bin/cros_setup_toolchains" \
Zdenek Behan2fbd5af2012-03-12 19:38:50 +0100605 --hostonly "${TOOLCHAIN_ARGS[@]}"
Brian Harringf539bc32012-02-06 00:18:37 -0800606
Ben Chan0c9da662017-05-15 17:29:51 -0700607info "Updating Perl modules"
608early_enter_chroot \
609 "${CHROOT_TRUNK_DIR}/src/scripts/build_library/perl_rebuild.sh"
Paul Drews8bae3b52012-10-10 11:18:13 -0700610
Brian Harringf539bc32012-02-06 00:18:37 -0800611if [ -n "${INITIALIZE_CHROOT}" ]; then
612 # If we're creating a new chroot, we also want to set it to the latest
613 # version.
Alex Kleine5e0ea92018-09-13 17:18:15 -0600614 enter_chroot run_chroot_version_hooks --init-latest
Brian Harringf539bc32012-02-06 00:18:37 -0800615fi
616
Brian Harring35767822012-02-01 23:50:45 -0800617# Update chroot.
Zdenek Behan2fbd5af2012-03-12 19:38:50 +0100618# Skip toolchain update because it already happened above, and the chroot is
619# not ready to emerge all cross toolchains.
Allen Webb8bdcfd52021-04-23 16:54:28 -0500620UPDATE_ARGS=( --skip_toolchain_update --noeclean )
David Purselld35d7af2015-05-04 16:37:08 -0700621if [[ "${FLAGS_usepkg}" == "${FLAGS_TRUE}" ]]; then
Brian Harring35767822012-02-01 23:50:45 -0800622 UPDATE_ARGS+=( --usepkg )
Brian Harringf539bc32012-02-06 00:18:37 -0800623else
Brian Harring35767822012-02-01 23:50:45 -0800624 UPDATE_ARGS+=( --nousepkg )
Brian Harringf539bc32012-02-06 00:18:37 -0800625fi
David James184e3902012-02-23 20:19:28 -0800626if [[ "${FLAGS_jobs}" -ne -1 ]]; then
David Purselld35d7af2015-05-04 16:37:08 -0700627 UPDATE_ARGS+=( --jobs="${FLAGS_jobs}" )
David James184e3902012-02-23 20:19:28 -0800628fi
Brian Harring2499bfb2012-12-18 16:23:31 -0800629enter_chroot "${CHROOT_TRUNK_DIR}/src/scripts/update_chroot" "${UPDATE_ARGS[@]}"
Brian Harringf539bc32012-02-06 00:18:37 -0800630
Stefan Zager48c776b2013-10-09 13:01:25 -0700631# The java-config package atm does not support $ROOT. Select a default
632# VM ourselves until that gets fixed upstream.
Jiyoun Ha0aa29af2020-08-04 22:32:46 +0900633enter_chroot sudo eselect java-vm set system openjdk-bin-11
Stefan Zager48c776b2013-10-09 13:01:25 -0700634
Brian Harring35767822012-02-01 23:50:45 -0800635CHROOT_EXAMPLE_OPT=""
636if [[ "$FLAGS_chroot" != "$DEFAULT_CHROOT_DIR" ]]; then
Brian Harringf539bc32012-02-06 00:18:37 -0800637 CHROOT_EXAMPLE_OPT="--chroot=$FLAGS_chroot"
638fi
639
Matt Tennant0a9d32d2012-07-30 16:51:37 -0700640command_completed
Brian Harringf539bc32012-02-06 00:18:37 -0800641
Brian Harring35767822012-02-01 23:50:45 -0800642cat <<EOF
Mike Frysingerbdc4fb12012-02-10 11:20:03 -0500643
644${CROS_LOG_PREFIX:-cros_sdk}: All set up. To enter the chroot, run:
645$ cros_sdk --enter $CHROOT_EXAMPLE_OPT
Brian Harring35767822012-02-01 23:50:45 -0800646
647CAUTION: Do *NOT* rm -rf the chroot directory; if there are stale bind
648mounts you may end up deleting your source tree too. To unmount and
649delete the chroot cleanly, use:
650$ cros_sdk --delete $CHROOT_EXAMPLE_OPT
Mike Frysingerbdc4fb12012-02-10 11:20:03 -0500651
Brian Harring35767822012-02-01 23:50:45 -0800652EOF
David James22dc2ba2012-11-29 15:46:58 -0800653
Mike Frysinger60b580b2019-07-29 00:39:16 -0400654is_nfs() {
655 [[ $(stat -f -L -c %T "$1") == "nfs" ]]
656}
657
Mike Frysinger88cd8c82019-10-03 16:51:28 -0400658if is_nfs "${SUDO_HOME}"; then
659 warn "${SUDO_HOME} is on NFS. This is untested. Send patches if it's broken."
Mike Frysinger60b580b2019-07-29 00:39:16 -0400660fi