HomeAgent/internal/plugin/proc/host.go

package proc

import (
	"fmt"
	"log"
	"os"
	"sync"

	pubsdk "gitcode.com/JianFeeeee/homeagent-sdk/sdk"
)

// Host 持有**被全部子进程插件共享的一块 StageContext 段**，是共享内存数据面的
// 所有权中心（§3.3/§3.4）。
//
// ❗ 为什么必须共享一块段（这是一个容易走错的关键点）：
// 若每个插件各持一块段，则「内核 ctx → 段 → 插件改 → 回读 ctx」在多插件下退化成
// 副本模型——两个插件各写各的段、各自回读，最后回读者覆盖前者，
// lost update 原样复现（§8.4 实测 35.8~36.8%）。
// 实验 8 的做法是 5 个 worker 进程 mmap **同一个 memfd**，本实现与之一致。
//
// 生命周期：Host 由 registry 创建一次，随内核存活；每个插件 spawn 时经
// ExtraFiles 拿到同一 memfd（fd 3），mmap 后即看到同一份物理页。
//
// 另外持有事件环段（§3.6）：独立于 StageContext 的事件通知通道，
// 子进程从 eventfd 感知新事件并从 mmap 读 slot。
// fd 分配：fd 3 = StageContext，fd 4 = 事件环，fd 5 = eventfd。
type Host struct {
	memfd   *os.File
	data    []byte
	seg     *Segment
	shmSize int

	// 事件环段（独立于 StageContext）
	evtfd       *os.File // Unix：eventfd/pipe 读端（fd 5）。Windows 为 nil，用 evtNotifyFd 。
	evtNotifyFd int      // 通知句柄的平台无关标识（Unix 是真 fd，Windows 是伪 fd）
	evtRing     *EvtRing // 内核侧事件环句柄
	evtRingFd   *os.File // Unix：事件环段 memfd（fd 4）。Windows 为 nil（命名段）。
	evtData     []byte   // 事件环段 mmap 数据

	// evtSubscriber 由 internal/plugin 注入，coreHandler 用它接子进程的 events.subscribe 请求。
	// proc 包不依赖 internal/plugin（循环依赖），故用接口类型存储。
	evtSubscriber EvtRingSubscriber

	locks   *lockRegistry
	stageMu sync.Mutex
	coordMu sync.Mutex
	coord   *stageCoordinator

	// sup 是内核侧唯一的子进程台账，与共享段同生命周期。
	//
	// 放在 Host 而不是 registry 的理由：能拿到 Host 的地方就能拿到台账，
	// 而 Host 本就是「全部子进程插件共享的那一份内核侧状态」。
	sup *Supervisor
}

// NewHost 创建共享段（平台层 allocShm + 布局初始化）。
//
// 段的**传递机制**按平台分开（shmalloc_*.go），但**布局**完全一致：
//   - Linux：memfd，经 ExtraFiles 传继承 fd
//   - macOS：立即 unlink 的临时文件（无 memfd_create），同样走 fd 继承
//   - Windows：命名 FileMapping（无 fd 继承语义），插件按名字打开
//
// 三者共同点：全部插件看到同一份物理页，段内一律用相对偏移而非指针
// （实验 2 已验证各进程 mmap 到不同虚拟地址时偏移解引用仍正确）。
func NewHost() (*Host, error) {
	memfd, data, err := allocShm(shmDefaultSize)
	if err != nil {
		return nil, err
	}
	seg, err := NewSegment(data)
	if err != nil {
		freeShm(memfd, data)
		return nil, err
	}

	// 创建事件环段（独立于 StageContext）
	evtRingFd, evtData, efd, err := allocEvtRing()
	if err != nil {
		freeShm(memfd, data)
		return nil, fmt.Errorf("事件环: %w", err)
	}
	evtRing, err := NewEvtRing(evtData)
	if err != nil {
		freeShm(memfd, data)
		return nil, fmt.Errorf("事件环初始化: %w", err)
	}
	evtRing.Init()

	return &Host{
		sup:         NewSupervisor(),
		memfd:       memfd,
		data:        data,
		seg:         seg,
		shmSize:     shmDefaultSize,
		evtfd:       evtfdReadFile(efd),
		evtNotifyFd: efd,
		evtRing:     evtRing,
		evtRingFd:   evtRingFd,
		evtData:     evtData,
		locks:       &lockRegistry{},
	}, nil
}

// shmDefaultSize 是共享 StageContext 段的大小。
//
// 取 256KB：StageContext 全字段 JSON 化后典型 < 4KB（工具结果中位 93B，§2.5），
// append-only 中间垃圾由 stage 结束时 Compact 回收，256KB 给足余量。
// 全部插件共享一块，总开销恒定，不随插件数增长。
const shmDefaultSize = 256 * 1024

// Close 释放共享段（StageContext + 事件环）。
// Supervisor 返回子进程台账（供 registry 查询/关停）。
func (h *Host) Supervisor() *Supervisor { return h.sup }

func (h *Host) Close() error {
	// 先停全部子进程再拆段：插件还持有映射时 unmap，
	// 它们下一次访问共享段就是 SIGBUS。
	if h.sup != nil {
		h.sup.StopAll(0)
	}
	var firstErr error
	if h.data != nil {
		if err := freeShm(h.memfd, h.data); err != nil && firstErr == nil {
			firstErr = err
		}
		h.data, h.memfd = nil, nil
	}
	if h.evtData != nil {
		if h.evtRingFd != nil {
			h.evtRingFd.Close()
			h.evtRingFd = nil
		}
		h.evtData = nil
	}
	if h.evtfd != nil {
		h.evtfd.Close()
		h.evtfd = nil
	}
	evtfdClose(h.evtNotifyFd)
	return firstErr
}

// beginStage 由插件 handler 进入时调用。
//
// 首个进入者：获取 stageMu（独占共享段）→ 把内核 StageContext 写入段。
// 后续进入者：仅递增 inflight。
//
// enter() 在 coordMu 内完成，两个原因：
//  1. 首进者的 WriteAll 未结束前不能让后到者拿到 coord 就去读共享段
//     （旧码的后到者 enter 立即返回，可能读到写一半的段）。
//  2. 与 endStage 的摘除互斥，防止后到者挂进一个正在收尾的协调器
//     （具体见 endStage 的注释）。
//
// 锁序：stageMu → coordMu。endStage 只解锁 stageMu、不获取，所以无环。
func (h *Host) beginStage(sc *pubsdk.StageContext) (*stageCoordinator, error) {
	h.coordMu.Lock()
	if h.coord == nil {
		// 首个进入者：独占共享段直到本次 stage 全部插件离开。
		// 必须先放 coordMu 再取 stageMu，不能反序。
		h.coordMu.Unlock()
		h.stageMu.Lock()
		h.coordMu.Lock()
		if h.coord == nil {
			coord := newStageCoordinator(h.seg)
			h.coord = coord
			if err := coord.enter(sc, true); err != nil {
				// 注意：runStage 的 defer endStage(coord) 是在 beginStage
				// 返回 err 的检查之后才注册的，所以这条路径上
				// endStage 永远不会被调用——stageMu 必须在此自行释放，
				// 否则整个 stage 通道永久卡死。
				h.coord = nil
				h.coordMu.Unlock()
				h.stageMu.Unlock()
				return nil, err
			}
			h.coordMu.Unlock()
			h.locks.bind(coord.lock)
			return coord, nil
		}
		// 双检失败：等锁期间已有其他插件建好协调器，退回后到者路径。
		h.stageMu.Unlock()
	}

	coord := h.coord
	if err := coord.enter(sc, false); err != nil {
		h.coordMu.Unlock()
		return nil, err
	}
	h.coordMu.Unlock()
	h.locks.bind(coord.lock)
	return coord, nil
}

// endStage 由插件 handler 返回时调用。
// 最后离开者：把共享段结果读回内核 StageContext → 压实 arena → 释放 stageMu。
//
// coordMu 必须覆盖「递减 inflight → 判定最后离开者 → 摘除 h.coord」全过程。
// 旧码把 leave() 放在 coordMu 之外，留出了这个窗口（即 2026-09-04 06:56:18
// 线上 fatal error: sync: unlock of unlocked mutex 的真因）：
//
//	A.endStage: leave() → inflight 1→0, last=true，尚未摘除 h.coord
//	B.beginStage: 看到 h.coord != nil，以「后到者」身份 enter，inflight 0→1
//	              （后到者不取 stageMu）
//	A.endStage: h.coord = nil；stageMu.Unlock()            ← 第 1 次
//	B.endStage: leave() → inflight 1→0, last=true → stageMu.Unlock()  ← 第 2 次 💥
//
// B 从未持有 stageMu（它是后到者），却因为挂进了一个正在收尾的协调器
// 而成为“最后离开者”，于是对同一把锁解了两次。sync.Mutex 的双重解锁是
// runtime fatal，**recover 捕不到**——这就是为何 stage.go / stages.go 里
// 那两层 recover 全部失效、整个 homed 直接死掉的原因。
func (h *Host) endStage(coord *stageCoordinator) error {
	h.coordMu.Lock()
	last, sc, written := coord.depart()
	if last && h.coord == coord {
		h.coord = nil
	}
	h.coordMu.Unlock()
	if !last {
		return nil
	}
	// finish 必须在 stageMu.Unlock() 之前：先放锁会让下一轮 stage
	// 在回读未完时就改写共享段。
	err := coord.finish(sc, written)
	h.stageMu.Unlock()
	return err
}

// ForceReleaseLock 在插件进程崩溃时释放其可能持有的 stage 锁（实验 9 自愈机制）。
func (h *Host) ForceReleaseLock(plugin string) bool {
	return h.locks.forceRelease(plugin)
}

// Segment 暴露共享段（供诊断与测试）。
func (h *Host) Segment() *Segment { return h.seg }

// stageCoordinator 跟踪一次 stage 执行中参与插件的进出。
type stageCoordinator struct {
	seg  *Segment
	lock *stageLock

	mu       sync.Mutex
	inflight int
	written  bool
	ctxRef   *pubsdk.StageContext
}

func newStageCoordinator(seg *Segment) *stageCoordinator {
	return &stageCoordinator{seg: seg, lock: newStageLock()}
}

// enter 登记一个插件进入本次 stage；first 为真时把内核状态写入共享段。
func (c *stageCoordinator) enter(sc *pubsdk.StageContext, first bool) error {
	c.mu.Lock()
	defer c.mu.Unlock()
	c.inflight++
	if !first || c.written {
		return nil
	}
	c.ctxRef = sc
	if err := c.seg.WriteAll(sc); err != nil {
		c.inflight--
		return fmt.Errorf("写入共享段: %w", err)
	}
	c.written = true
	return nil
}

// leave 登记一个插件离开；返回是否为最后一个离开者。
//
// 拆成两段：depart() 只动计数（由 endStage 在 coordMu 内调用，使
// 「递减 → 判定最后者 → 摘除 h.coord」成为原子操作），finish() 做
// 共享段回读与压实。本方法保留给单测用。
func (c *stageCoordinator) leave() (last bool, err error) {
	last, sc, written := c.depart()
	if !last {
		return last, nil
	}
	return last, c.finish(sc, written)
}

// depart 递减 inflight 并报告是否为最后离开者。
func (c *stageCoordinator) depart() (last bool, sc *pubsdk.StageContext, written bool) {
	c.mu.Lock()
	defer c.mu.Unlock()
	c.inflight--
	return c.inflight == 0, c.ctxRef, c.written
}

// finish 把共享段结果读回内核 StageContext 并压实 arena
// （此时无插件持锁，满足 §3.3 的压实前提）。
func (c *stageCoordinator) finish(sc *pubsdk.StageContext, written bool) error {
	if !written || sc == nil {
		return nil
	}
	if rErr := c.seg.ReadInto(sc); rErr != nil {
		return fmt.Errorf("回读共享段: %w", rErr)
	}
	if reclaimed := c.seg.Compact(); reclaimed > 0 {
		log.Printf("[proc] stage 结束，arena 压实回收 %d 字节", reclaimed)
	}
	return nil
}

// ShmSize 返回共享段大小（供诊断/日志）。
func (h *Host) ShmSize() int { return h.shmSize }

// EvtRing 返回内核侧事件环句柄。
func (h *Host) EvtRing() *EvtRing { return h.evtRing }

// Evtfd 返回通知读端的 *os.File（Unix；eventfd/pipe）。
// Windows 返回 nil——命名 Event 不是文件句柄，用 EvtNotifyFd 代替。
func (h *Host) Evtfd() *os.File { return h.evtfd }

// EvtNotifyFd 返回通知句柄的平台无关标识，供 EventRing 写通知。
//
// Unix 是真 fd；Windows 是映射到命名 Event 句柄的伪 fd。
// EvtfdNotify 接受这个值并按平台分派。
func (h *Host) EvtNotifyFd() int { return h.evtNotifyFd }

// SetEvtSubscriber 注入事件环订阅接口（由 Registry 在创建 Host 后设置）。
func (h *Host) SetEvtSubscriber(sub EvtRingSubscriber) { h.evtSubscriber = sub }

// EvtData 返回事件环段 mmap 数据（子进程消费者用）。
func (h *Host) EvtData() []byte { return h.evtData }

// EvtfdReadFile 返回 eventfd 的 *os.File（供子进程读取消费）。
func (h *Host) EvtfdReadFile() *os.File { return h.evtfd }