Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

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

このドキュメントは、Go言語の標準ライブラリtimeパッケージにおけるテストコードの改善に関するコミット489addd2250eca20608588197acc730cef23f9e9eについて、その技術的な詳細と背景を包括的に解説します。

コミット

  • コミットハッシュ: 489addd250eca20608588197acc730cef23f9e9e
  • 作者: Dmitriy Vyukov dvyukov@google.com
  • コミット日時: 2013年4月26日 金曜日 11:08:50 +0400
  • 変更ファイル: src/pkg/time/sleep_test.go
  • 変更概要: timeパッケージのテストにおいて、1ナノ秒タイマーを停止するように修正。

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

https://github.com/golang/go/commit/489addd250eca20608588197acc730cef23f9e9e

元コミット内容

time: stop 1ns timer in test

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

変更の背景

このコミットは、Go言語のtimeパッケージ内のsleep_test.goファイルにあるTestAfterStress関数におけるテストの改善を目的としています。元のコードでは、time.Tick(1)を使用して1ナノ秒間隔のタイマーを作成し、そのチャネルから100回読み取っていました。しかし、time.Tick関数は内部的にtime.NewTickerを使用していますが、Tickが返すチャネルは明示的に停止（Stop()）する手段を提供しません。これにより、テストが終了した後もタイマーがバックグラウンドで動作し続け、リソースを消費したり、テストの実行環境に予期せぬ影響を与えたりする可能性がありました。

特に、非常に短い間隔（1ナノ秒）でタイマーを動作させる場合、そのタイマーが適切にクリーンアップされないと、システムリソースの無駄遣いや、場合によってはテストの不安定性（例えば、テストスイート全体の実行時間に影響を与えるなど）につながる可能性があります。このコミットは、テストのクリーンアップを確実に行い、リソースリークを防ぐことを目的としています。

前提知識の解説

Go言語のtimeパッケージ

Go言語のtimeパッケージは、時間の測定、表示、およびタイマーやスケジューリング機能を提供します。主要な機能には以下のようなものがあります。

  • time.Duration: 時間の長さを表す型。ナノ秒単位で表現されます。
  • time.Sleep(d Duration): 指定された期間だけ現在のゴルーチンをスリープさせます。
  • time.Tick(d Duration): 指定された期間dごとにイベントを送信するチャネルを返します。この関数はNewTickerのラッパーですが、返されるチャネルは停止する手段を提供しません。
  • time.NewTicker(d Duration): 指定された期間dごとにイベントを送信する*Tickerオブジェクトを返します。Tickerオブジェクトは、イベントを送信するチャネルCと、タイマーを停止するためのStop()メソッドを持ちます。
  • Ticker.C: NewTickerが返す*Tickerオブジェクトのフィールドで、イベントが送信されるチャネルです。
  • Ticker.Stop(): Tickerによって開始されたタイマーを停止し、関連するリソースを解放します。Stopが呼び出された後、チャネルCは閉じられません。

ゴルーチンとチャネル

Go言語の並行処理の根幹をなすのがゴルーチンとチャネルです。

  • ゴルーチン (Goroutine): Goランタイムによって管理される軽量なスレッドです。goキーワードを使って関数呼び出しの前に置くことで、新しいゴルーチンとして実行されます。
  • チャネル (Channel): ゴルーチン間で値を安全に送受信するための通信メカニズムです。チャネルは型付けされており、特定の型の値のみを送受信できます。チャネルへの送信（ch <- value）と受信（<-ch）は、デフォルトで同期的な操作であり、これによりゴルーチン間の同期が容易になります。

atomicパッケージ

sync/atomicパッケージは、低レベルのアトミックな操作を提供します。これにより、ミューテックスなどのより高レベルな同期プリミティブを使用せずに、共有変数へのアクセスを安全に行うことができます。

  • atomic.StoreUint32(&addr, val uint32): addrが指すuint32型の変数にvalをアトミックに書き込みます。この操作は、他のゴルーチンからの読み書きと競合することなく安全に行われます。

技術的詳細

このコミットの核心は、time.Tickからtime.NewTickerへの変更と、それに伴うTicker.Stop()の明示的な呼び出しです。

time.Tickとtime.NewTickerの違い

  • time.Tick(d Duration): これは利便性のための関数であり、内部的にはNewTickerを呼び出してTicker.Cチャネルを返します。しかし、この関数はTickerオブジェクト自体を返さないため、作成されたタイマーを後から停止する手段がありません。これは、プログラムのライフサイクル全体でタイマーが必要な場合や、タイマーが自動的にガベージコレクションされることが期待される場合に便利ですが、短期間のタイマーや、明示的なリソース管理が必要な場合には不適切です。Tickによって作成されたタイマーは、参照されなくなるとガベージコレクションされますが、そのタイミングは保証されません。

  • time.NewTicker(d Duration): この関数は*time.Tickerオブジェクトを返します。このオブジェクトには、タイマーイベントを受信するチャネルCと、タイマーを停止するためのStop()メソッドが含まれています。Stop()を呼び出すことで、タイマーが使用していた内部リソース（例えば、タイマーイベントを生成するためのゴルーチン）を明示的に解放できます。これにより、リソースリークを防ぎ、プログラムの終了時にクリーンな状態を保つことができます。

TestAfterStress関数における問題点と解決策

TestAfterStress関数では、time.Tick(1)で1ナノ秒間隔のタイマーを作成し、そのチャネルから100回読み取っていました。このテストの目的は、非常に短い間隔でのタイマーの動作をストレス下で確認することです。しかし、100回の読み取りが完了した後も、Tick(1)によって作成されたタイマーはバックグラウンドで動作し続け、Stop()が呼び出されないため、関連するゴルーチンやリソースが解放されませんでした。

このコミットでは、以下の変更によってこの問題を解決しています。

  1. c := Tick(1)をticker := NewTicker(1)に変更。これにより、*time.Tickerオブジェクトが取得できるようになります。
  2. チャネルからの読み取りを<-cから<-ticker.Cに変更。これは、NewTickerが返すTickerオブジェクトのチャネルを使用するためです。
  3. ループの終了後にticker.Stop()を呼び出し。これにより、テストが完了した後にタイマーが明示的に停止され、関連するリソースが解放されることが保証されます。

この変更により、TestAfterStress関数はより堅牢になり、テスト実行後のリソースリークの可能性が排除されます。

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

--- a/src/pkg/time/sleep_test.go
+++ b/src/pkg/time/sleep_test.go
@@ -60,10 +60,11 @@ func TestAfterStress(t *testing.T) {
 		Sleep(Nanosecond)
 	}()
-	c := Tick(1)
+	ticker := NewTicker(1)
 	for i := 0; i < 100; i++ {
-\t\t<-c
+\t\t<-ticker.C
 	}
+\tticker.Stop()\n     	atomic.StoreUint32(&stop, 1)
 }

コアとなるコードの解説

  1. - c := Tick(1): 元のコードでは、time.Tick(1)を呼び出して、1ナノ秒間隔でイベントを送信するチャネルcを取得していました。前述の通り、TickはTickerオブジェクトを返さないため、タイマーを明示的に停止する手段がありませんでした。

  2. + ticker := NewTicker(1): 変更後のコードでは、time.NewTicker(1)を呼び出して、*time.Tickerオブジェクトをticker変数に格納しています。これにより、タイマーのチャネル（ticker.C）だけでなく、タイマーを制御するためのStop()メソッドも利用可能になります。

  3. - <-c: 元のコードでは、Tickが返したチャネルcからイベントを受信していました。

  4. + <-ticker.C: 変更後のコードでは、NewTickerが返したtickerオブジェクトのチャネルCからイベントを受信しています。機能的には同じですが、tickerオブジェクトを介してアクセスすることで、後続のStop()呼び出しが可能になります。

  5. + ticker.Stop(): これが最も重要な変更点です。forループが終了し、100回のタイマーイベントの受信が完了した後、ticker.Stop()が呼び出されます。この呼び出しにより、NewTickerによって内部的に起動されていたタイマーゴルーチンが停止され、関連するシステムリソースが解放されます。これにより、テストが終了した後もタイマーが不必要に動作し続けることがなくなり、リソースリークが防止されます。

この一連の変更により、TestAfterStress関数は、タイマーを適切に管理し、テストの実行後にクリーンアップを行う、より堅牢でリソース効率の良いテストになりました。

関連リンク

参考にした情報源リンク