ic_backup/policy/execution_progress/
mod.rs

1//! Pure original-plan progress from exact retained journals; no scheduling or dispatch.
2
3use crate::model::{
4    artifacts::ArtifactChecksumRecord,
5    attempt_journal::{AttemptJournalRecord, AttemptJournalView},
6    effect_graph::MAX_EFFECT_OPERATIONS,
7    operation_plan::OperationPlanRecord,
8};
9use serde::Serialize;
10use std::collections::BTreeMap;
11use thiserror::Error;
12
13/// Passive complete journal set supplied by the local evidence-owning caller.
14#[derive(Clone, Debug)]
15pub struct ExecutionProgressRequest<'a> {
16    /// Original immutable declaration; its hash binds every journal's intent.
17    pub plan: &'a OperationPlanRecord,
18    /// Exactly one validated retained journal per declared operation, in any order.
19    pub journals: &'a [&'a AttemptJournalRecord],
20}
21
22/// Derived local attempt condition, without fresh permission or backend qualification.
23#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
24#[serde(rename_all = "snake_case")]
25pub enum OperationProgressState {
26    /// At least one declared prerequisite lacks retained Applied evidence.
27    AwaitingDependencies,
28    /// Prerequisites are Applied and original mutation allowance remains.
29    MutationAvailable,
30    /// No unresolved mutation or Applied receipt, and mutation allowance is exhausted.
31    MutationExhausted,
32    /// A mutation is unresolved and original reconciliation allowance remains.
33    MutationUnresolved,
34    /// An observation reservation remains unresolved, even if its allowance is exhausted.
35    ObservationUnresolved,
36    /// A mutation remains unresolved with no pending observation or remaining observation allowance.
37    ReconciliationExhausted,
38    /// This operation has retained integration-qualified Applied evidence.
39    Applied,
40}
41
42/// Read-only local progress for one exact operation in graph planning order.
43#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
44pub struct OperationProgressView {
45    /// Original opaque operation identity, never an array index.
46    pub operation_sequence: u64,
47    /// Derived local condition; none of these values authorize dispatch.
48    pub state: OperationProgressState,
49    /// Exact retained accounting, authority digest and unresolved attempt identities.
50    pub attempts: AttemptJournalView,
51}
52
53/// Sums over original assigned allowances only; unused plan headroom is excluded.
54#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
55pub struct ExecutionAttemptTotalsView {
56    /// Mutation reservations consumed across all original journals, without refunds.
57    pub mutations_used: u32,
58    /// Observation reservations consumed across all original journals, without refunds.
59    pub observations_used: u32,
60    /// Sum of remaining originally assigned mutation allowances.
61    pub mutations_remaining: u32,
62    /// Sum of remaining originally assigned observation allowances.
63    pub observations_remaining: u32,
64}
65
66/// Read-only projection bound to the complete original declaration and retained journals.
67///
68/// Applied evidence is caller-qualified and does not prove full run completion,
69/// current IC state, artifact durability, application safety or reference release.
70#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
71pub struct ExecutionProgressView {
72    /// Full canonical original plan intent.
73    pub intent: ArtifactChecksumRecord,
74    /// Original explicit dependency graph digest.
75    pub graph: ArtifactChecksumRecord,
76    /// Number of operations with retained Applied receipts, not a terminal proof.
77    pub applied_operations: usize,
78    /// Derived totals over the original per-operation ceilings.
79    pub attempts: ExecutionAttemptTotalsView,
80    /// Exact journal conditions in deterministic graph planning order.
81    pub operations: Vec<OperationProgressView>,
82}
83
84/// Admit exact complete journal coverage and project causal retained local progress.
85///
86/// Missing journals are errors, never fresh zero-consumption declarations. Any
87/// attempted operation requires Applied evidence for every declared prerequisite.
88/// This validates retained causality, not cross-journal dispatch chronology: no
89/// remote observations, authority probes, writes or scheduling occur.
90///
91/// # Errors
92/// Rejects excessive, duplicate, unknown, missing or mismatched journals, premature
93/// attempts and accounting overflow. Unresolved/exhausted states remain visible.
94pub fn progress(
95    request: &ExecutionProgressRequest<'_>,
96) -> Result<ExecutionProgressView, ExecutionProgressError> {
97    Ok(progress_with_journals(request)?.0)
98}
99
100// Retain the admitted original index for exact-history settlement, so that it
101// consumes the same coverage/authority proof as the public progress projection.
102pub(super) fn progress_with_journals<'a>(
103    request: &ExecutionProgressRequest<'a>,
104) -> Result<
105    (
106        ExecutionProgressView,
107        BTreeMap<u64, &'a AttemptJournalRecord>,
108    ),
109    ExecutionProgressError,
110> {
111    if request.journals.len() > MAX_EFFECT_OPERATIONS {
112        return Err(ExecutionProgressError::TooManyJournals);
113    }
114    let plan = request.plan;
115    let intent = plan.digest();
116    let mut journals = BTreeMap::new();
117    for journal in request.journals {
118        let sequence = journal.authority().binding().operation_sequence();
119        let operation = plan
120            .operation(sequence)
121            .map_err(|_| ExecutionProgressError::UnknownOperation(sequence))?;
122        if journals.contains_key(&sequence) {
123            return Err(ExecutionProgressError::DuplicateJournal(sequence));
124        }
125        if !plan.matches_authority(operation, &intent, journal.authority()) {
126            return Err(ExecutionProgressError::AuthorityMismatch(sequence));
127        }
128        journals.insert(sequence, *journal);
129    }
130    for operation in plan.operations() {
131        if !journals.contains_key(&operation.operation_sequence()) {
132            return Err(ExecutionProgressError::MissingJournal(
133                operation.operation_sequence(),
134            ));
135        }
136    }
137    let is_applied = |sequence: &u64| {
138        journals
139            .get(sequence)
140            .is_some_and(|journal| journal.applied_receipt().is_some())
141    };
142    let mut totals = ExecutionAttemptTotalsView {
143        mutations_used: 0,
144        observations_used: 0,
145        mutations_remaining: 0,
146        observations_remaining: 0,
147    };
148    let mut operations = Vec::with_capacity(journals.len());
149    for node in plan.graph().ordered_nodes() {
150        let sequence = node.operation_sequence();
151        // Closed graph/table identity and complete coverage were admitted above.
152        let attempts = journals
153            .get(&sequence)
154            .ok_or(ExecutionProgressError::MissingJournal(sequence))?
155            .view();
156        let unmet = node
157            .depends_on()
158            .iter()
159            .find(|dependency| !is_applied(dependency));
160        if attempts.mutations_used != 0
161            && let Some(prerequisite) = unmet
162        {
163            return Err(ExecutionProgressError::PrematureAttempt {
164                operation_sequence: sequence,
165                prerequisite: *prerequisite,
166            });
167        }
168        totals.add(&attempts)?;
169        operations.push(OperationProgressView {
170            operation_sequence: sequence,
171            state: condition(&attempts, unmet.is_some()),
172            attempts,
173        });
174    }
175    Ok((
176        ExecutionProgressView {
177            intent,
178            graph: plan.graph().digest(),
179            applied_operations: journals
180                .keys()
181                .filter(|sequence| is_applied(sequence))
182                .count(),
183            attempts: totals,
184            operations,
185        },
186        journals,
187    ))
188}
189impl ExecutionAttemptTotalsView {
190    fn add(&mut self, attempts: &AttemptJournalView) -> Result<(), ExecutionProgressError> {
191        self.mutations_used = sum(self.mutations_used, attempts.mutations_used)?;
192        self.observations_used = sum(self.observations_used, attempts.observations_used)?;
193        self.mutations_remaining = sum(self.mutations_remaining, attempts.mutations_remaining)?;
194        self.observations_remaining =
195            sum(self.observations_remaining, attempts.observations_remaining)?;
196        Ok(())
197    }
198}
199fn sum(left: u32, right: u32) -> Result<u32, ExecutionProgressError> {
200    left.checked_add(right)
201        .ok_or(ExecutionProgressError::AccountingOverflow)
202}
203fn condition(attempts: &AttemptJournalView, unmet_dependencies: bool) -> OperationProgressState {
204    if attempts.applied {
205        OperationProgressState::Applied
206    } else if attempts.pending_observation.is_some() {
207        OperationProgressState::ObservationUnresolved
208    } else if attempts.pending_mutation.is_some() {
209        if attempts.observations_remaining == 0 {
210            OperationProgressState::ReconciliationExhausted
211        } else {
212            OperationProgressState::MutationUnresolved
213        }
214    } else if unmet_dependencies {
215        OperationProgressState::AwaitingDependencies
216    } else if attempts.mutations_remaining == 0 {
217        OperationProgressState::MutationExhausted
218    } else {
219        OperationProgressState::MutationAvailable
220    }
221}
222
223/// Typed original-plan journal admission, retained causality or accounting failure.
224#[derive(Debug, Error, Eq, PartialEq)]
225pub enum ExecutionProgressError {
226    /// The journal input exceeds the original bounded operation count.
227    #[error("execution progress exceeds {MAX_EFFECT_OPERATIONS} journals")]
228    TooManyJournals,
229    /// Multiple supplied journals claim the same original operation identity.
230    #[error("duplicate journal for operation {0}")]
231    DuplicateJournal(u64),
232    /// A supplied journal's operation is absent from the original plan.
233    #[error("journal operation {0} is absent from the original plan")]
234    UnknownOperation(u64),
235    /// Retained evidence for an original operation was not supplied.
236    #[error("missing original journal for operation {0}")]
237    MissingJournal(u64),
238    /// Intent, context, target, request or original allowance differs from the plan.
239    #[error("original journal authority mismatch for operation {0}")]
240    AuthorityMismatch(u64),
241    /// A reservation exists while a declared prerequisite lacks Applied evidence.
242    #[error(
243        "operation {operation_sequence} was attempted without applied prerequisite {prerequisite}"
244    )]
245    PrematureAttempt {
246        /// Operation with retained consumed mutation allowance.
247        operation_sequence: u64,
248        /// Exact declared prerequisite lacking retained Applied evidence.
249        prerequisite: u64,
250    },
251    /// Derived accounting could not be represented without overflow.
252    #[error("execution attempt accounting overflow")]
253    AccountingOverflow,
254}
255
256#[cfg(test)]
257mod tests;
ic_backup/policy/execution_progress/mod.rs

ic_backup/policy/execution_progress/
mod.rs
