Git
日本語 ▾ トピック ▾ 最新バージョン ▾ 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 10進数(entry_count)。

  • スペース(ASCII 32)。

  • このツリーが持つサブツリーの数を表すASCII 10進数。

  • 改行(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終端されたパス名(リポジトリのルートに対する相対パス、つまり完全なパス名)。

  • 3つのNUL終端されたASCII 8進数、ステージ1から3のエントリのモード(欠落しているステージはこのフィールドで"0"で表されます)。そして

  • ステージ1から3のエントリの最大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」ビットは最初のインデックスエントリに対応し、2番目の「1」ビットは2番目のエントリに対応します。置き換えられたエントリは、スペースを節約するために空のパス名を持つ場合があります。

    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番目のビットは、n番目のディレクトリのread_directory_recursive()の「チェックのみ」ビットを記録します。

  • ewahビットマップ。n番目のビットは、n番目のディレクトリのハッシュとstatデータが有効であり、次のデータに存在するかどうかを示します。

  • statデータの配列。n番目のデータは、前のewahビットマップのn番目の「1」ビットに対応します。

  • ハッシュの配列。n番目のハッシュは、前のewahビットマップのn番目の「1」ビットに対応します。

  • 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日の午前0時からの経過時間をナノ秒単位で格納した指定された時間までのすべての変更を反映します。

  • (バージョン2)NUL終端された文字列:ファイルシステムモニターアプリケーションによって定義された不透明なトークン。拡張データは、そのトークンに対するすべての変更を反映します。

  • 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