@matheusbsbs / matheus-bagliano / commits / cac15b3fb4

refs API: use "failure_errno", not "errno"

Fix a logic error in refs_resolve_ref_unsafe() introduced in a recent series of mine to abstract the refs API away from errno. See 96f6623ada0 (Merge branch 'ab/refs-errno-cleanup', 2021-11-29)for that series. In that series introduction of "failure_errno" to refs_resolve_ref_unsafe came in ef18119dec8 (refs API: add a version of refs_resolve_ref_unsafe() with "errno", 2021-10-16). There we'd set "errno = 0" immediately before refs_read_raw_ref(), and then set "failure_errno" to "errno" if errno was non-zero afterwards. Then in the next commit 8b72fea7e91 (refs API: make refs_read_raw_ref() not set errno, 2021-10-16) we started expecting "refs_read_raw_ref()" to set "failure_errno". It would do that if refs_read_raw_ref() failed, but it wouldn't be the same errno. So we might set the "errno" here to any arbitrary bad value, and end up e.g. returning NULL when we meant to return the refname from refs_resolve_ref_unsafe(), or the other way around. Instrumenting this code will reveal cases where refs_read_raw_ref() will fail, and "errno" and "failure_errno" will be set to different values. In practice I haven't found a case where this scary bug changed anything in practice. The reason for that is that we'll not care about the actual value of "errno" here per-se, but only whether: 1. We have an errno 2. If it's one of ENOENT, EISDIR or ENOTDIR. See the adjacent code added in a1c1d8170db (refs_resolve_ref_unsafe: handle d/f conflicts for writes, 2017-10-06) I.e. if we clobber "failure_errno" with "errno", but it happened to be one of those three, and we'll clobber it with another one of the three we were OK. Perhaps there are cases where the difference ended up mattering, but I haven't found them. Instrumenting the test suite to fail if "errno" and "failure_errno" are different shows a lot of failures, checking if they're different *and* one is but not the other is outside that list of three "errno" values yields no failures. But let's fix the obvious bug. We should just stop paying attention to "errno" in refs_resolve_ref_unsafe(). In addition let's change the partial resetting of "errno" in files_read_raw_ref() to happen just before the "return", to ensure that any such bug will be more easily spotted in the future. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Ævar Arnfjörð Bjarmason committed Jan 12, 2022 at 13:36 UTC cac15b3fb422efb2cd1572cc654793d5df5fa434

2 files changed +1 -4

refs.c

-2

@@ -1713,8 +1713,6 @@ const char *refs_resolve_ref_unsafe(struct ref_store *refs,

1713 if (refs_read_raw_ref(refs, refname, oid, &sb_refname,

1714 &read_flags, failure_errno)) {

1715 *flags |= read_flags;

1716 - if (errno)

1717 - *failure_errno = errno;

1716

1717 /* In reading mode, refs must eventually resolve */

1718 if (resolve_flags & RESOLVE_REF_READING)

refs/files-backend.c

+1 -2

@@ -385,7 +385,6 @@ stat_ref:

385 if (lstat(path, &st) < 0) {

386 int ignore_errno;

387 myerr = errno;

388 - errno = 0;

388 if (myerr != ENOENT)

389 goto out;

390 if (refs_read_raw_ref(refs->packed_ref_store, refname, oid,

@@ -402,7 +401,6 @@ stat_ref:

401 strbuf_reset(&sb_contents);

402 if (strbuf_readlink(&sb_contents, path, st.st_size) < 0) {

403 myerr = errno;

405 - errno = 0;

404 if (myerr == ENOENT || myerr == EINVAL)

405 /* inconsistent with lstat; retry */

406 goto stat_ref;

@@ -472,6 +470,7 @@ out:

470

471 strbuf_release(&sb_path);

472 strbuf_release(&sb_contents);

473 + errno = 0;

474 return ret;

475 }

476