Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[インデックス 16166] ファイルの概要

このコミットは、Go言語のランタイムにおいて、正確なガベージコレクション（Precise GC）を無効化するためのフックを追加するものです。これは、Precise GCが特定のプログラムで問題を引き起こしているかどうかを診断するためのデバッグ支援機能として導入されました。

コミット

commit 709e03f43dce8e6fde3398e01255c08d22cb1ee2
Author: Ian Lance Taylor <iant@golang.org>
Date:   Fri Apr 12 05:23:38 2013 -0700

    runtime: add a hook to disable precise GC
    
    This will let us ask people to rebuild the Go system without
    precise GC, and then rebuild and retest their program, to see
    if precise GC is causing whatever problem they are having.
    
    R=golang-dev, r
    CC=golang-dev
    https://golang.org/cl/8700043
---
 src/pkg/runtime/mgc0.c | 4 ++++\n 1 file changed, 4 insertions(+)

diff --git a/src/pkg/runtime/mgc0.c b/src/pkg/runtime/mgc0.c
index 64b5f0464a..f9dbdbb4a1 100644
--- a/src/pkg/runtime/mgc0.c
+++ b/src/pkg/runtime/mgc0.c
@@ -19,6 +19,7 @@ enum {
  	DebugMark = 0,  // run second pass to check mark
  	CollectStats = 0,
  	ScanStackByFrames = 0,
+	IgnorePreciseGC = 0,
 
  	// Four bits per word (see #defines below).\n \twordsPerBitmapWord = sizeof(void*)*8/4,\n@@ -771,6 +772,9 @@ scanblock(Workbuf *wbuf, Obj *wp, uintptr nobj, bool keepworking)\n \t\t\tpc = defaultProg;\n \t\t}\n \n+\t\tif(IgnorePreciseGC)\n+\t\t\tpc = defaultProg;\n+\n \t\tpc++;\n \t\tstack_top.b = (uintptr)b;\n \n```

## GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/709e03f43dce8e6fde3398e01255c08d22cb1ee2

## 元コミット内容

runtime: add a hook to disable precise GC

This will let us ask people to rebuild the Go system without precise GC, and then rebuild and retest their program, to see if precise GC is causing whatever problem they are having.


## 変更の背景

このコミットの主な背景は、Go言語のガベージコレクション（GC）が特定のアプリケーションで予期せぬ問題やパフォーマンスの低下を引き起こしている可能性があったことです。当時のGoのGCは「正確なGC（Precise GC）」を実装しており、これはヒープ上のポインタを正確に識別し、到達可能なオブジェクトのみをマークして回収する方式です。しかし、GCの実装は複雑であり、稀にバグや特定のコードパターンとの相性問題が発生することがあります。

開発者やユーザーがGC関連の問題に直面した際、その問題がPrecise GCの動作に起因するものなのか、それともアプリケーションコードや他のランタイムの側面によるものなのかを切り分けることが困難でした。このコミットは、Precise GCの機能を一時的に無効化する「フック」を提供することで、この診断プロセスを容易にすることを目的としています。

具体的には、ユーザーがGoシステムをPrecise GCなしで再ビルドし、その上で自身のプログラムを再ビルド・再テストすることで、問題が解決するかどうかを確認できるようにします。もし問題が解決すれば、その問題はPrecise GCに起因する可能性が高いと判断でき、そうでなければ別の原因を探るというデバッグ戦略が可能になります。これは、Goランタイムの安定性とデバッグ容易性を向上させるための重要なステップでした。

## 前提知識の解説

このコミットを理解するためには、以下の概念について基本的な知識が必要です。

1.  **ガベージコレクション (Garbage Collection, GC)**:
    *   プログラムが動的に確保したメモリ領域のうち、もはやどの部分からも参照されなくなった（到達不可能になった）ものを自動的に解放する仕組みです。プログラマが手動でメモリを解放する手間を省き、メモリリークやダングリングポインタといった問題を軽減します。
    *   Go言語は、ランタイムにGCを内蔵しています。

2.  **正確なガベージコレクション (Precise Garbage Collection)**:
    *   GCの一種で、ヒープ上のメモリ領域がポインタであるか、それとも単なる整数などの非ポインタデータであるかを正確に識別できるGCを指します。
    *   正確なGCは、ポインタではないデータを誤ってポインタとして解釈し、存在しないオブジェクトを参照していると判断してしまったり、逆にポインタであるべきものを非ポインタと誤解して、まだ到達可能なオブジェクトを誤って回収してしまったりするリスクを排除します。これにより、GCの安全性と効率性が向上します。
    *   GoのGCは、スタックやヒープ上のポインタを正確に識別する能力を持っています。これは、コンパイラがポインタの場所に関する情報をGCに提供することで実現されます。

3.  **保守的なガベージコレクション (Conservative Garbage Collection)**:
    *   Precise GCの対義語としてよく用いられます。ヒープ上のメモリ領域がポインタであるかどうかを確実に識別できない場合、それがポインタである「かもしれない」と仮定して処理を進めるGCです。
    *   保守的なGCは実装が容易ですが、誤って非ポインタをポインタと解釈してしまうことで、実際には到達不可能なオブジェクトを解放できず、メモリ使用量が増加する（メモリリークの一種）可能性があります。

4.  **Goランタイム (Go Runtime)**:
    *   Goプログラムを実行するために必要な、言語のコア機能を提供するライブラリとシステムのことです。これには、スケジューラ、メモリ管理（GCを含む）、ゴルーチン、チャネルなどが含まれます。
    *   `src/pkg/runtime/` ディレクトリには、GoランタイムのC言語およびGo言語で書かれたソースコードが含まれています。`mgc0.c` は、初期のGoランタイムにおけるメモリ管理とGCの低レベルな部分を扱っていたファイルの一つです。

5.  **コンパイル時定数 / ビルドフラグ**:
    *   Goのランタイムコードには、コンパイル時に値を決定する定数や、ビルド時に特定の機能を有効/無効にするためのフラグが埋め込まれていることがあります。これらは、異なる環境やデバッグの目的に応じてランタイムの挙動を調整するために使用されます。

このコミットは、GoのPrecise GCの動作を一時的に変更するためのコンパイル時オプションを追加することで、GC関連のデバッグを支援しようとするものです。

## 技術的詳細

このコミットは、Goランタイムのガベージコレクション（GC）メカニズムに、Precise GCの動作を制御するための新しいコンパイル時定数を導入しています。

GoのGCは、プログラムの実行中に到達可能なオブジェクトを特定し、それ以外の不要なオブジェクトが占めるメモリを解放します。このプロセスにおいて、スタックやレジスタ、ヒープ上のオブジェクト内部に存在するポインタを正確に識別することが重要です。Goのコンパイラは、各関数やデータ構造について、どこにポインタが存在するかというメタデータ（GCプログラム、またはGCビットマップと呼ばれることもあります）を生成し、ランタイムのGCがこれを利用して正確なスキャンを行います。

`src/pkg/runtime/mgc0.c` は、Goランタイムのメモリ管理とGCの初期実装における重要なC言語ソースファイルでした。このファイルには、GCの動作を制御するための様々な内部定数や関数が含まれています。

コミットによって追加された `IgnorePreciseGC` 定数は、`enum` ブロック内で定義されています。

```c
enum {
 	DebugMark = 0,  // run second pass to check mark
 	CollectStats = 0,
 	ScanStackByFrames = 0,
+	IgnorePreciseGC = 0, // 新しく追加された定数

この定数は、デフォルトで 0 (false) に設定されています。これは、通常はPrecise GCが有効であることを意味します。

そして、scanblock 関数内でこの定数が使用されています。scanblock 関数は、GCのマークフェーズにおいて、特定のメモリブロック（オブジェクト）をスキャンし、そこから到達可能な他のオブジェクトをマークする役割を担っています。この関数は、オブジェクト内のポインタを識別するために、コンパイラが生成したGCプログラム（pc 変数で表される）を使用します。

 	// ... 既存のコード ...
 	if(IgnorePreciseGC)
 		pc = defaultProg;
 	// ... 既存のコード ...

この if(IgnorePreciseGC) ブロックが追加された変更の核心です。

  • IgnorePreciseGC が 1 (true) に設定されている場合、pc (現在のGCプログラムカウンタ) が defaultProg に上書きされます。
  • defaultProg は、Goランタイム内で定義されている、ポインタをスキャンしない、あるいは非常に保守的な方法でスキャンする「デフォルトのGCプログラム」を指すと考えられます。つまり、この設定が有効になると、scanblock はオブジェクト内のポインタを正確に識別する通常のGCプログラムを使用せず、代わりにポインタを無視するか、あるいはすべてのワードをポインタであるかのように扱う（保守的なGCに近い挙動）ことになります。

これにより、Goシステムをビルドする際に IgnorePreciseGC を 1 に変更することで、ランタイムのGCがPrecise GCのロジックをスキップし、ポインタの正確な識別を行わなくなります。これは、GCのバグがポインタの正確な識別に関連している場合に、その問題を切り分けるための強力なデバッグツールとなります。

この変更は、Goのビルドシステムを通じて、ランタイムのコンパイル時にこの定数の値を変更できるようにすることを意図しています。例えば、特定のビルドタグや環境変数を通じて、この IgnorePreciseGC の値を 1 に設定し、Precise GCを無効化したGoバイナリを生成することが可能になります。

コアとなるコードの変更箇所

変更は src/pkg/runtime/mgc0.c ファイルに集中しています。

  1. enum 定数の追加:

    --- a/src/pkg/runtime/mgc0.c
+++ b/src/pkg/runtime/mgc0.c
@@ -19,6 +19,7 @@ enum {
  	DebugMark = 0,  // run second pass to check mark
  	CollectStats = 0,
  	ScanStackByFrames = 0,
+	IgnorePreciseGC = 0, // この行が追加された
 
  	// Four bits per word (see #defines below).\n \twordsPerBitmapWord = sizeof(void*)*8/4,\n

  2. scanblock 関数内の条件分岐の追加:

    --- a/src/pkg/runtime/mgc0.c
+++ b/src/pkg/runtime/mgc0.c
@@ -771,6 +772,9 @@ scanblock(Workbuf *wbuf, Obj *wp, uintptr nobj, bool keepworking)\n \t\t\tpc = defaultProg;\n \t\t}\n     
+\t\tif(IgnorePreciseGC)\n+\t\t\tpc = defaultProg;\n+\n \t\tpc++;\n \t\tstack_top.b = (uintptr)b;\n

コアとなるコードの解説

  • IgnorePreciseGC = 0,:

    • これは、GoランタイムのGC関連の定数を定義する enum ブロックに追加された新しい定数です。
    • デフォルト値は 0 であり、これは通常の状態ではPrecise GCが有効であることを意味します。
    • この値を 1 に変更してGoランタイムを再コンパイルすることで、Precise GCの機能を無効化できます。これは、Goのビルドプロセスにおいて、特定の環境変数やビルドタグを通じて行われることが想定されます。

  • if(IgnorePreciseGC):

    • この条件分岐は、GCのマークフェーズにおいてメモリブロックをスキャンする scanblock 関数内に挿入されました。
    • IgnorePreciseGC が true (つまり 1) の場合、以下の行が実行されます。

  • pc = defaultProg;:

    • pc は "program counter" の略で、GCがオブジェクト内のポインタをスキャンするために使用するGCプログラム（バイトコードのようなもの）の現在の位置を示します。Goコンパイラは、各型や関数について、どこにポインタがあるかを示すGCプログラムを生成します。
    • defaultProg は、Goランタイム内部で定義されている、ポインタをスキャンしない、または非常に保守的な方法でスキャンする「デフォルトのGCプログラム」への参照です。
    • この行が実行されると、scanblock 関数は、本来オブジェクト内のポインタを正確に識別するために使用すべきGCプログラム (pc) を無視し、代わりに defaultProg を使用してスキャンを続行します。これにより、Precise GCのロジックが実質的にバイパスされ、ポインタの正確な識別が行われなくなります。結果として、GCはポインタを無視するか、あるいはすべてのワードをポインタであるかのように扱う（保守的なGCに近い挙動）ことになります。

この変更により、GoのGCがPrecise GCのロジックをスキップするパスが導入され、GC関連のデバッグや問題の切り分けが容易になりました。

関連リンク

  • Go言語のガベージコレクションに関する公式ドキュメントやブログ記事（当時のもの）
  • Goのランタイムソースコードリポジトリ
  • GoのIssueトラッカーでGC関連のバグや議論がされているもの

（注：2013年当時の情報源を正確に特定することは困難なため、一般的なカテゴリを記載しています。）

参考にした情報源リンク

  • Go言語のガベージコレクションに関する一般的な解説記事
  • Go言語のランタイムソースコード（特にsrc/runtime/mgc.goやsrc/runtime/mheap.goなど、GC関連のファイル）
  • ガベージコレクションの種類（Precise GC vs Conservative GC）に関するコンピュータサイエンスの文献
  • Goの初期のコミット履歴やデザインドキュメント（もし公開されていれば）

（注：具体的なURLはコミット当時の情報にアクセスする必要があるため、一般的な情報源のカテゴリを記載しています。）