Document why header parsing won't exceed a window.
When we parse the object header or the delta base reference we don't bother to loop over use_pack() calls. The reason we don't need to bother with calling use_pack for each byte accessed is that use_pack will always promise us at least 20 bytes (really the hash size) after the offset. This promise from use_pack simplifies a lot of code in the header parsing logic, as well as helps out the zlib library by ensuring there's always some data for it to consume during an inflate call. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
Shawn O. Pearce committed
Dec 23, 2006 at 02:34 UTC
8d8a4ea5530ef9c738341887a7dcece4abd7dcbe
1 file changed
+12
-4
sha1_file.c
+12
-4
@@ -903,10 +903,12 @@ static unsigned long get_delta_base(struct packed_git *p,
903
unsigned char *base_info = use_pack(p, w_curs, offset, NULL);
904
unsigned long base_offset;
905
906
- /* there must be at least 20 bytes left regardless of delta type */
907
- if (p->pack_size <= offset + 20)
908
- die("truncated pack file");
909
-
906
+ /* use_pack() assured us we have [base_info, base_info + 20)
907
+ * as a range that we can look at without walking off the
908
+ * end of the mapped window. Its actually the hash size
909
+ * that is assured. An OFS_DELTA longer than the hash size
910
+ * is stupid, as then a REF_DELTA would be smaller to store.
911
+ */
912
if (kind == OBJ_OFS_DELTA) {
913
unsigned used = 0;
914
unsigned char c = base_info[used++];
@@ -1009,6 +1011,12 @@ static unsigned long unpack_object_header(struct packed_git *p,
1011
unsigned int left;
1012
unsigned long used;
1013
1014
+ /* use_pack() assures us we have [base, base + 20) available
1015
+ * as a range that we can look at at. (Its actually the hash
1016
+ * size that is assurred.) With our object header encoding
1017
+ * the maximum deflated object size is 2^137, which is just
1018
+ * insane, so we know won't exceed what we have been given.
1019
+ */
1020
base = use_pack(p, w_curs, offset, &left);
1021
used = unpack_object_header_gently(base, left, type, sizep);
1022
if (!used)