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_datastore
::{CATALOG_NAME, CryptConfig}
;
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}
;
23 use pbs_tools
::format
::HumanByte
;
25 use super::merge_known_chunks
::{MergeKnownChunks, MergedChunkInfo}
;
27 use super::{H2Client, HttpClient}
;
29 pub struct BackupWriter
{
33 crypt_config
: Option
<Arc
<CryptConfig
>>,
36 impl Drop
for BackupWriter
{
42 pub struct BackupStats
{
47 /// Options for uploading blobs/streams to the server
48 #[derive(Default, Clone)]
49 pub struct UploadOptions
{
50 pub previous_manifest
: Option
<Arc
<BackupManifest
>>,
53 pub fixed_size
: Option
<u64>,
61 size_compressed
: usize,
62 duration
: std
::time
::Duration
,
66 type UploadQueueSender
= mpsc
::Sender
<(MergedChunkInfo
, Option
<h2
::client
::ResponseFuture
>)>;
67 type UploadResultReceiver
= oneshot
::Receiver
<Result
<(), Error
>>;
73 crypt_config
: Option
<Arc
<CryptConfig
>>,
84 // FIXME: extract into (flattened) parameter struct?
85 #[allow(clippy::too_many_arguments)]
88 crypt_config
: Option
<Arc
<CryptConfig
>>,
95 ) -> Result
<Arc
<BackupWriter
>, Error
> {
97 "backup-type": backup_type
,
98 "backup-id": backup_id
,
99 "backup-time": backup_time
,
102 "benchmark": benchmark
105 let req
= HttpClient
::request_builder(
114 let (h2
, abort
) = client
115 .start_h2_connection(req
, String
::from(PROXMOX_BACKUP_PROTOCOL_ID_V1
!()))
118 Ok(BackupWriter
::new(h2
, abort
, crypt_config
, debug
))
121 pub async
fn get(&self, path
: &str, param
: Option
<Value
>) -> Result
<Value
, Error
> {
122 self.h2
.get(path
, param
).await
125 pub async
fn put(&self, path
: &str, param
: Option
<Value
>) -> Result
<Value
, Error
> {
126 self.h2
.put(path
, param
).await
129 pub async
fn post(&self, path
: &str, param
: Option
<Value
>) -> Result
<Value
, Error
> {
130 self.h2
.post(path
, param
).await
133 pub async
fn upload_post(
136 param
: Option
<Value
>,
139 ) -> Result
<Value
, Error
> {
141 .upload("POST", path
, param
, content_type
, data
)
145 pub async
fn send_upload_request(
149 param
: Option
<Value
>,
152 ) -> Result
<h2
::client
::ResponseFuture
, Error
> {
154 H2Client
::request_builder("localhost", method
, path
, param
, Some(content_type
))
156 let response_future
= self
158 .send_request(request
, Some(bytes
::Bytes
::from(data
.clone())))
163 pub async
fn upload_put(
166 param
: Option
<Value
>,
169 ) -> Result
<Value
, Error
> {
170 self.h2
.upload("PUT", path
, param
, content_type
, data
).await
173 pub async
fn finish(self: Arc
<Self>) -> Result
<(), Error
> {
174 let h2
= self.h2
.clone();
176 h2
.post("finish", None
)
183 pub fn cancel(&self) {
187 pub async
fn upload_blob
<R
: std
::io
::Read
>(
191 ) -> Result
<BackupStats
, Error
> {
192 let mut raw_data
= Vec
::new();
193 // fixme: avoid loading into memory
194 reader
.read_to_end(&mut raw_data
)?
;
196 let csum
= openssl
::sha
::sha256(&raw_data
);
197 let param
= json
!({"encoded-size": raw_data.len(), "file-name": file_name }
);
198 let size
= raw_data
.len() as u64;
205 "application/octet-stream",
209 Ok(BackupStats { size, csum }
)
212 pub async
fn upload_blob_from_data(
216 options
: UploadOptions
,
217 ) -> Result
<BackupStats
, Error
> {
218 let blob
= match (options
.encrypt
, &self.crypt_config
) {
219 (false, _
) => DataBlob
::encode(&data
, None
, options
.compress
)?
,
220 (true, None
) => bail
!("requested encryption without a crypt config"),
221 (true, Some(crypt_config
)) => {
222 DataBlob
::encode(&data
, Some(crypt_config
), options
.compress
)?
226 let raw_data
= blob
.into_inner();
227 let size
= raw_data
.len() as u64;
229 let csum
= openssl
::sha
::sha256(&raw_data
);
230 let param
= json
!({"encoded-size": size, "file-name": file_name }
);
237 "application/octet-stream",
241 Ok(BackupStats { size, csum }
)
244 pub async
fn upload_blob_from_file
<P
: AsRef
<std
::path
::Path
>>(
248 options
: UploadOptions
,
249 ) -> Result
<BackupStats
, Error
> {
250 let src_path
= src_path
.as_ref();
252 let mut file
= tokio
::fs
::File
::open(src_path
)
254 .map_err(|err
| format_err
!("unable to open file {:?} - {}", src_path
, err
))?
;
256 let mut contents
= Vec
::new();
258 file
.read_to_end(&mut contents
)
260 .map_err(|err
| format_err
!("unable to read file {:?} - {}", src_path
, err
))?
;
262 self.upload_blob_from_data(contents
, file_name
, options
)
266 pub async
fn upload_stream(
269 stream
: impl Stream
<Item
= Result
<bytes
::BytesMut
, Error
>>,
270 options
: UploadOptions
,
271 ) -> Result
<BackupStats
, Error
> {
272 let known_chunks
= Arc
::new(Mutex
::new(HashSet
::new()));
274 let mut param
= json
!({ "archive-name": archive_name }
);
275 let prefix
= if let Some(size
) = options
.fixed_size
{
276 param
["size"] = size
.into();
282 if options
.encrypt
&& self.crypt_config
.is_none() {
283 bail
!("requested encryption without a crypt config");
286 let index_path
= format
!("{}_index", prefix
);
287 let close_path
= format
!("{}_close", prefix
);
289 if let Some(manifest
) = options
.previous_manifest
{
290 // try, but ignore errors
291 match ArchiveType
::from_path(archive_name
) {
292 Ok(ArchiveType
::FixedIndex
) => {
294 .download_previous_fixed_index(
297 known_chunks
.clone(),
301 Ok(ArchiveType
::DynamicIndex
) => {
303 .download_previous_dynamic_index(
306 known_chunks
.clone(),
310 _
=> { /* do nothing */ }
316 .post(&index_path
, Some(param
))
321 let upload_stats
= Self::upload_chunk_info_stream(
326 known_chunks
.clone(),
328 self.crypt_config
.clone()
337 let size_dirty
= upload_stats
.size
- upload_stats
.size_reused
;
338 let size
: HumanByte
= upload_stats
.size
.into();
339 let archive
= if self.verbose
{
340 archive_name
.to_string()
342 pbs_tools
::format
::strip_server_file_extension(archive_name
)
344 if archive_name
!= CATALOG_NAME
{
345 let speed
: HumanByte
=
346 ((size_dirty
* 1_000_000) / (upload_stats
.duration
.as_micros() as usize)).into();
347 let size_dirty
: HumanByte
= size_dirty
.into();
348 let size_compressed
: HumanByte
= upload_stats
.size_compressed
.into();
350 "{}: had to backup {} of {} (compressed {}) in {:.2}s",
355 upload_stats
.duration
.as_secs_f64()
357 println
!("{}: average backup speed: {}/s", archive
, speed
);
359 println
!("Uploaded backup catalog ({})", size
);
362 if upload_stats
.size_reused
> 0 && upload_stats
.size
> 1024 * 1024 {
363 let reused_percent
= upload_stats
.size_reused
as f64 * 100. / upload_stats
.size
as f64;
364 let reused
: HumanByte
= upload_stats
.size_reused
.into();
366 "{}: backup was done incrementally, reused {} ({:.1}%)",
367 archive
, reused
, reused_percent
370 if self.verbose
&& upload_stats
.chunk_count
> 0 {
372 "{}: Reused {} from {} chunks.",
373 archive
, upload_stats
.chunk_reused
, upload_stats
.chunk_count
376 "{}: Average chunk size was {}.",
378 HumanByte
::from(upload_stats
.size
/ upload_stats
.chunk_count
)
381 "{}: Average time per request: {} microseconds.",
383 (upload_stats
.duration
.as_micros()) / (upload_stats
.chunk_count
as u128
)
389 "chunk-count": upload_stats
.chunk_count
,
390 "size": upload_stats
.size
,
391 "csum": proxmox
::tools
::digest_to_hex(&upload_stats
.csum
),
393 let _value
= self.h2
.post(&close_path
, Some(param
)).await?
;
395 size
: upload_stats
.size
as u64,
396 csum
: upload_stats
.csum
,
403 mpsc
::Sender
<h2
::client
::ResponseFuture
>,
404 oneshot
::Receiver
<Result
<(), Error
>>,
406 let (verify_queue_tx
, verify_queue_rx
) = mpsc
::channel(100);
407 let (verify_result_tx
, verify_result_rx
) = oneshot
::channel();
409 // FIXME: check if this works as expected as replacement for the combinator below?
410 // tokio::spawn(async move {
411 // let result: Result<(), Error> = (async move {
412 // while let Some(response) = verify_queue_rx.recv().await {
413 // match H2Client::h2api_response(response.await?).await {
414 // Ok(result) => println!("RESPONSE: {:?}", result),
415 // Err(err) => bail!("pipelined request failed: {}", err),
420 // let _ignore_closed_channel = verify_result_tx.send(result);
422 // old code for reference?
424 ReceiverStream
::new(verify_queue_rx
)
426 .try_for_each(move |response
: h2
::client
::ResponseFuture
| {
428 .map_err(Error
::from
)
429 .and_then(H2Client
::h2api_response
)
430 .map_ok(move |result
| {
432 println
!("RESPONSE: {:?}", result
)
435 .map_err(|err
| format_err
!("pipelined request failed: {}", err
))
438 let _ignore_closed_channel
= verify_result_tx
.send(result
);
442 (verify_queue_tx
, verify_result_rx
)
445 fn append_chunk_queue(
450 ) -> (UploadQueueSender
, UploadResultReceiver
) {
451 let (verify_queue_tx
, verify_queue_rx
) = mpsc
::channel(64);
452 let (verify_result_tx
, verify_result_rx
) = oneshot
::channel();
454 // FIXME: async-block-ify this code!
456 ReceiverStream
::new(verify_queue_rx
)
458 .and_then(move |(merged_chunk_info
, response
): (MergedChunkInfo
, Option
<h2
::client
::ResponseFuture
>)| {
459 match (response
, merged_chunk_info
) {
460 (Some(response
), MergedChunkInfo
::Known(list
)) => {
463 .map_err(Error
::from
)
464 .and_then(H2Client
::h2api_response
)
465 .and_then(move |_result
| {
466 future
::ok(MergedChunkInfo
::Known(list
))
470 (None
, MergedChunkInfo
::Known(list
)) => {
471 Either
::Right(future
::ok(MergedChunkInfo
::Known(list
)))
476 .merge_known_chunks()
477 .and_then(move |merged_chunk_info
| {
478 match merged_chunk_info
{
479 MergedChunkInfo
::Known(chunk_list
) => {
480 let mut digest_list
= vec
![];
481 let mut offset_list
= vec
![];
482 for (offset
, digest
) in chunk_list
{
483 digest_list
.push(digest_to_hex(&digest
));
484 offset_list
.push(offset
);
486 if verbose { println!("append chunks list len ({}
)", digest_list.len()); }
487 let param = json!({ "wid": wid, "digest-list": digest_list, "offset-list": offset_list });
488 let request = H2Client::request_builder("localhost
", "PUT
", &path, None, Some("application
/json
")).unwrap();
489 let param_data = bytes::Bytes::from(param.to_string().into_bytes());
490 let upload_data = Some(param_data);
491 h2.send_request(request, upload_data)
492 .and_then(move |response| {
494 .map_err(Error::from)
495 .and_then(H2Client::h2api_response)
498 .map_err(|err| format_err!("pipelined request failed
: {}
", err))
503 .try_for_each(|_| future::ok(()))
505 let _ignore_closed_channel = verify_result_tx.send(result);
509 (verify_queue_tx, verify_result_rx)
512 pub async fn download_previous_fixed_index(
515 manifest: &BackupManifest,
516 known_chunks: Arc<Mutex<HashSet<[u8; 32]>>>,
517 ) -> Result<FixedIndexReader, Error> {
518 let mut tmpfile = std::fs::OpenOptions::new()
521 .custom_flags(libc::O_TMPFILE)
524 let param = json!({ "archive-name": archive_name });
526 .download("previous
", Some(param), &mut tmpfile)
529 let index = FixedIndexReader::new(tmpfile).map_err(|err| {
530 format_err!("unable to read fixed index '{}'
- {}
", archive_name, err)
532 // Note: do not use values stored in index (not trusted) - instead, computed them again
533 let (csum, size) = index.compute_csum();
534 manifest.verify_file(archive_name, &csum, size)?;
536 // add index chunks to known chunks
537 let mut known_chunks = known_chunks.lock().unwrap();
538 for i in 0..index.index_count() {
539 known_chunks.insert(*index.index_digest(i).unwrap());
544 "{}
: known chunks list length is {}
",
553 pub async fn download_previous_dynamic_index(
556 manifest: &BackupManifest,
557 known_chunks: Arc<Mutex<HashSet<[u8; 32]>>>,
558 ) -> Result<DynamicIndexReader, Error> {
559 let mut tmpfile = std::fs::OpenOptions::new()
562 .custom_flags(libc::O_TMPFILE)
565 let param = json!({ "archive-name": archive_name });
567 .download("previous
", Some(param), &mut tmpfile)
570 let index = DynamicIndexReader::new(tmpfile).map_err(|err| {
571 format_err!("unable to read dynmamic index '{}'
- {}
", archive_name, err)
573 // Note: do not use values stored in index (not trusted) - instead, computed them again
574 let (csum, size) = index.compute_csum();
575 manifest.verify_file(archive_name, &csum, size)?;
577 // add index chunks to known chunks
578 let mut known_chunks = known_chunks.lock().unwrap();
579 for i in 0..index.index_count() {
580 known_chunks.insert(*index.index_digest(i).unwrap());
585 "{}
: known chunks list length is {}
",
594 /// Retrieve backup time of last backup
595 pub async fn previous_backup_time(&self) -> Result<Option<i64>, Error> {
596 let data = self.h2.get("previous_backup_time
", None).await?;
597 serde_json::from_value(data).map_err(|err| {
599 "Failed to parse backup time value returned by server
- {}
",
605 /// Download backup manifest (index.json) of last backup
606 pub async fn download_previous_manifest(&self) -> Result<BackupManifest, Error> {
607 let mut raw_data = Vec::with_capacity(64 * 1024);
609 let param = json!({ "archive-name": MANIFEST_BLOB_NAME });
611 .download("previous
", Some(param), &mut raw_data)
614 let blob = DataBlob::load_from_reader(&mut &raw_data[..])?;
615 // no expected digest available
616 let data = blob.decode(self.crypt_config.as_ref().map(Arc::as_ref), None)?;
619 BackupManifest::from_data(&data[..], self.crypt_config.as_ref().map(Arc::as_ref))?;
624 // We have no `self` here for `h2` and `verbose`, the only other arg "common
" with 1 other
625 // function in the same path is `wid`, so those 3 could be in a struct, but there's no real use
626 // since this is a private method.
627 #[allow(clippy::too_many_arguments)]
628 fn upload_chunk_info_stream(
631 stream: impl Stream<Item = Result<bytes::BytesMut, Error>>,
633 known_chunks: Arc<Mutex<HashSet<[u8; 32]>>>,
634 crypt_config: Option<Arc<CryptConfig>>,
637 ) -> impl Future<Output = Result<UploadStats, Error>> {
638 let total_chunks = Arc::new(AtomicUsize::new(0));
639 let total_chunks2 = total_chunks.clone();
640 let known_chunk_count = Arc::new(AtomicUsize::new(0));
641 let known_chunk_count2 = known_chunk_count.clone();
643 let stream_len = Arc::new(AtomicUsize::new(0));
644 let stream_len2 = stream_len.clone();
645 let compressed_stream_len = Arc::new(AtomicU64::new(0));
646 let compressed_stream_len2 = compressed_stream_len.clone();
647 let reused_len = Arc::new(AtomicUsize::new(0));
648 let reused_len2 = reused_len.clone();
650 let append_chunk_path = format!("{}_index
", prefix);
651 let upload_chunk_path = format!("{}_chunk
", prefix);
652 let is_fixed_chunk_size = prefix == "fixed
";
654 let (upload_queue, upload_result) =
655 Self::append_chunk_queue(h2.clone(), wid, append_chunk_path, verbose);
657 let start_time = std::time::Instant::now();
659 let index_csum = Arc::new(Mutex::new(Some(openssl::sha::Sha256::new())));
660 let index_csum_2 = index_csum.clone();
663 .and_then(move |data| {
664 let chunk_len = data.len();
666 total_chunks.fetch_add(1, Ordering::SeqCst);
667 let offset = stream_len.fetch_add(chunk_len, Ordering::SeqCst) as u64;
669 let mut chunk_builder = DataChunkBuilder::new(data.as_ref()).compress(compress);
671 if let Some(ref crypt_config) = crypt_config {
672 chunk_builder = chunk_builder.crypt_config(crypt_config);
675 let mut known_chunks = known_chunks.lock().unwrap();
676 let digest = chunk_builder.digest();
678 let mut guard = index_csum.lock().unwrap();
679 let csum = guard.as_mut().unwrap();
681 let chunk_end = offset + chunk_len as u64;
683 if !is_fixed_chunk_size {
684 csum.update(&chunk_end.to_le_bytes());
688 let chunk_is_known = known_chunks.contains(digest);
690 known_chunk_count.fetch_add(1, Ordering::SeqCst);
691 reused_len.fetch_add(chunk_len, Ordering::SeqCst);
692 future::ok(MergedChunkInfo::Known(vec![(offset, *digest)]))
694 let compressed_stream_len2 = compressed_stream_len.clone();
695 known_chunks.insert(*digest);
696 future::ready(chunk_builder.build().map(move |(chunk, digest)| {
697 compressed_stream_len2.fetch_add(chunk.raw_size(), Ordering::SeqCst);
698 MergedChunkInfo::New(ChunkInfo {
701 chunk_len: chunk_len as u64,
707 .merge_known_chunks()
708 .try_for_each(move |merged_chunk_info| {
709 let upload_queue = upload_queue.clone();
711 if let MergedChunkInfo::New(chunk_info) = merged_chunk_info {
712 let offset = chunk_info.offset;
713 let digest = chunk_info.digest;
714 let digest_str = digest_to_hex(&digest);
716 /* too verbose, needs finer verbosity setting granularity
718 println!("upload new chunk {}
({} bytes
, offset {}
)", digest_str,
719 chunk_info.chunk_len, offset);
723 let chunk_data = chunk_info.chunk.into_inner();
726 "digest
": digest_str,
727 "size
": chunk_info.chunk_len,
728 "encoded
-size
": chunk_data.len(),
731 let ct = "application
/octet
-stream
";
732 let request = H2Client::request_builder(
740 let upload_data = Some(bytes::Bytes::from(chunk_data));
742 let new_info = MergedChunkInfo::Known(vec![(offset, digest)]);
744 Either::Left(h2.send_request(request, upload_data).and_then(
745 move |response| async move {
747 .send((new_info, Some(response)))
750 format_err!("failed to send to upload queue
: {}
", err)
755 Either::Right(async move {
757 .send((merged_chunk_info, None))
759 .map_err(|err| format_err!("failed to send to upload queue
: {}
", err))
763 .then(move |result| async move { upload_result.await?.and(result) }.boxed())
765 let duration = start_time.elapsed();
766 let chunk_count = total_chunks2.load(Ordering::SeqCst);
767 let chunk_reused = known_chunk_count2.load(Ordering::SeqCst);
768 let size = stream_len2.load(Ordering::SeqCst);
769 let size_reused = reused_len2.load(Ordering::SeqCst);
770 let size_compressed = compressed_stream_len2.load(Ordering::SeqCst) as usize;
772 let mut guard = index_csum_2.lock().unwrap();
773 let csum = guard.take().unwrap().finish();
775 futures::future::ok(UploadStats {
787 /// Upload speed test - prints result to stderr
788 pub async fn upload_speedtest(&self, verbose: bool) -> Result<f64, Error> {
789 let mut data = vec![];
790 // generate pseudo random byte sequence
791 for i in 0..1024 * 1024 {
793 let byte = ((i >> (j << 3)) & 0xff) as u8;
798 let item_len = data.len();
802 let (upload_queue, upload_result) = Self::response_queue(verbose);
804 let start_time = std::time::Instant::now();
808 if start_time.elapsed().as_secs() >= 5 {
813 eprintln!("send test
data ({} bytes
)", data.len());
816 H2Client::request_builder("localhost
", "POST
", "speedtest
", None, None).unwrap();
817 let request_future = self
819 .send_request(request, Some(bytes::Bytes::from(data.clone())))
822 upload_queue.send(request_future).await?;
825 drop(upload_queue); // close queue
827 let _ = upload_result.await?;
830 "Uploaded {} chunks
in {} seconds
.",
832 start_time.elapsed().as_secs()
834 let speed = ((item_len * (repeat as usize)) as f64) / start_time.elapsed().as_secs_f64();
836 "Time per request
: {} microseconds
.",
837 (start_time.elapsed().as_micros()) / (repeat as u128)