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

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

From
Jeff King <peff@peff.net>
Date
Jul 8, 2026, 03:53 UTC
Message-ID
<20260708035305.GG41620@coredump.intra.peff.net>
In-Reply-To
<20260708035235.GA41491@coredump.intra.peff.net>

It only makes sense to call git_hash_update(), etc, on a hash context that has been initialized but not yet finalized or discarded. This is an unlikely error to make, but it's easy for us to catch it and complain.

It's especially important because it would quietly "work" for many hash backends (like sha1dc, which is just manipulating some bytes) but would cause undefined behavior with others (like OpenSSL, which puts the context onto the heap). Checking the flag lets us catch problems consistently on every build.

Note that we can't do the same for git_hash_init(). Even though it would cause a leak to call it twice (without an intervening final/discard), the point of the function is that the contents of the struct are undefined before the call. But calling it twice is an even less likely error to make, so not covering it is OK.

We leave git_hash_discard() alone, as its idempotent behavior is convenient for callers. We _could_ try to do something similar for git_hash_final(), allowing:

  git_hash_final(result, &ctx);
  git_hash_final(other_result, &ctx);

but it does not make much sense. After the first final() call we have thrown away the state, so we cannot produce the same output. We could come up with some sensible output (the null hash, or the empty hash), but double-calls like this are more likely a bug, so our best bet is to complain loudly (whereas the current code produces either nonsense output or undefined behavior, depending on the backend).

Signed-off-by: Jeff King <peff@peff.net>
---
 hash.c | 10 ++++++++++
 1 file changed, 10 insertions(+)
diff --git a/hash.c b/hash.c
index b1296f0018..82f7e24404 100644
--- a/hash.c
+++ b/hash.c
@@ -290,22 +290,32 @@ void git_hash_init(struct git_hash_ctx *ctx, const struct git_hash_algo *algop)
 
 void git_hash_clone(struct git_hash_ctx *dst, const struct git_hash_ctx *src)
 {
+	if (!src->active)
+		BUG("attempt to copy from an inactive hash context");
+	if (!dst->active)
+		BUG("attempt to copy to an inactive hash context");
 	src->algop->clone_fn(dst, src);
 }
 
 void git_hash_update(struct git_hash_ctx *ctx, const void *in, size_t len)
 {
+	if (!ctx->active)
+		BUG("attempt to update an inactive hash context");
 	ctx->algop->update_fn(ctx, in, len);
 }
 
 void git_hash_final(unsigned char *hash, struct git_hash_ctx *ctx)
 {
+	if (!ctx->active)
+		BUG("attempt to finalize an inactive hash context");
 	ctx->algop->final_fn(hash, ctx);
 	ctx->active = false;
 }
 
 void git_hash_final_oid(struct object_id *oid, struct git_hash_ctx *ctx)
 {
+	if (!ctx->active)
+		BUG("attempt to finalize an inactive hash context");
 	ctx->algop->final_oid_fn(oid, ctx);
 	ctx->active = false;
 }
-- 
2.55.0.459.g1b256877c9
Previous: Jeff KingNext: Patrick Steinhardt
Message 34 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.