From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [45.144.208.40]) by lore.proxmox.com (Postfix) with ESMTPS id F39891FF0AF for ; Fri, 20 Nov 2026 17:06:27 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id F02952178E; Fri, 20 Nov 2026 17:06:20 +0100 (CET) From: Jakob Klocker To: pve-devel@lists.proxmox.com Subject: [PATCH pve-storage v4 3/7] backup provider api: document repeated backup_init() calls on retries Date: Fri, 20 Nov 2026 17:05:06 +0100 Message-ID: <20261120160510.311796-4-j.klocker@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20261120160510.311796-1-j.klocker@proxmox.com> References: <20261120160510.311796-1-j.klocker@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1795190776519 X-SPAM-LEVEL: Spam detection results: 0 AWL 1.151 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: VLMWEL7OBJBSRVKHZBCOWZXVDUSJJCON X-Message-ID-Hash: VLMWEL7OBJBSRVKHZBCOWZXVDUSJJCON X-MailFrom: j.klocker@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: vzdump can retry failed guest backups within the same job, depending on the new 'error-behavior' option. As a result, backup_init() and backup_cleanup() can be called multiple times for the same guest on the same provider instance. Document that providers must not carry over per-guest state from a failed attempt. Signed-off-by: Jakob Klocker --- src/PVE/BackupProvider/Plugin/Base.pm | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/PVE/BackupProvider/Plugin/Base.pm b/src/PVE/BackupProvider/Plugin/Base.pm index 9358fc6..c693db0 100644 --- a/src/PVE/BackupProvider/Plugin/Base.pm +++ b/src/PVE/BackupProvider/Plugin/Base.pm @@ -48,6 +48,11 @@ backup_container_prepare() call while still privileged. The actual backup_container() call happens as the (unprivileged) container root user, so that the file owner and group IDs match the container's perspective. +If the backup of a guest fails, the job may retry it later, depending on the +C backup option. Each attempt goes through its own +backup_init() to backup_cleanup() cycle on the same backup provider instance, +so these methods can be called more than once for the same guest within a job. + =head3 1.1 Backup Mechanisms VM: @@ -254,6 +259,13 @@ C and colon C<:>. Use C<$self> to remember it for the C or C method that will be called later. +If a previous attempt for the same guest failed and the job retries it, +C is called again for that guest within the same job, after +C was called with C<$success> being false. Each call starts a +new attempt, so do not carry over per-guest state from an earlier attempt. For +example, reset what was remembered in C<$self> for this guest, and do not base +an incremental backup on data of the failed attempt. + Parameters: =over -- 2.47.3