Commit 8f51593c authored by Nícolas F. R. A. Prado's avatar Nícolas F. R. A. Prado Committed by Rob Herring
Browse files

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



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: b6acf807 ("dt: Add a check for undocumented compatible strings in kernel")
Reported-by: default avatarAishwarya TCV <aishwarya.tcv@arm.com>
Closes: https://lore.kernel.org/all/e90cb52f-d55b-d3ba-3933-6cc7b43fcfbc@arm.com


Signed-off-by: default avatar"Nícolas F. R. A. Prado" <nfraprado@collabora.com>
Link: https://lore.kernel.org/r/20231107225624.9811-1-nfraprado@collabora.com


Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent fe612629

scripts/dtc/dt-extract-compatibles

+12 −2
Original line number Diff line number Diff line 
#!/usr/bin/env python3

# SPDX-License-Identifier: GPL-2.0-only



import fnmatch

import os

import glob

import re

import argparse
@@ -81,10 +81,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