From: Christian Ebner <c.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH v4 pxar 01/58] format/examples: add header type `PXAR_PAYLOAD_REF`
Date: Mon, 29 Apr 2024 14:10:05 +0200 [thread overview]
Message-ID: <20240429121102.315059-2-c.ebner@proxmox.com> (raw)
In-Reply-To: <20240429121102.315059-1-c.ebner@proxmox.com>
Introduces the header type `PXAR_PAYLOAD_REF` to mark regular file
entry payloads, not encoded within the regular pxar archive but
rather redirected to a dedicated payload output writer.
It therefore substitutes the `PXAR_PAYLOAD` header type for these
entries.
The header marks the start and size for a `PayloadRef` typed object
in the archive, storing the offset to the payload header offset in the
payload stream of the dedicated payload output as well as the payload
size.
The `PayloadRef` provides the means to store, serialize and
deserialize the entry.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
examples/mk-format-hashes.rs | 5 +++++
src/format/mod.rs | 20 ++++++++++++++++++++
2 files changed, 25 insertions(+)
diff --git a/examples/mk-format-hashes.rs b/examples/mk-format-hashes.rs
index 6e00654..83adb38 100644
--- a/examples/mk-format-hashes.rs
+++ b/examples/mk-format-hashes.rs
@@ -41,6 +41,11 @@ const CONSTANTS: &[(&str, &str, &str)] = &[
"PXAR_PAYLOAD",
"__PROXMOX_FORMAT_PXAR_PAYLOAD__",
),
+ (
+ "Marks the beginning of a payload reference for regular files",
+ "PXAR_PAYLOAD_REF",
+ "__PROXMOX_FORMAT_PXAR_PAYLOAD_REF__",
+ ),
(
"Marks item as entry of goodbye table",
"PXAR_GOODBYE",
diff --git a/src/format/mod.rs b/src/format/mod.rs
index bfea9f6..5d7a652 100644
--- a/src/format/mod.rs
+++ b/src/format/mod.rs
@@ -22,6 +22,7 @@
//! * `FCAPS` -- file capability in Linux disk format
//! * `QUOTA_PROJECT_ID` -- the ext4/xfs quota project ID
//! * `PAYLOAD` -- file contents, if it is one
+//! * `PAYLOAD_REF` -- reference to file offset in optional payload file (introduced in v2)
//! * `SYMLINK` -- symlink target, if it is one
//! * `DEVICE` -- device major/minor, if it is a block/char device
//!
@@ -99,6 +100,8 @@ pub const PXAR_QUOTA_PROJID: u64 = 0xe07540e82f7d1cbb;
pub const PXAR_HARDLINK: u64 = 0x51269c8422bd7275;
/// Marks the beginning of the payload (actual content) of regular files
pub const PXAR_PAYLOAD: u64 = 0x28147a1b0b7c1a25;
+/// Marks the beginning of a payload reference for regular files
+pub const PXAR_PAYLOAD_REF: u64 = 0x419d3d6bc4ba977e;
/// Marks item as entry of goodbye table
pub const PXAR_GOODBYE: u64 = 0x2fec4fa642d5731d;
/// The end marker used in the GOODBYE object
@@ -152,6 +155,7 @@ impl Header {
PXAR_QUOTA_PROJID => size_of::<QuotaProjectId>() as u64,
PXAR_ENTRY => size_of::<Stat>() as u64,
PXAR_PAYLOAD | PXAR_GOODBYE => u64::MAX - (size_of::<Self>() as u64),
+ PXAR_PAYLOAD_REF => size_of::<PayloadRef>() as u64,
_ => u64::MAX - (size_of::<Self>() as u64),
}
}
@@ -192,6 +196,7 @@ impl Display for Header {
PXAR_QUOTA_PROJID => "QUOTA_PROJID",
PXAR_ENTRY => "ENTRY",
PXAR_PAYLOAD => "PAYLOAD",
+ PXAR_PAYLOAD_REF => "PAYLOAD_REF",
PXAR_GOODBYE => "GOODBYE",
_ => "UNKNOWN",
};
@@ -723,6 +728,21 @@ impl GoodbyeItem {
}
}
+/// References a regular file payload found in a separated payload archive
+#[derive(Clone, Debug, Endian)]
+pub struct PayloadRef {
+ pub offset: u64,
+ pub size: u64,
+}
+
+impl PayloadRef {
+ pub(crate) fn data(&self) -> Vec<u8> {
+ let mut data = self.offset.to_le_bytes().to_vec();
+ data.append(&mut self.size.to_le_bytes().to_vec());
+ data
+ }
+}
+
/// Hash a file name for use in the goodbye table.
pub fn hash_filename(name: &[u8]) -> u64 {
use std::hash::Hasher;
--
2.39.2
_______________________________________________
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-04-29 12:11 UTC|newest]
Thread overview: 60+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-29 12:10 [pbs-devel] [PATCH v4 pxar proxmox-backup 00/58] fix #3174: improve file-level backup Christian Ebner
2024-04-29 12:10 ` Christian Ebner [this message]
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 02/58] decoder: add method to read payload references Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 03/58] decoder: factor out skip part from skip_entry Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 04/58] encoder: add optional output writer for file payloads Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 05/58] encoder: move to stack based state tracking Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 06/58] decoder/accessor: add optional payload input stream Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 07/58] decoder: set payload input range when decoding via accessor Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 08/58] encoder: add payload reference capability Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 09/58] encoder: add payload position capability Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 10/58] encoder: add payload advance capability Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 11/58] encoder/format: finish payload stream with marker Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 12/58] format: add payload stream start marker Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 13/58] format/encoder/decoder: new pxar entry type `Version` Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 pxar 14/58] format/encoder/decoder: new pxar entry type `Prelude` Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 15/58] client: pxar: switch to stack based encoder state Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 16/58] client: backup: factor out extension from backup target Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 17/58] client: pxar: combine writers into struct Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 18/58] client: pxar: add optional pxar payload writer instance Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 19/58] client: pxar: optionally split metadata and payload streams Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 20/58] client: helper: add helpers for creating reader instances Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 21/58] client: helper: add method for split archive name mapping Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 22/58] client: restore: read payload from dedicated index Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 23/58] tools: cover extension for split pxar archives Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 24/58] restore: " Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 25/58] client: mount: make split pxar archives mountable Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 26/58] api: datastore: refactor getting local chunk reader Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 27/58] api: datastore: attach optional payload " Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 28/58] catalog: shell: make split pxar archives accessible Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 29/58] www: cover metadata extension for pxar archives Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 30/58] file restore: factor out getting pxar reader Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 31/58] file restore: cover split metadata and payload archives Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 32/58] file restore: show more error context when extraction fails Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 33/58] pxar: add optional payload input for achive restore Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 34/58] pxar: add more context to extraction error Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 35/58] client: pxar: include payload offset in entry listing Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 36/58] pxar: show padding in debug output on archive list Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 37/58] datastore: dynamic index: add method to get digest Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 38/58] client: pxar: helper for lookup of reusable dynamic entries Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 39/58] upload stream: implement reused chunk injector Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 40/58] client: chunk stream: add struct to hold injection state Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 41/58] client: streams: add channels for dynamic entry injection Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 42/58] specs: add backup detection mode specification Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 43/58] client: implement prepare reference method Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 44/58] client: pxar: add method for metadata comparison Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 45/58] pxar: caching: add look-ahead cache types Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 46/58] fix #3174: client: pxar: enable caching and meta comparison Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 47/58] client: backup writer: add injected chunk count to stats Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 48/58] pxar: create: keep track of reused chunks and files Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 49/58] pxar: create: show chunk injection stats debug output Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 50/58] client: pxar: add helper to handle optional preludes Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 51/58] client: pxar: opt encode cli exclude patterns as Prelude Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 52/58] docs: file formats: describe split pxar archive file layout Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 53/58] docs: add section describing change detection mode Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 54/58] test-suite: add detection mode change benchmark Christian Ebner
2024-04-29 12:10 ` [pbs-devel] [PATCH v4 proxmox-backup 55/58] test-suite: add bin to deb, add shell completions Christian Ebner
2024-04-29 12:11 ` [pbs-devel] [PATCH v4 proxmox-backup 56/58] datastore: chunker: add Chunker trait Christian Ebner
2024-04-29 12:11 ` [pbs-devel] [PATCH v4 proxmox-backup 57/58] datastore: chunker: implement chunker for payload stream Christian Ebner
2024-04-29 12:11 ` [pbs-devel] [PATCH v4 proxmox-backup 58/58] client: chunk stream: switch payload stream chunker Christian Ebner
2024-05-07 16:00 ` [pbs-devel] [PATCH v4 pxar proxmox-backup 00/58] fix #3174: improve file-level backup 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=20240429121102.315059-2-c.ebner@proxmox.com \
--to=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