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

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

このコミットは、Go 1.2のリリースノートである doc/go1.2.html に、os/exec パッケージの Cmd.StdinPipe メソッドの変更点に関する記述を追加するものです。具体的には、StdinPipe が返す io.WriteCloser の具象型が変更され、それによって以前存在した競合状態が解消されたこと、および *os.File のメソッドにアクセスするための型アサーションの方法について言及しています。

コミット

  • コミットハッシュ: d851c6d478fc68d88ac192ad9499726c9e393c8f
  • Author: Andrew Gerrand adg@golang.org
  • Date: Mon Sep 23 15:14:26 2013 +1000
  • コミットメッセージ: 
    doc: mention os/exec StdinPipe change in Go 1.2 doc

Fixes #6439.

R=r, minux.ma
CC=golang-dev
https://golang.org/cl/13478045

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

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

元コミット内容

doc: mention os/exec StdinPipe change in Go 1.2 doc

Fixes #6439.

R=r, minux.ma
CC=golang-dev
https://golang.org/cl/13478045

変更の背景

Go 1.2より前のバージョンでは、os/exec パッケージの Cmd.StdinPipe メソッドが返す io.WriteCloser の具象型が *os.File でした。この仕様には、パイプを閉じる際に避けられない競合状態（race condition）が存在していました。具体的には、StdinPipe から取得したパイプを Close() した際に、子プロセスがまだパイプから読み取りを完了していない場合、デッドロックや予期せぬ動作が発生する可能性がありました。

このコミットは、Go 1.2での Cmd.StdinPipe の内部実装変更に伴い、その変更内容とユーザーへの影響を公式ドキュメント (doc/go1.2.html) に明記するために行われました。実装変更により、StdinPipe が返す型が *os.File から、*os.File を埋め込んだ非公開型に変更され、これによりパイプのクローズ時の競合状態が解消されました。この重要な変更をユーザーに周知し、既存のコードが新しい動作に適切に対応できるよう情報を提供することが目的です。

前提知識の解説

os/exec パッケージ

os/exec パッケージは、外部コマンドを実行するための機能を提供します。exec.Command 関数でコマンドを構築し、Cmd 型のインスタンスを通じてその実行を制御します。標準入力 (stdin)、標準出力 (stdout)、標準エラー (stderr) のリダイレクトや、プロセスの開始・終了の待機などが可能です。

Cmd.StdinPipe() メソッド

Cmd.StdinPipe() メソッドは、実行する外部コマンドの標準入力にデータを書き込むためのパイプを返します。このメソッドは io.WriteCloser インターフェースを実装した値を返します。ユーザーはこのパイプにデータを書き込み、書き込みが完了したら Close() メソッドを呼び出してパイプを閉じます。

io.WriteCloser インターフェース

io.WriteCloser インターフェースは、io.Writer インターフェースと io.Closer インターフェースを組み合わせたものです。

  • io.Writer: Write(p []byte) (n int, err error) メソッドを持ち、バイトスライスを書き込む機能を提供します。
  • io.Closer: Close() error メソッドを持ち、リソースを閉じます。

*os.File 型

*os.File は、ファイルディスクリプタをラップしたGoの型で、ファイルやパイプなどのI/O操作を行うためのメソッド（Read, Write, Close, Sync など）を提供します。

競合状態 (Race Condition)

競合状態とは、複数のゴルーチン（またはスレッド）が共有リソースに同時にアクセスし、そのアクセス順序によってプログラムの最終結果が非決定的に変わってしまう状態を指します。Cmd.StdinPipe の以前の実装では、親プロセスがパイプを閉じようとするタイミングと、子プロセスがパイプから読み取りを完了するタイミングとの間に競合状態が存在し、これが問題を引き起こす可能性がありました。

型アサーション (Type Assertion)

Goにおける型アサーションは、インターフェース型の値が特定の具象型であるかどうかをチェックし、もしそうであればその具象型の値として取り出すための構文です。例えば、value.(Type) の形式で記述します。これは、インターフェースが提供するメソッド以外に、具象型が持つ特定のメソッドにアクセスしたい場合に利用されます。

技術的詳細

Go 1.2における os/exec.Cmd.StdinPipe の変更は、主に以下の点に集約されます。

  1. 具象型の変更: Go 1.2より前では、Cmd.StdinPipe は *os.File 型の値を io.WriteCloser インターフェースとして返していました。これは、ユーザーが返された io.WriteCloser を *os.File に型アサートし、Sync() などの *os.File 固有のメソッドを呼び出すことが可能であることを意味します。 Go 1.2からは、Cmd.StdinPipe は *os.File を直接返すのではなく、*os.File を埋め込んだ非公開型の値を io.WriteCloser として返すようになりました。この非公開型は、os/exec パッケージ内部でのみ定義されており、外部からは直接アクセスできません。

  2. 競合状態の解消: 以前の *os.File を直接返す実装では、親プロセスが StdinPipe を Close() した際に、子プロセスがまだパイプからデータを読み取っている最中であると、デッドロックや予期せぬエラーが発生する競合状態がありました。これは、*os.File の Close メソッドが、ファイルディスクリプタを即座に閉じてしまうためです。 新しい非公開型は、Close() メソッドの内部で、子プロセスがパイプからの読み取りを完了するまで待機するロジック（またはそれに類する同期メカニズム）を実装することで、この競合状態を解消しました。これにより、StdinPipe から返された値を安全に Close() できるようになりました。

  3. *os.File メソッドへのアクセス: 具象型が非公開になったため、以前のように pipe.(*os.File) のように直接 *os.File に型アサートすることはできなくなりました。しかし、Sync() のような *os.File が持つ特定のメソッドにアクセスしたい場合、ドキュメントに記載されているように、インターフェース型アサーションを使用することができます。 例: wc.(interface{ Sync() error }) これは、wc が Sync() error メソッドを持つ任意の型であるかどうかをチェックし、もしそうであればそのインターフェース型として値を取り出すものです。これにより、*os.File の具体的な型を知らなくても、その特定のメソッドを呼び出すことが可能になります。このアプローチは、Goのインターフェースの柔軟性を活用したもので、具象型に依存しないコードを書くことを推奨しています。

この変更は、os/exec パッケージの堅牢性を高め、外部コマンドとの連携における一般的な落とし穴を解消することを目的としています。

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

このコミットによるコードの変更は、doc/go1.2.html ファイルへの追加のみです。

--- a/doc/go1.2.html
+++ b/doc/go1.2.html
@@ -823,6 +823,17 @@ are absorbed by the
 and the client receives an empty body as required by the HTTP specification.
 </li>
 
+<li>
+The <a href="/pkg/os/exec/"><code>os/exec</code></a> package's 
+<a href="/pkg/os/exec/#Cmd.StdinPipe"><code>Cmd.StdinPipe</code></a> method 
+returns an <code>io.WriteCloser</code>, but has changed its concrete
+implementation from <code>*os.File</code> to an unexported type that embeds
+<code>*os.File</code>, and it is now safe to close the returned value.
+Before Go 1.2, there was an unavoidable race that this change fixes.
+Code that needs access to the methods of <code>*os.File</code> can use an
+interface type assertion, such as <code>wc.(interface{ Sync() error })</code>.
+</li>
+
 <li>
 The <a href="/pkg/runtime/"><code>runtime</code></a> package relaxes
 the constraints on finalizer functions in

コアとなるコードの解説

追加されたHTMLスニペットは、Go 1.2のリリースノートの一部として、os/exec パッケージの Cmd.StdinPipe メソッドに関する重要な変更点を説明しています。

  • os/exec パッケージと Cmd.StdinPipe メソッドへの言及: The <code>os/exec</code> package's <code>Cmd.StdinPipe</code> method これは、変更が os/exec パッケージ内の Cmd.StdinPipe メソッドに関連していることを明確に示しています。

  • 戻り値の型の変更: returns an <code>io.WriteCloser</code>, but has changed its concrete implementation from <code>*os.File</code> to an unexported type that embeds <code>*os.File</code> この部分が最も重要な変更点です。StdinPipe は引き続き io.WriteCloser を返しますが、その内部的な具象型が *os.File から、*os.File を埋め込んだ非公開型に変更されたことを説明しています。これにより、外部から直接 *os.File として扱えなくなります。

  • 競合状態の解消: and it is now safe to close the returned value. Before Go 1.2, there was an unavoidable race that this change fixes. この変更によって、返された io.WriteCloser を安全に Close() できるようになったことが強調されています。Go 1.2より前には、この Close() 操作に伴う避けられない競合状態が存在し、この変更がそれを修正したと明記されています。

  • *os.File メソッドへのアクセス方法: Code that needs access to the methods of <code>*os.File</code> can use an interface type assertion, such as <code>wc.(interface{ Sync() error })</code>. 具象型が非公開になったため、*os.File 固有のメソッド（例: Sync()) にアクセスしたい場合の新しい推奨される方法が示されています。それは、interface{ Sync() error } のようなインターフェース型アサーションを使用することです。これにより、特定のメソッドを持つインターフェースとして値を取り出し、そのメソッドを呼び出すことができます。

このドキュメントの追加は、Go 1.2へのアップグレードを検討している開発者に対して、os/exec を使用する既存のコードベースで潜在的な変更が必要になる可能性があることを警告し、新しい安全な使用方法を案内する役割を果たします。

関連リンク

参考にした情報源リンク