3453531284
[ Upstream commit 8f51593cdcab82fb23ef2e1a0010b2e6f99aae02 ]
The iglob function, which we use to find C source files in the kernel
tree, always follows symbolic links. This can cause unintentional
recursions whenever a symbolic link points to a parent directory. A
common scenario is building the kernel with the output set to a
directory inside the kernel tree, which will contain such a symlink.
Instead of using the iglob function, use os.walk to traverse the
directory tree, which by default doesn't follow symbolic links. fnmatch
is then used to match the glob on the filename, as well as ignore hidden
files (which were ignored by default with iglob).
This approach runs just as fast as using iglob.
Fixes: b6acf80735 ("dt: Add a check for undocumented compatible strings in kernel")
Reported-by: Aishwarya TCV <aishwarya.tcv@arm.com>
Closes: https://lore.kernel.org/all/e90cb52f-d55b-d3ba-3933-6cc7b43fcfbc@arm.com
Signed-off-by: "Nícolas F. R. A. Prado" <nfraprado@collabora.com>
Link: https://lore.kernel.org/r/20231107225624.9811-1-nfraprado@collabora.com
Signed-off-by: Rob Herring <robh@kernel.org>
Signed-off-by: Sasha Levin <sashal@kernel.org>
83 lines
2.1 KiB
Python
Executable File
83 lines
2.1 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
# SPDX-License-Identifier: GPL-2.0-only
|
|
|
|
import fnmatch
|
|
import os
|
|
import re
|
|
import argparse
|
|
|
|
|
|
def parse_of_declare_macros(data):
|
|
""" Find all compatible strings in OF_DECLARE() style macros """
|
|
compat_list = []
|
|
# CPU_METHOD_OF_DECLARE does not have a compatible string
|
|
for m in re.finditer(r'(?<!CPU_METHOD_)(IRQCHIP|OF)_(DECLARE|MATCH)(_DRIVER)?\(.*?\)', data):
|
|
try:
|
|
compat = re.search(r'"(.*?)"', m[0])[1]
|
|
except:
|
|
# Fails on compatible strings in #define, so just skip
|
|
continue
|
|
compat_list += [compat]
|
|
|
|
return compat_list
|
|
|
|
|
|
def parse_of_device_id(data):
|
|
""" Find all compatible strings in of_device_id structs """
|
|
compat_list = []
|
|
for m in re.finditer(r'of_device_id\s+[a-zA-Z0-9_]+\[\]\s*=\s*({.*?);', data):
|
|
compat_list += re.findall(r'\.compatible\s+=\s+"([a-zA-Z0-9_\-,]+)"', m[1])
|
|
|
|
return compat_list
|
|
|
|
|
|
def parse_compatibles(file):
|
|
with open(file, 'r', encoding='utf-8') as f:
|
|
data = f.read().replace('\n', '')
|
|
|
|
compat_list = parse_of_declare_macros(data)
|
|
compat_list += parse_of_device_id(data)
|
|
|
|
return compat_list
|
|
|
|
def print_compat(filename, compatibles):
|
|
if not compatibles:
|
|
return
|
|
if show_filename:
|
|
compat_str = ' '.join(compatibles)
|
|
print(filename + ": compatible(s): " + compat_str)
|
|
else:
|
|
print(*compatibles, sep='\n')
|
|
|
|
def glob_without_symlinks(root, glob):
|
|
for path, dirs, files in os.walk(root):
|
|
# Ignore hidden directories
|
|
for d in dirs:
|
|
if fnmatch.fnmatch(d, ".*"):
|
|
dirs.remove(d)
|
|
for f in files:
|
|
if fnmatch.fnmatch(f, glob):
|
|
yield os.path.join(path, f)
|
|
|
|
def files_to_parse(path_args):
|
|
for f in path_args:
|
|
if os.path.isdir(f):
|
|
for filename in glob_without_symlinks(f, "*.c"):
|
|
yield filename
|
|
else:
|
|
yield f
|
|
|
|
show_filename = False
|
|
|
|
if __name__ == "__main__":
|
|
ap = argparse.ArgumentParser()
|
|
ap.add_argument("cfile", type=str, nargs='*', help="C source files or directories to parse")
|
|
ap.add_argument('-H', '--with-filename', help="Print filename with compatibles", action="store_true")
|
|
args = ap.parse_args()
|
|
|
|
show_filename = args.with_filename
|
|
|
|
for f in files_to_parse(args.cfile):
|
|
compat_list = parse_compatibles(f)
|
|
print_compat(f, compat_list)
|