Checkpoint

Struct Checkpoint 

pub struct Checkpoint {
    pub header: CheckpointHeader,
    pub metadata: CheckpointMetadata,
    pub chunks: Vec<DataChunk>,
}
Expand description

Complete checkpoint containing all kernel state.

Fields§

§header: CheckpointHeader

Checkpoint header.

§metadata: CheckpointMetadata

Kernel metadata.

§chunks: Vec<DataChunk>

Data chunks.

Implementations§

§

impl Checkpoint

pub fn new(metadata: CheckpointMetadata) -> Checkpoint

Create a new checkpoint.

pub fn add_chunk(&mut self, chunk: DataChunk)

Add a data chunk.

pub fn add_control_block(&mut self, data: Vec<u8>)

Add control block data.

pub fn add_h2k_queue(&mut self, data: Vec<u8>)

Add H2K queue data.

pub fn add_k2h_queue(&mut self, data: Vec<u8>)

Add K2H queue data.

pub fn add_hlc_state(&mut self, data: Vec<u8>)

Add HLC state.

pub fn add_device_memory(&mut self, name: &str, data: Vec<u8>)

Add device memory region.

pub fn get_chunk(&self, chunk_type: ChunkType) -> Option<&DataChunk>

Get a chunk by type.

pub fn get_chunks(&self, chunk_type: ChunkType) -> Vec<&DataChunk>

Get all chunks of a type.

pub fn total_size(&self) -> usize

Calculate total size in bytes.

pub fn to_bytes(&self) -> Vec<u8>

Serialize checkpoint to bytes.

pub fn from_bytes(bytes: &[u8]) -> Result<Checkpoint, RingKernelError>

Deserialize checkpoint from bytes.

§

impl Checkpoint

pub fn content_digest(&self) -> String

Stable content digest of the checkpoint’s data chunks.

This is a CRC32 over each chunk’s (identity, data) in the order they were added. Two checkpoints with the same content digest have identical chunk contents at identical identities. Used as the stable “parent id” for delta checkpoints.

pub fn delta_from(base: &Checkpoint, new: &Checkpoint) -> Checkpoint

Produce a delta checkpoint: chunks present in new whose bytes differ from the corresponding chunk in base (same identity), plus chunks that are new in new. Unchanged chunks are omitted.

The delta’s metadata.custom records the base’s content digest under DELTA_PARENT_DIGEST_KEY so the reader can verify it before applying.

Restore via Checkpoint::applied_with_delta.

pub fn applied_with_delta( base: &Checkpoint, delta: &Checkpoint, ) -> Result<Checkpoint, RingKernelError>

Apply a delta produced by Checkpoint::delta_from on top of base, returning the resulting full checkpoint. Chunks in the delta replace chunks with the same identity in base; chunks only in base carry over unchanged.

Errors if the delta’s recorded parent digest does not match base.content_digest() — this catches accidental application on top of the wrong base.

Trait Implementations§

§

impl Clone for Checkpoint

§

fn clone(&self) -> Checkpoint

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl Debug for Checkpoint

§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Metadata = ()

The type for metadata in pointers and references to Self.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more