blob: 00a10a293f4fc0c681533772af4b7dbe0c44b7d2 [file] [log] [blame]
Valentin Rothberg7c5227a2016-08-28 08:51:28 +02001#!/usr/bin/env python3
Thomas Gleixner4f190482019-05-27 08:55:14 +02002# SPDX-License-Identifier: GPL-2.0-only
Valentin Rothberg24fe1f02014-09-27 16:30:45 +02003
Valentin Rothbergb1a3f242015-03-16 12:16:14 +01004"""Find Kconfig symbols that are referenced but not defined."""
Valentin Rothberg24fe1f02014-09-27 16:30:45 +02005
Valentin Rothberg8e8e3332017-01-18 13:08:19 +01006# (c) 2014-2017 Valentin Rothberg <valentinrothberg@gmail.com>
Valentin Rothbergcc641d552014-11-08 20:56:35 +01007# (c) 2014 Stefan Hengelein <stefan.hengelein@fau.de>
Valentin Rothberg24fe1f02014-09-27 16:30:45 +02008#
Valentin Rothberg24fe1f02014-09-27 16:30:45 +02009
10
Valentin Rothberg14390e32016-08-28 08:51:29 +020011import argparse
Valentin Rothberg1b2c8412015-11-26 14:17:15 +010012import difflib
Valentin Rothberg24fe1f02014-09-27 16:30:45 +020013import os
14import re
Valentin Rothberge2042a82015-10-15 10:37:47 +020015import signal
Valentin Rothbergf175ba12016-08-27 10:59:07 +020016import subprocess
Valentin Rothbergb1a3f242015-03-16 12:16:14 +010017import sys
Valentin Rothberge2042a82015-10-15 10:37:47 +020018from multiprocessing import Pool, cpu_count
Valentin Rothberg24fe1f02014-09-27 16:30:45 +020019
Valentin Rothbergcc641d552014-11-08 20:56:35 +010020
21# regex expressions
Valentin Rothberg24fe1f02014-09-27 16:30:45 +020022OPERATORS = r"&|\(|\)|\||\!"
Valentin Rothbergef3f5542016-08-28 08:51:31 +020023SYMBOL = r"(?:\w*[A-Z0-9]\w*){2,}"
24DEF = r"^\s*(?:menu){,1}config\s+(" + SYMBOL + r")\s*"
25EXPR = r"(?:" + OPERATORS + r"|\s|" + SYMBOL + r")+"
Valentin Rothberg0bd38ae2015-07-27 12:33:05 +020026DEFAULT = r"default\s+.*?(?:if\s.+){,1}"
Valentin Rothberg3b28f4f2017-02-02 18:00:44 +010027STMT = r"^\s*(?:if|select|imply|depends\s+on|(?:" + DEFAULT + r"))\s+" + EXPR
Valentin Rothbergef3f5542016-08-28 08:51:31 +020028SOURCE_SYMBOL = r"(?:\W|\b)+[D]{,1}CONFIG_(" + SYMBOL + r")"
Valentin Rothberg24fe1f02014-09-27 16:30:45 +020029
Valentin Rothbergcc641d552014-11-08 20:56:35 +010030# regex objects
Valentin Rothberg24fe1f02014-09-27 16:30:45 +020031REGEX_FILE_KCONFIG = re.compile(r".*Kconfig[\.\w+\-]*$")
Valentin Rothbergef3f5542016-08-28 08:51:31 +020032REGEX_SYMBOL = re.compile(r'(?!\B)' + SYMBOL + r'(?!\B)')
33REGEX_SOURCE_SYMBOL = re.compile(SOURCE_SYMBOL)
Valentin Rothbergcc641d552014-11-08 20:56:35 +010034REGEX_KCONFIG_DEF = re.compile(DEF)
Valentin Rothberg24fe1f02014-09-27 16:30:45 +020035REGEX_KCONFIG_EXPR = re.compile(EXPR)
36REGEX_KCONFIG_STMT = re.compile(STMT)
37REGEX_KCONFIG_HELP = re.compile(r"^\s+(help|---help---)\s*$")
Valentin Rothbergef3f5542016-08-28 08:51:31 +020038REGEX_FILTER_SYMBOLS = re.compile(r"[A-Za-z0-9]$")
Valentin Rothberg0bd38ae2015-07-27 12:33:05 +020039REGEX_NUMERIC = re.compile(r"0[xX][0-9a-fA-F]+|[0-9]+")
Valentin Rothberge2042a82015-10-15 10:37:47 +020040REGEX_QUOTES = re.compile("(\"(.*?)\")")
Valentin Rothberg24fe1f02014-09-27 16:30:45 +020041
42
Valentin Rothbergb1a3f242015-03-16 12:16:14 +010043def parse_options():
44 """The user interface of this module."""
Valentin Rothberg14390e32016-08-28 08:51:29 +020045 usage = "Run this tool to detect Kconfig symbols that are referenced but " \
46 "not defined in Kconfig. If no option is specified, " \
47 "checkkconfigsymbols defaults to check your current tree. " \
48 "Please note that specifying commits will 'git reset --hard\' " \
49 "your current tree! You may save uncommitted changes to avoid " \
50 "losing data."
Valentin Rothbergb1a3f242015-03-16 12:16:14 +010051
Valentin Rothberg14390e32016-08-28 08:51:29 +020052 parser = argparse.ArgumentParser(description=usage)
Valentin Rothbergb1a3f242015-03-16 12:16:14 +010053
Valentin Rothberg14390e32016-08-28 08:51:29 +020054 parser.add_argument('-c', '--commit', dest='commit', action='store',
55 default="",
56 help="check if the specified commit (hash) introduces "
57 "undefined Kconfig symbols")
Valentin Rothbergb1a3f242015-03-16 12:16:14 +010058
Valentin Rothberg14390e32016-08-28 08:51:29 +020059 parser.add_argument('-d', '--diff', dest='diff', action='store',
60 default="",
61 help="diff undefined symbols between two commits "
62 "(e.g., -d commmit1..commit2)")
Valentin Rothbergb1a3f242015-03-16 12:16:14 +010063
Valentin Rothberg14390e32016-08-28 08:51:29 +020064 parser.add_argument('-f', '--find', dest='find', action='store_true',
65 default=False,
66 help="find and show commits that may cause symbols to be "
67 "missing (required to run with --diff)")
Valentin Rothberga42fa922015-06-01 16:00:19 +020068
Valentin Rothberg14390e32016-08-28 08:51:29 +020069 parser.add_argument('-i', '--ignore', dest='ignore', action='store',
70 default="",
71 help="ignore files matching this Python regex "
72 "(e.g., -i '.*defconfig')")
Valentin Rothbergcf132e42015-04-29 16:58:27 +020073
Valentin Rothberg14390e32016-08-28 08:51:29 +020074 parser.add_argument('-s', '--sim', dest='sim', action='store', default="",
75 help="print a list of max. 10 string-similar symbols")
Valentin Rothberg1b2c8412015-11-26 14:17:15 +010076
Valentin Rothberg14390e32016-08-28 08:51:29 +020077 parser.add_argument('--force', dest='force', action='store_true',
78 default=False,
79 help="reset current Git tree even when it's dirty")
Valentin Rothbergb1a3f242015-03-16 12:16:14 +010080
Valentin Rothberg14390e32016-08-28 08:51:29 +020081 parser.add_argument('--no-color', dest='color', action='store_false',
82 default=True,
83 help="don't print colored output (default when not "
84 "outputting to a terminal)")
Andrew Donnellan4c73c082016-07-05 17:47:37 +100085
Valentin Rothberg14390e32016-08-28 08:51:29 +020086 args = parser.parse_args()
Valentin Rothbergb1a3f242015-03-16 12:16:14 +010087
Valentin Rothberg14390e32016-08-28 08:51:29 +020088 if args.commit and args.diff:
Valentin Rothbergb1a3f242015-03-16 12:16:14 +010089 sys.exit("Please specify only one option at once.")
90
Valentin Rothberg0d18c192016-10-27 14:34:57 +020091 if args.diff and not re.match(r"^[\w\-\.\^]+\.\.[\w\-\.\^]+$", args.diff):
Valentin Rothbergb1a3f242015-03-16 12:16:14 +010092 sys.exit("Please specify valid input in the following format: "
Andreas Ziegler38cbfe42016-03-31 09:24:29 +020093 "\'commit1..commit2\'")
Valentin Rothbergb1a3f242015-03-16 12:16:14 +010094
Valentin Rothberg14390e32016-08-28 08:51:29 +020095 if args.commit or args.diff:
96 if not args.force and tree_is_dirty():
Valentin Rothbergb1a3f242015-03-16 12:16:14 +010097 sys.exit("The current Git tree is dirty (see 'git status'). "
98 "Running this script may\ndelete important data since it "
99 "calls 'git reset --hard' for some performance\nreasons. "
100 " Please run this script in a clean Git tree or pass "
101 "'--force' if you\nwant to ignore this warning and "
102 "continue.")
103
Valentin Rothberg14390e32016-08-28 08:51:29 +0200104 if args.commit:
105 args.find = False
Valentin Rothberga42fa922015-06-01 16:00:19 +0200106
Valentin Rothberg14390e32016-08-28 08:51:29 +0200107 if args.ignore:
Valentin Rothbergcf132e42015-04-29 16:58:27 +0200108 try:
Valentin Rothberg14390e32016-08-28 08:51:29 +0200109 re.match(args.ignore, "this/is/just/a/test.c")
Valentin Rothbergcf132e42015-04-29 16:58:27 +0200110 except:
111 sys.exit("Please specify a valid Python regex.")
112
Valentin Rothberg14390e32016-08-28 08:51:29 +0200113 return args
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100114
115
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200116def main():
117 """Main function of this module."""
Valentin Rothberg14390e32016-08-28 08:51:29 +0200118 args = parse_options()
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100119
Valentin Rothberg36c79c7f2016-08-28 08:51:30 +0200120 global COLOR
121 COLOR = args.color and sys.stdout.isatty()
Andrew Donnellan4c73c082016-07-05 17:47:37 +1000122
Valentin Rothberg14390e32016-08-28 08:51:29 +0200123 if args.sim and not args.commit and not args.diff:
124 sims = find_sims(args.sim, args.ignore)
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100125 if sims:
Valentin Rothberg7c5227a2016-08-28 08:51:28 +0200126 print("%s: %s" % (yel("Similar symbols"), ', '.join(sims)))
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100127 else:
Valentin Rothberg7c5227a2016-08-28 08:51:28 +0200128 print("%s: no similar symbols found" % yel("Similar symbols"))
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100129 sys.exit(0)
130
131 # dictionary of (un)defined symbols
132 defined = {}
133 undefined = {}
134
Valentin Rothberg14390e32016-08-28 08:51:29 +0200135 if args.commit or args.diff:
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100136 head = get_head()
137
138 # get commit range
139 commit_a = None
140 commit_b = None
Valentin Rothberg14390e32016-08-28 08:51:29 +0200141 if args.commit:
142 commit_a = args.commit + "~"
143 commit_b = args.commit
144 elif args.diff:
145 split = args.diff.split("..")
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100146 commit_a = split[0]
147 commit_b = split[1]
148 undefined_a = {}
149 undefined_b = {}
150
151 # get undefined items before the commit
Valentin Rothberg2f9cc122016-08-28 08:51:32 +0200152 reset(commit_a)
Valentin Rothberg14390e32016-08-28 08:51:29 +0200153 undefined_a, _ = check_symbols(args.ignore)
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100154
155 # get undefined items for the commit
Valentin Rothberg2f9cc122016-08-28 08:51:32 +0200156 reset(commit_b)
Valentin Rothberg14390e32016-08-28 08:51:29 +0200157 undefined_b, defined = check_symbols(args.ignore)
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100158
159 # report cases that are present for the commit but not before
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200160 for symbol in sorted(undefined_b):
161 # symbol has not been undefined before
162 if symbol not in undefined_a:
163 files = sorted(undefined_b.get(symbol))
164 undefined[symbol] = files
165 # check if there are new files that reference the undefined symbol
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100166 else:
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200167 files = sorted(undefined_b.get(symbol) -
168 undefined_a.get(symbol))
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100169 if files:
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200170 undefined[symbol] = files
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100171
172 # reset to head
Valentin Rothberg2f9cc122016-08-28 08:51:32 +0200173 reset(head)
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100174
175 # default to check the entire tree
176 else:
Valentin Rothberg14390e32016-08-28 08:51:29 +0200177 undefined, defined = check_symbols(args.ignore)
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100178
179 # now print the output
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200180 for symbol in sorted(undefined):
181 print(red(symbol))
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100182
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200183 files = sorted(undefined.get(symbol))
Valentin Rothberg7c5227a2016-08-28 08:51:28 +0200184 print("%s: %s" % (yel("Referencing files"), ", ".join(files)))
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100185
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200186 sims = find_sims(symbol, args.ignore, defined)
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100187 sims_out = yel("Similar symbols")
188 if sims:
Valentin Rothberg7c5227a2016-08-28 08:51:28 +0200189 print("%s: %s" % (sims_out, ', '.join(sims)))
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100190 else:
Valentin Rothberg7c5227a2016-08-28 08:51:28 +0200191 print("%s: %s" % (sims_out, "no similar symbols found"))
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100192
Valentin Rothberg14390e32016-08-28 08:51:29 +0200193 if args.find:
Valentin Rothberg7c5227a2016-08-28 08:51:28 +0200194 print("%s:" % yel("Commits changing symbol"))
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200195 commits = find_commits(symbol, args.diff)
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100196 if commits:
197 for commit in commits:
198 commit = commit.split(" ", 1)
Valentin Rothberg7c5227a2016-08-28 08:51:28 +0200199 print("\t- %s (\"%s\")" % (yel(commit[0]), commit[1]))
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100200 else:
Valentin Rothberg7c5227a2016-08-28 08:51:28 +0200201 print("\t- no commit found")
Valentin Rothberg36c79c7f2016-08-28 08:51:30 +0200202 print() # new line
Valentin Rothbergc7455662015-06-01 16:00:20 +0200203
204
Valentin Rothberg2f9cc122016-08-28 08:51:32 +0200205def reset(commit):
206 """Reset current git tree to %commit."""
207 execute(["git", "reset", "--hard", commit])
208
209
Valentin Rothbergc7455662015-06-01 16:00:20 +0200210def yel(string):
211 """
212 Color %string yellow.
213 """
Valentin Rothberg36c79c7f2016-08-28 08:51:30 +0200214 return "\033[33m%s\033[0m" % string if COLOR else string
Valentin Rothbergc7455662015-06-01 16:00:20 +0200215
216
217def red(string):
218 """
219 Color %string red.
220 """
Valentin Rothberg36c79c7f2016-08-28 08:51:30 +0200221 return "\033[31m%s\033[0m" % string if COLOR else string
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100222
223
224def execute(cmd):
225 """Execute %cmd and return stdout. Exit in case of error."""
Valentin Rothbergf175ba12016-08-27 10:59:07 +0200226 try:
Valentin Rothberg2f9cc122016-08-28 08:51:32 +0200227 stdout = subprocess.check_output(cmd, stderr=subprocess.STDOUT, shell=False)
Valentin Rothberg7c5227a2016-08-28 08:51:28 +0200228 stdout = stdout.decode(errors='replace')
Valentin Rothbergf175ba12016-08-27 10:59:07 +0200229 except subprocess.CalledProcessError as fail:
Valentin Rothberg2f9cc122016-08-28 08:51:32 +0200230 exit(fail)
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100231 return stdout
232
233
Valentin Rothberga42fa922015-06-01 16:00:19 +0200234def find_commits(symbol, diff):
235 """Find commits changing %symbol in the given range of %diff."""
Valentin Rothberg2f9cc122016-08-28 08:51:32 +0200236 commits = execute(["git", "log", "--pretty=oneline",
237 "--abbrev-commit", "-G",
238 symbol, diff])
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100239 return [x for x in commits.split("\n") if x]
Valentin Rothberga42fa922015-06-01 16:00:19 +0200240
241
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100242def tree_is_dirty():
243 """Return true if the current working tree is dirty (i.e., if any file has
244 been added, deleted, modified, renamed or copied but not committed)."""
Valentin Rothberg2f9cc122016-08-28 08:51:32 +0200245 stdout = execute(["git", "status", "--porcelain"])
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100246 for line in stdout:
247 if re.findall(r"[URMADC]{1}", line[:2]):
248 return True
249 return False
250
251
252def get_head():
253 """Return commit hash of current HEAD."""
Valentin Rothberg2f9cc122016-08-28 08:51:32 +0200254 stdout = execute(["git", "rev-parse", "HEAD"])
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100255 return stdout.strip('\n')
256
257
Valentin Rothberge2042a82015-10-15 10:37:47 +0200258def partition(lst, size):
259 """Partition list @lst into eveni-sized lists of size @size."""
Valentin Rothberg7c5227a2016-08-28 08:51:28 +0200260 return [lst[i::size] for i in range(size)]
Valentin Rothberge2042a82015-10-15 10:37:47 +0200261
262
263def init_worker():
264 """Set signal handler to ignore SIGINT."""
265 signal.signal(signal.SIGINT, signal.SIG_IGN)
266
267
Valentin Rothberg36c79c7f2016-08-28 08:51:30 +0200268def find_sims(symbol, ignore, defined=[]):
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100269 """Return a list of max. ten Kconfig symbols that are string-similar to
270 @symbol."""
271 if defined:
Valentin Rothberg8e8e3332017-01-18 13:08:19 +0100272 return difflib.get_close_matches(symbol, set(defined), 10)
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100273
274 pool = Pool(cpu_count(), init_worker)
275 kfiles = []
276 for gitfile in get_files():
277 if REGEX_FILE_KCONFIG.match(gitfile):
278 kfiles.append(gitfile)
279
280 arglist = []
281 for part in partition(kfiles, cpu_count()):
282 arglist.append((part, ignore))
283
284 for res in pool.map(parse_kconfig_files, arglist):
285 defined.extend(res[0])
286
Valentin Rothberg8e8e3332017-01-18 13:08:19 +0100287 return difflib.get_close_matches(symbol, set(defined), 10)
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100288
289
290def get_files():
291 """Return a list of all files in the current git directory."""
292 # use 'git ls-files' to get the worklist
Valentin Rothberg2f9cc122016-08-28 08:51:32 +0200293 stdout = execute(["git", "ls-files"])
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100294 if len(stdout) > 0 and stdout[-1] == "\n":
295 stdout = stdout[:-1]
296
297 files = []
298 for gitfile in stdout.rsplit("\n"):
299 if ".git" in gitfile or "ChangeLog" in gitfile or \
300 ".log" in gitfile or os.path.isdir(gitfile) or \
301 gitfile.startswith("tools/"):
302 continue
303 files.append(gitfile)
304 return files
305
306
Valentin Rothbergcf132e42015-04-29 16:58:27 +0200307def check_symbols(ignore):
Valentin Rothbergb1a3f242015-03-16 12:16:14 +0100308 """Find undefined Kconfig symbols and return a dict with the symbol as key
Valentin Rothbergcf132e42015-04-29 16:58:27 +0200309 and a list of referencing files as value. Files matching %ignore are not
310 checked for undefined symbols."""
Valentin Rothberge2042a82015-10-15 10:37:47 +0200311 pool = Pool(cpu_count(), init_worker)
312 try:
313 return check_symbols_helper(pool, ignore)
314 except KeyboardInterrupt:
315 pool.terminate()
316 pool.join()
317 sys.exit(1)
318
319
320def check_symbols_helper(pool, ignore):
321 """Helper method for check_symbols(). Used to catch keyboard interrupts in
322 check_symbols() in order to properly terminate running worker processes."""
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200323 source_files = []
324 kconfig_files = []
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200325 defined_symbols = []
326 referenced_symbols = dict() # {file: [symbols]}
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200327
Valentin Rothberg1b2c8412015-11-26 14:17:15 +0100328 for gitfile in get_files():
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200329 if REGEX_FILE_KCONFIG.match(gitfile):
330 kconfig_files.append(gitfile)
331 else:
Valentin Rothberge2042a82015-10-15 10:37:47 +0200332 if ignore and not re.match(ignore, gitfile):
333 continue
334 # add source files that do not match the ignore pattern
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200335 source_files.append(gitfile)
336
Valentin Rothberge2042a82015-10-15 10:37:47 +0200337 # parse source files
338 arglist = partition(source_files, cpu_count())
339 for res in pool.map(parse_source_files, arglist):
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200340 referenced_symbols.update(res)
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200341
Valentin Rothberge2042a82015-10-15 10:37:47 +0200342 # parse kconfig files
343 arglist = []
344 for part in partition(kconfig_files, cpu_count()):
345 arglist.append((part, ignore))
346 for res in pool.map(parse_kconfig_files, arglist):
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200347 defined_symbols.extend(res[0])
348 referenced_symbols.update(res[1])
349 defined_symbols = set(defined_symbols)
Valentin Rothberge2042a82015-10-15 10:37:47 +0200350
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200351 # inverse mapping of referenced_symbols to dict(symbol: [files])
Valentin Rothberge2042a82015-10-15 10:37:47 +0200352 inv_map = dict()
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200353 for _file, symbols in referenced_symbols.items():
354 for symbol in symbols:
355 inv_map[symbol] = inv_map.get(symbol, set())
356 inv_map[symbol].add(_file)
357 referenced_symbols = inv_map
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200358
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200359 undefined = {} # {symbol: [files]}
360 for symbol in sorted(referenced_symbols):
Valentin Rothbergcc641d552014-11-08 20:56:35 +0100361 # filter some false positives
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200362 if symbol == "FOO" or symbol == "BAR" or \
363 symbol == "FOO_BAR" or symbol == "XXX":
Valentin Rothbergcc641d552014-11-08 20:56:35 +0100364 continue
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200365 if symbol not in defined_symbols:
366 if symbol.endswith("_MODULE"):
Valentin Rothbergcc641d552014-11-08 20:56:35 +0100367 # avoid false positives for kernel modules
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200368 if symbol[:-len("_MODULE")] in defined_symbols:
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200369 continue
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200370 undefined[symbol] = referenced_symbols.get(symbol)
371 return undefined, defined_symbols
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200372
373
Valentin Rothberge2042a82015-10-15 10:37:47 +0200374def parse_source_files(source_files):
375 """Parse each source file in @source_files and return dictionary with source
376 files as keys and lists of references Kconfig symbols as values."""
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200377 referenced_symbols = dict()
Valentin Rothberge2042a82015-10-15 10:37:47 +0200378 for sfile in source_files:
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200379 referenced_symbols[sfile] = parse_source_file(sfile)
380 return referenced_symbols
Valentin Rothberge2042a82015-10-15 10:37:47 +0200381
382
383def parse_source_file(sfile):
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200384 """Parse @sfile and return a list of referenced Kconfig symbols."""
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200385 lines = []
Valentin Rothberge2042a82015-10-15 10:37:47 +0200386 references = []
387
388 if not os.path.exists(sfile):
389 return references
390
Valentin Rothberg7c5227a2016-08-28 08:51:28 +0200391 with open(sfile, "r", encoding='utf-8', errors='replace') as stream:
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200392 lines = stream.readlines()
393
394 for line in lines:
Valentin Rothberg36c79c7f2016-08-28 08:51:30 +0200395 if "CONFIG_" not in line:
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200396 continue
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200397 symbols = REGEX_SOURCE_SYMBOL.findall(line)
398 for symbol in symbols:
399 if not REGEX_FILTER_SYMBOLS.search(symbol):
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200400 continue
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200401 references.append(symbol)
Valentin Rothberge2042a82015-10-15 10:37:47 +0200402
403 return references
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200404
405
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200406def get_symbols_in_line(line):
407 """Return mentioned Kconfig symbols in @line."""
408 return REGEX_SYMBOL.findall(line)
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200409
410
Valentin Rothberge2042a82015-10-15 10:37:47 +0200411def parse_kconfig_files(args):
412 """Parse kconfig files and return tuple of defined and references Kconfig
413 symbols. Note, @args is a tuple of a list of files and the @ignore
414 pattern."""
415 kconfig_files = args[0]
416 ignore = args[1]
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200417 defined_symbols = []
418 referenced_symbols = dict()
Valentin Rothberge2042a82015-10-15 10:37:47 +0200419
420 for kfile in kconfig_files:
421 defined, references = parse_kconfig_file(kfile)
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200422 defined_symbols.extend(defined)
Valentin Rothberge2042a82015-10-15 10:37:47 +0200423 if ignore and re.match(ignore, kfile):
424 # do not collect references for files that match the ignore pattern
425 continue
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200426 referenced_symbols[kfile] = references
427 return (defined_symbols, referenced_symbols)
Valentin Rothberge2042a82015-10-15 10:37:47 +0200428
429
430def parse_kconfig_file(kfile):
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200431 """Parse @kfile and update symbol definitions and references."""
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200432 lines = []
Valentin Rothberge2042a82015-10-15 10:37:47 +0200433 defined = []
434 references = []
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200435 skip = False
436
Valentin Rothberge2042a82015-10-15 10:37:47 +0200437 if not os.path.exists(kfile):
438 return defined, references
439
Valentin Rothberg7c5227a2016-08-28 08:51:28 +0200440 with open(kfile, "r", encoding='utf-8', errors='replace') as stream:
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200441 lines = stream.readlines()
442
443 for i in range(len(lines)):
444 line = lines[i]
445 line = line.strip('\n')
Valentin Rothbergcc641d552014-11-08 20:56:35 +0100446 line = line.split("#")[0] # ignore comments
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200447
448 if REGEX_KCONFIG_DEF.match(line):
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200449 symbol_def = REGEX_KCONFIG_DEF.findall(line)
450 defined.append(symbol_def[0])
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200451 skip = False
452 elif REGEX_KCONFIG_HELP.match(line):
453 skip = True
454 elif skip:
Valentin Rothbergcc641d552014-11-08 20:56:35 +0100455 # ignore content of help messages
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200456 pass
457 elif REGEX_KCONFIG_STMT.match(line):
Valentin Rothberge2042a82015-10-15 10:37:47 +0200458 line = REGEX_QUOTES.sub("", line)
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200459 symbols = get_symbols_in_line(line)
Valentin Rothbergcc641d552014-11-08 20:56:35 +0100460 # multi-line statements
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200461 while line.endswith("\\"):
462 i += 1
463 line = lines[i]
464 line = line.strip('\n')
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200465 symbols.extend(get_symbols_in_line(line))
466 for symbol in set(symbols):
467 if REGEX_NUMERIC.match(symbol):
Valentin Rothberg0bd38ae2015-07-27 12:33:05 +0200468 # ignore numeric values
469 continue
Valentin Rothbergef3f5542016-08-28 08:51:31 +0200470 references.append(symbol)
Valentin Rothberge2042a82015-10-15 10:37:47 +0200471
472 return defined, references
Valentin Rothberg24fe1f02014-09-27 16:30:45 +0200473
474
475if __name__ == "__main__":
476 main()