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_api_types
::HumanByte
;
18 use pbs_tools
::crypt_config
::CryptConfig
;
19 use pbs_datastore
::{CATALOG_NAME, PROXMOX_BACKUP_PROTOCOL_ID_V1}
;
20 use pbs_datastore
::data_blob
::{ChunkInfo, DataBlob, DataChunkBuilder}
;
21 use pbs_datastore
::dynamic_index
::DynamicIndexReader
;
22 use pbs_datastore
::fixed_index
::FixedIndexReader
;
23 use pbs_datastore
::index
::IndexFile
;
24 use pbs_datastore
::manifest
::{ArchiveType, BackupManifest, MANIFEST_BLOB_NAME}
;
26 use super::merge_known_chunks
::{MergeKnownChunks, MergedChunkInfo}
;
28 use super::{H2Client, HttpClient}
;
30 pub struct BackupWriter
{
34 crypt_config
: Option
<Arc
<CryptConfig
>>,
37 impl Drop
for BackupWriter
{
43 pub struct BackupStats
{
48 /// Options for uploading blobs/streams to the server
49 #[derive(Default, Clone)]
50 pub struct UploadOptions
{
51 pub previous_manifest
: Option
<Arc
<BackupManifest
>>,
54 pub fixed_size
: Option
<u64>,
62 size_compressed
: usize,
63 duration
: std
::time
::Duration
,
67 type UploadQueueSender
= mpsc
::Sender
<(MergedChunkInfo
, Option
<h2
::client
::ResponseFuture
>)>;
68 type UploadResultReceiver
= oneshot
::Receiver
<Result
<(), Error
>>;
74 crypt_config
: Option
<Arc
<CryptConfig
>>,
85 // FIXME: extract into (flattened) parameter struct?
86 #[allow(clippy::too_many_arguments)]
89 crypt_config
: Option
<Arc
<CryptConfig
>>,
96 ) -> Result
<Arc
<BackupWriter
>, Error
> {
98 "backup-type": backup_type
,
99 "backup-id": backup_id
,
100 "backup-time": backup_time
,
103 "benchmark": benchmark
106 let req
= HttpClient
::request_builder(
115 let (h2
, abort
) = client
116 .start_h2_connection(req
, String
::from(PROXMOX_BACKUP_PROTOCOL_ID_V1
!()))
119 Ok(BackupWriter
::new(h2
, abort
, crypt_config
, debug
))
122 pub async
fn get(&self, path
: &str, param
: Option
<Value
>) -> Result
<Value
, Error
> {
123 self.h2
.get(path
, param
).await
126 pub async
fn put(&self, path
: &str, param
: Option
<Value
>) -> Result
<Value
, Error
> {
127 self.h2
.put(path
, param
).await
130 pub async
fn post(&self, path
: &str, param
: Option
<Value
>) -> Result
<Value
, Error
> {
131 self.h2
.post(path
, param
).await
134 pub async
fn upload_post(
137 param
: Option
<Value
>,
140 ) -> Result
<Value
, Error
> {
142 .upload("POST", path
, param
, content_type
, data
)
146 pub async
fn send_upload_request(
150 param
: Option
<Value
>,
153 ) -> Result
<h2
::client
::ResponseFuture
, Error
> {
155 H2Client
::request_builder("localhost", method
, path
, param
, Some(content_type
))
157 let response_future
= self
159 .send_request(request
, Some(bytes
::Bytes
::from(data
.clone())))
164 pub async
fn upload_put(
167 param
: Option
<Value
>,
170 ) -> Result
<Value
, Error
> {
171 self.h2
.upload("PUT", path
, param
, content_type
, data
).await
174 pub async
fn finish(self: Arc
<Self>) -> Result
<(), Error
> {
175 let h2
= self.h2
.clone();
177 h2
.post("finish", None
)
184 pub fn cancel(&self) {
188 pub async
fn upload_blob
<R
: std
::io
::Read
>(
192 ) -> Result
<BackupStats
, Error
> {
193 let mut raw_data
= Vec
::new();
194 // fixme: avoid loading into memory
195 reader
.read_to_end(&mut raw_data
)?
;
197 let csum
= openssl
::sha
::sha256(&raw_data
);
198 let param
= json
!({"encoded-size": raw_data.len(), "file-name": file_name }
);
199 let size
= raw_data
.len() as u64;
206 "application/octet-stream",
210 Ok(BackupStats { size, csum }
)
213 pub async
fn upload_blob_from_data(
217 options
: UploadOptions
,
218 ) -> Result
<BackupStats
, Error
> {
219 let blob
= match (options
.encrypt
, &self.crypt_config
) {
220 (false, _
) => DataBlob
::encode(&data
, None
, options
.compress
)?
,
221 (true, None
) => bail
!("requested encryption without a crypt config"),
222 (true, Some(crypt_config
)) => {
223 DataBlob
::encode(&data
, Some(crypt_config
), options
.compress
)?
227 let raw_data
= blob
.into_inner();
228 let size
= raw_data
.len() as u64;
230 let csum
= openssl
::sha
::sha256(&raw_data
);
231 let param
= json
!({"encoded-size": size, "file-name": file_name }
);
238 "application/octet-stream",
242 Ok(BackupStats { size, csum }
)
245 pub async
fn upload_blob_from_file
<P
: AsRef
<std
::path
::Path
>>(
249 options
: UploadOptions
,
250 ) -> Result
<BackupStats
, Error
> {
251 let src_path
= src_path
.as_ref();
253 let mut file
= tokio
::fs
::File
::open(src_path
)
255 .map_err(|err
| format_err
!("unable to open file {:?} - {}", src_path
, err
))?
;
257 let mut contents
= Vec
::new();
259 file
.read_to_end(&mut contents
)
261 .map_err(|err
| format_err
!("unable to read file {:?} - {}", src_path
, err
))?
;
263 self.upload_blob_from_data(contents
, file_name
, options
)
267 pub async
fn upload_stream(
270 stream
: impl Stream
<Item
= Result
<bytes
::BytesMut
, Error
>>,
271 options
: UploadOptions
,
272 ) -> Result
<BackupStats
, Error
> {
273 let known_chunks
= Arc
::new(Mutex
::new(HashSet
::new()));
275 let mut param
= json
!({ "archive-name": archive_name }
);
276 let prefix
= if let Some(size
) = options
.fixed_size
{
277 param
["size"] = size
.into();
283 if options
.encrypt
&& self.crypt_config
.is_none() {
284 bail
!("requested encryption without a crypt config");
287 let index_path
= format
!("{}_index", prefix
);
288 let close_path
= format
!("{}_close", prefix
);
290 if let Some(manifest
) = options
.previous_manifest
{
291 // try, but ignore errors
292 match ArchiveType
::from_path(archive_name
) {
293 Ok(ArchiveType
::FixedIndex
) => {
295 .download_previous_fixed_index(
298 known_chunks
.clone(),
302 Ok(ArchiveType
::DynamicIndex
) => {
304 .download_previous_dynamic_index(
307 known_chunks
.clone(),
311 _
=> { /* do nothing */ }
317 .post(&index_path
, Some(param
))
322 let upload_stats
= Self::upload_chunk_info_stream(
327 known_chunks
.clone(),
329 self.crypt_config
.clone()
338 let size_dirty
= upload_stats
.size
- upload_stats
.size_reused
;
339 let size
: HumanByte
= upload_stats
.size
.into();
340 let archive
= if self.verbose
{
343 pbs_tools
::format
::strip_server_file_extension(archive_name
)
345 if archive_name
!= CATALOG_NAME
{
346 let speed
: HumanByte
=
347 ((size_dirty
* 1_000_000) / (upload_stats
.duration
.as_micros() as usize)).into();
348 let size_dirty
: HumanByte
= size_dirty
.into();
349 let size_compressed
: HumanByte
= upload_stats
.size_compressed
.into();
351 "{}: had to backup {} of {} (compressed {}) in {:.2}s",
356 upload_stats
.duration
.as_secs_f64()
358 println
!("{}: average backup speed: {}/s", archive
, speed
);
360 println
!("Uploaded backup catalog ({})", size
);
363 if upload_stats
.size_reused
> 0 && upload_stats
.size
> 1024 * 1024 {
364 let reused_percent
= upload_stats
.size_reused
as f64 * 100. / upload_stats
.size
as f64;
365 let reused
: HumanByte
= upload_stats
.size_reused
.into();
367 "{}: backup was done incrementally, reused {} ({:.1}%)",
368 archive
, reused
, reused_percent
371 if self.verbose
&& upload_stats
.chunk_count
> 0 {
373 "{}: Reused {} from {} chunks.",
374 archive
, upload_stats
.chunk_reused
, upload_stats
.chunk_count
377 "{}: Average chunk size was {}.",
379 HumanByte
::from(upload_stats
.size
/ upload_stats
.chunk_count
)
382 "{}: Average time per request: {} microseconds.",
384 (upload_stats
.duration
.as_micros()) / (upload_stats
.chunk_count
as u128
)
390 "chunk-count": upload_stats
.chunk_count
,
391 "size": upload_stats
.size
,
392 "csum": proxmox
::tools
::digest_to_hex(&upload_stats
.csum
),
394 let _value
= self.h2
.post(&close_path
, Some(param
)).await?
;
396 size
: upload_stats
.size
as u64,
397 csum
: upload_stats
.csum
,
404 mpsc
::Sender
<h2
::client
::ResponseFuture
>,
405 oneshot
::Receiver
<Result
<(), Error
>>,
407 let (verify_queue_tx
, verify_queue_rx
) = mpsc
::channel(100);
408 let (verify_result_tx
, verify_result_rx
) = oneshot
::channel();
410 // FIXME: check if this works as expected as replacement for the combinator below?
411 // tokio::spawn(async move {
412 // let result: Result<(), Error> = (async move {
413 // while let Some(response) = verify_queue_rx.recv().await {
414 // match H2Client::h2api_response(response.await?).await {
415 // Ok(result) => println!("RESPONSE: {:?}", result),
416 // Err(err) => bail!("pipelined request failed: {}", err),
421 // let _ignore_closed_channel = verify_result_tx.send(result);
423 // old code for reference?
425 ReceiverStream
::new(verify_queue_rx
)
427 .try_for_each(move |response
: h2
::client
::ResponseFuture
| {
429 .map_err(Error
::from
)
430 .and_then(H2Client
::h2api_response
)
431 .map_ok(move |result
| {
433 println
!("RESPONSE: {:?}", result
)
436 .map_err(|err
| format_err
!("pipelined request failed: {}", err
))
439 let _ignore_closed_channel
= verify_result_tx
.send(result
);
443 (verify_queue_tx
, verify_result_rx
)
446 fn append_chunk_queue(
451 ) -> (UploadQueueSender
, UploadResultReceiver
) {
452 let (verify_queue_tx
, verify_queue_rx
) = mpsc
::channel(64);
453 let (verify_result_tx
, verify_result_rx
) = oneshot
::channel();
455 // FIXME: async-block-ify this code!
457 ReceiverStream
::new(verify_queue_rx
)
459 .and_then(move |(merged_chunk_info
, response
): (MergedChunkInfo
, Option
<h2
::client
::ResponseFuture
>)| {
460 match (response
, merged_chunk_info
) {
461 (Some(response
), MergedChunkInfo
::Known(list
)) => {
464 .map_err(Error
::from
)
465 .and_then(H2Client
::h2api_response
)
466 .and_then(move |_result
| {
467 future
::ok(MergedChunkInfo
::Known(list
))
471 (None
, MergedChunkInfo
::Known(list
)) => {
472 Either
::Right(future
::ok(MergedChunkInfo
::Known(list
)))
477 .merge_known_chunks()
478 .and_then(move |merged_chunk_info
| {
479 match merged_chunk_info
{
480 MergedChunkInfo
::Known(chunk_list
) => {
481 let mut digest_list
= vec
![];
482 let mut offset_list
= vec
![];
483 for (offset
, digest
) in chunk_list
{
484 digest_list
.push(digest_to_hex(&digest
));
485 offset_list
.push(offset
);
487 if verbose { println!("append chunks list len ({}
)", digest_list.len()); }
488 let param = json!({ "wid": wid, "digest-list": digest_list, "offset-list": offset_list });
489 let request = H2Client::request_builder("localhost
", "PUT
", &path, None, Some("application
/json
")).unwrap();
490 let param_data = bytes::Bytes::from(param.to_string().into_bytes());
491 let upload_data = Some(param_data);
492 h2.send_request(request, upload_data)
493 .and_then(move |response| {
495 .map_err(Error::from)
496 .and_then(H2Client::h2api_response)
499 .map_err(|err| format_err!("pipelined request failed
: {}
", err))
504 .try_for_each(|_| future::ok(()))
506 let _ignore_closed_channel = verify_result_tx.send(result);
510 (verify_queue_tx, verify_result_rx)
513 pub async fn download_previous_fixed_index(
516 manifest: &BackupManifest,
517 known_chunks: Arc<Mutex<HashSet<[u8; 32]>>>,
518 ) -> Result<FixedIndexReader, Error> {
519 let mut tmpfile = std::fs::OpenOptions::new()
522 .custom_flags(libc::O_TMPFILE)
525 let param = json!({ "archive-name": archive_name });
527 .download("previous
", Some(param), &mut tmpfile)
530 let index = FixedIndexReader::new(tmpfile).map_err(|err| {
531 format_err!("unable to read fixed index '{}'
- {}
", archive_name, err)
533 // Note: do not use values stored in index (not trusted) - instead, computed them again
534 let (csum, size) = index.compute_csum();
535 manifest.verify_file(archive_name, &csum, size)?;
537 // add index chunks to known chunks
538 let mut known_chunks = known_chunks.lock().unwrap();
539 for i in 0..index.index_count() {
540 known_chunks.insert(*index.index_digest(i).unwrap());
545 "{}
: known chunks list length is {}
",
554 pub async fn download_previous_dynamic_index(
557 manifest: &BackupManifest,
558 known_chunks: Arc<Mutex<HashSet<[u8; 32]>>>,
559 ) -> Result<DynamicIndexReader, Error> {
560 let mut tmpfile = std::fs::OpenOptions::new()
563 .custom_flags(libc::O_TMPFILE)
566 let param = json!({ "archive-name": archive_name });
568 .download("previous
", Some(param), &mut tmpfile)
571 let index = DynamicIndexReader::new(tmpfile).map_err(|err| {
572 format_err!("unable to read dynmamic index '{}'
- {}
", archive_name, err)
574 // Note: do not use values stored in index (not trusted) - instead, computed them again
575 let (csum, size) = index.compute_csum();
576 manifest.verify_file(archive_name, &csum, size)?;
578 // add index chunks to known chunks
579 let mut known_chunks = known_chunks.lock().unwrap();
580 for i in 0..index.index_count() {
581 known_chunks.insert(*index.index_digest(i).unwrap());
586 "{}
: known chunks list length is {}
",
595 /// Retrieve backup time of last backup
596 pub async fn previous_backup_time(&self) -> Result<Option<i64>, Error> {
597 let data = self.h2.get("previous_backup_time
", None).await?;
598 serde_json::from_value(data).map_err(|err| {
600 "Failed to parse backup time value returned by server
- {}
",
606 /// Download backup manifest (index.json) of last backup
607 pub async fn download_previous_manifest(&self) -> Result<BackupManifest, Error> {
608 let mut raw_data = Vec::with_capacity(64 * 1024);
610 let param = json!({ "archive-name": MANIFEST_BLOB_NAME });
612 .download("previous
", Some(param), &mut raw_data)
615 let blob = DataBlob::load_from_reader(&mut &raw_data[..])?;
616 // no expected digest available
617 let data = blob.decode(self.crypt_config.as_ref().map(Arc::as_ref), None)?;
620 BackupManifest::from_data(&data[..], self.crypt_config.as_ref().map(Arc::as_ref))?;
625 // We have no `self` here for `h2` and `verbose`, the only other arg "common
" with 1 other
626 // function in the same path is `wid`, so those 3 could be in a struct, but there's no real use
627 // since this is a private method.
628 #[allow(clippy::too_many_arguments)]
629 fn upload_chunk_info_stream(
632 stream: impl Stream<Item = Result<bytes::BytesMut, Error>>,
634 known_chunks: Arc<Mutex<HashSet<[u8; 32]>>>,
635 crypt_config: Option<Arc<CryptConfig>>,
638 ) -> impl Future<Output = Result<UploadStats, Error>> {
639 let total_chunks = Arc::new(AtomicUsize::new(0));
640 let total_chunks2 = total_chunks.clone();
641 let known_chunk_count = Arc::new(AtomicUsize::new(0));
642 let known_chunk_count2 = known_chunk_count.clone();
644 let stream_len = Arc::new(AtomicUsize::new(0));
645 let stream_len2 = stream_len.clone();
646 let compressed_stream_len = Arc::new(AtomicU64::new(0));
647 let compressed_stream_len2 = compressed_stream_len.clone();
648 let reused_len = Arc::new(AtomicUsize::new(0));
649 let reused_len2 = reused_len.clone();
651 let append_chunk_path = format!("{}_index
", prefix);
652 let upload_chunk_path = format!("{}_chunk
", prefix);
653 let is_fixed_chunk_size = prefix == "fixed
";
655 let (upload_queue, upload_result) =
656 Self::append_chunk_queue(h2.clone(), wid, append_chunk_path, verbose);
658 let start_time = std::time::Instant::now();
660 let index_csum = Arc::new(Mutex::new(Some(openssl::sha::Sha256::new())));
661 let index_csum_2 = index_csum.clone();
664 .and_then(move |data| {
665 let chunk_len = data.len();
667 total_chunks.fetch_add(1, Ordering::SeqCst);
668 let offset = stream_len.fetch_add(chunk_len, Ordering::SeqCst) as u64;
670 let mut chunk_builder = DataChunkBuilder::new(data.as_ref()).compress(compress);
672 if let Some(ref crypt_config) = crypt_config {
673 chunk_builder = chunk_builder.crypt_config(crypt_config);
676 let mut known_chunks = known_chunks.lock().unwrap();
677 let digest = chunk_builder.digest();
679 let mut guard = index_csum.lock().unwrap();
680 let csum = guard.as_mut().unwrap();
682 let chunk_end = offset + chunk_len as u64;
684 if !is_fixed_chunk_size {
685 csum.update(&chunk_end.to_le_bytes());
689 let chunk_is_known = known_chunks.contains(digest);
691 known_chunk_count.fetch_add(1, Ordering::SeqCst);
692 reused_len.fetch_add(chunk_len, Ordering::SeqCst);
693 future::ok(MergedChunkInfo::Known(vec![(offset, *digest)]))
695 let compressed_stream_len2 = compressed_stream_len.clone();
696 known_chunks.insert(*digest);
697 future::ready(chunk_builder.build().map(move |(chunk, digest)| {
698 compressed_stream_len2.fetch_add(chunk.raw_size(), Ordering::SeqCst);
699 MergedChunkInfo::New(ChunkInfo {
702 chunk_len: chunk_len as u64,
708 .merge_known_chunks()
709 .try_for_each(move |merged_chunk_info| {
710 let upload_queue = upload_queue.clone();
712 if let MergedChunkInfo::New(chunk_info) = merged_chunk_info {
713 let offset = chunk_info.offset;
714 let digest = chunk_info.digest;
715 let digest_str = digest_to_hex(&digest);
717 /* too verbose, needs finer verbosity setting granularity
719 println!("upload new chunk {}
({} bytes
, offset {}
)", digest_str,
720 chunk_info.chunk_len, offset);
724 let chunk_data = chunk_info.chunk.into_inner();
727 "digest
": digest_str,
728 "size
": chunk_info.chunk_len,
729 "encoded
-size
": chunk_data.len(),
732 let ct = "application
/octet
-stream
";
733 let request = H2Client::request_builder(
741 let upload_data = Some(bytes::Bytes::from(chunk_data));
743 let new_info = MergedChunkInfo::Known(vec![(offset, digest)]);
745 Either::Left(h2.send_request(request, upload_data).and_then(
746 move |response| async move {
748 .send((new_info, Some(response)))
751 format_err!("failed to send to upload queue
: {}
", err)
756 Either::Right(async move {
758 .send((merged_chunk_info, None))
760 .map_err(|err| format_err!("failed to send to upload queue
: {}
", err))
764 .then(move |result| async move { upload_result.await?.and(result) }.boxed())
766 let duration = start_time.elapsed();
767 let chunk_count = total_chunks2.load(Ordering::SeqCst);
768 let chunk_reused = known_chunk_count2.load(Ordering::SeqCst);
769 let size = stream_len2.load(Ordering::SeqCst);
770 let size_reused = reused_len2.load(Ordering::SeqCst);
771 let size_compressed = compressed_stream_len2.load(Ordering::SeqCst) as usize;
773 let mut guard = index_csum_2.lock().unwrap();
774 let csum = guard.take().unwrap().finish();
776 futures::future::ok(UploadStats {
788 /// Upload speed test - prints result to stderr
789 pub async fn upload_speedtest(&self, verbose: bool) -> Result<f64, Error> {
790 let mut data = vec![];
791 // generate pseudo random byte sequence
792 for i in 0..1024 * 1024 {
794 let byte = ((i >> (j << 3)) & 0xff) as u8;
799 let item_len = data.len();
803 let (upload_queue, upload_result) = Self::response_queue(verbose);
805 let start_time = std::time::Instant::now();
809 if start_time.elapsed().as_secs() >= 5 {
814 eprintln!("send test
data ({} bytes
)", data.len());
817 H2Client::request_builder("localhost
", "POST
", "speedtest
", None, None).unwrap();
818 let request_future = self
820 .send_request(request, Some(bytes::Bytes::from(data.clone())))
823 upload_queue.send(request_future).await?;
826 drop(upload_queue); // close queue
828 let _ = upload_result.await?;
831 "Uploaded {} chunks
in {} seconds
.",
833 start_time.elapsed().as_secs()
835 let speed = ((item_len * (repeat as usize)) as f64) / start_time.elapsed().as_secs_f64();
837 "Time per request
: {} microseconds
.",
838 (start_time.elapsed().as_micros()) / (repeat as u128)