blob: 0920f60a10e7769286ede021273df8af49dad6b0 [file] [log] [blame]
J. Richard Barnette84477772011-07-25 13:41:33 -07001#!/bin/bash
Bill Richardsonc09b94f2010-03-15 11:40:30 -07002
Peter Mayo82975f92012-05-01 11:03:31 -04003# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
Bill Richardsonc09b94f2010-03-15 11:40:30 -07004# 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
Brian Harringaa13ea42012-03-15 18:31:03 -070012SCRIPT_ROOT=$(dirname $(readlink -f "$0"))
J. Richard Barnette84477772011-07-25 13:41:33 -070013. "${SCRIPT_ROOT}/build_library/build_common.sh" || exit 1
Bill Richardsonc09b94f2010-03-15 11:40:30 -070014
David James855afb72012-03-14 20:04:59 -070015# Developer-visible flags.
Liam McLoughlin12a9a842012-10-10 10:37:06 -040016DEFINE_string adjust_part "" \
17 "Adjustments to apply to the partition table"
Don Garrette0020b12010-06-17 15:55:35 -070018DEFINE_string board "${DEFAULT_BOARD}" \
Bill Richardsonc09b94f2010-03-15 11:40:30 -070019 "The board to build an image for."
David James855afb72012-03-14 20:04:59 -070020DEFINE_string boot_args "noinitrd" \
21 "Additional boot arguments to pass to the commandline"
22DEFINE_boolean enable_rootfs_verification ${FLAGS_TRUE} \
23 "Default all bootloaders to use kernel-based root fs integrity checking."
Bill Richardsonc09b94f2010-03-15 11:40:30 -070024DEFINE_string output_root "${DEFAULT_BUILD_ROOT}/images" \
25 "Directory in which to place image result directories (named by version)"
Liam McLoughlin5b37c542012-08-16 11:09:37 -070026DEFINE_string disk_layout "default" \
27 "The board to build an image for."
David Rochbergcf932372011-06-30 21:25:08 -040028DEFINE_boolean standard_backdoor ${FLAGS_TRUE} \
29 "Install standard backdoor credentials for testing"
David James855afb72012-03-14 20:04:59 -070030DEFINE_string usb_disk /dev/sdb3 \
31 "Path syslinux should use to do a usb boot. Default: /dev/sdb3"
Che-Liang Chiou611d5b72011-07-27 16:03:26 +080032
Chris Sosaef4a6452011-10-27 16:01:07 -070033FLAGS_HELP="USAGE: build_image [flags] [list of images to build].
34This script is used to build a Chromium OS image. Chromium OS comes in many
35different forms. This scripts can be used to build the following:
36
37base - Pristine Chromium OS image. As similar to Chrome OS as possible.
38dev - Developer image. Like base but with additional developer packages.
39test - Like dev, but with additional test specific packages and can be easily
40 used for automated testing using scripts like run_remote_tests, etc.
41factory_test - Like test but with extra packages and modifications used to
42 test images in a factory setting. Cannot be built along with a test image.
43factory_install - Install shim for bootstrapping the factory test process.
44 Cannot be built along with any other image.
45
David James855afb72012-03-14 20:04:59 -070046Examples:
Chris Sosaef4a6452011-10-27 16:01:07 -070047
48build_image --board=<board> dev test - builds developer and test images.
49build_image --board=<board> factory_install - builds a factory install shim.
50...
51"
David James855afb72012-03-14 20:04:59 -070052show_help_if_requested "$@"
53
54# The following options are advanced options, only available to those willing
55# to read the source code. They are not shown in help output, since they are
56# not needed for the typical developer workflow.
David James855afb72012-03-14 20:04:59 -070057DEFINE_integer build_attempt 1 \
58 "The build attempt for this image build."
59DEFINE_integer jobs -1 \
60 "How many packages to build in parallel at maximum."
61DEFINE_boolean replace ${FLAGS_FALSE} \
62 "Overwrite existing output, if any."
63DEFINE_string symlink "latest" \
64 "Symlink name to use for this image."
Liam McLoughlin07279032012-06-25 17:31:11 -070065DEFINE_string version "" \
66 "Overrides version number in name to this version."
Chris Sosaef4a6452011-10-27 16:01:07 -070067
Bill Richardsonc09b94f2010-03-15 11:40:30 -070068# Parse command line.
69FLAGS "$@" || exit 1
70eval set -- "${FLAGS_ARGV}"
71
72# Only now can we die on error. shflags functions leak non-zero error codes,
Brian Harring7f175a52012-03-02 05:37:00 -080073# so will die prematurely if 'switch_to_strict_mode' is specified before now.
74switch_to_strict_mode
Bill Richardsonc09b94f2010-03-15 11:40:30 -070075
J. Richard Barnettee4e3dec2011-08-08 16:35:02 -070076# Determine build version.
77OVERLAY_CHROMEOS_DIR="${SRC_ROOT}/third_party/chromiumos-overlay/chromeos"
78. "${OVERLAY_CHROMEOS_DIR}/config/chromeos_version.sh" || exit 1
J. Richard Barnettea308b392011-08-29 13:53:34 -070079# N.B. Ordering matters for some of the libraries below, because
80# some of the files contain initialization used by later files.
J. Richard Barnetteaaef7612011-08-11 17:10:28 -070081. "${BUILD_LIBRARY_DIR}/board_options.sh" || exit 1
Liam McLoughlin5b37c542012-08-16 11:09:37 -070082. "${BUILD_LIBRARY_DIR}/disk_layout_util.sh" || exit 1
J. Richard Barnette5f9dbe42011-08-22 14:31:33 -070083. "${BUILD_LIBRARY_DIR}/mount_gpt_util.sh" || exit 1
J. Richard Barnettea308b392011-08-29 13:53:34 -070084. "${BUILD_LIBRARY_DIR}/build_image_util.sh" || exit 1
85. "${BUILD_LIBRARY_DIR}/base_image_util.sh" || exit 1
86. "${BUILD_LIBRARY_DIR}/dev_image_util.sh" || exit 1
87. "${BUILD_LIBRARY_DIR}/test_image_util.sh" || exit 1
J. Richard Barnetteaaef7612011-08-11 17:10:28 -070088. "${BUILD_LIBRARY_DIR}/test_image_content.sh" || exit 1
J. Richard Barnettee4e3dec2011-08-08 16:35:02 -070089
Chris Sosab0f57322011-10-25 03:07:23 +000090parse_build_image_args
Peter Mayo82975f92012-05-01 11:03:31 -040091
David James18a9c252012-10-19 16:16:38 -070092for overlay in $(cros_list_overlays --board "$BOARD"); do
Liam McLoughlind606ee22012-07-03 16:48:57 -070093 setup_sh="${overlay}/scripts/board_specific_setup.sh"
94 if [[ -e ${setup_sh} ]]; then
95 source "${setup_sh}"
96 fi
97done
98
Liam McLoughlin5b37c542012-08-16 11:09:37 -070099# TODO: <prebuild hook>
Peter Mayo82975f92012-05-01 11:03:31 -0400100
Chris Sosa4299eb92011-11-01 12:54:01 -0700101# Tweak flags, configure extra USE flags, and add packages for the factory
102# install shim.
103EXTRA_PACKAGES=""
Chris Sosac9422fa2012-03-05 15:58:07 -0800104if should_build_image ${CHROMEOS_FACTORY_INSTALL_SHIM_NAME}; then
Nick Sandersae26a5c2010-08-30 21:59:50 -0700105 # TODO: Build a separated ebuild for the install shim to reduce size.
Hung-Te Lind32c59f2012-01-19 19:54:01 +0800106 INSTALL_MASK="${FACTORY_SHIM_INSTALL_MASK}"
Nick Sandersae26a5c2010-08-30 21:59:50 -0700107
Jon Salz67145df2011-10-20 14:05:06 +0800108 # Add the cros_factory_install boot arg.
109 FLAGS_boot_args="${FLAGS_boot_args} cros_factory_install"
Chris Sosa4299eb92011-11-01 12:54:01 -0700110
111 # Factory install needs to have the factory installer added.
112 EXTRA_PACKAGES="${EXTRA_PACKAGES} chromeos-base/chromeos-factoryinstall"
Hung-Te Lin7119cb12012-03-07 22:29:13 +0800113 # On x86/amd64, we boot the factory install shim from an SD card using
114 # initramfs for our root. On ARM, we boot the factory install shim over the
115 # network, so we don't require initramfs, but we do require fbconsole to fix
116 # a display driver bug.
117 if [ "${ARCH}" = "x86" -o "${ARCH}" = "amd64" ] ; then
Vic Yang40514052012-05-22 14:27:40 +0800118 export USE="${USE} initramfs vfat"
Chris Sosa4299eb92011-11-01 12:54:01 -0700119 fi
120 # CONFIG_BLK_DEV_RAM is disabled by default.
121 # But tftp install needs it to mount rootfs in ram
122 if [ "${ARCH}" = "arm" ] ; then
123 export USE="${USE} fbconsole blkdevram"
124 fi
Nick Sandersae26a5c2010-08-30 21:59:50 -0700125fi
126
Kees Cook8df86b22012-09-28 18:15:49 -0700127if should_build_image ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}; then
128 # Disable module restrictions on factory test image to allow for
129 # external third party drivers in /usr/local.
130 FLAGS_boot_args="${FLAGS_boot_args} lsm.module_locking=0"
131fi
132
Liam McLoughlin5b37c542012-08-16 11:09:37 -0700133# TODO: </prebuild hook>
Tan Gao843b70a2010-08-17 09:41:48 -0700134
Chris Sosa9673f3b2010-05-18 13:24:40 -0700135# If we are creating a developer image, also create a pristine image with a
136# different name.
Chris Sosa93e7b782012-01-03 15:52:12 -0800137PRISTINE_IMAGE_NAME=
Chris Sosac9422fa2012-03-05 15:58:07 -0800138if should_build_image ${CHROMEOS_FACTORY_INSTALL_SHIM_NAME}; then
Chris Sosab0f57322011-10-25 03:07:23 +0000139 PRISTINE_IMAGE_NAME=${CHROMEOS_FACTORY_INSTALL_SHIM_NAME}
Chris Sosa93e7b782012-01-03 15:52:12 -0800140else
Chris Sosac9422fa2012-03-05 15:58:07 -0800141 PRISTINE_IMAGE_NAME=${CHROMEOS_BASE_IMAGE_NAME}
Tan Gao843b70a2010-08-17 09:41:48 -0700142fi
143
Will Drewry7ab698d2010-08-05 13:57:52 -0500144DEVKEYSDIR="/usr/share/vboot/devkeys"
145
J. Richard Barnette8e480952011-08-30 16:00:59 -0700146eclean-$BOARD -d packages
Will Drewry12f14ce2010-08-17 17:27:16 -0500147
Liam McLoughlind606ee22012-07-03 16:48:57 -0700148if [[ ${skip_blacklist_check} -ne 1 ]]; then
149 check_blacklist
150fi
J. Richard Barnettea308b392011-08-29 13:53:34 -0700151
152# Check that the build root is sane.
Liam McLoughlind606ee22012-07-03 16:48:57 -0700153if [[ ${skip_test_build_root} -ne 1 ]]; then
154 "${BUILD_LIBRARY_DIR}/test_build_root" --root="${BOARD_ROOT}"
155fi
J. Richard Barnettea308b392011-08-29 13:53:34 -0700156
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700157# Hack to fix bug where x86_64 CHOST line gets incorrectly added.
158# ToDo(msb): remove this hack.
159PACKAGES_FILE="${BOARD_ROOT}/packages/Packages"
160sudo sed -e "s/CHOST: x86_64-pc-linux-gnu//" -i "${PACKAGES_FILE}"
161
162# Handle existing directory.
Chris Sosab0f57322011-10-25 03:07:23 +0000163if [[ -e "${BUILD_DIR}" ]]; then
Don Garrette0020b12010-06-17 15:55:35 -0700164 if [[ ${FLAGS_replace} -eq ${FLAGS_TRUE} ]]; then
Chris Sosab0f57322011-10-25 03:07:23 +0000165 sudo rm -rf "${BUILD_DIR}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700166 else
Chris Sosab0f57322011-10-25 03:07:23 +0000167 error "Directory ${BUILD_DIR} already exists."
168 error "Use --build_attempt option to specify an unused attempt."
Brian Harring7f175a52012-03-02 05:37:00 -0800169 error "Or use --replace if you want to overwrite this directory."
170 die "Unwilling to overwrite ${BUILD_DIR}."
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700171 fi
172fi
173
J. Richard Barnettea308b392011-08-29 13:53:34 -0700174# Create the output directory and temporary mount points.
Chris Sosab0f57322011-10-25 03:07:23 +0000175mkdir -p "${BUILD_DIR}"
Don Garrett3f41e152010-06-21 14:54:34 -0700176
Liam McLoughlin5b37c542012-08-16 11:09:37 -0700177# Create the base image.
Chris Sosab0f57322011-10-25 03:07:23 +0000178create_base_image ${PRISTINE_IMAGE_NAME}
Tan Gao843b70a2010-08-17 09:41:48 -0700179
Liam McLoughlind606ee22012-07-03 16:48:57 -0700180# Running board-specific setup if any exists.
181if type board_setup &>/dev/null; then
182 board_setup "${BUILD_DIR}/${PRISTINE_IMAGE_NAME}"
183fi
184
Chris Sosac9422fa2012-03-05 15:58:07 -0800185# Create a developer image if an image that is based on it is requested.
186if should_build_image ${CHROMEOS_DEVELOPER_IMAGE_NAME} \
187 ${CHROMEOS_TEST_IMAGE_NAME} ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}; then
Chris Sosab0f57322011-10-25 03:07:23 +0000188 copy_image ${CHROMEOS_BASE_IMAGE_NAME} ${CHROMEOS_DEVELOPER_IMAGE_NAME}
Chris Sosac9422fa2012-03-05 15:58:07 -0800189 install_dev_packages ${CHROMEOS_DEVELOPER_IMAGE_NAME}
Bill Richardson6ed13582010-06-16 21:38:15 -0700190fi
191
Chris Sosac9422fa2012-03-05 15:58:07 -0800192# From a developer image create a test|factory_test image.
193if should_build_image ${CHROMEOS_TEST_IMAGE_NAME}; then
194 copy_image ${CHROMEOS_DEVELOPER_IMAGE_NAME} ${CHROMEOS_TEST_IMAGE_NAME}
195 mod_image_for_test ${CHROMEOS_TEST_IMAGE_NAME}
196fi
197if should_build_image ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}; then
Chris Sosab0f57322011-10-25 03:07:23 +0000198 copy_image ${CHROMEOS_DEVELOPER_IMAGE_NAME} \
199 ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}
200 mod_image_for_test ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}
Vince Laviano6aebf312011-06-01 15:27:31 -0700201fi
202
Raja Aluriaeb10482010-12-10 13:03:09 -0800203# Generating AU generator zip file to run outside chroot
204generate_au_zip || echo "Failed generating AU zip file - ignoring Error..."
David James4dd4c542011-08-10 10:19:47 -0700205
206# Create a named symlink.
207LINK_NAME="${FLAGS_output_root}/${BOARD}/${FLAGS_symlink}"
Chris Sosab0f57322011-10-25 03:07:23 +0000208ln -sfT $(basename ${BUILD_DIR}) ${LINK_NAME}
Olof Johansson58f25cc2010-08-04 21:18:49 -0700209
Liam McLoughlin5b37c542012-08-16 11:09:37 -0700210echo "Done. Image(s) created in ${BUILD_DIR}"
Chris Sosac9422fa2012-03-05 15:58:07 -0800211
212# Print out the images we generated.
213if should_build_image ${CHROMEOS_BASE_IMAGE_NAME}; then
214 echo "Non-developer Chromium OS image created as ${PRISTINE_IMAGE_NAME}"
215fi
216if should_build_image ${CHROMEOS_FACTORY_SHIM_NAME}; then
217 echo "Chromium OS Factory install shim created as ${PRISTINE_IMAGE_NAME}"
218fi
219if should_build_image ${CHROMEOS_DEVELOPER_IMAGE_NAME}; then
Chris Sosab0f57322011-10-25 03:07:23 +0000220 echo "Developer image created as ${CHROMEOS_DEVELOPER_IMAGE_NAME}"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700221fi
Chris Sosac9422fa2012-03-05 15:58:07 -0800222if should_build_image ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}; then
Vince Laviano6aebf312011-06-01 15:27:31 -0700223 echo "Factory test image created as ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}"
Chris Sosac9422fa2012-03-05 15:58:07 -0800224fi
225if should_build_image ${CHROMEOS_TEST_IMAGE_NAME}; then
Vince Laviano6aebf312011-06-01 15:27:31 -0700226 echo "Test image created as ${CHROMEOS_TEST_IMAGE_NAME}"
227fi
Nick Sanders8ab729a2010-06-16 03:15:17 -0700228
Matt Tennant0a9d32d2012-07-30 16:51:37 -0700229command_completed
Nick Sandersd2509272010-06-16 03:50:04 -0700230
Gilad Arnolda7536ef2012-06-20 18:43:39 -0700231cat << EOF
232To copy the image to a USB key, use:
233 ./image_to_usb.sh --from=${OUTSIDE_OUTPUT_DIR}
234To convert it to a VMWare image, use:
235 ./image_to_vm.sh --from=${OUTSIDE_OUTPUT_DIR} --board=${BOARD}
236EOF