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