tetration 0.1.4

Tetration tensor file format: Rust library (tetration) and tet CLI
Documentation
use std::path::Path;

use crate::query::{
    dispatch,
    engine::{budget, spill_policy},
    fold,
    materialize::{self, stats::run_tier_c_operation},
    types,
};
use crate::utils::dtype::ElementDtype;

fn materialized_io(
    materialized: &materialize::MaterializedLogical,
) -> (u64, budget::MemoryStrategy) {
    match materialized {
        materialize::MaterializedLogical::F32 {
            total_bytes_read_from_disk,
            strategy,
            ..
        }
        | materialize::MaterializedLogical::F64 {
            total_bytes_read_from_disk,
            strategy,
            ..
        }
        | materialize::MaterializedLogical::I32 {
            total_bytes_read_from_disk,
            strategy,
            ..
        }
        | materialize::MaterializedLogical::I64 {
            total_bytes_read_from_disk,
            strategy,
            ..
        }
        | materialize::MaterializedLogical::U8 {
            total_bytes_read_from_disk,
            strategy,
            ..
        }
        | materialize::MaterializedLogical::U16 {
            total_bytes_read_from_disk,
            strategy,
            ..
        }
        | materialize::MaterializedLogical::I16 {
            total_bytes_read_from_disk,
            strategy,
            ..
        }
        | materialize::MaterializedLogical::U32 {
            total_bytes_read_from_disk,
            strategy,
            ..
        }
        | materialize::MaterializedLogical::U64 {
            total_bytes_read_from_disk,
            strategy,
            ..
        }
        | materialize::MaterializedLogical::F16 {
            total_bytes_read_from_disk,
            strategy,
            ..
        } => (*total_bytes_read_from_disk, *strategy),
    }
}

fn preview_from_bundle(
    total_bytes_read_from_disk: u64,
    previews: materialize::DecodePreviewBundle,
    operation: types::OperationPreviewFields,
    memory_strategy: Option<&'static str>,
    spill_f32_path: Option<String>,
    spill_f32_bytes: Option<u64>,
) -> types::QueryExecutionPreview {
    types::QueryExecutionPreview::assemble(types::QueryExecutionPreviewBuild {
        io: types::ExecutionPreviewIo {
            total_bytes_read_from_disk,
            memory_strategy,
            spill_f32_path,
            spill_f32_bytes,
        },
        previews,
        operation,
    })
}

fn attach_budget_fields(
    preview: &mut types::QueryExecutionPreview,
    budget: budget::ExecutionBudget,
    plan: &types::ReadPlan,
    dtype: ElementDtype,
    fold_policy: Option<fold::fold_policy::FoldIoPolicy>,
) {
    preview.memory_budget_bytes = Some(budget.memory_budget_bytes);
    preview.host_available_ram_bytes = budget.host_available_ram_bytes;
    preview.logical_selection_bytes = budget
        .logical_element_bytes(dtype, plan.logical_f32_element_count)
        .ok();
    if dtype == ElementDtype::F32 {
        preview.logical_selection_f32_bytes = preview.logical_selection_bytes;
    }
    if let Some(policy) = fold_policy {
        preview.fold_parallel = Some(policy.parallel);
        preview.fold_workers = policy.fold_workers;
        preview.io_regime = Some(policy.io_regime.as_str());
        preview.fold_linear_scan = Some(policy.linear_scan);
    }
}

fn fold_outcome_to_preview(
    folded: fold::FoldPlanOutcome,
    strategy: budget::MemoryStrategy,
    budget: budget::ExecutionBudget,
    plan: &types::ReadPlan,
    dtype: ElementDtype,
    fold_policy: fold::fold_policy::FoldIoPolicy,
) -> types::QueryExecutionPreview {
    let mut preview = preview_from_bundle(
        folded.total_bytes_read_from_disk,
        materialize::DecodePreviewBundle {
            f32: folded.f32_preview,
            f64: folded.f64_preview,
            i32: folded.i32_preview,
            i64: folded.i64_preview,
            f32_truncated: folded.f32_preview_truncated,
            f64_truncated: folded.f64_preview_truncated,
            i32_truncated: folded.i32_preview_truncated,
            i64_truncated: folded.i64_preview_truncated,
            u8: folded.u8_preview,
            u8_truncated: folded.u8_preview_truncated,
            u16: folded.u16_preview,
            u16_truncated: folded.u16_preview_truncated,
            i16: folded.i16_preview,
            i16_truncated: folded.i16_preview_truncated,
            u32: folded.u32_preview,
            u32_truncated: folded.u32_preview_truncated,
            u64: folded.u64_preview,
            u64_truncated: folded.u64_preview_truncated,
            f16: folded.f16_preview,
            f16_truncated: folded.f16_preview_truncated,
        },
        folded.operation,
        Some(strategy.as_str()),
        None,
        None,
    );
    attach_budget_fields(&mut preview, budget, plan, dtype, Some(fold_policy));
    preview
}

fn run_materialize_required_operation(
    mmap: &[u8],
    plan: &types::ReadPlan,
    op: &types::Operation,
    max_preview: usize,
    budget: &budget::ExecutionBudget,
    allowlist: &spill_policy::SpillPathAllowlist,
    dtype: ElementDtype,
) -> Result<types::QueryExecutionPreview, types::TetError> {
    let materialized =
        materialize::materialize_logical_selection(mmap, plan, budget, allowlist, dtype)?;
    let bundle = materialize::preview_from_materialized(
        &materialized,
        plan.logical_f32_element_count,
        max_preview,
    )?;
    let operation = run_tier_c_operation(&materialized, plan, op)?;
    let (total_bytes_read_from_disk, strategy) = materialized_io(&materialized);
    let mut preview = preview_from_bundle(
        total_bytes_read_from_disk,
        bundle,
        operation,
        Some(strategy.as_str()),
        None,
        None,
    );
    attach_budget_fields(&mut preview, *budget, plan, dtype, None);
    Ok(preview)
}

fn scalar_reduction_kind(op: &types::Operation) -> Option<fold::reduction::ReductionKind> {
    op.axes()
        .is_empty()
        .then(|| fold::reduction::ReductionKind::from(op))
}

fn spill_requested(output: Option<&types::OutputHints>) -> Option<&str> {
    match output.and_then(|o| o.preferred.as_ref()) {
        Some(types::OutputHint::SpillArray { handle }) => Some(handle.as_str()),
        _ => None,
    }
}

pub(super) struct ExecutionPreviewInput<'a> {
    pub mmap: &'a [u8],
    pub plan: &'a types::ReadPlan,
    pub dtype: u32,
    pub operation: Option<&'a types::Operation>,
    pub output: Option<&'a types::OutputHints>,
    pub max_f32: usize,
    pub budget: budget::ExecutionBudget,
    pub execution: Option<&'a types::ExecutionHints>,
    pub spill_allowlist: Option<&'a spill_policy::SpillPathAllowlist>,
    pub tet_path: Option<&'a Path>,
}

pub(super) fn build_execution_preview(
    input: &ExecutionPreviewInput<'_>,
) -> Result<types::QueryExecutionPreview, types::TetError> {
    let ExecutionPreviewInput {
        mmap,
        plan,
        dtype,
        operation,
        output,
        max_f32,
        budget,
        execution,
        spill_allowlist,
        tet_path,
    } = *input;
    let elem_dtype = ElementDtype::from_wire(dtype)?;

    match operation {
        None => build_decode_preview(
            mmap,
            plan,
            output,
            max_f32,
            budget,
            spill_allowlist,
            elem_dtype,
        ),
        Some(op) => build_operation_preview(&OperationPreviewInput {
            mmap,
            plan,
            op,
            max_preview: max_f32,
            budget,
            execution,
            spill_allowlist,
            dtype: elem_dtype,
            tet_path,
        }),
    }
}

struct OperationPreviewInput<'a> {
    mmap: &'a [u8],
    plan: &'a types::ReadPlan,
    op: &'a types::Operation,
    max_preview: usize,
    budget: budget::ExecutionBudget,
    execution: Option<&'a types::ExecutionHints>,
    spill_allowlist: Option<&'a spill_policy::SpillPathAllowlist>,
    dtype: ElementDtype,
    tet_path: Option<&'a Path>,
}

fn build_decode_preview(
    mmap: &[u8],
    plan: &types::ReadPlan,
    output: Option<&types::OutputHints>,
    max_preview: usize,
    budget: budget::ExecutionBudget,
    spill_allowlist: Option<&spill_policy::SpillPathAllowlist>,
    dtype: ElementDtype,
) -> Result<types::QueryExecutionPreview, types::TetError> {
    if let Some(spill_path) = spill_requested(output) {
        let path = Path::new(spill_path);
        let policy = spill_allowlist.ok_or_else(|| {
            types::TetError::Validation(
                "spill output requires a spill path allowlist (pass `--tet` so defaults apply)"
                    .into(),
            )
        })?;
        let resolved = policy.validate(path)?;
        let total_bytes_read_from_disk =
            dispatch::spill_full_selection(mmap, plan, &resolved, dtype)?;
        let bundle = dispatch::spill_export_preview(
            &resolved,
            plan.logical_f32_element_count,
            max_preview,
            dtype,
        )?;
        let spill_bytes = budget.logical_element_bytes(dtype, plan.logical_f32_element_count)?;
        let mut preview = preview_from_bundle(
            total_bytes_read_from_disk,
            bundle,
            types::OperationPreviewFields::default(),
            Some(budget::MemoryStrategy::MmapSpill.as_str()),
            Some(resolved.display().to_string()),
            Some(spill_bytes),
        );
        attach_budget_fields(&mut preview, budget, plan, dtype, None);
        return Ok(preview);
    }
    if budget.full_tensor_exceeds_budget(plan, dtype)? && max_preview == 0 {
        return Err(types::TetError::Validation(format!(
            "logical selection ({} elements, {} bytes) exceeds memory_budget_bytes ({}); \
             use a positive preview cap, a reduction key, `spill`, or raise execution.memory_budget_bytes / memory_budget_percent_bps",
            plan.logical_f32_element_count,
            budget.logical_element_bytes(dtype, plan.logical_f32_element_count)?,
            budget.memory_budget_bytes
        )));
    }
    let (bundle, total_bytes) =
        dispatch::materialize_for_execution(mmap, plan, Some(max_preview), dtype)?;
    let mut preview = preview_from_bundle(
        total_bytes,
        bundle,
        types::OperationPreviewFields::default(),
        Some(budget::MemoryStrategy::CappedInMemory.as_str()),
        None,
        None,
    );
    attach_budget_fields(&mut preview, budget, plan, dtype, None);
    Ok(preview)
}

fn build_operation_preview(
    input: &OperationPreviewInput<'_>,
) -> Result<types::QueryExecutionPreview, types::TetError> {
    let OperationPreviewInput {
        mmap,
        plan,
        op,
        max_preview,
        budget,
        execution,
        spill_allowlist,
        dtype,
        tet_path,
    } = *input;
    if op.requires_materialize() {
        let policy = spill_allowlist.ok_or_else(|| {
            types::TetError::Validation(
                "materialize-required operation needs a spill path allowlist (pass `--tet` so defaults apply)"
                    .into(),
            )
        })?;
        return run_materialize_required_operation(
            mmap,
            plan,
            op,
            max_preview,
            &budget,
            policy,
            dtype,
        );
    }
    let fold_policy = fold::fold_policy::FoldIoPolicy::resolve(plan, &budget, execution, dtype)?;
    if let Some(kind) = scalar_reduction_kind(op) {
        let folded =
            dispatch::scalar_fold(mmap, plan, max_preview, kind, dtype, &fold_policy, tet_path)?;
        return Ok(fold_outcome_to_preview(
            folded,
            budget::MemoryStrategy::StreamingFold,
            budget,
            plan,
            dtype,
            fold_policy,
        ));
    }
    let kind = fold::reduction::ReductionKind::from(op);
    let folded = dispatch::partial_fold(
        mmap,
        plan,
        max_preview,
        kind,
        op.axes(),
        dtype,
        &fold_policy,
    )?;
    Ok(fold_outcome_to_preview(
        folded,
        budget::MemoryStrategy::StreamingFold,
        budget,
        plan,
        dtype,
        fold_policy,
    ))
}