From patchwork Mon Jan 27 19:02:29 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Derrick Stolee X-Patchwork-Id: 13951670 Received: from mail-wm1-f49.google.com (mail-wm1-f49.google.com [209.85.128.49]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 38CD7191F75 for ; Mon, 27 Jan 2025 19:02:42 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.49 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738004565; cv=none; b=lvmqvzixA3TemEr5QdiATJd0ACCib8VBBdLL8dwFrL+9xkAqztOrwIN4mnmziRa3BMTWILRTl5qC4ICyW40P6bfomLzkUS5JRg4FusqbLCy7k5oWtxT/0u052meS97Ff7HYJlaVAhnhW1trf9swH4Zl1lNr0+NjtDKeXKDS/0uQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738004565; c=relaxed/simple; bh=VtOdlvqqF9l8YmxreVq58WPte6MgMGN6jaiW6SR/aVs=; h=Message-Id:In-Reply-To:References:From:Date:Subject:Content-Type: MIME-Version:To:Cc; b=pTWCl1cUFaS63GamLfonHUechS6Vx9tNGkAoe7hLFpfng94RhWigstiWBePGWbPh75rTnQOxxSQSP+lDt8tMWPR7q45PStb20dlXa33um6qkgKcG8kMHQq3LCy2dyOjIxR3FL7Ps9nnqJQD+Ji7e2M9jUh0E3mYgqdQdrBMxwjE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=kyforpPZ; arc=none smtp.client-ip=209.85.128.49 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="kyforpPZ" Received: by mail-wm1-f49.google.com with SMTP id 5b1f17b1804b1-43635796b48so30980805e9.0 for ; Mon, 27 Jan 2025 11:02:41 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1738004560; x=1738609360; darn=vger.kernel.org; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=3JftDG29tZaDaYyUdfTo570aq5S7mDB8kQuEqkFJx6s=; b=kyforpPZhPaoKIPJY2mboDuOpxIUY3mP5xuSkY181U0rG/RXuHSH36faYrbHlOtU3t LwGWQE7BjRTcutKAgyCtvI4g0w7T0DuFL3u6RbA3lpw4cwHz76UPB3jluHC2D8tnZvoO G+pL5VETmsyto0b6RMCRkYgZ16oDB3fc7YyZxFIqT74cGgdwzYFGPUJNvRyTydVMq5q1 nhldYUz0rrD0KpDW/JflRoxSD0IWrFGCJRFPl716ad49ZVViiEvaCU3c20k0cM3k3Szu JurCe48ZTNHhhFTx5hKInBWk86GPcKfEqB0wx+wiGUvumHyCGqj/wOxXWH03GBcP2lYL HpYw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1738004560; x=1738609360; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=3JftDG29tZaDaYyUdfTo570aq5S7mDB8kQuEqkFJx6s=; b=mPf91Lw+3Zbko4dhKqk0Hn6TIugoVpGqHcY/KqR51rDNFKLsNcWB5pv5mc8i53cpvR a2Z1JkzLdtvTCjSggFChD8tDtmTEupPMIZ/KyOsFd9MgiTWs0Ogpu5xFK48x7AAvXeVR y5Cmy8EWTbQmlVvs8Ny1bxEMYpEl66Qkfze/Hna/6wwkM3QJiE8Z6pIlKEahaYkw/UjF v01TqGwASa5URr0bk3u/7bAW6h+RtJkWcopKgwJH2bDK/e1mmM0z/PUOtyWyMCkJyNGh GS0C3VT9RvTFx6ZE8HembunVgd+lOxoZf3aaSxh5LE2mXsxdlYH4sykoapa/l3JrY3lh utxg== X-Gm-Message-State: AOJu0Ywo4Cu4xmhCt1txqbsELNh0mN/3gqXKdqfc1218d0DX8O8a+J82 IAcCaIj+yGaEB43O61dlxyZQz0GLvBYLckmdBvWcYyo+v+y5Wt3711oF7Q== X-Gm-Gg: ASbGncui1+IZ/mrCJCjHEfopiupUsMj4EjVG0m+FOzmSp8AlYxZo+lNdYWldATWpCyU bpIgTLBont5VLtzD+J+JKPT2igVPS4bp1hM9zsdUlhXjHxnPHBSON+WcPqmTVtWQO7pepnHip9J 6mruEsruBeQeEepbyhxam8y96lIftwgKr/rLQP4g66mD9q+sHQGujwupOd7UIIODhGoYLsdgkQD 8UsTU4AEYXiaAEW5zjSAsTVOBAs7g5LxV8gPYKbhnyTChWLQSQWcIdg1yJaYt6c1Bv5JMvXkQlb giRqrNokFawo5T1T X-Google-Smtp-Source: AGHT+IGaKruSQ5hFUe7wQHblEXdJL3IJxtt6t4P1PxjLGROLVmQE29KLx/oSqigCW9tJ60Pvit12MQ== X-Received: by 2002:a05:600c:1d95:b0:434:ff08:202e with SMTP id 5b1f17b1804b1-438d596dc8bmr4108915e9.8.1738004559636; Mon, 27 Jan 2025 11:02:39 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-438bd4fa599sm148100595e9.7.2025.01.27.11.02.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 27 Jan 2025 11:02:39 -0800 (PST) Message-Id: <7ee1845144fda5b8192dfa13eaab3cbd669b39ed.1738004555.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Mon, 27 Jan 2025 19:02:29 +0000 Subject: [PATCH v4 2/7] pack-objects: add --name-hash-version option Fcc: Sent Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 To: git@vger.kernel.org Cc: gitster@pobox.com, johannes.schindelin@gmx.de, peff@peff.net, ps@pks.im, me@ttaylorr.com, johncai86@gmail.com, newren@gmail.com, jonathantanmy@google.com, karthik nayak , Derrick Stolee , Derrick Stolee From: Derrick Stolee From: Derrick Stolee The previous change introduced a new pack_name_hash_v2() function that intends to satisfy much of the hash locality features of the existing pack_name_hash() function while also distinguishing paths with similar final components of their paths. This change adds a new --name-hash-version option for 'git pack-objects' to allow users to select their preferred function version. This use of an integer version allows for future expansion and a direct way to later store a name hash version in the .bitmap format. For now, let's consider how effective this mechanism is when repacking a repository with different name hash versions. Specifically, we will execute 'git pack-objects' the same way a 'git repack -adf' process would, except we include --name-hash-version= for testing. On the Git repository, we do not expect much difference. All path names are short. This is backed by our results: | Stage | Pack Size | Repack Time | |-----------------------|-----------|-------------| | After clone | 260 MB | N/A | | --name-hash-version=1 | 127 MB | 129s | | --name-hash-version=2 | 127 MB | 112s | This example demonstrates how there is some natural overhead coming from the cloned copy because the server is hosting many forks and has not optimized for exactly this set of reachable objects. But the full repack has similar characteristics for both versions. Let's consider some repositories that are hitting too many collisions with version 1. First, let's explore the kinds of paths that are commonly causing these collisions: * "/CHANGELOG.json" is 15 characters, and is created by the beachball [1] tool. Only the final character of the parent directory can differentiate different versions of this file, but also only the two most-significant digits. If that character is a letter, then this is always a collision. Similar issues occur with the similar "/CHANGELOG.md" path, though there is more opportunity for differences In the parent directory. * Localization files frequently have common filenames but differentiates via parent directories. In C#, the name "/strings.resx.lcl" is used for these localization files and they will all collide in name-hash. [1] https://github.com/microsoft/beachball I've come across many other examples where some internal tool uses a common name across multiple directories and is causing Git to repack poorly due to name-hash collisions. One open-source example is the fluentui [2] repo, which uses beachball to generate CHANGELOG.json and CHANGELOG.md files, and these files have very poor delta characteristics when comparing against versions across parent directories. | Stage | Pack Size | Repack Time | |-----------------------|-----------|-------------| | After clone | 694 MB | N/A | | --name-hash-version=1 | 438 MB | 728s | | --name-hash-version=2 | 168 MB | 142s | [2] https://github.com/microsoft/fluentui In this example, we see significant gains in the compressed packfile size as well as the time taken to compute the packfile. Using a collection of repositories that use the beachball tool, I was able to make similar comparisions with dramatic results. While the fluentui repo is public, the others are private so cannot be shared for reproduction. The results are so significant that I find it important to share here: | Repo | --name-hash-version=1 | --name-hash-version=2 | |----------|-----------------------|-----------------------| | fluentui | 440 MB | 161 MB | | Repo B | 6,248 MB | 856 MB | | Repo C | 37,278 MB | 6,755 MB | | Repo D | 131,204 MB | 7,463 MB | Future changes could include making --name-hash-version implied by a config value or even implied by default during a full repack. It is important to point out that the name hash value is stored in the .bitmap file format, so we must force --name-hash-version=1 when bitmaps are being read or written. Later, the bitmap format could be updated to be aware of the name hash version so deltas can be quickly computed across the bitmapped/not-bitmapped boundary. To promote the safety of this parameter, the validate_name_hash_version() method will die() if the given name-hash version is incorrect and will disable newer versions if not yet compatible with other features, such as --write-bitmap-index. Signed-off-by: Derrick Stolee --- Documentation/git-pack-objects.txt | 32 +++++++++++++++++- builtin/pack-objects.c | 52 +++++++++++++++++++++++++++--- t/t5300-pack-object.sh | 31 ++++++++++++++++++ 3 files changed, 109 insertions(+), 6 deletions(-) diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt index e32404c6aae..7f69ae4855f 100644 --- a/Documentation/git-pack-objects.txt +++ b/Documentation/git-pack-objects.txt @@ -15,7 +15,8 @@ SYNOPSIS [--revs [--unpacked | --all]] [--keep-pack=] [--cruft] [--cruft-expiration=