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

このコミットは、Go言語のテストスイート内のtest/garbageディレクトリをtest/bench/garbageに移動し、関連するファイルパスを修正するものです。この変更の主な目的は、これらのファイルがテストではなく、ガベージコレクタのベンチマークであることを明確にすることです。

コミット

コミットハッシュ: 5fe96c640a23eaac4d53d164e9a164e93b1414af
作者: Russ Cox rsc@golang.org
コミット日時: 2011年12月13日火曜日 18:02:49 -0500

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

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

元コミット内容

test/garbage: move to test/bench/garbage

(These are benchmarks for the garbage collector, not tests.)

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/5484070

変更の背景

このコミットの背景には、Go言語プロジェクトにおけるコードの分類と整理の明確化があります。元のtest/garbageディレクトリに含まれていたコードは、その名前が示すように「テスト」として分類されていましたが、実際にはGoのガベージコレクタのパフォーマンスを測定するための「ベンチマーク」でした。

Go言語の標準的な慣習では、テストコードは通常_test.goファイルに記述され、go testコマンドで実行されます。一方、ベンチマークコードも_test.goファイルに記述されますが、Benchmarkプレフィックスを持つ関数として定義され、go test -bench=.のようなコマンドで実行されます。テストは機能の正しさを検証するものであり、ベンチマークはパフォーマンス特性を測定するものです。

このコミットは、これらのガベージコレクタ関連のコードがテストではなくベンチマークであるという事実を反映するために、ディレクトリ構造をtest/garbageからtest/bench/garbageへと変更しました。これにより、プロジェクトの構造がより意味的になり、開発者がコードの目的をより迅速に理解できるようになります。

前提知識の解説

Go言語におけるテストとベンチマーク

Go言語には、標準ライブラリに組み込まれた強力なテストフレームワークがあります。

テスト (Tests): Goのテストは、コードの機能が期待通りに動作するかどうかを検証するために使用されます。テスト関数はfunc TestXxx(*testing.T)という形式で定義され、go testコマンドで実行されます。テストは通常、特定の関数やメソッドが正しい出力を生成するか、エラーを適切に処理するかなどを確認します。
ベンチマーク (Benchmarks): ベンチマークは、コードのパフォーマンスを測定するために使用されます。ベンチマーク関数はfunc BenchmarkXxx(*testing.B)という形式で定義され、go test -bench=.コマンドで実行されます。testing.B型は、ベンチマークの実行回数を自動的に調整し、安定したパフォーマンス測定を可能にするためのメソッドを提供します。ベンチマークは、特定のアルゴリズムの実行時間やメモリ使用量などを評価するのに役立ちます。

このコミットの文脈では、test/garbage内のコードが、単に機能の正しさを確認するだけでなく、ガベージコレクタの性能を評価するためのものであるため、「ベンチマーク」として再分類されたことが重要です。

ガベージコレクタ (Garbage Collector, GC)

ガベージコレクタは、プログラムが動的に割り当てたメモリのうち、もはや使用されていない（到達不能な）領域を自動的に解放するシステムです。これにより、開発者は手動でのメモリ管理の複雑さから解放され、メモリリークのリスクを低減できます。

Go言語は、並行マーク＆スイープ方式のガベージコレクタを採用しています。これは、プログラムの実行中にガベージコレクションを並行して行うことで、アプリケーションの一時停止（ストップ・ザ・ワールド）時間を最小限に抑えるように設計されています。ガベージコレクタの効率は、Goアプリケーションの全体的なパフォーマンスに大きな影響を与えるため、その性能を正確に測定するためのベンチマークは非常に重要です。

test/garbage（移動後はtest/bench/garbage）内のコードは、ガベージコレクタがどのようにメモリを管理し、オブジェクトを回収するかをシミュレートし、その過程でのパフォーマンス特性（例：一時停止時間、スキャン時間）を測定するために設計されています。

技術的詳細

このコミットの技術的な変更は、主にファイルシステムの再編成と、それに伴うパスの調整に集約されます。

ディレクトリの移動: test/garbageディレクトリとその内容全体が、test/bench/garbageに移動されました。これは、git mvコマンドに相当する操作であり、Gitはファイルの内容変更ではなく、ファイル名の変更としてこれを認識します。
パスの更新: ディレクトリの移動に伴い、移動されたファイルや、移動されたファイルを参照していた他のファイル内の相対パスが更新されました。
- src/clean.bash: このシェルスクリプトは、Goプロジェクトのクリーンアップ処理を行うもので、ビルド成果物や一時ファイルを削除します。このスクリプト内で、test/garbageを参照していたパスがtest/bench/garbageに更新されました。これにより、クリーンアッププロセスが新しいディレクトリ構造を正しく認識し、ベンチマーク関連のファイルを適切に処理できるようになります。
- test/garbage/Makefile -> test/bench/garbage/Makefile: Makefileは、ビルドプロセスを定義するファイルです。このファイル内で、Goのビルドシステムが使用する共通のインクルードファイルであるMake.incへの相対パスが変更されました。
  - 変更前: include ../../src/Make.inc
  - 変更後: include ../../../src/Make.inc これは、test/garbageからsrcディレクトリへは2階層上に移動する必要がありましたが、test/bench/garbageからは3階層上に移動する必要があるためです。このパスの修正により、ベンチマークのビルドプロセスが引き続き正しく機能することが保証されます。
- test/bench/shootout/timing.sh: このシェルスクリプトも、ベンチマークのタイミングを測定するためのもので、Make.incへの相対パスが同様に修正されました。
  - 変更前: eval $(gomake --no-print-directory -f ../../src/Make.inc go-env)
  - 変更後: eval $(gomake --no-print-directory -f ../../../src/Make.inc go-env) これも、test/bench/shootoutからsrcディレクトリへの相対パスが、test/bench/garbageの移動によって間接的に影響を受けたためです。
コードの整形:
- test/garbage/peano.go -> test/bench/garbage/peano.go: このファイルは、ペアノ数を使用してガベージコレクタの動作をシミュレートするベンチマークコードです。機能的な変更はありませんが、複数の空行が削除され、コードの可読性が向上しました。これは、コードベース全体のスタイルガイドラインに合わせた整形作業の一環と考えられます。
- test/garbage/stats.go -> test/bench/garbage/stats.go: このファイルは、ガベージコレクションの統計情報を収集・表示するためのコードです。このファイルでも、Swapメソッドの定義が一行から複数行に整形され、コメントのインデントが修正されました。これも機能的な変更ではなく、コードの整形です。

これらの変更は、Goプロジェクトのディレクトリ構造をより論理的に整理し、将来のメンテナンスと理解を容易にすることを目的としています。

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

このコミットで変更された主要なファイルは以下の通りです。

src/clean.bash
test/{ => bench}/garbage/Makefile (ファイル名変更と内容変更)
test/{ => bench}/garbage/parser.go (ファイル名変更のみ)
test/{ => bench}/garbage/peano.go (ファイル名変更と内容変更)
test/{ => bench}/garbage/stats.go (ファイル名変更と内容変更)
test/{ => bench}/garbage/tree.go (ファイル名変更のみ)
test/bench/shootout/timing.sh

コアとなるコードの解説

`src/clean.bash` の変更

--- a/src/clean.bash
+++ b/src/clean.bash
@@ -24,7 +24,7 @@ for i in lib9 libbio libmach cmd pkg \
 	../misc/cgo/life ../misc/cgo/test \
 	../misc/dashboard/builder ../misc/goplay\
 	../doc/codelab/wiki\
--	../test/bench/shootout ../test/garbage
+-	../test/bench/shootout ../test/bench/garbage
 do
 	# Do not use gomake here. It may not be available.
 	$MAKE -C "$GOROOT/src/$i" clean

この変更は、clean.bashスクリプトがクリーンアップ対象とするディレクトリリストを更新するものです。../test/garbageが../test/bench/garbageに変更され、ガベージコレクタのベンチマーク関連ファイルが新しい場所でクリーンアップされるようにしました。

`test/garbage/Makefile` -> `test/bench/garbage/Makefile` の変更

--- a/test/garbage/Makefile
+++ b/test/bench/garbage/Makefile
@@ -2,7 +2,7 @@
 # Use of this source code is governed by a BSD-style
 # license that can be found in the LICENSE file.
 
-include ../../src/Make.inc
+include ../../../src/Make.inc
 
 ALL=\
 	parser\

この変更は、Makefile内で参照されているMake.incへの相対パスを修正するものです。ディレクトリが1階層深くなったため、../../src/Make.incから../../../src/Make.incへとパスが変更されました。これにより、ベンチマークのビルドが引き続き正しく行われます。

`test/garbage/peano.go` -> `test/bench/garbage/peano.go` の変更

--- a/test/garbage/peano.go
+++ b/test/bench/garbage/peano.go
@@ -12,31 +12,25 @@ import (
 	"time"
 )
 
-
 type Number struct {
 	next *Number
 }
 
-
 // -------------------------------------
 // Peano primitives
 
 func zero() *Number { return nil }
 
-
 func is_zero(x *Number) bool { return x == nil }
 
-
 func add1(x *Number) *Number {
 	e := new(Number)
 	e.next = x
 	return e
 }
 
-
 func sub1(x *Number) *Number { return x.next }
 
-
 func add(x, y *Number) *Number {
 	if is_zero(y) {
 		return x
@@ -45,7 +39,6 @@ func add(x, y *Number) *Number {
 	return add(add1(x), sub1(y))
 }
 
-
 func mul(x, y *Number) *Number {
 	if is_zero(x) || is_zero(y) {
 		return zero()
@@ -54,7 +46,6 @@ func mul(x, y *Number) *Number {
 	return add(mul(x, sub1(y)), x)
 }
 
-
 func fact(n *Number) *Number {
 	if is_zero(n) {
 		return add1(zero())
@@ -63,7 +54,6 @@ func fact(n *Number) *Number {
 	return mul(fact(sub1(n)), n)
 }
 
-
 // -------------------------------------
 // Helpers to generate/count Peano integers
 
@@ -75,7 +65,6 @@ func gen(n int) *Number {
 	return zero()
 }
 
-
 func count(x *Number) int {
 	if is_zero(x) {
 		return 0
@@ -84,7 +73,6 @@ func count(x *Number) int {
 	return count(sub1(x)) + 1
 }
 
-
 func check(x *Number, expected int) {
 	var c = count(x)
 	if c != expected {
@@ -92,7 +80,6 @@ func check(x *Number, expected int) {
 	}
 }
 
-
 // -------------------------------------
 // Test basic functionality
 
@@ -117,7 +104,6 @@ func verify() {
 	check(fact(gen(5)), 120)
 }
 
-
 // -------------------------------------
 // Factorial

このファイルでは、機能的な変更は一切なく、単に複数の空行が削除されています。これはコードの整形であり、可読性の向上を目的としています。

`test/garbage/stats.go` -> `test/bench/garbage/stats.go` の変更

--- a/test/garbage/stats.go
+++ b/test/bench/garbage/stats.go
@@ -22,13 +22,14 @@ func gcstats(name string, n int, t int64) {
 	}
 	t1, t2, t3, t4, t5 := tukey5(st.PauseNs[0:nn])
 	fmt.Printf("garbage.%sPause5: %d %d %d %d %d\n", name, t1, t2, t3, t4, t5)
-	
-//	fmt.Printf("garbage.%sScan: %v\\n", name, st.ScanDist)\
+
+	//	fmt.Printf("garbage.%sScan: %v\\n", name, st.ScanDist)\
 }\
 
 type T []uint64\
-func (t T) Len() int { return len(t) }\
-func (t T) Swap(i, j int) { t[i], t[j] = t[j], t[i] }\
+\
+func (t T) Len() int           { return len(t) }\
+func (t T) Swap(i, j int)      { t[i], t[j] = t[j], t[i] }\
 func (t T) Less(i, j int) bool { return t[i] < t[j] }\
 \
 func tukey5(raw []uint64) (lo, q1, q2, q3, hi uint64) {

このファイルでは、Swapメソッドの定義が一行から複数行に整形され、コメントのインデントが修正されています。これも機能的な変更ではなく、コードの整形です。

`test/bench/shootout/timing.sh` の変更

--- a/test/bench/shootout/timing.sh
+++ b/test/bench/shootout/timing.sh
@@ -5,7 +5,7 @@
 
 set -e
 
-eval $(gomake --no-print-directory -f ../../src/Make.inc go-env)\
+eval $(gomake --no-print-directory -f ../../../src/Make.inc go-env)\
 PATH=.:$PATH
 
 havegccgo=false

この変更も、Makefileと同様にMake.incへの相対パスを修正するものです。test/bench/shootoutからsrcディレクトリへの相対パスが、test/bench/garbageの移動によって間接的に影響を受けたため、../../../src/Make.incへと変更されました。

参考にした情報源リンク

Go言語のテスト: https://go.dev/doc/tutorial/add-a-test
Go言語のベンチマーク: https://go.dev/doc/tutorial/write-a-benchmark
Go言語のガベージコレクション: https://go.dev/doc/gc-guide
Go言語のガベージコレクタの仕組み (外部記事): https://zenn.dev/spiegel/articles/20220801-go-gc-mechanism (日本語)
Go言語のガベージコレクタのチューニング (外部記事): https://future-architect.github.io/articles/20200907/ (日本語)

comemo