scripts/qemu.py: use a more consistent docstring style
[qemu/ar7.git] / scripts / update-linux-headers.sh
blob0a964fe240db30459eee3c7ecc0e16b2f1f5cd2e
1 #!/bin/sh -e
3 # Update Linux kernel headers QEMU requires from a specified kernel tree.
5 # Copyright (C) 2011 Siemens AG
7 # Authors:
8 # Jan Kiszka <jan.kiszka@siemens.com>
10 # This work is licensed under the terms of the GNU GPL version 2.
11 # See the COPYING file in the top-level directory.
13 tmpdir=$(mktemp -d)
14 linux="$1"
15 output="$2"
17 if [ -z "$linux" ] || ! [ -d "$linux" ]; then
18 cat << EOF
19 usage: update-kernel-headers.sh LINUX_PATH [OUTPUT_PATH]
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
27 if [ -z "$output" ]; then
28 output="$PWD"
31 cp_portable() {
32 f=$1
33 to=$2
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/kernel' \
45 -e 'linux/sysinfo' \
46 -e 'asm-generic/kvm_para' \
47 > /dev/null
48 then
49 echo "Unexpected #include in input file $f".
50 exit 2
53 header=$(basename "$f");
54 sed -e 's/__aligned_u64/__u64 __attribute__((aligned(8)))/g' \
55 -e 's/__u\([0-9][0-9]*\)/uint\1_t/g' \
56 -e 's/u\([0-9][0-9]*\)/uint\1_t/g' \
57 -e 's/__s\([0-9][0-9]*\)/int\1_t/g' \
58 -e 's/__le\([0-9][0-9]*\)/uint\1_t/g' \
59 -e 's/__be\([0-9][0-9]*\)/uint\1_t/g' \
60 -e 's/"\(input-event-codes\.h\)"/"standard-headers\/linux\/\1"/' \
61 -e 's/<linux\/\([^>]*\)>/"standard-headers\/linux\/\1"/' \
62 -e 's/__bitwise//' \
63 -e 's/__attribute__((packed))/QEMU_PACKED/' \
64 -e 's/__inline__/inline/' \
65 -e 's/__BITS_PER_LONG/HOST_LONG_BITS/' \
66 -e '/\"drm.h\"/d' \
67 -e '/sys\/ioctl.h/d' \
68 -e 's/SW_MAX/SW_MAX_/' \
69 -e 's/atomic_t/int/' \
70 -e 's/__kernel_long_t/long/' \
71 -e 's/__kernel_ulong_t/unsigned long/' \
72 -e 's/struct ethhdr/struct eth_header/' \
73 -e '/\#define _LINUX_ETHTOOL_H/a \\n\#include "net/eth.h"' \
74 "$f" > "$to/$header";
77 # This will pick up non-directories too (eg "Kconfig") but we will
78 # ignore them in the next loop.
79 ARCHLIST=$(cd "$linux/arch" && echo *)
81 for arch in $ARCHLIST; do
82 # Discard anything which isn't a KVM-supporting architecture
83 if ! [ -e "$linux/arch/$arch/include/asm/kvm.h" ] &&
84 ! [ -e "$linux/arch/$arch/include/uapi/asm/kvm.h" ] ; then
85 continue
88 if [ "$arch" = x86 ]; then
89 arch_var=SRCARCH
90 else
91 arch_var=ARCH
94 make -C "$linux" INSTALL_HDR_PATH="$tmpdir" $arch_var=$arch headers_install
96 rm -rf "$output/linux-headers/asm-$arch"
97 mkdir -p "$output/linux-headers/asm-$arch"
98 for header in kvm.h unistd.h bitsperlong.h; do
99 cp "$tmpdir/include/asm/$header" "$output/linux-headers/asm-$arch"
100 done
102 if [ $arch = mips ]; then
103 cp "$tmpdir/include/asm/sgidefs.h" "$output/linux-headers/asm-mips/"
106 rm -rf "$output/include/standard-headers/asm-$arch"
107 mkdir -p "$output/include/standard-headers/asm-$arch"
108 if [ $arch = s390 ]; then
109 cp_portable "$tmpdir/include/asm/virtio-ccw.h" "$output/include/standard-headers/asm-s390/"
110 cp "$tmpdir/include/asm/unistd_32.h" "$output/linux-headers/asm-s390/"
111 cp "$tmpdir/include/asm/unistd_64.h" "$output/linux-headers/asm-s390/"
113 if [ $arch = arm ]; then
114 cp "$tmpdir/include/asm/unistd-eabi.h" "$output/linux-headers/asm-arm/"
115 cp "$tmpdir/include/asm/unistd-oabi.h" "$output/linux-headers/asm-arm/"
116 cp "$tmpdir/include/asm/unistd-common.h" "$output/linux-headers/asm-arm/"
118 if [ $arch = x86 ]; then
119 cp "$tmpdir/include/asm/unistd_32.h" "$output/linux-headers/asm-x86/"
120 cp "$tmpdir/include/asm/unistd_x32.h" "$output/linux-headers/asm-x86/"
121 cp "$tmpdir/include/asm/unistd_64.h" "$output/linux-headers/asm-x86/"
122 cp_portable "$tmpdir/include/asm/kvm_para.h" "$output/include/standard-headers/asm-$arch"
124 done
126 rm -rf "$output/linux-headers/linux"
127 mkdir -p "$output/linux-headers/linux"
128 for header in kvm.h vfio.h vfio_ccw.h vhost.h \
129 psci.h psp-sev.h userfaultfd.h; do
130 cp "$tmpdir/include/linux/$header" "$output/linux-headers/linux"
131 done
133 rm -rf "$output/linux-headers/asm-generic"
134 mkdir -p "$output/linux-headers/asm-generic"
135 for header in unistd.h bitsperlong.h; do
136 cp "$tmpdir/include/asm-generic/$header" "$output/linux-headers/asm-generic"
137 done
139 if [ -L "$linux/source" ]; then
140 cp "$linux/source/COPYING" "$output/linux-headers"
141 else
142 cp "$linux/COPYING" "$output/linux-headers"
145 # Recent kernel sources split the copyright/license info into multiple
146 # files, which we need to copy. This set of licenses is the set that
147 # are referred to by SPDX lines in the headers we currently copy.
148 # We don't copy the Documentation/process/license-rules.rst which
149 # is also referred to by COPYING, since it's explanatory rather than license.
150 if [ -d "$linux/LICENSES" ]; then
151 mkdir -p "$output/linux-headers/LICENSES/preferred" \
152 "$output/linux-headers/LICENSES/exceptions"
153 for l in preferred/GPL-2.0 preferred/BSD-2-Clause preferred/BSD-3-Clause \
154 exceptions/Linux-syscall-note; do
155 cp "$linux/LICENSES/$l" "$output/linux-headers/LICENSES/$l"
156 done
159 cat <<EOF >$output/linux-headers/linux/virtio_config.h
160 #include "standard-headers/linux/virtio_config.h"
162 cat <<EOF >$output/linux-headers/linux/virtio_ring.h
163 #include "standard-headers/linux/virtio_ring.h"
166 rm -rf "$output/include/standard-headers/linux"
167 mkdir -p "$output/include/standard-headers/linux"
168 for i in "$tmpdir"/include/linux/*virtio*.h \
169 "$tmpdir/include/linux/qemu_fw_cfg.h" \
170 "$tmpdir/include/linux/input.h" \
171 "$tmpdir/include/linux/input-event-codes.h" \
172 "$tmpdir/include/linux/pci_regs.h" \
173 "$tmpdir/include/linux/ethtool.h" "$tmpdir/include/linux/kernel.h" \
174 "$tmpdir/include/linux/sysinfo.h"; do
175 cp_portable "$i" "$output/include/standard-headers/linux"
176 done
177 mkdir -p "$output/include/standard-headers/drm"
178 cp_portable "$tmpdir/include/drm/drm_fourcc.h" \
179 "$output/include/standard-headers/drm"
181 rm -rf "$output/include/standard-headers/drivers/infiniband/hw/vmw_pvrdma"
182 mkdir -p "$output/include/standard-headers/drivers/infiniband/hw/vmw_pvrdma"
184 # Remove the unused functions from pvrdma_verbs.h avoiding the unnecessary
185 # import of several infiniband/networking/other headers
186 tmp_pvrdma_verbs="$tmpdir/pvrdma_verbs.h"
187 # Parse the entire file instead of single lines to match
188 # function declarations expanding over multiple lines
189 # and strip the declarations starting with pvrdma prefix.
190 sed -e '1h;2,$H;$!d;g' -e 's/[^};]*pvrdma[^(| ]*([^)]*);//g' \
191 "$linux/drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.h" > \
192 "$tmp_pvrdma_verbs";
194 for i in "$linux/drivers/infiniband/hw/vmw_pvrdma/pvrdma_ring.h" \
195 "$linux/drivers/infiniband/hw/vmw_pvrdma/pvrdma_dev_api.h" \
196 "$tmp_pvrdma_verbs"; do \
197 cp_portable "$i" \
198 "$output/include/standard-headers/drivers/infiniband/hw/vmw_pvrdma/"
199 done
201 rm -rf "$output/include/standard-headers/rdma/"
202 mkdir -p "$output/include/standard-headers/rdma/"
203 for i in "$tmpdir/include/rdma/vmw_pvrdma-abi.h"; do
204 cp_portable "$i" \
205 "$output/include/standard-headers/rdma/"
206 done
208 cat <<EOF >$output/include/standard-headers/linux/types.h
209 /* For QEMU all types are already defined via osdep.h, so this
210 * header does not need to do anything.
213 cat <<EOF >$output/include/standard-headers/linux/if_ether.h
214 #define ETH_ALEN 6
217 rm -rf "$tmpdir"