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

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

このコミットは、Go言語のドキュメンテーションツールであるgodocの内部的なファイルシステムバインディングに関する重要な修正です。具体的には、godocがGoのソースコードやドキュメンテーションをzipアーカイブから提供する際に、そのコンテンツをGoのインストールルートディレクトリ（*goroot）を基準としたパスにバインドするように変更することで、godocがGoの標準的なファイル構造を正しく解釈し、コンテンツを正確に提供できるようにしています。

コミット

  • コミットハッシュ: 181dc14cd63dd364efaa4d6f7a6af7f3892cc83a
  • 作者: Andrew Gerrand adg@golang.org
  • コミット日時: 2012年3月15日 木曜日 11:31:16 +1100
  • コミットメッセージ: cmd/godoc: use *goroot as base path in zip file

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

https://github.com/golang/go/commit/181dc14cd63dd364efaa4d6f7a6af7f3892cc83a

元コミット内容

cmd/godoc: use *goroot as base path in zip file

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

変更の背景

godocは、Go言語のソースコードからドキュメントを生成し、それをWebサーバーとして公開するツールです。Goの標準ライブラリやユーザーのプロジェクトのドキュメントをブラウザで閲覧する際に利用されます。godocは、Goのインストールディレクトリ（GOROOT環境変数で指定されるパス）内のファイルを読み込み、Webサーバーとして公開します。

Goの配布形態によっては、godocがGoのソースコードやドキュメントを、通常のファイルシステムではなく、単一のzipアーカイブファイルとして内部に持つ場合があります。このような場合、godocはzipファイルの内容を仮想的なファイルシステムとして扱い、そこからコンテンツを提供する必要があります。

このコミット以前の実装では、godocがzipファイルからコンテンツを読み込む際、zipファイル内のルートパス（/）を、godocが公開するWebサーバーのルートパス（/）に直接バインドしていました。しかし、godocの内部ロジックは、Goのソースコードやドキュメントが$GOROOT/srcや$GOROOT/docといったGOROOTからの相対パスに配置されていることを前提としています。

例えば、zipファイル内にsrc/fmt/print.goというファイルがあったとします。

  • 変更前は、このファイルはWebサーバー上では/src/fmt/print.goとしてアクセスされることになります。
  • しかし、godocの内部処理が$GOROOT/src/fmt/print.go（例: /usr/local/go/src/fmt/print.go）のような絶対パスを解決しようとした場合、zipファイルの内容がWebサーバーのルートにマッピングされているだけでは、このGOROOTを基準としたパス解決が正しく行えませんでした。

この不整合により、godocがzipファイルから提供されるGoのソースコードやドキュメントを正しく見つけられない、または内部的なパス解決が期待通りに機能しないという問題が発生していました。

このコミットは、zipファイル内のコンテンツを*goroot（godocが認識するGoのインストールルートパス）を基準としてバインドすることで、godocの内部的なファイルシステムビューと、Goの標準的なディレクトリ構造との整合性を確保し、コンテンツの正確な提供を可能にすることを目的としています。

前提知識の解説

  • godoc: Go言語の公式ドキュメンテーションツールであり、Webサーバー機能も内蔵しています。Goのソースコードからコメントを解析してドキュメントを生成し、それをWebブラウザで閲覧できるようにします。Goのインストール時に同梱されており、開発者がGoの標準ライブラリや自身のプロジェクトのドキュメントを参照する際に広く利用されます。
  • fs.Bind: godocの内部で利用されるファイルシステム抽象化レイヤーの一部です。これは、あるファイルシステム（この場合はNewZipFSによって作成されたzipファイルシステム）の特定のパスを、別のファイルシステム（この場合はgodocが公開する仮想ファイルシステム）の特定のパスに「バインド」（マウント）する機能を提供します。これにより、異なる物理的な場所にあるファイルを、アプリケーションからは統一された論理的なパスでアクセスできるようになります。
  • NewZipFS(rc, zipFilename): godocがzipアーカイブファイルからコンテンツを読み込むためのファイルシステム実装を生成する関数です。rcはzipファイルのリーダー（io.ReadCloser）、zipFilenameはzipファイルのパスを指します。この関数が返すオブジェクトは、zipファイル内のエントリをファイルやディレクトリとして扱うためのfs.FileSystemインターフェースを実装しています。
  • *goroot: Goプログラム内でGoのインストールルートディレクトリのパスを指す変数（またはコマンドラインフラグ）です。godocのようなツールは、このパスを基準としてGoの標準ライブラリのソースコードやドキュメントを探します。通常、環境変数GOROOTの値が使用されます。
  • ファイルシステムバインディングの概念: 複数の異なるファイルシステム（例: 実際のディスク上のファイルシステム、メモリ上の仮想ファイルシステム、zipファイル内のファイルシステム）を、単一の統一されたファイルシステムツリーとして扱うための技術です。これにより、アプリケーションはファイルがどこに保存されているかを意識することなく、論理的なパスでアクセスできます。これは、Unix/Linuxにおけるmountコマンドの概念に似ています。

技術的詳細

このコミットの核心は、src/cmd/godoc/appinit.goファイル内のfs.Bind関数の第3引数の変更です。

変更前: fs.Bind("/", NewZipFS(rc, zipFilename), "/", bindReplace)

変更後: fs.Bind("/", NewZipFS(rc, zipFilename), *goroot, bindReplace)

このfs.Bind関数の引数は以下の意味を持ちます。

  1. 第1引数 ("/"): これは、NewZipFSによって提供されるzipファイルシステム内の「ソース」パスを示します。つまり、zipファイルシステム全体のルート（/）を対象とします。
  2. 第2引数 (NewZipFS(rc, zipFilename)): これは、バインドされる「ソース」ファイルシステムそのものです。ここでは、指定されたzipファイルの内容をファイルシステムとして扱います。
  3. 第3引数 ("/" から *goroot への変更): これが最も重要な変更点であり、バインディングの「ターゲット」パスを示します。これは、godocが公開するWebサーバーの仮想ファイルシステム内で、zipファイルの内容がどこにマウントされるかを指定します。
    • 変更前の"/": zipファイルシステム内のルートパスを、godocが公開するWebサーバーのルートパス（/）に直接バインドすることを意味していました。この設定では、zipファイル内のsrc/fmt/print.goはWebサーバー上では/src/fmt/print.goとしてアクセスされます。
    • 変更後の*goroot: zipファイルシステム内のルートパスを、godocが認識するGoのインストールルートパス（例: /usr/local/goやC:\Go）にバインドすることを意味します。これにより、zipファイル内のコンテンツが、あたかも実際のGOROOTディレクトリに存在するかのように扱われます。例えば、zipファイル内にsrc/fmt/print.goというパスのファイルがあった場合、godocはそれを内部的に$GOROOT/src/fmt/print.goとして解決し、Webサーバー上でもhttp://localhost:6060/src/fmt/print.goといった形で、Goの標準的なパス構造に沿って提供できるようになります。
  4. 第4引数 (bindReplace): これはバインディングのモードを示し、ターゲットパスに既存のバインディングがある場合はそれを置き換えることを意味します。

この変更により、godocがzipファイルから提供するコンテンツのパス解決がより堅牢になり、Goの標準的なディレクトリ構造との整合性が保たれるようになりました。これは、特にGoの配布物に含まれるgodocが、自身のドキュメントやソースコードを正しく提供するために不可欠な修正です。godocが内部的にGOROOTを基準としたパスでファイルを検索する際に、zipファイル内のコンテンツがその期待されるパスに正確にマッピングされるようになったため、ファイルが見つからないといった問題が解消されます。

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

--- a/src/cmd/godoc/appinit.go
+++ b/src/cmd/godoc/appinit.go
@@ -42,7 +42,7 @@ func init() {
 		log.Fatalf("%s: %s\n", zipfile, err)
 	}
 	// rc is never closed (app running forever)
-	fs.Bind("/", NewZipFS(rc, zipFilename), "/", bindReplace)
+	fs.Bind("/", NewZipFS(rc, zipFilename), *goroot, bindReplace)
 
 	// initialize http handlers
 	readTemplates()

コアとなるコードの解説

変更された行はsrc/cmd/godoc/appinit.goファイルの44行目です。

  • 元のコード:

    fs.Bind("/", NewZipFS(rc, zipFilename), "/", bindReplace)

    この行は、NewZipFSによって作成されたzipファイルシステム（NewZipFS(rc, zipFilename)）のルートディレクトリ（第1引数の"/"）を、godocが公開する仮想ファイルシステムのルートディレクトリ（第3引数の"/"）にバインドしていました。これは、zipファイル内のコンテンツがWebサーバーのルートパスから直接アクセスされることを意味します。

  • 修正後のコード:

    fs.Bind("/", NewZipFS(rc, zipFilename), *goroot, bindReplace)

    この行では、第3引数が"/"から*gorootに変更されています。これにより、zipファイルシステム内のルートディレクトリ（第1引数の"/"）が、godocが認識するGoのインストールルートディレクトリ（*gorootが指すパス、例: /usr/local/go）にバインドされるようになりました。

この変更の意図は、godocがGoのソースコードやドキュメントを扱う際に、それらが常にGOROOTからの相対パスで参照されるという内部的な前提に合わせるためです。zipファイルがGoのインストールディレクトリの構造を模倣している場合、この変更によってzipファイル内のsrc/やpkg/などのディレクトリが、godocの内部ファイルシステム上で$GOROOT/src/や$GOROOT/pkg/といった正しいパスにマッピングされるようになります。これにより、godocはzipファイルから提供されるコンテンツを、あたかも実際のGOROOTディレクトリに存在するかのようにシームレスに処理できるようになり、ドキュメントの生成やWebサーバーでの表示が正しく行われるようになります。

関連リンク

参考にした情報源リンク

  • Go言語のソースコード (特にsrc/cmd/godocディレクトリ): https://github.com/golang/go/tree/master/src/cmd/godoc
  • Go言語のファイルシステム抽象化に関する一般的な情報 (Goのio/fsパッケージなど)
  • godocの動作原理に関する一般的な知識