tiny.machine.Checkpoint

1/// A borrowed handle to published checkpoint metadata and a normalized memory2/// image. Both regions stay at one address with their bytes untouched while the3/// handle lives.4pub const Checkpoint = struct {5    storage: *const Storage,6    ram: []align(layout.page_bytes) const u8,7    root_digest: os.abi.Digest,89    /// Reports whether the storage is still published under this handle's root.10    /// A malformed status byte, or a stored root other than this handle's,11    /// returns false.12    pub fn active(self: *const @This()) bool {13        const owner = ownerStateConst(self.storage);14        const status = checkedStatus(owner) catch return false;15        return status == .published and owns(self, owner);16    }1718    /// Recomputes the memory, state, and root identities from the stored bytes.19    /// Closed, changed, or malformed storage returns the specific checkpoint20    /// error.21    pub fn verify(self: *const @This()) Error!void {22        const owner = ownerStateConst(self.storage);23        if (try checkedStatus(owner) != .published) {24            return error.CheckpointClosed;25        }26        try verifyOwner(owner, self.ram);27        if (!owns(self, owner)) return error.CheckpointClosed;28    }2930    /// Returns the verified checkpoint root.31    pub fn root(self: *const @This()) Error!types.Root {32        try self.verify();33        return ownerStateConst(self.storage).root;34    }3536    /// Returns the verified checkpoint root together with the digest of the37    /// settled receipt.38    pub fn identity(self: *const @This()) Error!types.Identity {39        try self.verify();40        const owner = ownerStateConst(self.storage);41        return .{42            .root = owner.root,43            .semantic = try instance_receipt.semanticReceiptDigest(owner.receipt),44        };45    }4647    /// Returns the verified state digest the checkpoint root commits. The48    /// caller uses this digest to compare two captures without the49    /// configuration they ran under.50    pub fn stateDigest(self: *const @This()) Error!types.StateDigest {51        try self.verify();52        return ownerStateConst(self.storage).root.state;53    }54};

1pub const Checkpoint = checkpoint.Checkpoint;