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

このコミットで変更されたファイルは src/cmd/gc/swt.c です。 src/cmd/gc ディレクトリはGo言語のコンパイラ（gc は "Go compiler" の略）のソースコードを含んでいます。 swt.c というファイル名は、Go言語の switch ステートメント、特に「型スイッチ (type switch)」のコンパイルに関連する処理を扱っていることを示唆しています。このファイルは、Goのソースコードが抽象構文木（AST）に変換された後、型スイッチのセマンティクスを正しく処理し、実行可能なコードに変換する役割を担っていると考えられます。

コミット

このコミットは、Goコンパイラの型スイッチの実装において、ある式が二重に評価されるバグを修正するものです。具体的には、インターフェースのハッシュ値を計算する際に、その引数となる式が一度ではなく二度評価されてしまう問題を解決しています。

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

https://github.com/golang/go/commit/2450c590e9be32bef4d7a490343c9b082324fe60

元コミット内容

commit 2450c590e9be32bef4d7a490343c9b082324fe60
Author: Ken Thompson <ken@golang.org>
Date:   Wed Apr 1 21:28:59 2009 -0700

    typeswitch - expression evaluated
    twice instead of once.
    
    R=r
    OCL=27015
    CL=27015
--
 src/cmd/gc/swt.c | 2 +--
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/cmd/gc/swt.c b/src/cmd/gc/swt.c
index 59065b6f06..70d1a9e477 100644
--- a/src/cmd/gc/swt.c
+++ b/src/cmd/gc/swt.c
@@ -788,7 +788,7 @@ typeswitch(Node *sw)
 
  	a = syslook("ifacethash", 1);
  	argtype(a, sw->ntest->right->type);
- 	a = nod(OCALL, a, sw->ntest->right);
+ 	a = nod(OCALL, a, facename);
  	a = nod(OAS, hashname, a);
  	cas = list(cas, a);
 

変更の背景

Go言語の型スイッチは、インターフェース変数の動的な型に基づいて異なるコードパスを実行するための強力な機能です。コンパイラは、この型スイッチを効率的に処理するために、内部的にインターフェースの型情報をハッシュ化して比較するなどの最適化を行います。

このコミットが行われる前は、型スイッチのコンパイル過程で、インターフェースの型情報をハッシュ化するために必要な式（sw->ntest->right）が、コンパイラの内部処理で意図せず二度評価されていました。

式が二重に評価されることには、いくつかの問題があります。

1. 性能の低下: 無駄な計算が追加されるため、コンパイルされたコードの実行時性能が低下する可能性があります。特に、評価にコストがかかる式の場合、この影響は顕著になります。
2. 副作用の問題: もしその式が副作用（例: グローバル変数の変更、I/O操作、乱数生成など）を持つ場合、二重評価によって予期せぬ動作やバグが発生する可能性があります。例えば、一度だけ実行されるべき処理が二度実行されてしまう、といった事態が考えられます。

このコミットは、このような性能低下や潜在的なバグを防ぐために、式の評価が一度だけ行われるように修正することを目的としています。

前提知識の解説

このコミットを理解するためには、以下のGoコンパイラの内部構造とGo言語の機能に関する知識が必要です。

• Go言語の型スイッチ (Type Switch): Go言語の switch ステートメントの一種で、インターフェース変数の動的な型に基づいて異なる処理を行うために使用されます。構文は switch v := i.(type) { ... } のようになります。コンパイラは、実行時にインターフェース i の具体的な型を判別し、対応する case ブロックにジャンプするコードを生成します。

• Goコンパイラ (gc): Go言語の公式コンパイラであり、src/cmd/gc ディレクトリにそのソースコードがあります。gc はGoのソースコードを解析し、抽象構文木（AST）を構築し、型チェックを行い、最終的に実行可能なバイナリコードを生成します。

• 抽象構文木 (AST: Abstract Syntax Tree): コンパイラがソースコードを内部的に表現するために使用するツリー構造です。ソースコードの各要素（変数、関数呼び出し、演算子など）はASTのノードとして表現されます。コンパイラはASTを走査して、様々な最適化やコード生成を行います。

• Node 構造体: GoコンパイラのASTにおける基本的な構成要素です。各 Node は、ソースコード内の特定の構文要素（例: 識別子、リテラル、式、ステートメント）を表します。Node 構造体には、そのノードの種類（Op）、関連する型情報（Type）、子ノードへのポインタ（Left, Right, List など）が含まれます。

  • sw->ntest->right: ここで sw は型スイッチ全体のASTノードを指します。ntest は型スイッチのテスト式（例: i.(type)）に関連するノード、right はそのテスト式の右側の部分、つまり型スイッチの対象となるインターフェース変数自体を指していると考えられます。

• OCALL ノード: GoコンパイラのASTにおけるノードの種類の一つで、関数呼び出しを表します。nod(OCALL, func_node, arg_node) のように使用され、func_node が呼び出す関数、arg_node がその関数に渡される引数を表します。

• syslook 関数: Goコンパイラの内部関数で、システム定義のシンボル（関数や変数など）をルックアップするために使用されます。このコミットでは、"ifacethash" という名前のシンボルを検索しています。

• ifacethash: Goコンパイラの内部で使われる関数名です。名前から推測すると、インターフェースの動的な型情報をハッシュ化するために使用される関数である可能性が高いです。型スイッチの効率的なディスパッチのために、インターフェースの型を数値にマッピングする際に利用されます。

• facename: Goコンパイラの内部で使われる特定の変数またはシンボル名です。この文脈では、型スイッチの対象となるインターフェース値の型情報、またはそのハッシュ値が事前に格納される一時的な場所を指していると推測されます。

• OAS ノード: GoコンパイラのASTにおけるノードの種類の一つで、代入操作（=）を表します。nod(OAS, left_node, right_node) のように使用され、left_node に right_node の結果が代入されます。

• hashname: ifacethash の結果が代入される変数名です。インターフェースの型ハッシュ値を保持するために使用される一時変数であると考えられます。

技術的詳細

このコミットは、Goコンパイラの src/cmd/gc/swt.c ファイル内の typeswitch 関数におけるバグ修正です。typeswitch 関数は、Goソースコード中の型スイッチステートメントをコンパイルする役割を担っています。

問題の核心は、インターフェースの型ハッシュを計算する ifacethash 関数を呼び出す際に、その引数として渡される式 sw->ntest->right が二重に評価されていた点にあります。

元のコード:

 	a = syslook("ifacethash", 1);
 	argtype(a, sw->ntest->right->type);
 	a = nod(OCALL, a, sw->ntest->right); // ここで sw->ntest->right が評価される
 	a = nod(OAS, hashname, a);
 	cas = list(cas, a);

このコードでは、nod(OCALL, a, sw->ntest->right) の行で OCALL ノードが構築されます。この OCALL ノードの第3引数 sw->ntest->right は、ifacethash 関数に渡される引数を表すASTノードです。コンパイラがこのASTを処理して最終的な機械語コードを生成する際、sw->ntest->right が一度評価されます。しかし、その前の argtype(a, sw->ntest->right->type); の行でも sw->ntest->right->type にアクセスしており、このアクセスが sw->ntest->right の評価をトリガーしていた可能性があります。あるいは、OCALL ノードの構築時と、その後のコード生成フェーズで、同じASTノードが独立して評価されるようなコンパイラの内部ロジックが存在したのかもしれません。

修正後のコード:

 	a = syslook("ifacethash", 1);
 	argtype(a, sw->ntest->right->type);
 	a = nod(OCALL, a, facename); // ここで facename が使われる
 	a = nod(OAS, hashname, a);
 	cas = list(cas, a);

修正では、OCALL ノードの第3引数が sw->ntest->right から facename に変更されています。 この変更は、sw->ntest->right の評価結果が、OCALL ノードが構築される前に、一時変数またはシンボルである facename に格納されるようにコンパイラの他の部分で変更されたことを示唆しています。これにより、ifacethash 関数に渡される引数は、facename を参照することで、sw->ntest->right の式が一度だけ評価され、その結果が再利用されるようになります。

この修正により、型スイッチのコンパイル時に発生していた式の二重評価が解消され、コンパイルされたコードの正確性と効率性が向上しました。特に、副作用を持つ式が型スイッチの対象となる場合に、予期せぬ動作を防ぐ上で重要です。

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

--- a/src/cmd/gc/swt.c
+++ b/src/cmd/gc/swt.c
@@ -788,7 +788,7 @@ typeswitch(Node *sw)
 
  	a = syslook("ifacethash", 1);
  	argtype(a, sw->ntest->right->type);
- 	a = nod(OCALL, a, sw->ntest->right);
+ 	a = nod(OCALL, a, facename);
  	a = nod(OAS, hashname, a);
  	cas = list(cas, a);
 

コアとなるコードの解説

変更は src/cmd/gc/swt.c ファイル内の typeswitch 関数内で行われています。この関数は、Go言語の型スイッチステートメントを処理するコンパイラのバックエンド部分です。

1. a = syslook("ifacethash", 1); この行は、Goランタイムが提供する内部関数 ifacethash のシンボルをルックアップしています。ifacethash は、インターフェースの動的な型情報をハッシュ値に変換するために使用される関数です。このハッシュ値は、型スイッチの効率的なディスパッチ（どの case ブロックにジャンプするかを決定する）に利用されます。

2. argtype(a, sw->ntest->right->type); この行は、ifacethash 関数（a が指す）の引数の型を設定しています。引数の型は sw->ntest->right->type、つまり型スイッチの対象となるインターフェース変数の型です。これは、コンパイラが型チェックを行う上で必要な情報です。

3. - a = nod(OCALL, a, sw->ntest->right); 変更前のこの行では、OCALL (関数呼び出し) のASTノードを構築していました。

   • 最初の a は呼び出す関数 (ifacethash) を指します。
   • sw->ntest->right は、ifacethash に渡される引数を表すASTノードです。このノードは、型スイッチの対象となるインターフェース変数を指しています。問題は、この sw->ntest->right が、この OCALL ノードの構築時と、その前の argtype の呼び出し、あるいはその後のコード生成フェーズで、複数回評価される可能性があったことです。もし sw->ntest->right が副作用を持つ式であった場合、この二重評価はバグを引き起こす可能性がありました。

4. + a = nod(OCALL, a, facename); 変更後のこの行では、OCALL ノードの第3引数が sw->ntest->right から facename に置き換えられています。 facename は、Goコンパイラの内部で使われる一時的な変数またはシンボルであり、型スイッチの対象となるインターフェース変数の評価結果（またはその型情報）が事前に格納されていると推測されます。 この変更により、ifacethash 関数に渡される引数は、facename を参照することで、sw->ntest->right の式が一度だけ評価され、その結果が再利用されるようになります。これにより、式の二重評価が回避され、コンパイルされたコードの正確性と性能が向上します。

5. a = nod(OAS, hashname, a); この行は、OAS (代入) のASTノードを構築しています。ifacethash の呼び出し結果（a が指す）が、hashname という変数に代入されます。hashname は、インターフェースの型ハッシュ値を保持するために使用される一時変数であると考えられます。

6. cas = list(cas, a); この行は、構築されたASTノード（a）を、型スイッチの case ブロックに関連するリスト（cas）に追加しています。これは、コンパイラが型スイッチの各 case を処理するために必要な内部的なリスト構造の一部です。

このコミットは、Goコンパイラの初期段階における、細かな最適化とバグ修正の一例であり、コンパイラがどのようにソースコードを内部的に表現し、処理しているかを示す良い例です。

関連リンク

• Go言語の型スイッチに関する公式ドキュメント: https://go.dev/tour/methods/16
• Go言語のソースコードリポジトリ: https://github.com/golang/go
• Goコンパイラの内部構造に関する一般的な情報（より現代のGoに関するものですが、概念は共通しています）:
  • The Go Programming Language Specification - Type switches: https://go.dev/ref/spec#Type_switches

参考にした情報源リンク

• Go言語のコンパイラに関する一般的な知識
• 抽象構文木 (AST) の概念
• コンパイラの最適化に関する一般的な原則
• Go言語の型スイッチの動作原理```markdown

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

このコミットで変更されたファイルは src/cmd/gc/swt.c です。 src/cmd/gc ディレクトリはGo言語のコンパイラ（gc は "Go compiler" の略）のソースコードを含んでいます。 swt.c というファイル名は、Go言語の switch ステートメント、特に「型スイッチ (type switch)」のコンパイルに関連する処理を扱っていることを示唆しています。このファイルは、Goのソースコードが抽象構文木（AST）に変換された後、型スイッチのセマンティクスを正しく処理し、実行可能なコードに変換する役割を担っていると考えられます。

コミット

このコミットは、Goコンパイラの型スイッチの実装において、ある式が二重に評価されるバグを修正するものです。具体的には、インターフェースのハッシュ値を計算する際に、その引数となる式が一度ではなく二度評価されてしまう問題を解決しています。

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

https://github.com/golang/go/commit/2450c590e9be32bef4d7a490343c9b082324fe60

元コミット内容

commit 2450c590e9be32bef4d7a490343c9b082324fe60
Author: Ken Thompson <ken@golang.org>
Date:   Wed Apr 1 21:28:59 2009 -0700

    typeswitch - expression evaluated
    twice instead of once.
    
    R=r
    OCL=27015
    CL=27015
--
 src/cmd/gc/swt.c | 2 +--
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/cmd/gc/swt.c b/src/cmd/gc/swt.c
index 59065b6f06..70d1a9e477 100644
--- a/src/cmd/gc/swt.c
+++ b/src/cmd/gc/swt.c
@@ -788,7 +788,7 @@ typeswitch(Node *sw)
 
  	a = syslook("ifacethash", 1);
  	argtype(a, sw->ntest->right->type);
- 	a = nod(OCALL, a, sw->ntest->right);
+ 	a = nod(OCALL, a, facename);
  	a = nod(OAS, hashname, a);
  	cas = list(cas, a);
 

変更の背景

Go言語の型スイッチは、インターフェース変数の動的な型に基づいて異なるコードパスを実行するための強力な機能です。コンパイラは、この型スイッチを効率的に処理するために、内部的にインターフェースの型情報をハッシュ化して比較するなどの最適化を行います。

このコミットが行われる前は、型スイッチのコンパイル過程で、インターフェースの型情報をハッシュ化するために必要な式（sw->ntest->right）が、コンパイラの内部処理で意図せず二度評価されていました。

式が二重に評価されることには、いくつかの問題があります。

1. 性能の低下: 無駄な計算が追加されるため、コンパイルされたコードの実行時性能が低下する可能性があります。特に、評価にコストがかかる式の場合、この影響は顕著になります。
2. 副作用の問題: もしその式が副作用（例: グローバル変数の変更、I/O操作、乱数生成など）を持つ場合、二重評価によって予期せぬ動作やバグが発生する可能性があります。例えば、一度だけ実行されるべき処理が二度実行されてしまう、といった事態が考えられます。

このコミットは、このような性能低下や潜在的なバグを防ぐために、式の評価が一度だけ行われるように修正することを目的としています。

前提知識の解説

このコミットを理解するためには、以下のGoコンパイラの内部構造とGo言語の機能に関する知識が必要です。

• Go言語の型スイッチ (Type Switch): Go言語の switch ステートメントの一種で、インターフェース変数の動的な型に基づいて異なる処理を行うために使用されます。構文は switch v := i.(type) { ... } のようになります。コンパイラは、実行時にインターフェース i の具体的な型を判別し、対応する case ブロックにジャンプするコードを生成します。

• Goコンパイラ (gc): Go言語の公式コンパイラであり、src/cmd/gc ディレクトリにそのソースコードがあります。gc はGoのソースコードを解析し、抽象構文木（AST）を構築し、型チェックを行い、最終的に実行可能なバイナリコードを生成します。

• 抽象構文木 (AST: Abstract Syntax Tree): コンパイラがソースコードを内部的に表現するために使用するツリー構造です。ソースコードの各要素（変数、関数呼び出し、演算子など）はASTのノードとして表現されます。コンパイラはASTを走査して、様々な最適化やコード生成を行います。

• Node 構造体: GoコンパイラのASTにおける基本的な構成要素です。各 Node は、ソースコード内の特定の構文要素（例: 識別子、リテラル、式、ステートメント）を表します。Node 構造体には、そのノードの種類（Op）、関連する型情報（Type）、子ノードへのポインタ（Left, Right, List など）が含まれます。

  • sw->ntest->right: ここで sw は型スイッチ全体のASTノードを指します。ntest は型スイッチのテスト式（例: i.(type)）に関連するノード、right はそのテスト式の右側の部分、つまり型スイッチの対象となるインターフェース変数自体を指していると考えられます。

• OCALL ノード: GoコンパイラのASTにおけるノードの種類の一つで、関数呼び出しを表します。nod(OCALL, func_node, arg_node) のように使用され、func_node が呼び出す関数、arg_node がその関数に渡される引数を表します。

• syslook 関数: Goコンパイラの内部関数で、システム定義のシンボル（関数や変数など）をルックアップするために使用されます。このコミットでは、"ifacethash" という名前のシンボルを検索しています。

• ifacethash: Goコンパイラの内部で使われる関数名です。名前から推測すると、インターフェースの動的な型情報をハッシュ化するために使用される関数である可能性が高いです。型スイッチの効率的なディスパッチのために、インターフェースの型を数値にマッピングする際に利用されます。

• facename: Goコンパイラの内部で使われる特定の変数またはシンボル名です。この文脈では、型スイッチの対象となるインターフェース値の型情報、またはそのハッシュ値が事前に格納される一時的な場所を指していると推測されます。

• OAS ノード: GoコンパイラのASTにおけるノードの種類の一つで、代入操作（=）を表します。nod(OAS, left_node, right_node) のように使用され、left_node に right_node の結果が代入されます。

• hashname: ifacethash の結果が代入される変数名です。インターフェースの型ハッシュ値を保持するために使用される一時変数であると考えられます。

技術的詳細

このコミットは、Goコンパイラの src/cmd/gc/swt.c ファイル内の typeswitch 関数におけるバグ修正です。typeswitch 関数は、Goソースコード中の型スイッチステートメントをコンパイルする役割を担っています。

問題の核心は、インターフェースの型ハッシュを計算する ifacethash 関数を呼び出す際に、その引数として渡される式 sw->ntest->right が二重に評価されていた点にあります。

元のコード:

 	a = syslook("ifacethash", 1);
 	argtype(a, sw->ntest->right->type);
 	a = nod(OCALL, a, sw->ntest->right); // ここで sw->ntest->right が評価される
 	a = nod(OAS, hashname, a);
 	cas = list(cas, a);

このコードでは、nod(OCALL, a, sw->ntest->right) の行で OCALL ノードが構築されます。この OCALL ノードの第3引数 sw->ntest->right は、ifacethash 関数に渡される引数を表すASTノードです。コンパイラがこのASTを処理して最終的な機械語コードを生成する際、sw->ntest->right が一度評価されます。しかし、その前の argtype(a, sw->ntest->right->type); の行でも sw->ntest->right->type にアクセスしており、このアクセスが sw->ntest->right の評価をトリガーしていた可能性があります。あるいは、OCALL ノードの構築時と、その後のコード生成フェーズで、同じASTノードが独立して評価されるようなコンパイラの内部ロジックが存在したのかもしれません。

修正後のコード:

 	a = syslook("ifacethash", 1);
 	argtype(a, sw->ntest->right->type);
 	a = nod(OCALL, a, facename); // ここで facename が使われる
 	a = nod(OAS, hashname, a);
 	cas = list(cas, a);

修正では、OCALL ノードの第3引数が sw->ntest->right から facename に変更されています。 この変更は、sw->ntest->right の評価結果が、OCALL ノードが構築される前に、一時変数またはシンボルである facename に格納されるようにコンパイラの他の部分で変更されたことを示唆しています。これにより、ifacethash 関数に渡される引数は、facename を参照することで、sw->ntest->right の式が一度だけ評価され、その結果が再利用されるようになります。

この修正により、型スイッチのコンパイル時に発生していた式の二重評価が解消され、コンパイルされたコードの正確性と効率性が向上しました。特に、副作用を持つ式が型スイッチの対象となる場合に、予期せぬ動作を防ぐ上で重要です。

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

--- a/src/cmd/gc/swt.c
+++ b/src/cmd/gc/swt.c
@@ -788,7 +788,7 @@ typeswitch(Node *sw)
 
  	a = syslook("ifacethash", 1);
  	argtype(a, sw->ntest->right->type);
- 	a = nod(OCALL, a, sw->ntest->right);
+ 	a = nod(OCALL, a, facename);
  	a = nod(OAS, hashname, a);
  	cas = list(cas, a);
 

コアとなるコードの解説

変更は src/cmd/gc/swt.c ファイル内の typeswitch 関数内で行われています。この関数は、Go言語の型スイッチステートメントを処理するコンパイラのバックエンド部分です。

1. a = syslook("ifacethash", 1); この行は、Goランタイムが提供する内部関数 ifacethash のシンボルをルックアップしています。ifacethash は、インターフェースの動的な型情報をハッシュ値に変換するために使用される関数です。このハッシュ値は、型スイッチの効率的なディスパッチ（どの case ブロックにジャンプするかを決定する）に利用されます。

2. argtype(a, sw->ntest->right->type); この行は、ifacethash 関数（a が指す）の引数の型を設定しています。引数の型は sw->ntest->right->type、つまり型スイッチの対象となるインターフェース変数の型です。これは、コンパイラが型チェックを行う上で必要な情報です。

3. - a = nod(OCALL, a, sw->ntest->right); 変更前のこの行では、OCALL (関数呼び出し) のASTノードを構築していました。

   • 最初の a は呼び出す関数 (ifacethash) を指します。
   • sw->ntest->right は、ifacethash に渡される引数を表すASTノードです。このノードは、型スイッチの対象となるインターフェース変数を指しています。問題は、この sw->ntest->right が、この OCALL ノードの構築時と、その前の argtype の呼び出し、あるいはその後のコード生成フェーズで、複数回評価される可能性があったことです。もし sw->ntest->right が副作用を持つ式であった場合、この二重評価はバグを引き起こす可能性がありました。

4. + a = nod(OCALL, a, facename); 変更後のこの行では、OCALL ノードの第3引数が sw->ntest->right から facename に置き換えられています。 facename は、Goコンパイラの内部で使われる一時的な変数またはシンボルであり、型スイッチの対象となるインターフェース変数の評価結果（またはその型情報）が事前に格納されていると推測されます。 この変更により、ifacethash 関数に渡される引数は、facename を参照することで、sw->ntest->right の式が一度だけ評価され、その結果が再利用されるようになります。これにより、式の二重評価が回避され、コンパイルされたコードの正確性と性能が向上します。

5. a = nod(OAS, hashname, a); この行は、OAS (代入) のASTノードを構築しています。ifacethash の呼び出し結果（a が指す）が、hashname という変数に代入されます。hashname は、インターフェースの型ハッシュ値を保持するために使用される一時変数であると考えられます。

6. cas = list(cas, a); この行は、構築されたASTノード（a）を、型スイッチの case ブロックに関連するリスト（cas）に追加しています。これは、コンパイラが型スイッチの各 case を処理するために必要な内部的なリスト構造の一部です。

このコミットは、Goコンパイラの初期段階における、細かな最適化とバグ修正の一例であり、コンパイラがどのようにソースコードを内部的に表現し、処理しているかを示す良い例です。

関連リンク

• Go言語の型スイッチに関する公式ドキュメント: https://go.dev/tour/methods/16
• Go言語のソースコードリポジトリ: https://github.com/golang/go
• Goコンパイラの内部構造に関する一般的な情報（より現代のGoに関するものですが、概念は共通しています）:
  • The Go Programming Language Specification - Type switches: https://go.dev/ref/spec#Type_switches

参考にした情報源リンク

• Go言語のコンパイラに関する一般的な知識
• 抽象構文木 (AST) の概念
• コンパイラの最適化に関する一般的な原則
• Go言語の型スイッチの動作原理