ordofp_core 0.1.0

OrdoFP core provides developers with HList, Disiunctio, NominataUniversalis, Universalis, and functional type classes
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
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
//! Distributed Node Management
//!
//! > *"Nodus est fundamentum retis"*
//! > — A node is the foundation of a network. (Latin)
//!
//! This module provides types for identifying and managing nodes
//! in a distributed cluster.

use alloc::boxed::Box;
use alloc::string::String;
use alloc::vec::Vec;
use core::fmt;
use core::hash::Hash;
use core::time::Duration;

// =============================================================================
// Node Identity
// =============================================================================

/// Unique identifier for a node in the cluster.
///
/// # Latin Etymology
/// *Identitas nodi distribuendi* = identity of a distributed node.
#[derive(Clone, Copy, PartialEq, Eq, Hash)]
pub struct NodusIdentitas {
    /// High bits (typically derived from hostname/IP).
    pub alta: u64,
    /// Low bits (typically random or sequential).
    pub ima: u64,
}

impl NodusIdentitas {
    /// Create a new node ID from two 64-bit values.
    pub const fn new(alta: u64, ima: u64) -> Self {
        NodusIdentitas { alta, ima }
    }

    /// Create from a 128-bit value.
    // Both casts intentionally split `value` into its high/low 64-bit
    // halves; no bits are discarded (`to_u128` reconstructs the original
    // value exactly), so the truncation clippy warns about is by design.
    #[allow(clippy::cast_possible_truncation)]
    pub const fn from_u128(value: u128) -> Self {
        NodusIdentitas {
            alta: (value >> 64) as u64,
            ima: value as u64,
        }
    }

    /// Convert to 128-bit value.
    pub const fn to_u128(&self) -> u128 {
        ((self.alta as u128) << 64) | (self.ima as u128)
    }

    /// Nil/zero ID.
    pub const NIL: Self = NodusIdentitas { alta: 0, ima: 0 };

    /// Check if this is the nil ID.
    pub const fn is_nil(&self) -> bool {
        self.alta == 0 && self.ima == 0
    }

    /// Generate a random node ID.
    #[cfg(feature = "std")]
    pub fn generate() -> Self {
        use core::sync::atomic::{AtomicU64, Ordering};
        static COUNTER: AtomicU64 = AtomicU64::new(1);

        // Timestamp + counter suffices for a single-process discriminator;
        // add a hostname hash if IDs must be unique across hosts.
        #[allow(clippy::cast_possible_truncation)] // nanos-since-epoch fits
        // u64 until ~2554 (u64::MAX ns is ~584 years), which safely outlives
        // any process using this as a node-ID discriminator.
        let timestamp = std::time::SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .map_or(0, |d| d.as_nanos() as u64);

        NodusIdentitas {
            alta: timestamp,
            ima: COUNTER.fetch_add(1, Ordering::SeqCst),
        }
    }
}

impl fmt::Debug for NodusIdentitas {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "NodusId({:016x}{:016x})", self.alta, self.ima)
    }
}

impl fmt::Display for NodusIdentitas {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:016x}{:016x}", self.alta, self.ima)
    }
}

// =============================================================================
// Node Address
// =============================================================================

/// Network address of a node.
///
/// # Latin Etymology
/// *Inscriptio nodi* = address of a node.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct InscriptioNodi {
    /// Host address (IP or hostname).
    pub hospes: String,
    /// Port number.
    pub portus: u16,
    /// Protocol scheme.
    pub schema: ProtocollumSchema,
}

impl InscriptioNodi {
    /// Create a new node address.
    pub fn new(hospes: impl Into<String>, portus: u16) -> Self {
        InscriptioNodi {
            hospes: hospes.into(),
            portus,
            schema: ProtocollumSchema::Grpc,
        }
    }

    /// Create with explicit protocol.
    pub fn with_schema(hospes: impl Into<String>, portus: u16, schema: ProtocollumSchema) -> Self {
        InscriptioNodi {
            hospes: hospes.into(),
            portus,
            schema,
        }
    }

    /// Format as URI string.
    pub fn to_uri(&self) -> String {
        let schema = match self.schema {
            ProtocollumSchema::Grpc => "grpc",
            ProtocollumSchema::Http => "http",
            ProtocollumSchema::Https => "https",
            ProtocollumSchema::Tcp => "tcp",
            ProtocollumSchema::Unix => "unix",
        };
        alloc::format!("{}://{}:{}", schema, self.hospes, self.portus)
    }
}

impl fmt::Display for InscriptioNodi {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}:{}", self.hospes, self.portus)
    }
}

/// Protocol scheme for node communication.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub enum ProtocollumSchema {
    /// gRPC (HTTP/2 + protobuf).
    #[default]
    Grpc,
    /// Plain HTTP.
    Http,
    /// HTTPS.
    Https,
    /// Raw TCP.
    Tcp,
    /// Unix domain socket.
    Unix,
}

// =============================================================================
// Node Information
// =============================================================================

/// Complete information about a node in the cluster.
///
/// # Latin Etymology
/// *Informationes nodi* = information about a node.
#[derive(Debug, Clone)]
pub struct InformationesNodi {
    /// Unique node identifier.
    pub identitas: NodusIdentitas,
    /// Network address.
    pub inscriptio: InscriptioNodi,
    /// Node role.
    pub munus: MunusNodi,
    /// Node status.
    pub status: StatusNodi,
    /// Node capabilities.
    pub facultates: FacultatesNodi,
    /// Metadata/labels.
    pub tituli: Vec<(String, String)>,
    /// Last heartbeat time (as duration since Unix epoch).
    pub ultima_pulsatio: Option<Duration>,
}

impl InformationesNodi {
    /// Create basic node info.
    #[inline]
    pub fn new(identitas: NodusIdentitas, inscriptio: InscriptioNodi) -> Self {
        InformationesNodi {
            identitas,
            inscriptio,
            munus: MunusNodi::Executor,
            status: StatusNodi::Unknown,
            facultates: FacultatesNodi::default(),
            tituli: Vec::with_capacity(4),
            ultima_pulsatio: None,
        }
    }

    /// Set node role.
    pub fn with_role(mut self, munus: MunusNodi) -> Self {
        self.munus = munus;
        self
    }

    /// Add a label.
    pub fn with_label(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.tituli.push((key.into(), value.into()));
        self
    }

    /// Check if node is healthy.
    #[inline]
    pub fn is_healthy(&self) -> bool {
        matches!(self.status, StatusNodi::Sanus)
    }

    /// Check if node can execute computations.
    #[inline]
    pub fn can_execute(&self) -> bool {
        self.is_healthy()
            && matches!(
                self.munus,
                MunusNodi::Executor | MunusNodi::Coordinator | MunusNodi::All
            )
    }
}

/// Role of a node in the cluster.
///
/// # Latin Etymology
/// *Munus* = duty, function, role.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub enum MunusNodi {
    /// Coordinator node (schedules work).
    Coordinator,
    /// Executor node (runs computations).
    #[default]
    Executor,
    /// Both coordinator and executor.
    All,
    /// Gateway node (external API).
    Porta,
    /// Storage node.
    Repositorium,
}

impl fmt::Display for MunusNodi {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            MunusNodi::Coordinator => write!(f, "coordinator"),
            MunusNodi::Executor => write!(f, "executor"),
            MunusNodi::All => write!(f, "all"),
            MunusNodi::Porta => write!(f, "gateway"),
            MunusNodi::Repositorium => write!(f, "storage"),
        }
    }
}

/// Status of a node.
///
/// # Latin Etymology
/// *Status* = condition, state.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub enum StatusNodi {
    /// Unknown status.
    #[default]
    Unknown,
    /// Healthy and ready.
    Sanus,
    /// Starting up.
    Surgit,
    /// Shutting down.
    Descendit,
    /// Unhealthy/failing.
    Aegrotus,
    /// Unreachable.
    Inaccessibilis,
    /// Draining (not accepting new work).
    Exhaurit,
}

impl StatusNodi {
    /// Check if the node can accept new work.
    pub fn can_accept_work(&self) -> bool {
        matches!(self, StatusNodi::Sanus)
    }
}

impl fmt::Display for StatusNodi {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            StatusNodi::Unknown => write!(f, "unknown"),
            StatusNodi::Sanus => write!(f, "healthy"),
            StatusNodi::Surgit => write!(f, "starting"),
            StatusNodi::Descendit => write!(f, "stopping"),
            StatusNodi::Aegrotus => write!(f, "unhealthy"),
            StatusNodi::Inaccessibilis => write!(f, "unreachable"),
            StatusNodi::Exhaurit => write!(f, "draining"),
        }
    }
}

// =============================================================================
// Node Capabilities
// =============================================================================

/// Capabilities of a node.
///
/// # Latin Etymology
/// *Facultates* = capabilities, powers.
#[derive(Debug, Clone, Default)]
pub struct FacultatesNodi {
    /// Number of CPU cores.
    pub nuclei_cpu: u32,
    /// Total memory in bytes.
    pub memoria_bytes: u64,
    /// Available memory in bytes.
    pub memoria_disponibilis: u64,
    /// GPU availability.
    pub gpu: Option<GpuFacultas>,
    /// Supported effect handlers.
    pub effectus_tractati: Vec<u64>,
    /// Maximum concurrent tasks.
    pub munera_maxima: u32,
    /// Current task count.
    pub munera_currentia: u32,
}

impl FacultatesNodi {
    /// Calculate load factor (0.0 - 1.0).
    #[inline]
    pub fn load_factor(&self) -> f64 {
        if self.munera_maxima == 0 {
            1.0
        } else {
            f64::from(self.munera_currentia) / f64::from(self.munera_maxima)
        }
    }

    /// Check if node has capacity for more work.
    #[inline]
    pub fn has_capacity(&self) -> bool {
        self.munera_currentia < self.munera_maxima
    }

    /// Check if node can handle a specific effect.
    #[inline]
    pub fn can_handle_effect(&self, effect_id: u64) -> bool {
        self.effectus_tractati.contains(&effect_id)
    }
}

/// GPU capability information.
#[derive(Debug, Clone)]
pub struct GpuFacultas {
    /// GPU vendor.
    pub vendor: String,
    /// GPU model.
    pub modellum: String,
    /// VRAM in bytes.
    pub vram_bytes: u64,
    /// Compute capability version.
    pub versio_computationis: String,
}

// =============================================================================
// Node Affinity
// =============================================================================

/// Affinity specification for node selection.
///
/// # Latin Etymology
/// *Affinitas* = relationship, affinity.
#[derive(Debug, Clone, Default)]
pub enum AffinitasNodi {
    /// No preference - any node is acceptable.
    #[default]
    Quodlibet,

    /// Prefer local execution.
    Localis,

    /// Prefer a specific node.
    Nodus(NodusIdentitas),

    /// Prefer nodes matching labels.
    Tituli(Vec<(String, String)>),

    /// Prefer nodes in a specific zone/region.
    Regio(String),

    /// Prefer nodes with specific capabilities.
    Facultates(RequirementaFacultatum),

    /// Weighted preferences.
    Ponderata(Vec<(AffinitasNodi, u32)>),

    /// Anti-affinity (avoid these nodes).
    Non(Box<AffinitasNodi>),
}

impl AffinitasNodi {
    /// Check if a node matches this affinity.
    pub fn matches(&self, node: &InformationesNodi) -> bool {
        match self {
            AffinitasNodi::Quodlibet => true,
            AffinitasNodi::Localis => false, // Must be handled by caller
            AffinitasNodi::Nodus(id) => node.identitas == *id,
            AffinitasNodi::Tituli(labels) => labels
                .iter()
                .all(|(k, v)| node.tituli.iter().any(|(nk, nv)| nk == k && nv == v)),
            AffinitasNodi::Regio(region) => {
                node.tituli.iter().any(|(k, v)| k == "regio" && v == region)
            }
            AffinitasNodi::Facultates(req) => req.satisfies(&node.facultates),
            AffinitasNodi::Ponderata(affinities) => affinities.iter().any(|(a, _)| a.matches(node)),
            AffinitasNodi::Non(inner) => !inner.matches(node),
        }
    }

    /// Calculate affinity score for a node (higher is better).
    pub fn score(&self, node: &InformationesNodi) -> u32 {
        match self {
            AffinitasNodi::Quodlibet => 1,
            AffinitasNodi::Localis => 0, // Must be handled by caller
            AffinitasNodi::Nodus(id) => {
                if node.identitas == *id {
                    100
                } else {
                    0
                }
            }
            AffinitasNodi::Tituli(labels) => {
                let matching = labels
                    .iter()
                    .filter(|(k, v)| node.tituli.iter().any(|(nk, nv)| nk == k && nv == v))
                    .count();
                (matching * 10) as u32
            }
            AffinitasNodi::Regio(region) => {
                if node.tituli.iter().any(|(k, v)| k == "regio" && v == region) {
                    50
                } else {
                    0
                }
            }
            AffinitasNodi::Facultates(req) => {
                if req.satisfies(&node.facultates) {
                    30
                } else {
                    0
                }
            }
            AffinitasNodi::Ponderata(affinities) => affinities
                .iter()
                // A score is a ranking value, not an exact quantity — on
                // overflow, saturating to u32::MAX still ranks this
                // candidate correctly as "very strongly preferred" rather
                // than wrapping into a small/misleading number.
                .map(|(a, weight)| a.score(node).saturating_mul(*weight))
                .max()
                .unwrap_or(0),
            AffinitasNodi::Non(inner) => {
                if inner.matches(node) {
                    0
                } else {
                    10
                }
            }
        }
    }
}

/// Requirements for node capabilities.
#[derive(Debug, Clone, Default)]
pub struct RequirementaFacultatum {
    /// Minimum CPU cores.
    pub nuclei_cpu_min: Option<u32>,
    /// Minimum memory.
    pub memoria_min: Option<u64>,
    /// Requires GPU.
    pub gpu_requiritur: bool,
    /// Required effect handlers.
    pub effectus_requiriti: Vec<u64>,
}

impl RequirementaFacultatum {
    /// Check if capabilities satisfy requirements.
    pub fn satisfies(&self, cap: &FacultatesNodi) -> bool {
        if let Some(min_cpu) = self.nuclei_cpu_min
            && cap.nuclei_cpu < min_cpu
        {
            return false;
        }

        if let Some(min_mem) = self.memoria_min
            && cap.memoria_disponibilis < min_mem
        {
            return false;
        }

        if self.gpu_requiritur && cap.gpu.is_none() {
            return false;
        }

        for effect_id in &self.effectus_requiriti {
            if !cap.effectus_tractati.contains(effect_id) {
                return false;
            }
        }

        true
    }
}

// =============================================================================
// Tests
// =============================================================================

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

    #[test]
    fn test_nodus_identitas() {
        let id1 = NodusIdentitas::new(1, 2);
        let id2 = NodusIdentitas::new(1, 2);
        let id3 = NodusIdentitas::new(1, 3);

        assert_eq!(id1, id2);
        assert_ne!(id1, id3);
    }

    #[test]
    fn test_nodus_identitas_u128() {
        let value: u128 = 0x0123_4567_89AB_CDEF_FEDC_BA98_7654_3210;
        let id = NodusIdentitas::from_u128(value);
        assert_eq!(id.to_u128(), value);
    }

    #[test]
    fn test_inscriptio_nodi() {
        let addr = InscriptioNodi::new("localhost", 8080);
        assert_eq!(addr.hospes, "localhost");
        assert_eq!(addr.portus, 8080);
        assert_eq!(addr.to_uri(), "grpc://localhost:8080");
    }

    #[test]
    fn test_status_nodi() {
        assert!(StatusNodi::Sanus.can_accept_work());
        assert!(!StatusNodi::Aegrotus.can_accept_work());
        assert!(!StatusNodi::Exhaurit.can_accept_work());
    }

    #[test]
    fn test_facultates_load_factor() {
        let cap = FacultatesNodi {
            munera_maxima: 100,
            munera_currentia: 50,
            ..Default::default()
        };
        assert!((cap.load_factor() - 0.5).abs() < f64::EPSILON);
    }

    #[test]
    fn test_affinitas_matches() {
        let node = InformationesNodi {
            identitas: NodusIdentitas::new(1, 1),
            inscriptio: InscriptioNodi::new("localhost", 8080),
            munus: MunusNodi::Executor,
            status: StatusNodi::Sanus,
            facultates: FacultatesNodi::default(),
            tituli: vec![("regio".into(), "us-west".into())],
            ultima_pulsatio: None,
        };

        assert!(AffinitasNodi::Quodlibet.matches(&node));
        assert!(AffinitasNodi::Regio("us-west".into()).matches(&node));
        assert!(!AffinitasNodi::Regio("us-east".into()).matches(&node));
    }
}