簡體中文 ▾ 主題 ▾ 最新版本 ▾ 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 的 stat 資料。請參閱“索引條目”部分中從 ctime 欄位到“檔案大小”的內容。

  • core.excludesFile 的 stat 資料

  • 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 個目錄的雜湊和 stat 資料是否有效且存在於下一個資料中。

  • 一個 stat 資料陣列。第 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