chore(tools): add structure checker

This commit is contained in:
Microindole 2026-05-10 12:18:15 +08:00
parent 7db47d0e38
commit edd6e5f2d1
No known key found for this signature in database
GPG Key ID: 22FB34CD2133ACA1
4 changed files with 230 additions and 35 deletions

View File

@ -67,7 +67,7 @@
- 可独立执行的检查放在 `scripts/checks/`
- 多个检查共享的函数放在 `scripts/lib/`
- 不把所有检查逻辑持续堆进 `scripts/check.sh`
- 项目结构规则放在 `scripts/checks/structure.sh`,优先用宿主 Linux/LLVM 工具实现底层扫描,把 Tianole 自己的目录和 include 约束固化在脚本里。
- 项目结构规则放在 `scripts/tools/check_structure.py`,由 `scripts/checks/structure.sh` 调用;优先用宿主 Linux/LLVM 工具实现底层检查,把 Tianole 自己的目录和 include 约束固化在轻量 Python 工具里。
- 启动阶段内核自测集中放在 `kernel/selftest/`,不要散落在具体实现目录里。
## 验证

View File

@ -31,12 +31,18 @@ check_lines build/debug.log \
"preempt thread 2 step=1" \
"waiter sleeping" \
"waker sleeping" \
"condition waiter sleeping" \
"condition waker sleeping" \
"timeout waiter sleeping" \
"preempt thread 1 step=2" \
"preempt thread 2 step=2" \
"timeout waiter timed out" \
"preempt thread 1 step=3" \
"preempt thread 2 step=3" \
"waker wake_one" \
"waiter woke" \
"condition waker wake_all" \
"condition waiter woke" \
"timer tick=1" \
"timer tick=2" \
"timer tick=3"
@ -62,12 +68,18 @@ check_lines build/serial.log \
"preempt thread 2 step=1" \
"waiter sleeping" \
"waker sleeping" \
"condition waiter sleeping" \
"condition waker sleeping" \
"timeout waiter sleeping" \
"preempt thread 1 step=2" \
"preempt thread 2 step=2" \
"timeout waiter timed out" \
"preempt thread 1 step=3" \
"preempt thread 2 step=3" \
"waker wake_one" \
"waiter woke" \
"condition waker wake_all" \
"condition waiter woke" \
"timer tick=1" \
"timer tick=2" \
"timer tick=3"

View File

@ -3,37 +3,4 @@ set -euo pipefail
cd "$(dirname "$0")/../.."
fail()
{
echo "structure check failed: $*" >&2
exit 1
}
check_no_relative_parent_includes()
{
local matches
matches=$(find arch include kernel mm -name '*.c' -o -name '*.h' |
xargs grep -nE '^[[:space:]]*#include[[:space:]]+[<"]\.\./' || true)
if [ -n "$matches" ]; then
echo "$matches" >&2
fail "do not use ../ includes; promote shared headers or add a private include root"
fi
}
check_selftests_are_centralized()
{
local matches
matches=$(find arch kernel mm -name '*selftest*.c' |
grep -v '^kernel/selftest/' || true)
if [ -n "$matches" ]; then
echo "$matches" >&2
fail "kernel selftests belong under kernel/selftest/"
fi
}
check_no_relative_parent_includes
check_selftests_are_centralized
python3 scripts/tools/check_structure.py --all

View File

@ -0,0 +1,216 @@
#!/usr/bin/env python3
import argparse
import re
import subprocess
import sys
from pathlib import Path
SOURCE_ROOTS = ("arch", "include", "kernel", "mm")
C_SOURCE_ROOTS = ("arch", "kernel", "mm")
MAKEFILE_SOURCE_VARS = (
"ARCH_KERNEL_SRCS",
"ARCH_MM_SRCS",
"BOOT_SRCS",
"KERNEL_SRCS",
"MM_SRCS",
)
def repo_root() -> Path:
return Path(__file__).resolve().parents[2]
def run_git(root: Path, args: list[str]) -> list[str]:
result = subprocess.run(
["git", *args],
cwd=root,
check=True,
text=True,
stdout=subprocess.PIPE,
)
return [line for line in result.stdout.splitlines() if line]
def changed_files(root: Path) -> set[Path]:
files = set()
for path in run_git(root, ["diff", "--name-only", "--diff-filter=ACMR"]):
files.add(Path(path))
for path in run_git(
root, ["diff", "--cached", "--name-only", "--diff-filter=ACMR"]
):
files.add(Path(path))
for path in run_git(root, ["ls-files", "--others", "--exclude-standard"]):
files.add(Path(path))
return files
def all_files(root: Path) -> set[Path]:
files = set()
for base in SOURCE_ROOTS:
root_dir = root / base
if not root_dir.exists():
continue
for path in root_dir.rglob("*"):
if path.is_file():
files.add(path.relative_to(root))
for path in (root / "scripts").rglob("*"):
if path.is_file():
files.add(path.relative_to(root))
return files
def source_files(files: set[Path]) -> list[Path]:
return sorted(path for path in files if path.suffix in (".c", ".h"))
def c_files(files: set[Path]) -> list[Path]:
return sorted(
path
for path in files
if path.suffix == ".c" and path.parts and path.parts[0] in C_SOURCE_ROOTS
)
def read_text(root: Path, path: Path) -> str:
return (root / path).read_text(encoding="utf-8")
def check_no_relative_parent_includes(root: Path, files: list[Path]) -> list[str]:
errors = []
include_re = re.compile(r'^\s*#include\s+[<"]\.\./')
for path in files:
for line_no, line in enumerate(read_text(root, path).splitlines(), 1):
if include_re.search(line):
errors.append(
f"{path}:{line_no}: do not use ../ includes; "
"promote shared headers or add a private include root"
)
return errors
def check_selftests_are_centralized(files: list[Path]) -> list[str]:
errors = []
for path in files:
if "selftest" not in path.name:
continue
if len(path.parts) < 2 or path.parts[:2] != ("kernel", "selftest"):
errors.append(f"{path}: kernel selftests belong under kernel/selftest/")
return errors
def expand_make_var_token(token: str, makefile: Path) -> str:
return token.replace("$(ARCH_DIR)", "arch/x86").replace(
"$(BUILD_DIR)", "build"
)
def parse_makefile_sources(root: Path, makefile: Path) -> set[Path]:
text = read_text(root, makefile)
lines = text.splitlines()
sources = set()
index = 0
while index < len(lines):
line = lines[index]
match = re.match(r"^([A-Z0-9_]+)\s*:=", line)
if match == None or match.group(1) not in MAKEFILE_SOURCE_VARS:
index += 1
continue
remainder = line.split(":=", 1)[1].strip()
while True:
continued = remainder.endswith("\\")
remainder = remainder[:-1].strip() if continued else remainder
if remainder:
for token in remainder.split():
if token.endswith(".c"):
sources.add(Path(expand_make_var_token(token, makefile)))
if not continued:
break
index += 1
if index >= len(lines):
break
remainder = lines[index].strip()
index += 1
return sources
def makefile_sources(root: Path) -> set[Path]:
sources = set()
for makefile in sorted(root.rglob("Makefile")):
if "build" in makefile.parts:
continue
sources.update(parse_makefile_sources(root, makefile.relative_to(root)))
return sources
def check_makefile_source_lists(root: Path, files: set[Path], all_mode: bool) -> list[str]:
errors = []
listed = makefile_sources(root)
existing = set(c_files(all_files(root)))
for path in sorted(listed):
if not (root / path).exists():
errors.append(f"{path}: listed in Makefile but file does not exist")
if all_mode:
for path in sorted(existing - listed):
errors.append(f"{path}: C source is not listed in a Makefile source list")
else:
for path in sorted(c_files(files)):
if path not in listed:
errors.append(
f"{path}: changed C source is not listed in a Makefile source list"
)
return errors
def main() -> int:
parser = argparse.ArgumentParser(description="Check Tianole structure rules")
mode = parser.add_mutually_exclusive_group()
mode.add_argument("--all", action="store_true", help="check the whole tree")
mode.add_argument(
"--changed", action="store_true", help="check changed and untracked files"
)
args = parser.parse_args()
root = repo_root()
all_mode = not args.changed
files = all_files(root) if all_mode else changed_files(root)
errors = []
errors.extend(check_no_relative_parent_includes(root, source_files(files)))
errors.extend(check_selftests_are_centralized(c_files(files)))
errors.extend(check_makefile_source_lists(root, files, all_mode))
if errors:
for error in errors:
print(error, file=sys.stderr)
return 1
return 0
if __name__ == "__main__":
raise SystemExit(main())