unpack_loose_rest(): never clean up zstream

The unpack_loose_rest() function has funny ownership semantics: we pass
in a z_stream opened by the caller, but then only _sometimes_ close it.

This oddity has developed over time. When the function was originally
split out in 5180cacc20 (Split up unpack_sha1_file() some more,
2005-06-02), it always called inflateEnd() to clean up the stream
(though nowadays it is a git_zstream and we call git_inflate_end()).

But in 7efbff7531 (unpack_sha1_file(): detect corrupt loose object
files., 2007-03-05) we added error code paths which don't close the
stream. This makes some sense, as we'd still look at parts of the stream
struct to decide which error to show (though I am not sure in practice
if inflateEnd() even touches those fields).

This subtlety makes it hard to know when the caller has to clean up the
stream and when it does not. That led to the leak fixed by aa9ef614dc
(object-file: fix memory leak when reading corrupted headers,
2024-08-14).

Let's instead always leave the stream intact, forcing the caller to
clean it up. You might think that would create more work for the
callers, but it actually ends up simplifying them, since they can put
the call to git_inflate_end() in the common cleanup code path.

Two things to note, though:

  - The check_stream_oid() function is used as a replacement for
    unpack_loose_rest() in read_loose_object() to read blobs. It
    inherited the same funny semantics, and we should fix it here, too
    (to keep the cleanup in read_loose_object() consistent).

  - In read_loose_object() we need a second "out" label, as we can jump
    to the existing label before opening the stream at all (and since
    the struct is opaque, there is no way to if it was initialized or
    not, so we must not call git_inflate_end() in that case).

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/object-file.c b/object-file.c
index 17d54c845d835d62dd4007ad5e71332c9a4dfb9e..f9713e4e8bacf1f08e7f258a58687012b535b098 100644 (file)
--- a/object-file.c
+++ b/object-file.c
@@ -1348,7 +1348,6 @@ static void *unpack_loose_rest(git_zstream *stream,
                }
        }
        if (status == Z_STREAM_END && !stream->avail_in) {
-               git_inflate_end(stream);
                return buf;
        }
 
@@ -1512,8 +1511,8 @@ static int loose_object_info(struct repository *r,
                die(_("loose object %s (stored in %s) is corrupt"),
                    oid_to_hex(oid), path);
 
-       git_inflate_end(&stream);
 cleanup:
+       git_inflate_end(&stream);
        munmap(map, mapsize);
        if (oi->sizep == &size_scratch)
                oi->sizep = NULL;
@@ -2735,7 +2734,6 @@ static int check_stream_oid(git_zstream *stream,
                the_hash_algo->update_fn(&c, buf, stream->next_out - buf);
                total_read += stream->next_out - buf;
        }
-       git_inflate_end(stream);
 
        if (status != Z_STREAM_END) {
                error(_("corrupt loose object '%s'"), oid_to_hex(expected_oid));
@@ -2782,34 +2780,34 @@ int read_loose_object(const char *path,
        if (unpack_loose_header(&stream, map, mapsize, hdr, sizeof(hdr),
                                NULL) != ULHR_OK) {
                error(_("unable to unpack header of %s"), path);
-               goto out;
+               goto out_inflate;
        }
 
        if (parse_loose_header(hdr, oi) < 0) {
                error(_("unable to parse header of %s"), path);
-               git_inflate_end(&stream);
-               goto out;
+               goto out_inflate;
        }
 
        if (*oi->typep == OBJ_BLOB && *size > big_file_threshold) {
                if (check_stream_oid(&stream, hdr, *size, path, expected_oid) < 0)
-                       goto out;
+                       goto out_inflate;
        } else {
                *contents = unpack_loose_rest(&stream, hdr, *size, expected_oid);
                if (!*contents) {
                        error(_("unable to unpack contents of %s"), path);
-                       git_inflate_end(&stream);
-                       goto out;
+                       goto out_inflate;
                }
                hash_object_file_literally(the_repository->hash_algo,
                                           *contents, *size,
                                           oi->type_name->buf, real_oid);
                if (!oideq(expected_oid, real_oid))
-                       goto out;
+                       goto out_inflate;
        }
 
        ret = 0; /* everything checks out */
 
+out_inflate:
+       git_inflate_end(&stream);
 out:
        if (map)
                munmap(map, mapsize);