lvm.sh

#
# SPDX-License-Identifier: GPL-2.0
# Copyright (c) 2024 Rafel del Valle <rvalle@privaz.io>
# This file is a part of the Armbian Build Framework https://github.com/armbian/build/
#

# This extension will place the root partition on an LVM volume.
# It is possible to customise the volume group name and the image is extended to allow
# for LVM headers

# In case of failed builds check for leaked logical volumes with "dmsetup list" and
# remove them with "dmsetup remove"

# Additional log infomration will be created on lvm.log

# We will need to create several LVM objects: PV VG VOL on the image from the host
function add_host_dependencies__lvm_host_deps() {
	declare -g EXTRA_BUILD_DEPS="${EXTRA_BUILD_DEPS} lvm2"
}

function extension_prepare_config__lvm_image_suffix() {
	# Add to image suffix.
	EXTRA_IMAGE_SUFFIXES+=("-lvm")
}

function extension_prepare_config__prepare_lvm() {
	# Config for lvm, boot partition is required, many bootloaders do not support LVM.
	declare -g BOOTPART_REQUIRED=yes
	declare -g LVM_VG_NAME="${LVM_VG_NAME:-armbivg}"
	declare -g EXTRA_ROOTFS_MIB_SIZE=256
	add_packages_to_image lvm2
}

function post_create_partitions__setup_lvm() {

	LOOP=$(losetup -f)
	[[ -z $LOOP ]] && exit_with_error "Unable to find free loop device"
	check_loop_device "$LOOP"
	losetup $LOOP ${SDCARD}.raw
	partprobe $LOOP

	# the partition to setup LVM on is defined as rootpart
	local lvmpart=${rootpart}
	local lvmdev=${LOOP}p${lvmpart}
	display_alert "LVM will be on Partition ${lvmpart}, thats ${lvmdev}" "${EXTENSION}" "info"

	# Setup LVM on the partition, ROOTFS
	parted -s ${SDCARD}.raw -- set ${lvmpart} lvm on
	display_alert "LVM Partition table created" "${EXTENSION}" "info"
	parted -s ${SDCARD}.raw -- print >> "${DEST}"/${LOG_SUBPATH}/lvm.log 2>&1

	# Caculate the required volume size
	declare -g -i rootfs_size
	rootfs_size=$(du --apparent-size -sm "${SDCARD}"/ | cut -f1) # MiB
	display_alert "Current rootfs size" "$rootfs_size MiB" "info"
	volsize=$(bc -l <<< "scale=0; ((($rootfs_size * 1.30) / 1 + 0) / 4 + 1) * 4")
	display_alert "Root volume size" "$volsize MiB" "info"

	# Create the PV VG and VOL
	display_alert "LVM Creating VG" "${SDCARD}.raw" "info"
	check_loop_device ${lvmdev}
	pvcreate ${lvmdev}
	vgcreate ${LVM_VG_NAME} ${lvmdev}
	# Note that devices wont come up automatically inside docker
	lvcreate -Zn --name root --size ${volsize}M ${LVM_VG_NAME}
	vgmknodes
	lvs >> "${DEST}"/${LOG_SUBPATH}/lvm.log 2>&1
	vgchange -a n ${LVM_VG_NAME}
	losetup -d ${LOOP}
	display_alert "LVM created volume group" "${EXTENSION}" "info"
}

function prepare_root_device__create_volume_group() {

	LOOP=$(losetup -f)
	[[ -z $LOOP ]] && exit_with_error "Unable to find free loop device"
	check_loop_device "$LOOP"
	losetup $LOOP ${SDCARD}.raw
	partprobe $LOOP

	display_alert "Using LVM root" "${EXTENSION}" "info"
	vgscan
	vgchange -a y ${LVM_VG_NAME}

	rootdevice=/dev/mapper/${LVM_VG_NAME}-root
	display_alert "Root device is ${rootdevice}" "${EXTENSION}" "info"
}

function format_partitions__format_lvm() {
	# Label the root volume
	e2label /dev/mapper/${LVM_VG_NAME}-root armbi_root
	blkid | grep ${LVM_VG_NAME} >> "${DEST}"/${LOG_SUBPATH}/lvm.log 2>&1
	display_alert "LVM labeled partitions" "${EXTENSION}" "info"
}

function post_umount_final_image__close_lvm() {
	# Deactivat the Volume Group
	vgchange -a n ${LVM_VG_NAME}
	display_alert "LVM deactivated volume group" "${EXTENSION}" "info"
}