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

このコミットは、Goコンパイラ（gc）における定数演算時のエラーメッセージをより分かりやすく、かつ冗長にならないように改善することを目的としています。特に、オーバーフローや範囲外の定数に関するエラー報告の精度とユーザーフレンドリーさを向上させています。また、ビルドプロセスにおける一時ファイルのクリーンアップに関する小さな改善も含まれています。

コミット

コミットハッシュ: 337547d1c997a11266c967e27ac7bc6c611b6372
Author: Russ Cox rsc@golang.org
Date: Sat Feb 11 00:50:56 2012 -0500

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

https://github.com/golang/go/commit/337547d1c997a11266c967e27ac7bc6c611b6372

元コミット内容

gc: make constant arith errors a little more friendly

Fixes #2804.

R=ken2
CC=golang-dev
https://golang.org/cl/5652067

この変更は、Go言語のIssue #2804「gc should report constant overflow errors more clearly」に対応するものです。Goコンパイラは、コンパイル時に定数式の評価を行います。この際、定数演算の結果が表現可能な範囲を超えたり（オーバーフロー）、無効な操作が行われたりした場合にエラーを報告します。しかし、以前の実装では、これらのエラーメッセージが「ovf in mpaddxx」や「set ovf in mpmulfixfix」のように、内部的な関数名や状態を示すものが多く、ユーザーにとって何が問題なのかを理解しにくいものでした。

また、複合的な定数式（例: LargeA * LargeA * LargeA）の評価中に、中間結果でオーバーフローが発生した場合に、複数の冗長なエラーメッセージが出力される問題もありました。このコミットは、これらの問題を解決し、より明確でユーザーに役立つエラーメッセージを提供することを目指しています。

前提知識の解説

Goコンパイラ (`gc`)

gcは、Go言語の公式コンパイラであり、Goプログラムを機械語に変換する役割を担っています。Goのツールチェインの一部として提供され、コンパイル、リンク、アセンブルなどのプロセスを管理します。定数評価は、コンパイル時の重要なフェーズの一つです。

定数演算

Go言語では、コンパイル時に評価される「定数」が存在します。これらは数値、真偽値、文字列などのリテラルや、それらを用いた定数式です。定数式は、実行時ではなくコンパイル時にその値が確定するため、コンパイラは定数演算の正確性を保証する必要があります。このコミットで変更されているのは、この定数演算を行うコンパイラの内部ロジックです。

`Mpint` と `Mpflt`

これらはGoコンパイラの内部で多倍長整数（Mpint）および多倍長浮動小数点数（Mpflt）を扱うためのデータ構造です。Go言語の定数は、通常のCPUレジスタで扱える範囲を超える大きな値を持つことができるため、コンパイラはこれらの多倍長演算ライブラリを使用して正確な計算を行います。

Mpint: 任意精度の整数を表現します。
Mpflt: 任意精度の浮動小数点数を表現します。

`yyerror`

yyerrorは、Goコンパイラの字句解析器/構文解析器（Yacc/Bisonによって生成されることが多い）がエラーを報告するために使用する関数です。コンパイルエラーが発生した場合に、ユーザーに表示されるエラーメッセージを生成します。

`nsavederrors` と `nerrors`

これらはGoコンパイラの内部でエラーの状態を管理するための変数です。

nerrors: 現在のコンパイルセッションで発生したエラーの総数を追跡します。
nsavederrors: 以前のコンパイルフェーズで発生し、既に報告されたエラーの数を追跡します。これらの変数をチェックすることで、既にエラーが報告されている場合に、同じ種類の冗長なエラーメッセージを再度出力するのを避けることができます。

`defer os.RemoveAll(a1.objdir)`

deferはGo言語のキーワードで、その関数がリターンする直前に指定された関数を実行することを保証します。os.RemoveAllは指定されたパスのディレクトリとその内容をすべて削除する関数です。 a1.objdirはビルドプロセス中に生成されるオブジェクトファイルが格納される一時ディレクトリを指します。この行は、ビルドが完了した後に、この一時ディレクトリを確実にクリーンアップするためのものです。これにより、ビルド後のディスクスペースの消費を抑え、クリーンな状態を保ちます。

技術的詳細

このコミットの主要な変更点は、Goコンパイラの定数演算ライブラリ（mparith関連ファイル）におけるエラー報告のロジックとメッセージの改善です。

mpaddfixfix 関数の変更:
- src/cmd/gc/go.h で、mpaddfixfix 関数のシグネチャに新しい引数 int quiet が追加されました。
```
-void	mpaddfixfix(Mpint *a, Mpint *b);
+void	mpaddfixfix(Mpint *a, Mpint *b, int);
```
- src/cmd/gc/mparith2.c の mpaddfixfix 実装において、この quiet 引数が導入されました。
```
-void
-mpaddfixfix(Mpint *a, Mpint *b)
+void
+mpaddfixfix(Mpint *a, Mpint *b, int quiet)
{
    // ...
-	if(a->ovf)
-		yyerror("set ovf in mpaddxx");
+	if(a->ovf && !quiet)
+		yyerror("constant addition overflow");
}
```
  quiet が 0（false）の場合にのみエラーメッセージが出力されるようになり、1（true）の場合はエラーメッセージが抑制されます。これは、多倍長演算の内部で中間的な加算が行われる際に、その中間結果のオーバーフローが直接ユーザーに報告される必要がない場合に利用されます。例えば、乗算（mpmulfixfix）の内部では、繰り返し加算が行われますが、その都度オーバーフローエラーを報告するのは冗長です。
エラーメッセージの具体化と冗長性の排除:
- src/cmd/gc/mparith1.c では、浮動小数点数や整数のパース時のエラーメッセージがより具体的になりました。
  - "exponent out of range" が "constant exponent out of range: %s" に変更され、元の文字列が表示されるようになりました。
  - "set ovf in mpatof" や "set ovf in mpatov" が "constant too large: %s" に変更され、よりユーザーフレンドリーになりました。
- src/cmd/gc/mparith2.c では、mpcmp, mpmulfixfix, mpmulfract, mporfixfix, mpandfixfix, mpandnotfixfix, mpxorfixfix, mplshfixfix, mprshfixfix, mpgetfix などの関数で、オーバーフローエラーの報告が if(nsavederrors+nerrors == 0) という条件付きになりました。これにより、既にエラーが報告されている場合には、同じ種類のオーバーフローエラーが繰り返し報告されるのを防ぎ、出力のノイズを減らします。
- 具体的なエラーメッセージも改善されました。例えば、"set ovf in mpaddxx" は "constant addition overflow" に、"set ovf in mpmulfixfix" は "constant multiplication overflow" に、"set ovf in mpdivmodfixfix" は "constant division overflow" に変更されました。
- src/cmd/gc/mparith3.c の mpdivfltflt では、ゼロ除算のエラーメッセージが "constant division by zero" と明確化されました。
src/cmd/go/build.go の変更:
- このファイルでは、ビルドプロセス後のクリーンアップ処理が追加されました。
```
+	defer os.RemoveAll(a1.objdir)
+	defer os.Remove(a1.target)
```
  これは、ビルドが完了した際に、一時的なオブジェクトディレクトリ（a1.objdir）と最終的なターゲットファイル（a1.target）を削除することを保証します。これにより、ビルドキャッシュの管理が改善され、ディスクスペースの効率的な利用が促進されます。この変更は定数演算エラーとは直接関係ありませんが、同じコミットで含まれています。
テストケースの追加:
- test/const2.go に、定数乗算オーバーフローをテストする新しい定数定義が追加されました。
```
const LargeA = 1000000000000000000
const LargeB = LargeA * LargeA * LargeA
const LargeC = LargeB * LargeB * LargeB  // ERROR "constant multiplication overflow"
```
  これにより、LargeC の定義が定数乗算オーバーフローを引き起こし、新しいエラーメッセージが正しく報告されることを検証します。

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

src/cmd/gc/const.c: evconst 関数内の mpaddfixfix の呼び出しに quiet 引数 (0) を追加。
src/cmd/gc/go.h: mpaddfixfix 関数のプロトタイプに int 引数を追加。
src/cmd/gc/go.y: hidden_constant ルール内の mpaddfixfix の呼び出しに quiet 引数 (0) を追加。
src/cmd/gc/mparith1.c:
- mpsubfixfix, mpaddcfix 内の mpaddfixfix の呼び出しに quiet 引数 (0) を追加。
- mpatoflt, mpatofix のエラーメッセージをより具体的に変更。
src/cmd/gc/mparith2.c:
- mpaddfixfix 関数のシグネチャに int quiet を追加し、エラー報告を条件付き (!quiet) に変更。
- mpcmp, mpmulfixfix, mpmulfract, mporfixfix, mpandfixfix, mpandnotfixfix, mpxorfixfix, mplshfixfix, mprshfixfix, mpgetfix, mpdivmodfixfix 内の yyerror 呼び出しを if(nsavederrors+nerrors == 0) で条件付きにし、エラーメッセージを改善。
- mpmulfixfix と mpmulfract 内の mpaddfixfix の呼び出しに quiet 引数 (1) を追加。
src/cmd/gc/mparith3.c:
- mpaddfltflt 内の mpaddfixfix の呼び出しに quiet 引数 (0) を追加。
- mpdivfltflt のゼロ除算エラーメッセージを改善。
- mpgetflt のオーバーフローエラー報告を条件付きに変更。
src/cmd/gc/y.tab.c: yyreduce 関数内の mpaddfixfix の呼び出しに quiet 引数 (0) を追加。
src/cmd/go/build.go: install 関数に defer os.RemoveAll(a1.objdir) と defer os.Remove(a1.target) を追加。
test/const2.go: 定数乗算オーバーフローのテストケースを追加。

コアとなるコードの解説

このコミットの核心は、Goコンパイラが定数演算のオーバーフローを報告する方法を改善することにあります。

`mpaddfixfix` の `quiet` 引数

mpaddfixfix 関数は、多倍長整数 Mpint の加算を行います。この関数に quiet という新しい引数が追加されたことで、エラーメッセージの出力が制御できるようになりました。

void
mpaddfixfix(Mpint *a, Mpint *b, int quiet)
{
    // ...
    if(a->ovf && !quiet)
        yyerror("constant addition overflow");
}

quiet が 0 の場合（デフォルトの動作）、オーバーフローが発生すると "constant addition overflow" というエラーメッセージが yyerror を通じて報告されます。しかし、quiet が 1 の場合、このエラーメッセージは抑制されます。

これは、例えば多倍長整数の乗算（mpmulfixfix）のように、内部で繰り返し加算を行うような複雑な演算において非常に重要です。乗算の途中で中間結果がオーバーフローしても、それが最終的な乗算結果のオーバーフローに繋がるわけではない場合や、最終的な乗算結果のオーバーフローが別途報告される場合には、中間的な加算のオーバーフローメッセージは冗長になります。quiet=1 を使用することで、このような内部的なエラー報告を抑制し、ユーザーには最終的な、より意味のあるエラーのみを提示できるようになります。

条件付きエラー報告 (`if(nsavederrors+nerrors == 0)`)

多くの mparith 関数で、yyerror の呼び出しが以下の条件で囲まれるようになりました。

if(nsavederrors+nerrors == 0)
    yyerror("...");

これは、既にコンパイルエラーが検出され、報告されている場合に、同じ種類の追加のエラーメッセージを抑制するためのものです。例えば、ある定数式で複数のオーバーフローが発生する可能性がある場合でも、最初のオーバーフローが報告されれば、それ以降の関連するオーバーフローメッセージは不要であることが多いです。この条件により、コンパイラの出力がより簡潔になり、ユーザーは本当に重要なエラーに集中できるようになります。

エラーメッセージの具体化

以前の「ovf in mpaddxx」のような内部的なエラーメッセージは、ユーザーにとって理解しにくいものでした。このコミットでは、これらのメッセージが「constant addition overflow」や「constant multiplication overflow」のように、より具体的で、何が問題なのかを直接的に示す表現に改善されました。これにより、開発者はコンパイルエラーの原因を迅速に特定し、修正できるようになります。

`build.go` のクリーンアップ

src/cmd/go/build.go に追加された defer os.RemoveAll(a1.objdir) と defer os.Remove(a1.target) は、Goのビルドシステムが生成する一時ファイルを自動的にクリーンアップするためのものです。これは、ビルドの信頼性と効率性を向上させるための一般的なプラクティスであり、特に大規模なプロジェクトやCI/CD環境において、ディスクスペースの管理とビルドの再現性を確保する上で役立ちます。

これらの変更は全体として、Goコンパイラのユーザーエクスペリエンスを向上させ、エラーメッセージの品質を高めることに貢献しています。

参考にした情報源リンク

上記のGo IssueおよびGo CLのリンク
Go言語の公式ドキュメント（定数、defer文など）
Goコンパイラのソースコード（src/cmd/gc ディレクトリ内のファイル）
Yacc/Bisonに関する一般的な知識（yyerrorの役割理解のため）
多倍長演算ライブラリに関する一般的な知識