tools/patman/checkpatch.py

   1 # SPDX-License-Identifier: GPL-2.0+
   2 # Copyright (c) 2011 The Chromium OS Authors.
   3 #
   4
   5 import collections
   6 import os
   7 import re
   8 import sys
   9
  10 from patman import command
  11 from patman import gitutil
  12 from patman import terminal
  13 from patman import tools
  14
  15 def FindCheckPatch():
  16     top_level = gitutil.GetTopLevel()
  17     try_list = [
  18         os.getcwd(),
  19         os.path.join(os.getcwd(), '..', '..'),
  20         os.path.join(top_level, 'tools'),
  21         os.path.join(top_level, 'scripts'),
  22         '%s/bin' % os.getenv('HOME'),
  23         ]
  24     # Look in current dir
  25     for path in try_list:
  26         fname = os.path.join(path, 'checkpatch.pl')
  27         if os.path.isfile(fname):
  28             return fname
  29
  30     # Look upwwards for a Chrome OS tree
  31     while not os.path.ismount(path):
  32         fname = os.path.join(path, 'src', 'third_party', 'kernel', 'files',
  33                 'scripts', 'checkpatch.pl')
  34         if os.path.isfile(fname):
  35             return fname
  36         path = os.path.dirname(path)
  37
  38     sys.exit('Cannot find checkpatch.pl - please put it in your ' +
  39              '~/bin directory or use --no-check')
  40
  41 def CheckPatch(fname, verbose=False):
  42     """Run checkpatch.pl on a file.
  43
  44     Returns:
  45         namedtuple containing:
  46             ok: False=failure, True=ok
  47             problems: List of problems, each a dict:
  48                 'type'; error or warning
  49                 'msg': text message
  50                 'file' : filename
  51                 'line': line number
  52             errors: Number of errors
  53             warnings: Number of warnings
  54             checks: Number of checks
  55             lines: Number of lines
  56             stdout: Full output of checkpatch
  57     """
  58     fields = ['ok', 'problems', 'errors', 'warnings', 'checks', 'lines',
  59               'stdout']
  60     result = collections.namedtuple('CheckPatchResult', fields)
  61     result.ok = False
  62     result.errors, result.warnings, result.checks = 0, 0, 0
  63     result.lines = 0
  64     result.problems = []
  65     chk = FindCheckPatch()
  66     item = {}
  67     result.stdout = command.Output(chk, '--no-tree', fname,
  68                                    raise_on_error=False)
  69     #pipe = subprocess.Popen(cmd, stdout=subprocess.PIPE)
  70     #stdout, stderr = pipe.communicate()
  71
  72     # total: 0 errors, 0 warnings, 159 lines checked
  73     # or:
  74     # total: 0 errors, 2 warnings, 7 checks, 473 lines checked
  75     emacs_prefix = '(?:[0-9]{4}.*\.patch:[0-9]+: )?'
  76     emacs_stats = '(?:[0-9]{4}.*\.patch )?'
  77     re_stats = re.compile(emacs_stats +
  78                           'total: (\\d+) errors, (\d+) warnings, (\d+)')
  79     re_stats_full = re.compile(emacs_stats +
  80                                'total: (\\d+) errors, (\d+) warnings, (\d+)'
  81                                ' checks, (\d+)')
  82     re_ok = re.compile('.*has no obvious style problems')
  83     re_bad = re.compile('.*has style problems, please review')
  84     re_error = re.compile('ERROR: (.*)')
  85     re_warning = re.compile(emacs_prefix + 'WARNING:(?:[A-Z_]+:)? (.*)')
  86     re_check = re.compile('CHECK: (.*)')
  87     re_file = re.compile('#\d+: FILE: ([^:]*):(\d+):')
  88     re_note = re.compile('NOTE: (.*)')
  89     indent = ' ' * 6
  90     for line in result.stdout.splitlines():
  91         if verbose:
  92             print(line)
  93
  94         # A blank line indicates the end of a message
  95         if not line:
  96             if item:
  97                 result.problems.append(item)
  98                 item = {}
  99             continue
 100         if re_note.match(line):
 101             continue
 102         # Skip lines which quote code
 103         if line.startswith(indent):
 104             continue
 105         # Skip code quotes and #<n>
 106         if line.startswith('+') or line.startswith('#'):
 107             continue
 108         match = re_stats_full.match(line)
 109         if not match:
 110             match = re_stats.match(line)
 111         if match:
 112             result.errors = int(match.group(1))
 113             result.warnings = int(match.group(2))
 114             if len(match.groups()) == 4:
 115                 result.checks = int(match.group(3))
 116                 result.lines = int(match.group(4))
 117             else:
 118                 result.lines = int(match.group(3))
 119             continue
 120         elif re_ok.match(line):
 121             result.ok = True
 122             continue
 123         elif re_bad.match(line):
 124             result.ok = False
 125             continue
 126         err_match = re_error.match(line)
 127         warn_match = re_warning.match(line)
 128         file_match = re_file.match(line)
 129         check_match = re_check.match(line)
 130         subject_match = line.startswith('Subject:')
 131         if err_match:
 132             item['msg'] = err_match.group(1)
 133             item['type'] = 'error'
 134         elif warn_match:
 135             item['msg'] = warn_match.group(1)
 136             item['type'] = 'warning'
 137         elif check_match:
 138             item['msg'] = check_match.group(1)
 139             item['type'] = 'check'
 140         elif file_match:
 141             item['file'] = file_match.group(1)
 142             item['line'] = int(file_match.group(2))
 143         elif subject_match:
 144             item['file'] = '<patch subject>'
 145             item['line'] = None
 146         else:
 147             print('bad line "%s", %d' % (line, len(line)))
 148
 149     return result
 150
 151 def GetWarningMsg(col, msg_type, fname, line, msg):
 152     '''Create a message for a given file/line
 153
 154     Args:
 155         msg_type: Message type ('error' or 'warning')
 156         fname: Filename which reports the problem
 157         line: Line number where it was noticed
 158         msg: Message to report
 159     '''
 160     if msg_type == 'warning':
 161         msg_type = col.Color(col.YELLOW, msg_type)
 162     elif msg_type == 'error':
 163         msg_type = col.Color(col.RED, msg_type)
 164     elif msg_type == 'check':
 165         msg_type = col.Color(col.MAGENTA, msg_type)
 166     line_str = '' if line is None else '%d' % line
 167     return '%s:%s: %s: %s\n' % (fname, line_str, msg_type, msg)
 168
 169 def CheckPatches(verbose, args):
 170     '''Run the checkpatch.pl script on each patch'''
 171     error_count, warning_count, check_count = 0, 0, 0
 172     col = terminal.Color()
 173
 174     for fname in args:
 175         result = CheckPatch(fname, verbose)
 176         if not result.ok:
 177             error_count += result.errors
 178             warning_count += result.warnings
 179             check_count += result.checks
 180             print('%d errors, %d warnings, %d checks for %s:' % (result.errors,
 181                     result.warnings, result.checks, col.Color(col.BLUE, fname)))
 182             if (len(result.problems) != result.errors + result.warnings +
 183                     result.checks):
 184                 print("Internal error: some problems lost")
 185             for item in result.problems:
 186                 sys.stderr.write(
 187                     GetWarningMsg(col, item.get('type', '<unknown>'),
 188                         item.get('file', '<unknown>'),
 189                         item.get('line', 0), item.get('msg', 'message')))
 190             print
 191             #print(stdout)
 192     if error_count or warning_count or check_count:
 193         str = 'checkpatch.pl found %d error(s), %d warning(s), %d checks(s)'
 194         color = col.GREEN
 195         if warning_count:
 196             color = col.YELLOW
 197         if error_count:
 198             color = col.RED
 199         print(col.Color(color, str % (error_count, warning_count, check_count)))
 200         return False
 201     return True