1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2011 The Chromium OS Authors.
10 from patman import command
11 from patman import gitutil
12 from patman import terminal
13 from patman import tools
16 top_level = gitutil.GetTopLevel()
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'),
26 fname = os.path.join(path, 'checkpatch.pl')
27 if os.path.isfile(fname):
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):
36 path = os.path.dirname(path)
38 sys.exit('Cannot find checkpatch.pl - please put it in your ' +
39 '~/bin directory or use --no-check')
41 def CheckPatch(fname, verbose=False):
42 """Run checkpatch.pl on a file.
45 namedtuple containing:
46 ok: False=failure, True=ok
47 problems: List of problems, each a dict:
48 'type'; error or warning
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
58 fields = ['ok', 'problems', 'errors', 'warnings', 'checks', 'lines',
60 result = collections.namedtuple('CheckPatchResult', fields)
62 result.errors, result.warning, result.checks = 0, 0, 0
65 chk = FindCheckPatch()
67 result.stdout = command.Output(chk, '--no-tree', fname,
69 #pipe = subprocess.Popen(cmd, stdout=subprocess.PIPE)
70 #stdout, stderr = pipe.communicate()
72 # total: 0 errors, 0 warnings, 159 lines checked
74 # total: 0 errors, 2 warnings, 7 checks, 473 lines checked
75 re_stats = re.compile('total: (\\d+) errors, (\d+) warnings, (\d+)')
76 re_stats_full = re.compile('total: (\\d+) errors, (\d+) warnings, (\d+)'
78 re_ok = re.compile('.*has no obvious style problems')
79 re_bad = re.compile('.*has style problems, please review')
80 re_error = re.compile('ERROR: (.*)')
81 re_warning = re.compile('WARNING: (.*)')
82 re_check = re.compile('CHECK: (.*)')
83 re_file = re.compile('#\d+: FILE: ([^:]*):(\d+):')
85 for line in result.stdout.splitlines():
89 # A blank line indicates the end of a message
91 result.problems.append(item)
93 match = re_stats_full.match(line)
95 match = re_stats.match(line)
97 result.errors = int(match.group(1))
98 result.warnings = int(match.group(2))
99 if len(match.groups()) == 4:
100 result.checks = int(match.group(3))
101 result.lines = int(match.group(4))
103 result.lines = int(match.group(3))
104 elif re_ok.match(line):
106 elif re_bad.match(line):
108 err_match = re_error.match(line)
109 warn_match = re_warning.match(line)
110 file_match = re_file.match(line)
111 check_match = re_check.match(line)
113 item['msg'] = err_match.group(1)
114 item['type'] = 'error'
116 item['msg'] = warn_match.group(1)
117 item['type'] = 'warning'
119 item['msg'] = check_match.group(1)
120 item['type'] = 'check'
122 item['file'] = file_match.group(1)
123 item['line'] = int(file_match.group(2))
127 def GetWarningMsg(col, msg_type, fname, line, msg):
128 '''Create a message for a given file/line
131 msg_type: Message type ('error' or 'warning')
132 fname: Filename which reports the problem
133 line: Line number where it was noticed
134 msg: Message to report
136 if msg_type == 'warning':
137 msg_type = col.Color(col.YELLOW, msg_type)
138 elif msg_type == 'error':
139 msg_type = col.Color(col.RED, msg_type)
140 elif msg_type == 'check':
141 msg_type = col.Color(col.MAGENTA, msg_type)
142 return '%s:%d: %s: %s\n' % (fname, line, msg_type, msg)
144 def CheckPatches(verbose, args):
145 '''Run the checkpatch.pl script on each patch'''
146 error_count, warning_count, check_count = 0, 0, 0
147 col = terminal.Color()
150 result = CheckPatch(fname, verbose)
152 error_count += result.errors
153 warning_count += result.warnings
154 check_count += result.checks
155 print('%d errors, %d warnings, %d checks for %s:' % (result.errors,
156 result.warnings, result.checks, col.Color(col.BLUE, fname)))
157 if (len(result.problems) != result.errors + result.warnings +
159 print("Internal error: some problems lost")
160 for item in result.problems:
162 GetWarningMsg(col, item.get('type', '<unknown>'),
163 item.get('file', '<unknown>'),
164 item.get('line', 0), item.get('msg', 'message')))
167 if error_count or warning_count or check_count:
168 str = 'checkpatch.pl found %d error(s), %d warning(s), %d checks(s)'
174 print(col.Color(color, str % (error_count, warning_count, check_count)))