2 # shellcheck disable=SC2086
4 # kmodtool - Helper script for building kernel module RPMs
5 # Copyright (c) 2003-2012 Ville Skyttä <ville.skytta@iki.fi>,
6 # Thorsten Leemhuis <fedora@leemhuis.info>
7 # Nicolas Chauvet <kwizart@gmail.com>
9 # Permission is hereby granted, free of charge, to any person obtaining
10 # a copy of this software and associated documentation files (the
11 # "Software"), to deal in the Software without restriction, including
12 # without limitation the rights to use, copy, modify, merge, publish,
13 # distribute, sublicense, and/or sell copies of the Software, and to
14 # permit persons to whom the Software is furnished to do so, subject to
15 # the following conditions:
17 # The above copyright notice and this permission notice shall be
18 # included in all copies or substantial portions of the Software.
20 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
24 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
25 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
26 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
30 myprog="kmodtool-${repo}"
34 build_kernels="current"
35 kernels_known_variants=
37 kernel_versions_to_build_for=
49 # the next line is not multi-line safe -- not needed *yet*
50 echo "%global kmodtool_check echo \"kmodtool error: $*\"; exit ${errorlevel};"
54 print_rpmtemplate_header()
57 echo "%global kmodinstdir_prefix ${prefix}/lib/modules/"
58 echo "%global kmodinstdir_postfix /extra/${kmodname}/"
59 echo "%global kernel_versions ${kernel_versions}"
63 print_akmodtemplate ()
68 %global akmod_install mkdir -p \$RPM_BUILD_ROOT/%{_usrsrc}/akmods/; \\\
69 LANG=C rpmbuild --define "_sourcedir %{_sourcedir}" \\\
70 --define "_srcrpmdir \$RPM_BUILD_ROOT/%{_usrsrc}/akmods/" \\\
71 -bs --nodeps %{_specdir}/%{name}.spec ; \\\
72 ln -s \$(ls \$RPM_BUILD_ROOT/%{_usrsrc}/akmods/) \$RPM_BUILD_ROOT/%{_usrsrc}/akmods/${kmodname}-kmod.latest
74 %package -n akmod-${kmodname}
75 Summary: Akmod package for ${kmodname} kernel module(s)
76 Group: System Environment/Kernel
79 %{?AkmodsBuildRequires:Requires: %{AkmodsBuildRequires}}
80 # same requires and provides as a kmods package would have
81 Requires: ${kmodname}-kmod-common >= %{?epoch:%{epoch}:}%{version}
82 Provides: ${kmodname}-kmod = %{?epoch:%{epoch}:}%{version}-%{release}
85 if [ -n "${obsolete_name}" ]; then
86 echo "Provides: akmod-${obsolete_name} = ${obsolete_version}"
87 echo "Obsoletes: akmod-${obsolete_name} < ${obsolete_version}"
92 %description -n akmod-${kmodname}
93 This package provides the akmod package for the ${kmodname} kernel modules.
95 %posttrans -n akmod-${kmodname}
96 nohup ${prefix}/sbin/akmods --from-akmod-posttrans --akmod ${kmodname} &> /dev/null &
98 %files -n akmod-${kmodname}
99 %defattr(-,root,root,-)
108 %package -n kmod-${kmodname}
109 Summary: Metapackage which tracks in ${kmodname} kernel module for newest kernel${dashvariant}
110 Group: System Environment/Kernel
112 Provides: ${kmodname}-kmod = %{?epoch:%{epoch}:}%{version}-%{release}
113 Provides: kmod-${kmodname}-xen = %{?epoch:%{epoch}:}%{version}-%{release}
114 Provides: kmod-${kmodname}-smp = %{?epoch:%{epoch}:}%{version}-%{release}
115 Provides: kmod-${kmodname}-PAE = %{?epoch:%{epoch}:}%{version}-%{release}
116 Requires: akmod-${kmodname} = %{?epoch:%{epoch}:}%{version}-%{release}
119 if [ -n "${obsolete_name}" ]; then
120 echo "Provides: kmod-${obsolete_name} = ${obsolete_version}"
121 echo "Obsoletes: kmod-${obsolete_name} < ${obsolete_version}"
125 %description -n kmod-${kmodname}${dashvariant}
126 This is a meta-package without payload which sole purpose is to require the
127 ${kmodname} kernel module(s) for the newest kernel${dashvariant},
128 to make sure you get it together with a new kernel.
130 %files -n kmod-${kmodname}${dashvariant}
131 %defattr(644,root,root,755)
135 print_rpmtemplate_per_kmodpkg ()
137 if [ "${1}" = "--custom" ]; then
139 local customkernel=true
140 elif [ "${1}" = "--redhat" ]; then
141 # this is needed for akmods
143 local redhatkernel=true
146 local kernel_uname_r=${1}
147 local kernel_variant="${2:+-${2}}"
149 # Detect depmod install location
150 local depmod_path=/sbin/depmod
151 if [ ! -f "${depmod_path}" ]; then
152 depmod_path=/usr/sbin/depmod
157 %package -n kmod-${kmodname}-${kernel_uname_r}
158 Summary: ${kmodname} kernel module(s) for ${kernel_uname_r}
159 Group: System Environment/Kernel
160 Provides: kernel-modules-for-kernel = ${kernel_uname_r}
161 Provides: kmod-${kmodname}-uname-r = ${kernel_uname_r}
162 Provides: ${kmodname}-kmod = %{?epoch:%{epoch}:}%{version}-%{release}
163 Requires: ${kmodname}-kmod-common >= %{?epoch:%{epoch}:}%{version}
165 %if 0%{?rhel} == 6 || 0%{?centos} == 6
166 Requires(post): module-init-tools
167 Requires(postun): module-init-tools
170 Requires(postun): kmod
174 if [ -n "${obsolete_name}" ]; then
175 echo "Provides: kmod-${obsolete_name}-${kernel_uname_r} = ${obsolete_version}"
176 echo "Obsoletes: kmod-${obsolete_name}-${kernel_uname_r} < ${obsolete_version}"
180 if [ -z "${customkernel}" ]; then
182 Requires: kernel-uname-r = ${kernel_uname_r}
183 BuildRequires: kernel-devel-uname-r = ${kernel_uname_r}
184 %{?KmodsRequires:Requires: %{KmodsRequires}-uname-r = ${kernel_uname_r}}
185 %{?KmodsRequires:BuildRequires: %{KmodsRequires}-uname-r = ${kernel_uname_r}}
186 %post -n kmod-${kmodname}-${kernel_uname_r}
187 if [ -f "/boot/System.map-${kernel_uname_r}" ]; then
188 ${prefix}${depmod_path} -aeF /boot/System.map-${kernel_uname_r} ${kernel_uname_r} > /dev/null || :
189 elif [ -f "/lib/modules/${kernel_uname_r}/System.map" ]; then
190 ${prefix}${depmod_path} -aeF /lib/modules/${kernel_uname_r}/System.map ${kernel_uname_r} > /dev/null || :
192 ${prefix}${depmod_path} -ae ${kernel_uname_r} &> /dev/null || :
194 %postun -n kmod-${kmodname}-${kernel_uname_r}
195 if [ -f "/boot/System.map-${kernel_uname_r}" ]; then
196 ${prefix}${depmod_path} -aF /boot/System.map-${kernel_uname_r} ${kernel_uname_r} &> /dev/null || :
197 elif [ -f "/lib/modules/${kernel_uname_r}/System.map" ]; then
198 ${prefix}${depmod_path} -aF /lib/modules/${kernel_uname_r}/System.map ${kernel_uname_r} &> /dev/null || :
200 ${prefix}${depmod_path} -a ${kernel_uname_r} &> /dev/null || :
206 %post -n kmod-${kmodname}-${kernel_uname_r}
207 [ "\$(uname -r)" = "${kernel_uname_r}" ] && ${prefix}${depmod_path} -a > /dev/null || :
208 %postun -n kmod-${kmodname}-${kernel_uname_r}
209 [ "\$(uname -r)" = "${kernel_uname_r}" ] && ${prefix}${depmod_path} -a > /dev/null || :
216 %description -n kmod-${kmodname}-${kernel_uname_r}
217 This package provides the ${kmodname} kernel modules built for the Linux
218 kernel ${kernel_uname_r} for the %{_target_cpu} family of processors.
219 %files -n kmod-${kmodname}-${kernel_uname_r}
220 %defattr(644,root,root,755)
221 %dir $prefix/lib/modules/${kernel_uname_r}/extra
222 ${prefix}/lib/modules/${kernel_uname_r}/extra/${kmodname}/
228 print_rpmtemplate_kmoddevelpkg ()
230 if [ "${1}" = "--custom" ]; then
232 local customkernel=true
233 elif [ "${1}" = "--redhat" ]; then
235 local redhatkernel=true
238 local kernel_uname_r=${1}
241 %package -n kmod-${kmodname}-devel
242 Summary: ${kmodname} kernel module(s) devel common
243 Group: System Environment/Kernel
244 Provides: ${kmodname}-devel-kmod = %{?epoch:%{epoch}:}%{version}-%{release}
247 if [ -z "${customkernel}" ] && [ -z "${redhatkernel}" ]; then
248 echo "Requires: kmod-${kmodname}-devel-${kernel_uname_r} >= %{?epoch:%{epoch}:}%{version}-%{release}"
251 if [ -n "${obsolete_name}" ]; then
252 echo "Provides: kmod-${obsolete_name}-devel = ${obsolete_version}"
253 echo "Obsoletes: kmod-${obsolete_name}-devel < ${obsolete_version}"
257 %description -n kmod-${kmodname}-devel
258 This package provides the common header files to build kernel modules
259 which depend on the ${kmodname} kernel module. It may optionally require
260 the ${kmodname}-devel-<kernel> objects for the newest kernel.
262 %files -n kmod-${kmodname}-devel
263 %defattr(644,root,root,755)
264 %{_usrsrc}/${kmodname}-%{version}
266 if [ -n "${obsolete_name}" ]; then
267 echo "%{_usrsrc}/${obsolete_name}-%{version}"
270 for kernel in ${1}; do
271 local kernel_uname_r=${kernel}
272 echo "%exclude %{_usrsrc}/${kmodname}-%{version}/${kernel_uname_r}"
273 if [ -n "${obsolete_name}" ]; then
274 echo "%exclude %{_usrsrc}/${obsolete_name}-%{version}/${kernel_uname_r}"
282 print_rpmtemplate_per_kmoddevelpkg ()
284 if [ "${1}" = "--custom" ]; then
286 local customkernel=true
287 elif [ "${1}" = "--redhat" ]; then
288 # this is needed for akmods
290 local redhatkernel=true
293 local kernel_uname_r=${1}
294 local kernel_variant="${2:+-${2}}"
298 %package -n kmod-${kmodname}-devel-${kernel_uname_r}
299 Summary: ${kmodname} kernel module(s) devel for ${kernel_uname_r}
300 Group: System Environment/Kernel
301 Provides: kernel-objects-for-kernel = ${kernel_uname_r}
302 Provides: ${kmodname}-devel-kmod = %{?epoch:%{epoch}:}%{version}-%{release}
303 Provides: kmod-${kmodname}-devel-uname-r = ${kernel_uname_r}
306 if [ -n "${obsolete_name}" ]; then
307 echo "Provides: kmod-${obsolete_name}-devel-${kernel_uname_r} = ${obsolete_version}"
308 echo "Obsoletes: kmod-${obsolete_name}-devel-${kernel_uname_r} < ${obsolete_version}"
312 if [ -z "${customkernel}" ]; then
314 Requires: kernel-devel-uname-r = ${kernel_uname_r}
315 BuildRequires: kernel-devel-uname-r = ${kernel_uname_r}
316 %{?KmodsDevelRequires:Requires: %{KmodsDevelRequires}-uname-r = ${kernel_uname_r}}
317 %{?KmodsDevelRequires:BuildRequires: %{KmodsDevelRequires}-uname-r = ${kernel_uname_r}}
323 %description -n kmod-${kmodname}-devel-${kernel_uname_r}
324 This package provides objects and symbols required to build kernel modules
325 which depend on the ${kmodname} kernel modules built for the Linux
326 kernel ${kernel_uname_r} for the %{_target_cpu} family of processors.
327 %files -n kmod-${kmodname}-devel-${kernel_uname_r}
328 %defattr(644,root,root,755)
329 %{_usrsrc}/${kmodname}-%{version}/${kernel_uname_r}
331 if [ -n "${obsolete_name}" ]; then
332 echo "%{_usrsrc}/${obsolete_name}-%{version}/${kernel_uname_r}"
336 print_rpmtemplate_kmodmetapkg ()
338 local kernel_uname_r=${1}
339 local kernel_variant="${2:+-${2}}"
342 %package -n kmod-${kmodname}${kernel_variant}
343 Summary: Metapackage which tracks in ${kmodname} kernel module for newest kernel${kernel_variant}
344 Group: System Environment/Kernel
346 Provides: ${kmodname}-kmod = %{?epoch:%{epoch}:}%{version}-%{release}
347 Requires: kmod-${kmodname}-${kernel_uname_r} >= %{?epoch:%{epoch}:}%{version}-%{release}
348 %{?KmodsMetaRequires:Requires: %{?KmodsMetaRequires}}
351 if [ -n "${obsolete_name}" ]; then
352 echo "Provides: kmod-${obsolete_name}${kernel_variant} = ${obsolete_version}"
353 echo "Obsoletes: kmod-${obsolete_name}${kernel_variant} < ${obsolete_version}"
358 %description -n kmod-${kmodname}${kernel_variant}
359 This is a meta-package without payload which sole purpose is to require the
360 ${kmodname} kernel module(s) for the newest kernel${kernel_variant}.
361 to make sure you get it together with a new kernel.
363 %files -n kmod-${kmodname}${kernel_variant}
364 %defattr(644,root,root,755)
370 print_customrpmtemplate ()
374 if [ -e "${buildroot}/usr/src/kernels/${kernel}" ] ; then
375 # this looks like a Fedora/RH kernel -- print a normal template (which includes the proper BR) and be happy :)
376 kernel_versions="${kernel_versions}${kernel}___${buildroot}%{_usrsrc}/kernels/${kernel} "
378 # parse kernel versions string and print template
379 local kernel_verrelarch=${kernel%%${kernels_known_variants}}
380 print_rpmtemplate_per_kmodpkg --redhat ${kernel} ${kernel##${kernel_verrelarch}}
382 # create development package
383 if [ -n "${devel}" ]; then
384 # create devel package including common headers
385 print_rpmtemplate_kmoddevelpkg --redhat ${kernel} ${kernel##${kernel_verrelarch}}
387 # create devel package
388 print_rpmtemplate_per_kmoddevelpkg --redhat ${kernel} ${kernel##${kernel_verrelarch}}
390 elif [ -e "${prefix}/lib/modules/${kernel}/build/Makefile" ]; then
391 # likely a user-build-kernel with available buildfiles
392 # fixme: we should check if uname from Makefile is the same as ${kernel}
394 kernel_versions="${kernel_versions}${kernel}___${prefix}/lib/modules/${kernel}/build/ "
395 print_rpmtemplate_per_kmodpkg --custom "${kernel}"
397 # create development package
398 if [ -n "${devel}" ]; then
399 # create devel package including common headers
400 print_rpmtemplate_kmoddevelpkg --custom "${kernel}"
402 # create devel package
403 print_rpmtemplate_per_kmoddevelpkg --custom "${kernel}"
406 error_out 2 "Don't know how to handle ${kernel} -- ${prefix}/lib/modules/${kernel}/build/Makefile not found"
410 # well, it's no header anymore, but who cares ;-)
411 print_rpmtemplate_header
417 # create kernel_versions var
418 for kernel_version in ${kernel_versions_to_build_for}
420 kernel_versions="${kernel_versions}${kernel_version}___%{_usrsrc}/kernels/${kernel_version} "
423 # and print it and some other required stuff as macro
424 print_rpmtemplate_header
426 # now print the packages
427 for kernel in ${kernel_versions_to_build_for} ; do
429 local kernel_verrelarch=${kernel%%${kernels_known_variants}}
432 print_rpmtemplate_kmodmetapkg "${kernel}" "${kernel##${kernel_verrelarch}}"
435 print_rpmtemplate_per_kmodpkg "${kernel}" "${kernel##${kernel_verrelarch}}"
437 if [ -n "${devel}" ]; then
438 # create devel package including common headers
439 print_rpmtemplate_kmoddevelpkg "${kernel}" "${kernel##${kernel_verrelarch}}"
441 # create devel package
442 print_rpmtemplate_per_kmoddevelpkg "${kernel}" "${kernel##${kernel_verrelarch}}"
449 echo "Usage: ${0##*/} [OPTIONS]"
451 echo "Creates a template to be used during kmod building"
453 echo "Available options:"
454 echo " --filterfile <file> -- filter the results with grep --file <file>"
455 echo " --for-kernels <list> -- created templates only for these kernels"
456 echo " --kmodname <file> -- name of the kmod (required)"
457 echo " --devel -- make kmod-devel package"
458 echo " --noakmod -- no akmod package"
459 echo " --repo <name> -- use buildsys-build-<name>-kerneldevpkgs"
460 echo " --target <arch> -- target-arch (required)"
461 echo " --buildroot <dir> -- Build root (place to look for build files)"
464 while [ -n "${1}" ] ; do
468 if [ -z "${1}" ] ; then
469 error_out 2 "Please provide path to a filter-file together with --filterfile" >&2
470 elif [ ! -e "${1}" ]; then
471 error_out 2 "Filterfile ${1} not found" >&2
478 if [ -z "${1}" ] ; then
479 error_out 2 "Please provide the name of the kmod together with --kmodname" >&2
481 # strip pending -kmod
482 kmodname="${1%%-kmod}"
491 if [ -z "${1}" ] ; then
492 error_out 2 "Please provide a prefix with --prefix" >&2
499 if [ -z "${1}" ] ; then
500 error_out 2 "Please provide the name of the repo together with --repo" >&2
507 if [ -z "${1}" ] ; then
508 error_out 2 "Please provide the name of the kmod together with --kmodname" >&2
519 if [ -z "${1}" ] ; then
520 error_out 2 "Please provide the name of the kmod to obsolete together with --obsolete-name" >&2
527 if [ -z "${1}" ] ; then
528 error_out 2 "Please provide the version of the kmod to obsolete together with --obsolete-version" >&2
530 obsolete_version="${1}"
540 build_kernels="akmod"
544 build_kernels="newest"
548 build_kernels="current"
560 echo "${myprog} ${myver}"
564 echo "Error: Unknown option '${1}'." >&2
571 if [ -e ./kmodtool-kernel-variants ]; then
572 kernels_known_variants="$(cat ./kmodtool-kernel-variants)"
573 elif [ -e /usr/share/kmodtool/kernel-variants ] ; then
574 kernels_known_variants="$(cat /usr/share/kmodtool/kernel-variants)"
576 kernels_known_variants="@(smp?(-debug)|PAE?(-debug)|debug|kdump|xen|kirkwood|highbank|imx|omap|tegra)"
579 # general sanity checks
580 if [ -z "${target}" ]; then
581 error_out 2 "please pass target arch with --target"
582 elif [ -z "${kmodname}" ]; then
583 error_out 2 "please pass kmodname with --kmodname"
584 elif [ -z "${kernels_known_variants}" ] ; then
585 error_out 2 "could not determine known variants"
586 elif { [ -n "${obsolete_name}" ] && [ -z "${obsolete_version}" ]; } || { [ -z "${obsolete_name}" ] && [ -n "${obsolete_version}" ]; } ; then
587 error_out 2 "you need to provide both --obsolete-name and --obsolete-version"
591 if [ -n "${for_kernels}" ]; then
593 print_customrpmtemplate "${for_kernels}"
594 elif [ "${build_kernels}" = "akmod" ]; then
595 # do only a akmod package
599 # seems we are on out own to decide for which kernels to build
601 # we need more sanity checks in this case
602 if [ -z "${repo}" ]; then
603 error_out 2 "please provide repo name with --repo"
604 elif ! command -v "buildsys-build-${repo}-kerneldevpkgs" > /dev/null 2>&1; then
605 error_out 2 "buildsys-build-${repo}-kerneldevpkgs not found"
608 # call buildsys-build-${repo}-kerneldevpkgs to get the list of kernels
609 cmdoptions="--target ${target}"
611 # filterfile to filter list of kernels?
612 if [ -n "${filterfile}" ] ; then
613 cmdoptions="${cmdoptions} --filterfile ${filterfile}"
616 kernel_versions_to_build_for=$(buildsys-build-${repo}-kerneldevpkgs "--${build_kernels}" ${cmdoptions})
618 if [ "$returncode" -ne 0 ]; then
620 error_out 2 "buildsys-build-${repo}-kerneldevpkgs failed: ${kernel_versions_to_build_for}"
623 if [ "${build_kernels}" = "current" ] && [ -z "${noakmod}" ]; then