blob: aefa0d21bc8295c08d0a1e3e5c5dc6e1bd21aa43 [file] [log] [blame]
Patrick Williams92b42cb2022-09-03 06:53:57 -05001#
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 ?= ""
Patrick Williams92b42cb2022-09-03 06:53:57 -050036INITRAMFS_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}"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500212
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"
218
219#
220# configuration
221#
222export CMDLINE_CONSOLE = "console=${@d.getVar("KERNEL_CONSOLE") or "ttyS0"}"
223
224KERNEL_VERSION = "${@get_kernelversion_headers('${B}')}"
225
226# kernels are generally machine specific
227PACKAGE_ARCH = "${MACHINE_ARCH}"
228
229# U-Boot support
230UBOOT_ENTRYPOINT ?= "20008000"
231UBOOT_LOADADDRESS ?= "${UBOOT_ENTRYPOINT}"
232
233# Some Linux kernel configurations need additional parameters on the command line
234KERNEL_EXTRA_ARGS ?= ""
235
Andrew Geissler6aa7eec2023-03-03 12:41:14 -0600236EXTRA_OEMAKE += ' CC="${KERNEL_CC}" LD="${KERNEL_LD}" OBJCOPY="${KERNEL_OBJCOPY}"'
Patrick Williams92b42cb2022-09-03 06:53:57 -0500237EXTRA_OEMAKE += ' HOSTCC="${BUILD_CC}" HOSTCFLAGS="${BUILD_CFLAGS}" HOSTLDFLAGS="${BUILD_LDFLAGS}" HOSTCPP="${BUILD_CPP}"'
238EXTRA_OEMAKE += ' HOSTCXX="${BUILD_CXX}" HOSTCXXFLAGS="${BUILD_CXXFLAGS}" PAHOLE=false'
239
240KERNEL_ALT_IMAGETYPE ??= ""
241
242copy_initramfs() {
243 echo "Copying initramfs into ./usr ..."
244 # In case the directory is not created yet from the first pass compile:
245 mkdir -p ${B}/usr
246 # Find and use the first initramfs image archive type we find
247 rm -f ${B}/usr/${INITRAMFS_IMAGE_NAME}.cpio
248 for img in cpio cpio.gz cpio.lz4 cpio.lzo cpio.lzma cpio.xz cpio.zst; do
249 if [ -e "${INITRAMFS_DEPLOY_DIR_IMAGE}/${INITRAMFS_IMAGE_NAME}.$img" ]; then
250 cp ${INITRAMFS_DEPLOY_DIR_IMAGE}/${INITRAMFS_IMAGE_NAME}.$img ${B}/usr/.
251 case $img in
252 *gz)
253 echo "gzip decompressing image"
254 gunzip -f ${B}/usr/${INITRAMFS_IMAGE_NAME}.$img
255 break
256 ;;
257 *lz4)
258 echo "lz4 decompressing image"
259 lz4 -df ${B}/usr/${INITRAMFS_IMAGE_NAME}.$img ${B}/usr/${INITRAMFS_IMAGE_NAME}.cpio
260 break
261 ;;
262 *lzo)
263 echo "lzo decompressing image"
264 lzop -df ${B}/usr/${INITRAMFS_IMAGE_NAME}.$img
265 break
266 ;;
267 *lzma)
268 echo "lzma decompressing image"
269 lzma -df ${B}/usr/${INITRAMFS_IMAGE_NAME}.$img
270 break
271 ;;
272 *xz)
273 echo "xz decompressing image"
274 xz -df ${B}/usr/${INITRAMFS_IMAGE_NAME}.$img
275 break
276 ;;
277 *zst)
278 echo "zst decompressing image"
279 zstd -df ${B}/usr/${INITRAMFS_IMAGE_NAME}.$img
280 break
281 ;;
282 esac
283 break
284 fi
285 done
286 # Verify that the above loop found a initramfs, fail otherwise
287 [ -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."
288}
289
290do_bundle_initramfs () {
291 if [ ! -z "${INITRAMFS_IMAGE}" -a x"${INITRAMFS_IMAGE_BUNDLE}" = x1 ]; then
292 echo "Creating a kernel image with a bundled initramfs..."
293 copy_initramfs
294 # Backing up kernel image relies on its type(regular file or symbolic link)
295 tmp_path=""
296 for imageType in ${KERNEL_IMAGETYPE_FOR_MAKE} ; do
297 if [ -h ${KERNEL_OUTPUT_DIR}/$imageType ] ; then
298 linkpath=`readlink -n ${KERNEL_OUTPUT_DIR}/$imageType`
299 realpath=`readlink -fn ${KERNEL_OUTPUT_DIR}/$imageType`
300 mv -f $realpath $realpath.bak
301 tmp_path=$tmp_path" "$imageType"#"$linkpath"#"$realpath
302 elif [ -f ${KERNEL_OUTPUT_DIR}/$imageType ]; then
303 mv -f ${KERNEL_OUTPUT_DIR}/$imageType ${KERNEL_OUTPUT_DIR}/$imageType.bak
304 tmp_path=$tmp_path" "$imageType"##"
305 fi
306 done
307 use_alternate_initrd=CONFIG_INITRAMFS_SOURCE=${B}/usr/${INITRAMFS_IMAGE_NAME}.cpio
308 kernel_do_compile
309 # Restoring kernel image
310 for tp in $tmp_path ; do
311 imageType=`echo $tp|cut -d "#" -f 1`
312 linkpath=`echo $tp|cut -d "#" -f 2`
313 realpath=`echo $tp|cut -d "#" -f 3`
314 if [ -n "$realpath" ]; then
315 mv -f $realpath $realpath.initramfs
316 mv -f $realpath.bak $realpath
317 ln -sf $linkpath.initramfs ${B}/${KERNEL_OUTPUT_DIR}/$imageType.initramfs
318 else
319 mv -f ${KERNEL_OUTPUT_DIR}/$imageType ${KERNEL_OUTPUT_DIR}/$imageType.initramfs
320 mv -f ${KERNEL_OUTPUT_DIR}/$imageType.bak ${KERNEL_OUTPUT_DIR}/$imageType
321 fi
322 done
323 fi
324}
325do_bundle_initramfs[dirs] = "${B}"
326
327kernel_do_transform_bundled_initramfs() {
328 # vmlinux.gz is not built by kernel
329 if (echo "${KERNEL_IMAGETYPES}" | grep -wq "vmlinux\.gz"); then
330 gzip -9cn < ${KERNEL_OUTPUT_DIR}/vmlinux.initramfs > ${KERNEL_OUTPUT_DIR}/vmlinux.gz.initramfs
331 fi
332}
333do_transform_bundled_initramfs[dirs] = "${B}"
334
335python do_devshell:prepend () {
336 os.environ["LDFLAGS"] = ''
337}
338
339addtask bundle_initramfs after do_install before do_deploy
340
341KERNEL_DEBUG_TIMESTAMPS ??= "0"
342
343kernel_do_compile() {
344 unset CFLAGS CPPFLAGS CXXFLAGS LDFLAGS MACHINE
345
346 # setup native pkg-config variables (kconfig scripts call pkg-config directly, cannot generically be overriden to pkg-config-native)
347 export PKG_CONFIG_DIR="${STAGING_DIR_NATIVE}${libdir_native}/pkgconfig"
348 export PKG_CONFIG_PATH="$PKG_CONFIG_DIR:${STAGING_DATADIR_NATIVE}/pkgconfig"
349 export PKG_CONFIG_LIBDIR="$PKG_CONFIG_DIR"
350 export PKG_CONFIG_SYSROOT_DIR=""
351
352 if [ "${KERNEL_DEBUG_TIMESTAMPS}" != "1" ]; then
353 # kernel sources do not use do_unpack, so SOURCE_DATE_EPOCH may not
354 # be set....
355 if [ "${SOURCE_DATE_EPOCH}" = "" -o "${SOURCE_DATE_EPOCH}" = "0" ]; then
356 # The source directory is not necessarily a git repository, so we
357 # specify the git-dir to ensure that git does not query a
358 # repository in any parent directory.
359 SOURCE_DATE_EPOCH=`git --git-dir="${S}/.git" log -1 --pretty=%ct 2>/dev/null || echo "${REPRODUCIBLE_TIMESTAMP_ROOTFS}"`
360 fi
361
362 ts=`LC_ALL=C date -d @$SOURCE_DATE_EPOCH`
363 export KBUILD_BUILD_TIMESTAMP="$ts"
364 export KCONFIG_NOTIMESTAMP=1
365 bbnote "KBUILD_BUILD_TIMESTAMP: $ts"
Andrew Geissler517393d2023-01-13 08:55:19 -0600366 else
367 ts=`LC_ALL=C date`
368 export KBUILD_BUILD_TIMESTAMP="$ts"
369 bbnote "KBUILD_BUILD_TIMESTAMP: $ts"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500370 fi
371 # The $use_alternate_initrd is only set from
372 # do_bundle_initramfs() This variable is specifically for the
373 # case where we are making a second pass at the kernel
374 # compilation and we want to force the kernel build to use a
375 # different initramfs image. The way to do that in the kernel
376 # is to specify:
377 # make ...args... CONFIG_INITRAMFS_SOURCE=some_other_initramfs.cpio
378 if [ "$use_alternate_initrd" = "" ] && [ "${INITRAMFS_TASK}" != "" ] ; then
379 # The old style way of copying an prebuilt image and building it
380 # is turned on via INTIRAMFS_TASK != ""
381 copy_initramfs
382 use_alternate_initrd=CONFIG_INITRAMFS_SOURCE=${B}/usr/${INITRAMFS_IMAGE_NAME}.cpio
383 fi
384 for typeformake in ${KERNEL_IMAGETYPE_FOR_MAKE} ; do
385 oe_runmake ${typeformake} ${KERNEL_EXTRA_ARGS} $use_alternate_initrd
386 done
387}
388
389kernel_do_transform_kernel() {
390 # vmlinux.gz is not built by kernel
391 if (echo "${KERNEL_IMAGETYPES}" | grep -wq "vmlinux\.gz"); then
392 mkdir -p "${KERNEL_OUTPUT_DIR}"
393 gzip -9cn < ${B}/vmlinux > "${KERNEL_OUTPUT_DIR}/vmlinux.gz"
394 fi
395}
396do_transform_kernel[dirs] = "${B}"
397addtask transform_kernel after do_compile before do_install
398
399do_compile_kernelmodules() {
400 unset CFLAGS CPPFLAGS CXXFLAGS LDFLAGS MACHINE
401 if [ "${KERNEL_DEBUG_TIMESTAMPS}" != "1" ]; then
402 # kernel sources do not use do_unpack, so SOURCE_DATE_EPOCH may not
403 # be set....
404 if [ "${SOURCE_DATE_EPOCH}" = "" -o "${SOURCE_DATE_EPOCH}" = "0" ]; then
405 # The source directory is not necessarily a git repository, so we
406 # specify the git-dir to ensure that git does not query a
407 # repository in any parent directory.
408 SOURCE_DATE_EPOCH=`git --git-dir="${S}/.git" log -1 --pretty=%ct 2>/dev/null || echo "${REPRODUCIBLE_TIMESTAMP_ROOTFS}"`
409 fi
410
411 ts=`LC_ALL=C date -d @$SOURCE_DATE_EPOCH`
412 export KBUILD_BUILD_TIMESTAMP="$ts"
413 export KCONFIG_NOTIMESTAMP=1
414 bbnote "KBUILD_BUILD_TIMESTAMP: $ts"
Andrew Geissler517393d2023-01-13 08:55:19 -0600415 else
416 ts=`LC_ALL=C date`
417 export KBUILD_BUILD_TIMESTAMP="$ts"
418 bbnote "KBUILD_BUILD_TIMESTAMP: $ts"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500419 fi
420 if (grep -q -i -e '^CONFIG_MODULES=y$' ${B}/.config); then
421 oe_runmake -C ${B} ${PARALLEL_MAKE} modules ${KERNEL_EXTRA_ARGS}
422
423 # Module.symvers gets updated during the
424 # building of the kernel modules. We need to
425 # update this in the shared workdir since some
426 # external kernel modules has a dependency on
427 # other kernel modules and will look at this
428 # file to do symbol lookups
429 cp ${B}/Module.symvers ${STAGING_KERNEL_BUILDDIR}/
430 # 5.10+ kernels have module.lds that we need to copy for external module builds
431 if [ -e "${B}/scripts/module.lds" ]; then
432 install -Dm 0644 ${B}/scripts/module.lds ${STAGING_KERNEL_BUILDDIR}/scripts/module.lds
433 fi
434 else
435 bbnote "no modules to compile"
436 fi
437}
438addtask compile_kernelmodules after do_compile before do_strip
439
440kernel_do_install() {
441 #
442 # First install the modules
443 #
444 unset CFLAGS CPPFLAGS CXXFLAGS LDFLAGS MACHINE
445 if (grep -q -i -e '^CONFIG_MODULES=y$' .config); then
446 oe_runmake DEPMOD=echo MODLIB=${D}${nonarch_base_libdir}/modules/${KERNEL_VERSION} INSTALL_FW_PATH=${D}${nonarch_base_libdir}/firmware modules_install
447 rm "${D}${nonarch_base_libdir}/modules/${KERNEL_VERSION}/build"
448 rm "${D}${nonarch_base_libdir}/modules/${KERNEL_VERSION}/source"
Andrew Geissler517393d2023-01-13 08:55:19 -0600449 # Remove empty module directories to prevent QA issues
450 find "${D}${nonarch_base_libdir}/modules/${KERNEL_VERSION}/kernel" -type d -empty -delete
Patrick Williams92b42cb2022-09-03 06:53:57 -0500451 else
452 bbnote "no modules to install"
453 fi
454
455 #
456 # Install various kernel output (zImage, map file, config, module support files)
457 #
458 install -d ${D}/${KERNEL_IMAGEDEST}
459
460 #
461 # When including an initramfs bundle inside a FIT image, the fitImage is created after the install task
462 # by do_assemble_fitimage_initramfs.
463 # This happens after the generation of the initramfs bundle (done by do_bundle_initramfs).
464 # So, at the level of the install task we should not try to install the fitImage. fitImage is still not
465 # generated yet.
466 # After the generation of the fitImage, the deploy task copies the fitImage from the build directory to
467 # the deploy folder.
468 #
469
470 for imageType in ${KERNEL_IMAGETYPES} ; do
471 if [ $imageType != "fitImage" ] || [ "${INITRAMFS_IMAGE_BUNDLE}" != "1" ] ; then
472 install -m 0644 ${KERNEL_OUTPUT_DIR}/$imageType ${D}/${KERNEL_IMAGEDEST}/$imageType-${KERNEL_VERSION}
473 fi
474 done
475
476 install -m 0644 System.map ${D}/${KERNEL_IMAGEDEST}/System.map-${KERNEL_VERSION}
477 install -m 0644 .config ${D}/${KERNEL_IMAGEDEST}/config-${KERNEL_VERSION}
478 install -m 0644 vmlinux ${D}/${KERNEL_IMAGEDEST}/vmlinux-${KERNEL_VERSION}
479 [ -e Module.symvers ] && install -m 0644 Module.symvers ${D}/${KERNEL_IMAGEDEST}/Module.symvers-${KERNEL_VERSION}
480 install -d ${D}${sysconfdir}/modules-load.d
481 install -d ${D}${sysconfdir}/modprobe.d
482}
483
484# Must be ran no earlier than after do_kernel_checkout or else Makefile won't be in ${S}/Makefile
485do_kernel_version_sanity_check() {
486 if [ "x${KERNEL_VERSION_SANITY_SKIP}" = "x1" ]; then
487 exit 0
488 fi
489
490 # The Makefile determines the kernel version shown at runtime
491 # Don't use KERNEL_VERSION because the headers it grabs the version from aren't generated until do_compile
492 VERSION=$(grep "^VERSION =" ${S}/Makefile | sed s/.*=\ *//)
493 PATCHLEVEL=$(grep "^PATCHLEVEL =" ${S}/Makefile | sed s/.*=\ *//)
494 SUBLEVEL=$(grep "^SUBLEVEL =" ${S}/Makefile | sed s/.*=\ *//)
495 EXTRAVERSION=$(grep "^EXTRAVERSION =" ${S}/Makefile | sed s/.*=\ *//)
496
497 # Build a string for regex and a plain version string
498 reg="^${VERSION}\.${PATCHLEVEL}"
499 vers="${VERSION}.${PATCHLEVEL}"
500 if [ -n "${SUBLEVEL}" ]; then
501 # Ignoring a SUBLEVEL of zero is fine
502 if [ "${SUBLEVEL}" = "0" ]; then
503 reg="${reg}(\.${SUBLEVEL})?"
504 else
505 reg="${reg}\.${SUBLEVEL}"
506 vers="${vers}.${SUBLEVEL}"
507 fi
508 fi
509 vers="${vers}${EXTRAVERSION}"
510 reg="${reg}${EXTRAVERSION}"
511
512 if [ -z `echo ${PV} | grep -E "${reg}"` ]; then
513 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."
514 fi
515 exit 0
516}
517
518addtask shared_workdir after do_compile before do_compile_kernelmodules
519addtask shared_workdir_setscene
520
521do_shared_workdir_setscene () {
522 exit 1
523}
524
525emit_depmod_pkgdata() {
526 # Stash data for depmod
527 install -d ${PKGDESTWORK}/${KERNEL_PACKAGE_NAME}-depmod/
528 echo "${KERNEL_VERSION}" > ${PKGDESTWORK}/${KERNEL_PACKAGE_NAME}-depmod/${KERNEL_PACKAGE_NAME}-abiversion
529 cp ${B}/System.map ${PKGDESTWORK}/${KERNEL_PACKAGE_NAME}-depmod/System.map-${KERNEL_VERSION}
530}
531
532PACKAGEFUNCS += "emit_depmod_pkgdata"
533
534do_shared_workdir[cleandirs] += " ${STAGING_KERNEL_BUILDDIR}"
535do_shared_workdir () {
536 cd ${B}
537
538 kerneldir=${STAGING_KERNEL_BUILDDIR}
539 install -d $kerneldir
540
541 #
542 # Store the kernel version in sysroots for module-base.bbclass
543 #
544
545 echo "${KERNEL_VERSION}" > $kerneldir/${KERNEL_PACKAGE_NAME}-abiversion
546
547 # Copy files required for module builds
548 cp System.map $kerneldir/System.map-${KERNEL_VERSION}
549 [ -e Module.symvers ] && cp Module.symvers $kerneldir/
550 cp .config $kerneldir/
551 mkdir -p $kerneldir/include/config
552 cp include/config/kernel.release $kerneldir/include/config/kernel.release
553 if [ -e certs/signing_key.x509 ]; then
554 # The signing_key.* files are stored in the certs/ dir in
555 # newer Linux kernels
556 mkdir -p $kerneldir/certs
557 cp certs/signing_key.* $kerneldir/certs/
558 elif [ -e signing_key.priv ]; then
559 cp signing_key.* $kerneldir/
560 fi
561
562 # We can also copy over all the generated files and avoid special cases
563 # like version.h, but we've opted to keep this small until file creep starts
564 # to happen
565 if [ -e include/linux/version.h ]; then
566 mkdir -p $kerneldir/include/linux
567 cp include/linux/version.h $kerneldir/include/linux/version.h
568 fi
569
570 # As of Linux kernel version 3.0.1, the clean target removes
571 # arch/powerpc/lib/crtsavres.o which is present in
572 # KBUILD_LDFLAGS_MODULE, making it required to build external modules.
573 if [ ${ARCH} = "powerpc" ]; then
574 if [ -e arch/powerpc/lib/crtsavres.o ]; then
575 mkdir -p $kerneldir/arch/powerpc/lib/
576 cp arch/powerpc/lib/crtsavres.o $kerneldir/arch/powerpc/lib/crtsavres.o
577 fi
578 fi
579
580 if [ -d include/generated ]; then
581 mkdir -p $kerneldir/include/generated/
582 cp -fR include/generated/* $kerneldir/include/generated/
583 fi
584
585 if [ -d arch/${ARCH}/include/generated ]; then
586 mkdir -p $kerneldir/arch/${ARCH}/include/generated/
587 cp -fR arch/${ARCH}/include/generated/* $kerneldir/arch/${ARCH}/include/generated/
588 fi
589
590 if (grep -q -i -e '^CONFIG_UNWINDER_ORC=y$' $kerneldir/.config); then
591 # With CONFIG_UNWINDER_ORC (the default in 4.14), objtool is required for
592 # out-of-tree modules to be able to generate object files.
593 if [ -x tools/objtool/objtool ]; then
594 mkdir -p ${kerneldir}/tools/objtool
595 cp tools/objtool/objtool ${kerneldir}/tools/objtool/
596 fi
597 fi
Patrick Williams7784c422022-11-17 07:29:11 -0600598
599 # When building with CONFIG_MODVERSIONS=y and CONFIG_RANDSTRUCT=y we need
600 # to copy the build assets generated for the randstruct seed to
601 # STAGING_KERNEL_BUILDDIR, otherwise the out-of-tree modules build will
602 # generate those assets which will result in a different
603 # RANDSTRUCT_HASHED_SEED
604 if [ -d scripts/basic ]; then
605 mkdir -p ${kerneldir}/scripts
606 cp -r scripts/basic ${kerneldir}/scripts
607 fi
608
609 if [ -d scripts/gcc-plugins ]; then
610 mkdir -p ${kerneldir}/scripts
611 cp -r scripts/gcc-plugins ${kerneldir}/scripts
612 fi
613
Patrick Williams92b42cb2022-09-03 06:53:57 -0500614}
615
616# We don't need to stage anything, not the modules/firmware since those would clash with linux-firmware
Patrick Williams2390b1b2022-11-03 13:47:49 -0500617SYSROOT_DIRS = ""
Patrick Williams92b42cb2022-09-03 06:53:57 -0500618
619KERNEL_CONFIG_COMMAND ?= "oe_runmake_call -C ${S} O=${B} olddefconfig || oe_runmake -C ${S} O=${B} oldnoconfig"
620
621python check_oldest_kernel() {
622 oldest_kernel = d.getVar('OLDEST_KERNEL')
623 kernel_version = d.getVar('KERNEL_VERSION')
624 tclibc = d.getVar('TCLIBC')
625 if tclibc == 'glibc':
626 kernel_version = kernel_version.split('-', 1)[0]
627 if oldest_kernel and kernel_version:
628 if bb.utils.vercmp_string(kernel_version, oldest_kernel) < 0:
629 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))
630}
631
632check_oldest_kernel[vardepsexclude] += "OLDEST_KERNEL KERNEL_VERSION"
633do_configure[prefuncs] += "check_oldest_kernel"
634
635kernel_do_configure() {
636 # fixes extra + in /lib/modules/2.6.37+
637 # $ scripts/setlocalversion . => +
638 # $ make kernelversion => 2.6.37
639 # $ make kernelrelease => 2.6.37+
640 touch ${B}/.scmversion ${S}/.scmversion
641
642 if [ "${S}" != "${B}" ] && [ -f "${S}/.config" ] && [ ! -f "${B}/.config" ]; then
643 mv "${S}/.config" "${B}/.config"
644 fi
645
646 # Copy defconfig to .config if .config does not exist. This allows
647 # recipes to manage the .config themselves in do_configure:prepend().
648 if [ -f "${WORKDIR}/defconfig" ] && [ ! -f "${B}/.config" ]; then
649 cp "${WORKDIR}/defconfig" "${B}/.config"
650 fi
651
652 ${KERNEL_CONFIG_COMMAND}
653}
654
655do_savedefconfig() {
656 bbplain "Saving defconfig to:\n${B}/defconfig"
657 oe_runmake -C ${B} savedefconfig
658}
659do_savedefconfig[nostamp] = "1"
660addtask savedefconfig after do_configure
661
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500662inherit cml1 pkgconfig
Patrick Williams92b42cb2022-09-03 06:53:57 -0500663
664# Need LD, HOSTLDFLAGS and more for config operations
665KCONFIG_CONFIG_COMMAND:append = " ${EXTRA_OEMAKE}"
666
667EXPORT_FUNCTIONS do_compile do_transform_kernel do_transform_bundled_initramfs do_install do_configure
668
669# kernel-base becomes kernel-${KERNEL_VERSION}
670# kernel-image becomes kernel-image-${KERNEL_VERSION}
671PACKAGES = "${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"
672FILES:${PN} = ""
673FILES:${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"
674FILES:${KERNEL_PACKAGE_NAME}-image = ""
675FILES:${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"
676FILES:${KERNEL_PACKAGE_NAME}-vmlinux = "/${KERNEL_IMAGEDEST}/vmlinux-${KERNEL_VERSION_NAME}"
677FILES:${KERNEL_PACKAGE_NAME}-modules = ""
678FILES:${KERNEL_PACKAGE_NAME}-dbg = "/usr/lib/debug /usr/src/debug"
679RDEPENDS:${KERNEL_PACKAGE_NAME} = "${KERNEL_PACKAGE_NAME}-base (= ${EXTENDPKGV})"
680# Allow machines to override this dependency if kernel image files are
681# not wanted in images as standard
682RRECOMMENDS:${KERNEL_PACKAGE_NAME}-base ?= "${KERNEL_PACKAGE_NAME}-image (= ${EXTENDPKGV})"
683PKG:${KERNEL_PACKAGE_NAME}-image = "${KERNEL_PACKAGE_NAME}-image-${@legitimize_package_name(d.getVar('KERNEL_VERSION'))}"
684RDEPENDS:${KERNEL_PACKAGE_NAME}-image += "${@oe.utils.conditional('KERNEL_IMAGETYPE', 'vmlinux', '${KERNEL_PACKAGE_NAME}-vmlinux (= ${EXTENDPKGV})', '', d)}"
685PKG:${KERNEL_PACKAGE_NAME}-base = "${KERNEL_PACKAGE_NAME}-${@legitimize_package_name(d.getVar('KERNEL_VERSION'))}"
686RPROVIDES:${KERNEL_PACKAGE_NAME}-base += "${KERNEL_PACKAGE_NAME}-${KERNEL_VERSION}"
687ALLOW_EMPTY:${KERNEL_PACKAGE_NAME} = "1"
688ALLOW_EMPTY:${KERNEL_PACKAGE_NAME}-base = "1"
689ALLOW_EMPTY:${KERNEL_PACKAGE_NAME}-image = "1"
690ALLOW_EMPTY:${KERNEL_PACKAGE_NAME}-modules = "1"
691DESCRIPTION:${KERNEL_PACKAGE_NAME}-modules = "Kernel modules meta package"
692
693pkg_postinst:${KERNEL_PACKAGE_NAME}-base () {
694 if [ ! -e "$D/lib/modules/${KERNEL_VERSION}" ]; then
695 mkdir -p $D/lib/modules/${KERNEL_VERSION}
696 fi
697 if [ -n "$D" ]; then
Andrew Geissler87f5cff2022-09-30 13:13:31 -0500698 depmodwrapper -a -b $D ${KERNEL_VERSION} ${KERNEL_PACKAGE_NAME}
Patrick Williams92b42cb2022-09-03 06:53:57 -0500699 else
700 depmod -a ${KERNEL_VERSION}
701 fi
702}
703
Andrew Geissler517393d2023-01-13 08:55:19 -0600704PACKAGESPLITFUNCS =+ "split_kernel_packages"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500705
706python split_kernel_packages () {
707 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='')
708}
709
710# Many scripts want to look in arch/$arch/boot for the bootable
711# image. This poses a problem for vmlinux and vmlinuz based
712# booting. This task arranges to have vmlinux and vmlinuz appear
713# in the normalized directory location.
714do_kernel_link_images() {
715 if [ ! -d "${B}/arch/${ARCH}/boot" ]; then
716 mkdir ${B}/arch/${ARCH}/boot
717 fi
718 cd ${B}/arch/${ARCH}/boot
719 ln -sf ../../../vmlinux
720 if [ -f ../../../vmlinuz ]; then
721 ln -sf ../../../vmlinuz
722 fi
723 if [ -f ../../../vmlinuz.bin ]; then
724 ln -sf ../../../vmlinuz.bin
725 fi
726 if [ -f ../../../vmlinux.64 ]; then
727 ln -sf ../../../vmlinux.64
728 fi
729}
730addtask kernel_link_images after do_compile before do_strip
731
732python do_strip() {
733 import shutil
734
735 strip = d.getVar('STRIP')
736 extra_sections = d.getVar('KERNEL_IMAGE_STRIP_EXTRA_SECTIONS')
737 kernel_image = d.getVar('B') + "/" + d.getVar('KERNEL_OUTPUT_DIR') + "/vmlinux"
738
739 if (extra_sections and kernel_image.find(d.getVar('KERNEL_IMAGEDEST') + '/vmlinux') != -1):
740 kernel_image_stripped = kernel_image + ".stripped"
741 shutil.copy2(kernel_image, kernel_image_stripped)
742 oe.package.runstrip((kernel_image_stripped, 8, strip, extra_sections))
743 bb.debug(1, "KERNEL_IMAGE_STRIP_EXTRA_SECTIONS is set, stripping sections: " + \
744 extra_sections)
745}
746do_strip[dirs] = "${B}"
747
748addtask strip before do_sizecheck after do_kernel_link_images
749
750# Support checking the kernel size since some kernels need to reside in partitions
751# with a fixed length or there is a limit in transferring the kernel to memory.
752# If more than one image type is enabled, warn on any that don't fit but only fail
753# if none fit.
754do_sizecheck() {
755 if [ ! -z "${KERNEL_IMAGE_MAXSIZE}" ]; then
756 invalid=`echo ${KERNEL_IMAGE_MAXSIZE} | sed 's/[0-9]//g'`
757 if [ -n "$invalid" ]; then
758 die "Invalid KERNEL_IMAGE_MAXSIZE: ${KERNEL_IMAGE_MAXSIZE}, should be an integer (The unit is Kbytes)"
759 fi
760 at_least_one_fits=
761 for imageType in ${KERNEL_IMAGETYPES} ; do
762 size=`du -ks ${B}/${KERNEL_OUTPUT_DIR}/$imageType | awk '{print $1}'`
763 if [ $size -gt ${KERNEL_IMAGE_MAXSIZE} ]; then
764 bbwarn "This kernel $imageType (size=$size(K) > ${KERNEL_IMAGE_MAXSIZE}(K)) is too big for your device."
765 else
766 at_least_one_fits=y
767 fi
768 done
769 if [ -z "$at_least_one_fits" ]; then
770 die "All kernel images are too big for your device. Please reduce the size of the kernel by making more of it modular."
771 fi
772 fi
773}
774do_sizecheck[dirs] = "${B}"
775
776addtask sizecheck before do_install after do_strip
777
778inherit kernel-artifact-names
779
780kernel_do_deploy() {
781 deployDir="${DEPLOYDIR}"
782 if [ -n "${KERNEL_DEPLOYSUBDIR}" ]; then
783 deployDir="${DEPLOYDIR}/${KERNEL_DEPLOYSUBDIR}"
784 mkdir "$deployDir"
785 fi
786
787 for imageType in ${KERNEL_IMAGETYPES} ; do
788 baseName=$imageType-${KERNEL_IMAGE_NAME}
789
790 if [ -s ${KERNEL_OUTPUT_DIR}/$imageType.stripped ] ; then
791 install -m 0644 ${KERNEL_OUTPUT_DIR}/$imageType.stripped $deployDir/$baseName${KERNEL_IMAGE_BIN_EXT}
792 else
793 install -m 0644 ${KERNEL_OUTPUT_DIR}/$imageType $deployDir/$baseName${KERNEL_IMAGE_BIN_EXT}
794 fi
795 if [ -n "${KERNEL_IMAGE_LINK_NAME}" ] ; then
796 ln -sf $baseName${KERNEL_IMAGE_BIN_EXT} $deployDir/$imageType-${KERNEL_IMAGE_LINK_NAME}${KERNEL_IMAGE_BIN_EXT}
797 fi
798 if [ "${KERNEL_IMAGETYPE_SYMLINK}" = "1" ] ; then
799 ln -sf $baseName${KERNEL_IMAGE_BIN_EXT} $deployDir/$imageType
800 fi
801 done
802
803 if [ ${MODULE_TARBALL_DEPLOY} = "1" ] && (grep -q -i -e '^CONFIG_MODULES=y$' .config); then
804 mkdir -p ${D}${root_prefix}/lib
805 if [ -n "${SOURCE_DATE_EPOCH}" ]; then
806 TAR_ARGS="--sort=name --clamp-mtime --mtime=@${SOURCE_DATE_EPOCH}"
807 else
808 TAR_ARGS=""
809 fi
810 TAR_ARGS="$TAR_ARGS --owner=0 --group=0"
811 tar $TAR_ARGS -cv -C ${D}${root_prefix} lib | gzip -9n > $deployDir/modules-${MODULE_TARBALL_NAME}.tgz
812
813 if [ -n "${MODULE_TARBALL_LINK_NAME}" ] ; then
814 ln -sf modules-${MODULE_TARBALL_NAME}.tgz $deployDir/modules-${MODULE_TARBALL_LINK_NAME}.tgz
815 fi
816 fi
817
818 if [ ! -z "${INITRAMFS_IMAGE}" -a x"${INITRAMFS_IMAGE_BUNDLE}" = x1 ]; then
819 for imageType in ${KERNEL_IMAGETYPES} ; do
820 if [ "$imageType" = "fitImage" ] ; then
821 continue
822 fi
823 initramfsBaseName=$imageType-${INITRAMFS_NAME}
824 install -m 0644 ${KERNEL_OUTPUT_DIR}/$imageType.initramfs $deployDir/$initramfsBaseName${KERNEL_IMAGE_BIN_EXT}
825 if [ -n "${INITRAMFS_LINK_NAME}" ] ; then
826 ln -sf $initramfsBaseName${KERNEL_IMAGE_BIN_EXT} $deployDir/$imageType-${INITRAMFS_LINK_NAME}${KERNEL_IMAGE_BIN_EXT}
827 fi
828 done
829 fi
830}
831
832# We deploy to filenames that include PKGV and PKGR, read the saved data to
833# ensure we get the right values for both
834do_deploy[prefuncs] += "read_subpackage_metadata"
835
836addtask deploy after do_populate_sysroot do_packagedata
837
838EXPORT_FUNCTIONS do_deploy
839
840# Add using Device Tree support
841inherit kernel-devicetree