mirror of
https://gitcode.com/JianFeeeee/HomeAgent.git
synced 2026-11-01 14:57:38 +00:00
a68d6a428c
* feat(kernel): 模块化内核 + 编译期依赖图定序
把单体 init 序列拆成「模块自声明依赖 + 编译期生成依赖图 + 运行期只读图」。
## 为什么
原 cmd/homed/main.go 里 17 步 init 是**手写顺序**，依赖关系只存在于
注释和人脑里。实测踩到的坑（见 docs/zh/kernel-modularization-design.md）：
· nlp.defaultParser 被 initONNXParser 写、被 distiller 读，两者相距 60 行，
只靠 ticker 10min 才没炸（隐式依赖，无声明）
· 加一个模块要人肉找"该插在哪"，插错的表现是运行期 nil 解引用
· 关停是 defer ks.CloseAll()，而热更新路径 os.Exit(42) **跳过 defer**
⇒ docStore/distiller/textMem 的 flush 全部丢失（每次热更新都发生）
## 怎么改
- internal/kernelboot/：KernelState（一个结构体收全部包级共享变量，字段
nil 安全）、Module 接口、graphfile（依赖图编解码 + 与二进制 hash 对账）、
scheduler（按 BFS 层并行 Init）、syncbus（层边界写通知）、
lifecycle（Quiesce/Resume 可逆伪关机，区别于一次性 CloseAll）
- internal/kernelmod/<name>/：每个模块一个文件夹，Requires/Provides 自声明；
all/all.go 是唯一的 import 清单（Go 循环导入约束）
- cmd/homed-depgraph：编译期生成依赖图，Makefile 注入 digest
- 运行期只**读**图，不计算顺序（顺序是编译期决定的，源码里没有中央清单）
## 判据
kernelboot 8 条 + 图失败模式 7 条（全部拒绝并给准确错误）+ 模块目录数
与注册表一致性。变异测试 15/15 咬住，含：
· 删掉 AddCloser 的锁 → -race 报数据竞争
· Scheduler 同批跑去重 → 203 vs 200
· 图 hash 不匹配 → 拒绝启动
## 顺带修的缺陷
热更新路径漏调模块关闭 ⇒ 显式 stopKernelModules()，并用 AST 判据钉住
"必须在 os.Exit 之前"（字符串检查在本仓已骗过我三次）。
实测：冷启动 1630ms（5 层/17 模块，原 17 步串行）；生产 22 插件全部建链。
* feat(security): 密钥防火墙 + 配置加密 + close 纪律
## 密钥防火墙
模型只见别名、不见明文；插件工具调用入口（StageHost.ExecuteTool）做入向
回填。三维能力：
· 出向：工具输出里的密钥被替换成 [[secret:name]] 别名后才进上下文
· 入向：模型传别名，入口处填回真值（插件完全无感知）
· 存储：config.db 里不存明文（0644 的库可读），敏感值独立 0600 文件
模式库「宁漏勿误伤」：宁可漏掉一次替换，也不把正常文本误当密钥。
## 配置加密
- internal/security/{codec,key,keyring,store,global}.go：AES-256-GCM，
enc:v1: 前缀，密钥轮换（OldKeys 解码 + 新钥加密）
- harden.go：数据目录权限收紧
- embedded.go：支持内嵌主密钥（可选，仍保留外部 key 文件路径）
- EncryptExistingSecrets / AuditSecrets：启动时幂等迁移 + 审计
## close 纪律（用户明确要求：只要调 close 就要有前置检查）
internal/safeclose：Safe / SafeFunc。全仓 37 处裸 close(chan) → 0。
关键教训（都写进注释和判据）：
· `select { case <-ch: default: close(ch) }` **不是**并发安全的
（两个 goroutine 可同时命中 default）—— healthcheck 原先是这种写法
· `sync.Once` **不可重入**：X.Do(func(){ Safe(&X, ...) }) 会自锁，
症状是 go test 直接挂住（3 个包 600s 超时），栈里只有嵌套的 Once.Do
· map 里按请求持有的 channel（mcp/stdio.go、clawhubadapter/sidecar.go）
改成 *pendingRPC 包装，每通道一个 once
## 判据
security 全量 + TestNoBareCloseOutsideSafeclose（AST 级扫描，含注释剥离）
+ TestNoNestedSelfOnceDeadlock（正则修正：\w+ 不匹配点号，捕获组要含 '.'）。
变异 2/2 咬住。全量 52 包 ok。
* feat(plugin+deploy): 插件三态生命周期、数据目录迁移、发行包修复
## 插件三态生命周期（用户要求：自动启动 / 启用但不自动启动 / 禁用）
- Manifest 新增 requires_facilities / auto_start（*bool，用于区分
"未声明"与"显式 false"）
- plugin-host 模块（internal/kernelmod/pluginhost）：用 kernelboot.Scheduler
按依赖时机拉起，**不再手写两阶段**
- 运行态停启 StopPlugin/StartPlugin **可逆**：不写 disabled_plugins
（不改用户决定）、不置 shuttingDown（之后还能加载）、会摘掉注册面
- 与 StopAll 的区别写进注释 —— StopAll 置 shuttingDown 后**永久无法加载**，
那是进程退出用的，误用于"暂停"就是关了就死
## 数据目录迁移（伪关机 → 迁移 → 唤醒）
- kernelboot/lifecycle.go：Quiesce/Resume（可逆，区别于一次性 CloseAll），
逆序暂停、逆序恢复、Pause 失败回滚
- kernelboot/migrate.go：BeginMigration/End 编排（先停插件 → 再停内核写者
→ 等在途归零）
- distiller/textmem 增 Pause/Resume 门（不是 cancel —— cancel 不可逆，
恢复要重建整个对象）
- 模块 migration：体检 + 生成可执行迁移脚本
★ 迁移脚本的三个实测教训（都写成了判据）：
1. 无条件改 /etc/systemd/system ⇒ 演练把**生产** -data 改成了演练目录。
加 --dry-run（零改动）+ 强制校验 systemd 当前 -data == OLD
2. 本机没装 rsync，脚本在"服务已停、数据未搬"处硬失败 ⇒ cp -a 回退，
并明确警告不保硬链接/ACL（生产 plugindev 有大量 git 硬链接）
## 发行包修复（全部经实测确认）
1. package-linux.sh **完全漏打 depgraph.bin** ⇒ 内核 exit 1
（"生产构建（内嵌 hash 非空）但读不到依赖图"）
2. build_homed 不走 Makefile ⇒ 单独修 Makefile 无效，必须同时生成图+注入
3. build.sh 的 LDFLAGS 用**历史模块路径 gitcode.com** ⇒ -X 静默 no-op
⇒ --version 显示 unknown
4. Makefile -ldflags 用**单引号** ⇒ 注入了字面 $GRAPH_HASH
## ★ build.sh 的版本号必须校验（真实事故）
原 `VERSION="$(git describe --tags --dirty)"`。无 tag 分支上它返回**分支名**
`backup/pre-identity-rewrite-20261005-51-g03d87a4e-dirty`，被注入 meta.Version
⇒ 插件握手判据 MajorVersion() 把整串当主版本 ⇒ **22 个子进程插件全部
握手失败**（"主版本不匹配"）。内核活着、systemd active、日志每条都像
插件的问题 —— 实际是发行包带着非法版本号。
修法：git describe 只在形如 vX.Y.Z 时采用，否则回退 meta.Version（权威源），
并对最终值做形态守卫。deploy/packaging/version_guard_test.go 3 条判据，
变异 2/2 咬住。
## deb 的 systemd unit 改为 guard 模式
ExecStart=/usr/bin/homed --role=guard --data /var/lib/homeagent
（worker exit 42 → guard 重拉，不经过 systemd、不计失败）
含 RestartSteps/RestartMaxDelaySec/TimeoutStopSec + 硬化
（NoNewPrivileges/ProtectSystem/ProtectHome/DevicePolicy/ReadWritePaths）。
## 其他
- internal/plugin/proc：非法 JSON 帧的报错**可定位**（内容摘要 + 可能原因 +
修法）。生产实测 1038 条非法帧（插件往 stdout 打日志 = 污染协议通道）
- 示例插件 4 个 14 处 fmt.Printf → log.Printf
- hmapdev 模板同步修复；scaffold 判据剥离注释（模板注释里就含 fmt.Printf）
* chore: 收尾（主密钥轮换命令、IPC/知识库加固、SDK 对齐）
- cmd/homed-key-rotate：把 security 里的 RotateKey/RotateKeyFile/RekeySecrets
串成一条**可执行**的运维路径。没有它，E-1 就只是库里的能力而不是
"出事时能做的事"，而轮换的价值恰恰在于能执行。
- cmd/homed：kmod_runtime（模块装配入口）、plugins_scheduled（failback
白名单）、memcandidate、bootstrap_order_test / shutdown_flush_test
- internal/ipc、internal/devicebridge、internal/knowledge：配套加固
- third_party/homeagent-sdk/sdk：PluginMgrAPI 增三态能力（mgrStop/mgrStart/
mgrIsRuntimeStopped）+ settings 对齐
判据：bootstrap_order_test（启动顺序不依赖手写序列）、
shutdown_flush_test（停机的两条路径必须对称 —— exit 42 会跳过 defer，
热更新路径下模块关闭/flush 曾全部丢失）。
* test(security): 测试夹具改用不可误认的占位值（修 push protection 拦截）
GitHub secret scanning 拦住了推送：三处测试夹具用了"看起来像真密钥"的
字面量：
internal/security/prefilter_test.go:39
internal/security/store_test.go:177
internal/security/survey_test.go:20
它们全是**假密钥**（`AKIAIOSFODNN7EXAMPLE` 是 AWS 官方文档的标准示例，
其余是 `abcdefghij...` 这类可读占位符），但扫描器无法区分 —— 它只看形态。
★ 不绕过（不用 unblock URL、不加 allowlist）：直接改夹具。
原因：一旦允许"假密钥可以通过"，真密钥混进来时就没有最后一道门了。
改法：保留**模式库匹配所需的结构**，把可识别内容换成 FAKE：
glpat-abcdefghijklmnopqrst → glpat-FAKE-TEST-TOKEN-NOT-REAL
sk-abcdefghij...012345 → sk-FAKE-TEST-KEY-NOT-REAL-0000000
AKIAIOSFODNN7EXAMPLE → AKIA0000FAKE0000TEST (保持 20 字符)
ASIAIOSFODNN7EXAMPLE → ASIA0000FAKE0000TEST
xoxb-123456789012-abcdefghijklmnop → xoxb-FAKE-TEST-TOKEN-NOT-REAL
★ 中途踩到一次：AWS 键的模式是 `\b(AKIA|ASIA)[0-9A-Z]{16}\b`（共 20 字符），
我第一次替换成 19 字符的 `AKIAFAKETESTKEY0000` ⇒ 模式匹配不上 ⇒
TestSurvey_WhatIsCaught / TestRecognizesCommonShapes /
TestPrefilterNeverBlocksRealMatches 三条当场变红。
判据正确地拒绝了"为了过扫描器而削弱覆盖"。
顺带核实：全仓 grep 无任何真实密钥泄漏。
* fix(packaging): package-linux.sh 的版本解析与 build.sh 统一
上一版只修了 build.sh，漏了 package-linux.sh —— 它仍只看 git describe：
VERSION="${VERSION:-$(git describe --tags --dirty)}"
无 tag 分支上 git describe 返回**分支名**
（backup/pre-identity-rewrite-20261005-56-g98850e1），守卫会正确拒绝，
但要求人**手动传 VERSION** 才能打包。而 build.sh 早已能自动回退 meta.Version
⇒ 同一个版本，走 build.sh 打得出来、走 package-linux.sh 打不出来。
危害不只是"要手动传参"：运维为了跑通会去掉守卫，而分支名一旦进
meta.Version 就是**插件协议主版本**的来源 ⇒ 22 个子进程插件全部握手失败
（这是真实发生过的事故，见 3efa4e5）。
修法：两个脚本用同一套规则（git describe 仅在 vX.Y.Z 形态时采用，
否则回退 meta.Version），并对最终值做形态守卫。
判据：TestBothPackagingScriptsShareVersionRules —— 逐个读两个脚本，
要求都能从 meta/meta.go 取权威版本、都校验 git describe 形态。
变异（把 package-linux.sh 改回旧规则）咬住并准确指出是哪个脚本。
实测：不传 VERSION 跑 package-linux.sh，输出
[PKG] warn: git describe 给出非版本串（...），改用 meta.Version=1.4.0
Version: 1.4.0
* fix(test): 跨仓判据在 CI 上应 skip 而非 fail（修 PR 双红）
CI 上 "Go build / vet / test" 与 "Build linux/amd64" 双红：
--- FAIL: TestHmapdevTemplateImplementsAllPluginMgrMethods
bridge_sync_test.go:170: 读模板: open
../../../third_party/homeagent-sdk/tools/hmapdev/templates/proc_main.go.tmpl:
no such file or directory
## 根因：判据依赖了一个**被 gitignore 的路径**
`.gitignore:33` 有 `third_party/homeagent-sdk/tools/`（SDK 仓自治，本仓不跟踪）。
于是：
· 本机（完整 SDK 检出）有该文件 ⇒ 判据通过
· CI（只 checkout 本仓）没有该文件 ⇒ Fatalf ⇒ **必红**
我提交时只在本机跑测试、没看 CI，所以这个问题拖到 PR 才暴露。
## 修法
文件缺失时 `t.Skipf` 而不是 `t.Fatalf`。
★ 这不是"放弃检查"：
· 跨仓一致性由 **SDK 仓自己的判据**守着
（tools/hmapdev/scaffold_stdout_test.go 等），那里才是模板的真实归属地
· 本判据在本机开发时**仍然生效**（已验证：有文件时 PASS，缺文件时 SKIP）
## 验证
· 本机（有文件） → PASS（判据真跑）
· 模拟 CI（移走 tools/）→ SKIP（不再 fail）
· 全量 53 包 ok / 0 fail
## 顺带
同目录还有 e2e_template_test.go 也读 tools/，但它是 `//go:build` 门控的
e2e 判据，CI 默认不跑，无需处理。
---------
Co-authored-by: JianFeeeee <JianFeeeee@users.noreply.gitcode.com>
117 lines
5.1 KiB
Desktop File
117 lines
5.1 KiB
Desktop File
[Unit]
|
||
Description=HomeAgent - 24/7 AI Butler
|
||
Documentation=https://github.com/trueagent/HomeAgent
|
||
After=network-online.target docker.service
|
||
Wants=network-online.target
|
||
|
||
# ★★ 为什么默认就走 guard（父守护）模式（2026-10-17 对齐本机生产实例）
|
||
#
|
||
# guard 是**双进程**架构：
|
||
# homed --role=guard 只负责拉起/看护 worker，自己不初始化内核
|
||
# homed --role=agent worker，跑真正的新版模块化启动（依赖图定序 + BFS 分层）
|
||
#
|
||
# 它带来的能力是单进程模式**没有**的：
|
||
# · 崩溃自愈：worker 崩了 guard 用**当前二进制**重新拉起
|
||
# · 安全模式：连续崩溃超 max_restarts → 自动进 failback 受限启动
|
||
# （只加载 webui/pluginmgr/recoverydiag，跑恢复梯子）
|
||
# · 卡死检测：IPC PING + 心跳 mtime，带启动宽限
|
||
# · 热更新：worker 以 exit 42 优雅退出 → guard 用新二进制重拉，
|
||
# **不经过 systemd**、不计崩遣次数、guard 进程保持存活
|
||
#
|
||
# 为什么不是 drop-in：单文件发行时 drop-in 容易被漏装。写在主单元里，
|
||
# 装完即是生产同款行为。要回退成单进程，只需把 ExecStart 的 --role=guard 去掉。
|
||
|
||
[Service]
|
||
# Type=exec（不是 simple）：simple 会在 fork 后**立刻**认为启动完成，
|
||
# 于是 ExecStartPost 与 LoadCredential 的建立可能竞争。exec 会等到
|
||
# exec() 真正成功才继续，凭据目录与 ExecStartPost 的顺序才是确定的。
|
||
Type=exec
|
||
|
||
# ★ guard 模式（与本机生产实例一致）。
|
||
# 数据目录默认 /var/lib/homeagent（Debian 惯例）；迁移到别的目录时
|
||
# 必须**同时**改这里和 core.daemon.data_dir —— 两者不等价，见 README。
|
||
ExecStart=/usr/bin/homed --role=guard --data /var/lib/homeagent
|
||
|
||
Restart=always
|
||
RestartSec=10
|
||
|
||
# ★ 指数退避（对齐本机 zz-restart-backoff.conf）
|
||
#
|
||
# 为什么需要：RestartSec=10 是**固定**间隔，而 StartLimitBurst/Interval
|
||
# 在这些长驻 agent 上是故意放松的（收紧会让故障单元进入终态 failed、
|
||
# 必须人工 reset-failed —— 与"自愈"相反）。结果就是一个永久坏掉的服务
|
||
# 以固定频率无限重试，systemd 一句都不说。
|
||
# 实测（2026-09-05，llmsproxy）：每 5 秒拉一次，连拉 79 分钟 = 836 次重启。
|
||
#
|
||
# RestartSteps 让间隔从 RestartSec 起指数递增到 RestartMaxDelaySec：
|
||
# 崩溃循环会衰减到每 5 分钟一次，服务不会被放弃（病根修好后自己回来），
|
||
# 日志也不再被刷爆。
|
||
RestartSteps=6
|
||
RestartMaxDelaySec=5min
|
||
|
||
# 关机上限 25s（对齐本机 zz-shutdown-timeout.conf）。
|
||
# 实测本服务正常退出 <1s；给 guard 转发 SIGTERM → 等 worker → Kill 留足余量，
|
||
# 而默认 90s 在本机从未用到，属于纯粹的风险敞口。
|
||
TimeoutStopSec=25s
|
||
|
||
# KillMode=control-group（默认）：guard 与 worker 同 cgroup，
|
||
# 一起收，双保险不留孤儿进程。
|
||
KillMode=control-group
|
||
|
||
WorkingDirectory=/var/lib/homeagent
|
||
StateDirectory=homeagent
|
||
Environment=HOME=/root
|
||
# onnx 运行库随包安装（不在 /opt，见 packaging/package-linux.sh）
|
||
Environment=ONNXRUNTIME_DIR=/usr/lib/homeagent/onnxruntime
|
||
|
||
# ★ 主密钥生产注入（security/key.go）
|
||
#
|
||
# 优先级：LoadCredential > HOMED_SECURITY_KEY(env) > <datadir>/security.key
|
||
#
|
||
# 为何用 LoadCredential：环境变量对同用户进程**可见**
|
||
# （/proc/<pid>/environ），任何以该用户身份运行的进程都能读到主密钥。
|
||
# LoadCredential 把内容放到 tmpfs（$CREDENTIALS_DIRECTORY，仅本进程 0400），
|
||
# 不在磁盘留副本、也不进 environ。
|
||
#
|
||
# 生成密钥（一次性，然后妥善保管）：
|
||
# head -c 32 /dev/urandom | xxd -p -c 64 | sudo tee /etc/homeagent/security.key
|
||
# sudo chmod 600 /etc/homeagent/security.key
|
||
#
|
||
# ⚠ 该文件就是数据的主密钥：**丢了它，已加密的变量全部解不开**（响亮失败，
|
||
# 不会静默重建）。请与备份一并保管。
|
||
#
|
||
# ⚠ 未配置时**不要**留一个空文件 —— 凭据目录一旦被设置而凭据缺失，内核会
|
||
# **拒绝启动**（不静默回退到磁盘密钥）。若要用磁盘密钥路径，删掉下面这行。
|
||
#
|
||
# ⚠ 从旧版（/var/lib/homeagent/security.key 磁盘钥）升级时：
|
||
# 内核支持"磁盘钥 + 内嵌钥"并存解密（AdditionalDecryptKeys），
|
||
# 所以先放 /etc/homeagent/security.key 与旧磁盘钥**同一份内容**再启用本行，
|
||
# 否则旧密文解不开。
|
||
LoadCredential=homed_security_key:/etc/homeagent/security.key
|
||
|
||
# Security hardening
|
||
NoNewPrivileges=true
|
||
ProtectSystem=strict
|
||
ProtectHome=true
|
||
PrivateTmp=true
|
||
PrivateDevices=false
|
||
DevicePolicy=closed
|
||
# 只允许读主密钥所在目录，其余系统路径保持只读
|
||
ReadOnlyPaths=/etc/homeagent
|
||
# 插件需要写自己目录 + 数据目录 + 插件沙箱
|
||
ReadWritePaths=/var/lib/homeagent
|
||
# Audio devices
|
||
DeviceAllow=/dev/snd rw
|
||
DeviceAllow=/dev/dsp rw
|
||
|
||
# Resource limits
|
||
LimitNOFILE=65536
|
||
LimitNPROC=256
|
||
# Chinese-CLIP 本身实测约 1.15GB；加文档稠密索引、词向量、插件与
|
||
# ORT arena 后生产实例约 4.5GB。2GB 会在首次全量建索引时被 cgroup OOM。
|
||
MemoryMax=8G
|
||
CPUQuota=100%
|
||
|
||
[Install]
|
||
WantedBy=multi-user.target
|