build_image, mod_image_for_*: break out make_image_bootable

build_image

 #!/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.
@@ skipping 126 matching lines @@
 
 STATEFUL_FS_IMG="${OUTPUT_DIR}/stateful_partition.image"
 STATEFUL_FS_DIR="${OUTPUT_DIR}/stateful_partition"
 
 OEM_FS_IMG="${OUTPUT_DIR}/partner_partition.image"
 OEM_FS_DIR="${OUTPUT_DIR}/partner_partition"
 
 ESP_FS_IMG=${OUTPUT_DIR}/esp.image
 ESP_FS_DIR=${OUTPUT_DIR}/esp
 
+DEVKEYSDIR="/usr/share/vboot/devkeys"
+
 LOOP_DEV=
 STATEFUL_LOOP_DEV=
 OEM_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
 
+if [[ ${FLAGS_enable_rootfs_verification} -eq ${FLAGS_TRUE} ]]; then
+  enable_rootfs_verification_flag="--enable_rootfs_verification"
+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"
     ;;
@@ skipping 87 matching lines @@
 # $3 - Directory where the ESP partition is mounted.
 mount_gpt_cleanup() {
   local rootfs="${1-$ROOT_FS_DIR}"
   local statefs="${2-$STATEFUL_FS_DIR}"
   local espfs="${3-$ESP_FS_DIR}"
   "${SCRIPTS_DIR}/mount_gpt_image.sh" \
     -u -r "${rootfs}" -s "${statefs}" -e "${espfs}"
   delete_prompt
 }
 
-make_image_bootable() {
-  local image_name="$1"
-  cros_root=/dev/sd%D%P
-  if [[ "${ARCH}" = "arm" ]]; then
-    # TODO(wad) assumed like in build_gpt for now.
-    cros_root=/dev/mmcblk1p3
-  fi
-  if [[ ${FLAGS_enable_rootfs_verification} -eq ${FLAGS_TRUE} ]]; then
-    cros_root=/dev/dm-0
-  fi
-
-  # TODO(wad) mount the root fs to LOOP_DEV from the image
-  trap "mount_gpt_cleanup" EXIT
-  ${SCRIPTS_DIR}/mount_gpt_image.sh --from "${OUTPUT_DIR}" \
-    --image "${image_name}" -r "${ROOT_FS_DIR}" \
-    -s "${STATEFUL_FS_DIR}"
-
-  # The rootfs should never be mounted rw again after this point without
-  # re-calling make_image_bootable.
-  sudo mount -o remount,ro "${ROOT_FS_DIR}"
-  root_dev=$(mount | grep -- "on ${ROOT_FS_DIR} type" | cut -f1 -d' ' | tail -1)
-
-  DEVKEYSDIR="/usr/share/vboot/devkeys"
-
-  # Builds the kernel partition image.  The temporary files are kept around
-  # so that we can perform a load_kernel_test later on the final image.
-  ${SCRIPTS_DIR}/build_kernel_image.sh \
-    --arch="${ARCH}" \
-    --to="${OUTPUT_DIR}/vmlinuz.image" \
-    --hd_vblock="${OUTPUT_DIR}/vmlinuz_hd.vblock" \
-    --vmlinuz="${OUTPUT_DIR}/boot/vmlinuz" \
-    --working_dir="${OUTPUT_DIR}" \
-    --keep_work \
-    --rootfs_image=${root_dev} \
-    --rootfs_hash=${ROOT_FS_HASH} \
-    --verity_hash_alg=${FLAGS_verity_algorithm} \
-    --verity_tree_depth=${FLAGS_verity_depth} \
-    --verity_max_ios=${FLAGS_verity_max_ios} \
-    --verity_error_behavior=${FLAGS_verity_error_behavior} \
-    --root=${cros_root} \
-    --keys_dir="${DEVKEYSDIR}"
-
-  local rootfs_hash_size=$(stat -c '%s' ${ROOT_FS_HASH})
-  info "Appending rootfs.hash (${rootfs_hash_size} bytes) to the root fs"
-  if [[ ${rootfs_hash_size} -gt $((FLAGS_rootfs_hash_pad * 1024 * 1024)) ]]
-  then
-    die "--rootfs_hash_pad reserves less than the needed ${rootfs_hash_size}"
-  fi
-  # Unfortunately, mount_gpt_image uses mount and not losetup to create the
-  # loop devices.  This means that they are not the correct size.  We have to
-  # write directly to the image to append the hash tree data.
-  local hash_offset="$(partoffset ${OUTPUT_DIR}/${image_name} 3)"
-  hash_offset=$((hash_offset + ((1024 * 1024 * ${FLAGS_rootfs_size}) / 512)))
-  sudo dd bs=512 \
-          seek=${hash_offset} \
-          if="${ROOT_FS_HASH}" \
-          of="${OUTPUT_DIR}/${image_name}" \
-          conv=notrunc
-  # We don't need to keep the file around anymore.
-  sudo rm "${ROOT_FS_HASH}"
-
-  # Move the verification block needed for the hard disk install to the
-  # stateful partition. Mount stateful fs, copy file, and umount fs.
-  # In original CL: http://codereview.chromium.org/2868044, this was done in
-  # create_base_image(). However, it could break the build if it is a clean
-  # build because vmlinuz_hd.vblock hasn't been created by build_kernel_image.sh
-  if [[ "${ARCH}" = "x86" ]]; then
-    sudo cp "${OUTPUT_DIR}/vmlinuz_hd.vblock" "${STATEFUL_FS_DIR}"
-  fi
-
-  # START_KERN_A is set by the first call to install the gpt.
-  local koffset="$(partoffset ${OUTPUT_DIR}/${image_name} 2)"
-  sudo dd if="${OUTPUT_DIR}/vmlinuz.image" of="${OUTPUT_DIR}/${image_name}" \
-    conv=notrunc bs=512 seek=${koffset}
-
-  # Update the bootloaders.  For legacy/efi x86, the EFI system partition
-  # will be updated and for arm, the mbr will be updated (for u-boot).
-  local kernel_part=
-  local bootloader_to=
-  local bootloader_to_flags=
-  local usb_disk="${FLAGS_usb_disk}"
-
-  if [[ "${ARCH}" = "x86" ]]; then
-    # x86 should update the esp in place in the image.
-    bootloader_to="${OUTPUT_DIR}/${image_name}"
-    local esp_offset="$(partoffset ${OUTPUT_DIR}/${image_name} 12)"
-    esp_offset=$((esp_offset * 512))  # sectors to bytes
-    local esp_size="$(partsize ${OUTPUT_DIR}/${image_name} 12)"
-    esp_size=$((esp_size * 512))  # sectors to bytes
-    bootloader_to_flags="--to_offset=${esp_offset} --to_size=${esp_size}"
-    # Use the kernel partition to acquire configuration flags.
-    kernel_part="--kernel_partition='${OUTPUT_DIR}/vmlinuz.image'"
-    # Install syslinux on the EFI System Partition.
-    kernel_part="${kernel_part} --install_syslinux"
-  elif [[ "${ARCH}" = "arm" ]]; then
-    # TODO(wad) mmcblk1p3 is hardcoded for arm for now!
-    usb_disk="/dev/mmcblk1p3"
-    # ARM doesn't support using the kernel image for kernel cmdline flags yet.
-    kernel_part="--kernel_cmdline=\"${FLAGS_arm_extra_bootargs}\" "
-    # TODO(wad) Integrate dmtable extraction into the arm build
-    # E.g.  $(cat ${OUTPUT_DIR}/boot.config | tr -s '\n' ' ')"
-    local kpart_offset="--kernel_partition_offset=${koffset}"
-    local kpart_size="--kernel_partition_sectors="
-    kpart_size="${kpart_size}$(partsize ${OUTPUT_DIR}/${image_name} 2)"
-    kernel_part="${kernel_part} ${kpart_size} ${kpart_offset}"
-    info "Using addition bootloader arguments: ${kernel_part}"
-    bootloader_to="${OUTPUT_DIR}/arm.mbr"
-  fi
-
-  # Update partition 12 / legacy bootloaders and arm.
-  ${SCRIPTS_DIR}/update_bootloaders.sh \
-    --arch=${ARCH} \
-    --to="${bootloader_to}" \
-    --from="${OUTPUT_DIR}"/boot \
-    --vmlinuz="${OUTPUT_DIR}"/boot/vmlinuz \
-    --usb_disk="${usb_disk}" \
-    ${bootloader_to_flags} \
-    $kernel_part
-
-  if [[ "${ARCH}" == "arm" ]]; then
-    sudo dd bs=1 conv=notrunc  if="${bootloader_to}" \
-      of="${OUTPUT_DIR}/${image_name}"
-    sudo rm "${bootloader_to}"
-  fi
-
-  trap - EXIT
-  ${SCRIPTS_DIR}/mount_gpt_image.sh -u -r "${ROOT_FS_DIR}" \
-    -s "${STATEFUL_FS_DIR}"
+# Takes no arguments and populates the configuration for
+# cros_make_image_bootable.
+create_boot_desc() {
+  cat <<EOF > ${OUTPUT_DIR}/boot.desc
+  --arch="${ARCH}"
+  --output_dir="${OUTPUT_DIR}"
+  --rootfs_size="${FLAGS_rootfs_size}"
+  --rootfs_hash_pad="${FLAGS_rootfs_hash_pad}"
+  --rootfs_hash="${ROOT_FS_HASH}"
+  --rootfs_mountpoint="${ROOT_FS_DIR}"
+  --statefulfs_mountpoint="${STATEFUL_FS_DIR}"
+  --espfs_mountpoint="${ESP_FS_DIR}"
+  --verity_error_behavior="${FLAGS_verity_error_behavior}"
+  --verity_depth="${FLAGS_verity_depth}"
+  --verity_max_ios="${FLAGS_verity_max_ios}"
+  --verity_algorithm="${FLAGS_verity_algorithm}"
+  --keys_dir="${DEVKEYSDIR}"
+  --usb_disk="${FLAGS_usb_disk}"
+  --nocleanup_dirs
+  ${enable_rootfs_verification_flag}
+EOF
 }
 
 # 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" EXIT
 
@@ skipping 234 matching lines @@
   if [[ ${FLAGS_enable_rootfs_verification} -eq ${FLAGS_TRUE} ]]; then
     enable_rootfs_verification="--enable_rootfs_verification"
   fi
 
   ${SCRIPTS_DIR}/create_legacy_bootloader_templates.sh \
     --arch=${ARCH} \
     --to="${ROOT_FS_DIR}"/boot \
     --install \
     ${enable_rootfs_verification}
 
-  # Create a working copy so we don't need the rootfs mounted
-  sudo mkdir -p "${OUTPUT_DIR}"/boot
-  # This will include any built files dropped in /boot as well.
-  # Like the current vmlinuz.
-  sudo cp -r "${ROOT_FS_DIR}"/boot/. "${OUTPUT_DIR}"/boot/
-  sudo chmod -R a+r "${OUTPUT_DIR}"/boot/
-
   # 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}"
 
-  # make_image_bootable will clobber vmlinuz.image for x86.
+  # cros_make_image_bootable will clobber vmlinuz.image for x86.
   # Until then, just copy the kernel to vmlinuz.image. It is
   # expected in build_gpt.sh and needed by ARM until it supports the
   # full, signed kernel partition format.
   cp "${ROOT_FS_DIR}/boot/vmlinuz" "${OUTPUT_DIR}/vmlinuz.image"
 
   # Create an empty esp image to be updated in by update_bootloaders.sh.
   ${SCRIPTS_DIR}/create_esp.sh --to="${ESP_FS_IMG}"
 
   cleanup
 
@@ skipping 17 matching lines @@
 mkdir -p "${STATEFUL_FS_DIR}"
 mkdir -p "${OEM_FS_DIR}"
 mkdir -p "${ESP_FS_DIR}"
 
 # Preserve old images by copying them forward for --preserve.
 if [[ $FLAGS_preserve -eq ${FLAGS_TRUE} ]] ; then
   if [[ -f ${PREVIOUS_DIR}/${PRISTINE_IMAGE_NAME} ]] ; then
     # Copy forward pristine image, and associated files
     cp ${PREVIOUS_DIR}/*.sh ${PREVIOUS_DIR}/config.txt ${OUTPUT_DIR}
     cp ${PREVIOUS_DIR}/${PRISTINE_IMAGE_NAME} ${OUTPUT_DIR}
-    cp -r ${PREVIOUS_DIR}/boot ${OUTPUT_DIR}/boot
 
     # Copy forward the developer image, if we already copied forward the base.
     if [[ ${FLAGS_withdev} -eq ${FLAGS_TRUE} ]] && \
        [[ -f ${PREVIOUS_DIR}/${DEVELOPER_IMAGE_NAME} ]] ; then
       cp ${PREVIOUS_DIR}/${DEVELOPER_IMAGE_NAME} ${OUTPUT_DIR}
     fi
   fi
 fi
 
+# Create the boot.desc file which stores the build-time configuration
+# information needed for making the image bootable after creation with
+# cros_make_image_bootable.
+create_boot_desc
+
 if [[ -f ${PRISTINE_IMG} ]] ; then
   update_base_packages ${PRISTINE_IMAGE_NAME}
 else
   create_base_image ${PRISTINE_IMAGE_NAME}
 fi
-make_image_bootable ${PRISTINE_IMAGE_NAME}
+${SCRIPTS_DIR}/bin/cros_make_image_bootable "${OUTPUT_DIR}" \
+                                            "${PRISTINE_IMAGE_NAME}"
 
 # FIXME: only signing things for x86 right now.
 if [[ "${ARCH}" = "x86" ]]; then
   # Verify the final image.
   load_kernel_test "${OUTPUT_DIR}/${PRISTINE_IMAGE_NAME}" \
     "${DEVKEYSDIR}/recovery_key.vbpubk"
 fi
 
 # Create a developer image based on the chromium os base image.
 if [ "${FLAGS_withdev}" -eq "${FLAGS_TRUE}" ] ; then
   if [[ ! -f ${DEVELOPER_IMG} ]] ; then
     echo "Creating developer image from base image ${PRISTINE_IMAGE_NAME}"
     cp ${PRISTINE_IMG} ${DEVELOPER_IMG}
   fi
 
   update_dev_packages ${DEVELOPER_IMAGE_NAME}
-  make_image_bootable ${DEVELOPER_IMAGE_NAME}
+  ${SCRIPTS_DIR}/bin/cros_make_image_bootable "${OUTPUT_DIR}" \
+                                              "${DEVELOPER_IMAGE_NAME}"
 fi
 
 # Clean up temporary files.
 rm -f "${ROOT_FS_IMG}" "${STATEFUL_FS_IMG}" "${OUTPUT_DIR}/vmlinuz.image" \
   "${ESP_FS_IMG}" "${OEM_FS_IMG}" "${OUTPUT_DIR}/vmlinuz_hd.vblock"
 rmdir "${ROOT_FS_DIR}" "${STATEFUL_FS_DIR}" "${OEM_FS_DIR}" "${ESP_FS_DIR}"
 
 echo "Done.  Image created in ${OUTPUT_DIR}"
 echo "Chromium OS image created as ${PRISTINE_IMAGE_NAME}"
 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, INSIDE the chroot, do something like:"
 echo "  ./image_to_vm.sh --from=${OUTSIDE_OUTPUT_DIR}"
 echo "from the scripts directory where you entered the chroot."