tetration 0.1.9

Chunked tensor .tet format, tet CLI, and optional C ABI (tetration-ffi)
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

//! Per-file execution settings stored in the chunk index header (layout v1).

use serde::Serialize;

use crate::utils::wire;

/// Default share of host RAM used when no fixed byte budget is set (25.00% = 2500 bps).
pub const DEFAULT_MEMORY_BUDGET_PERCENT_BPS: u16 = 2500;

/// On-disk execution preferences for a `.tet` file (TIDX header bytes 16–31).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize)]
#[serde(rename_all = "snake_case")]
pub struct FileExecutionSettingsV1 {
    /// Basis points of host available RAM (10000 = 100%). `0` = engine default ([`DEFAULT_MEMORY_BUDGET_PERCENT_BPS`]).
    pub memory_budget_percent_bps: u16,
    /// Fixed RAM cap for dense in-memory decode; `0` = derive from [`Self::memory_budget_percent_bps`].
    pub memory_budget_bytes: u32,
}

impl FileExecutionSettingsV1 {
    pub const WIRE_LEN: usize = 16;

    /// All-zero settings: use engine default percent of detected host RAM.
    #[must_use]
    pub const fn default_engine() -> Self {
        Self {
            memory_budget_percent_bps: 0,
            memory_budget_bytes: 0,
        }
    }

    /// Parse from the 16-byte **reserved** tail of the chunk index header (offset 16 from `TIDX`).
    #[must_use]
    pub fn from_index_header_tail(tail: &[u8]) -> Self {
        debug_assert!(tail.len() >= Self::WIRE_LEN);
        Self {
            memory_budget_percent_bps: wire::u16_le_at(tail, 0),
            memory_budget_bytes: wire::u32_le_at(tail, 4),
        }
    }

    /// Write into the 16-byte reserved tail (bytes 16–31 of the chunk index header).
    pub fn write_index_header_tail(&self, tail: &mut [u8]) {
        debug_assert!(tail.len() >= Self::WIRE_LEN);
        let mut o = 0usize;
        wire::put_u16_le(tail, &mut o, self.memory_budget_percent_bps);
        wire::put_u16_le(tail, &mut o, 0);
        wire::put_u32_le(tail, &mut o, self.memory_budget_bytes);
        wire::put_u64_le(tail, &mut o, 0);
        debug_assert_eq!(o, Self::WIRE_LEN);
    }

    /// Effective percent basis points: file override, else engine default.
    #[must_use]
    pub const fn effective_percent_bps(self) -> u16 {
        if self.memory_budget_percent_bps == 0 {
            DEFAULT_MEMORY_BUDGET_PERCENT_BPS
        } else {
            self.memory_budget_percent_bps
        }
    }
}