@matheusbsbs / matheus-bagliano / commits / ac54c277f0
Fork 0

Be more careful about zlib return values

When creating a new object, we use "deflate(stream, Z_FINISH)" in a loop until it no longer returns Z_OK, and then we do "deflateEnd()" to finish up business. That should all work, but the fact is, it's not how you're _supposed_ to use the zlib return values properly: - deflate() should never return Z_OK in the first place, except if we need to increase the output buffer size (which we're not doing, and should never need to do, since we pre-allocated a buffer that is supposed to be able to hold the output in full). So the "while()" loop was incorrect: Z_OK doesn't actually mean "ok, continue", it means "ok, allocate more memory for me and continue"! - if we got an error return, we would consider it to be end-of-stream, but it could be some internal zlib error. In short, we should check for Z_STREAM_END explicitly, since that's the only valid return value anyway for the Z_FINISH case. - we never checked deflateEnd() return codes at all. Now, admittedly, none of these issues should ever happen, unless there is some internal bug in zlib. So this patch should make zero difference, but it seems to be the right thing to do. We should probablybe anal and check the return value of "deflateInit()" too! Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org> Signed-off-by: Junio C Hamano <junkio@cox.net>

Linus Torvalds committed Mar 20, 2007 at 11:38 UTC ac54c277f05c65f441efdc1b9cd7a04aaa6cf75a
1 file changed +9 -4
sha1_file.c
+9 -4
@@ -1947,7 +1947,7 @@ int hash_sha1_file(const void *buf, unsigned long len, const char *type,
1947
1948 int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *returnsha1)
1949 {
1950 - int size;
1950 + int size, ret;
1951 unsigned char *compressed;
1952 z_stream stream;
1953 unsigned char sha1[20];
@@ -2007,9 +2007,14 @@ int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned cha
2007 /* Then the data itself.. */
2008 stream.next_in = buf;
2009 stream.avail_in = len;
2010 - while (deflate(&stream, Z_FINISH) == Z_OK)
2011 - /* nothing */;
2012 - deflateEnd(&stream);
2010 + ret = deflate(&stream, Z_FINISH);
2011 + if (ret != Z_STREAM_END)
2012 + die("unable to deflate new object %s (%d)", sha1_to_hex(sha1), ret);
2013 +
2014 + ret = deflateEnd(&stream);
2015 + if (ret != Z_OK)
2016 + die("deflateEnd on object %s failed (%d)", sha1_to_hex(sha1), ret);
2017 +
2018 size = stream.total_out;
2019
2020 if (write_buffer(fd, compressed, size) < 0)