From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id A3B409763D for ; Tue, 5 Mar 2024 10:28:24 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 2882B3F6E for ; Tue, 5 Mar 2024 10:27:49 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Tue, 5 Mar 2024 10:27:45 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 181DB487D8 for ; Tue, 5 Mar 2024 10:27:45 +0100 (CET) From: Christian Ebner To: pbs-devel@lists.proxmox.com Date: Tue, 5 Mar 2024 10:26:34 +0100 Message-Id: <20240305092703.126906-8-c.ebner@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240305092703.126906-1-c.ebner@proxmox.com> References: <20240305092703.126906-1-c.ebner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.044 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pbs-devel] [RFC v2 pxar 07/36] encoder: add payload reference capability X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 05 Mar 2024 09:28:24 -0000 Allows to encode regular files with a payload reference within a separate payload archive rather than encoding the payload within the regular archive. Following the PXAR_PAYLOAD_REF marked header, the payload offset and size are encoded. Signed-off-by: Christian Ebner --- changes since version 1: - get rid of unused sub method impl for PayloadOffset src/encoder/aio.rs | 15 ++++++++++++++- src/encoder/mod.rs | 43 +++++++++++++++++++++++++++++++++++++++++++ src/encoder/sync.rs | 18 +++++++++++++++++- 3 files changed, 74 insertions(+), 2 deletions(-) diff --git a/src/encoder/aio.rs b/src/encoder/aio.rs index 60b11cd..87d75ef 100644 --- a/src/encoder/aio.rs +++ b/src/encoder/aio.rs @@ -5,7 +5,7 @@ use std::path::Path; use std::pin::Pin; use std::task::{Context, Poll}; -use crate::encoder::{self, LinkOffset, SeqWrite}; +use crate::encoder::{self, LinkOffset, PayloadOffset, SeqWrite}; use crate::format; use crate::Metadata; @@ -98,6 +98,19 @@ impl<'a, T: SeqWrite + 'a> Encoder<'a, T> { // content.as_async_reader(), // ).await // } + // + /// Encode a payload reference, returning the payload offset within the payload stream + pub async fn add_payload_ref( + &mut self, + metadata: &Metadata, + file_name: &Path, + file_size: u64, + payload_offset: PayloadOffset, + ) -> io::Result<()> { + self.inner + .add_payload_ref(metadata, file_name.as_ref(), file_size, payload_offset) + .await + } /// Create a new subdirectory. Note that the subdirectory has to be finished by calling the /// `finish()` method, otherwise the entire archive will be in an error state. diff --git a/src/encoder/mod.rs b/src/encoder/mod.rs index 962087a..1baa221 100644 --- a/src/encoder/mod.rs +++ b/src/encoder/mod.rs @@ -38,6 +38,24 @@ impl LinkOffset { } } +/// File reference used to create payload references. +#[derive(Clone, Copy, Debug, Default, Eq, PartialEq, Ord, PartialOrd)] +pub struct PayloadOffset(u64); + +impl PayloadOffset { + /// Get the raw byte offset of this link. + #[inline] + pub fn raw(self) -> u64 { + self.0 + } + + /// Return a new PayloadOffset, positively shifted by offset + #[inline] + pub fn add(&self, offset: u64) -> Self { + Self(self.0 + offset) + } +} + /// Sequential write interface used by the encoder's state machine. /// /// This is our internal writer trait which is available for `std::io::Write` types in the @@ -472,6 +490,31 @@ impl<'a, T: SeqWrite + 'a> EncoderImpl<'a, T> { Ok(offset) } + /// Encode a payload reference, returning the payload offset within the payload stream + pub async fn add_payload_ref( + &mut self, + metadata: &Metadata, + file_name: &Path, + file_size: u64, + payload_offset: PayloadOffset, + ) -> io::Result<()> { + if self.payload_output.as_mut().is_none() { + io_bail!("unable to add payload reference"); + } + + let mut payload_ref = payload_offset.raw().to_le_bytes().to_vec(); + payload_ref.append(&mut file_size.to_le_bytes().to_vec()); + let _this_offset: LinkOffset = self + .add_file_entry( + Some(metadata), + file_name, + Some((format::PXAR_PAYLOAD_REF, &payload_ref)), + ) + .await?; + + Ok(()) + } + /// Return a file offset usable with `add_hardlink`. pub async fn add_symlink( &mut self, diff --git a/src/encoder/sync.rs b/src/encoder/sync.rs index a7c350e..90af8f9 100644 --- a/src/encoder/sync.rs +++ b/src/encoder/sync.rs @@ -6,7 +6,7 @@ use std::pin::Pin; use std::task::{Context, Poll}; use crate::decoder::sync::StandardReader; -use crate::encoder::{self, LinkOffset, SeqWrite}; +use crate::encoder::{self, LinkOffset, PayloadOffset, SeqWrite}; use crate::format; use crate::util::poll_result_once; use crate::Metadata; @@ -100,6 +100,22 @@ impl<'a, T: SeqWrite + 'a> Encoder<'a, T> { )) } + /// Encode a payload reference, returning the payload offset within the payload stream + pub async fn add_payload_ref( + &mut self, + metadata: &Metadata, + file_name: &Path, + file_size: u64, + payload_offset: PayloadOffset, + ) -> io::Result<()> { + poll_result_once(self.inner.add_payload_ref( + metadata, + file_name.as_ref(), + file_size, + payload_offset, + )) + } + /// Create a new subdirectory. Note that the subdirectory has to be finished by calling the /// `finish()` method, otherwise the entire archive will be in an error state. pub fn create_directory>( -- 2.39.2