build_functions.sh

#!/bin/bash
# Bash script that creates a Debian rootfs or even a complete SD memory card for the Embedded Projects Gnublin board
# Should run on current Debian or Ubuntu versions
# Author: Ingmar Klein (ingmar.klein@hs-augsburg.de)
# Created in scope of the "Embedded Linux" lecture, held by Professor Hubert Hoegl, at the University of Applied Sciences Augsburg, 2012


# This program (including documentation) is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License version 3 (GPLv3; http://www.gnu.org/licenses/gpl-3.0.html ) for more details.


###########################
##### MAIN Functions: #####
###########################

# Description: Check if the user calling the script has the necessary priviliges
check_priviliges()
{
if [[ $UID -ne 0 ]]
then
	echo "$0 must be run as root/superuser (sudo etc.)!
Please try again with the necessary priviliges."
	exit 2
fi
}


# Description: Function to log and echo messages in terminal at the same time
fn_my_echo()
{
	if [ -d ${output_dir} ]
	then
		echo "`date`:   ${1}" >> ${output_dir}/log.txt
		echo "${1}"
	else
		echo "Output directory '${output_dir}' doesn't exist. Exiting now!"
		exit 3
	fi
}


# Description: See if the needed packages are installed and if the versions are sufficient
check_n_install_prerequisites()
{
fn_my_echo "Installing some packages, if needed."
if [ "${host_os}" = "Debian" ]
then
	apt_prerequisites=${apt_prerequisites_debian}
elif [ "${host_os}" = "Ubuntu" ]
then
	apt_prerequisites=${apt_prerequisites_ubuntu}
else
	fn_my_echo "OS-Type '${host_os}' not correct.
Please run 'build_debian_system.sh --help' for more information"
	exit 4
fi

fn_my_echo "Running 'apt-get update' to get the latest package dependencies."
apt-get update
if [ "$?" = "0" ]
then
	fn_my_echo "'apt-get update' ran successfully! Continuing..."
else
	fn_my_echo "ERROR while trying to run 'apt-get update'. Exiting now."
	exit 5
fi

set -- ${apt_prerequisites}

while [ $# -gt 0 ]
do
	dpkg -l |grep "ii  ${1}" >/dev/null
	if [ "$?" = "0" ]
	then
		fn_my_echo "Package '${1}' is already installed. Nothing to be done."
	else
		fn_my_echo "Package '${1}' is not installed yet.
Trying to install it now!"
		apt-get install -y --force-yes ${1}
		if [ "$?" = "0" ]
		then
			fn_my_echo "'${1}' installed sueccessfully!"
		else
			fn_my_echo "ERROR while trying to install '${1}'."
			if [ "${host_os}" = "Ubuntu" ] && [ "${1}" = "qemu-system" ]
			then
				fn_my_echo "Assuming that you are running this on Ubuntu 10.XX, where the package 'qemu-system' doesn't exist.
If your host system is not Ubuntu 10.XX based, this could lead to errors. Please check!"
			else
				fn_my_echo "Exiting now!"
				exit 7
			fi
		fi
	fi

	if [ $1 = "qemu-user-static" ] && [ "${host_os}" = "Debian" ]
	then
		sh -c "dpkg -l|grep "qemu-user-static"|grep "1."" >/dev/null
		if [ $? = "0" ]
		then
			fn_my_echo "Sufficient version of package '${1}' found. Continueing..."
		else
			fn_my_echo "The installed version of package '${1}' is too old.
You need to install a package with a version of at least 1.0.
For example from the debian-testing repositiories.
Link: 'http://packages.debian.org/search?keywords=qemu&searchon=names&suite=testing&section=all'
Exiting now!"
			exit 6
		fi
	fi
	shift
done

fn_my_echo "Function 'check_n_install_prerequisites' DONE."
}


# Description: Create a image file as root-device for the installation process
create_n_mount_temp_image_file()
{
fn_my_echo "Creating the temporary image file for the debootstrap process."
dd if=/dev/zero of=${output_dir}/${output_filename}.img bs=1M count=${work_image_size_MB}
if [ "$?" = "0" ]
then
	fn_my_echo "File '${output_dir}/${output_filename}.img' successfully created with a size of ${work_image_size_MB}MB."
else
	fn_my_echo "ERROR while trying to create the file '${output_dir}/${output_filename}.img'. Exiting now!"
	exit 8
fi

fn_my_echo "Formatting the image file with the ext3 filesystem."
mkfs.ext3 -F ${output_dir}/${output_filename}.img
if [ "$?" = "0" ]
then
	fn_my_echo "Ext3 filesystem successfully created on '${output_dir}/${output_filename}.img'."
else
	fn_my_echo "ERROR while trying to create the ext3 filesystem on  '${output_dir}/${output_filename}.img'. Exiting now!"
	exit 9
fi

fn_my_echo "Creating the directory to mount the temporary filesystem."
mkdir -p ${output_dir}/mnt_debootstrap
if [ "$?" = "0" ]
then
	fn_my_echo "Directory '${output_dir}/mnt_debootstrap' successfully created."
else
	fn_my_echo "ERROR while trying to create the directory '${output_dir}/mnt_debootstrap'. Exiting now!"
	exit 10
fi

fn_my_echo "Now mounting the temporary filesystem."
mount ${output_dir}/${output_filename}.img ${output_dir}/mnt_debootstrap -o loop
if [ "$?" = "0" ]
then
	fn_my_echo "Filesystem correctly mounted on '${output_dir}/mnt_debootstrap'."
else
	fn_my_echo "ERROR while trying to mount the filesystem on '${output_dir}/mnt_debootstrap'. Exiting now!"
	exit 11
fi

fn_my_echo "Function 'create_n_mount_temp_image_file' DONE."
}


# Description: Run the debootstrap steps, like initial download, extraction plus configuration and setup
do_debootstrap()
{
fn_my_echo "Running first stage of debootstrap now."
debootstrap --verbose --arch armel --variant=minbase --foreign ${debian_target_version} ${output_dir}/mnt_debootstrap ${debian_mirror_url}
if [ "$?" = "0" ]
then
	fn_my_echo "Debootstrap 1st stage finished successfully."
else
	fn_my_echo "ERROR while trying to run the first stage of debootstrap. Exiting now!"
	umount_img all
	exit 12
fi

modprobe binfmt_misc

cp /usr/bin/qemu-arm-static ${output_dir}/mnt_debootstrap/usr/bin

mkdir -p ${output_dir}/mnt_debootstrap/dev/pts

fn_my_echo "Mounting both /dev/pts and /proc on the temporary filesystem."
mount devpts ${output_dir}/mnt_debootstrap/dev/pts -t devpts
mount -t proc proc ${output_dir}/mnt_debootstrap/proc

fn_my_echo "Entering chroot environment NOW!"

fn_my_echo "Starting the second stage of debootstrap now."
/usr/sbin/chroot ${output_dir}/mnt_debootstrap /bin/bash -c "
mkdir -p /usr/share/man/man1/
/debootstrap/debootstrap --second-stage 2>>/deboostrap_stg2_errors.txt
cd /root 2>>/deboostrap_stg2_errors.txt

cat <<END > /etc/apt/sources.list 2>>/deboostrap_stg2_errors.txt
deb http://ftp.uk.debian.org/emdebian/grip ${debian_target_version} main dev doc debug java
deb-src http://ftp.uk.debian.org/emdebian/grip ${debian_target_version} main

END

apt-get update

mkdir -p /dev/bus/usb/001/
for k in {0..9}; do mknod /dev/bus/usb/001/0\${k} c 189 \${k}; done;
for l in {10..31}; do mknod /dev/bus/usb/001/0\${l} c 189 \${l}; done;
mknod /dev/ttyS0 c 4 64	# for the serial console
mknod /dev/rtc0 c 254 0
mknod /dev/ramzswap0 b 254 0
mknod -m 0666 /dev/mmcblk0p3 b 179 3	# SWAP
mknod /dev/sda b 8 0	# SCSI storage device
mknod /dev/sda1 b 8 1
mknod /dev/sda2 b 8 2
mknod /dev/sda3 b 8 3
ln -s /dev/rtc0 /dev/rtc

cat <<END > /etc/network/interfaces
auto lo eth0
iface lo inet loopback
iface eth0 inet dhcp
END

echo gnublin-emdebian > /etc/hostname 2>>/deboostrap_stg2_errors.txt

echo \"127.0.0.1 localhost\" >> /etc/hosts 2>>/deboostrap_stg2_errors.txt
echo \"127.0.0.1 gnublin-debian\" >> /etc/hosts 2>>/deboostrap_stg2_errors.txt
echo \"nameserver ${nameserver_addr}\" > /etc/resolv.conf 2>>/deboostrap_stg2_errors.txt

cat <<END > /etc/rc.local 2>>/deboostrap_stg2_errors.txt
#!/bin/sh -e
#
# rc.local
#
# This script is executed at the end of each multiuser runlevel.
# Make sure that the script will exit 0 on success or any other
# value on error.
#
# In order to enable or disable this script just change the execution
# bits.
#
# By default this script does nothing.

if [ -e /ramzswap_setup.sh ]
then
	/ramzswap_setup.sh 2>/ramzswap_setup_log.txt && rm /ramzswap_setup.sh
fi
/setup.sh 2>/setup_log.txt && rm /setup.sh

exit 0
END
exit" 2>${output_dir}/chroot_1_log.txt

if [ "$?" = "0" ]
then
	fn_my_echo "First part of chroot operations done successfully!"
else
	fn_my_echo "Errors while trying to run the first part of the chroot operations."
fi

mount devpts ${output_dir}/mnt_debootstrap/dev/pts -t devpts
mount -t proc proc ${output_dir}/mnt_debootstrap/proc

/usr/sbin/chroot ${output_dir}/mnt_debootstrap /bin/sh -c "
export LANG=C 2>>/deboostrap_stg2_errors.txt
apt-get -y --force-yes  install apt-utils dialog locales manpages man-db 2>>/deboostrap_stg2_errors.txt

cat <<END > /etc/apt/apt.conf 2>>/deboostrap_stg2_errors.txt
APT::Install-Recommends \"0\";
APT::Install-Suggests \"0\";
END

apt-get -d -y --force-yes install ${additional_packages} 2>>/deboostrap_stg2_errors.txt

sed -i 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/g' /etc/locale.gen 2>>/deboostrap_stg2_errors.txt	# enable locale
locale-gen 2>>/deboostrap_stg2_errors.txt

export LANG=en_US.UTF-8 2>>/deboostrap_stg2_errors.txt	# language settings
export LC_ALL=en_US.UTF-8 2>>/deboostrap_stg2_errors.txt
export LANGUAGE=en_US.UTF-8 2>>/deboostrap_stg2_errors.txt

cat <<END > /etc/fstab 2>>/deboostrap_stg2_errors.txt
# /etc/fstab: static file system information.
#
# <file system> <mount point>   <type>  <options>       <dump>  <pass>
/dev/root	/	ext3	noatime,errors=remount-ro	0	1
/dev/mmcblk0p3	none	swap	defaults	0	0
END

update-rc.d -f mountoverflowtmp remove 2>>/deboostrap_stg2_errors.txt
echo 'T0:2345:respawn:/sbin/getty -L ttyS0 115200 vt102' >> /etc/inittab 2>>/deboostrap_stg2_errors.txt	# disable virtual consoles
sed -i 's/^\([1-6]:.* tty[1-6]\)/#\1/' /etc/inittab 2>>/deboostrap_stg2_errors.txt

exit
" 2>${output_dir}/chroot_2_log.txt

if [ "$?" = "0" ]
then
	fn_my_echo "Second part of chroot operations done successfully!"
else
	fn_my_echo "Errors while trying to run the second part of the chroot operations."
fi

sleep 5
umount_img sys
fn_my_echo "Just exited chroot environment."
fn_my_echo "Base debootstrap steps 1&2 are DONE!"
}



# Description: Do some further configuration of the system, after debootstrap has finished
do_post_debootstrap_config()
{

fn_my_echo "Now starting the post-debootstrap configuration steps."

mkdir -p ${output_dir}/qemu-kernel

get_n_check_file "${std_kernel_pkg_path}" "${std_kernel_pkg_name}" "standard_kernel"

get_n_check_file "${qemu_kernel_pkg_path}" "${qemu_kernel_pkg_name}" "qemu_kernel"

tar_all extract "${output_dir}/tmp/${qemu_kernel_pkg_name}" "${output_dir}/qemu-kernel"
sleep 3
tar_all extract "${output_dir}/tmp/${std_kernel_pkg_name}" "${output_dir}/mnt_debootstrap"

cp -ar ${output_dir}/qemu-kernel/lib/ ${output_dir}/mnt_debootstrap

if [ "${use_ramzswap}" = "yes" ]
then
	echo "#!/bin/sh
cat <<END > /etc/rc.local 2>>/ramzswap_setup_errors.txt
#!/bin/sh -e
#
# rc.local
#
# This script is executed at the end of each multiuser runlevel.
# Make sure that the script will exit 0 on success or any other
# value on error.
#
# In order to enable or disable this script just change the execution
# bits.
#
# By default this script does nothing.

modprobe ${ramzswap_kernel_module_name} num_devices=1 disksize_kb=${ramzswap_size_kb}
swapon -p 100 /dev/ramzswap0
exit 0
END

exit 0" > ${output_dir}/mnt_debootstrap/ramzswap_setup.sh
chmod +x ${output_dir}/mnt_debootstrap/ramzswap_setup.sh
fi

echo "
########################################################
########################################################
## __      __     _                        _          ##
## \ \    / /___ | | __  ___  _ __   ___  | |_  ___   ##
##  \ \/\/ // -_)| |/ _|/ _ \| '  \ / -_) |  _|/ _ \  ##
##   \_/\_/ \___||_|\__|\___/|_|_|_|\___|  \__|\___/  ##
##     _____ _   _ _    _ ____  _      _____ _   _    ##
##    / ____| \ | | |  | |  _ \| |    |_   _| \ | |   ##
##   | |  __|  \| | |  | | |_) | |      | | |  \| |   ##
##   | | |_ | . \` | |  | |  _ <| |      | | | . \` |   ##
##   | |__| | |\  | |__| | |_) | |____ _| |_| |\  |   ##
##    \_____|_| \_|\____/|____/|______|_____|_| \_|   ##
##   ______               _      _     _              ##
##  |  ____|             | |    | |   (_)             ##
##  | |__   _ __ ___   __| | ___| |__  _  __ _ _ __   ##
##  |  __| | '_ \` _ \ / _\` |/ _ \ '_ \| |/ _\` | '_ \  ##
##  | |____| | | | | | (_| |  __/ |_) | | (_| | | | | ##
##  |______|_| |_| |_|\__,_|\___|_.__/|_|\__,_|_| |_| ##
##                                                    ##
########################################################
########################################################
" >> ${output_dir}/mnt_debootstrap/etc/motd.tail


date_cur=`date` # needed further down as a very important part to circumvent the PAM Day0 change password problem

echo "#!/bin/sh

date -s \"${date_cur}\" 2>>/post_deboostrap_errors.txt	# set the system date to prevent PAM from exhibiting its nasty DAY0 forced password change
apt-get -y --force-yes install ${additional_packages} 2>>/post_deboostrap_errors.txt && apt-get clean	# install the already downloaded packages

if [ "${i2c_hwclock}" = "yes" ]
then 
	update-rc.d -f i2c_hwclock.sh start 02 S . stop 07 0 6 . 2>>/post_deboostrap_errors.txt
fi

cat <<END > /sbin/hotplug 2>>/post_deboostrap_errors.txt	# entry for devices with firmware specifically
#!/bin/sh
HOTPLUG_FW_DIR=/lib/firmware
echo 1 > /sys/\\\${DEVPATH}/loading
cat \\\${HOTPLUG_FW_DIR}/\\\${FIRMWARE} > /sys/\\\${DEVPATH}/data
echo 0 > /sys/\\\${DEVPATH}/loading
END

chmod +x /sbin/hotplug

if [ "${use_ramzswap}" = "yes" ]
then
	echo vm.swappiness=${vm_swappiness} >> /etc/sysctl.conf
fi

if [ ! -z `grep setup.sh /etc/rc.local` ]
then
	cat <<END > /etc/rc.local 2>>/post_deboostrap_errors.txt
#!/bin/sh -e
#
# rc.local
#
# This script is executed at the end of each multiuser runlevel.
# Make sure that the script will exit 0 on success or any other
# value on error.
#
# In order to enable or disable this script just change the execution
# bits.
#
# By default this script does nothing.

exit 0
END
fi

sh -c \"echo 'root
root
' | passwd root\" 2>>/post_deboostrap_errors.txt
passwd -u root 2>>/post_deboostrap_errors.txt
passwd -x -1 root 2>>/post_deboostrap_errors.txt
passwd -w -1 root 2>>/post_deboostrap_errors.txt

ldconfig

reboot 2>>/post_deboostrap_errors.txt
exit 0" > ${output_dir}/mnt_debootstrap/setup.sh

chmod +x ${output_dir}/mnt_debootstrap/setup.sh

if [ "${i2c_hwclock}" = "yes" ]
then
	fn_my_echo "Setting up a script for being able to use the i2c-connected RTC (hardware clock)."
	echo "#!/bin/sh
### BEGIN INIT INFO
# Provides:          i2c-hwclock
# Required-Start:    checkroot
# Required-Stop:     $local_fs
# Default-Start:     S
# Default-Stop:      0 6
### END INIT INFO

case \"\$1\" in
	start)
	if [ ! -e /dev/rtc0 ]
	then
		mknod /dev/rtc0 c 254 0
	else
		if [ ! -e /dev/rtc ]
		then
			ln -s /dev/rtc0 /dev/rtc
		fi
	fi
	modprobe i2c-pnx
	modprobe ${rtc_kernel_module_name}
	echo ${i2c_hwclock_name} ${i2c_hwclock_addr} > /sys/bus/i2c/devices/i2c-1/new_device
	/sbin/hwclock -s && echo \"Time successfully set from the RTC!\"
	;;
	stop|restart|reload|force-reload)
	#echo ${i2c_hwclock_name} ${i2c_hwclock_addr} > /sys/bus/i2c/devices/i2c-1/delete_device
	#modprobe -r rtc-ds1307
	#modprobe -r i2c-pnx
	;;
	*)
	    echo \"Usage: i2c_hwclock.sh {start|stop}\"
	    echo \"       start sets up kernel i2c-system for using the i2c-connected hardware (RTC) clock\"
	    echo \"       stop unloads the driver module for the hardware (RTC) clock\"
	    return 1
	;;
    esac
exit 0" > ${output_dir}/mnt_debootstrap/etc/init.d/i2c_hwclock.sh
	chmod +x ${output_dir}/mnt_debootstrap/etc/init.d/i2c_hwclock.sh
else
	fn_my_echo "No RTC (hardware clock) setup. Continueing..."
fi

sed_search_n_replace "mkdir /lib/init/rw/sendsigs.omit.d/" "if [ ! -d  /lib/init/rw/sendsigs.omit.d/ ]; then mkdir /lib/init/rw/sendsigs.omit.d/; fi;" ${output_dir}/mnt_debootstrap/etc/init.d/mountkernfs.sh

sleep 1

umount_img all
if [ "$?" = "0" ]
then
	fn_my_echo "Filesystem image file successfully unmounted. Ready to continue."
else
	fn_my_echo "Error while trying to unmount the filesystem image. Exiting now!"
	exit 13
fi

sleep 5

mount |grep "${output_dir}/mnt_debootstrap" > /dev/null
if [ ! "$?" = "0" ]
then
	fn_my_echo "Starting the qemu environment now!"
	qemu-system-arm -M versatilepb -cpu arm926 -no-reboot -kernel ${output_dir}/qemu-kernel/zImage -hda ${output_dir}/${output_filename}.img -m 256 -append "root=/dev/sda rootfstype=ext3 mem=256M devtmpfs.mount=0 rw ip=dhcp" 2>qemu_error_log.txt
else
	fn_my_echo "ERROR! Filesystem is still mounted. Can't run qemu!"
	exit 14
fi

fn_my_echo "Additional chroot system configuration successfully finished!"

}


# Description: Compress the resulting rootfs
compress_debian_rootfs()
{
fn_my_echo "Compressing the rootfs now!"

mount |grep ${output_dir}/${output_filename}.img >/dev/null
if [ ! "$?" = "0" ]
then 
	fsck.ext3 -fy ${output_dir}/${output_filename}.img
	if [ "$?" = "0" ]
	then
		fn_my_echo "Temporary filesystem checked out, OK!"
	else
		fn_my_echo "ERROR: State of Temporary filesystem is NOT OK! Exiting now."
		umount_img all
		exit 60
	fi
else
	fn_my_echo "ERROR: Image file still mounted. Exiting now!"
	umount_img all
	exit 61
fi

mount ${output_dir}/${output_filename}.img ${output_dir}/mnt_debootstrap -o loop
if [ "$?" = "0" ]
then
	rm -r ${output_dir}/mnt_debootstrap/lib/modules/2.6.33-gnublin-qemu-*/
	cd ${output_dir}/mnt_debootstrap
	if [ "${tar_format}" = "bz2" ]
	then
		tar_all compress "${output_dir}/${output_filename}.tar.${tar_format}" .
	elif [ "${tar_format}" = "gz" ]
	then
		tar_all compress "${output_dir}/${output_filename}.tar.${tar_format}" .
	else
		fn_my_echo "Incorrect setting '${tar_format}' for the variable 'tar_format' in the general_settings.sh.
Please check! Only valid entries are 'bz2' or 'gz'. Could not compress the Rootfs!"
	fi

	cd ${output_dir}
	sleep 5
else
	fn_my_echo "ERROR: Image file could not be remounted correctly. Exiting now!"
	umount_img all
	exit 62
fi

umount ${output_dir}/mnt_debootstrap
sleep 10
mount | grep ${output_dir}/mnt_debootstrap > /dev/null
if [ ! "$?" = "0" ] && [ "${clean_tmp_files}" = "yes" ]
then
	rm -r ${output_dir}/mnt_debootstrap
	rm -r ${output_dir}/qemu-kernel
	rm ${output_dir}/${output_filename}.img
elif [ "$?" = "0" ] && [ "${clean_tmp_files}" = "yes" ]
then
	fn_my_echo "Directory '${output_dir}/mnt_debootstrap' is still mounted, so it can't be removed. Exiting now!"
	umount_img all
	exit 15
elif [ "$?" = "0" ] && [ "${clean_tmp_files}" = "no" ]
then
	fn_my_echo "Directory '${output_dir}/mnt_debootstrap' is still mounted, please check. Exiting now!"
	umount_img all
	exit 16
fi

fn_my_echo "Rootfs successfully DONE!"
}


# Description: Get the SD-card device and than create the partitions and format them
partition_n_format_disk()
{
device=""
fn_my_echo "Now listing all available devices:
"

while [ -z "${device}" ]
do
parted -l

echo "
Please enter the name of the SD-card device (eg. /dev/sdb) OR press ENTER to refresh the device list:"

read device
if [ -e ${device} ] &&  [ "${device:0:5}" = "/dev/" ]
then
	umount ${device}*
	mount |grep ${device}
	if [ ! "$?" = "0" ]
	then
		echo "${device} partition table:"
		parted -s ${device} unit MB print
		echo "If you are sure that you want to repartition device '${device}', then type 'yes'.
Type anything else and/or hit Enter to cancel!"
		read affirmation
		if [ "${affirmation}" = "yes" ]
		then
			parted -s ${device} mklabel msdos
			# first partition = root (rest of the drive size)
			parted --align=opt -- ${device} unit MB mkpart primary ext3 1 -132
			# second partition = boot (raw, 4MB)
			parted -s --align=opt -- ${device} unit MB mkpart primary ext2 -132 -128
			parted -s -- ${device} set 2 boot on
			# last partition = swap	(128MB)
			parted -s --align=opt -- ${device} unit MB mkpart primary linux-swap -128 -0
			echo ">>> ${device} Partition table is now:"
			parted -s ${device} unit MB print
		else
			fn_my_echo "Action canceled by user. Exiting now!"
			umount_img all
			exit 17
		fi
	else
		fn_my_echo "ERROR! Some partition on device '${device}' is still mounted. Exiting now!"
		umount_img all
		exit 18
	fi
else
	if [ ! -z "${device}" ] # in case of a refresh we don't want to see the error message ;-)
	then 
		fn_my_echo "ERROR! Device '${device}' doesn't seem to be a valid device!"
	fi
	device=""
fi

done

if [ -e ${device}1 ] && [ -e ${device}2 ] && [ -e ${device}3 ]
then
	mkfs.ext3 ${device}1 # ext3 on root partition
	mkswap ${device}3 # swap
	dd if=/dev/null of=${device}2 # raw for the boot (Apex bootloader) partition
	fn_my_echo "Now setting the boot partition to type 'BootIt', using fdisk."

	/sbin/fdisk ${device} << END
t
2
df
w
quit
END

else
	fn_my_echo "ERROR: There should be 3 partitions on '${device}', but one or more seem to be missing.
Exiting now!"
	umount_img all
	exit 20
fi

sleep 1
partprobe
sleep 1

dev_str=`sudo fdisk -l |grep BootIt`

if [ "${dev_str:0:8}" = "${device}" ]
then
	fn_my_echo "SD-card boot partition successfully set to type 'BootIt'."
else
	fn_my_echo "ERROR! SD-card boot partition doesn't seem to have type 'BootIt'. Exiting now!"
	umount_img all
	exit 21
fi
}



# Description: Copy bootloader, rootfs and kernel to the SD-card and then unmount it
finalize_disk()
{
# Copy bootloader to the boot partition
fn_my_echo "Getting the bootloader and trying to copy it to the boot partition, now!"

get_n_check_file "${bootloader_bin_path}" "${bootloader_bin_name}" "bootloader_binary"

if [ -e ${device} ] &&  [ "${device:0:5}" = "/dev/" ]
then
	umount ${device}*
	mount |grep ${device}
	if [ ! "$?" = "0" ]
	then
		if [ -e "${output_dir}/tmp/${bootloader_bin_name}" ]
		then
			dd if=${output_dir}/tmp/${bootloader_bin_name} of=${device}2
			if [ "$?" = "0" ]
			then
				fn_my_echo "Bootloader successfully copied!"
			else
				fn_my_echo "ERROR while trying to copy the bootloader '${bootloader_bin_path}/${bootloader_bin_name}' to the device '${device}2'."
			fi
		else
			fn_my_echo "ERROR! Bootloader binary '${bootloader_bin_name}' doesn't seem to exist in directory '${output_dir}/tmp/'.
			You won't be able to boot the card, without copying the file to the second partition."
		fi

		
	else
		fn_my_echo "ERROR! Some partition on device '${device}' is still mounted. Exiting now!"
	fi
else
	fn_my_echo "ERROR! Device '${device}' doesn't seem to exist!
	Exiting now"
	umount_img all
	exit 21
fi

# unpack the filesystem and kernel to the root partition

fn_my_echo "Now unpacking the rootfs to the SD-card's root partition!"

mkdir ${output_dir}/sd-card

if [ "$?" = "0" ]
then
	fsck -fy ${device}1 # just to be sure
	
	mount ${device}1 ${output_dir}/sd-card
	if [ "$?" = "0" ]
	then
		if [ -e ${output_dir}/${output_filename}.tar.${tar_format} ]
		then 
			tar_all extract "${output_dir}/${output_filename}.tar.${tar_format}" "${output_dir}/sd-card"
		else
			fn_my_echo "ERROR: File '${output_dir}/${output_filename}.tar.${tar_format}' doesn't seem to exist. Exiting now!"
			umount_img all
			exit 22
		fi
		sleep 1
	else
		fn_my_echo "ERROR while trying to mount '${device}1' to '${output_dir}/sd-card'. Exiting now!"
		umount_img all
		exit 23
	fi
else
	fn_my_echo "ERROR while trying to create the temporary directory '${output_dir}/sd-card'. Exiting now!"
	umount_img all
	exit 24
fi

sleep 3

umount ${output_dir}/sd-card

sleep 3

fsck -fy ${device}1 # final check

if [ "$?" = "0" ]
then
	fn_my_echo "SD-card successfully created!
You can remove the card now and try it in your gnublin-board.
ALL DONE!"

else
	fn_my_echo "ERROR! Filesystem check on your card returned an error status. Maybe your card is going bad, or something else went wrong."
fi

rm -r ${output_dir}/tmp
rm -r ${output_dir}/sd-card
}



#############################
##### HELPER Functions: #####
#############################


# Description: Helper funtion for all tar-related tasks
tar_all()
{
if [ "$1" = "compress" ]
then
	if [ -d "${2%/*}"  ] && [ -e "${3}" ]
	then
		if [ "${2:(-8)}" = ".tar.bz2" ]
		then
			tar -cpjvf "${2}" "${3}"
		elif [ "${2:(-7)}" = ".tar.gz" ]
		then
			tar -cpzvf "${2}" "${3}"
		else
			fn_my_echo "ERROR! Created files can only be of type '.tar.gz', or '.tar.bz2'! Exiting now!"
			umount_img all
			exit 40
		fi
	else
		fn_my_echo "ERROR! Illegal arguments '$2' and/or '$3'. Exiting now!"
		umount_img all
		exit 41
	fi
elif [ "$1" = "extract" ]
then
	if [ -e "${2}"  ] && [ -d "${3}" ]
	then
		if [ "${2:(-8)}" = ".tar.bz2" ]
		then
			tar -xpjvf "${2}" -C "${3}"
		elif [ "${2:(-7)}" = ".tar.gz"  ]
		then
			tar -xpzvf "${2}" -C "${3}"
		else
			fn_my_echo "ERROR! Can only extract files of type '.tar.gz', or '.tar.bz2'!
'${2}' doesn't seem to fit that requirement. Exiting now!"
			umount_img all
			exit 42
		fi
	else
		fn_my_echo "ERROR! Illegal arguments '$2' and/or '$3'. Exiting now!"
		umount_img all
		exit 43
	fi
else
	fn_my_echo "ERROR! The first parameter needs to be either 'compress' or 'extract', and not '$1'. Exiting now!"
	umount_img all
	exit 44
fi
}


# Description: Helper function to completely or partially unmount the image file when and where needed
umount_img()
{
if [ "${1}" = "sys" ]
then
	mount | grep "${output_dir}" > /dev/null
	if [ "$?" = "0"  ]
	then
		fn_my_echo "Virtual Image still mounted. Trying to umount now!"
		umount ${output_dir}/mnt_debootstrap/sys > /dev/null
		umount ${output_dir}/mnt_debootstrap/dev/pts > /dev/null
		umount ${output_dir}/mnt_debootstrap/proc > /dev/null
	fi

	mount | egrep '(${output_dir}/mnt_debootstrap/sys|${output_dir}/mnt_debootstrap/proc|${output_dir}/mnt_debootstrap/dev/pts)' > /dev/null
	if [ "$?" = "0"  ]
	then
		fn_my_echo "ERROR! Something went wrong. All subdirectories of '${output_dir}' should have been unmounted, but are not."
	else
		fn_my_echo "Virtual image successfully unmounted."
	fi
elif [ "${1}" = "all" ]
then
	mount | grep "${output_dir}" > /dev/null
	if [ "$?" = "0"  ]
	then
		fn_my_echo "Virtual Image still mounted. Trying to umount now!"
		umount ${output_dir}/mnt_debootstrap/sys > /dev/null
		umount ${output_dir}/mnt_debootstrap/dev/pts > /dev/null
		umount ${output_dir}/mnt_debootstrap/proc > /dev/null
		umount ${output_dir}/mnt_debootstrap/ > /dev/null
	fi

	mount | grep "${output_dir}" > /dev/null
	if [ "$?" = "0"  ]
	then
		fn_my_echo "ERROR! Something went wrong. '${output_dir}' should have been unmounted, but isn't."
	else
		fn_my_echo "Virtual image successfully unmounted."
	fi
else
	fn_my_echo "ERROR! Wrong parameter. Only 'sys' and 'all' allowed when calling 'umount_img'."
fi
}


# Description: Helper function to search and replace strings (also those containing special characters!) in files
sed_search_n_replace()
{
if [ ! -z "${1}" ] && [ ! -z "${3}" ] && [ -e "${3}" ]
then
	original=${1}
	replacement=${2}
	file=${3}

	escaped_original=$(printf %s "${original}" | sed -e 's![.\[^$*/]!\\&!g')

	escaped_replacement=$(printf %s "${replacement}" | sed -e 's![\&]!\\&!g')

	sed -i -e "s~${escaped_original}~${escaped_replacement}~g" ${file}
else
	fn_my_echo "ERROR! Trying to call the function 'sed_search_n_replace' with (a) wrong parameter(s). The following was used:
'Param1='${1}'
Param2='${2}'
Param3='${3}'"
fi
sleep 1
grep -F "${replacement}" "${file}" > /dev/null

if [ "$?" = "0" ]
then
	fn_my_echo "String '${original}' was successfully replaced in file '${file}'."
else
	fn_my_echo "ERROR! String '${original}' could not be replaced in file '${file}'!"
fi

}


# Description: Function to disable all /etc/init.d startup entries that try to mount something as tmpfs
disable_mnt_tmpfs()
{

if [ -e "${output_dir}/mnt_debootstrap/etc/init.d/mountoverflowtmp" ]
then
	rm ${output_dir}/mnt_debootstrap/etc/init.d/mountoverflowtmp
	if [ "$?" = "0" ]
	then
		fn_my_echo "File '${output_dir}/mnt_debootstrap/etc/init.d/mountoverflowtmp' successfully removed."
	else
		fn_my_echo "ERROR while trying to remove file '${output_dir}/mnt_debootstrap/etc/init.d/mountoverflowtmp'."
	fi
fi

grep_results=`grep -rn domount ${output_dir}/mnt_debootstrap/etc/init.d/ |grep tmpfs`

if [ ! -z "${grep_results}" ]
then
cat <<END > ${output_dir}/tmpfs_grep_results.txt
$grep_results
END

	while read LINE
	do
		set -- $LINE
		dest_filename="${1%%:*[0-9]:}"
		search="${LINE#${1}}"
		replace="sleep 1 # ${search}"
		echo "${dest_filename}" |grep -i "udev"
		if [ "$?" = "0" ]
		then
			fn_my_echo "UDEV seems to be installed. As udev needs a tmpfs to work properly, file won't be touched."
		else
			sed_search_n_replace "${search}" "${replace}" "${dest_filename}"
		fi
	done < ${output_dir}/tmpfs_grep_results.txt
else
	fn_my_echo "No entries found that match both the keywords 'domount' and 'tmpfs'."
fi

}


get_n_check_file()
{

file_path=${1}
file_name=${2}
short_description=${3}

if [ -z "${1}" ] || [ -z "${2}" ] || [ -z "${3}" ]
then
	fn_my_echo "ERROR: Function get_n_check_file needs 3 parameters.
Parameter 1 is file_path, parameter 2 is file_name and parameter 3 is short_description.
Faulty parameters passed were '${1}', '${2}' and '${3}'.
One or more of these appear to be empty. Exiting now!" 
	umount_img all
	exit 50
fi

if [ "${file_path:0:4}" = "http" ] || [ "${file_path:0:3}" = "ftp" ]
then
	fn_my_echo "Downloading ${short_description} from address '${file_path}/${file_name}', now."
	cd ${output_dir}/tmp
	wget ${file_path}/${file_name}
	if [ "$?" = "0" ]
	then
		fn_my_echo "'${short_description}' successfully downloaded from address '${file_path}/${file_name}'."
	else
		fn_my_echo "ERROR: File '${file_path}/${file_name}' could not be downloaded.
Exiting now!"
	umount_img all
	exit 51
	fi
else
	fn_my_echo "Looking for the ${short_description} locally (offline)."	
	if [ -d ${file_path} ]
	then
		if [ -e ${file_path}/${file_name} ]
		then
			fn_my_echo "Now copying local file '${file_path}/${file_name}' to '${output_dir}/tmp'."
			cp '${file_path}/${file_name}' '${output_dir}/tmp'
			if [ "$?" = "0" ]
			then
				fn_my_echo "File successfully copied."
			else
				fn_my_echo "ERROR while trying to copy the file! Exiting now."
				umount_img all
				exit 52
			fi
		else
			fn_my_echo "ERROR: File '${file_name}' does not seem to be a valid file in existing directory '${file_path}'.Exiting now!"
			umount_img all
			exit 53
		fi
	else
		fn_my_echo "ERROR: Folder '${file_path}' does not seem to exist as a local directory. Exiting now!"
		umount_img all
		exit 54
	fi
fi

}


cleanup()
{
	fn_my_echo "Build process interrrupted. Now trying to clean up!"
	umount_img all
	rm -r ${output_dir}/mnt_debootstrap
	rm -r ${output_dir}/tmp
	rm -r ${output_dir}/sd-card
	exit 99
}