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

このコミットは、Goコンパイラ（cmd/gc）の字句解析器の一部である src/cmd/gc/lex.c ファイルに対する変更です。lex.c は、Goソースコードをトークンに分割する役割を担う、コンパイルプロセスの初期段階を処理するC言語のソースファイルです。

コミット

このコミットは、Goコンパイラ (cmd/gc) 内のエラーメッセージ処理を改善することを目的としています。具体的には、src/cmd/gc/lex.c ファイルにおいて、特定の致命的なエラー発生時に fatal 関数ではなく sysfatal 関数を使用するように変更することで、エラーメッセージ内の %L フォーマット指定子に関連する問題を回避します。これにより、コンパイラの堅牢性が向上し、初期化が不完全な状態でのエラー報告時のクラッシュを防ぎます。

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

https://github.com/golang/go/commit/943dc2cb8d1a2b56a7e61b2d49b519161efe0dbf

元コミット内容

cmd/gc: avoid %L in error message

Fixes #7783

LGTM=minux.ma
R=rsc, minux.ma
CC=golang-codereviews
https://golang.org/cl/89290043

変更の背景

この変更は、Goコンパイラ (cmd/gc) が特定の条件下で GOARCH 環境変数の値が不正である場合に、エラーメッセージのフォーマット中にクラッシュする可能性があった問題を修正するために行われました。具体的には、エラーメッセージ内でファイル名と行番号を示す %L フォーマット指定子を使用する際に、エラー報告システムが完全に初期化されていない状況で fatal 関数が呼び出されると問題が発生していました。

Goコンパイラは、起動時に GOARCH 環境変数をチェックし、現在のアーキテクチャがコンパイラがサポートするものと一致するかどうかを確認します。もし一致しない場合、コンパイラは致命的なエラーを報告して終了する必要があります。しかし、このエラー報告の段階で、fatal 関数が内部的に %L を使用しようとすると、必要なコンテキストがまだ設定されていないために問題が生じることがありました。

この問題は、Goプロジェクトの内部課題トラッカーで #7783 として追跡されていました。このコミットは、この特定のエラーパスにおける堅牢性を高めることを目的としています。

前提知識の解説

cmd/gc: Go言語の公式コンパイラです。Goソースコードを機械語に変換する主要なツールチェーンの一部です。このコミットが作成された2014年時点では、コンパイラの一部はC言語で書かれていました（特にフロントエンドの一部）。
src/cmd/gc/lex.c: cmd/gc のソースコードの一部であり、字句解析（lexical analysis）を担当するC言語のファイルです。字句解析とは、ソースコードの文字列を、コンパイラが理解できる最小単位である「トークン」（キーワード、識別子、演算子など）の並びに変換するプロセスです。
GOARCH: Goプログラムをビルドするターゲットアーキテクチャ（例: amd64, arm, 386 など）を指定する環境変数です。コンパイラは、この値に基づいて適切なコード生成を行います。
fatal 関数: Goコンパイラ内部で使用されるエラー報告関数の一つです。通常、回復不可能なエラーが発生した場合にプログラムを終了させるために使用されます。しかし、この関数が内部的にどのようにエラーメッセージをフォーマットするかに依存して、特定の初期化段階では問題を引き起こす可能性がありました。
sysfatal 関数: fatal と同様にプログラムを終了させるための関数ですが、より低レベルで、システムレベルの致命的なエラーや、エラー報告システム自体が完全に機能していない可能性のある状況で使用されることを意図しています。sysfatal は、fatal よりも少ない依存関係で動作し、エラーメッセージのフォーマットに関する問題を回避できる場合があります。この文脈では、%L フォーマット指定子に関連する問題を回避するために選択されました。
%L フォーマット指定子: C言語の printf 系関数で、通常は __FILE__ と __LINE__ マクロと組み合わせて、現在のファイル名と行番号を出力するために使用されます。コンパイラのエラーメッセージで、エラーが発生したソースコードの位置を示すためによく利用されます。

技術的詳細

このコミットの技術的な核心は、src/cmd/gc/lex.c 内の特定の場所で fatal 関数の呼び出しを sysfatal 関数に置き換えることです。

変更前のコードでは、GOARCH 環境変数が不正な場合に、以下のような fatal 関数の呼び出しがありました。

fatal("cannot use %cg with GOARCH=%s", thechar, p);

ここで、%cg の g はおそらく %L の誤記か、あるいは内部的な特殊なフォーマット指定子であり、ファイル名と行番号に関連する情報を含んでいた可能性があります。Go CLの議論によると、この %L が問題の原因でした。fatal 関数がこのフォーマット指定子を処理しようとした際に、エラー報告に必要な内部状態がまだ完全に初期化されていないために、コンパイラがクラッシュするという問題が発生していました。

sysfatal 関数は、このような初期化が不完全な状況でも安全に呼び出せるように設計されています。これは、sysfatal が fatal よりも少ない内部依存関係で動作し、エラーメッセージのフォーマットに関してより単純なメカニズムを使用するためです。この変更により、GOARCH のチェックが失敗した場合でも、コンパイラは安定してエラーメッセージを報告し、終了できるようになりました。

この修正は、コンパイラの起動シーケンスにおける初期のエラーチェックの堅牢性を高めるという点で重要です。コンパイラが自身の環境設定に関するエラーを適切に報告できない場合、デバッグが困難になるため、このような低レベルでの安定性は非常に重要です。

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

--- a/src/cmd/gc/lex.c
+++ b/src/cmd/gc/lex.c
@@ -214,7 +214,7 @@ main(int argc, char *argv[])
 	// but not other values.	
 	p = getgoarch();
 	if(strncmp(p, thestring, strlen(thestring)) != 0)
-		fatal("cannot use %cg with GOARCH=%s", thechar, p);
+		sysfatal("cannot use %cg with GOARCH=%s", thechar, p);
 	goarch = p;
 
 	linkarchinit();

コアとなるコードの解説

変更された行は src/cmd/gc/lex.c の main 関数内にあります。

if(strncmp(p, thestring, strlen(thestring)) != 0)

この行は、getgoarch() 関数によって取得された現在の GOARCH の値（p）が、コンパイラが期待するアーキテクチャ文字列（thestring）と一致しないかどうかをチェックしています。strncmp は文字列を比較するC標準ライブラリ関数です。

-		fatal("cannot use %cg with GOARCH=%s", thechar, p);
+		sysfatal("cannot use %cg with GOARCH=%s", thechar, p);

この部分が今回のコミットの核心です。GOARCH が一致しない場合、以前は fatal 関数が呼び出されていました。この fatal 関数が、エラーメッセージのフォーマット中に %L のような指定子を処理しようとした際に、コンパイラの内部状態がまだ完全に初期化されていないために問題が発生していました。

fatal を sysfatal に置き換えることで、この問題を解決しています。sysfatal は、より基本的なエラー報告メカニズムを提供し、エラーメッセージのフォーマットに関する依存関係が少ないため、コンパイラの起動初期段階で発生する可能性のある致命的なエラーに対して、より堅牢な終了処理を提供します。これにより、コンパイラはクラッシュすることなく、適切なエラーメッセージを出力して終了できるようになります。

参考にした情報源リンク

Go CL 89290043 のレビューディスカッション
Go言語の log.Fatal と panic、およびランタイムの致命的なエラーに関する一般的な情報源（Web検索結果）
C言語の printf フォーマット指定子に関する一般的な情報

comemo