1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
pub(crate) mod file_archiver;
pub(crate) mod parent;
pub(crate) mod tree;
pub(crate) mod tree_archiver;
use std::path::{Path, PathBuf};
use std::thread::scope;
use jiff::Zoned;
use log::warn;
use pariter::IteratorExt;
use crate::{
Progress,
archiver::{
file_archiver::FileArchiver, parent::Parent, tree::TreeIterator,
tree_archiver::TreeArchiver,
},
backend::{ReadSource, ReadSourceEntry, decrypt::DecryptFullBackend},
blob::BlobType,
error::RusticResult,
index::{
ReadGlobalIndex,
indexer::{Indexer, SharedIndexer},
},
repofile::{configfile::ConfigFile, snapshotfile::SnapshotFile},
};
#[derive(thiserror::Error, Debug, displaydoc::Display)]
/// Tree stack empty
pub struct TreeStackEmptyError;
/// The `Archiver` is responsible for archiving files and trees.
/// It will read the file, chunk it, and write the chunks to the backend.
///
/// # Type Parameters
///
/// * `BE` - The backend type.
/// * `I` - The index to read from.
#[allow(missing_debug_implementations)]
#[allow(clippy::struct_field_names)]
pub struct Archiver<'a, BE: DecryptFullBackend, I: ReadGlobalIndex> {
/// The `FileArchiver` is responsible for archiving files.
file_archiver: FileArchiver<'a, BE, I>,
/// The `TreeArchiver` is responsible for archiving trees.
tree_archiver: TreeArchiver<'a, BE, I>,
/// The parent snapshot to use.
parent: Parent,
/// The `SharedIndexer` is used to index the data.
indexer: SharedIndexer<BE>,
/// The backend to write to.
be: BE,
/// The backend to write to.
index: &'a I,
/// The `SnapshotFile` to write to.
snap: SnapshotFile,
}
impl<'a, BE: DecryptFullBackend, I: ReadGlobalIndex> Archiver<'a, BE, I> {
/// Creates a new `Archiver`.
///
/// # Arguments
///
/// * `be` - The backend to write to.
/// * `index` - The index to read from.
/// * `config` - The config file.
/// * `parent` - The parent snapshot to use.
/// * `snap` - The `SnapshotFile` to write to.
///
/// # Errors
///
/// * If sending the message to the raw packer fails.
/// * If converting the data length to u64 fails
pub fn new(
be: BE,
index: &'a I,
config: &ConfigFile,
parent: Parent,
mut snap: SnapshotFile,
) -> RusticResult<Self> {
let indexer = Indexer::new(be.clone()).into_shared();
let mut summary = snap.summary.take().unwrap_or_default();
summary.backup_start = Zoned::now();
let file_archiver = FileArchiver::new(be.clone(), index, indexer.clone(), config)?;
let tree_archiver = TreeArchiver::new(be.clone(), index, indexer.clone(), config, summary)?;
Ok(Self {
file_archiver,
tree_archiver,
parent,
indexer,
be,
index,
snap,
})
}
/// Archives the given source.
///
/// This will archive all files and trees in the given source.
///
/// # Type Parameters
///
/// * `R` - The type of the source.
///
/// # Arguments
///
/// * `index` - The index to read from.
/// * `src` - The source to archive.
/// * `backup_path` - The path to the backup.
/// * `as_path` - The path to archive the backup as.
/// * `skip_identical_parent` - skip saving of snapshot if tree is identical to parent tree.
/// * `p` - The progress bar.
///
/// # Errors
///
/// * If sending the message to the raw packer fails.
/// * If the index file could not be serialized.
/// * If the time is not in the range of `Local::now()`.
pub fn archive<R>(
mut self,
src: &R,
backup_path: &Path,
as_path: Option<&PathBuf>,
skip_identical_parent: bool,
no_scan: bool,
p: &Progress,
) -> RusticResult<SnapshotFile>
where
R: ReadSource + 'static,
<R as ReadSource>::Open: Send,
<R as ReadSource>::Iter: Send,
{
scope(|s| -> RusticResult<_> {
// determine backup size in parallel to running backup
let src_size_handle = s.spawn(|| {
if !no_scan && !p.is_hidden() {
match src.size() {
Ok(Some(size)) => p.set_length(size),
Ok(None) => {}
Err(err) => warn!("error determining backup size: {}", err.display_log()),
}
}
});
// filter out errors and handle as_path
let iter = src.entries().filter_map(|item| match item {
Err(err) => {
warn!("ignoring error: {}", err.display_log());
None
}
Ok(ReadSourceEntry { path, node, open }) => {
let snapshot_path = if let Some(as_path) = as_path {
as_path
.clone()
.join(path.strip_prefix(backup_path).unwrap())
} else {
path
};
Some(if node.is_dir() {
(snapshot_path, node, open)
} else {
(
snapshot_path
.parent()
.expect("file path should have a parent!")
.to_path_buf(),
node,
open,
)
})
}
});
// handle beginning and ending of trees
let iter = TreeIterator::new(iter);
// use parent snapshot
iter.filter_map(
|item| match self.parent.process(&self.be, self.index, item) {
Ok(item) => Some(item),
Err(err) => {
warn!("ignoring error reading parent snapshot: {err:?}");
None
}
},
)
// archive files in parallel
.parallel_map_scoped(s, |item| self.file_archiver.process(item, p))
.readahead_scoped(s)
.filter_map(|item| match item {
Ok(item) => Some(item),
Err(err) => {
warn!("ignoring error: {}", err.display_log());
None
}
})
.try_for_each(|item| self.tree_archiver.add(item))?;
src_size_handle
.join()
.expect("Scoped Size Handler thread should not panic!");
Ok(())
})?;
let stats = self.file_archiver.finalize()?;
let (id, mut summary) = self.tree_archiver.finalize(self.parent.tree_id())?;
stats.apply(&mut summary, BlobType::Data);
self.snap.tree = id;
self.indexer.write().unwrap().finalize()?;
summary.finalize(&self.snap.time);
self.snap.summary = Some(summary);
if !skip_identical_parent || Some(self.snap.tree) != self.parent.tree_id() {
let id = self.be.save_file(&self.snap)?;
self.snap.id = id.into();
}
p.finish();
Ok(self.snap)
}
}