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

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

このコミットは、Goコンパイラのcmd/5g（ARMアーキテクチャ向けコンパイラ）内のpeep.cファイルにおけるデバッグ出力の書式設定に関する修正です。具体的には、peephole最適化のデバッグ時に使用されるprint関数のフォーマット指定子が誤っていた点を修正しています。

コミット

commit 27cb59fdad4696c9a9169af50bff520492d98b35
Author: Anthony Martin <ality@pbrane.org>
Date:   Wed Feb 12 17:03:21 2014 -0800

    cmd/5g: fix print format in peephole debugging
    
    Fixes #7294.
    
    LGTM=minux.ma, dave, bradfitz
    R=golang-codereviews, minux.ma, dave, bradfitz
    CC=golang-codereviews
    https://golang.org/cl/61370043

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

https://github.com/golang/go/commit/27cb59fdad4696c9a9169af50bff520492d98b35

元コミット内容

cmd/5g: fix print format in peephole debugging

このコミットは、peepholeデバッグにおける出力フォーマットの修正を目的としています。Issue #7294を解決します。

変更の背景

この変更は、GoコンパイラのARMアーキテクチャ向けバックエンドであるcmd/5gのデバッグ機能に関するものです。特に、peephole最適化の過程でデバッグ情報を出力する際に、意図しないフォーマットで表示されてしまうバグが存在していました。

Goコンパイラは、コード生成の最終段階でpeephole最適化と呼ばれる手法を使用します。これは、生成されたアセンブリコードを局所的に見て、より効率的な命令シーケンスに置き換える最適化です。この最適化のデバッグ時には、最適化前後の命令列などを表示して、最適化が正しく適用されているか、あるいは予期せぬ副作用がないかを確認します。

元のコードでは、デバッグ出力のためにprint関数が使用されており、その中で%nilというフォーマット指定子が使われていました。しかし、これは命令（Prog構造体）を適切に表示するためのものではなく、結果として意味不明な出力や、デバッグ情報の欠落を引き起こしていました。この問題はGoのIssue #7294として報告されていました。

前提知識の解説

  • Goコンパイラ (cmd/5g): Go言語のソースコードを機械語に変換するプログラムの一部です。5gはARMアーv5アーキテクチャ向けのコンパイラを指します。Goのツールチェインでは、各アーキテクチャ（例: 8g for amd64, 6g for 386, 5g for arm）ごとにコンパイラが存在していました（現在は統合されていますが、当時のコードベースではこのように分かれていました）。
  • Peephole最適化: コンパイラ最適化の一種で、生成されたアセンブリコードの小さな「窓（peephole）」を覗き込み、非効率な命令シーケンスをより効率的なものに置き換える手法です。例えば、「レジスタに値をロードし、その直後に同じレジスタから値をストアする」といった冗長な命令列を、「直接メモリからメモリへコピーする」といった単一の命令に置き換えるなどが挙げられます。
  • peep.c: cmd/5gコンパイラ内のソースファイルの一つで、peephole最適化のロジックが実装されています。
  • Prog構造体: Goコンパイラの内部表現で、アセンブリ命令を表す構造体です。各Progインスタンスは、命令の種類（例: MOV, ADD）、オペランド（レジスタ、メモリ位置、定数など）といった情報を含みます。
  • print関数とフォーマット指定子: C言語のprintfに似た、コンパイラ内部で使用されるデバッグ用の出力関数です。特定のフォーマット指定子（例: %d for 整数, %s for 文字列）を使って、変数の値を整形して出力します。Goコンパイラの内部では、アセンブリ命令（Prog）を人間が読める形式で出力するための特別なフォーマット指定子が存在します。
    • %nil: 通常、ポインタがNULLであるかどうかのチェックや、特定の内部状態を示すために使われることがあります。命令のデバッグ出力には不適切です。
    • %A: Goコンパイラの内部で定義された、Prog構造体（アセンブリ命令）を人間が読める形式で整形して出力するためのカスタムフォーマット指定子です。これにより、命令の種類、オペランドなどが適切に表示されます。
  • Issue #7294: GoプロジェクトのIssueトラッカーで報告されたバグです。このコミットが修正対象としている具体的な問題を示します。

技術的詳細

このコミットの技術的な核心は、Goコンパイラのデバッグ出力メカニズムにおけるフォーマット指定子の誤用です。

Goコンパイラのバックエンド（この場合はcmd/5g）は、コード生成の過程で多くの中間表現を扱います。Prog構造体はその一つで、最終的なアセンブリ命令に近い形式を表します。コンパイラの開発やデバッグにおいては、これらのProgインスタンスがどのように生成され、最適化によってどのように変化するかを追跡することが非常に重要です。

peep.cファイル内のgotitラベルの直後とcopyu関数のdefaultケースでは、デバッグフラグdebug['P']が設定されている場合に、現在のProgインスタンスp->asの情報を出力しようとしていました。

元のコードでは、print(" => %nil\\n", p->as); および print("copyu: can't find %nil\\n", p->as); のように、%nilというフォーマット指定子を使用していました。しかし、%nilはProg構造体を人間が読めるアセンブリ命令の形式で出力するようには設計されていません。その結果、デバッグ出力は期待通りの命令情報を提供せず、デバッグ作業を困難にしていました。

このコミットは、この誤ったフォーマット指定子を%Aに修正しています。%AはGoコンパイラの内部で、Prog構造体（アセンブリ命令）をそのニーモニック、オペランドなどを含む標準的なアセンブリ形式で表示するために特別に実装されたフォーマット指定子です。この変更により、peephole最適化のデバッグ出力が正確かつ有用な情報を提供するようになり、コンパイラの開発者が最適化の挙動をより効果的に分析できるようになりました。

これは、コンパイラのデバッグ機能の正確性を向上させるための、小さくも重要な修正です。デバッグ出力の品質は、複雑なソフトウェア、特にコンパイラのようなシステムにおける問題特定と解決の効率に直接影響します。

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

src/cmd/5g/peep.c ファイルの以下の2箇所が変更されています。

--- a/src/cmd/5g/peep.c
+++ b/src/cmd/5g/peep.c
@@ -545,7 +545,7 @@ gotit:
 		break;
 	}
 	if(debug['P'])
-		print(" => %nil\\n", p->as);
+		print(" => %A\\n", p->as);
 	return 1;
 }
 
@@ -936,7 +936,7 @@ copyu(Prog *p, Adr *v, Adr *s)
 	switch(p->as) {
 
 	default:
-		print("copyu: can't find %nil\\n", p->as);
+		print("copyu: can't find %A\\n", p->as);
 		return 2;
 
 	case AMOVM:

コアとなるコードの解説

変更は非常にシンプルで、print関数の第1引数であるフォーマット文字列内のフォーマット指定子を%nilから%Aに変更しています。

  1. 1つ目の変更箇所 (gotitラベル付近):

    if(debug['P'])
-		print(" => %nil\\n", p->as);
+		print(" => %A\\n", p->as);

    この部分は、peephole最適化が適用された後、デバッグフラグ'P'が有効な場合に、最適化後の命令p->asを出力するためのものです。%nilから%Aへの変更により、最適化後の命令が正しくアセンブリ形式で表示されるようになります。これにより、開発者は最適化がどのように命令を変更したかを視覚的に確認できます。

  2. 2つ目の変更箇所 (copyu関数内):

    default:
-		print("copyu: can't find %nil\\n", p->as);
+		print("copyu: can't find %A\\n", p->as);
		return 2;

    copyu関数は、命令のコピーに関連する処理を行っていると推測されます。switch(p->as)のdefaultケースは、予期しない命令タイプに遭遇した場合のエラーハンドリングまたはデバッグ出力です。ここでも%nilから%Aへの変更が行われており、どの命令タイプが見つからなかったのかを正確に表示できるようになります。これにより、コンパイラのバグや予期せぬ命令シーケンスの特定が容易になります。

これらの変更は、Goコンパイラのデバッグ出力の品質を向上させ、コンパイラ開発者が内部の挙動をより深く理解し、問題を効率的に解決するための重要な改善です。

関連リンク

参考にした情報源リンク