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

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

このコミットは、Go言語のdebug/gosymパッケージ内のテストコードにおいて、go tool 6a（アセンブラ）およびgo tool 6l（リンカ）の実行結果（標準出力および標準エラー出力）をプロセスの標準出力および標準エラー出力にリダイレクトするように変更するものです。これにより、これらのツールが失敗した場合にその詳細なエラーメッセージを確認できるようになり、デバッグが容易になります。

コミット

commit 0fc441b053097ad07f20a77cb1a71a366b820a01
Author: David Symonds <dsymonds@golang.org>
Date:   Thu Feb 16 14:54:45 2012 +1100

    debug/gosym: dump 6a/6l output to process stdout/stderr so we can see failures.
    
    TBR=r
    CC=golang-dev
    https://golang.org/cl/5671060

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

https://github.com/golang/go/commit/0fc441b053097ad07f20a77cb1a71a366b820a01

元コミット内容

このコミットの目的は、debug/gosymパッケージのテスト実行時に、内部で呼び出されるgo tool 6a（アセンブラ）とgo tool 6l（リンカ）の標準出力（stdout）と標準エラー出力（stderr）を、テストを実行しているプロセスの標準出力と標準エラー出力に直接出力するようにすることです。これにより、これらのツールが何らかの理由で失敗した場合に、その失敗の原因となる詳細なメッセージを開発者が直接確認できるようになります。コミットメッセージの「TBR=r」はレビュー担当者、「CC=golang-dev」はメーリングリストへの通知、「https://golang.org/cl/5671060」はGo Gerritの変更リストへのリンクを示しています。

変更の背景

debug/gosymパッケージは、Goバイナリのシンボルテーブルや行番号テーブルを解析するための機能を提供します。このパッケージのテストでは、実際にアセンブラ（6a）とリンカ（6l）を使用してテスト用のバイナリを生成し、そのバイナリを解析する、という手順を踏んでいます。

変更前は、6aや6lの実行時に発生したエラーメッセージや警告が、テストを実行しているプロセスのコンソールには表示されませんでした。これは、exec.Commandで外部コマンドを実行した場合、デフォルトではそのコマンドの標準出力と標準エラー出力は親プロセスには表示されず、破棄されるか、またはバッファリングされるためです。

もし6aや6lの実行が失敗した場合、cmd.Run()はエラーを返しますが、そのエラーが抽象的である場合、具体的な失敗の原因（例えば、アセンブリコードの構文エラーやリンカのパスの問題など）を特定するのが困難でした。このコミットは、これらのツールの出力を直接表示することで、テストの失敗時に開発者が迅速に問題を診断できるようにすることを目的としています。

前提知識の解説

  • go tool 6a: Go 1.5より前のGoツールチェインにおいて、amd64（x86-64）アーキテクチャ向けのアセンブラでした。アセンブリ言語で書かれたソースコード（.sまたは.asmファイル）をオブジェクトファイル（.6ファイル）にコンパイルするために使用されました。Go 1.5以降はgo tool asmに統合されています。
  • go tool 6l: Go 1.5より前のGoツールチェインにおいて、amd64アーキテクチャ向けのリンカでした。オブジェクトファイル（.6ファイル）やアーカイブファイル（.aファイル）を結合して実行可能なバイナリファイルを生成するために使用されました。Go 1.5以降はgo tool linkに統合されています。
  • debug/gosymパッケージ: Go言語の標準ライブラリの一部で、Goバイナリに埋め込まれたシンボルテーブル（関数名、変数名など）や行番号テーブル（ソースコードの行と実行可能コードのアドレスのマッピング）をプログラム的に読み取り、解析するための機能を提供します。デバッガやプロファイラなどのツールがGoバイナリの内部構造を理解するために利用されます。
  • os.Stdout: Go言語のosパッケージで提供される、標準出力（通常はコンソール）を表すio.Writerインターフェースの実装です。
  • os.Stderr: Go言語のosパッケージで提供される、標準エラー出力（通常はコンソール）を表すio.Writerインターフェースの実装です。エラーメッセージや診断情報を出力するために使用されます。
  • exec.Command: Go言語のos/execパッケージの関数で、外部コマンドを実行するためのCmd構造体を生成します。この構造体を通じて、コマンドの引数、環境変数、標準入出力などを設定できます。
  • cmd.Run(): exec.Cmd構造体のメソッドで、設定された外部コマンドを実行し、コマンドが終了するまで待機します。コマンドの実行が成功した場合はnilを返し、失敗した場合はエラーを返します。
  • panic(err): Go言語の組み込み関数で、プログラムの実行を即座に停止させ、スタックトレースを出力します。通常、回復不可能なエラーが発生した場合や、プログラムのロジックに重大な問題がある場合に使用されます。テストコードでは、予期せぬエラーが発生した場合にテストを失敗させるために使われることがあります。

技術的詳細

この変更は、Go言語のos/execパッケージのCmd構造体のStdoutおよびStderrフィールドを利用しています。

exec.Commandで外部コマンド（この場合はsh -c "go tool 6a ... && go tool 6l ..."）を実行する際、デフォルトではそのコマンドの標準出力と標準エラー出力は、Cmd構造体のStdoutおよびStderrフィールドが設定されていない限り、親プロセスとは独立して扱われます。具体的には、これらのフィールドがnilの場合、Cmd.Run()はコマンドの出力を内部的にバッファリングするか、または破棄します。

このコミットでは、以下の2行を追加しています。

cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr

これにより、cmdによって実行される外部コマンドの標準出力は、Goプログラム自身の標準出力（os.Stdout）に直接接続されます。同様に、外部コマンドの標準エラー出力は、Goプログラム自身の標準エラー出力（os.Stderr）に直接接続されます。

この設定により、go tool 6aやgo tool 6lが何かを出力した場合（例えば、コンパイルエラー、リンカエラー、警告メッセージなど）、それらのメッセージはテストを実行しているコンソールにリアルタイムで表示されるようになります。これにより、テストが失敗した際に、開発者は外部ツールの具体的なエラーメッセージを確認し、問題の原因を迅速に特定できるようになります。これは、特にCI/CD環境や自動テストシステムにおいて、デバッグ情報を得る上で非常に重要です。

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

--- a/src/pkg/debug/gosym/pclntab_test.go
+++ b/src/pkg/debug/gosym/pclntab_test.go
@@ -28,6 +28,8 @@ func dotest() bool {
 	// but we have renamed it to keep it away from the go tool.
 	pclinetestBinary = os.TempDir() + "/pclinetest"
 	cmd := exec.Command("sh", "-c", "go tool 6a pclinetest.asm && go tool 6l -E main -o "+pclinetestBinary+" pclinetest.6")
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
 	if err := cmd.Run(); err != nil {
 		panic(err)
 	}

コアとなるコードの解説

変更はsrc/pkg/debug/gosym/pclntab_test.goファイル内のdotest()関数にあります。

元のコードでは、exec.Commandを使用してシェルコマンドを実行し、pclinetest.asmをgo tool 6aでアセンブルし、その結果の.6ファイルをgo tool 6lでリンクしてpclinetestBinaryという実行可能ファイルを生成していました。

追加された2行は以下の通りです。

  1. cmd.Stdout = os.Stdout: これは、cmdによって実行されるシェルコマンド（go tool 6aとgo tool 6lを含む）の標準出力ストリームを、Goプログラム自身の標準出力ストリーム（通常はコンソール）に接続します。これにより、6aや6lが標準出力に何かを書き込んだ場合、それが直接コンソールに表示されるようになります。
  2. cmd.Stderr = os.Stderr: 同様に、これはcmdによって実行されるシェルコマンドの標準エラー出力ストリームを、Goプログラム自身の標準エラー出力ストリームに接続します。これにより、6aや6lがエラーメッセージや警告を標準エラー出力に書き込んだ場合、それが直接コンソールに表示されるようになります。

これらの変更により、外部コマンドの実行中に発生する可能性のある詳細な情報やエラーメッセージが、テストの実行ログに直接出力されるようになり、デバッグの効率が大幅に向上します。

関連リンク

  • Go Gerrit Change-ID: https://golang.org/cl/5671060
    • Goプロジェクトでは、コードレビューと変更管理にGerritを使用しています。このリンクは、このコミットに対応するGerritの変更リストを示しており、詳細なレビューコメントや変更履歴を確認できます。

参考にした情報源リンク