3 # kmodtool - Helper script for building kernel module RPMs
4 # Copyright (c) 2003-2012 Ville Skyttä <ville.skytta@iki.fi>,
5 # Thorsten Leemhuis <fedora@leemhuis.info>
6 # Nicolas Chauvet <kwizart@gmail.com>
8 # Permission is hereby granted, free of charge, to any person obtaining
9 # a copy of this software and associated documentation files (the
10 # "Software"), to deal in the Software without restriction, including
11 # without limitation the rights to use, copy, modify, merge, publish,
12 # distribute, sublicense, and/or sell copies of the Software, and to
13 # permit persons to whom the Software is furnished to do so, subject to
14 # the following conditions:
16 # The above copyright notice and this permission notice shall be
17 # included in all copies or substantial portions of the Software.
19 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
22 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
23 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
24 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
25 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 myprog="kmodtool-${repo}"
33 build_kernels="current"
34 kernels_known_variants=
36 kernel_versions_to_build_for=
46 # the next line is not multi-line safe -- not needed *yet*
47 echo "%global kmodtool_check echo \"kmodtool error: $@\"; exit ${errorlevel};"
51 print_rpmtemplate_header()
54 echo '%global kmodinstdir_prefix '${prefix}/lib/modules/
55 echo '%global kmodinstdir_postfix '/extra/${kmodname}/
56 echo '%global kernel_versions '${kernel_versions}
60 print_akmodtemplate ()
65 %global akmod_install mkdir -p \$RPM_BUILD_ROOT/%{_usrsrc}/akmods/; \\\
66 rpmbuild --define "_sourcedir %{_sourcedir}" \\\
67 --define "_srcrpmdir \$RPM_BUILD_ROOT/%{_usrsrc}/akmods/" \\\
68 -bs --nodeps %{_specdir}/%{name}.spec ; \\\
69 ln -s \$(ls \$RPM_BUILD_ROOT/%{_usrsrc}/akmods/) \$RPM_BUILD_ROOT/%{_usrsrc}/akmods/${kmodname}-kmod.latest
71 %package -n akmod-${kmodname}
72 Summary: Akmod package for ${kmodname} kernel module(s)
73 Group: System Environment/Kernel
76 %{?AkmodsBuildRequires:Requires: %{AkmodsBuildRequires}}
77 # same requires and provides as a kmods package would have
78 Requires: ${kmodname}-kmod-common >= %{?epoch:%{epoch}:}%{version}
79 Provides: ${kmodname}-kmod = %{?epoch:%{epoch}:}%{version}-%{release}
82 if [[ ${obsolete_name} ]]; then
83 echo "Provides: akmod-${obsolete_name} = ${obsolete_version}"
84 echo "Obsoletes: akmod-${obsolete_name} < ${obsolete_version}"
89 %description -n akmod-${kmodname}
90 This package provides the akmod package for the ${kmodname} kernel modules.
92 %posttrans -n akmod-${kmodname}
93 nohup ${prefix}/sbin/akmods --from-akmod-posttrans --akmod ${kmodname} &> /dev/null &
95 %files -n akmod-${kmodname}
96 %defattr(-,root,root,-)
105 %package -n kmod-${kmodname}
106 Summary: Metapackage which tracks in ${kmodname} kernel module for newest kernel${dashvariant}
107 Group: System Environment/Kernel
109 Provides: ${kmodname}-kmod = %{?epoch:%{epoch}:}%{version}-%{release}
110 Provides: kmod-${kmodname}-xen = %{?epoch:%{epoch}:}%{version}-%{release}
111 Provides: kmod-${kmodname}-smp = %{?epoch:%{epoch}:}%{version}-%{release}
112 Provides: kmod-${kmodname}-PAE = %{?epoch:%{epoch}:}%{version}-%{release}
113 Requires: akmod-${kmodname} = %{?epoch:%{epoch}:}%{version}-%{release}
116 if [[ ${obsolete_name} ]]; then
117 echo "Provides: kmod-${obsolete_name} = ${obsolete_version}"
118 echo "Obsoletes: kmod-${obsolete_name} < ${obsolete_version}"
122 %description -n kmod-${kmodname}${dashvariant}
123 This is a meta-package without payload which sole purpose is to require the
124 ${kmodname} kernel module(s) for the newest kernel${dashvariant},
125 to make sure you get it together with a new kernel.
127 %files -n kmod-${kmodname}${dashvariant}
128 %defattr(644,root,root,755)
132 print_rpmtemplate_per_kmodpkg ()
134 if [[ "${1}" == "--custom" ]]; then
136 local customkernel=true
137 elif [[ "${1}" == "--redhat" ]]; then
138 # this is needed for akmods
140 local redhatkernel=true
143 local kernel_uname_r=${1}
144 local kernel_variant="${2:+-${2}}"
148 %package -n kmod-${kmodname}-${kernel_uname_r}
149 Summary: ${kmodname} kernel module(s) for ${kernel_uname_r}
150 Group: System Environment/Kernel
151 Provides: kernel-modules-for-kernel = ${kernel_uname_r}
152 Provides: kmod-${kmodname}-uname-r = ${kernel_uname_r}
153 Provides: ${kmodname}-kmod = %{?epoch:%{epoch}:}%{version}-%{release}
154 Requires: ${kmodname}-kmod-common >= %{?epoch:%{epoch}:}%{version}
155 Requires(post): ${prefix}/sbin/depmod
156 Requires(postun): ${prefix}/sbin/depmod
157 %{?KmodsRequires:Requires: %{KmodsRequires}-uname-r = ${kernel_uname_r}}
158 %{?KmodsBuildRequires:BuildRequires: %{KmodsBuildRequires}-uname-r = ${kernel_uname_r}}
159 %{?KmodsBuildRequires:BuildRequires: %{KmodsBuildRequires}}
162 if [[ ${obsolete_name} ]]; then
163 echo "Provides: kmod-${obsolete_name}-${kernel_uname_r} = ${obsolete_version}"
164 echo "Obsoletes: kmod-${obsolete_name}-${kernel_uname_r} < ${obsolete_version}"
168 if [[ ! "${customkernel}" ]]; then
170 Requires: kernel-uname-r = ${kernel_uname_r}
171 BuildRequires: kernel-devel-uname-r = ${kernel_uname_r}
172 %post -n kmod-${kmodname}-${kernel_uname_r}
173 ${prefix}/sbin/depmod -aeF /boot/System.map-${kernel_uname_r} ${kernel_uname_r} > /dev/null || :
174 %postun -n kmod-${kmodname}-${kernel_uname_r}
175 ${prefix}/sbin/depmod -aF /boot/System.map-${kernel_uname_r} ${kernel_uname_r} &> /dev/null || :
180 %post -n kmod-${kmodname}-${kernel_uname_r}
181 [[ "$(uname -r)" == "${kernel_uname_r}" ]] && ${prefix}/sbin/depmod -a > /dev/null || :
182 %postun -n kmod-${kmodname}-${kernel_uname_r}
183 [[ "$(uname -r)" == "${kernel_uname_r}" ]] && ${prefix}/sbin/depmod -a > /dev/null || :
190 %description -n kmod-${kmodname}-${kernel_uname_r}
191 This package provides the ${kmodname} kernel modules built for the Linux
192 kernel ${kernel_uname_r} for the %{_target_cpu} family of processors.
193 %files -n kmod-${kmodname}-${kernel_uname_r}
194 %defattr(644,root,root,755)
195 %dir $prefix/lib/modules/${kernel_uname_r}/extra
196 ${prefix}/lib/modules/${kernel_uname_r}/extra/${kmodname}/
202 print_rpmtemplate_kmoddevelpkg ()
205 %package -n kmod-${kmodname}-devel
206 Summary: ${kmodname} kernel module(s) devel common
207 Group: System Environment/Kernel
208 Provides: ${kmodname}-devel-kmod-common = %{?epoch:%{epoch}:}%{version}-%{release}
210 %description -n kmod-${kmodname}-devel
211 This package provides the common header files to build kernel modules
212 which depend on the ${kmodname} kernel module.
213 %files -n kmod-${kmodname}-devel
214 %defattr(644,root,root,755)
215 %{_usrsrc}/${kmodname}-%{version}
218 for kernel in ${1}; do
219 local kernel_uname_r=${kernel}
220 echo "%exclude %{_usrsrc}/${kmodname}-%{version}/${kernel_uname_r}"
227 print_rpmtemplate_per_kmoddevelpkg ()
229 if [[ "${1}" == "--custom" ]]; then
231 local customkernel=true
232 elif [[ "${1}" == "--redhat" ]]; then
233 # this is needed for akmods
235 local redhatkernel=true
238 local kernel_uname_r=${1}
239 local kernel_variant="${2:+-${2}}"
242 %package -n kmod-${kmodname}-devel-${kernel_uname_r}
243 Summary: ${kmodname} kernel module(s) devel for ${kernel_uname_r}
244 Group: System Environment/Kernel
245 Requires: ${kmodname}-devel-kmod-common = %{?epoch:%{epoch}:}%{version}-%{release}
246 Provides: kmod-${kmodname}-devel-uname-r = ${kernel_uname_r}
250 if [[ ! "${customkernel}" ]]; then
252 Requires: kernel-uname-r = ${kernel_uname_r}
253 BuildRequires: kernel-devel-uname-r = ${kernel_uname_r}
258 %description -n kmod-${kmodname}-devel-${kernel_uname_r}
259 This package provides objects and symbols required to build kernel modules
260 which depend on the ${kmodname} kernel modules built for the Linux
261 kernel ${kernel_uname_r} for the %{_target_cpu} family of processors.
262 %files -n kmod-${kmodname}-devel-${kernel_uname_r}
263 %defattr(644,root,root,755)
264 %{_usrsrc}/${kmodname}-%{version}/${kernel_uname_r}
270 print_rpmtemplate_kmodmetapkg ()
272 local kernel_uname_r=${1}
273 local kernel_variant="${2:+-${2}}"
276 %package -n kmod-${kmodname}${kernel_variant}
277 Summary: Metapackage which tracks in ${kmodname} kernel module for newest kernel${kernel_variant}
278 Group: System Environment/Kernel
280 Provides: ${kmodname}-kmod = %{?epoch:%{epoch}:}%{version}-%{release}
281 Requires: kmod-${kmodname}-${kernel_uname_r} >= %{?epoch:%{epoch}:}%{version}-%{release}
284 if [[ ${obsolete_name} ]]; then
285 echo "Provides: kmod-${obsolete_name}${kernel_variant} = ${obsolete_version}"
286 echo "Obsoletes: kmod-${obsolete_name}${kernel_variant} < ${obsolete_version}"
291 %description -n kmod-${kmodname}${kernel_variant}
292 This is a meta-package without payload which sole purpose is to require the
293 ${kmodname} kernel module(s) for the newest kernel${kernel_variant}.
294 to make sure you get it together with a new kernel.
296 %files -n kmod-${kmodname}${kernel_variant}
297 %defattr(644,root,root,755)
303 print_customrpmtemplate ()
307 if [[ -e "/usr/src/kernels/${kernel}" ]] ; then
308 # this looks like a Fedora/RH kernel -- print a normal template (which includes the proper BR) and be happy :)
309 kernel_versions="${kernel_versions}${kernel}___%{_usrsrc}/kernels/${kernel} "
311 # parse kernel versions string and print template
312 local kernel_verrelarch=${kernel%%${kernels_known_variants}}
313 print_rpmtemplate_per_kmodpkg --redhat ${kernel} ${kernel##${kernel_verrelarch}}
315 # create development package
316 if [[ "${devel}" ]]; then
317 print_rpmtemplate_per_kmoddevelpkg --redhat ${kernel} ${kernel##${kernel_verrelarch}}
319 elif [[ -e ${prefix}/lib/modules/"${kernel}"/build/Makefile ]] ; then
320 # likely a user-build-kernel with available buildfiles
321 # fixme: we should check if uname from Makefile is the same as ${kernel}
323 kernel_versions="${kernel_versions}${kernel}___${prefix}/lib/modules/${kernel}/build/ "
324 print_rpmtemplate_per_kmodpkg --custom "${kernel}"
326 # create development package
327 if [[ "${devel}" ]]; then
328 print_rpmtemplate_per_kmoddevelpkg --custom "${kernel}"
331 error_out 2 "Don't know how to handle ${kernel} -- ${prefix}/lib/modules/${kernel}/build/Makefile not found"
335 # create common development package
336 if [[ "${devel}" ]]; then
337 print_rpmtemplate_kmoddevelpkg "${1}"
340 # well, it's no header anymore, but who cares ;-)
341 print_rpmtemplate_header
347 # create kernel_versions var
348 for kernel_version in ${kernel_versions_to_build_for}
350 kernel_versions="${kernel_versions}${kernel_version}___%{_usrsrc}/kernels/${kernel_version} "
353 # and print it and some other required stuff as macro
354 print_rpmtemplate_header
356 # now print the packages itselfs
357 for kernel in ${kernel_versions_to_build_for} ; do
359 local kernel_verrelarch=${kernel%%${kernels_known_variants}}
362 print_rpmtemplate_kmodmetapkg ${kernel} ${kernel##${kernel_verrelarch}}
365 print_rpmtemplate_per_kmodpkg ${kernel} ${kernel##${kernel_verrelarch}}
367 # create development package
368 if [[ "${devel}" ]]; then
369 print_rpmtemplate_per_kmoddevelpkg ${kernel} ${kernel##${kernel_verrelarch}}
373 # create common development package
374 if [[ "${devel}" ]]; then
375 print_rpmtemplate_kmoddevelpkg "${1}"
381 echo "Usage: $(basename ${0}) [OPTIONS]"
382 echo $'\n'"Creates a template to be used during kmod building"
383 echo $'\n'"Available options:"
384 # FIXME echo " --datadir <dir> -- look for our shared files in <dir>"
385 echo " --filterfile <file> -- filter the results with grep --file <file>"
386 echo " --for-kernels <list> -- created templates only for these kernels"
387 echo " --kmodname <file> -- name of the kmod (required)"
388 echo " --devel -- make kmod-devel package"
389 echo " --noakmod -- no akmod package"
390 echo " --repo <name> -- use buildsys-build-<name>-kerneldevpkgs"
391 echo " --target <arch> -- target-arch (required)"
394 while [ "${1}" ] ; do
398 if [[ ! "${1}" ]] ; then
399 error_out 2 "Please provide path to a filter-file together with --filterfile" >&2
400 elif [[ ! -e "${1}" ]]; then
401 error_out 2 "Filterfile ${1} not found" >&2
408 if [[ ! "${1}" ]] ; then
409 error_out 2 "Please provide the name of the kmod together with --kmodname" >&2
411 # strip pending -kmod
412 kmodname="${1%%-kmod}"
421 if [[ ! "${1}" ]] ; then
422 error_out 2 "Please provide a prefix with --prefix" >&2
429 if [[ ! "${1}" ]] ; then
430 error_out 2 "Please provide the name of the repo together with --repo" >&2
437 if [[ ! "${1}" ]] ; then
438 error_out 2 "Please provide the name of the kmod together with --kmodname" >&2
449 if [[ ! "${1}" ]] ; then
450 error_out 2 "Please provide the name of the kmod to obsolte together with --obsolete-name" >&2
457 if [[ ! "${1}" ]] ; then
458 error_out 2 "Please provide the version of the kmod to obsolte together with --obsolete-version" >&2
460 obsolete_version="${1}"
470 build_kernels="akmod"
474 build_kernels="newest"
478 build_kernels="current"
485 echo "${myprog} ${myver}"
489 echo "Error: Unknown option '${1}'." >&2
496 if [[ -e ./kmodtool-kernel-variants ]]; then
497 kernels_known_variants="$(cat ./kmodtool-kernel-variants)"
498 elif [[ -e /usr/share/kmodtool/kernel-variants ]] ; then
499 kernels_known_variants="$(cat /usr/share/kmodtool/kernel-variants)"
501 kernels_known_variants="@(smp?(-debug)|PAE?(-debug)|debug|kdump|xen|kirkwood|highbank|imx|omap|tegra)"
504 # general sanity checks
505 if [[ ! "${target}" ]]; then
506 error_out 2 "please pass target arch with --target"
507 elif [[ ! "${kmodname}" ]]; then
508 error_out 2 "please pass kmodname with --kmodname"
509 elif [[ ! "${kernels_known_variants}" ]] ; then
510 error_out 2 "could not determine known variants"
511 elif ( [[ "${obsolete_name}" ]] && [[ ! "${obsolete_version}" ]] ) || ( [[ ! "${obsolete_name}" ]] && [[ "${obsolete_version}" ]] ) ; then
512 error_out 2 "you need to provide both --obsolete-name and --obsolete-version"
516 if [[ "${for_kernels}" ]]; then
518 print_customrpmtemplate "${for_kernels}"
519 elif [[ "${build_kernels}" == "akmod" ]]; then
520 # do only a akmod package
524 # seems we are on out own to decide for which kernels to build
526 # we need more sanity checks in this case
527 if [[ ! "${repo}" ]]; then
528 error_out 2 "please provide repo name with --repo"
529 elif ! $(which buildsys-build-${repo}-kerneldevpkgs &> /dev/null) ; then
530 error_out 2 "buildsys-build-${repo}-kerneldevpkgs not found"
533 # call buildsys-build-${repo}-kerneldevpkgs to get the list of kernels
534 cmdoptions="--target ${target}"
536 # filterfile to filter list of kernels?
537 if [[ "${filterfile}" ]] ; then
538 cmdoptions="${cmdoptions} --filterfile ${filterfile}"
541 kernel_versions_to_build_for="$(buildsys-build-${repo}-kerneldevpkgs --${build_kernels} ${cmdoptions})"
543 if (( ${returncode} != 0 )); then
544 error_out 2 "buildsys-build-${repo}-kerneldevpkgs failed: $(buildsys-build-${repo}-kerneldevpkgs --${build_kernels} ${cmdoptions})"
547 if [[ "${build_kernels}" == "current" ]] && [[ ! "${noakmod}" ]]; then