scripts/gcc-wrapper.py

   1 #! /usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 # Copyright (c) 2011-2012, The Linux Foundation. All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions are met:
   8 #     * Redistributions of source code must retain the above copyright
   9 #       notice, this list of conditions and the following disclaimer.
  10 #     * Redistributions in binary form must reproduce the above copyright
  11 #       notice, this list of conditions and the following disclaimer in the
  12 #       documentation and/or other materials provided with the distribution.
  13 #     * Neither the name of The Linux Foundation nor
  14 #       the names of its contributors may be used to endorse or promote
  15 #       products derived from this software without specific prior written
  16 #       permission.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 # IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  21 # NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  22 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  23 # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  24 # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  25 # OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  26 # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  27 # OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  28 # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 # Invoke gcc, looking for warnings, and causing a failure if there are
  31 # non-whitelisted warnings.
  32
  33 import errno
  34 import re
  35 import os
  36 import sys
  37 import subprocess
  38
  39 # Note that gcc uses unicode, which may depend on the locale.  TODO:
  40 # force LANG to be set to en_US.UTF-8 to get consistent warnings.
  41
  42 allowed_warnings = set([
  43     "core.c:142", # drivers/regulator/core.c:142:6: warning: unused variable 'i'
  44     "posix-cpu-timers.c:1268", # kernel/time/posix-cpu-timers.c:1268:13: warning: 'now' may be used uninitialized in this function
  45     "af_unix.c:1036", # net/unix/af_unix.c:1036:20: warning: 'hash' may be used uninitialized in this function
  46     "sunxi_sram.c:214", # drivers/soc/sunxi/sunxi_sram.c:214:24: warning: 'device' may be used uninitialized in this function
  47     "ks8851.c:298", # drivers/net/ethernet/micrel/ks8851.c:298:2: warning: 'rxb[0]' may be used uninitialized in this function
  48     "ks8851.c:421", # drivers/net/ethernet/micrel/ks8851.c:421:20: warning: 'rxb[0]' may be used uninitialized in this function
  49     "compat_binfmt_elf.c:58", # fs/compat_binfmt_elf.c:58:13: warning: 'cputime_to_compat_timeval' defined but not used
  50     "cgroup.c:2132", # kernel/cgroup.c:2132:13: warning: 'root' may be used uninitialized in this function
  51  ])
  52
  53 # Capture the name of the object file, can find it.
  54 ofile = None
  55
  56 warning_re = re.compile(r'''(.*/|)([^/]+\.[a-z]+:\d+):(\d+:)? warning:''')
  57 def interpret_warning(line):
  58     """Decode the message from gcc.  The messages we care about have a filename, and a warning"""
  59     line = line.rstrip('\n')
  60     m = warning_re.match(line)
  61     if m and m.group(2) not in allowed_warnings:
  62         print "error, forbidden warning:", m.group(2)
  63
  64         # If there is a warning, remove any object if it exists.
  65         if ofile:
  66             try:
  67                 os.remove(ofile)
  68             except OSError:
  69                 pass
  70         sys.exit(1)
  71
  72 def run_gcc():
  73     args = sys.argv[1:]
  74     # Look for -o
  75     try:
  76         i = args.index('-o')
  77         global ofile
  78         ofile = args[i+1]
  79     except (ValueError, IndexError):
  80         pass
  81
  82     compiler = sys.argv[0]
  83
  84     try:
  85         proc = subprocess.Popen(args, stderr=subprocess.PIPE)
  86         for line in proc.stderr:
  87             print line,
  88             interpret_warning(line)
  89
  90         result = proc.wait()
  91     except OSError as e:
  92         result = e.errno
  93         if result == errno.ENOENT:
  94             print args[0] + ':',e.strerror
  95             print 'Is your PATH set correctly?'
  96         else:
  97             print ' '.join(args), str(e)
  98
  99     return result
 100
 101 if __name__ == '__main__':
 102     status = run_gcc()
 103     sys.exit(status)