ringkernel-core 1.1.0

Core traits and types for RingKernel GPU-native actor system
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
//! Named Actor Registry — FR-002
//!
//! Global actor registry with symbolic names for service discovery.
//! Actors register by name; callers look up actors by name or wildcard pattern.
//!
//! # Usage
//!
//! ```ignore
//! use ringkernel_core::registry::ActorRegistry;
//! use ringkernel_core::runtime::KernelId;
//!
//! let mut registry = ActorRegistry::new();
//!
//! // Register actors by name
//! registry.register("isa_ontology", KernelId::new("kernel_1"));
//! registry.register("pcaob_rules", KernelId::new("kernel_2"));
//! registry.register("standards/isa/500", KernelId::new("kernel_3"));
//!
//! // Lookup by exact name
//! let actor = registry.lookup("isa_ontology"); // Some(KernelId("kernel_1"))
//!
//! // Lookup by wildcard
//! let actors = registry.lookup_pattern("standards/*"); // ["standards/isa/500"]
//! ```

use std::collections::HashMap;
use std::time::Instant;

use crate::runtime::KernelId;

/// A named actor registration entry.
#[derive(Debug, Clone)]
pub struct RegistryEntry {
    /// Symbolic name.
    pub name: String,
    /// The kernel ID this name resolves to.
    pub kernel_id: KernelId,
    /// When the registration was created.
    pub registered_at: Instant,
    /// Metadata tags.
    pub tags: HashMap<String, String>,
}

/// Event emitted when the registry changes.
#[derive(Debug, Clone)]
pub enum RegistryEvent {
    /// A new actor was registered.
    Registered {
        /// Symbolic name of the registered actor.
        name: String,
        /// Kernel ID assigned to the actor.
        kernel_id: KernelId,
    },
    /// An actor was deregistered.
    Deregistered {
        /// Symbolic name of the deregistered actor.
        name: String,
        /// Kernel ID that was removed.
        kernel_id: KernelId,
    },
    /// An actor's registration was updated.
    Updated {
        /// Symbolic name of the updated actor.
        name: String,
        /// Previous kernel ID.
        old_kernel_id: KernelId,
        /// New kernel ID.
        new_kernel_id: KernelId,
    },
}

/// Global actor registry with symbolic names.
///
/// Provides service discovery for the actor system: LLM tool calls,
/// external APIs, and inter-actor routing can find actors by name
/// instead of opaque kernel IDs.
pub struct ActorRegistry {
    /// Name → Entry mapping.
    entries: HashMap<String, RegistryEntry>,
    /// Reverse mapping: KernelId → names (one kernel can have multiple names).
    reverse: HashMap<KernelId, Vec<String>>,
    /// Watchers: pattern → callback channels.
    watchers: Vec<(String, Vec<RegistryEvent>)>,
}

impl ActorRegistry {
    /// Create an empty registry.
    pub fn new() -> Self {
        Self {
            entries: HashMap::new(),
            reverse: HashMap::new(),
            watchers: Vec::new(),
        }
    }

    /// Register an actor by name.
    ///
    /// If the name is already registered, updates the mapping and
    /// emits an `Updated` event.
    pub fn register(&mut self, name: impl Into<String>, kernel_id: KernelId) -> RegistryEvent {
        let name = name.into();

        let event = if let Some(existing) = self.entries.get(&name) {
            let old_id = existing.kernel_id.clone();
            // Remove from old reverse mapping
            if let Some(names) = self.reverse.get_mut(&old_id) {
                names.retain(|n| n != &name);
            }
            RegistryEvent::Updated {
                name: name.clone(),
                old_kernel_id: old_id,
                new_kernel_id: kernel_id.clone(),
            }
        } else {
            RegistryEvent::Registered {
                name: name.clone(),
                kernel_id: kernel_id.clone(),
            }
        };

        // Add to reverse mapping
        self.reverse
            .entry(kernel_id.clone())
            .or_default()
            .push(name.clone());

        self.entries.insert(
            name.clone(),
            RegistryEntry {
                name,
                kernel_id,
                registered_at: Instant::now(),
                tags: HashMap::new(),
            },
        );

        self.notify_watchers(&event);
        event
    }

    /// Register with metadata tags.
    pub fn register_with_tags(
        &mut self,
        name: impl Into<String>,
        kernel_id: KernelId,
        tags: HashMap<String, String>,
    ) -> RegistryEvent {
        let event = self.register(name, kernel_id);
        if let RegistryEvent::Registered { ref name, .. }
        | RegistryEvent::Updated { ref name, .. } = event
        {
            if let Some(entry) = self.entries.get_mut(name) {
                entry.tags = tags;
            }
        }
        event
    }

    /// Deregister an actor by name.
    pub fn deregister(&mut self, name: &str) -> Option<RegistryEvent> {
        if let Some(entry) = self.entries.remove(name) {
            // Remove from reverse mapping
            if let Some(names) = self.reverse.get_mut(&entry.kernel_id) {
                names.retain(|n| n != name);
                if names.is_empty() {
                    self.reverse.remove(&entry.kernel_id);
                }
            }

            let event = RegistryEvent::Deregistered {
                name: name.to_string(),
                kernel_id: entry.kernel_id,
            };
            self.notify_watchers(&event);
            Some(event)
        } else {
            None
        }
    }

    /// Deregister all names associated with a kernel ID.
    pub fn deregister_kernel(&mut self, kernel_id: &KernelId) -> Vec<RegistryEvent> {
        let mut events = Vec::new();
        if let Some(names) = self.reverse.remove(kernel_id) {
            for name in names {
                if let Some(entry) = self.entries.remove(&name) {
                    events.push(RegistryEvent::Deregistered {
                        name,
                        kernel_id: entry.kernel_id,
                    });
                }
            }
        }
        for event in &events {
            self.notify_watchers(event);
        }
        events
    }

    /// Lookup an actor by exact name.
    pub fn lookup(&self, name: &str) -> Option<&KernelId> {
        self.entries.get(name).map(|e| &e.kernel_id)
    }

    /// Lookup the full registry entry by name.
    pub fn lookup_entry(&self, name: &str) -> Option<&RegistryEntry> {
        self.entries.get(name)
    }

    /// Lookup all names registered to a kernel ID.
    pub fn names_for(&self, kernel_id: &KernelId) -> Vec<&str> {
        self.reverse
            .get(kernel_id)
            .map(|names| names.iter().map(String::as_str).collect())
            .unwrap_or_default()
    }

    /// Lookup actors by wildcard pattern.
    ///
    /// Supports:
    /// - `*` matches any sequence of characters (excluding `/`)
    /// - `**` matches any sequence including `/`
    /// - `?` matches a single character
    ///
    /// Examples:
    /// - `"standards/*"` matches `"standards/isa"` but not `"standards/isa/500"`
    /// - `"standards/**"` matches `"standards/isa/500"`
    /// - `"isa_*"` matches `"isa_ontology"`, `"isa_rules"`
    pub fn lookup_pattern(&self, pattern: &str) -> Vec<(&str, &KernelId)> {
        self.entries
            .iter()
            .filter(|(name, _)| wildcard_match(pattern, name))
            .map(|(name, entry)| (name.as_str(), &entry.kernel_id))
            .collect()
    }

    /// List all registered names.
    pub fn list_names(&self) -> Vec<&str> {
        self.entries.keys().map(String::as_str).collect()
    }

    /// Number of registered entries.
    pub fn len(&self) -> usize {
        self.entries.len()
    }

    /// Check if registry is empty.
    pub fn is_empty(&self) -> bool {
        self.entries.is_empty()
    }

    /// Add a watcher for registry changes.
    ///
    /// Returns a watcher ID that can be used to retrieve events.
    pub fn watch(&mut self, pattern: impl Into<String>) -> usize {
        let id = self.watchers.len();
        self.watchers.push((pattern.into(), Vec::new()));
        id
    }

    /// Drain events for a watcher.
    pub fn drain_events(&mut self, watcher_id: usize) -> Vec<RegistryEvent> {
        if let Some((_, events)) = self.watchers.get_mut(watcher_id) {
            std::mem::take(events)
        } else {
            Vec::new()
        }
    }

    fn notify_watchers(&mut self, event: &RegistryEvent) {
        let name = match event {
            RegistryEvent::Registered { name, .. } => name,
            RegistryEvent::Deregistered { name, .. } => name,
            RegistryEvent::Updated { name, .. } => name,
        };

        for (pattern, events) in &mut self.watchers {
            if wildcard_match(pattern, name) {
                events.push(event.clone());
            }
        }
    }
}

impl Default for ActorRegistry {
    fn default() -> Self {
        Self::new()
    }
}

/// Simple wildcard pattern matching.
///
/// `*` matches any characters except `/`.
/// `**` matches any characters including `/`.
/// `?` matches a single character.
fn wildcard_match(pattern: &str, text: &str) -> bool {
    let p = pattern.chars().collect::<Vec<_>>();
    let t = text.chars().collect::<Vec<_>>();

    wildcard_match_recursive(&p, &t, 0, 0)
}

fn wildcard_match_recursive(pattern: &[char], text: &[char], pi: usize, ti: usize) -> bool {
    if pi == pattern.len() && ti == text.len() {
        return true;
    }
    if pi == pattern.len() {
        return false;
    }

    // Check for ** (matches everything including /)
    if pi + 1 < pattern.len() && pattern[pi] == '*' && pattern[pi + 1] == '*' {
        // Try matching ** against 0 or more characters
        for i in ti..=text.len() {
            if wildcard_match_recursive(pattern, text, pi + 2, i) {
                return true;
            }
        }
        return false;
    }

    // Check for * (matches everything except /)
    if pattern[pi] == '*' {
        for i in ti..=text.len() {
            if i > ti && i <= text.len() && text[i - 1] == '/' {
                // * doesn't cross /
                break;
            }
            if wildcard_match_recursive(pattern, text, pi + 1, i) {
                return true;
            }
        }
        return false;
    }

    // Check for ? (matches any single char)
    if pattern[pi] == '?' && ti < text.len() {
        return wildcard_match_recursive(pattern, text, pi + 1, ti + 1);
    }

    // Exact character match
    if ti < text.len() && pattern[pi] == text[ti] {
        return wildcard_match_recursive(pattern, text, pi + 1, ti + 1);
    }

    false
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_register_and_lookup() {
        let mut reg = ActorRegistry::new();

        reg.register("isa_ontology", KernelId::new("k1"));
        reg.register("pcaob_rules", KernelId::new("k2"));

        assert_eq!(reg.lookup("isa_ontology"), Some(&KernelId::new("k1")));
        assert_eq!(reg.lookup("pcaob_rules"), Some(&KernelId::new("k2")));
        assert_eq!(reg.lookup("nonexistent"), None);
    }

    #[test]
    fn test_deregister() {
        let mut reg = ActorRegistry::new();
        reg.register("actor_a", KernelId::new("k1"));
        assert_eq!(reg.len(), 1);

        reg.deregister("actor_a");
        assert_eq!(reg.len(), 0);
        assert_eq!(reg.lookup("actor_a"), None);
    }

    #[test]
    fn test_update_registration() {
        let mut reg = ActorRegistry::new();
        reg.register("my_actor", KernelId::new("k1"));
        let event = reg.register("my_actor", KernelId::new("k2"));

        assert!(matches!(event, RegistryEvent::Updated { .. }));
        assert_eq!(reg.lookup("my_actor"), Some(&KernelId::new("k2")));
    }

    #[test]
    fn test_reverse_lookup() {
        let mut reg = ActorRegistry::new();
        reg.register("name_a", KernelId::new("k1"));
        reg.register("name_b", KernelId::new("k1"));

        let names = reg.names_for(&KernelId::new("k1"));
        assert_eq!(names.len(), 2);
        assert!(names.contains(&"name_a"));
        assert!(names.contains(&"name_b"));
    }

    #[test]
    fn test_wildcard_exact() {
        assert!(wildcard_match("hello", "hello"));
        assert!(!wildcard_match("hello", "world"));
    }

    #[test]
    fn test_wildcard_star() {
        assert!(wildcard_match("isa_*", "isa_ontology"));
        assert!(wildcard_match("isa_*", "isa_rules"));
        assert!(!wildcard_match("isa_*", "pcaob_rules"));
    }

    #[test]
    fn test_wildcard_star_no_slash() {
        assert!(wildcard_match("standards/*", "standards/isa"));
        assert!(!wildcard_match("standards/*", "standards/isa/500"));
    }

    #[test]
    fn test_wildcard_double_star() {
        assert!(wildcard_match("standards/**", "standards/isa/500"));
        assert!(wildcard_match("standards/**", "standards/isa"));
        assert!(!wildcard_match("standards/**", "other/isa"));
    }

    #[test]
    fn test_wildcard_question() {
        assert!(wildcard_match("actor_?", "actor_a"));
        assert!(wildcard_match("actor_?", "actor_b"));
        assert!(!wildcard_match("actor_?", "actor_ab"));
    }

    #[test]
    fn test_pattern_lookup() {
        let mut reg = ActorRegistry::new();
        reg.register("standards/isa/500", KernelId::new("k1"));
        reg.register("standards/isa/700", KernelId::new("k2"));
        reg.register("standards/pcaob/101", KernelId::new("k3"));
        reg.register("other/thing", KernelId::new("k4"));

        let isa = reg.lookup_pattern("standards/isa/*");
        assert_eq!(isa.len(), 2);

        let all_standards = reg.lookup_pattern("standards/**");
        assert_eq!(all_standards.len(), 3);
    }

    #[test]
    fn test_watcher() {
        let mut reg = ActorRegistry::new();
        let watcher = reg.watch("isa_*");

        reg.register("isa_ontology", KernelId::new("k1"));
        reg.register("pcaob_rules", KernelId::new("k2")); // Shouldn't trigger
        reg.register("isa_rules", KernelId::new("k3"));

        let events = reg.drain_events(watcher);
        assert_eq!(events.len(), 2); // Only isa_* matches
    }

    #[test]
    fn test_deregister_kernel() {
        let mut reg = ActorRegistry::new();
        reg.register("name_a", KernelId::new("k1"));
        reg.register("name_b", KernelId::new("k1"));
        reg.register("name_c", KernelId::new("k2"));

        let events = reg.deregister_kernel(&KernelId::new("k1"));
        assert_eq!(events.len(), 2);
        assert_eq!(reg.len(), 1);
        assert_eq!(reg.lookup("name_c"), Some(&KernelId::new("k2")));
    }

    #[test]
    fn test_register_with_tags() {
        let mut reg = ActorRegistry::new();
        let mut tags = HashMap::new();
        tags.insert("domain".to_string(), "audit".to_string());
        tags.insert("version".to_string(), "2.0".to_string());

        reg.register_with_tags("isa_ontology", KernelId::new("k1"), tags);

        let entry = reg.lookup_entry("isa_ontology").unwrap();
        assert_eq!(entry.tags.get("domain").unwrap(), "audit");
    }
}