Files
HomeAgent/internal/plugin/evtring.go
JianFeeeee 6d38a164eb chore(module): Go module 路径随托管地迁移 gitcode → github
## 背景

仓库早已迁移到 GitHub(`github.com/JianFeeeee/HomeAgent`,CI/CD 都在那边跑),
gitcode 保留为**国内只读镜像**(`ci.yml` 的 sync-gitcode-main 快进推送)。
但 go.mod 的 module 路径一直是 `gitcode.com/JianFeeeee/...` —— 既与权威源
不符,`meta.SourceURL`(AGPL §13 的源码提供入口)也指向镜像而非实际运行的代码。

## 关键区分(这是本次改动安全的前提)

两个 module 是**不同**的,影响面差一个数量级:

| module | 谁依赖 | 改它的后果 |
|---|---|---|
| `.../HomeAgent`(主仓) | **只有主仓自己** | 内部重构,零外部影响 |
| `.../homeagent-sdk`(SDK 仓) | 主仓 49 文件 + 所有外部插件 | 需重编插件 |

★ 实测确认:**插件不 import 主仓 module**(`strings qq/plugin.bin | grep HomeAgent` = 0),
只依赖 SDK 仓。而插件与内核的边界是 **RPC 方法名字符串**
(`plugin.init` / `tool.invoke`…,见 proc/protocol.go),**与 Go module 名无关**。
⇒ module 改名**不改变任何 wire 协议**,现网已装的插件照常运行。

SDK 的 GitHub 仓名是 `homeagentsdk`(无连字符),module 路径必须与之精确匹配,
否则 `go get` 会因路径不符失败,故取 `github.com/JianFeeeee/homeagentsdk`。

## 改动

- `go.mod` / `go.sum`:两个 module 路径 + require/replace
- 277 个 Go 文件 + Makefile + 打包脚本的 import 与 ldflags 路径
- SDK 仓 `meta.CoreModule`、`tools/hmapdev` 的 module 声明与工程模板
- 对外文档/链接的仓库地址(README、PLUGIN_DEV、OVERVIEW 等)

## 明确**保留** gitcode 的地方(镜像机制,不能动)

- `GITCODE_TOKEN`、`GC_URL="…@gitcode.com"`(CI 同步 job)
- `gitcode.com/api/v5/...`(release 附件上传)
- git remote `gitcode`(镜像拉取/推送)
- `docs/zh/ci-cd-runbook.md`(整篇讲镜像运维)

## 验证

- `go build ./...` / `go vet ./...` 绿
- `go test ./... -count=1` → 48 包 ok / 0 FAIL
- hmapdev 工具链编译通过(`third_party/homeagent-sdk/tools/hmapdev`)
- 全仓残留检查:module 形态的 `gitcode.com/JianFeeeee` = 0
- 镜像机制抽验:GC_URL / @gitcode / api/v5 / remote 均完好

## 顺带修正

`hmapdev/templates.go` 的注释此前写「gitcode 的模块不在 proxy.golang.org 上」——
module 已迁 GitHub,该论断不再成立。改为如实说明**为何仍默认 replace 到本机 SDK**:
离线可构建、避免版本漂移、内网可用。理由与托管地无关,故 replace 保留。
2026-10-08 10:40:17 +08:00

101 lines
3.3 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

package plugin
import (
"encoding/json"
"sync"
"github.com/JianFeeeee/HomeAgent/internal/events"
"github.com/JianFeeeee/HomeAgent/internal/plugin/proc"
pubsdk "github.com/JianFeeeee/homeagentsdk/sdk"
)
// EventRing 是 Bus 与 proc.EvtRing 之间的适配层。
//
// 把内核的事件总线接到共享内存事件环:Bus.Publish → handler
// 把事件序列化写入 EvtRing slot → eventfd 通知子进程。
// 不改 Bus 自身结构(保护零 API 变动)。
type EventRing struct {
ring *proc.EvtRing
bus *events.Bus
efd int
// unsubs 保存全部已注册订阅的取消函数。
//
// ★ 为什么必须留着:这些 handler 会 ring.WritePush(写共享内存)。
// 而 Host.Close() 会 freeShm 解除整块映射 —— 若那时 handler 还在 Bus 上,
// 一条事件就会让 handler 写已解除映射的内存:SIGSEGV。
// 注意 Bus.safeCall 的 recover **捕不到** SIGSEGV(它是 runtime 致命错误,
// 不是 panic),所以这不是「最坏情况只丢一条事件」,而是整个内核进程被杀。
//
// 此前 handleEvents 把 EvtRingSubscribe 返回的取消函数直接丢弃
// (且 EventsUnsubscribe 是空实现),于是每个订阅过的插件都在 Bus 上
// 永久留了一个写共享内存的 handler —— 内核关停时必炸。
// 现在改为在这里登记,由 Close 统一退订(内核关停、以及插件自己的
// events.unsubscribe 都走这里)。
mu sync.Mutex
unsubs []func()
}
func NewEventRing(ring *proc.EvtRing, efd int, bus *events.Bus) *EventRing {
return &EventRing{ring: ring, bus: bus, efd: efd}
}
// Close 退订本适配层注册到 Bus 的全部 handler。
//
// 必须在 Host.Close()(munmap 共享段)**之前**调用;见 unsubs 的说明。
// 幂等:重复调用安全(退订函数本身在 Bus 侧是「找不到就什么都不做」)。
func (er *EventRing) Close() {
er.mu.Lock()
unsubs := er.unsubs
er.unsubs = nil
er.mu.Unlock()
for _, fn := range unsubs {
if fn != nil {
fn()
}
}
}
// Subscribe 在 Bus 上注册一个把事件分发到事件环的 handler,返回取消函数。
//
// 不改 Bus 自身结构——handler 把事件序列化后写入环并 post eventfd,
// Bus 侧按 EventType 精确匹配分发(与现有逻辑完全一致)。
func (er *EventRing) Subscribe(eventType pubsdk.EventType) func() {
return er.bus.Subscribe(events.EventType(eventType), func(evt *events.Event) {
payload, err := json.Marshal(evt)
if err != nil {
return
}
er.ring.WritePush(pubsdk.EventType(evt.Type), payload)
proc.EvtfdNotify(er.efd)
})
}
// EvtRingSubscribe 实现 proc.EvtRingSubscriber 接口。
// 按事件类型列表订阅,返回统一取消函数。
func (er *EventRing) EvtRingSubscribe(types []pubsdk.EventType) func() {
unsubscribes := make([]func(), 0, len(types))
for _, t := range types {
unsubscribes = append(unsubscribes, er.Subscribe(t))
}
return func() {
for _, fn := range unsubscribes {
fn()
}
}
}
// EvtRingSubscribeTracked 与 EvtRingSubscribe 相同,但把取消函数登记到
// unsubs,供 Close 统一退订。内核的 events.subscribe 走这条。
func (er *EventRing) EvtRingSubscribeTracked(types []pubsdk.EventType) func() {
un := er.EvtRingSubscribe(types)
if un == nil {
return nil
}
er.mu.Lock()
er.unsubs = append(er.unsubs, un)
er.mu.Unlock()
return un
}