ipfrs-tensorlogic 0.1.0

Zero-copy tensor operations and logic programming for content-addressed storage
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
//! Shared memory support for zero-copy IPC
//!
//! Provides mmap-based buffer sharing for:
//! - Cross-process tensor sharing
//! - Zero-copy IPC between processes
//! - Memory-efficient model serving

use crate::arrow::TensorDtype;
use memmap2::{Mmap, MmapMut};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::fs::{File, OpenOptions};
use std::path::{Path, PathBuf};
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::Arc;

/// Shared memory region for tensor data
pub struct SharedTensorBuffer {
    /// Memory-mapped region
    mmap: MmapMut,
    /// Header with metadata
    header: SharedBufferHeader,
    /// Path to the backing file
    path: PathBuf,
}

/// Header stored at the beginning of shared memory
#[repr(C)]
#[derive(Debug, Clone, Copy)]
pub struct SharedBufferHeader {
    /// Magic number for validation
    pub magic: u64,
    /// Version number
    pub version: u32,
    /// Flags
    pub flags: u32,
    /// Total size of the buffer
    pub total_size: u64,
    /// Data offset (after header and metadata)
    pub data_offset: u64,
    /// Number of tensors
    pub num_tensors: u32,
    /// Checksum of data
    pub checksum: u64,
    /// Reference count (for multi-process access)
    pub ref_count: u64,
}

impl SharedBufferHeader {
    const MAGIC: u64 = 0x4950_4652_5354_454E; // "IPFRSTN"

    /// Create a new header
    pub fn new(total_size: u64, data_offset: u64, num_tensors: u32) -> Self {
        Self {
            magic: Self::MAGIC,
            version: 1,
            flags: 0,
            total_size,
            data_offset,
            num_tensors,
            checksum: 0,
            ref_count: 1,
        }
    }

    /// Validate the header
    pub fn validate(&self) -> bool {
        self.magic == Self::MAGIC && self.version == 1
    }
}

/// Metadata for tensors in shared memory
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SharedTensorInfo {
    /// Tensor name
    pub name: String,
    /// Data type
    pub dtype: TensorDtype,
    /// Shape
    pub shape: Vec<usize>,
    /// Offset from data start
    pub offset: usize,
    /// Size in bytes
    pub size: usize,
}

impl SharedTensorBuffer {
    /// Create a new shared tensor buffer
    pub fn create<P: AsRef<Path>>(
        path: P,
        size: usize,
        tensors: &[SharedTensorInfo],
    ) -> Result<Self, SharedMemoryError> {
        let path = path.as_ref().to_path_buf();

        // Serialize tensor metadata
        let metadata_json = serde_json::to_vec(tensors)?;
        let metadata_size = metadata_json.len();

        // Calculate total size needed
        let header_size = std::mem::size_of::<SharedBufferHeader>();
        let metadata_offset = header_size;
        let data_offset = metadata_offset + metadata_size + 8; // 8 bytes for metadata length
        let total_size = data_offset + size;

        // Create and size the file
        let file = OpenOptions::new()
            .read(true)
            .write(true)
            .create(true)
            .truncate(true)
            .open(&path)?;

        file.set_len(total_size as u64)?;

        // Memory map the file
        let mut mmap = unsafe { MmapMut::map_mut(&file)? };

        // Write header
        let header =
            SharedBufferHeader::new(total_size as u64, data_offset as u64, tensors.len() as u32);
        let header_bytes: &[u8] = unsafe {
            std::slice::from_raw_parts(
                &header as *const SharedBufferHeader as *const u8,
                std::mem::size_of::<SharedBufferHeader>(),
            )
        };
        mmap[..header_size].copy_from_slice(header_bytes);

        // Write metadata length and metadata
        let metadata_len_bytes = (metadata_size as u64).to_le_bytes();
        mmap[metadata_offset..metadata_offset + 8].copy_from_slice(&metadata_len_bytes);
        mmap[metadata_offset + 8..metadata_offset + 8 + metadata_size]
            .copy_from_slice(&metadata_json);

        mmap.flush()?;

        Ok(Self { mmap, header, path })
    }

    /// Open an existing shared tensor buffer
    pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, SharedMemoryError> {
        let path = path.as_ref().to_path_buf();

        let file = OpenOptions::new().read(true).write(true).open(&path)?;

        let mmap = unsafe { MmapMut::map_mut(&file)? };

        // Read and validate header
        let header_size = std::mem::size_of::<SharedBufferHeader>();
        if mmap.len() < header_size {
            return Err(SharedMemoryError::InvalidFormat("File too small".into()));
        }

        let header: SharedBufferHeader =
            unsafe { std::ptr::read(mmap.as_ptr() as *const SharedBufferHeader) };

        if !header.validate() {
            return Err(SharedMemoryError::InvalidFormat(
                "Invalid header magic or version".into(),
            ));
        }

        Ok(Self { mmap, header, path })
    }

    /// Open read-only
    pub fn open_readonly<P: AsRef<Path>>(
        path: P,
    ) -> Result<SharedTensorBufferReadOnly, SharedMemoryError> {
        let path = path.as_ref().to_path_buf();
        let file = File::open(&path)?;
        let mmap = unsafe { Mmap::map(&file)? };

        let header_size = std::mem::size_of::<SharedBufferHeader>();
        if mmap.len() < header_size {
            return Err(SharedMemoryError::InvalidFormat("File too small".into()));
        }

        let header: SharedBufferHeader =
            unsafe { std::ptr::read(mmap.as_ptr() as *const SharedBufferHeader) };

        if !header.validate() {
            return Err(SharedMemoryError::InvalidFormat(
                "Invalid header magic or version".into(),
            ));
        }

        Ok(SharedTensorBufferReadOnly { mmap, header, path })
    }

    /// Get tensor metadata
    pub fn tensor_metadata(&self) -> Result<Vec<SharedTensorInfo>, SharedMemoryError> {
        let header_size = std::mem::size_of::<SharedBufferHeader>();

        // Read metadata length
        let mut len_bytes = [0u8; 8];
        len_bytes.copy_from_slice(&self.mmap[header_size..header_size + 8]);
        let metadata_len = u64::from_le_bytes(len_bytes) as usize;

        // Read metadata
        let metadata_bytes = &self.mmap[header_size + 8..header_size + 8 + metadata_len];
        let tensors: Vec<SharedTensorInfo> = serde_json::from_slice(metadata_bytes)?;

        Ok(tensors)
    }

    /// Get mutable data slice for a tensor
    pub fn tensor_data_mut(&mut self, info: &SharedTensorInfo) -> &mut [u8] {
        let start = self.header.data_offset as usize + info.offset;
        let end = start + info.size;
        &mut self.mmap[start..end]
    }

    /// Get data slice for a tensor
    pub fn tensor_data(&self, info: &SharedTensorInfo) -> &[u8] {
        let start = self.header.data_offset as usize + info.offset;
        let end = start + info.size;
        &self.mmap[start..end]
    }

    /// Write tensor data
    pub fn write_tensor<T: Copy>(&mut self, info: &SharedTensorInfo, data: &[T]) {
        let bytes = unsafe {
            std::slice::from_raw_parts(data.as_ptr() as *const u8, std::mem::size_of_val(data))
        };
        self.tensor_data_mut(info).copy_from_slice(bytes);
    }

    /// Read tensor data as typed Vec (safe copy)
    pub fn read_tensor<T: Copy + Default>(&self, info: &SharedTensorInfo) -> Vec<T> {
        let bytes = self.tensor_data(info);
        let elem_size = std::mem::size_of::<T>();
        let count = bytes.len() / elem_size;
        let mut result = vec![T::default(); count];

        // Safe copy using byte manipulation
        let result_bytes = unsafe {
            std::slice::from_raw_parts_mut(result.as_mut_ptr() as *mut u8, count * elem_size)
        };
        result_bytes.copy_from_slice(&bytes[..count * elem_size]);
        result
    }

    /// Update checksum
    pub fn update_checksum(&mut self) {
        let data_start = self.header.data_offset as usize;
        let data = &self.mmap[data_start..];

        // Simple checksum (could use CRC32 or Blake3)
        let checksum: u64 = data.iter().fold(0u64, |acc, &b| acc.wrapping_add(b as u64));

        // Update header
        let header_bytes = &mut self.mmap[..std::mem::size_of::<SharedBufferHeader>()];
        let offset = std::mem::offset_of!(SharedBufferHeader, checksum);
        header_bytes[offset..offset + 8].copy_from_slice(&checksum.to_le_bytes());
    }

    /// Flush changes to disk
    pub fn flush(&self) -> Result<(), SharedMemoryError> {
        self.mmap.flush()?;
        Ok(())
    }

    /// Get the path to the backing file
    pub fn path(&self) -> &Path {
        &self.path
    }

    /// Get total size
    pub fn size(&self) -> usize {
        self.header.total_size as usize
    }
}

/// Read-only shared tensor buffer
pub struct SharedTensorBufferReadOnly {
    /// Memory-mapped region
    mmap: Mmap,
    /// Header
    header: SharedBufferHeader,
    /// Path
    path: PathBuf,
}

impl SharedTensorBufferReadOnly {
    /// Get tensor metadata
    pub fn tensor_metadata(&self) -> Result<Vec<SharedTensorInfo>, SharedMemoryError> {
        let header_size = std::mem::size_of::<SharedBufferHeader>();

        let mut len_bytes = [0u8; 8];
        len_bytes.copy_from_slice(&self.mmap[header_size..header_size + 8]);
        let metadata_len = u64::from_le_bytes(len_bytes) as usize;

        let metadata_bytes = &self.mmap[header_size + 8..header_size + 8 + metadata_len];
        let tensors: Vec<SharedTensorInfo> = serde_json::from_slice(metadata_bytes)?;

        Ok(tensors)
    }

    /// Get data slice for a tensor
    pub fn tensor_data(&self, info: &SharedTensorInfo) -> &[u8] {
        let start = self.header.data_offset as usize + info.offset;
        let end = start + info.size;
        &self.mmap[start..end]
    }

    /// Read tensor data as typed Vec (safe copy)
    pub fn read_tensor<T: Copy + Default>(&self, info: &SharedTensorInfo) -> Vec<T> {
        let bytes = self.tensor_data(info);
        let elem_size = std::mem::size_of::<T>();
        let count = bytes.len() / elem_size;
        let mut result = vec![T::default(); count];

        // Safe copy using byte manipulation
        let result_bytes = unsafe {
            std::slice::from_raw_parts_mut(result.as_mut_ptr() as *mut u8, count * elem_size)
        };
        result_bytes.copy_from_slice(&bytes[..count * elem_size]);
        result
    }

    /// Verify checksum
    pub fn verify_checksum(&self) -> bool {
        let data_start = self.header.data_offset as usize;
        let data = &self.mmap[data_start..];

        let computed: u64 = data.iter().fold(0u64, |acc, &b| acc.wrapping_add(b as u64));
        computed == self.header.checksum
    }

    /// Get path
    pub fn path(&self) -> &Path {
        &self.path
    }
}

/// Shared memory pool for managing multiple buffers
#[allow(dead_code)]
pub struct SharedMemoryPool {
    /// Base directory for shared memory files
    base_dir: PathBuf,
    /// Active buffers
    buffers: HashMap<String, Arc<SharedTensorBufferReadOnly>>,
    /// Maximum total size
    max_size: usize,
    /// Current total size
    current_size: AtomicU64,
}

impl SharedMemoryPool {
    /// Create a new pool
    pub fn new<P: AsRef<Path>>(base_dir: P, max_size: usize) -> Self {
        std::fs::create_dir_all(base_dir.as_ref()).ok();

        Self {
            base_dir: base_dir.as_ref().to_path_buf(),
            buffers: HashMap::new(),
            max_size,
            current_size: AtomicU64::new(0),
        }
    }

    /// Register a buffer in the pool
    pub fn register(
        &mut self,
        name: &str,
        buffer: SharedTensorBufferReadOnly,
    ) -> Result<(), SharedMemoryError> {
        let size = buffer.mmap.len();

        // Check size limit
        let current = self.current_size.load(Ordering::Relaxed);
        if current + size as u64 > self.max_size as u64 {
            return Err(SharedMemoryError::PoolFull);
        }

        self.current_size.fetch_add(size as u64, Ordering::Relaxed);
        self.buffers.insert(name.to_string(), Arc::new(buffer));

        Ok(())
    }

    /// Get a buffer by name
    pub fn get(&self, name: &str) -> Option<Arc<SharedTensorBufferReadOnly>> {
        self.buffers.get(name).cloned()
    }

    /// Remove a buffer
    pub fn remove(&mut self, name: &str) -> Option<Arc<SharedTensorBufferReadOnly>> {
        if let Some(buffer) = self.buffers.remove(name) {
            let size = buffer.mmap.len() as u64;
            self.current_size.fetch_sub(size, Ordering::Relaxed);
            Some(buffer)
        } else {
            None
        }
    }

    /// List all buffer names
    pub fn list(&self) -> Vec<&str> {
        self.buffers.keys().map(|s| s.as_str()).collect()
    }

    /// Get current memory usage
    pub fn memory_usage(&self) -> usize {
        self.current_size.load(Ordering::Relaxed) as usize
    }

    /// Get available memory
    pub fn available(&self) -> usize {
        self.max_size.saturating_sub(self.memory_usage())
    }
}

/// Error types for shared memory operations
#[derive(Debug)]
pub enum SharedMemoryError {
    /// IO error
    Io(std::io::Error),
    /// Invalid format
    InvalidFormat(String),
    /// JSON serialization error
    Json(serde_json::Error),
    /// Pool is full
    PoolFull,
    /// Buffer not found
    NotFound(String),
}

impl From<std::io::Error> for SharedMemoryError {
    fn from(err: std::io::Error) -> Self {
        SharedMemoryError::Io(err)
    }
}

impl From<serde_json::Error> for SharedMemoryError {
    fn from(err: serde_json::Error) -> Self {
        SharedMemoryError::Json(err)
    }
}

impl std::fmt::Display for SharedMemoryError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            SharedMemoryError::Io(e) => write!(f, "IO error: {}", e),
            SharedMemoryError::InvalidFormat(s) => write!(f, "Invalid format: {}", s),
            SharedMemoryError::Json(e) => write!(f, "JSON error: {}", e),
            SharedMemoryError::PoolFull => write!(f, "Shared memory pool is full"),
            SharedMemoryError::NotFound(s) => write!(f, "Buffer not found: {}", s),
        }
    }
}

impl std::error::Error for SharedMemoryError {}

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

    #[test]
    fn test_shared_buffer_create_and_read() {
        let dir = tempdir().unwrap();
        let path = dir.path().join("test.shm");

        // Define tensors
        let tensors = vec![
            SharedTensorInfo {
                name: "weights".to_string(),
                dtype: TensorDtype::Float32,
                shape: vec![2, 3],
                offset: 0,
                size: 24, // 6 * 4 bytes
            },
            SharedTensorInfo {
                name: "bias".to_string(),
                dtype: TensorDtype::Float32,
                shape: vec![3],
                offset: 24,
                size: 12, // 3 * 4 bytes
            },
        ];

        // Create buffer
        let mut buffer = SharedTensorBuffer::create(&path, 36, &tensors).unwrap();

        // Write data
        let weights: Vec<f32> = vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0];
        let bias: Vec<f32> = vec![0.1, 0.2, 0.3];

        buffer.write_tensor(&tensors[0], &weights);
        buffer.write_tensor(&tensors[1], &bias);
        buffer.update_checksum();
        buffer.flush().unwrap();

        // Read back
        let read_buffer = SharedTensorBuffer::open_readonly(&path).unwrap();
        let metadata = read_buffer.tensor_metadata().unwrap();

        assert_eq!(metadata.len(), 2);
        assert_eq!(metadata[0].name, "weights");
        assert_eq!(metadata[1].name, "bias");

        let read_weights: Vec<f32> = read_buffer.read_tensor(&metadata[0]);
        let read_bias: Vec<f32> = read_buffer.read_tensor(&metadata[1]);

        assert_eq!(read_weights, weights);
        assert_eq!(read_bias, bias);
    }

    #[test]
    fn test_memory_pool() {
        let dir = tempdir().unwrap();
        let pool_dir = dir.path().join("pool");

        let mut pool = SharedMemoryPool::new(&pool_dir, 1024 * 1024);

        // Create a buffer
        let path = pool_dir.join("test1.shm");
        let tensors = vec![SharedTensorInfo {
            name: "test".to_string(),
            dtype: TensorDtype::Float32,
            shape: vec![4],
            offset: 0,
            size: 16,
        }];

        SharedTensorBuffer::create(&path, 16, &tensors).unwrap();

        // Register in pool
        let buffer = SharedTensorBuffer::open_readonly(&path).unwrap();
        pool.register("test1", buffer).unwrap();

        assert_eq!(pool.list().len(), 1);
        assert!(pool.get("test1").is_some());

        // Remove
        pool.remove("test1");
        assert!(pool.get("test1").is_none());
    }
}