scripts/kmodtool

   1 #!/bin/bash
   2
   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>
   7 #
   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:
  15 #
  16 # The above copyright notice and this permission notice shall be
  17 # included in all copies or substantial portions of the Software.
  18 #
  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.
  26
  27 shopt -s extglob
  28
  29 myprog="kmodtool-${repo}"
  30 myver="0.12.1"
  31
  32 kmodname=
  33 build_kernels="current"
  34 kernels_known_variants=
  35 kernel_versions=
  36 kernel_versions_to_build_for=
  37 prefix=
  38 filterfile=
  39 target=
  40
  41 error_out()
  42 {
  43         local errorlevel=${1}
  44         shift
  45         echo "Error: $@" >&2
  46         # the next line is not multi-line safe -- not needed *yet*
  47         echo "%global kmodtool_check echo \"kmodtool error: $@\"; exit ${errorlevel};"
  48         exit ${errorlevel}
  49 }
  50
  51 print_rpmtemplate_header()
  52 {
  53         echo
  54         echo '%global kmodinstdir_prefix  '${prefix}/lib/modules/
  55         echo '%global kmodinstdir_postfix '/extra/${kmodname}/
  56         echo '%global kernel_versions     '${kernel_versions}
  57         echo
  58 }
  59
  60 print_akmodtemplate ()
  61 {
  62         echo
  63         cat <<EOF
  64
  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
  70
  71 %package -n akmod-${kmodname}
  72 Summary:        Akmod package for ${kmodname} kernel module(s)
  73 Group:          System Environment/Kernel
  74 Requires:   kmodtool
  75 Requires:       akmods
  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}
  80 EOF
  81
  82         if [[ ${obsolete_name} ]]; then
  83                 echo "Provides:   akmod-${obsolete_name} = ${obsolete_version}"
  84                 echo "Obsoletes:  akmod-${obsolete_name} < ${obsolete_version}"
  85         fi
  86
  87         cat <<EOF
  88
  89 %description -n akmod-${kmodname}
  90 This package provides the akmod package for the ${kmodname} kernel modules.
  91
  92 %posttrans -n akmod-${kmodname}
  93 nohup ${prefix}/sbin/akmods --from-akmod-posttrans --akmod ${kmodname} &> /dev/null &
  94
  95 %files -n akmod-${kmodname}
  96 %defattr(-,root,root,-)
  97 %{_usrsrc}/akmods/*
  98
  99 EOF
 100 }
 101
 102 print_akmodmeta ()
 103 {
 104                 cat <<EOF
 105 %package      -n kmod-${kmodname}
 106 Summary:         Metapackage which tracks in ${kmodname} kernel module for newest kernel${dashvariant}
 107 Group:           System Environment/Kernel
 108
 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}
 114 EOF
 115
 116         if [[ ${obsolete_name} ]]; then
 117                 echo "Provides:        kmod-${obsolete_name} = ${obsolete_version}"
 118                 echo "Obsoletes:       kmod-${obsolete_name} < ${obsolete_version}"
 119         fi
 120 cat <<EOF
 121
 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.
 126
 127 %files        -n kmod-${kmodname}${dashvariant}
 128 %defattr(644,root,root,755)
 129 EOF
 130 }
 131
 132 print_rpmtemplate_per_kmodpkg ()
 133 {
 134         if [[ "${1}" == "--custom" ]]; then
 135                 shift
 136                 local customkernel=true
 137         elif [[ "${1}" == "--redhat" ]]; then
 138                 # this is needed for akmods
 139                 shift
 140                 local redhatkernel=true
 141         fi
 142
 143         local kernel_uname_r=${1}
 144         local kernel_variant="${2:+-${2}}"
 145
 146     # first part
 147         cat <<EOF
 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}}
 160 EOF
 161
 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}"
 165         fi
 166
 167         # second part
 168         if [[ ! "${customkernel}" ]]; then
 169              cat <<EOF
 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 || :
 176
 177 EOF
 178         else
 179           cat <<EOF
 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 || :
 184
 185 EOF
 186         fi
 187
 188   # third part
 189         cat <<EOF
 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}/
 197
 198
 199 EOF
 200 }
 201
 202 print_rpmtemplate_kmoddevelpkg ()
 203 {
 204         cat <<EOF
 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}
 209
 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}
 216 EOF
 217
 218         for kernel in ${1}; do
 219                 local kernel_uname_r=${kernel}
 220                 echo "%exclude %{_usrsrc}/${kmodname}-%{version}/${kernel_uname_r}"
 221         done
 222
 223         echo
 224         echo
 225 }
 226
 227 print_rpmtemplate_per_kmoddevelpkg ()
 228 {
 229         if [[ "${1}" == "--custom" ]]; then
 230                 shift
 231                 local customkernel=true
 232         elif [[ "${1}" == "--redhat" ]]; then
 233                 # this is needed for akmods
 234                 shift
 235                 local redhatkernel=true
 236         fi
 237
 238         local kernel_uname_r=${1}
 239         local kernel_variant="${2:+-${2}}"
 240
 241         cat <<EOF
 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}
 247 EOF
 248
 249         # second part
 250         if [[ ! "${customkernel}" ]]; then
 251                 cat <<EOF
 252 Requires:         kernel-uname-r = ${kernel_uname_r}
 253 BuildRequires:    kernel-devel-uname-r = ${kernel_uname_r}
 254 EOF
 255         fi
 256
 257         cat <<EOF
 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}
 265
 266
 267 EOF
 268 }
 269
 270 print_rpmtemplate_kmodmetapkg ()
 271 {
 272                 local kernel_uname_r=${1}
 273                 local kernel_variant="${2:+-${2}}"
 274
 275                 cat <<EOF
 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
 279
 280 Provides:        ${kmodname}-kmod = %{?epoch:%{epoch}:}%{version}-%{release}
 281 Requires:        kmod-${kmodname}-${kernel_uname_r} >= %{?epoch:%{epoch}:}%{version}-%{release}
 282 EOF
 283
 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}"
 287                 fi
 288
 289                 cat <<EOF
 290
 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.
 295
 296 %files        -n kmod-${kmodname}${kernel_variant}
 297 %defattr(644,root,root,755)
 298
 299
 300 EOF
 301 }
 302
 303 print_customrpmtemplate ()
 304 {
 305         for kernel in ${1}
 306         do
 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} "
 310
 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}}
 314
 315                         # create development package
 316                         if [[ "${devel}" ]]; then
 317                                 print_rpmtemplate_per_kmoddevelpkg --redhat ${kernel} ${kernel##${kernel_verrelarch}}
 318                         fi
 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}
 322
 323                         kernel_versions="${kernel_versions}${kernel}___${prefix}/lib/modules/${kernel}/build/ "
 324                         print_rpmtemplate_per_kmodpkg --custom "${kernel}"
 325
 326                         # create development package
 327                         if [[ "${devel}" ]]; then
 328                                 print_rpmtemplate_per_kmoddevelpkg --custom "${kernel}"
 329                         fi
 330                 else
 331                         error_out 2 "Don't know how to handle ${kernel} -- ${prefix}/lib/modules/${kernel}/build/Makefile not found"
 332                 fi
 333         done
 334
 335         # create common development package
 336         if [[ "${devel}" ]]; then
 337                 print_rpmtemplate_kmoddevelpkg "${1}"
 338         fi
 339
 340         # well, it's no header anymore, but who cares ;-)
 341         print_rpmtemplate_header
 342 }
 343
 344
 345 print_rpmtemplate ()
 346 {
 347         # create kernel_versions var
 348         for kernel_version in ${kernel_versions_to_build_for}
 349         do
 350                 kernel_versions="${kernel_versions}${kernel_version}___%{_usrsrc}/kernels/${kernel_version} "
 351         done
 352
 353         # and print it and some other required stuff as macro
 354         print_rpmtemplate_header
 355
 356         # now print the packages itselfs
 357         for kernel in ${kernel_versions_to_build_for} ; do
 358
 359                 local kernel_verrelarch=${kernel%%${kernels_known_variants}}
 360
 361                 # create metapackage
 362                 print_rpmtemplate_kmodmetapkg ${kernel} ${kernel##${kernel_verrelarch}}
 363
 364                 # create package
 365                 print_rpmtemplate_per_kmodpkg ${kernel} ${kernel##${kernel_verrelarch}}
 366
 367                 # create development package
 368                 if [[ "${devel}" ]]; then
 369                         print_rpmtemplate_per_kmoddevelpkg ${kernel} ${kernel##${kernel_verrelarch}}
 370                 fi
 371         done
 372
 373         # create common development package
 374         if [[ "${devel}" ]]; then
 375                 print_rpmtemplate_kmoddevelpkg "${1}"
 376         fi
 377 }
 378
 379 myprog_help ()
 380 {
 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)"
 392 }
 393
 394 while [ "${1}" ] ; do
 395         case "${1}" in
 396                 --filterfile)
 397                         shift
 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
 402                         fi
 403                         filterfile="${1}"
 404                         shift
 405                         ;;
 406                 --kmodname)
 407                         shift
 408                         if [[ ! "${1}" ]] ; then
 409                                 error_out 2 "Please provide the name of the kmod together with --kmodname" >&2
 410                     fi
 411                         # strip pending -kmod
 412                         kmodname="${1%%-kmod}"
 413                         shift
 414                         ;;
 415                 --devel)
 416                         shift
 417                         devel="true"
 418                         ;;
 419                 --prefix)
 420                         shift
 421                         if [[ ! "${1}" ]] ; then
 422                                 error_out 2 "Please provide a prefix with --prefix" >&2
 423                     fi
 424                         prefix="${1}"
 425                         shift
 426                         ;;
 427                 --repo)
 428                         shift
 429                         if [[ ! "${1}" ]] ; then
 430                                 error_out 2 "Please provide the name of the repo together with --repo" >&2
 431                     fi
 432                         repo=${1}
 433                         shift
 434                         ;;
 435                 --for-kernels)
 436                         shift
 437                         if [[ ! "${1}" ]] ; then
 438                                 error_out 2 "Please provide the name of the kmod together with --kmodname" >&2
 439                         fi
 440                         for_kernels="${1}"
 441                         shift
 442                         ;;
 443                 --noakmod)
 444                         shift
 445                         noakmod="true"
 446                         ;;
 447                 --obsolete-name)
 448                         shift
 449                         if [[ ! "${1}" ]] ; then
 450                                 error_out 2 "Please provide the name of the kmod to obsolte together with --obsolete-name" >&2
 451                         fi
 452                         obsolete_name="${1}"
 453                         shift
 454                         ;;
 455                 --obsolete-version)
 456                         shift
 457                         if [[ ! "${1}" ]] ; then
 458                                 error_out 2 "Please provide the version of the kmod to obsolte together with --obsolete-version" >&2
 459                         fi
 460                         obsolete_version="${1}"
 461                         shift
 462                         ;;
 463                 --target)
 464                         shift
 465                         target="${1}"
 466                         shift
 467                         ;;
 468                 --akmod)
 469                         shift
 470                         build_kernels="akmod"
 471                         ;;
 472                 --newest)
 473                         shift
 474                         build_kernels="newest"
 475                         ;;
 476                 --current)
 477                         shift
 478                         build_kernels="current"
 479                         ;;
 480                 --help)
 481                         myprog_help
 482                         exit 0
 483                         ;;
 484                 --version)
 485                         echo "${myprog} ${myver}"
 486                         exit 0
 487                         ;;
 488                 *)
 489                         echo "Error: Unknown option '${1}'." >&2
 490                         usage >&2
 491                         exit 2
 492                         ;;
 493         esac
 494 done
 495
 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)"
 500 else
 501         kernels_known_variants="@(smp?(-debug)|PAE?(-debug)|debug|kdump|xen|kirkwood|highbank|imx|omap|tegra)"
 502 fi
 503
 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"
 513 fi
 514
 515 # go
 516 if [[ "${for_kernels}" ]]; then
 517         # this is easy:
 518         print_customrpmtemplate "${for_kernels}"
 519 elif [[ "${build_kernels}" == "akmod" ]]; then
 520         # do only a akmod package
 521         print_akmodtemplate
 522         print_akmodmeta
 523 else
 524         # seems we are on out own to decide for which kernels to build
 525
 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"
 531         fi
 532
 533         # call buildsys-build-${repo}-kerneldevpkgs to get the list of kernels
 534         cmdoptions="--target ${target}"
 535
 536         # filterfile to filter list of kernels?
 537         if [[ "${filterfile}" ]] ; then
 538                  cmdoptions="${cmdoptions} --filterfile ${filterfile}"
 539         fi
 540
 541         kernel_versions_to_build_for="$(buildsys-build-${repo}-kerneldevpkgs --${build_kernels} ${cmdoptions})"
 542         returncode=$?
 543         if (( ${returncode} != 0 )); then
 544                 error_out 2 "buildsys-build-${repo}-kerneldevpkgs failed: $(buildsys-build-${repo}-kerneldevpkgs --${build_kernels} ${cmdoptions})"
 545         fi
 546
 547         if [[ "${build_kernels}" == "current" ]] && [[ ! "${noakmod}" ]]; then
 548                 print_akmodtemplate
 549         fi
 550
 551         print_rpmtemplate
 552 fi