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

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

このコミットは、Go言語のランタイムとデータ競合検出 (runtime/race) パッケージに関連する変更を含んでいます。具体的には、src/pkg/runtime/malloc.goc と src/pkg/runtime/race/race.go の2つのファイルが変更されています。

コミット

commit 7c44edf4250d8e1ad0ed37bf4ae27ec7f6c07ab6
Author: Shenghou Ma <minux.ma@gmail.com>
Date:   Tue Oct 23 02:33:51 2012 +0800

    runtime, runtime/race: add missing if(raceenabled), update package docs of pkg race
    
    R=dvyukov
    CC=golang-dev
    https://golang.org/cl/6733058

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

https://github.com/golang/go/commit/7c44edf4250d8e1ad0ed37bf4ae27ec7f6c07ab6

元コミット内容

diff --git a/src/pkg/runtime/malloc.goc b/src/pkg/runtime/malloc.goc
index eaae52a641..f8aa1c949e 100644
--- a/src/pkg/runtime/malloc.goc
+++ b/src/pkg/runtime/malloc.goc
@@ -715,7 +715,8 @@ runtime·cnew(Type *typ)
 	uint32 flag;
 	void *ret;
 
-\tm->racepc = runtime·getcallerpc(&typ);\n+\tif(raceenabled)\n+\t\tm->racepc = runtime·getcallerpc(&typ);\n \tflag = typ->kind&KindNoPointers ? FlagNoPointers : 0;\n \tret = runtime·mallocgc(typ->size, flag, 1, 1);\n \ndiff --git a/src/pkg/runtime/race/race.go b/src/pkg/runtime/race/race.go
index ddeff5de76..f3a7be50c6 100644
--- a/src/pkg/runtime/race/race.go
+++ b/src/pkg/runtime/race/race.go
@@ -4,7 +4,7 @@
 
 // +build race,linux,amd64 race,darwin,amd64
 
-// Data race detection.\n+// Package race provides low-level facilities for data race detection.\n package race
 
 /*

変更の背景

このコミットの背景には、Go言語のデータ競合検出器 (Data Race Detector) の効率性と正確性の向上が挙げられます。

  1. if(raceenabled) の追加: Goのデータ競合検出器は、プログラムの実行時にメモリへのアクセスを監視し、複数のゴルーチンが同時に同じメモリ位置にアクセスし、少なくとも1つのアクセスが書き込みである場合に発生するデータ競合を検出します。この検出器は非常に強力ですが、その性質上、実行時のオーバーヘッドを伴います。 raceenabled は、データ競合検出器が有効になっているかどうかを示す内部フラグです。データ競合検出器が有効でない場合（つまり、通常のビルドの場合）、競合検出に関連するコードは実行する必要がありません。 runtime·cnew 関数は、Goのランタイム内で新しいメモリを割り当てる際に使用される低レベルの関数です。以前のコードでは、raceenabled の状態に関わらず m->racepc = runtime·getcallerpc(&typ); という行が常に実行されていました。この行は、データ競合検出器が有効な場合にのみ意味を持つ処理です。 したがって、if(raceenabled) を追加することで、データ競合検出器が有効でないビルドではこの処理をスキップし、不要なオーバーヘッドを削減することが目的です。これは、パフォーマンスの最適化と、データ競合検出器が有効でない場合のコードパスのクリーンアップを意図しています。

  2. runtime/race パッケージドキュメントの更新: runtime/race パッケージは、Goのデータ競合検出器の低レベルな機能を提供します。以前のパッケージコメントは単に // Data race detection. となっており、その役割が十分に説明されていませんでした。 新しいコメント // Package race provides low-level facilities for data race detection. は、このパッケージがデータ競合検出のための「低レベルな機能」を提供することを明確にしています。これにより、開発者がこのパッケージの目的とスコープをより正確に理解できるようになります。これは、ドキュメンテーションの改善と、パッケージの役割の明確化を目的としています。

前提知識の解説

Go言語のランタイム (Runtime)

Go言語のランタイムは、Goプログラムの実行を管理する非常に重要な部分です。これには、ガベージコレクション、ゴルーチン (goroutine) のスケジューリング、メモリ割り当て、システムコールとのインターフェースなどが含まれます。Goプログラムは、コンパイル時にランタイムとリンクされ、ランタイムが提供する機能を利用して実行されます。src/pkg/runtime/ ディレクトリには、このランタイムのソースコードが含まれています。

データ競合 (Data Race)

データ競合は、並行プログラミングにおける一般的なバグの一種です。以下の3つの条件がすべて満たされた場合に発生します。

  1. 複数のゴルーチン（またはスレッド）が同時に同じメモリ位置にアクセスする。
  2. 少なくとも1つのアクセスが書き込み操作である。
  3. それらのアクセスが同期メカニズム（ミューテックス、チャネルなど）によって保護されていない。

データ競合が発生すると、プログラムの動作が予測不能になり、クラッシュや誤った結果につながる可能性があります。

Go言語のデータ競合検出器 (Data Race Detector)

Go言語には、データ競合を検出するための組み込みツールがあります。これは、コンパイル時に -race フラグを付けてビルドすることで有効になります。

go build -race myprogram.go

-race フラグを付けてビルドされたプログラムは、実行時にメモリへのアクセスを監視し、データ競合が検出された場合に警告を出力します。この検出器は、Googleが開発したThreadSanitizerという技術に基づいています。

raceenabled フラグ

raceenabled は、Goランタイム内部で使用されるブール型のフラグです。このフラグは、プログラムが -race フラグを付けてビルドされた場合に true に設定され、そうでない場合は false に設定されます。ランタイムコードは、このフラグの値に基づいて、データ競合検出に関連する追加の処理を実行するかどうかを決定します。

runtime/race パッケージ

runtime/race パッケージは、Goのデータ競合検出器の低レベルな実装に関連するコードを含んでいます。このパッケージは、通常のエンドユーザーが直接使用するものではなく、ランタイム内部でデータ競合検出のメカニズムを実装するために使用されます。

技術的詳細

このコミットは、Goランタイムのメモリ割り当て部分とデータ競合検出パッケージのドキュメントという、2つの異なる側面で技術的な改善を行っています。

src/pkg/runtime/malloc.goc の変更

malloc.goc は、Goランタイムのメモリ割り当てに関するC言語のコードが含まれるファイルです（Goのランタイムの一部はC言語で書かれています）。 変更された runtime·cnew(Type *typ) 関数は、新しいオブジェクトのためにメモリを割り当てる際に呼び出されます。

元のコード:

	m->racepc = runtime·getcallerpc(&typ);

この行は、m という構造体（おそらくメモリ割り当てに関するメタデータを持つ）の racepc フィールドに、呼び出し元のプログラムカウンタ (PC) を設定しています。racepc は、データ競合検出器が競合を報告する際に、どのコードパスが関与しているかを特定するために使用される情報です。

変更後のコード:

	if(raceenabled)
		m->racepc = runtime·getcallerpc(&typ);

この変更により、runtime·getcallerpc(&typ) の呼び出しと m->racepc への代入は、raceenabled が true の場合にのみ実行されるようになりました。 技術的な影響:

  • パフォーマンス向上: -race フラグなしでビルドされたGoプログラムでは、raceenabled は false になります。この場合、runtime·getcallerpc の呼び出しとそれに続く代入が完全にスキップされます。これにより、データ競合検出器が不要な場合のランタイムオーバーヘッドが削減され、プログラムの実行速度が向上します。
  • コードの明確化: データ競合検出に関連する処理が、その機能が有効な場合にのみ実行されることがコード上で明確になります。これは、コードの可読性と保守性を向上させます。

src/pkg/runtime/race/race.go の変更

race.go は、runtime/race パッケージのGo言語のソースファイルです。

元のパッケージコメント:

// Data race detection.

これは非常に簡潔ですが、パッケージの具体的な役割についてはあまり情報を提供していません。

変更後のパッケージコメント:

// Package race provides low-level facilities for data race detection.

技術的な影響:

  • ドキュメンテーションの改善: 新しいコメントは、このパッケージが「低レベルな機能 (low-level facilities)」を提供することを明示しています。これは、開発者がこのパッケージがデータ競合検出器の内部実装の一部であり、通常は直接操作するものではないことを理解するのに役立ちます。
  • APIの意図の明確化: パッケージの意図がより明確になることで、将来的な開発者がこのパッケージを誤用したり、その機能について誤解したりする可能性が低くなります。

これらの変更は、Goランタイムの堅牢性、効率性、およびドキュメンテーションの品質を向上させるための、細部への注意を示すものです。

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

--- a/src/pkg/runtime/malloc.goc
+++ b/src/pkg/runtime/malloc.goc
@@ -715,7 +715,8 @@ runtime·cnew(Type *typ)
 	uint32 flag;
 	void *ret;
 
-\tm->racepc = runtime·getcallerpc(&typ);\n+\tif(raceenabled)\n+\t\tm->racepc = runtime·getcallerpc(&typ);\n \tflag = typ->kind&KindNoPointers ? FlagNoPointers : 0;\n \tret = runtime·mallocgc(typ->size, flag, 1, 1);\n \ndiff --git a/src/pkg/runtime/race/race.go b/src/pkg/runtime/race/race.go
index ddeff5de76..f3a7be50c6 100644
--- a/src/pkg/runtime/race/race.go
+++ b/src/pkg/runtime/race/race.go
@@ -4,7 +4,7 @@
 
 // +build race,linux,amd64 race,darwin,amd64
 
-// Data race detection.\n+// Package race provides low-level facilities for data race detection.\n package race
 
 /*

コアとなるコードの解説

src/pkg/runtime/malloc.goc の変更点

runtime·cnew(Type *typ) 関数は、Goランタイムが新しい型のためにメモリを割り当てる際に使用する内部関数です。この関数内で、データ競合検出器が有効な場合にのみ m->racepc フィールドを設定するように変更されました。

  • 変更前: m->racepc = runtime·getcallerpc(&typ); この行は、raceenabled の状態に関わらず常に実行されていました。runtime·getcallerpc は、現在の関数の呼び出し元のプログラムカウンタを取得するランタイム関数です。この情報は、データ競合検出器が競合を報告する際に、どのコードが問題を引き起こしたかを特定するために使用されます。
  • 変更後: if(raceenabled) m->racepc = runtime·getcallerpc(&typ); if(raceenabled) という条件文が追加されました。これにより、データ競合検出器が有効な場合（つまり、プログラムが -race フラグ付きでビルドされた場合）にのみ、runtime·getcallerpc の呼び出しと m->racepc への代入が行われます。 この変更により、データ競合検出器が有効でないビルドでは、この余分な処理がスキップされ、ランタイムのオーバーヘッドが削減されます。

src/pkg/runtime/race/race.go の変更点

runtime/race パッケージのGoソースファイルにおけるパッケージコメントが変更されました。

  • 変更前: // Data race detection. これはパッケージの目的を簡潔に示していますが、その性質（低レベルであること）については言及していません。
  • 変更後: // Package race provides low-level facilities for data race detection. 「low-level facilities (低レベルな機能)」という記述が追加されました。これにより、このパッケージがデータ競合検出器の内部実装の一部であり、通常のエンドユーザーが直接利用するAPIではないことがより明確に示されます。これは、ドキュメンテーションの精度と明確性を向上させるための変更です。

これらの変更は、Goランタイムの効率性とドキュメンテーションの品質を向上させるための、細部にわたる改善です。

関連リンク

参考にした情報源リンク

  • コミットデータ: ./commit_data/14210.txt
  • GitHubコミットページ: https://github.com/golang/go/commit/7c44edf4250d8e1ad0ed37bf4ae27ec7f6c07ab6
  • golang.org/cl/6733058 についてのWeb検索結果: 提供されたCLリンク https://golang.org/cl/6733058 は、このコミットの内容とは異なる情報（go run コマンドの -C フラグに関するもの）を示しており、このコミットの直接的な情報源としては使用できませんでした。