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 60E7C69765 for ; Tue, 23 Mar 2021 11:12:53 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 4FEDA2C88A for ; Tue, 23 Mar 2021 11:12:23 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (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 E7A4C2C87F for ; Tue, 23 Mar 2021 11:12:21 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id A6E1342D55 for ; Tue, 23 Mar 2021 11:12:21 +0100 (CET) From: Dominik Csapak To: pbs-devel@lists.proxmox.com Date: Tue, 23 Mar 2021 11:12:20 +0100 Message-Id: <20210323101220.14096-1-d.csapak@proxmox.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.180 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment 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 URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [tools.rs, proxmox-backup-client.rs] Subject: [pbs-devel] [PATCH proxmox-backup] fix #3359: fix blocking writes in async code during pxar create 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: Tue, 23 Mar 2021 10:12:53 -0000 in commit `asyncify pxar create_archive`, we changed from a separate thread for creating a pxar to using async code, but the StdChannelWriter used for both pxar and catalog can block, which may block the tokio runtime for single (and probably dual) core environments this patch adds a wrapper struct for any writer that implements 'std::io::Write' and wraps the write calls with 'block_in_place' so that if called in a tokio runtime, it knows that this code potentially blocks Fixes: 6afb60abf557 ("asyncify pxar create_archive") Signed-off-by: Dominik Csapak --- alternatives would be: * asyncify complete CatalogWriter and PxarBackupStream * add 'block_in_place' in 'create_archive' * add a threaded non-async variant of create_archive src/bin/proxmox-backup-client.rs | 12 ++++++++---- src/client/pxar_backup_stream.rs | 10 +++++++--- src/tools.rs | 3 +++ src/tools/tokio_writer_adapter.rs | 26 ++++++++++++++++++++++++++ 4 files changed, 44 insertions(+), 7 deletions(-) create mode 100644 src/tools/tokio_writer_adapter.rs diff --git a/src/bin/proxmox-backup-client.rs b/src/bin/proxmox-backup-client.rs index 5aae0873..45b26c7a 100644 --- a/src/bin/proxmox-backup-client.rs +++ b/src/bin/proxmox-backup-client.rs @@ -32,7 +32,11 @@ use proxmox::{ }; use pxar::accessor::{MaybeReady, ReadAt, ReadAtOperation}; -use proxmox_backup::tools; +use proxmox_backup::tools::{ + self, + StdChannelWriter, + TokioWriterAdapter, +}; use proxmox_backup::api2::types::*; use proxmox_backup::api2::version; use proxmox_backup::client::*; @@ -162,7 +166,7 @@ async fn backup_directory>( dir_path: P, archive_name: &str, chunk_size: Option, - catalog: Arc>>, + catalog: Arc>>>, pxar_create_options: proxmox_backup::pxar::PxarCreateOptions, upload_options: UploadOptions, ) -> Result { @@ -460,7 +464,7 @@ async fn start_garbage_collection(param: Value) -> Result { } struct CatalogUploadResult { - catalog_writer: Arc>>, + catalog_writer: Arc>>>, result: tokio::sync::oneshot::Receiver>, } @@ -473,7 +477,7 @@ fn spawn_catalog_upload( let catalog_chunk_size = 512*1024; let catalog_chunk_stream = ChunkStream::new(catalog_stream, Some(catalog_chunk_size)); - let catalog_writer = Arc::new(Mutex::new(CatalogWriter::new(crate::tools::StdChannelWriter::new(catalog_tx))?)); + let catalog_writer = Arc::new(Mutex::new(CatalogWriter::new(TokioWriterAdapter::new(StdChannelWriter::new(catalog_tx)))?)); let (catalog_result_tx, catalog_result_rx) = tokio::sync::oneshot::channel(); diff --git a/src/client/pxar_backup_stream.rs b/src/client/pxar_backup_stream.rs index b57061a3..035f735c 100644 --- a/src/client/pxar_backup_stream.rs +++ b/src/client/pxar_backup_stream.rs @@ -13,6 +13,10 @@ use nix::fcntl::OFlag; use nix::sys::stat::Mode; use crate::backup::CatalogWriter; +use crate::tools::{ + StdChannelWriter, + TokioWriterAdapter, +}; /// Stream implementation to encode and upload .pxar archives. /// @@ -45,10 +49,10 @@ impl PxarBackupStream { let error = Arc::new(Mutex::new(None)); let error2 = Arc::clone(&error); let handler = async move { - let writer = std::io::BufWriter::with_capacity( + let writer = TokioWriterAdapter::new(std::io::BufWriter::with_capacity( buffer_size, - crate::tools::StdChannelWriter::new(tx), - ); + StdChannelWriter::new(tx), + )); let verbose = options.verbose; diff --git a/src/tools.rs b/src/tools.rs index cc782da2..7e3bff7b 100644 --- a/src/tools.rs +++ b/src/tools.rs @@ -57,6 +57,9 @@ pub use async_channel_writer::AsyncChannelWriter; mod std_channel_writer; pub use std_channel_writer::StdChannelWriter; +mod tokio_writer_adapter; +pub use tokio_writer_adapter::TokioWriterAdapter; + mod process_locker; pub use process_locker::{ProcessLocker, ProcessLockExclusiveGuard, ProcessLockSharedGuard}; diff --git a/src/tools/tokio_writer_adapter.rs b/src/tools/tokio_writer_adapter.rs new file mode 100644 index 00000000..7b7f5dcf --- /dev/null +++ b/src/tools/tokio_writer_adapter.rs @@ -0,0 +1,26 @@ +use std::io::Write; + +use tokio::task::block_in_place; + +/// Wrapper around a writer which implements Write +/// +/// wraps each write with a 'block_in_place' so that +/// any (blocking) writer can be safely used in async context in a +/// tokio runtime +pub struct TokioWriterAdapter(W); + +impl TokioWriterAdapter { + pub fn new(writer: W) -> Self { + Self(writer) + } +} + +impl Write for TokioWriterAdapter { + fn write(&mut self, buf: &[u8]) -> Result { + block_in_place(|| self.0.write(buf)) + } + + fn flush(&mut self) -> Result<(), std::io::Error> { + block_in_place(|| self.0.flush()) + } +} -- 2.20.1