ek_core/
registry.rs

1//! 注册表(内部):单表统一 add / get / typed get / remove;
2//! 状态原子 CAS;能力索引(svc_id → 提供方列表)+ 改版世代计数 + services 现场缓存;
3//! start 拓扑序。
4//!
5//! 0.2.0 变更:
6//! - `svc_index`:add 时从 `services()` 抽 id 织入(宿主只存「谁会什么 id」,
7//!   宿主最小知识);removal 修剪、Quarantined 保留(条目=能力声明,非可用性);
8//! - `revision` 世代:登记簿任何变动 +1,memoize 缓存按世代核对(审核 F4);
9//! - `svc_cache`:services() 现场取回的透明性能缓存,非登记事实。
10//! - `revision` 为字段名:`gen` 在 Rust 2024 是保留字。
11
12use crate::error::PluginError;
13use crate::main_engine::{PluginInfo, PluginState};
14use crate::service::ServiceDesc;
15use ek_event::{Event, HandlerId};
16use std::any::Any;
17use std::collections::{HashMap, VecDeque};
18use std::sync::atomic::{AtomicBool, AtomicU64, AtomicU8, Ordering};
19use std::sync::{Arc, Mutex, RwLock};
20use std::thread::JoinHandle;
21
22use crossbeam_channel::Sender;
23
24/// 每插件运行统计(供宿主查询/测试断言/告警)。
25#[derive(Default)]
26pub(crate) struct EntryStats {
27    /// forwarder 溢出丢弃累计(邮箱满)。
28    pub spilled: AtomicU64,
29    /// handler panic 累计。
30    pub panics: AtomicU64,
31    /// worker 退出标志(join-with-deadline 用,D4)。
32    pub done: AtomicBool,
33}
34
35/// 注册表的一条记录(内部,不公开)。
36pub(crate) struct PluginEntry {
37    pub name: String,
38    /// 供 worker/on_mail 与生命周期钩子调用的 trait 对象。
39    pub plugin: Arc<dyn crate::plugin::Plugin>,
40    /// 指向同一分配的 `Arc<dyn Any + Send + Sync>`:get_typed 的 downcast 底座。
41    pub any: Arc<dyn Any + Send + Sync>,
42    pub state: PluginStateCell,
43    pub mailbox_cap: usize,
44    pub deps: Vec<String>,
45    /// 宿主侧邮箱发端(持有一份;close 第③步置 None → 全部 Sender 消费尽 → 断连)。
46    pub mailbox: Mutex<Option<Sender<Event>>>,
47    /// start 装配的 forwarder 注册 id(close/remove 第①步逐个卸)。
48    pub forwarder_ids: Mutex<Vec<HandlerId>>,
49    /// worker 句柄(close 第⑤步 join,超时则弃-剥离)。
50    pub worker: Mutex<Option<JoinHandle<()>>>,
51    pub stats: Arc<EntryStats>,
52}
53
54/// 插件状态(AtomicU8 CAS 迁移,非法迁移拒绝)。
55#[derive(Debug, Clone, Copy, PartialEq, Eq)]
56pub enum PluginStateCode {
57    Ready = 0,
58    Running = 1,
59    Stopping = 2,
60    Exited = 3,
61    Quarantined = 4,
62}
63
64/// 状态原子单元(锁-free;Clone 共享同一原子底座)。
65#[derive(Clone)]
66pub(crate) struct PluginStateCell(Arc<AtomicU8>);
67
68impl PluginStateCell {
69    pub fn new(s: PluginStateCode) -> Self {
70        Self(Arc::new(AtomicU8::new(s as u8)))
71    }
72    pub fn get(&self) -> PluginState {
73        PluginState::from_code(self.0.load(Ordering::Acquire))
74    }
75    pub(crate) fn cas(&self, from: PluginStateCode, to: PluginStateCode) -> bool {
76        self.0
77            .compare_exchange(from as u8, to as u8, Ordering::AcqRel, Ordering::Acquire)
78            .is_ok()
79    }
80    /// worker 自然结束:Running/Stopping → Exited。
81    pub(crate) fn finish(&self) -> bool {
82        self.cas(PluginStateCode::Running, PluginStateCode::Exited)
83            || self.cas(PluginStateCode::Stopping, PluginStateCode::Exited)
84    }
85}
86
87/// 内部注册表集中区。
88pub(crate) struct RegistryInner {
89    pub entries: HashMap<String, Arc<PluginEntry>>,
90    /// 注册顺序(确定性、拓扑并列时的排序依据)。
91    pub order: Vec<String>,
92}
93
94/// services() 现场取回的缓存条目:(登记世代快照,现场目录)。
95type SvcCacheEntry = (u64, Arc<Vec<ServiceDesc>>);
96
97pub(crate) struct Registry {
98    pub state_of: RwLock<RegistryInner>,
99    /// 能力索引:svc_id → 提供方名单(注册序;removal 修剪、Quarantined 保留)。
100    pub(crate) svc_index: RwLock<HashMap<String, Vec<String>>>,
101    /// 改版世代:登记簿任何变动 +1(缓存失效用,审核 F4)。
102    revision: AtomicU64,
103    /// services() 现场取回的透明缓存(性能件,非登记事实)。
104    svc_cache: Mutex<HashMap<String, SvcCacheEntry>>,
105}
106
107impl Registry {
108    pub fn new() -> Self {
109        Self {
110            state_of: RwLock::new(RegistryInner { entries: HashMap::new(), order: Vec::new() }),
111            svc_index: RwLock::new(HashMap::new()),
112            revision: AtomicU64::new(1),
113            svc_cache: Mutex::new(HashMap::new()),
114        }
115    }
116
117    pub fn revision(&self) -> u64 {
118        self.revision.load(Ordering::Acquire)
119    }
120
121    pub fn bump(&self) {
122        self.revision.fetch_add(1, Ordering::AcqRel);
123    }
124
125    /// 织入/刷新某提供方的索引条目(add 与 publish_services 共用)。
126    pub fn index_put(&self, name: &str, ids: &[String]) {
127        let mut w = self.svc_index.write().unwrap();
128        for list in w.values_mut() {
129            list.retain(|n| n != name);
130        }
131        w.retain(|_, l| !l.is_empty());
132        for id in ids {
133            let entry = w.entry(id.clone()).or_default();
134            if !entry.iter().any(|n| n == name) {
135                entry.push(name.to_string());
136            }
137        }
138    }
139
140    /// 摘除某提供方的全部索引条目(removal;Quarantined 不动)。
141    pub fn index_remove(&self, name: &str) {
142        let mut w = self.svc_index.write().unwrap();
143        for list in w.values_mut() {
144            list.retain(|n| n != name);
145        }
146        w.retain(|_, l| !l.is_empty());
147    }
148
149    /// 某服务的全部提供方(注册序)。
150    pub fn index_providers(&self, svc: &str) -> Vec<String> {
151        self.svc_index
152            .read()
153            .unwrap()
154            .get(svc)
155            .cloned()
156            .unwrap_or_default()
157    }
158
159    /// publish_services 的登记侧:重织索引 + 失效缓存(+bump)。
160    /// 返回该插件当前申报版本(插件不存在 → 空串)。
161    pub(crate) fn publish(&self, name: &str, list: Vec<ServiceDesc>) -> String {
162        let Some(entry) = self.get(name) else { return String::new() };
163        let mut ids: Vec<String> = Vec::with_capacity(list.len());
164        for d in &list {
165            if !ids.contains(&d.id) {
166                ids.push(d.id.clone());
167            }
168        }
169        self.index_put(name, &ids);
170        self.invalidate(name);
171        entry.plugin.version().into_owned()
172    }
173
174    /// services() 现场取 + 世代核对 + memoize(F4):宿主存的是性能缓存而非登记事实。
175    pub fn services_of(&self, name: &str) -> Option<Arc<Vec<ServiceDesc>>> {
176        let entry = self.get(name)?;
177        let revision = self.revision();
178        if let Some((rev, list)) = self.svc_cache.lock().unwrap().get(name) {
179            if *rev == revision {
180                return Some(Arc::clone(list));
181            }
182        }
183        let list = Arc::new(entry.plugin.services());
184        self.svc_cache
185            .lock()
186            .unwrap()
187            .insert(name.to_string(), (revision, Arc::clone(&list)));
188        Some(list)
189    }
190
191    /// 信息快照(get_plugin / ctx.plugins() 共用:单一披露面,审核 F5)。
192    pub(crate) fn info_of(&self, name: &str) -> Option<PluginInfo> {
193        self.get(name).map(|e| PluginInfo {
194            name: e.name.clone(),
195            version: e.plugin.version().into_owned(),
196            state: e.state.get(),
197            deps: e.deps.clone(),
198        })
199    }
200
201    pub fn get(&self, name: &str) -> Option<Arc<PluginEntry>> {
202        self.state_of.read().unwrap().entries.get(name).cloned()
203    }
204
205    pub fn remove(&self, name: &str) -> Option<Arc<PluginEntry>> {
206        let mut w = self.state_of.write().unwrap();
207        w.entries.remove(name).inspect(|_| {
208            if let Some(i) = w.order.iter().position(|n| n == name) {
209                w.order.remove(i);
210            }
211        })
212    }
213
214    pub fn names(&self) -> Vec<String> {
215        self.state_of.read().unwrap().order.clone()
216    }
217
218    pub fn any_depends_on(&self, target: &str) -> Vec<String> {
219        let r = self.state_of.read().unwrap();
220        r.order
221            .iter()
222            .filter_map(|n| r.entries.get(n))
223            .filter(|e| e.deps.iter().any(|d| d == target))
224            .map(|e| e.name.clone())
225            .collect()
226    }
227
228    pub fn clear(&self) {
229        let mut w = self.state_of.write().unwrap();
230        w.entries.clear();
231        w.order.clear();
232        drop(w);
233        self.svc_index.write().unwrap().clear();
234        self.svc_cache.lock().unwrap().clear();
235        self.bump();
236    }
237
238    /// add/remove/publish 等变动时统一让缓存失效(F4)。
239    pub fn invalidate(&self, name: &str) {
240        self.svc_cache.lock().unwrap().remove(name);
241        self.bump();
242    }
243
244    /// start() 的依赖拓扑序(Kahn;并列按注册序;环 → Err)。
245    /// deps 存在性在此把关(新 D1:add 期不校验,悬空依赖按缺失报错)。
246    pub fn topo_order(&self) -> Result<Vec<Arc<PluginEntry>>, PluginError> {
247        let r = self.state_of.read().unwrap();
248        let mut indeg: HashMap<String, usize> = HashMap::new();
249        let mut dependents: HashMap<String, Vec<String>> = HashMap::new();
250        for name in &r.order {
251            indeg.entry(name.clone()).or_insert(0);
252        }
253        for name in &r.order {
254            let e = &r.entries[name];
255            for d in &e.deps {
256                if !r.entries.contains_key(d) {
257                    return Err(PluginError::UnknownDep(d.clone()));
258                }
259                *indeg.entry(name.clone()).or_insert(0) += 1;
260                dependents.entry(d.clone()).or_default().push(name.clone());
261            }
262        }
263        let mut queue: VecDeque<String> = r
264            .order
265            .iter()
266            .filter(|n| indeg[*n] == 0)
267            .cloned()
268            .collect();
269        let mut out = Vec::with_capacity(r.order.len());
270        while let Some(n) = queue.pop_front() {
271            let e = Arc::clone(&r.entries[&n]);
272            out.push(e);
273            if let Some(deps_list) = dependents.get(&n) {
274                for dep_name in deps_list {
275                    let d = indeg.get_mut(dep_name).unwrap();
276                    *d -= 1;
277                    if *d == 0 {
278                        queue.push_back(dep_name.clone());
279                    }
280                }
281            }
282        }
283        if out.len() < r.order.len() {
284            let cycle: Vec<String> = r.order.iter().filter(|n| indeg[*n] > 0).cloned().collect();
285            return Err(PluginError::DepCycle(cycle));
286        }
287        Ok(out)
288    }
289}
ek_core/registry.rs

ek_core/
registry.rs
