-
Notifications
You must be signed in to change notification settings - Fork 55
/
setup.rs
624 lines (577 loc) · 22 KB
/
setup.rs
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//! Functions to gather information necessary to set up a pool from a set
//! of unlocked devices.
use std::{
collections::{HashMap, HashSet},
fs::OpenOptions,
};
use chrono::{DateTime, Utc};
use itertools::Itertools;
use devicemapper::Sectors;
use crate::{
engine::{
strat_engine::{
backstore::blockdev::{
v1::{self, UnderlyingDevice},
v2, InternalBlockDev,
},
crypt::handle::v1::CryptHandle,
device::blkdev_size,
liminal::device_info::{LStratisDevInfo, LStratisInfo},
metadata::BDA,
serde_structs::{BackstoreSave, BaseBlockDevSave, PoolFeatures, PoolSave},
shared::{bds_to_bdas, tiers_to_bdas},
types::{BDARecordResult, BDAResult},
},
types::{BlockDevTier, DevUuid, DevicePath, Name},
},
stratis::{StratisError, StratisResult},
};
/// Get the most recent metadata from a set of devices.
/// Returns None if no metadata found for this pool on any device. This can
/// happen if the pool was constructed but failed in the interval before the
/// metadata could be written.
/// Returns an error if there is a last update time, but no metadata could
/// be obtained from any of the devices.
///
/// Precondition: infos and bdas have identical sets of keys
pub fn get_metadata(
infos: &HashMap<DevUuid, &LStratisInfo>,
) -> StratisResult<Option<(DateTime<Utc>, PoolSave)>> {
// Try to read from all available devnodes that could contain most
// recent metadata. In the event of errors, continue to try until all are
// exhausted.
let (_, time, info) = match infos
.iter()
.filter_map(|(dev_uuid, info)| {
info.bda
.last_update_time()
.map(|time| (dev_uuid, *time, info))
})
.max_by(|(_, time1, _), (_, time2, _)| time1.cmp(time2))
{
Some(tup) => tup,
None => return Ok(None),
};
OpenOptions::new()
.read(true)
.open(&info.dev_info.devnode)
.ok()
.and_then(|mut f| info.bda.load_state(&mut f).unwrap_or(None))
.and_then(|data| serde_json::from_slice(&data).ok())
.map(|psave| Some((time, psave)))
.ok_or_else(|| {
StratisError::Msg(
"timestamp indicates data was written, but no data successfully read".to_string(),
)
})
}
/// Get the name from the most recent metadata from a set of devices.
/// Returns None if no metadata found for this pool on any device. This can
/// happen if the pool was constructed but failed in the interval before the
/// metadata could be written.
/// Returns an error if devices provided don't match the devices recorded in the
/// metadata.
pub fn get_name(infos: &HashMap<DevUuid, &LStratisInfo>) -> StratisResult<Option<Name>> {
let found_uuids = infos.keys().copied().collect::<HashSet<_>>();
match get_metadata(infos)? {
Some((_, pool)) => {
let v = [];
let meta_uuids = pool
.backstore
.data_tier
.blockdev
.devs
.iter()
.map(|bd| bd.uuid)
.chain(
pool.backstore
.cache_tier
.as_ref()
.map(|ct| ct.blockdev.devs.iter())
.unwrap_or_else(|| v.iter())
.map(|bd| bd.uuid),
)
.collect::<HashSet<_>>();
if found_uuids != meta_uuids {
return Err(StratisError::Msg(format!(
"UUIDs in metadata ({}) did not match UUIDs found ({})",
Itertools::intersperse(
meta_uuids.into_iter().map(|u| u.to_string()),
", ".to_string(),
)
.collect::<String>(),
Itertools::intersperse(
found_uuids.into_iter().map(|u| u.to_string()),
", ".to_string(),
)
.collect::<String>(),
)));
}
Ok(Some(Name::new(pool.name)))
}
None => Ok(None),
}
}
/// Get the feature set from the most recent metadata from a set of devices.
/// Returns None if no metadata found for this pool on any device. This can
/// happen if the pool was constructed but failed in the interval before the
/// metadata could be written.
/// Returns an error if devices provided don't match the devices recorded in the
/// metadata.
pub fn get_feature_set(
infos: &HashMap<DevUuid, &LStratisInfo>,
) -> StratisResult<Option<Vec<PoolFeatures>>> {
let found_uuids = infos.keys().copied().collect::<HashSet<_>>();
match get_metadata(infos)? {
Some((_, pool)) => {
let v = [];
let meta_uuids = pool
.backstore
.data_tier
.blockdev
.devs
.iter()
.map(|bd| bd.uuid)
.chain(
pool.backstore
.cache_tier
.as_ref()
.map(|ct| ct.blockdev.devs.iter())
.unwrap_or_else(|| v.iter())
.map(|bd| bd.uuid),
)
.collect::<HashSet<_>>();
if found_uuids != meta_uuids {
return Err(StratisError::Msg(format!(
"UUIDs in metadata ({}) did not match UUIDs found ({})",
Itertools::intersperse(
meta_uuids.into_iter().map(|u| u.to_string()),
", ".to_string(),
)
.collect::<String>(),
Itertools::intersperse(
found_uuids.into_iter().map(|u| u.to_string()),
", ".to_string(),
)
.collect::<String>(),
)));
}
Ok(Some(pool.features))
}
None => Ok(None),
}
}
/// Get all the blockdevs corresponding to this pool that can be obtained from
/// the given devices. Sort the blockdevs in the order in which they were
/// recorded in the metadata.
/// Returns an error if the blockdevs obtained do not match the metadata.
/// Returns a tuple, of which the first are the data devs, and the second
/// are the devs that support the cache tier.
/// Precondition: Every device in infos has already been determined to
/// belong to one pool; all BDAs agree on their pool UUID, set of keys in
/// infos and bdas are identical.
pub fn get_blockdevs_legacy(
backstore_save: &BackstoreSave,
infos: &HashMap<DevUuid, LStratisDevInfo>,
mut bdas: HashMap<DevUuid, BDA>,
) -> BDARecordResult<(Vec<v1::StratBlockDev>, Vec<v1::StratBlockDev>)> {
let recorded_data_map: HashMap<DevUuid, (usize, &BaseBlockDevSave)> = backstore_save
.data_tier
.blockdev
.devs
.iter()
.enumerate()
.map(|(i, bds)| (bds.uuid, (i, bds)))
.collect();
let recorded_cache_map: HashMap<DevUuid, (usize, &BaseBlockDevSave)> =
match backstore_save.cache_tier {
Some(ref cache_tier) => cache_tier
.blockdev
.devs
.iter()
.enumerate()
.map(|(i, bds)| (bds.uuid, (i, bds)))
.collect(),
None => HashMap::new(),
};
let mut segment_table: HashMap<DevUuid, Vec<(Sectors, Sectors)>> = HashMap::new();
for seg in &backstore_save.data_tier.blockdev.allocs[0] {
segment_table
.entry(seg.parent)
.or_default()
.push((seg.start, seg.length))
}
if let Some(ref cache_tier) = backstore_save.cache_tier {
for seg in cache_tier.blockdev.allocs.iter().flat_map(|i| i.iter()) {
segment_table
.entry(seg.parent)
.or_default()
.push((seg.start, seg.length))
}
}
let (mut datadevs, mut cachedevs): (Vec<v1::StratBlockDev>, Vec<v1::StratBlockDev>) =
(vec![], vec![]);
let dev_uuids = infos.keys().collect::<HashSet<_>>();
for dev_uuid in dev_uuids {
match get_blockdev_legacy(
infos.get(dev_uuid).expect("bdas.keys() == infos.keys()"),
bdas.remove(dev_uuid).expect("bdas.keys() == infos.keys()"),
&recorded_data_map,
&recorded_cache_map,
&segment_table,
) {
Ok((tier, blockdev)) => match tier {
BlockDevTier::Data => &mut datadevs,
BlockDevTier::Cache => &mut cachedevs,
}
.push(blockdev),
Err((e, bda)) => return Err((e, tiers_to_bdas(datadevs, cachedevs, Some(bda)))),
}
}
let datadevs = match check_and_sort_devs(datadevs, &recorded_data_map) {
Ok(dd) => dd,
Err((err, mut bdas)) => {
bdas.extend(bds_to_bdas(cachedevs));
return Err((
StratisError::Msg(format!(
"Data devices did not appear consistent with metadata: {err}"
)),
bdas,
));
}
};
let cachedevs = match check_and_sort_devs(cachedevs, &recorded_cache_map) {
Ok(cd) => cd,
Err((err, mut bdas)) => {
bdas.extend(bds_to_bdas(datadevs));
return Err((
StratisError::Msg(format!(
"Cache devices did not appear consistent with metadata: {err}"
)),
bdas,
));
}
};
Ok((datadevs, cachedevs))
}
/// Get all the blockdevs corresponding to this pool that can be obtained from
/// the given devices. Sort the blockdevs in the order in which they were
/// recorded in the metadata.
/// Returns an error if the blockdevs obtained do not match the metadata.
/// Returns a tuple, of which the first are the data devs, and the second
/// are the devs that support the cache tier.
/// Precondition: Every device in infos has already been determined to
/// belong to one pool; all BDAs agree on their pool UUID, set of keys in
/// infos and bdas are identical.
pub fn get_blockdevs(
backstore_save: &BackstoreSave,
infos: &HashMap<DevUuid, LStratisDevInfo>,
mut bdas: HashMap<DevUuid, BDA>,
) -> BDARecordResult<(Vec<v2::StratBlockDev>, Vec<v2::StratBlockDev>)> {
let recorded_data_map: HashMap<DevUuid, (usize, &BaseBlockDevSave)> = backstore_save
.data_tier
.blockdev
.devs
.iter()
.enumerate()
.map(|(i, bds)| (bds.uuid, (i, bds)))
.collect();
let recorded_cache_map: HashMap<DevUuid, (usize, &BaseBlockDevSave)> =
match backstore_save.cache_tier {
Some(ref cache_tier) => cache_tier
.blockdev
.devs
.iter()
.enumerate()
.map(|(i, bds)| (bds.uuid, (i, bds)))
.collect(),
None => HashMap::new(),
};
let mut segment_table: HashMap<DevUuid, Vec<(Sectors, Sectors)>> = HashMap::new();
for seg in &backstore_save.data_tier.blockdev.allocs[0] {
segment_table
.entry(seg.parent)
.or_default()
.push((seg.start, seg.length))
}
if let Some(ref cache_tier) = backstore_save.cache_tier {
for seg in cache_tier.blockdev.allocs.iter().flat_map(|i| i.iter()) {
segment_table
.entry(seg.parent)
.or_default()
.push((seg.start, seg.length))
}
}
let (mut datadevs, mut cachedevs): (Vec<v2::StratBlockDev>, Vec<v2::StratBlockDev>) =
(vec![], vec![]);
let dev_uuids = infos.keys().collect::<HashSet<_>>();
for dev_uuid in dev_uuids {
match get_blockdev(
infos.get(dev_uuid).expect("bdas.keys() == infos.keys()"),
bdas.remove(dev_uuid).expect("bdas.keys() == infos.keys()"),
&recorded_data_map,
&recorded_cache_map,
&segment_table,
) {
Ok((tier, blockdev)) => match tier {
BlockDevTier::Data => &mut datadevs,
BlockDevTier::Cache => &mut cachedevs,
}
.push(blockdev),
Err((e, bda)) => return Err((e, tiers_to_bdas(datadevs, cachedevs, Some(bda)))),
}
}
let datadevs = match check_and_sort_devs(datadevs, &recorded_data_map) {
Ok(dd) => dd,
Err((err, mut bdas)) => {
bdas.extend(bds_to_bdas(cachedevs));
return Err((
StratisError::Msg(format!(
"Data devices did not appear consistent with metadata: {err}"
)),
bdas,
));
}
};
let cachedevs = match check_and_sort_devs(cachedevs, &recorded_cache_map) {
Ok(cd) => cd,
Err((err, mut bdas)) => {
bdas.extend(bds_to_bdas(datadevs));
return Err((
StratisError::Msg(format!(
"Cache devices did not appear consistent with metadata: {err}"
)),
bdas,
));
}
};
Ok((datadevs, cachedevs))
}
// Construct a single legacy StratBlockDev. Return the tier to which the
// blockdev has been found to belong. Returns an error if the block
// device has shrunk, no metadata can be found for the block device,
// or it is impossible to set up the device because the recorded
// allocation information is impossible.
fn get_blockdev_legacy(
info: &LStratisDevInfo,
bda: BDA,
data_map: &HashMap<DevUuid, (usize, &BaseBlockDevSave)>,
cache_map: &HashMap<DevUuid, (usize, &BaseBlockDevSave)>,
segment_table: &HashMap<DevUuid, Vec<(Sectors, Sectors)>>,
) -> BDAResult<(BlockDevTier, v1::StratBlockDev)> {
let actual_size = match OpenOptions::new()
.read(true)
.open(&info.dev_info.devnode)
.map_err(StratisError::from)
.and_then(|f| blkdev_size(&f))
{
Ok(actual_size) => actual_size,
Err(err) => return Err((err, bda)),
};
// Return an error if apparent size of Stratis block device appears to
// have decreased since metadata was recorded or if size of block
// device could not be obtained.
let actual_size_sectors = actual_size.sectors();
let recorded_size = bda.dev_size().sectors();
if actual_size_sectors < recorded_size {
let err_msg = format!(
"Stratis device with {}, {} had recorded size {}, but actual size is less at {}",
info.dev_info,
bda.identifiers(),
recorded_size,
actual_size_sectors
);
return Err((StratisError::Msg(err_msg), bda));
}
let dev_uuid = bda.dev_uuid();
// Locate the device in the metadata using its uuid. Return the device
// metadata and whether it was a cache or a datadev.
let (tier, &(_, bd_save)) = match data_map
.get(&dev_uuid)
.map(|bd_save| (BlockDevTier::Data, bd_save))
.or_else(|| {
cache_map
.get(&dev_uuid)
.map(|bd_save| (BlockDevTier::Cache, bd_save))
}) {
Some(s) => s,
None => {
let err_msg = format!(
"Stratis device with {}, {} had no record in pool metadata",
bda.identifiers(),
info.dev_info
);
return Err((StratisError::Msg(err_msg), bda));
}
};
// This should always succeed since the actual size is at
// least the recorded size, so all segments should be
// available to be allocated. If this fails, the most likely
// conclusion is metadata corruption.
let segments = segment_table.get(&dev_uuid);
let physical_path = match &info.luks {
Some(luks) => &luks.dev_info.devnode,
None => &info.dev_info.devnode,
};
let handle = match CryptHandle::setup(physical_path, None, None) {
Ok(h) => h,
Err(e) => return Err((e, bda)),
};
let underlying_device = match handle {
Some(handle) => UnderlyingDevice::Encrypted(handle),
None => UnderlyingDevice::Unencrypted(match DevicePath::new(physical_path) {
Ok(d) => d,
Err(e) => return Err((e, bda)),
}),
};
Ok((
tier,
v1::StratBlockDev::new(
info.dev_info.device_number,
bda,
segments.unwrap_or(&vec![]),
bd_save.user_info.clone(),
bd_save.hardware_info.clone(),
underlying_device,
)?,
))
}
// Construct a single StratBlockDev. Return the tier to which the
// blockdev has been found to belong. Returns an error if the block
// device has shrunk, no metadata can be found for the block device,
// or it is impossible to set up the device because the recorded
// allocation information is impossible.
fn get_blockdev(
info: &LStratisDevInfo,
bda: BDA,
data_map: &HashMap<DevUuid, (usize, &BaseBlockDevSave)>,
cache_map: &HashMap<DevUuid, (usize, &BaseBlockDevSave)>,
segment_table: &HashMap<DevUuid, Vec<(Sectors, Sectors)>>,
) -> BDAResult<(BlockDevTier, v2::StratBlockDev)> {
let actual_size = match OpenOptions::new()
.read(true)
.open(&info.dev_info.devnode)
.map_err(StratisError::from)
.and_then(|f| blkdev_size(&f))
{
Ok(actual_size) => actual_size,
Err(err) => return Err((err, bda)),
};
// Return an error if apparent size of Stratis block device appears to
// have decreased since metadata was recorded or if size of block
// device could not be obtained.
let actual_size_sectors = actual_size.sectors();
let recorded_size = bda.dev_size().sectors();
if actual_size_sectors < recorded_size {
let err_msg = format!(
"Stratis device with {}, {} had recorded size {}, but actual size is less at {}",
info.dev_info,
bda.identifiers(),
recorded_size,
actual_size_sectors
);
return Err((StratisError::Msg(err_msg), bda));
}
let dev_uuid = bda.dev_uuid();
// Locate the device in the metadata using its uuid. Return the device
// metadata and whether it was a cache or a datadev.
let (tier, &(_, bd_save)) = match data_map
.get(&dev_uuid)
.map(|bd_save| (BlockDevTier::Data, bd_save))
.or_else(|| {
cache_map
.get(&dev_uuid)
.map(|bd_save| (BlockDevTier::Cache, bd_save))
}) {
Some(s) => s,
None => {
let err_msg = format!(
"Stratis device with {}, {} had no record in pool metadata",
bda.identifiers(),
info.dev_info
);
return Err((StratisError::Msg(err_msg), bda));
}
};
let devnode = match DevicePath::new(&info.dev_info.devnode) {
Ok(d) => d,
Err(e) => return Err((e, bda)),
};
// This should always succeed since the actual size is at
// least the recorded size, so all segments should be
// available to be allocated. If this fails, the most likely
// conclusion is metadata corruption.
let segments = segment_table.get(&dev_uuid);
let meta = data_map.get(&dev_uuid);
let raid = meta.map(|base| &base.1.raid_meta_allocs);
let integrity = meta.map(|base| &base.1.integrity_meta_allocs);
assert_eq!(info.luks, None);
Ok((
tier,
v2::StratBlockDev::new(
info.dev_info.device_number,
bda,
segments.unwrap_or(&vec![]),
raid.unwrap_or(&vec![]),
integrity.unwrap_or(&vec![]),
bd_save.user_info.clone(),
bd_save.hardware_info.clone(),
devnode,
)?,
))
}
// Verify that devices located are consistent with the metadata recorded
// and generally consistent with expectations. If all seems correct,
// sort the devices according to their order in the metadata.
fn check_and_sort_devs<B>(
mut devs: Vec<B>,
dev_map: &HashMap<DevUuid, (usize, &BaseBlockDevSave)>,
) -> BDARecordResult<Vec<B>>
where
B: InternalBlockDev,
{
let mut uuids = HashSet::new();
let mut duplicate_uuids = Vec::new();
let mut metadata_version = HashSet::new();
for dev in &devs {
let dev_uuid = dev.uuid();
if !uuids.insert(dev_uuid) {
duplicate_uuids.push(dev_uuid);
}
metadata_version.insert(dev.metadata_version());
}
if !duplicate_uuids.is_empty() {
let err_msg = format!(
"The following list of Stratis UUIDs were each claimed by more than one Stratis device: {}",
duplicate_uuids.iter().map(|u| u.to_string()).collect::<Vec<_>>().join(", ")
);
return Err((StratisError::Msg(err_msg), bds_to_bdas(devs)));
}
if metadata_version.len() > 1 {
return Err((
StratisError::Msg(format!(
"Found mismatching metadata versions across block devices: {:?}",
metadata_version,
)),
bds_to_bdas(devs),
));
}
let recorded_uuids: HashSet<_> = dev_map.keys().cloned().collect();
if uuids != recorded_uuids {
let err_msg = format!(
"UUIDs of devices found ({}) did not correspond with UUIDs specified in the metadata for this group of devices ({})",
uuids.iter().map(|u| u.to_string()).collect::<Vec<_>>().join(", "),
recorded_uuids.iter().map(|u| u.to_string()).collect::<Vec<_>>().join(", "),
);
return Err((StratisError::Msg(err_msg), bds_to_bdas(devs)));
}
// Sort the devices according to their original location in the
// metadata. Use a faster unstable sort, because the order of
// devs before the sort is arbitrary and does not need to be
// preserved.
devs.sort_unstable_by_key(|dev| dev_map[&dev.uuid()].0);
Ok(devs)
}