From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 2E4FFCF29 for ; Wed, 13 Apr 2022 11:12:29 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 1800E20781 for ; Wed, 13 Apr 2022 11:11:59 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id F328920760 for ; Wed, 13 Apr 2022 11:11:56 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id CC5B3414B1 for ; Wed, 13 Apr 2022 11:11:56 +0200 (CEST) From: Stefan Sterz To: pbs-devel@lists.proxmox.com Date: Wed, 13 Apr 2022 11:11:48 +0200 Message-Id: <20220413091151.150019-2-s.sterz@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220413091151.150019-1-s.sterz@proxmox.com> References: <20220413091151.150019-1-s.sterz@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.022 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% 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 proxmox-backup v2 1/4] fix #3935: datastore/api/backup: add locking helpers to datastore 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: , X-List-Received-Date: Wed, 13 Apr 2022 09:12:29 -0000 to avoid duplicate code, add helpers for locking groups and snapshots to the datastore trait and refactor existing code to use them. Signed-off-by: Stefan Sterz --- pbs-datastore/src/datastore.rs | 58 ++++++++++++++++++++-------- pbs-datastore/src/snapshot_reader.rs | 12 +----- src/api2/backup/mod.rs | 4 +- src/api2/reader/mod.rs | 7 +--- src/backup/verify.rs | 8 +--- 5 files changed, 48 insertions(+), 41 deletions(-) diff --git a/pbs-datastore/src/datastore.rs b/pbs-datastore/src/datastore.rs index d062d1cf..3895688d 100644 --- a/pbs-datastore/src/datastore.rs +++ b/pbs-datastore/src/datastore.rs @@ -11,11 +11,13 @@ use lazy_static::lazy_static; use proxmox_schema::ApiType; -use proxmox_sys::fs::{replace_file, file_read_optional_string, CreateOptions}; +use proxmox_sys::fs::{ + file_read_optional_string, lock_dir_noblock, lock_dir_noblock_shared, replace_file, + CreateOptions, DirLockGuard, +}; use proxmox_sys::process_locker::ProcessLockSharedGuard; use proxmox_sys::WorkerTaskContext; use proxmox_sys::{task_log, task_warn}; -use proxmox_sys::fs::{lock_dir_noblock, DirLockGuard}; use pbs_api_types::{ UPID, DataStoreConfig, Authid, GarbageCollectionStatus, HumanByte, @@ -340,11 +342,9 @@ impl DataStore { /// Remove a complete backup group including all snapshots, returns true /// if all snapshots were removed, and false if some were protected pub fn remove_backup_group(&self, backup_group: &BackupGroup) -> Result { - + let _guard = self.lock_group(backup_group)?; let full_path = self.group_path(backup_group); - let _guard = proxmox_sys::fs::lock_dir_noblock(&full_path, "backup group", "possible running backup")?; - log::info!("removing backup group {:?}", full_path); let mut removed_all = true; @@ -374,13 +374,11 @@ impl DataStore { } /// Remove a backup directory including all content - pub fn remove_backup_dir(&self, backup_dir: &BackupDir, force: bool) -> Result<(), Error> { - - let full_path = self.snapshot_path(backup_dir); - + pub fn remove_backup_dir(&self, backup_dir: &BackupDir, force: bool) -> Result<(), Error> { let (_guard, _manifest_guard); + if !force { - _guard = lock_dir_noblock(&full_path, "snapshot", "possibly running or in use")?; + _guard = self.lock_snapshot(backup_dir)?; _manifest_guard = self.lock_manifest(backup_dir)?; } @@ -388,6 +386,8 @@ impl DataStore { bail!("cannot remove protected snapshot"); } + let full_path = self.snapshot_path(backup_dir); + log::info!("removing backup snapshot {:?}", full_path); std::fs::remove_dir_all(&full_path) .map_err(|err| { @@ -490,13 +490,13 @@ impl DataStore { // create the last component now match std::fs::create_dir(&full_path) { Ok(_) => { - let guard = lock_dir_noblock(&full_path, "backup group", "another backup is already running")?; + let guard = self.lock_group(backup_group)?; self.set_owner(backup_group, auth_id, false)?; let owner = self.get_owner(backup_group)?; // just to be sure Ok((owner, guard)) } Err(ref err) if err.kind() == io::ErrorKind::AlreadyExists => { - let guard = lock_dir_noblock(&full_path, "backup group", "another backup is already running")?; + let guard = self.lock_group(backup_group)?; let owner = self.get_owner(backup_group)?; // just to be sure Ok((owner, guard)) } @@ -514,8 +514,7 @@ impl DataStore { let mut full_path = self.base_path(); full_path.push(&relative_path); - let lock = || - lock_dir_noblock(&full_path, "snapshot", "internal error - tried creating snapshot that's already in use"); + let lock = || self.lock_snapshot(backup_dir); match std::fs::create_dir(&full_path) { Ok(_) => Ok((relative_path, true, lock()?)), @@ -935,9 +934,7 @@ impl DataStore { backup_dir: &BackupDir, protection: bool ) -> Result<(), Error> { - let full_path = self.snapshot_path(backup_dir); - - let _guard = lock_dir_noblock(&full_path, "snapshot", "possibly running or in use")?; + let _guard = self.lock_snapshot(backup_dir)?; let protected_path = backup_dir.protected_file(self.base_path()); if protection { @@ -1004,4 +1001,31 @@ impl DataStore { Ok(chunk_list) } + + /// Lock a snapshot exclusively + pub fn lock_snapshot(&self, backup_dir: &BackupDir) -> Result { + lock_dir_noblock( + &self.snapshot_path(backup_dir), + "snapshot", + "possibly running or in use", + ) + } + + /// Acquire a shared lock on a snapshot + pub fn lock_snapshot_shared(&self, backup_dir: &BackupDir) -> Result { + lock_dir_noblock_shared( + &self.snapshot_path(backup_dir), + "snapshot", + "possibly running or in use", + ) + } + + /// Lock a group exclusively + pub fn lock_group(&self, group: &BackupGroup) -> Result { + lock_dir_noblock( + &self.group_path(group), + "backup group", + "possible running backup", + ) + } } diff --git a/pbs-datastore/src/snapshot_reader.rs b/pbs-datastore/src/snapshot_reader.rs index d7df3f23..0eddac14 100644 --- a/pbs-datastore/src/snapshot_reader.rs +++ b/pbs-datastore/src/snapshot_reader.rs @@ -6,8 +6,6 @@ use std::fs::File; use anyhow::{bail, Error}; use nix::dir::Dir; -use proxmox_sys::fs::lock_dir_noblock_shared; - use crate::backup_info::BackupDir; use crate::index::IndexFile; use crate::fixed_index::FixedIndexReader; @@ -30,13 +28,7 @@ impl SnapshotReader { /// Lock snapshot, reads the manifest and returns a new instance pub fn new(datastore: Arc, snapshot: BackupDir) -> Result { - - let snapshot_path = datastore.snapshot_path(&snapshot); - - let locked_dir = lock_dir_noblock_shared( - &snapshot_path, - "snapshot", - "locked by another operation")?; + let locked_dir = datastore.lock_snapshot_shared(&snapshot)?; let datastore_name = datastore.name().to_string(); @@ -48,7 +40,7 @@ impl SnapshotReader { } }; - let mut client_log_path = snapshot_path; + let mut client_log_path = datastore.snapshot_path(&snapshot); client_log_path.push(CLIENT_LOG_BLOB_NAME); let mut file_list = Vec::new(); diff --git a/src/api2/backup/mod.rs b/src/api2/backup/mod.rs index 9d62dc52..075b6a42 100644 --- a/src/api2/backup/mod.rs +++ b/src/api2/backup/mod.rs @@ -20,7 +20,6 @@ use pbs_api_types::{ BACKUP_ID_SCHEMA, BACKUP_TIME_SCHEMA, BACKUP_TYPE_SCHEMA, DATASTORE_SCHEMA, CHUNK_DIGEST_SCHEMA, PRIV_DATASTORE_BACKUP, BACKUP_ARCHIVE_NAME_SCHEMA, }; -use proxmox_sys::fs::lock_dir_noblock_shared; use pbs_tools::json::{required_array_param, required_integer_param, required_string_param}; use pbs_config::CachedUserInfo; use pbs_datastore::{DataStore, PROXMOX_BACKUP_PROTOCOL_ID_V1}; @@ -157,8 +156,7 @@ async move { } // lock last snapshot to prevent forgetting/pruning it during backup - let full_path = datastore.snapshot_path(&last.backup_dir); - Some(lock_dir_noblock_shared(&full_path, "snapshot", "base snapshot is already locked by another operation")?) + Some(datastore.lock_snapshot_shared(&last.backup_dir)?) } else { None }; diff --git a/src/api2/reader/mod.rs b/src/api2/reader/mod.rs index 45cefe5d..b0438f45 100644 --- a/src/api2/reader/mod.rs +++ b/src/api2/reader/mod.rs @@ -20,7 +20,7 @@ use pbs_api_types::{ BACKUP_ID_SCHEMA, CHUNK_DIGEST_SCHEMA, PRIV_DATASTORE_READ, PRIV_DATASTORE_BACKUP, BACKUP_ARCHIVE_NAME_SCHEMA, }; -use proxmox_sys::fs::lock_dir_noblock_shared; + use pbs_tools::json::{required_integer_param, required_string_param}; use pbs_datastore::{DataStore, PROXMOX_BACKUP_READER_PROTOCOL_ID_V1}; use pbs_datastore::backup_info::BackupDir; @@ -114,10 +114,7 @@ fn upgrade_to_backup_reader_protocol( } } - let _guard = lock_dir_noblock_shared( - &datastore.snapshot_path(&backup_dir), - "snapshot", - "locked by another operation")?; + let _guard = datastore.lock_snapshot_shared(&backup_dir)?; let path = datastore.base_path(); diff --git a/src/backup/verify.rs b/src/backup/verify.rs index 307d366c..eea0e15d 100644 --- a/src/backup/verify.rs +++ b/src/backup/verify.rs @@ -13,7 +13,6 @@ use pbs_datastore::{DataStore, DataBlob, StoreProgress}; use pbs_datastore::backup_info::{BackupGroup, BackupDir, BackupInfo}; use pbs_datastore::index::IndexFile; use pbs_datastore::manifest::{archive_type, ArchiveType, BackupManifest, FileInfo}; -use proxmox_sys::fs::lock_dir_noblock_shared; use crate::tools::parallel_handler::ParallelHandler; @@ -300,11 +299,8 @@ pub fn verify_backup_dir( upid: UPID, filter: Option<&dyn Fn(&BackupManifest) -> bool>, ) -> Result { - let snap_lock = lock_dir_noblock_shared( - &verify_worker.datastore.snapshot_path(backup_dir), - "snapshot", - "locked by another operation", - ); + let snap_lock = verify_worker.datastore.lock_snapshot_shared(&backup_dir); + match snap_lock { Ok(snap_lock) => { verify_backup_dir_with_lock(verify_worker, backup_dir, upid, filter, snap_lock) -- 2.30.2