1#
2# Copyright OpenEmbedded Contributors
3#
4# SPDX-License-Identifier: MIT
5#
6
7inherit linux-kernel-base kernel-module-split
8
9COMPATIBLE_HOST = ".*-linux"
10
11KERNEL_PACKAGE_NAME ??= "kernel"
12KERNEL_DEPLOYSUBDIR ??= "${@ "" if (d.getVar("KERNEL_PACKAGE_NAME") == "kernel") else d.getVar("KERNEL_PACKAGE_NAME") }"
13
14PROVIDES += "virtual/kernel"
15DEPENDS += "virtual/${TARGET_PREFIX}binutils virtual/${TARGET_PREFIX}gcc kmod-native bc-native bison-native"
16DEPENDS += "${@bb.utils.contains("INITRAMFS_FSTYPES", "cpio.lzo", "lzop-native", "", d)}"
17DEPENDS += "${@bb.utils.contains("INITRAMFS_FSTYPES", "cpio.lz4", "lz4-native", "", d)}"
18DEPENDS += "${@bb.utils.contains("INITRAMFS_FSTYPES", "cpio.zst", "zstd-native", "", d)}"
19PACKAGE_WRITE_DEPS += "depmodwrapper-cross"
20
21do_deploy[depends] += "depmodwrapper-cross:do_populate_sysroot gzip-native:do_populate_sysroot"
22do_clean[depends] += "make-mod-scripts:do_clean"
23
24CVE_PRODUCT ?= "linux_kernel"
25
26S = "${STAGING_KERNEL_DIR}"
27B = "${WORKDIR}/build"
28KBUILD_OUTPUT = "${B}"
29OE_TERMINAL_EXPORTS += "KBUILD_OUTPUT"
30
31# we include gcc above, we dont need virtual/libc
32INHIBIT_DEFAULT_DEPS = "1"
33
34KERNEL_IMAGETYPE ?= "zImage"
35INITRAMFS_IMAGE ?= ""
36INITRAMFS_TASK ?= ""
37INITRAMFS_IMAGE_BUNDLE ?= ""
38INITRAMFS_DEPLOY_DIR_IMAGE ?= "${DEPLOY_DIR_IMAGE}"
39INITRAMFS_MULTICONFIG ?= ""
40
41# KERNEL_VERSION is extracted from source code. It is evaluated as
42# None for the first parsing, since the code has not been fetched.
43# After the code is fetched, it will be evaluated as real version
44# number and cause kernel to be rebuilt. To avoid this, make
45# KERNEL_VERSION_NAME and KERNEL_VERSION_PKG_NAME depend on
46# LINUX_VERSION which is a constant.
47KERNEL_VERSION_NAME = "${@d.getVar('KERNEL_VERSION') or ""}"
48KERNEL_VERSION_NAME[vardepvalue] = "${LINUX_VERSION}"
49KERNEL_VERSION_PKG_NAME = "${@legitimize_package_name(d.getVar('KERNEL_VERSION'))}"
50KERNEL_VERSION_PKG_NAME[vardepvalue] = "${LINUX_VERSION}"
51
52python __anonymous () {
53    pn = d.getVar("PN")
54    kpn = d.getVar("KERNEL_PACKAGE_NAME")
55
56    # XXX Remove this after bug 11905 is resolved
57    #  FILES:${KERNEL_PACKAGE_NAME}-dev doesn't expand correctly
58    if kpn == pn:
59        bb.warn("Some packages (E.g. *-dev) might be missing due to "
60                "bug 11905 (variable KERNEL_PACKAGE_NAME == PN)")
61
62    # The default kernel recipe builds in a shared location defined by
63    # bitbake/distro confs: STAGING_KERNEL_DIR and STAGING_KERNEL_BUILDDIR.
64    # Set these variables to directories under ${WORKDIR} in alternate
65    # kernel recipes (I.e. where KERNEL_PACKAGE_NAME != kernel) so that they
66    # may build in parallel with the default kernel without clobbering.
67    if kpn != "kernel":
68        workdir = d.getVar("WORKDIR")
69        sourceDir = os.path.join(workdir, 'kernel-source')
70        artifactsDir = os.path.join(workdir, 'kernel-build-artifacts')
71        d.setVar("STAGING_KERNEL_DIR", sourceDir)
72        d.setVar("STAGING_KERNEL_BUILDDIR", artifactsDir)
73
74    # Merge KERNEL_IMAGETYPE and KERNEL_ALT_IMAGETYPE into KERNEL_IMAGETYPES
75    type = d.getVar('KERNEL_IMAGETYPE') or ""
76    alttype = d.getVar('KERNEL_ALT_IMAGETYPE') or ""
77    types = d.getVar('KERNEL_IMAGETYPES') or ""
78    if type not in types.split():
79        types = (type + ' ' + types).strip()
80    if alttype not in types.split():
81        types = (alttype + ' ' + types).strip()
82    d.setVar('KERNEL_IMAGETYPES', types)
83
84    # KERNEL_IMAGETYPES may contain a mixture of image types supported directly
85    # by the kernel build system and types which are created by post-processing
86    # the output of the kernel build system (e.g. compressing vmlinux ->
87    # vmlinux.gz in kernel_do_transform_kernel()).
88    # KERNEL_IMAGETYPE_FOR_MAKE should contain only image types supported
89    # directly by the kernel build system.
90    if not d.getVar('KERNEL_IMAGETYPE_FOR_MAKE'):
91        typeformake = set()
92        for type in types.split():
93            if type == 'vmlinux.gz':
94                type = 'vmlinux'
95            typeformake.add(type)
96
97        d.setVar('KERNEL_IMAGETYPE_FOR_MAKE', ' '.join(sorted(typeformake)))
98
99    kname = d.getVar('KERNEL_PACKAGE_NAME') or "kernel"
100    imagedest = d.getVar('KERNEL_IMAGEDEST')
101
102    for type in types.split():
103        if bb.data.inherits_class('nopackages', d):
104            continue
105        typelower = type.lower()
106        d.appendVar('PACKAGES', ' %s-image-%s' % (kname, typelower))
107        d.setVar('FILES:' + kname + '-image-' + typelower, '/' + imagedest + '/' + type + '-${KERNEL_VERSION_NAME}' + ' /' + imagedest + '/' + type)
108        d.appendVar('RDEPENDS:%s-image' % kname, ' %s-image-%s (= ${EXTENDPKGV})' % (kname, typelower))
109        splitmods = d.getVar("KERNEL_SPLIT_MODULES")
110        if splitmods != '1':
111            d.appendVar('RDEPENDS:%s-image' % kname, ' %s-modules (= ${EXTENDPKGV})' % kname)
112            d.appendVar('RDEPENDS:%s-image-%s' % (kname, typelower), ' %s-modules-${KERNEL_VERSION_PKG_NAME} (= ${EXTENDPKGV})' % kname)
113            d.setVar('PKG:%s-modules' % kname, '%s-modules-${KERNEL_VERSION_PKG_NAME}' % kname)
114            d.appendVar('RPROVIDES:%s-modules' % kname, '%s-modules-${KERNEL_VERSION_PKG_NAME}' % kname)
115
116        d.setVar('PKG:%s-image-%s' % (kname,typelower), '%s-image-%s-${KERNEL_VERSION_PKG_NAME}' % (kname, typelower))
117        d.setVar('ALLOW_EMPTY:%s-image-%s' % (kname, typelower), '1')
118        d.prependVar('pkg_postinst:%s-image-%s' % (kname,typelower), """set +e
119if [ -n "$D" ]; then
120    ln -sf %s-${KERNEL_VERSION} $D/${KERNEL_IMAGEDEST}/%s > /dev/null 2>&1
121else
122    ln -sf %s-${KERNEL_VERSION} ${KERNEL_IMAGEDEST}/%s > /dev/null 2>&1
123    if [ $? -ne 0 ]; then
124        echo "Filesystem on ${KERNEL_IMAGEDEST}/ doesn't support symlinks, falling back to copied image (%s)."
125        install -m 0644 ${KERNEL_IMAGEDEST}/%s-${KERNEL_VERSION} ${KERNEL_IMAGEDEST}/%s
126    fi
127fi
128set -e
129""" % (type, type, type, type, type, type, type))
130        d.setVar('pkg_postrm:%s-image-%s' % (kname,typelower), """set +e
131if [ -f "${KERNEL_IMAGEDEST}/%s" -o -L "${KERNEL_IMAGEDEST}/%s" ]; then
132    rm -f ${KERNEL_IMAGEDEST}/%s  > /dev/null 2>&1
133fi
134set -e
135""" % (type, type, type))
136
137
138    image = d.getVar('INITRAMFS_IMAGE')
139    # If the INTIRAMFS_IMAGE is set but the INITRAMFS_IMAGE_BUNDLE is set to 0,
140    # the do_bundle_initramfs does nothing, but the INITRAMFS_IMAGE is built
141    # standalone for use by wic and other tools.
142    if image:
143        if d.getVar('INITRAMFS_MULTICONFIG'):
144            d.appendVarFlag('do_bundle_initramfs', 'mcdepends', ' mc::${INITRAMFS_MULTICONFIG}:${INITRAMFS_IMAGE}:do_image_complete')
145        else:
146            d.appendVarFlag('do_bundle_initramfs', 'depends', ' ${INITRAMFS_IMAGE}:do_image_complete')
147    if image and bb.utils.to_boolean(d.getVar('INITRAMFS_IMAGE_BUNDLE')):
148        bb.build.addtask('do_transform_bundled_initramfs', 'do_deploy', 'do_bundle_initramfs', d)
149
150    # NOTE: setting INITRAMFS_TASK is for backward compatibility
151    #       The preferred method is to set INITRAMFS_IMAGE, because
152    #       this INITRAMFS_TASK has circular dependency problems
153    #       if the initramfs requires kernel modules
154    image_task = d.getVar('INITRAMFS_TASK')
155    if image_task:
156        d.appendVarFlag('do_configure', 'depends', ' ${INITRAMFS_TASK}')
157}
158
159# Here we pull in all various kernel image types which we support.
160#
161# In case you're wondering why kernel.bbclass inherits the other image
162# types instead of the other way around, the reason for that is to
163# maintain compatibility with various currently existing meta-layers.
164# By pulling in the various kernel image types here, we retain the
165# original behavior of kernel.bbclass, so no meta-layers should get
166# broken.
167#
168# KERNEL_CLASSES by default pulls in kernel-uimage.bbclass, since this
169# used to be the default behavior when only uImage was supported. This
170# variable can be appended by users who implement support for new kernel
171# image types.
172
173KERNEL_CLASSES ?= " kernel-uimage "
174inherit ${KERNEL_CLASSES}
175
176# Old style kernels may set ${S} = ${WORKDIR}/git for example
177# We need to move these over to STAGING_KERNEL_DIR. We can't just
178# create the symlink in advance as the git fetcher can't cope with
179# the symlink.
180do_unpack[cleandirs] += " ${S} ${STAGING_KERNEL_DIR} ${B} ${STAGING_KERNEL_BUILDDIR}"
181do_clean[cleandirs] += " ${S} ${STAGING_KERNEL_DIR} ${B} ${STAGING_KERNEL_BUILDDIR}"
182python do_symlink_kernsrc () {
183    s = d.getVar("S")
184    if s[-1] == '/':
185        # drop trailing slash, so that os.symlink(kernsrc, s) doesn't use s as directory name and fail
186        s=s[:-1]
187    kernsrc = d.getVar("STAGING_KERNEL_DIR")
188    if s != kernsrc:
189        bb.utils.mkdirhier(kernsrc)
190        bb.utils.remove(kernsrc, recurse=True)
191        if d.getVar("EXTERNALSRC"):
192            # With EXTERNALSRC S will not be wiped so we can symlink to it
193            os.symlink(s, kernsrc)
194        else:
195            import shutil
196            shutil.move(s, kernsrc)
197            os.symlink(kernsrc, s)
198}
199# do_patch is normally ordered before do_configure, but
200# externalsrc.bbclass deletes do_patch, breaking the dependency of
201# do_configure on do_symlink_kernsrc.
202addtask symlink_kernsrc before do_patch do_configure after do_unpack
203
204inherit kernel-arch deploy
205
206PACKAGES_DYNAMIC += "^${KERNEL_PACKAGE_NAME}-module-.*"
207PACKAGES_DYNAMIC += "^${KERNEL_PACKAGE_NAME}-image-.*"
208PACKAGES_DYNAMIC += "^${KERNEL_PACKAGE_NAME}-firmware-.*"
209
210export OS = "${TARGET_OS}"
211export CROSS_COMPILE = "${TARGET_PREFIX}"
212
213KERNEL_RELEASE ?= "${KERNEL_VERSION}"
214
215# The directory where built kernel lies in the kernel tree
216KERNEL_OUTPUT_DIR ?= "arch/${ARCH}/boot"
217KERNEL_IMAGEDEST ?= "boot"
218KERNEL_DTBDEST ?= "${KERNEL_IMAGEDEST}"
219KERNEL_DTBVENDORED ?= "0"
220
221#
222# configuration
223#
224export CMDLINE_CONSOLE = "console=${@d.getVar("KERNEL_CONSOLE") or "ttyS0"}"
225
226KERNEL_VERSION = "${@get_kernelversion_headers('${B}')}"
227
228# kernels are generally machine specific
229PACKAGE_ARCH = "${MACHINE_ARCH}"
230
231# U-Boot support
232UBOOT_ENTRYPOINT ?= "20008000"
233UBOOT_LOADADDRESS ?= "${UBOOT_ENTRYPOINT}"
234
235# Some Linux kernel configurations need additional parameters on the command line
236KERNEL_EXTRA_ARGS ?= ""
237
238EXTRA_OEMAKE += ' CC="${KERNEL_CC}" LD="${KERNEL_LD}" OBJCOPY="${KERNEL_OBJCOPY}" STRIP="${KERNEL_STRIP}"'
239EXTRA_OEMAKE += ' HOSTCC="${BUILD_CC}" HOSTCFLAGS="${BUILD_CFLAGS}" HOSTLDFLAGS="${BUILD_LDFLAGS}" HOSTCPP="${BUILD_CPP}"'
240EXTRA_OEMAKE += ' HOSTCXX="${BUILD_CXX}" HOSTCXXFLAGS="${BUILD_CXXFLAGS}"'
241
242KERNEL_ALT_IMAGETYPE ??= ""
243
244copy_initramfs() {
245	echo "Copying initramfs into ./usr ..."
246	# In case the directory is not created yet from the first pass compile:
247	mkdir -p ${B}/usr
248	# Find and use the first initramfs image archive type we find
249	rm -f ${B}/usr/${INITRAMFS_IMAGE_NAME}.cpio
250	for img in cpio cpio.gz cpio.lz4 cpio.lzo cpio.lzma cpio.xz cpio.zst; do
251		if [ -e "${INITRAMFS_DEPLOY_DIR_IMAGE}/${INITRAMFS_IMAGE_NAME}.$img" ]; then
252			cp ${INITRAMFS_DEPLOY_DIR_IMAGE}/${INITRAMFS_IMAGE_NAME}.$img ${B}/usr/.
253			case $img in
254			*gz)
255				echo "gzip decompressing image"
256				gunzip -f ${B}/usr/${INITRAMFS_IMAGE_NAME}.$img
257				break
258				;;
259			*lz4)
260				echo "lz4 decompressing image"
261				lz4 -df ${B}/usr/${INITRAMFS_IMAGE_NAME}.$img ${B}/usr/${INITRAMFS_IMAGE_NAME}.cpio
262				break
263				;;
264			*lzo)
265				echo "lzo decompressing image"
266				lzop -df ${B}/usr/${INITRAMFS_IMAGE_NAME}.$img
267				break
268				;;
269			*lzma)
270				echo "lzma decompressing image"
271				lzma -df ${B}/usr/${INITRAMFS_IMAGE_NAME}.$img
272				break
273				;;
274			*xz)
275				echo "xz decompressing image"
276				xz -df ${B}/usr/${INITRAMFS_IMAGE_NAME}.$img
277				break
278				;;
279			*zst)
280				echo "zst decompressing image"
281				zstd -df ${B}/usr/${INITRAMFS_IMAGE_NAME}.$img
282				break
283				;;
284			esac
285			break
286		fi
287	done
288	# Verify that the above loop found a initramfs, fail otherwise
289	[ -f ${B}/usr/${INITRAMFS_IMAGE_NAME}.cpio ] && echo "Finished copy of initramfs into ./usr" || die "Could not find any ${INITRAMFS_DEPLOY_DIR_IMAGE}/${INITRAMFS_IMAGE_NAME}.cpio{.gz|.lz4|.lzo|.lzma|.xz|.zst) for bundling; INITRAMFS_IMAGE_NAME might be wrong."
290}
291
292do_bundle_initramfs () {
293	if [ ! -z "${INITRAMFS_IMAGE}" -a x"${INITRAMFS_IMAGE_BUNDLE}" = x1 ]; then
294		echo "Creating a kernel image with a bundled initramfs..."
295		copy_initramfs
296		# Backing up kernel image relies on its type(regular file or symbolic link)
297		tmp_path=""
298		for imageType in ${KERNEL_IMAGETYPE_FOR_MAKE} ; do
299			if [ -h ${KERNEL_OUTPUT_DIR}/$imageType ] ; then
300				linkpath=`readlink -n ${KERNEL_OUTPUT_DIR}/$imageType`
301				realpath=`readlink -fn ${KERNEL_OUTPUT_DIR}/$imageType`
302				mv -f $realpath $realpath.bak
303				tmp_path=$tmp_path" "$imageType"#"$linkpath"#"$realpath
304			elif [ -f ${KERNEL_OUTPUT_DIR}/$imageType ]; then
305				mv -f ${KERNEL_OUTPUT_DIR}/$imageType ${KERNEL_OUTPUT_DIR}/$imageType.bak
306				tmp_path=$tmp_path" "$imageType"##"
307			fi
308		done
309		use_alternate_initrd=CONFIG_INITRAMFS_SOURCE=${B}/usr/${INITRAMFS_IMAGE_NAME}.cpio
310		kernel_do_compile
311		# Restoring kernel image
312		for tp in $tmp_path ; do
313			imageType=`echo $tp|cut -d "#" -f 1`
314			linkpath=`echo $tp|cut -d "#" -f 2`
315			realpath=`echo $tp|cut -d "#" -f 3`
316			if [ -n "$realpath" ]; then
317				mv -f $realpath $realpath.initramfs
318				mv -f $realpath.bak $realpath
319				ln -sf $linkpath.initramfs ${B}/${KERNEL_OUTPUT_DIR}/$imageType.initramfs
320			else
321				mv -f ${KERNEL_OUTPUT_DIR}/$imageType ${KERNEL_OUTPUT_DIR}/$imageType.initramfs
322				mv -f ${KERNEL_OUTPUT_DIR}/$imageType.bak ${KERNEL_OUTPUT_DIR}/$imageType
323			fi
324		done
325	fi
326}
327do_bundle_initramfs[dirs] = "${B}"
328
329kernel_do_transform_bundled_initramfs() {
330        # vmlinux.gz is not built by kernel
331	if (echo "${KERNEL_IMAGETYPES}" | grep -wq "vmlinux\.gz"); then
332		gzip -9cn < ${KERNEL_OUTPUT_DIR}/vmlinux.initramfs > ${KERNEL_OUTPUT_DIR}/vmlinux.gz.initramfs
333        fi
334}
335do_transform_bundled_initramfs[dirs] = "${B}"
336
337python do_package:prepend () {
338    os.environ['STRIP'] = d.getVar('KERNEL_STRIP')
339}
340
341python do_devshell:prepend () {
342    os.environ["LDFLAGS"] = ''
343}
344
345addtask bundle_initramfs after do_install before do_deploy
346
347KERNEL_DEBUG_TIMESTAMPS ??= "0"
348
349kernel_do_compile() {
350	unset CFLAGS CPPFLAGS CXXFLAGS LDFLAGS MACHINE
351
352	# setup native pkg-config variables (kconfig scripts call pkg-config directly, cannot generically be overriden to pkg-config-native)
353	export PKG_CONFIG_DIR="${STAGING_DIR_NATIVE}${libdir_native}/pkgconfig"
354	export PKG_CONFIG_PATH="$PKG_CONFIG_DIR:${STAGING_DATADIR_NATIVE}/pkgconfig"
355	export PKG_CONFIG_LIBDIR="$PKG_CONFIG_DIR"
356	export PKG_CONFIG_SYSROOT_DIR=""
357
358	if [ "${KERNEL_DEBUG_TIMESTAMPS}" != "1" ]; then
359		# kernel sources do not use do_unpack, so SOURCE_DATE_EPOCH may not
360		# be set....
361		if [ "${SOURCE_DATE_EPOCH}" = "" -o "${SOURCE_DATE_EPOCH}" = "0" ]; then
362			# The source directory is not necessarily a git repository, so we
363			# specify the git-dir to ensure that git does not query a
364			# repository in any parent directory.
365			SOURCE_DATE_EPOCH=`git --git-dir="${S}/.git" log -1 --pretty=%ct 2>/dev/null || echo "${REPRODUCIBLE_TIMESTAMP_ROOTFS}"`
366		fi
367
368		ts=`LC_ALL=C date -d @$SOURCE_DATE_EPOCH`
369		export KBUILD_BUILD_TIMESTAMP="$ts"
370		export KCONFIG_NOTIMESTAMP=1
371		bbnote "KBUILD_BUILD_TIMESTAMP: $ts"
372	else
373		ts=`LC_ALL=C date`
374		export KBUILD_BUILD_TIMESTAMP="$ts"
375		bbnote "KBUILD_BUILD_TIMESTAMP: $ts"
376	fi
377	# The $use_alternate_initrd is only set from
378	# do_bundle_initramfs() This variable is specifically for the
379	# case where we are making a second pass at the kernel
380	# compilation and we want to force the kernel build to use a
381	# different initramfs image.  The way to do that in the kernel
382	# is to specify:
383	# make ...args... CONFIG_INITRAMFS_SOURCE=some_other_initramfs.cpio
384	if [ "$use_alternate_initrd" = "" ] && [ "${INITRAMFS_TASK}" != "" ] ; then
385		# The old style way of copying an prebuilt image and building it
386		# is turned on via INTIRAMFS_TASK != ""
387		copy_initramfs
388		use_alternate_initrd=CONFIG_INITRAMFS_SOURCE=${B}/usr/${INITRAMFS_IMAGE_NAME}.cpio
389	fi
390	for typeformake in ${KERNEL_IMAGETYPE_FOR_MAKE} ; do
391		oe_runmake ${PARALLEL_MAKE} ${typeformake} ${KERNEL_EXTRA_ARGS} $use_alternate_initrd
392	done
393}
394
395kernel_do_transform_kernel() {
396	# vmlinux.gz is not built by kernel
397	if (echo "${KERNEL_IMAGETYPES}" | grep -wq "vmlinux\.gz"); then
398		mkdir -p "${KERNEL_OUTPUT_DIR}"
399		gzip -9cn < ${B}/vmlinux > "${KERNEL_OUTPUT_DIR}/vmlinux.gz"
400	fi
401}
402do_transform_kernel[dirs] = "${B}"
403addtask transform_kernel after do_compile before do_install
404
405do_compile_kernelmodules() {
406	unset CFLAGS CPPFLAGS CXXFLAGS LDFLAGS MACHINE
407	if [ "${KERNEL_DEBUG_TIMESTAMPS}" != "1" ]; then
408		# kernel sources do not use do_unpack, so SOURCE_DATE_EPOCH may not
409		# be set....
410		if [ "${SOURCE_DATE_EPOCH}" = "" -o "${SOURCE_DATE_EPOCH}" = "0" ]; then
411			# The source directory is not necessarily a git repository, so we
412			# specify the git-dir to ensure that git does not query a
413			# repository in any parent directory.
414			SOURCE_DATE_EPOCH=`git --git-dir="${S}/.git" log -1 --pretty=%ct 2>/dev/null || echo "${REPRODUCIBLE_TIMESTAMP_ROOTFS}"`
415		fi
416
417		ts=`LC_ALL=C date -d @$SOURCE_DATE_EPOCH`
418		export KBUILD_BUILD_TIMESTAMP="$ts"
419		export KCONFIG_NOTIMESTAMP=1
420		bbnote "KBUILD_BUILD_TIMESTAMP: $ts"
421	else
422		ts=`LC_ALL=C date`
423		export KBUILD_BUILD_TIMESTAMP="$ts"
424		bbnote "KBUILD_BUILD_TIMESTAMP: $ts"
425	fi
426	if (grep -q -i -e '^CONFIG_MODULES=y$' ${B}/.config); then
427		oe_runmake -C ${B} ${PARALLEL_MAKE} modules ${KERNEL_EXTRA_ARGS}
428
429		# Module.symvers gets updated during the
430		# building of the kernel modules. We need to
431		# update this in the shared workdir since some
432		# external kernel modules has a dependency on
433		# other kernel modules and will look at this
434		# file to do symbol lookups
435		cp ${B}/Module.symvers ${STAGING_KERNEL_BUILDDIR}/
436		# 5.10+ kernels have module.lds that we need to copy for external module builds
437		if [ -e "${B}/scripts/module.lds" ]; then
438			install -Dm 0644 ${B}/scripts/module.lds ${STAGING_KERNEL_BUILDDIR}/scripts/module.lds
439		fi
440	else
441		bbnote "no modules to compile"
442	fi
443}
444addtask compile_kernelmodules after do_compile before do_strip
445
446kernel_do_install() {
447	#
448	# First install the modules
449	#
450	unset CFLAGS CPPFLAGS CXXFLAGS LDFLAGS MACHINE
451	if (grep -q -i -e '^CONFIG_MODULES=y$' .config); then
452		oe_runmake DEPMOD=echo MODLIB=${D}${nonarch_base_libdir}/modules/${KERNEL_VERSION} INSTALL_FW_PATH=${D}${nonarch_base_libdir}/firmware modules_install
453		rm "${D}${nonarch_base_libdir}/modules/${KERNEL_VERSION}/build"
454		rm "${D}${nonarch_base_libdir}/modules/${KERNEL_VERSION}/source"
455		# Remove empty module directories to prevent QA issues
456		find "${D}${nonarch_base_libdir}/modules/${KERNEL_VERSION}/kernel" -type d -empty -delete
457	else
458		bbnote "no modules to install"
459	fi
460
461	#
462	# Install various kernel output (zImage, map file, config, module support files)
463	#
464	install -d ${D}/${KERNEL_IMAGEDEST}
465
466	#
467	# When including an initramfs bundle inside a FIT image, the fitImage is created after the install task
468	# by do_assemble_fitimage_initramfs.
469	# This happens after the generation of the initramfs bundle (done by do_bundle_initramfs).
470	# So, at the level of the install task we should not try to install the fitImage. fitImage is still not
471	# generated yet.
472	# After the generation of the fitImage, the deploy task copies the fitImage from the build directory to
473	# the deploy folder.
474	#
475
476	for imageType in ${KERNEL_IMAGETYPES} ; do
477		if [ $imageType != "fitImage" ] || [ "${INITRAMFS_IMAGE_BUNDLE}" != "1" ] ; then
478			install -m 0644 ${KERNEL_OUTPUT_DIR}/$imageType ${D}/${KERNEL_IMAGEDEST}/$imageType-${KERNEL_VERSION}
479		fi
480	done
481
482	install -m 0644 System.map ${D}/${KERNEL_IMAGEDEST}/System.map-${KERNEL_VERSION}
483	install -m 0644 .config ${D}/${KERNEL_IMAGEDEST}/config-${KERNEL_VERSION}
484	install -m 0644 vmlinux ${D}/${KERNEL_IMAGEDEST}/vmlinux-${KERNEL_VERSION}
485	[ -e Module.symvers ] && install -m 0644 Module.symvers ${D}/${KERNEL_IMAGEDEST}/Module.symvers-${KERNEL_VERSION}
486	install -d ${D}${sysconfdir}/modules-load.d
487	install -d ${D}${sysconfdir}/modprobe.d
488}
489
490# Must be ran no earlier than after do_kernel_checkout or else Makefile won't be in ${S}/Makefile
491do_kernel_version_sanity_check() {
492	if [ "x${KERNEL_VERSION_SANITY_SKIP}" = "x1" ]; then
493		exit 0
494	fi
495
496	# The Makefile determines the kernel version shown at runtime
497	# Don't use KERNEL_VERSION because the headers it grabs the version from aren't generated until do_compile
498	VERSION=$(grep "^VERSION =" ${S}/Makefile | sed s/.*=\ *//)
499	PATCHLEVEL=$(grep "^PATCHLEVEL =" ${S}/Makefile | sed s/.*=\ *//)
500	SUBLEVEL=$(grep "^SUBLEVEL =" ${S}/Makefile | sed s/.*=\ *//)
501	EXTRAVERSION=$(grep "^EXTRAVERSION =" ${S}/Makefile | sed s/.*=\ *//)
502
503	# Build a string for regex and a plain version string
504	reg="^${VERSION}\.${PATCHLEVEL}"
505	vers="${VERSION}.${PATCHLEVEL}"
506	if [ -n "${SUBLEVEL}" ]; then
507		# Ignoring a SUBLEVEL of zero is fine
508		if [ "${SUBLEVEL}" = "0" ]; then
509			reg="${reg}(\.${SUBLEVEL})?"
510		else
511			reg="${reg}\.${SUBLEVEL}"
512			vers="${vers}.${SUBLEVEL}"
513		fi
514	fi
515	vers="${vers}${EXTRAVERSION}"
516	reg="${reg}${EXTRAVERSION}"
517
518	if [ -z `echo ${PV} | grep -E "${reg}"` ]; then
519		bbfatal "Package Version (${PV}) does not match of kernel being built (${vers}). Please update the PV variable to match the kernel source or set KERNEL_VERSION_SANITY_SKIP=\"1\" in your recipe."
520	fi
521	exit 0
522}
523
524addtask shared_workdir after do_compile before do_compile_kernelmodules
525addtask shared_workdir_setscene
526
527do_shared_workdir_setscene () {
528	exit 1
529}
530
531emit_depmod_pkgdata() {
532	# Stash data for depmod
533	install -d ${PKGDESTWORK}/${KERNEL_PACKAGE_NAME}-depmod/
534	echo "${KERNEL_VERSION}" > ${PKGDESTWORK}/${KERNEL_PACKAGE_NAME}-depmod/${KERNEL_PACKAGE_NAME}-abiversion
535	cp ${B}/System.map ${PKGDESTWORK}/${KERNEL_PACKAGE_NAME}-depmod/System.map-${KERNEL_VERSION}
536}
537
538PACKAGEFUNCS += "emit_depmod_pkgdata"
539
540do_shared_workdir[cleandirs] += " ${STAGING_KERNEL_BUILDDIR}"
541do_shared_workdir () {
542	cd ${B}
543
544	kerneldir=${STAGING_KERNEL_BUILDDIR}
545	install -d $kerneldir
546
547	#
548	# Store the kernel version in sysroots for module-base.bbclass
549	#
550
551	echo "${KERNEL_VERSION}" > $kerneldir/${KERNEL_PACKAGE_NAME}-abiversion
552
553	# Copy files required for module builds
554	cp System.map $kerneldir/System.map-${KERNEL_VERSION}
555	[ -e Module.symvers ] && cp Module.symvers $kerneldir/
556	cp .config $kerneldir/
557	mkdir -p $kerneldir/include/config
558	cp include/config/kernel.release $kerneldir/include/config/kernel.release
559	if [ -e certs/signing_key.x509 ]; then
560		# The signing_key.* files are stored in the certs/ dir in
561		# newer Linux kernels
562		mkdir -p $kerneldir/certs
563		cp certs/signing_key.* $kerneldir/certs/
564	elif [ -e signing_key.priv ]; then
565		cp signing_key.* $kerneldir/
566	fi
567
568	# We can also copy over all the generated files and avoid special cases
569	# like version.h, but we've opted to keep this small until file creep starts
570	# to happen
571	if [ -e include/linux/version.h ]; then
572		mkdir -p $kerneldir/include/linux
573		cp include/linux/version.h $kerneldir/include/linux/version.h
574	fi
575
576	# As of Linux kernel version 3.0.1, the clean target removes
577	# arch/powerpc/lib/crtsavres.o which is present in
578	# KBUILD_LDFLAGS_MODULE, making it required to build external modules.
579	if [ ${ARCH} = "powerpc" ]; then
580		if [ -e arch/powerpc/lib/crtsavres.o ]; then
581			mkdir -p $kerneldir/arch/powerpc/lib/
582			cp arch/powerpc/lib/crtsavres.o $kerneldir/arch/powerpc/lib/crtsavres.o
583		fi
584	fi
585
586	if [ -d include/generated ]; then
587		mkdir -p $kerneldir/include/generated/
588		cp -fR include/generated/* $kerneldir/include/generated/
589	fi
590
591	if [ -d arch/${ARCH}/include/generated ]; then
592		mkdir -p $kerneldir/arch/${ARCH}/include/generated/
593		cp -fR arch/${ARCH}/include/generated/* $kerneldir/arch/${ARCH}/include/generated/
594	fi
595
596	if (grep -q -i -e '^CONFIG_UNWINDER_ORC=y$' $kerneldir/.config); then
597		# With CONFIG_UNWINDER_ORC (the default in 4.14), objtool is required for
598		# out-of-tree modules to be able to generate object files.
599		if [ -x tools/objtool/objtool ]; then
600			mkdir -p ${kerneldir}/tools/objtool
601			cp tools/objtool/objtool ${kerneldir}/tools/objtool/
602		fi
603	fi
604
605	# When building with CONFIG_MODVERSIONS=y and CONFIG_RANDSTRUCT=y we need
606	# to copy the build assets generated for the randstruct seed to
607	# STAGING_KERNEL_BUILDDIR, otherwise the out-of-tree modules build will
608	# generate those assets which will result in a different
609	# RANDSTRUCT_HASHED_SEED
610	if [ -d scripts/basic ]; then
611		mkdir -p ${kerneldir}/scripts
612		cp -r scripts/basic ${kerneldir}/scripts
613	fi
614
615	if [ -d scripts/gcc-plugins ]; then
616		mkdir -p ${kerneldir}/scripts
617		cp -r scripts/gcc-plugins ${kerneldir}/scripts
618	fi
619
620}
621
622# We don't need to stage anything, not the modules/firmware since those would clash with linux-firmware
623SYSROOT_DIRS = ""
624
625KERNEL_LOCALVERSION ??= ""
626KERNEL_CONFIG_COMMAND ?= "oe_runmake_call -C ${S} O=${B} olddefconfig || oe_runmake -C ${S} O=${B} oldnoconfig"
627
628python check_oldest_kernel() {
629    oldest_kernel = d.getVar('OLDEST_KERNEL')
630    kernel_version = d.getVar('KERNEL_VERSION')
631    tclibc = d.getVar('TCLIBC')
632    if tclibc == 'glibc':
633        kernel_version = kernel_version.split('-', 1)[0]
634        if oldest_kernel and kernel_version:
635            if bb.utils.vercmp_string(kernel_version, oldest_kernel) < 0:
636                bb.warn('%s: OLDEST_KERNEL is "%s" but the version of the kernel you are building is "%s" - therefore %s as built may not be compatible with this kernel. Either set OLDEST_KERNEL to an older version, or build a newer kernel.' % (d.getVar('PN'), oldest_kernel, kernel_version, tclibc))
637}
638
639check_oldest_kernel[vardepsexclude] += "OLDEST_KERNEL KERNEL_VERSION"
640do_configure[prefuncs] += "check_oldest_kernel"
641
642kernel_do_configure() {
643	# fixes extra + in /lib/modules/2.6.37+
644	# $ scripts/setlocalversion . => +
645	# $ make kernelversion => 2.6.37
646	# $ make kernelrelease => 2.6.37+
647	if [ ! -e ${B}/.scmversion -a ! -e ${S}/.scmversion ]; then
648		echo ${KERNEL_LOCALVERSION} > ${B}/.scmversion
649		echo ${KERNEL_LOCALVERSION} > ${S}/.scmversion
650	fi
651
652	if [ "${S}" != "${B}" ] && [ -f "${S}/.config" ] && [ ! -f "${B}/.config" ]; then
653		mv "${S}/.config" "${B}/.config"
654	fi
655
656	# Copy defconfig to .config if .config does not exist. This allows
657	# recipes to manage the .config themselves in do_configure:prepend().
658	if [ -f "${WORKDIR}/defconfig" ] && [ ! -f "${B}/.config" ]; then
659		cp "${WORKDIR}/defconfig" "${B}/.config"
660	fi
661
662	${KERNEL_CONFIG_COMMAND}
663}
664
665do_savedefconfig() {
666	bbplain "Saving defconfig to:\n${B}/defconfig"
667	oe_runmake -C ${B} savedefconfig
668}
669do_savedefconfig[nostamp] = "1"
670addtask savedefconfig after do_configure
671
672inherit cml1 pkgconfig
673
674# Need LD, HOSTLDFLAGS and more for config operations
675KCONFIG_CONFIG_COMMAND:append = " ${EXTRA_OEMAKE}"
676
677EXPORT_FUNCTIONS do_compile do_transform_kernel do_transform_bundled_initramfs do_install do_configure
678
679# kernel-base becomes kernel-${KERNEL_VERSION}
680# kernel-image becomes kernel-image-${KERNEL_VERSION}
681PACKAGES = "${KERNEL_PACKAGE_NAME} ${KERNEL_PACKAGE_NAME}-base ${KERNEL_PACKAGE_NAME}-vmlinux ${KERNEL_PACKAGE_NAME}-image ${KERNEL_PACKAGE_NAME}-dev ${KERNEL_PACKAGE_NAME}-modules ${KERNEL_PACKAGE_NAME}-dbg"
682FILES:${PN} = ""
683FILES:${KERNEL_PACKAGE_NAME}-base = "${nonarch_base_libdir}/modules/${KERNEL_VERSION}/modules.order ${nonarch_base_libdir}/modules/${KERNEL_VERSION}/modules.builtin ${nonarch_base_libdir}/modules/${KERNEL_VERSION}/modules.builtin.modinfo"
684FILES:${KERNEL_PACKAGE_NAME}-image = ""
685FILES:${KERNEL_PACKAGE_NAME}-dev = "/${KERNEL_IMAGEDEST}/System.map* /${KERNEL_IMAGEDEST}/Module.symvers* /${KERNEL_IMAGEDEST}/config* ${KERNEL_SRC_PATH} ${nonarch_base_libdir}/modules/${KERNEL_VERSION}/build"
686FILES:${KERNEL_PACKAGE_NAME}-vmlinux = "/${KERNEL_IMAGEDEST}/vmlinux-${KERNEL_VERSION_NAME}"
687FILES:${KERNEL_PACKAGE_NAME}-modules = ""
688FILES:${KERNEL_PACKAGE_NAME}-dbg = "/usr/lib/debug /usr/src/debug"
689RDEPENDS:${KERNEL_PACKAGE_NAME} = "${KERNEL_PACKAGE_NAME}-base (= ${EXTENDPKGV})"
690# Allow machines to override this dependency if kernel image files are
691# not wanted in images as standard
692RRECOMMENDS:${KERNEL_PACKAGE_NAME}-base ?= "${KERNEL_PACKAGE_NAME}-image (= ${EXTENDPKGV})"
693PKG:${KERNEL_PACKAGE_NAME}-image = "${KERNEL_PACKAGE_NAME}-image-${@legitimize_package_name(d.getVar('KERNEL_VERSION'))}"
694RDEPENDS:${KERNEL_PACKAGE_NAME}-image += "${@oe.utils.conditional('KERNEL_IMAGETYPE', 'vmlinux', '${KERNEL_PACKAGE_NAME}-vmlinux (= ${EXTENDPKGV})', '', d)}"
695PKG:${KERNEL_PACKAGE_NAME}-base = "${KERNEL_PACKAGE_NAME}-${@legitimize_package_name(d.getVar('KERNEL_VERSION'))}"
696RPROVIDES:${KERNEL_PACKAGE_NAME}-base += "${KERNEL_PACKAGE_NAME}-${KERNEL_VERSION}"
697ALLOW_EMPTY:${KERNEL_PACKAGE_NAME} = "1"
698ALLOW_EMPTY:${KERNEL_PACKAGE_NAME}-base = "1"
699ALLOW_EMPTY:${KERNEL_PACKAGE_NAME}-image = "1"
700ALLOW_EMPTY:${KERNEL_PACKAGE_NAME}-modules = "1"
701DESCRIPTION:${KERNEL_PACKAGE_NAME}-modules = "Kernel modules meta package"
702
703pkg_postinst:${KERNEL_PACKAGE_NAME}-base () {
704	if [ ! -e "$D/lib/modules/${KERNEL_VERSION}" ]; then
705		mkdir -p $D/lib/modules/${KERNEL_VERSION}
706	fi
707	if [ -n "$D" ]; then
708		depmodwrapper -a -b $D ${KERNEL_VERSION} ${KERNEL_PACKAGE_NAME}
709	else
710		depmod -a ${KERNEL_VERSION}
711	fi
712}
713
714PACKAGESPLITFUNCS =+ "split_kernel_packages"
715
716python split_kernel_packages () {
717    do_split_packages(d, root='${nonarch_base_libdir}/firmware', file_regex=r'^(.*)\.(bin|fw|cis|csp|dsp)$', output_pattern='${KERNEL_PACKAGE_NAME}-firmware-%s', description='Firmware for %s', recursive=True, extra_depends='')
718}
719
720# Many scripts want to look in arch/$arch/boot for the bootable
721# image. This poses a problem for vmlinux and vmlinuz based
722# booting. This task arranges to have vmlinux and vmlinuz appear
723# in the normalized directory location.
724do_kernel_link_images() {
725	if [ ! -d "${B}/arch/${ARCH}/boot" ]; then
726		mkdir ${B}/arch/${ARCH}/boot
727	fi
728	cd ${B}/arch/${ARCH}/boot
729	ln -sf ../../../vmlinux
730	if [ -f ../../../vmlinuz ]; then
731		ln -sf ../../../vmlinuz
732	fi
733	if [ -f ../../../vmlinuz.bin ]; then
734		ln -sf ../../../vmlinuz.bin
735	fi
736	if [ -f ../../../vmlinux.64 ]; then
737		ln -sf ../../../vmlinux.64
738	fi
739}
740addtask kernel_link_images after do_compile before do_strip
741
742python do_strip() {
743    import shutil
744
745    strip = d.getVar('STRIP')
746    extra_sections = d.getVar('KERNEL_IMAGE_STRIP_EXTRA_SECTIONS')
747    kernel_image = d.getVar('B') + "/" + d.getVar('KERNEL_OUTPUT_DIR') + "/vmlinux"
748
749    if (extra_sections and kernel_image.find(d.getVar('KERNEL_IMAGEDEST') + '/vmlinux') != -1):
750        kernel_image_stripped = kernel_image + ".stripped"
751        shutil.copy2(kernel_image, kernel_image_stripped)
752        oe.package.runstrip((kernel_image_stripped, 8, strip, extra_sections))
753        bb.debug(1, "KERNEL_IMAGE_STRIP_EXTRA_SECTIONS is set, stripping sections: " + \
754            extra_sections)
755}
756do_strip[dirs] = "${B}"
757
758addtask strip before do_sizecheck after do_kernel_link_images
759
760# Support checking the kernel size since some kernels need to reside in partitions
761# with a fixed length or there is a limit in transferring the kernel to memory.
762# If more than one image type is enabled, warn on any that don't fit but only fail
763# if none fit.
764do_sizecheck() {
765	if [ ! -z "${KERNEL_IMAGE_MAXSIZE}" ]; then
766		invalid=`echo ${KERNEL_IMAGE_MAXSIZE} | sed 's/[0-9]//g'`
767		if [ -n "$invalid" ]; then
768			die "Invalid KERNEL_IMAGE_MAXSIZE: ${KERNEL_IMAGE_MAXSIZE}, should be an integer (The unit is Kbytes)"
769		fi
770		at_least_one_fits=
771		for imageType in ${KERNEL_IMAGETYPES} ; do
772			size=`du -ks ${B}/${KERNEL_OUTPUT_DIR}/$imageType | awk '{print $1}'`
773			if [ $size -gt ${KERNEL_IMAGE_MAXSIZE} ]; then
774				bbwarn "This kernel $imageType (size=$size(K) > ${KERNEL_IMAGE_MAXSIZE}(K)) is too big for your device."
775			else
776				at_least_one_fits=y
777			fi
778		done
779		if [ -z "$at_least_one_fits" ]; then
780			die "All kernel images are too big for your device. Please reduce the size of the kernel by making more of it modular."
781		fi
782	fi
783}
784do_sizecheck[dirs] = "${B}"
785
786addtask sizecheck before do_install after do_strip
787
788inherit kernel-artifact-names
789
790kernel_do_deploy() {
791	deployDir="${DEPLOYDIR}"
792	if [ -n "${KERNEL_DEPLOYSUBDIR}" ]; then
793		deployDir="${DEPLOYDIR}/${KERNEL_DEPLOYSUBDIR}"
794		mkdir "$deployDir"
795	fi
796
797	for imageType in ${KERNEL_IMAGETYPES} ; do
798		baseName=$imageType-${KERNEL_IMAGE_NAME}
799
800		if [ -s ${KERNEL_OUTPUT_DIR}/$imageType.stripped ] ; then
801			install -m 0644 ${KERNEL_OUTPUT_DIR}/$imageType.stripped $deployDir/$baseName${KERNEL_IMAGE_BIN_EXT}
802		else
803			install -m 0644 ${KERNEL_OUTPUT_DIR}/$imageType $deployDir/$baseName${KERNEL_IMAGE_BIN_EXT}
804		fi
805		if [ -n "${KERNEL_IMAGE_LINK_NAME}" ] ; then
806			ln -sf $baseName${KERNEL_IMAGE_BIN_EXT} $deployDir/$imageType-${KERNEL_IMAGE_LINK_NAME}${KERNEL_IMAGE_BIN_EXT}
807		fi
808		if [ "${KERNEL_IMAGETYPE_SYMLINK}" = "1" ] ; then
809			ln -sf $baseName${KERNEL_IMAGE_BIN_EXT} $deployDir/$imageType
810		fi
811	done
812
813	if [ ${MODULE_TARBALL_DEPLOY} = "1" ] && (grep -q -i -e '^CONFIG_MODULES=y$' .config); then
814		mkdir -p ${D}${root_prefix}/lib
815		if [ -n "${SOURCE_DATE_EPOCH}" ]; then
816			TAR_ARGS="--sort=name --clamp-mtime --mtime=@${SOURCE_DATE_EPOCH}"
817		else
818			TAR_ARGS=""
819		fi
820		TAR_ARGS="$TAR_ARGS --owner=0 --group=0"
821		tar $TAR_ARGS -cv -C ${D}${root_prefix} lib | gzip -9n > $deployDir/modules-${MODULE_TARBALL_NAME}.tgz
822
823		if [ -n "${MODULE_TARBALL_LINK_NAME}" ] ; then
824			ln -sf modules-${MODULE_TARBALL_NAME}.tgz $deployDir/modules-${MODULE_TARBALL_LINK_NAME}.tgz
825		fi
826	fi
827
828	if [ ! -z "${INITRAMFS_IMAGE}" -a x"${INITRAMFS_IMAGE_BUNDLE}" = x1 ]; then
829		for imageType in ${KERNEL_IMAGETYPES} ; do
830			if [ "$imageType" = "fitImage" ] ; then
831				continue
832			fi
833			initramfsBaseName=$imageType-${INITRAMFS_NAME}
834			install -m 0644 ${KERNEL_OUTPUT_DIR}/$imageType.initramfs $deployDir/$initramfsBaseName${KERNEL_IMAGE_BIN_EXT}
835			if [ -n "${INITRAMFS_LINK_NAME}" ] ; then
836				ln -sf $initramfsBaseName${KERNEL_IMAGE_BIN_EXT} $deployDir/$imageType-${INITRAMFS_LINK_NAME}${KERNEL_IMAGE_BIN_EXT}
837			fi
838		done
839	fi
840}
841
842# We deploy to filenames that include PKGV and PKGR, read the saved data to
843# ensure we get the right values for both
844do_deploy[prefuncs] += "read_subpackage_metadata"
845
846addtask deploy after do_populate_sysroot do_packagedata
847
848EXPORT_FUNCTIONS do_deploy
849
850# Add using Device Tree support
851inherit kernel-devicetree
852