diff options
Diffstat (limited to 'bsp/meta-arm/meta-arm-autonomy/classes/xenguest-image.bbclass')
| -rw-r--r-- | bsp/meta-arm/meta-arm-autonomy/classes/xenguest-image.bbclass | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/bsp/meta-arm/meta-arm-autonomy/classes/xenguest-image.bbclass b/bsp/meta-arm/meta-arm-autonomy/classes/xenguest-image.bbclass new file mode 100644 index 00000000..e8880f3f --- /dev/null +++ b/bsp/meta-arm/meta-arm-autonomy/classes/xenguest-image.bbclass @@ -0,0 +1,195 @@ +# This class must be used to create, extend or pack a xenguest image. +# It is using xenguest-mkimage tool to do operations + +DEPENDS += "xenguest-mkimage-native" + +# +# Xenguest image parameters +# All the following parameters can be modified in local.conf or on recipes +# inheriting this class +# + +# Guest memory size in MB +XENGUEST_IMAGE_MEMORY_SIZE ??= "512" + +# Guest number of vcpus +XENGUEST_IMAGE_NUM_VCPUS ??= "1" + +# Guest auto boot during init, set to 1 to have guest started during init or +# to 0 if the guest should not be auto started +XENGUEST_IMAGE_AUTOBOOT ??= "1" + +# Partition containing the root file system +# Xen will actually add root=${XENGUEST_IMAGE_ROOT} to your guest kernel +# command line +# You can let this empty if the root filesystem is specified in an other way +# and have root= option added to the command line for example or if you don't +# need a root filesystem mounted for your guest (initrd for example) +XENGUEST_IMAGE_ROOT ??= "/dev/xvda1" + +# Guest kernel command line arguments +XENGUEST_IMAGE_CMDLINE ??= "earlyprintk=xenboot console=hvc0 rw" + +# Extra commands to add to xenguest-image when creating the image +XENGUEST_IMAGE_EXTRA_CMD ??= "" + +# Kernel binary +# This value is used by the xenguest image type but is declared here to have +# all variables in the same place +# If this value is empty no kernel will be added to the image +XENGUEST_IMAGE_KERNEL ??= "Image" + +# Size of the disk to create (if 0 no disk will be created and rootfs will not +# be included in the xenguest image) +XENGUEST_IMAGE_DISK_SIZE ??= "${@ '4' if not d.getVar('INITRAMFS_IMAGE') else '0'}" + +# +# XENGUEST_IMAGE_DISK PARTITIONS is used to describe the partitions to setup +# and their content. +# It must be set to a space separated list of entries with each entry having +# the format num:sz:fs:[file] where: +# - num is a partition number +# - sz is the partition size in Gigabit +# - fs is the filesystem to use for the partition +# - file is optionally pointing to a file to use as content of the partition +# Please check image_types_xenguest.bbclass for rootfs handling of files +# +# Default value creates a partition 1 using the full disk, formated with ext4 +# and containing the root filesystem produced by Yocto +XENGUEST_IMAGE_DISK_PARTITIONS ??= "1:${XENGUEST_IMAGE_DISK_SIZE}:ext4:rootfs.tar.gz" + +# XENGUEST_IMAGE_NETWORK_BRIDGE can be set to 1 to have a network interface +# on the guest connected to host bridged network. This will provide the guest +# with a network interface connected directly to the external network +XENGUEST_IMAGE_NETWORK_BRIDGE ??= "1" + +# Sub-directory in wich the guest is created. This is create in deploy as a +# subdirectory and must be coherent between all components using this class so +# it must only be modified from local.conf if needed +XENGUEST_IMAGE_DEPLOY_SUBDIR ?= "xenguest" + +# Directory in which the xenguest should be deployed +# a sub-directory named ${XENGUEST_IMAGE_DEPLOY_SUBDIR} will be created there. +# This should be set to: +# - ${DEPLOYDIR} (default) if creating or extending the xenguest for a normal +# recipe. +# - something in ${WORKDIR} if you need to clone and manipulate an image +XENGUEST_IMAGE_DEPLOY_DIR ??= "${DEPLOYDIR}" + +# +# Wrapper to call xenguest-mkimage +# It is using XENGUEST_IMAGE_DEPLOY_DIR and XENGUEST_IMAGE_DEPLOY_SUBDIR +# to find the image to operate on +# +# Usage: call_xenguest_mkimage [operation] [args] +call_xenguest_mkimage() { + local cmd="${1}" + local img="${XENGUEST_IMAGE_DEPLOY_DIR}/${XENGUEST_IMAGE_DEPLOY_SUBDIR}" + shift + + echo "xenguest-mkimage $cmd $img $@" + xenguest-mkimage $cmd $img $@ +} + +# +# Create an initial xenguest image. +# This is a task which must be added in a recipe inheriting deploy +# It is using XENGUEST_IMAGE_MEMORY_SIZE, XENGUEST_IMAGE_NUM_VCPUS, +# XENGUEST_IMAGE_AUTOBOOT, XENGUEST_IMAGE_ROOT, XENGUEST_IMAGE_EXTRA_CMD, +# XENGUEST_IMAGE_CMDLINE, XENGUEST_IMAGE_DISK_SIZE and +# XENGUEST_IMAGE_DISK_PARTITIONS to customize the initial guest +# +xenguest_image_create() { + if [ -z "${XENGUEST_IMAGE_DEPLOY_DIR}" -o \ + -z "${XENGUEST_IMAGE_DEPLOY_SUBDIR}" ]; then + die "Configuration error: XENGUEST_IMAGE_DEPLOY_DIR or XENGUEST_IMAGE_DEPLOY_SUBDIR is empty" + fi + + rm -rf ${XENGUEST_IMAGE_DEPLOY_DIR}/${XENGUEST_IMAGE_DEPLOY_SUBDIR} + + mkdir -p ${XENGUEST_IMAGE_DEPLOY_DIR}/${XENGUEST_IMAGE_DEPLOY_SUBDIR} + + # Create the image + call_xenguest_mkimage create --xen-memory=${XENGUEST_IMAGE_MEMORY_SIZE} \ + --xen-vcpus=${XENGUEST_IMAGE_NUM_VCPUS} \ + --xen-root=${XENGUEST_IMAGE_ROOT} \ + ${XENGUEST_IMAGE_EXTRA_CMD} + + # add command line + if [ -n "${XENGUEST_IMAGE_CMDLINE}" ]; then + call_xenguest_mkimage update --xen-clean-extra + for arg in ${XENGUEST_IMAGE_CMDLINE}; do + call_xenguest_mkimage update --xen-extra=$arg + done + fi + + # create disk if needed + disksize="${XENGUEST_IMAGE_DISK_SIZE}" + if [ -z "$disksize" ]; then + disksize="0" + fi + if [ $disksize -gt 0 ]; then + # setup disk size + call_xenguest_mkimage update --disk-reset-config --disk-size=$disksize + + diskparts="${XENGUEST_IMAGE_DISK_PARTITIONS}" + if [ -n "$diskparts" ]; then + for arg in $diskparts; do + call_xenguest_mkimage update --disk-add-part=$arg + partnum="$(expr $partnum + 1)" + done + fi + fi + + if [ "${XENGUEST_IMAGE_AUTOBOOT}" = "1" ]; then + call_xenguest_mkimage update --set-param=GUEST_AUTOBOOT=1 + else + call_xenguest_mkimage update --set-param=GUEST_AUTOBOOT=0 + fi + + if [ "${XENGUEST_IMAGE_NETWORK_BRIDGE}" = "1" ]; then + call_xenguest_mkimage update --set-param=NETWORK_BRIDGE=1 + else + call_xenguest_mkimage update --set-param=NETWORK_BRIDGE=0 + fi +} + +# +# Clone the current xenguest from deploy to manipulate it locally +# This is required if you need to change things before packing an image +# To set the local directory where to clone you must set +# XENGUEST_IMAGE_DEPLOY_DIR if you don't want to use do_deploy to modify the +# image +# +xenguest_image_clone() { + if [ -z "${XENGUEST_IMAGE_DEPLOY_DIR}" -o \ + -z "${XENGUEST_IMAGE_DEPLOY_SUBDIR}" ]; then + die "Configuration error: XENGUEST_IMAGE_DEPLOY_DIR or XENGUEST_IMAGE_DEPLOY_SUBDIR is empty" + fi + + if [ ! -f ${DEPLOY_DIR_IMAGE}/${XENGUEST_IMAGE_DEPLOY_SUBDIR}/guest.cfg ]; then + die "xenguest-image: ${DEPLOY_DIR_IMAGE}/${XENGUEST_IMAGE_DEPLOY_SUBDIR} does not contain a valid guest" + fi + + rm -rf ${XENGUEST_IMAGE_DEPLOY_DIR}/${XENGUEST_IMAGE_DEPLOY_SUBDIR} + mkdir -p ${XENGUEST_IMAGE_DEPLOY_DIR} + cp -rf ${DEPLOY_DIR_IMAGE}/${XENGUEST_IMAGE_DEPLOY_SUBDIR} \ + ${XENGUEST_IMAGE_DEPLOY_DIR}/${XENGUEST_IMAGE_DEPLOY_SUBDIR} +} + +# Helper function to retrieve rootfs file if present in one partition +# This can return an empty string or rootfs.tar[.COMP] +def xenguest_image_rootfs_file(d): + disksize = d.getVar('XENGUEST_IMAGE_DISK_SIZE') + # if disksize is 0, we don't create anything + if not disksize or disksize == '0': + return "" + # Find first partition with file=rootfs.tar* + partlist = d.getVar('XENGUEST_IMAGE_DISK_PARTITIONS') + if partlist: + for partdesc in partlist.split(): + partelems = partdesc.split(':', 3) + if partelems[3]: + if partelems[3].startswith('rootfs.tar'): + return partelems[3] + return "" |