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

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

このコミットは、Goコンパイラ(cmd/gc)におけるバグ修正に関するものです。具体的には、インライン化された関数のボディが型アサーション(x, ok := v.(Type))を含んでいる場合に、その型定義が正しくエクスポートされず、「unknown type」コンパイラエラーが発生する問題を解決します。

変更されたファイルは以下の通りです。

  • src/cmd/gc/export.c: Goコンパイラのコード生成およびエクスポート処理に関連するC言語のソースファイル。このファイルにバグ修正が加えられました。
  • test/fixedbugs/issue4370.dir/p1.go: バグを再現するためのGoのテストファイル。型アサーションを含むメソッドを定義しています。
  • test/fixedbugs/issue4370.dir/p2.go: p1.goをインポートし、p1.Tを埋め込んだ構造体を持つテストファイル。
  • test/fixedbugs/issue4370.dir/p3.go: p2.goをインポートし、p2パッケージの関数を呼び出すテストファイル。
  • test/fixedbugs/issue4370.go: 上記のテストディレクトリ内のGoファイルをコンパイルし、バグが修正されたことを確認するためのメインのテストスクリプト。

コミット

commit 761830f48196aa1170b5224c1da34f4e20053ebd
Author: Russ Cox <rsc@golang.org>
Date:   Thu Nov 8 16:07:05 2012 -0500

    cmd/gc: fix export of inlined function body with type guard
    
    When exporting a body containing
            x, ok := v.(Type)
    
    the definition for Type was not being included, so when the body
    was actually used, it would cause an "unknown type" compiler error.
    
    Fixes #4370.
    
    R=ken2
    CC=golang-dev
    https://golang.org/cl/6827064

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

https://github.com/golang/go/commit/761830f48196aa1170b5224c1da34f4e20053ebd

元コミット内容

このコミットは、Goコンパイラ(cmd/gc)が、インライン化された関数のボディ内にx, ok := v.(Type)のような型アサーション(type guard)が含まれている場合に、そのTypeの定義を正しくエクスポートしないというバグを修正するものです。この問題により、エクスポートされたコードが実際に使用される際に「unknown type」というコンパイラエラーが発生していました。

変更の背景

Go言語では、コンパイラがパフォーマンス最適化のために一部の関数をインライン化することがあります。インライン化とは、関数呼び出しの代わりに、呼び出される関数のコードを呼び出し元に直接埋め込む最適化手法です。これにより、関数呼び出しのオーバーヘッドが削減され、実行速度が向上する可能性があります。

しかし、このコミットが修正するバグは、インライン化された関数が特定のGoの言語機能、具体的には型アサーションx, ok := v.(Type)を使用している場合に発生しました。型アサーションは、インターフェース型の値が特定の具象型であるかどうかをチェックし、もしそうであればその具象型の値に変換するGoの強力な機能です。

問題は、コンパイラがインライン化された関数のボディをエクスポートする際に、そのボディ内で使用されている型アサーションの対象となる型(上記の例ではType)の定義を、エクスポートされるメタデータに含めるのを忘れていたことにありました。結果として、別のパッケージからこのインライン化された関数が呼び出され、そのボディが展開されると、コンパイラはTypeの定義を見つけることができず、「unknown type」(未知の型)エラーを報告していました。

このバグはGoのIssue #4370として報告されており、このコミットはその問題を解決するために作成されました。

前提知識の解説

このコミットの理解には、以下のGo言語およびGoコンパイラの基本的な概念が役立ちます。

  1. Goコンパイラ (cmd/gc): Go言語の公式コンパイラは、通常gc(Go Compiler)と呼ばれます。これはGoのソースコードを機械語に変換する役割を担っています。コンパイルプロセスには、構文解析、型チェック、最適化、コード生成、そして他のパッケージとのリンクに必要な情報の「エクスポート」などが含まれます。

  2. パッケージとエクスポート: Goのコードはパッケージに分割されます。あるパッケージが別のパッケージの公開された(エクスポートされた)識別子(関数、変数、型など)を使用する場合、コンパイラはそれらの識別子の定義に関する情報を必要とします。この情報は、コンパイル時にパッケージのメタデータとしてエクスポートされ、他のパッケージがインポートする際に利用されます。

  3. インライン化 (Inlining): コンパイラ最適化の一つで、小さな関数の呼び出しを、その関数の本体のコードで直接置き換えることです。これにより、関数呼び出しのオーバーヘッド(スタックフレームの作成、引数の渡し、戻り値の処理など)が削減され、プログラムの実行速度が向上します。Goコンパイラは、特定の条件を満たす関数を自動的にインライン化します。

  4. 型アサーション (x, ok := v.(Type)): Go言語における型アサーションは、インターフェース型の値が特定の具象型であるかどうかを動的にチェックし、もしそうであればその具象型の値に変換するために使用されます。

    • value.(Type): インターフェースvalueType型であるとアサートし、Type型の値を返します。アサーションが失敗するとパニックが発生します。
    • x, ok := value.(Type): インターフェースvalueType型であるとアサートします。okはアサーションが成功したかどうかを示すブール値で、xは成功した場合にType型の値になります。失敗した場合、xはその型のゼロ値になり、okfalseになります。この形式は「型ガード(type guard)」とも呼ばれ、安全に型チェックを行うために広く使われます。
  5. 抽象構文木 (AST - Abstract Syntax Tree): コンパイラはソースコードを直接操作するのではなく、まずそれを抽象構文木というツリー構造に変換します。ASTはプログラムの構造を抽象的に表現したもので、コンパイラの各フェーズ(型チェック、最適化、コード生成など)はこのASTを操作します。Goコンパイラ内部では、ASTの各ノードは特定の操作や式を表すOp(Operation)コードを持っています。

    • ODOTTYPE: v.(Type)のような単一の戻り値を持つ型アサーションを表すASTノード。
    • ODOTTYPE2: x, ok := v.(Type)のような2つの戻り値を持つ型アサーションを表すASTノード。
  6. reexportdep 関数: src/cmd/gc/export.c内に存在するこの関数は、Goコンパイラがコードをエクスポートする際に、特定のASTノードが参照している型やその他の依存関係を再エクスポートする必要があるかどうかを判断し、その処理を行うためのものです。例えば、ある関数が別の型を引数に取る場合、その型定義もエクスポートされる必要があります。

技術的詳細

このバグは、Goコンパイラのインライン化とエクスポートのメカニズムが、型アサーションの特定の形式(x, ok := v.(Type))を適切に処理していなかったことに起因します。

Goコンパイラは、関数をインライン化する際に、その関数のASTを呼び出し元のASTにマージします。その後、コンパイルされたコードが他のパッケージから参照される可能性がある場合、コンパイラはそのパッケージの公開された要素(インライン化された関数のボディを含む)が依存するすべての型定義をエクスポートする必要があります。

src/cmd/gc/export.c内のreexportdep関数は、この依存関係のエクスポートを担当しています。この関数は、ASTノードを走査し、そのノードが参照する型や他のエンティティをエクスポートリストに追加します。

既存の実装では、reexportdep関数はODOTTYPEノード(単一の戻り値を持つ型アサーションv.(Type))を処理し、そのアサーションの対象となる型をエクスポートしていました。しかし、ODOTTYPE2ノード(2つの戻り値を持つ型アサーションx, ok := v.(Type))については、この処理が欠落していました。

したがって、インライン化された関数がx, ok := v.(Type)形式の型アサーションを含んでいた場合、そのアサーションの対象となる型(例: Magic型)はreexportdepによって適切に識別されず、エクスポートされるメタデータに含まれませんでした。その結果、このインライン化された関数が別のパッケージから使用されると、コンパイラはそのMagic型を見つけることができず、「unknown type」エラーが発生したのです。

このコミットは、reexportdep関数がODOTTYPE2ノードも同様に処理するように修正することで、この問題を解決しています。これにより、x, ok := v.(Type)形式の型アサーションに含まれる型も、インライン化された関数のボディがエクスポートされる際に正しく依存関係として認識され、エクスポートされるようになります。

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

変更はsrc/cmd/gc/export.cファイル内のreexportdep関数にあります。

--- a/src/cmd/gc/export.c
+++ b/src/cmd/gc/export.c
@@ -152,6 +152,7 @@ reexportdep(Node *n)
 	case OCONVIFACE:
 	case OCONVNOP:
 	case ODOTTYPE:
+	case ODOTTYPE2:
 	case OSTRUCTLIT:
 	case OPTRLIT:
 		t = n->type;

この差分は、reexportdep関数のswitch文にcase ODOTTYPE2:を追加していることを示しています。

コアとなるコードの解説

reexportdep関数は、GoコンパイラがASTノードを走査し、そのノードが依存する型情報をエクスポートリストに追加するために使用されます。この関数は、さまざまな種類のASTノード(Opコード)を処理するswitch文を持っています。

変更前のコードでは、ODOTTYPE(単一の戻り値を持つ型アサーション、例: v.(Type))の場合には、そのアサーションの対象となる型(n->type)をtに代入し、その型がエクスポートされるように処理していました。

しかし、ODOTTYPE2(2つの戻り値を持つ型アサーション、例: x, ok := v.(Type))の場合には、このcaseが明示的に存在していませんでした。そのため、ODOTTYPE2ノードに遭遇しても、reexportdep関数はそのノードが参照する型を依存関係として認識せず、エクスポートリストに追加しませんでした。

今回の修正では、ODOTTYPE2ODOTTYPEと同じcaseブロックに追加することで、x, ok := v.(Type)形式の型アサーションも、そのアサーションの対象となる型(n->type)がreexportdepによって正しく処理され、エクスポートされるようにしました。これにより、インライン化された関数がこの形式の型アサーションを含んでいても、その型定義が他のパッケージに正しく伝達され、「unknown type」エラーが解消されます。

関連リンク

参考にした情報源リンク

  • Go言語の公式ドキュメント
  • Goコンパイラのソースコード (src/cmd/gc)
  • Go言語の型アサーションに関する一般的な情報
  • Go言語のインライン化に関する一般的な情報