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

os: 不規則なファイルに対するFileInfo.Sizeのシステム依存性を文書化

コミット

commit 4edd53e47b5a2e474f4e0b0399c272c48952d261
Author: Brad Fitzpatrick <bradfitz@golang.org>
Date:   Mon Mar 12 13:17:48 2012 -0700

    os: document FileInfo.Size as system-dependent for irregular files
    
    R=rsc, r
    CC=golang-dev
    https://golang.org/cl/5795059

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

https://github.com/golang/go/commit/4edd53e47b5a2e474f4e0b0399c272c48952d261

元コミット内容

os: document FileInfo.Size as system-dependent for irregular files

このコミットは、Go言語の標準ライブラリosパッケージにおけるFileInfo.Size()メソッドのドキュメントを修正するものです。以前のドキュメントでは、Size()メソッドは単に「バイト単位の長さ」を返すと記述されていました。しかし、ファイルシステムには通常のファイル（レギュラーファイル）だけでなく、ディレクトリ、シンボリックリンク、デバイスファイル（例: /dev/null）、名前付きパイプ（FIFO）、ソケットなどの「不規則なファイル（irregular files）」が存在します。

これらの不規則なファイルに対してSize()メソッドが返す値は、オペレーティングシステム（OS）によってその解釈や挙動が異なる場合があります。例えば、パイプやソケットのようなストリーム指向のファイルでは、概念的な「サイズ」が存在しないか、あるいは現在のバッファ内のデータ量を示すなど、レギュラーファイルとは異なる意味を持つことがあります。また、シンボリックリンクのサイズは、リンク先のパスの長さを示す場合もあれば、常に0を返す場合もあります。

このようなOS間の差異や、不規則なファイルの種類による挙動の違いが明示されていなかったため、開発者がFileInfo.Size()の戻り値に誤った期待を抱く可能性がありました。このコミットは、この曖昧さを解消し、特に不規則なファイルに対するSize()の挙動が「システム依存（system-dependent）」であることを明確にすることで、APIの正確性と堅牢性を向上させることを目的としています。これにより、開発者はFileInfo.Size()を使用する際に、その値が常にレギュラーファイルのバイト長を意味するわけではないことを認識し、適切なハンドリングを行うことができるようになります。

前提知識の解説

Go言語の`os`パッケージとファイル操作

Go言語のosパッケージは、オペレーティングシステムとの基本的な相互作用を提供します。これには、ファイルやディレクトリの操作、プロセス管理、環境変数へのアクセスなどが含まれます。ファイル操作においては、os.Stat()やos.Lstat()といった関数が重要です。

os.Stat(name string) (FileInfo, error): 指定されたパスnameのファイルに関するFileInfoインターフェースを返します。シンボリックリンクの場合、リンク先のファイルの情報が返されます（シンボリックリンクを解決します）。
os.Lstat(name string) (FileInfo, error): os.Statと同様にFileInfoを返しますが、シンボリックリンクの場合、リンク自体に関する情報が返されます（シンボリックリンクを解決しません）。

`FileInfo`インターフェース

FileInfoインターフェースは、ファイルに関するメタデータ（名前、サイズ、パーミッション、更新時刻など）への統一的なアクセスを提供します。その定義は以下のようになっています（コミット前の状態）：

type FileInfo interface {
    Name() string       // base name of the file
    Size() int64        // length in bytes
    Mode() FileMode     // file mode bits
    ModTime() time.Time // modification time
    IsDir() bool        // abbreviation for Mode().IsDir()
    Sys() interface{}   // underlying data source (can return nil)
}

このコミットで変更されるのは、Size() int64のコメント部分です。

レギュラーファイルと不規則なファイル

ファイルシステムにおけるファイルは、大きく分けて「レギュラーファイル」と「不規則なファイル」に分類されます。

レギュラーファイル (Regular Files): 一般的なデータファイルです。テキストファイル、画像ファイル、実行可能ファイルなど、ディスク上に連続したデータとして保存され、明確なバイト長を持つものです。Size()メソッドは、これらのファイルの正確なバイト長を返します。
不規則なファイル (Irregular Files): レギュラーファイル以外の特殊なファイルです。
- ディレクトリ (Directories): ファイルや他のディレクトリを格納するコンテナ。サイズは通常、ディレクトリ内のエントリ数やファイルシステムの実装に依存します。
- シンボリックリンク (Symbolic Links / Symlinks): 他のファイルやディレクトリへの参照（ポインタ）です。サイズは通常、参照先のパス文字列の長さになりますが、OSによっては0を返すこともあります。
- デバイスファイル (Device Files): ハードウェアデバイス（例: /dev/null, /dev/zero, /dev/sda）を表すファイル。サイズは通常、意味を持ちません。
- 名前付きパイプ (Named Pipes / FIFOs): プロセス間通信のためのファイル。データは一時的にバッファリングされ、読み書きされるため、固定のサイズを持ちません。
- ソケット (Sockets): ネットワーク通信のためのファイル。これも固定のサイズを持ちません。

これらの不規則なファイルに対するSize()の挙動は、ファイルシステムの種類やOSのAPIによって異なり、必ずしも「バイト単位の長さ」という直感的な意味を持たないことがあります。

技術的詳細

このコミットの技術的詳細の核心は、FileInfo.Size()が返す値の「意味」を、レギュラーファイルと不規則なファイルで区別し、後者についてはその挙動がシステムに依存することを明示する点にあります。

`Size()`の挙動の多様性

レギュラーファイル: Size()は、ファイルが占める正確なバイト数を返します。これは、ファイルの内容の長さに直接対応します。
ディレクトリ: 多くのUnix系システムでは、ディレクトリのサイズは、そのディレクトリのエントリ（ファイル名とinode番号のペア）を格納するために必要なディスクスペースを示します。これは通常、非常に小さい値（例: 4096バイト）であり、ディレクトリ内のファイルの合計サイズとは関係ありません。Windowsでは、ディレクトリのサイズは通常0です。
シンボリックリンク:
- Unix系システムでは、シンボリックリンクのサイズは、それが指すパス文字列のバイト長を返します。例えば、/path/to/targetというパスへのシンボリックリンクであれば、その文字列の長さがサイズとして返されます。
- Windowsでは、シンボリックリンクのサイズは通常0です。
デバイスファイル、パイプ、ソケット: これらのファイルタイプは、ディスク上の固定されたデータ領域を持たないため、Size()が返す値は通常0であるか、あるいは特定のOSの文脈でのみ意味を持つ（例: パイプのバッファ内のデータ量）場合があります。多くの場合、これらのファイルタイプに対してSize()を呼び出すことは、その値がアプリケーションロジックにとって有用ではないことを意味します。

「システム依存」の重要性

「システム依存（system-dependent）」という記述は、Go言語がクロスプラットフォームであることを考慮した上で非常に重要です。Goのosパッケージは、基盤となるOSのファイルシステムAPI（例: Unix系ではstat(2)、WindowsではGetFileInformationByHandleなど）を抽象化して提供しています。しかし、これらのOS固有のAPIが不規則なファイルに対して返す「サイズ」の情報は一貫していません。

このドキュメントの変更は、GoのosパッケージがこれらのOS固有の挙動をそのまま透過的に公開していることを示唆しています。つまり、Goランタイムが特定のOSのstatシステムコールから取得したst_sizeフィールドの値を、そのままFileInfo.Size()として返している可能性が高いということです。これにより、開発者は、異なるOS上で同じコードを実行した場合に、不規則なファイルのSize()が異なる値を返す可能性があることを認識し、その値に依存するロジックを記述する際には注意を払う必要があります。

例えば、あるOSでシンボリックリンクのサイズがパスの長さとして返されることを期待してコードを書いた場合、別のOS（例: Windows）でそのサイズが0として返されると、予期せぬバグにつながる可能性があります。このドキュメントの修正は、このような潜在的なクロスプラットフォームの落とし穴を開発者に警告する役割を果たします。

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

--- a/src/pkg/os/types.go
+++ b/src/pkg/os/types.go
@@ -15,7 +15,7 @@ func Getpagesize() int { return syscall.Getpagesize() }\n // A FileInfo describes a file and is returned by Stat and Lstat\n type FileInfo interface {\n 	Name() string       // base name of the file\n-	Size() int64        // length in bytes\n+	Size() int64        // length in bytes for regular files; system-dependent for others\n 	Mode() FileMode     // file mode bits\n 	ModTime() time.Time // modification time\n 	IsDir() bool        // abbreviation for Mode().IsDir()\n```

## コアとなるコードの解説

このコミットによるコードの変更は、`src/pkg/os/types.go`ファイル内の`FileInfo`インターフェースの定義における`Size()`メソッドのコメント行のみです。

*   **変更前**:
    ```go
    Size() int64        // length in bytes
    ```
    これは、`Size()`メソッドが常に「バイト単位の長さ」を返すと解釈される可能性がありました。

*   **変更後**:
    ```go
    Size() int64        // length in bytes for regular files; system-dependent for others
    ```
    この変更により、コメントがより詳細かつ正確になりました。
    *   `length in bytes for regular files`: レギュラーファイルの場合、`Size()`は期待通りにファイルの正確なバイト長を返します。
    *   `system-dependent for others`: レギュラーファイル以外のファイル（不規則なファイル）の場合、`Size()`が返す値は「システム依存」であることを明確にしています。これは、その値がOSやファイルシステムの実装によって異なる挙動を示す可能性があることを意味します。

この修正は、コードの動作自体を変更するものではなく、APIのドキュメントを改善し、開発者が`FileInfo.Size()`の挙動についてより正確な理解を持つことを促すものです。これにより、特にクロスプラットフォームアプリケーションを開発する際に、不規則なファイルのサイズに関する誤解やバグを防ぐことができます。

## 関連リンク

*   Go CL 5795059: [https://golang.org/cl/5795059](https://golang.org/cl/5795059)

## 参考にした情報源リンク

*   Go言語 `os` パッケージドキュメント: [https://pkg.go.dev/os](https://pkg.go.dev/os)
*   `stat(2)` man page (Unix/Linux): [https://man7.org/linux/man-pages/man2/stat.2.html](https://man7.org/linux/man-pages/man2/stat.2.html)
*   Microsoft Learn - `GetFileInformationByHandle` function: [https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getfileinformationbyhandle](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getfileinformationbyhandle)
*   Stack Overflow - What is the size of a directory?: [https://stackoverflow.com/questions/1391000/what-is-the-size-of-a-directory](https://stackoverflow.com/questions/1391000/what-is-the-size-of-a-directory)
*   Stack Overflow - What is the size of a symbolic link?: [https://stackoverflow.com/questions/100003/what-is-the-size-of-a-symbolic-link](https://stackoverflow.com/questions/100003/what-is-the-size-of-a-symbolic-link)
*   Go issue tracker (related discussions might exist, though not directly linked in the commit message, searching for "FileInfo.Size irregular files" could reveal more context): [https://github.com/golang/go/issues](https://github.com/golang/go/issues)
*   Go Wiki - FileInfo: [https://go.dev/wiki/FileInfo](https://go.dev/wiki/FileInfo) (General information about FileInfo)
*   Go Wiki - Go and the OS: [https://go.dev/wiki/GoAndTheOS](https://go.dev/wiki/GoAndTheOS) (General information about Go's interaction with the OS)
*   Go Blog - The Go Programming Language and the OS: [https://go.dev/blog/os](https://go.dev/blog/os) (General information about Go's interaction with the OS)```markdown
# [インデックス 12576] ファイルの概要

os: 不規則なファイルに対するFileInfo.Sizeのシステム依存性を文書化

## コミット

commit 4edd53e47b5a2e474f4e0b0399c272c48952d261 Author: Brad Fitzpatrick bradfitz@golang.org Date: Mon Mar 12 13:17:48 2012 -0700

os: document FileInfo.Size as system-dependent for irregular files

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


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

[https://github.com/golang/go/commit/4edd53e47b5a2e474f4e0b0399c272c48952d261](https://github.com/golang/go/commit/4edd53e47b5a2e474f4e0b0399c272c48952d261)

## 元コミット内容

`os: document FileInfo.Size as system-dependent for irregular files`

## 変更の背景

このコミットは、Go言語の標準ライブラリ`os`パッケージにおける`FileInfo.Size()`メソッドのドキュメントを修正するものです。以前のドキュメントでは、`Size()`メソッドは単に「バイト単位の長さ」を返すと記述されていました。しかし、ファイルシステムには通常のファイル（レギュラーファイル）だけでなく、ディレクトリ、シンボリックリンク、デバイスファイル（例: `/dev/null`）、名前付きパイプ（FIFO）、ソケットなどの「不規則なファイル（irregular files）」が存在します。

これらの不規則なファイルに対して`Size()`メソッドが返す値は、オペレーティングシステム（OS）によってその解釈や挙動が異なる場合があります。例えば、パイプやソケットのようなストリーム指向のファイルでは、概念的な「サイズ」が存在しないか、あるいは現在のバッファ内のデータ量を示すなど、レギュラーファイルとは異なる意味を持つことがあります。また、シンボリックリンクのサイズは、リンク先のパスの長さを示す場合もあれば、常に0を返す場合もあります。

このようなOS間の差異や、不規則なファイルの種類による挙動の違いが明示されていなかったため、開発者が`FileInfo.Size()`の戻り値に誤った期待を抱く可能性がありました。このコミットは、この曖昧さを解消し、特に不規則なファイルに対する`Size()`の挙動が「システム依存（system-dependent）」であることを明確にすることで、APIの正確性と堅牢性を向上させることを目的としています。これにより、開発者は`FileInfo.Size()`を使用する際に、その値が常にレギュラーファイルのバイト長を意味するわけではないことを認識し、適切なハンドリングを行うことができるようになります。

## 前提知識の解説

### Go言語の`os`パッケージとファイル操作

Go言語の`os`パッケージは、オペレーティングシステムとの基本的な相互作用を提供します。これには、ファイルやディレクトリの操作、プロセス管理、環境変数へのアクセスなどが含まれます。ファイル操作においては、`os.Stat()`や`os.Lstat()`といった関数が重要です。

*   **`os.Stat(name string) (FileInfo, error)`**: 指定されたパス`name`のファイルに関する`FileInfo`インターフェースを返します。シンボリックリンクの場合、リンク先のファイルの情報が返されます（シンボリックリンクを解決します）。
*   **`os.Lstat(name string) (FileInfo, error)`**: `os.Stat`と同様に`FileInfo`を返しますが、シンボリックリンクの場合、リンク自体に関する情報が返されます（シンボリックリンクを解決しません）。

### `FileInfo`インターフェース

`FileInfo`インターフェースは、ファイルに関するメタデータ（名前、サイズ、パーミッション、更新時刻など）への統一的なアクセスを提供します。その定義は以下のようになっています（コミット前の状態）：

```go
type FileInfo interface {
    Name() string       // base name of the file
    Size() int64        // length in bytes
    Mode() FileMode     // file mode bits
    ModTime() time.Time // modification time
    IsDir() bool        // abbreviation for Mode().IsDir()
    Sys() interface{}   // underlying data source (can return nil)
}

このコミットで変更されるのは、Size()メソッドのコメント部分です。