#!/bin/bash # Copyright (c) 2009 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. # Load common constants. This should be the first executable line. # The path to common.sh should be relative to your script's location. . "$(dirname "$0")/common.sh" # Script must be run inside the chroot. restart_in_chroot_if_needed $* get_default_board # Flags. DEFINE_string board "${DEFAULT_BOARD}" \ "The board to build an image for." DEFINE_string build_root "/build" \ "The root location for board sysroots." DEFINE_integer build_attempt 1 \ "The build attempt for this image build." DEFINE_string output_root "${DEFAULT_BUILD_ROOT}/images" \ "Directory in which to place image result directories (named by version)" DEFINE_boolean replace ${FLAGS_FALSE} \ "Overwrite existing output, if any." DEFINE_boolean withdev ${FLAGS_TRUE} \ "Include useful developer friendly utilities in the image." DEFINE_boolean installmask ${FLAGS_TRUE} \ "Use INSTALL_MASK to shrink the resulting image." DEFINE_integer jobs -1 \ "How many packages to build in parallel at maximum." DEFINE_boolean statefuldev ${FLAGS_TRUE} \ "Install development packages on stateful partition rather than the rootfs" DEFINE_string to "" \ "The target image file or device" DEFINE_boolean factory_install ${FLAGS_FALSE} \ "Build a smaller image to overlay the factory install shim on; this argument \ is also required in image_to_usb." DEFINE_string arm_extra_bootargs "" \ "Additional command line options to pass to the ARM kernel." DEFINE_boolean recovery ${FLAGS_FALSE} \ "Build a recovery image. Default: False." DEFINE_integer rootfs_partition_size 1024 \ "rootfs parition size in MBs." DEFINE_integer rootfs_size 720 \ "rootfs filesystem size in MBs." # Parse command line. FLAGS "$@" || exit 1 eval set -- "${FLAGS_ARGV}" # Only now can we die on error. shflags functions leak non-zero error codes, # so will die prematurely if 'set -e' is specified before now. set -e if [ -z "${FLAGS_board}" ] ; then error "--board is required." exit 1 fi if [ "${FLAGS_rootfs_size}" -gt "${FLAGS_rootfs_partition_size}" ] ; then error "rootfs (${FLAGS_rootfs_size} MB) is bigger than partition (${FLAGS_rootfs_partition_size} MB)." exit 1 fi EMERGE_CMD="emerge" EMERGE_BOARD_CMD="emerge-${FLAGS_board}" TOP_SCRIPTS_DIR="$(dirname $0)" if [ -e "${TOP_SCRIPTS_DIR}/.emerge" ]; then echo "Using alternate emerge" . "${TOP_SCRIPTS_DIR}/.emerge" fi # Determine build version. . "${SCRIPTS_DIR}/chromeos_version.sh" # Use canonical path since some tools (e.g. mount) do not like symlinks. # Append build attempt to output directory. IMAGE_SUBDIR="${CHROMEOS_VERSION_STRING}-a${FLAGS_build_attempt}" OUTPUT_DIR="${FLAGS_output_root}/${FLAGS_board}/${IMAGE_SUBDIR}" OUTSIDE_OUTPUT_DIR="../build/images/${FLAGS_board}/${IMAGE_SUBDIR}" # If we are creating a developer image, also create a pristine image with a # different name. DEVELOPER_IMAGE_NAME= PRISTINE_IMAGE_NAME=chromiumos_image.bin if [ "${FLAGS_withdev}" -eq "${FLAGS_TRUE}" ]; then PRISTINE_IMAGE_NAME=chromiumos_base_image.bin DEVELOPER_IMAGE_NAME=chromiumos_image.bin fi # If we are creating a recovery image, rename pristine image. if [ "${FLAGS_recovery}" -eq "${FLAGS_TRUE}" ]; then PRISTINE_IMAGE_NAME=recovery_image.bin fi OUTPUT_IMG=${FLAGS_to:-${OUTPUT_DIR}/${PRISTINE_IMAGE_NAME}} BOARD="${FLAGS_board}" BOARD_ROOT="${FLAGS_build_root}/${BOARD}" ROOT_FS_IMG="${OUTPUT_DIR}/rootfs.image" ROOT_FS_DIR="${OUTPUT_DIR}/rootfs" STATEFUL_FS_IMG="${OUTPUT_DIR}/stateful_partition.image" STATEFUL_FS_DIR="${OUTPUT_DIR}/stateful_partition" ESP_FS_IMG=${OUTPUT_DIR}/esp.image ESP_FS_DIR=${OUTPUT_DIR}/esp LOOP_DEV= STATEFUL_LOOP_DEV= ESP_LOOP_DEV= # ${DEV_IMAGE_ROOT} specifies the location of where developer packages will # be installed on the stateful dir. On a Chromium OS system, this will # translate to /usr/local. DEV_IMAGE_ROOT="${STATEFUL_FS_DIR}/dev_image" # What cross-build are we targeting? . "${BOARD_ROOT}/etc/make.conf.board_setup" LIBC_VERSION=${LIBC_VERSION:-"2.10.1-r1"} INSTALL_MASK="" if [[ ${FLAGS_installmask} -eq ${FLAGS_TRUE} ]] ; then INSTALL_MASK="${DEFAULT_INSTALL_MASK}" fi # Reduce the size of factory install shim. # TODO: Build a separated ebuild for the factory install shim to reduce size. if [[ ${FLAGS_factory_install} -eq ${FLAGS_TRUE} ]] ; then INSTALL_MASK="${INSTALL_MASK} ${FACTORY_INSTALL_MASK}" fi if [[ ${FLAGS_jobs} -ne -1 ]]; then EMERGE_JOBS="--jobs=${FLAGS_jobs}" fi # Figure out ARCH from the given toolchain. # TODO: Move to common.sh as a function after scripts are switched over. TC_ARCH=$(echo "${CHOST}" | awk -F'-' '{ print $1 }') case "${TC_ARCH}" in arm*) ARCH="arm" ;; *86) ARCH="x86" ;; *) error "Unable to determine ARCH from toolchain: ${CHOST}" exit 1 esac # Hack to fix bug where x86_64 CHOST line gets incorrectly added. # ToDo(msb): remove this hack. PACKAGES_FILE="${BOARD_ROOT}/packages/Packages" sudo sed -e "s/CHOST: x86_64-pc-linux-gnu//" -i "${PACKAGES_FILE}" # Handle existing directory. if [[ -e "${OUTPUT_DIR}" ]]; then if [[ ${FLAGS_replace} -eq ${FLAGS_TRUE} ]]; then sudo rm -rf "${OUTPUT_DIR}" else echo "Directory ${OUTPUT_DIR} already exists." echo "Use --build_attempt option to specify an unused attempt." echo "Or use --replace if you want to overwrite this directory." exit 1 fi fi cleanup_rootfs_loop() { sudo umount -d "${ROOT_FS_DIR}" } cleanup_stateful_fs_loop() { sudo umount "${ROOT_FS_DIR}/usr/local" sudo umount "${ROOT_FS_DIR}/var" sudo umount -d "${STATEFUL_FS_DIR}" } cleanup_esp_loop() { sudo umount -d "${ESP_FS_DIR}" } cleanup() { # Disable die on error. set +e if [[ -n "${STATEFUL_LOOP_DEV}" ]]; then cleanup_stateful_fs_loop fi if [[ -n "${LOOP_DEV}" ]]; then cleanup_rootfs_loop fi if [[ -n "${ESP_LOOP_DEV}" ]]; then cleanup_esp_loop fi # Turn die on error back on. set -e } delete_prompt() { echo "An error occurred in your build so your latest output directory" \ "is invalid." read -p "Would you like to delete the output directory (y/N)? " SURE SURE="${SURE:0:1}" # Get just the first character. if [ "${SURE}" == "y" ] ; then sudo rm -rf "${OUTPUT_DIR}" echo "Deleted ${OUTPUT_DIR}" else echo "Not deleting ${OUTPUT_DIR}. Note dev server updates will not work" \ "until you successfully build another image or delete this directory" fi } # $1 - Directory where developer rootfs is mounted. # $2 - Directory where developer stateful_partition is mounted. mount_gpt_cleanup() { "${SCRIPTS_DIR}/mount_gpt_image.sh" -u -r "$1" -s "$2" delete_prompt } # Modifies an existing image to add development packages update_dev_packages() { local image_name=$1 echo "Adding developer packages to ${image_name}" trap "mount_gpt_cleanup \"${ROOT_FS_DIR}\" \"${STATEFUL_FS_DIR}\"" EXIT ${SCRIPTS_DIR}/mount_gpt_image.sh --from "${OUTPUT_DIR}" \ --image "$( basename ${image_name} )" -r "${ROOT_FS_DIR}" \ -s "${STATEFUL_FS_DIR}" # Determine the root dir for developer packages. local root_dev_dir="${ROOT_FS_DIR}" [ ${FLAGS_statefuldev} -eq ${FLAGS_TRUE} ] && \ root_dev_dir="${ROOT_FS_DIR}/usr/local" # Install developer packages described in chromeos-dev. sudo INSTALL_MASK="${INSTALL_MASK}" ${EMERGE_BOARD_CMD} \ --root="${root_dev_dir}" --root-deps=rdeps \ --usepkgonly chromeos-dev ${EMERGE_JOBS} # Re-run ldconfig to fix /etc/ldconfig.so.cache. sudo /sbin/ldconfig -r "${ROOT_FS_DIR}" # Mark the image as a developer image (input to chromeos_startup). sudo mkdir -p "${ROOT_FS_DIR}/root" sudo touch "${ROOT_FS_DIR}/root/.dev_mode" # Additional changes to developer image. # The ldd tool is a useful shell script but lives in glibc; just copy it. sudo cp -a "$(which ldd)" "${root_dev_dir}/usr/bin" # If vim is installed, then a vi symlink would probably help. if [[ -x "${ROOT_FS_DIR}/usr/local/bin/vim" ]]; then sudo ln -sf vim "${ROOT_FS_DIR}/usr/local/bin/vi" fi # Check that the image has been correctly created. Only do it if not # building a factory install image, as the INSTALL_MASK for it will # make test_image fail. if [[ ${FLAGS_factory_install} -eq ${FLAGS_FALSE} ]] ; then "${SCRIPTS_DIR}/test_image" \ --root="${ROOT_FS_DIR}" \ --target="${ARCH}" fi echo "Developer image built and stored at ${image_name}" trap - EXIT ${SCRIPTS_DIR}/mount_gpt_image.sh -u -r "${ROOT_FS_DIR}" -s "${STATEFUL_FS_DIR}" } # Modifies an existing image to add recovery packages update_recovery_packages() { local image_name=$1 echo "Adding recovery packages to ${image_name}" # Create stateful partition of the same size as the rootfs. trap "mount_gpt_cleanup \"${ROOT_FS_DIR}\" \"${STATEFUL_FS_DIR}\"" EXIT ${SCRIPTS_DIR}/mount_gpt_image.sh --from "${OUTPUT_DIR}" \ --image "$( basename ${image_name} )" -r "${ROOT_FS_DIR}" \ -s "${STATEFUL_FS_DIR}" # Install recovery installer. sudo ${EMERGE_BOARD_CMD} --root=${ROOT_FS_DIR} --usepkgonly \ --root-deps=rdeps --nodeps chromeos-recovery # Re-run ldconfig to fix /etc/ldconfig.so.cache. sudo /sbin/ldconfig -r "${ROOT_FS_DIR}" # Mark the image as a developer image (input to chromeos_startup). sudo mkdir -p "${ROOT_FS_DIR}/root" sudo touch "${ROOT_FS_DIR}/root/.recovery_installer" trap - EXIT ${SCRIPTS_DIR}/mount_gpt_image.sh -u -r "${ROOT_FS_DIR}" -s "${STATEFUL_FS_DIR}" } create_base_image() { trap "cleanup && delete_prompt" EXIT # Create and format the root file system. # Check for loop device before creating image. LOOP_DEV=$(sudo losetup -f) if [ -z "${LOOP_DEV}" ] ; then echo "No free loop device. Free up a loop device or reboot. exiting. " exit 1 fi # Create root file system disk image to fit on a 1GB memory stick. # 1 GB in hard-drive-manufacturer-speak is 10^9, not 2^30. 950MB < 10^9 bytes. if [[ ${FLAGS_factory_install} -eq ${FLAGS_TRUE} ]] ; then ROOT_SIZE_BYTES=$((1024 * 1024 * 300)) else ROOT_SIZE_BYTES=$((1024 * 1024 * ${FLAGS_rootfs_size})) fi dd if=/dev/zero of="${ROOT_FS_IMG}" bs=1 count=1 seek=$((ROOT_SIZE_BYTES - 1)) sudo losetup "${LOOP_DEV}" "${ROOT_FS_IMG}" sudo mkfs.ext3 "${LOOP_DEV}" # Tune and mount rootfs. UUID=$(uuidgen) DISK_LABEL="C-KEYFOB" sudo tune2fs -L "${DISK_LABEL}" -U "${UUID}" -c 0 -i 0 "${LOOP_DEV}" sudo mount "${LOOP_DEV}" "${ROOT_FS_DIR}" # Create stateful partition of the same size as the rootfs. STATEFUL_LOOP_DEV=$(sudo losetup -f) if [ -z "${STATEFUL_LOOP_DEV}" ] ; then echo "No free loop device. Free up a loop device or reboot. exiting. " exit 1 fi dd if=/dev/zero of="${STATEFUL_FS_IMG}" bs=1 count=1 seek=$((ROOT_SIZE_BYTES - 1)) sudo losetup "${STATEFUL_LOOP_DEV}" "${STATEFUL_FS_IMG}" sudo mkfs.ext3 "${STATEFUL_LOOP_DEV}" sudo tune2fs -L "C-STATE" -U "${UUID}" -c 0 -i 0 \ "${STATEFUL_LOOP_DEV}" # Mount the stateful partition. sudo mount "${STATEFUL_LOOP_DEV}" "${STATEFUL_FS_DIR}" # Turn root file system into bootable image. if [[ "${ARCH}" = "x86" ]]; then # Setup extlinux configuration. # TODO: For some reason the /dev/disk/by-uuid is not being generated by udev # in the initramfs. When we figure that out, switch to root=UUID=${UUID}. sudo mkdir -p "${ROOT_FS_DIR}"/boot # TODO(adlr): use initramfs for booting. cat < /usr/local/bin, etc. setup_symlinks_on_root "${DEV_IMAGE_ROOT}" "${STATEFUL_FS_DIR}/var" \ "${STATEFUL_FS_DIR}" # Perform binding rather than symlinking because directories must exist # on rootfs so that we can bind at run-time since rootfs is read-only. echo "Binding directories from stateful partition onto the rootfs" sudo mkdir -p "${ROOT_FS_DIR}/usr/local" sudo mount --bind "${DEV_IMAGE_ROOT}" "${ROOT_FS_DIR}/usr/local" sudo mkdir -p "${ROOT_FS_DIR}/var" sudo mount --bind "${STATEFUL_FS_DIR}/var" "${ROOT_FS_DIR}/var" sudo mkdir -p "${ROOT_FS_DIR}/dev" # We "emerge --root=${ROOT_FS_DIR} --root-deps=rdeps --usepkgonly" all of the # runtime packages for chrome os. This builds up a chrome os image from # binary packages with runtime dependencies only. We use INSTALL_MASK to # trim the image size as much as possible. sudo INSTALL_MASK="${INSTALL_MASK}" ${EMERGE_BOARD_CMD} \ --root="${ROOT_FS_DIR}" --root-deps=rdeps \ --usepkgonly chromeos ${EMERGE_JOBS} # Create EFI System Partition to boot stock EFI BIOS (but not ChromeOS EFI # BIOS). We only need this for x86, but it's simpler and safer to keep the # disk images the same for both x86 and ARM. # NOTE: The size argument for mkfs.vfat is in 1024-byte blocks. # We'll hard-code it to 16M for now. ESP_BLOCKS=16384 /usr/sbin/mkfs.vfat -C ${OUTPUT_DIR}/esp.image ${ESP_BLOCKS} ESP_LOOP_DEV=$(sudo losetup -f) if [ -z "${ESP_LOOP_DEV}" ] ; then echo "No free loop device. Free up a loop device or reboot. exiting. " exit 1 fi sudo losetup "${ESP_LOOP_DEV}" "${ESP_FS_IMG}" sudo mount "${ESP_LOOP_DEV}" "${ESP_FS_DIR}" sudo mkdir -p "${ESP_FS_DIR}/efi/boot" sudo grub-mkimage -p /efi/boot -o "${ESP_FS_DIR}/efi/boot/bootx64.efi" \ part_gpt fat ext2 normal boot sh chain configfile linux cat <<'EOF' | sudo dd of="${ESP_FS_DIR}/efi/boot/grub.cfg" set default=0 set timeout=2 # NOTE: These magic grub variables are a Chrome OS hack. They are not portable. menuentry "local image A" { 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 } menuentry "local image B" { 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 } menuentry "Alternate USB Boot" { 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 } EOF # FIXME: At the moment, we're working on signed images for x86 only. ARM will # support this before shipping, but at the moment they don't. if [[ "${ARCH}" = "x86" ]]; then # Legacy BIOS will use the kernel in the rootfs (via syslinux), as will # standard EFI BIOS (via grub, from the EFI System Partition). Chrome OS # BIOS will use a separate signed kernel partition, which we'll create now. # FIXME: remove serial output, debugging messages. cat <<'EOF' > "${OUTPUT_DIR}/config.txt" earlyprintk=serial,ttyS0,115200 console=ttyS0,115200 init=/sbin/init add_efi_memmap boot=local rootwait root=/dev/sd%D%P ro noresume noswap i915.modeset=1 loglevel=7 cros_secure EOF # FIXME: We need to specify the real keys and certs here! SIG_DIR="${SRC_ROOT}/platform/vboot_reference/tests/testkeys" # Wrap the public keys with VbPublicKey headers. vbutil_key --pack \ --in "${SIG_DIR}/key_rsa2048.keyb" \ --version 1 --algorithm 4 \ --out "${OUTPUT_DIR}/key_alg4.vbpubk" vbutil_key --pack \ --in "${SIG_DIR}/key_rsa4096.keyb" \ --version 1 --algorithm 8 \ --out "${OUTPUT_DIR}/key_alg8.vbpubk" vbutil_keyblock --pack "${OUTPUT_DIR}/data4_sign8.keyblock" \ --datapubkey "${OUTPUT_DIR}/key_alg4.vbpubk" \ --signprivate "${SIG_DIR}/key_rsa4096.pem" \ --algorithm 8 --flags 3 # Verify the keyblock. vbutil_keyblock --unpack "${OUTPUT_DIR}/data4_sign8.keyblock" \ --signpubkey "${OUTPUT_DIR}/key_alg8.vbpubk" # Sign the kernel: vbutil_kernel --pack "${OUTPUT_DIR}/vmlinuz.image" \ --keyblock "${OUTPUT_DIR}/data4_sign8.keyblock" \ --signprivate "${SIG_DIR}/key_rsa2048.pem" \ --version 1 \ --config "${OUTPUT_DIR}/config.txt" \ --bootloader /lib64/bootstub/bootstub.efi \ --vmlinuz "${ROOT_FS_DIR}/boot/vmlinuz" # And verify it. vbutil_kernel --verify "${OUTPUT_DIR}/vmlinuz.image" \ --signpubkey "${OUTPUT_DIR}/key_alg8.vbpubk" else # FIXME: For now, ARM just uses the unsigned kernel by itself. cp -f "${ROOT_FS_DIR}/boot/vmlinuz" "${OUTPUT_DIR}/vmlinuz.image" fi # Perform any customizations on the root file system that are needed. "${SCRIPTS_DIR}/customize_rootfs" \ --root="${ROOT_FS_DIR}" \ --target="${ARCH}" \ --board="${BOARD}" # Don't test the factory install shim. if [[ ${FLAGS_factory_install} -eq ${FLAGS_FALSE} ]] ; then # Check that the image has been correctly created. "${SCRIPTS_DIR}/test_image" \ --root="${ROOT_FS_DIR}" \ --target="${ARCH}" fi # Clean up symlinks so they work on a running target rooted at "/". # Here development packages are rooted at /usr/local. However, do not # create /usr/local or /var on host (already exist on target). setup_symlinks_on_root "/usr/local" "/var" "${STATEFUL_FS_DIR}" # Cleanup loop devices. cleanup trap delete_prompt EXIT RECOVERY="--norecovery" if [[ ${FLAGS_recovery} -eq ${FLAGS_TRUE} ]]; then RECOVERY="--recovery" fi # Create the GPT-formatted image. ${SCRIPTS_DIR}/build_gpt.sh \ --arch=${ARCH} \ --board=${FLAGS_board} \ --arm_extra_bootargs="${FLAGS_arm_extra_bootargs}" \ --rootfs_partition_size=${FLAGS_rootfs_partition_size} \ ${RECOVERY} \ "${OUTPUT_DIR}" \ "${OUTPUT_IMG}" } # Create the output directory. mkdir -p "${OUTPUT_DIR}" mkdir -p "${ROOT_FS_DIR}" mkdir -p "${STATEFUL_FS_DIR}" mkdir -p "${ESP_FS_DIR}" create_base_image ${OUTPUT_DIR}/${PRISTINE_IMAGE_NAME} # Create a recovery image based on the chromium os base image. if [ "${FLAGS_recovery}" -eq "${FLAGS_TRUE}" ] ; then update_recovery_packages ${OUTPUT_DIR}/${PRISTINE_IMAGE_NAME} fi trap - EXIT # Create a developer image based on the chromium os base image. if [ "${FLAGS_withdev}" -eq "${FLAGS_TRUE}" ] ; then echo "Creating developer image from base image ${OUTPUT_IMG}" cp ${OUTPUT_DIR}/${PRISTINE_IMAGE_NAME} ${OUTPUT_DIR}/${DEVELOPER_IMAGE_NAME} update_dev_packages ${OUTPUT_DIR}/${DEVELOPER_IMAGE_NAME} fi trap - EXIT # FIXME: only signing things for x86 right now. if [[ "${ARCH}" = "x86" ]]; then # Verify the final image. load_kernel_test "${OUTPUT_IMG}" "${OUTPUT_DIR}/key_alg8.vbpubk" fi # Clean up temporary files. rm -f "${ROOT_FS_IMG}" "${STATEFUL_FS_IMG}" "${OUTPUT_DIR}/vmlinuz.image" \ "${ESP_FS_IMG}" "${OUTPUT_DIR}/data4_sign8.keyblock" \ "${OUTPUT_DIR}/key_alg4.vbpubk" "${OUTPUT_DIR}/key_alg8.vbpubk" rmdir "${ROOT_FS_DIR}" "${STATEFUL_FS_DIR}" "${ESP_FS_DIR}" echo "Done. Image created in ${OUTPUT_DIR}" echo "Chromium OS image created as ${PRISTINE_IMAGE_NAME}" if [ "${FLAGS_recovery}" -eq "${FLAGS_TRUE}" ]; then echo "Recovery image created as ${PRISTINE_IMAGE_NAME}" fi if [ "${FLAGS_withdev}" -eq "${FLAGS_TRUE}" ]; then echo "Developer image created as ${DEVELOPER_IMAGE_NAME}" fi print_time_elapsed echo "To copy to USB keyfob, OUTSIDE the chroot, do something like:" echo " ./image_to_usb.sh --from=${OUTSIDE_OUTPUT_DIR} --to=/dev/sdX" echo "To convert to VMWare image, OUTSIDE the chroot, do something like:" echo " ./image_to_vmware.sh --from=${OUTSIDE_OUTPUT_DIR}" echo "from the scripts directory where you entered the chroot."