git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 8/8] refs: explicitly propagate errno from refs_read_raw_ref

From
Han-Wen Nienhuys <hanwen@google.com>
Date
Jul 5, 2021, 16:09 UTC
Message-ID
<CAFQ2z_OeO8ALHPv6JzL2UDWqEb6Um8e8nPYMWBH8mmaMvibMhQ@mail.gmail.com>
In-Reply-To
<8735sydvzs.fsf@evledraar.gmail.com>
On Thu, Jul 1, 2021 at 3:06 PM Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
Show 22 quoted lines
> > -     const char *result = refs_resolve_ref_unsafe_implicit_errno(
> > -             refs, refname, resolve_flags, oid, flags);
> > -     *failure_errno = errno;
> > -     return result;
> > +     int ignore;
> > +     return refs_resolve_ref_unsafe_with_errno(refs, refname, resolve_flags,
> > +                                               oid, flags, &ignore);
> >  }
>
> Okey, so here we have something like the "caller should explicitly
> ignore it" I suggested in <878s2qdy8y.fsf@evledraar.gmail.com>. We no
> longer set "errno" at all for the benefit of the callers of that
> function, but instead explicitly throw it away, our
> refs_resolve_ref_unsafe_with_errno() no longer sets errno.
>
> But this end-state seems to have resulted in introducing new bugs. A
> bunch of functions are thin wrappers for
> refs_resolve_ref_unsafe(). Previously they could inspect errno on a -1
> return, now they can't.
>
> I didn't look at them all, but just the second one I looked at,
> refs_read_ref_full() has a verify_lock() caller which calls it, and that
It looks like you were lucky. I looked at the output of

egrep -A7 -B7 --color -nH -e '(refs_resolve_refdup|resolve_refdup|refs_read_ref_full|read_ref_full|read_ref|refs_ref_exists|ref_exists|resolve_gitlink_ref|index_path)\(' *.[ch] */*.[ch]

and the case you pointed out is the only one which inspects errno after calling resolve_ref_unsafe (transitively through the grepped functions.)

Show 14 quoted lines
> function then expects a meaningful errno that it in turn ferries up with
> "can't verify ref". It in turn is called by lock_ref_oid_basic(), it
> ferries up that strbuf with the error, which'll now have a meaningless
> strerror(0) in it.
>
> So it seems to me that the refactoring being done here is halfway done,
> [..]
> of what you're starting here. I.e. we have a low-level function that may
> encounter an errno, and then callers removed from that via:
>
>     index_path() -> resolve_gitlink_ref() -> refs_resolve_ref_unsafe()
>..
> Where the common case for index_path() is to report the error we got,
> but it doesn't call die_errno() or error_errno() now, but really should,
"but really should": Why?

Why should all functions that resolve a ref print out system level errors? For example, that would entail large changes to sequencer.c which does "error" == "does not exist".

Also, the errors you print out will be fundamentally limited. An error in resolving HEAD could be caused by a problem in any of the following files

   .git/HEAD
   .git/packed-refs
   .git/refs/
   .git/refs/heads/
   .git/refs/heads/main

Since we have no way of reporting the filename involved, what is a user going to do with the error message ("file doesn't exist")? I think refs_verify_refname_available() provides a more realistic approach: create custom error messages for situations that a user is more likely to encounter.

Also, for something like the reftable backend, there are error classes that have no direct errno counterpart. For example, if reftable finds corrupt zlib data, should it invent a bogus errno code so it can work with the errno reporting system?

I'll take from this review that I should elide the part where errno is cleared, and leave it to someone else to figure out a more holistic strategy to error reporting.

-- 
Han-Wen Nienhuys - Google Munich
I work 80%. Don't expect answers from me on Fridays.
--
Google Germany GmbH, Erika-Mann-Strasse 33, 80636 Munich
Registergericht und -nummer: Hamburg, HRB 86891
Sitz der Gesellschaft: Hamburg
Geschäftsführer: Paul Manicle, Halimah DeLaine Prado
Previous: Ævar Arnfjörð BjarmasonNext: Ævar Arnfjörð Bjarmason
Message 38 of 148 in “refs: cleanup errno sideband ref related functions”
  1. 0/8 refs: cleanup errno sideband ref related functionsHan-Wen Nienhuys via GitGitGadget, Apr 29, 2021
  2. 1/8 refs: remove EINVAL specification from the errno sideband in read_raw_ref_fnHan-Wen Nienhuys via GitGitGadget, Apr 29, 2021
  3. Junio C HamanoApr 30, 2021
  4. Han-Wen NienhuysMay 19, 2021
  5. Jonathan TanJun 3, 2021
  6. Han-Wen NienhuysJun 9, 2021
  7. 2/8 refs/files-backend: stop setting errno from lock_ref_oid_basicHan-Wen Nienhuys via GitGitGadget, Apr 29, 2021
  8. Junio C HamanoApr 30, 2021
  9. Han-Wen NienhuysMay 19, 2021
  10. Jonathan TanJun 3, 2021
  11. Han-Wen NienhuysJun 10, 2021
  12. 4/8 refs: make errno output explicit for refs_resolve_ref_unsafeHan-Wen Nienhuys via GitGitGadget, Apr 29, 2021
  13. Jonathan TanJun 3, 2021
  14. Han-Wen NienhuysJun 10, 2021
  15. 5/8 refs: add failure_errno to refs_read_raw_ref() signatureHan-Wen Nienhuys via GitGitGadget, Apr 29, 2021
  16. 3/8 refs: make errno output explicit for read_raw_ref_fnHan-Wen Nienhuys via GitGitGadget, Apr 29, 2021
  17. Junio C HamanoApr 30, 2021
  18. Junio C HamanoApr 30, 2021
  19. Han-Wen NienhuysMay 19, 2021
  20. Jonathan TanJun 3, 2021
  21. Han-Wen NienhuysJun 10, 2021
  22. 8/8 refs: explicitly propagate errno from refs_read_raw_refHan-Wen Nienhuys via GitGitGadget, Apr 29, 2021
  23. 6/8 refs: clear errno return in refs_resolve_ref_unsafe()Han-Wen Nienhuys via GitGitGadget, Apr 29, 2021
  24. Jonathan TanJun 3, 2021
  25. Han-Wen NienhuysJun 10, 2021
  26. 7/8 refs: stop setting EINVAL and ELOOP in symref resolutionHan-Wen Nienhuys via GitGitGadget, Apr 29, 2021
  27. Jonathan TanJun 3, 2021
  28. Han-Wen NienhuysJun 10, 2021
  29. Jonathan TanJun 3, 2021
  30. Han-Wen NienhuysJun 9, 2021
  31. 0/8 refs: cleanup errno sideband ref related functionsHan-Wen Nienhuys via GitGitGadget, Jun 10, 2021
  32. 5/8 refs: use refs_resolve_ref_unsafe_with_errno() where neededHan-Wen Nienhuys via GitGitGadget, Jun 10, 2021
  33. Ævar Arnfjörð BjarmasonJul 1, 2021
  34. 4/8 refs: make errno output explicit for refs_resolve_ref_unsafeHan-Wen Nienhuys via GitGitGadget, Jun 10, 2021
  35. Ævar Arnfjörð BjarmasonJul 1, 2021
  36. 8/8 refs: explicitly propagate errno from refs_read_raw_refHan-Wen Nienhuys via GitGitGadget, Jun 10, 2021
  37. Ævar Arnfjörð BjarmasonJul 1, 2021
  38. Han-Wen NienhuysJul 5, 2021
  39. Ævar Arnfjörð BjarmasonJul 5, 2021
  40. Han-Wen NienhuysJul 5, 2021
  41. 1/8 refs: remove EINVAL errno output from specification of read_raw_ref_fnHan-Wen Nienhuys via GitGitGadget, Jun 10, 2021
  42. 2/8 refs/files-backend: stop setting errno from lock_ref_oid_basicHan-Wen Nienhuys via GitGitGadget, Jun 10, 2021
  43. Ævar Arnfjörð BjarmasonJul 1, 2021
  44. Han-Wen NienhuysJul 5, 2021
  45. 3/8 refs: make errno output explicit for read_raw_ref_fnHan-Wen Nienhuys via GitGitGadget, Jun 10, 2021
  46. Ævar Arnfjörð BjarmasonJul 1, 2021
  47. Han-Wen NienhuysJul 5, 2021
  48. 6/8 refs: add failure_errno to refs_read_raw_ref() signatureHan-Wen Nienhuys via GitGitGadget, Jun 10, 2021
  49. Ævar Arnfjörð BjarmasonJul 1, 2021
  50. 7/8 refs: clear errno return in refs_resolve_ref_unsafe()Han-Wen Nienhuys via GitGitGadget, Jun 10, 2021
  51. Ævar Arnfjörð BjarmasonJul 1, 2021
  52. Han-Wen NienhuysJun 14, 2021
  53. 0/5 refs: cleanup errno sideband ref related functionsHan-Wen Nienhuys via GitGitGadget, Jul 5, 2021
  54. 1/5 refs: remove EINVAL errno output from specification of read_raw_ref_fnHan-Wen Nienhuys via GitGitGadget, Jul 5, 2021
  55. 2/5 refs/files-backend: stop setting errno from lock_ref_oid_basicHan-Wen Nienhuys via GitGitGadget, Jul 5, 2021
  56. 3/5 refs: make errno output explicit for read_raw_ref_fnHan-Wen Nienhuys via GitGitGadget, Jul 5, 2021
  57. 4/5 refs: add failure_errno to refs_read_raw_ref() signatureHan-Wen Nienhuys via GitGitGadget, Jul 5, 2021
  58. Junio C HamanoJul 6, 2021
  59. 5/5 refs: make errno output explicit for refs_resolve_ref_unsafeHan-Wen Nienhuys via GitGitGadget, Jul 5, 2021
  60. Ævar Arnfjörð BjarmasonJul 6, 2021
  61. Han-Wen NienhuysJul 6, 2021
  62. Ævar Arnfjörð BjarmasonJul 6, 2021
  63. Han-Wen NienhuysJul 6, 2021
  64. 0/6 refs: cleanup errno sideband ref related functionsHan-Wen Nienhuys via GitGitGadget, Jul 6, 2021
  65. 1/6 refs: remove EINVAL errno output from specification of read_raw_ref_fnHan-Wen Nienhuys via GitGitGadget, Jul 6, 2021
  66. 2/6 refs/files-backend: stop setting errno from lock_ref_oid_basicHan-Wen Nienhuys via GitGitGadget, Jul 6, 2021
  67. 5/6 refs: explicitly return failure_errno from parse_loose_ref_contentsHan-Wen Nienhuys via GitGitGadget, Jul 6, 2021
  68. Junio C HamanoJul 6, 2021
  69. Han-Wen NienhuysJul 7, 2021
  70. 3/6 refs: make errno output explicit for read_raw_ref_fnHan-Wen Nienhuys via GitGitGadget, Jul 6, 2021
  71. 4/6 refs: add failure_errno to refs_read_raw_ref() signatureHan-Wen Nienhuys via GitGitGadget, Jul 6, 2021
  72. Junio C HamanoJul 6, 2021
  73. 6/6 refs: make errno output explicit for refs_resolve_ref_unsafeHan-Wen Nienhuys via GitGitGadget, Jul 6, 2021
  74. 0/6 refs: cleanup errno sideband ref related functionsHan-Wen Nienhuys via GitGitGadget, Jul 7, 2021
  75. 1/6 refs: remove EINVAL errno output from specification of read_raw_ref_fnHan-Wen Nienhuys via GitGitGadget, Jul 7, 2021
  76. 2/6 refs/files-backend: stop setting errno from lock_ref_oid_basicHan-Wen Nienhuys via GitGitGadget, Jul 7, 2021
  77. Ævar Arnfjörð BjarmasonJul 11, 2021
  78. Han-Wen NienhuysJul 13, 2021
  79. 3/6 refs: make errno output explicit for read_raw_ref_fnHan-Wen Nienhuys via GitGitGadget, Jul 7, 2021
  80. Ævar Arnfjörð BjarmasonJul 11, 2021
  81. 4/6 refs: add failure_errno to refs_read_raw_ref() signatureHan-Wen Nienhuys via GitGitGadget, Jul 7, 2021
  82. Ævar Arnfjörð BjarmasonJul 11, 2021
  83. Han-Wen NienhuysJul 13, 2021
  84. 5/6 refs: explicitly return failure_errno from parse_loose_ref_contentsHan-Wen Nienhuys via GitGitGadget, Jul 7, 2021
  85. Ævar Arnfjörð BjarmasonJul 11, 2021
  86. 6/6 refs: make errno output explicit for refs_resolve_ref_unsafeHan-Wen Nienhuys via GitGitGadget, Jul 7, 2021
  87. Junio C HamanoJul 7, 2021
  88. 00/17 refs API: get rid of errno setting entirelyÆvar Arnfjörð Bjarmason, Jul 11, 2021
  89. 01/17 refs: remove EINVAL errno output from specification of read_raw_ref_fnÆvar Arnfjörð Bjarmason, Jul 11, 2021
  90. 03/17 refs: make errno output explicit for read_raw_ref_fnÆvar Arnfjörð Bjarmason, Jul 11, 2021
  91. 02/17 refs/files-backend: stop setting errno from lock_ref_oid_basicÆvar Arnfjörð Bjarmason, Jul 11, 2021
  92. 04/17 refs: add failure_errno to refs_read_raw_ref() signatureÆvar Arnfjörð Bjarmason, Jul 11, 2021
  93. 05/17 refs: explicitly return failure_errno from parse_loose_ref_contentsÆvar Arnfjörð Bjarmason, Jul 11, 2021
  94. 06/17 refs: make errno output explicit for refs_resolve_ref_unsafeÆvar Arnfjörð Bjarmason, Jul 11, 2021
  95. 07/17 refs: make errno ignoring explicit in lock_ref_oid_basic()Ævar Arnfjörð Bjarmason, Jul 11, 2021
  96. 10/17 refs API: remove refs_read_ref_full() wrapperÆvar Arnfjörð Bjarmason, Jul 11, 2021
  97. 11/17 refs API: make resolve_gitlink_ref() not set errnoÆvar Arnfjörð Bjarmason, Jul 11, 2021
  98. 08/17 refs file-backend.c: stop setting "EBUSY" in verify_lock()Ævar Arnfjörð Bjarmason, Jul 11, 2021
  99. Han-Wen NienhuysJul 13, 2021
  100. 09/17 refs file-backend.c: deal with errno directly in verify_lock()Ævar Arnfjörð Bjarmason, Jul 11, 2021
  101. 12/17 refs API: make refs_resolve_ref_unsafe() staticÆvar Arnfjörð Bjarmason, Jul 11, 2021
  102. 13/17 refs API: make refs_resolve_refdup() not set errnoÆvar Arnfjörð Bjarmason, Jul 11, 2021
  103. 14/17 refs API: make refs_ref_exists() not set errnoÆvar Arnfjörð Bjarmason, Jul 11, 2021
  104. 15/17 refs API: make resolve_ref_unsafe() not set errnoÆvar Arnfjörð Bjarmason, Jul 11, 2021
  105. Han-Wen NienhuysJul 13, 2021
  106. Ævar Arnfjörð BjarmasonJul 14, 2021
  107. 17/17 refs API: don't leak "errno" in run_transaction_hook()Ævar Arnfjörð Bjarmason, Jul 11, 2021
  108. 16/17 refs API: make expand_ref() and repo_dwim_log() not set errnoÆvar Arnfjörð Bjarmason, Jul 11, 2021
  109. Han-Wen NienhuysJul 13, 2021
  110. Ævar Arnfjörð BjarmasonJul 13, 2021
  111. Ævar Arnfjörð BjarmasonJul 14, 2021
  112. Han-Wen NienhuysJul 14, 2021
  113. 0/6 refs: cleanup errno sideband ref related functionsÆvar Arnfjörð Bjarmason, Jul 14, 2021
  114. 1/6 refs: remove EINVAL errno output from specification of read_raw_ref_fnÆvar Arnfjörð Bjarmason, Jul 14, 2021
  115. 2/6 refs/files-backend: stop setting errno from lock_ref_oid_basicÆvar Arnfjörð Bjarmason, Jul 14, 2021
  116. 3/6 refs: make errno output explicit for read_raw_ref_fnÆvar Arnfjörð Bjarmason, Jul 14, 2021
  117. 4/6 refs: add failure_errno to refs_read_raw_ref() signatureÆvar Arnfjörð Bjarmason, Jul 14, 2021
  118. 5/6 refs: explicitly return failure_errno from parse_loose_ref_contentsÆvar Arnfjörð Bjarmason, Jul 14, 2021
  119. 6/6 refs: make errno output explicit for refs_resolve_ref_unsafeÆvar Arnfjörð Bjarmason, Jul 14, 2021
  120. 0/7 refs: cleanup errno sideband ref related functionsÆvar Arnfjörð Bjarmason, Jul 16, 2021
  121. 1/7 refs file backend: move raceproof_create_file() hereÆvar Arnfjörð Bjarmason, Jul 16, 2021
  122. 3/7 refs/files-backend: stop setting errno from lock_ref_oid_basicÆvar Arnfjörð Bjarmason, Jul 16, 2021
  123. 2/7 refs: remove EINVAL errno output from specification of read_raw_ref_fnÆvar Arnfjörð Bjarmason, Jul 16, 2021
  124. 4/7 refs: make errno output explicit for read_raw_ref_fnÆvar Arnfjörð Bjarmason, Jul 16, 2021
  125. 5/7 refs: add failure_errno to refs_read_raw_ref() signatureÆvar Arnfjörð Bjarmason, Jul 16, 2021
  126. 6/7 refs: explicitly return failure_errno from parse_loose_ref_contentsÆvar Arnfjörð Bjarmason, Jul 16, 2021
  127. 7/7 refs: make errno output explicit for refs_resolve_ref_unsafeÆvar Arnfjörð Bjarmason, Jul 16, 2021
  128. 0/7 refs: cleanup errno sideband ref related functionsÆvar Arnfjörð Bjarmason, Jul 20, 2021
  129. 1/7 refs file backend: move raceproof_create_file() hereÆvar Arnfjörð Bjarmason, Jul 20, 2021
  130. 2/7 refs: remove EINVAL errno output from specification of read_raw_ref_fnÆvar Arnfjörð Bjarmason, Jul 20, 2021
  131. 3/7 refs/files-backend: stop setting errno from lock_ref_oid_basicÆvar Arnfjörð Bjarmason, Jul 20, 2021
  132. 4/7 refs: make errno output explicit for read_raw_ref_fnÆvar Arnfjörð Bjarmason, Jul 20, 2021
  133. Han-Wen NienhuysAug 16, 2021
  134. 5/7 refs: add failure_errno to refs_read_raw_ref() signatureÆvar Arnfjörð Bjarmason, Jul 20, 2021
  135. 6/7 refs: explicitly return failure_errno from parse_loose_ref_contentsÆvar Arnfjörð Bjarmason, Jul 20, 2021
  136. Jonathan TanAug 13, 2021
  137. 7/7 refs: make errno output explicit for refs_resolve_ref_unsafeÆvar Arnfjörð Bjarmason, Jul 20, 2021
  138. Ævar Arnfjörð BjarmasonJul 26, 2021
  139. Junio C HamanoJul 27, 2021
  140. 0/8 refs: cleanup errno sideband ref related functionsÆvar Arnfjörð Bjarmason, Aug 23, 2021
  141. 1/8 refs file backend: move raceproof_create_file() hereÆvar Arnfjörð Bjarmason, Aug 23, 2021
  142. 2/8 refs: remove EINVAL errno output from specification of read_raw_ref_fnÆvar Arnfjörð Bjarmason, Aug 23, 2021
  143. 3/8 refs/files-backend: stop setting errno from lock_ref_oid_basicÆvar Arnfjörð Bjarmason, Aug 23, 2021
  144. 4/8 refs: make errno output explicit for read_raw_ref_fnÆvar Arnfjörð Bjarmason, Aug 23, 2021
  145. 5/8 refs: add failure_errno to refs_read_raw_ref() signatureÆvar Arnfjörð Bjarmason, Aug 23, 2021
  146. 6/8 branch tests: test for errno propagating on failing readÆvar Arnfjörð Bjarmason, Aug 23, 2021
  147. 7/8 refs: explicitly return failure_errno from parse_loose_ref_contentsÆvar Arnfjörð Bjarmason, Aug 23, 2021
  148. 8/8 refs: make errno output explicit for refs_resolve_ref_unsafeÆvar Arnfjörð Bjarmason, Aug 23, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.