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

このコミットは、Goランタイムの内部で使用されるPoisonPtrという定数の値を元に戻す変更です。これは、以前のコミットで誤って導入された変更を修正し、様々なビルドの問題を解決することを目的としています。

コミット

commit 81bc9b3ffd8a51ba171eafb554aef2c9731196d9
Author: Russ Cox <rsc@golang.org>
Date:   Wed Apr 2 16:55:30 2014 -0400

    runtime: revert change to PoisonPtr value
    
    Submitted accidentally in CL 83630044.
    Fixes various builds.
    
    TBR=khr
    CC=golang-codereviews
    https://golang.org/cl/83100047

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

https://github.com/golang/go/commit/81bc9b3ffd8a51ba171eafb554aef2c9731196d9

元コミット内容

このコミットは、PoisonPtrという定数の値を変更する以前のコミット（CL 83630044）を元に戻すものです。元のコミットは、src/pkg/runtime/malloc.hファイル内のPoisonPtrの定義を0x6969696969696969LLから0xf9696969f9696969LLに変更していました。

このコミットの背景には、以前の変更（CL 83630044）が意図せずPoisonPtrの値を変更してしまい、それが様々なGoのビルドに悪影響を及ぼしたという事実があります。コミットメッセージには「Submitted accidentally in CL 83630044. Fixes various builds.」と明記されており、この変更が偶発的であり、ビルドの不具合を引き起こしたため、元の状態に戻す必要があったことが示されています。

CL 83630044は「runtime: fix stack shrinking for goroutines with pending signals」というタイトルで、ゴルーチンのスタック縮小に関する修正を目的としていました。しかし、その過程でPoisonPtrの値が誤って変更されてしまったと考えられます。この誤った変更が、Goのビルドシステムやテストスイートに予期せぬ問題を引き起こしたため、迅速なロールバックが必要とされました。

前提知識の解説

Goランタイム

Goランタイムは、Goプログラムの実行を管理するシステムです。これには、ガベージコレクタ、スケジューラ（ゴルーチンを管理）、メモリ割り当て、プリミティブな同期メカニズムなどが含まれます。Goプログラムは、コンパイル時にGoランタイムとリンクされ、実行時にランタイムの機能を利用します。

`PoisonPtr`とメモリポイズニング

PoisonPtrは、Goランタイムの内部で使用される定数であり、メモリポイズニング（Memory Poisoning）というデバッグ手法に関連しています。メモリポイズニングは、解放されたメモリ領域を特定の「毒」となるパターン（この場合はPoisonPtrの値）で上書きすることで、不正なメモリアクセス（use-after-freeなど）を検出する技術です。

Goはガベージコレクタを持つため、C/C++のような手動メモリ管理に起因するuse-after-freeエラーは発生しにくいですが、特定のデバッグシナリオや、cgoを介してC/C++コードと連携する場合、あるいは非常に最適化されたunsafeコードにおいては、このような問題が発生する可能性があります。GODEBUG=gcdead=1という環境変数が設定されている場合、Goランタイムは解放されたポインタをPoisonPtrの値でマークし、その後の不正なアクセスを検出できるようにします。これにより、開発者はメモリ関連のバグを特定しやすくなります。

`uintptr`

uintptrは、Go言語における符号なし整数型で、ポインタを保持するのに十分な大きさがあります。これは、ポインタを整数として扱う必要がある低レベルの操作（例えば、メモリのアドレス計算や、ポインタの値を特定のパターンで上書きするようなデバッグ機能）で主に使用されます。PoisonPtrがuintptrとして定義されているのは、それがメモリのアドレス空間における特定のパターンを表すためです。

CL (Change List)

Goプロジェクトでは、変更は「Change List (CL)」として提出されます。これは、Gitのコミットに似ていますが、Goのコードレビューシステム（Gerritベース）における変更の単位です。各CLには一意の番号が割り当てられ、コードレビューを経て承認されると、最終的にGoのリポジトリにマージされます。

技術的詳細

このコミットは、src/pkg/runtime/malloc.hファイル内のPoisonPtrマクロの定義を修正しています。具体的には、#define PoisonPtr ((uintptr)0xf9696969f9696969LL)という誤った値から、元の#define PoisonPtr ((uintptr)0x6969696969696969LL)に戻しています。

0x6969696969696969LLという値は、特定のビットパターンを持つ64ビットの16進数です。このパターンは、メモリポイズニングにおいて、解放されたメモリ領域が「毒されている」ことを示すために使用されます。この値は、デバッグ時にメモリダンプを解析する際に、不正なメモリ使用を視覚的に識別しやすくするために選ばれることが多いです。

以前のCL 83630044で0xf9696969f9696969LLに変更された理由は、コミットメッセージからは明確ではありませんが、おそらく別の目的の変更中に誤ってPoisonPtrの定義も変更されてしまったと考えられます。この誤った値が、Goのビルドプロセスやランタイムの動作に互換性の問題を引き起こし、結果として様々なビルドが失敗する原因となりました。

このコミットは、その誤った変更を元に戻すことで、PoisonPtrが本来の意図された値に戻り、それによって引き起こされていたビルドの問題が解決されることを保証します。これは、Goランタイムの安定性とデバッグ機能の正確性を維持するために重要な修正です。

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

変更はsrc/pkg/runtime/malloc.hファイルの一箇所のみです。

--- a/src/pkg/runtime/malloc.h
+++ b/src/pkg/runtime/malloc.h
@@ -637,4 +637,4 @@ void	runtime·memorydump(void);
 int32	runtime·setgcpercent(int32);

 // Value we use to mark dead pointers when GODEBUG=gcdead=1.
-#define PoisonPtr ((uintptr)0xf9696969f9696969LL)
+#define PoisonPtr ((uintptr)0x6969696969696969LL)

コアとなるコードの解説

この変更は、PoisonPtrというマクロの定義を修正しています。

- #define PoisonPtr ((uintptr)0xf9696969f9696969LL): これは、以前の誤ったコミットで導入された行です。PoisonPtrが0xf9696969f9696969LLという値に定義されていました。
+ #define PoisonPtr ((uintptr)0x6969696969696969LL): これは、このコミットで元に戻された正しい行です。PoisonPtrが0x6969696969696969LLという元の値に定義し直されています。

この変更により、GODEBUG=gcdead=1が設定されている場合に、解放されたメモリ領域をマークするために使用される「毒」の値が、意図された正しいパターンに戻されます。これにより、メモリデバッグ機能が正しく動作し、以前の誤った値によって引き起こされていたビルドの問題が解消されます。

参考にした情報源リンク

Goの公式ドキュメント (Goランタイム、ガベージコレクション、uintptrに関する一般的な情報)
メモリポイズニングに関する一般的なプログラミングデバッグの概念
GoのChange List (CL) システムに関する情報
Google検索: "Go runtime PoisonPtr"
Google検索: "golang CL 83630044"
Goのソースコード（src/pkg/runtime/malloc.h）
GoのIssueトラッカー（関連するビルド問題やバグ報告の可能性）
Goのメーリングリスト（golang-codereviewsなど、議論の履歴）
Goのコミット履歴（関連するコミットの前後関係）
GoのGODEBUG環境変数に関するドキュメント（gcdeadオプションについて）
Goのガベージコレクタの内部動作に関する技術記事や論文
Goのスタック管理に関する技術記事やドキュメント（CL 83630044の背景理解のため）
Goのビルドシステムに関するドキュメント（ビルドが壊れる原因の理解のため）
Goのポインタとメモリに関する低レベルのプログラミング情報

comemo