# kernel global smage functions
# $Id$

# needed extra vars:
#  ${KERNEL_TYPE}:       needed, 'sources', 'headers' or 'image'
#  ${BRANCH}:            needed, style branch of the kernel
#  ${KERNEL_CONFIG}:     optional, needed if you want to override the default
#                        searchpath ${SOURCEDIR}/${PNAME}/config-${PVER}-${BRANCH}-${PBUILD}
#
#  ${PSUBVER}:           optional, only needed for 2.6.x.x naming scheme
#  ${EXTRAVERSION}:      optinal, extra version for the kernel name
#                        default setting is ${PSUBVER}-${BRANCH}-${PBUILD}
#  ${KERNEL_IMAGE_PATH}: override the default KERNEL_IMAGE_PATH (to build xen images for e.g.)
#  ${COMPRESS_MODULES}:  compresses the kernel modules with given compressor (gzip|bzip2|xz)
#  ${LINUX_FIRMWARE}:    remove included firmware bits if requested
#                        set the version here like USE_LINUX_FIRMARE="20110605"
#                        version "internal" keeps the bits too
#
#  ${INCLUDE_KERNELVERSION_FILE}: creates a /boot/kernelversion file (deprecated)
#  ${USE_KERNEL_SYMLINKS}: creates symlinks to unversioned kernel image files
#			   - kernel-x.x.x.x -> /boot/vmlinuz
#			   - initrd-x.x.x.x -> /boot/initrd
#			   - config-x.x.x.x -> /boot/config
#			   - System.map-x.x.x.x -> /boot/System.map

sminclude mtools

# remove me when all distris support this:
if [[ ${USE_KERNEL_ARCH_EXTENSION} = true ]]
then
	KERNEL_ARCH_EXTENSION="-${ARCH}"
else
	KERNEL_ARCH_EXTENSION=""
fi

if [[ ! -z ${COMPRESS_MODULES} ]]
then
	case ${COMPRESS_MODULES} in
		gzip)
			COMPRESS_MODULES_CMD="gzip -9v"
			SDEPEND="${SDEPEND}
				>= app-arch/gzip-1.4"
			;;
		bzip2)
			COMPRESS_MODULES_CMD="bzip2 -9v"
			SDEPEND="${SDEPEND}
				>= app-arch/bzip2-1.0.6"
			;;
		xz)
			COMPRESS_MODULES_CMD="xz -9v"
			SDEPEND="${SDEPEND}
				>= app-arch/xz-5"
			;;
		none)
			echo "Disabled compressed kernel-modules!"
			COMPRESS_MODULES_CMD=""
			;;
		*) die "Unkown compression format '${COMPRESS_MODULES}'" ;;
	esac
fi

# some sane defaults
: ${PCAT="sys-kernel"}
: ${HOMEPAGE="http://magellan-linux.de/"}
: ${TARBALLPVER="${PVER}"}
: ${SRCFILE="linux-${TARBALLPVER}.tar.bz2"}
: ${SRCDIR="${BUILDDIR}/linux-${PVER}-${BRANCH}-${PBUILD}"}

if [[ -z ${SRC_URI[*]} ]]
then
	SRC_URI=(
		http://www.kernel.org/pub/linux/kernel/v$(echo ${PVER} | cut -d. -f1).x/${SRCFILE}
		http://ftp.uni-erlangen.de/pub/Linux/MIRROR.kernel/v$(echo ${PVER} | cut -d. -f1).x/${SRCFILE}
		mirror://kernel-${BRANCH}/${SRCFILE}
	)
	case ${KERNEL_TYPE} in
		image|sources)
				SRC_URI=(
					${SRC_URI[*]}
					mirror://kernel-${BRANCH}/config-${PVER}-${BRANCH}-${PBUILD}-i686
					mirror://kernel-${BRANCH}/config-${PVER}-${BRANCH}-${PBUILD}-x86_64
				)
			;;
	esac
fi

case ${KERNEL_TYPE} in
	image)
		: ${PROVIDE="virtual/kernel"}
		: ${DEPEND=">= virtual/module-tools
			>= sys-fs/udev-115
			>= virtual/initramfs-tools
			>= virtual/initscripts"}
			if [[ ! -z ${LINUX_FIRMWARE}  ]] && [[ ${LINUX_FIRMWARE} != internal ]]
			then
				DEPEND="${DEPEND}
					>= sys-kernel/linux-firmware-${LINUX_FIRMWARE}"
			fi
		SDEPEND="${SDEPEND}
			>= sys-dev/bc-1.06"
		: ${DESCRIPTION="Kernel image of the '${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION}' kernel branch."}
		;;

	sources)
		: ${PROVIDE="virtual/kernel-sources"}
		: ${DESCRIPTION="Kernel sources of the '${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION}' kernel branch."}
		;;

	headers)
		: ${PROVIDE="virtual/kernel-headers"}
		: ${DESCRIPTION="Sanitized kernel headers for libc."}
		;;
esac

EXTRAVERSION="${PSUBVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION}"
KERNEL_CONFIG="${SOURCEDIR}/${PNAME}/config-${PVER}-${BRANCH}-${PBUILD}-${ARCH}"

# special vars for mage file only
KPVER="${PVER}"
KPBUILD="${PBUILD}"
KBRANCH="${BRANCH}"
SPECIAL_VARS="${SPECIAL_VARS} KPVER KPBUILD KBRANCH USE_KERNEL_SYMLINKS"

# dummy function to apply kernel patches
kernel_apply_patches()
{
	return 0
}

kernel_src_prepare()
{
	munpack ${SRCFILE} || die
	mv ${BUILDDIR}/linux-${TARBALLPVER} ${SRCDIR} || die

	# fix permissions
	chown -R 0:0 ${SRCDIR} || die
	chmod -R a+r-w+X,u+w ${SRCDIR} || die

	cd ${SRCDIR}
	kernel_apply_patches || die

	# fixes INSTALL_PATH to /boot and EXTRAVERSION
	sed -i -e 's:#export\tINSTALL_PATH:export\tINSTALL_PATH:' \
		-e "s:^\(EXTRAVERSION =\).*:\1 ${EXTRAVERSION}:" Makefile || die

	# fix sublevel version with 3.x kernels and higher
	local kver=$(echo ${PVER} | sed "s:\.::g")
	if [[ ${PVER%%.*} -gt 2 ]]
	then
		local sublevel="$(echo ${PVER} | cut -d. -f3)"
		sed -i "s:^\(SUBLEVEL =\).*:\1 ${sublevel}:" Makefile || die
	fi
}

kernel_src_compile()
{
	cd ${SRCDIR}

	make mrproper || die

	if [[ ${KERNEL_TYPE} = sources ]] || [[ ${KERNEL_TYPE} = image ]]
	then
		# inject our kernel config
		cp ${KERNEL_CONFIG} ${SRCDIR}/.config || die
		make ARCH=${ARCH/i*86/x86} oldconfig || die
	fi

	case ${KERNEL_TYPE} in
		image)
			mmake ARCH=${ARCH/i*86/x86} || die
			;;

		headers)
			make ARCH=${ARCH/i*86/x86} headers_check || die
			;;

		sources)
			make clean || die

			# needed to compile other programs like iptables
			make ARCH=${ARCH/i*86/x86} prepare || die
			# needed to cover >=2.6.14 builds
			# but deprecated with >=2.6.21, prepare cover all targets there
			local kver=$(echo ${PVER} | sed "s:\.::g")
			# honor >=3.0.x; add one zero
			if [[ ${PVER%%.*} -gt 2 ]]
			then
				kver="${kver}0"
			fi
			if [[ ${kver} < 2621 ]]
			then
				make ARCH=${ARCH/i*86/x86} prepare-all || die
			fi
			make ARCH=${ARCH/i*86/x86} scripts || die

			# at least alsa-drivers needs this one ...
			touch include/linux/autoconf.h || die
			;;
	esac
}

kernel_image_src_install()
{
	cd ${SRCDIR}

	# needed directories
	minstalldir /boot || die

	# install modules
	make ARCH=${ARCH/i*86/x86} INSTALL_MOD_PATH=${BINDIR}/usr modules_install || die

	# install kernelimage
	if [[ -z ${KERNEL_IMAGE_PATH} ]]
	then
		local my_arch="${ARCH}"
		[[ ${my_arch} = i*86 ]] && my_arch=i386
		minstallfile arch/${my_arch}/boot/bzImage \
			/boot/kernel-${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION} \
			|| die
	else
		minstallfile ${KERNEL_IMAGE_PATH} \
			/boot/kernel-${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION} \
			|| die
	fi

	# install System.map
	minstallfile System.map \
		/boot/System.map-${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION} \
		|| die

	# install Module.symvers in boot and /usr/src
	minstallfile Module.symvers \
		/boot/Module.symvers-${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION} \
		|| die
	minstalldir /usr/src/linux-${PVER}-${BRANCH}-${PBUILD} || die
	minstallfile Module.symvers \
		/usr/src/linux-${PVER}-${BRANCH}-${PBUILD} \
		|| die

	if [[ ${INCLUDE_KERNELVERSION_FILE} = true ]]
	then
		MCONFIG=/boot/kernelversion
		# install kernel description
		mclearconfig || die
		maddconfig "KRNVER=${BRANCH}-${PVER}-${ARCH}-${PBUILD}${KERNEL_ARCH_EXTENSION}" || die
		maddconfig "KRNLIB=${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION}" || die
		maddconfig "KRNIMG=kernel-${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION}" || die
		maddconfig "KRNINITRD=" || die
	fi

	# install kernel-config from srcdir
	minstallfile .config \
		/boot/config-${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION} \
		|| die

	# fix build symlink
	if [ -L ${BINDIR}/usr/lib/modules/${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION}/build ]
	then
		echo "fixing build symlink"
		rm ${BINDIR}/usr/lib/modules/${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION}/build || die
		mlink /usr/src/linux-${PVER}-${BRANCH}-${PBUILD} \
			/usr/lib/modules/${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION}/build \
			|| die
	fi

	# and fixing source symlink
	if [ -L ${BINDIR}/usr/lib/modules/${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION}/source ]
	then
		echo "fixing source symlink"
		rm ${BINDIR}/usr/lib/modules/${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION}/source || die
		mlink /usr/src/linux-${PVER}-${BRANCH}-${PBUILD} \
			/usr/lib/modules/${PVER}-${BRANCH}-${PBUILD}${KERNEL_ARCH_EXTENSION}/source \
			|| die
	fi

	# remove firmware bits if $LINUX_FIRMWARE was set
	if [[ ! -z ${LINUX_FIRMWARE} ]] && [[ ${LINUX_FIRMWARE} != internal ]]
	then
		if [[ -d ${BINDIR}/usr/lib/firmware ]]
		then
			rm -rv ${BINDIR}/usr/lib/firmware
		fi
	fi

	# compress modules if COMPRESS_MODULES_CMD was set
	if [[ ! -z ${COMPRESS_MODULES_CMD} ]]
	then
		# compress all kernel modules
		find ${BINDIR} -name \*.ko | xargs ${COMPRESS_MODULES_CMD} || die
	fi
}

kernel_headers_src_install()
{
	cd ${SRCDIR}
	make ARCH=${ARCH/i*86/x86} INSTALL_HDR_PATH=${BINDIR}/usr headers_install || die

	# clean-up unnecessary files
	find ${BINDIR} -name .install -or -name ..install.cmd | xargs --no-run-if-empty rm -f
}

kernel_sources_src_install()
{
	cd ${BUILDDIR}

	echo "Creating linux-${PVER}-${BRANCH}-${PBUILD} sources tarball ... "
	tar cvjf ${BUILDDIR}/linux-${PVER}-${BRANCH}-${PBUILD}.tar.bz2 $(basename ${SRCDIR}) || die

	echo "Moving linux-${PVER}-${BRANCH}-${PBUILD} tarball to \${BINDIR}/usr/src ... "
	minstalldir /usr/src || die
	mv ${BUILDDIR}/linux-${PVER}-${BRANCH}-${PBUILD}.tar.bz2 ${BINDIR}/usr/src || die
}

# installs module-sources path/to/SRCDIR to MODDIR/MODNAME
# kernel_external_modules_install path/to/SRCDIR DESTDIRNAME
kernel_external_modules_install()
{
	cd ${BUILDDIR}

	local modsrc="$1"
	local moddest="$2"
	local moddir="${BUILDDIR}/kernel-modules-${PVER}-${BRANCH}-${PBUILD}"

	echo "Installing ${modsrc} to ${moddir}/${moddest} ..."
	install -d ${moddir} || die
	mv ${modsrc} ${moddir}/${moddest} || die
}

kernel_external_modules_tarball()
{
	cd ${BUILDDIR}

	echo "Creating kernel-modules-${PVER}-${BRANCH}-${PBUILD} sources tarball ... "
	tar cvjf ${BUILDDIR}/kernel-modules-${PVER}-${BRANCH}-${PBUILD}.tar.bz2 \
		kernel-modules-${PVER}-${BRANCH}-${PBUILD} || die

	echo "Moving kernel-modules-${PVER}-${BRANCH}-${PBUILD} tarball to \${BINDIR}/usr/src ... "
	minstalldir /usr/src || die
	mv ${BUILDDIR}/kernel-modules-${PVER}-${BRANCH}-${PBUILD}.tar.bz2 ${BINDIR}/usr/src || die
}

kernel_src_install()
{
	case ${KERNEL_TYPE} in
		image)
			kernel_image_src_install || die
			;;

		headers)
			kernel_headers_src_install || die
			;;

		sources)
			kernel_sources_src_install || die
			;;
	esac
}

kernel_major_version()
{
	local ksrc="$@"
	local kv

	if [[ -z ${ksrc} ]]
	then
		kv="$(uname -r|cut -d. -f1-2)"
	else
		local version
		local patchlevel

		# get version from makefile
		version=$(grep "^VERSION[[:space:]]*=[[:space:]]*[[:digit:]]" ${ksrc}/Makefile | sed "s/^.*=[[:space:]]*\([[:digit:]]\+\)/\1/g")
		# get patchlevel from makefile
		patchlevel=$(grep "^PATCHLEVEL[[:space:]]*=[[:space:]]*[[:digit:]]" ${ksrc}/Makefile | sed "s/^.*=[[:space:]]*\([[:digit:]]\+\)/\1/g")
		# kernelversion
		kv="${version}.${patchlevel}"
	fi

	echo "${kv}"
}

mod_suffix()
{
	local ksrc="$@"
	local mod_suffix
	local kmv

	kmv=$(kernel_major_version ${ksrc})
	if [[ ${kmv//.} -ge 26 ]]
	then
		mod_suffix="ko"
	else
		mod_suffix="o"
	fi

	echo ${mod_suffix}
}

kernel_image_preinstall()
{
	if [[ -z ${MROOT} ]] || [[ ${MROOT} = / ]]
	then
		mount /boot &> /dev/null
	fi
}

kernel_image_preremove()
{
	if [[ -z ${MROOT} ]] || [[ ${MROOT} = / ]]
	then
		mount /boot &> /dev/null
	fi
}

kernel_image_postremove()
{
	if [[ -z ${MROOT} ]] || [[ ${MROOT} = / ]]
	then
		# remove old image entry from grub
		new-kernel-pkg -v --rminitrd --rmmoddep --remove ${KPVER}-${KBRANCH}-${KPBUILD}
	fi
}

kernel_image_postinstall()
{
	[ ! -d ${MROOT}/sys ] && install -d ${MROOT}/sys

	# fixes a small glitch in <=mage-0.3.6-r15 with symlinks
	[ -f ${MROOT}/usr/src/linux-${KPVER}-${KBRANCH}-${KPBUILD} ] && \
		rm ${MROOT}/usr/src/linux-${KPVER}-${KBRANCH}-${KPBUILD}

	[ -x ${MROOT}/sbin/depmod ] &&
		${MROOT}/sbin/depmod -ae \
			-F /boot/System.map-${KPVER}-${KBRANCH}-${KPBUILD} \
			${KPVER}-${KBRANCH}-${KPBUILD}

	# do not run this if ${MROOT} is set !
	if [[ -z ${MROOT} ]] || [[ ${MROOT} = / ]]
	then
		new-kernel-pkg -v --mkinitrd --make-default --install ${KPVER}-${KBRANCH}-${KPBUILD}
	fi

	if [[ ${USE_KERNEL_SYMLINKS} = true ]]
	then
		# symlink actual kernel to /boot/vmlinuz etc...
		ln -snf kernel-${KPVER}-${KBRANCH}-${KPBUILD} ${MROOT}/boot/vmlinuz
		ln -snf System.map-${KPVER}-${KBRANCH}-${KPBUILD} ${MROOT}/boot/System.map
		ln -snf config-${KPVER}-${KBRANCH}-${KPBUILD} ${MROOT}/boot/config
		[[ -f ${MROOT}/boot/initrd-${KPVER}-${KBRANCH}-${KPBUILD}.img ]] &&
			ln -snf initrd-${KPVER}-${KBRANCH}-${KPBUILD}.img ${MROOT}/boot/initrd
	fi
}

kernel_sources_postinstall()
{
	# check for linux-VERSION/include as the kernel-image installs
	# the file Modules.symver in the linux-VERSION directory
	if mqueryfeature "kernelsrcunpack" &&
		[ ! -d ${MROOT}/usr/src/linux-${KPVER}-${KBRANCH}-${KPBUILD}/include ]
	then
		echo "Unpacking linux-${KPVER}-${KBRANCH}-${KPBUILD} source tarball ... "
		tar xvjf ${MROOT}/usr/src/linux-${KPVER}-${KBRANCH}-${KPBUILD}.tar.bz2 -C ${MROOT}/usr/src
	fi

	if mqueryfeature "kernelsrcunpack" &&
		[ ! -d ${MROOT}/usr/src/kernel-modules-${KPVER}-${KBRANCH}-${KPBUILD} ] &&
		[ -f ${MROOT}/usr/src/kernel-modules-${KPVER}-${KBRANCH}-${KPBUILD}.tar.bz2 ]
	then
		echo "Unpacking kernel-modules-${KPVER}-${KBRANCH}-${KPBUILD} source tarball ... "
		tar xvjf ${MROOT}/usr/src/kernel-modules-${KPVER}-${KBRANCH}-${KPBUILD}.tar.bz2 -C ${MROOT}/usr/src
	fi

	# create linux symlink
	if mqueryfeature "linuxsymlink"
	then
		echo "Creating linux -> linux-${KPVER}-${KBRANCH}-${KPBUILD} symlink ... "
		[ ! -d ${MROOT}/usr/src ] && install ${MROOT}/usr/src
		ln -snf ${MROOT}/usr/src/linux-${KPVER}-${KBRANCH}-${KPBUILD} \
			${MROOT}/usr/src/linux || die
	fi

	# create kernel-modules symlink
	if mqueryfeature "linuxsymlink" &&
		[ -d ${MROOT}/usr/src/kernel-modules-${KPVER}-${KBRANCH}-${KPBUILD} ]
	then
		echo "Creating kernel-modules -> kernel-modules-${KPVER}-${KBRANCH}-${KPBUILD} symlink ... "
		[ ! -d ${MROOT}/usr/src ] && install ${MROOT}/usr/src
		ln -snf ${MROOT}/usr/src/kernel-modules-${KPVER}-${KBRANCH}-${KPBUILD} \
			${MROOT}/usr/src/kernel-modules || die
	fi
}

export_inherits kernel src_prepare src_compile src_install

# export pre/postinstall functions depending on KERNEL_TYPE
case ${KERNEL_TYPE} in
	image)
		export_inherits kernel_image preinstall preremove postinstall postremove
		SPECIAL_FUNCTIONS="${SPECIAL_FUNCTIONS} kernel_image_preinstall kernel_image_preremove kernel_image_postinstall kernel_image_postremove"
		;;
	sources)
		export_inherits kernel_sources postinstall
		SPECIAL_FUNCTIONS="${SPECIAL_FUNCTIONS} kernel_sources_postinstall"
		;;
esac