[gentoo-commits] repo/gentoo:master commit in: sys-fs/bees/, sys-fs/bees/files/

["Sam James" <sam@gentoo.org>]

commit:     2fe964f4c01f4cebfbeb87ad8c9d65d0cb3bb2e0
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Mon Jan 20 03:36:50 2025 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Mon Jan 20 03:36:50 2025 +0000
URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=2fe964f4

Revert "sys-fs/bees: drop 0.10"

This reverts commit 4b18687cf86110887846d381b1e32b722ba60fee.

sys-fs/bees
  DroppedStableKeywords: commit 4b18687cf861 (or later) dropped stable keyword: [ amd64 ]

Signed-off-by: Sam James <sam <AT> gentoo.org>

 sys-fs/bees/bees-0.10.ebuild                       | 112 +++++++++++++++++++++
 ...le-Work-around-kernel-memory-fragmentatio.patch |  34 +++++++
 2 files changed, 146 insertions(+)

diff --git a/sys-fs/bees/bees-0.10.ebuild b/sys-fs/bees/bees-0.10.ebuild
new file mode 100644
index 000000000000..a1b15c2ef627
--- /dev/null
+++ b/sys-fs/bees/bees-0.10.ebuild
@@ -0,0 +1,112 @@
+# Copyright 1999-2023 Gentoo Authors
+# Distributed under the terms of the GNU General Public License v2
+
+EAPI=8
+
+inherit linux-info systemd toolchain-funcs
+
+DESCRIPTION="Best-Effort Extent-Same, a btrfs dedup agent"
+HOMEPAGE="https://github.com/Zygo/bees"
+
+if [[ ${PV} == 9999 ]] ; then
+	inherit git-r3
+	EGIT_REPO_URI="https://github.com/Zygo/bees.git"
+else
+	SRC_URI="https://github.com/Zygo/bees/archive/v${PV}.tar.gz -> ${P}.tar.gz"
+	KEYWORDS="amd64 ~arm64"
+fi
+
+LICENSE="GPL-3"
+SLOT="0"
+IUSE=""
+
+DEPEND="
+	>=sys-apps/util-linux-2.30.2
+	>=sys-fs/btrfs-progs-4.20.2
+"
+RDEPEND="${DEPEND}"
+
+CONFIG_CHECK="~BTRFS_FS"
+ERROR_BTRFS_FS="CONFIG_BTRFS_FS: bees does currently only work with btrfs"
+
+PATCHES=(
+	"${FILESDIR}/0001-HACK-crucible-Work-around-kernel-memory-fragmentatio.patch"
+)
+
+pkg_pretend() {
+	if [[ ${MERGE_TYPE} != buildonly ]]; then
+		if kernel_is -lt 4 11; then
+			ewarn "With kernel versions below 4.11, bees may severely degrade system performance"
+			ewarn "and responsiveness. Especially, the kernel may deadlock while bees is"
+			ewarn "running, it's recommended to run at least kernel 4.11."
+			ewarn
+		elif kernel_is -lt 4 14 29; then
+			ewarn "With kernel versions below 4.14.29, bees may generate a lot of bogus WARN_ON()"
+			ewarn "messages in the kernel log. These messages can be ignored and this is fixed"
+			ewarn "with more recent kernels:"
+			ewarn "# WARNING: CPU: 3 PID: 18172 at fs/btrfs/backref.c:1391 find_parent_nodes+0xc41/0x14e0"
+			ewarn
+		elif kernel_is -lt 5 7 0; then
+			ewarn "With kernel versions below 5.4.96 and 5.7, the kernel may hold file system"
+			ewarn "locks for a long time while at the same time CPU usage increases when bees is"
+			ewarn "operating. bees tries to avoid this behavior by excluding very common extents"
+			ewarn "from deduplication. This has only a minimal impact on dedupe effectiveness."
+			ewarn
+		fi
+		if kernel_is -lt 5 1 0; then
+			ewarn "IMPORTANT: With kernel versions below 5.1.0, you may experience data corruption"
+			ewarn "due to bees using compression in btrfs. You are adviced to use a chronologically"
+			ewarn "later kernel, that includes older LTS versions released after 5.0.4:"
+			ewarn "Fixed in: 5.1+, 5.0.4+, 4.19.31+, 4.14.108+, 4.9.165+, 4.4.177+, 3.18.137+"
+			ewarn "# commit 8e92821 btrfs: fix corruption reading shared and compressed extents after hole punching"
+			ewarn
+		fi
+		if kernel_is -lt 5 4 19; then
+			ewarn "With kernel versions below 5.4.19, bees may trigger a btrfs bug when running"
+			ewarn "btrfs-balance in parallel. This may lead to meta-data corruption in the worst"
+			ewarn "case. Especially, kernels 5.1.21 and 5.2.21 should be avoided. Kernels 5.0.x"
+			ewarn "after 5.0.21 should be safe. In the best case, affected kernels may force"
+			ewarn "the device RO without writing corrupted meta-data. More details:"
+			ewarn "https://github.com/Zygo/bees/blob/master/docs/btrfs-kernel.md"
+			ewarn
+		fi
+		if kernel_is -gt 5 15 106; then
+			if kernel_is -lt 6 3 10; then
+				ewarn "With kernel versions 5.15.107 or later, there is a memory fragmentation"
+				ewarn "issue with LOGICAL_INO which can lead to cache thrashing and cause IO"
+				ewarn "latency spikes. This version ships with a work-around at the cost of not"
+				ewarn "handling highly duplicated filesystems that well. More details:"
+				ewarn "https://github.com/Zygo/bees/issues/260"
+				ewarn
+			fi
+		fi
+
+		elog "Bees recommends running the latest current kernel for performance and"
+		elog "reliability reasons, see README.md."
+	fi
+}
+
+src_prepare() {
+	default
+	sed -i 's/ -Werror//' makeflags || die
+}
+
+src_configure() {
+	tc-export CC CXX AR
+	cat >localconf <<-EOF || die
+		ETC_PREFIX="${EPREFIX}/etc"
+		LIBEXEC_PREFIX="${EPREFIX}/usr/libexec"
+		PREFIX="${EPREFIX}/usr"
+		SYSTEMD_SYSTEM_UNIT_DIR="$(systemd_get_systemunitdir)"
+		DEFAULT_MAKE_TARGET=all
+	EOF
+	if [[ ${PV} != "9999" ]] ; then
+		echo BEES_VERSION=v${PV} >>localconf || die
+	fi
+}
+
+src_compile() {
+	default
+	# localconf quotes leak in the systemd unit but are still needed for spaces
+	sed -i 's/"//g' scripts/beesd@.service || die
+}

diff --git a/sys-fs/bees/files/0001-HACK-crucible-Work-around-kernel-memory-fragmentatio.patch b/sys-fs/bees/files/0001-HACK-crucible-Work-around-kernel-memory-fragmentatio.patch
new file mode 100644
index 000000000000..0ceb5cbfc79e
--- /dev/null
+++ b/sys-fs/bees/files/0001-HACK-crucible-Work-around-kernel-memory-fragmentatio.patch
@@ -0,0 +1,34 @@
+From 10c2006e627b5bda74f9f8aca1a574aa0e0e1eaa Mon Sep 17 00:00:00 2001
+From: Kai Krakow <kai@kaishome.de>
+Date: Sun, 9 Jul 2023 12:24:40 +0200
+Subject: [PATCH] HACK: crucible: Work around kernel memory fragmentation
+
+According to @Zygo:
+
+> This will drastically reduce the number of reflinks bees can handle
+> to a single extent, but that size is beyond more than enough for most
+> filesystems. Making the buffer smaller may also reduce the size of
+> vmallocs which might be aggravating the kernel's memory manager.
+
+Link: https://github.com/Zygo/bees/issues/260#issuecomment-1627586574
+Signed-off-by: Kai Krakow <kai@kaishome.de>
+---
+ include/crucible/fs.h | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+diff --git a/include/crucible/fs.h b/include/crucible/fs.h
+index 6d1780b..5da7da0 100644
+--- a/include/crucible/fs.h
++++ b/include/crucible/fs.h
+@@ -65,7 +65,7 @@ namespace crucible {
+ 	};
+ 
+ 	struct BtrfsIoctlLogicalInoArgs {
+-		BtrfsIoctlLogicalInoArgs(uint64_t logical, size_t buf_size = 16 * 1024 * 1024);
++		BtrfsIoctlLogicalInoArgs(uint64_t logical, size_t buf_size = 64 * 1024);
+ 
+ 		uint64_t get_flags() const;
+ 		void set_flags(uint64_t new_flags);
+-- 
+2.39.3
+