1# SPDX-License-Identifier: GPL-2.0+ 2# Copyright (c) 2011 The Chromium OS Authors. 3# 4 5import collections 6import concurrent.futures 7import os 8import re 9import sys 10 11from patman import gitutil 12from u_boot_pylib import command 13from u_boot_pylib import terminal 14 15EMACS_PREFIX = r'(?:[0-9]{4}.*\.patch:[0-9]+: )?' 16TYPE_NAME = r'([A-Z_]+:)?' 17RE_ERROR = re.compile(r'ERROR:%s (.*)' % TYPE_NAME) 18RE_WARNING = re.compile(EMACS_PREFIX + r'WARNING:%s (.*)' % TYPE_NAME) 19RE_CHECK = re.compile(r'CHECK:%s (.*)' % TYPE_NAME) 20RE_FILE = re.compile(r'#(\d+): (FILE: ([^:]*):(\d+):)?') 21RE_NOTE = re.compile(r'NOTE: (.*)') 22 23 24def find_check_patch(): 25 top_level = gitutil.get_top_level() 26 try_list = [ 27 os.getcwd(), 28 os.path.join(os.getcwd(), '..', '..'), 29 os.path.join(top_level, 'tools'), 30 os.path.join(top_level, 'scripts'), 31 '%s/bin' % os.getenv('HOME'), 32 ] 33 # Look in current dir 34 for path in try_list: 35 fname = os.path.join(path, 'checkpatch.pl') 36 if os.path.isfile(fname): 37 return fname 38 39 # Look upwwards for a Chrome OS tree 40 while not os.path.ismount(path): 41 fname = os.path.join(path, 'src', 'third_party', 'kernel', 'files', 42 'scripts', 'checkpatch.pl') 43 if os.path.isfile(fname): 44 return fname 45 path = os.path.dirname(path) 46 47 sys.exit('Cannot find checkpatch.pl - please put it in your ' + 48 '~/bin directory or use --no-check') 49 50 51def check_patch_parse_one_message(message): 52 """Parse one checkpatch message 53 54 Args: 55 message: string to parse 56 57 Returns: 58 dict: 59 'type'; error or warning 60 'msg': text message 61 'file' : filename 62 'line': line number 63 """ 64 65 if RE_NOTE.match(message): 66 return {} 67 68 item = {} 69 70 err_match = RE_ERROR.match(message) 71 warn_match = RE_WARNING.match(message) 72 check_match = RE_CHECK.match(message) 73 if err_match: 74 item['cptype'] = err_match.group(1) 75 item['msg'] = err_match.group(2) 76 item['type'] = 'error' 77 elif warn_match: 78 item['cptype'] = warn_match.group(1) 79 item['msg'] = warn_match.group(2) 80 item['type'] = 'warning' 81 elif check_match: 82 item['cptype'] = check_match.group(1) 83 item['msg'] = check_match.group(2) 84 item['type'] = 'check' 85 else: 86 message_indent = ' ' 87 print('patman: failed to parse checkpatch message:\n%s' % 88 (message_indent + message.replace('\n', '\n' + message_indent)), 89 file=sys.stderr) 90 return {} 91 92 file_match = RE_FILE.search(message) 93 # some messages have no file, catch those here 94 no_file_match = any(s in message for s in [ 95 '\nSubject:', 'Missing Signed-off-by: line(s)', 96 'does MAINTAINERS need updating' 97 ]) 98 99 if file_match: 100 err_fname = file_match.group(3) 101 if err_fname: 102 item['file'] = err_fname 103 item['line'] = int(file_match.group(4)) 104 else: 105 item['file'] = '<patch>' 106 item['line'] = int(file_match.group(1)) 107 elif no_file_match: 108 item['file'] = '<patch>' 109 else: 110 message_indent = ' ' 111 print('patman: failed to find file / line information:\n%s' % 112 (message_indent + message.replace('\n', '\n' + message_indent)), 113 file=sys.stderr) 114 115 return item 116 117 118def check_patch_parse(checkpatch_output, verbose=False): 119 """Parse checkpatch.pl output 120 121 Args: 122 checkpatch_output: string to parse 123 verbose: True to print out every line of the checkpatch output as it is 124 parsed 125 126 Returns: 127 namedtuple containing: 128 ok: False=failure, True=ok 129 problems (list of problems): each a dict: 130 'type'; error or warning 131 'msg': text message 132 'file' : filename 133 'line': line number 134 errors: Number of errors 135 warnings: Number of warnings 136 checks: Number of checks 137 lines: Number of lines 138 stdout: checkpatch_output 139 """ 140 fields = ['ok', 'problems', 'errors', 'warnings', 'checks', 'lines', 141 'stdout'] 142 result = collections.namedtuple('CheckPatchResult', fields) 143 result.stdout = checkpatch_output 144 result.ok = False 145 result.errors, result.warnings, result.checks = 0, 0, 0 146 result.lines = 0 147 result.problems = [] 148 149 # total: 0 errors, 0 warnings, 159 lines checked 150 # or: 151 # total: 0 errors, 2 warnings, 7 checks, 473 lines checked 152 emacs_stats = r'(?:[0-9]{4}.*\.patch )?' 153 re_stats = re.compile(emacs_stats + 154 r'total: (\d+) errors, (\d+) warnings, (\d+)') 155 re_stats_full = re.compile(emacs_stats + 156 r'total: (\d+) errors, (\d+) warnings, (\d+)' 157 r' checks, (\d+)') 158 re_ok = re.compile(r'.*has no obvious style problems') 159 re_bad = re.compile(r'.*has style problems, please review') 160 161 # A blank line indicates the end of a message 162 for message in result.stdout.split('\n\n'): 163 if verbose: 164 print(message) 165 166 # either find stats, the verdict, or delegate 167 match = re_stats_full.match(message) 168 if not match: 169 match = re_stats.match(message) 170 if match: 171 result.errors = int(match.group(1)) 172 result.warnings = int(match.group(2)) 173 if len(match.groups()) == 4: 174 result.checks = int(match.group(3)) 175 result.lines = int(match.group(4)) 176 else: 177 result.lines = int(match.group(3)) 178 elif re_ok.match(message): 179 result.ok = True 180 elif re_bad.match(message): 181 result.ok = False 182 else: 183 problem = check_patch_parse_one_message(message) 184 if problem: 185 result.problems.append(problem) 186 187 return result 188 189 190def check_patch(fname, verbose=False, show_types=False, use_tree=False): 191 """Run checkpatch.pl on a file and parse the results. 192 193 Args: 194 fname: Filename to check 195 verbose: True to print out every line of the checkpatch output as it is 196 parsed 197 show_types: Tell checkpatch to show the type (number) of each message 198 use_tree (bool): If False we'll pass '--no-tree' to checkpatch. 199 200 Returns: 201 namedtuple containing: 202 ok: False=failure, True=ok 203 problems: List of problems, each a dict: 204 'type'; error or warning 205 'msg': text message 206 'file' : filename 207 'line': line number 208 errors: Number of errors 209 warnings: Number of warnings 210 checks: Number of checks 211 lines: Number of lines 212 stdout: Full output of checkpatch 213 """ 214 chk = find_check_patch() 215 args = [chk] 216 if not use_tree: 217 args.append('--no-tree') 218 if show_types: 219 args.append('--show-types') 220 output = command.output(*args, fname, raise_on_error=False) 221 222 return check_patch_parse(output, verbose) 223 224 225def get_warning_msg(col, msg_type, fname, line, msg): 226 '''Create a message for a given file/line 227 228 Args: 229 msg_type: Message type ('error' or 'warning') 230 fname: Filename which reports the problem 231 line: Line number where it was noticed 232 msg: Message to report 233 ''' 234 if msg_type == 'warning': 235 msg_type = col.build(col.YELLOW, msg_type) 236 elif msg_type == 'error': 237 msg_type = col.build(col.RED, msg_type) 238 elif msg_type == 'check': 239 msg_type = col.build(col.MAGENTA, msg_type) 240 line_str = '' if line is None else '%d' % line 241 return '%s:%s: %s: %s\n' % (fname, line_str, msg_type, msg) 242 243def check_patches(verbose, args, use_tree): 244 '''Run the checkpatch.pl script on each patch''' 245 error_count, warning_count, check_count = 0, 0, 0 246 col = terminal.Color() 247 248 with concurrent.futures.ThreadPoolExecutor(max_workers=16) as executor: 249 futures = [] 250 for fname in args: 251 f = executor.submit(check_patch, fname, verbose, use_tree=use_tree) 252 futures.append(f) 253 254 for fname, f in zip(args, futures): 255 result = f.result() 256 if not result.ok: 257 error_count += result.errors 258 warning_count += result.warnings 259 check_count += result.checks 260 print('%d errors, %d warnings, %d checks for %s:' % (result.errors, 261 result.warnings, result.checks, col.build(col.BLUE, fname))) 262 if (len(result.problems) != result.errors + result.warnings + 263 result.checks): 264 print("Internal error: some problems lost") 265 # Python seems to get confused by this 266 # pylint: disable=E1133 267 for item in result.problems: 268 sys.stderr.write( 269 get_warning_msg(col, item.get('type', '<unknown>'), 270 item.get('file', '<unknown>'), 271 item.get('line', 0), item.get('msg', 'message'))) 272 print 273 if error_count or warning_count or check_count: 274 str = 'checkpatch.pl found %d error(s), %d warning(s), %d checks(s)' 275 color = col.GREEN 276 if warning_count: 277 color = col.YELLOW 278 if error_count: 279 color = col.RED 280 print(col.build(color, str % (error_count, warning_count, check_count))) 281 return False 282 return True 283