blob: edeb5cedbc9d84497d5f692ff4cb28949d2010b7 [file] [log] [blame]
# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
# Script to build a bootable keyfob-based chromeos system image from within
# a chromiumos setup. This assumes that all needed packages have been built into
# the given target's root with binary packages turned on. This script will
# build the Chrome OS image using only pre-built binary packages.
SCRIPT_ROOT="$(dirname "$(readlink -f "$0")")"
# shellcheck source=build_library/
. "${SCRIPT_ROOT}/build_library/" || exit 1
# Make sure we run with network disabled to prevent leakage.
if [[ -z ${UNSHARE} ]]; then
if [[ $(id -u) -ne 0 ]]; then
exec sudo -E env PATH="${PATH}" "$0" "$@"
exec unshare -n -- sudo -E UNSHARE=true -u "${SUDO_USER}" -- "$0" "$@"
# Developer-visible flags.
DEFINE_string adjust_part "" \
"Adjustments to apply to partition table (LABEL:[+-=]SIZE) e.g. ROOT-A:+1G"
DEFINE_string board "${DEFAULT_BOARD}" \
"The board to build an image for."
DEFINE_string boot_args "noinitrd" \
"Additional boot arguments to pass to the commandline"
DEFINE_boolean enable_bootcache ${FLAGS_FALSE} \
"Default all bootloaders to NOT use boot cache."
DEFINE_boolean enable_rootfs_verification ${FLAGS_TRUE} \
"Default all bootloaders to use kernel-based root fs integrity checking." \
DEFINE_string output_root "${DEFAULT_BUILD_ROOT}/images" \
"Directory in which to place image result directories (named by version)"
DEFINE_string disk_layout "default" \
"The disk layout type to use for this image."
DEFINE_string enable_serial "" \
"Enable serial port for printks. Example values: ttyS0"
DEFINE_integer loglevel 7 \
"The loglevel to add to the kernel command line."
DEFINE_string builder_path "" \
"The build_name to be installed on DUT during hwtest."
FLAGS_HELP="USAGE: build_image [flags] [list of images to build].
This script is used to build a Chromium OS image. Chromium OS comes in many
different forms. This scripts can be used to build the following:
base - Pristine Chromium OS image. As similar to Chrome OS as possible.
dev [default] - Developer image. Like base but with additional dev packages.
test - Like dev, but with additional test specific packages and can be easily
used for automated testing using scripts like test_that, etc.
factory_install - Install shim for bootstrapping the factory test process.
Cannot be built along with any other image.
build_image --board=<board> dev test - builds developer and test images.
build_image --board=<board> factory_install - builds a factory install shim.
Note if you want to build an image with custom size partitions, either consider
adding a new disk layout in build_library/legacy_disk_layout.json OR use
adjust_part. See the help above but here are a few examples:
adjust_part='STATE:+1G' -- add one GB to the size the stateful partition
adjust_part='ROOT-A:-1G' -- remove one GB from the primary rootfs partition
adjust_part='STATE:=1G' -- make the stateful partition 1 GB
# The following options are advanced options, only available to those willing
# to read the source code. They are not shown in help output, since they are
# not needed for the typical developer workflow.
DEFINE_integer build_attempt 1 \
"The build attempt for this image build."
DEFINE_string build_root "${DEFAULT_BUILD_ROOT}/images" \
"Directory in which to compose the image, before copying it to output_root."
DEFINE_integer jobs -1 \
"How many packages to build in parallel at maximum."
DEFINE_boolean replace ${FLAGS_FALSE} \
"Overwrite existing output, if any."
DEFINE_string symlink "latest" \
"Symlink name to use for this image."
DEFINE_string version "" \
"Overrides version number in name to this version."
DEFINE_string output_suffix "" \
"Add custom suffix to output directory."
DEFINE_boolean eclean ${FLAGS_TRUE} \
"Do NOT call eclean before building the image (default is to call eclean)."
# Parse command line.
FLAGS "$@" || exit 1
# See if we want to default the bootcache flag before we clobber
# the user's command line. We want to default to false if the
# user explicitly disabled rootfs verification otherwise they
# have to manually specify both.
case " $* " in
*" --enable_bootcache "*|\
*" --noenable_bootcache "*)
eval set -- "${FLAGS_ARGV}"
# Only now can we die on error. shflags functions leak non-zero error codes,
# so will die prematurely if 'switch_to_strict_mode' is specified before now.
# Determine build version.
# shellcheck source=../third_party/chromiumos-overlay/chromeos/config/
. "${OVERLAY_CHROMEOS_DIR}/config/" || exit 1
# N.B. Ordering matters for some of the libraries below, because
# some of the files contain initialization used by later files.
# shellcheck source=build_library/
. "${BUILD_LIBRARY_DIR}/" || exit 1
# shellcheck source=build_library/
. "${BUILD_LIBRARY_DIR}/" || exit 1
# shellcheck source=build_library/
. "${BUILD_LIBRARY_DIR}/" || exit 1
# shellcheck source=build_library/
. "${BUILD_LIBRARY_DIR}/" || exit 1
# shellcheck source=build_library/
. "${BUILD_LIBRARY_DIR}/" || exit 1
# shellcheck source=build_library/
. "${BUILD_LIBRARY_DIR}/" || exit 1
# shellcheck source=build_library/
. "${BUILD_LIBRARY_DIR}/" || exit 1
# shellcheck source=build_library/
. "${BUILD_LIBRARY_DIR}/" || exit 1
load_board_specific_script ""
sudo_clear_shadow_locks "/build/${FLAGS_board}"
# TODO: <prebuild hook>
# Tweak flags, configure extra USE flags, and set base packages for the factory
# install shim.
if should_build_image "${CHROMEOS_FACTORY_INSTALL_SHIM_NAME}"; then
# TODO: Build a separated ebuild for the install shim to reduce size.
# Add the cros_factory_install boot arg.
FLAGS_boot_args="${FLAGS_boot_args} cros_factory_install"
export USE="${USE} fbconsole vtconsole factory_shim_ramfs i2cdev vfat"
# Mask systemd directories if this is not a systemd image.
if ! has "systemd" "$("portageq-${FLAGS_board}" envvar USE)"; then
# TODO: </prebuild hook>
# If we are creating a developer image, also create a pristine image with a
# different name.
if should_build_image "${CHROMEOS_FACTORY_INSTALL_SHIM_NAME}"; then
if [[ ${FLAGS_eclean} -eq ${FLAGS_TRUE} ]]; then
"${BOARD_ROOT}/build/bin/eclean" -d packages
# Handle existing directory.
if [[ -e "${BUILD_DIR}" ]]; then
if [[ ${FLAGS_replace} -eq ${FLAGS_TRUE} ]]; then
sudo rm -rf "${BUILD_DIR}"
error "Directory ${BUILD_DIR} already exists."
error "Use --build_attempt option to specify an unused attempt."
error "Or use --replace if you want to overwrite this directory."
die "Unwilling to overwrite ${BUILD_DIR}."
# Create the output directory and temporary mount points.
mkdir -p "${BUILD_DIR}"
# Create the base image.
create_base_image "${PRISTINE_IMAGE_NAME}" \
"${FLAGS_enable_rootfs_verification}" "${FLAGS_enable_bootcache}"
# Running board-specific setup if any exists.
if type board_setup &>/dev/null; then
# Create a developer image if an image that is based on it is requested.
if should_build_image "${CHROMEOS_DEVELOPER_IMAGE_NAME}" \
install_dev_packages "${CHROMEOS_DEVELOPER_IMAGE_NAME}"
# From a developer image create a test image.
if should_build_image "${CHROMEOS_TEST_IMAGE_NAME}"; then
mod_image_for_test "${CHROMEOS_TEST_IMAGE_NAME}"
# Move the completed image to the output_root.
move_image "${BUILD_DIR}" "${OUTPUT_DIR}"
# Copy DLC images to the output_root directory.
build_dlc --sysroot="${BOARD_ROOT}" --install-root-dir="${OUTPUT_DIR}/dlc" \
# Create a named symlink.
ln -sfT "$(basename "${OUTPUT_DIR}")" "${LINK_NAME}"
info "Done. Image(s) created in ${OUTPUT_DIR}"
# Print out the images we generated.
summarize() {
local name="$1" img="$2"
local dir_path
# __flags_output_root_default defined in shflags.
# shellcheck disable=2154
if [[ "${FLAGS_output_root}" == "${__flags_output_root_default}" ]]; then
info "${name} image created as ${img}"
info "To copy the image to a USB key, use:"
info " cros flash usb:// ${dir_path}/${img}"
info "To flash the image to a Chrome OS device, use:"
info " cros flash YOUR_DEVICE_IP ${dir_path}/${img}"
info "Note that the device must be accessible over the network."
info "A base image will not work in this mode, but a test or dev image will."
if [[ $# -ge 3 ]]; then
info "To run the image in a virtual machine, use:"
info " cros_vm --start --image-path=${dir_path}/${img} --board=${BOARD}"
if should_build_image "${CHROMEOS_BASE_IMAGE_NAME}"; then
summarize "Non-developer Chromium OS" "${PRISTINE_IMAGE_NAME}"
if should_build_image "${CHROMEOS_FACTORY_SHIM_NAME}"; then
summarize "Chromium OS Factory install shim" "${PRISTINE_IMAGE_NAME}"
if should_build_image "${CHROMEOS_DEVELOPER_IMAGE_NAME}"; then
summarize "Developer" "${CHROMEOS_DEVELOPER_IMAGE_NAME}" ""
if should_build_image "${CHROMEOS_TEST_IMAGE_NAME}"; then
summarize "Test" "${CHROMEOS_TEST_IMAGE_NAME}" "--test"