scripts/update-linux-headers.sh

   1 #!/bin/sh -e
   2 #
   3 # Update Linux kernel headers QEMU requires from a specified kernel tree.
   4 #
   5 # Copyright (C) 2011 Siemens AG
   6 #
   7 # Authors:
   8 #  Jan Kiszka        <jan.kiszka@siemens.com>
   9 #
  10 # This work is licensed under the terms of the GNU GPL version 2.
  11 # See the COPYING file in the top-level directory.
  12 #
  13 # The script will copy the headers into two target folders:
  14 #
  15 # - linux-headers/ for files that are required for compiling for a
  16 #   Linux host.  Generally we have these so we can use kernel structs
  17 #   and defines that are more recent than the headers that might be
  18 #   installed on the host system.  Usually this script can do simple
  19 #   file copies for these headers.
  20 #
  21 # - include/standard-headers/ for files that are used for guest
  22 #   device emulation and are required on all hosts.  For instance, we
  23 #   get our definitions of the virtio structures from the Linux
  24 #   kernel headers, but we need those definitions regardless of which
  25 #   host OS we are building for.  This script has to be careful to
  26 #   sanitize the headers to remove any use of Linux-specifics such as
  27 #   types like "__u64".  This work is done in the cp_portable function.
  28
  29 tmpdir=$(mktemp -d)
  30 hdrdir="$tmpdir/headers"
  31 blddir="$tmpdir/build"
  32 linux="$1"
  33 output="$2"
  34
  35 if [ -z "$linux" ] || ! [ -d "$linux" ]; then
  36     cat << EOF
  37 usage: update-kernel-headers.sh LINUX_PATH [OUTPUT_PATH]
  38
  39 LINUX_PATH      Linux kernel directory to obtain the headers from
  40 OUTPUT_PATH     output directory, usually the qemu source tree (default: $PWD)
  41 EOF
  42     exit 1
  43 fi
  44
  45 if [ -z "$output" ]; then
  46     output="$PWD"
  47 fi
  48
  49 cp_portable() {
  50     f=$1
  51     to=$2
  52     if
  53         grep '#include' "$f" | grep -v -e 'linux/virtio' \
  54                                      -e 'linux/types' \
  55                                      -e 'linux/ioctl' \
  56                                      -e 'stdint' \
  57                                      -e 'linux/if_ether' \
  58                                      -e 'input-event-codes' \
  59                                      -e 'sys/' \
  60                                      -e 'drm.h' \
  61                                      -e 'limits' \
  62                                      -e 'linux/const' \
  63                                      -e 'linux/kernel' \
  64                                      -e 'linux/sysinfo' \
  65                                      -e 'asm/setup_data.h' \
  66                                      -e 'asm/kvm_para.h' \
  67                                      > /dev/null
  68     then
  69         echo "Unexpected #include in input file $f".
  70         exit 2
  71     fi
  72
  73     header=$(basename "$f");
  74
  75     if test -z "$arch"; then
  76         # Let users of include/standard-headers/linux/ headers pick the
  77         # asm-* header that they care about
  78         arch_cmd='/<asm\/\([^>]*\)>/d'
  79     else
  80         arch_cmd='s/<asm\/\([^>]*\)>/"standard-headers\/asm-'$arch'\/\1"/'
  81     fi
  82
  83     sed -e 's/__aligned_u64/__u64 __attribute__((aligned(8)))/g' \
  84         -e 's/__u\([0-9][0-9]*\)/uint\1_t/g' \
  85         -e 's/u\([0-9][0-9]*\)/uint\1_t/g' \
  86         -e 's/__s\([0-9][0-9]*\)/int\1_t/g' \
  87         -e 's/__le\([0-9][0-9]*\)/uint\1_t/g' \
  88         -e 's/__be\([0-9][0-9]*\)/uint\1_t/g' \
  89         -e 's/"\(input-event-codes\.h\)"/"standard-headers\/linux\/\1"/' \
  90         -e 's/<linux\/\([^>]*\)>/"standard-headers\/linux\/\1"/' \
  91         -e "$arch_cmd" \
  92         -e 's/__bitwise//' \
  93         -e 's/__attribute__((packed))/QEMU_PACKED/' \
  94         -e 's/__inline__/inline/' \
  95         -e 's/__BITS_PER_LONG/HOST_LONG_BITS/' \
  96         -e '/\"drm.h\"/d' \
  97         -e '/sys\/ioctl.h/d' \
  98         -e '/linux\/ioctl.h/d' \
  99         -e 's/SW_MAX/SW_MAX_/' \
 100         -e 's/atomic_t/int/' \
 101         -e 's/__kernel_long_t/long/' \
 102         -e 's/__kernel_ulong_t/unsigned long/' \
 103         -e 's/struct ethhdr/struct eth_header/' \
 104         -e '/\#define _LINUX_ETHTOOL_H/a \\n\#include "net/eth.h"' \
 105         "$f" > "$to/$header";
 106 }
 107
 108 # This will pick up non-directories too (eg "Kconfig") but we will
 109 # ignore them in the next loop.
 110 ARCHLIST=$(cd "$linux/arch" && echo *)
 111
 112 for arch in $ARCHLIST; do
 113     # Discard anything which isn't a KVM-supporting architecture
 114     if ! [ -e "$linux/arch/$arch/include/asm/kvm.h" ] &&
 115         ! [ -e "$linux/arch/$arch/include/uapi/asm/kvm.h" ] ; then
 116         continue
 117     fi
 118
 119     if [ "$arch" = x86 ]; then
 120         arch_var=SRCARCH
 121     else
 122         arch_var=ARCH
 123     fi
 124
 125     rm -rf "$hdrdir"
 126     make -C "$linux" O="$blddir" INSTALL_HDR_PATH="$hdrdir" $arch_var=$arch headers_install
 127
 128     rm -rf "$output/linux-headers/asm-$arch"
 129     mkdir -p "$output/linux-headers/asm-$arch"
 130     for header in kvm.h unistd.h bitsperlong.h mman.h; do
 131         if test -f "$hdrdir/include/asm/$header"; then
 132             cp "$hdrdir/include/asm/$header" "$output/linux-headers/asm-$arch"
 133         elif test -f "$hdrdir/include/asm-generic/$header"; then
 134             # not installed as <asm/$header>, but used as such in kernel sources
 135             cat <<EOF >$output/linux-headers/asm-$arch/$header
 136 #include <asm-generic/$header>
 137 EOF
 138         fi
 139     done
 140
 141     if [ $arch = mips ]; then
 142         cp "$hdrdir/include/asm/sgidefs.h" "$output/linux-headers/asm-mips/"
 143         cp "$hdrdir/include/asm/unistd_o32.h" "$output/linux-headers/asm-mips/"
 144         cp "$hdrdir/include/asm/unistd_n32.h" "$output/linux-headers/asm-mips/"
 145         cp "$hdrdir/include/asm/unistd_n64.h" "$output/linux-headers/asm-mips/"
 146     fi
 147     if [ $arch = powerpc ]; then
 148         cp "$hdrdir/include/asm/unistd_32.h" "$output/linux-headers/asm-powerpc/"
 149         cp "$hdrdir/include/asm/unistd_64.h" "$output/linux-headers/asm-powerpc/"
 150     fi
 151
 152     rm -rf "$output/include/standard-headers/asm-$arch"
 153     mkdir -p "$output/include/standard-headers/asm-$arch"
 154     if [ $arch = s390 ]; then
 155         cp_portable "$hdrdir/include/asm/virtio-ccw.h" "$output/include/standard-headers/asm-s390/"
 156         cp "$hdrdir/include/asm/unistd_32.h" "$output/linux-headers/asm-s390/"
 157         cp "$hdrdir/include/asm/unistd_64.h" "$output/linux-headers/asm-s390/"
 158     fi
 159     if [ $arch = arm ]; then
 160         cp "$hdrdir/include/asm/unistd-eabi.h" "$output/linux-headers/asm-arm/"
 161         cp "$hdrdir/include/asm/unistd-oabi.h" "$output/linux-headers/asm-arm/"
 162         cp "$hdrdir/include/asm/unistd-common.h" "$output/linux-headers/asm-arm/"
 163     fi
 164     if [ $arch = arm64 ]; then
 165         cp "$hdrdir/include/asm/sve_context.h" "$output/linux-headers/asm-arm64/"
 166     fi
 167     if [ $arch = x86 ]; then
 168         cp "$hdrdir/include/asm/unistd_32.h" "$output/linux-headers/asm-x86/"
 169         cp "$hdrdir/include/asm/unistd_x32.h" "$output/linux-headers/asm-x86/"
 170         cp "$hdrdir/include/asm/unistd_64.h" "$output/linux-headers/asm-x86/"
 171
 172         cp_portable "$hdrdir/include/asm/kvm_para.h" "$output/include/standard-headers/asm-$arch"
 173         cat <<EOF >$output/linux-headers/asm-$arch/kvm_para.h
 174 #include "standard-headers/asm-$arch/kvm_para.h"
 175 EOF
 176
 177         # Remove everything except the macros from bootparam.h avoiding the
 178         # unnecessary import of several video/ist/etc headers
 179         sed -e '/__ASSEMBLY__/,/__ASSEMBLY__/d' \
 180                "$hdrdir/include/asm/bootparam.h" > "$hdrdir/bootparam.h"
 181         cp_portable "$hdrdir/bootparam.h" \
 182                     "$output/include/standard-headers/asm-$arch"
 183         cp_portable "$hdrdir/include/asm/setup_data.h" \
 184                     "$output/include/standard-headers/asm-x86"
 185     fi
 186     if [ $arch = riscv ]; then
 187         cp "$hdrdir/include/asm/ptrace.h" "$output/linux-headers/asm-riscv/"
 188     fi
 189 done
 190 arch=
 191
 192 rm -rf "$output/linux-headers/linux"
 193 mkdir -p "$output/linux-headers/linux"
 194 for header in const.h stddef.h kvm.h vfio.h vfio_ccw.h vfio_zdev.h vhost.h \
 195               psci.h psp-sev.h userfaultfd.h memfd.h mman.h nvme_ioctl.h \
 196               vduse.h iommufd.h bits.h; do
 197     cp "$hdrdir/include/linux/$header" "$output/linux-headers/linux"
 198 done
 199
 200 rm -rf "$output/linux-headers/asm-generic"
 201 mkdir -p "$output/linux-headers/asm-generic"
 202 for header in unistd.h bitsperlong.h mman-common.h mman.h hugetlb_encode.h; do
 203     cp "$hdrdir/include/asm-generic/$header" "$output/linux-headers/asm-generic"
 204 done
 205
 206 if [ -L "$linux/source" ]; then
 207     cp "$linux/source/COPYING" "$output/linux-headers"
 208 else
 209     cp "$linux/COPYING" "$output/linux-headers"
 210 fi
 211
 212 # Recent kernel sources split the copyright/license info into multiple
 213 # files, which we need to copy. This set of licenses is the set that
 214 # are referred to by SPDX lines in the headers we currently copy.
 215 # We don't copy the Documentation/process/license-rules.rst which
 216 # is also referred to by COPYING, since it's explanatory rather than license.
 217 if [ -d "$linux/LICENSES" ]; then
 218     mkdir -p "$output/linux-headers/LICENSES/preferred" \
 219              "$output/linux-headers/LICENSES/exceptions"
 220     for l in preferred/GPL-2.0 preferred/BSD-2-Clause preferred/BSD-3-Clause \
 221              exceptions/Linux-syscall-note; do
 222         cp "$linux/LICENSES/$l" "$output/linux-headers/LICENSES/$l"
 223     done
 224 fi
 225
 226 cat <<EOF >$output/linux-headers/linux/kvm_para.h
 227 #include "standard-headers/linux/kvm_para.h"
 228 #include <asm/kvm_para.h>
 229 EOF
 230 cat <<EOF >$output/linux-headers/linux/virtio_config.h
 231 #include "standard-headers/linux/virtio_config.h"
 232 EOF
 233 cat <<EOF >$output/linux-headers/linux/virtio_ring.h
 234 #include "standard-headers/linux/virtio_ring.h"
 235 EOF
 236 cat <<EOF >$output/linux-headers/linux/vhost_types.h
 237 #include "standard-headers/linux/vhost_types.h"
 238 EOF
 239
 240 rm -rf "$output/include/standard-headers/linux"
 241 mkdir -p "$output/include/standard-headers/linux"
 242 for i in "$hdrdir"/include/linux/*virtio*.h \
 243          "$hdrdir/include/linux/qemu_fw_cfg.h" \
 244          "$hdrdir/include/linux/fuse.h" \
 245          "$hdrdir/include/linux/input.h" \
 246          "$hdrdir/include/linux/input-event-codes.h" \
 247          "$hdrdir/include/linux/udmabuf.h" \
 248          "$hdrdir/include/linux/pci_regs.h" \
 249          "$hdrdir/include/linux/ethtool.h" \
 250          "$hdrdir/include/linux/const.h" \
 251          "$hdrdir/include/linux/kernel.h" \
 252          "$hdrdir/include/linux/kvm_para.h" \
 253          "$hdrdir/include/linux/vhost_types.h" \
 254          "$hdrdir/include/linux/sysinfo.h"; do
 255     cp_portable "$i" "$output/include/standard-headers/linux"
 256 done
 257 mkdir -p "$output/include/standard-headers/misc"
 258 cp_portable "$hdrdir/include/misc/pvpanic.h" \
 259             "$output/include/standard-headers/misc"
 260 mkdir -p "$output/include/standard-headers/drm"
 261 cp_portable "$hdrdir/include/drm/drm_fourcc.h" \
 262             "$output/include/standard-headers/drm"
 263
 264 cat <<EOF >$output/include/standard-headers/linux/types.h
 265 /* For QEMU all types are already defined via osdep.h, so this
 266  * header does not need to do anything.
 267  */
 268 EOF
 269 cat <<EOF >$output/include/standard-headers/linux/if_ether.h
 270 #define ETH_ALEN    6
 271 EOF
 272
 273 rm -rf "$tmpdir"