From nobody Thu Apr 04 14:58:54 2024 X-Original-To: dev-commits-src-main@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4V9Prt5xFMz5H7xn; Thu, 4 Apr 2024 14:58:54 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4V9Prt4xrJz4M3N; Thu, 4 Apr 2024 14:58:54 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1712242734; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=sVo7d5w0L+AueeJZdscVR6uGii0KqjV5r5V/JwRTOps=; b=oInbttIUnh4bTRX76SsrCjm36rs1b5TKq1p20Wbe8FU2dNzKpT3hOyrryiH2+aGzZDLet7 cMxd7AJi/H4vYbUnyiUnlu/Jl/qTMidFsl3IEG/8WsuIgzJ/TekkC983pS2jIbEWrTY/qF eQyNszJEfbxURl3Kd8MkA8fgrac/q5HoZN1wLXyqeH/FUwVJE90RJrhX1k8HcAxL7Cl7y2 76eDUnRYAxAD3VEbIfdVaTpOPHuIdDPdAtVOfgL52/XqE96pzIjAHftjkQH54DVbLR8ZAx aTtTegxmVZL1Z39UB7uPchNoufJsCgCMs3OR9/7AeQCGwLpJOAskmWKeH9QhUQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1712242734; a=rsa-sha256; cv=none; b=KVhC/GdbJ4tMvjQWVqfPs1FyHD7zia/d5GryDgT+VlLPgKT973nPgwpMTedvrYGtOnIoOX LvrugUZJRM0yqeenGO0t8axoSnbGsiChgvSyAKE1qas2W3DUHIYNPeSmThDir87LNKrmtP KeGukvHOQ0YMV131ANIQKrqzZ7Txw7XkTxuwpMEj3U1lDh7PlgcpOUsdUuWP/X41PdjaAR OcFmlqP0hlWOpP61DRGypcdLrtVdAx2FDCqk/arfz1l52TCvxxl1i/N0+OKOiKyFbr00oH pP1XDAbLPtH2EU7NDIk5T5yQ6Lm2V7IVgkHdqwkCQLOroXbpgVZqXtMlGZdydw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1712242734; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=sVo7d5w0L+AueeJZdscVR6uGii0KqjV5r5V/JwRTOps=; b=mDvjfPHv4MxQWqNd0PjRhPLIOSRMX6cUzVaz9YGYnVzneDMT5qot/amwPCsPgJcdpm9kc/ YPdtreveYCCyWZ49LvgnvJ7ghif7LfYbN+Dg1/cB5yjVj02YVGGwOZppHR+m4j0I4fECqj yN0u3nywJHLKLK6zPYz6tqfhAOJA49go1MnDHQXsKZbZpe/6D4/NoqZLmqwETCNwrPEufa n1iq7753y1yUb50npLzYeYuCfm6MN/MJv19zvWyfJw5ieW2gkgrWObIuNB9KyFaiOYkK9w sr9vRV3KOkGKMco4BoHSrm4ifuYa0FtbqUGiZlfWAE9g1mR/Wut/uNh+TmCQbA== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4V9Prt4NQ7zLh7; Thu, 4 Apr 2024 14:58:54 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 434EwsXD098806; Thu, 4 Apr 2024 14:58:54 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 434Ews9U098803; Thu, 4 Apr 2024 14:58:54 GMT (envelope-from git) Date: Thu, 4 Apr 2024 14:58:54 GMT Message-Id: <202404041458.434Ews9U098803@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mark Johnston Subject: git: d1801babad49 - main - tarfs.5: Document the importance of zstd framing List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: markj X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: d1801babad495be2a3eb1d974e1daf9714c5b0fd Auto-Submitted: auto-generated The branch main has been updated by markj: URL: https://cgit.FreeBSD.org/src/commit/?id=d1801babad495be2a3eb1d974e1daf9714c5b0fd commit d1801babad495be2a3eb1d974e1daf9714c5b0fd Author: Mark Johnston AuthorDate: 2024-04-04 14:54:25 +0000 Commit: Mark Johnston CommitDate: 2024-04-04 14:54:25 +0000 tarfs.5: Document the importance of zstd framing Reviewed by: des, kib MFC after: 1 week Sponsored by: Klara, Inc. Differential Revision: https://reviews.freebsd.org/D44628 --- share/man/man5/tarfs.5 | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/share/man/man5/tarfs.5 b/share/man/man5/tarfs.5 index 29999b8066f7..5378491b9c9f 100644 --- a/share/man/man5/tarfs.5 +++ b/share/man/man5/tarfs.5 @@ -61,6 +61,19 @@ sysctl setting and tunable. Setting it to 0 will reset it to its default value. Note that changes to this setting only apply to filesystems mounted after the change. +.Pp +When the backing tar file is compressed with +.Xr zstd 1 , +I/O performance can be improved by ensuring that compressed data is +broken up into multiple frames. +This helps minimize unnecessary decompression work. +When using +.Xr bsdtar 1 +to create the tar file, this can be achieved using the +.Cm zstd:max-frame-size +and +.Cm ztsd:frame-per-file +options. .Sh DIAGNOSTICS If enabled by the .Dv TARFS_DEBUG