ic_memory/
lib.rs

1#![forbid(unsafe_code)]
2#![deny(rustdoc::broken_intra_doc_links)]
3#![doc = include_str!("../README.md")]
4
5//! Stable-memory allocation-governance primitives for Internet Computer
6//! canister upgrades.
7//!
8//! `ic-memory` prevents stable-memory slot drift.
9//!
10//! Once a stable key is committed to a physical allocation slot, future binaries
11//! must either reopen that same stable key on that same slot or declare a new
12//! stable key.
13//!
14//! The crate records and validates durable ownership in both directions: an
15//! active stable key cannot move to a different physical slot, and an active
16//! physical slot cannot be reused by a different stable key.
17//!
18//! The intended integration flow is:
19//!
20//! 1. Recover the persisted allocation ledger.
21//! 2. Declare the stable stores expected by the current binary.
22//! 3. Validate those declarations against ledger history and any framework
23//!    policy.
24//! 4. Commit the next generation.
25//! 5. Only then open stable-memory handles through a validated allocation
26//!    session.
27//!
28//! This crate owns allocation invariants, not framework policy. Namespace
29//! rules, controller authorization, endpoint lifecycle, schema migrations, and
30//! application validation belong to the framework or application.
31//!
32//! For the default `MemoryManager` runtime, registered `ic-memory` range claims
33//! are generic allocation policy and are enforced before caller-supplied
34//! policy. A framework such as Canic that wants higher-level range semantics
35//! should adapt to this contract deliberately: either register the ranges it
36//! wants `ic-memory` to enforce, or omit user ranges and enforce application
37//! space through its own [`AllocationPolicy`].
38//!
39//! Use these primitives before opening stable-memory handles. Integrations
40//! should recover the historical ledger, declare the stores expected by the
41//! current binary, validate declarations against history and policy, commit a
42//! new generation, and only then publish a validated allocation session that can
43//! open slots through a storage substrate.
44//!
45//! [`AllocationBootstrap`] is the golden path for whichever layer owns a given
46//! ledger store. Canic may own bootstrap for a framework canister and compose
47//! IcyDB/application declarations through its registry; IcyDB may own bootstrap
48//! directly for generated database stores; or a standalone application canister
49//! may own bootstrap itself. Exactly one owner should bootstrap one ledger
50//! store. Multiple layers in the same canister must either compose declarations
51//! into that owner or use distinct ledger stores and allocation domains.
52//!
53//! `ic-stable-structures` `MemoryManager` IDs are the first-class supported
54//! physical slot substrate. That ID domain is `u8`: IDs `0..=254` are usable,
55//! and ID `255` is always the `ic-stable-structures` unallocated sentinel.
56//! The crate still keeps narrow internal abstractions for storage adapters and
57//! diagnostics, but the native IC path is
58//! `MemoryManager` ID 0 -> `ic-stable-structures::Cell<StableCellLedgerRecord,
59//! _>` -> [`LedgerCommitStore`] -> [`CommittedGenerationBytes`] ->
60//! [`LedgerPayloadEnvelope`] -> [`RecoveredLedger`] -> [`ValidatedAllocations`].
61//!
62//! `ic-memory` is not a replacement for `ic-stable-structures` collections and
63//! does not wrap typed stores such as `StableBTreeMap`.
64
65pub mod bootstrap;
66mod constants;
67pub mod declaration;
68pub mod diagnostics;
69pub mod key;
70pub mod ledger;
71pub mod physical;
72pub mod policy;
73pub mod registry;
74pub mod runtime;
75pub mod schema;
76pub mod session;
77pub mod slot;
78pub mod stable_cell;
79pub mod substrate;
80pub mod validation;
81
82pub use ic_stable_structures as stable_structures;
83
84pub use bootstrap::{
85    AllocationBootstrap, BootstrapCommit, BootstrapError, BootstrapReservationError,
86    BootstrapRetirementError,
87};
88pub use constants::WASM_PAGE_SIZE_BYTES;
89pub use declaration::{
90    AllocationDeclaration, DeclarationCollector, DeclarationSnapshot, DeclarationSnapshotError,
91};
92pub use diagnostics::{
93    DiagnosticExport, DiagnosticGeneration, DiagnosticMemorySize, DiagnosticRecord,
94};
95pub use key::{StableKey, StableKeyError};
96pub use ledger::{
97    AllocationHistory, AllocationLedger, AllocationRecord, AllocationReservationError,
98    AllocationRetirement, AllocationRetirementError, AllocationStageError, AllocationState,
99    GenerationRecord, LedgerCommitError, LedgerCommitStore, LedgerIntegrityError,
100    LedgerPayloadEnvelope, LedgerPayloadEnvelopeError, RecoveredLedger, SchemaMetadataRecord,
101};
102pub use physical::{
103    AuthoritativeSlot, CommitRecoveryError, CommitSlotDiagnostic, CommitSlotIndex,
104    CommitStoreDiagnostic, CommittedGenerationBytes, DualCommitStore, DualProtectedCommitStore,
105    ProtectedGenerationSlot, select_authoritative_slot,
106};
107pub use policy::AllocationPolicy;
108pub use registry::{
109    StaticMemoryDeclaration, StaticMemoryDeclarationError, StaticMemoryRangeDeclaration,
110    collect_static_memory_declarations, register_static_memory_declaration,
111    register_static_memory_manager_declaration,
112    register_static_memory_manager_declaration_with_schema, register_static_memory_manager_range,
113    register_static_memory_range_declaration, static_memory_declaration_snapshot,
114    static_memory_declarations, static_memory_range_authority, static_memory_range_declarations,
115};
116pub use runtime::{
117    RuntimeBootstrapError, RuntimeDiagnosticError, RuntimeOpenError, RuntimePolicyError,
118    bootstrap_default_memory_manager, bootstrap_default_memory_manager_with_policy,
119    default_memory_manager_commit_recovery_diagnostic, default_memory_manager_diagnostic_export,
120};
121pub use schema::{SchemaMetadata, SchemaMetadataError};
122pub use session::{AllocationSession, AllocationSessionError, ValidatedAllocations};
123pub use slot::{
124    AllocationSlot, AllocationSlotDescriptor, IC_MEMORY_AUTHORITY_OWNER,
125    IC_MEMORY_AUTHORITY_PURPOSE, IC_MEMORY_LEDGER_LABEL, IC_MEMORY_LEDGER_STABLE_KEY,
126    IC_MEMORY_STABLE_KEY_PREFIX, MEMORY_MANAGER_GOVERNANCE_MAX_ID, MEMORY_MANAGER_INVALID_ID,
127    MEMORY_MANAGER_LEDGER_ID, MEMORY_MANAGER_MAX_ID, MEMORY_MANAGER_MIN_ID,
128    MemoryManagerAuthorityRecord, MemoryManagerIdRange, MemoryManagerRangeAuthority,
129    MemoryManagerRangeAuthorityError, MemoryManagerRangeError, MemoryManagerRangeMode,
130    MemoryManagerSlotError, is_ic_memory_stable_key, memory_manager_governance_range,
131    validate_memory_manager_id,
132};
133pub use stable_cell::{
134    STABLE_CELL_HEADER_SIZE, STABLE_CELL_LAYOUT_VERSION, STABLE_CELL_MAGIC,
135    STABLE_CELL_VALUE_OFFSET, StableCellLedgerError, StableCellLedgerRecord,
136    StableCellPayloadError, decode_stable_cell_ledger_record, decode_stable_cell_payload,
137    validate_stable_cell_ledger_memory,
138};
139pub use substrate::{LedgerAnchor, StorageSubstrate};
140pub use validation::{AllocationValidationError, Validate, validate_allocations};
141
142#[doc(hidden)]
143pub mod __reexports {
144    pub use ctor;
145}
146
147/// Register a `MemoryManager` allocation declaration during static initialization.
148///
149/// This macro only registers declaration metadata. It does not open stable
150/// memory. The bootstrap owner still has to collect/seal declarations, validate
151/// them against the ledger, commit the generation, and then open memory handles.
152#[macro_export]
153macro_rules! ic_memory_declaration {
154    (key = $stable_key:literal, ty = $label:path, id = $id:expr $(,)?) => {
155        const _: () = {
156            #[allow(dead_code)]
157            type IcMemoryTypeCheck = $label;
158
159            #[ $crate::__reexports::ctor::ctor(unsafe, anonymous, crate_path = $crate::__reexports::ctor) ]
160            fn __ic_memory_register_static_declaration() {
161                $crate::register_static_memory_manager_declaration(
162                    $id,
163                    env!("CARGO_PKG_NAME"),
164                    stringify!($label),
165                    $stable_key,
166                )
167                .expect("ic-memory static memory declaration failed");
168            }
169        };
170    };
171    (key = $stable_key:literal, label = $label:literal, id = $id:expr $(,)?) => {
172        const _: () = {
173            #[ $crate::__reexports::ctor::ctor(unsafe, anonymous, crate_path = $crate::__reexports::ctor) ]
174            fn __ic_memory_register_static_declaration() {
175                $crate::register_static_memory_manager_declaration(
176                    $id,
177                    env!("CARGO_PKG_NAME"),
178                    $label,
179                    $stable_key,
180                )
181                .expect("ic-memory static memory declaration failed");
182            }
183        };
184    };
185}
186
187/// Declare a `MemoryManager` allocation range during static initialization.
188#[macro_export]
189macro_rules! ic_memory_range {
190    (start = $start:expr, end = $end:expr $(,)?) => {
191        $crate::ic_memory_range!(
192            start = $start,
193            end = $end,
194            mode = Reserved,
195        );
196    };
197    (start = $start:expr, end = $end:expr, mode = $mode:ident $(,)?) => {
198        const _: () = {
199            #[ $crate::__reexports::ctor::ctor(unsafe, anonymous, crate_path = $crate::__reexports::ctor) ]
200            fn __ic_memory_register_static_range() {
201                $crate::register_static_memory_manager_range(
202                    $start,
203                    $end,
204                    env!("CARGO_PKG_NAME"),
205                    $crate::MemoryManagerRangeMode::$mode,
206                    None,
207                )
208                .expect("ic-memory static memory range declaration failed");
209            }
210        };
211    };
212}
213
214/// Declare and open a validated `MemoryManager` slot by stable key.
215///
216/// The macro registers declaration metadata during static initialization and
217/// returns the validated default-runtime memory handle at expression use time.
218#[macro_export]
219macro_rules! ic_memory_key {
220    ($stable_key:literal, $label:path, $id:expr $(,)?) => {{
221        $crate::ic_memory_declaration!(key = $stable_key, ty = $label, id = $id,);
222        $crate::runtime::open_default_memory_manager_memory($stable_key, $id)
223            .expect("ic-memory failed to open validated stable memory; bootstrap must run first and the stable key/id must match the validated declaration")
224    }};
225    (key = $stable_key:literal, ty = $label:path, id = $id:expr $(,)?) => {{ $crate::ic_memory_key!($stable_key, $label, $id) }};
226    (key = $stable_key:literal, label = $label:literal, id = $id:expr $(,)?) => {{
227        $crate::ic_memory_declaration!(key = $stable_key, label = $label, id = $id,);
228        $crate::runtime::open_default_memory_manager_memory($stable_key, $id)
229            .expect("ic-memory failed to open validated stable memory; bootstrap must run first and the stable key/id must match the validated declaration")
230    }};
231}
232
233/// Register one pre-bootstrap hook.
234#[macro_export]
235macro_rules! eager_init {
236    ($body:block) => {
237        const _: () = {
238            fn __ic_memory_registered_eager_init_body() {
239                $body
240            }
241
242            #[ $crate::__reexports::ctor::ctor(unsafe, anonymous, crate_path = $crate::__reexports::ctor) ]
243            fn __ic_memory_register_eager_init() {
244                $crate::runtime::defer_eager_init(__ic_memory_registered_eager_init_body);
245            }
246        };
247    };
248}
ic_memory/lib.rs

ic_memory/
lib.rs
