blob: d37bd4f69284ee0a2d0a2896ce8a69811eb39219 [file] [log] [blame]
Peter Maydell85071702015-12-07 16:23:43 +00001#!/bin/sh -e
2#
3# Clean up QEMU #include lines by ensuring that qemu/osdep.h
Peter Maydellfd3e39a2016-02-23 11:58:02 +00004# is the first include listed in .c files, and no headers provided
5# by osdep.h itself are redundantly included in either .c or .h files.
Peter Maydell85071702015-12-07 16:23:43 +00006#
7# Copyright (c) 2015 Linaro Limited
8#
9# Authors:
10# Peter Maydell <peter.maydell@linaro.org>
11#
12# This work is licensed under the terms of the GNU GPL, version 2
13# or (at your option) any later version. See the COPYING file in
14# the top-level directory.
15
16# Usage:
Anand Jd66253e2016-10-21 12:27:06 +053017# clean-includes [--git subjectprefix] [--check-dup-head] file ...
Peter Maydelld57106a2016-02-23 11:58:02 +000018# or
Anand Jd66253e2016-10-21 12:27:06 +053019# clean-includes [--git subjectprefix] [--check-dup-head] --all
Peter Maydell85071702015-12-07 16:23:43 +000020#
21# If the --git subjectprefix option is given, then after making
22# the changes to the files this script will create a git commit
23# with the subject line "subjectprefix: Clean up includes"
24# and a boilerplate commit message.
Peter Maydelld57106a2016-02-23 11:58:02 +000025#
Anand Jd66253e2016-10-21 12:27:06 +053026# If --check-dup-head is specified, additionally check for duplicate
27# header includes.
28#
Peter Maydelld57106a2016-02-23 11:58:02 +000029# Using --all will cause clean-includes to run on the whole source
30# tree (excluding certain directories which are known not to need
31# handling).
Peter Maydell85071702015-12-07 16:23:43 +000032
33# This script requires Coccinelle to be installed.
34
Peter Maydellfd3e39a2016-02-23 11:58:02 +000035# .c files will have the osdep.h included added, and redundant
36# includes removed.
37# .h files will have redundant includes (including includes of osdep.h)
38# removed.
39# Other files (including C++ and ObjectiveC) can't be handled by this script.
Peter Maydell85071702015-12-07 16:23:43 +000040
41# The following one-liner may be handy for finding files to run this on.
42# However some caution is required regarding files that might be part
43# of the guest agent or standalone tests.
44
Stefan Weilbbd90802016-05-16 15:23:33 +020045# for i in $(git ls-tree --name-only HEAD) ; do test -f $i && \
Peter Maydell85071702015-12-07 16:23:43 +000046# grep -E '^# *include' $i | head -1 | grep 'osdep.h' ; test $? != 0 && \
47# echo $i ; done
48
49
50GIT=no
Anand Jd66253e2016-10-21 12:27:06 +053051DUPHEAD=no
Peter Maydell85071702015-12-07 16:23:43 +000052
Peter Maydelld57106a2016-02-23 11:58:02 +000053# Extended regular expression defining files to ignore when using --all
Thomas Huth21166502022-06-03 18:42:49 +020054XDIRREGEX='^(tests/tcg|tests/multiboot|pc-bios)'
Peter Maydelld57106a2016-02-23 11:58:02 +000055
Anand Jd66253e2016-10-21 12:27:06 +053056while true
57do
58 case $1 in
59 "--git")
60 if [ $# -eq 1 ]; then
61 echo "--git option requires an argument"
62 exit 1
63 fi
64 GITSUBJ="$2"
65 GIT=yes
66 shift
67 shift
68 ;;
69 "--check-dup-head")
70 DUPHEAD=yes
71 shift
72 ;;
73 "--")
74 shift
75 break
76 ;;
77 *)
78 break
79 ;;
80 esac
81done
Peter Maydell85071702015-12-07 16:23:43 +000082
83if [ $# -eq 0 ]; then
Anand Jd66253e2016-10-21 12:27:06 +053084 echo "Usage: clean-includes [--git subjectprefix] [--check-dup-head] [--all | foo.c ...]"
Peter Maydell85071702015-12-07 16:23:43 +000085 echo "(modifies the files in place)"
86 exit 1
87fi
88
Peter Maydelld57106a2016-02-23 11:58:02 +000089if [ "$1" = "--all" ]; then
90 # We assume there are no files in the tree with spaces in their name
91 set -- $(git ls-files '*.[ch]' | grep -E -v "$XDIRREGEX")
92fi
93
Peter Maydell85071702015-12-07 16:23:43 +000094# Annoyingly coccinelle won't read a scriptfile unless its
95# name ends '.cocci', so write it out to a tempfile with the
96# right kind of name.
97COCCIFILE="$(mktemp --suffix=.cocci)"
98
99trap 'rm -f -- "$COCCIFILE"' INT TERM HUP EXIT
100
101cat >"$COCCIFILE" <<EOT
102@@
103@@
104
105(
106+ #include "qemu/osdep.h"
107 #include "..."
108|
109+ #include "qemu/osdep.h"
110 #include <...>
111)
112EOT
113
Peter Maydell85071702015-12-07 16:23:43 +0000114for f in "$@"; do
Peter Maydellfd3e39a2016-02-23 11:58:02 +0000115 case "$f" in
Paolo Bonzini139c1832020-02-04 12:41:01 +0100116 *.c.inc)
Peter Maydellf8e1f5d2016-02-23 14:49:42 +0000117 # These aren't standalone C source files
118 echo "SKIPPING $f (not a standalone source file)"
119 continue
120 ;;
Peter Maydellfd3e39a2016-02-23 11:58:02 +0000121 *.c)
122 MODE=c
123 ;;
124 *include/qemu/osdep.h | \
125 *include/qemu/compiler.h | \
Philippe Mathieu-Daudéa6703e62020-06-05 16:49:17 +0100126 *include/qemu/qemu-plugin.h | \
Peter Maydelldf891b92016-05-24 16:24:36 +0100127 *include/glib-compat.h | \
Paolo Bonzini02d0e092016-06-06 13:57:39 +0200128 *include/sysemu/os-posix.h | \
129 *include/sysemu/os-win32.h | \
Peter Maydellfd3e39a2016-02-23 11:58:02 +0000130 *include/standard-headers/ )
131 # Removing include lines from osdep.h itself would be counterproductive.
132 echo "SKIPPING $f (special case header)"
133 continue
134 ;;
135 *include/standard-headers/*)
136 echo "SKIPPING $f (autogenerated header)"
137 continue
138 ;;
139 *.h)
140 MODE=h
141 ;;
142 *)
143 echo "WARNING: ignoring $f (cannot handle non-C files)"
144 continue
145 ;;
146 esac
Peter Maydell85071702015-12-07 16:23:43 +0000147
Peter Maydellfd3e39a2016-02-23 11:58:02 +0000148 if [ "$MODE" = "c" ]; then
149 # First, use Coccinelle to add qemu/osdep.h before the first existing include
150 # (this will add two lines if the file uses both "..." and <...> #includes,
151 # but we will remove the extras in the next step)
152 spatch --in-place --no-show-diff --cocci-file "$COCCIFILE" "$f"
153
154 # Now remove any duplicate osdep.h includes
155 perl -n -i -e 'print if !/#include "qemu\/osdep.h"/ || !$n++;' "$f"
156 else
157 # Remove includes of osdep.h itself
158 perl -n -i -e 'print if !/\s*#\s*include\s*(["<][^>"]*[">])/ ||
159 ! (grep { $_ eq $1 } qw ("qemu/osdep.h"))' "$f"
160 fi
Peter Maydell85071702015-12-07 16:23:43 +0000161
162 # Remove includes that osdep.h already provides
163 perl -n -i -e 'print if !/\s*#\s*include\s*(["<][^>"]*[">])/ ||
164 ! (grep { $_ eq $1 } qw (
Markus Armbrusterda34e652016-03-14 09:01:28 +0100165 "config-host.h" "config-target.h" "qemu/compiler.h"
Stefan Weil8ff98f12016-03-14 15:47:05 +0100166 <setjmp.h> <stdarg.h> <stddef.h> <stdbool.h> <stdint.h> <sys/types.h>
Peter Maydell85071702015-12-07 16:23:43 +0000167 <stdlib.h> <stdio.h> <string.h> <strings.h> <inttypes.h>
168 <limits.h> <unistd.h> <time.h> <ctype.h> <errno.h> <fcntl.h>
Peter Maydelldf891b92016-05-24 16:24:36 +0100169 <sys/stat.h> <sys/time.h> <assert.h> <signal.h> <glib.h>
Paolo Bonzini02d0e092016-06-06 13:57:39 +0200170 <sys/stat.h> <sys/time.h> <assert.h> <signal.h> <glib.h> <sys/mman.h>
Markus Armbrusterda34e652016-03-14 09:01:28 +0100171 "sysemu/os-posix.h, sysemu/os-win32.h "glib-compat.h"
172 "qemu/typedefs.h"
Peter Maydell85071702015-12-07 16:23:43 +0000173 ))' "$f"
174
175done
176
Anand Jd66253e2016-10-21 12:27:06 +0530177if [ "$DUPHEAD" = "yes" ]; then
178 egrep "^[[:space:]]*#[[:space:]]*include" "$@" | tr -d '[:blank:]' \
179 | sort | uniq -c | awk '{if ($1 > 1) print $0}'
180 if [ $? -eq 0 ]; then
181 echo "Found duplicate header file includes. Please check the above files manually."
182 exit 1
183 fi
184fi
185
Peter Maydell85071702015-12-07 16:23:43 +0000186if [ "$GIT" = "yes" ]; then
187 git add -- "$@"
188 git commit --signoff -F - <<EOF
189$GITSUBJ: Clean up includes
190
191Clean up includes so that osdep.h is included first and headers
192which it implies are not included manually.
193
194This commit was created with scripts/clean-includes.
195
196EOF
197
198fi