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

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

このコミットは、Go言語の初期のioパッケージ内のByteBuffer型に関するバグ修正です。具体的には、src/lib/io/bytebuffer.goファイルが変更されています。

コミット

commit a10267adcdd40093cb2c9d8a470194332b947b86
Author: Rob Pike <r@golang.org>
Date:   Tue Dec 16 13:01:39 2008 -0800

    If ByteBuffer has never been used, b.buf is nil but Data() should still work.
    Fix the bug using a (safe) shared global empty array.
    
    R=rsc
    DELTA=8  (8 added, 0 deleted, 0 changed)
    OCL=21303
    CL=21303

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

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

元コミット内容

ByteBufferが一度も使用されていない場合、b.bufはnilですが、Data()メソッドはそれでも機能するべきです。このバグを、（安全な）共有グローバル空配列を使用して修正します。

変更の背景

Go言語の初期のByteBuffer実装において、新しいByteBufferインスタンスが作成された直後、つまりデータが一度も書き込まれていない状態では、内部のバッファ（b.buf）がnilになっていました。この状態でData()メソッドを呼び出すと、nilスライスに対してスライス操作を行おうとするため、ランタイムパニックや予期せぬ動作を引き起こす可能性がありました。

Data()メソッドの期待される振る舞いは、バッファが空であっても、有効な（ただし長さが0の）バイトスライスを返すことです。これは、Go言語におけるスライスの慣習、特にbytes.Bufferのような標準ライブラリの振る舞いと一致させるためにも重要でした。nilスライスと空スライスは異なる概念であり、多くのGoのAPIは空の状態を表すためにnilではなく空スライスを返します。

このコミットは、この初期化時のnilバッファの問題を解決し、ByteBufferが常に堅牢な振る舞いをするようにするためのものです。

前提知識の解説

Go言語におけるスライスとnil

Go言語のスライスは、配列の一部を参照する軽量なデータ構造です。スライスは、ポインタ、長さ（len）、容量（cap）の3つの要素で構成されます。

  • nilスライス: スライスのゼロ値はnilです。nilスライスは、基になる配列を持たず、長さも容量も0です。var s []intのように宣言されたスライスはnilスライスになります。nilスライスは、有効なスライスであり、多くの操作（len(s)、cap(s)、for range sなど）を安全に行うことができます。
  • 空スライス: 長さが0のスライスは空スライスと呼ばれます。これはmake([]int, 0)や[]int{}のように作成できます。空スライスは基になる配列を持つ場合と持たない場合がありますが、長さは常に0です。

重要な違いは、nilスライスは「存在しない」ことを意味するのに対し、空スライスは「存在するが、要素がない」ことを意味するという点です。多くのGoの関数やメソッドは、結果がない場合にnilではなく空スライスを返します。これは、呼び出し側がnilチェックをせずにループ処理などを行えるようにするためです。

ByteBuffer (Go言語初期のI/Oバッファ)

このコミットが対象としているByteBufferは、Go言語の初期に存在したI/Oバッファリングのための型です。現在のGoの標準ライブラリでは、同様の機能は主にbytes.Buffer型によって提供されています。ByteBufferは、バイトデータを効率的に読み書きするための内部バッファを管理していました。

ByteBufferの内部には、バイトデータを保持するためのスライス（このコミットではb.bufと記述されている）と、読み書きのオフセットや長さを示すフィールドがありました。

技術的詳細

このバグは、ByteBufferが初期化された直後、つまりWriteメソッドなどでデータが一度も追加されていない状態では、内部のb.bufフィールドがnilであることに起因していました。Data()メソッドは、このb.bufスライスに対してスライス操作（b.buf[b.off:b.len]）を行っていましたが、nilスライスに対してスライス操作を行うとランタイムパニックが発生します。

修正の核心は、Data()メソッドが呼び出された際にb.bufがnilであるかどうかをチェックし、もしnilであれば、代わりに共有のグローバルな空バイトスライスを返すようにすることです。

導入されたEmptyByteArrayは、new([]byte, 0)によって作成されます。これは、長さと容量が0の新しいバイトスライスへのポインタを返します。このスライス自体は不変（immutable）であり、共有しても安全です。なぜなら、このスライスを介してデータを追加したり変更したりすることはできないため、複数のByteBufferインスタンスが同じ空スライスを参照しても競合状態が発生しないからです。

このアプローチにより、ByteBufferが初期状態であってもData()メソッドは常に有効な（長さ0の）スライスを返し、呼び出し側はnilチェックをすることなく、返されたスライスを安全に扱うことができるようになります。これは、Go言語のイディオムに沿った堅牢な設計です。

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

--- a/src/lib/io/bytebuffer.go
+++ b/src/lib/io/bytebuffer.go
@@ -75,7 +75,15 @@ func (b *ByteBuffer) Len() int {
 	return b.len
 }
 
+// If the buffer is empty, Data() should still give a valid array.
+// Use this variable as a surrogate.  It's immutable (can't be
+// grown, can't store any data) so it's safe to share.
+var EmptyByteArray = new([]byte, 0)
+
 func (b *ByteBuffer) Data() *[]byte {
+	if b.buf == nil {
+		return EmptyByteArray
+	}
 	return b.buf[b.off:b.len]
 }

コアとなるコードの解説

  1. var EmptyByteArray = new([]byte, 0):

    • EmptyByteArrayというグローバル変数が導入されました。
    • new([]byte, 0)は、長さと容量が0の新しいバイトスライスを指すポインタを作成します。このスライス自体は、要素を持たないため、不変（immutable）と見なすことができます。
    • この変数は、ByteBufferが空で内部バッファがnilの場合にData()メソッドが返す「代替」の空スライスとして機能します。グローバルに共有することで、メモリの無駄を省き、毎回新しい空スライスを作成するオーバーヘッドを避けています。

  2. func (b *ByteBuffer) Data() *[]byte { ... }:

    • Data()メソッドの冒頭にif b.buf == nilという条件分岐が追加されました。
    • これは、ByteBufferの内部バッファb.bufがnilであるかどうかをチェックします。b.bufがnilであるのは、ByteBufferが初期化されたばかりで、まだデータが書き込まれていない状態です。
    • もしb.bufがnilであれば、return EmptyByteArrayが実行され、事前に定義されたグローバルな空バイトスライスが返されます。これにより、nilスライスに対する不正な操作を防ぎます。
    • b.bufがnilでない場合（つまり、データが書き込まれているか、少なくともバッファが初期化されている場合）は、以前と同様にreturn b.buf[b.off:b.len]が実行され、内部バッファの適切な部分がスライスとして返されます。

この変更により、ByteBufferのData()メソッドは、バッファが空の状態であっても常に有効な（長さ0の）バイトスライスを返すようになり、より堅牢で予測可能な振る舞いをするようになりました。

関連リンク

参考にした情報源リンク

  • コミットデータ: /home/orange/Project/comemo/commit_data/1351.txt
  • Go言語におけるスライスとnilの概念に関する一般的な知識
  • Go言語のbytes.Bufferの振る舞いに関する一般的な知識
  • Web検索: "Go ByteBuffer nil Data() early implementation" (Go言語の初期のByteBuffer実装におけるnilの扱いに関する情報収集)