🤖

Gitのインデックスの中身

commits10 min read

はじめに

Gitは、commitをする前にaddをする必要があります。これをステージングといいます。このステージングされる場所をインデックスといいます。実体は.git/indexというファイルです。これがどういうファイルかちょっと見てみましょう、という記事です。

インデックス

init直後

とりあえずインデックスを見てみましょう。適当なディレクトリを掘って、そこにファイルを作り、git initします。

mkdir index_test
cd index_test
echo "My first file" > test.txt
git init

さて、git initした直後は、まだindexは作られていません。

$ tree .git
.git
├── HEAD
├── config
├── description
├── hooks
│   ├── applypatch-msg.sample
│   ├── commit-msg.sample
│   ├── fsmonitor-watchman.sample
│   ├── post-update.sample
│   ├── pre-applypatch.sample
│   ├── pre-commit.sample
│   ├── pre-merge-commit.sample
│   ├── pre-push.sample
│   ├── pre-rebase.sample
│   ├── pre-receive.sample
│   ├── prepare-commit-msg.sample
│   ├── push-to-checkout.sample
│   └── update.sample
├── info
│   └── exclude
├── objects
│   ├── info
│   └── pack
└── refs
    ├── heads
    └── tags

8 directories, 17 files

また、この時点でgit diffしても何も表示されません。

add直後

git addすることでindexが作られます。

$ git add test.txt
$ tree .git
.git
├── HEAD
├── config
├── description
(snip)
├── index
├── info
│   └── exclude
├── objects
│   ├── 36
│   │   └── 3d8b784900d74b3159e8e93a651c0db42629ef
│   ├── info
│   └── pack
└── refs
    ├── heads
    └── tags

9 directories, 19 files

headが作られ、objectsの中に、36というディレクトリが作られ、その中に3d8b784900d74b3159e8e93a651c0db42629efというファイルができました。

さて、この状態でも、git diffは何も表示しません。

$ git diff
$

ここまで、何が起きたのでしょうか?

まず、git addすることで、そのファイルのblobオブジェクトが作られ、インデックスに登録されます。インデックスの中身は、git ls-files --stageで見ることができます。

$ git ls-files --stage
100644 363d8b784900d74b3159e8e93a651c0db42629ef 0    test.txt

test.txtというファイルに対応するblobオブジェクトができています。そのハッシュは363d8b784900d74b3159e8e93a651c0db42629efです。このオブジェクトを調べるには、git cat-fileを使います。-tでタイプが、-pで中身を見ることができます。

$ git cat-file -t 363d8b784900d74b3159e8e93a651c0db42629ef
blob
$ git cat-file -p 363d8b784900d74b3159e8e93a651c0db42629ef
My first file

ハッシュ363...を持つオブジェクトがblobオブジェクトであり、その中身がMy first fileであることがわかります。つまり、インデックスにはtest.txtに対応するblobオブジェクトが入っています。test.txtのハッシュはgit hash-objectで得ることができます。

$ git hash-object test.txt
363d8b784900d74b3159e8e93a651c0db42629ef

つまり、git add test.txtをした時、Gitは

  • test.txtに対応するblobオブジェクトを作り、ファイル名はハッシュとする
  • 作られたオブジェクトは.git/objectsに保存。ただし、ハッシュの上二文字をディレクトリとし、残りをファイル名として仕分けする
  • indexにそのblobオブジェクトと名前を登録する

ということをしています。

また、git diffは、引数なしだと「インデックスにあるファイルとワーキングツリーのファイルを比較する」ので、インデックスが空なら何も表示せず、git add直後は、インデックスとワーキングツリーのファイルが一致しているので、やはり何も表示しません。

commit直後

さて、コミットしてみましょう。

$ git commit -m "Initial commit"
[main (root-commit) fc4050c] Initial commit
 1 file changed, 1 insertion(+)
 create mode 100644 test.txt

無事にコミットされ、fc4050cというコミットオブジェクトが作られました。

index

.gitがどうなっているか見てみましょう。

$ tree .git
.git
├── COMMIT_EDITMSG
├── HEAD
(snip)
├── index
├── info
│   └── exclude
├── logs
│   ├── HEAD
│   └── refs
│       └── heads
│           └── main
├── objects
│   ├── 36
│   │   └── 3d8b784900d74b3159e8e93a651c0db42629ef
│   ├── b4
│   │   └── 0d873c372b28782e7bef9ab962a971b43fc1ca
│   ├── fc
│   │   └── 4050c6ff60e688e052f12fdccec760d0a27503
│   ├── info
│   └── pack
└── refs
    ├── heads
    │   └── main
    └── tags

14 directories, 25 files

objectsが3つに増えています。また、logsというディレクトリも作られました。まずはこの3つのオブジェクトを見てみましょう。

1つは先程のblobオブジェクト363d8b7でした。もう1つのfc4050cはコミットオブジェクトです。

$ git cat-file -t fc4050c
commit

中身を見てみましょう。

$ git cat-file -p fc4050c
tree b40d873c372b28782e7bef9ab962a971b43fc1ca
author H. Watanabe <kaityo256@example.com> 1628835374 +0900
committer H. Watanabe <kaityo256@example.com> 1628835374 +0900

Initial commit

コミットメッセージと、treeオブジェクトb40d873を含んでいますね。これがtreeであることを確認し、中身も見てみましょう。

$ git cat-file -t b40d873
tree
$ git cat-file -p b40d873
100644 blob 363d8b784900d74b3159e8e93a651c0db42629ef    test.txt

test.txtに対応するblobオブジェクトを一つだけ含んでいました。

以上から、ファイル一つだけのリポジトリを作り、コミットした直後には、

  • ファイルに対応するblobオブジェクト
  • コミットに対応するcommitオブジェクト
  • コミットの中にあるtreeオブジェクト

の3つのオブジェクトが作られることがわかりました。先程、objectsディレクトリに3つあったのはこれです。

ブランチ切り替えとインデックス

git diffは、デフォルトでワーキングツリーとインデックスの内容を比較するのでした。では、ブランチを切り替えると、インデックスはどうなるのでしょうか?

まずはブランチbranch_aを切って、そこにfile_a.txtを追加、コミットします。

$ git checkout -b branch_a
Switched to a new branch 'branch_a'
$ echo "This is A" > file_a.txt
$ git add file_a.txt
$ git commit -m "adds file_a.txt"
[branch_a 41e4b52] adds file_a.txt
 1 file changed, 1 insertion(+)
 create mode 100644 file_a.txt

これで、ワーキングツリーにはtest.txtfile_a.txtの二つのファイルが含まれるようになりました。当然、インデックスにも同じファイルが登録されています。

$ git ls-files --stage
100644 e32836f4cedd87510bfd2f145bc0696861fdb026 0    file_a.txt
100644 363d8b784900d74b3159e8e93a651c0db42629ef 0    test.txt

file_a.txtのblobオブジェクトが増えていますね。ハッシュも確認しておきましょう。

$ git hash-object file_a.txt
e32836f4cedd87510bfd2f145bc0696861fdb026

同じです。

この状態で、ブランチを切り替えてみましょう。まずはmainに戻ります。

$ git switch main
Switched to branch 'main'

インデックスを見てみましょう。

$ git ls-files --stage
100644 363d8b784900d74b3159e8e93a651c0db42629ef 0    test.txt

mainブランチにはtest.txtしかないので、インデックスにあるのもtest.txtのblobオブジェクトだけです。

新たなブランチbranch_bを切って、歴史を分岐させましょう。

$ git checkout -b branch_b
Switched to a new branch 'branch_b'

ファイルfile_b.txtを追加し、コミットします。

$ echo "This is B" > file_b.txt
$ git add file_b.txt
$ git commit -m "adds file_b.txt"
[branch_b 81085f2] adds file_b.txt
 1 file changed, 1 insertion(+)
 create mode 100644 file_b.txt

git addの時点でfile_b.txtに対応するblobオブジェクトが作られ、インデックスに登録されます。インデックスの中身を見てみましょう。

$ git ls-files --stage
100644 6a571f63d9d0bce7995b5c08d218370d7ea719a5 0    file_b.txt
100644 363d8b784900d74b3159e8e93a651c0db42629ef 0    test.txt

test.txtfile_b.txtが入っていますね。

この状態で、branch_aに切り替えてみましょう。

$ git switch branch_a
Switched to branch 'branch_a'

ワーキングツリーのファイルがtest.txtfile_a.txtになります。

$ ls
file_a.txt  test.txt

インデックスの中身も同じです。

$ git ls-files --stage
100644 e32836f4cedd87510bfd2f145bc0696861fdb026 0    file_a.txt
100644 363d8b784900d74b3159e8e93a651c0db42629ef 0    test.txt

index

つまり、ブランチ切り替えの際、ワーキングツリーだけでなく、インデックスも切り替えられています。

ハッシュが同じファイル

git hash-objectは、ファイルの中身が同じならファイル名が異なっても同じハッシュを返します。

$ echo "Hello" > test.txt
$ echo "Hello" > test2.txt
$ git hash-object test.txt test2.txt 
e965047ad7c57865823c7d992b1d046ea66edf78
e965047ad7c57865823c7d992b1d046ea66edf78

それを両方git addしたらどうなるのでしょうか?異なるファイルで同じblobオブジェクトを作らないように、なんらかの処理がなされるのでしょうか?見てみましょう。

$ git init
$ git add test.txt test2.txt 
$ git ls-files --stage
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0   test.txt
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0   test2.txt

異なるファイル名が、同じblobオブジェクトを指しています。

$ tree .git/objects
.git/objects
├── e9
│   └── 65047ad7c57865823c7d992b1d046ea66edf78
├── info
└── pack

3 directories, 1 file

作られたblobオブジェクトも一つだけです。Blobオブジェクトはファイルの中身だけを格納し、ファイル名を含まないため、異なるファイル名でも同じ中身であれば同じblobオブジェクトになります。

では、この状態でコミットしましょう。

$ git commit -m "initial commit"
[main (root-commit) 5f5cabe] initial comiit
 2 files changed, 2 insertions(+)
 create mode 100644 test.txt
 create mode 100644 test2.txt

インデックスは相変わらず同じblobオブジェクトが格納されています。

$ git ls-files --stage
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0   test.txt
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0   test2.txt

作られたコミットオブジェクトを見てみましょう。

$ git cat-file -p 5f5cabe
tree 44c2534716a893ea86255ceddaf2afbf9e89b882
author H. Watanabe <kaityo256@example.com> 1628841438 +0900
committer H. Watanabe <kaityo256@example.com> 1628841438 +0900

initial commit

ツリーオブジェクト44c2534ができているので、それを見てみます。

$ git cat-file -p 44c2534
100644 blob e965047ad7c57865823c7d992b1d046ea66edf78    test.txt
100644 blob e965047ad7c57865823c7d992b1d046ea66edf78    test2.txt

出力がインデックスの中身と同じですが、こいつがファイル名とオブジェクトの対応を取っています。ファイルシステムのinodeとディレクトリの関係に似ていますね。

一応.git/objectsも見てみましょう。

$ tree .git/objects 
.git/objects
├── 44
│   └── c2534716a893ea86255ceddaf2afbf9e89b882
├── 5f
│   └── 5cabe1b69ce14a824760db8c00941ed7679f17
├── e9
│   └── 65047ad7c57865823c7d992b1d046ea66edf78
├── info
└── pack

5 directories, 3 files

ファイルが2つ、コミットオブジェクト1つ、コミットオブジェクトが含むツリーオブジェクトが1つで、合計4つのオブジェクトが必要な気がしますが、2つのファイルの中身が同じなので、それぞれが同じblobオブジェクトを指しており、全体で3つのオブジェクトしか作られていません。

中身が同じファイルをいくつ作ってもblobオブジェクトは一つです。

$ git ls-files --stage
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0    test.txt
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0    test2.txt
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0    test3.txt
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0    test4.txt
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0    test5.txt
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0    test6.txt
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0    test7.txt
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0    test8.txt
100644 e965047ad7c57865823c7d992b1d046ea66edf78 0    test9.txt

いや、だからどうした、と言われても困りますが。

ちなみにインデックスに入っているオブジェクトは全てblobオブジェクトです。適当なリポジトリで以下を実行してみましょう。

git ls-files --stage | awk '{print $2}' |xargs -I arg git cat-file -t arg | sort -u

blobと出るはずです。

まとめ

  • インデックスの実体は.git/indexという一つのファイル
  • インデックスには、ワーキングツリーに対応したblobオブジェクトが格納されている
  • git diffを引数なしで叩くと、ワーキングツリーとインデックスの差をチェックする
  • ブランチを切り替えると、ワーキングツリーが切り替わるが、対応してインデックスの中身も切り替わる

ちなみに.git/indexのファイルフォーマットはこちら。気になる人は解析してみると面白いかも。

参考文献

GitHubで編集を提案

Discussion

ログインするとコメントできます