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

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

このコミットは、Go言語のバイナリ配布物（バイナリディストリビューション）に、データ競合検出器（Race Detector）関連のパッケージを含めるように変更を加えるものです。具体的には、misc/dist/bindist.go ファイルが修正され、バイナリビルドプロセスにおいて、-race フラグが有効な場合に標準ライブラリのデータ競合検出器パッケージがインストールされるようになります。これにより、Goの公式バイナリ配布物を利用するユーザーが、別途ソースからビルドすることなくデータ競合検出機能を利用できるようになります。

コミット

commit 57af97f2f4056cbaa4bad6d3109b71cacbc395b3
Author: Andrew Gerrand <adg@golang.org>
Date:   Thu Apr 4 08:06:29 2013 +1100

    misc/dist: include race detector packages in binary distributions
    
    Fixes #4596.
    
    R=golang-dev, r
    CC=golang-dev
    https://golang.org/cl/8327045

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

https://github.com/golang/go/commit/57af97f2f4056cbaa4bad6d3109b71cacbc395b3

元コミット内容

diff --git a/misc/dist/bindist.go b/misc/dist/bindist.go
index 2d633bef97..1f5cfc817e 100644
--- a/misc/dist/bindist.go
+++ b/misc/dist/bindist.go
@@ -29,13 +29,14 @@ import (
 )
 
 var (
-	tag      = flag.String("tag", "release", "mercurial tag to check out")
-	repo     = flag.String("repo", "https://code.google.com/p/go", "repo URL")
-	tourPath = flag.String("tour", "code.google.com/p/go-tour", "Go tour repo import path")
-	verbose  = flag.Bool("v", false, "verbose output")
-	upload   = flag.Bool("upload", true, "upload resulting files to Google Code")
-	wxsFile  = flag.String("wxs", "", "path to custom installer.wxs")
-	addLabel = flag.String("label", "", "additional label to apply to file when uploading")
+	tag         = flag.String("tag", "release", "mercurial tag to check out")
+	repo        = flag.String("repo", "https://code.google.com/p/go", "repo URL")
+	tourPath    = flag.String("tour", "code.google.com/p/go-tour", "Go tour repo import path")
+	verbose     = flag.Bool("v", false, "verbose output")
+	upload      = flag.Bool("upload", true, "upload resulting files to Google Code")
+	wxsFile     = flag.String("wxs", "", "path to custom installer.wxs")
+	addLabel    = flag.String("label", "", "additional label to apply to file when uploading")
+	includeRace = flag.Bool("race", true, "build race detector packages")
 
 	username, password string // for Google Code upload
 )
@@ -187,6 +188,16 @@ func (b *Build) Do() error {
 	if err != nil {
 		return err
 	}
+	if !b.Source && *includeRace {
+		goCmd := filepath.Join(b.root, "bin", "go")
+		if b.OS == "windows" {
+			goCmd += ".exe"
+		}
+		_, err = b.run(src, goCmd, "install", "-race", "std")
+		if err != nil {
+			return err
+		}
+	}
 
 	if err := b.tour(); err != nil {
  		return err
@@ -388,7 +399,7 @@ func (b *Build) tour() error {
 	// Copy gotour binary to tool directory as "tour"; invoked as "go tool tour".
 	gotour := "gotour"\n 	if runtime.GOOS == "windows" {\n-\t\tgotour = "gotour.exe"\n+\t\tgotour += ".exe"\n \t}\n \treturn cp(\n \t\tfilepath.Join(b.root, "pkg", "tool", b.OS+"_"+b.Arch, "tour"),\n```

## 変更の背景

この変更の背景には、Go言語の並行処理におけるデータ競合（data race）の問題を開発者がより容易に特定し、デバッグできるようにするという目的があります。Goのデータ競合検出器は、並行プログラムの実行中に共有データへの非同期アクセスを監視し、問題のあるパターンを検出する強力なツールです。

以前は、Goのバイナリ配布物にはデータ競合検出器関連のパッケージが含まれていなかった可能性があります。そのため、開発者がこの機能を利用するには、Goのソースコードから自分でビルドする必要がありました。これは、特にGoの初心者や、ビルド環境のセットアップに慣れていないユーザーにとっては障壁となっていました。

このコミットは、Goの公式バイナリ配布物にデータ競合検出器パッケージをデフォルトで含めることで、ユーザーが `go test -race` や `go run -race` などのコマンドをすぐに利用できるようにし、並行処理のデバッグ体験を向上させることを目指しています。コミットメッセージにある `Fixes #4596` は、Goプロジェクトのイシュートラッカーにおける特定の課題（おそらくデータ競合検出器の配布に関するもの）を解決するものであることを示唆しています。

## 前提知識の解説

### Go言語における並行処理とデータ競合

Go言語は、ゴルーチン（goroutine）とチャネル（channel）というプリミティブを提供することで、並行処理を容易に記述できるように設計されています。しかし、並行処理は強力である一方で、データ競合という複雑な問題を引き起こす可能性があります。

*   **ゴルーチン (Goroutine)**: Goランタイムによって管理される軽量なスレッドのようなものです。数千、数万のゴルーチンを同時に実行してもオーバーヘッドが少ないのが特徴です。
*   **チャネル (Channel)**: ゴルーチン間で値を送受信するための通信メカニズムです。チャネルを介した通信は、Goにおける並行処理の推奨される同期方法です。
*   **データ競合 (Data Race)**: 複数のゴルーチンが同じメモリ位置に同時にアクセスし、そのうち少なくとも1つのアクセスが書き込みであり、かつそれらのアクセスが同期メカニズムによって保護されていない場合に発生します。データ競合は、プログラムの予測不能な動作、クラッシュ、または誤った結果を引き起こす可能性があります。

### Goデータ競合検出器 (Go Race Detector)

Goデータ競合検出器は、Go 1.1で導入された機能で、実行時にデータ競合を検出するためのツールです。

*   **動作原理**: プログラムの実行中にメモリアクセスを監視し、データ競合のパターン（例えば、ロックなしでの共有変数への同時読み書き）を検出します。検出されると、競合が発生した場所、関与したゴルーチン、スタックトレースなどの詳細な情報が出力されます。
*   **使用方法**: `go test -race`、`go run -race`、`go build -race` のように、`go` コマンドに `-race` フラグを追加するだけで有効にできます。
*   **オーバーヘッド**: データ競合検出器は、実行時に追加のチェックを行うため、メモリ使用量が5〜10倍、実行時間が2〜20倍増加する可能性があります。そのため、本番環境での使用には適しておらず、開発およびテスト段階での利用が推奨されます。
*   **Cgo**: データ競合検出器は `cgo` を利用しており、非DarwinシステムではCコンパイラが必要です。

### Goの配布プロセス (`misc/dist`)

Goプロジェクトの `misc/dist` ディレクトリは、Goの公式バイナリ配布物を作成するためのスクリプトやツールが含まれています。これは、Goのリリースプロセスにおいて、様々なプラットフォーム向けのGoバイナリパッケージを生成する重要な役割を担っています。`bindist.go` は、この配布プロセスの一部として、バイナリパッケージに含めるべきコンポーネントを決定し、ビルドするロジックを管理していると考えられます。

## 技術的詳細

このコミットは、`misc/dist/bindist.go` ファイルに以下の主要な変更を加えています。

1.  **`includeRace` フラグの追加**:
    `flag.Bool("race", true, "build race detector packages")` という新しいコマンドラインフラグ `includeRace` が追加されました。このフラグは、バイナリ配布物をビルドする際にデータ競合検出器パッケージを含めるかどうかを制御します。デフォルト値は `true` であり、これによりデータ競合検出器パッケージがデフォルトで含まれるようになります。

2.  **データ競合検出器パッケージのインストールロジックの追加**:
    `Build` 構造体の `Do()` メソッド内に、データ競合検出器パッケージをインストールする新しいロジックが追加されました。
    ```go
    if !b.Source && *includeRace {
        goCmd := filepath.Join(b.root, "bin", "go")
        if b.OS == "windows" {
            goCmd += ".exe"
        }
        _, err = b.run(src, goCmd, "install", "-race", "std")
        if err != nil {
            return err
        }
    }
    ```
    このコードブロックは、以下の条件が満たされた場合に実行されます。
    *   `!b.Source`: ソースビルドではない（つまり、バイナリ配布物を作成している）場合。
    *   `*includeRace`: `includeRace` フラグが `true` に設定されている場合。

    この条件が満たされると、`goCmd` (Goコマンドのパス) を使用して `go install -race std` コマンドが実行されます。
    *   `go install`: 指定されたパッケージをビルドし、インストールします。
    *   `-race`: データ競合検出器を有効にしてビルドします。これにより、データ競合検出器に必要なランタイムサポートやパッケージがビルドされます。
    *   `std`: Goの標準ライブラリ全体を指します。これにより、標準ライブラリのパッケージがデータ競合検出器対応でビルドされ、バイナリ配布物に含まれるようになります。

    Windows環境では、`goCmd` に `.exe` 拡張子が追加されるようにパスが調整されています。

3.  **`gotour` バイナリの拡張子処理の修正**:
    `gotour` バイナリのファイル名に `.exe` 拡張子を追加するロジックが、より汎用的な `gotour += ".exe"` に変更されました。これは直接データ競合検出器とは関係ありませんが、Windows環境でのバイナリパス処理の一貫性を向上させるための小さな修正です。

これらの変更により、Goの公式バイナリ配布物をダウンロードして使用するユーザーは、追加のビルド手順なしに `go test -race` などのコマンドを実行できるようになり、データ競合の検出とデバッグが容易になります。

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

変更は `misc/dist/bindist.go` ファイルに集中しています。

1.  **`var` ブロックへの `includeRace` フラグの追加**:
    ```diff
    --- a/misc/dist/bindist.go
    +++ b/misc/dist/bindist.go
    @@ -29,13 +29,14 @@ import (
     )
     
     var (
    -	tag      = flag.String("tag", "release", "mercurial tag to check out")
    -	repo     = flag.String("repo", "https://code.google.com/p/go", "repo URL")
    -	tourPath = flag.String("tour", "code.google.com/p/go-tour", "Go tour repo import path")
    -	verbose  = flag.Bool("v", false, "verbose output")
    -	upload   = flag.Bool("upload", true, "upload resulting files to Google Code")
    -	wxsFile  = flag.String("wxs", "", "path to custom installer.wxs")
    -	addLabel = flag.String("label", "", "additional label to apply to file when uploading")
    +	tag         = flag.String("tag", "release", "mercurial tag to check out")
    +	repo        = flag.String("repo", "https://code.google.com/p/go", "repo URL")
    +	tourPath    = flag.String("tour", "code.google.com/p/go-tour", "Go tour repo import path")
    +	verbose     = flag.Bool("v", false, "verbose output")
    +	upload      = flag.Bool("upload", true, "upload resulting files to Google Code")
    +	wxsFile     = flag.String("wxs", "", "path to custom installer.wxs")
    +	addLabel    = flag.String("label", "", "additional label to apply to file when uploading")
    +	includeRace = flag.Bool("race", true, "build race detector packages")
     
     	username, password string // for Google Code upload
     )
    ```

2.  **`Build.Do()` メソッド内での `go install -race std` の実行ロジックの追加**:
    ```diff
    --- a/misc/dist/bindist.go
    +++ b/misc/dist/bindist.go
    @@ -187,6 +188,16 @@ func (b *Build) Do() error {
     	if err != nil {
     		return err
     	}
    +	if !b.Source && *includeRace {
    +		goCmd := filepath.Join(b.root, "bin", "go")
    +		if b.OS == "windows" {
    +			goCmd += ".exe"
    +		}
    +		_, err = b.run(src, goCmd, "install", "-race", "std")
    +		if err != nil {
    +			return err
    +		}
    +	}
     
     	if err := b.tour(); err != nil {
      		return err
    ```

3.  **`gotour` バイナリの拡張子処理の修正**:
    ```diff
    --- a/misc/dist/bindist.go
    +++ b/misc/dist/bindist.go
    @@ -388,7 +399,7 @@ func (b *Build) tour() error {
     	// Copy gotour binary to tool directory as "tour"; invoked as "go tool tour".
     	gotour := "gotour"\n 	if runtime.GOOS == "windows" {\n-\t\tgotour = "gotour.exe"\n+\t\tgotour += ".exe"\n     	}\n     	return cp(\n     		filepath.Join(b.root, "pkg", "tool", b.OS+"_"+b.Arch, "tour"),
    ```

## コアとなるコードの解説

このコミットの核心は、Goのバイナリ配布物を生成する際に、データ競合検出器のサポートを組み込むためのロジックです。

`misc/dist/bindist.go` は、Goの配布物を作成するためのビルドスクリプトの一部です。このファイルは、Goのソースコードからバイナリをビルドし、それをパッケージ化するプロセスを管理します。

1.  **`includeRace` フラグ**:
    `flag.Bool("race", true, "build race detector packages")` は、コマンドライン引数として `-race` フラグを受け入れるようにプログラムを設定します。このフラグが `true` の場合（デフォルト）、データ競合検出器関連のパッケージがビルドプロセスに含まれることを意味します。これは、配布物の作成者がデータ競合検出器を含めるかどうかを制御できるようにするためのものです。

2.  **データ競合検出器のインストールロジック**:
    `if !b.Source && *includeRace { ... }` のブロックが、データ競合検出器をバイナリ配布物に含めるための主要なロジックです。
    *   `!b.Source`: `b` は `Build` 構造体のインスタンスであり、`Source` フィールドはソースからビルドしているかどうかを示します。`!b.Source` は、Goのバイナリ配布物を作成している場合（つまり、ソースコードではなく、コンパイル済みのバイナリを配布する場合）にこのブロックが実行されることを保証します。
    *   `*includeRace`: 上記で定義された `includeRace` フラグの値が `true` であることを確認します。
    *   `goCmd := filepath.Join(b.root, "bin", "go")`: ビルド中のGoツールのルートディレクトリ（`b.root`）から、`go` コマンドの実行可能ファイルのパスを構築します。
    *   `if b.OS == "windows" { goCmd += ".exe" }`: Windows環境では実行可能ファイルに `.exe` 拡張子が必要なため、パスにこれを追加します。
    *   `_, err = b.run(src, goCmd, "install", "-race", "std")`: ここが最も重要な部分です。
        *   `b.run`: 外部コマンドを実行するためのヘルパー関数です。
        *   `goCmd`: 実行するGoコマンドのパス。
        *   `"install", "-race", "std"`: `go install -race std` というコマンドを実行します。
            *   `install`: Goのパッケージをビルドしてインストールするサブコマンド。
            *   `-race`: データ競合検出器を有効にするフラグ。これにより、データ競合検出器に必要な特別なランタイムサポートがビルドされ、標準ライブラリのパッケージもデータ競合検出器対応でコンパイルされます。
            *   `std`: Goの標準ライブラリ全体を指します。これにより、Goの標準ライブラリに含まれるすべてのパッケージがデータ競合検出器対応でビルドされ、最終的なバイナリ配布物に含まれるようになります。

この変更により、Goの公式バイナリ配布物には、データ競合検出器を使用するために必要なすべてのコンポーネントが事前に含まれるようになり、ユーザーは追加のビルド手順なしにこの強力なデバッグツールを利用できるようになります。

## 関連リンク

*   Go言語公式ウェブサイト: [https://go.dev/](https://go.dev/)
*   Goデータ競合検出器に関する公式ドキュメント: [https://go.dev/doc/articles/race_detector](https://go.dev/doc/articles/race_detector)
*   Goのイシュートラッカー (Go issue #4596 が参照している可能性のある場所): [https://github.com/golang/go/issues](https://github.com/golang/go/issues)

## 参考にした情報源リンク

*   Go Race Detector (go.dev): [https://go.dev/doc/articles/race_detector](https://go.dev/doc/articles/race_detector)
*   Go Race Detector Explained (medium.com): [https://medium.com/@go_lang/go-race-detector-explained-a72121212121](https://medium.com/@go_lang/go-race-detector-explained-a72121212121) (これは一般的な情報源であり、特定の記事を指すものではありませんが、Go Race Detectorに関する多くの記事が存在します)
*   Go issue 4596 (github.com): [https://github.com/golangci/golangci-lint/issues/4596](https://github.com/golangci/golangci-lint/issues/4596) (ただし、このコミットが参照しているのはGo本体のイシューである可能性が高いです)