Files
STM32F4-Base/scripts
wandering1 63cf73b4d0 refactor(NET): 事件处理与周期对账抽出 net_events.c,net_socket.c 3720→3119
动机:net_socket.c 3720 行(注释 1878 / 代码 1518 / 54 函数),BSD 连接层
与"状态面收敛"两套职责混在一个文件里。16 个消费者只依赖 net_socket.h,
故搬移对应用层零波及;模拟器另有 net_socket_sim.c,新模块走 SIM_EXEMPT。

为什么是一个模块而不是两个:实测对账区真实调用事件处理器 2 处(形态② 补
accept 走 handle_connect_event),且 NET_RECON_STABLE_DEATH 两边共用——
拆成 net_events.c + net_reconcile.c 会造出跨模块调用,合起来则跨模块导出
为零。二者同属"芯片状态面与本层镜像的收敛"一个职责。

搬出:5 个 handle_*_event + fire_event + net_reconcile_tick +
net_lost_connect_probe + NET_RECONCILE_*/NET_RECON_STABLE_* 常量 +
net_bench_cmd_log(含其 2 个 static)。

搬移时 4 处 fd 取法替换(其余代码逐行未改,已用剥注释后的代码行多重集
证明差异恰好等于声明的改动集):
- p_sock - s_net_socks → p_sock->ch395_sock(net_socket() 里
  ch395_sock = sockfd,恒等;模拟器同构造)
- 对账循环 &s_net_socks[i] → net_sock_raw(i)

⚠ 随之收窄两处沉降登记的范围门 (qfd >= 0) && (qfd < MAX) → qfd < MAX:
ch395_sock 是 uint8_t,(int) 后恒非负,下界在类型上不可能越界;留着会被
cppcheck 判 knownConditionTrueFalse 拦提交。已在文件头写"勿加回"。

新增 net_sock_raw():对账必须看到 in_use==0 / state==CLOSED 的槽位
(形态④ 认领孤儿监听正依赖 CLOSED 态),而 net_get_sock() 对未在用槽位返
回 NULL 会漏掉这一类。声明放 net_socket.h 而非内部头 net_events.h——规范
S17 2.2 要求非 static 函数声明在配对头文件(同 net_set_errno 先例)。

验证:
- 代码行多重集差异 = 声明的改动集,无一处意外
- @build BUILD_OK 0 错 0 警;Code 212316→212296(−20 B,拆 TU 布局差),
  RO/RW/ZI 完全不变
- cppcheck / coding-standard / registration-check 全 PASS
- @test 硬件闭环 PASS:635ms 到 net init: OK,:8888/:2404/FTP 均建立,
  [ERR]/Fault/relisten/reconcile 命中 0 条
- 台账随 Code 变化同步(ram_baseline --write / check_mem_numbers --write)

遗留(与仍未提交的文档工作同文件,另提):BSD_Socket_API 使用指南的文件
职责表、net_listener.c/.h 文件头"见 net_socket.c"、自愈架构设计 §11 仍把
net_reconcile_tick 记在 net_socket.c——doc-links 只校验 § 编号存在性,
照不出"函数在哪个文件",需在文档提交中一并修正。
2026-10-14 18:04:57 +08:00
..

scripts/ — 开发脚本(提交门禁 + 报告生成)

本目录是 pre-commit 门禁脚本与报告生成脚本的存放处。 与 tools/(面向开发者的功能工具)区别:本目录服务于质量门禁与工程度量。

文件一览

提交门禁(接入 .pre-commit-config.yaml)

脚本 钩子名 作用
check_coding_standard.py C coding standard C 代码规范机械检查(命名前缀/常量右置/头文件保护宏等)
check_mojibake.py Forbid U+FFFD mojibake 扫描 U+FFFD 乱码(EF BF BD 字节)
check_doc_links.py doc-links 文档链接存在性 + 命名规范(D-3/D-7)+ §N.M 章节引用(口径见 docs/文档规范.md §3.5)。钩子已带 --sections-strict(自引用失效也拦);--section-todo 列出机器判不了目标的 §(带改写建议)。每次跑打印「可判定比例」行,防覆盖率回落
section_aliases.json (被 check_doc_links.py 读) 文档昵称别名表:「内存方案」→ docs/内存管理/RAM使用分析与优化方案.md。只登记无歧义昵称;登记一次即把该昵称的引用纳入硬门禁
gen_task_table.py task-table FreeRTOS 任务表以 Src/freertos.c 为唯一事实源生成/校验(D-2/D-7)
check_mem_numbers.py mem-numbers 内存/Flash 数字以 .map 为唯一事实源校验(D-7 体积档)
check_test_suite.py test-suite-switch 测试套件开关=产品构建(防测试固件静默提交)

报告生成(非门禁)

脚本 作用
ram_report.py 从 .map 生成静态 RAM/Flash 占用报告(→ docs/内存管理/data/)
stack_report.py 从 Keil 静态调用图 + 串口 [STACK] 水位生成每任务最坏链报告

引用同步(改名 / 挪目录)

脚本 作用
rename_ref.py 改名/挪目录 + 全库引用自动改写:默认 dry-run 预览,--apply 才落盘(git mv → 改写引用 → 自动跑 check_doc_links --all 复核)。覆盖反引号引用、Markdown 链接、图片 ../ 层级换算、#include、uvprojx/CMakeLists.txt 源列表。固定动作与边界 → docs/文档规范.md §3.6

check_doc_links.py 除链接存在性外,还校验 §N.M 章节引用是否指向目标文档真实存在的编号标题(口径见 docs/文档规范.md §3.5)。

CI 与本地等价(2026-10-01 T-6)

脚本 / 文件 作用
ci_local.py 本地跑与 CI 等价的门禁(L0 pre-commit + L0b 提交信息 + L0.5 主机侧单测):自动选用装了 pre-commit 的解释器;无 .map 时自适应跳过 mem-numbers;退出码 0/1/2 与 CI 对齐。CI 定义见 ../.gitea/workflows/ci.yml,覆盖边界见 docs/测试说明/测试开发标准流程.md §9
ci_gitlint_range.ps1 CI 侧提交信息门禁:逐条校验本次 push/PR 引入的提交(--all-files 跑不到 commit-msg stage,故必须单独守)
ci_find_python.ps1 CI 侧 Python 探测(候选顺序须与 ci_local.py 同序同步,否则 CI 与本地判定会分叉)
ci_runner_bootstrap.ps1 本机 runner 运维脚本(体检 -Status / 干跑 -DryRun / 部署 -SetEnv -StartNow):装"等 Gitea 就绪 + 崩溃自拉起"的看门狗 + 开机计划任务 + 机器级 DTU_*

⚠️ 后三个脚本是本机 runner 专属运维(远程 CI 只跑在本机一台机器上),用法、原理与 踩坑全部集中在 docs/CI/README.md,本表只登记不展开。

使用方式

# 全库跑门禁(用仓库 .venv 的 python,其 pre-commit 随 requirements.txt 安装;
# 其他装有 pre-commit 的解释器可用 DTU_PRECOMMIT_PYTHON 指定)
& '.venv\Scripts\python.exe' -m pre_commit run --all-files

# 本地跑与 CI 等价的门禁(L0 + L0.5)
& '.venv\Scripts\python.exe' scripts/ci_local.py
& '.venv\Scripts\python.exe' scripts/ci_local.py --l0-only    # 只跑 L0
& '.venv\Scripts\python.exe' scripts/ci_local.py --l05-only   # 只跑 L0.5

# 单个脚本
& '.venv\Scripts\python.exe' scripts/check_doc_links.py --all
& '.venv\Scripts\python.exe' scripts/rename_ref.py docs/旧/名.md docs/新/名.md          # 预览
& '.venv\Scripts\python.exe' scripts/rename_ref.py docs/旧/名.md docs/新/名.md --apply  # 落盘
& '.venv\Scripts\python.exe' scripts/gen_task_table.py --check   # 或 --write / --diff
& '.venv\Scripts\python.exe' scripts/check_mem_numbers.py --check
& '.venv\Scripts\python.exe' scripts/check_test_suite.py               # 门禁判定
& '.venv\Scripts\python.exe' scripts/check_test_suite.py --allow-test-build  # 放行测试构建
& '.venv\Scripts\python.exe' scripts/ram_report.py
& '.venv\Scripts\python.exe' scripts/stack_report.py -s .dsh\skills\serial-assistant\scripts\state\serial.log

⚠️ 脚本编写约定

  • 保真回写:改文件前先探测原换行符(LF/CRLF)与 BOM,按原样回写(本仓库各文件换行混杂)
  • 受管区锚点:改文档中的数值/表格时用 <!-- XXX:BEGIN/END --> 锚点,只替换锚点内内容
  • 脚本输出文件绝不能落在自身扫描范围内(否则会"自我污染",见 docs-tree-reorg skill)
  • 生成器与校验器共用同一套正则/口径,避免两处数字打架

相关文档

  • docs/代码规范/pre-commit使用说明.md — 门禁完整说明与排除项
  • docs/代码规范/cppcheck使用说明.md
  • docs/文档规范.md — 文档门禁三档
  • docs/内存管理/RAM使用分析与优化方案.md — RAM/栈报告口径