2 .\" Title: gitformat-pack
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
7 .\" Source: Git 2.46.0.267.gbb9c16bd4f
10 .TH "GITFORMAT\-PACK" "5" "2024-08-19" "Git 2\&.46\&.0\&.267\&.gbb9c16" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 gitformat-pack \- Git pack format
35 $GIT_DIR/objects/pack/pack\-\fB\&.{pack,idx}
36 $GIT_DIR/objects/pack/pack\-\fR\&.rev
37 $GIT_DIR/objects/pack/pack\-*\&.mtimes
38 $GIT_DIR/objects/pack/multi\-pack\-index
42 The Git pack format is how Git stores most of its primary repository data\&. Over the lifetime of a repository, loose objects (if any) and smaller packs are consolidated into larger pack(s)\&. See \fBgit-gc\fR(1) and \fBgit-pack-objects\fR(1)\&.
44 The pack format is also used over\-the\-wire, see e\&.g\&. \fBgitprotocol-v2\fR(5), as well as being a part of other container formats in the case of \fBgitformat-bundle\fR(5)\&.
45 .SH "CHECKSUMS AND OBJECT IDS"
47 In a repository using the traditional SHA\-1, pack checksums, index checksums, and object IDs (object names) mentioned below are all computed using SHA\-1\&. Similarly, in SHA\-256 repositories, these values are computed using SHA\-256\&.
48 .SH "PACK\-*\&.PACK FILES HAVE THE FOLLOWING FORMAT:"
58 A header appears at the beginning and consists of the following:
65 The signature is: {\*(AqP\*(Aq, \*(AqA\*(Aq, \*(AqC\*(Aq, \*(AqK\*(Aq}
75 4\-byte version number (network byte order):
76 Git currently accepts version number 2 or 3 but
77 generates version 2 only\&.
87 4\-byte number of objects contained in the pack (network byte order)
97 Observation: we cannot have more than 4G versions ;\-) and
98 more than 4G objects in a pack\&.
113 The header is followed by a number of object entries, each of which looks like this:
119 (undeltified representation)
120 n\-byte type and length (3\-bit type, (n\-1)*7+4\-bit length)
131 (deltified representation)
132 n\-byte type and length (3\-bit type, (n\-1)*7+4\-bit length)
133 base object name if OBJ_REF_DELTA or a negative relative
134 offset from the delta object\*(Aqs position in the pack if this
135 is an OBJ_OFS_DELTA object
136 compressed delta data
146 Observation: the length of each object is encoded in a variable
147 length format and is not constrained to 32\-bit or anything\&.
162 The trailer records a pack checksum of all of the above\&.
166 Valid object types are:
234 Type 5 is reserved for future expansion\&. Type 0 is invalid\&.
237 This document uses the following "size encoding" of non\-negative integers: From each byte, the seven least significant bits are used to form the resulting integer\&. As long as the most significant bit is 1, this process continues; the byte with MSB 0 provides the last seven bits\&. The seven\-bit chunks are concatenated\&. Later values are more significant\&.
239 This size encoding should not be confused with the "offset encoding", which is also used in this document\&.
240 .SS "Deltified representation"
242 Conceptually there are only four object types: commit, tree, tag and blob\&. However to save space, an object could be stored as a "delta" of another "base" object\&. These representations are assigned new types ofs\-delta and ref\-delta, which is only valid in a pack file\&.
244 Both ofs\-delta and ref\-delta store the "delta" to be applied to another object (called \fIbase object\fR) to reconstruct the object\&. The difference between them is, ref\-delta directly encodes base object name\&. If the base object is in the same pack, ofs\-delta encodes the offset of the base object in the pack instead\&.
246 The base object could also be deltified if it\(cqs in the same pack\&. Ref\-delta can also refer to an object outside the pack (i\&.e\&. the so\-called "thin pack")\&. When stored on disk however, the pack should be self contained to avoid cyclic dependency\&.
248 The delta data starts with the size of the base object and the size of the object to be reconstructed\&. These sizes are encoded using the size encoding from above\&. The remainder of the delta data is a sequence of instructions to reconstruct the object from the base object\&. If the base object is deltified, it must be converted to canonical form first\&. Each instruction appends more and more data to the target object until it\(cqs complete\&. There are two supported instructions so far: one for copying a byte range from the source object and one for inserting new data embedded in the instruction itself\&.
250 Each instruction has variable length\&. Instruction type is determined by the seventh bit of the first octet\&. The following diagrams follow the convention in RFC 1951 (Deflate compressed data format)\&.
253 .nr an-no-space-flag 1
257 \fBInstruction to copy from base object\fR
264 +\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+
265 | 1xxxxxxx | offset1 | offset2 | offset3 | offset4 | size1 | size2 | size3 |
266 +\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+
272 This is the instruction format to copy a byte range from the source object\&. It encodes the offset to copy from and the number of bytes to copy\&. Offset and size are in little\-endian order\&.
274 All offset and size bytes are optional\&. This is to reduce the instruction size when encoding small offsets or sizes\&. The first seven bits in the first octet determine which of the next seven octets is present\&. If bit zero is set, offset1 is present\&. If bit one is set offset2 is present and so on\&.
276 Note that a more compact instruction does not change offset and size encoding\&. For example, if only offset2 is omitted like below, offset3 still contains bits 16\-23\&. It does not become offset2 and contains bits 8\-15 even if it\(cqs right next to offset1\&.
282 +\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+
283 | 10000101 | offset1 | offset3 |
284 +\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+
290 In its most compact form, this instruction only takes up one byte (0x80) with both offset and size omitted, which will have default values zero\&. There is another exception: size zero is automatically converted to 0x10000\&.
294 .nr an-no-space-flag 1
298 \fBInstruction to add new data\fR
305 +\-\-\-\-\-\-\-\-\-\-+============+
307 +\-\-\-\-\-\-\-\-\-\-+============+
313 This is the instruction to construct the target object without the base object\&. The following data is appended to the target object\&. The first seven bits of the first octet determine the size of data in bytes\&. The size must be non\-zero\&.
317 .nr an-no-space-flag 1
321 \fBReserved instruction\fR
328 +\-\-\-\-\-\-\-\-\-\-+============
330 +\-\-\-\-\-\-\-\-\-\-+============
336 This is the instruction reserved for future expansion\&.
338 .SH "ORIGINAL (VERSION 1) PACK\-*\&.IDX FILES HAVE THE FOLLOWING FORMAT:"
348 The header consists of 256 4\-byte network byte order integers\&. N\-th entry of this table records the number of objects in the corresponding pack, the first byte of whose object name is less than or equal to N\&. This is called the
349 \fIfirst\-level fan\-out\fR
361 The header is followed by sorted 24\-byte entries, one entry per object in the pack\&. Each entry is:
367 4\-byte network byte order integer, recording where the
368 object is stored in the packfile as the offset from the
379 one object name of the appropriate size\&.
394 The file is concluded with a trailer:
400 A copy of the pack checksum at the end of the corresponding
411 Index checksum of all of the above\&.
424 \-\- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
425 fanout | fanout[0] = 2 (for example) |\-\&.
426 table +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ |
428 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ |
430 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
431 | fanout[255] = total objects |\-\-\-\&.
432 \-\- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | |
434 index | object name 00XXXXXXXXXXXXXXXX | | |
435 table +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | |
437 | object name 00XXXXXXXXXXXXXXXX | | |
438 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+<+ |
440 | | object name 01XXXXXXXXXXXXXXXX | |
441 | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ |
443 | | object name 01XXXXXXXXXXXXXXXX | |
444 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
446 | | object name FFXXXXXXXXXXXXXXXX | |
447 \-\-| +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+<\-\-+
448 trailer | | packfile checksum |
449 | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
450 | | idxfile checksum |
451 | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
464 packed object header:
465 1\-byte size extension bit (MSB)
468 n\-byte sizeN (as long as MSB is set, each 7\-bit)
469 size0\&.\&.sizeN form 4+7+7+\&.\&.+7 bit integer, size0
470 is the least significant part, and sizeN is the
471 most significant part\&.
473 If it is not DELTA, then deflated bytes (the size above
474 is the size before compression)\&.
475 If it is REF_DELTA, then
476 base object name (the size above is the
477 size of the delta data that follows)\&.
478 delta data, deflated\&.
479 If it is OFS_DELTA, then
480 n\-byte offset (see below) interpreted as a negative
481 offset from the type\-byte of the header of the
482 ofs\-delta entry (the size above is the size of
483 the delta data that follows)\&.
484 delta data, deflated\&.
495 n bytes with MSB set in all but the last one\&.
496 The offset is then the number constructed by
497 concatenating the lower 7 bit of each byte, and
498 for n >= 2 adding 2^7 + 2^14 + \&.\&.\&. + 2^(7*(n\-1))
504 .SH "VERSION 2 PACK\-*\&.IDX FILES SUPPORT PACKS LARGER THAN 4 GIB, AND"
510 have some other reorganizations\&. They have the format:
524 A 4\-byte magic number
526 which is an unreasonable fanout[0] value\&.
537 A 4\-byte version number (= 2)
548 A 256\-entry fan\-out table just like v1\&.
559 A table of sorted object names\&. These are packed together without offset values to reduce the cache footprint of the binary search for a specific object name\&.
570 A table of 4\-byte CRC32 values of the packed object data\&. This is new in v2 so compressed data can be copied directly from pack to pack during repacking without undetected data corruption\&.
581 A table of 4\-byte offset values (in network byte order)\&. These are usually 31\-bit pack file offsets, but large offsets are encoded as an index into the next table with the msbit set\&.
592 A table of 8\-byte offset entries (empty for pack files less than 2 GiB)\&. Pack files are organized with heavily used objects toward the front, so most object references should not need to refer to this table\&.
603 The same trailer as a v1 pack file:
609 A copy of the pack checksum at the end of the
610 corresponding packfile\&.
620 Index checksum of all of the above\&.
626 .SH "PACK\-*\&.REV FILES HAVE THE FORMAT:"
636 A 4\-byte magic number
649 A 4\-byte version identifier (= 1)\&.
660 A 4\-byte hash function identifier (= 1 for SHA\-1, 2 for SHA\-256)\&.
671 A table of index positions (one per packed object, num_objects in total, each a 4\-byte unsigned integer in network order), sorted by their corresponding offsets in the packfile\&.
682 A trailer, containing a:
688 checksum of the corresponding packfile, and
698 a checksum of all of the above\&.
705 All 4\-byte numbers are in network order\&.
706 .SH "PACK\-*\&.MTIMES FILES HAVE THE FORMAT:"
708 All 4\-byte numbers are in network byte order\&.
718 A 4\-byte magic number
731 A 4\-byte version identifier (= 1)\&.
742 A 4\-byte hash function identifier (= 1 for SHA\-1, 2 for SHA\-256)\&.
753 A table of 4\-byte unsigned integers\&. The ith value is the modification time (mtime) of the ith object in the corresponding pack by lexicographic (index) order\&. The mtimes count standard epoch seconds\&.
764 A trailer, containing a checksum of the corresponding packfile, and a checksum of all of the above (each having length according to the specified hash function)\&.
766 .SH "MULTI\-PACK\-INDEX (MIDX) FILES HAVE THE FOLLOWING FORMAT:"
768 The multi\-pack\-index files refer to multiple pack\-files and loose objects\&.
770 In order to allow extensions that add extra data to the MIDX, we organize the body into "chunks" and provide a lookup table at the beginning of the body\&. The header includes certain length values, such as the number of packs, the number of base MIDX files, hash lengths and types\&.
772 All 4\-byte numbers are in network order\&.
781 The signature is: {\*(AqM\*(Aq, \*(AqI\*(Aq, \*(AqD\*(Aq, \*(AqX\*(Aq}
791 1\-byte version number:
792 Git only writes or recognizes version 1\&.
802 1\-byte Object Id Version
803 We infer the length of object IDs (OIDs) from this value:
806 If the hash type does not match the repository\*(Aqs hash algorithm,
807 the multi\-pack\-index file should be ignored with a warning
808 presented to the user\&.
818 1\-byte number of "chunks"
828 1\-byte number of base multi\-pack\-index files:
829 This value is currently always zero\&.
839 4\-byte number of pack files
851 (C + 1) * 12 bytes providing the chunk offsets:
852 First 4 bytes describe chunk id\&. Value 0 is a terminating label\&.
853 Other 8 bytes provide offset in current file for chunk to start\&.
854 (Chunks are provided in file\-order, so you can infer the length
855 using the next chunk position if necessary\&.)
865 The CHUNK LOOKUP matches the table of contents from
866 the chunk\-based file format, see linkgit:gitformat\-chunk[5]\&.
876 The remaining data in the body is described one chunk at a time, and
877 these chunks may be given in any order\&. Chunks are required unless
878 otherwise specified\&.
890 Packfile Names (ID: {\*(AqP\*(Aq, \*(AqN\*(Aq, \*(AqA\*(Aq, \*(AqM\*(Aq})
891 Store the names of packfiles as a sequence of NUL\-terminated
892 strings\&. There is no extra padding between the filenames,
893 and they are listed in lexicographic order\&. The chunk itself
894 is padded at the end with between 0 and 3 NUL bytes to make the
895 chunk size a multiple of 4 bytes\&.
905 Bitmapped Packfiles (ID: {\*(AqB\*(Aq, \*(AqT\*(Aq, \*(AqM\*(Aq, \*(AqP\*(Aq})
906 Stores a table of two 4\-byte unsigned integers in network order\&.
907 Each table entry corresponds to a single pack (in the order that
908 they appear above in the `PNAM` chunk)\&. The values for each table
909 entry are as follows:
910 \- The first bit position (in pseudo\-pack order, see below) to
911 contain an object from that pack\&.
912 \- The number of bits whose objects are selected from that pack\&.
922 OID Fanout (ID: {\*(AqO\*(Aq, \*(AqI\*(Aq, \*(AqD\*(Aq, \*(AqF\*(Aq})
923 The ith entry, F[i], stores the number of OIDs with first
924 byte at most i\&. Thus F[255] stores the total
935 OID Lookup (ID: {\*(AqO\*(Aq, \*(AqI\*(Aq, \*(AqD\*(Aq, \*(AqL\*(Aq})
936 The OIDs for all objects in the MIDX are stored in lexicographic
937 order in this chunk\&.
947 Object Offsets (ID: {\*(AqO\*(Aq, \*(AqO\*(Aq, \*(AqF\*(Aq, \*(AqF\*(Aq})
948 Stores two 4\-byte values for every object\&.
949 1: The pack\-int\-id for the pack storing this object\&.
950 2: The offset within the pack\&.
951 If all offsets are less than 2^32, then the large offset chunk
952 will not exist and offsets are stored as in IDX v1\&.
953 If there is at least one offset value larger than 2^32\-1, then
954 the large offset chunk must exist, and offsets larger than
955 2^31\-1 must be stored in it instead\&. If the large offset chunk
956 exists and the 31st bit is on, then removing that bit reveals
957 the row in the large offsets containing the 8\-byte offset of
968 [Optional] Object Large Offsets (ID: {\*(AqL\*(Aq, \*(AqO\*(Aq, \*(AqF\*(Aq, \*(AqF\*(Aq})
969 8\-byte offsets into large packfiles\&.
979 [Optional] Bitmap pack order (ID: {\*(AqR\*(Aq, \*(AqI\*(Aq, \*(AqD\*(Aq, \*(AqX\*(Aq})
980 A list of MIDX positions (one per object in the MIDX, num_objects in
981 total, each a 4\-byte unsigned integer in network byte order), sorted
982 according to their relative bitmap/pseudo\-pack positions\&.
994 Index checksum of the above contents\&.
999 .SH "MULTI\-PACK\-INDEX REVERSE INDEXES"
1001 Similar to the pack\-based reverse index, the multi\-pack index can also be used to generate a reverse index\&.
1003 Instead of mapping between offset, pack\-, and index position, this reverse index maps between an object\(cqs position within the MIDX, and that object\(cqs position within a pseudo\-pack that the MIDX describes (i\&.e\&., the ith entry of the multi\-pack reverse index holds the MIDX position of ith object in pseudo\-pack order)\&.
1005 To clarify the difference between these orderings, consider a multi\-pack reachability bitmap (which does not yet exist, but is what we are building towards here)\&. Each bit needs to correspond to an object in the MIDX, and so we need an efficient mapping from bit position to MIDX position\&.
1007 One solution is to let bits occupy the same position in the oid\-sorted index stored by the MIDX\&. But because oids are effectively random, their resulting reachability bitmaps would have no locality, and thus compress poorly\&. (This is the reason that single\-pack bitmaps use the pack ordering, and not the \&.idx ordering, for the same purpose\&.)
1009 So we\(cqd like to define an ordering for the whole MIDX based around pack ordering, which has far better locality (and thus compresses more efficiently)\&. We can think of a pseudo\-pack created by the concatenation of all of the packs in the MIDX\&. E\&.g\&., if we had a MIDX with three packs (a, b, c), with 10, 15, and 20 objects respectively, we can imagine an ordering of the objects like:
1015 |a,0|a,1|\&.\&.\&.|a,9|b,0|b,1|\&.\&.\&.|b,14|c,0|c,1|\&.\&.\&.|c,19|
1021 where the ordering of the packs is defined by the MIDX\(cqs pack list, and then the ordering of objects within each pack is the same as the order in the actual packfile\&.
1023 Given the list of packs and their counts of objects, you can na\(:ively reconstruct that pseudo\-pack ordering (e\&.g\&., the object at position 27 must be (c,1) because packs "a" and "b" consumed 25 of the slots)\&. But there\(cqs a catch\&. Objects may be duplicated between packs, in which case the MIDX only stores one pointer to the object (and thus we\(cqd want only one slot in the bitmap)\&.
1025 Callers could handle duplicates themselves by reading objects in order of their bit\-position, but that\(cqs linear in the number of objects, and much too expensive for ordinary bitmap lookups\&. Building a reverse index solves this, since it is the logical inverse of the index, and that index has already removed duplicates\&. But, building a reverse index on the fly can be expensive\&. Since we already have an on\-disk format for pack\-based reverse indexes, let\(cqs reuse it for the MIDX\(cqs pseudo\-pack, too\&.
1027 Objects from the MIDX are ordered as follows to string together the pseudo\-pack\&. Let \fBpack(o)\fR return the pack from which \fBo\fR was selected by the MIDX, and define an ordering of packs based on their numeric ID (as stored by the MIDX)\&. Let \fBoffset(o)\fR return the object offset of \fBo\fR within \fBpack(o)\fR\&. Then, compare \fBo1\fR and \fBo2\fR as follows:
1031 \h'-04'\(bu\h'+03'\c
1041 is preferred and the other is not, then the preferred one sorts first\&.
1043 (This is a detail that allows the MIDX bitmap to determine which pack should be used by the pack\-reuse mechanism, since it can ask the MIDX for the pack containing the object at bit position 0)\&.
1048 \h'-04'\(bu\h'+03'\c
1055 \fBpack(o1) \(!= pack(o2)\fR, then sort the two objects in descending order based on the pack ID\&.
1060 \h'-04'\(bu\h'+03'\c
1067 \fBpack(o1) = pack(o2)\fR, and the objects are sorted in pack\-order (i\&.e\&.,
1072 \fBoffset(o1) < offset(o2)\fR)\&.
1075 In short, a MIDX\(cqs pseudo\-pack is the de\-duplicated concatenation of objects in packs stored by the MIDX, laid out in pack order, and the packs arranged in MIDX order (with the preferred pack coming first)\&.
1077 The MIDX\(cqs reverse index is stored in the optional \fIRIDX\fR chunk within the MIDX itself\&.
1078 .SS "\fBBTMP\fR chunk"
1080 The Bitmapped Packfiles (\fBBTMP\fR) chunk encodes additional information about the objects in the multi\-pack index\(cqs reachability bitmap\&. Recall that objects from the MIDX are arranged in "pseudo\-pack" order (see above) for reachability bitmaps\&.
1082 From the example above, suppose we have packs "a", "b", and "c", with 10, 15, and 20 objects, respectively\&. In pseudo\-pack order, those would be arranged as follows:
1088 |a,0|a,1|\&.\&.\&.|a,9|b,0|b,1|\&.\&.\&.|b,14|c,0|c,1|\&.\&.\&.|c,19|
1094 When working with single\-pack bitmaps (or, equivalently, multi\-pack reachability bitmaps with a preferred pack), \fBgit-pack-objects\fR(1) performs \(lqverbatim\(rq reuse, attempting to reuse chunks of the bitmapped or preferred packfile instead of adding objects to the packing list\&.
1096 When a chunk of bytes is reused from an existing pack, any objects contained therein do not need to be added to the packing list, saving memory and CPU time\&. But a chunk from an existing packfile can only be reused when the following conditions are met:
1100 \h'-04'\(bu\h'+03'\c
1106 The chunk contains only objects which were requested by the caller (i\&.e\&. does not contain any objects which the caller didn\(cqt ask for explicitly or implicitly)\&.
1111 \h'-04'\(bu\h'+03'\c
1117 All objects stored in non\-thin packs as offset\- or reference\-deltas also include their base object in the resulting pack\&.
1120 The \fBBTMP\fR chunk encodes the necessary information in order to implement multi\-pack reuse over a set of packfiles as described above\&. Specifically, the \fBBTMP\fR chunk encodes three pieces of information (all 32\-bit unsigned integers in network byte\-order) for each packfile \fBp\fR that is stored in the MIDX, as follows:
1124 The first bit position (in pseudo\-pack order) in the multi\-pack index\(cqs reachability bitmap occupied by an object from
1130 The number of bit positions (including the one at
1131 \fBbitmap_pos\fR) that encode objects from that pack
1135 For example, the \fBBTMP\fR chunk corresponding to the above example (with packs \(lqa\(rq, \(lqb\(rq, and \(lqc\(rq) would look like:
1183 With this information in place, we can treat each packfile as individually reusable in the same fashion as verbatim pack reuse is performed on individual packs prior to the implementation of the \fBBTMP\fR chunk\&.
1186 The cruft packs feature offer an alternative to Git\(cqs traditional mechanism of removing unreachable objects\&. This document provides an overview of Git\(cqs pruning mechanism, and how a cruft pack can be used instead to accomplish the same\&.
1189 To remove unreachable objects from your repository, Git offers \fBgit repack \-Ad\fR (see \fBgit-repack\fR(1))\&. Quoting from the documentation:
1195 [\&.\&.\&.] unreachable objects in a previous pack become loose, unpacked objects,
1196 instead of being left in the old pack\&. [\&.\&.\&.] loose unreachable objects will be
1197 pruned according to normal expiry rules with the next \*(Aqgit gc\*(Aq invocation\&.
1203 Unreachable objects aren\(cqt removed immediately, since doing so could race with an incoming push which may reference an object which is about to be deleted\&. Instead, those unreachable objects are stored as loose objects and stay that way until they are older than the expiration window, at which point they are removed by \fBgit-prune\fR(1)\&.
1205 Git must store these unreachable objects loose in order to keep track of their per\-object mtimes\&. If these unreachable objects were written into one big pack, then either freshening that pack (because an object contained within it was re\-written) or creating a new pack of unreachable objects would cause the pack\(cqs mtime to get updated, and the objects within it would never leave the expiration window\&. Instead, objects are stored loose in order to keep track of the individual object mtimes and avoid a situation where all cruft objects are freshened at once\&.
1207 This can lead to undesirable situations when a repository contains many unreachable objects which have not yet left the grace period\&. Having large directories in the shards of \fB\&.git/objects\fR can lead to decreased performance in the repository\&. But given enough unreachable objects, this can lead to inode starvation and degrade the performance of the whole system\&. Since we can never pack those objects, these repositories often take up a large amount of disk space, since we can only zlib compress them, but not store them in delta chains\&.
1210 A cruft pack eliminates the need for storing unreachable objects in a loose state by including the per\-object mtimes in a separate file alongside a single pack containing all loose objects\&.
1212 A cruft pack is written by \fBgit repack \-\-cruft\fR when generating a new pack\&. \fBgit-pack-objects\fR(1)\*(Aqs \fB\-\-cruft\fR option\&. Note that \fBgit repack \-\-cruft\fR is a classic all\-into\-one repack, meaning that everything in the resulting pack is reachable, and everything else is unreachable\&. Once written, the \fB\-\-cruft\fR option instructs \fBgit repack\fR to generate another pack containing only objects not packed in the previous step (which equates to packing all unreachable objects together)\&. This progresses as follows:
1222 Enumerate every object, marking any object which is (a) not contained in a kept\-pack, and (b) whose mtime is within the grace period as a traversal tip\&.
1233 Perform a reachability traversal based on the tips gathered in the previous step, adding every object along the way to the pack\&.
1244 Write the pack out, along with a
1246 file that records the per\-object timestamps\&.
1249 This mode is invoked internally by \fBgit-repack\fR(1) when instructed to write a cruft pack\&. Crucially, the set of in\-core kept packs is exactly the set of packs which will not be deleted by the repack; in other words, they contain all of the repository\(cqs reachable objects\&.
1251 When a repository already has a cruft pack, \fBgit repack \-\-cruft\fR typically only adds objects to it\&. An exception to this is when \fBgit repack\fR is given the \fB\-\-cruft\-expiration\fR option, which allows the generated cruft pack to omit expired objects instead of waiting for \fBgit-gc\fR(1) to expire those objects later on\&.
1253 It is \fBgit-gc\fR(1) that is typically responsible for removing expired unreachable objects\&.
1256 Notable alternatives to this design include:
1260 \h'-04'\(bu\h'+03'\c
1266 The location of the per\-object mtime data\&.
1269 On the location of mtime data, a new auxiliary file tied to the pack was chosen to avoid complicating the \fB\&.idx\fR format\&. If the \fB\&.idx\fR format were ever to gain support for optional chunks of data, it may make sense to consolidate the \fB\&.mtimes\fR format into the \fB\&.idx\fR itself\&.
1272 Part of the \fBgit\fR(1) suite