blob: 48e93d0769daa933a17d4c9ededf9e008b39ad9e [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 "" \
Chris Sosa36b4e302013-10-17 11:54:50 -070017 "Adjustments to apply to partition table (LABEL:[+-=]SIZE) e.g. ROOT-A:+1G"
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"
Paul Taysom00df6f62012-11-20 12:35:40 -080022DEFINE_boolean enable_bootcache ${FLAGS_FALSE} \
23 "Default all bootloaders to NOT use boot cache."
David James855afb72012-03-14 20:04:59 -070024DEFINE_boolean enable_rootfs_verification ${FLAGS_TRUE} \
25 "Default all bootloaders to use kernel-based root fs integrity checking."
Bill Richardsonc09b94f2010-03-15 11:40:30 -070026DEFINE_string output_root "${DEFAULT_BUILD_ROOT}/images" \
27 "Directory in which to place image result directories (named by version)"
Liam McLoughlin5b37c542012-08-16 11:09:37 -070028DEFINE_string disk_layout "default" \
Liam McLoughlinb78a7c32012-11-06 20:19:05 -050029 "The disk layout type to use for this image."
David Rochbergcf932372011-06-30 21:25:08 -040030DEFINE_boolean standard_backdoor ${FLAGS_TRUE} \
31 "Install standard backdoor credentials for testing"
David James855afb72012-03-14 20:04:59 -070032DEFINE_string usb_disk /dev/sdb3 \
33 "Path syslinux should use to do a usb boot. Default: /dev/sdb3"
Paul Taysom5e39bb62013-01-18 07:39:25 -080034DEFINE_string enable_serial "" \
35 "Enable serial port for printks. Example values: ttyS0"
Che-Liang Chiou611d5b72011-07-27 16:03:26 +080036
Chris Sosaef4a6452011-10-27 16:01:07 -070037FLAGS_HELP="USAGE: build_image [flags] [list of images to build].
38This script is used to build a Chromium OS image. Chromium OS comes in many
39different forms. This scripts can be used to build the following:
40
41base - Pristine Chromium OS image. As similar to Chrome OS as possible.
42dev - Developer image. Like base but with additional developer packages.
43test - Like dev, but with additional test specific packages and can be easily
44 used for automated testing using scripts like run_remote_tests, etc.
45factory_test - Like test but with extra packages and modifications used to
46 test images in a factory setting. Cannot be built along with a test image.
47factory_install - Install shim for bootstrapping the factory test process.
48 Cannot be built along with any other image.
49
David James855afb72012-03-14 20:04:59 -070050Examples:
Chris Sosaef4a6452011-10-27 16:01:07 -070051
52build_image --board=<board> dev test - builds developer and test images.
53build_image --board=<board> factory_install - builds a factory install shim.
Chris Sosa36b4e302013-10-17 11:54:50 -070054
55Note if you want to build an image with custom size partitions, either consider
56adding a new disk layout in build_library/legacy_disk_layout.json OR use
57--adjust_part. See the help above but here are a few examples:
58
59--adjust_part='STATE:+1G' -- add one GB to the size the stateful partition
60--adjust_part='ROOT-A:-1G' -- remove one GB from the primary rootfs partition
61--adjust_part='STATE:=1G' -- make the stateful partition 1 GB
Chris Sosaef4a6452011-10-27 16:01:07 -070062...
63"
David James855afb72012-03-14 20:04:59 -070064show_help_if_requested "$@"
65
66# The following options are advanced options, only available to those willing
67# to read the source code. They are not shown in help output, since they are
68# not needed for the typical developer workflow.
David James855afb72012-03-14 20:04:59 -070069DEFINE_integer build_attempt 1 \
70 "The build attempt for this image build."
71DEFINE_integer jobs -1 \
72 "How many packages to build in parallel at maximum."
73DEFINE_boolean replace ${FLAGS_FALSE} \
74 "Overwrite existing output, if any."
75DEFINE_string symlink "latest" \
76 "Symlink name to use for this image."
Liam McLoughlin07279032012-06-25 17:31:11 -070077DEFINE_string version "" \
78 "Overrides version number in name to this version."
Chris Sosaef4a6452011-10-27 16:01:07 -070079
Bill Richardsonc09b94f2010-03-15 11:40:30 -070080# Parse command line.
81FLAGS "$@" || exit 1
Mike Frysinger454c5262012-12-01 14:18:51 -050082
83# See if we want to default the bootcache flag before we clobber
84# the user's command line. We want to default to false if the
85# user explicitly disabled rootfs verification otherwise they
86# have to manually specify both.
87FLAGS_bootcache_use_board_default=${FLAGS_enable_rootfs_verification}
88case " $* " in
89 *" --enable_bootcache "*|\
90 *" --noenable_bootcache "*)
91 FLAGS_bootcache_use_board_default=${FLAGS_FALSE}
92 ;;
93esac
94
Bill Richardsonc09b94f2010-03-15 11:40:30 -070095eval set -- "${FLAGS_ARGV}"
96
97# Only now can we die on error. shflags functions leak non-zero error codes,
Brian Harring7f175a52012-03-02 05:37:00 -080098# so will die prematurely if 'switch_to_strict_mode' is specified before now.
99switch_to_strict_mode
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700100
J. Richard Barnettee4e3dec2011-08-08 16:35:02 -0700101# Determine build version.
102OVERLAY_CHROMEOS_DIR="${SRC_ROOT}/third_party/chromiumos-overlay/chromeos"
103. "${OVERLAY_CHROMEOS_DIR}/config/chromeos_version.sh" || exit 1
J. Richard Barnettea308b392011-08-29 13:53:34 -0700104# N.B. Ordering matters for some of the libraries below, because
105# some of the files contain initialization used by later files.
J. Richard Barnetteaaef7612011-08-11 17:10:28 -0700106. "${BUILD_LIBRARY_DIR}/board_options.sh" || exit 1
Liam McLoughlin5b37c542012-08-16 11:09:37 -0700107. "${BUILD_LIBRARY_DIR}/disk_layout_util.sh" || exit 1
J. Richard Barnette5f9dbe42011-08-22 14:31:33 -0700108. "${BUILD_LIBRARY_DIR}/mount_gpt_util.sh" || exit 1
J. Richard Barnettea308b392011-08-29 13:53:34 -0700109. "${BUILD_LIBRARY_DIR}/build_image_util.sh" || exit 1
110. "${BUILD_LIBRARY_DIR}/base_image_util.sh" || exit 1
111. "${BUILD_LIBRARY_DIR}/dev_image_util.sh" || exit 1
112. "${BUILD_LIBRARY_DIR}/test_image_util.sh" || exit 1
J. Richard Barnetteaaef7612011-08-11 17:10:28 -0700113. "${BUILD_LIBRARY_DIR}/test_image_content.sh" || exit 1
J. Richard Barnettee4e3dec2011-08-08 16:35:02 -0700114
Chris Sosab0f57322011-10-25 03:07:23 +0000115parse_build_image_args
Peter Mayo82975f92012-05-01 11:03:31 -0400116
Albert Chaulk5d190f72013-07-12 11:42:18 -0700117load_board_specific_script "${FLAGS_board}" "board_specific_setup.sh"
Liam McLoughlind606ee22012-07-03 16:48:57 -0700118
Liam McLoughlin5b37c542012-08-16 11:09:37 -0700119# TODO: <prebuild hook>
Peter Mayo82975f92012-05-01 11:03:31 -0400120
Vic Yang8e0cd072012-12-18 22:31:46 +0800121BASE_PACKAGE="chromeos-base/chromeos"
122# Tweak flags, configure extra USE flags, and set base packages for the factory
Chris Sosa4299eb92011-11-01 12:54:01 -0700123# install shim.
Chris Sosac9422fa2012-03-05 15:58:07 -0800124if should_build_image ${CHROMEOS_FACTORY_INSTALL_SHIM_NAME}; then
Nick Sandersae26a5c2010-08-30 21:59:50 -0700125 # TODO: Build a separated ebuild for the install shim to reduce size.
Hung-Te Lind32c59f2012-01-19 19:54:01 +0800126 INSTALL_MASK="${FACTORY_SHIM_INSTALL_MASK}"
Nick Sandersae26a5c2010-08-30 21:59:50 -0700127
Jon Salz67145df2011-10-20 14:05:06 +0800128 # Add the cros_factory_install boot arg.
129 FLAGS_boot_args="${FLAGS_boot_args} cros_factory_install"
Chris Sosa4299eb92011-11-01 12:54:01 -0700130
Vic Yang8e0cd072012-12-18 22:31:46 +0800131 BASE_PACKAGE="chromeos-base/chromeos-installshim"
132
Vic Yang3239b1a2013-01-22 21:56:16 +0800133 export USE="${USE} initramfs vfat tpm i2cdev"
Vic Yang90e3b252013-01-09 18:34:35 +0800134
135 # On ARM, fbconsole is required to fix a display driver bug.
Chris Sosa4299eb92011-11-01 12:54:01 -0700136 if [ "${ARCH}" = "arm" ] ; then
Vic Yang90e3b252013-01-09 18:34:35 +0800137 export USE="${USE} fbconsole"
Chris Sosa4299eb92011-11-01 12:54:01 -0700138 fi
Nick Sandersae26a5c2010-08-30 21:59:50 -0700139fi
140
Kees Cook8df86b22012-09-28 18:15:49 -0700141if should_build_image ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}; then
142 # Disable module restrictions on factory test image to allow for
143 # external third party drivers in /usr/local.
144 FLAGS_boot_args="${FLAGS_boot_args} lsm.module_locking=0"
145fi
146
Liam McLoughlin5b37c542012-08-16 11:09:37 -0700147# TODO: </prebuild hook>
Tan Gao843b70a2010-08-17 09:41:48 -0700148
Chris Sosa9673f3b2010-05-18 13:24:40 -0700149# If we are creating a developer image, also create a pristine image with a
150# different name.
Chris Sosa93e7b782012-01-03 15:52:12 -0800151PRISTINE_IMAGE_NAME=
Chris Sosac9422fa2012-03-05 15:58:07 -0800152if should_build_image ${CHROMEOS_FACTORY_INSTALL_SHIM_NAME}; then
Chris Sosab0f57322011-10-25 03:07:23 +0000153 PRISTINE_IMAGE_NAME=${CHROMEOS_FACTORY_INSTALL_SHIM_NAME}
Chris Sosa93e7b782012-01-03 15:52:12 -0800154else
Chris Sosac9422fa2012-03-05 15:58:07 -0800155 PRISTINE_IMAGE_NAME=${CHROMEOS_BASE_IMAGE_NAME}
Tan Gao843b70a2010-08-17 09:41:48 -0700156fi
157
Will Drewry7ab698d2010-08-05 13:57:52 -0500158DEVKEYSDIR="/usr/share/vboot/devkeys"
159
J. Richard Barnette8e480952011-08-30 16:00:59 -0700160eclean-$BOARD -d packages
Will Drewry12f14ce2010-08-17 17:27:16 -0500161
Liam McLoughlind606ee22012-07-03 16:48:57 -0700162if [[ ${skip_blacklist_check} -ne 1 ]]; then
163 check_blacklist
164fi
J. Richard Barnettea308b392011-08-29 13:53:34 -0700165
166# Check that the build root is sane.
Liam McLoughlind606ee22012-07-03 16:48:57 -0700167if [[ ${skip_test_build_root} -ne 1 ]]; then
168 "${BUILD_LIBRARY_DIR}/test_build_root" --root="${BOARD_ROOT}"
169fi
J. Richard Barnettea308b392011-08-29 13:53:34 -0700170
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700171# Hack to fix bug where x86_64 CHOST line gets incorrectly added.
172# ToDo(msb): remove this hack.
173PACKAGES_FILE="${BOARD_ROOT}/packages/Packages"
174sudo sed -e "s/CHOST: x86_64-pc-linux-gnu//" -i "${PACKAGES_FILE}"
175
176# Handle existing directory.
Chris Sosab0f57322011-10-25 03:07:23 +0000177if [[ -e "${BUILD_DIR}" ]]; then
Don Garrette0020b12010-06-17 15:55:35 -0700178 if [[ ${FLAGS_replace} -eq ${FLAGS_TRUE} ]]; then
Chris Sosab0f57322011-10-25 03:07:23 +0000179 sudo rm -rf "${BUILD_DIR}"
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700180 else
Chris Sosab0f57322011-10-25 03:07:23 +0000181 error "Directory ${BUILD_DIR} already exists."
182 error "Use --build_attempt option to specify an unused attempt."
Brian Harring7f175a52012-03-02 05:37:00 -0800183 error "Or use --replace if you want to overwrite this directory."
184 die "Unwilling to overwrite ${BUILD_DIR}."
Bill Richardsonc09b94f2010-03-15 11:40:30 -0700185 fi
186fi
187
J. Richard Barnettea308b392011-08-29 13:53:34 -0700188# Create the output directory and temporary mount points.
Chris Sosab0f57322011-10-25 03:07:23 +0000189mkdir -p "${BUILD_DIR}"
Don Garrett3f41e152010-06-21 14:54:34 -0700190
Liam McLoughlin5b37c542012-08-16 11:09:37 -0700191# Create the base image.
Paul Taysom00df6f62012-11-20 12:35:40 -0800192create_base_image ${PRISTINE_IMAGE_NAME} ${FLAGS_enable_rootfs_verification} \
193 ${FLAGS_enable_bootcache}
Tan Gao843b70a2010-08-17 09:41:48 -0700194
Liam McLoughlind606ee22012-07-03 16:48:57 -0700195# Running board-specific setup if any exists.
196if type board_setup &>/dev/null; then
197 board_setup "${BUILD_DIR}/${PRISTINE_IMAGE_NAME}"
198fi
199
Chris Sosac9422fa2012-03-05 15:58:07 -0800200# Create a developer image if an image that is based on it is requested.
201if should_build_image ${CHROMEOS_DEVELOPER_IMAGE_NAME} \
202 ${CHROMEOS_TEST_IMAGE_NAME} ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}; then
Chris Sosab0f57322011-10-25 03:07:23 +0000203 copy_image ${CHROMEOS_BASE_IMAGE_NAME} ${CHROMEOS_DEVELOPER_IMAGE_NAME}
Chris Sosac9422fa2012-03-05 15:58:07 -0800204 install_dev_packages ${CHROMEOS_DEVELOPER_IMAGE_NAME}
Bill Richardson6ed13582010-06-16 21:38:15 -0700205fi
206
Chris Sosac9422fa2012-03-05 15:58:07 -0800207# From a developer image create a test|factory_test image.
208if should_build_image ${CHROMEOS_TEST_IMAGE_NAME}; then
209 copy_image ${CHROMEOS_DEVELOPER_IMAGE_NAME} ${CHROMEOS_TEST_IMAGE_NAME}
210 mod_image_for_test ${CHROMEOS_TEST_IMAGE_NAME}
211fi
212if should_build_image ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}; then
Chris Sosab0f57322011-10-25 03:07:23 +0000213 copy_image ${CHROMEOS_DEVELOPER_IMAGE_NAME} \
214 ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}
215 mod_image_for_test ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}
Vince Laviano6aebf312011-06-01 15:27:31 -0700216fi
217
David James4dd4c542011-08-10 10:19:47 -0700218# Create a named symlink.
219LINK_NAME="${FLAGS_output_root}/${BOARD}/${FLAGS_symlink}"
Chris Sosab0f57322011-10-25 03:07:23 +0000220ln -sfT $(basename ${BUILD_DIR}) ${LINK_NAME}
Olof Johansson58f25cc2010-08-04 21:18:49 -0700221
Liam McLoughlin5b37c542012-08-16 11:09:37 -0700222echo "Done. Image(s) created in ${BUILD_DIR}"
Chris Sosac9422fa2012-03-05 15:58:07 -0800223
224# Print out the images we generated.
225if should_build_image ${CHROMEOS_BASE_IMAGE_NAME}; then
226 echo "Non-developer Chromium OS image created as ${PRISTINE_IMAGE_NAME}"
227fi
228if should_build_image ${CHROMEOS_FACTORY_SHIM_NAME}; then
229 echo "Chromium OS Factory install shim created as ${PRISTINE_IMAGE_NAME}"
230fi
231if should_build_image ${CHROMEOS_DEVELOPER_IMAGE_NAME}; then
Chris Sosab0f57322011-10-25 03:07:23 +0000232 echo "Developer image created as ${CHROMEOS_DEVELOPER_IMAGE_NAME}"
Chris Sosa9673f3b2010-05-18 13:24:40 -0700233fi
Chris Sosac9422fa2012-03-05 15:58:07 -0800234if should_build_image ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}; then
Vince Laviano6aebf312011-06-01 15:27:31 -0700235 echo "Factory test image created as ${CHROMEOS_FACTORY_TEST_IMAGE_NAME}"
Chris Sosac9422fa2012-03-05 15:58:07 -0800236fi
237if should_build_image ${CHROMEOS_TEST_IMAGE_NAME}; then
Vince Laviano6aebf312011-06-01 15:27:31 -0700238 echo "Test image created as ${CHROMEOS_TEST_IMAGE_NAME}"
239fi
Nick Sanders8ab729a2010-06-16 03:15:17 -0700240
Matt Tennant0a9d32d2012-07-30 16:51:37 -0700241command_completed
Nick Sandersd2509272010-06-16 03:50:04 -0700242
Gilad Arnolda7536ef2012-06-20 18:43:39 -0700243cat << EOF
244To copy the image to a USB key, use:
245 ./image_to_usb.sh --from=${OUTSIDE_OUTPUT_DIR}
246To convert it to a VMWare image, use:
247 ./image_to_vm.sh --from=${OUTSIDE_OUTPUT_DIR} --board=${BOARD}
248EOF