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

このコミットは、Go言語のAPI互換性リストにNetBSD/ARM EABI (Embedded Application Binary Interface) 環境における例外を追加するものです。具体的には、api/except.txtファイルにNetBSD/ARMアーキテクチャ向けのsyscallパッケージに関する特定の定義を追加し、異なる環境間でのGoプログラムの互換性と安定性を確保することを目的としています。

コミット

commit d957169cf841dcf120b1095abfdb9a8a3a7f55e1
Author: Shenghou Ma <minux.ma@gmail.com>
Date:   Thu Mar 6 01:19:16 2014 -0500

    api: add NetBSD/ARM EABI exceptions.
    
    LGTM=bradfitz
    R=golang-codereviews, bradfitz
    CC=golang-codereviews
    https://golang.org/cl/71940043

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

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

元コミット内容

api: add NetBSD/ARM EABI exceptions.

このコミットは、NetBSD/ARM EABI環境におけるGoのAPIに特定の例外を追加します。

変更の背景

Go言語は、異なるオペレーティングシステムやアーキテクチャ間で高い互換性を持つことを目指しています。しかし、OSやアーキテクチャの組み合わせによっては、特定のシステムコールやデータ構造のレイアウトが標準的なものと異なる場合があります。このような差異は、Goのコンパイラやランタイムが期待するメモリレイアウトやアラインメントと合致しない場合に問題を引き起こす可能性があります。

api/except.txtファイルは、GoのAPI互換性チェックシステムの一部として機能します。このファイルには、特定のOS/アーキテクチャの組み合わせにおいて、Goの標準ライブラリのAPIが期待される形式と異なる場合の「例外」が記述されています。これは、Goの将来のバージョンでAPIの変更があった際に、既存のコードが予期せず壊れることを防ぐためのメカニズムです。

このコミットの背景には、NetBSDオペレーティングシステム上のARMアーキテクチャ、特にEABIを使用する環境において、syscallパッケージ内の特定の構造体や定数（SizeofIfDataとIfMsghdr）が、Goの内部的な期待値と異なるアラインメントやサイズを持つことが判明したという事情があります。これらの差異を明示的にexcept.txtに記述することで、Goツールチェインがこれらの特殊なケースを認識し、適切に処理できるようになります。これにより、NetBSD/ARM環境でのGoプログラムの安定性と正確性が保証されます。

前提知識の解説

Go API互換性: Go言語は、後方互換性を非常に重視しています。新しいバージョンがリリースされても、既存のGoプログラムが動作し続けることを保証するための厳格なAPI互換性ポリシーがあります。api/except.txtのようなファイルは、この互換性保証メカニズムの一部です。
api/except.txt: Goのソースコードリポジトリにあるこのファイルは、特定のOS/アーキテクチャの組み合わせにおいて、Goの標準ライブラリのAPIが「例外的に」異なる振る舞いをすることを記録しています。これは、GoのAPIチェッカーがこれらの差異をエラーとして報告しないようにするためのものです。
NetBSD: オープンソースのUnix系オペレーティングシステムの一つで、高い移植性を特徴としています。多くの異なるハードウェアアーキテクチャで動作します。
ARMアーキテクチャ: モバイルデバイスや組み込みシステムで広く使用されているプロセッサアーキテクチャです。
EABI (Embedded Application Binary Interface): 組み込みシステム向けのアプリケーションバイナリインターフェースの標準です。これは、コンパイラが生成するコードがどのようにメモリを使用し、関数呼び出しを処理するかなど、低レベルの規約を定義します。異なるEABIバージョンは、データのアラインメント、構造体のパディング、関数呼び出し規約などに影響を与える可能性があり、これがGoのような言語のクロスプラットフォーム互換性において問題となることがあります。
syscallパッケージ: Goの標準ライブラリの一部で、オペレーティングシステムのシステムコールにアクセスするための機能を提供します。ファイルI/O、ネットワーク通信、プロセス管理など、OSレベルの操作を行う際に使用されます。
SizeofIfData: ネットワークインターフェースに関するデータ構造のサイズを示す定数です。
IfMsghdr: ネットワークインターフェースのメッセージヘッダ構造体です。ネットワークインターフェースの状態変更や設定に関する情報がカーネルからユーザー空間に渡される際に使用されます。
Pad_cgo_1: Cgo（GoとC言語の相互運用機能）を使用する際に、構造体のアラインメント要件を満たすためにコンパイラが自動的に挿入するパディングバイトを示すことが多いです。異なるOSやアーキテクチャでは、構造体のアラインメント規則が異なるため、このようなパディングが必要になることがあります。

技術的詳細

このコミットは、api/except.txtファイルに以下の4行を追加しています。

--- a/api/except.txt
+++ b/api/except.txt
@@ -395,3 +395,7 @@ pkg syscall (freebsd-arm-cgo), type BpfHdr struct, Pad_cgo_0 [2]uint8
 pkg syscall (freebsd-arm-cgo), type RawSockaddrDatalink struct, Pad_cgo_0 [2]uint8
 pkg syscall (freebsd-arm-cgo), type RawSockaddrUnix struct, Pad_cgo_0 [2]uint8
 pkg syscall (freebsd-arm-cgo), type Stat_t struct, Pad_cgo_0 [4]uint8
+pkg syscall (netbsd-arm), const SizeofIfData = 132
+pkg syscall (netbsd-arm), type IfMsghdr struct, Pad_cgo_1 [4]uint8
+pkg syscall (netbsd-arm-cgo), const SizeofIfData = 132
+pkg syscall (netbsd-arm-cgo), type IfMsghdr struct, Pad_cgo_1 [4]uint8

これらの行は、NetBSD/ARM環境（Cgoを使用しない場合とCgoを使用する場合の両方）において、syscallパッケージ内のSizeofIfData定数の値が132であり、IfMsghdr構造体にPad_cgo_1 [4]uint8というパディングフィールドが存在することをGoのAPIチェッカーに伝えています。

これは、NetBSD/ARMのEABIが、これらのデータ構造のサイズやアラインメントに関して、他のシステムとは異なる特定の規約を持っていることを示唆しています。Goのコンパイラやランタイムは、これらのシステムコール関連の構造体を正確に扱うために、OSが期待するメモリレイアウトに厳密に従う必要があります。もしGoがこれらの差異を認識せずに、一般的なアラインメント規則を適用した場合、メモリの破損や不正なデータアクセスが発生し、プログラムのクラッシュや予期せぬ動作につながる可能性があります。

Pad_cgo_1 [4]uint8という記述は、IfMsghdr構造体がCgoを介してC言語の構造体と相互運用される際に、4バイトのパディングが必要であることを示しています。これは、C言語のコンパイラとGoのコンパイラが構造体のメンバをメモリ上に配置する際のアラインメント規則の違いを吸収するために重要です。

このコミットは、GoがNetBSD/ARM環境でシステムコールを正確に呼び出し、OSから返されるデータを正しく解釈するために必要な、低レベルの互換性調整を行っていることを意味します。

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

変更はapi/except.txtファイルのみです。

--- a/api/except.txt
+++ b/api/except.txt
@@ -395,3 +395,7 @@ pkg syscall (freebsd-arm-cgo), type BpfHdr struct, Pad_cgo_0 [2]uint8
 pkg syscall (freebsd-arm-cgo), type RawSockaddrDatalink struct, Pad_cgo_0 [2]uint8
 pkg syscall (freebsd-arm-cgo), type RawSockaddrUnix struct, Pad_cgo_0 [2]uint8
 pkg syscall (freebsd-arm-cgo), type Stat_t struct, Pad_cgo_0 [4]uint8
+pkg syscall (netbsd-arm), const SizeofIfData = 132
+pkg syscall (netbsd-arm), type IfMsghdr struct, Pad_cgo_1 [4]uint8
+pkg syscall (netbsd-arm-cgo), const SizeofIfData = 132
+pkg syscall (netbsd-arm-cgo), type IfMsghdr struct, Pad_cgo_1 [4]uint8

コアとなるコードの解説

追加された各行は、GoのAPIチェッカーに対する指示として機能します。

pkg syscall (netbsd-arm), const SizeofIfData = 132:
- pkg syscall: syscallパッケージに関する例外であることを示します。
- (netbsd-arm): NetBSDオペレーティングシステム上のARMアーキテクチャに適用されることを示します。
- const SizeofIfData = 132: SizeofIfDataという定数の値が132であることをAPIチェッカーに伝えます。これは、Goの内部的な計算や他のOSでの値と異なる可能性があるため、明示的に指定されています。
pkg syscall (netbsd-arm), type IfMsghdr struct, Pad_cgo_1 [4]uint8:
- type IfMsghdr struct: IfMsghdrという構造体に関する例外であることを示します。
- Pad_cgo_1 [4]uint8: IfMsghdr構造体内にPad_cgo_1という名前のフィールドがあり、それが[4]uint8（4バイトの符号なし8ビット整数配列）型であることを示します。これは、Cgoを介した相互運用性のため、または特定のEABIのアラインメント要件を満たすために、コンパイラが挿入するパディングフィールドです。
pkg syscall (netbsd-arm-cgo), const SizeofIfData = 132:
- 上記と同様ですが、Cgoを使用するNetBSD/ARM環境に特化したものです。Cgoを使用する場合と使用しない場合で、システムコール関連の定数や構造体の扱いが微妙に異なることがあるため、両方のケースで明示的に記述されています。
pkg syscall (netbsd-arm-cgo), type IfMsghdr struct, Pad_cgo_1 [4]uint8:
- 上記と同様ですが、Cgoを使用するNetBSD/ARM環境に特化したものです。

これらのエントリが存在することで、GoのビルドシステムはNetBSD/ARM環境でsyscallパッケージをコンパイルする際に、これらの特定の差異を許容し、エラーとして報告しないようになります。これにより、Goのクロスプラットフォーム対応がより堅牢になります。

参考にした情報源リンク

Go言語のソースコードリポジトリ (特にapi/except.txtファイルとその周辺のドキュメント)
Go言語のAPI互換性に関する公式ブログ記事やドキュメント (一般的な情報源として)
NetBSDのドキュメントやメーリングリスト (NetBSD/ARM EABIに関する詳細情報)
EABIに関する一般的な技術文書
Goのsyscallパッケージのソースコード (具体的な構造体定義や定数の確認)
Goのコードレビューシステム (Gerrit) の該当コミットページ: https://golang.org/cl/71940043

comemo