public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Christian Ebner <c.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH v4 proxmox-backup 42/58] specs: add backup detection mode specification
Date: Mon, 29 Apr 2024 14:10:46 +0200	[thread overview]
Message-ID: <20240429121102.315059-43-c.ebner@proxmox.com> (raw)
In-Reply-To: <20240429121102.315059-1-c.ebner@proxmox.com>

Adds the specification for switching the detection mode used to
identify regular files which changed since a reference backup run.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
 pbs-client/src/backup_specification.rs | 44 ++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/pbs-client/src/backup_specification.rs b/pbs-client/src/backup_specification.rs
index 619a3a9da..b6b0f5199 100644
--- a/pbs-client/src/backup_specification.rs
+++ b/pbs-client/src/backup_specification.rs
@@ -4,6 +4,7 @@ use proxmox_schema::*;
 
 const_regex! {
     BACKUPSPEC_REGEX = r"^([a-zA-Z0-9_-]+\.(pxar|img|conf|log)):(.+)$";
+    DETECTION_MODE_REGEX = r"^(default|data|metadata)$";
 }
 
 pub const BACKUP_SOURCE_SCHEMA: Schema =
@@ -11,6 +12,11 @@ pub const BACKUP_SOURCE_SCHEMA: Schema =
         .format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX))
         .schema();
 
+pub const BACKUP_DETECTION_MODE_SPEC: Schema =
+    StringSchema::new("Backup detection mode specification (default|data|metadata).")
+        .format(&ApiStringFormat::Pattern(&DETECTION_MODE_REGEX))
+        .schema();
+
 pub enum BackupSpecificationType {
     PXAR,
     IMAGE,
@@ -45,3 +51,41 @@ pub fn parse_backup_specification(value: &str) -> Result<BackupSpecification, Er
 
     bail!("unable to parse backup source specification '{}'", value);
 }
+
+/// Mode to detect file changes since last backup run
+pub enum BackupDetectionMode {
+    /// Encode backup as self contained pxar archive
+    Default,
+    /// Split backup mode, re-encode payload data
+    Data,
+    /// Compare metadata, reuse payload chunks if metadata unchanged
+    Metadata,
+}
+
+impl BackupDetectionMode {
+    /// Selected mode is data based file change detection with split meta/payload streams
+    pub fn is_data(&self) -> bool {
+        matches!(self, Self::Data)
+    }
+    /// Selected mode is metadata based file change detection
+    pub fn is_metadata(&self) -> bool {
+        matches!(self, Self::Metadata)
+    }
+}
+
+pub fn parse_backup_detection_mode_specification(
+    value: &str,
+) -> Result<BackupDetectionMode, Error> {
+    match (DETECTION_MODE_REGEX.regex_obj)().captures(value) {
+        Some(caps) => {
+            let mode = match caps.get(1).unwrap().as_str() {
+                "default" => BackupDetectionMode::Default,
+                "data" => BackupDetectionMode::Data,
+                "metadata" => BackupDetectionMode::Metadata,
+                _ => bail!("invalid backup detection mode"),
+            };
+            Ok(mode)
+        }
+        None => bail!("unable to parse backup detection mode specification '{value}'"),
+    }
+}
-- 
2.39.2



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


  parent reply	other threads:[~2024-04-29 12:12 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 ` [pbs-devel] [PATCH v4 pxar 01/58] format/examples: add header type `PXAR_PAYLOAD_REF` Christian Ebner
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 ` Christian Ebner [this message]
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-43-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
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal