treewide: always have a valid "index_state.repo" member

When the "repo" member was added to "the_index" in [1] the
repo_read_index() was made to populate it, but the unpopulated
"the_index" variable didn't get the same treatment.

Let's do that in initialize_the_repository() when we set it up, and
likewise for all of the current callers initialized an empty "struct
index_state".

This simplifies code that needs to deal with "the_index" or a custom
"struct index_state", we no longer need to second-guess this part of
the "index_state" deep in the stack. A recent example of such
second-guessing is the "istate->repo ? istate->repo : the_repository"
code in [2]. We can now simply use "istate->repo".

We're doing this by making use of the INDEX_STATE_INIT() macro (and
corresponding function) added in [3], which now have mandatory "repo"
arguments.

Because we now call index_state_init() in repository.c's
initialize_the_repository() we don't need to handle the case where we
have a "repo->index" whose "repo" member doesn't match the "repo"
we're setting up, i.e. the "Complete the double-reference" code in
repo_read_index() being altered here. That logic was originally added
in [1], and was working around the lack of what we now have in
initialize_the_repository().

For "fsmonitor-settings.c" we can remove the initialization of a NULL
"r" argument to "the_repository". This was added back in [4], and was
needed at the time for callers that would pass us the "r" from an
"istate->repo". Before this change such a change to
"fsmonitor-settings.c" would segfault all over the test suite (e.g. in
t0002-gitfile.sh).

This change has wider eventual implications for
"fsmonitor-settings.c". The reason the other lazy loading behavior in
it is required (starting with "if (!r->settings.fsmonitor) ..." is
because of the previously passed "r" being "NULL".

I have other local changes on top of this which move its configuration
reading to "prepare_repo_settings()" in "repo-settings.c", as we could
now start to rely on it being called for our "r". But let's leave all
of that for now, and narrowly remove this particular part of the
lazy-loading.

1. 1fd9ae517c4 (repository: add repo reference to index_state,
   2021-01-23)
2. ee1f0c242ef (read-cache: add index.skipHash config option,
   2023-01-06)
3. 2f6b1eb794e (cache API: add a "INDEX_STATE_INIT" macro/function,
   add release_index(), 2023-01-12)
4. 1e0ea5c4316 (fsmonitor: config settings are repository-specific,
   2022-03-25)

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---

This an updated verison of the 6/6 of [A], which per Junio's [B]
wasn't picked up with those patches, which are now in "next".

Junio: Now that Derrick's ds/omit-trailing-hash-in-index has landed on
"master" this can be applied on top a merge of "master" and what you
have in "ab/cache-api-cleanup" (that topic itself being based on a
too-old "master").

Since the v2 I changed the "Complete the double-reference" logic in
repo_read_index() so that we're not working around a state of a
affairs that no longer exists with this change.

A. https://lore.kernel.org/git/cover-v2-0.6-00000000000-20230112T124842Z-avarab@gmail.com/
B. https://lore.kernel.org/git/xmqqtu0u2q9u.fsf@gitster.g/

Range-diff:
1:  291233b0420 ! 1:  b4998652822 treewide: always have a valid "index_state.repo" member
    @@ Commit message
         code in [2]. We can now simply use "istate->repo".

         We're doing this by making use of the INDEX_STATE_INIT() macro (and
    -    corresponding function) added in the preceding commit, which now have
    -    mandatory "repo" arguments. As seen here there are cases where we set
    -    it to NULL, but only if we're about to fill in the correct non-NULL
    -    "repo" right afterwards.
    +    corresponding function) added in [3], which now have mandatory "repo"
    +    arguments.
    +
    +    Because we now call index_state_init() in repository.c's
    +    initialize_the_repository() we don't need to handle the case where we
    +    have a "repo->index" whose "repo" member doesn't match the "repo"
    +    we're setting up, i.e. the "Complete the double-reference" code in
    +    repo_read_index() being altered here. That logic was originally added
    +    in [1], and was working around the lack of what we now have in
    +    initialize_the_repository().

         For "fsmonitor-settings.c" we can remove the initialization of a NULL
    -    "r" argument to "the_repository". This was added back in [3], and was
    +    "r" argument to "the_repository". This was added back in [4], and was
         needed at the time for callers that would pass us the "r" from an
         "istate->repo". Before this change such a change to
         "fsmonitor-settings.c" would segfault all over the test suite (e.g. in
    @@ Commit message
            2021-01-23)
         2. ee1f0c242ef (read-cache: add index.skipHash config option,
            2023-01-06)
    -    3. 1e0ea5c4316 (fsmonitor: config settings are repository-specific,
    +    3. 2f6b1eb794e (cache API: add a "INDEX_STATE_INIT" macro/function,
    +       add release_index(), 2023-01-12)
    +    4. 1e0ea5c4316 (fsmonitor: config settings are repository-specific,
            2022-03-25)

         Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
    @@ repository.c: void initialize_the_repository(void)
      }

     @@ repository.c: int repo_read_index(struct repository *repo)
    + {
    + 	int res;

    ++	/* Complete the double-reference */
      	if (!repo->index) {
      		ALLOC_ARRAY(repo->index, 1);
     -		index_state_init(repo->index);
    -+		index_state_init(repo->index, NULL /* set below */);
    - 	}
    +-	}
    +-
    +-	/* Complete the double-reference */
    +-	if (!repo->index->repo)
    +-		repo->index->repo = repo;
    +-	else if (repo->index->repo != repo)
    ++		index_state_init(repo->index, repo);
    ++	} else if (repo->index->repo != repo) {
    + 		BUG("repo's index should point back at itself");
    ++	}
    + 
    + 	res = read_index_from(repo->index, repo->index_file, repo->gitdir);

    - 	/* Complete the double-reference */

      ## revision.c ##
     @@ revision.c: void add_index_objects_to_pending(struct rev_info *revs, unsigned int flags)

 apply.c                   |  2 +-
 builtin/difftool.c        |  2 +-
 builtin/sparse-checkout.c |  2 +-
 builtin/stash.c           |  8 ++++----
 builtin/worktree.c        |  2 +-
 cache.h                   |  9 ++++++---
 fsmonitor-settings.c      | 14 --------------
 fsmonitor.c               |  2 +-
 merge-recursive.c         |  2 +-
 read-cache.c              | 17 +++++------------
 repository.c              | 13 ++++++-------
 revision.c                |  2 +-
 sparse-index.c            |  9 ---------
 split-index.c             |  2 +-
 unpack-trees.c            |  2 +-
 15 files changed, 30 insertions(+), 58 deletions(-)

Message ID	patch-1.1-b4998652822-20230117T135234Z-avarab@gmail.com (mailing list archive)
State	Accepted
Commit	6269f8eaad054a02517f5e03873726e84a032d8e
Headers	show Return-Path: <git-owner@vger.kernel.org> X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0917BC3DA78 for <git@archiver.kernel.org>; Tue, 17 Jan 2023 13:58:19 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229775AbjAQN6R (ORCPT <rfc822;git@archiver.kernel.org>); Tue, 17 Jan 2023 08:58:17 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52714 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231382AbjAQN5w (ORCPT <rfc822;git@vger.kernel.org>); Tue, 17 Jan 2023 08:57:52 -0500 Received: from mail-ed1-x533.google.com (mail-ed1-x533.google.com [IPv6:2a00:1450:4864:20::533]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4512B3C28A for <git@vger.kernel.org>; Tue, 17 Jan 2023 05:57:08 -0800 (PST) Received: by mail-ed1-x533.google.com with SMTP id x36so10510447ede.13 for <git@vger.kernel.org>; Tue, 17 Jan 2023 05:57:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=ZmHw0Sp6zYSxOlSD/B8UrWkxk6c6/RGBuMJyk9Zx2vU=; b=XcF16cwMA026aXRLF6HbZLMZ/g33u/Whya9zneRorAjjuIzCI20kWsA5XT+4HSZBLq NhWUvhRvZOCAiqiE51sB2aT1jjFxj6E/bjDttqhUCTohMTZA8txAtJ75HX4TFHkBeWxo ETA+b9pZPZkAh0J/FllPusr+WLXMDlo2dJTTKIhg9MIMHutBAKXOBDwAii3RWwpxGjuY S9bxdmPXXWtpicenCC1TAYzVCnMNLW8kb2NoDTxdIOL6XVk8FvX4fiAnrQRpYi4FYxuN Uj45W0eY4Tt86prxZMllUaiOHyoH6W6DCe5KYzZRFEnLlb9LCrr3FDge6JWgSLO2Buqz ryyQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=ZmHw0Sp6zYSxOlSD/B8UrWkxk6c6/RGBuMJyk9Zx2vU=; b=od1+Txe7UpoX1UO8Pl2U/YyupdsDT/Cvc7yZ4y9dZP6XUZMDdYQDjQZdXbsKXGHvBb Shq8NSvkBaVtszNA0W6sw+cmay3txePOIuSlNhUbIS+5viJ5949/wtTs2PspvzbNAHa4 S0diHmt3qgX/go8Xnzekymr2jnO63bghj/jzJxipN2vBy8eOrFzh5IMayT62E8AS++gY Mdbjq6okmZTaiK1NtEF5G/T+FV7+KvOsqOvzfQR8IOOEAqyYCAtMJjMA0HhuOvcYXoda 4vhFtNNPkKLvfmdg7i2xOSKWAJA80VtpIVemvjSgD0BaorHF/K/DuaVKzlfcrwXlLpkA 6p9w== X-Gm-Message-State: AFqh2kp+VAaNVdYatTK9uyYJfgpLnAvPjXbyB+AkDhupX+iKCAOfJj0l +cP5Wzmlg89YfBEBfx0RuK8OwLJ6SVwlVQ== X-Google-Smtp-Source: AMrXdXvqoSlL+rs8n1+nrsRpstJIk/yI3SA/M3ft3JRXc2+ez19hdiOW1TGvQ0VXEtu1rELbMv0GIA== X-Received: by 2002:a05:6402:220e:b0:46c:aec4:606f with SMTP id cq14-20020a056402220e00b0046caec4606fmr2243080edb.23.1673963826148; Tue, 17 Jan 2023 05:57:06 -0800 (PST) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id v19-20020a509553000000b0046cbcc86bdesm13052515eda.7.2023.01.17.05.57.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 17 Jan 2023 05:57:05 -0800 (PST) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= <avarab@gmail.com> To: git@vger.kernel.org Cc: Junio C Hamano <gitster@pobox.com>, Derrick Stolee <derrickstolee@github.com>, Victoria Dye <vdye@github.com>, Jeff Hostetler <jeffhost@microsoft.com>, =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBC?= =?utf-8?b?amFybWFzb24=?= <avarab@gmail.com> Subject: [PATCH] treewide: always have a valid "index_state.repo" member Date: Tue, 17 Jan 2023 14:57:00 +0100 Message-Id: <patch-1.1-b4998652822-20230117T135234Z-avarab@gmail.com> X-Mailer: git-send-email 2.39.0.1225.g30a3d88132d In-Reply-To: <xmqqlem2coix.fsf@gitster.g> References: <xmqqlem2coix.fsf@gitster.g> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: <git.vger.kernel.org> X-Mailing-List: git@vger.kernel.org
Series	treewide: always have a valid "index_state.repo" member \| expand treewide: always have a valid "index_state.repo" member

treewide: always have a valid "index_state.repo" member

Commit Message

Comments

Patch