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

このコミットは、Goコンパイラ（gc）におけるエラーメッセージの表示方法を改善するものです。具体的には、メソッドのレシーバ型が不正である場合に発生する、根本原因ではない（non-root cause）エラーメッセージの出力を抑制します。これにより、コンパイラのエラー出力がより明確になり、開発者が問題の真の原因を特定しやすくなります。

コミット

commit 6a401339c113769be5339483bf134284292f03bc
Author: Luuk van Dijk <lvd@golang.org>
Date:   Wed Dec 14 08:21:37 2011 +0100

    gc: suppress non-root cause message for bad receivers.
    
    Fixed issue 2500
    
    R=rsc
    CC=golang-dev
    https://golang.org/cl/5485053

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

https://github.com/golang/go/commit/6a401339c113769be5339483bf134284292f03bc

元コミット内容

gc: suppress non-root cause message for bad receivers.

Fixed issue 2500

R=rsc
CC=golang-dev
https://golang.org/cl/5485053

変更の背景

Go言語のコンパイラは、コード内のエラーを検出した際に、そのエラーに関するメッセージを出力します。しかし、場合によっては、一つの根本的なエラーが複数の二次的なエラーを引き起こし、コンパイラがそれらすべてについてメッセージを出力してしまうことがあります。これにより、開発者は大量のエラーメッセージの中から真の根本原因を特定するのに苦労することがありました。

このコミットは、特にメソッドのレシーバ型が不正である場合にこの問題が発生していたことを解決するために導入されました。具体的には、レシーバの型が未定義であるといった根本的な問題がある場合、コンパイラは「型が未定義である」というエラーだけでなく、その未定義の型を使用しようとしたことによって発生する後続の（根本原因ではない）エラーも報告していました。これは、Issue 2500として報告されており、このコミットはその問題を修正することを目的としています。

前提知識の解説

Go言語のメソッドとレシーバ

Go言語において、メソッドは特定の型に関連付けられた関数です。メソッドを定義する際には、そのメソッドがどの型の値に対して操作を行うかを示す「レシーバ」を指定します。レシーバは、関数名の前に括弧で囲んで記述されます。

例:

type MyType struct {
    value int
}

// MyTypeのメソッド
func (m MyType) GetValue() int {
    return m.value
}

// ポインタレシーバの例
func (m *MyType) SetValue(newValue int) {
    m.value = newValue
}

この例では、GetValue メソッドのレシーバは m MyType であり、SetValue メソッドのレシーバは m *MyType です。レシーバの型が不正（例えば、未定義の型を参照している）である場合、コンパイラはエラーを報告します。

Goコンパイラ（gc）

gcは、Go言語の公式コンパイラであり、Goのソースコードを機械語に変換する役割を担っています。gcは、構文解析、型チェック、最適化、コード生成など、コンパイルの様々な段階でエラーを検出します。

根本原因（Root Cause）と非根本原因（Non-Root Cause）のエラー

ソフトウェア開発において、一つのバグや問題が連鎖的に他の問題を引き起こすことがあります。このとき、最初に発生した、他のすべての問題の引き金となった問題を「根本原因」と呼びます。それに対して、根本原因によって引き起こされた二次的な問題を「非根本原因」または「派生エラー」と呼びます。

コンパイラのエラーメッセージにおいては、根本原因のエラーメッセージは問題の核心を伝え、非根本原因のエラーメッセージは根本原因によって引き起こされた結果を伝える傾向があります。理想的には、コンパイラは根本原因のエラーメッセージを明確に伝え、非根本原因のメッセージは抑制することで、開発者が効率的にデバッグできるようにすべきです。

技術的詳細

このコミットの技術的な核心は、Goコンパイラの型チェックフェーズとエラー報告メカニズムの連携にあります。

Goコンパイラは、ソースコードを解析する際に、まず各識別子（変数名、型名など）が適切に定義され、使用されているかをチェックします。このプロセス中に、もしメソッドのレシーバとして使用されている型が未定義であると判明した場合、コンパイラはその型に「壊れている」（broke）というフラグを設定します。

変更前のコンパイラでは、addmethod 関数（メソッドの追加処理を行う部分）が、レシーバの型が不正であることによって発生する可能性のある追加のエラーメッセージを無条件に生成していました。例えば、レシーバの型が未定義である場合、その型に関連するシンボルが解決できないため、addmethod 関数内でさらに別のエラー（例: 「r が未定義」）が報告される可能性がありました。

このコミットでは、src/cmd/gc/dcl.c ファイル内の addmethod 関数に以下の行が追加されました。

if(t->broke) // rely on typecheck having complained before
    return;

このコードは、addmethod 関数がレシーバの型 t を処理する前に、その型が既に broke フラグを持っているかどうかをチェックします。

• t->broke が true の場合、それは型チェックのより早い段階で、この型に関する根本的な問題（例: 未定義）が既に検出され、それに関するエラーメッセージが既に出力されていることを意味します。
• この場合、addmethod 関数はそれ以上の処理を行わずに return します。これにより、根本原因のエラーメッセージが既に出力されているにもかかわらず、同じ根本原因に起因する二次的なエラーメッセージが重複して出力されるのを防ぎます。

この変更により、コンパイラは「未定義の型」という根本原因のエラーメッセージのみを出力し、その後の「未定義の型を持つレシーバ r が使用されたことによるエラー」といった派生的なメッセージは抑制されるようになります。

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

src/cmd/gc/dcl.c ファイルの addmethod 関数内に以下のコードが追加されました。

--- a/src/cmd/gc/dcl.c
+++ b/src/cmd/gc/dcl.c
@@ -1273,6 +1273,8 @@ addmethod(Sym *sf, Type *t, int local)
 			t = t->type;
 		}
 	}
+	if(t->broke) // rely on typecheck having complained before
+		return;
 	if(t != T) {
 		if(t->sym == S) {
 			yyerror("invalid receiver type %T (%T is an unnamed type)", pa, t);

また、この変更によって修正されたバグを再現し、修正が正しく機能することを確認するための新しいテストケースが追加されました。

test/fixedbugs/bug384.go (新規ファイル)

// errchk $G $D/$F.go

// Copyright 2011 The Go Authors.  All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// Issue 2500

package foo

// Check that we only get root cause message, no further complaints about r undefined
func (r *indexWriter) foo() {}  // ERROR "undefined.*indexWriter"

コアとなるコードの解説

src/cmd/gc/dcl.c の変更

addmethod 関数は、Go言語のメソッド宣言を処理するコンパイラの内部関数です。この関数は、メソッドのレシーバ型を解析し、その型が有効であるか、そしてメソッドが正しく定義されているかを検証します。

追加された if(t->broke) return; の行は、この関数の実行フローを制御します。

• t は、現在のメソッドのレシーバの型を表すポインタです。
• t->broke は、その型 t が以前の型チェックフェーズで「壊れている」（つまり、何らかの根本的なエラーがある）とマークされているかどうかを示すブール値のフラグです。
• コメント // rely on typecheck having complained before が示すように、このフラグが true であれば、コンパイラは既にこの型に関するエラーメッセージ（例えば、「indexWriter が未定義」）を出力済みであると判断します。
• したがって、return; ステートメントによって、addmethod 関数はそれ以上の処理を中断し、このレシーバ型に関連するさらなるエラーメッセージの生成を防ぎます。これにより、冗長なエラーメッセージが抑制され、出力がクリーンになります。

test/fixedbugs/bug384.go の追加

このテストファイルは、Issue 2500で報告された具体的なバグシナリオを再現するために作成されました。

• // errchk $G $D/$F.go: これはGoのテストフレームワークで使用されるディレクティブで、このファイルがコンパイルされる際にエラーが発生することを期待していることを示します。$G はGoコンパイラ、$D/$F.go は現在のファイルのパスを指します。
• func (r *indexWriter) foo() {}: この行がテストの核心です。indexWriter という型は、このファイル内でも、Goの標準ライブラリ内でも定義されていません。したがって、これは未定義の型をメソッドのレシーバとして使用しようとする不正なコードです。
• // ERROR "undefined.*indexWriter": このコメントは、コンパイラがこの行に対して「indexWriter が未定義である」というエラーメッセージを出力することを期待していることを示します。

このテストの目的は、変更前には「indexWriter が未定義」というエラーに加えて、r が未定義の型を持つことによる別のエラーメッセージも出力されていた状況を再現し、変更後には「indexWriter が未定義」という根本原因のエラーメッセージのみが出力され、他の冗長なメッセージが抑制されることを検証することです。

関連リンク

• Go言語のメソッドに関する公式ドキュメント: https://go.dev/tour/methods/1
• Go言語のコンパイラ（gc）のソースコード: https://github.com/golang/go/tree/master/src/cmd/compile

参考にした情報源リンク

• Go Issue 2500: https://github.com/golang/go/issues/2500 (このコミットが修正したバグの元の報告)
• Go Code Review 5485053: https://golang.org/cl/5485053 (このコミットのコードレビューページ)
• Go言語のソースコード: https://github.com/golang/go
• Go言語のツアー: https://go.dev/tour/
• Go言語の仕様: https://go.dev/ref/spec
• Go言語のコンパイラに関する一般的な情報源 (例: "Go compiler internals", "Go type checking")

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

このコミットは、Goコンパイラ（gc）におけるエラーメッセージの表示方法を改善するものです。具体的には、メソッドのレシーバ型が不正である場合に発生する、根本原因ではない（non-root cause）エラーメッセージの出力を抑制します。これにより、コンパイラのエラー出力がより明確になり、開発者が問題の真の原因を特定しやすくなります。

コミット

commit 6a401339c113769be5339483bf134284292f03bc
Author: Luuk van Dijk <lvd@golang.org>
Date:   Wed Dec 14 08:21:37 2011 +0100

    gc: suppress non-root cause message for bad receivers.
    
    Fixed issue 2500
    
    R=rsc
    CC=golang-dev
    https://golang.org/cl/5485053

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

https://github.com/golang/go/commit/6a401339c113769be5339483bf134284292f03bc

元コミット内容

gc: suppress non-root cause message for bad receivers.

Fixed issue 2500

R=rsc
CC=golang-dev
https://golang.org/cl/5485053

変更の背景

Go言語のコンパイラは、コード内のエラーを検出した際に、そのエラーに関するメッセージを出力します。しかし、場合によっては、一つの根本的なエラーが複数の二次的なエラーを引き起こし、コンパイラがそれらすべてについてメッセージを出力してしまうことがあります。これにより、開発者は大量のエラーメッセージの中から真の根本原因を特定するのに苦労することがありました。

このコミットは、特にメソッドのレシーバ型が不正である場合にこの問題が発生していたことを解決するために導入されました。具体的には、レシーバの型が未定義であるといった根本的な問題がある場合、コンパイラは「型が未定義である」というエラーだけでなく、その未定義の型を使用しようとしたことによって発生する後続の（根本原因ではない）エラーも報告していました。これは、Issue 2500として報告されており、このコミットはその問題を修正することを目的としています。

前提知識の解説

Go言語のメソッドとレシーバ

Go言語において、メソッドは特定の型に関連付けられた関数です。メソッドを定義する際には、そのメソッドがどの型の値に対して操作を行うかを示す「レシーバ」を指定します。レシーバは、関数名の前に括弧で囲んで記述されます。

例:

type MyType struct {
    value int
}

// MyTypeのメソッド
func (m MyType) GetValue() int {
    return m.value
}

// ポインタレシーバの例
func (m *MyType) SetValue(newValue int) {
    m.value = newValue
}

この例では、GetValue メソッドのレシーバは m MyType であり、SetValue メソッドのレシーバは m *MyType です。レシーバの型が不正（例えば、未定義の型を参照している）である場合、コンパイラはエラーを報告します。

Goコンパイラ（gc）

gcは、Go言語の公式コンパイラであり、Goのソースコードを機械語に変換する役割を担っています。gcは、構文解析、型チェック、最適化、コード生成など、コンパイルの様々な段階でエラーを検出します。

根本原因（Root Cause）と非根本原因（Non-Root Cause）のエラー

ソフトウェア開発において、一つのバグや問題が連鎖的に他の問題を引き起こすことがあります。このとき、最初に発生した、他のすべての問題の引き金となった問題を「根本原因」と呼びます。それに対して、根本原因によって引き起こされた二次的な問題を「非根本原因」または「派生エラー」と呼びます。

コンパイラのエラーメッセージにおいては、根本原因のエラーメッセージは問題の核心を伝え、非根本原因のエラーメッセージは根本原因によって引き起こされた結果を伝える傾向があります。理想的には、コンパイラは根本原因のエラーメッセージを明確に伝え、非根本原因のメッセージは抑制することで、開発者が効率的にデバッグできるようにすべきです。

技術的詳細

このコミットの技術的な核心は、Goコンパイラの型チェックフェーズとエラー報告メカニズムの連携にあります。

Goコンパイラは、ソースコードを解析する際に、まず各識別子（変数名、型名など）が適切に定義され、使用されているかをチェックします。このプロセス中に、もしメソッドのレシーバとして使用されている型が未定義であると判明した場合、コンパイラはその型に「壊れている」（broke）というフラグを設定します。

変更前のコンパイラでは、addmethod 関数（メソッドの追加処理を行う部分）が、レシーバの型が不正であることによって発生する可能性のある追加のエラーメッセージを無条件に生成していました。例えば、レシーバの型が未定義である場合、その型に関連するシンボルが解決できないため、addmethod 関数内でさらに別のエラー（例: 「r が未定義」）が報告される可能性がありました。

このコミットでは、src/cmd/gc/dcl.c ファイル内の addmethod 関数に以下の行が追加されました。

if(t->broke) // rely on typecheck having complained before
    return;

このコードは、addmethod 関数がレシーバの型 t を処理する前に、その型が既に broke フラグを持っているかどうかをチェックします。

• t->broke が true の場合、それは型チェックのより早い段階で、この型に関する根本的な問題（例: 未定義）が既に検出され、それに関するエラーメッセージが既に出力されていることを意味します。
• この場合、addmethod 関数はそれ以上の処理を行わずに return します。これにより、根本原因のエラーメッセージが既に出力されているにもかかわらず、同じ根本原因に起因する二次的なエラーメッセージが重複して出力されるのを防ぎます。

この変更により、コンパイラは「未定義の型」という根本原因のエラーメッセージのみを出力し、その後の「未定義の型を持つレシーバ r が使用されたことによるエラー」といった派生的なメッセージは抑制されるようになります。

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

src/cmd/gc/dcl.c ファイルの addmethod 関数内に以下のコードが追加されました。

--- a/src/cmd/gc/dcl.c
+++ b/src/cmd/gc/dcl.c
@@ -1273,6 +1273,8 @@ addmethod(Sym *sf, Type *t, int local)
 			t = t->type;
 		}
 	}
+	if(t->broke) // rely on typecheck having complained before
+		return;
 	if(t != T) {
 		if(t->sym == S) {
 			yyerror("invalid receiver type %T (%T is an unnamed type)", pa, t);

また、この変更によって修正されたバグを再現し、修正が正しく機能することを確認するための新しいテストケースが追加されました。

test/fixedbugs/bug384.go (新規ファイル)

// errchk $G $D/$F.go

// Copyright 2011 The Go Authors.  All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// Issue 2500

package foo

// Check that we only get root cause message, no further complaints about r undefined
func (r *indexWriter) foo() {}  // ERROR "undefined.*indexWriter"

コアとなるコードの解説

src/cmd/gc/dcl.c の変更

addmethod 関数は、Go言語のメソッド宣言を処理するコンパイラの内部関数です。この関数は、メソッドのレシーバ型を解析し、その型が有効であるか、そしてメソッドが正しく定義されているかを検証します。

追加された if(t->broke) return; の行は、この関数の実行フローを制御します。

• t は、現在のメソッドのレシーバの型を表すポインタです。
• t->broke は、その型 t が以前の型チェックフェーズで「壊れている」（つまり、何らかの根本的なエラーがある）とマークされているかどうかを示すブール値のフラグです。
• コメント // rely on typecheck having complained before が示すように、このフラグが true であれば、コンパイラは既にこの型に関するエラーメッセージ（例えば、「indexWriter が未定義」）を出力済みであると判断します。
• したがって、return; ステートメントによって、addmethod 関数はそれ以上の処理を中断し、このレシーバ型に関連するさらなるエラーメッセージの生成を防ぎます。これにより、冗長なエラーメッセージが抑制され、出力がクリーンになります。

test/fixedbugs/bug384.go の追加

このテストファイルは、Issue 2500で報告された具体的なバグシナリオを再現するために作成されました。

• // errchk $G $D/$F.go: これはGoのテストフレームワークで使用されるディレクティブで、このファイルがコンパイルされる際にエラーが発生することを期待していることを示します。$G はGoコンパイラ、$D/$F.go は現在のファイルのパスを指します。
• func (r *indexWriter) foo() {}: この行がテストの核心です。indexWriter という型は、このファイル内でも、Goの標準ライブラリ内でも定義されていません。したがって、これは未定義の型をメソッドのレシーバとして使用しようとする不正なコードです。
• // ERROR "undefined.*indexWriter": このコメントは、コンパイラがこの行に対して「indexWriter が未定義である」というエラーメッセージを出力することを期待していることを示します。

このテストの目的は、変更前には「indexWriter が未定義」というエラーに加えて、r が未定義の型を持つことによる別のエラーメッセージも出力されていた状況を再現し、変更後には「indexWriter が未定義」という根本原因のエラーメッセージのみが出力され、他の冗長なメッセージが抑制されることを検証することです。

関連リンク

• Go言語のメソッドに関する公式ドキュメント: https://go.dev/tour/methods/1
• Go言語のコンパイラ（gc）のソースコード: https://github.com/golang/go/tree/master/src/cmd/compile

参考にした情報源リンク

• Go Issue 2500 (Goの内部バグトラッカーまたは関連する報告): https://golang.org/cl/5485053 (このコミットのコードレビューページに記載されているCL番号から推測される、関連するGoの変更リスト)
• Go言語のソースコード: https://github.com/golang/go
• Go言語のツアー: https://go.dev/tour/
• Go言語の仕様: https://go.dev/ref/spec