1 use std
::collections
::HashSet
;
2 use std
::future
::Future
;
3 use std
::os
::unix
::fs
::OpenOptionsExt
;
4 use std
::sync
::atomic
::{AtomicU64, AtomicUsize, Ordering}
;
5 use std
::sync
::{Arc, Mutex}
;
7 use anyhow
::{bail, format_err, Error}
;
8 use futures
::future
::{self, AbortHandle, Either, FutureExt, TryFutureExt}
;
9 use futures
::stream
::{Stream, StreamExt, TryStreamExt}
;
10 use serde_json
::{json, Value}
;
11 use tokio
::io
::AsyncReadExt
;
12 use tokio
::sync
::{mpsc, oneshot}
;
13 use tokio_stream
::wrappers
::ReceiverStream
;
15 use pbs_api_types
::HumanByte
;
16 use pbs_tools
::crypt_config
::CryptConfig
;
17 use pbs_datastore
::{CATALOG_NAME, PROXMOX_BACKUP_PROTOCOL_ID_V1}
;
18 use pbs_datastore
::data_blob
::{ChunkInfo, DataBlob, DataChunkBuilder}
;
19 use pbs_datastore
::dynamic_index
::DynamicIndexReader
;
20 use pbs_datastore
::fixed_index
::FixedIndexReader
;
21 use pbs_datastore
::index
::IndexFile
;
22 use pbs_datastore
::manifest
::{ArchiveType, BackupManifest, MANIFEST_BLOB_NAME}
;
24 use super::merge_known_chunks
::{MergeKnownChunks, MergedChunkInfo}
;
26 use super::{H2Client, HttpClient}
;
28 pub struct BackupWriter
{
32 crypt_config
: Option
<Arc
<CryptConfig
>>,
35 impl Drop
for BackupWriter
{
41 pub struct BackupStats
{
46 /// Options for uploading blobs/streams to the server
47 #[derive(Default, Clone)]
48 pub struct UploadOptions
{
49 pub previous_manifest
: Option
<Arc
<BackupManifest
>>,
52 pub fixed_size
: Option
<u64>,
60 size_compressed
: usize,
61 duration
: std
::time
::Duration
,
65 type UploadQueueSender
= mpsc
::Sender
<(MergedChunkInfo
, Option
<h2
::client
::ResponseFuture
>)>;
66 type UploadResultReceiver
= oneshot
::Receiver
<Result
<(), Error
>>;
72 crypt_config
: Option
<Arc
<CryptConfig
>>,
83 // FIXME: extract into (flattened) parameter struct?
84 #[allow(clippy::too_many_arguments)]
87 crypt_config
: Option
<Arc
<CryptConfig
>>,
94 ) -> Result
<Arc
<BackupWriter
>, Error
> {
96 "backup-type": backup_type
,
97 "backup-id": backup_id
,
98 "backup-time": backup_time
,
101 "benchmark": benchmark
104 let req
= HttpClient
::request_builder(
113 let (h2
, abort
) = client
114 .start_h2_connection(req
, String
::from(PROXMOX_BACKUP_PROTOCOL_ID_V1
!()))
117 Ok(BackupWriter
::new(h2
, abort
, crypt_config
, debug
))
120 pub async
fn get(&self, path
: &str, param
: Option
<Value
>) -> Result
<Value
, Error
> {
121 self.h2
.get(path
, param
).await
124 pub async
fn put(&self, path
: &str, param
: Option
<Value
>) -> Result
<Value
, Error
> {
125 self.h2
.put(path
, param
).await
128 pub async
fn post(&self, path
: &str, param
: Option
<Value
>) -> Result
<Value
, Error
> {
129 self.h2
.post(path
, param
).await
132 pub async
fn upload_post(
135 param
: Option
<Value
>,
138 ) -> Result
<Value
, Error
> {
140 .upload("POST", path
, param
, content_type
, data
)
144 pub async
fn send_upload_request(
148 param
: Option
<Value
>,
151 ) -> Result
<h2
::client
::ResponseFuture
, Error
> {
153 H2Client
::request_builder("localhost", method
, path
, param
, Some(content_type
))
155 let response_future
= self
157 .send_request(request
, Some(bytes
::Bytes
::from(data
.clone())))
162 pub async
fn upload_put(
165 param
: Option
<Value
>,
168 ) -> Result
<Value
, Error
> {
169 self.h2
.upload("PUT", path
, param
, content_type
, data
).await
172 pub async
fn finish(self: Arc
<Self>) -> Result
<(), Error
> {
173 let h2
= self.h2
.clone();
175 h2
.post("finish", None
)
182 pub fn cancel(&self) {
186 pub async
fn upload_blob
<R
: std
::io
::Read
>(
190 ) -> Result
<BackupStats
, Error
> {
191 let mut raw_data
= Vec
::new();
192 // fixme: avoid loading into memory
193 reader
.read_to_end(&mut raw_data
)?
;
195 let csum
= openssl
::sha
::sha256(&raw_data
);
196 let param
= json
!({"encoded-size": raw_data.len(), "file-name": file_name }
);
197 let size
= raw_data
.len() as u64;
204 "application/octet-stream",
208 Ok(BackupStats { size, csum }
)
211 pub async
fn upload_blob_from_data(
215 options
: UploadOptions
,
216 ) -> Result
<BackupStats
, Error
> {
217 let blob
= match (options
.encrypt
, &self.crypt_config
) {
218 (false, _
) => DataBlob
::encode(&data
, None
, options
.compress
)?
,
219 (true, None
) => bail
!("requested encryption without a crypt config"),
220 (true, Some(crypt_config
)) => {
221 DataBlob
::encode(&data
, Some(crypt_config
), options
.compress
)?
225 let raw_data
= blob
.into_inner();
226 let size
= raw_data
.len() as u64;
228 let csum
= openssl
::sha
::sha256(&raw_data
);
229 let param
= json
!({"encoded-size": size, "file-name": file_name }
);
236 "application/octet-stream",
240 Ok(BackupStats { size, csum }
)
243 pub async
fn upload_blob_from_file
<P
: AsRef
<std
::path
::Path
>>(
247 options
: UploadOptions
,
248 ) -> Result
<BackupStats
, Error
> {
249 let src_path
= src_path
.as_ref();
251 let mut file
= tokio
::fs
::File
::open(src_path
)
253 .map_err(|err
| format_err
!("unable to open file {:?} - {}", src_path
, err
))?
;
255 let mut contents
= Vec
::new();
257 file
.read_to_end(&mut contents
)
259 .map_err(|err
| format_err
!("unable to read file {:?} - {}", src_path
, err
))?
;
261 self.upload_blob_from_data(contents
, file_name
, options
)
265 pub async
fn upload_stream(
268 stream
: impl Stream
<Item
= Result
<bytes
::BytesMut
, Error
>>,
269 options
: UploadOptions
,
270 ) -> Result
<BackupStats
, Error
> {
271 let known_chunks
= Arc
::new(Mutex
::new(HashSet
::new()));
273 let mut param
= json
!({ "archive-name": archive_name }
);
274 let prefix
= if let Some(size
) = options
.fixed_size
{
275 param
["size"] = size
.into();
281 if options
.encrypt
&& self.crypt_config
.is_none() {
282 bail
!("requested encryption without a crypt config");
285 let index_path
= format
!("{}_index", prefix
);
286 let close_path
= format
!("{}_close", prefix
);
288 if let Some(manifest
) = options
.previous_manifest
{
289 // try, but ignore errors
290 match ArchiveType
::from_path(archive_name
) {
291 Ok(ArchiveType
::FixedIndex
) => {
293 .download_previous_fixed_index(
296 known_chunks
.clone(),
300 Ok(ArchiveType
::DynamicIndex
) => {
302 .download_previous_dynamic_index(
305 known_chunks
.clone(),
309 _
=> { /* do nothing */ }
315 .post(&index_path
, Some(param
))
320 let upload_stats
= Self::upload_chunk_info_stream(
325 known_chunks
.clone(),
327 self.crypt_config
.clone()
336 let size_dirty
= upload_stats
.size
- upload_stats
.size_reused
;
337 let size
: HumanByte
= upload_stats
.size
.into();
338 let archive
= if self.verbose
{
341 pbs_tools
::format
::strip_server_file_extension(archive_name
)
343 if archive_name
!= CATALOG_NAME
{
344 let speed
: HumanByte
=
345 ((size_dirty
* 1_000_000) / (upload_stats
.duration
.as_micros() as usize)).into();
346 let size_dirty
: HumanByte
= size_dirty
.into();
347 let size_compressed
: HumanByte
= upload_stats
.size_compressed
.into();
349 "{}: had to backup {} of {} (compressed {}) in {:.2}s",
354 upload_stats
.duration
.as_secs_f64()
356 println
!("{}: average backup speed: {}/s", archive
, speed
);
358 println
!("Uploaded backup catalog ({})", size
);
361 if upload_stats
.size_reused
> 0 && upload_stats
.size
> 1024 * 1024 {
362 let reused_percent
= upload_stats
.size_reused
as f64 * 100. / upload_stats
.size
as f64;
363 let reused
: HumanByte
= upload_stats
.size_reused
.into();
365 "{}: backup was done incrementally, reused {} ({:.1}%)",
366 archive
, reused
, reused_percent
369 if self.verbose
&& upload_stats
.chunk_count
> 0 {
371 "{}: Reused {} from {} chunks.",
372 archive
, upload_stats
.chunk_reused
, upload_stats
.chunk_count
375 "{}: Average chunk size was {}.",
377 HumanByte
::from(upload_stats
.size
/ upload_stats
.chunk_count
)
380 "{}: Average time per request: {} microseconds.",
382 (upload_stats
.duration
.as_micros()) / (upload_stats
.chunk_count
as u128
)
388 "chunk-count": upload_stats
.chunk_count
,
389 "size": upload_stats
.size
,
390 "csum": hex
::encode(&upload_stats
.csum
),
392 let _value
= self.h2
.post(&close_path
, Some(param
)).await?
;
394 size
: upload_stats
.size
as u64,
395 csum
: upload_stats
.csum
,
402 mpsc
::Sender
<h2
::client
::ResponseFuture
>,
403 oneshot
::Receiver
<Result
<(), Error
>>,
405 let (verify_queue_tx
, verify_queue_rx
) = mpsc
::channel(100);
406 let (verify_result_tx
, verify_result_rx
) = oneshot
::channel();
408 // FIXME: check if this works as expected as replacement for the combinator below?
409 // tokio::spawn(async move {
410 // let result: Result<(), Error> = (async move {
411 // while let Some(response) = verify_queue_rx.recv().await {
412 // match H2Client::h2api_response(response.await?).await {
413 // Ok(result) => println!("RESPONSE: {:?}", result),
414 // Err(err) => bail!("pipelined request failed: {}", err),
419 // let _ignore_closed_channel = verify_result_tx.send(result);
421 // old code for reference?
423 ReceiverStream
::new(verify_queue_rx
)
425 .try_for_each(move |response
: h2
::client
::ResponseFuture
| {
427 .map_err(Error
::from
)
428 .and_then(H2Client
::h2api_response
)
429 .map_ok(move |result
| {
431 println
!("RESPONSE: {:?}", result
)
434 .map_err(|err
| format_err
!("pipelined request failed: {}", err
))
437 let _ignore_closed_channel
= verify_result_tx
.send(result
);
441 (verify_queue_tx
, verify_result_rx
)
444 fn append_chunk_queue(
449 ) -> (UploadQueueSender
, UploadResultReceiver
) {
450 let (verify_queue_tx
, verify_queue_rx
) = mpsc
::channel(64);
451 let (verify_result_tx
, verify_result_rx
) = oneshot
::channel();
453 // FIXME: async-block-ify this code!
455 ReceiverStream
::new(verify_queue_rx
)
457 .and_then(move |(merged_chunk_info
, response
): (MergedChunkInfo
, Option
<h2
::client
::ResponseFuture
>)| {
458 match (response
, merged_chunk_info
) {
459 (Some(response
), MergedChunkInfo
::Known(list
)) => {
462 .map_err(Error
::from
)
463 .and_then(H2Client
::h2api_response
)
464 .and_then(move |_result
| {
465 future
::ok(MergedChunkInfo
::Known(list
))
469 (None
, MergedChunkInfo
::Known(list
)) => {
470 Either
::Right(future
::ok(MergedChunkInfo
::Known(list
)))
475 .merge_known_chunks()
476 .and_then(move |merged_chunk_info
| {
477 match merged_chunk_info
{
478 MergedChunkInfo
::Known(chunk_list
) => {
479 let mut digest_list
= vec
![];
480 let mut offset_list
= vec
![];
481 for (offset
, digest
) in chunk_list
{
482 digest_list
.push(hex
::encode(&digest
));
483 offset_list
.push(offset
);
485 if verbose { println!("append chunks list len ({}
)", digest_list.len()); }
486 let param = json!({ "wid": wid, "digest-list": digest_list, "offset-list": offset_list });
487 let request = H2Client::request_builder("localhost
", "PUT
", &path, None, Some("application
/json
")).unwrap();
488 let param_data = bytes::Bytes::from(param.to_string().into_bytes());
489 let upload_data = Some(param_data);
490 h2.send_request(request, upload_data)
491 .and_then(move |response| {
493 .map_err(Error::from)
494 .and_then(H2Client::h2api_response)
497 .map_err(|err| format_err!("pipelined request failed
: {}
", err))
502 .try_for_each(|_| future::ok(()))
504 let _ignore_closed_channel = verify_result_tx.send(result);
508 (verify_queue_tx, verify_result_rx)
511 pub async fn download_previous_fixed_index(
514 manifest: &BackupManifest,
515 known_chunks: Arc<Mutex<HashSet<[u8; 32]>>>,
516 ) -> Result<FixedIndexReader, Error> {
517 let mut tmpfile = std::fs::OpenOptions::new()
520 .custom_flags(libc::O_TMPFILE)
523 let param = json!({ "archive-name": archive_name });
525 .download("previous
", Some(param), &mut tmpfile)
528 let index = FixedIndexReader::new(tmpfile).map_err(|err| {
529 format_err!("unable to read fixed index '{}'
- {}
", archive_name, err)
531 // Note: do not use values stored in index (not trusted) - instead, computed them again
532 let (csum, size) = index.compute_csum();
533 manifest.verify_file(archive_name, &csum, size)?;
535 // add index chunks to known chunks
536 let mut known_chunks = known_chunks.lock().unwrap();
537 for i in 0..index.index_count() {
538 known_chunks.insert(*index.index_digest(i).unwrap());
543 "{}
: known chunks list length is {}
",
552 pub async fn download_previous_dynamic_index(
555 manifest: &BackupManifest,
556 known_chunks: Arc<Mutex<HashSet<[u8; 32]>>>,
557 ) -> Result<DynamicIndexReader, Error> {
558 let mut tmpfile = std::fs::OpenOptions::new()
561 .custom_flags(libc::O_TMPFILE)
564 let param = json!({ "archive-name": archive_name });
566 .download("previous
", Some(param), &mut tmpfile)
569 let index = DynamicIndexReader::new(tmpfile).map_err(|err| {
570 format_err!("unable to read dynmamic index '{}'
- {}
", archive_name, err)
572 // Note: do not use values stored in index (not trusted) - instead, computed them again
573 let (csum, size) = index.compute_csum();
574 manifest.verify_file(archive_name, &csum, size)?;
576 // add index chunks to known chunks
577 let mut known_chunks = known_chunks.lock().unwrap();
578 for i in 0..index.index_count() {
579 known_chunks.insert(*index.index_digest(i).unwrap());
584 "{}
: known chunks list length is {}
",
593 /// Retrieve backup time of last backup
594 pub async fn previous_backup_time(&self) -> Result<Option<i64>, Error> {
595 let data = self.h2.get("previous_backup_time
", None).await?;
596 serde_json::from_value(data).map_err(|err| {
598 "Failed to parse backup time value returned by server
- {}
",
604 /// Download backup manifest (index.json) of last backup
605 pub async fn download_previous_manifest(&self) -> Result<BackupManifest, Error> {
606 let mut raw_data = Vec::with_capacity(64 * 1024);
608 let param = json!({ "archive-name": MANIFEST_BLOB_NAME });
610 .download("previous
", Some(param), &mut raw_data)
613 let blob = DataBlob::load_from_reader(&mut &raw_data[..])?;
614 // no expected digest available
615 let data = blob.decode(self.crypt_config.as_ref().map(Arc::as_ref), None)?;
618 BackupManifest::from_data(&data[..], self.crypt_config.as_ref().map(Arc::as_ref))?;
623 // We have no `self` here for `h2` and `verbose`, the only other arg "common
" with 1 other
624 // function in the same path is `wid`, so those 3 could be in a struct, but there's no real use
625 // since this is a private method.
626 #[allow(clippy::too_many_arguments)]
627 fn upload_chunk_info_stream(
630 stream: impl Stream<Item = Result<bytes::BytesMut, Error>>,
632 known_chunks: Arc<Mutex<HashSet<[u8; 32]>>>,
633 crypt_config: Option<Arc<CryptConfig>>,
636 ) -> impl Future<Output = Result<UploadStats, Error>> {
637 let total_chunks = Arc::new(AtomicUsize::new(0));
638 let total_chunks2 = total_chunks.clone();
639 let known_chunk_count = Arc::new(AtomicUsize::new(0));
640 let known_chunk_count2 = known_chunk_count.clone();
642 let stream_len = Arc::new(AtomicUsize::new(0));
643 let stream_len2 = stream_len.clone();
644 let compressed_stream_len = Arc::new(AtomicU64::new(0));
645 let compressed_stream_len2 = compressed_stream_len.clone();
646 let reused_len = Arc::new(AtomicUsize::new(0));
647 let reused_len2 = reused_len.clone();
649 let append_chunk_path = format!("{}_index
", prefix);
650 let upload_chunk_path = format!("{}_chunk
", prefix);
651 let is_fixed_chunk_size = prefix == "fixed
";
653 let (upload_queue, upload_result) =
654 Self::append_chunk_queue(h2.clone(), wid, append_chunk_path, verbose);
656 let start_time = std::time::Instant::now();
658 let index_csum = Arc::new(Mutex::new(Some(openssl::sha::Sha256::new())));
659 let index_csum_2 = index_csum.clone();
662 .and_then(move |data| {
663 let chunk_len = data.len();
665 total_chunks.fetch_add(1, Ordering::SeqCst);
666 let offset = stream_len.fetch_add(chunk_len, Ordering::SeqCst) as u64;
668 let mut chunk_builder = DataChunkBuilder::new(data.as_ref()).compress(compress);
670 if let Some(ref crypt_config) = crypt_config {
671 chunk_builder = chunk_builder.crypt_config(crypt_config);
674 let mut known_chunks = known_chunks.lock().unwrap();
675 let digest = chunk_builder.digest();
677 let mut guard = index_csum.lock().unwrap();
678 let csum = guard.as_mut().unwrap();
680 let chunk_end = offset + chunk_len as u64;
682 if !is_fixed_chunk_size {
683 csum.update(&chunk_end.to_le_bytes());
687 let chunk_is_known = known_chunks.contains(digest);
689 known_chunk_count.fetch_add(1, Ordering::SeqCst);
690 reused_len.fetch_add(chunk_len, Ordering::SeqCst);
691 future::ok(MergedChunkInfo::Known(vec![(offset, *digest)]))
693 let compressed_stream_len2 = compressed_stream_len.clone();
694 known_chunks.insert(*digest);
695 future::ready(chunk_builder.build().map(move |(chunk, digest)| {
696 compressed_stream_len2.fetch_add(chunk.raw_size(), Ordering::SeqCst);
697 MergedChunkInfo::New(ChunkInfo {
700 chunk_len: chunk_len as u64,
706 .merge_known_chunks()
707 .try_for_each(move |merged_chunk_info| {
708 let upload_queue = upload_queue.clone();
710 if let MergedChunkInfo::New(chunk_info) = merged_chunk_info {
711 let offset = chunk_info.offset;
712 let digest = chunk_info.digest;
713 let digest_str = hex::encode(&digest);
715 /* too verbose, needs finer verbosity setting granularity
717 println!("upload new chunk {}
({} bytes
, offset {}
)", digest_str,
718 chunk_info.chunk_len, offset);
722 let chunk_data = chunk_info.chunk.into_inner();
725 "digest
": digest_str,
726 "size
": chunk_info.chunk_len,
727 "encoded
-size
": chunk_data.len(),
730 let ct = "application
/octet
-stream
";
731 let request = H2Client::request_builder(
739 let upload_data = Some(bytes::Bytes::from(chunk_data));
741 let new_info = MergedChunkInfo::Known(vec![(offset, digest)]);
743 Either::Left(h2.send_request(request, upload_data).and_then(
744 move |response| async move {
746 .send((new_info, Some(response)))
749 format_err!("failed to send to upload queue
: {}
", err)
754 Either::Right(async move {
756 .send((merged_chunk_info, None))
758 .map_err(|err| format_err!("failed to send to upload queue
: {}
", err))
762 .then(move |result| async move { upload_result.await?.and(result) }.boxed())
764 let duration = start_time.elapsed();
765 let chunk_count = total_chunks2.load(Ordering::SeqCst);
766 let chunk_reused = known_chunk_count2.load(Ordering::SeqCst);
767 let size = stream_len2.load(Ordering::SeqCst);
768 let size_reused = reused_len2.load(Ordering::SeqCst);
769 let size_compressed = compressed_stream_len2.load(Ordering::SeqCst) as usize;
771 let mut guard = index_csum_2.lock().unwrap();
772 let csum = guard.take().unwrap().finish();
774 futures::future::ok(UploadStats {
786 /// Upload speed test - prints result to stderr
787 pub async fn upload_speedtest(&self, verbose: bool) -> Result<f64, Error> {
788 let mut data = vec![];
789 // generate pseudo random byte sequence
790 for i in 0..1024 * 1024 {
792 let byte = ((i >> (j << 3)) & 0xff) as u8;
797 let item_len = data.len();
801 let (upload_queue, upload_result) = Self::response_queue(verbose);
803 let start_time = std::time::Instant::now();
807 if start_time.elapsed().as_secs() >= 5 {
812 eprintln!("send test
data ({} bytes
)", data.len());
815 H2Client::request_builder("localhost
", "POST
", "speedtest
", None, None).unwrap();
816 let request_future = self
818 .send_request(request, Some(bytes::Bytes::from(data.clone())))
821 upload_queue.send(request_future).await?;
824 drop(upload_queue); // close queue
826 let _ = upload_result.await?;
829 "Uploaded {} chunks
in {} seconds
.",
831 start_time.elapsed().as_secs()
833 let speed = ((item_len * (repeat as usize)) as f64) / start_time.elapsed().as_secs_f64();
835 "Time per request
: {} microseconds
.",
836 (start_time.elapsed().as_micros()) / (repeat as u128)