canic-core 0.110.36

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
41
42
43
44
45
46
47
48
49
50
51
52

//! Module: memory
//!
//! Responsibility: adapt Canic stable-memory declarations to `ic-memory` bootstrap.
//! Also owns physical stable-memory extent observation for runtime metrics.
//! Does not own: stable data schemas, ops storage APIs, or lifecycle orchestration.
//! Boundary: lifecycle initializes this before stable structures are accessed.

pub mod admission;
pub(crate) mod ledger;
mod policy;
pub mod registry;
pub mod runtime;

pub use crate::{
    eager_init, eager_static, ic_memory_key, ic_memory_range, memory_bootstrap_admission,
};
pub use policy::CanicMemoryManagerPolicy;

/// Stable allocation-policy authority for Canic core memory declarations.
pub const CANIC_CORE_MEMORY_AUTHORITY: &str = "canic-core";
/// Stable allocation-policy authority for Canic control-plane memory declarations.
pub const CANIC_CONTROL_PLANE_MEMORY_AUTHORITY: &str = "canic-control-plane";

/// Bucket size compiled into this artifact, in 64 KiB Wasm pages.
///
/// # Panics
/// Panics if the build script supplies an invalid value; normal builds validate it first.
#[must_use]
pub fn configured_bucket_pages() -> u16 {
    env!("CANIC_MEMORY_BUCKET_PAGES")
        .parse()
        .expect("build-validated memory bucket size")
}

/// Observe the current physical stable-memory extent without allocating or reading data.
#[cfg(target_arch = "wasm32")]
pub(crate) fn stable_extent_bytes() -> u64 {
    ic_cdk::api::stable_size().saturating_mul(65_536)
}

pub(crate) fn bootstrap_default_memory_manager()
-> Result<(), ic_memory::RuntimeBootstrapError<registry::MemoryRegistryError>> {
    let config = ic_memory::MemoryManagerConfig::new(configured_bucket_pages())
        .map_err(ic_memory::RuntimeStateError::from)?;
    let mut policy = policy::CanicMemoryManagerPolicy::new();
    if let Some(participant) =
        admission::seal().map_err(ic_memory::RuntimeBootstrapError::AdmissionPolicy)?
    {
        policy = policy.with_admission(participant);
    }
    ic_memory::bootstrap_default_memory_manager_with_config(config, &policy).map(|_| ())
}