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

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

このコミットは、Go言語の標準ライブラリlog/syslogパッケージに、Plan 9オペレーティングシステム向けのスタブファイルsyslog_plan9.goを追加するものです。このファイルは、Plan 9における適切なシステムログのセマンティクスがまだ実装されていないための一時的なプレースホルダーとして機能します。

コミット

log/syslog: Plan 9 用のスタブを追加

Plan 9 用の適切なローカルシステムログのセマンティクスはまだ作成されていません。 その間、テストスイート (具体的には exp/gotype) は、各インポートパスに何らかの Go ソースが存在することを期待しています。 したがって、この目的のために、syslog_windows と同等のスタブがここにあります。

R=golang-dev, rsc, alex.brainman CC=golang-dev https://golang.org/cl/7000062

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

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

元コミット内容

commit 5bcb9707b63c12bbd6ab6dd8f0913b2518b83531
Author: Akshat Kumar <seed@mail.nanosouffle.net>
Date:   Thu Dec 27 11:45:03 2012 +1100

    log/syslog: add stub for Plan 9
    
    Proper local system log semantics still need to be
    created for Plan 9. In the meantime, the test suite
    (viz., exp/gotype) expects there to be some Go
    source for each import path. Thus, here is a stub,
    equivalent to syslog_windows, for this purpose.
    
    R=golang-dev, rsc, alex.brainman
    CC=golang-dev
    https://golang.org/cl/7000062
---
 src/pkg/log/syslog/syslog_plan9.go | 8 ++++++++\n 1 file changed, 8 insertions(+)

diff --git a/src/pkg/log/syslog/syslog_plan9.go b/src/pkg/log/syslog/syslog_plan9.go
new file mode 100644
index 0000000000..0c05f6f83c
--- /dev/null
+++ b/src/pkg/log/syslog/syslog_plan9.go
@@ -0,0 +1,8 @@
+// Copyright 2012 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 syslog provides a simple interface to the system log service.
+package syslog
+
+// BUG(akumar): This package is not implemented on Plan 9 yet.

変更の背景

この変更の主な背景は、Go言語のlog/syslogパッケージがPlan 9オペレーティングシステム上で完全に機能するシステムログセマンティクスをまだ持っていないという点にあります。しかし、Goのテストスイート（特にexp/gotype）は、インポートパスごとに対応するGoソースファイルが存在することを期待しています。

この期待に応えるため、そしてビルドやテストのプロセスが中断されないようにするために、一時的な措置としてPlan 9向けのスタブファイルが追加されました。このスタブは、機能的には何も提供しませんが、コンパイラやツールが期待するファイルが存在することで、依存関係の解決やテストの実行を可能にします。コミットメッセージにあるように、これはsyslog_windows.goのような、特定のOSでまだ完全な実装がない場合のプレースホルダーと同様の役割を果たします。

前提知識の解説

Plan 9 from Bell Labs

Plan 9 from Bell Labsは、ベル研究所で開発された分散オペレーティングシステムです。Unixの後継として設計され、ネットワーク透過性、リソースのファイルシステムとしての表現（"Everything is a file"）、UTF-8の採用など、革新的なコンセプトを多数導入しました。Go言語の開発者の一部（Rob Pike, Ken Thompsonなど）はPlan 9の開発にも深く関わっており、Go言語の設計思想にもPlan 9の影響が見られます。しかし、Plan 9は一般的なOSとは異なる設計思想を持つため、既存のソフトウェアを移植する際には、そのOS固有のシステムコールやAPIに対応する特別な実装が必要となる場合があります。

Syslog

Syslogは、システムメッセージやイベントログを記録するための標準的なプロトコルです。Unix系OSやネットワーク機器などで広く利用されており、アプリケーションやシステムプロセスが生成するログメッセージを一元的に収集・管理するために使われます。Go言語のlog/syslogパッケージは、このSyslogプロトコルを通じてシステムログサービスと連携するためのインターフェースを提供します。これにより、Goアプリケーションからシステムログにメッセージを送信できるようになります。

Go言語におけるOS固有の実装とビルドタグ

Go言語はクロスプラットフォーム開発を強力にサポートしていますが、特定のOSに依存する機能（例: システムログ、ネットワークインターフェースなど）については、OSごとに異なる実装を提供する必要があります。Goでは、ファイル名にOS名を付加する慣習（例: _windows.go, _linux.go, _darwin.go）や、ビルドタグ（// +build linuxなど）を使用して、特定のOSでのみコンパイルされるコードを記述できます。これにより、単一のパッケージ内で複数のOSに対応した実装を共存させることが可能になります。

このコミットで追加されたsyslog_plan9.goは、まさにこのOS固有の実装の慣習に従ったものです。ファイル名が_plan9.goとなっていることで、GoツールチェインはこれをPlan 9環境でのみビルド対象と認識します。

スタブ (Stub)

ソフトウェア開発におけるスタブとは、まだ完全に実装されていない機能やモジュールの代わりに、一時的に置かれる最小限の機能を持つプレースホルダーのことです。スタブは、実際の機能がなくても、そのインターフェース（関数シグネチャなど）を満たすことで、依存する他のモジュールのコンパイルやテストを可能にします。このコミットにおけるsyslog_plan9.goは、Plan 9向けのSyslog実装が未完成であるため、コンパイルエラーを回避し、テストスイートの要件を満たすためのスタブとして機能しています。

技術的詳細

このコミットは、Go言語のクロスプラットフォーム対応における一般的なパターンを示しています。Goの標準ライブラリは、様々なオペレーティングシステムで動作するように設計されていますが、OS固有の機能（この場合はシステムログサービス）にアクセスする必要がある場合、そのOSに特化した実装が必要になります。

log/syslogパッケージは、Unix系システムでは/dev/logのようなUnixドメインソケットやUDPポート514を介してSyslogデーモンと通信しますが、Plan 9では異なるメカニズムが使用される可能性があります。このコミットの時点では、Plan 9向けのSyslog通信メカニズムがGoでまだ実装されていなかったため、コンパイルエラーやリンケージエラーを防ぐために、空のスタブファイルが導入されました。

syslog_plan9.goファイルは、log/syslogパッケージの一部として、Plan 9環境でビルドされる際に、他のOS固有のファイル（例: syslog_unix.goやsyslog_windows.go）の代わりに選択されます。このファイルには、syslogパッケージが提供するはずの関数や型の定義が含まれていませんが、Goのビルドシステムは、パッケージ内にsyslog_plan9.goという名前のファイルが存在すること自体を認識し、コンパイルを続行します。

コメントアウトされたBUG(akumar): This package is not implemented on Plan 9 yet.という行は、このスタブが一時的なものであり、将来的に完全な実装が必要であることを開発者に示しています。これは、Goのソースコード内でよく見られる慣習で、既知の制限や未実装の機能を示すために使用されます。

このアプローチは、開発の初期段階や、特定のプラットフォームでのサポートがまだ完全ではない場合に、コードベース全体の整合性を保ちつつ、他のプラットフォームでの開発やテストを継続するための実用的な解決策となります。

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

このコミットによって追加されたファイルは以下の通りです。

src/pkg/log/syslog/syslog_plan9.go

--- /dev/null
+++ b/src/pkg/log/syslog/syslog_plan9.go
@@ -0,0 +1,8 @@
+// Copyright 2012 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 syslog provides a simple interface to the system log service.
+package syslog
+
+// BUG(akumar): This package is not implemented on Plan 9 yet.

この差分は、syslog_plan9.goという新しいファイルが追加されたことを示しています。ファイルの内容は非常にシンプルで、Goのパッケージ宣言とコメントのみで構成されています。

コアとなるコードの解説

追加されたsyslog_plan9.goファイルは、以下の要素で構成されています。

  1. 著作権表示:

    // Copyright 2012 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.

    これはGo言語の標準ライブラリの慣習に従った著作権表示です。BSDスタイルのライセンスが適用されることを示しています。

  2. パッケージコメント:

    // Package syslog provides a simple interface to the system log service.

    この行は、syslogパッケージの目的を説明するパッケージコメントです。このコメントは、go docコマンドなどでパッケージのドキュメントを生成する際に表示されます。

  3. パッケージ宣言:

    package syslog

    この行は、このファイルがsyslogパッケージの一部であることを宣言しています。これにより、Goのビルドシステムは、このファイルをlog/syslogパッケージのコンポーネントとして認識します。

  4. BUGコメント:

    // BUG(akumar): This package is not implemented on Plan 9 yet.

    これはGoのソースコードでよく使われる特殊なコメント形式です。BUG(担当者名):という形式で記述され、特定の機能が未実装であることや、既知のバグ、制限事項などを明示的に示します。この場合、akumarというユーザーが担当者であり、Plan 9向けのsyslogパッケージがまだ実装されていないことを示しています。これは、将来的な開発のためのリマインダーとして機能します。

このファイルには、syslogパッケージが通常提供するはずの関数（例: Dial, New, Writeなど）や構造体は一切含まれていません。これは、前述の通り、Plan 9向けの完全な実装がまだ存在しないため、コンパイルエラーを回避するための最小限のスタブとして機能しているためです。

関連リンク

参考にした情報源リンク