Git
English ▾ 主题 ▾ 最新版本 ▾ gitformat-index 最后更新于 2.44.0

名称

gitformat-index - Git 索引格式

概要

$GIT_DIR/index

描述

Git 索引格式

Git 索引文件具有以下格式

All binary numbers are in network byte order.
In a repository using the traditional SHA-1, 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.
Version 2 is described here unless stated otherwise.
  • 一个由以下内容组成的 12 字节头部:

    4-byte signature:
      The signature is { 'D', 'I', 'R', 'C' } (stands for "dircache")
    4-byte version number:
      The current supported versions are 2, 3 and 4.
    32-bit number of index entries.
  • 若干排序的索引条目(见下文)。

  • 扩展

    Extensions are identified by signature. Optional extensions can
    be ignored if Git does not understand them.
    4-byte extension signature. If the first byte is 'A'..'Z' the
    extension is optional and can be ignored.
    32-bit size of the extension
    Extension data
  • 此校验和之前的索引文件内容的哈希校验和。

索引条目

Index entries are sorted in ascending order on the name field,
interpreted as a string of unsigned bytes (i.e. memcmp() order, no
localization, no special casing of directory separator '/'). Entries
with the same name are sorted by their stage field.
An index entry typically represents a file. However, if sparse-checkout
is enabled in cone mode (`core.sparseCheckoutCone` is enabled) and the
`extensions.sparseIndex` extension is enabled, then the index may
contain entries for directories outside of the sparse-checkout definition.
These entries have mode `040000`, include the `SKIP_WORKTREE` bit, and
the path ends in a directory separator.
32-bit ctime seconds, the last time a file's metadata changed
  this is stat(2) data
32-bit ctime nanosecond fractions
  this is stat(2) data
32-bit mtime seconds, the last time a file's data changed
  this is stat(2) data
32-bit mtime nanosecond fractions
  this is stat(2) data
32-bit dev
  this is stat(2) data
32-bit ino
  this is stat(2) data
32-bit mode, split into (high to low bits)
16-bit unused, must be zero
4-bit object type
  valid values in binary are 1000 (regular file), 1010 (symbolic link)
  and 1110 (gitlink)
3-bit unused, must be zero
9-bit unix permission. Only 0755 and 0644 are valid for regular files.
Symbolic links and gitlinks have value 0 in this field.
32-bit uid
  this is stat(2) data
32-bit gid
  this is stat(2) data
32-bit file size
  This is the on-disk size from stat(2), truncated to 32-bit.
Object name for the represented object
A 16-bit 'flags' field split into (high to low bits)
1-bit assume-valid flag
1-bit extended flag (must be zero in version 2)
2-bit stage (during merge)
12-bit name length if the length is less than 0xFFF; otherwise 0xFFF
is stored in this field.
(Version 3 or later) A 16-bit field, only applicable if the
"extended flag" above is 1, split into (high to low bits).
1-bit reserved for future
1-bit skip-worktree flag (used by sparse checkout)
1-bit intent-to-add flag (used by "git add -N")
13-bit unused, must be zero
Entry path name (variable length) relative to top level directory
  (without leading slash). '/' is used as path separator. The special
  path components ".", ".." and ".git" (without quotes) are disallowed.
  Trailing slash is also disallowed.
The exact encoding is undefined, but the '.' and '/' characters
are encoded in 7-bit ASCII and the encoding cannot contain a NUL
byte (iow, this is a UNIX pathname).
(Version 4) In version 4, the entry path name is prefix-compressed
  relative to the path name for the previous entry (the very first
  entry is encoded as if the path name for the previous entry is an
  empty string).  At the beginning of an entry, an integer N in the
  variable width encoding (the same encoding as the offset is encoded
  for OFS_DELTA pack entries; see gitformat-pack[5]) is stored, followed
  by a NUL-terminated string S.  Removing N bytes from the end of the
  path name for the previous entry, and replacing it with the string S
  yields the path name for this entry.
1-8 nul bytes as necessary to pad the entry to a multiple of eight bytes
while keeping the name NUL-terminated.
(Version 4) In version 4, the padding after the pathname does not
exist.
Interpretation of index entries in split index mode is completely
different. See below for details.

扩展

缓存树

Since the index does not record entries for directories, the cache
entries cannot describe tree objects that already exist in the object
database for regions of the index that are unchanged from an existing
commit. The cache tree extension stores a recursive tree structure that
describes the trees that already exist and completely match sections of
the cache entries. This speeds up tree object generation from the index
for a new commit by only computing the trees that are "new" to that
commit. It also assists when comparing the index to another tree, such
as `HEAD^{tree}`, since sections of the index can be skipped when a tree
comparison demonstrates equality.
The recursive tree structure uses nodes that store a number of cache
entries, a list of subnodes, and an object ID (OID). The OID references
the existing tree for that node, if it is known to exist. The subnodes
correspond to subdirectories that themselves have cache tree nodes. The
number of cache entries corresponds to the number of cache entries in
the index that describe paths within that tree's directory.
The extension tracks the full directory structure in the cache tree
extension, but this is generally smaller than the full cache entry list.
When a path is updated in index, Git invalidates all nodes of the
recursive cache tree corresponding to the parent directories of that
path. We store these tree nodes as being "invalid" by using "-1" as the
number of cache entries. Invalid nodes still store a span of index
entries, allowing Git to focus its efforts when reconstructing a full
cache tree.
The signature for this extension is { 'T', 'R', 'E', 'E' }.
A series of entries fill the entire extension; each of which
consists of:
  • 以 NUL 结尾的路径组件(相对于其父目录);

  • 索引中由该条目表示的树所覆盖的条目的 ASCII 十进制数 (entry_count);

  • 一个空格 (ASCII 32);

  • 表示此树具有的子树数量的 ASCII 十进制数;

  • 一个换行符 (ASCII 10);以及

  • 将此索引范围写入树时将产生的对象的名称。

    An entry can be in an invalidated state and is represented by having
    a negative number in the entry_count field. In this case, there is no
    object name and the next entry starts immediately after the newline.
    When writing an invalid entry, -1 should always be used as entry_count.
    The entries are written out in the top-down, depth-first order.  The
    first entry represents the root level of the repository, followed by the
    first subtree--let's call this A--of the root level (with its name
    relative to the root level), followed by the first subtree of A (with
    its name relative to A), and so on. The specified number of subtrees
    indicates when the current level of the recursive stack is complete.

解决撤消

A conflict is represented in the index as a set of higher stage entries.
When a conflict is resolved (e.g. with "git add path"), these higher
stage entries will be removed and a stage-0 entry with proper resolution
is added.
When these higher stage entries are removed, they are saved in the
resolve undo extension, so that conflicts can be recreated (e.g. with
"git checkout -m"), in case users want to redo a conflict resolution
from scratch.
The signature for this extension is { 'R', 'E', 'U', 'C' }.
A series of entries fill the entire extension; each of which
consists of:
  • 条目描述的以 NUL 结尾的文件名(相对于存储库的根目录,即完整文件名);

  • 三个以 NUL 结尾的 ASCII 八进制数,第 1 到 3 阶段中条目的条目模式(缺失的阶段在此字段中以“0”表示);以及

  • 最多三个从 1 到 3 阶段中条目的对象名称(对于缺失的阶段不写入任何内容)。

拆分索引

In split index mode, the majority of index entries could be stored
in a separate file. This extension records the changes to be made on
top of that to produce the final index.
The signature for this extension is { 'l', 'i', 'n', 'k' }.
The extension consists of:
  • 共享索引文件的哈希值。共享索引文件路径为 $GIT_DIR/sharedindex.<hash>。如果所有位都为零,则索引不需要共享索引文件。

  • 一个 ewah 编码的删除位图,每个位表示共享索引中的一个条目。如果设置了一个位,则共享索引中对应的条目将从最终索引中删除。请注意,由于删除操作会更改索引条目的位置,但我们确实需要替换阶段中的原始位置,因此最好只是标记要删除的条目,然后在替换后进行批量删除。

  • 一个 ewah 编码的替换位图,每个位表示共享索引中的一个条目。如果设置了一个位,则共享索引中对应的条目将替换为此索引文件中的一个条目。所有替换的条目都按排序顺序存储在此索引中。替换位图中的第一个“1”位对应于第一个索引条目,第二个“1”位对应于第二个条目,依此类推。替换的条目可能具有空路径名以节省空间。

    The remaining index entries after replaced ones will be added to the
    final index. These added entries are also sorted by entry name then
    stage.

未跟踪缓存

Untracked cache saves the untracked file list and necessary data to
verify the cache. The signature for this extension is { 'U', 'N',
'T', 'R' }.
The extension starts with
  • 一系列以 NUL 结尾的字符串,前面是可变宽度编码中的序列大小。每个字符串描述可以使用缓存的环境。

  • $GIT_DIR/info/exclude 的状态数据。请参阅从 ctime 字段到“文件大小”的“索引条目”部分。

  • core.excludesFile 的状态数据

  • 32 位 dir_flags(参见 struct dir_struct)

  • $GIT_DIR/info/exclude 的哈希值。空哈希值表示文件不存在。

  • core.excludesFile 的哈希值。空哈希值表示文件不存在。

  • 每个目录排除文件名的以 NUL 结尾的字符串。这通常是“.gitignore”。

  • 以下目录块的数量,可变宽度编码。如果此数字为零,则扩展名在此处以以下 NUL 结尾。

  • 若干个按深度优先搜索顺序排列的目录块,每个块包含:

  • 未跟踪条目的数量,可变宽度编码。

  • 子目录块的数量,可变宽度编码。

  • 以 NUL 结尾的目录名。

  • 若干个以 NUL 结尾的未跟踪文件/目录名。

每个目录块的剩余数据按类型分组

  • 一个 ewah 位图,第 n 位标记第 n 个目录是否具有有效的未跟踪缓存条目。

  • 一个 ewah 位图,第 n 位记录 read_directory_recursive() 的“仅检查”位,用于第 n 个目录。

  • 一个 ewah 位图,第 n 位指示哈希和状态数据对于第 n 个目录是否有效,以及是否存在于下一个数据中。

  • 一个状态数据数组。第 n 个数据对应于前一个 ewah 位图中的第 n 个“1”位。

  • 一个哈希数组。第 n 个哈希对应于前一个 ewah 位图中的第 n 个“1”位。

  • 一个 NUL。

文件系统监视器缓存

The file system monitor cache tracks files for which the core.fsmonitor
hook has told us about changes.  The signature for this extension is
{ 'F', 'S', 'M', 'N' }.
The extension starts with
  • 32 位版本号:当前支持的版本为 1 和 2。

  • (版本 1)64 位时间:扩展数据反映了在给定时间之前的所有更改,该时间存储为自 1970 年 1 月 1 日午夜以来的纳秒数。

  • (版本 2)一个以 null 结尾的字符串:由文件系统监视器应用程序定义的不透明令牌。扩展数据反映了相对于该令牌的所有更改。

  • 32 位位图大小:CE_FSMONITOR_VALID 位图的大小。

  • 一个 ewah 位图,第 n 位指示第 n 个索引条目是否不是 CE_FSMONITOR_VALID。

索引条目结束

The End of Index Entry (EOIE) is used to locate the end of the variable
length index entries and the beginning of the extensions. Code can take
advantage of this to quickly locate the index extensions without having
to parse through all of the index entries.
Because it must be able to be loaded before the variable length cache
entries and other index extensions, this extension must be written last.
The signature for this extension is { 'E', 'O', 'I', 'E' }.
The extension consists of:
  • 32 位偏移量,指向索引条目的末尾

  • 扩展类型及其大小(但不是其内容)的哈希值。例如,如果我们有长度为 N 字节的“TREE”扩展名,长度为 M 字节的“REUC”扩展名,然后是“EOIE”,则哈希值将为

    Hash("TREE" + <binary-representation-of-N> +
    	"REUC" + <binary-representation-of-M>)

索引条目偏移量表

The Index Entry Offset Table (IEOT) is used to help address the CPU
cost of loading the index by enabling multi-threading the process of
converting cache entries from the on-disk format to the in-memory format.
The signature for this extension is { 'I', 'E', 'O', 'T' }.
The extension consists of:
  • 32 位版本(当前为 1)

  • 若干个索引偏移量条目,每个条目包含:

  • 从文件开头到此条目块中的第一个缓存条目的 32 位偏移量。

  • 此块中缓存条目的 32 位计数

稀疏目录条目

When using sparse-checkout in cone mode, some entire directories within
the index can be summarized by pointing to a tree object instead of the
entire expanded list of paths within that tree. An index containing such
entries is a "sparse index". Index format versions 4 and less were not
implemented with such entries in mind. Thus, for these versions, an
index containing sparse directory entries will include this extension
with signature { 's', 'd', 'i', 'r' }. Like the split-index extension,
tools should avoid interacting with a sparse index unless they understand
this extension.

GIT

git[1] 套件的一部分

scroll-to-top