scripts/clean-includes

   1 #!/bin/sh -e
   2 #
   3 # Clean up QEMU #include lines by ensuring that qemu/osdep.h
   4 # 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.
   6 #
   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:
  17 #   clean-includes [--git subjectprefix] [--check-dup-head] file ...
  18 # or
  19 #   clean-includes [--git subjectprefix] [--check-dup-head] --all
  20 #
  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.
  25 #
  26 # If --check-dup-head is specified, additionally check for duplicate
  27 # header includes.
  28 #
  29 # 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).
  32
  33 # This script requires Coccinelle to be installed.
  34
  35 # .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.
  40
  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
  45 # for i in $(git ls-tree --name-only HEAD) ; do test -f $i && \
  46 #   grep -E '^# *include' $i | head -1 | grep 'osdep.h' ; test $? != 0 && \
  47 #   echo $i ; done
  48
  49
  50 GIT=no
  51 DUPHEAD=no
  52
  53 # Extended regular expression defining files to ignore when using --all
  54 XDIRREGEX='^(tests/tcg|tests/multiboot|tests/fp|tests/plugin|tests/uefi-test-tools|pc-bios|subprojects|contrib/plugins|tools/ebpf|ebpf/rss.bpf.skeleton.h|linux-user/(mips64|x86_64)/(cpu_loop|signal).c)'
  55
  56 while true
  57 do
  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
  81 done
  82
  83 if [ $# -eq 0 ]; then
  84     echo "Usage: clean-includes [--git subjectprefix] [--check-dup-head] [--all | foo.c ...]"
  85     echo "(modifies the files in place)"
  86     exit 1
  87 fi
  88
  89 if [ "$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")
  92 fi
  93
  94 # 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.
  97 COCCIFILE="$(mktemp --suffix=.cocci)"
  98
  99 trap 'rm -f -- "$COCCIFILE"' INT TERM HUP EXIT
 100
 101 cat >"$COCCIFILE" <<EOT
 102 @@
 103 @@
 104
 105 (
 106 + #include "qemu/osdep.h"
 107  #include "..."
 108 |
 109 + #include "qemu/osdep.h"
 110  #include <...>
 111 )
 112 EOT
 113
 114 files=
 115 for f in "$@"; do
 116   if [ -L "$f" ]; then
 117       echo "SKIPPING $f (symbolic link)"
 118       continue
 119   fi
 120   case "$f" in
 121     *.c.inc)
 122       # These aren't standalone C source files
 123       echo "SKIPPING $f (not a standalone source file)"
 124       continue
 125       ;;
 126     *.c)
 127       MODE=c
 128       ;;
 129     *include/qemu/osdep.h | \
 130     *include/qemu/compiler.h | \
 131     *include/qemu/qemu-plugin.h | \
 132     *include/glib-compat.h | \
 133     *include/sysemu/os-posix.h | \
 134     *include/sysemu/os-win32.h | \
 135     *include/standard-headers/ )
 136       # Removing include lines from osdep.h itself would be counterproductive.
 137       echo "SKIPPING $f (special case header)"
 138       continue
 139       ;;
 140     *include/standard-headers/*)
 141       echo "SKIPPING $f (autogenerated header)"
 142       continue
 143       ;;
 144     *.h)
 145       MODE=h
 146       ;;
 147     *)
 148       echo "WARNING: ignoring $f (cannot handle non-C files)"
 149       continue
 150       ;;
 151   esac
 152   files="$files $f"
 153
 154   if [ "$MODE" = "c" ]; then
 155     # First, use Coccinelle to add qemu/osdep.h before the first existing include
 156     # (this will add two lines if the file uses both "..." and <...> #includes,
 157     # but we will remove the extras in the next step)
 158     spatch  --in-place --no-show-diff --cocci-file "$COCCIFILE" "$f"
 159
 160     # Now remove any duplicate osdep.h includes
 161     perl -n -i -e 'print if !/#include "qemu\/osdep.h"/ || !$n++;' "$f"
 162   else
 163     # Remove includes of osdep.h itself
 164     perl -n -i -e 'print if !/\s*#\s*include\s*(["<][^>"]*[">])/ ||
 165                             ! (grep { $_ eq $1 } qw ("qemu/osdep.h"))' "$f"
 166   fi
 167
 168   # Remove includes that osdep.h already provides
 169   perl -n -i -e 'print if !/\s*#\s*include\s*(["<][^>"]*[">])/ ||
 170                           ! (grep { $_ eq $1 } qw (
 171            "config-host.h" "config-target.h" "qemu/compiler.h"
 172            <setjmp.h> <stdarg.h> <stddef.h> <stdbool.h> <stdint.h> <sys/types.h>
 173            <stdlib.h> <stdio.h> <string.h> <strings.h> <inttypes.h>
 174            <limits.h> <unistd.h> <time.h> <ctype.h> <errno.h> <fcntl.h>
 175            <sys/stat.h> <sys/time.h> <assert.h> <signal.h> <glib.h>
 176            <sys/stat.h> <sys/time.h> <assert.h> <signal.h> <glib.h> <sys/mman.h>
 177            "sysemu/os-posix.h, sysemu/os-win32.h "glib-compat.h"
 178            "qemu/typedefs.h"
 179             ))' "$f"
 180
 181 done
 182
 183 if [ "$DUPHEAD" = "yes" ] && [ -n "$files" ]; then
 184     if egrep "^[[:space:]]*#[[:space:]]*include" $files | tr -d '[:blank:]' \
 185         | sort | uniq -c | grep -v '^ *1 '; then
 186         echo "Found duplicate header file includes. Please check the above files manually."
 187         exit 1
 188     fi
 189 fi
 190
 191 if [ "$GIT" = "yes" ]; then
 192     git add -- $files
 193     git commit --signoff -F - <<EOF
 194 $GITSUBJ: Clean up includes
 195
 196 This commit was created with scripts/clean-includes.
 197
 198 All .c should include qemu/osdep.h first.  The script performs three
 199 related cleanups:
 200
 201 * Ensure .c files include qemu/osdep.h first.
 202 * Including it in a .h is redundant, since the .c  already includes
 203   it.  Drop such inclusions.
 204 * Likewise, including headers qemu/osdep.h includes is redundant.
 205   Drop these, too.
 206
 207 EOF
 208
 209 fi