blob: f9e53025cf30d78ac86cc505178a92ca08ba4624 [file] [log] [blame]
Bill Richardsonc09b94f2010-03-15 11:40:30 -07001#!/bin/bash
2
3# Copyright (c) 2009 The Chromium OS Authors. All rights reserved.
4# 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 build a bootable keyfob-based chromeos system image from within
8# a chromiumos setup. This assumes that all needed packages have been built into
9# the given target's root with binary packages turned on. This script will
10# build the Chrome OS image using only pre-built binary packages.
11
12# Load common constants. This should be the first executable line.
13# The path to common.sh should be relative to your script's location.
14. "$(dirname "$0")/common.sh"
15
16# Script must be run inside the chroot.
Don Garrett640a0582010-05-04 16:54:28 -070017restart_in_chroot_if_needed $*
Bill Richardsonc09b94f2010-03-15 11:40:30 -070018
19get_default_board
20
21# Flags.
Don Garrette0020b12010-06-17 15:55:35 -070022DEFINE_string board "${DEFAULT_BOARD}" \
Bill Richardsonc09b94f2010-03-15 11:40:30 -070023 "The board to build an image for."
24DEFINE_string build_root "/build" \
25 "The root location for board sysroots."
26DEFINE_integer build_attempt 1 \
27 "The build attempt for this image build."
28DEFINE_string output_root "${DEFAULT_BUILD_ROOT}/images" \
29 "Directory in which to place image result directories (named by version)"
Don Garrette0020b12010-06-17 15:55:35 -070030DEFINE_boolean replace ${FLAGS_FALSE} \
Bill Richardsonc09b94f2010-03-15 11:40:30 -070031 "Overwrite existing output, if any."
Don Garrette0020b12010-06-17 15:55:35 -070032DEFINE_boolean withdev ${FLAGS_TRUE} \
Bill Richardsonc09b94f2010-03-15 11:40:30 -070033 "Include useful developer friendly utilities in the image."
Don Garrette0020b12010-06-17 15:55:35 -070034DEFINE_boolean installmask ${FLAGS_TRUE} \
Bill Richardsonc09b94f2010-03-15 11:40:30 -070035 "Use INSTALL_MASK to shrink the resulting image."
36DEFINE_integer jobs -1 \
37 "How many packages to build in parallel at maximum."
Don Garrette0020b12010-06-17 15:55:35 -070038DEFINE_boolean statefuldev ${FLAGS_TRUE} \
Chris Sosa4bffb8b2010-04-07 17:23:54 -070039 "Install development packages on stateful partition rather than the rootfs"
Antoine Laboure9e585f2010-04-01 15:57:57 -070040DEFINE_string to "" \
41 "The target image file or device"
Don Garrette0020b12010-06-17 15:55:35 -070042DEFINE_boolean factory_install ${FLAGS_FALSE} \
Tom Wai-Hong Tamf87a3672010-05-17 16:06:33 +080043 "Build a smaller image to overlay the factory install shim on; this argument \
44is also required in image_to_usb."
robotboyb75eee32010-04-30 09:51:23 -070045DEFINE_string arm_extra_bootargs "" \
46 "Additional command line options to pass to the ARM kernel."
Don Garrette0020b12010-06-17 15:55:35 -070047DEFINE_boolean recovery ${FLAGS_FALSE} \
Tan Gao6df5aee2010-05-19 14:19:55 -070048 "Build a recovery image. Default: False."
Zelidrag Hornung1d12c1a2010-06-02 10:20:29 -070049DEFINE_integer rootfs_partition_size 1024 \
50 "rootfs parition size in MBs."
51DEFINE_integer rootfs_size 720 \
52 "rootfs filesystem size in MBs."
Bill Richardsonc09b94f2010-03-15 11:40:30 -070053
54# Parse command line.
55FLAGS "$@" || exit 1
56eval set -- "${FLAGS_ARGV}"
57
58# Only now can we die on error. shflags functions leak non-zero error codes,
59# so will die prematurely if 'set -e' is specified before now.
60set -e
61
Don Garrette0020b12010-06-17 15:55:35 -070062if [ -z "${FLAGS_board}" ] ; then
Bill Richardsonc09b94f2010-03-15 11:40:30 -070063 error "--board is required."
64 exit 1
65fi
66
Don Garrette0020b12010-06-17 15:55:35 -070067if [ "${FLAGS_rootfs_size}" -gt "${FLAGS_rootfs_partition_size}" ] ; then
Zelidrag Hornung1d12c1a2010-06-02 10:20:29 -070068 error "rootfs (${FLAGS_rootfs_size} MB) is bigger than partition (${FLAGS_rootfs_partition_size} MB)."
69 exit 1
70fi
71
Nick Sanders8ab729a2010-06-16 03:15:17 -070072EMERGE_CMD="emerge"
73EMERGE_BOARD_CMD="emerge-${FLAGS_board}"
74TOP_SCRIPTS_DIR="$(dirname $0)"
75if [ -e "${TOP_SCRIPTS_DIR}/.emerge" ]; then
76 echo "Using alternate emerge"
77 . "${TOP_SCRIPTS_DIR}/.emerge"
78fi
79
Bill Richardsonc09b94f2010-03-15 11:40:30 -070080# Determine build version.
81. "${SCRIPTS_DIR}/chromeos_version.sh"
82
83# Use canonical path since some tools (e.g. mount) do not like symlinks.
84# Append build attempt to output directory.
85IMAGE_SUBDIR="${CHROMEOS_VERSION_STRING}-a${FLAGS_build_attempt}"
86OUTPUT_DIR="${FLAGS_output_root}/${FLAGS_board}/${IMAGE_SUBDIR}"
87ROOT_FS_DIR="${OUTPUT_DIR}/rootfs"
88ROOT_FS_IMG="${OUTPUT_DIR}/rootfs.image"
Chris Sosa9673f3b2010-05-18 13:24:40 -070089
90# If we are creating a developer image, also create a pristine image with a
91# different name.
92DEVELOPER_IMAGE_NAME=
93PRISTINE_IMAGE_NAME=chromiumos_image.bin
Don Garrette0020b12010-06-17 15:55:35 -070094if [ "${FLAGS_withdev}" -eq "${FLAGS_TRUE}" ]; then
Chris Sosa9673f3b2010-05-18 13:24:40 -070095 PRISTINE_IMAGE_NAME=chromiumos_base_image.bin
96 DEVELOPER_IMAGE_NAME=chromiumos_image.bin
97fi
Tan Gaoa40ed442010-06-02 15:45:19 -070098
Don Garrette0020b12010-06-17 15:55:35 -070099# If we are creating a recovery image, rename pristine image.
100if [ "${FLAGS_recovery}" -eq "${FLAGS_TRUE}" ]; then
Tan Gaoa40ed442010-06-02 15:45:19 -0700101 PRISTINE_IMAGE_NAME=recovery_image.bin
102fi
103
Chris Sosa9673f3b2010-05-18 13:24:40 -0700104OUTPUT_IMG=${FLAGS_to:-${OUTPUT_DIR}/${PRISTINE_IMAGE_NAME}}
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700105
106BOARD="${FLAGS_board}"
107BOARD_ROOT="${FLAGS_build_root}/${BOARD}"
108
109LOOP_DEV=
Chris Sosa4bffb8b2010-04-07 17:23:54 -0700110STATEFUL_LOOP_DEV=
Bill Richardsona81df762010-04-09 08:12:05 -0700111ESP_LOOP_DEV=
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700112
113# What cross-build are we targeting?
114. "${BOARD_ROOT}/etc/make.conf.board_setup"
115LIBC_VERSION=${LIBC_VERSION:-"2.10.1-r1"}
116
117# Figure out ARCH from the given toolchain.
118# TODO: Move to common.sh as a function after scripts are switched over.
Don Garrette0020b12010-06-17 15:55:35 -0700119TC_ARCH=$(echo "${CHOST}" | awk -F'-' '{ print $1 }')
120case "${TC_ARCH}" in
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700121 arm*)
122 ARCH="arm"
123 ;;
124 *86)
125 ARCH="x86"
126 ;;
127 *)
Don Garrette0020b12010-06-17 15:55:35 -0700128 error "Unable to determine ARCH from toolchain: ${CHOST}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700129 exit 1
130esac
131
132# Hack to fix bug where x86_64 CHOST line gets incorrectly added.
133# ToDo(msb): remove this hack.
134PACKAGES_FILE="${BOARD_ROOT}/packages/Packages"
135sudo sed -e "s/CHOST: x86_64-pc-linux-gnu//" -i "${PACKAGES_FILE}"
136
137# Handle existing directory.
Don Garrette0020b12010-06-17 15:55:35 -0700138if [[ -e "${OUTPUT_DIR}" ]]; then
139 if [[ ${FLAGS_replace} -eq ${FLAGS_TRUE} ]]; then
140 sudo rm -rf "${OUTPUT_DIR}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700141 else
Don Garrette0020b12010-06-17 15:55:35 -0700142 echo "Directory ${OUTPUT_DIR} already exists."
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700143 echo "Use --build_attempt option to specify an unused attempt."
144 echo "Or use --replace if you want to overwrite this directory."
145 exit 1
146 fi
147fi
148
149# Create the output directory.
Don Garrette0020b12010-06-17 15:55:35 -0700150mkdir -p "${OUTPUT_DIR}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700151
152cleanup_rootfs_loop() {
Don Garrette0020b12010-06-17 15:55:35 -0700153 sudo umount -d "${ROOT_FS_DIR}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700154}
155
156cleanup_stateful_fs_loop() {
Chris Sosa4bffb8b2010-04-07 17:23:54 -0700157 sudo umount "${ROOT_FS_DIR}/usr/local"
158 sudo umount "${ROOT_FS_DIR}/var"
Chris Sosabde8c1b2010-04-29 14:02:35 -0700159 sudo umount -d "${STATEFUL_DIR}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700160}
161
Bill Richardson8b3bd102010-04-06 15:00:10 -0700162cleanup_esp_loop() {
Don Garrette0020b12010-06-17 15:55:35 -0700163 sudo umount -d "${ESP_DIR}"
Bill Richardson8b3bd102010-04-06 15:00:10 -0700164}
165
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700166cleanup() {
167 # Disable die on error.
168 set +e
169
Don Garrette0020b12010-06-17 15:55:35 -0700170 if [[ -n "${STATEFUL_LOOP_DEV}" ]]; then
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700171 cleanup_stateful_fs_loop
172 fi
173
Don Garrette0020b12010-06-17 15:55:35 -0700174 if [[ -n "${LOOP_DEV}" ]]; then
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700175 cleanup_rootfs_loop
176 fi
177
Don Garrette0020b12010-06-17 15:55:35 -0700178 if [[ -n "${ESP_LOOP_DEV}" ]]; then
Bill Richardson8b3bd102010-04-06 15:00:10 -0700179 cleanup_esp_loop
180 fi
181
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700182 # Turn die on error back on.
183 set -e
184}
185
Chris Sosabde8c1b2010-04-29 14:02:35 -0700186delete_prompt() {
187 echo "An error occurred in your build so your latest output directory" \
188 "is invalid."
189 read -p "Would you like to delete the output directory (y/N)? " SURE
Don Garrette0020b12010-06-17 15:55:35 -0700190 SURE="${SURE:0:1}" # Get just the first character.
Chris Sosabde8c1b2010-04-29 14:02:35 -0700191 if [ "${SURE}" == "y" ] ; then
Don Garrette0020b12010-06-17 15:55:35 -0700192 sudo rm -rf "${OUTPUT_DIR}"
193 echo "Deleted ${OUTPUT_DIR}"
Chris Sosabde8c1b2010-04-29 14:02:35 -0700194 else
Don Garrette0020b12010-06-17 15:55:35 -0700195 echo "Not deleting ${OUTPUT_DIR}. Note dev server updates will not work" \
Chris Sosabde8c1b2010-04-29 14:02:35 -0700196 "until you successfully build another image or delete this directory"
197 fi
198}
199
Chris Sosa9673f3b2010-05-18 13:24:40 -0700200# $1 - Directory where developer rootfs is mounted.
201# $2 - Directory where developer stateful_partition is mounted.
202developer_cleanup() {
Don Garrette0020b12010-06-17 15:55:35 -0700203 "${SCRIPTS_DIR}/mount_gpt_image.sh" -u -r "$1" -s "$2"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700204 delete_prompt
205}
206
Don Garrette0020b12010-06-17 15:55:35 -0700207# Creates a modified image based on ${OUTPUT_IMG} with additional packages.
Tan Gaoa40ed442010-06-02 15:45:19 -0700208create_mod_image() {
209 local image_type=$1
Chris Sosa9673f3b2010-05-18 13:24:40 -0700210 local root_fs_dir="${OUTPUT_DIR}/rootfs_dev"
211 local root_fs_img="${OUTPUT_DIR}/rootfs_dev.image"
Tan Gaoa40ed442010-06-02 15:45:19 -0700212 local image_to_mount=${DEVELOPER_IMAGE_NAME}
213 local output_img="${OUTPUT_DIR}/${image_to_mount}"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700214
215 # Create stateful partition of the same size as the rootfs.
Don Garrette0020b12010-06-17 15:55:35 -0700216 local stateful_img="${OUTPUT_DIR}/stateful_partition_dev.image"
217 local stateful_dir="${OUTPUT_DIR}/stateful_partition_dev"
Tan Gaoa40ed442010-06-02 15:45:19 -0700218 local file_to_touch=".dev_mode"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700219
Don Garrette0020b12010-06-17 15:55:35 -0700220 trap "developer_cleanup \"${root_fs_dir}\" \"${stateful_dir}\"" EXIT
Chris Sosa9673f3b2010-05-18 13:24:40 -0700221
Don Garrette0020b12010-06-17 15:55:35 -0700222 if [ "${image_type}" == "dev" ]; then
Tan Gaoa40ed442010-06-02 15:45:19 -0700223 # Mount a new copy of the base image.
Don Garrette0020b12010-06-17 15:55:35 -0700224 echo "Creating developer image from base image ${OUTPUT_IMG}"
225 cp "${OUTPUT_IMG}" "${output_img}"
226 elif [ "${image_type}" == "recovery" ]; then
227 image_to_mount=${PRISTINE_IMAGE_NAME}
Tan Gaoa40ed442010-06-02 15:45:19 -0700228 file_to_touch=".recovery_installer"
229 fi
230
Don Garrette0020b12010-06-17 15:55:35 -0700231 ${SCRIPTS_DIR}/mount_gpt_image.sh --from "${OUTPUT_DIR}" \
232 --image "${image_to_mount}" -r "${root_fs_dir}" -s "${stateful_dir}"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700233
Don Garrette0020b12010-06-17 15:55:35 -0700234 if [ "${image_type}" == "dev" ]; then
Tan Gaoa40ed442010-06-02 15:45:19 -0700235 # Determine the root dir for developer packages.
Don Garrette0020b12010-06-17 15:55:35 -0700236 local root_dev_dir="${root_fs_dir}"
237 [ ${FLAGS_statefuldev} -eq ${FLAGS_TRUE} ] && \
238 root_dev_dir="${root_fs_dir}/usr/local"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700239
Tan Gaoa40ed442010-06-02 15:45:19 -0700240 # Install developer packages described in chromeos-dev.
Don Garrette0020b12010-06-17 15:55:35 -0700241 sudo INSTALL_MASK="${INSTALL_MASK}" ${EMERGE_BOARD_CMD} \
242 --root="${root_dev_dir}" --root-deps=rdeps \
243 --usepkgonly chromeos-dev ${EMERGE_JOBS}
244 elif [ "${image_type}" == "recovery" ]; then
245 # Install recovery installer.
246 sudo ${EMERGE_BOARD_CMD} --root=${root_fs_dir} --usepkgonly \
Tan Gaoa40ed442010-06-02 15:45:19 -0700247 --root-deps=rdeps --nodeps chromeos-recovery
248 fi
Chris Sosa9673f3b2010-05-18 13:24:40 -0700249
250 # Re-run ldconfig to fix /etc/ldconfig.so.cache.
Don Garrette0020b12010-06-17 15:55:35 -0700251 sudo /sbin/ldconfig -r "${root_fs_dir}"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700252
253 # Mark the image as a developer image (input to chromeos_startup).
Don Garrette0020b12010-06-17 15:55:35 -0700254 sudo mkdir -p "${root_fs_dir}/root"
255 sudo touch "${root_fs_dir}/root/${file_to_touch}"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700256
Don Garrette0020b12010-06-17 15:55:35 -0700257 if [ "${image_type}" == "dev" ]; then
Tan Gaoa40ed442010-06-02 15:45:19 -0700258 # Additional changes to developer image.
Chris Sosa9673f3b2010-05-18 13:24:40 -0700259
Tan Gaoa40ed442010-06-02 15:45:19 -0700260 # The ldd tool is a useful shell script but lives in glibc; just copy it.
261 sudo cp -a "$(which ldd)" "${root_dev_dir}/usr/bin"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700262
Tan Gaoa40ed442010-06-02 15:45:19 -0700263 # If vim is installed, then a vi symlink would probably help.
264 if [[ -x "${root_fs_dir}/usr/local/bin/vim" ]]; then
265 sudo ln -sf vim "${root_fs_dir}/usr/local/bin/vi"
266 fi
Chris Sosa9673f3b2010-05-18 13:24:40 -0700267
Tan Gaoa40ed442010-06-02 15:45:19 -0700268 # Check that the image has been correctly created. Only do it if not
269 # building a factory install image, as the INSTALL_MASK for it will
270 # make test_image fail.
Don Garrette0020b12010-06-17 15:55:35 -0700271 if [[ ${FLAGS_factory_install} -eq ${FLAGS_FALSE} ]] ; then
Tan Gaoa40ed442010-06-02 15:45:19 -0700272 "${SCRIPTS_DIR}/test_image" \
Don Garrette0020b12010-06-17 15:55:35 -0700273 --root="${root_fs_dir}" \
274 --target="${ARCH}"
Tan Gaoa40ed442010-06-02 15:45:19 -0700275 fi
Don Garrette0020b12010-06-17 15:55:35 -0700276 echo "Developer image built and stored at ${output_img}"
Girts Folkmanis7a8a8382010-05-18 22:52:25 -0700277 fi
Chris Sosa9673f3b2010-05-18 13:24:40 -0700278
279 trap - EXIT
Don Garrette0020b12010-06-17 15:55:35 -0700280 ${SCRIPTS_DIR}/mount_gpt_image.sh -u -r "${root_fs_dir}" -s "${stateful_dir}"
281 sudo rm -rf "${root_fs_dir}" "${stateful_dir}"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700282}
283
Chris Sosa4bffb8b2010-04-07 17:23:54 -0700284# ${DEV_IMAGE_ROOT} specifies the location of where developer packages will
285# be installed on the stateful dir. On a Chromium OS system, this will
Don Garrette0020b12010-06-17 15:55:35 -0700286# translate to /usr/local.
Chris Sosa4bffb8b2010-04-07 17:23:54 -0700287DEV_IMAGE_ROOT=
288
Chris Sosabde8c1b2010-04-29 14:02:35 -0700289trap "cleanup && delete_prompt" EXIT
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700290
Don Garrette0020b12010-06-17 15:55:35 -0700291mkdir -p "${ROOT_FS_DIR}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700292
293# Create and format the root file system.
294
295# Check for loop device before creating image.
296LOOP_DEV=$(sudo losetup -f)
Don Garrette0020b12010-06-17 15:55:35 -0700297if [ -z "${LOOP_DEV}" ] ; then
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700298 echo "No free loop device. Free up a loop device or reboot. exiting. "
299 exit 1
300fi
301
302# Create root file system disk image to fit on a 1GB memory stick.
303# 1 GB in hard-drive-manufacturer-speak is 10^9, not 2^30. 950MB < 10^9 bytes.
Don Garrette0020b12010-06-17 15:55:35 -0700304if [[ ${FLAGS_factory_install} -eq ${FLAGS_TRUE} ]] ; then
Girts Folkmanis7a8a8382010-05-18 22:52:25 -0700305 ROOT_SIZE_BYTES=$((1024 * 1024 * 300))
Tom Wai-Hong Tamf87a3672010-05-17 16:06:33 +0800306else
Zelidrag Hornung1d12c1a2010-06-02 10:20:29 -0700307 ROOT_SIZE_BYTES=$((1024 * 1024 * ${FLAGS_rootfs_size}))
Tom Wai-Hong Tamf87a3672010-05-17 16:06:33 +0800308fi
309
Don Garrette0020b12010-06-17 15:55:35 -0700310dd if=/dev/zero of="${ROOT_FS_IMG}" bs=1 count=1 seek=$((ROOT_SIZE_BYTES - 1))
311sudo losetup "${LOOP_DEV}" "${ROOT_FS_IMG}"
312sudo mkfs.ext3 "${LOOP_DEV}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700313
314# Tune and mount rootfs.
315UUID=$(uuidgen)
316DISK_LABEL="C-KEYFOB"
Don Garrette0020b12010-06-17 15:55:35 -0700317sudo tune2fs -L "${DISK_LABEL}" -U "${UUID}" -c 0 -i 0 "${LOOP_DEV}"
318sudo mount "${LOOP_DEV}" "${ROOT_FS_DIR}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700319
320# Create stateful partition of the same size as the rootfs.
Don Garrette0020b12010-06-17 15:55:35 -0700321STATEFUL_IMG="${OUTPUT_DIR}/stateful_partition.image"
322STATEFUL_DIR="${OUTPUT_DIR}/stateful_partition"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700323STATEFUL_LOOP_DEV=$(sudo losetup -f)
Don Garrette0020b12010-06-17 15:55:35 -0700324if [ -z "${STATEFUL_LOOP_DEV}" ] ; then
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700325 echo "No free loop device. Free up a loop device or reboot. exiting. "
326 exit 1
327fi
Don Garrette0020b12010-06-17 15:55:35 -0700328dd if=/dev/zero of="${STATEFUL_IMG}" bs=1 count=1 seek=$((ROOT_SIZE_BYTES - 1))
329sudo losetup "${STATEFUL_LOOP_DEV}" "${STATEFUL_IMG}"
330sudo mkfs.ext3 "${STATEFUL_LOOP_DEV}"
331sudo tune2fs -L "C-STATE" -U "${UUID}" -c 0 -i 0 \
332 "${STATEFUL_LOOP_DEV}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700333
334# Mount the stateful partition.
Don Garrette0020b12010-06-17 15:55:35 -0700335mkdir -p "${STATEFUL_DIR}"
336sudo mount "${STATEFUL_LOOP_DEV}" "${STATEFUL_DIR}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700337
Don Garrette0020b12010-06-17 15:55:35 -0700338# Set dev image root now that we have mounted the stateful partition
339# we created.
340DEV_IMAGE_ROOT="${STATEFUL_DIR}/dev_image"
Chris Sosa4bffb8b2010-04-07 17:23:54 -0700341
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700342# Turn root file system into bootable image.
Don Garrette0020b12010-06-17 15:55:35 -0700343if [[ "${ARCH}" = "x86" ]]; then
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700344 # Setup extlinux configuration.
345 # TODO: For some reason the /dev/disk/by-uuid is not being generated by udev
Don Garrette0020b12010-06-17 15:55:35 -0700346 # in the initramfs. When we figure that out, switch to root=UUID=${UUID}.
347 sudo mkdir -p "${ROOT_FS_DIR}"/boot
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700348 # TODO(adlr): use initramfs for booting.
Don Garrette0020b12010-06-17 15:55:35 -0700349 cat <<EOF | sudo dd of="${ROOT_FS_DIR}"/boot/extlinux.conf
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700350DEFAULT chromeos-usb
351PROMPT 0
352TIMEOUT 0
353
354label chromeos-usb
355 menu label chromeos-usb
356 kernel vmlinuz
Bill Richardson25e4c182010-06-17 12:50:49 -0700357 append quiet console=tty2 init=/sbin/init boot=local rootwait root=/dev/sdb3 ro noresume noswap i915.modeset=1 loglevel=1 cros_legacy
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700358
359label chromeos-hd
360 menu label chromeos-hd
361 kernel vmlinuz
Bill Richardson25e4c182010-06-17 12:50:49 -0700362 append quiet console=tty2 init=/sbin/init boot=local rootwait root=HDROOT ro noresume noswap i915.modeset=1 loglevel=1 cros_legacy
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700363EOF
364
365 # Make partition bootable and label it.
366 sudo extlinux -z --install "${ROOT_FS_DIR}/boot"
367fi
368
369# -- Install packages into the root file system --
370
371# We need to install libc manually from the cross toolchain.
372# TODO: Improve this? We only want libc and not the whole toolchain.
373PKGDIR="/var/lib/portage/pkgs/cross/"
374sudo tar jxvpf \
375 "${PKGDIR}/${CHOST}/cross-${CHOST}"/glibc-${LIBC_VERSION}.tbz2 \
Don Garrette0020b12010-06-17 15:55:35 -0700376 -C "${ROOT_FS_DIR}" --strip-components=3 \
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700377 --exclude=usr/include --exclude=sys-include --exclude=*.a --exclude=*.o
378
379# We need to install libstdc++ manually from the cross toolchain.
380# TODO: Figure out a better way of doing this?
381sudo cp -a "${BOARD_ROOT}"/lib/libgcc_s.so* "${ROOT_FS_DIR}/lib"
382sudo cp -a "${BOARD_ROOT}"/usr/lib/libstdc++.so* "${ROOT_FS_DIR}/usr/lib"
383
384INSTALL_MASK=""
Don Garrette0020b12010-06-17 15:55:35 -0700385if [[ ${FLAGS_installmask} -eq ${FLAGS_TRUE} ]] ; then
386 INSTALL_MASK="${DEFAULT_INSTALL_MASK}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700387fi
388
Tom Wai-Hong Tamf87a3672010-05-17 16:06:33 +0800389# Reduce the size of factory install shim.
390# TODO: Build a separated ebuild for the factory install shim to reduce size.
Don Garrette0020b12010-06-17 15:55:35 -0700391if [[ ${FLAGS_factory_install} -eq ${FLAGS_TRUE} ]] ; then
392 INSTALL_MASK="${INSTALL_MASK} ${FACTORY_INSTALL_MASK}"
Tom Wai-Hong Tamf87a3672010-05-17 16:06:33 +0800393fi
394
Don Garrette0020b12010-06-17 15:55:35 -0700395if [[ ${FLAGS_jobs} -ne -1 ]]; then
396 EMERGE_JOBS="--jobs=${FLAGS_jobs}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700397fi
398
Don Garrette0020b12010-06-17 15:55:35 -0700399# Prepare stateful partition with some pre-created directories.
Chris Sosa4bffb8b2010-04-07 17:23:54 -0700400sudo mkdir -p "${DEV_IMAGE_ROOT}"
401sudo mkdir -p "${STATEFUL_DIR}/var"
Bill Richardson8b3bd102010-04-06 15:00:10 -0700402
Chris Sosa4bffb8b2010-04-07 17:23:54 -0700403# Create symlinks so that /usr/local/usr based directories are symlinked to
404# /usr/local/ directories e.g. /usr/local/usr/bin -> /usr/local/bin, etc.
Chris Sosa702618f2010-05-14 12:52:32 -0700405setup_symlinks_on_root "${DEV_IMAGE_ROOT}" "${STATEFUL_DIR}/var" \
406 "${STATEFUL_DIR}"
Bill Richardson8b3bd102010-04-06 15:00:10 -0700407
Chris Sosa4bffb8b2010-04-07 17:23:54 -0700408# Perform binding rather than symlinking because directories must exist
Don Garrette0020b12010-06-17 15:55:35 -0700409# on rootfs so that we can bind at run-time since rootfs is read-only.
Chris Sosa4bffb8b2010-04-07 17:23:54 -0700410echo "Binding directories from stateful partition onto the rootfs"
411sudo mkdir -p "${ROOT_FS_DIR}/usr/local"
412sudo mount --bind "${DEV_IMAGE_ROOT}" "${ROOT_FS_DIR}/usr/local"
413sudo mkdir -p "${ROOT_FS_DIR}/var"
414sudo mount --bind "${STATEFUL_DIR}/var" "${ROOT_FS_DIR}/var"
Nick Sanders8ab729a2010-06-16 03:15:17 -0700415sudo mkdir -p "${ROOT_FS_DIR}/dev"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700416
Don Garrette0020b12010-06-17 15:55:35 -0700417# We "emerge --root=${ROOT_FS_DIR} --root-deps=rdeps --usepkgonly" all of the
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700418# runtime packages for chrome os. This builds up a chrome os image from binary
419# packages with runtime dependencies only. We use INSTALL_MASK to trim the
420# image size as much as possible.
Don Garrette0020b12010-06-17 15:55:35 -0700421sudo INSTALL_MASK="${INSTALL_MASK}" ${EMERGE_BOARD_CMD} \
422 --root="${ROOT_FS_DIR}" --root-deps=rdeps \
423 --usepkgonly chromeos ${EMERGE_JOBS}
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700424
Bill Richardson8b3bd102010-04-06 15:00:10 -0700425# Create EFI System Partition to boot stock EFI BIOS (but not ChromeOS EFI
426# BIOS). We only need this for x86, but it's simpler and safer to keep the disk
427# images the same for both x86 and ARM.
428ESP_IMG=${OUTPUT_DIR}/esp.image
429# NOTE: The size argument for mkfs.vfat is in 1024-byte blocks. We'll hard-code
430# it to 16M for now.
431ESP_BLOCKS=16384
432/usr/sbin/mkfs.vfat -C ${OUTPUT_DIR}/esp.image ${ESP_BLOCKS}
433ESP_DIR=${OUTPUT_DIR}/esp
Bill Richardsona81df762010-04-09 08:12:05 -0700434ESP_LOOP_DEV=$(sudo losetup -f)
Don Garrette0020b12010-06-17 15:55:35 -0700435if [ -z "${ESP_LOOP_DEV}" ] ; then
Bill Richardsona81df762010-04-09 08:12:05 -0700436 echo "No free loop device. Free up a loop device or reboot. exiting. "
437 exit 1
438fi
439mkdir -p "${ESP_DIR}"
440sudo losetup "${ESP_LOOP_DEV}" "${ESP_IMG}"
441sudo mount "${ESP_LOOP_DEV}" "${ESP_DIR}"
442sudo mkdir -p "${ESP_DIR}/efi/boot"
443sudo grub-mkimage -p /efi/boot -o "${ESP_DIR}/efi/boot/bootx64.efi" \
Bill Richardson8b3bd102010-04-06 15:00:10 -0700444 part_gpt fat ext2 normal boot sh chain configfile linux
Bill Richardson9c5e5ec2010-05-14 17:00:21 -0700445cat <<'EOF' | sudo dd of="${ESP_DIR}/efi/boot/grub.cfg"
Bill Richardson8b3bd102010-04-06 15:00:10 -0700446set default=0
Bill Richardson9c5e5ec2010-05-14 17:00:21 -0700447set timeout=2
Bill Richardson8b3bd102010-04-06 15:00:10 -0700448
Bill Richardson9c5e5ec2010-05-14 17:00:21 -0700449# NOTE: These magic grub variables are a Chrome OS hack. They are not portable.
450
451menuentry "local image A" {
Bill Richardson25e4c182010-06-17 12:50:49 -0700452 linux $grubpartA/boot/vmlinuz quiet console=tty2 init=/sbin/init boot=local rootwait root=/dev/$linuxpartA ro noresume noswap i915.modeset=1 loglevel=1 cros_efi
Bill Richardsona81df762010-04-09 08:12:05 -0700453}
454
Bill Richardson9c5e5ec2010-05-14 17:00:21 -0700455menuentry "local image B" {
Bill Richardson25e4c182010-06-17 12:50:49 -0700456 linux $grubpartB/boot/vmlinuz quiet console=tty2 init=/sbin/init boot=local rootwait root=/dev/$linuxpartB ro noresume noswap i915.modeset=1 loglevel=1 cros_efi
Bill Richardson041bd712010-04-27 09:36:14 -0700457}
458
Nick Sanders9e305db2010-06-11 15:18:35 -0700459menuentry "Alternate USB Boot" {
Bill Richardson25e4c182010-06-17 12:50:49 -0700460 linux (hd0,3)/boot/vmlinuz quiet console=tty2 init=/sbin/init boot=local rootwait root=/dev/sdb3 ro noresume noswap i915.modeset=1 loglevel=1 cros_efi
Nick Sanders9e305db2010-06-11 15:18:35 -0700461}
462
Bill Richardson8b3bd102010-04-06 15:00:10 -0700463EOF
464
Bill Richardson3fefd2a2010-06-03 11:03:27 -0700465# FIXME: At the moment, we're working on signed images for x86 only. ARM will
466# support this before shipping, but at the moment they don't.
Don Garrette0020b12010-06-17 15:55:35 -0700467if [[ "${ARCH}" = "x86" ]]; then
468
Bill Richardson3fefd2a2010-06-03 11:03:27 -0700469 # Legacy BIOS will use the kernel in the rootfs (via syslinux), as will
470 # standard EFI BIOS (via grub, from the EFI System Partition). Chrome OS BIOS
471 # will use a separate signed kernel partition, which we'll create now.
Don Garrette0020b12010-06-17 15:55:35 -0700472 # FIXME: remove serial output, debugging messages.
Bill Richardson3fefd2a2010-06-03 11:03:27 -0700473 cat <<'EOF' > "${OUTPUT_DIR}/config.txt"
Bill Richardson67956222010-05-28 15:38:56 -0700474earlyprintk=serial,ttyS0,115200
475console=ttyS0,115200
476init=/sbin/init
477add_efi_memmap
478boot=local
479rootwait
480root=/dev/sd%D%P
481ro
482noresume
483noswap
484i915.modeset=1
485loglevel=7
Bill Richardson25e4c182010-06-17 12:50:49 -0700486cros_secure
Bill Richardson67956222010-05-28 15:38:56 -0700487EOF
Don Garrette0020b12010-06-17 15:55:35 -0700488
Bill Richardson3fefd2a2010-06-03 11:03:27 -0700489 # FIXME: We need to specify the real keys and certs here!
490 SIG_DIR="${SRC_ROOT}/platform/vboot_reference/tests/testkeys"
Bill Richardson6ed13582010-06-16 21:38:15 -0700491
Don Garrette0020b12010-06-17 15:55:35 -0700492 # Wrap the public keys with VbPublicKey headers.
Bill Richardson6ed13582010-06-16 21:38:15 -0700493 vbutil_key --pack \
494 --in "${SIG_DIR}/key_rsa2048.keyb" \
495 --version 1 --algorithm 4 \
496 --out "${OUTPUT_DIR}/key_alg4.vbpubk"
497
498 vbutil_key --pack \
499 --in "${SIG_DIR}/key_rsa4096.keyb" \
500 --version 1 --algorithm 8 \
501 --out "${OUTPUT_DIR}/key_alg8.vbpubk"
502
503 vbutil_keyblock --pack "${OUTPUT_DIR}/data4_sign8.keyblock" \
504 --datapubkey "${OUTPUT_DIR}/key_alg4.vbpubk" \
505 --signprivate "${SIG_DIR}/key_rsa4096.pem" \
506 --algorithm 8 --flags 3
Don Garrette0020b12010-06-17 15:55:35 -0700507
508 # Verify the keyblock.
Bill Richardson6ed13582010-06-16 21:38:15 -0700509 vbutil_keyblock --unpack "${OUTPUT_DIR}/data4_sign8.keyblock" \
510 --signpubkey "${OUTPUT_DIR}/key_alg8.vbpubk"
511
512 # Sign the kernel:
513 vbutil_kernel --pack "${OUTPUT_DIR}/vmlinuz.image" \
514 --keyblock "${OUTPUT_DIR}/data4_sign8.keyblock" \
515 --signprivate "${SIG_DIR}/key_rsa2048.pem" \
516 --version 1 \
517 --config "${OUTPUT_DIR}/config.txt" \
518 --bootloader /lib64/bootstub/bootstub.efi \
519 --vmlinuz "${ROOT_FS_DIR}/boot/vmlinuz"
Don Garrette0020b12010-06-17 15:55:35 -0700520
521 # And verify it.
Bill Richardson6ed13582010-06-16 21:38:15 -0700522 vbutil_kernel --verify "${OUTPUT_DIR}/vmlinuz.image" \
523 --signpubkey "${OUTPUT_DIR}/key_alg8.vbpubk"
524
Bill Richardson3fefd2a2010-06-03 11:03:27 -0700525else
526 # FIXME: For now, ARM just uses the unsigned kernel by itself.
527 cp -f "${ROOT_FS_DIR}/boot/vmlinuz" "${OUTPUT_DIR}/vmlinuz.image"
528fi
Bill Richardson67956222010-05-28 15:38:56 -0700529
Bill Richardson67956222010-05-28 15:38:56 -0700530
Chris Sosa3f21b992010-05-10 16:34:47 -0700531# Perform any customizations on the root file system that are needed.
Chris Sosa503efe12010-04-08 10:05:46 -0700532"${SCRIPTS_DIR}/customize_rootfs" \
Don Garrette0020b12010-06-17 15:55:35 -0700533 --root="${ROOT_FS_DIR}" \
534 --target="${ARCH}" \
535 --board="${BOARD}"
Chris Sosa503efe12010-04-08 10:05:46 -0700536
Tom Wai-Hong Tamf87a3672010-05-17 16:06:33 +0800537# Don't test the factory install shim.
Don Garrette0020b12010-06-17 15:55:35 -0700538if [[ ${FLAGS_factory_install} -eq ${FLAGS_FALSE} ]] ; then
Tom Wai-Hong Tamf87a3672010-05-17 16:06:33 +0800539 # Check that the image has been correctly created.
540 "${SCRIPTS_DIR}/test_image" \
Don Garrette0020b12010-06-17 15:55:35 -0700541 --root="${ROOT_FS_DIR}" \
542 --target="${ARCH}"
Tom Wai-Hong Tamf87a3672010-05-17 16:06:33 +0800543fi
Chris Sosa503efe12010-04-08 10:05:46 -0700544
Chris Sosa4bffb8b2010-04-07 17:23:54 -0700545# Clean up symlinks so they work on a running target rooted at "/".
546# Here development packages are rooted at /usr/local. However, do not
547# create /usr/local or /var on host (already exist on target).
Chris Sosa702618f2010-05-14 12:52:32 -0700548setup_symlinks_on_root "/usr/local" "/var" "${STATEFUL_DIR}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700549
550# Cleanup loop devices.
Chris Sosa4bffb8b2010-04-07 17:23:54 -0700551cleanup
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700552
Chris Sosabde8c1b2010-04-29 14:02:35 -0700553trap delete_prompt EXIT
554
Tan Gao6df5aee2010-05-19 14:19:55 -0700555RECOVERY="--norecovery"
Don Garrette0020b12010-06-17 15:55:35 -0700556if [[ ${FLAGS_recovery} -eq ${FLAGS_TRUE} ]]; then
Tan Gao6df5aee2010-05-19 14:19:55 -0700557 RECOVERY="--recovery"
558fi
559
Don Garrette0020b12010-06-17 15:55:35 -0700560# Create the GPT-formatted image.
Bill Richardson4364a2e2010-03-30 14:17:34 -0700561${SCRIPTS_DIR}/build_gpt.sh \
robotboyb75eee32010-04-30 09:51:23 -0700562 --arch=${ARCH} \
563 --board=${FLAGS_board} \
564 --arm_extra_bootargs="${FLAGS_arm_extra_bootargs}" \
Zelidrag Hornung1d12c1a2010-06-02 10:20:29 -0700565 --rootfs_partition_size=${FLAGS_rootfs_partition_size} \
Tan Gao6df5aee2010-05-19 14:19:55 -0700566 ${RECOVERY} \
robotboyb75eee32010-04-30 09:51:23 -0700567 "${OUTPUT_DIR}" \
568 "${OUTPUT_IMG}"
Bill Richardson4364a2e2010-03-30 14:17:34 -0700569
Don Garrette0020b12010-06-17 15:55:35 -0700570# Create a recovery image based on the chromium os base image.
571[ "${FLAGS_recovery}" -eq "${FLAGS_TRUE}" ] && create_mod_image "recovery"
Tan Gaoa40ed442010-06-02 15:45:19 -0700572trap - EXIT
573
Don Garrette0020b12010-06-17 15:55:35 -0700574# Create a developer image based on the chromium os base image.
575[ "${FLAGS_withdev}" -eq "${FLAGS_TRUE}" ] && create_mod_image "dev"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700576trap - EXIT
577
Bill Richardson6ed13582010-06-16 21:38:15 -0700578# FIXME: only signing things for x86 right now.
Don Garrette0020b12010-06-17 15:55:35 -0700579if [[ "${ARCH}" = "x86" ]]; then
580 # Verify the final image.
Bill Richardson6ed13582010-06-16 21:38:15 -0700581 load_kernel_test "${OUTPUT_IMG}" "${OUTPUT_DIR}/key_alg8.vbpubk"
582fi
583
584# Clean up temporary files.
585rm -f "${ROOT_FS_IMG}" "${STATEFUL_IMG}" "${OUTPUT_DIR}/vmlinuz.image" \
586 "${ESP_IMG}" "${OUTPUT_DIR}/data4_sign8.keyblock" \
Don Garrette0020b12010-06-17 15:55:35 -0700587 "${OUTPUT_DIR}/key_alg4.vbpubk" "${OUTPUT_DIR}/key_alg8.vbpubk"
Bill Richardson6ed13582010-06-16 21:38:15 -0700588rmdir "${ROOT_FS_DIR}" "${STATEFUL_DIR}" "${ESP_DIR}"
589
590OUTSIDE_OUTPUT_DIR="../build/images/${FLAGS_board}/${IMAGE_SUBDIR}"
Bill Richardson67956222010-05-28 15:38:56 -0700591
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700592echo "Done. Image created in ${OUTPUT_DIR}"
Don Garrette0020b12010-06-17 15:55:35 -0700593echo "Chromium OS image created as ${PRISTINE_IMAGE_NAME}"
594if [ "${FLAGS_recovery}" -eq "${FLAGS_TRUE}" ]; then
595 echo "Recovery image created as ${PRISTINE_IMAGE_NAME}"
Tan Gaoa40ed442010-06-02 15:45:19 -0700596fi
Don Garrette0020b12010-06-17 15:55:35 -0700597if [ "${FLAGS_withdev}" -eq "${FLAGS_TRUE}" ]; then
598 echo "Developer image created as ${DEVELOPER_IMAGE_NAME}"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700599fi
Nick Sanders8ab729a2010-06-16 03:15:17 -0700600
Nick Sandersd2509272010-06-16 03:50:04 -0700601print_time_elapsed
602
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700603echo "To copy to USB keyfob, OUTSIDE the chroot, do something like:"
Daniel Eratdd9818a2010-04-26 09:16:44 -0700604echo " ./image_to_usb.sh --from=${OUTSIDE_OUTPUT_DIR} --to=/dev/sdX"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700605echo "To convert to VMWare image, OUTSIDE the chroot, do something like:"
606echo " ./image_to_vmware.sh --from=${OUTSIDE_OUTPUT_DIR}"
607echo "from the scripts directory where you entered the chroot."