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