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
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
use crate::chunker::AsyncChunker;
use crate::repository::backend::common::manifest::ManifestTransaction;
use crate::repository::{BackendClone, ChunkID, Repository};
pub use asuran_core::manifest::archive::{Archive, ChunkLocation, Extent};
pub use asuran_core::manifest::listing::{Listing, Node, NodeType};
use chrono::prelude::*;
use dashmap::DashMap;
use futures::future::join_all;
use serde::{Deserialize, Serialize};
use serde_cbor::Serializer;
use smol::lock::RwLock;
use thiserror::Error;
use std::collections::VecDeque;
use std::io::{Read, Write};
use std::sync::Arc;
#[derive(Error, Debug)]
#[non_exhaustive]
pub enum ArchiveError {
#[error("Chunker Error")]
Chunker(#[from] crate::chunker::ChunkerError),
#[error("I/O Error")]
IO(#[from] std::io::Error),
#[error("RepositoryError): {0}")]
Repository(#[from] crate::repository::RepositoryError),
#[error("Failed to deserialize archive")]
ArchiveDeserialization,
}
type Result<T> = std::result::Result<T, ArchiveError>;
#[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq, Hash)]
pub struct StoredArchive {
pub id: ChunkID,
pub timestamp: DateTime<FixedOffset>,
}
impl StoredArchive {
pub async fn load(&self, repo: &mut Repository<impl BackendClone>) -> Result<ActiveArchive> {
let bytes = repo.read_chunk(self.id).await?;
let dumb_archive: Archive = serde_cbor::de::from_slice(&bytes[..])
.map_err(|_| ArchiveError::ArchiveDeserialization)?;
let archive = ActiveArchive::from_archive(dumb_archive);
Ok(archive)
}
#[cfg(test)]
pub fn dummy_archive() -> StoredArchive {
StoredArchive {
id: ChunkID::random_id(),
timestamp: Local::now().with_timezone(Local::now().offset()),
}
}
pub fn timestamp(&self) -> DateTime<FixedOffset> {
self.timestamp
}
pub fn id(&self) -> ChunkID {
self.id
}
}
impl From<ManifestTransaction> for StoredArchive {
fn from(item: ManifestTransaction) -> Self {
StoredArchive {
id: item.pointer(),
timestamp: item.timestamp(),
}
}
}
#[derive(Clone, Debug)]
pub struct ActiveArchive {
name: String,
objects: Arc<DashMap<String, Vec<ChunkLocation>>>,
namespace: Vec<String>,
timestamp: DateTime<FixedOffset>,
listing: Arc<RwLock<Listing>>,
}
impl ActiveArchive {
pub fn new(name: &str) -> Self {
ActiveArchive {
name: name.to_string(),
objects: Arc::new(DashMap::new()),
namespace: Vec::new(),
timestamp: Local::now().with_timezone(Local::now().offset()),
listing: Arc::new(RwLock::new(Listing::default())),
}
}
pub async fn put_object<R: Read + Send + 'static>(
&mut self,
chunker: &impl AsyncChunker,
repository: &mut Repository<impl BackendClone>,
path: &str,
from_reader: R,
ex: &smol::Executor<'_>,
) -> Result<()> {
let extent = Extent { start: 0, end: 0 };
let readers = vec![(extent, from_reader)];
self.put_sparse_object(chunker, repository, path, readers, ex)
.await
}
pub async fn put_sparse_object<R: Read + Send + 'static>(
&mut self,
chunker: &impl AsyncChunker,
repository: &mut Repository<impl BackendClone>,
path: &str,
from_readers: Vec<(Extent, R)>,
ex: &smol::Executor<'_>,
) -> Result<()> {
let mut locations: Vec<ChunkLocation> = Vec::new();
let path = self.canonical_namespace() + path.trim();
for (extent, read) in from_readers {
let max_futs = 100;
let mut futs = VecDeque::new();
let slices = chunker.async_chunk(read, repository.queue_depth);
let mut start = extent.start;
while let Ok(result) = slices.recv_async().await {
let data = result?;
let end = start + (data.len() as u64);
let mut repository = repository.clone();
futs.push_back(ex.spawn(async move {
let id = repository.write_chunk(data).await?.0;
let result: Result<ChunkLocation> = Ok(ChunkLocation {
id,
start,
length: end - start + 1,
});
result
}));
while futs.len() >= max_futs {
let loc = futs.pop_front().unwrap().await?;
locations.push(loc);
}
start = end + 1;
}
let locs = join_all(futs).await;
for loc in locs {
let loc = loc?;
locations.push(loc);
}
}
self.objects.insert(path.to_string(), locations);
Ok(())
}
pub async fn put_empty(&mut self, path: &str) {
let locations: Vec<ChunkLocation> = Vec::new();
self.objects.insert(path.to_string(), locations);
}
pub async fn get_object(
&self,
repository: &mut Repository<impl BackendClone>,
path: &str,
mut restore_to: impl Write,
) -> Result<()> {
let path = self.canonical_namespace() + path.trim();
#[allow(clippy::map_clone)]
let locations = self.objects.get(&path.to_string()).map(|x| x.clone());
let mut locations = if let Some(locations) = locations {
locations
} else {
return Ok(());
};
locations.sort_unstable();
let mut last_index = locations[0].start;
for location in &locations {
let id = location.id;
let start = location.start;
if start > last_index + 1 {
let zero = [0_u8];
for _ in last_index + 1..start {
restore_to.write_all(&zero)?;
}
}
let bytes = repository.read_chunk(id).await?;
restore_to.write_all(&bytes)?;
last_index = start + location.length - 1;
}
Ok(())
}
pub async fn get_extent(
&self,
repository: &mut Repository<impl BackendClone>,
path: &str,
extent: Extent,
mut restore_to: impl Write,
) -> Result<()> {
let path = self.canonical_namespace() + path.trim();
#[allow(clippy::map_clone)]
let locations = self.objects.get(&path.to_string()).map(|x| x.clone());
let mut locations = if let Some(locations) = locations {
locations
} else {
return Ok(());
};
locations.sort_unstable();
let locations = locations
.iter()
.filter(|x| x.start >= extent.start && x.start <= extent.end);
let mut last_index = extent.start;
for location in locations {
let id = location.id;
let start = location.start;
if start > last_index + 1 {
let zero = [0_u8];
for _ in last_index + 1..start {
restore_to.write_all(&zero)?;
}
}
let bytes = repository.read_chunk(id).await?;
restore_to.write_all(&bytes)?;
last_index = start + location.length - 1;
}
Ok(())
}
pub async fn get_sparse_object(
&self,
repository: &mut Repository<impl BackendClone>,
path: &str,
mut to_writers: Vec<(Extent, impl Write)>,
) -> Result<()> {
for (extent, restore_to) in &mut to_writers {
self.get_extent(repository, path, *extent, restore_to)
.await?;
}
Ok(())
}
pub fn canonical_namespace(&self) -> String {
self.namespace.join(":") + ":"
}
pub fn namespace_append(&self, name: &str) -> ActiveArchive {
let mut new_namespace = self.namespace.clone();
new_namespace.push(name.to_string());
let mut archive = self.clone();
archive.namespace = new_namespace;
archive
}
pub async fn store(self, repo: &mut Repository<impl BackendClone>) -> StoredArchive {
let dumb_archive = self.into_archive().await;
let mut bytes = Vec::<u8>::new();
dumb_archive
.serialize(&mut Serializer::new(&mut bytes))
.expect("Unable to serialize archive.");
let id = repo
.write_chunk(bytes)
.await
.expect("Unable to write archive metatdata to repository.")
.0;
repo.commit_index().await;
StoredArchive {
id,
timestamp: dumb_archive.timestamp,
}
}
#[cfg(not(tarpaulin_include))]
pub fn name(&self) -> &str {
&self.name
}
#[cfg(not(tarpaulin_include))]
pub fn timestamp(&self) -> &DateTime<FixedOffset> {
&self.timestamp
}
pub fn from_archive(archive: Archive) -> ActiveArchive {
ActiveArchive {
name: archive.name,
objects: Arc::new(archive.objects.into_iter().collect()),
namespace: archive.namespace,
timestamp: archive.timestamp,
listing: Arc::new(RwLock::new(archive.listing)),
}
}
pub async fn into_archive(self) -> Archive {
Archive {
name: self.name,
objects: DashMap::clone(&self.objects).into_iter().collect(),
namespace: self.namespace,
timestamp: self.timestamp,
listing: self.listing.read().await.clone(),
}
}
pub async fn listing(&self) -> Listing {
self.listing.read().await.clone()
}
pub async fn set_listing(&self, listing: Listing) {
*self.listing.write().await = listing;
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::chunker::*;
use crate::repository::backend::mem::Mem;
use crate::repository::ChunkSettings;
use crate::repository::Key;
use rand::prelude::*;
use std::fs;
use std::io::{BufReader, Cursor, Seek, SeekFrom};
use std::path::Path;
use tempfile::tempdir;
fn get_repo_mem(key: Key) -> Repository<impl BackendClone> {
let settings = ChunkSettings::lightweight();
let backend = Mem::new(settings, key.clone(), 4);
Repository::with(backend, settings, key, 2)
}
#[test]
fn single_add_get() {
let ex = smol::Executor::new();
let ex: &'static smol::Executor = Box::leak(Box::new(ex));
let (_signal, shutdown) = smol::channel::unbounded::<()>();
std::thread::spawn(move || futures::executor::block_on(ex.run(shutdown.recv())));
smol::block_on(async {
let seed = 0;
println!("Seed: {}", seed);
let chunker = FastCDC::default();
let key = Key::random(32);
let size = 2 * 2_usize.pow(14);
let mut data = vec![0_u8; size];
let mut rand = SmallRng::seed_from_u64(seed);
rand.fill_bytes(&mut data);
let mut repo = get_repo_mem(key);
let mut archive = ActiveArchive::new("test");
let testdir = tempdir().unwrap();
let input_file_path = testdir.path().join(Path::new("file1"));
{
let mut input_file = fs::File::create(input_file_path.clone()).unwrap();
input_file.write_all(&data).unwrap();
}
let input_file = BufReader::new(fs::File::open(input_file_path).unwrap());
archive
.put_object(&chunker, &mut repo, "FileOne", input_file, &ex)
.await
.unwrap();
let mut buf = Cursor::new(Vec::<u8>::new());
archive
.get_object(&mut repo, "FileOne", &mut buf)
.await
.unwrap();
let output = buf.into_inner();
println!("Input length: {}", data.len());
println!("Output length: {}", output.len());
let mut mismatch = false;
for i in 0..data.len() {
if data[i] != output[i] {
println!(
"Byte {} was different in output. Input val: {:X?} Output val {:X?}",
i, data[i], output[i]
);
mismatch = true;
}
}
assert!(!mismatch);
});
}
#[test]
fn sparse_add_get() {
let ex = smol::Executor::new();
let ex: &'static smol::Executor = Box::leak(Box::new(ex));
let (_signal, shutdown) = smol::channel::unbounded::<()>();
std::thread::spawn(move || futures::executor::block_on(ex.run(shutdown.recv())));
smol::block_on(async {
let seed = 0;
let chunker: FastCDC = FastCDC::default();
let key = Key::random(32);
let mut repo = get_repo_mem(key);
let mut archive = ActiveArchive::new("test");
let mut rng = SmallRng::seed_from_u64(seed);
let mut extents: Vec<Extent> = Vec::new();
let extent_count: usize = rng.gen_range(1..10);
let ex: &'static smol::Executor = Box::leak(Box::new(ex));
let mut next_start: u64 = 0;
let mut final_size: usize = 0;
for _ in 0..extent_count {
let extent_length = rng.gen_range(256..16384);
let extent = Extent {
start: next_start,
end: next_start + extent_length,
};
final_size = (next_start + extent_length) as usize;
extents.push(extent);
let jump = rng.gen_range(256..16384);
next_start = next_start + extent_length + jump;
}
let mut test_input = vec![0_u8; final_size];
for Extent { start, end } in extents.clone() {
for i in start..end {
test_input[i as usize] = rng.gen();
}
}
let mut extent_list = Vec::new();
for extent in extents.clone() {
let data = test_input[extent.start as usize..extent.end as usize].to_vec();
extent_list.push((extent, Cursor::new(data)));
}
archive
.put_sparse_object(&chunker, &mut repo, "test", extent_list, &ex)
.await
.expect("Archive Put Failed");
let test_output = Vec::new();
println!("Output is a buffer of {} bytes.", final_size);
let mut cursor = Cursor::new(test_output);
for (i, extent) in extents.clone().iter().enumerate() {
println!("Getting extent #{} : {:?}", i, extent);
cursor
.seek(SeekFrom::Start(extent.start))
.expect("Out of bounds");
archive
.get_extent(&mut repo, "test", *extent, &mut cursor)
.await
.expect("Archive Get Failed");
}
let test_output = cursor.into_inner();
println!("Input is now a buffer of {} bytes.", test_input.len());
println!("Output is now a buffer of {} bytes.", test_output.len());
for i in 0..test_input.len() {
if test_output[i] != test_input[i] {
println!("Difference at {}", i);
println!("Orig: {:?}", &test_input[i - 2..i + 3]);
println!("New: {:?}", &test_output[i - 2..i + 3]);
break;
}
}
std::mem::drop(repo);
assert_eq!(test_input, test_output);
});
}
#[test]
fn default_namespace() {
let archive = ActiveArchive::new("test");
let namespace = archive.canonical_namespace();
assert_eq!(namespace, ":");
}
#[test]
fn namespace_append() {
let archive = ActiveArchive::new("test");
let archive = archive.namespace_append("1");
let archive = archive.namespace_append("2");
let namespace = archive.canonical_namespace();
println!("Namespace: {}", namespace);
assert_eq!(namespace, "1:2:");
}
#[test]
fn namespaced_insertions() {
let ex = smol::Executor::new();
let ex: &'static smol::Executor = Box::leak(Box::new(ex));
let (_signal, shutdown) = smol::channel::unbounded::<()>();
std::thread::spawn(move || futures::executor::block_on(ex.run(shutdown.recv())));
smol::block_on(async {
let chunker = FastCDC::default();
let key = Key::random(32);
let mut repo = get_repo_mem(key);
let obj1 = Cursor::new([1_u8; 32]);
let obj2 = Cursor::new([2_u8; 32]);
let mut archive_1 = ActiveArchive::new("test");
let mut archive_2 = archive_1.clone();
archive_1
.put_object(&chunker, &mut repo, "1", obj1.clone(), &ex)
.await
.unwrap();
archive_2
.put_object(&chunker, &mut repo, "2", obj2.clone(), &ex)
.await
.unwrap();
let mut restore_1 = Cursor::new(Vec::<u8>::new());
archive_2
.get_object(&mut repo, "1", &mut restore_1)
.await
.unwrap();
let mut restore_2 = Cursor::new(Vec::<u8>::new());
archive_1
.get_object(&mut repo, "2", &mut restore_2)
.await
.unwrap();
let obj1 = obj1.into_inner();
let obj2 = obj2.into_inner();
let restore1 = restore_1.into_inner();
let restore2 = restore_2.into_inner();
assert_eq!(&obj1[..], &restore1[..]);
assert_eq!(&obj2[..], &restore2[..]);
});
}
#[test]
fn commit_and_load() {
let ex = smol::Executor::new();
let ex: &'static smol::Executor = Box::leak(Box::new(ex));
let (_signal, shutdown) = smol::channel::unbounded::<()>();
std::thread::spawn(move || futures::executor::block_on(ex.run(shutdown.recv())));
smol::block_on(async {
let chunker = FastCDC::default();
let key = Key::random(32);
let mut repo = get_repo_mem(key);
let mut obj1 = [0_u8; 32];
for i in 0..obj1.len() {
obj1[i] = i as u8;
}
let obj1 = Cursor::new(obj1);
let mut archive = ActiveArchive::new("test");
archive
.put_object(&chunker, &mut repo, "1", obj1.clone(), &ex)
.await
.expect("Unable to put object in archive");
let stored_archive = archive.store(&mut repo).await;
let archive = stored_archive
.load(&mut repo)
.await
.expect("Unable to load archive from repository");
let mut obj_restore = Cursor::new(Vec::new());
archive
.get_object(&mut repo, "1", &mut obj_restore)
.await
.expect("Unable to restore object from archive");
assert_eq!(&obj1.into_inner()[..], &obj_restore.into_inner()[..]);
});
}
}