From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 4FD251FF3A8 for ; Tue, 28 May 2024 11:43:17 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 41A1F11FBC; Tue, 28 May 2024 11:43:31 +0200 (CEST) From: Christian Ebner To: pbs-devel@lists.proxmox.com Date: Tue, 28 May 2024 11:42:03 +0200 Message-Id: <20240528094303.309806-10-c.ebner@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240528094303.309806-1-c.ebner@proxmox.com> References: <20240528094303.309806-1-c.ebner@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.029 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] [PATCH v8 pxar 09/69] 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: , Reply-To: Proxmox Backup Server development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" 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 7: - no changes changes since version 6: - no changes src/encoder/aio.rs | 18 ++++++++++++++- src/encoder/mod.rs | 54 +++++++++++++++++++++++++++++++++++++++++++++ src/encoder/sync.rs | 21 +++++++++++++++++- 3 files changed, 91 insertions(+), 2 deletions(-) diff --git a/src/encoder/aio.rs b/src/encoder/aio.rs index 610fce5..23b2bbf 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, PxarVariant}; @@ -95,6 +95,22 @@ impl<'a, T: SeqWrite + 'a> Encoder<'a, T> { // ).await // } + /// Encode a payload reference pointing to given offset in the separate payload output + /// + /// Returns with error if the encoder instance has no separate payload output or encoding + /// failed. + 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. pub async fn create_directory>( diff --git a/src/encoder/mod.rs b/src/encoder/mod.rs index fbd90fe..31933fc 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 @@ -506,6 +524,42 @@ impl<'a, T: SeqWrite + 'a> EncoderImpl<'a, T> { Ok(offset) } + /// Encode a payload reference pointing to given offset in the separate payload output + /// + /// Returns a file offset usable with `add_hardlink` or with error if the encoder instance has + /// no separate payload output or encoding failed. + pub async fn add_payload_ref( + &mut self, + metadata: &Metadata, + file_name: &Path, + file_size: u64, + payload_offset: PayloadOffset, + ) -> io::Result { + if self.output.payload().is_none() { + io_bail!("unable to add payload reference"); + } + + let offset = payload_offset.raw(); + let payload_position = self.state()?.payload_position(); + if offset < payload_position { + io_bail!("offset smaller than current position: {offset} < {payload_position}"); + } + + let payload_ref = PayloadRef { + offset, + size: file_size, + }; + let this_offset: LinkOffset = self + .add_file_entry( + Some(metadata), + file_name, + Some((format::PXAR_PAYLOAD_REF, &payload_ref.data())), + ) + .await?; + + Ok(this_offset) + } + /// 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 9d39658..62bb5e1 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, PxarVariant}; @@ -102,6 +102,25 @@ impl<'a, T: SeqWrite + 'a> Encoder<'a, T> { )) } + /// Encode a payload reference pointing to given offset in the separate payload output + /// + /// Returns with error if the encoder instance has no separate payload output or encoding + /// failed. + 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 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel