Files
hexagon-dsp-binaries/scripts/check.py
Dmitry Baryshkov cbe0320d64 scripts/check: don't choke on missing subdirs
The check.py script already warns about missing dirs. Don't choke on
them in check_dirs(), fixing the following crash:

Traceback (most recent call last):
  File "/home/lumag/Projects/Qcomm/Firmware/hexagon-dsp-binaries/./scripts/check.py", line 249, in <module>
    sys.exit(main())
             ~~~~^^
  File "/home/lumag/Projects/Qcomm/Firmware/hexagon-dsp-binaries/./scripts/check.py", line 242, in main
    if not check_dir(entry):
           ~~~~~~~~~^^^^^^^
  File "/home/lumag/Projects/Qcomm/Firmware/hexagon-dsp-binaries/./scripts/check.py", line 184, in check_dir
    for file in os.listdir(subdir):
                ~~~~~~~~~~^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: 'qcs615/Qualcomm/foo/bar'

Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>
2025-10-22 15:17:26 +03:00

254 lines
7.2 KiB
Python
Executable File

#! /usr/bin/python3
# SPDX-License-Identifier: MIT
# Copyright (c) 2024-2025 Linaro Ltd.
import os, re, sys
def empty_data():
return {'dirs': {}}
def verify_data(data):
if data == empty_data():
return True
ret = True
blocklineno = min(data['dirs'].values())
for (entry, lineno) in data['dirs'].items():
if not os.path.exists(entry):
sys.stderr.write("WHENCE:%d: dir %s doesn't exist\n" % (lineno, entry))
ret = False
elif not os.path.isdir(entry):
sys.stderr.write("WHENCE:%d: %s is not a directory\n" % (lineno, entry))
ret = False
elif entry.endswith("/"):
sys.stderr.write("WHENCE:%d: stray ending '/' in %s\n" % (lineno, entry))
ret = False
if 'licence' in data:
lic, lineno = data['licence']
if not os.path.exists(lic):
sys.stderr.write("WHENCE:%d: licence %s doesn't exist\n" % (lineno, lic))
ret = False
elif not os.path.isfile(lic):
sys.stderr.write("WHENCE:%d: %s is not a file\n" % (lineno, lic))
ret = False
else:
sys.stderr.write("WHENCE:%d: licence not specified\n" % blocklineno)
ret = False
if 'status' in data:
status, lineno = data['status']
if "Redistributable" not in status:
sys.stderr.write("WHENCE:%d: binaries are not redistributable\n" % lineno)
ret = False
else:
sys.stderr.write("WHENCE:%d: status not specified\n" % blocklineno)
ret = False
return ret
def load_whence():
data = empty_data()
with open("WHENCE", encoding="utf-8") as file:
pattern_dir = re.compile("^Dir: (.*)\n$")
pattern_licence = re.compile("^Licence: (.*)\n$")
pattern_status = re.compile("^Status: (.*)\n$")
pattern_break = re.compile("^----")
for (lineno, line) in enumerate(file, start=1):
match = pattern_dir.match(line)
if match:
data['dirs'][match.group(1)] = lineno
continue
match = pattern_licence.match(line)
if match:
data['licence'] = (match.group(1), lineno)
match = pattern_status.match(line)
if match:
data['status'] = (match.group(1), lineno)
match = pattern_break.match(line)
if match:
yield data
data = empty_data()
continue
# return final data entry, might be empty
yield data
def load_config():
with open("config.txt", encoding="utf-8") as file:
pattern_empty = re.compile("^#|^$")
pattern_install = re.compile("Install: ([^ \t]+)[ \t]+([^ \t]+)[ \t]+([^ \t]+)\n")
pattern_link = re.compile("Link: ([^ \t]+)[ \t]+([^ \t]+)\n")
for (lineno, line) in enumerate(file, start=1):
if pattern_empty.match(line):
continue
match = pattern_install.match(line)
if match:
yield ("install", lineno, *match.groups())
continue
match = pattern_link.match(line)
if match:
yield ("link", lineno, *match.groups())
continue
raise Exception("config.txt: %d: failed to parse '%s'" % (lineno, line[:-1]))
DSPS = [ "adsp", "cdsp", "sdsp", "cdsp1", "gdsp0", "gdsp1" ]
def check_install_config(data, dirs):
(lineno, path, dsp, subdir) = data
ret = True
if path.endswith("/"):
sys.stderr.write("config.txt: %d: trailing '/' in %s\n" % (lineno, path))
ret = False
if subdir.endswith("/"):
sys.stderr.write("config.txt: %d: trailing '/' in %s\n" % (lineno, subdir))
ret = False
full = "%s/%s" % (path, subdir)
if full not in dirs:
sys.stderr.write("config.txt: %d: path '%s' not found in WHENCE\n" % (lineno, full))
ret = False
if dsp not in DSPS:
sys.stderr.write("config.txt: %d: unknown DSP type '%s'\n" % (lineno, dsp))
ret = False
return ret
def check_link_config(data):
(lineno, src_path, dst_path) = data
ret = True
if src_path.endswith("/"):
sys.stderr.write("config.txt: %d: trailing '/' in %s\n" % (lineno, src_path))
ret = False
if dst_path.endswith("/"):
sys.stderr.write("config.txt: %d: trailing '/' in %s\n" % (lineno, dst_path))
ret = False
dsp_path = os.path.dirname(src_path)
sourcedir = os.path.dirname(dsp_path)
if not os.path.exists(sourcedir):
sys.stderr.write("config.txt: %d: dir %s doesn't exist\n" % (lineno, sourcedir))
ret = False
if os.path.basename(dsp_path) != "dsp":
sys.stderr.write("config.txt: %d: DSP type not under 'dsp' dir %s\n" % (lineno, src_path))
ret = False
return ret
def check_config(data, dirs):
ret = True
if data[0] == "install":
ret = check_install_config(data[1:], dirs)
elif data[0] == "link":
ret = check_link_config(data[1:])
return ret
def list_git():
if not os.path.exists(".git"):
sys.stderr.write("Skipping git ls-files check, no .git dir")
return None
git = os.popen("git ls-files")
for file in git:
yield file.rstrip("\n")
if git.close():
sys.stderr.write("WHENCE: skipped contents validation, git file listing failed\n")
def check_dir(subdir):
pattern_shell = re.compile("^fastrpc_shell(_unsigned)?_[0-9]$")
pattern_library = re.compile("^[-_+0-9a-zA-Z]*\\.so(\\.[0-9]*)?$")
okay = True
# We alrady warned earlier
if not os.path.exists(subdir):
return False
for file in os.listdir(subdir):
fullname = os.path.join(subdir, file)
if not os.path.isfile(fullname):
sys.stderr.write("WHENCE: not a file %s\n" % fullname)
okay = False
if not pattern_shell.match(file) and \
not pattern_library.match(file):
sys.stderr.write("WHENCE: unknown file type %s\n" % fullname)
okay = False
return okay
def main():
okay = True
dirs = {}
licences = {'LICENSE.MIT' : None}
for data in load_whence():
if not verify_data(data):
okay = False
dirs.update(dict.fromkeys(data['dirs'].keys()))
if 'licence' in data:
licences[data['licence'][0]] = None
known_files = ['config.txt', 'Makefile', 'TODO', 'README.md', 'WHENCE']
for file in list_git():
if os.path.dirname(file) in dirs:
continue
if file in licences:
continue
if os.path.dirname(file) == 'scripts':
continue
if os.path.dirname(file) == '.github/workflows':
continue
if file in known_files:
continue
sys.stderr.write("WHENCE: file %s is not under a listed directory\n" % file)
okay = False
try:
for data in load_config():
if not check_config(data, dirs):
okay = False
except Exception as e:
sys.stderr.write("%s\n" % e)
okay = False
for entry in dirs.keys():
if not check_dir(entry):
sys.stderr.write("WHENCE: subdir %s failed the checks\n" % entry)
okay = False
return 0 if okay else 1
if __name__ == "__main__":
sys.exit(main())