From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.ozlabs.org (lists.ozlabs.org [112.213.38.117]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 7F583C3ABA2 for ; Mon, 16 Sep 2024 13:56:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lists.ozlabs.org; s=201707; t=1726494980; bh=RkMMOXQTsmanQe52UgGZbvf6dLNC+ICFQfOIzTuSzMo=; h=To:Subject:Date:In-Reply-To:References:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc: From; b=EUllbgsom3pS2L/lzmFlqdQODlBP2fa/ew95FbYXXhEMt1TPud2YpuAlazhqB7kyz q1+5RpIgKFwsShvf7aRReKEMkWJOxgDipoFrUSNmmWV1a2ngsc2pbqQdTWUzd3oQyg tERn0g4QvGRLbYuAbSPFy1q7vCx4vs3s5sg4JdO8UICRAIYeJMoZpODe34PpKWQz5g YXCaidhe56yT4L3PIucTs1X/is9riYJI+1DFW7QcpShgSCv1rqvcC/WJ16WNbwS0E9 MjBDcw0pXgLAPnxHav0wB70uvLluGPfDq1LpvK3rRlVwhfu/uiWh/C2QqP5b2HkoAQ ZEAC+95EjpApA== Received: from boromir.ozlabs.org (localhost [IPv6:::1]) by lists.ozlabs.org (Postfix) with ESMTP id 4X6mfX0Bz8z3brx for ; Mon, 16 Sep 2024 23:56:20 +1000 (AEST) Authentication-Results: lists.ozlabs.org; arc=none smtp.remote-ip=148.135.17.20 ARC-Seal: i=1; a=rsa-sha256; d=lists.ozlabs.org; s=201707; t=1726494977; cv=none; b=g0M5diMciayDA5a3AFAy297FV0UFqqJtj+UWm/nKOFWzW++l3L3IM0+aPnJ64B0c66bfGSpPDgX5vp/3uicxpxtimcAdZRwOhvn6Tz3mGj/VZL+01ZaTuqshNWUUFkrWcE2n1KdzA/lRsX1i3602Eir2cQ4eZclG0QNTV6NhJmoIZm5Q8XpDU1jY4S0dJK0E5hqTGTZ0SviCCWp5YSUfhKW0Uhq7QsduRUZisDxBAV81Oy9oP26jGp2OpcVi1hfStIPRwX8S4rshjmJsWCXAGKMsxukiVxNLJApD5vjqMKUMviDavmIbE6GEvuEPmlEbeEXogElh2s5f13Uvw1yseg== ARC-Message-Signature: i=1; a=rsa-sha256; d=lists.ozlabs.org; s=201707; t=1726494977; c=relaxed/relaxed; bh=RkMMOXQTsmanQe52UgGZbvf6dLNC+ICFQfOIzTuSzMo=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=kxdYGV8cu+yh1ZfJSj1OYSGii7U9bSi5OOhmNAQVLrjzA0e4siGQAURggsy/L/qyRsbEbktR1QXxobnFtU0OLTUpz8GGdC8+bMfxLT4SoHWScGh3NIJvkTWQg9DPLIWqkvvFCPN39+VcAd50kBlCH+phT0T/jyC2s9iwWTyFi4C4UFWoKVT2hr68XdT4DKAblAPET68NkBmYmvUcdvlskmU4m0Oh/8FfIQXW/ot/nyoRFSl5CRVhp7DzagnfDaQdXKFKwrxbqN/Iux3CkCwnqSi7dJ29IPUOE9LvoZ9zpi3WCqoxEsVr7qVmSOfp3iz2/+sTO2dElEiFnWLOVi74Aw== ARC-Authentication-Results: i=1; lists.ozlabs.org; dmarc=pass (p=reject dis=none) header.from=tlmp.cc; dkim=pass (2048-bit key; secure) header.d=tlmp.cc header.i=@tlmp.cc header.a=rsa-sha256 header.s=dkim header.b=lWj1RcoQ; dkim-atps=neutral; spf=pass (client-ip=148.135.17.20; helo=mail.tlmp.cc; envelope-from=toolmanp@tlmp.cc; receiver=lists.ozlabs.org) smtp.mailfrom=tlmp.cc Authentication-Results: lists.ozlabs.org; dmarc=pass (p=reject dis=none) header.from=tlmp.cc Authentication-Results: lists.ozlabs.org; dkim=pass (2048-bit key; secure) header.d=tlmp.cc header.i=@tlmp.cc header.a=rsa-sha256 header.s=dkim header.b=lWj1RcoQ; dkim-atps=neutral Authentication-Results: lists.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=tlmp.cc (client-ip=148.135.17.20; helo=mail.tlmp.cc; envelope-from=toolmanp@tlmp.cc; receiver=lists.ozlabs.org) Received: from mail.tlmp.cc (unknown [148.135.17.20]) (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.ozlabs.org (Postfix) with ESMTPS id 4X6mfS6HRtz2yxN for ; Mon, 16 Sep 2024 23:56:16 +1000 (AEST) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 7D8A26997B; Mon, 16 Sep 2024 09:56:12 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tlmp.cc; s=dkim; t=1726494973; h=from:subject:date:message-id:to:cc:mime-version: content-transfer-encoding:in-reply-to:references; bh=RkMMOXQTsmanQe52UgGZbvf6dLNC+ICFQfOIzTuSzMo=; b=lWj1RcoQuWBLQcg52cSVUJlekfGYmj3eyjhUX1zRLg5iPFQua2BXf+5dlwA0+Lc8jXT9+y mhEoRsnJaaH9X7lCI38wRpiDni2rp/BQJ5lwFewaK/pvR610KrpNG/NUkgNhKcmNYCJmAp b1pfLeNHdJMtbkMKxyFkG6Rqxab08HRTEfs423n/2xiL/Zoa/un+P7GvIXjqp/YPsL1b35 +0j+IVX4g+2Xdb3m3fIQytqD5IHifDEru+0sCOsNgHPAmP2NBWUf0vUkqvFNw3paqDEIKs FNQAp23to/z/F9G43nJebIYU2LBl0ZXgWAeJaOH/rF0yRVy7SO6iIz8jfifnAw== To: linux-erofs@lists.ozlabs.org Subject: [RFC PATCH 07/24] erofs: add data abstraction in Rust Date: Mon, 16 Sep 2024 21:55:24 +0800 Message-ID: <20240916135541.98096-8-toolmanp@tlmp.cc> X-Mailer: git-send-email 2.46.0 In-Reply-To: <20240916135541.98096-1-toolmanp@tlmp.cc> References: <20240916135541.98096-1-toolmanp@tlmp.cc> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Last-TLS-Session-Version: TLSv1.3 X-BeenThere: linux-erofs@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development of Linux EROFS file system List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , From: Yiyang Wu via Linux-erofs Reply-To: Yiyang Wu Cc: linux-fsdevel@vger.kernel.org, rust-for-linux@vger.kernel.org Errors-To: linux-erofs-bounces+linux-erofs=archiver.kernel.org@lists.ozlabs.org Sender: "Linux-erofs" Introduce Buffer, Source, Backend traits. Implement Uncompressed Backend and RefBuffer to be used in future data operations. Signed-off-by: Yiyang Wu --- fs/erofs/rust/erofs_sys.rs | 1 + fs/erofs/rust/erofs_sys/data.rs | 62 +++++++++++++++++++ fs/erofs/rust/erofs_sys/data/backends.rs | 4 ++ .../erofs_sys/data/backends/uncompressed.rs | 39 ++++++++++++ 4 files changed, 106 insertions(+) create mode 100644 fs/erofs/rust/erofs_sys/data.rs create mode 100644 fs/erofs/rust/erofs_sys/data/backends.rs create mode 100644 fs/erofs/rust/erofs_sys/data/backends/uncompressed.rs diff --git a/fs/erofs/rust/erofs_sys.rs b/fs/erofs/rust/erofs_sys.rs index c6fd7f78ac97..8cca2cd9b75f 100644 --- a/fs/erofs/rust/erofs_sys.rs +++ b/fs/erofs/rust/erofs_sys.rs @@ -24,6 +24,7 @@ pub(crate) type PosixResult = Result; pub(crate) mod alloc_helper; +pub(crate) mod data; pub(crate) mod errnos; pub(crate) mod inode; pub(crate) mod superblock; diff --git a/fs/erofs/rust/erofs_sys/data.rs b/fs/erofs/rust/erofs_sys/data.rs new file mode 100644 index 000000000000..284c8b1f3bd4 --- /dev/null +++ b/fs/erofs/rust/erofs_sys/data.rs @@ -0,0 +1,62 @@ +// Copyright 2024 Yiyang Wu +// SPDX-License-Identifier: MIT or GPL-2.0-or-later +pub(crate) mod backends; +use super::*; + +/// Represent some sort of generic data source. This cound be file, memory or even network. +/// Note that users should never use this directly please use backends instead. +pub(crate) trait Source { + fn fill(&self, data: &mut [u8], offset: Off) -> PosixResult; + fn as_buf<'a>(&'a self, offset: Off, len: Off) -> PosixResult>; +} + +/// Represents a generic data access backend that is backed by some sort of data source. +/// This often has temporary buffers to decompress the data from the data source. +/// The method signatures are the same as those of the Source trait. +pub(crate) trait Backend { + fn fill(&self, data: &mut [u8], offset: Off) -> PosixResult; + fn as_buf<'a>(&'a self, offset: Off, len: Off) -> PosixResult>; +} + +/// Represents a buffer trait which can yield its internal reference or be casted as an iterator of +/// DirEntries. +pub(crate) trait Buffer { + fn content(&self) -> &[u8]; +} + +/// Represents a buffer that holds a reference to a slice of data that +/// is borrowed from the thin air. +pub(crate) struct RefBuffer<'a> { + buf: &'a [u8], + start: usize, + len: usize, + put_buf: fn(*mut core::ffi::c_void), +} + +impl<'a> Buffer for RefBuffer<'a> { + fn content(&self) -> &[u8] { + &self.buf[self.start..self.start + self.len] + } +} + +impl<'a> RefBuffer<'a> { + pub(crate) fn new( + buf: &'a [u8], + start: usize, + len: usize, + put_buf: fn(*mut core::ffi::c_void), + ) -> Self { + Self { + buf, + start, + len, + put_buf, + } + } +} + +impl<'a> Drop for RefBuffer<'a> { + fn drop(&mut self) { + (self.put_buf)(self.buf.as_ptr() as *mut core::ffi::c_void) + } +} diff --git a/fs/erofs/rust/erofs_sys/data/backends.rs b/fs/erofs/rust/erofs_sys/data/backends.rs new file mode 100644 index 000000000000..3249f1af8be7 --- /dev/null +++ b/fs/erofs/rust/erofs_sys/data/backends.rs @@ -0,0 +1,4 @@ +// Copyright 2024 Yiyang Wu +// SPDX-License-Identifier: MIT or GPL-2.0-or-later + +pub(crate) mod uncompressed; diff --git a/fs/erofs/rust/erofs_sys/data/backends/uncompressed.rs b/fs/erofs/rust/erofs_sys/data/backends/uncompressed.rs new file mode 100644 index 000000000000..c1b1a60258f8 --- /dev/null +++ b/fs/erofs/rust/erofs_sys/data/backends/uncompressed.rs @@ -0,0 +1,39 @@ +// Copyright 2024 Yiyang Wu +// SPDX-License-Identifier: MIT or GPL-2.0-or-later + +use super::super::*; + +pub(crate) struct UncompressedBackend +where + T: Source, +{ + source: T, +} + +impl Backend for UncompressedBackend +where + T: Source, +{ + fn fill(&self, data: &mut [u8], offset: Off) -> PosixResult { + self.source.fill(data, offset) + } + + fn as_buf<'a>(&'a self, offset: Off, len: Off) -> PosixResult> { + self.source.as_buf(offset, len) + } +} + +impl UncompressedBackend { + pub(crate) fn new(source: T) -> Self { + Self { source } + } +} + +impl From for UncompressedBackend +where + T: Source, +{ + fn from(value: T) -> Self { + Self::new(value) + } +} -- 2.46.0 From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail.tlmp.cc (unknown [148.135.17.20]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 007C315852E; Mon, 16 Sep 2024 13:56:14 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=148.135.17.20 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726494976; cv=none; b=QUf1XNww2hnnBUTWKBS+p6MOfTSuvK7srWuriBYkHeOR6qmRiJ+3kkBJ3FsxJWZ/vrKQbwFQpq51gLJ0QW5f3k4qmvX86QdpQ/OPSP25OTaYyq+ovQkpYnX5PvvwD+7rId1Ag7TVXYhm3sOPBlNkp2ohi7XmXUXVVs/yIoK+V60= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1726494976; c=relaxed/simple; bh=H9qZQ6sPOX6lomGbiY5NWabke+KIbETnJDwauhJvUys=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=FPzDVI3kFiWwUKhKRyJFV4tfMyrZS97JlPtLEQzShRCyv3vpRzfvFCYr6PyKeiGD0HUhmMgT6B2Ea81PEoTjVpOBoN4B7pKXne0b0as4DlDXDl7qB0JJGMTsOe/I/lXzFe7efuKj2r5UZDPuJo0J1tgo5tyv3cwyWTLICEbyX7M= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=tlmp.cc; spf=pass smtp.mailfrom=tlmp.cc; dkim=pass (2048-bit key) header.d=tlmp.cc header.i=@tlmp.cc header.b=lWj1RcoQ; arc=none smtp.client-ip=148.135.17.20 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=tlmp.cc Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=tlmp.cc Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=tlmp.cc header.i=@tlmp.cc header.b="lWj1RcoQ" Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 7D8A26997B; Mon, 16 Sep 2024 09:56:12 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tlmp.cc; s=dkim; t=1726494973; h=from:subject:date:message-id:to:cc:mime-version: content-transfer-encoding:in-reply-to:references; bh=RkMMOXQTsmanQe52UgGZbvf6dLNC+ICFQfOIzTuSzMo=; b=lWj1RcoQuWBLQcg52cSVUJlekfGYmj3eyjhUX1zRLg5iPFQua2BXf+5dlwA0+Lc8jXT9+y mhEoRsnJaaH9X7lCI38wRpiDni2rp/BQJ5lwFewaK/pvR610KrpNG/NUkgNhKcmNYCJmAp b1pfLeNHdJMtbkMKxyFkG6Rqxab08HRTEfs423n/2xiL/Zoa/un+P7GvIXjqp/YPsL1b35 +0j+IVX4g+2Xdb3m3fIQytqD5IHifDEru+0sCOsNgHPAmP2NBWUf0vUkqvFNw3paqDEIKs FNQAp23to/z/F9G43nJebIYU2LBl0ZXgWAeJaOH/rF0yRVy7SO6iIz8jfifnAw== From: Yiyang Wu To: linux-erofs@lists.ozlabs.org Cc: rust-for-linux@vger.kernel.org, linux-fsdevel@vger.kernel.org Subject: [RFC PATCH 07/24] erofs: add data abstraction in Rust Date: Mon, 16 Sep 2024 21:55:24 +0800 Message-ID: <20240916135541.98096-8-toolmanp@tlmp.cc> X-Mailer: git-send-email 2.46.0 In-Reply-To: <20240916135541.98096-1-toolmanp@tlmp.cc> References: <20240916135541.98096-1-toolmanp@tlmp.cc> Precedence: bulk X-Mailing-List: rust-for-linux@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Last-TLS-Session-Version: TLSv1.3 Introduce Buffer, Source, Backend traits. Implement Uncompressed Backend and RefBuffer to be used in future data operations. Signed-off-by: Yiyang Wu --- fs/erofs/rust/erofs_sys.rs | 1 + fs/erofs/rust/erofs_sys/data.rs | 62 +++++++++++++++++++ fs/erofs/rust/erofs_sys/data/backends.rs | 4 ++ .../erofs_sys/data/backends/uncompressed.rs | 39 ++++++++++++ 4 files changed, 106 insertions(+) create mode 100644 fs/erofs/rust/erofs_sys/data.rs create mode 100644 fs/erofs/rust/erofs_sys/data/backends.rs create mode 100644 fs/erofs/rust/erofs_sys/data/backends/uncompressed.rs diff --git a/fs/erofs/rust/erofs_sys.rs b/fs/erofs/rust/erofs_sys.rs index c6fd7f78ac97..8cca2cd9b75f 100644 --- a/fs/erofs/rust/erofs_sys.rs +++ b/fs/erofs/rust/erofs_sys.rs @@ -24,6 +24,7 @@ pub(crate) type PosixResult = Result; pub(crate) mod alloc_helper; +pub(crate) mod data; pub(crate) mod errnos; pub(crate) mod inode; pub(crate) mod superblock; diff --git a/fs/erofs/rust/erofs_sys/data.rs b/fs/erofs/rust/erofs_sys/data.rs new file mode 100644 index 000000000000..284c8b1f3bd4 --- /dev/null +++ b/fs/erofs/rust/erofs_sys/data.rs @@ -0,0 +1,62 @@ +// Copyright 2024 Yiyang Wu +// SPDX-License-Identifier: MIT or GPL-2.0-or-later +pub(crate) mod backends; +use super::*; + +/// Represent some sort of generic data source. This cound be file, memory or even network. +/// Note that users should never use this directly please use backends instead. +pub(crate) trait Source { + fn fill(&self, data: &mut [u8], offset: Off) -> PosixResult; + fn as_buf<'a>(&'a self, offset: Off, len: Off) -> PosixResult>; +} + +/// Represents a generic data access backend that is backed by some sort of data source. +/// This often has temporary buffers to decompress the data from the data source. +/// The method signatures are the same as those of the Source trait. +pub(crate) trait Backend { + fn fill(&self, data: &mut [u8], offset: Off) -> PosixResult; + fn as_buf<'a>(&'a self, offset: Off, len: Off) -> PosixResult>; +} + +/// Represents a buffer trait which can yield its internal reference or be casted as an iterator of +/// DirEntries. +pub(crate) trait Buffer { + fn content(&self) -> &[u8]; +} + +/// Represents a buffer that holds a reference to a slice of data that +/// is borrowed from the thin air. +pub(crate) struct RefBuffer<'a> { + buf: &'a [u8], + start: usize, + len: usize, + put_buf: fn(*mut core::ffi::c_void), +} + +impl<'a> Buffer for RefBuffer<'a> { + fn content(&self) -> &[u8] { + &self.buf[self.start..self.start + self.len] + } +} + +impl<'a> RefBuffer<'a> { + pub(crate) fn new( + buf: &'a [u8], + start: usize, + len: usize, + put_buf: fn(*mut core::ffi::c_void), + ) -> Self { + Self { + buf, + start, + len, + put_buf, + } + } +} + +impl<'a> Drop for RefBuffer<'a> { + fn drop(&mut self) { + (self.put_buf)(self.buf.as_ptr() as *mut core::ffi::c_void) + } +} diff --git a/fs/erofs/rust/erofs_sys/data/backends.rs b/fs/erofs/rust/erofs_sys/data/backends.rs new file mode 100644 index 000000000000..3249f1af8be7 --- /dev/null +++ b/fs/erofs/rust/erofs_sys/data/backends.rs @@ -0,0 +1,4 @@ +// Copyright 2024 Yiyang Wu +// SPDX-License-Identifier: MIT or GPL-2.0-or-later + +pub(crate) mod uncompressed; diff --git a/fs/erofs/rust/erofs_sys/data/backends/uncompressed.rs b/fs/erofs/rust/erofs_sys/data/backends/uncompressed.rs new file mode 100644 index 000000000000..c1b1a60258f8 --- /dev/null +++ b/fs/erofs/rust/erofs_sys/data/backends/uncompressed.rs @@ -0,0 +1,39 @@ +// Copyright 2024 Yiyang Wu +// SPDX-License-Identifier: MIT or GPL-2.0-or-later + +use super::super::*; + +pub(crate) struct UncompressedBackend +where + T: Source, +{ + source: T, +} + +impl Backend for UncompressedBackend +where + T: Source, +{ + fn fill(&self, data: &mut [u8], offset: Off) -> PosixResult { + self.source.fill(data, offset) + } + + fn as_buf<'a>(&'a self, offset: Off, len: Off) -> PosixResult> { + self.source.as_buf(offset, len) + } +} + +impl UncompressedBackend { + pub(crate) fn new(source: T) -> Self { + Self { source } + } +} + +impl From for UncompressedBackend +where + T: Source, +{ + fn from(value: T) -> Self { + Self::new(value) + } +} -- 2.46.0