blob: d47ea438b7da58cc1c6d569dbc8c55f0b6e3e6f6 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
Simon Glass0d24de92012-01-14 15:12:45 +00002# Copyright (c) 2011 The Chromium OS Authors.
3#
Simon Glass0d24de92012-01-14 15:12:45 +00004
Simon Glassd29fe6e2013-03-26 13:09:39 +00005import collections
Simon Glass0d24de92012-01-14 15:12:45 +00006import command
7import gitutil
8import os
9import re
Vadim Bendebury99adf6e2013-01-09 16:00:10 +000010import sys
Simon Glass0d24de92012-01-14 15:12:45 +000011import terminal
12
13def FindCheckPatch():
Doug Andersond96ef372012-11-26 15:23:23 +000014 top_level = gitutil.GetTopLevel()
Simon Glass0d24de92012-01-14 15:12:45 +000015 try_list = [
16 os.getcwd(),
17 os.path.join(os.getcwd(), '..', '..'),
Doug Andersond96ef372012-11-26 15:23:23 +000018 os.path.join(top_level, 'tools'),
19 os.path.join(top_level, 'scripts'),
Simon Glass0d24de92012-01-14 15:12:45 +000020 '%s/bin' % os.getenv('HOME'),
21 ]
22 # Look in current dir
23 for path in try_list:
24 fname = os.path.join(path, 'checkpatch.pl')
25 if os.path.isfile(fname):
26 return fname
27
28 # Look upwwards for a Chrome OS tree
29 while not os.path.ismount(path):
30 fname = os.path.join(path, 'src', 'third_party', 'kernel', 'files',
31 'scripts', 'checkpatch.pl')
32 if os.path.isfile(fname):
33 return fname
34 path = os.path.dirname(path)
Vadim Bendebury99adf6e2013-01-09 16:00:10 +000035
Masahiro Yamada31e21412014-08-16 00:59:26 +090036 sys.exit('Cannot find checkpatch.pl - please put it in your ' +
37 '~/bin directory or use --no-check')
Simon Glass0d24de92012-01-14 15:12:45 +000038
39def CheckPatch(fname, verbose=False):
40 """Run checkpatch.pl on a file.
41
42 Returns:
Simon Glassd29fe6e2013-03-26 13:09:39 +000043 namedtuple containing:
44 ok: False=failure, True=ok
Simon Glass0d24de92012-01-14 15:12:45 +000045 problems: List of problems, each a dict:
46 'type'; error or warning
47 'msg': text message
48 'file' : filename
49 'line': line number
Simon Glassd29fe6e2013-03-26 13:09:39 +000050 errors: Number of errors
51 warnings: Number of warnings
52 checks: Number of checks
Simon Glass0d24de92012-01-14 15:12:45 +000053 lines: Number of lines
Simon Glassd29fe6e2013-03-26 13:09:39 +000054 stdout: Full output of checkpatch
Simon Glass0d24de92012-01-14 15:12:45 +000055 """
Simon Glassd29fe6e2013-03-26 13:09:39 +000056 fields = ['ok', 'problems', 'errors', 'warnings', 'checks', 'lines',
57 'stdout']
58 result = collections.namedtuple('CheckPatchResult', fields)
59 result.ok = False
60 result.errors, result.warning, result.checks = 0, 0, 0
61 result.lines = 0
62 result.problems = []
Simon Glass0d24de92012-01-14 15:12:45 +000063 chk = FindCheckPatch()
Simon Glass0d24de92012-01-14 15:12:45 +000064 item = {}
Simon Glass785f1542016-07-25 18:59:00 -060065 result.stdout = command.Output(chk, '--no-tree', fname,
66 raise_on_error=False)
Simon Glass0d24de92012-01-14 15:12:45 +000067 #pipe = subprocess.Popen(cmd, stdout=subprocess.PIPE)
68 #stdout, stderr = pipe.communicate()
69
70 # total: 0 errors, 0 warnings, 159 lines checked
Simon Glassd29fe6e2013-03-26 13:09:39 +000071 # or:
72 # total: 0 errors, 2 warnings, 7 checks, 473 lines checked
Simon Glass0d24de92012-01-14 15:12:45 +000073 re_stats = re.compile('total: (\\d+) errors, (\d+) warnings, (\d+)')
Simon Glassd29fe6e2013-03-26 13:09:39 +000074 re_stats_full = re.compile('total: (\\d+) errors, (\d+) warnings, (\d+)'
75 ' checks, (\d+)')
Simon Glass0d24de92012-01-14 15:12:45 +000076 re_ok = re.compile('.*has no obvious style problems')
77 re_bad = re.compile('.*has style problems, please review')
78 re_error = re.compile('ERROR: (.*)')
79 re_warning = re.compile('WARNING: (.*)')
Simon Glassd29fe6e2013-03-26 13:09:39 +000080 re_check = re.compile('CHECK: (.*)')
Simon Glass0d24de92012-01-14 15:12:45 +000081 re_file = re.compile('#\d+: FILE: ([^:]*):(\d+):')
82
Simon Glassd29fe6e2013-03-26 13:09:39 +000083 for line in result.stdout.splitlines():
Simon Glass0d24de92012-01-14 15:12:45 +000084 if verbose:
Paul Burtona920a172016-09-27 16:03:50 +010085 print(line)
Simon Glass0d24de92012-01-14 15:12:45 +000086
87 # A blank line indicates the end of a message
88 if not line and item:
Simon Glassd29fe6e2013-03-26 13:09:39 +000089 result.problems.append(item)
Simon Glass0d24de92012-01-14 15:12:45 +000090 item = {}
Simon Glassd29fe6e2013-03-26 13:09:39 +000091 match = re_stats_full.match(line)
92 if not match:
93 match = re_stats.match(line)
Simon Glass0d24de92012-01-14 15:12:45 +000094 if match:
Simon Glassd29fe6e2013-03-26 13:09:39 +000095 result.errors = int(match.group(1))
96 result.warnings = int(match.group(2))
97 if len(match.groups()) == 4:
98 result.checks = int(match.group(3))
99 result.lines = int(match.group(4))
100 else:
101 result.lines = int(match.group(3))
Simon Glass0d24de92012-01-14 15:12:45 +0000102 elif re_ok.match(line):
Simon Glassd29fe6e2013-03-26 13:09:39 +0000103 result.ok = True
Simon Glass0d24de92012-01-14 15:12:45 +0000104 elif re_bad.match(line):
Simon Glassd29fe6e2013-03-26 13:09:39 +0000105 result.ok = False
106 err_match = re_error.match(line)
107 warn_match = re_warning.match(line)
108 file_match = re_file.match(line)
109 check_match = re_check.match(line)
110 if err_match:
111 item['msg'] = err_match.group(1)
Simon Glass0d24de92012-01-14 15:12:45 +0000112 item['type'] = 'error'
Simon Glassd29fe6e2013-03-26 13:09:39 +0000113 elif warn_match:
114 item['msg'] = warn_match.group(1)
Simon Glass0d24de92012-01-14 15:12:45 +0000115 item['type'] = 'warning'
Simon Glassd29fe6e2013-03-26 13:09:39 +0000116 elif check_match:
117 item['msg'] = check_match.group(1)
118 item['type'] = 'check'
119 elif file_match:
120 item['file'] = file_match.group(1)
121 item['line'] = int(file_match.group(2))
Simon Glass0d24de92012-01-14 15:12:45 +0000122
Simon Glassd29fe6e2013-03-26 13:09:39 +0000123 return result
Simon Glass0d24de92012-01-14 15:12:45 +0000124
125def GetWarningMsg(col, msg_type, fname, line, msg):
126 '''Create a message for a given file/line
127
128 Args:
129 msg_type: Message type ('error' or 'warning')
130 fname: Filename which reports the problem
131 line: Line number where it was noticed
132 msg: Message to report
133 '''
134 if msg_type == 'warning':
135 msg_type = col.Color(col.YELLOW, msg_type)
136 elif msg_type == 'error':
137 msg_type = col.Color(col.RED, msg_type)
Simon Glassd29fe6e2013-03-26 13:09:39 +0000138 elif msg_type == 'check':
139 msg_type = col.Color(col.MAGENTA, msg_type)
Simon Glass8aa41362017-01-17 16:52:23 -0700140 return '%s:%d: %s: %s\n' % (fname, line, msg_type, msg)
Simon Glass0d24de92012-01-14 15:12:45 +0000141
142def CheckPatches(verbose, args):
143 '''Run the checkpatch.pl script on each patch'''
Simon Glassd29fe6e2013-03-26 13:09:39 +0000144 error_count, warning_count, check_count = 0, 0, 0
Simon Glass0d24de92012-01-14 15:12:45 +0000145 col = terminal.Color()
146
147 for fname in args:
Simon Glassd29fe6e2013-03-26 13:09:39 +0000148 result = CheckPatch(fname, verbose)
149 if not result.ok:
150 error_count += result.errors
151 warning_count += result.warnings
152 check_count += result.checks
Paul Burtona920a172016-09-27 16:03:50 +0100153 print('%d errors, %d warnings, %d checks for %s:' % (result.errors,
154 result.warnings, result.checks, col.Color(col.BLUE, fname)))
Simon Glassd29fe6e2013-03-26 13:09:39 +0000155 if (len(result.problems) != result.errors + result.warnings +
156 result.checks):
Paul Burtona920a172016-09-27 16:03:50 +0100157 print("Internal error: some problems lost")
Simon Glassd29fe6e2013-03-26 13:09:39 +0000158 for item in result.problems:
Simon Glass8aa41362017-01-17 16:52:23 -0700159 sys.stderr.write(
160 GetWarningMsg(col, item.get('type', '<unknown>'),
Simon Glassafb9bf52012-09-27 15:33:46 +0000161 item.get('file', '<unknown>'),
Paul Burtona920a172016-09-27 16:03:50 +0100162 item.get('line', 0), item.get('msg', 'message')))
Simon Glassd29fe6e2013-03-26 13:09:39 +0000163 print
Paul Burtona920a172016-09-27 16:03:50 +0100164 #print(stdout)
Simon Glassd29fe6e2013-03-26 13:09:39 +0000165 if error_count or warning_count or check_count:
166 str = 'checkpatch.pl found %d error(s), %d warning(s), %d checks(s)'
Simon Glass0d24de92012-01-14 15:12:45 +0000167 color = col.GREEN
168 if warning_count:
169 color = col.YELLOW
170 if error_count:
171 color = col.RED
Paul Burtona920a172016-09-27 16:03:50 +0100172 print(col.Color(color, str % (error_count, warning_count, check_count)))
Simon Glass0d24de92012-01-14 15:12:45 +0000173 return False
174 return True