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