dt: dt-extract-compatibles: Don't follow symlinks when walking tree

[ 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: b6acf8073517 ("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>

diff --git a/scripts/dtc/dt-extract-compatibles b/scripts/dtc/dt-extract-compatibles
index 05c47e3d8c00e208044e21564986057b3e6c7d87..9686a1cf85498b516484035d63f3f7a47878a2f3 100755 (executable)
--- a/scripts/dtc/dt-extract-compatibles
+++ b/scripts/dtc/dt-extract-compatibles
@@ -1,8 +1,8 @@
 #!/usr/bin/env python3
 # SPDX-License-Identifier: GPL-2.0-only
 
+import fnmatch
 import os
-import glob
 import re
 import argparse
 
@@ -49,10 +49,20 @@ def print_compat(filename, compatibles):
        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.iglob(f + "/**/*.c", recursive=True):
+                       for filename in glob_without_symlinks(f, "*.c"):
                                yield filename
                else:
                        yield f