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 proxmox
::tools
::digest_to_hex
;
17 use pbs_tools
::format
::HumanByte
;
19 use super::merge_known_chunks
::{MergeKnownChunks, MergedChunkInfo}
;
22 use super::{H2Client, HttpClient}
;
24 pub struct BackupWriter
{
28 crypt_config
: Option
<Arc
<CryptConfig
>>,
31 impl Drop
for BackupWriter
{
37 pub struct BackupStats
{
42 /// Options for uploading blobs/streams to the server
43 #[derive(Default, Clone)]
44 pub struct UploadOptions
{
45 pub previous_manifest
: Option
<Arc
<BackupManifest
>>,
48 pub fixed_size
: Option
<u64>,
56 size_compressed
: usize,
57 duration
: std
::time
::Duration
,
61 type UploadQueueSender
= mpsc
::Sender
<(MergedChunkInfo
, Option
<h2
::client
::ResponseFuture
>)>;
62 type UploadResultReceiver
= oneshot
::Receiver
<Result
<(), Error
>>;
68 crypt_config
: Option
<Arc
<CryptConfig
>>,
79 // FIXME: extract into (flattened) parameter struct?
80 #[allow(clippy::too_many_arguments)]
83 crypt_config
: Option
<Arc
<CryptConfig
>>,
90 ) -> Result
<Arc
<BackupWriter
>, Error
> {
92 "backup-type": backup_type
,
93 "backup-id": backup_id
,
94 "backup-time": backup_time
,
97 "benchmark": benchmark
100 let req
= HttpClient
::request_builder(
109 let (h2
, abort
) = client
110 .start_h2_connection(req
, String
::from(PROXMOX_BACKUP_PROTOCOL_ID_V1
!()))
113 Ok(BackupWriter
::new(h2
, abort
, crypt_config
, debug
))
116 pub async
fn get(&self, path
: &str, param
: Option
<Value
>) -> Result
<Value
, Error
> {
117 self.h2
.get(path
, param
).await
120 pub async
fn put(&self, path
: &str, param
: Option
<Value
>) -> Result
<Value
, Error
> {
121 self.h2
.put(path
, param
).await
124 pub async
fn post(&self, path
: &str, param
: Option
<Value
>) -> Result
<Value
, Error
> {
125 self.h2
.post(path
, param
).await
128 pub async
fn upload_post(
131 param
: Option
<Value
>,
134 ) -> Result
<Value
, Error
> {
136 .upload("POST", path
, param
, content_type
, data
)
140 pub async
fn send_upload_request(
144 param
: Option
<Value
>,
147 ) -> Result
<h2
::client
::ResponseFuture
, Error
> {
149 H2Client
::request_builder("localhost", method
, path
, param
, Some(content_type
))
151 let response_future
= self
153 .send_request(request
, Some(bytes
::Bytes
::from(data
.clone())))
158 pub async
fn upload_put(
161 param
: Option
<Value
>,
164 ) -> Result
<Value
, Error
> {
165 self.h2
.upload("PUT", path
, param
, content_type
, data
).await
168 pub async
fn finish(self: Arc
<Self>) -> Result
<(), Error
> {
169 let h2
= self.h2
.clone();
171 h2
.post("finish", None
)
178 pub fn cancel(&self) {
182 pub async
fn upload_blob
<R
: std
::io
::Read
>(
186 ) -> Result
<BackupStats
, Error
> {
187 let mut raw_data
= Vec
::new();
188 // fixme: avoid loading into memory
189 reader
.read_to_end(&mut raw_data
)?
;
191 let csum
= openssl
::sha
::sha256(&raw_data
);
192 let param
= json
!({"encoded-size": raw_data.len(), "file-name": file_name }
);
193 let size
= raw_data
.len() as u64;
200 "application/octet-stream",
204 Ok(BackupStats { size, csum }
)
207 pub async
fn upload_blob_from_data(
211 options
: UploadOptions
,
212 ) -> Result
<BackupStats
, Error
> {
213 let blob
= match (options
.encrypt
, &self.crypt_config
) {
214 (false, _
) => DataBlob
::encode(&data
, None
, options
.compress
)?
,
215 (true, None
) => bail
!("requested encryption without a crypt config"),
216 (true, Some(crypt_config
)) => {
217 DataBlob
::encode(&data
, Some(crypt_config
), options
.compress
)?
221 let raw_data
= blob
.into_inner();
222 let size
= raw_data
.len() as u64;
224 let csum
= openssl
::sha
::sha256(&raw_data
);
225 let param
= json
!({"encoded-size": size, "file-name": file_name }
);
232 "application/octet-stream",
236 Ok(BackupStats { size, csum }
)
239 pub async
fn upload_blob_from_file
<P
: AsRef
<std
::path
::Path
>>(
243 options
: UploadOptions
,
244 ) -> Result
<BackupStats
, Error
> {
245 let src_path
= src_path
.as_ref();
247 let mut file
= tokio
::fs
::File
::open(src_path
)
249 .map_err(|err
| format_err
!("unable to open file {:?} - {}", src_path
, err
))?
;
251 let mut contents
= Vec
::new();
253 file
.read_to_end(&mut contents
)
255 .map_err(|err
| format_err
!("unable to read file {:?} - {}", src_path
, err
))?
;
257 self.upload_blob_from_data(contents
, file_name
, options
)
261 pub async
fn upload_stream(
264 stream
: impl Stream
<Item
= Result
<bytes
::BytesMut
, Error
>>,
265 options
: UploadOptions
,
266 ) -> Result
<BackupStats
, Error
> {
267 let known_chunks
= Arc
::new(Mutex
::new(HashSet
::new()));
269 let mut param
= json
!({ "archive-name": archive_name }
);
270 let prefix
= if let Some(size
) = options
.fixed_size
{
271 param
["size"] = size
.into();
277 if options
.encrypt
&& self.crypt_config
.is_none() {
278 bail
!("requested encryption without a crypt config");
281 let index_path
= format
!("{}_index", prefix
);
282 let close_path
= format
!("{}_close", prefix
);
284 if let Some(manifest
) = options
.previous_manifest
{
285 // try, but ignore errors
286 match archive_type(archive_name
) {
287 Ok(ArchiveType
::FixedIndex
) => {
289 .download_previous_fixed_index(
292 known_chunks
.clone(),
296 Ok(ArchiveType
::DynamicIndex
) => {
298 .download_previous_dynamic_index(
301 known_chunks
.clone(),
305 _
=> { /* do nothing */ }
311 .post(&index_path
, Some(param
))
316 let upload_stats
= Self::upload_chunk_info_stream(
321 known_chunks
.clone(),
323 self.crypt_config
.clone()
332 let size_dirty
= upload_stats
.size
- upload_stats
.size_reused
;
333 let size
: HumanByte
= upload_stats
.size
.into();
334 let archive
= if self.verbose
{
335 archive_name
.to_string()
337 pbs_tools
::format
::strip_server_file_extension(archive_name
)
339 if archive_name
!= CATALOG_NAME
{
340 let speed
: HumanByte
=
341 ((size_dirty
* 1_000_000) / (upload_stats
.duration
.as_micros() as usize)).into();
342 let size_dirty
: HumanByte
= size_dirty
.into();
343 let size_compressed
: HumanByte
= upload_stats
.size_compressed
.into();
345 "{}: had to backup {} of {} (compressed {}) in {:.2}s",
350 upload_stats
.duration
.as_secs_f64()
352 println
!("{}: average backup speed: {}/s", archive
, speed
);
354 println
!("Uploaded backup catalog ({})", size
);
357 if upload_stats
.size_reused
> 0 && upload_stats
.size
> 1024 * 1024 {
358 let reused_percent
= upload_stats
.size_reused
as f64 * 100. / upload_stats
.size
as f64;
359 let reused
: HumanByte
= upload_stats
.size_reused
.into();
361 "{}: backup was done incrementally, reused {} ({:.1}%)",
362 archive
, reused
, reused_percent
365 if self.verbose
&& upload_stats
.chunk_count
> 0 {
367 "{}: Reused {} from {} chunks.",
368 archive
, upload_stats
.chunk_reused
, upload_stats
.chunk_count
371 "{}: Average chunk size was {}.",
373 HumanByte
::from(upload_stats
.size
/ upload_stats
.chunk_count
)
376 "{}: Average time per request: {} microseconds.",
378 (upload_stats
.duration
.as_micros()) / (upload_stats
.chunk_count
as u128
)
384 "chunk-count": upload_stats
.chunk_count
,
385 "size": upload_stats
.size
,
386 "csum": proxmox
::tools
::digest_to_hex(&upload_stats
.csum
),
388 let _value
= self.h2
.post(&close_path
, Some(param
)).await?
;
390 size
: upload_stats
.size
as u64,
391 csum
: upload_stats
.csum
,
398 mpsc
::Sender
<h2
::client
::ResponseFuture
>,
399 oneshot
::Receiver
<Result
<(), Error
>>,
401 let (verify_queue_tx
, verify_queue_rx
) = mpsc
::channel(100);
402 let (verify_result_tx
, verify_result_rx
) = oneshot
::channel();
404 // FIXME: check if this works as expected as replacement for the combinator below?
405 // tokio::spawn(async move {
406 // let result: Result<(), Error> = (async move {
407 // while let Some(response) = verify_queue_rx.recv().await {
408 // match H2Client::h2api_response(response.await?).await {
409 // Ok(result) => println!("RESPONSE: {:?}", result),
410 // Err(err) => bail!("pipelined request failed: {}", err),
415 // let _ignore_closed_channel = verify_result_tx.send(result);
417 // old code for reference?
419 ReceiverStream
::new(verify_queue_rx
)
421 .try_for_each(move |response
: h2
::client
::ResponseFuture
| {
423 .map_err(Error
::from
)
424 .and_then(H2Client
::h2api_response
)
425 .map_ok(move |result
| {
427 println
!("RESPONSE: {:?}", result
)
430 .map_err(|err
| format_err
!("pipelined request failed: {}", err
))
433 let _ignore_closed_channel
= verify_result_tx
.send(result
);
437 (verify_queue_tx
, verify_result_rx
)
440 fn append_chunk_queue(
445 ) -> (UploadQueueSender
, UploadResultReceiver
) {
446 let (verify_queue_tx
, verify_queue_rx
) = mpsc
::channel(64);
447 let (verify_result_tx
, verify_result_rx
) = oneshot
::channel();
449 // FIXME: async-block-ify this code!
451 ReceiverStream
::new(verify_queue_rx
)
453 .and_then(move |(merged_chunk_info
, response
): (MergedChunkInfo
, Option
<h2
::client
::ResponseFuture
>)| {
454 match (response
, merged_chunk_info
) {
455 (Some(response
), MergedChunkInfo
::Known(list
)) => {
458 .map_err(Error
::from
)
459 .and_then(H2Client
::h2api_response
)
460 .and_then(move |_result
| {
461 future
::ok(MergedChunkInfo
::Known(list
))
465 (None
, MergedChunkInfo
::Known(list
)) => {
466 Either
::Right(future
::ok(MergedChunkInfo
::Known(list
)))
471 .merge_known_chunks()
472 .and_then(move |merged_chunk_info
| {
473 match merged_chunk_info
{
474 MergedChunkInfo
::Known(chunk_list
) => {
475 let mut digest_list
= vec
![];
476 let mut offset_list
= vec
![];
477 for (offset
, digest
) in chunk_list
{
478 digest_list
.push(digest_to_hex(&digest
));
479 offset_list
.push(offset
);
481 if verbose { println!("append chunks list len ({}
)", digest_list.len()); }
482 let param = json!({ "wid": wid, "digest-list": digest_list, "offset-list": offset_list });
483 let request = H2Client::request_builder("localhost
", "PUT
", &path, None, Some("application
/json
")).unwrap();
484 let param_data = bytes::Bytes::from(param.to_string().into_bytes());
485 let upload_data = Some(param_data);
486 h2.send_request(request, upload_data)
487 .and_then(move |response| {
489 .map_err(Error::from)
490 .and_then(H2Client::h2api_response)
493 .map_err(|err| format_err!("pipelined request failed
: {}
", err))
498 .try_for_each(|_| future::ok(()))
500 let _ignore_closed_channel = verify_result_tx.send(result);
504 (verify_queue_tx, verify_result_rx)
507 pub async fn download_previous_fixed_index(
510 manifest: &BackupManifest,
511 known_chunks: Arc<Mutex<HashSet<[u8; 32]>>>,
512 ) -> Result<FixedIndexReader, Error> {
513 let mut tmpfile = std::fs::OpenOptions::new()
516 .custom_flags(libc::O_TMPFILE)
519 let param = json!({ "archive-name": archive_name });
521 .download("previous
", Some(param), &mut tmpfile)
524 let index = FixedIndexReader::new(tmpfile).map_err(|err| {
525 format_err!("unable to read fixed index '{}'
- {}
", archive_name, err)
527 // Note: do not use values stored in index (not trusted) - instead, computed them again
528 let (csum, size) = index.compute_csum();
529 manifest.verify_file(archive_name, &csum, size)?;
531 // add index chunks to known chunks
532 let mut known_chunks = known_chunks.lock().unwrap();
533 for i in 0..index.index_count() {
534 known_chunks.insert(*index.index_digest(i).unwrap());
539 "{}
: known chunks list length is {}
",
548 pub async fn download_previous_dynamic_index(
551 manifest: &BackupManifest,
552 known_chunks: Arc<Mutex<HashSet<[u8; 32]>>>,
553 ) -> Result<DynamicIndexReader, Error> {
554 let mut tmpfile = std::fs::OpenOptions::new()
557 .custom_flags(libc::O_TMPFILE)
560 let param = json!({ "archive-name": archive_name });
562 .download("previous
", Some(param), &mut tmpfile)
565 let index = DynamicIndexReader::new(tmpfile).map_err(|err| {
566 format_err!("unable to read dynmamic index '{}'
- {}
", archive_name, err)
568 // Note: do not use values stored in index (not trusted) - instead, computed them again
569 let (csum, size) = index.compute_csum();
570 manifest.verify_file(archive_name, &csum, size)?;
572 // add index chunks to known chunks
573 let mut known_chunks = known_chunks.lock().unwrap();
574 for i in 0..index.index_count() {
575 known_chunks.insert(*index.index_digest(i).unwrap());
580 "{}
: known chunks list length is {}
",
589 /// Retrieve backup time of last backup
590 pub async fn previous_backup_time(&self) -> Result<Option<i64>, Error> {
591 let data = self.h2.get("previous_backup_time
", None).await?;
592 serde_json::from_value(data).map_err(|err| {
594 "Failed to parse backup time value returned by server
- {}
",
600 /// Download backup manifest (index.json) of last backup
601 pub async fn download_previous_manifest(&self) -> Result<BackupManifest, Error> {
602 let mut raw_data = Vec::with_capacity(64 * 1024);
604 let param = json!({ "archive-name": MANIFEST_BLOB_NAME });
606 .download("previous
", Some(param), &mut raw_data)
609 let blob = DataBlob::load_from_reader(&mut &raw_data[..])?;
610 // no expected digest available
611 let data = blob.decode(self.crypt_config.as_ref().map(Arc::as_ref), None)?;
614 BackupManifest::from_data(&data[..], self.crypt_config.as_ref().map(Arc::as_ref))?;
619 // We have no `self` here for `h2` and `verbose`, the only other arg "common
" with 1 other
620 // function in the same path is `wid`, so those 3 could be in a struct, but there's no real use
621 // since this is a private method.
622 #[allow(clippy::too_many_arguments)]
623 fn upload_chunk_info_stream(
626 stream: impl Stream<Item = Result<bytes::BytesMut, Error>>,
628 known_chunks: Arc<Mutex<HashSet<[u8; 32]>>>,
629 crypt_config: Option<Arc<CryptConfig>>,
632 ) -> impl Future<Output = Result<UploadStats, Error>> {
633 let total_chunks = Arc::new(AtomicUsize::new(0));
634 let total_chunks2 = total_chunks.clone();
635 let known_chunk_count = Arc::new(AtomicUsize::new(0));
636 let known_chunk_count2 = known_chunk_count.clone();
638 let stream_len = Arc::new(AtomicUsize::new(0));
639 let stream_len2 = stream_len.clone();
640 let compressed_stream_len = Arc::new(AtomicU64::new(0));
641 let compressed_stream_len2 = compressed_stream_len.clone();
642 let reused_len = Arc::new(AtomicUsize::new(0));
643 let reused_len2 = reused_len.clone();
645 let append_chunk_path = format!("{}_index
", prefix);
646 let upload_chunk_path = format!("{}_chunk
", prefix);
647 let is_fixed_chunk_size = prefix == "fixed
";
649 let (upload_queue, upload_result) =
650 Self::append_chunk_queue(h2.clone(), wid, append_chunk_path, verbose);
652 let start_time = std::time::Instant::now();
654 let index_csum = Arc::new(Mutex::new(Some(openssl::sha::Sha256::new())));
655 let index_csum_2 = index_csum.clone();
658 .and_then(move |data| {
659 let chunk_len = data.len();
661 total_chunks.fetch_add(1, Ordering::SeqCst);
662 let offset = stream_len.fetch_add(chunk_len, Ordering::SeqCst) as u64;
664 let mut chunk_builder = DataChunkBuilder::new(data.as_ref()).compress(compress);
666 if let Some(ref crypt_config) = crypt_config {
667 chunk_builder = chunk_builder.crypt_config(crypt_config);
670 let mut known_chunks = known_chunks.lock().unwrap();
671 let digest = chunk_builder.digest();
673 let mut guard = index_csum.lock().unwrap();
674 let csum = guard.as_mut().unwrap();
676 let chunk_end = offset + chunk_len as u64;
678 if !is_fixed_chunk_size {
679 csum.update(&chunk_end.to_le_bytes());
683 let chunk_is_known = known_chunks.contains(digest);
685 known_chunk_count.fetch_add(1, Ordering::SeqCst);
686 reused_len.fetch_add(chunk_len, Ordering::SeqCst);
687 future::ok(MergedChunkInfo::Known(vec![(offset, *digest)]))
689 let compressed_stream_len2 = compressed_stream_len.clone();
690 known_chunks.insert(*digest);
691 future::ready(chunk_builder.build().map(move |(chunk, digest)| {
692 compressed_stream_len2.fetch_add(chunk.raw_size(), Ordering::SeqCst);
693 MergedChunkInfo::New(ChunkInfo {
696 chunk_len: chunk_len as u64,
702 .merge_known_chunks()
703 .try_for_each(move |merged_chunk_info| {
704 let upload_queue = upload_queue.clone();
706 if let MergedChunkInfo::New(chunk_info) = merged_chunk_info {
707 let offset = chunk_info.offset;
708 let digest = chunk_info.digest;
709 let digest_str = digest_to_hex(&digest);
711 /* too verbose, needs finer verbosity setting granularity
713 println!("upload new chunk {}
({} bytes
, offset {}
)", digest_str,
714 chunk_info.chunk_len, offset);
718 let chunk_data = chunk_info.chunk.into_inner();
721 "digest
": digest_str,
722 "size
": chunk_info.chunk_len,
723 "encoded
-size
": chunk_data.len(),
726 let ct = "application
/octet
-stream
";
727 let request = H2Client::request_builder(
735 let upload_data = Some(bytes::Bytes::from(chunk_data));
737 let new_info = MergedChunkInfo::Known(vec![(offset, digest)]);
739 Either::Left(h2.send_request(request, upload_data).and_then(
740 move |response| async move {
742 .send((new_info, Some(response)))
745 format_err!("failed to send to upload queue
: {}
", err)
750 Either::Right(async move {
752 .send((merged_chunk_info, None))
754 .map_err(|err| format_err!("failed to send to upload queue
: {}
", err))
758 .then(move |result| async move { upload_result.await?.and(result) }.boxed())
760 let duration = start_time.elapsed();
761 let chunk_count = total_chunks2.load(Ordering::SeqCst);
762 let chunk_reused = known_chunk_count2.load(Ordering::SeqCst);
763 let size = stream_len2.load(Ordering::SeqCst);
764 let size_reused = reused_len2.load(Ordering::SeqCst);
765 let size_compressed = compressed_stream_len2.load(Ordering::SeqCst) as usize;
767 let mut guard = index_csum_2.lock().unwrap();
768 let csum = guard.take().unwrap().finish();
770 futures::future::ok(UploadStats {
782 /// Upload speed test - prints result to stderr
783 pub async fn upload_speedtest(&self, verbose: bool) -> Result<f64, Error> {
784 let mut data = vec![];
785 // generate pseudo random byte sequence
786 for i in 0..1024 * 1024 {
788 let byte = ((i >> (j << 3)) & 0xff) as u8;
793 let item_len = data.len();
797 let (upload_queue, upload_result) = Self::response_queue(verbose);
799 let start_time = std::time::Instant::now();
803 if start_time.elapsed().as_secs() >= 5 {
808 eprintln!("send test
data ({} bytes
)", data.len());
811 H2Client::request_builder("localhost
", "POST
", "speedtest
", None, None).unwrap();
812 let request_future = self
814 .send_request(request, Some(bytes::Bytes::from(data.clone())))
817 upload_queue.send(request_future).await?;
820 drop(upload_queue); // close queue
822 let _ = upload_result.await?;
825 "Uploaded {} chunks
in {} seconds
.",
827 start_time.elapsed().as_secs()
829 let speed = ((item_len * (repeat as usize)) as f64) / start_time.elapsed().as_secs_f64();
831 "Time per request
: {} microseconds
.",
832 (start_time.elapsed().as_micros()) / (repeat as u128)