crdtosphere 0.1.0

Universal embedded CRDTs for distributed coordination across automotive, robotics, IoT, and industrial applications
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
//! Platform-specific constants and optimizations
//!
//! This module provides platform-specific constants and optimizations
//! for different embedded platforms without requiring HAL dependencies.

/// Platform-specific constants for AURIX TriCore
#[cfg(feature = "aurix")]
pub mod constants {
    /// Maximum merge cycles for AURIX platform
    pub const MAX_MERGE_CYCLES: u32 = 500;

    /// Maximum interrupt latency in CPU cycles
    pub const MAX_INTERRUPT_LATENCY: u32 = 100;

    /// Cache line size in bytes
    pub const CACHE_LINE_SIZE: usize = 32;

    /// Supports multi-core operations
    pub const SUPPORTS_MULTICORE: bool = true;

    /// Maximum number of cores
    pub const MAX_CORES: u8 = 3;

    /// Memory alignment requirement
    pub const MEMORY_ALIGNMENT: usize = 32;

    /// Platform name
    pub const PLATFORM_NAME: &str = "AURIX";
}

/// Platform-specific constants for STM32
#[cfg(feature = "stm32")]
pub mod constants {
    /// Maximum merge cycles for STM32 platform
    pub const MAX_MERGE_CYCLES: u32 = 200;

    /// Maximum interrupt latency in CPU cycles
    pub const MAX_INTERRUPT_LATENCY: u32 = 50;

    /// Cache line size in bytes
    pub const CACHE_LINE_SIZE: usize = 32;

    /// Supports multi-core operations
    pub const SUPPORTS_MULTICORE: bool = false;

    /// Maximum number of cores
    pub const MAX_CORES: u8 = 1;

    /// Memory alignment requirement
    pub const MEMORY_ALIGNMENT: usize = 4;

    /// Platform name
    pub const PLATFORM_NAME: &str = "STM32";
}

/// Platform-specific constants for Cortex-M
#[cfg(feature = "cortex-m")]
pub mod constants {
    /// Maximum merge cycles for Cortex-M platform
    pub const MAX_MERGE_CYCLES: u32 = 100;

    /// Maximum interrupt latency in CPU cycles
    pub const MAX_INTERRUPT_LATENCY: u32 = 25;

    /// Cache line size in bytes
    pub const CACHE_LINE_SIZE: usize = 32;

    /// Supports multi-core operations
    pub const SUPPORTS_MULTICORE: bool = false;

    /// Maximum number of cores
    pub const MAX_CORES: u8 = 1;

    /// Memory alignment requirement
    pub const MEMORY_ALIGNMENT: usize = 4;

    /// Platform name
    pub const PLATFORM_NAME: &str = "Cortex-M";
}

/// Platform-specific constants for RISC-V
#[cfg(feature = "riscv")]
pub mod constants {
    /// Maximum merge cycles for RISC-V platform
    pub const MAX_MERGE_CYCLES: u32 = 300;

    /// Maximum interrupt latency in CPU cycles
    pub const MAX_INTERRUPT_LATENCY: u32 = 30;

    /// Cache line size in bytes
    pub const CACHE_LINE_SIZE: usize = 64;

    /// Supports multi-core operations
    pub const SUPPORTS_MULTICORE: bool = true;

    /// Maximum number of cores (variable for RISC-V)
    pub const MAX_CORES: u8 = 8;

    /// Memory alignment requirement
    pub const MEMORY_ALIGNMENT: usize = 8;

    /// Platform name
    pub const PLATFORM_NAME: &str = "RISC-V";
}

/// Default platform constants (when no specific platform is selected)
#[cfg(not(any(
    feature = "aurix",
    feature = "stm32",
    feature = "cortex-m",
    feature = "riscv"
)))]
pub mod constants {
    /// Maximum merge cycles for default platform
    pub const MAX_MERGE_CYCLES: u32 = 150;

    /// Maximum interrupt latency in CPU cycles
    pub const MAX_INTERRUPT_LATENCY: u32 = 40;

    /// Cache line size in bytes
    pub const CACHE_LINE_SIZE: usize = 32;

    /// Supports multi-core operations
    pub const SUPPORTS_MULTICORE: bool = false;

    /// Maximum number of cores
    pub const MAX_CORES: u8 = 1;

    /// Memory alignment requirement
    pub const MEMORY_ALIGNMENT: usize = 4;

    /// Platform name
    pub const PLATFORM_NAME: &str = "Generic";
}

/// Platform-specific validation limits
pub mod validation {
    /// Maximum active nodes for platform-specific validation
    #[cfg(feature = "aurix")]
    pub const MAX_ACTIVE_NODES: usize = 3; // AURIX TriCore limit

    /// Maximum active nodes for platform-specific validation
    #[cfg(feature = "stm32")]
    pub const MAX_ACTIVE_NODES: usize = 8; // STM32 power-aware limit

    /// Maximum active nodes for platform-specific validation
    #[cfg(feature = "cortex-m")]
    pub const MAX_ACTIVE_NODES: usize = 4; // Cortex-M memory constraint

    /// Maximum active nodes for platform-specific validation
    #[cfg(feature = "riscv")]
    pub const MAX_ACTIVE_NODES: usize = 16; // RISC-V flexible limit

    /// Maximum active nodes for platform-specific validation (default)
    #[cfg(not(any(
        feature = "aurix",
        feature = "stm32",
        feature = "cortex-m",
        feature = "riscv"
    )))]
    pub const MAX_ACTIVE_NODES: usize = 8; // Default conservative limit

    /// Maximum memory usage for platform-specific validation
    #[cfg(feature = "aurix")]
    pub const MAX_MEMORY_USAGE: usize = 8192; // AURIX has more memory

    /// Maximum memory usage for platform-specific validation
    #[cfg(feature = "stm32")]
    pub const MAX_MEMORY_USAGE: usize = 2048; // STM32 moderate memory

    /// Maximum memory usage for platform-specific validation
    #[cfg(feature = "cortex-m")]
    pub const MAX_MEMORY_USAGE: usize = 1024; // Cortex-M memory constraint

    /// Maximum memory usage for platform-specific validation
    #[cfg(feature = "riscv")]
    pub const MAX_MEMORY_USAGE: usize = 4096; // RISC-V variable memory

    /// Maximum memory usage for platform-specific validation
    #[cfg(not(any(
        feature = "aurix",
        feature = "stm32",
        feature = "cortex-m",
        feature = "riscv"
    )))]
    pub const MAX_MEMORY_USAGE: usize = 2048; // Default moderate limit
}

/// Platform-specific error handling types
pub mod error_handling {
    #[allow(unused_imports)]
    use crate::error::CRDTError;

    /// AURIX safety actions for error handling
    #[cfg(feature = "aurix")]
    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    pub enum AurixSafetyAction {
        /// Continue normal operation
        ContinueOperation,
        /// Enter safe state
        SafeState,
        /// Reset the system
        SystemReset,
        /// Isolate the node
        IsolateNode,
    }

    #[cfg(feature = "aurix")]
    impl From<CRDTError> for AurixSafetyAction {
        fn from(err: CRDTError) -> Self {
            match err {
                CRDTError::BufferOverflow => AurixSafetyAction::SafeState,
                CRDTError::InvalidState => AurixSafetyAction::SystemReset,
                CRDTError::InvalidNodeId => AurixSafetyAction::IsolateNode,
                _ => AurixSafetyAction::ContinueOperation,
            }
        }
    }

    /// STM32 power management actions for error handling
    #[cfg(feature = "stm32")]
    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    pub enum STM32PowerAction {
        /// Continue normal operation
        Continue,
        /// Reduce CPU frequency
        ReduceFrequency,
        /// Enter stop mode
        EnterStopMode,
        /// Enter standby mode
        EnterStandbyMode,
    }

    #[cfg(feature = "stm32")]
    impl From<CRDTError> for STM32PowerAction {
        fn from(err: CRDTError) -> Self {
            match err {
                CRDTError::BufferOverflow => STM32PowerAction::ReduceFrequency,
                CRDTError::InvalidState => STM32PowerAction::EnterStopMode,
                CRDTError::ConfigurationExceeded => STM32PowerAction::EnterStandbyMode,
                _ => STM32PowerAction::Continue,
            }
        }
    }

    /// Cortex-M memory management actions for error handling
    #[cfg(feature = "cortex-m")]
    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    pub enum CortexMMemoryAction {
        /// Continue normal operation
        Continue,
        /// Compact memory
        CompactMemory,
        /// Reduce capacity
        ReduceCapacity,
        /// Reset to minimal state
        ResetMinimal,
    }

    #[cfg(feature = "cortex-m")]
    impl From<CRDTError> for CortexMMemoryAction {
        fn from(err: CRDTError) -> Self {
            match err {
                CRDTError::BufferOverflow => CortexMMemoryAction::CompactMemory,
                CRDTError::ConfigurationExceeded => CortexMMemoryAction::ReduceCapacity,
                CRDTError::InvalidState => CortexMMemoryAction::ResetMinimal,
                _ => CortexMMemoryAction::Continue,
            }
        }
    }

    /// RISC-V performance actions for error handling
    #[cfg(feature = "riscv")]
    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    pub enum RiscVPerformanceAction {
        /// Continue normal operation
        Continue,
        /// Optimize for performance
        OptimizePerformance,
        /// Distribute load
        DistributeLoad,
        /// Scale down operations
        ScaleDown,
    }

    #[cfg(feature = "riscv")]
    impl From<CRDTError> for RiscVPerformanceAction {
        fn from(err: CRDTError) -> Self {
            match err {
                CRDTError::BufferOverflow => RiscVPerformanceAction::OptimizePerformance,
                CRDTError::ConfigurationExceeded => RiscVPerformanceAction::DistributeLoad,
                CRDTError::InvalidState => RiscVPerformanceAction::ScaleDown,
                _ => RiscVPerformanceAction::Continue,
            }
        }
    }
}

/// Platform-specific multi-core support
pub mod multicore {
    #[allow(unused_imports)]
    use super::constants;
    #[allow(unused_imports)]
    use crate::error::CRDTResult;

    /// Multi-core coordination trait for platforms that support it
    #[cfg(any(feature = "aurix", feature = "riscv"))]
    pub trait MultiCoreCRDT {
        /// Number of cores available
        fn core_count() -> u8 {
            constants::MAX_CORES
        }

        /// Distribute work across cores
        fn distribute_work(&mut self, core_mask: u8) -> CRDTResult<()>;

        /// Collect results from other cores
        fn collect_results(&mut self) -> CRDTResult<()>;

        /// Check if core-local operations are supported
        fn supports_core_local_ops() -> bool {
            constants::SUPPORTS_MULTICORE
        }
    }

    /// Single-core trait for platforms that don't support multi-core
    #[cfg(any(feature = "stm32", feature = "cortex-m"))]
    pub trait SingleCoreCRDT {
        /// Optimize for single-core performance
        fn optimize_single_core(&mut self) -> CRDTResult<()>;

        /// Check if single-core optimizations are available
        fn supports_single_core_opts() -> bool {
            true
        }
    }
}

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

    #[test]
    fn test_platform_constants() {
        // Test that constants are defined and reasonable
        assert!(constants::MAX_MERGE_CYCLES > 0);
        assert!(constants::MAX_INTERRUPT_LATENCY > 0);
        assert!(constants::CACHE_LINE_SIZE > 0);
        assert!(constants::MAX_CORES > 0);
        assert!(constants::MEMORY_ALIGNMENT > 0);
        assert!(!constants::PLATFORM_NAME.is_empty());
    }

    #[test]
    fn test_validation_constants() {
        // Test that validation constants are reasonable
        assert!(validation::MAX_ACTIVE_NODES > 0);
        assert!(validation::MAX_MEMORY_USAGE > 0);
    }

    #[test]
    fn test_platform_specific_values() {
        // Test platform-specific optimizations
        #[cfg(feature = "aurix")]
        {
            assert_eq!(constants::MAX_CORES, 3);
            assert_eq!(constants::MEMORY_ALIGNMENT, 32);
            assert!(constants::SUPPORTS_MULTICORE);
            assert_eq!(constants::PLATFORM_NAME, "AURIX");
        }

        #[cfg(feature = "stm32")]
        {
            assert_eq!(constants::MAX_CORES, 1);
            assert_eq!(constants::MEMORY_ALIGNMENT, 4);
            assert!(!constants::SUPPORTS_MULTICORE);
            assert_eq!(constants::PLATFORM_NAME, "STM32");
        }

        #[cfg(feature = "cortex-m")]
        {
            assert_eq!(constants::MAX_CORES, 1);
            assert_eq!(constants::MEMORY_ALIGNMENT, 4);
            assert!(!constants::SUPPORTS_MULTICORE);
            assert_eq!(constants::PLATFORM_NAME, "Cortex-M");
        }

        #[cfg(feature = "riscv")]
        {
            assert_eq!(constants::MAX_CORES, 8);
            assert_eq!(constants::MEMORY_ALIGNMENT, 8);
            assert!(constants::SUPPORTS_MULTICORE);
            assert_eq!(constants::PLATFORM_NAME, "RISC-V");
        }
    }

    #[cfg(feature = "aurix")]
    #[test]
    fn test_aurix_error_handling() {
        use crate::error::CRDTError;
        use error_handling::*;

        let action: AurixSafetyAction = CRDTError::BufferOverflow.into();
        assert_eq!(action, AurixSafetyAction::SafeState);

        let action: AurixSafetyAction = CRDTError::InvalidState.into();
        assert_eq!(action, AurixSafetyAction::SystemReset);

        let action: AurixSafetyAction = CRDTError::InvalidNodeId.into();
        assert_eq!(action, AurixSafetyAction::IsolateNode);
    }

    #[cfg(feature = "stm32")]
    #[test]
    fn test_stm32_error_handling() {
        use crate::error::CRDTError;
        use error_handling::*;

        let action: STM32PowerAction = CRDTError::BufferOverflow.into();
        assert_eq!(action, STM32PowerAction::ReduceFrequency);

        let action: STM32PowerAction = CRDTError::InvalidState.into();
        assert_eq!(action, STM32PowerAction::EnterStopMode);
    }
}