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

src/pkg/go/types/builtins.go は、Go言語のコンパイラの一部である go/types パッケージに属するファイルです。このファイルは、Go言語の組み込み関数（append, make, new, len, cap など）の型チェックロジックを定義しています。go/types パッケージは、Goプログラムの静的解析を行い、式の型を決定し、型の一貫性を検証する役割を担っています。builtins.go 内の builtin 関数は、これらの組み込み関数の呼び出しが正しい引数型と数でなされているか、そしてその結果としてどのような型が返されるべきかを判断します。

コミット

このコミットは、Go言語の型チェッカーにおける append 組み込み関数の結果型が誤って推論されるバグを修正するものです。既存のコードをより堅牢な方法で書き直すことで、同様の誤りを将来的に防ぐことを目的としています。

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

https://github.com/golang/go/commit/5a4a197d7b692c5725d0364a51ad1cb76f1b99e4

元コミット内容

go/types: correct result type for append (bug fix)

Rewrote existing code to prevent similar mistakes.

R=adonovan
CC=golang-dev
https://golang.org/cl/7129046

変更の背景

Go言語の append 関数は、スライスに要素を追加し、必要に応じて新しい基底配列を持つスライスを返すことがあります。この挙動のため、append の結果型は、元のスライスの型と一致する必要があります。しかし、このコミット以前の go/types パッケージの実装では、append の結果型を決定するロジックに誤りがあり、場合によっては不正確な型が推論される可能性がありました。

具体的には、型チェックの過程で一時的に使用される変数 typ0 が、append の結果型として誤って使用されることがありました。これは、_Make や _New のような他の組み込み関数では typ0 が引数から導出される型として適切であったのに対し、append の場合は、append の最初の引数（スライス）の型が結果型となるべきであるという特性と合致していなかったためです。

このバグは、コンパイラが append の結果を誤って型付けし、その後の型チェックやコード生成で問題を引き起こす可能性がありました。コミットメッセージにある「Rewrote existing code to prevent similar mistakes.」という記述は、この append のバグだけでなく、同様の型推論の誤りが他の組み込み関数でも発生しないように、より一般的なコードの堅牢化を目指したことを示唆しています。

前提知識の解説

Go言語の型システム

Go言語は静的型付け言語であり、すべての変数と式には型があります。

基本型 (Basic Types): int, string, bool, float64 など。
複合型 (Composite Types):
- スライス (Slice): 同じ型の要素の可変長シーケンス。[]T の形式で表され、T は要素の型です。
- マップ (Map): キーと値のペアのコレクション。map[K]V の形式で表されます。
- チャネル (Channel): ゴルーチン間の通信に使用される。chan T の形式で表されます。
- ポインタ (Pointer): 変数のメモリアドレスを保持する。*T の形式で表されます。
underlying 型: Goの型システムには、基底型（underlying type）という概念があります。これは、型宣言によって新しい名前付き型が定義された場合でも、その型が最終的にどのような組み込み型に基づいているかを示します。例えば、type MyInt int と定義された MyInt の基底型は int です。型チェックの際には、多くの場合、名前付き型ではなくその基底型に基づいて互換性が判断されます。

`go/types` パッケージ

go/types パッケージは、Go言語のコンパイラツールチェーンの一部であり、Goプログラムの型チェックと型推論を担当します。これは、ソースコードを抽象構文木（AST）として解析した後、各ノードの型を決定し、Go言語の型規則に違反がないかを検証します。このパッケージは、IDE、リンター、その他の静的解析ツールでも利用されます。

Goの組み込み関数 (Builtins)

Go言語には、言語仕様によって定義された特別な関数がいくつかあります。これらは通常の関数とは異なり、コンパイラによって特別に扱われます。

append: スライスに要素を追加する。
make: スライス、マップ、チャネルを初期化して作成する。
new: 型のゼロ値を割り当て、その型へのポインタを返す。
len: スライス、マップ、チャネル、配列、文字列の長さを返す。
cap: スライス、チャネル、配列の容量を返す。
close: チャネルを閉じる。
copy: スライスから別のスライスへ要素をコピーする。
delete: マップから要素を削除する。
panic, recover: ランタイムパニックの処理。
print, println: デバッグ出力。
complex, real, imag: 複素数関連。
recover: パニックから回復する。

`operand` 構造体と `check.expr`, `check.typ` メソッド

go/types パッケージの内部では、型チェックの際に式やオペランドの情報を保持するために operand 構造体が使用されます。

check.expr(x, arg, nil, iota): 式 arg の型をチェックし、その結果を operand x に格納します。
check.typ(arg, false): 式 arg が型を表している場合に、その型を返します。

これらの関数は、Goコードの各部分が期待される型を持っているかを検証し、必要に応じて型情報を伝播させるために不可欠です。

技術的詳細

このコミットの技術的詳細は、go/types パッケージが組み込み関数の型チェックをどのように処理するか、特に append の結果型推論の正確性をどのように改善したかに焦点を当てています。

src/pkg/go/types/builtins.go 内の builtin 関数は、ast.CallExpr（関数呼び出しの抽象構文木ノード）を受け取り、それがどの組み込み関数であるかを bin.id で識別します。そして、その組み込み関数に応じた型チェックロジックを実行します。

変更前は、多くの組み込み関数で、最初の引数の型を typ0 という変数に格納していました。

_Make, _New の場合: typ0 = check.typ(arg0, false) (引数が型であるため)
その他の場合: typ0 = underlying(x.typ) (引数が式であるため、その式の基底型を取得)

このアプローチは、_Make や _New のように引数自体が型を表す場合には適切でしたが、_Append のように引数がスライスなどの「値」であり、その値の型が結果型に影響する場合に問題を引き起こしました。

append の場合、append(s, elems...) の s はスライスであり、append の結果も同じ型のスライスであるべきです。しかし、変更前のコードでは、typ0 が append の結果型として直接使用されていました。もし typ0 が何らかの理由で append の最初の引数であるスライスの型を正確に反映していなかった場合、誤った結果型が推論される可能性がありました。

このコミットでは、この問題を解決するために、append の結果型を x.typ (最初の引数 s の型) から直接取得し、それを resultTyp という新しい変数に格納するように変更しました。これにより、append の結果型が常に最初のスライスの型と一致することが保証されます。

また、他の組み込み関数（_Cap, _Len, _Close, _Copy, _Delete, _Imag, _Real, _Make, _New, _Sizeof, _Assert）についても、typ0 の使用を廃止し、直接 x.typ や underlying(x.typ) を使用するように変更されています。これは、typ0 という一時変数を介さずに、より直接的にオペランド x の型情報にアクセスすることで、コードの明確性と堅牢性を高め、将来的な同様のバグを防ぐためのリファクタリングです。特に _Make と _New では、check.typ(arg0, false) の結果を resultTyp に格納し、それを結果型として使用することで、意図がより明確になっています。

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

変更は src/pkg/go/types/builtins.go ファイルに集中しています。

arg0 と typ0 の宣言の変更:
```
-	var arg0 ast.Expr
-	var typ0 Type
+	var arg0 ast.Expr // first argument, if present
```
typ0 変数の宣言が削除され、arg0 のコメントが追加されました。

_Make, _New, _Trace の初期型チェックロジックの変更:

-		switch id {
-		case _Make, _New:
-			// argument must be a type
-			typ0 = check.typ(arg0, false)
-			if typ0 == Typ[Invalid] {
-				goto Error
-			}
-		case _Trace:
-			// _Trace implementation does the work
-		default:
-			// argument must be an expression
-			check.expr(x, arg0, nil, iota)
-			if x.mode == invalid {
-				goto Error
-			}
-			typ0 = underlying(x.typ)
-		}
+		switch id {
+		case _Make, _New, _Trace:
+			// respective cases below do the work
+		default:
+			// argument must be an expression
+			check.expr(x, arg0, nil, iota)
+			if x.mode == invalid {
+				goto Error
+			}
+		}

typ0 への代入ロジックが削除され、各組み込み関数のケース内で直接型を処理するように変更されました。

_Append の結果型処理の修正:

case _Append:
-		s, ok := typ0.(*Slice)
-		if !ok {
+		if _, ok := underlying(x.typ).(*Slice); !ok {
			check.invalidArg(x.pos(), "%s is not a typed slice", x)
			goto Error
		}
+		resultTyp := x.typ
		for _, arg := range args[1:] {
			check.expr(x, arg, nil, iota)
			if x.mode == invalid {
				goto Error
			}
			// TODO(gri) check assignability
		}
		x.mode = value
-		x.typ = s
+		x.typ = resultTyp

typ0 からスライス型を取得する代わりに、underlying(x.typ) を直接チェックし、x.typ を resultTyp として保持し、最終的に x.typ に resultTyp を代入するように変更されました。

他の組み込み関数における typ0 の使用箇所の変更:
- _Cap, _Len: implicitDeref(typ0) から implicitDeref(underlying(x.typ)) へ変更。
- _Close: typ0.(*Chan) から underlying(x.typ).(*Chan) へ変更。
- _Copy: typ0.(*Slice) から underlying(x.typ).(*Slice) へ変更。
- _Delete: typ0.(*Map) から underlying(x.typ).(*Map) へ変更。
- _Imag, _Real: isComplex(typ0) から isComplex(x.typ) へ変更。
- _Imag, _Real の結果型決定: typ0.(*Basic).Kind から underlying(x.typ).(*Basic).Kind へ変更。
- _Make: underlying(typ0) から underlying(resultTyp) へ変更。resultTyp の初期化ロジックが追加。
- _New: typ0 から resultTyp へ変更。resultTyp の初期化ロジックが追加。
- _Sizeof: sizeof(check.ctxt, typ0) から sizeof(check.ctxt, x.typ) へ変更。
- _Assert: isBoolean(typ0) から isBoolean(x.typ) へ変更。

コアとなるコードの解説

このコミットの核心は、組み込み関数の型チェックにおいて、引数の型情報をより直接的かつ正確に扱うように変更した点にあります。

以前のコードでは、typ0 という一時変数が、組み込み関数の最初の引数の型を保持するために使われていました。しかし、この typ0 の値が、組み込み関数の種類によって異なる方法で設定されたり、あるいは適切に更新されなかったりする可能性がありました。特に append の場合、append の結果型は常に最初の引数であるスライスの型と一致する必要があるにもかかわらず、typ0 がその保証を提供していませんでした。

新しいコードでは、以下の改善が行われています。

typ0 の廃止と直接的な x.typ の利用: 多くの組み込み関数において、typ0 を介さずに、直接 x.typ (オペランド x の型) を参照するように変更されました。x は check.expr によって既に型チェックされたオペランドであり、その typ フィールドは常に現在のコンテキストにおける正確な型情報を持っています。これにより、型情報の伝播がより明確になり、中間変数による誤解やバグのリスクが低減されます。
_Append の結果型処理の明確化: _Append のケースでは、resultTyp := x.typ という行が追加されました。これは、append の結果型が、常に最初の引数であるスライス x の型と同じであることを明示的に示しています。これにより、append が新しい基底配列を持つスライスを返した場合でも、その型が元のスライスの型と一致することが保証され、型チェックの正確性が向上します。
_Make と _New の resultTyp 導入: _Make と _New のケースでは、check.typ(arg0, false) の結果を resultTyp に格納し、その resultTyp を最終的な x.typ として使用するように変更されました。これは、これらの関数が引数として「型」を受け取るという特性をより明確に反映しており、コードの意図がより分かりやすくなっています。

これらの変更は、単なるバグ修正に留まらず、go/types パッケージ内の組み込み関数型チェックロジック全体の堅牢性と可読性を向上させるためのリファクタリングでもあります。これにより、将来的に同様の型推論の誤りが発生する可能性が低減されます。

参考にした情報源リンク

Go言語の公式ドキュメントと仕様
GitHubのgolang/goリポジトリのソースコード
Go言語の型システムに関する一般的な知識

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

コミット

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

https://github.com/golang/go/commit/5a4a197d7b692c5725d0364a51ad1cb76f1b99e4

元コミット内容

go/types: correct result type for append (bug fix)

Rewrote existing code to prevent similar mistakes.

R=adonovan
CC=golang-dev
https://golang.org/cl/7129046

変更の背景

このバグは、コンパイラが append の結果を誤って型付けし、その後の型チェックやコード生成で問題を引き起こす可能性がありました。例えば、append の結果が期待されるスライス型ではなく、異なる型として扱われることで、後続の操作で型ミスマッチエラーが発生したり、不正なコードが生成されたりする可能性がありました。コミットメッセージにある「Rewrote existing code to prevent similar mistakes.」という記述は、この append のバグだけでなく、同様の型推論の誤りが他の組み込み関数でも発生しないように、より一般的なコードの堅牢化を目指したことを示唆しています。これは、typ0 のような汎用的な一時変数を複数の異なる組み込み関数の型チェックロジックで使い回すことによる潜在的なリスクを認識し、各組み込み関数の特性に応じたより明示的で安全な型処理を行うように設計思想を転換したことを意味します。

前提知識の解説

Go言語の型システム

Go言語は静的型付け言語であり、すべての変数と式には型があります。

基本型 (Basic Types): int, string, bool, float64 など、言語に組み込まれた基本的なデータ型です。
複合型 (Composite Types):
- スライス (Slice): 同じ型の要素の可変長シーケンスです。[]T の形式で表され、T は要素の型です。スライスは配列への参照であり、動的にサイズを変更できます。
- マップ (Map): キーと値のペアのコレクションです。map[K]V の形式で表され、K はキーの型、V は値の型です。キーは一意であり、値はキーによって効率的に検索できます。
- チャネル (Channel): ゴルーチン間の通信に使用される型安全なパイプです。chan T の形式で表され、T はチャネルを通じて送受信されるデータの型です。
- ポインタ (Pointer): 変数のメモリアドレスを保持する型です。*T の形式で表され、T はポインタが指す値の型です。
underlying 型: Goの型システムには、基底型（underlying type）という概念があります。これは、型宣言によって新しい名前付き型が定義された場合でも、その型が最終的にどのような組み込み型に基づいているかを示します。例えば、type MyInt int と定義された MyInt の基底型は int です。型チェックの際には、多くの場合、名前付き型ではなくその基底型に基づいて互換性が判断されます。これにより、異なる名前を持つ型でも、基底型が同じであれば互換性を持つ場合があります。

`go/types` パッケージ

go/types パッケージは、Go言語のコンパイラツールチェーンの一部であり、Goプログラムの型チェックと型推論を担当します。これは、ソースコードを抽象構文木（AST）として解析した後、各ノードの型を決定し、Go言語の型規則に違反がないかを検証します。このパッケージは、Goコンパイラのバックエンドだけでなく、IDE、リンター、その他の静的解析ツールでも利用され、コードの正確性と品質を保証する上で中心的な役割を果たします。

Goの組み込み関数 (Builtins)

Go言語には、言語仕様によって定義された特別な関数がいくつかあります。これらは通常の関数とは異なり、コンパイラによって特別に扱われ、特定のコンテキストでのみ使用できます。

append: スライスに要素を追加し、新しいスライスを返します。必要に応じて、より大きな容量を持つ新しい基底配列が割り当てられることがあります。
make: スライス、マップ、チャネルを初期化して作成します。これらの型は、make を使ってメモリを割り当て、初期化する必要があります。
new: 型のゼロ値を割り当て、その型へのポインタを返します。make とは異なり、new はメモリを割り当てるだけで、初期化は行いません。
len: スライス、マップ、チャネル、配列、文字列の長さを返します。
cap: スライス、チャネル、配列の容量を返します。
close: チャネルを閉じます。閉じられたチャネルからは、それ以上値が送信されなくなります。
copy: スライスから別のスライスへ要素をコピーします。
delete: マップから要素を削除します。
panic, recover: ランタイムパニックの処理に使用されます。panic はプログラムの異常終了を引き起こし、recover はパニックから回復するために使用されます。
print, println: デバッグ出力に使用される組み込み関数です。
complex, real, imag: 複素数型を操作するための関数です。
recover: パニックから回復するための関数です。

`operand` 構造体と `check.expr`, `check.typ` メソッド

go/types パッケージの内部では、型チェックの際に式やオペランドの情報を保持するために operand 構造体が使用されます。

operand.typ: オペランドの型情報。
operand.mode: オペランドの評価モード（例: value, variable, constant, invalid）。
check.expr(x, arg, nil, iota): 式 arg の型をチェックし、その結果（型、モード、値など）を operand x に格納します。これは、Goコード内の任意の式（変数、リテラル、関数呼び出しなど）の型を決定するために使用されます。
check.typ(arg, false): 式 arg が型を表している場合に、その型を返します。例えば、make([]int, 10) の []int の部分が型として認識されます。

これらの関数は、Goコードの各部分が期待される型を持っているかを検証し、必要に応じて型情報を伝播させるために不可欠です。型チェックのプロセスは、これらの関数を組み合わせて、ASTを走査しながら各ノードの型を推論し、Go言語の型規則に照らして検証することで行われます。

技術的詳細

変更前は、多くの組み込み関数で、最初の引数の型を typ0 という変数に格納していました。

_Make, _New の場合: typ0 = check.typ(arg0, false) (引数が型であるため、その型を取得)
その他の場合: typ0 = underlying(x.typ) (引数が式であるため、その式の基底型を取得)

このアプローチは、_Make や _New のように引数自体が型を表す場合には適切でしたが、_Append のように引数がスライスなどの「値」であり、その値の型が結果型に影響する場合に問題を引き起こしました。append のシグネチャは func append(slice []Type, elems ...Type) []Type であり、戻り値の型は常に最初の引数であるスライスの型と同じである必要があります。

このコミットでは、この問題を解決するために、append の結果型を x.typ (最初の引数 s の型) から直接取得し、それを resultTyp という新しい変数に格納するように変更しました。これにより、append の結果型が常に最初のスライスの型と一致することが保証されます。x.typ は、check.expr によって既に型チェックされたオペランドの正確な型情報を含んでいるため、このアプローチはより信頼性が高いです。

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

変更は src/pkg/go/types/builtins.go ファイルに集中しています。

arg0 と typ0 の宣言の変更:
```
-	var arg0 ast.Expr
-	var typ0 Type
+	var arg0 ast.Expr // first argument, if present
```
typ0 変数の宣言が削除され、arg0 のコメントが追加されました。これは、typ0 が不要になったことを示しています。

_Make, _New, _Trace の初期型チェックロジックの変更:

-		switch id {
-		case _Make, _New:
-			// argument must be a type
-			typ0 = check.typ(arg0, false)
-			if typ0 == Typ[Invalid] {
-				goto Error
-			}
-		case _Trace:
-			// _Trace implementation does the work
-		default:
-			// argument must be an expression
-			check.expr(x, arg0, nil, iota)
-			if x.mode == invalid {
-				goto Error
-			}
-			typ0 = underlying(x.typ)
-		}
+		switch id {
+		case _Make, _New, _Trace:
+			// respective cases below do the work
+		default:
+			// argument must be an expression
+			check.expr(x, arg0, nil, iota)
+			if x.mode == invalid {
+				goto Error
+			}
+		}

typ0 への代入ロジックが削除され、各組み込み関数のケース内で直接型を処理するように変更されました。これにより、typ0 のライフサイクルとスコープに関する混乱が解消されます。

_Append の結果型処理の修正:

case _Append:
-		s, ok := typ0.(*Slice)
-		if !ok {
+		if _, ok := underlying(x.typ).(*Slice); !ok {
			check.invalidArg(x.pos(), "%s is not a typed slice", x)
			goto Error
		}
+		resultTyp := x.typ
		for _, arg := range args[1:] {
			check.expr(x, arg, nil, iota)
			if x.mode == invalid {
				goto Error
			}
			// TODO(gri) check assignability
		}
		x.mode = value
-		x.typ = s
+		x.typ = resultTyp

typ0 からスライス型を取得する代わりに、underlying(x.typ) を直接チェックし、x.typ を resultTyp として保持し、最終的に x.typ に resultTyp を代入するように変更されました。これは append の結果型が常に最初の引数であるスライスの型と同じであることを保証します。

他の組み込み関数における typ0 の使用箇所の変更:
- _Cap, _Len: implicitDeref(typ0) から implicitDeref(underlying(x.typ)) へ変更。これにより、オペランド x の基底型を直接参照します。
- _Close: typ0.(*Chan) から underlying(x.typ).(*Chan) へ変更。
- _Copy: typ0.(*Slice) から underlying(x.typ).(*Slice) へ変更。
- _Delete: typ0.(*Map) から underlying(x.typ).(*Map) へ変更。
- _Imag, _Real: isComplex(typ0) から isComplex(x.typ) へ変更。
- _Imag, _Real の結果型決定: typ0.(*Basic).Kind から underlying(x.typ).(*Basic).Kind へ変更。
- _Make: underlying(typ0) から underlying(resultTyp) へ変更。resultTyp の初期化ロジックが追加され、check.typ(arg0, false) の結果が直接 resultTyp に格納されます。
- _New: typ0 から resultTyp へ変更。resultTyp の初期化ロジックが追加され、check.typ(arg0, false) の結果が直接 resultTyp に格納されます。
- _Sizeof: sizeof(check.ctxt, typ0) から sizeof(check.ctxt, x.typ) へ変更。
- _Assert: isBoolean(typ0) から isBoolean(x.typ) へ変更。

これらの変更は、typ0 という一時変数の使用を排除し、各組み込み関数の型チェックロジックが、その組み込み関数自身の引数から直接型情報を取得するようにすることで、コードの堅牢性と保守性を大幅に向上させています。

コアとなるコードの解説

このコミットの核心は、組み込み関数の型チェックにおいて、引数の型情報をより直接的かつ正確に扱うように変更した点にあります。

新しいコードでは、以下の改善が行われています。

typ0 の廃止と直接的な x.typ の利用: 多くの組み込み関数において、typ0 を介さずに、直接 x.typ (オペランド x の型) を参照するように変更されました。x は check.expr によって既に型チェックされたオペランドであり、その typ フィールドは常に現在のコンテキストにおける正確な型情報を持っています。これにより、型情報の伝播がより明確になり、中間変数による誤解やバグのリスクが低減されます。各組み込み関数が自身の引数から直接型情報を取得することで、依存関係が明確になり、コードの独立性が高まります。
_Append の結果型処理の明確化: _Append のケースでは、resultTyp := x.typ という行が追加されました。これは、append の結果型が、常に最初の引数であるスライス x の型と同じであることを明示的に示しています。append は、元のスライスの容量が不足した場合に新しい基底配列を割り当てて新しいスライスを返すことがありますが、その場合でも返されるスライスの型は元のスライスと同じでなければなりません。この変更により、append が新しい基底配列を持つスライスを返した場合でも、その型が元のスライスの型と一致することが保証され、型チェックの正確性が向上します。
_Make と _New の resultTyp 導入: _Make と _New のケースでは、check.typ(arg0, false) の結果を resultTyp に格納し、その resultTyp を最終的な x.typ として使用するように変更されました。これは、これらの関数が引数として「型」を受け取るという特性をより明確に反映しており、コードの意図がより分かりやすくなっています。make([]int, 10) の []int のように、引数自体が型を表す場合に、その型を正確に取得し、結果型として設定するプロセスが明確化されました。

これらの変更は、単なるバグ修正に留まらず、go/types パッケージ内の組み込み関数型チェックロジック全体の堅牢性と可読性を向上させるためのリファクタリングでもあります。これにより、将来的に同様の型推論の誤りが発生する可能性が低減されます。コードがより意図を明確に表現するようになり、デバッグや将来の機能追加が容易になります。

参考にした情報源リンク

Go言語の公式ドキュメントと仕様
GitHubのgolang/goリポジトリのソースコード
Go言語の型システムに関する一般的な知識
Web検索結果: "Go go/types package append builtin function type inference" (特に、append のシグネチャ、型互換性、戻り値の型に関する情報)

comemo

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

コミット

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

元コミット内容

変更の背景

前提知識の解説

Go言語の型システム

`go/types` パッケージ

Goの組み込み関数 (Builtins)

`operand` 構造体と `check.expr`, `check.typ` メソッド

技術的詳細

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

コアとなるコードの解説

関連リンク

参考にした情報源リンク

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

コミット

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

元コミット内容

変更の背景

前提知識の解説

Go言語の型システム

`go/types` パッケージ

Goの組み込み関数 (Builtins)

`operand` 構造体と `check.expr`, `check.typ` メソッド

技術的詳細

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

コアとなるコードの解説

関連リンク

参考にした情報源リンク

Keyboard shortcuts

comemo