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 tmpdir=$(mktemp -d)
  14 linux="$1"
  15 output="$2"
  16
  17 if [ -z "$linux" ] || ! [ -d "$linux" ]; then
  18     cat << EOF
  19 usage: update-kernel-headers.sh LINUX_PATH [OUTPUT_PATH]
  20
  21 LINUX_PATH      Linux kernel directory to obtain the headers from
  22 OUTPUT_PATH     output directory, usually the qemu source tree (default: $PWD)
  23 EOF
  24     exit 1
  25 fi
  26
  27 if [ -z "$output" ]; then
  28     output="$PWD"
  29 fi
  30
  31 cp_portable() {
  32     f=$1
  33     to=$2
  34     if
  35         grep '#include' "$f" | grep -v -e 'linux/virtio' \
  36                                      -e 'linux/types' \
  37                                      -e 'linux/ioctl' \
  38                                      -e 'stdint' \
  39                                      -e 'linux/if_ether' \
  40                                      -e 'input-event-codes' \
  41                                      -e 'sys/' \
  42                                      -e 'pvrdma_verbs' \
  43                                      -e 'drm.h' \
  44                                      -e 'limits' \
  45                                      -e 'linux/const' \
  46                                      -e 'linux/kernel' \
  47                                      -e 'linux/sysinfo' \
  48                                      -e 'asm-generic/kvm_para' \
  49                                      > /dev/null
  50     then
  51         echo "Unexpected #include in input file $f".
  52         exit 2
  53     fi
  54
  55     header=$(basename "$f");
  56     sed -e 's/__aligned_u64/__u64 __attribute__((aligned(8)))/g' \
  57         -e 's/__u\([0-9][0-9]*\)/uint\1_t/g' \
  58         -e 's/u\([0-9][0-9]*\)/uint\1_t/g' \
  59         -e 's/__s\([0-9][0-9]*\)/int\1_t/g' \
  60         -e 's/__le\([0-9][0-9]*\)/uint\1_t/g' \
  61         -e 's/__be\([0-9][0-9]*\)/uint\1_t/g' \
  62         -e 's/"\(input-event-codes\.h\)"/"standard-headers\/linux\/\1"/' \
  63         -e 's/<linux\/\([^>]*\)>/"standard-headers\/linux\/\1"/' \
  64         -e 's/__bitwise//' \
  65         -e 's/__attribute__((packed))/QEMU_PACKED/' \
  66         -e 's/__inline__/inline/' \
  67         -e 's/__BITS_PER_LONG/HOST_LONG_BITS/' \
  68         -e '/\"drm.h\"/d' \
  69         -e '/sys\/ioctl.h/d' \
  70         -e '/linux\/ioctl.h/d' \
  71         -e 's/SW_MAX/SW_MAX_/' \
  72         -e 's/atomic_t/int/' \
  73         -e 's/__kernel_long_t/long/' \
  74         -e 's/__kernel_ulong_t/unsigned long/' \
  75         -e 's/struct ethhdr/struct eth_header/' \
  76         -e '/\#define _LINUX_ETHTOOL_H/a \\n\#include "net/eth.h"' \
  77         "$f" > "$to/$header";
  78 }
  79
  80 # This will pick up non-directories too (eg "Kconfig") but we will
  81 # ignore them in the next loop.
  82 ARCHLIST=$(cd "$linux/arch" && echo *)
  83
  84 for arch in $ARCHLIST; do
  85     # Discard anything which isn't a KVM-supporting architecture
  86     if ! [ -e "$linux/arch/$arch/include/asm/kvm.h" ] &&
  87         ! [ -e "$linux/arch/$arch/include/uapi/asm/kvm.h" ] ; then
  88         continue
  89     fi
  90
  91     if [ "$arch" = x86 ]; then
  92         arch_var=SRCARCH
  93     else
  94         arch_var=ARCH
  95     fi
  96
  97     make -C "$linux" INSTALL_HDR_PATH="$tmpdir" $arch_var=$arch headers_install
  98
  99     rm -rf "$output/linux-headers/asm-$arch"
 100     mkdir -p "$output/linux-headers/asm-$arch"
 101     for header in kvm.h unistd.h bitsperlong.h mman.h; do
 102         cp "$tmpdir/include/asm/$header" "$output/linux-headers/asm-$arch"
 103     done
 104
 105     if [ $arch = mips ]; then
 106         cp "$tmpdir/include/asm/sgidefs.h" "$output/linux-headers/asm-mips/"
 107         cp "$tmpdir/include/asm/unistd_o32.h" "$output/linux-headers/asm-mips/"
 108         cp "$tmpdir/include/asm/unistd_n32.h" "$output/linux-headers/asm-mips/"
 109         cp "$tmpdir/include/asm/unistd_n64.h" "$output/linux-headers/asm-mips/"
 110     fi
 111     if [ $arch = powerpc ]; then
 112         cp "$tmpdir/include/asm/unistd_32.h" "$output/linux-headers/asm-powerpc/"
 113         cp "$tmpdir/include/asm/unistd_64.h" "$output/linux-headers/asm-powerpc/"
 114     fi
 115
 116     rm -rf "$output/include/standard-headers/asm-$arch"
 117     mkdir -p "$output/include/standard-headers/asm-$arch"
 118     if [ $arch = s390 ]; then
 119         cp_portable "$tmpdir/include/asm/virtio-ccw.h" "$output/include/standard-headers/asm-s390/"
 120         cp "$tmpdir/include/asm/unistd_32.h" "$output/linux-headers/asm-s390/"
 121         cp "$tmpdir/include/asm/unistd_64.h" "$output/linux-headers/asm-s390/"
 122     fi
 123     if [ $arch = arm ]; then
 124         cp "$tmpdir/include/asm/unistd-eabi.h" "$output/linux-headers/asm-arm/"
 125         cp "$tmpdir/include/asm/unistd-oabi.h" "$output/linux-headers/asm-arm/"
 126         cp "$tmpdir/include/asm/unistd-common.h" "$output/linux-headers/asm-arm/"
 127     fi
 128     if [ $arch = arm64 ]; then
 129         cp "$tmpdir/include/asm/sve_context.h" "$output/linux-headers/asm-arm64/"
 130     fi
 131     if [ $arch = x86 ]; then
 132         cp "$tmpdir/include/asm/unistd_32.h" "$output/linux-headers/asm-x86/"
 133         cp "$tmpdir/include/asm/unistd_x32.h" "$output/linux-headers/asm-x86/"
 134         cp "$tmpdir/include/asm/unistd_64.h" "$output/linux-headers/asm-x86/"
 135         cp_portable "$tmpdir/include/asm/kvm_para.h" "$output/include/standard-headers/asm-$arch"
 136         # Remove everything except the macros from bootparam.h avoiding the
 137         # unnecessary import of several video/ist/etc headers
 138         sed -e '/__ASSEMBLY__/,/__ASSEMBLY__/d' \
 139                "$tmpdir/include/asm/bootparam.h" > "$tmpdir/bootparam.h"
 140         cp_portable "$tmpdir/bootparam.h" \
 141                     "$output/include/standard-headers/asm-$arch"
 142     fi
 143 done
 144
 145 rm -rf "$output/linux-headers/linux"
 146 mkdir -p "$output/linux-headers/linux"
 147 for header in kvm.h vfio.h vfio_ccw.h vfio_zdev.h vhost.h \
 148               psci.h psp-sev.h userfaultfd.h mman.h; do
 149     cp "$tmpdir/include/linux/$header" "$output/linux-headers/linux"
 150 done
 151
 152 rm -rf "$output/linux-headers/asm-generic"
 153 mkdir -p "$output/linux-headers/asm-generic"
 154 for header in unistd.h bitsperlong.h mman-common.h mman.h hugetlb_encode.h; do
 155     cp "$tmpdir/include/asm-generic/$header" "$output/linux-headers/asm-generic"
 156 done
 157
 158 if [ -L "$linux/source" ]; then
 159     cp "$linux/source/COPYING" "$output/linux-headers"
 160 else
 161     cp "$linux/COPYING" "$output/linux-headers"
 162 fi
 163
 164 # Recent kernel sources split the copyright/license info into multiple
 165 # files, which we need to copy. This set of licenses is the set that
 166 # are referred to by SPDX lines in the headers we currently copy.
 167 # We don't copy the Documentation/process/license-rules.rst which
 168 # is also referred to by COPYING, since it's explanatory rather than license.
 169 if [ -d "$linux/LICENSES" ]; then
 170     mkdir -p "$output/linux-headers/LICENSES/preferred" \
 171              "$output/linux-headers/LICENSES/exceptions"
 172     for l in preferred/GPL-2.0 preferred/BSD-2-Clause preferred/BSD-3-Clause \
 173              exceptions/Linux-syscall-note; do
 174         cp "$linux/LICENSES/$l" "$output/linux-headers/LICENSES/$l"
 175     done
 176 fi
 177
 178 cat <<EOF >$output/linux-headers/linux/virtio_config.h
 179 #include "standard-headers/linux/virtio_config.h"
 180 EOF
 181 cat <<EOF >$output/linux-headers/linux/virtio_ring.h
 182 #include "standard-headers/linux/virtio_ring.h"
 183 EOF
 184 cat <<EOF >$output/linux-headers/linux/vhost_types.h
 185 #include "standard-headers/linux/vhost_types.h"
 186 EOF
 187
 188 rm -rf "$output/include/standard-headers/linux"
 189 mkdir -p "$output/include/standard-headers/linux"
 190 for i in "$tmpdir"/include/linux/*virtio*.h \
 191          "$tmpdir/include/linux/qemu_fw_cfg.h" \
 192          "$tmpdir/include/linux/fuse.h" \
 193          "$tmpdir/include/linux/input.h" \
 194          "$tmpdir/include/linux/input-event-codes.h" \
 195          "$tmpdir/include/linux/udmabuf.h" \
 196          "$tmpdir/include/linux/pci_regs.h" \
 197          "$tmpdir/include/linux/ethtool.h" \
 198          "$tmpdir/include/linux/const.h" \
 199          "$tmpdir/include/linux/kernel.h" \
 200          "$tmpdir/include/linux/vhost_types.h" \
 201          "$tmpdir/include/linux/sysinfo.h"; do
 202     cp_portable "$i" "$output/include/standard-headers/linux"
 203 done
 204 mkdir -p "$output/include/standard-headers/drm"
 205 cp_portable "$tmpdir/include/drm/drm_fourcc.h" \
 206             "$output/include/standard-headers/drm"
 207
 208 rm -rf "$output/include/standard-headers/drivers/infiniband/hw/vmw_pvrdma"
 209 mkdir -p "$output/include/standard-headers/drivers/infiniband/hw/vmw_pvrdma"
 210
 211 # Remove the unused functions from pvrdma_verbs.h avoiding the unnecessary
 212 # import of several infiniband/networking/other headers
 213 tmp_pvrdma_verbs="$tmpdir/pvrdma_verbs.h"
 214 # Parse the entire file instead of single lines to match
 215 # function declarations expanding over multiple lines
 216 # and strip the declarations starting with pvrdma prefix.
 217 sed  -e '1h;2,$H;$!d;g'  -e 's/[^};]*pvrdma[^(| ]*([^)]*);//g' \
 218     "$linux/drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.h" > \
 219     "$tmp_pvrdma_verbs";
 220
 221 for i in "$linux/drivers/infiniband/hw/vmw_pvrdma/pvrdma_dev_api.h" \
 222          "$tmp_pvrdma_verbs"; do \
 223     cp_portable "$i" \
 224          "$output/include/standard-headers/drivers/infiniband/hw/vmw_pvrdma/"
 225 done
 226
 227 rm -rf "$output/include/standard-headers/rdma/"
 228 mkdir -p "$output/include/standard-headers/rdma/"
 229 for i in "$tmpdir/include/rdma/vmw_pvrdma-abi.h"; do
 230     cp_portable "$i" \
 231          "$output/include/standard-headers/rdma/"
 232 done
 233
 234 cat <<EOF >$output/include/standard-headers/linux/types.h
 235 /* For QEMU all types are already defined via osdep.h, so this
 236  * header does not need to do anything.
 237  */
 238 EOF
 239 cat <<EOF >$output/include/standard-headers/linux/if_ether.h
 240 #define ETH_ALEN    6
 241 EOF
 242
 243 rm -rf "$tmpdir"