commit-graph: check chunk sizes after writing

In my experience while experimenting with new commit-graph chunks,
early versions of the corresponding new write_commit_graph_my_chunk()
functions are, sadly but not surprisingly, often buggy, and write more
or less data than they are supposed to, especially if the chunk size
is not directly proportional to the number of commits.  This then
causes all kinds of issues when reading such a bogus commit-graph
file, raising the question of whether the writing or the reading part
happens to be buggy this time.

Let's catch such issues early, already when writing the commit-graph
file, and check that each write_graph_chunk_*() function wrote the
amount of data that it was expected to, and what has been encoded in
the Chunk Lookup table.  Now that all commit-graph chunks are written
in a loop we can do this check in a single place for all chunks, and
any chunks added in the future will get checked as well.

Helped-by: René Scharfe <l.s.r@web.de>
Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/commit-graph.c b/commit-graph.c
index 2b26a9dad36b7122360d45e2a41479929ccbea69..6752916c1acda44dcd8113b3f5e3f1078d960e9d 100644 (file)
--- a/commit-graph.c
+++ b/commit-graph.c
@@ -1693,8 +1693,15 @@ static int write_commit_graph_file(struct write_commit_graph_context *ctx)
        }
 
        for (i = 0; i < num_chunks; i++) {
+               uint64_t start_offset = f->total + f->offset;
+
                if (chunks[i].write_fn(f, ctx))
                        return -1;
+
+               if (f->total + f->offset != start_offset + chunks[i].size)
+                       BUG("expected to write %"PRId64" bytes to chunk %"PRIx32", but wrote %"PRId64" instead",
+                           chunks[i].size, chunks[i].id,
+                           f->total + f->offset - start_offset);
        }
 
        stop_progress(&ctx->progress);