build.sh

#!/bin/bash
set -u

export LANG=C
export RUST_BACKTRACE=full

update=yes
btype=binary
shell=no
custom=no
sign=no
flavour=none
exclude=none
rename=no
patch=no
series=${series:-"jammy"}
checkbugs=yes
buildmeta=no
debug=no
kver="$kver"
metaver="0"
metatime=1672531200
metaonly=no
maintainer="Zaphod Beeblebrox <zaphod@betelgeuse-seven.western-spiral-arm.change.me.to.match.signing.key>"
buildargs="-aamd64 -d"
branch=""
bundle=no
stype=crack
clean=no
dryrun=no

# Set these both to yes if you want to to install the required rust version and build a rust enabled kernel
rustup=no
haverust=no

do_metapackage() {
  KVER=$1
  METAVER=$2
  METATIME="$(date -d @${3} '+UTC %Y-%m-%d %T')"
  VERSION=$(echo ${KVER} | awk -F. '{printf "%d.%02d", $1,$2 }')
  FLAVOUR=$4
  SERIES=$5
  MAINT=$6
  ABINUM=$7
  BTYPE=$8
  BINS="${KVER}-${ABINUM}-${FLAVOUR}"
  DEPS="linux-headers-${BINS}, linux-image-unsigned-${BINS}, linux-modules-${BINS}"

  echo ">>> Metapackage for $FLAVOUR: MetaVersion: $METAVER, MetaTime: $METATIME"
  [ -d "../meta" ] || mkdir ../meta
  cd ../meta
  cat > metapackage.control <<-EOF
		Section: devel
		Priority: optional
		# Homepage: <enter URL here; no default>
		Standards-Version: 3.9.2

		Package: linux-${FLAVOUR}-${VERSION}
		Changelog: changelog
		Version: ${KVER}-${METAVER}
		Maintainer: ${MAINT}
		Depends: ${DEPS}
		Architecture: amd64
		Description: Meta-package which will always depend on the latest packages in a mainline series.
		  This meta package will depend on the latest kernel in a series (eg 5.12.x) and install the
		  dependencies for that kernel.
		  .
		  Example: linux-generic-5.12 will depend on linux-image-unsigned-5.12.x-generic,
		  linux-modules-5.12.x-generic, linux-headers-5.12.x-generic and linux-headers-5.12.x
	EOF
	cat > changelog <<-EOF
		linux-${FLAVOUR}-${VERSION} (${KVER}-${METAVER}) ${SERIES}; urgency=low

		  Metapackage for Linux ${VERSION}.x
		  Mainline build at commit: v${KVER}

		 -- ${MAINT}  $(date -R)
	EOF

  mkdir -p "source/usr/share/doc/linux-${FLAVOUR}-${VERSION}"
  cat > "source/usr/share/doc/linux-${FLAVOUR}-${VERSION}/README" <<-EOF
		This meta-package will always depend on the latest ${VERSION} kernel
		To see which version that is you can execute:

          $ apt-cache depends linux-${FLAVOUR}-${VERSION}

        :wq
	EOF

  grep "native" /usr/share/equivs/template/debian/source/format > /dev/null
  native=$?

  if [ "$native" == "0" ]
  then
    echo "Extra-Files: source/usr/share/doc/linux-${FLAVOUR}-${VERSION}/README" >> metapackage.control
  else
    tar -C source --sort=name --owner=root:0 --group=root:0 --mtime="$METATIME" -zcf "linux-${FLAVOUR}-${VERSION}_${KVER}.orig.tar.gz" .
  fi

  equivs-build metapackage.control
  if [ "$BTYPE" == "source" ]
  then
    echo ">>> Building source"
    equivs-build --source metapackage.control
  fi

  changesfile="linux-${FLAVOUR}-${VERSION}_${KVER}-${METAVER}_source.changes"
  grep "BEGIN PGP SIGNED MESSAGE" "$changesfile" > /dev/null
  signed=$?

  if [ "$signed" != "0" ]
  then
    debsign -m"${MAINT}" "${changesfile}"
  fi

  mv linux-* ../
  cd -
}

__die() {
  local rc=$1; shift
  printf 1>&2 '%s\n' "ERROR: $*"; exit $rc
}

__update_sources() {
  echo -e ">>> Args.... update is $update"
  cd /home/source/

  if [ -z "${branch}" ]
  then
    if [ ${stype} == "crack" ]
    then
      branch="cod/mainline/${kver}"
    else
      branch="${kver}"
    fi
  fi

  if [ "${update}" == "new" ]
  then
    [ "$(ls -A /home/source)" != "" ] && __die 1 "/home/source must be empty when using 'update=new'"
    if [ ${stype} == "crack" ]
    then
      echo -e "********\n\nFetching git source from Launchpad, branch: $branch\n\n********"
      git clone --depth 1 git://git.launchpad.net/~ubuntu-kernel-test/ubuntu/+source/linux/+git/mainline-crack \
        --branch "${branch}" /home/source --single-branch || __die 1 "Failed to checkout source from launchpad"
    else
      echo -e "********\n\nFetching git source from Kernel.org, branch: $branch\n\n********"
      git clone --depth 1 https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git \
        --branch "${branch}" /home/source --single-branch || __die 1 "Failed to checkout source from kernel.org"
    fi
  else
    echo -e "********\n\nCleaning git source tree\n\n********"
    git clean -fdx || __die 1 'git failed'
    git reset --hard HEAD
    if [ "$update" == "yes" ]
    then
      echo -e "********\n\nUpdating git source tree\n\n********"
      git fetch --tags origin
    fi
    echo -e "********\n\nSwitching to ${branch} branch\n\n********"
    git checkout "${branch}" || __die 1 "Tag for '${branch} not found"
  fi
}

__unbundle() {
  cd /home/source/
  wget "https://kernel.ubuntu.com/~kernel-ppa/mainline/${kver}/crack.bundle" || __die 1 "Failed to download bundle from ubuntu.com"
  git bundle verify crack.bundle || __die 1 "bundle will not apply"
  git bundle unbundle crack.bundle || __die 1 "Failed to unbundle"
  git checkout $(git bundle list-heads crack.bundle | grep "${kver}" | awk '{ print $1 }') || __die 1 "failed to checkout commit"
}

echo -e "********\n\nBuild starting\n\n********"

args=( "$@" );
for (( i=0; $i < $# ; i++ ))
do
  arg=${args[$i]}
  if [[ $arg = --*=* ]]
  then
    key=${arg#--}
    val=${key#*=}; key=${key%%=*}
    case "$key" in
      update|btype|shell|custom|sign|flavour|exclude|rename|patch|series|checkbugs|buildmeta|maintainer|debug|kver|metaver|metaonly|metatime|haverust|branch|bundle|stype|clean|rustup|dryrun)
        printf -v "$key" '%s' "$val" ;;
      *) __die 1 "Unknown flag $arg"
    esac
  else __die 1 "Bad arg $arg"
  fi
done

echo -e ">>> Args.... sign is $sign"
if [ "$sign" == "no" ]
then
  buildargs="$buildargs -uc -ui -us"
else
  buildargs="$buildargs -sa --sign-key=${sign}"
  cp -rp /root/keys /root/.gnupg
  chown -R root:root /root/.gnupg
  chmod 700 /root/.gnupg
fi

cd "$ksrc" || __die 1 "\$ksrc ${ksrc@Q} not found"

# tell git to trust /home/source
git config --global --add safe.directory /home/source

__update_sources

if [ "${bundle}" == "yes" ]
then
  __unbundle
fi

# install rust if requested
if [ "$rustup" == "yes" ]
then
  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
  /root/.cargo/bin/rustup override set $(scripts/min-tool-version.sh rustc)
  /root/.cargo/bin/rustup component add rust-src
  /root/.cargo/bin/cargo install --locked --version $(scripts/min-tool-version.sh bindgen) bindgen-cli
  cp /root/.cargo/bin/* /usr/local/bin
fi

# Apply patch if requested
echo -e ">>> Args.... patch is $patch"
if [ "$patch" != "no" ]
then
  echo -e "********\n\nDownloading and patching cod/mainline/${kver} to $patch\n\n********"
  if [[ "$patch" =~ v[0-9]+\.[0-9]+\.[0-9]* ]]
  then
    # apply patch
    curl -s https://cdn.kernel.org/pub/linux/kernel/${patch/.*/}.x/patch-${patch:1}.xz > /home/patch.xz
    ret=$?
    [ $ret -ne 0 ] && __die $ret "Failed to download patch. Code: $ret"
    xzcat /home/patch.xz |  patch -p1 --forward -r -
    ret=$?
    [ $ret -gt 1 ] && __die $ret "Patching failed. Code $ret"
    kver="$patch"
  else
    __die 1 "Patch version should be a kernel version, Eg v5.11.19"
  fi
fi

# prep
echo -e "********\n\nRenaming source package and updating control files\n\n********"
debversion=$(date +%Y%m%d%H%M)
abinum=$(echo ${kver:1} | awk -F. '{printf "%02d%02d%02d", $1,$2,$3 }')
echo -e ">>> Args.... rename is $rename"
if [ "$rename" == "yes" ]
then
  sed -i -re "s/(^linux) \(([0-9]+\.[0-9]+\.[0-9]+)-([^\.]*)\.[0-9]+\) ([^;]*)(.*)/linux-${kver:1} (${kver:1}-${abinum}.${debversion}) ${series}\5/" debian.master/changelog
  sed -i -re 's/SRCPKGNAME/linux/g' debian.master/control.stub.in
  sed -i -re 's/SRCPKGNAME/linux/g' debian.master/control.d/flavour-control.stub
  sed -i -re "s/Source: linux/Source: linux-${kver:1}/" debian.master/control.stub.in
  sed -i -re "s/^(Package:\s+)(linux(-cloud[-tools]*|-tools)(-common|-host))$/\1\2-PKGVER/" debian.master/control.stub.in
  sed -i -re "s/^(Depends:\s+.*, )(linux(-cloud[-tools]*|-tools)(-common|-host))$/\1\2-PKGVER/" debian.master/control.stub.in
  sed -i -re "s/indep_hdrs_pkg_name=[^-]*/indep_hdrs_pkg_name=linux/" debian/rules.d/0-common-vars.mk
  sed -i -re "s/rust_pkg_name=[^-]*/rust_pkg_name=linux/" debian/rules.d/0-common-vars.mk
else
  sed -i -re "s/(^linux) \(([0-9]+\.[0-9]+\.[0-9]+)-([0-9]+)\.[0-9]+\) ([^;]*)(.*)/linux (${kver:1}-${abinum}.${debversion}) ${series}\5/" debian.master/changelog
fi
sed -i -re 's/dwarves \[/dwarves (>=1.21) \[/g' debian.master/control.stub.in

# don't fail if we find no *.ko files in the build dir
sed -i -re 's/zstd -19 --quiet --rm/zstd -19 --rm || true/g' debian/rules.d/2-binary-arch.mk

# undo GCC-11 update in focal
echo -e ">>> Args.... series is $series"
if [ "$series" == "focal" ]
then
  echo -e ">>> Downgrade GCC to version 9 on focal"
  sed -i -re 's/export gcc\?=.*/export gcc?=gcc-9/' debian/rules.d/0-common-vars.mk
# revert GCC to v12 on Jammy
elif [ "$series" == "jammy" ]
then
  echo -e ">>> Downgrade GCC to version 12 on focal"
  sed -i -re 's/export gcc\?=.*/export gcc?=gcc-12/' debian/rules.d/0-common-vars.mk
fi

# Remove rust dependencies if $haverust is "no". Defaults to "no" on focal and "yes" on others.
echo -e ">>> Args.... haverust is $haverust"
if [ "$haverust" == "no" ]
then
  if [ "$abinum" -ge "060100" ]
  then
    echo -e ">>> Removing deps and disabling rust in kernel"
    sed -i -re 's/^ (rust|bindgen|clang|llvm)(.*)/#\1\2/g' debian.master/control.stub.in
    sed -i -re "s#CONFIG_HAVE_RUST.*#CONFIG_HAVE_RUST                                policy<{'amd64': 'n'}>#" debian.master/config/annotations
    sed -i -re "s#CONFIG_RUST_IS_AVAILABLE.*#CONFIG_RUST_IS_AVAILABLE                        policy<{'amd64': 'n'}>#" debian.master/config/annotations
  fi
fi

# force python3 to python3.9 in focal
if [ "$series" == "focal" ]
then
    echo -e ">>> Forcing python3.9 on focal"
    sed -i -re 's#PYTHON=python3#PYTHON=python3.9\nexport PATH=$(shell pwd)/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin#' debian/rules
    sed -i -re 's#dh_clean#dh_clean\n\n\trm -rf bin\n\tmkdir bin\n\tln -sf /usr/bin/python3.9 bin/python3\n\tenv\n\tpython3 --version\n#' debian/rules
    sed -i -re 's# python3-dev <!stage1>,# python3-dev <!stage1>,\n python3.9-dev <!stage1>,\n python3.9-minimal <!stage1>,#g' debian.master/control.stub.in
    sed -i -re 's#PYTHON3\s*=\s*python3#PYTHON3 = python3.9#' Makefile
fi

echo -e ">>> Args.... flavour is $flavour"
if [ "$flavour" != "none" ]
then
  echo -e "********\n\nSetting flavour: $flavour\n\n********"
  sed -i -re "s/(flavours\s+=).*/\1 $flavour/" debian.master/rules.d/amd64.mk
fi

echo -e ">>> Args.... exclude is $exclude"
if [ "$exclude" != "none" ]
then
  IFS=',' read -ra pkgs <<< "$exclude"
  for pkg in "${pkgs[@]}"
  do
    if [ "$pkg" == "cloud-tools" ]
    then
      sed -i -re "s/(do_tools_hyperv\s+=).*/\1 false/" debian.master/rules.d/amd64.mk
    elif [ "$pkg" == "tools" ]
    then
      # This doesn't work. We'll rename tools packages instead
      sed -i -re "s/^(do_tools_)((common|host)\s+=).*/\1\2 false/" debian.master/rules.d/amd64.mk
      echo "do_linux_tools  = false" >> debian.master/rules.d/amd64.mk
    elif [ "$pkg" == "udebs" ]
    then
      echo "disable_d_i     = true" >> debian.master/rules.d/amd64.mk
    fi
  done
fi

echo -e ">>> Args.... debug is $debug"
if [ "$debug" == yes ]
then
  echo -e "********\n\nEnabling Debug packages\n\n********\n"
  sed -i -re "s/skipdbg\s*=\s*true/skipdbg = false/g" debian/rules.d/0-common-vars.mk
fi

echo -e ">>> Args.... checkbugs is $checkbugs"
if [ "$checkbugs" == "yes" ]
then
  echo -e "********\n\nChecking for potential bugs\n\n********\n"
  if [ "$(cat debian/debian.env)" == "DEBIAN=debian.master" ]
  then
    echo ">>>  ---> debian.env bug == no"
  else
    echo ">>>  ---> debian.env bug == yes"
    echo "DEBIAN=debian.master" > debian/debian.env
  fi
fi

# Make lowlatency changes manually, the flavour was removed in 5.16.12 and newer
if [ "$flavour" = "lowlatency" -a ! -f debian.master/control.d/vars.lowlatency ]
then
  echo ">>> Recreating settings for defunct lowlatency flavour"
  cat debian.master/control.d/vars.generic | sed -e 's/Generic/Lowlatency/g' > debian.master/control.d/vars.lowlatency
  touch debian.master/config/amd64/config.flavour.lowlatency
  ./scripts/config --file debian.master/config/amd64/config.common.amd64 --disable COMEDI_TESTS_EXAMPLE
  ./scripts/config --file debian.master/config/amd64/config.common.amd64 --disable COMEDI_TESTS_NI_ROUTES
  ./scripts/config --file debian.master/config/amd64/config.common.amd64 --set-val CONFIG_HZ 1000
  ./scripts/config --file debian.master/config/amd64/config.common.amd64 --enable HZ_1000
  ./scripts/config --file debian.master/config/amd64/config.common.amd64 --disable HZ_250
  ./scripts/config --file debian.master/config/amd64/config.common.amd64 --enable LATENCYTOP
  ./scripts/config --file debian.master/config/amd64/config.common.amd64 --enable PREEMPT
  ./scripts/config --file debian.master/config/amd64/config.common.amd64 --disable PREEMPT_VOLUNTARY
  ./scripts/config --file debian.master/config/amd64/config.common.amd64 --set-val TEST_DIV64 m
fi

echo -e ">>> Args.... metaonly is $metaonly"
if [ "$metaonly" == "no" ]
then
  echo -e "********\n\nApplying default configs\n\n********"
  echo 'archs="amd64"' > debian.master/etc/kernelconfig
  fakeroot debian/rules clean defaultconfigs
  #fakeroot debian/rules importconfigs
  fakeroot debian/rules clean
fi

echo -e ">>> Args.... shell is $shell"
if [ "$shell" == "yes" ]
then
  echo -e "********\n\nPre-build shell, exit or ctrl-d to continue build\n\n********"
  bash
fi

echo -e ">>> Args.... custom is $custom"
if [ "$custom" == "yes" ]
then
  echo -e "********\n\nYou have asked for a custom build.\nYou will be given the chance to makemenuconfig next.\n\n********"
  read -p 'Press return to continue...' foo
  fakeroot debian/rules editconfigs
else
  if [ -x "/custom/${custom}-patch.sh" ]
  then
    echo -e "********\n\nYou have asked for a custom build.\nPatching source with /custom/${custom}-patch.sh\n\n********"
    /custom/${custom}-patch.sh
    read -p 'Press return to continue...' foo
    fakeroot debian/rules editconfigs
  fi
fi

# Build
if [ "$metaonly" == "no" ]
then
  echo -e "********\n\nBuilding packages\nCommand: dpkg-buildpackage --build=$btype $buildargs\n\n********"
  if [ "$dryrun" == "no" ]
  then
    dpkg-buildpackage --build=$btype $buildargs
  fi
fi

echo -e "********\n\nBuilding meta package\n\n********"
echo -e ">>> Args.... buildmeta is $buildmeta"
if [ "$buildmeta" == "yes" ]
then
  if [ "$dryrun" == "yes" ]
  then
    echo -e "********\n\nDry-run\nCommand: dpkg-buildpackage --build=$btype $buildargs"
    echo "do_metapackage "${kver:1}" "${metaver}" "${metatime}" "generic" "$series" "$maintainer" "$abinum" "$btype""
    echo "dry-run shell"
    bash
  elif [ "$flavour" == "none" ]
  then
    echo ">>> Building generic metapackage"
    do_metapackage "${kver:1}" "${metaver}" "${metatime}" "generic" "$series" "$maintainer" "$abinum" "$btype"
    if [ -f debian.master/control.d/vars.lowlatency ]
    then
      echo ">>> Building lowlatency metapackage"
      do_metapackage "${kver:1}" "${metaver}" "${metatime}" "lowlatency" "$series" "$maintainer" "$abinum" "$btype"
    fi
  else
    echo ">>> Building $flavour metapackage"
    do_metapackage "${kver:1}" "${metaver}" "${metatime}" "$flavour" "$series" "$maintainer" "$abinum" "$btype"
  fi
fi

echo -e "********\n\nMoving packages to debs folder\n\n********"
[ -d "$kdeb/$kver" ] || mkdir "$kdeb/$kver"
mv "$ksrc"/../*.* "$kdeb/$kver"

if [ "$shell" == "yes" ]
then
  echo -e "********\n\nPost-build shell, exit or ctrl-d to finish\n\n********"
  bash
fi

if [ "$clean" == "yes" ]
then
  echo -e "********\n\nRemoving git source tree\n\n********"
  rm -r /home/source/*
  rm -r /home/source/.[a-z]*
else
  echo -e "********\n\nCleaning git source tree\n\n********"
  git clean -fdx
  git reset --hard HEAD
fi