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

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

このコミットは、Go言語のsyscallパッケージ内のtypes_*.goファイル群における// +buildコメントの配置を修正するものです。具体的には、go buildコマンドが正しくビルドタグを認識できるよう、これらのコメントをファイルの先頭に移動しています。これにより、特定のオペレーティングシステム向けの型定義ファイルが適切にビルドプロセスから除外されるようになります。

コミット

commit 8fe75a28fbd7dcbdaf41f904fca5065a54a89998
Author: Russ Cox <rsc@golang.org>
Date:   Thu Feb 2 19:42:02 2012 -0500

    syscall: fix // +build comments in types_*.go

    I fixed types_linux.go yesterday but missed the others.

    R=golang-dev, bradfitz
    CC=golang-dev
    https://golang.org/cl/5620054

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

https://github.com/golang/go/commit/8fe75a28fbd7dcbdaf41f904fca5065a54a89998

元コミット内容

syscall: fix // +build comments in types_*.go

I fixed types_linux.go yesterday but missed the others.

R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/5620054

変更の背景

このコミットの背景には、Go言語のビルドシステムにおける+buildタグの厳密な解釈ルールがあります。+buildタグは、特定の条件（OS、アーキテクチャ、カスタムタグなど）に基づいてファイルをビルドに含めるか除外するかを制御するために使用されます。しかし、このタグがファイル内で正しく認識されるためには、ファイルの先頭、パッケージ宣言よりも前に配置されている必要があります。

元のコードでは、types_*.goファイル群（types_darwin.go, types_freebsd.go, types_linux.go, types_netbsd.go, types_openbsd.go）において、// +build ignoreというビルドタグが、ファイルの先頭にあるライセンスコメントや他のコメントの後に配置されていました。この配置では、go buildコマンドがこのタグを正しく認識できず、結果としてこれらのファイルが意図せずビルドに含まれてしまう可能性がありました。

コミットメッセージにある「I fixed types_linux.go yesterday but missed the others.」という記述から、types_linux.goについては既に同様の修正が行われていたものの、他のOS向けのファイルで同じ問題が残っていたことが伺えます。このコミットは、残りのファイルについても一貫した修正を適用し、ビルドプロセスの正確性を保証することを目的としています。

前提知識の解説

このコミットを理解するためには、以下のGo言語のビルドシステムと関連ツールに関する知識が必要です。

  1. Go Build Tags (+build directives): Go言語では、ソースコードファイルに特別なコメント行を追加することで、そのファイルを特定のビルド条件に含めるか除外するかを制御できます。これが「ビルドタグ」または「ビルド制約」と呼ばれます。 形式は// +build tagまたは// +build !tagです。複数のタグをスペースで区切って指定することもできます（例: // +build linux,amd64）。 これらのタグは、go buildコマンドがソースファイルをコンパイルする際に評価され、条件に合致しないファイルはビルドプロセスから除外されます。 特に重要なのは、// +build ignoreタグです。これは、そのファイルが通常のビルドプロセスから完全に無視されるべきであることを示します。これは、コード生成の入力ファイルや、特定のツールが使用するが直接コンパイルされるべきではないファイルによく使われます。

  2. cgo: cgoは、GoプログラムからC言語のコードを呼び出すためのGoツールです。CのライブラリやシステムコールをGoから利用する際に使用されます。cgoを使用するGoファイルは、通常のGoコンパイラだけでなく、Cコンパイラ（通常はGCCやClang）も必要とします。

  3. godefs: godefsは、cgoと組み合わせて使用されるGoツールの一つです。C言語のヘッダファイルからGoの構造体定義を自動生成するために使われます。システムコールやOS固有のデータ構造をGoで扱う際、Cの定義とGoの定義を同期させるために非常に有用です。 types_*.goファイルは、まさにこのgodefsツールの入力として設計されており、各OSのシステムコールに関連するCの型定義をGoの型にマッピングするための情報を含んでいます。これらのファイル自体は直接Goプログラムとしてコンパイルされることを意図しておらず、godefsによって処理されるべきものです。そのため、// +build ignoreタグが付与され、通常のビルドから除外される必要があります。

  4. syscallパッケージ: Go言語の標準ライブラリであるsyscallパッケージは、オペレーティングシステムの低レベルな機能（システムコール）へのアクセスを提供します。OSに依存する部分が多く、各OS（Linux, Darwin, FreeBSD, NetBSD, OpenBSDなど）ごとに異なる実装や型定義が必要です。types_*.goファイルは、このsyscallパッケージ内で各OS固有の型定義をgodefsを通じて生成するために利用されます。

技術的詳細

Goのビルドタグ（// +build）は、Goコンパイラによって非常に厳密に解析されます。公式ドキュメントやGoのソースコードの解析から、以下の重要なルールが導き出されます。

  • ファイルの先頭に配置: // +buildタグは、ファイルの先頭にある必要があります。具体的には、パッケージ宣言（package mainなど）よりも前、かつ、ファイルの最初の非空白行である必要があります。
  • コメント形式: //で始まる単一行コメントである必要があります。/* ... */のようなブロックコメント内では認識されません。
  • 空白行の扱い: // +buildタグの前に空白行があっても問題ありませんが、他のコードやコメント（特に//以外のコメント）が間に入ると、タグが認識されなくなる可能性があります。

このコミットで修正されたtypes_*.goファイル群では、// +build ignoreタグが、ファイルの先頭にあるライセンスコメント（// Copyright ...）の後に配置されていました。

// Copyright ...
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

/*
Input to cgo -godefs.  See also mkerrors.sh and mkall.sh
*/

// +build ignore // <-- この位置では認識されない可能性があった

この配置では、go buildコマンドが// +build ignoreタグを正しく解析できず、結果としてこれらのファイルが通常のGoソースファイルとして扱われ、コンパイルエラーや意図しないビルド結果を引き起こす可能性がありました。godefsの入力ファイルであるため、これらはGoコンパイラによって直接コンパイルされるべきではありません。

今回の修正は、// +build ignoreタグをライセンスコメントと/* ... */ブロックコメントの間に移動させることで、この問題を解決しています。

// Copyright ...
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// +build ignore // <-- この位置であれば正しく認識される

/*
Input to cgo -godefs.  See also mkerrors.sh and mkall.sh
*/

この変更により、go buildはこれらのファイルを正しくignore（無視）するようになり、godefsツールのみがこれらのファイルを処理するようになります。これは、Goのビルドシステムにおけるビルドタグの厳密な解析ルールへの準拠を徹底するものです。

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

このコミットでは、src/pkg/syscall/ディレクトリ内の以下の5つのファイルが変更されています。

  • src/pkg/syscall/types_darwin.go
  • src/pkg/syscall/types_freebsd.go
  • src/pkg/syscall/types_linux.go
  • src/pkg/syscall/types_netbsd.go
  • src/pkg/syscall/types_openbsd.go

各ファイルで行われた変更は、// +build ignoreコメントの行を、既存のライセンスコメントと/* ... */ブロックコメントの間に移動させることです。

例: src/pkg/syscall/types_darwin.go の変更差分

--- a/src/pkg/syscall/types_darwin.go
+++ b/src/pkg/syscall/types_darwin.go
@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.

+// +build ignore
+
 /*
 Input to cgo -godefs.  See also mkerrors.sh and mkall.sh
 */

-// +build ignore
-
 // +godefs map struct_in_addr [4]byte /* in_addr */
 // +godefs map struct_in6_addr [16]byte /* in6_addr */

この差分は、元の位置にあった// +build ignore行（-で始まる行）が削除され、新しい位置（+で始まる行）に挿入されたことを示しています。他の4つのファイルでも同様の変更が行われています。

コアとなるコードの解説

変更の核心は、// +build ignoreというビルドタグの物理的な位置の修正です。

  • 変更前:

    // Copyright ...
/*
Input to cgo -godefs.  See also mkerrors.sh and mkall.sh
*/
// +build ignore

    この配置では、/* ... */というブロックコメントが// +build ignoreタグの前に存在していました。Goのビルドタグのパーサーは、ファイルの先頭からタグを探し、最初の非空白行が// +buildで始まることを期待します。ブロックコメントが存在すると、そのブロックコメントが最初の非空白行と見なされ、その後に続く// +buildタグが正しく認識されない可能性がありました。

  • 変更後:

    // Copyright ...
// +build ignore
/*
Input to cgo -godefs.  See also mkerrors.sh and mkall.sh
*/

    この新しい配置では、ライセンスコメントの直後に// +build ignoreタグが来ています。これにより、Goのビルドシステムがファイルを解析する際に、このタグをファイルの先頭にあるビルド制約として正しく認識できるようになります。結果として、これらのtypes_*.goファイルは、go buildコマンドによってコンパイルされることなく、godefsツールによってのみ処理されるという意図された動作が保証されます。

この修正は、Goのビルドシステムがビルドタグをどのように解釈するかという、細部ながらも重要なルールへの準拠を徹底するものです。このような細かな修正が、大規模なプロジェクトにおけるビルドの安定性と正確性を保つ上で不可欠となります。

関連リンク

参考にした情報源リンク