チャプター ▾ 第2版

10.7 Git内部 - メンテナンスとデータ復旧

メンテナンスとデータ復旧

時々、リポジトリをよりコンパクトにしたり、インポートしたリポジトリをクリーンアップしたり、失われた作業を回復したりするために、クリーンアップが必要になる場合があります。このセクションでは、これらのシナリオのいくつかについて説明します。

メンテナンス

Gitは時々、「auto gc」というコマンドを自動的に実行します。ほとんどの場合、このコマンドは何もしません。しかし、ルーズオブジェクト(パックファイルに含まれていないオブジェクト)が多すぎる場合や、パックファイルが多すぎる場合は、Gitは本格的なgit gcコマンドを起動します。「gc」はガベージコレクトの略で、このコマンドはいくつかのことを行います。すべてのルーズオブジェクトを収集してパックファイルに配置し、パックファイルを1つの大きなパックファイルに統合し、どのコミットからも到達できず、数ヶ月経過したオブジェクトを削除します。

auto gc は次のように手動で実行できます。

$ git gc --auto

繰り返しになりますが、これは通常何も行いません。Gitが実際に gc コマンドを起動するには、約7,000個以上のルーズオブジェクトまたは50個以上のパックファイルが必要です。これらの制限は、それぞれ gc.autogc.autopacklimit の設定で変更できます。

gcが実行するもう1つのことは、参照を1つのファイルにパックすることです。リポジトリに次のブランチとタグが含まれているとします。

$ find .git/refs -type f
.git/refs/heads/experiment
.git/refs/heads/master
.git/refs/tags/v1.0
.git/refs/tags/v1.1

git gcを実行すると、これらのファイルはrefsディレクトリには存在しなくなります。Gitは効率のためにこれらを.git/packed-refsというファイルに移動し、そのファイルは次のようになります。

$ cat .git/packed-refs
# pack-refs with: peeled fully-peeled
cac0cab538b970a37ea1e769cbbde608743bc96d refs/heads/experiment
ab1afef80fac8e34258ff41fc1b867c702daa24b refs/heads/master
cac0cab538b970a37ea1e769cbbde608743bc96d refs/tags/v1.0
9585191f37f7b0fb9444f35a9bf50de191beadc2 refs/tags/v1.1
^1a410efbd13591db07496601ebc7a059dd55cfe9

参照を更新しても、Gitはこのファイルを編集せず、代わりに refs/heads に新しいファイルを書き込みます。特定の参照の適切なSHA-1を取得するために、Gitはその参照を refs ディレクトリで確認し、次に packed-refs ファイルをフォールバックとして確認します。したがって、 refs ディレクトリで参照が見つからない場合は、おそらく packed-refs ファイルに含まれています。

ファイルの最後の行に注目してください。行頭に^が付いています。これは、直前のタグがアノテートタグであり、この行がそのアノテートタグが指しているコミットであることを意味します。

データ回復

Gitの旅のどこかで、誤ってコミットを失ってしまうことがあるかもしれません。一般的に、これは作業中のブランチを強制的に削除してしまい、結局そのブランチが必要だったと判明した場合、またはブランチをハードリセットして、そこから何かが必要だったコミットを放棄した場合に発生します。このようなことが起こったとして、どうすればコミットを取り戻せるでしょうか?

これは、テストリポジトリのmasterブランチを古いコミットにハードリセットし、失われたコミットを回復する例です。まず、この時点でのリポジトリの状態を確認しましょう。

$ git log --pretty=oneline
ab1afef80fac8e34258ff41fc1b867c702daa24b Modify repo.rb a bit
484a59275031909e19aadb7c92262719cfcdf19a Create repo.rb
1a410efbd13591db07496601ebc7a059dd55cfe9 Third commit
cac0cab538b970a37ea1e769cbbde608743bc96d Second commit
fdf4fc3344e67ab068f836878b6c4951e3b15f3d First commit

次に、masterブランチを途中のコミットに戻します。

$ git reset --hard 1a410efbd13591db07496601ebc7a059dd55cfe9
HEAD is now at 1a410ef Third commit
$ git log --pretty=oneline
1a410efbd13591db07496601ebc7a059dd55cfe9 Third commit
cac0cab538b970a37ea1e769cbbde608743bc96d Second commit
fdf4fc3344e67ab068f836878b6c4951e3b15f3d First commit

上位の2つのコミットを実質的に失いました。これらのコミットに到達できるブランチがありません。最新のコミットのSHA-1を見つけて、それを指すブランチを追加する必要があります。問題は、その最新のコミットのSHA-1を見つけることです。覚えているわけではありませんよね?

多くの場合、最も手っ取り早い方法は git reflog というツールを使うことです。作業中、GitはHEADが変更されるたびに、そのHEADの情報を密かに記録しています。コミットしたり、ブランチを変更したりするたびに、reflogが更新されます。reflogは git update-ref コマンドによっても更新されます。これは、Gitリファレンスで説明したように、リファレンスファイルにSHA-1値を直接書き込むのではなく、このコマンドを使用するもう1つの理由です。git reflog を実行すると、いつでも自分がどこにいたかを確認できます。

$ git reflog
1a410ef HEAD@{0}: reset: moving to 1a410ef
ab1afef HEAD@{1}: commit: Modify repo.rb a bit
484a592 HEAD@{2}: commit: Create repo.rb

ここではチェックアウトした2つのコミットを見ることができますが、あまり多くの情報はありません。より役立つ方法で同じ情報を見るには、git log -gを実行すると、reflogの通常のログ出力が得られます。

$ git log -g
commit 1a410efbd13591db07496601ebc7a059dd55cfe9
Reflog: HEAD@{0} (Scott Chacon <schacon@gmail.com>)
Reflog message: updating HEAD
Author: Scott Chacon <schacon@gmail.com>
Date:   Fri May 22 18:22:37 2009 -0700

		Third commit

commit ab1afef80fac8e34258ff41fc1b867c702daa24b
Reflog: HEAD@{1} (Scott Chacon <schacon@gmail.com>)
Reflog message: updating HEAD
Author: Scott Chacon <schacon@gmail.com>
Date:   Fri May 22 18:15:24 2009 -0700

       Modify repo.rb a bit

失ったのは一番下のコミットのようです。そのコミットで新しいブランチを作成することで回復できます。たとえば、そのコミット(ab1afef)でrecover-branchという名前のブランチを開始できます。

$ git branch recover-branch ab1afef
$ git log --pretty=oneline recover-branch
ab1afef80fac8e34258ff41fc1b867c702daa24b Modify repo.rb a bit
484a59275031909e19aadb7c92262719cfcdf19a Create repo.rb
1a410efbd13591db07496601ebc7a059dd55cfe9 Third commit
cac0cab538b970a37ea1e769cbbde608743bc96d Second commit
fdf4fc3344e67ab068f836878b6c4951e3b15f3d First commit

これで、masterブランチがあった場所にrecover-branchというブランチが作成され、最初の2つのコミットに再び到達できるようになりました。次に、何らかの理由で失われたコミットがreflogにない場合を想定します。これは、recover-branchを削除し、reflogを削除することでシミュレートできます。これで、最初の2つのコミットはどこからも到達できなくなります。

$ git branch -D recover-branch
$ rm -Rf .git/logs/

reflogデータは .git/logs/ ディレクトリに保持されているため、実質的にreflogはありません。この時点で、そのコミットをどのように回復できますか?1つの方法は、データベースの整合性をチェックする git fsck ユーティリティを使用することです。 --full オプションを付けて実行すると、他のオブジェクトから指されていないすべてのオブジェクトが表示されます。

$ git fsck --full
Checking object directories: 100% (256/256), done.
Checking objects: 100% (18/18), done.
dangling blob d670460b4b4aece5915caf5c68d12f560a9fe3e4
dangling commit ab1afef80fac8e34258ff41fc1b867c702daa24b
dangling tree aea790b9a58f6cf6f2804eeac9f0abbe9631e4c9
dangling blob 7108f7ecb345ee9d0084193f147cdad4d2998293

この場合、「dangling commit」という文字列の後に失われたコミットが表示されます。これと同じ方法で、そのSHA-1を指すブランチを追加することで回復できます。

オブジェクトの削除

Gitには素晴らしい点がたくさんありますが、問題を引き起こす可能性のある機能の1つは、`git clone`がプロジェクトの全履歴、つまりすべてのファイルのすべてのバージョンをダウンロードすることです。プロジェクト全体がソースコードであれば問題ありません。Gitはデータを効率的に圧縮するために高度に最適化されているからです。しかし、プロジェクトの履歴のどこかで誰かが単一の巨大なファイルを追加した場合、たとえそのファイルが次のコミットですぐにプロジェクトから削除されたとしても、その後すべてのクローンはその大きなファイルをダウンロードしなければなりません。履歴から到達可能であるため、常にそこに存在します。

これは、SubversionやPerforceのリポジトリをGitに変換する場合に大きな問題となることがあります。これらのシステムでは完全な履歴をダウンロードしないため、この種の追加による影響はほとんどありません。別のシステムからインポートした場合や、リポジトリが本来よりもはるかに大きいことが判明した場合、大きなオブジェクトを見つけて削除する方法を説明します。

警告: この方法はコミット履歴を破壊します。 大きなファイル参照を削除するために変更する必要がある最も古いツリー以降のすべてのコミットオブジェクトを書き換えます。インポート直後で、誰もそのコミットに基づいて作業を開始する前にこれを行う場合は問題ありません。そうでなければ、すべての貢献者に、新しいコミットに作業をリベースする必要があることを通知する必要があります。

実演のために、テストリポジトリに大きなファイルを追加し、次のコミットでそれを削除し、それを見つけて、リポジトリから完全に削除します。まず、大きなオブジェクトを履歴に追加します。

$ curl -L https://www.kernel.org/pub/software/scm/git/git-2.1.0.tar.gz > git.tgz
$ git add git.tgz
$ git commit -m 'Add git tarball'
[master 7b30847] Add git tarball
 1 file changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 git.tgz

おっと、プロジェクトに巨大なtarballを追加するつもりはありませんでしたね。さっさと削除しましょう。

$ git rm git.tgz
rm 'git.tgz'
$ git commit -m 'Oops - remove large tarball'
[master dadf725] Oops - remove large tarball
 1 file changed, 0 insertions(+), 0 deletions(-)
 delete mode 100644 git.tgz

さあ、データベースを gc して、どれだけのスペースを使用しているか見てみましょう。

$ git gc
Counting objects: 17, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (13/13), done.
Writing objects: 100% (17/17), done.
Total 17 (delta 1), reused 10 (delta 0)

count-objects コマンドを実行すると、使用している容量を素早く確認できます。

$ git count-objects -v
count: 7
size: 32
in-pack: 17
packs: 1
size-pack: 4868
prune-packable: 0
garbage: 0
size-garbage: 0

size-pack エントリはパックファイルのサイズをキロバイトで表すので、ほぼ5MBを使用しています。最後のコミットの前は2K程度だったので、前のコミットからファイルを削除しても、履歴から削除されたわけではないことが明らかです。誰かがこのリポジトリをクローンするたびに、この小さなプロジェクトを取得するためだけに、誤って大きなファイルを追加したため、5MBすべてをクローンしなければなりません。削除しましょう。

まず、それを見つけなければなりません。この場合、どのファイルか既に知っています。しかし、知らなかったとしたらどうでしょう?どのファイルがそんなに多くの容量を占めているかをどうやって特定するでしょうか?git gcを実行すると、すべてのオブジェクトはパックファイルにあります。大きなオブジェクトは、git verify-packという別の配管コマンドを実行し、出力の3番目のフィールド(ファイルサイズ)でソートすることで特定できます。最後のいくつかの一番大きなファイルだけに関心があるので、tailコマンドにパイプすることもできます。

$ git verify-pack -v .git/objects/pack/pack-29…69.idx \
  | sort -k 3 -n \
  | tail -3
dadf7258d699da2c8d89b09ef6670edb7d5f91b4 commit 229 159 12
033b4468fa6b2a9547a70d88d1bbe8bf3f9ed0d5 blob   22044 5792 4977696
82c99a3e86bb1267b236a4b6eff7868d97489af1 blob   4975916 4976258 1438

一番下にある大きなオブジェクトは5MBです。それがどのファイルであるかを見つけるために、コミットメッセージ形式の強制で少し使ったrev-listコマンドを使用します。rev-list--objectsを渡すと、すべてのコミットのSHA-1と、それらに関連付けられたファイルパスを持つBLOBのSHA-1がリストされます。これを使ってBLOBの名前を見つけることができます。

$ git rev-list --objects --all | grep 82c99a3
82c99a3e86bb1267b236a4b6eff7868d97489af1 git.tgz

次に、過去のすべてのツリーからこのファイルを削除する必要があります。どのコミットがこのファイルを変更したかは簡単に確認できます。

$ git log --oneline --branches -- git.tgz
dadf725 Oops - remove large tarball
7b30847 Add git tarball

Git履歴からこのファイルを完全に削除するには、7b30847以降のすべてのコミットを書き換える必要があります。そのためには、履歴の書き換えで使用したfilter-branchを使用します。

$ git filter-branch --index-filter \
  'git rm --ignore-unmatch --cached git.tgz' -- 7b30847^..
Rewrite 7b30847d080183a1ab7d18fb202473b3096e9f34 (1/2)rm 'git.tgz'
Rewrite dadf7258d699da2c8d89b09ef6670edb7d5f91b4 (2/2)
Ref 'refs/heads/master' was rewritten

--index-filterオプションは、履歴の書き換えで使用した--tree-filterオプションと似ていますが、ディスクにチェックアウトされたファイルを変更するコマンドを渡す代わりに、毎回ステージングエリアまたはインデックスを変更するという点が異なります。

rm fileのようなもので特定のファイルを削除するのではなく、git rm --cachedで削除する必要があります。ディスクからではなく、インデックスから削除しなければなりません。このようにする理由は速度です。Gitはフィルターを実行する前に各リビジョンをディスクにチェックアウトする必要がないため、処理がはるかに高速になります。必要であれば、--tree-filterでも同じタスクを実行できます。git rm--ignore-unmatchオプションは、削除しようとしているパターンが存在しない場合でもエラーを出さないように指示します。最後に、filter-branch7b30847コミットからのみ履歴を書き換えるように要求します。なぜなら、問題が始まったのがそこだと知っているからです。そうしないと、最初から始まり、不必要に時間がかかります。

あなたの履歴には、そのファイルへの参照はもう含まれていません。しかし、reflogと、filter-branchを実行したときにGitが.git/refs/originalの下に追加した新しいrefsセットにはまだ含まれています。そのため、それらを削除してからデータベースを再パックする必要があります。再パックする前に、それらの古いコミットへのポインタを持つものをすべて削除する必要があります。

$ rm -Rf .git/refs/original
$ rm -Rf .git/logs/
$ git gc
Counting objects: 15, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (11/11), done.
Writing objects: 100% (15/15), done.
Total 15 (delta 1), reused 12 (delta 0)

どれだけスペースを節約できたか見てみましょう。

$ git count-objects -v
count: 11
size: 4904
in-pack: 15
packs: 1
size-pack: 8
prune-packable: 0
garbage: 0
size-garbage: 0

パックされたリポジトリのサイズは8Kに減少しました。これは5MBよりもはるかに優れています。sizeの値から、大きなオブジェクトはまだルーズオブジェクトに残っていることがわかります。つまり、まだ消えていません。しかし、プッシュやその後のクローン時には転送されないため、それが重要です。本当に必要であれば、git prune--expireオプションを付けて実行することで、オブジェクトを完全に削除できます。

$ git prune --expire now
$ git count-objects -v
count: 0
size: 0
in-pack: 15
packs: 1
size-pack: 8
prune-packable: 0
garbage: 0
size-garbage: 0
scroll-to-top