ic_backup/ops/persistence/
mod.rs

1//! Durable publication, journal/layout exclusion and retained local dependencies.
2
3mod artifact_commit;
4mod attempt_journal;
5mod command_lifetime_lock;
6mod consistency;
7mod download_journal;
8mod effect_graph;
9mod execution_progress;
10mod execution_settlement;
11mod execution_workflow;
12mod fence_obligation;
13mod file_lock;
14mod inventory;
15mod journal_lock;
16mod json;
17mod layout_lifetime;
18mod operation_plan;
19mod restore_safety;
20
21pub use artifact_commit::{ArtifactCommitOutcome, commit_artifact_directory};
22pub use attempt_journal::{AttemptJournalError, AttemptJournalGuard};
23pub use command_lifetime_lock::{
24    COMMAND_CUSTODY_DESCRIPTOR_ENV, CommandLifetimeLock, CommandLifetimeLockError,
25    CommandQuiescenceGuard,
26};
27pub use consistency::{
28    ConsistencyPersistenceError, create_consistency_requirement, read_consistency_requirement,
29};
30pub use download_journal::{
31    DownloadIntegrityError, DownloadJournalError, DownloadJournalGuard, DownloadManifestError,
32    LocalRestoreArtifactError, LocalRestoreArtifactPublicationError, LocalRestoreArtifactView,
33    LocalRestoreSourceError, read_download_manifest,
34};
35#[cfg(unix)]
36pub use download_journal::{
37    IcSnapshotArtifactError, IcSnapshotArtifactWriter, IcSnapshotLocalMetrics,
38    IcSnapshotUploadArtifactError, MeasurementHistogram, MeasurementSummary,
39};
40pub use effect_graph::{EffectGraphPersistenceError, create_effect_graph, read_effect_graph};
41pub use execution_progress::{ExecutionProgressPersistenceError, read_execution_progress};
42pub use execution_settlement::{
43    ExecutionSettlementCheckpointError, ExecutionSettlementPersistenceError,
44    checkpoint_execution_settlement, create_execution_settlement, read_execution_settlement,
45};
46pub use execution_workflow::{
47    ExecutionStageGuard, ExecutionStagePreparationError, ExecutionStageResumeError,
48    ExecutionWorkflowPersistenceError, create_execution_workflow, read_execution_workflow,
49};
50pub use fence_obligation::{
51    FenceObligationPersistenceError, FenceObligationRequirement, create_fence_obligation,
52    read_fence_obligation,
53};
54pub use inventory::{InventoryError, create_inventory, read_inventory};
55pub use journal_lock::{JournalLock, JournalLockError};
56pub use json::{create_json_durable, read_json, write_json_durable};
57pub use layout_lifetime::{BackupLayoutGuard, MAX_RESTORE_REFERENCE_BYTES};
58pub use operation_plan::{
59    OperationPlanPersistenceError, create_operation_plan, read_operation_plan,
60};
61pub use restore_safety::{
62    RestoreSafetyPersistenceError, create_restore_safety_requirement,
63    read_restore_safety_requirement,
64};
65
66use crate::{model::artifacts::ChecksumError, ops::artifacts::ArtifactError};
67use std::io;
68use thiserror::Error;
69
70/// Typed local persistence failure.
71#[derive(Debug, Error)]
72pub enum PersistenceError {
73    /// An existing layout path no longer denotes the held directory.
74    #[error("backup layout changed while held: {path:?}")]
75    LayoutChanged {
76        /// Resolved layout location.
77        path: std::path::PathBuf,
78    },
79    /// A retained dependency document or journal location has an unsafe entry type.
80    #[error("unsafe restore reference entry: {path:?}")]
81    InvalidRestoreReferences {
82        /// Rejected local path.
83        path: std::path::PathBuf,
84    },
85    /// Restore dependency validation or an immutable retention transition failed.
86    #[error(transparent)]
87    RestoreReference(#[from] crate::model::restore_references::RestoreReferenceError),
88    /// Parent preparation, record reads or other local filesystem IO failed.
89    /// Shared JSON publication failures retain their separate structured boundary.
90    #[error(transparent)]
91    Io(#[from] io::Error),
92    /// Shared file publication failed, retaining producer/cleanup causes and visibility.
93    /// An after-publication failure leaves output visible and requires reconciliation.
94    #[error(transparent)]
95    Publication(#[from] ic_host_fs::durable::NamedWriteError<io::Error>),
96    /// JSON encoding or decoding failed.
97    #[error(transparent)]
98    Json(#[from] serde_json::Error),
99    /// A machine record exceeds its caller-selected byte bound.
100    #[error("record exceeds byte limit {limit}")]
101    RecordTooLarge {
102        /// Maximum accepted bytes.
103        limit: u64,
104    },
105    /// Artifact traversal or streaming failed.
106    #[error(transparent)]
107    Artifact(#[from] ArtifactError),
108    /// Verified bytes do not match the expected checksum.
109    #[error(transparent)]
110    Checksum(#[from] ChecksumError),
111    /// Publication requires distinct siblings in one directory.
112    #[error("artifact commit paths must be distinct siblings: {temporary}, {canonical}")]
113    ArtifactCommitPathMismatch {
114        /// Retained staging path.
115        temporary: String,
116        /// Canonical destination.
117        canonical: String,
118    },
119    /// Both staging and canonical trees exist; neither is overwritten.
120    #[error("artifact commit has conflicting paths: {temporary}, {canonical}")]
121    ArtifactCommitPathConflict {
122        /// Retained staging path.
123        temporary: String,
124        /// Existing canonical destination.
125        canonical: String,
126    },
127    /// Neither expected tree exists.
128    #[error("artifact commit is missing both paths: {temporary}, {canonical}")]
129    ArtifactCommitPathMissing {
130        /// Missing staging path.
131        temporary: String,
132        /// Missing canonical destination.
133        canonical: String,
134    },
135    /// Atomic no-replace directory publication is unsupported.
136    #[error("durable artifact publication is unsupported on {platform}")]
137    ArtifactCommitUnsupportedPlatform {
138        /// Host platform name.
139        platform: &'static str,
140    },
141    /// Publication found an unsafe tree entry.
142    #[error("unsupported artifact entry at {path}: {kind}")]
143    UnsupportedArtifactEntry {
144        /// Entry path.
145        path: String,
146        /// Observed entry kind.
147        kind: String,
148    },
149}
ic_backup/ops/persistence/mod.rs

ic_backup/ops/persistence/
mod.rs
