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

このコミットは、Goコンパイラのgc（Go Compiler）部分にあるfmt.cファイルに対する小規模な修正を含んでいます。主な目的は、シンボルが不正な状態（"garbled state"）にある場合にエラーメッセージを出力する際のクラッシュを防ぐこと、およびOCOMPLIT（複合リテラル）をエクスポートモードで正しくレンダリングすることです。これにより、コンパイラの堅牢性とエクスポートされる情報の正確性が向上します。

コミット

commit 7cf4825425be6098b95a313ebe8008ea59c23611
Author: Luuk van Dijk <lvd@golang.org>
Date:   Tue Dec 13 09:15:46 2011 +0100

    gc: small fixes to fmt.c
    
    don't crash when printing error messages about symbols in a garbled state.
    render OCOMPLIT in export mode.
    
    R=rsc
    CC=golang-dev
    https://golang.org/cl/5466045

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

https://github.com/golang/go/commit/7cf4825425be6098b95a313ebe8008ea59c23611

元コミット内容

gc: small fixes to fmt.c

don't crash when printing error messages about symbols in a garbled state.
render OCOMPLIT in export mode.

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

変更の背景

このコミットは、Goコンパイラの安定性と機能性を向上させるために行われました。具体的には、以下の2つの主要な問題に対処しています。

1. シンボルが不正な状態でのクラッシュ防止: コンパイラが内部的にシンボル情報を処理する際、何らかの理由でシンボルが「garbled state」（破損または不完全な状態）になることがありました。このような状況で、コンパイラがそのシンボルに関するエラーメッセージを出力しようとすると、不正なメモリ参照などが発生し、コンパイラ自体がクラッシュする可能性がありました。この修正は、このようなクラッシュを防ぎ、より堅牢なエラー報告メカニズムを提供することを目的としています。
2. OCOMPLITのエクスポートモードでの正しいレンダリング: OCOMPLITはGo言語の「複合リテラル」（例: []int{1, 2, 3}やstruct{X int}{X: 1}）を表す抽象構文木（AST）ノードです。コンパイラが型情報などをエクスポートする際、これらの複合リテラルが正しく表現されない場合がありました。特に、エクスポートモード（FExp）では、単に「composite literal」という汎用的な文字列として出力されることがあり、エクスポートされた情報が不完全になる問題がありました。この修正により、エクスポートされる情報がより詳細で正確になります。

これらの修正は、コンパイラのデバッグ能力と、他のツール（リンカなど）がコンパイラから受け取る情報の品質を向上させる上で重要です。

前提知識の解説

このコミットを理解するためには、Goコンパイラの内部構造と、特にgc（Go Compiler）の役割に関する基本的な知識が必要です。

• Goコンパイラ (gc): Go言語の公式コンパイラは、通常gcと呼ばれます。これは、Goソースコードを機械語に変換する主要なツールです。gcは、字句解析、構文解析、型チェック、最適化、コード生成など、複数のフェーズで動作します。
• fmt.c: gcのソースコードの一部であり、主にコンパイラの内部データ構造（ASTノード、シンボル、型など）を人間が読める形式や、他のコンパイラフェーズやツールが利用できる形式に「フォーマット」（整形）する役割を担っています。デバッグ出力、エラーメッセージ、エクスポートされる型情報などの生成に関わります。
• Sym (Symbol): コンパイラが扱う識別子（変数名、関数名、型名など）を表す内部データ構造です。各シンボルは、その名前、所属するパッケージ、型などの情報を持っています。
• Node (AST Node): 抽象構文木（AST）の各ノードを表す内部データ構造です。Goのソースコードは、構文解析フェーズでASTに変換され、コンパイラの各フェーズはこのASTを操作します。Nodeは、式、文、宣言など、プログラムの様々な要素を表します。
• OCOMPLIT: Nodeの種類の一つで、Go言語の複合リテラル（Composite Literal）を表します。例えば、[]int{1, 2, 3}やmap[string]int{"a": 1}、struct{X int}{X: 1}などがこれに該当します。
• OTARRAY: Nodeの種類の一つで、配列型を表します。例えば、[]int（スライス）や[5]string（固定長配列）などです。
• FExp (Export Mode Formatting): fmt.c内で使用されるフォーマットモードの一つで、コンパイラが型情報などを他のコンパイルユニットやリンカにエクスポートする際に適用されるモードです。このモードでは、人間が読むためだけでなく、機械が解析しやすい形式で情報が出力される必要があります。
• builtinpkg: Go言語の組み込み型や関数が定義されている特別なパッケージです。例えば、int, string, len, makeなどがこれに属します。

技術的詳細

このコミットは、fmt.c内のいくつかのフォーマット関数に焦点を当てています。

1. symfmt関数の修正:

   • symfmtはシンボル（Sym構造体）をフォーマットする関数です。
   • case FExp:ブロックは、エクスポートモードでのシンボルのフォーマットを扱います。
   • 変更前は、@\"%Z\".%sという形式でパッケージパスとシンボル名を出力していましたが、これはbuiltinpkg（組み込みパッケージ）のシンボルに対しても適用されていました。組み込みパッケージのシンボルは、通常、明確なパッケージパスを持たないか、エクスポート時にそのパスが不要な場合があります。
   • 追加されたif(s->pkg != builtinpkg)チェックにより、組み込みパッケージのシンボルに対しては、このパッケージパスを含む形式での出力がスキップされるようになりました。これにより、不必要な情報が出力されたり、場合によってはbuiltinpkgのシンボルが「garbled state」にある場合にクラッシュする可能性が低減されます。

2. exprfmt関数のOTARRAYケースの修正:

   • exprfmtはASTノード（Node構造体）をフォーマットする関数です。
   • case OTARRAY:ブロックは、配列型ノードのフォーマットを扱います。
   • 変更前は、[]%Nという形式でn->left（配列の要素型）のみを出力していました。しかし、型チェックが完了する前など、特定のコンパイラフェーズではn->leftがまだ設定されていない（NULLである）場合があります。
   • 追加されたif(n->left)チェックと、n->rightへのフォールバック（return fmtprint(f, "[]%N", n->right); // happens before typecheck）により、n->leftがNULLの場合でもn->right（これは通常、型チェック前のASTノードで一時的に使用される）を使用してフォーマットを試みるようになりました。これにより、型チェック前の段階で配列型をフォーマットしようとした際のクラッシュが防止されます。

3. exprfmt関数のOCOMPLITケースの修正:

   • case OCOMPLIT:ブロックは、複合リテラルノードのフォーマットを扱います。
   • 変更前は、fmtstrcpy(f, "composite literal")と、常に汎用的な文字列を出力していました。これは、特にエクスポートモード（FExp）において、複合リテラルの詳細な型や要素情報が失われることを意味していました。
   • 追加されたif(fmtmode == FErr)チェックにより、エラーモード（FErr）の場合のみ、以前の汎用的な文字列を出力するようになりました。
   • それ以外のモード（特にエクスポートモード）では、return fmtprint(f, "%N{ %,H }", n->right, n->list);という形式で、複合リテラルの実際の型（n->right）と要素リスト（n->list）を詳細にフォーマットして出力するようになりました。これにより、エクスポートされる情報がより正確で有用になります。

4. Sconv関数の修正:

   • Sconvは、シンボル名を文字列に変換するユーティリティ関数です。
   • 変更前は、if(s->name[0] == '_' && s->name[1] == '\0')という条件で、シンボル名が_であるかをチェックしていました。しかし、s->nameがNULLである可能性が考慮されていませんでした。シンボルが「garbled state」にある場合、s->nameがNULLになることがあり、その状態でs->name[0]にアクセスしようとすると、NULLポインタデリファレンスによるクラッシュが発生します。
   • 追加されたs->name &&チェックにより、s->nameがNULLでないことを確認してから、その内容にアクセスするようになりました。これにより、不正なシンボル名によるクラッシュが防止されます。

これらの修正は、Goコンパイラの内部的な堅牢性を高め、特にデバッグやエクスポートのシナリオにおいて、より正確で有用な情報を提供することを目的としています。

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

--- a/src/cmd/gc/fmt.c
+++ b/src/cmd/gc/fmt.c
@@ -511,7 +511,8 @@ symfmt(Fmt *fp, Sym *s)
 			return fmtprint(fp, "%s.%s", s->pkg->name, s->name);	// dcommontype, typehash
 		return fmtprint(fp, "%s.%s", s->pkg->prefix, s->name);	// (methodsym), typesym, weaksym
 	case FExp:
-		return fmtprint(fp, "@\"%Z\".%s", s->pkg->path, s->name);
+		if(s->pkg != builtinpkg)
+			return fmtprint(fp, "@\"%Z\".%s", s->pkg->path, s->name);
 		}
 	}
 
@@ -1073,7 +1074,9 @@ exprfmt(Fmt *f, Node *n, int prec)
 		return fmtprint(f, "%T", n->type);
 
 	case OTARRAY:
-		return fmtprint(f, "[]%N", n->left);
+		if(n->left)
+			return fmtprint(f, "[]%N", n->left);
+		return fmtprint(f, "[]%N", n->right);  // happens before typecheck
 
 	case OTPAREN:
 		return fmtprint(f, "(%N)", n->left);
@@ -1109,7 +1112,9 @@ exprfmt(Fmt *f, Node *n, int prec)
 		return fmtprint(f, "%T { %H }", n->type, n->nbody);
 
 	case OCOMPLIT:
-		return fmtstrcpy(f, "composite literal");
+		if(fmtmode == FErr)
+			return fmtstrcpy(f, "composite literal");
+		return fmtprint(f, "%N{ %,H }", n->right, n->list);
 
 	case OPTRLIT:
 		return fmtprint(f, "&%N", n->left);
@@ -1401,7 +1406,7 @@ Sconv(Fmt *fp)
 	if(s == S)
 		return fmtstrcpy(fp, "<S>");
 
-	if(s->name[0] == '_' && s->name[1] == '\0')
+	if(s->name && s->name[0] == '_' && s->name[1] == '\0')
 		return fmtstrcpy(fp, "_");
 
 	sf = fp->flags;

コアとなるコードの解説

上記の差分は、src/cmd/gc/fmt.cファイル内の4つの異なる箇所に対する修正を示しています。

1. symfmt関数内、FExpケースの変更:

   • 変更前: return fmtprint(fp, "@\"%Z\".%s", s->pkg->path, s->name);
   • 変更後:

     if(s->pkg != builtinpkg)
         return fmtprint(fp, "@\"%Z\".%s", s->pkg->path, s->name);
     

   • 解説: シンボルをエクスポートモード（FExp）でフォーマットする際に、そのシンボルがbuiltinpkg（Goの組み込みパッケージ）に属していない場合にのみ、パッケージパスを含む形式で出力するように変更されました。これにより、組み込みシンボルに対して不適切なパッケージパスが出力されることを防ぎ、また、builtinpkgのシンボルが不正な状態にある場合に発生しうるクラッシュを回避します。

2. exprfmt関数内、OTARRAYケースの変更:

   • 変更前: return fmtprint(f, "[]%N", n->left);
   • 変更後:

     if(n->left)
         return fmtprint(f, "[]%N", n->left);
     return fmtprint(f, "[]%N", n->right);  // happens before typecheck
     

   • 解説: 配列型ノード（OTARRAY）をフォーマットする際に、まずn->left（配列の要素型）が存在するかどうかを確認します。もしn->leftがNULLでなければ、通常通り[]%Nの形式でn->leftをフォーマットします。しかし、n->leftがNULLの場合（例えば、型チェック前の段階）、代わりにn->rightを使用してフォーマットを試みます。これは、コンパイラの初期段階でASTノードが完全に構築されていない場合でも、クラッシュせずにフォーマットを続行できるようにするための堅牢性向上策です。

3. exprfmt関数内、OCOMPLITケースの変更:

   • 変更前: return fmtstrcpy(f, "composite literal");
   • 変更後:

     if(fmtmode == FErr)
         return fmtstrcpy(f, "composite literal");
     return fmtprint(f, "%N{ %,H }", n->right, n->list);
     

   • 解説: 複合リテラルノード（OCOMPLIT）をフォーマットする際に、フォーマットモードがエラーモード（FErr）である場合にのみ、汎用的な文字列「composite literal」を出力するように変更されました。それ以外のモード（特にエクスポートモード）では、%N{ %,H }という形式で、複合リテラルの実際の型（n->right）と要素のリスト（n->list）を詳細にフォーマットして出力するようになりました。これにより、エクスポートされる情報がより具体的で有用になります。

4. Sconv関数内、シンボル名チェックの変更:

   • 変更前: if(s->name[0] == '_' && s->name[1] == '\0')
   • 変更後: if(s->name && s->name[0] == '_' && s->name[1] == '\0')
   • 解説: シンボル名が_であるかをチェックする条件に、s->nameがNULLでないことの確認（s->name &&）が追加されました。これにより、s->nameがNULLである場合にs->name[0]にアクセスしようとして発生するNULLポインタデリファレンスによるクラッシュを防ぎます。これは、シンボルが「garbled state」にある場合に特に重要です。

これらの変更は、Goコンパイラの内部的な安定性を高め、特にエラー報告と型情報のエクスポートの正確性を向上させることに貢献しています。

関連リンク

• Go CL (Code Review) リンク: https://golang.org/cl/5466045

参考にした情報源リンク

• N/A (提供されたコミット情報とGoコンパイラの一般的な知識に基づいて解説を生成しました。)