From: Dominik Csapak <d.csapak@proxmox.com>
To: Proxmox Backup Server development discussion
<pbs-devel@lists.proxmox.com>,
Christian Ebner <c.ebner@proxmox.com>
Subject: Re: [pbs-devel] [PATCH v6 proxmox-backup 17/65] client: pxar: combine writers into struct
Date: Tue, 21 May 2024 12:29:25 +0200 [thread overview]
Message-ID: <e72260e6-ee73-4278-8a39-e00227491c09@proxmox.com> (raw)
In-Reply-To: <20240514103421.289431-18-c.ebner@proxmox.com>
nit inline:
On 5/14/24 12:33, Christian Ebner wrote:
> Introduce a `PxarWriters` struct to bundle all writer instances
> required for the pxar archive creation into a single object to limit
> the number of function call parameters, allowing to extend this
> further by e.g. the optional payload writer instance.
>
> Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
> ---
> pbs-client/src/pxar/create.rs | 18 ++++++++++++++----
> pbs-client/src/pxar/mod.rs | 2 +-
> pbs-client/src/pxar_backup_stream.rs | 5 +++--
> .../src/proxmox_restore_daemon/api.rs | 6 ++++--
> pxar-bin/src/main.rs | 6 +++---
> tests/catar.rs | 3 +--
> 6 files changed, 26 insertions(+), 14 deletions(-)
>
> diff --git a/pbs-client/src/pxar/create.rs b/pbs-client/src/pxar/create.rs
> index c9bf6df85..82f05889b 100644
> --- a/pbs-client/src/pxar/create.rs
> +++ b/pbs-client/src/pxar/create.rs
> @@ -135,12 +135,22 @@ struct Archiver {
>
> type Encoder<'a, T> = pxar::encoder::aio::Encoder<'a, T>;
>
> +pub struct PxarWriters<T> {
> + writer: T,
nit: imho, i wouldn't call that 'writer' as we're already know that from the struct name
and often from the variable name (e.g. see below 'writers.writer' is just confusing)
how about archive/main/pxar/... ?
writers.pxar & writers.catalog is imho more readable
than writers.writer & writers.catalog
but no hard feelings
> + catalog: Option<Arc<Mutex<dyn BackupCatalogWriter + Send>>>,
> +}
> +
> +impl<T> PxarWriters<T> {
> + pub fn new(writer: T, catalog: Option<Arc<Mutex<dyn BackupCatalogWriter + Send>>>) -> Self {
> + Self { writer, catalog }
> + }
> +}
> +
> pub async fn create_archive<T, F>(
> source_dir: Dir,
> - mut writer: T,
> + mut writers: PxarWriters<T>,
> feature_flags: Flags,
> callback: F,
> - catalog: Option<Arc<Mutex<dyn BackupCatalogWriter + Send>>>,
> options: PxarCreateOptions,
> ) -> Result<(), Error>
> where
> @@ -170,7 +180,7 @@ where
> set.insert(stat.st_dev);
> }
>
> - let mut encoder = Encoder::new(&mut writer, &metadata, None).await?;
> + let mut encoder = Encoder::new(&mut writers.writer, &metadata, None).await?;
>
> let mut patterns = options.patterns;
>
> @@ -188,7 +198,7 @@ where
> fs_magic,
> callback: Box::new(callback),
> patterns,
> - catalog,
> + catalog: writers.catalog,
> path: PathBuf::new(),
> entry_counter: 0,
> entry_limit: options.entries_max,
> diff --git a/pbs-client/src/pxar/mod.rs b/pbs-client/src/pxar/mod.rs
> index 14674b9b9..b7dcf8362 100644
> --- a/pbs-client/src/pxar/mod.rs
> +++ b/pbs-client/src/pxar/mod.rs
> @@ -56,7 +56,7 @@ pub(crate) mod tools;
> mod flags;
> pub use flags::Flags;
>
> -pub use create::{create_archive, PxarCreateOptions};
> +pub use create::{create_archive, PxarCreateOptions, PxarWriters};
> pub use extract::{
> create_tar, create_zip, extract_archive, extract_sub_dir, extract_sub_dir_seq, ErrorHandler,
> OverwriteFlags, PxarExtractContext, PxarExtractOptions,
> diff --git a/pbs-client/src/pxar_backup_stream.rs b/pbs-client/src/pxar_backup_stream.rs
> index 22a6ffdc2..bfa108a8b 100644
> --- a/pbs-client/src/pxar_backup_stream.rs
> +++ b/pbs-client/src/pxar_backup_stream.rs
> @@ -17,6 +17,8 @@ use proxmox_io::StdChannelWriter;
>
> use pbs_datastore::catalog::CatalogWriter;
>
> +use crate::pxar::create::PxarWriters;
> +
> /// Stream implementation to encode and upload .pxar archives.
> ///
> /// The hyper client needs an async Stream for file upload, so we
> @@ -56,13 +58,12 @@ impl PxarBackupStream {
> let writer = pxar::encoder::sync::StandardWriter::new(writer);
> if let Err(err) = crate::pxar::create_archive(
> dir,
> - writer,
> + PxarWriters::new(writer, Some(catalog)),
> crate::pxar::Flags::DEFAULT,
> move |path| {
> log::debug!("{:?}", path);
> Ok(())
> },
> - Some(catalog),
> options,
> )
> .await
> diff --git a/proxmox-restore-daemon/src/proxmox_restore_daemon/api.rs b/proxmox-restore-daemon/src/proxmox_restore_daemon/api.rs
> index c20552225..1ee200573 100644
> --- a/proxmox-restore-daemon/src/proxmox_restore_daemon/api.rs
> +++ b/proxmox-restore-daemon/src/proxmox_restore_daemon/api.rs
> @@ -23,7 +23,9 @@ use proxmox_sortable_macro::sortable;
> use proxmox_sys::fs::read_subdir;
>
> use pbs_api_types::file_restore::{FileRestoreFormat, RestoreDaemonStatus};
> -use pbs_client::pxar::{create_archive, Flags, PxarCreateOptions, ENCODER_MAX_ENTRIES};
> +use pbs_client::pxar::{
> + create_archive, Flags, PxarCreateOptions, PxarWriters, ENCODER_MAX_ENTRIES,
> +};
> use pbs_datastore::catalog::{ArchiveEntry, DirEntryAttribute};
> use pbs_tools::json::required_string_param;
>
> @@ -356,7 +358,7 @@ fn extract(
> };
>
> let pxar_writer = TokioWriter::new(writer);
> - create_archive(dir, pxar_writer, Flags::DEFAULT, |_| Ok(()), None, options)
> + create_archive(dir, PxarWriters::new(pxar_writer, None), Flags::DEFAULT, |_| Ok(()), options)
> .await
> }
> .await;
> diff --git a/pxar-bin/src/main.rs b/pxar-bin/src/main.rs
> index d475da4e3..ae2325078 100644
> --- a/pxar-bin/src/main.rs
> +++ b/pxar-bin/src/main.rs
> @@ -13,7 +13,8 @@ use tokio::signal::unix::{signal, SignalKind};
>
> use pathpatterns::{MatchEntry, MatchType, PatternFlag};
> use pbs_client::pxar::{
> - format_single_line_entry, Flags, OverwriteFlags, PxarExtractOptions, ENCODER_MAX_ENTRIES,
> + format_single_line_entry, Flags, OverwriteFlags, PxarExtractOptions, PxarWriters,
> + ENCODER_MAX_ENTRIES,
> };
>
> use proxmox_router::cli::*;
> @@ -376,13 +377,12 @@ async fn create_archive(
> let writer = pxar::encoder::sync::StandardWriter::new(writer);
> pbs_client::pxar::create_archive(
> dir,
> - writer,
> + PxarWriters::new(writer, None),
> feature_flags,
> move |path| {
> log::debug!("{:?}", path);
> Ok(())
> },
> - None,
> options,
> )
> .await?;
> diff --git a/tests/catar.rs b/tests/catar.rs
> index 36bb4f3bc..f414da8c9 100644
> --- a/tests/catar.rs
> +++ b/tests/catar.rs
> @@ -35,10 +35,9 @@ fn run_test(dir_name: &str) -> Result<(), Error> {
> let rt = tokio::runtime::Runtime::new().unwrap();
> rt.block_on(create_archive(
> dir,
> - writer,
> + PxarWriters::new(writer, None),
> Flags::DEFAULT,
> |_| Ok(()),
> - None,
> options,
> ))?;
>
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
next prev parent reply other threads:[~2024-05-21 10:29 UTC|newest]
Thread overview: 98+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-14 10:33 [pbs-devel] [PATCH v5 pxar proxmox-backup 00/62] fix #3174: improve file-level backup Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 01/14] format/examples: add header type `PXAR_PAYLOAD_REF` Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 02/14] decoder: add method to read payload references Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 03/14] decoder: factor out skip part from skip_entry Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 04/14] encoder: add optional output writer for file payloads Christian Ebner
2024-05-21 10:06 ` Dominik Csapak
2024-05-21 10:21 ` Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 05/14] encoder: move to stack based state tracking Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 06/14] decoder/accessor: add optional payload input stream Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 07/14] decoder: set payload input range when decoding via accessor Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 08/14] encoder: add payload reference capability Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 09/14] encoder: add payload position capability Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 10/14] encoder: add payload advance capability Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 11/14] encoder/format: finish payload stream with marker Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 12/14] format: add payload stream start marker Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 13/14] format/encoder/decoder: new pxar entry type `Version` Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 pxar 14/14] format/encoder/decoder: new pxar entry type `Prelude` Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 15/65] client: pxar: switch to stack based encoder state Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 16/65] client: backup: factor out extension from backup target Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 17/65] client: pxar: combine writers into struct Christian Ebner
2024-05-21 10:29 ` Dominik Csapak [this message]
2024-05-21 13:30 ` Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 18/65] client: pxar: add optional pxar payload writer instance Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 19/65] client: pxar: optionally split metadata and payload streams Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 20/65] client: helper: add helpers for creating reader instances Christian Ebner
2024-05-21 12:26 ` Dominik Csapak
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 21/65] client: helper: add method for split archive name mapping Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 22/65] client: restore: read payload from dedicated index Christian Ebner
2024-05-21 12:44 ` Dominik Csapak
2024-05-24 6:45 ` Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 23/65] tools: cover extension for split pxar archives Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 24/65] restore: " Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 25/65] client: mount: make split pxar archives mountable Christian Ebner
2024-05-21 12:54 ` Dominik Csapak
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 26/65] api: datastore: refactor getting local chunk reader Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 27/65] api: datastore: attach optional payload " Christian Ebner
2024-05-21 13:12 ` Dominik Csapak
2024-05-24 6:48 ` Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 28/65] catalog: shell: make split pxar archives accessible Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 29/65] www: cover metadata extension for pxar archives Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 30/65] file restore: factor out getting pxar reader Christian Ebner
2024-05-21 13:19 ` Dominik Csapak
2024-05-21 14:07 ` Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 31/65] file restore: cover split metadata and payload archives Christian Ebner
2024-05-21 13:25 ` Dominik Csapak
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 32/65] file restore: show more error context when extraction fails Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 33/65] pxar: add optional payload input for achive restore Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 34/65] pxar: add more context to extraction error Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 35/65] client: pxar: include payload offset in entry listing Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 36/65] pxar: show padding in debug output on archive list Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 37/65] datastore: dynamic index: add method to get digest Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 38/65] client: pxar: helper for lookup of reusable dynamic entries Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 39/65] upload stream: implement reused chunk injector Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 40/65] client: chunk stream: add struct to hold injection state Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 41/65] chunker: add method to reset chunker state Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 42/65] client: streams: add channels for dynamic entry injection Christian Ebner
2024-05-22 9:56 ` Dominik Csapak
2024-05-24 6:57 ` Christian Ebner
2024-05-14 10:33 ` [pbs-devel] [PATCH v6 proxmox-backup 43/65] specs: add backup detection mode specification Christian Ebner
2024-05-22 13:07 ` Dominik Csapak
2024-05-24 6:59 ` Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 44/65] client: implement prepare reference method Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 45/65] client: pxar: add method for metadata comparison Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 46/65] pxar: caching: add look-ahead cache types Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 47/65] fix #3174: client: pxar: enable caching and meta comparison Christian Ebner
2024-05-22 14:45 ` Dominik Csapak
2024-05-24 8:50 ` Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 48/65] client: backup writer: add injected chunk count to stats Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 49/65] pxar: create: keep track of reused chunks and files Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 50/65] pxar: create: show chunk injection stats debug output Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 51/65] client: pxar: add helper to handle optional preludes Christian Ebner
2024-05-23 8:47 ` Dominik Csapak
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 52/65] client: pxar: opt encode cli exclude patterns as Prelude Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 53/65] docs: file formats: describe split pxar archive file layout Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 54/65] docs: add section describing change detection mode Christian Ebner
2024-05-23 9:28 ` Dominik Csapak
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 55/65] test-suite: add detection mode change benchmark Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 56/65] test-suite: add bin to deb, add shell completions Christian Ebner
2024-05-23 9:32 ` Dominik Csapak
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 57/65] datastore: chunker: add Chunker trait Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 58/65] datastore: chunker: implement chunker for payload stream Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 59/65] client: chunk stream: switch payload stream chunker Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 60/65] client: pxar: allow to restore prelude to optional path Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 61/65] client: pxar: add archive creation with reference test Christian Ebner
2024-05-23 10:04 ` Dominik Csapak
2024-05-23 10:17 ` Christian Ebner
2024-05-23 10:17 ` Dominik Csapak
2024-05-27 11:05 ` Christian Ebner
2024-05-27 11:17 ` Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 62/65] client: tools: add helper to raise nofile rlimit Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 63/65] client: pxar: set cache limit based on " Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 64/65] chunker: tests: add regression tests for payload chunker Christian Ebner
2024-05-21 11:23 ` Dominik Csapak
2024-05-21 11:27 ` Christian Ebner
2024-05-14 10:34 ` [pbs-devel] [PATCH v6 proxmox-backup 65/65] chunk stream: " Christian Ebner
2024-05-21 11:21 ` Dominik Csapak
2024-05-14 10:45 ` [pbs-devel] [PATCH v5 pxar proxmox-backup 00/62] fix #3174: improve file-level backup Christian Ebner
2024-05-27 14:35 ` Christian Ebner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=e72260e6-ee73-4278-8a39-e00227491c09@proxmox.com \
--to=d.csapak@proxmox.com \
--cc=c.ebner@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox