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

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

このコミットは、Go言語のテストスイートにおいて、gccgoコンパイラが出力するエラーメッセージを正しく認識できるようにするための修正です。具体的には、関数へのアドレス取得や関数への代入といった不正な操作に対するエラーメッセージのパターンに、gccgoが生成する可能性のある「invalid」というキーワードを追加しています。

コミット

  • コミットハッシュ: 1103d78c84d9654035c2b43aeb01cd5a71c539de
  • 作者: Ian Lance Taylor iant@golang.org
  • コミット日時: 2009年2月6日(金)15:57:02 -0800
  • コミットメッセージ:
    Recognize gccgo error messages:
    
    func4.go:8:11: error: invalid operand for unary '&'
    func4.go:9:8: error: invalid left hand side of assignment
    
    R=rsc
    DELTA=2  (0 added, 0 deleted, 2 changed)
    OCL=24294
    CL=24603
    

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

https://github.com/golang/go/commit/1103d78c84d9654035c2b43aeb01cd5a71c539de

元コミット内容

このコミットの目的は、gccgoコンパイラが生成する特定のエラーメッセージを、Go言語のテストフレームワークが正しく認識できるようにすることです。具体的には、func4.goというテストファイル内で意図的に発生させているエラー(関数のアドレス取得と関数への代入)に対して、gccgoが標準のGoコンパイラ(gc)とは異なるエラーメッセージを出力する場合があるため、その差異を吸収するための変更です。

コミットメッセージには、gccgoが出力するエラーメッセージの例が示されています。

  • func4.go:8:11: error: invalid operand for unary '&'
  • func4.go:9:8: error: invalid left hand side of assignment

これらのメッセージは、Go言語の仕様に違反するコードに対してgccgoが報告するエラーの形式を示しており、既存のテストがこれらのメッセージを「期待されるエラー」として認識できるように修正が必要でした。

変更の背景

Go言語には、主に2つの主要なコンパイラ実装が存在します。一つは公式のGoコンパイラであるgc(Go Compiler)で、もう一つはGCC(GNU Compiler Collection)をベースにしたgccgoです。これら2つのコンパイラは、Go言語の仕様に準拠していても、エラーメッセージの文言や形式が微妙に異なる場合があります。

Goのテストスイートでは、特定のコードが特定のエラーを発生させることを期待するテストケースが多数存在します。これらのテストは、コンパイラが正しくエラーを検出しているかを確認するために重要です。しかし、gccgogcとは異なるエラーメッセージを出力する場合、既存のテストがそのエラーを認識できず、テストが失敗する(または意図しない成功となる)可能性があります。

このコミットは、gccgoが「invalid operand for unary '&'」や「invalid left hand side of assignment」といった形式のエラーメッセージを出力するようになったことを受け、テストスイートがこれらのメッセージも正しく「期待されるエラー」として扱えるようにするために行われました。これにより、gccgo環境でもGoのテストスイートが安定して動作し、コンパイラの互換性と正確性が保証されます。

前提知識の解説

Go言語の関数とアドレス、代入

Go言語において、関数は第一級オブジェクト(first-class citizen)です。これは、関数を変数に代入したり、関数の引数として渡したり、関数の戻り値として返したりできることを意味します。しかし、Go言語の仕様では、いくつかの制限があります。

  1. 関数のアドレス取得: Go言語では、関数のアドレスを直接取得する操作(例: &main)は許可されていません。これは、C言語のようなポインタ演算を伴う低レベルな操作をGoでは推奨しないためです。関数はそれ自体が値として扱われ、そのアドレスを明示的に取得する必要がない設計になっています。
  2. 関数への代入: 関数名自体は、その関数を指す識別子であり、変数ではありません。したがって、別の関数を関数名に直接代入する操作(例: main = notmain)も許可されていません。関数を変数に代入したい場合は、その関数と同じシグネチャを持つ関数型を定義し、その型の変数に関数を代入する必要があります。

これらの操作はGo言語の文法上不正であり、コンパイラはエラーを報告する必要があります。

gccgoコンパイラ

gccgoは、GCCのフロントエンドとして実装されたGo言語のコンパイラです。GCCの強力な最適化バックエンドを利用できるため、生成されるバイナリのパフォーマンスが向上する可能性があります。また、GCCがサポートする多様なアーキテクチャに対応できるという利点もあります。

gccgoはGo言語の仕様に準拠していますが、エラーメッセージの生成ロジックはgcとは独立して実装されているため、同じGoコードに対して異なる文言のエラーメッセージを出力することがあります。これは、コンパイラの実装詳細の違いによるもので、言語仕様の解釈が異なるわけではありません。

Goのテストフレームワークとエラーメッセージの正規表現マッチング

Go言語の標準テストフレームワーク(testingパッケージ)は、Goプログラムのテストを記述するための機能を提供します。このフレームワークでは、特定のテストケースがエラーを発生させることを期待する場合、そのエラーメッセージが特定のパターンにマッチするかどうかを検証するメカニズムが利用されます。

Goのテストファイルでは、// ERROR "pattern"というコメント構文が使われることがあります。これは、その行またはその周辺のコードが、指定されたpatternにマッチするエラーメッセージをコンパイラから出力することを期待していることを示します。このpatternは正規表現として解釈され、コンパイラが出力するエラーメッセージがこの正規表現にマッチすれば、テストは成功とみなされます。

このコミットでは、既存の正規表現パターンに|invalidを追加することで、gcgccgoの両方のコンパイラが出力するエラーメッセージに対応できるようにしています。|は正規表現のOR演算子であり、「"address of function" または "invalid"」のいずれかにマッチすればよい、という意味になります。

技術的詳細

このコミットの技術的詳細の核心は、Go言語のテストスイートがコンパイラのエラーメッセージを検証する際に使用する正規表現の柔軟性を高める点にあります。

Goのテストフレームワークでは、コンパイラが特定のコードに対してエラーを報告することを期待するテストケースにおいて、// ERROR "expected_error_message_pattern"という形式のコメントを使用します。このexpected_error_message_patternは、コンパイラが出力するエラーメッセージと照合される正規表現です。

元のtest/func4.goファイルでは、以下のエラーパターンが期待されていました。

  • // ERROR "address of function"
  • // ERROR "assign to function"

これは、標準のGoコンパイラ(gc)がこれらの不正な操作に対して「address of function」や「assign to function」というエラーメッセージを出力することを想定していました。

しかし、gccgoコンパイラは、これらの同じ不正な操作に対して、より一般的な「invalid operand for unary '&'」や「invalid left hand side of assignment」といったメッセージを出力することが判明しました。これらのメッセージは、元の正規表現パターンにはマッチしません。その結果、gccgoでテストを実行すると、これらのテストケースが期待通りにエラーを検出できない、あるいはテストが失敗する可能性がありました。

このコミットでは、正規表現のOR演算子(|)を使用して、両方のコンパイラが出力する可能性のあるメッセージをカバーするようにパターンを拡張しました。

  • // ERROR "address of function|invalid"
  • // ERROR "assign to function|invalid"

この変更により、テストフレームワークは、コンパイラが出力するエラーメッセージが「address of function」または「invalid」のいずれかを含んでいれば、そのテストケースを成功とみなすようになります。同様に、2番目のエラーについても「assign to function」または「invalid」のいずれかを含んでいれば成功とみなされます。

このアプローチは、コンパイラの実装詳細に起因するエラーメッセージの差異を吸収し、テストスイートの堅牢性と移植性を高めるための一般的な手法です。これにより、異なるGoコンパイラ実装間での互換性を維持しつつ、テストの正確性を保証することができます。

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

変更はtest/func4.goファイルにのみ行われています。

--- a/test/func4.go
+++ b/test/func4.go
@@ -9,6 +9,6 @@ package main
 var notmain func()\n \n func main() {\n-\tvar x = &main;\t\t// ERROR \"address of function\"\n-\tmain = notmain;\t// ERROR \"assign to function\"\n+\tvar x = &main;\t\t// ERROR \"address of function|invalid\"\n+\tmain = notmain;\t// ERROR \"assign to function|invalid\"\
 }\n

具体的には、以下の2行が変更されています。

  1. var x = &main; // ERROR "address of function"var x = &main; // ERROR "address of function|invalid"

  2. main = notmain; // ERROR "assign to function"main = notmain; // ERROR "assign to function|invalid"

コアとなるコードの解説

test/func4.goは、Go言語のコンパイラが特定の不正な操作に対して正しくエラーを報告するかどうかを検証するためのテストファイルです。

package main

var notmain func()

func main() {
	var x = &main;		// ERROR "address of function|invalid"
	main = notmain;	// ERROR "assign to function|invalid"
}

このファイルには、main関数内で意図的にGo言語の仕様に違反する2つの操作が含まれています。

  1. var x = &main; これは、main関数のアドレスを取得しようとする試みです。Go言語では関数のアドレスを直接取得することは許可されていないため、コンパイラはここでエラーを報告する必要があります。

  2. main = notmain; これは、main関数に別の関数notmainを代入しようとする試みです。関数名自体は変数ではないため、このような代入は許可されておらず、コンパイラはエラーを報告する必要があります。

各行の末尾にある// ERROR "..."コメントは、Goのテストフレームワークが使用する特別な指示です。このコメントは、その行のコンパイル時に、引用符で囲まれた正規表現にマッチするエラーメッセージがコンパイラから出力されることを期待していることを示します。

変更前は、正規表現が"address of function""assign to function"でした。これは、標準のGoコンパイラ(gc)がこれらのエラーに対して出力するメッセージに直接マッチするように設計されていました。

しかし、gccgoコンパイラは、これらのエラーに対して「invalid operand for unary '&'」や「invalid left hand side of assignment」といった、より一般的な「invalid」というキーワードを含むメッセージを出力することがあります。

今回の変更では、正規表現に|invalidを追加することで、この差異に対応しています。

  • // ERROR "address of function|invalid": この正規表現は、コンパイラのエラーメッセージが「address of function」という文字列を含むか、または「invalid」という文字列を含む場合にマッチします。
  • // ERROR "assign to function|invalid": 同様に、この正規表現は、エラーメッセージが「assign to function」という文字列を含むか、または「invalid」という文字列を含む場合にマッチします。

この修正により、gcgccgoの両方のコンパイラが生成するエラーメッセージをテストスイートが正しく認識できるようになり、Go言語の異なるコンパイラ実装間でのテストの互換性が向上しました。

関連リンク

参考にした情報源リンク

  • Go言語の公式ドキュメント
  • GCCの公式ドキュメント(gccgo関連)
  • Go言語のソースコード(特にテストディレクトリの慣習)