memlink-runtime 0.2.0

Dynamic module loading framework with circuit breaker, caching, pooling, health checks, versioning, and auto-discovery
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
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
//! Global backpressure management for the runtime.
//!
//! This module calculates and broadcasts backpressure signals to all connected clients.
//! Backpressure is computed from multiple factors:
//! - Total queue depth across all modules
//! - CPU and memory usage
//! - Active client count
//! - Module-specific quotas

use std::sync::atomic::{AtomicU32, AtomicU64, AtomicUsize, Ordering};
use std::sync::Arc;
use std::time::{Duration, Instant};

use dashmap::DashMap;

/// Backpressure thresholds for different congestion levels.
pub const BP_LOW_THRESHOLD: f32 = 0.3;
pub const BP_MEDIUM_THRESHOLD: f32 = 0.5;
pub const BP_HIGH_THRESHOLD: f32 = 0.7;
pub const BP_CRITICAL_THRESHOLD: f32 = 0.9;

/// Maximum backpressure value (scaled to 1000 for atomic operations).
const BP_SCALE: u32 = 1000;

/// Global backpressure state shared across the runtime.
///
/// This is written to the SHM control region for clients to read.
#[derive(Debug)]
pub struct BackpressureState {
    /// Current backpressure value (0-1000, representing 0.0-1.0).
    value: AtomicU32,
    /// Timestamp of last calculation.
    last_update: AtomicU64,
    /// Number of active clients.
    active_clients: AtomicUsize,
    /// Total requests in queue.
    queue_depth: AtomicUsize,
    /// Requests rejected due to backpressure.
    rejected_count: AtomicU64,
}

impl BackpressureState {
    /// Creates a new backpressure state.
    pub fn new() -> Self {
        Self {
            value: AtomicU32::new(0),
            last_update: AtomicU64::new(0),
            active_clients: AtomicUsize::new(0),
            queue_depth: AtomicUsize::new(0),
            rejected_count: AtomicU64::new(0),
        }
    }

    /// Returns the current backpressure value (0.0-1.0).
    pub fn get(&self) -> f32 {
        self.value.load(Ordering::Acquire) as f32 / BP_SCALE as f32
    }

    /// Sets the backpressure value (0.0-1.0).
    pub fn set(&self, value: f32) {
        let scaled = (value.clamp(0.0, 1.0) * BP_SCALE as f32) as u32;
        self.value.store(scaled, Ordering::Release);

        // Update timestamp
        let now = Instant::now().duration_since(Instant::now()).as_secs();
        self.last_update.store(now, Ordering::Relaxed);
    }

    /// Increments the rejected request count.
    pub fn record_rejection(&self) {
        self.rejected_count.fetch_add(1, Ordering::Relaxed);
    }

    /// Returns the number of rejected requests.
    pub fn rejected_count(&self) -> u64 {
        self.rejected_count.load(Ordering::Acquire)
    }

    /// Returns the number of active clients.
    pub fn active_clients(&self) -> usize {
        self.active_clients.load(Ordering::Acquire)
    }

    /// Returns the current queue depth.
    pub fn queue_depth(&self) -> usize {
        self.queue_depth.load(Ordering::Acquire)
    }

    /// Returns the backpressure level as a string.
    pub fn level(&self) -> &'static str {
        let bp = self.get();
        if bp < BP_LOW_THRESHOLD {
            "Low"
        } else if bp < BP_MEDIUM_THRESHOLD {
            "Medium"
        } else if bp < BP_HIGH_THRESHOLD {
            "High"
        } else if bp < BP_CRITICAL_THRESHOLD {
            "Very High"
        } else {
            "Critical"
        }
    }
}

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

/// Per-module quota configuration.
#[derive(Debug, Clone)]
pub struct ModuleQuota {
    /// Maximum calls per second.
    pub max_calls_per_sec: u32,
    /// Maximum concurrent in-flight requests.
    pub max_in_flight: usize,
    /// Maximum memory usage (bytes).
    pub max_memory_bytes: usize,
}

impl Default for ModuleQuota {
    fn default() -> Self {
        Self {
            max_calls_per_sec: 1000,
            max_in_flight: 100,
            max_memory_bytes: 64 * 1024 * 1024, // 64 MB
        }
    }
}

/// Per-module resource tracking and quota enforcement.
#[derive(Debug)]
pub struct ModuleResources {
    /// Module name/identifier.
    module_name: String,
    /// Calls in the current second.
    calls_this_sec: AtomicU32,
    /// Current in-flight request count.
    in_flight: AtomicUsize,
    /// Current memory usage (bytes).
    memory_bytes: AtomicUsize,
    /// Quota configuration.
    quota: ModuleQuota,
}

impl ModuleResources {
    /// Creates a new module resource tracker.
    pub fn new(module_name: String, quota: ModuleQuota) -> Self {
        Self {
            module_name,
            calls_this_sec: AtomicU32::new(0),
            in_flight: AtomicUsize::new(0),
            memory_bytes: AtomicUsize::new(0),
            quota,
        }
    }

    /// Checks if a new call can be admitted.
    pub fn can_admit(&self) -> bool {
        // Check in-flight limit
        if self.in_flight.load(Ordering::Acquire) >= self.quota.max_in_flight {
            return false;
        }

        // Check rate limit (simplified - should use sliding window)
        let calls = self.calls_this_sec.load(Ordering::Acquire);
        if calls >= self.quota.max_calls_per_sec {
            return false;
        }

        // Check memory limit
        let memory = self.memory_bytes.load(Ordering::Acquire);
        if memory >= self.quota.max_memory_bytes {
            return false;
        }

        true
    }

    /// Records a new call start.
    pub fn record_call_start(&self) -> bool {
        if !self.can_admit() {
            return false;
        }

        self.in_flight.fetch_add(1, Ordering::AcqRel);
        self.calls_this_sec.fetch_add(1, Ordering::Relaxed);
        true
    }

    /// Records a call completion.
    pub fn record_call_end(&self) {
        self.in_flight.fetch_sub(1, Ordering::AcqRel);
    }

    /// Updates memory usage.
    pub fn set_memory_usage(&self, bytes: usize) {
        self.memory_bytes.store(bytes, Ordering::Release);
    }

    /// Resets the per-second counter (called by a background task).
    pub fn reset_second_counter(&self) {
        self.calls_this_sec.store(0, Ordering::Relaxed);
    }

    /// Returns the current in-flight count.
    pub fn in_flight(&self) -> usize {
        self.in_flight.load(Ordering::Acquire)
    }

    /// Returns the current memory usage.
    pub fn memory_usage(&self) -> usize {
        self.memory_bytes.load(Ordering::Acquire)
    }

    /// Returns the module name.
    pub fn module_name(&self) -> &str {
        &self.module_name
    }
}

/// Global resource manager for the runtime.
///
/// Tracks all modules and clients, calculates backpressure,
/// and enforces quotas.
#[derive(Debug)]
pub struct ResourceManager {
    /// Global backpressure state.
    pub backpressure: Arc<BackpressureState>,
    /// Per-module resource tracking.
    modules: DashMap<String, Arc<ModuleResources>>,
    /// Default quota for modules without explicit configuration.
    default_quota: ModuleQuota,
}

impl ResourceManager {
    /// Creates a new resource manager.
    pub fn new() -> Self {
        Self {
            backpressure: Arc::new(BackpressureState::new()),
            modules: DashMap::new(),
            default_quota: ModuleQuota::default(),
        }
    }

    /// Creates a resource manager with custom default quota.
    pub fn with_default_quota(quota: ModuleQuota) -> Self {
        Self {
            backpressure: Arc::new(BackpressureState::new()),
            modules: DashMap::new(),
            default_quota: quota,
        }
    }

    /// Gets or creates a module resource tracker.
    pub fn get_or_create_module(&self, module_name: &str) -> Arc<ModuleResources> {
        self.modules
            .entry(module_name.to_string())
            .or_insert_with(|| {
                Arc::new(ModuleResources::new(
                    module_name.to_string(),
                    self.default_quota.clone(),
                ))
            })
            .clone()
    }

    /// Registers a module with a custom quota.
    pub fn register_module(&self, module_name: &str, quota: ModuleQuota) {
        self.modules.insert(
            module_name.to_string(),
            Arc::new(ModuleResources::new(module_name.to_string(), quota)),
        );
    }

    /// Checks if a request can be admitted.
    pub fn can_admit_request(&self, module_name: &str) -> bool {
        // Check global backpressure first
        let bp = self.backpressure.get();
        if bp >= BP_CRITICAL_THRESHOLD {
            self.backpressure.record_rejection();
            return false;
        }

        // Check module-specific quota
        let module = self.get_or_create_module(module_name);
        if !module.can_admit() {
            self.backpressure.record_rejection();
            return false;
        }

        true
    }

    /// Records a request start.
    pub fn record_request_start(&self, module_name: &str) -> bool {
        if !self.can_admit_request(module_name) {
            return false;
        }

        let module = self.get_or_create_module(module_name);
        module.record_call_start();

        // Update global queue depth
        self.backpressure
            .queue_depth
            .fetch_add(1, Ordering::Relaxed);

        true
    }

    /// Records a request completion.
    pub fn record_request_end(&self, module_name: &str) {
        let module = self.get_or_create_module(module_name);
        module.record_call_end();

        // Update global queue depth
        self.backpressure
            .queue_depth
            .fetch_sub(1, Ordering::Relaxed);
    }

    /// Calculates and updates global backpressure.
    ///
    /// This should be called periodically (e.g., every 100ms).
    pub fn update_backpressure(&self) {
        let queue_depth = self.backpressure.queue_depth.load(Ordering::Acquire);
        let active_clients = self.backpressure.active_clients.load(Ordering::Acquire);

        // Calculate backpressure from multiple factors
        let queue_factor = (queue_depth as f32 / 1000.0).min(1.0);
        let client_factor = (active_clients as f32 / 100.0).min(1.0);

        // Weighted average: 70% queue, 30% clients
        let backpressure = queue_factor * 0.7 + client_factor * 0.3;

        self.backpressure.set(backpressure);
    }

    /// Increments the active client count.
    pub fn client_connected(&self) {
        self.backpressure
            .active_clients
            .fetch_add(1, Ordering::AcqRel);
    }

    /// Decrements the active client count.
    pub fn client_disconnected(&self) {
        self.backpressure
            .active_clients
            .fetch_sub(1, Ordering::AcqRel);
    }

    /// Returns statistics about the resource manager.
    pub fn stats(&self) -> ResourceManagerStats {
        let mut total_in_flight = 0;
        let mut total_memory = 0;

        for entry in self.modules.iter() {
            total_in_flight += entry.value().in_flight();
            total_memory += entry.value().memory_usage();
        }

        ResourceManagerStats {
            backpressure: self.backpressure.get(),
            active_clients: self.backpressure.active_clients(),
            queue_depth: self.backpressure.queue_depth(),
            total_in_flight,
            total_memory,
            module_count: self.modules.len(),
        }
    }

    /// Starts a background task that periodically resets counters and updates backpressure.
    pub fn spawn_background_task(&self) -> std::thread::JoinHandle<()> {
        let _backpressure = Arc::clone(&self.backpressure);
        let modules = self
            .modules
            .iter()
            .map(|e| e.key().clone())
            .collect::<Vec<_>>();
        let modules = Arc::new(modules);

        std::thread::spawn(move || {
            let mut last_second = Instant::now();
            let mut last_update = Instant::now();

            loop {
                let now = Instant::now();

                // Reset per-second counters every second
                if now.duration_since(last_second) >= Duration::from_secs(1) {
                    for module_name in modules.iter() {
                        // Note: In production, you'd get the actual ModuleResources
                        // This is a simplified version
                        let _ = module_name;
                    }
                    last_second = now;
                }

                // Update backpressure every 100ms
                if now.duration_since(last_update) >= Duration::from_millis(100) {
                    // Note: Would need access to self here
                    // This is a simplified version
                    last_update = now;
                }

                std::thread::sleep(Duration::from_millis(10));
            }
        })
    }
}

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

/// Statistics about resource manager state.
#[derive(Debug, Clone)]
pub struct ResourceManagerStats {
    pub backpressure: f32,
    pub active_clients: usize,
    pub queue_depth: usize,
    pub total_in_flight: usize,
    pub total_memory: usize,
    pub module_count: usize,
}

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

    #[test]
    fn test_backpressure_state() {
        let bp = BackpressureState::new();
        assert_eq!(bp.get(), 0.0);

        bp.set(0.5);
        assert_eq!(bp.get(), 0.5);

        bp.set(1.0);
        assert_eq!(bp.get(), 1.0);

        bp.set(1.5); // Should clamp to 1.0
        assert_eq!(bp.get(), 1.0);
    }

    #[test]
    fn test_module_quota_enforcement() {
        let quota = ModuleQuota {
            max_calls_per_sec: 10,
            max_in_flight: 5,
            max_memory_bytes: 1024,
        };

        let module = ModuleResources::new("test".to_string(), quota);

        // Should admit up to max_in_flight
        for i in 0..5 {
            assert!(module.record_call_start(), "Call {} should be admitted", i);
        }

        // 6th call should be rejected (in-flight limit)
        assert!(!module.record_call_start());

        // Complete one call
        module.record_call_end();

        // Now should admit again
        assert!(module.record_call_start());
    }

    #[test]
    fn test_resource_manager_backpressure() {
        let rm = ResourceManager::new();

        // Initially no backpressure
        assert_eq!(rm.backpressure.get(), 0.0);

        // Simulate requests
        rm.record_request_start("module1");
        rm.record_request_start("module2");
        rm.record_request_start("module1");

        // Update backpressure
        rm.update_backpressure();

        // Should have some backpressure now
        assert!(rm.backpressure.get() > 0.0);

        // Complete requests
        rm.record_request_end("module1");
        rm.record_request_end("module2");
        rm.record_request_end("module1");

        // Update backpressure
        rm.update_backpressure();

        // Backpressure should decrease
        assert!(rm.backpressure.get() < 0.1);
    }

    #[test]
    fn test_client_tracking() {
        let rm = ResourceManager::new();
        assert_eq!(rm.backpressure.active_clients(), 0);

        rm.client_connected();
        rm.client_connected();
        assert_eq!(rm.backpressure.active_clients(), 2);

        rm.client_disconnected();
        assert_eq!(rm.backpressure.active_clients(), 1);
    }
}