Spaces:
Sleeping
Sleeping
File size: 33,673 Bytes
1d777c4 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 |
'\" t
.\" Title: gitformat-pack
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 04/24/2023
.\" Manual: Git Manual
.\" Source: Git 2.40.1
.\" Language: English
.\"
.TH "GITFORMAT\-PACK" "5" "04/24/2023" "Git 2\&.40\&.1" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gitformat-pack \- Git pack format
.SH "SYNOPSIS"
.sp
.nf
$GIT_DIR/objects/pack/pack\-\fB\&.{pack,idx}
$GIT_DIR/objects/pack/pack\-\fR\&.rev
$GIT_DIR/objects/pack/pack\-*\&.mtimes
$GIT_DIR/objects/pack/multi\-pack\-index
.fi
.sp
.SH "DESCRIPTION"
.sp
The Git pack format is now Git stores most of its primary repository data\&. Over the lietime af 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)\&.
.sp
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)\&.
.SH "CHECKSUMS AND OBJECT IDS"
.sp
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\&.
.SH "PACK\-*\&.PACK FILES HAVE THE FOLLOWING FORMAT:"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A header appears at the beginning and consists of the following:
.sp
.if n \{\
.RS 4
.\}
.nf
4\-byte signature:
The signature is: {\*(AqP\*(Aq, \*(AqA\*(Aq, \*(AqC\*(Aq, \*(AqK\*(Aq}
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
4\-byte version number (network byte order):
Git currently accepts version number 2 or 3 but
generates version 2 only\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
4\-byte number of objects contained in the pack (network byte order)
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
Observation: we cannot have more than 4G versions ;\-) and
more than 4G objects in a pack\&.
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The header is followed by number of object entries, each of which looks like this:
.sp
.if n \{\
.RS 4
.\}
.nf
(undeltified representation)
n\-byte type and length (3\-bit type, (n\-1)*7+4\-bit length)
compressed data
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
(deltified representation)
n\-byte type and length (3\-bit type, (n\-1)*7+4\-bit length)
base object name if OBJ_REF_DELTA or a negative relative
offset from the delta object\*(Aqs position in the pack if this
is an OBJ_OFS_DELTA object
compressed delta data
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
Observation: length of each object is encoded in a variable
length format and is not constrained to 32\-bit or anything\&.
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The trailer records a pack checksum of all of the above\&.
.RE
.SS "Object types"
.sp
Valid object types are:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
OBJ_COMMIT (1)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
OBJ_TREE (2)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
OBJ_BLOB (3)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
OBJ_TAG (4)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
OBJ_OFS_DELTA (6)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
OBJ_REF_DELTA (7)
.RE
.sp
Type 5 is reserved for future expansion\&. Type 0 is invalid\&.
.SS "Size encoding"
.sp
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\&.
.sp
This size encoding should not be confused with the "offset encoding", which is also used in this document\&.
.SS "Deltified representation"
.sp
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\&.
.sp
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\&.
.sp
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\&.
.sp
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 copy a byte range from the source object and one for inserting new data embedded in the instruction itself\&.
.sp
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)\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBInstruction to copy from base object\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
+\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+
| 1xxxxxxx | offset1 | offset2 | offset3 | offset4 | size1 | size2 | size3 |
+\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+
.fi
.if n \{\
.RE
.\}
.sp
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\&.
.sp
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 determines 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\&.
.sp
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\&.
.sp
.if n \{\
.RS 4
.\}
.nf
+\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+
| 10000101 | offset1 | offset3 |
+\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+
.fi
.if n \{\
.RE
.\}
.sp
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\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBInstruction to add new data\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
+\-\-\-\-\-\-\-\-\-\-+============+
| 0xxxxxxx | data |
+\-\-\-\-\-\-\-\-\-\-+============+
.fi
.if n \{\
.RE
.\}
.sp
This is the instruction to construct target object without the base object\&. The following data is appended to the target object\&. The first seven bits of the first octet determines the size of data in bytes\&. The size must be non\-zero\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBReserved instruction\fR
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
+\-\-\-\-\-\-\-\-\-\-+============
| 00000000 |
+\-\-\-\-\-\-\-\-\-\-+============
.fi
.if n \{\
.RE
.\}
.sp
This is the instruction reserved for future expansion\&.
.RE
.SH "ORIGINAL (VERSION 1) PACK\-*\&.IDX FILES HAVE THE FOLLOWING FORMAT:"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
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
\fIfirst\-level fan\-out\fR
table\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The header is followed by sorted 24\-byte entries, one entry per object in the pack\&. Each entry is:
.sp
.if n \{\
.RS 4
.\}
.nf
4\-byte network byte order integer, recording where the
object is stored in the packfile as the offset from the
beginning\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
one object name of the appropriate size\&.
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The file is concluded with a trailer:
.sp
.if n \{\
.RS 4
.\}
.nf
A copy of the pack checksum at the end of the corresponding
packfile\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
Index checksum of all of the above\&.
.fi
.if n \{\
.RE
.\}
.RE
.sp
Pack Idx file:
.sp
.if n \{\
.RS 4
.\}
.nf
\-\- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
fanout | fanout[0] = 2 (for example) |\-\&.
table +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ |
| fanout[1] | |
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ |
| fanout[2] | |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| fanout[255] = total objects |\-\-\-\&.
\-\- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | |
main | offset | | |
index | object name 00XXXXXXXXXXXXXXXX | | |
table +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | |
| offset | | |
| object name 00XXXXXXXXXXXXXXXX | | |
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+<+ |
\&.\-| offset | |
| | object name 01XXXXXXXXXXXXXXXX | |
| +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ |
| | offset | |
| | object name 01XXXXXXXXXXXXXXXX | |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| | offset | |
| | object name FFXXXXXXXXXXXXXXXX | |
\-\-| +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+<\-\-+
trailer | | packfile checksum |
| +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| | idxfile checksum |
| +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
\&.\-\-\-\-\-\-\-\&.
|
Pack file entry: <+
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
packed object header:
1\-byte size extension bit (MSB)
type (next 3 bit)
size0 (lower 4\-bit)
n\-byte sizeN (as long as MSB is set, each 7\-bit)
size0\&.\&.sizeN form 4+7+7+\&.\&.+7 bit integer, size0
is the least significant part, and sizeN is the
most significant part\&.
packed object data:
If it is not DELTA, then deflated bytes (the size above
is the size before compression)\&.
If it is REF_DELTA, then
base object name (the size above is the
size of the delta data that follows)\&.
delta data, deflated\&.
If it is OFS_DELTA, then
n\-byte offset (see below) interpreted as a negative
offset from the type\-byte of the header of the
ofs\-delta entry (the size above is the size of
the delta data that follows)\&.
delta data, deflated\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
offset encoding:
n bytes with MSB set in all but the last one\&.
The offset is then the number constructed by
concatenating the lower 7 bit of each byte, and
for n >= 2 adding 2^7 + 2^14 + \&.\&.\&. + 2^(7*(n\-1))
to the result\&.
.fi
.if n \{\
.RE
.\}
.SH "VERSION 2 PACK\-*\&.IDX FILES SUPPORT PACKS LARGER THAN 4 GIB, AND"
.sp
.if n \{\
.RS 4
.\}
.nf
have some other reorganizations\&. They have the format:
.fi
.if n \{\
.RE
.\}
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A 4\-byte magic number
\fI\e377tOc\fR
which is an unreasonable fanout[0] value\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A 4\-byte version number (= 2)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A 256\-entry fan\-out table just like v1\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
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\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
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\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
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\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
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\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The same trailer as a v1 pack file:
.sp
.if n \{\
.RS 4
.\}
.nf
A copy of the pack checksum at the end of
corresponding packfile\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
Index checksum of all of the above\&.
.fi
.if n \{\
.RE
.\}
.RE
.SH "PACK\-*\&.REV FILES HAVE THE FORMAT:"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A 4\-byte magic number
\fI0x52494458\fR
(\fIRIDX\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A 4\-byte version identifier (= 1)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A 4\-byte hash function identifier (= 1 for SHA\-1, 2 for SHA\-256)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
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\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A trailer, containing a:
.sp
.if n \{\
.RS 4
.\}
.nf
checksum of the corresponding packfile, and
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
a checksum of all of the above\&.
.fi
.if n \{\
.RE
.\}
.RE
.sp
All 4\-byte numbers are in network order\&.
.SH "PACK\-*\&.MTIMES FILES HAVE THE FORMAT:"
.sp
All 4\-byte numbers are in network byte order\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A 4\-byte magic number
\fI0x4d544d45\fR
(\fIMTME\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A 4\-byte version identifier (= 1)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A 4\-byte hash function identifier (= 1 for SHA\-1, 2 for SHA\-256)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
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\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
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)\&.
.RE
.SH "MULTI\-PACK\-INDEX (MIDX) FILES HAVE THE FOLLOWING FORMAT:"
.sp
The multi\-pack\-index files refer to multiple pack\-files and loose objects\&.
.sp
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\&.
.sp
All 4\-byte numbers are in network order\&.
.sp
HEADER:
.sp
.if n \{\
.RS 4
.\}
.nf
4\-byte signature:
The signature is: {\*(AqM\*(Aq, \*(AqI\*(Aq, \*(AqD\*(Aq, \*(AqX\*(Aq}
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
1\-byte version number:
Git only writes or recognizes version 1\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
1\-byte Object Id Version
We infer the length of object IDs (OIDs) from this value:
1 => SHA\-1
2 => SHA\-256
If the hash type does not match the repository\*(Aqs hash algorithm,
the multi\-pack\-index file should be ignored with a warning
presented to the user\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
1\-byte number of "chunks"
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
1\-byte number of base multi\-pack\-index files:
This value is currently always zero\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
4\-byte number of pack files
.fi
.if n \{\
.RE
.\}
.sp
CHUNK LOOKUP:
.sp
.if n \{\
.RS 4
.\}
.nf
(C + 1) * 12 bytes providing the chunk offsets:
First 4 bytes describe chunk id\&. Value 0 is a terminating label\&.
Other 8 bytes provide offset in current file for chunk to start\&.
(Chunks are provided in file\-order, so you can infer the length
using the next chunk position if necessary\&.)
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
The CHUNK LOOKUP matches the table of contents from
the chunk\-based file format, see linkgit:gitformat\-chunk[5]\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
The remaining data in the body is described one chunk at a time, and
these chunks may be given in any order\&. Chunks are required unless
otherwise specified\&.
.fi
.if n \{\
.RE
.\}
.sp
CHUNK DATA:
.sp
.if n \{\
.RS 4
.\}
.nf
Packfile Names (ID: {\*(AqP\*(Aq, \*(AqN\*(Aq, \*(AqA\*(Aq, \*(AqM\*(Aq})
Stores the packfile names as concatenated, null\-terminated strings\&.
Packfiles must be listed in lexicographic order for fast lookups by
name\&. This is the only chunk not guaranteed to be a multiple of four
bytes in length, so should be the last chunk for alignment reasons\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
OID Fanout (ID: {\*(AqO\*(Aq, \*(AqI\*(Aq, \*(AqD\*(Aq, \*(AqF\*(Aq})
The ith entry, F[i], stores the number of OIDs with first
byte at most i\&. Thus F[255] stores the total
number of objects\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
OID Lookup (ID: {\*(AqO\*(Aq, \*(AqI\*(Aq, \*(AqD\*(Aq, \*(AqL\*(Aq})
The OIDs for all objects in the MIDX are stored in lexicographic
order in this chunk\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
Object Offsets (ID: {\*(AqO\*(Aq, \*(AqO\*(Aq, \*(AqF\*(Aq, \*(AqF\*(Aq})
Stores two 4\-byte values for every object\&.
1: The pack\-int\-id for the pack storing this object\&.
2: The offset within the pack\&.
If all offsets are less than 2^32, then the large offset chunk
will not exist and offsets are stored as in IDX v1\&.
If there is at least one offset value larger than 2^32\-1, then
the large offset chunk must exist, and offsets larger than
2^31\-1 must be stored in it instead\&. If the large offset chunk
exists and the 31st bit is on, then removing that bit reveals
the row in the large offsets containing the 8\-byte offset of
this object\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
[Optional] Object Large Offsets (ID: {\*(AqL\*(Aq, \*(AqO\*(Aq, \*(AqF\*(Aq, \*(AqF\*(Aq})
8\-byte offsets into large packfiles\&.
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
[Optional] Bitmap pack order (ID: {\*(AqR\*(Aq, \*(AqI\*(Aq, \*(AqD\*(Aq, \*(AqX\*(Aq})
A list of MIDX positions (one per object in the MIDX, num_objects in
total, each a 4\-byte unsigned integer in network byte order), sorted
according to their relative bitmap/pseudo\-pack positions\&.
.fi
.if n \{\
.RE
.\}
.sp
TRAILER:
.sp
.if n \{\
.RS 4
.\}
.nf
Index checksum of the above contents\&.
.fi
.if n \{\
.RE
.\}
.SH "MULTI\-PACK\-INDEX REVERSE INDEXES"
.sp
Similar to the pack\-based reverse index, the multi\-pack index can also be used to generate a reverse index\&.
.sp
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)\&.
.sp
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\&.
.sp
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\&.)
.sp
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:
.sp
.if n \{\
.RS 4
.\}
.nf
|a,0|a,1|\&.\&.\&.|a,9|b,0|b,1|\&.\&.\&.|b,14|c,0|c,1|\&.\&.\&.|c,19|
.fi
.if n \{\
.RE
.\}
.sp
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\&.
.sp
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)\&.
.sp
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\&.
.sp
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:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
If one of
\fBpack(o1)\fR
and
\fBpack(o2)\fR
is preferred and the other is not, then the preferred one sorts first\&.
.sp
(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)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
If
\fBpack(o1) \(!= pack(o2)\fR, then sort the two objects in descending order based on the pack ID\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Otherwise,
\fBpack(o1) = pack(o2)\fR, and the objects are sorted in pack\-order (i\&.e\&.,
\fBo1\fR
sorts ahead of
\fBo2\fR
exactly when
\fBoffset(o1) < offset(o2)\fR)\&.
.RE
.sp
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)\&.
.sp
The MIDX\(cqs reverse index is stored in the optional \fIRIDX\fR chunk within the MIDX itself\&.
.SH "CRUFT PACKS"
.sp
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\&.
.SS "Background"
.sp
To remove unreachable objects from your repository, Git offers \fBgit repack \-Ad\fR (see \fBgit-repack\fR(1))\&. Quoting from the documentation:
.sp
.if n \{\
.RS 4
.\}
.nf
[\&.\&.\&.] unreachable objects in a previous pack become loose, unpacked objects,
instead of being left in the old pack\&. [\&.\&.\&.] loose unreachable objects will be
pruned according to normal expiry rules with the next \*(Aqgit gc\*(Aq invocation\&.
.fi
.if n \{\
.RE
.\}
.sp
.sp
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)\&.
.sp
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\&.
.sp
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\&.
.SS "Cruft packs"
.sp
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\&.
.sp
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:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 1." 4.2
.\}
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\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 2." 4.2
.\}
Perform a reachability traversal based on the tips gathered in the previous step, adding every object along the way to the pack\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 3." 4.2
.\}
Write the pack out, along with a
\fB\&.mtimes\fR
file that records the per\-object timestamps\&.
.RE
.sp
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\&.
.sp
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\&.
.sp
It is \fBgit-gc\fR(1) that is typically responsible for removing expired unreachable objects\&.
.SS "Caution for mixed\-version environments"
.sp
Repositories that have cruft packs in them will continue to work with any older version of Git\&. Note, however, that previous versions of Git which do not understand the \fB\&.mtimes\fR file will use the cruft pack\(cqs mtime as the mtime for all of the objects in it\&. In other words, do not expect older (pre\-cruft pack) versions of Git to interpret or even read the contents of the \fB\&.mtimes\fR file\&.
.sp
Note that having mixed versions of Git GC\-ing the same repository can lead to unreachable objects never being completely pruned\&. This can happen under the following circumstances:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
An older version of Git running GC explodes the contents of an existing cruft pack loose, using the cruft pack\(cqs mtime\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A newer version running GC collects those loose objects into a cruft pack, where the \&.mtime file reflects the loose object\(cqs actual mtimes, but the cruft pack mtime is "now"\&.
.RE
.sp
Repeating this process will lead to unreachable objects not getting pruned as a result of repeatedly resetting the objects\*(Aq mtimes to the present time\&.
.sp
If you are GC\-ing repositories in a mixed version environment, consider omitting the \fB\-\-cruft\fR option when using \fBgit-repack\fR(1) and \fBgit-gc\fR(1), and leaving the \fBgc\&.cruftPacks\fR configuration unset until all writers understand cruft packs\&.
.SS "Alternatives"
.sp
Notable alternatives to this design include:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The location of the per\-object mtime data, and
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Storing unreachable objects in multiple cruft packs\&.
.RE
.sp
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\&.
.sp
Storing unreachable objects among multiple cruft packs (e\&.g\&., creating a new cruft pack during each repacking operation including only unreachable objects which aren\(cqt already stored in an earlier cruft pack) is significantly more complicated to construct, and so aren\(cqt pursued here\&. The obvious drawback to the current implementation is that the entire cruft pack must be re\-written from scratch\&.
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite
|