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 proxmox-backup v4 41/45] api: backup: add no-cache flag to bypass local datastore cache
Date: Mon, 23 Jun 2025 11:41:02 +0200	[thread overview]
Message-ID: <20250623094106.299251-45-c.ebner@proxmox.com> (raw)
In-Reply-To: <20250623094106.299251-1-c.ebner@proxmox.com>

Adds the `no-cache` flag so the client can request to bypass the
local datastore cache for chunk uploads. This is mainly intended for
debugging and benchmarking, but can be used in cases the caching is
known to be ineffective (no possible deduplication).

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
 examples/upload-speed.rs               |  1 +
 pbs-client/src/backup_writer.rs        |  4 +++-
 proxmox-backup-client/src/benchmark.rs |  1 +
 proxmox-backup-client/src/main.rs      |  8 ++++++++
 src/api2/backup/environment.rs         |  3 +++
 src/api2/backup/mod.rs                 |  3 +++
 src/api2/backup/upload_chunk.rs        | 11 +++++++++++
 src/server/push.rs                     |  1 +
 8 files changed, 31 insertions(+), 1 deletion(-)

diff --git a/examples/upload-speed.rs b/examples/upload-speed.rs
index e4b570ec5..8a6594a47 100644
--- a/examples/upload-speed.rs
+++ b/examples/upload-speed.rs
@@ -25,6 +25,7 @@ async fn upload_speed() -> Result<f64, Error> {
         &(BackupType::Host, "speedtest".to_string(), backup_time).into(),
         false,
         true,
+        false,
     )
     .await?;
 
diff --git a/pbs-client/src/backup_writer.rs b/pbs-client/src/backup_writer.rs
index 1253ef561..ce5bd9375 100644
--- a/pbs-client/src/backup_writer.rs
+++ b/pbs-client/src/backup_writer.rs
@@ -82,6 +82,7 @@ impl BackupWriter {
         backup: &BackupDir,
         debug: bool,
         benchmark: bool,
+        no_cache: bool,
     ) -> Result<Arc<BackupWriter>, Error> {
         let mut param = json!({
             "backup-type": backup.ty(),
@@ -89,7 +90,8 @@ impl BackupWriter {
             "backup-time": backup.time,
             "store": datastore,
             "debug": debug,
-            "benchmark": benchmark
+            "benchmark": benchmark,
+            "no-cache": no_cache,
         });
 
         if !ns.is_root() {
diff --git a/proxmox-backup-client/src/benchmark.rs b/proxmox-backup-client/src/benchmark.rs
index a6f24d745..ed21c7a91 100644
--- a/proxmox-backup-client/src/benchmark.rs
+++ b/proxmox-backup-client/src/benchmark.rs
@@ -236,6 +236,7 @@ async fn test_upload_speed(
         &(BackupType::Host, "benchmark".to_string(), backup_time).into(),
         false,
         true,
+        true,
     )
     .await?;
 
diff --git a/proxmox-backup-client/src/main.rs b/proxmox-backup-client/src/main.rs
index 44f4f5db5..83fc9309a 100644
--- a/proxmox-backup-client/src/main.rs
+++ b/proxmox-backup-client/src/main.rs
@@ -742,6 +742,12 @@ fn spawn_catalog_upload(
                 optional: true,
                 default: false,
             },
+            "no-cache": {
+                type: Boolean,
+                description: "Bypass local datastore cache for network storages.",
+                optional: true,
+                default: false,
+            },
         }
     }
  )]
@@ -754,6 +760,7 @@ async fn create_backup(
     change_detection_mode: Option<BackupDetectionMode>,
     dry_run: bool,
     skip_e2big_xattr: bool,
+    no_cache: bool,
     limit: ClientRateLimitConfig,
     _info: &ApiMethod,
     _rpcenv: &mut dyn RpcEnvironment,
@@ -960,6 +967,7 @@ async fn create_backup(
         &snapshot,
         true,
         false,
+        no_cache,
     )
     .await?;
 
diff --git a/src/api2/backup/environment.rs b/src/api2/backup/environment.rs
index 7842444a9..802e35fd6 100644
--- a/src/api2/backup/environment.rs
+++ b/src/api2/backup/environment.rs
@@ -113,6 +113,7 @@ pub struct BackupEnvironment {
     result_attributes: Value,
     auth_id: Authid,
     pub debug: bool,
+    pub no_cache: bool,
     pub formatter: &'static dyn OutputFormatter,
     pub worker: Arc<WorkerTask>,
     pub datastore: Arc<DataStore>,
@@ -129,6 +130,7 @@ impl BackupEnvironment {
         worker: Arc<WorkerTask>,
         datastore: Arc<DataStore>,
         backup_dir: BackupDir,
+        no_cache: bool,
     ) -> Result<Self, Error> {
         let state = SharedBackupState {
             finished: false,
@@ -149,6 +151,7 @@ impl BackupEnvironment {
             worker,
             datastore,
             debug: tracing::enabled!(tracing::Level::DEBUG),
+            no_cache,
             formatter: JSON_FORMATTER,
             backup_dir,
             last_backup: None,
diff --git a/src/api2/backup/mod.rs b/src/api2/backup/mod.rs
index 026f1f106..ae61ff697 100644
--- a/src/api2/backup/mod.rs
+++ b/src/api2/backup/mod.rs
@@ -53,6 +53,7 @@ pub const API_METHOD_UPGRADE_BACKUP: ApiMethod = ApiMethod::new(
             ("backup-time", false, &BACKUP_TIME_SCHEMA),
             ("debug", true, &BooleanSchema::new("Enable verbose debug logging.").schema()),
             ("benchmark", true, &BooleanSchema::new("Job is a benchmark (do not keep data).").schema()),
+            ("no-cache", true, &BooleanSchema::new("Disable local datastore cache for network storages").schema()),
         ]),
     )
 ).access(
@@ -79,6 +80,7 @@ fn upgrade_to_backup_protocol(
     async move {
         let debug = param["debug"].as_bool().unwrap_or(false);
         let benchmark = param["benchmark"].as_bool().unwrap_or(false);
+        let no_cache = param["no-cache"].as_bool().unwrap_or(false);
 
         let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
 
@@ -214,6 +216,7 @@ fn upgrade_to_backup_protocol(
                     worker.clone(),
                     datastore,
                     backup_dir,
+                    no_cache,
                 )?;
 
                 env.debug = debug;
diff --git a/src/api2/backup/upload_chunk.rs b/src/api2/backup/upload_chunk.rs
index 5a5ed386a..316cc82c0 100644
--- a/src/api2/backup/upload_chunk.rs
+++ b/src/api2/backup/upload_chunk.rs
@@ -259,6 +259,17 @@ async fn upload_to_backend(
             let data = req_body.collect().await?.to_bytes();
             let upload_body = Body::from(data.clone());
 
+            if env.no_cache {
+                let is_duplicate = match s3_client.put_object(digest.into(), upload_body).await? {
+                    PutObjectResponse::PreconditionFailed => true,
+                    PutObjectResponse::NeedsRetry => {
+                        bail!("concurrent operation, reupload required")
+                    }
+                    PutObjectResponse::Success(_content) => false,
+                };
+                return Ok((digest, size, encoded_size, is_duplicate));
+            }
+
             if encoded_size != data.len() as u32 {
                 bail!(
                     "got blob with unexpected length ({encoded_size} != {})",
diff --git a/src/server/push.rs b/src/server/push.rs
index e71012ed8..6a31d2abe 100644
--- a/src/server/push.rs
+++ b/src/server/push.rs
@@ -828,6 +828,7 @@ pub(crate) async fn push_snapshot(
         snapshot,
         false,
         false,
+        false,
     )
     .await?;
 
-- 
2.47.2



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


  parent reply	other threads:[~2025-06-23  9:49 UTC|newest]

Thread overview: 53+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-23  9:40 [pbs-devel] [PATCH proxmox{, -backup} v4 00/48] fix #2943: S3 storage backend for datastores Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox v4 1/3] pbs-api-types: add types for S3 client configs and secrets Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox v4 2/3] pbs-api-types: extend datastore config by backend config enum Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox v4 3/3] pbs-api-types: maintenance: add new maintenance mode S3 refresh Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 01/45] api: fix minor formatting issues Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 02/45] bin: sort submodules alphabetically Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 03/45] datastore: ignore missing owner file when removing group directory Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 04/45] verify: refactor verify related functions to be methods of worker Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 05/45] s3 client: add crate for AWS s3 compatible object store client Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 06/45] s3 client: implement AWS signature v4 request authentication Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 07/45] s3 client: add dedicated type for s3 object keys Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 08/45] s3 client: add type for last modified timestamp in responses Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 09/45] s3 client: add helper to parse http date headers Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 10/45] s3 client: implement methods to operate on s3 objects in bucket Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 11/45] config: introduce s3 object store client configuration Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 12/45] api: config: implement endpoints to manipulate and list s3 configs Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 13/45] api: datastore: check s3 backend bucket access on datastore create Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 14/45] api/cli: add endpoint and command to check s3 client connection Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 15/45] datastore: allow to get the backend for a datastore Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 16/45] api: backup: store datastore backend in runtime environment Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 17/45] api: backup: conditionally upload chunks to s3 object store backend Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 18/45] api: backup: conditionally upload blobs " Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 19/45] api: backup: conditionally upload indices " Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 20/45] api: backup: conditionally upload manifest " Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 21/45] sync: pull: conditionally upload content to s3 backend Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 22/45] api: reader: fetch chunks based on datastore backend Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 23/45] datastore: local chunk reader: read chunks based on backend Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 24/45] verify worker: add datastore backed to verify worker Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 25/45] verify: implement chunk verification for stores with s3 backend Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 26/45] datastore: create namespace marker in S3 backend Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 27/45] datastore: create/delete protected marker file on s3 storage backend Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 28/45] datastore: prune groups/snapshots from s3 object store backend Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 29/45] datastore: get and set owner for S3 " Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 30/45] datastore: implement garbage collection for s3 backend Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 31/45] ui: add datastore type selector and reorganize component layout Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 32/45] ui: add S3 client edit window for configuration create/edit Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 33/45] ui: add S3 client view for configuration Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 34/45] ui: expose the S3 client view in the navigation tree Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 35/45] ui: add s3 client selector and bucket field for s3 backend setup Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 36/45] tools: lru cache: add removed callback for evicted cache nodes Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 37/45] tools: async lru cache: implement insert, remove and contains methods Christian Ebner
2025-06-23  9:40 ` [pbs-devel] [PATCH proxmox-backup v4 38/45] datastore: add local datastore cache for network attached storages Christian Ebner
2025-06-23  9:41 ` [pbs-devel] [PATCH proxmox-backup v4 39/45] api: backup: use local datastore cache on s3 backend chunk upload Christian Ebner
2025-06-23  9:41 ` [pbs-devel] [PATCH proxmox-backup v4 40/45] api: reader: use local datastore cache on s3 backend chunk fetching Christian Ebner
2025-06-23  9:41 ` Christian Ebner [this message]
2025-06-23  9:41 ` [pbs-devel] [PATCH proxmox-backup v4 42/45] api/datastore: implement refresh endpoint for stores with s3 backend Christian Ebner
2025-06-23  9:41 ` [pbs-devel] [PATCH proxmox-backup v4 43/45] cli: add dedicated subcommand for datastore s3 refresh Christian Ebner
2025-06-23  9:41 ` [pbs-devel] [PATCH proxmox-backup v4 44/45] ui: render s3 refresh as valid maintenance type and task description Christian Ebner
2025-06-23  9:41 ` [pbs-devel] [PATCH proxmox-backup v4 45/45] ui: expose s3 refresh button for datastores backed by object store Christian Ebner
2025-06-30  9:21 ` [pbs-devel] [PATCH proxmox{, -backup} v4 00/48] fix #2943: S3 storage backend for datastores Christian Ebner
2025-07-01 14:30 ` Hannes Duerr
2025-07-01 14:53   ` Christian Ebner
2025-07-03 13:20 ` [pbs-devel] superseded: " 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=20250623094106.299251-45-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