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

Re: [PATCH 7/7] hash: check ctx->active flag in all wrapper functions

From
Jeff King <peff@peff.net>
Date
Jul 7, 2026, 20:10 UTC
Message-ID
<20260707201046.GB11780@coredump.intra.peff.net>
In-Reply-To
<xmqqcxwy7oal.fsf@gitster.g>
On Tue, Jul 07, 2026 at 09:33:06AM -0700, Junio C Hamano wrote:
Show 6 quoted lines
> Among the four we see here, I agree that calling _clone and _update
> on an already discarded or finalized context should be caught as an
> error. As I alluded to earlier, though, I am not sure about
> _final. The asymmetry in a design that allows _discard after _final
> but not _final after _final disturbs me slightly, but perhaps that
> is only because my morning caffeine has not yet kicked in. 
There was more discussion in the earlier thread:
  https://lore.kernel.org/git/20260706000105.GA2301945@coredump.intra.peff.net/

But basically the asymmetry comes from the fact that the finalize is trying to _do_ something, whereas discard is just, well, discarding.

So what should:
  git_hash_discard(&ctx);
  git_hash_finalize(result, &ctx);
put into result? It is probably one of:
  1. the null hash
  2. the hash you get from init() + no updates + final()
  3. nothing, BUG() instead

It seems nice at first that (1) or (2) won't cause the program to crash, but ultimately they are probably the sign of a bug in the program. So complaining loudly via BUG() is probably our best bet. We could always loosen it later if somebody actually adds code where another behavior makes sense (we know there are not such paths now, as they'd segfault under openssl's heap-based backend).

-Peff
Previous: Junio C HamanoNext: Patrick Steinhardt
Message 25 of 35 in “git_hash_*() quality-of-life improvements”
  1. 0/7 git_hash_*() quality-of-life improvementsJeff King, Jul 7, 2026
  2. 1/7 hash: use git_hash_init() consistentlyJeff King, Jul 7, 2026
  3. Junio C HamanoJul 7, 2026
  4. Jeff KingJul 7, 2026
  5. Junio C HamanoJul 7, 2026
  6. Jeff KingJul 7, 2026
  7. brian m. carlsonJul 7, 2026
  8. Jeff KingJul 8, 2026
  9. 2/7 hash: convert remaining direct function callsJeff King, Jul 7, 2026
  10. Junio C HamanoJul 7, 2026
  11. 3/7 hash: document function pointers and wrappersJeff King, Jul 7, 2026
  12. Patrick SteinhardtJul 7, 2026
  13. Jeff KingJul 7, 2026
  14. 4/7 hash: make git_hash_discard() idempotentJeff King, Jul 7, 2026
  15. Junio C HamanoJul 7, 2026
  16. Jeff KingJul 7, 2026
  17. brian m. carlsonJul 7, 2026
  18. Junio C HamanoJul 7, 2026
  19. 5/7 csum-file: use idempotent git_hash_discard()Jeff King, Jul 7, 2026
  20. 6/7 http: use idempotent git_hash_discard()Jeff King, Jul 7, 2026
  21. Junio C HamanoJul 7, 2026
  22. 7/7 hash: check ctx->active flag in all wrapper functionsJeff King, Jul 7, 2026
  23. Patrick SteinhardtJul 7, 2026
  24. Junio C HamanoJul 7, 2026
  25. Jeff KingJul 7, 2026
  26. Patrick SteinhardtJul 7, 2026
  27. 0/7 git_hash_*() quality-of-life improvementsJeff King, Jul 8, 2026
  28. 1/7 hash: use git_hash_init() consistentlyJeff King, Jul 8, 2026
  29. 2/7 hash: convert remaining direct function callsJeff King, Jul 8, 2026
  30. 3/7 hash: document function pointers and wrappersJeff King, Jul 8, 2026
  31. 4/7 hash: make git_hash_discard() idempotentJeff King, Jul 8, 2026
  32. 5/7 csum-file: use idempotent git_hash_discard()Jeff King, Jul 8, 2026
  33. 6/7 http: use idempotent git_hash_discard()Jeff King, Jul 8, 2026
  34. 7/7 hash: check ctx->active flag in all wrapper functionsJeff King, Jul 8, 2026
  35. Patrick SteinhardtJul 8, 2026

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.