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