From nobody Mon Apr 15 14:05:27 2024 X-Original-To: dev-commits-src-all@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 4VJ8880lxGz5GfZB; Mon, 15 Apr 2024 14:05:28 +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 4VJ8876Tgdz4VgW; Mon, 15 Apr 2024 14:05:27 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1713189927; 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=btDocriZbILGRyHEyLF9te/S65ItlTvb4d2fYgDSzGE=; b=KKfQHPYjfXc+2gtpQvV+VxOUC0xNlNp2cHRn8wmWoKwHFMQnQ4Kqg/YKnZvZTbcF2hu4ZP 9nm6tjijKV9itMUU5YykhtyiIyxHe8kNaLlXQ8mw+i9vCuee8F3R4RxP/U+YhlSwtoMDDm uF0VjxgmH0jNCsgDHbuBYBbAcXYH2HUCR1h/qRL8rlkHVbGNT6TmbbF5VTknh6pn2z7nAh fCvpIPrHWZqvAhFDUir22kHEju8YCOP7e2LXMoE/zRjklpC3JiZbkI/1EpiAofjRj7XwE/ Vp7Un6P8FVN1HQmA4P+1V8f5ogdibO6/fUEZ9lLG/EQK4TAWahI7yj3jwY6JhQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1713189927; a=rsa-sha256; cv=none; b=jAmkkvNPVRN0rCxjbaIgz7GWPeCF0ckaRIf8YcCXBL91Sm7Ti9UH3capbqWvr7a2Hjm9EP RKLhn0p/ofpNbvWzscyI7AkRcr4rsHzANEQhQaIxYSHGeBY7w0Ob8p8438qGKdnN5GJnpS 5wW830Bx8Evr8eyegLkMa+0GQHgAEP3mpiXDkp++ZScwCQjjJ6DIrCa4aMUfplojYSCGZL mTUCSSdDXx/Y3I/akS4rDuu5IS8Zzkq8bK+RLer8CLAHOSMn53ZhWWZ2BIe3QANFsTToX/ lTg1FYVI2mXPypfujCZB6Peqi6AmNHDpI4Ym+Sot6T+g/69KSMvesPt86mIMSQ== 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=1713189927; 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=btDocriZbILGRyHEyLF9te/S65ItlTvb4d2fYgDSzGE=; b=VibEKMEOSt53o0SqZG897Qb37zJht4LHuqHf05O8YiY67ONyFkTK9rvCXYAC1U2yZ09+D5 RfD2Q3I7jjIys5htU/5zsD3gdLpeKc7HWTZbl6JJ1Ve8zPKu0icoMf8lVsfCksXTG0kV6x /W9qUkk4lbWFSMDwAutinkSk4AMJtfoED5g9NuJaiDsOm/Violu+X1Ya2MKauAJnv1Btxz FXy5TzgKpm54qbQqnJmaeiae8iIIoAW9jwFszOwy9T63YRXeLrBh7wBWc3jxyIEgOy3QKQ EaceQAx71TFBNR8a6wJDe3Z4pTu8s7Qa1TF7bYmS5o91xq5ubXlQnuDrJlnOwg== 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 4VJ88765yyz12n8; Mon, 15 Apr 2024 14:05:27 +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 43FE5RsY069854; Mon, 15 Apr 2024 14:05:27 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 43FE5RVu069851; Mon, 15 Apr 2024 14:05:27 GMT (envelope-from git) Date: Mon, 15 Apr 2024 14:05:27 GMT Message-Id: <202404151405.43FE5RVu069851@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Mark Johnston Subject: git: f97a19fc0129 - stable/14 - tarfs.5: Document the importance of zstd framing List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@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/stable/14 X-Git-Reftype: branch X-Git-Commit: f97a19fc012939360b4c2467823246b7a7f34ac2 Auto-Submitted: auto-generated The branch stable/14 has been updated by markj: URL: https://cgit.FreeBSD.org/src/commit/?id=f97a19fc012939360b4c2467823246b7a7f34ac2 commit f97a19fc012939360b4c2467823246b7a7f34ac2 Author: Mark Johnston AuthorDate: 2024-04-04 14:54:25 +0000 Commit: Mark Johnston CommitDate: 2024-04-15 14:05:13 +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 (cherry picked from commit d1801babad495be2a3eb1d974e1daf9714c5b0fd) --- 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