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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
use std::{
ops::Deref,
sync::atomic::{AtomicBool, Ordering},
time::Instant,
};
use gix_features::progress::{MessageLevel, Progress};
use crate::{
pack,
store::verify::integrity::{IndexStatistics, SingleOrMultiStatistics},
types::IndexAndPacks,
};
pub mod integrity {
use std::{marker::PhantomData, path::PathBuf};
use crate::pack;
pub type Options<F> = pack::index::verify::integrity::Options<F>;
#[derive(Debug, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
#[error(transparent)]
MultiIndexIntegrity(#[from] pack::index::traverse::Error<pack::multi_index::verify::integrity::Error>),
#[error(transparent)]
IndexIntegrity(#[from] pack::index::traverse::Error<pack::index::verify::integrity::Error>),
#[error(transparent)]
IndexOpen(#[from] pack::index::init::Error),
#[error(transparent)]
LooseObjectStoreIntegrity(#[from] crate::loose::verify::integrity::Error),
#[error(transparent)]
MultiIndexOpen(#[from] pack::multi_index::init::Error),
#[error(transparent)]
PackOpen(#[from] pack::data::init::Error),
#[error(transparent)]
InitializeODB(#[from] crate::store::load_index::Error),
#[error("The disk on state changed while performing the operation, and we observed the change.")]
NeedsRetryDueToChangeOnDisk,
}
#[derive(Debug, PartialEq, Eq, Hash, Ord, PartialOrd, Clone)]
#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
pub struct LooseObjectStatistics {
pub path: PathBuf,
pub statistics: crate::loose::verify::integrity::Statistics,
}
#[derive(Debug, PartialEq, Eq, Hash, Ord, PartialOrd, Clone)]
#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
#[allow(missing_docs)]
pub enum SingleOrMultiStatistics {
Single(pack::index::traverse::Statistics),
Multi(Vec<(PathBuf, pack::index::traverse::Statistics)>),
}
#[derive(Debug, PartialEq, Eq, Hash, Ord, PartialOrd, Clone)]
#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
pub struct IndexStatistics {
pub path: PathBuf,
pub statistics: SingleOrMultiStatistics,
}
pub struct Outcome<P> {
pub loose_object_stores: Vec<LooseObjectStatistics>,
pub index_statistics: Vec<IndexStatistics>,
pub progress: P,
}
#[derive(Debug, Copy, Clone)]
pub enum ProgressId {
VerifyLooseObjectDbPath,
VerifyIndex(PhantomData<gix_pack::index::verify::integrity::ProgressId>),
VerifyMultiIndex(PhantomData<gix_pack::multi_index::verify::integrity::ProgressId>),
}
impl From<ProgressId> for gix_features::progress::Id {
fn from(v: ProgressId) -> Self {
match v {
ProgressId::VerifyLooseObjectDbPath => *b"VISP",
ProgressId::VerifyMultiIndex(_) => *b"VIMI",
ProgressId::VerifyIndex(_) => *b"VISI",
}
}
}
}
impl super::Store {
pub fn verify_integrity<C, P, F>(
&self,
mut progress: P,
should_interrupt: &AtomicBool,
options: integrity::Options<F>,
) -> Result<integrity::Outcome<P>, integrity::Error>
where
P: Progress,
C: pack::cache::DecodeEntry,
F: Fn() -> C + Send + Clone,
{
let mut index = self.index.load();
if !index.is_initialized() {
self.consolidate_with_disk_state(true, false)?;
index = self.index.load();
assert!(
index.is_initialized(),
"BUG: after consolidating successfully, we have an initialized index"
)
}
progress.init(
Some(index.slot_indices.len()),
gix_features::progress::count("pack indices"),
);
let mut statistics = Vec::new();
let index_check_message = |path: &std::path::Path| {
format!(
"Checking integrity: {}",
path.file_name()
.map(|f| f.to_string_lossy())
.unwrap_or_else(std::borrow::Cow::default)
)
};
for slot_index in &index.slot_indices {
let slot = &self.files[*slot_index];
if slot.generation.load(Ordering::SeqCst) != index.generation {
return Err(integrity::Error::NeedsRetryDueToChangeOnDisk);
}
let files = slot.files.load();
let files = Option::as_ref(&files).ok_or(integrity::Error::NeedsRetryDueToChangeOnDisk)?;
let start = Instant::now();
let (mut child_progress, num_objects, index_path) = match files {
IndexAndPacks::Index(bundle) => {
let index;
let index = match bundle.index.loaded() {
Some(index) => index.deref(),
None => {
index = pack::index::File::at(bundle.index.path(), self.object_hash)?;
&index
}
};
let pack;
let data = match bundle.data.loaded() {
Some(pack) => pack.deref(),
None => {
pack = pack::data::File::at(bundle.data.path(), self.object_hash)?;
&pack
}
};
let outcome = index.verify_integrity(
Some(pack::index::verify::PackContext {
data,
options: options.clone(),
}),
progress.add_child_with_id(
"verify index",
integrity::ProgressId::VerifyIndex(Default::default()).into(),
),
should_interrupt,
)?;
statistics.push(IndexStatistics {
path: bundle.index.path().to_owned(),
statistics: SingleOrMultiStatistics::Single(
outcome
.pack_traverse_statistics
.expect("pack provided so there are stats"),
),
});
(outcome.progress, index.num_objects(), index.path().to_owned())
}
IndexAndPacks::MultiIndex(bundle) => {
let index;
let index = match bundle.multi_index.loaded() {
Some(index) => index.deref(),
None => {
index = pack::multi_index::File::at(bundle.multi_index.path())?;
&index
}
};
let outcome = index.verify_integrity(
progress.add_child_with_id(
"verify multi-index",
integrity::ProgressId::VerifyMultiIndex(Default::default()).into(),
),
should_interrupt,
options.clone(),
)?;
let index_dir = bundle.multi_index.path().parent().expect("file in a directory");
statistics.push(IndexStatistics {
path: Default::default(),
statistics: SingleOrMultiStatistics::Multi(
outcome
.pack_traverse_statistics
.into_iter()
.zip(index.index_names())
.map(|(statistics, index_name)| (index_dir.join(index_name), statistics))
.collect(),
),
});
(outcome.progress, index.num_objects(), index.path().to_owned())
}
};
child_progress.set_name(index_check_message(&index_path));
child_progress.show_throughput_with(
start,
num_objects as usize,
gix_features::progress::count("objects").expect("set"),
MessageLevel::Success,
);
progress.inc();
}
progress.init(
Some(index.loose_dbs.len()),
gix_features::progress::count("loose object stores"),
);
let mut loose_object_stores = Vec::new();
for loose_db in &*index.loose_dbs {
let out = loose_db
.verify_integrity(
progress.add_child_with_id(
loose_db.path().display().to_string(),
integrity::ProgressId::VerifyLooseObjectDbPath.into(),
),
should_interrupt,
)
.map(|statistics| integrity::LooseObjectStatistics {
path: loose_db.path().to_owned(),
statistics,
})?;
loose_object_stores.push(out);
}
Ok(integrity::Outcome {
loose_object_stores,
index_statistics: statistics,
progress,
})
}
}