canic-core 0.111.0

Canic — a canister orchestration and management toolkit for the Internet Computer
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

//! Module: memory::ledger
//!
//! Responsibility: adapt the native `ic-memory` runtime diagnostic export.
//! Does not own: memory-manager instances, ledger cells, allocation policy, or DTO shaping.
//! Boundary: diagnostics read the already bootstrapped default runtime through `ic-memory`.

use crate::memory::{pool, registry::MemoryRegistryError};
use ic_memory::{DiagnosticExport, MemoryAllocationPool, RuntimeDiagnosticError};

pub const MEMORY_LEDGER_SCHEMA_VERSION: u32 = 1;
pub const MEMORY_PHYSICAL_FORMAT_ID: u32 = 1;

///
/// NativeMemoryLedgerSnapshot
///
/// Diagnostic snapshot of the native memory allocation ledger and authorities.
/// Owned by memory ledger and consumed by diagnostics/status surfaces.
///

pub struct NativeMemoryLedgerSnapshot {
    pub export: DiagnosticExport,
    pub allocation_pool: MemoryAllocationPool,
}

/// Read the committed allocation ledger from the canonical default runtime.
pub fn try_snapshot() -> Result<NativeMemoryLedgerSnapshot, MemoryLedgerError> {
    Ok(NativeMemoryLedgerSnapshot {
        export: ic_memory::default_memory_manager_diagnostic_export()?,
        allocation_pool: pool::selected()?,
    })
}

/// Failure to read the established runtime or its sealed host pool.
#[derive(Debug, thiserror::Error)]
pub enum MemoryLedgerError {
    #[error(transparent)]
    Diagnostic(#[from] RuntimeDiagnosticError),
    #[error(transparent)]
    Pool(#[from] MemoryRegistryError),
}