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

このコミットは、Goコンパイラ（cmd/gc）におけるエラー報告の改善を目的としています。具体的には、配列のインデックスが不正である場合に、既に別のエラーが報告されているにもかかわらず、その不正なインデックスが原因でさらに別のエラーが重複して報告される問題を抑制します。これにより、コンパイラのエラー出力がより簡潔になり、開発者がコードの問題を特定しやすくなります。

コミット

commit 2ca99505f6cfc1390b5b69eecb35e46d0e36456d
Author: Jan Ziak <0xe2.0x9a.0x9b@gmail.com>
Date:   Sat Mar 29 15:45:40 2014 +0100

    cmd/gc: suppress array index error caused by a previously reported error
    
    Fixes #7153
    
    LGTM=rsc
    R=rsc
    CC=golang-codereviews
    https://golang.org/cl/82180043

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

https://github.com/golang/go/commit/2ca99505f6cfc1390b5b69eecb35e46d0e36456d

元コミット内容

cmd/gc: suppress array index error caused by a previously reported error

Fixes #7153

LGTM=rsc
R=rsc
CC=golang-codereviews
https://golang.org/cl/82180043

Goコンパイラ（cmd/gc）は、ソースコードの構文や意味に誤りがある場合にエラーメッセージを出力し、開発者に問題箇所を通知します。しかし、特定のシナリオ、特に複合リテラル（例: []int{...} や map[int]int{...}）内で配列のインデックスが不正である場合、既にそのインデックス式自体が別の理由でエラー状態（例えば、未定義の変数を使用しているなど）になっているにもかかわらず、その不正なインデックス値が原因で「array index must be non-negative integer constant」（配列インデックスは非負の整数定数でなければなりません）というエラーが重複して報告される問題がありました。

この重複したエラー報告は、開発者にとって混乱を招き、真の原因となるエラーを見つけにくくする可能性がありました。Issue #7153（具体的な内容は現在参照できませんが、このコミットが修正対象としています）は、このような冗長なエラーメッセージの報告を改善し、コンパイラのエラー出力をより明確で有用なものにすることを目的としていたと考えられます。コンパイラのエラー報告の品質は、開発体験に直結するため、このような改善はGo言語の使いやすさを向上させる上で重要です。

前提知識の解説

Goコンパイラ (`cmd/gc`)

cmd/gc は、Go言語の初期の公式コンパイラの一部であり、Goソースコードを機械語に変換する役割を担っていました。現在では、より新しいコンパイラである cmd/compile に統合されていますが、基本的なコンパイルフェーズ（字句解析、構文解析、型チェック、最適化、コード生成など）の概念は共通しています。このコミットは、当時の cmd/gc の型チェック部分に焦点を当てています。

型チェック (Type Checking)

型チェックは、コンパイルプロセスの重要なフェーズの一つです。この段階で、コンパイラはプログラムのソースコードがGo言語の型システム規則に準拠しているかを確認します。例えば、変数の型と代入される値の型が一致しているか、関数の引数の型が正しいか、演算子のオペランドの型が適切かなどを検証します。型エラーは、プログラムが実行される前に検出されるべき論理的な誤りを示し、早期に問題を特定することで開発効率を高めます。

配列のインデックス

Go言語において、配列やスライス内の特定の要素にアクセスするには、インデックス（添字）を使用します。インデックスは0から始まり、配列の長さ-1までの範囲でなければなりません。また、コンパイル時にインデックスが定数として評価される場合、その値は非負の整数である必要があります。このコミットでは、特にこの「非負の整数定数」であるべきインデックスが負の値として評価された場合のエラー報告が問題となっています。

コンパイラのエラー報告メカニズム

コンパイラは、ソースコードに問題を発見すると、エラーメッセージを標準エラー出力などに出力します。理想的なエラーメッセージは、問題の正確な場所（ファイル名、行番号、列番号）と、その問題の具体的な原因を明確に伝えるべきです。重複したエラーや誤解を招くエラーは、開発者が問題をデバッグする際の妨げとなります。コンパイラの内部では、抽象構文木（AST）の各ノードに、既にエラーが報告されたかどうかを示すフラグ（例: diag フラグ）を持つことがあります。これにより、同じASTノードに関連する複数のエラーメッセージが生成されるのを防ぎ、エラー報告の冗長性を減らすことができます。

技術的詳細

このコミットの変更は、Goコンパイラの型チェックロジックが記述されている src/cmd/gc/typecheck.c ファイル内の typecheckcomplit 関数に集中しています。

`src/cmd/gc/typecheck.c` の役割

src/cmd/gc/typecheck.c は、Goコンパイラのフロントエンドの一部であり、Goプログラムの型チェックを行う主要なC言語ソースファイルです。このファイルには、変数、式、関数呼び出し、複合リテラルなど、様々なGo言語の構造の型を検証するためのロジックが含まれています。

`typecheckcomplit(Node **np)` 関数

typecheckcomplit 関数は、Go言語の複合リテラル（例: []int{1, 2, 3} や map[string]int{"a": 1}）の型チェックを担当します。この関数内で、配列やマップの要素のキー（インデックス）部分の型と値が適切であるかどうかが検証されます。

`nonnegconst` と `yyerror` の役割

nonnegconst(l->left): l->left は複合リテラルの要素のキー部分を表す抽象構文木（AST）ノードです。この関数は、そのノードが表す定数値が非負であるかを評価し、その値を返します。もし値が負であれば、負の値を返します。
yyerror(...): これは、Goコンパイラがエラーメッセージを生成し、ユーザーに報告するために使用する内部関数です。

問題の特定と修正のアプローチ

以前のコードでは、typecheckcomplit 関数内で配列インデックスの定数値 i が負であるかをチェックしていました。もし i < 0 であれば、無条件に「array index must be non-negative integer constant」というエラーメッセージを yyerror を使って出力していました。

しかし、問題は、l->left（インデックスのASTノード）が既に別の型チェックエラー（例えば、インデックスとして使用されている変数が未定義であるなど）によって不正な状態になっている場合でも、このチェックが実行され、i が負の値として評価されることがあった点です。この場合、既に l->left に関連するエラーが報告されているにもかかわらず、さらに「array index must be non-negative integer constant」という重複したエラーが報告されていました。

このコミットでは、l->left->diag というフラグを導入することでこの問題を解決しています。diag フラグは、特定のASTノードが既にエラーを報告済みであることを示すために使用されます。

修正されたロジックでは、i < 0 の条件に加えて !l->left->diag という条件が追加されました。これにより、l->left ノードがまだエラーを報告していない場合にのみ、「array index must be non-negative integer constant」エラーが報告されるようになります。さらに、このエラーが報告された際には l->left->diag = 1; を設定し、将来的にこのノードが原因で発生する可能性のある重複エラーを抑制します。

この変更により、コンパイラはよりスマートにエラーを報告し、開発者は真の原因となるエラーに集中できるようになります。

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

--- a/src/cmd/gc/typecheck.c
+++ b/src/cmd/gc/typecheck.c
@@ -2525,8 +2525,9 @@ typecheckcomplit(Node **np)
 			typecheck(&l->left, Erv);
 			evconst(l->left);
 			i = nonnegconst(l->left);
-			if(i < 0) {
+			if(i < 0 && !l->left->diag) {
 				yyerror("array index must be non-negative integer constant");
+				l->left->diag = 1;
 				i = -(1<<30);	// stay negative for a while
 			}
 			if(i >= 0)

コアとなるコードの解説

上記の差分は、src/cmd/gc/typecheck.c 内の typecheckcomplit 関数における配列インデックスのチェック部分を示しています。

変更前:
```
if(i < 0) {
    yyerror("array index must be non-negative integer constant");
    i = -(1<<30);    // stay negative for a while
}
```
このコードは、i（配列インデックスとして評価された定数値）が負の場合に、無条件で「array index must be non-negative integer constant」というエラーメッセージを出力していました。
変更後:
```
if(i < 0 && !l->left->diag) {
    yyerror("array index must be non-negative integer constant");
    l->left->diag = 1;
    i = -(1<<30);    // stay negative for a while
}
```
- if(i < 0 && !l->left->diag): ここが主要な変更点です。i が負であるという条件に加えて、!l->left->diag という新しい条件が追加されました。
  - l->left は、複合リテラルのキー（この場合は配列インデックス）を表す抽象構文木（AST）ノードです。
  - l->left->diag は、この l->left ノードが既に何らかのエラーを報告済みである場合に 1 に設定される内部フラグです。
  - したがって、!l->left->diag は「l->left ノードがまだエラーを報告していない」ことを意味します。
- この変更により、l->left が既に別のエラー（例えば、インデックスとして使用されている変数が未定義であるなど）によって不正な状態になっている場合、l->left->diag が 1 に設定されているため、i < 0 であってもこの特定の「array index must be non-negative integer constant」エラーは報告されなくなります。
- l->left->diag = 1;: エラーが報告された際に、l->left->diag フラグを 1 に設定する行が追加されました。これにより、同じノードに関連する将来の重複エラー報告が抑制されます。

この修正によって、コンパイラはより洗練されたエラー報告を行うようになり、開発者は冗長なエラーメッセージに惑わされることなく、コードの根本的な問題に集中できるようになりました。

参考にした情報源リンク

Go言語の公式ドキュメント
Goコンパイラのソースコード (src/cmd/gc ディレクトリ)
Go言語のIssueトラッカー (過去のIssueの検索試行)
Go言語のChange List (CL) システムに関する一般的な情報
Go言語におけるエラーハンドリングに関する一般的な情報 (Web検索結果より)

comemo