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

このコミットは、Go言語の標準ライブラリ time パッケージにおける、time.Time 型の Unix() メソッドの振る舞いに関するバグ（Issue 7863）を修正するためのテストを追加するものです。具体的には、time.Time インスタンスから取得したメソッド値が、元のインスタンスの Unix() メソッドを直接呼び出した場合と同じ結果を返さないという問題が修正されました。

コミット

• コミットハッシュ: bd401baef2349e41d99280557bd5d709be78c894
• Author: Brad Fitzpatrick bradfitz@golang.org
• Date: Tue May 27 16:01:43 2014 -0700

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

https://github.com/golang/go/commit/bd401baef2349e41d99280557bd5d709be78c894

元コミット内容

test: add test for fixed issue 7863

Fixes #7863

LGTM=rsc
R=rsc, ruiu
CC=golang-codereviews
https://golang.org/cl/98610045

変更の背景

このコミットは、Go言語の time パッケージにおける、time.Time 型の Unix() メソッドに関する潜在的なバグ（Issue 7863）を修正したことを検証するためのテストコードを追加するものです。

time.Time 型は、特定の時点を表すために設計されており、そのインスタンスは不変（immutable）であると期待されます。つまり、一度作成された time.Time オブジェクトは、その時刻情報を変更することはありません。Unix() メソッドは、この time.Time インスタンスが表す時刻をUnixエポック（1970年1月1日UTC）からの秒数として返します。

問題は、time.Time インスタンスのメソッドを「メソッド値」として取得した場合に発生しました。Go言語では、t := time.Now(); f := t.Unix のように、構造体のメソッドを関数値として変数に代入することができます。この f は、レシーバ t にバインドされた Unix メソッドを表す関数です。期待される動作は、t.Unix() を直接呼び出す場合と f() を呼び出す場合で、常に同じ結果が得られることです。しかし、Issue 7863では、この期待が裏切られるケースがあったようです。

具体的なバグの詳細は、古いGoのIssueトラッカー（Google Code）に存在していたため、現在のGitHubのIssueトラッカーからは直接参照が難しいですが、テストコードから推測するに、time.Time の内部状態の取り扱い、特にメソッド値がレシーバの値をどのようにキャプチャし、利用するかという点に問題があったと考えられます。これにより、同じ time.Time インスタンスから得られた Unix() の値が、直接呼び出しとメソッド値経由の呼び出しで異なるという、不整合な状態が発生していました。

このコミットは、この不整合が修正されたことを確認するための回帰テストを追加することで、将来的に同様の問題が再発するのを防ぐことを目的としています。

前提知識の解説

Go言語の time パッケージ

time パッケージは、時刻の取得、操作、表示を行うための機能を提供します。

• time.Time 型: 特定の時点を表す構造体です。Go言語の設計思想に基づき、time.Time のインスタンスは不変であり、一度作成された時刻情報は変更されません。
• time.Now(): 現在のローカル時刻を time.Time 型で返します。通常、システムクロックの精度に応じてナノ秒単位の精度を持ちます。
• Time.Unix() メソッド: time.Time インスタンスが表す時刻を、Unixエポック（1970年1月1日00:00:00 UTC）からの経過秒数（int64 型）として返します。

Go言語のメソッド値 (Method Values)

Go言語では、構造体のメソッドを関数値として変数に代入することができます。これを「メソッド値」と呼びます。 例:

type MyStruct struct {
    value int
}

func (m MyStruct) GetValue() int {
    return m.value
}

func main() {
    m := MyStruct{value: 10}
    f := m.GetValue // GetValue メソッドをメソッド値として取得
    println(f())    // 10 が出力される
}

メソッド値 f は、レシーバ m にバインドされた GetValue メソッドを表す関数です。f を呼び出すと、m.GetValue() を呼び出すのと同じ効果が得られます。重要なのは、メソッド値が作成された時点でレシーバの値が「キャプチャ」されるという点です。つまり、f が呼び出される際には、m のその時点での値が使用されます。

不変性 (Immutability)

不変性とは、オブジェクトが一度作成されたらその状態を変更できない特性を指します。time.Time のような不変なオブジェクトは、並行処理環境での安全性が高く、予測可能な動作をします。もし time.Time が不変でなかった場合、あるゴルーチンが time.Time オブジェクトの Unix() メソッドを呼び出している間に、別のゴルーチンがそのオブジェクトの内部状態を変更してしまう可能性があり、予期せぬ結果を招くことがあります。

技術的詳細

Issue 7863の具体的な技術的詳細は、公式なバグ報告が参照できないため推測に頼る部分がありますが、テストコードから以下の点が考えられます。

now := time.Now() で time.Time インスタンス now が作成されます。この now は、その時点のシステム時刻を正確に保持しています。 次に f := now.Unix という行で、now インスタンスの Unix メソッドがメソッド値 f としてキャプチャされます。この f は、レシーバとして now を持つ Unix() メソッドの呼び出しをカプセル化したものです。

バグが発生していた状況では、now.Unix() と f() の結果が異なることがありました。これは、time.Time の不変性という設計原則に反する振る舞いです。考えられる原因としては、以下のようなものが挙げられます。

1. メソッド値のレシーバキャプチャの不備: f := now.Unix の際に、now の値が正しくキャプチャされていなかった、あるいは Unix メソッドが内部的に now 以外の、例えばグローバルな時刻情報源に依存してしまっていた可能性。
2. 内部状態の不整合: time.Time 構造体の内部に、Unix秒を計算するためのキャッシュのようなものが存在し、それがメソッド値経由の呼び出しで正しく更新または利用されていなかった可能性。
3. コンパイラ最適化の誤り: 非常に稀なケースですが、コンパイラが now.Unix のようなメソッド値の生成や呼び出しを最適化する際に、誤ったコードを生成し、結果的に不整合な値が返されることがあった可能性。

このバグは、time.Time の基本的な契約である「不変性」と「メソッド値の正確な動作」に影響を与えるものであり、Goプログラムの時刻処理の信頼性を損なう可能性がありました。修正は、おそらく time パッケージの内部実装、特に Unix() メソッドやメソッド値の生成に関する部分で行われたと考えられます。これにより、time.Time インスタンスから得られる Unix 秒が、どのような方法で呼び出されても一貫していることが保証されるようになりました。

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

このコミットで追加されたテストファイルは以下の通りです。

test/fixedbugs/issue7863.go

// run

// Copyright 2014 The Go Authors.  All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package main

import "time"

func main() {
	now := time.Now()
	f := now.Unix
	if now.Unix() != f() {
		println("BUG: ", now.Unix(), "!=", f())
	}
}

コアとなるコードの解説

追加された test/fixedbugs/issue7863.go は、Goのテストスイートの一部として実行される「run」テストです。この種のテストは、特定のコードが期待通りに動作するかどうかを検証するために、コンパイルして実行されます。

テストコードの核心部分は以下の通りです。

1. now := time.Now(): 現在の時刻を表す time.Time 型の変数 now を作成します。
2. f := now.Unix: now インスタンスの Unix メソッドをメソッド値として変数 f に代入します。この f は、now にバインドされた Unix() メソッドの呼び出しを表す関数です。
3. if now.Unix() != f(): ここがテストの肝となる部分です。
   • now.Unix(): now インスタンスの Unix() メソッドを直接呼び出し、その時点でのUnix秒を取得します。
   • f(): メソッド値 f を呼び出します。これは、now にバインドされた Unix() メソッドの呼び出しと同じ効果を持つはずです。
   • この if 文は、直接呼び出しの結果とメソッド値経由の呼び出しの結果が異なる場合に真となります。
4. println("BUG: ", now.Unix(), "!=", f()): もし now.Unix() と f() の結果が異なれば、この println が実行され、テストは失敗とみなされます。これは、バグがまだ存在することを示します。

このテストの目的は、time.Time インスタンスの Unix() メソッドが、直接呼び出された場合でも、メソッド値としてキャプチャされてから呼び出された場合でも、常に同じUnix秒を返すことを保証することです。このテストが追加された時点でバグは修正済みであったため、このテストは常に成功し、将来的に同様の回帰バグが発生しないことを保証します。

関連リンク

• GitHubコミットページ: https://github.com/golang/go/commit/bd401baef2349e41d99280557bd5d709be78c894
• Go言語 time パッケージドキュメント: https://pkg.go.dev/time (一般的な情報源として)

参考にした情報源リンク

• Go言語の公式ドキュメント (time パッケージ): https://pkg.go.dev/time
• Go言語のメソッド値に関する一般的な情報 (Go言語の仕様やチュートリアルなど)
• Go言語のIssueトラッカーの一般的な構造に関する知識