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

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

このコミットは、Goのcgoテストスイート内のmisc/cgo/test/issue6506.goファイルから、標準Cライブラリには含まれない非標準関数（alloca, bzero, bcmp, strncasecmp, strlcpy, strlcat）の呼び出しを削除するものです。これにより、異なるシステムやコンパイラ環境でのビルド失敗を防ぎ、Goのビルドの堅牢性と移植性を向上させることが目的です。

コミット

misc/cgo/test: cut out non-standard functions

Otherwise the link fails. Fixes build.

TBR=golang-dev
CC=golang-dev
https://golang.org/cl/14483050

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

https://github.com/golang/go/commit/74f639176da060afc1fa939f7165310abbbb707f

元コミット内容

misc/cgo/test: cut out non-standard functions

Otherwise the link fails. Fixes build.

TBR=golang-dev
CC=golang-dev
https://golang.org/cl/14483050

変更の背景

この変更の背景には、Goのcgoテストが特定の環境でビルドに失敗するという問題がありました。具体的には、misc/cgo/test/issue6506.goというテストファイル内で、C言語の非標準関数が使用されており、これらの関数がすべてのシステムやCコンパイラで利用可能であるとは限らなかったためです。

コミットメッセージにある「Otherwise the link fails. Fixes build.」という記述は、これらの非標準関数へのリンクが、それらの関数を提供しない環境では失敗し、結果としてGoのビルドプロセス全体が中断していたことを示唆しています。特に、allocaのような関数はClangの組み込み関数として提供されることがありますが、他のコンパイラ（GCCなど）や異なるOS環境では利用できないか、異なるヘッダーで宣言されている場合があります。

Goプロジェクトはクロスプラットフォームでの動作を重視しており、特定のコンパイラやOSに依存するコードは、可能な限り避けるべきです。このコミットは、テストスイートの移植性を高め、より広範な環境でのGoのビルドを成功させるために行われました。

前提知識の解説

cgo

cgoは、Go言語のプログラムからC言語のコードを呼び出すためのGoの機能です。また、C言語のコードからGo言語の関数を呼び出すことも可能です。cgoを使用することで、既存のCライブラリをGoプロジェクトに統合したり、パフォーマンスが重要な部分をCで記述したりすることができます。

cgoを使用するには、Goのソースファイル内でimport "C"という特別なインポート文を使用し、その直前のコメントブロックにC言語のコード（#includeディレクティブやC関数の定義など）を記述します。このコメントブロックは「プリアンブル」と呼ばれます。Goコンパイラは、cgoが有効な場合、このプリアンブル内のCコードをCコンパイラ（通常はGCCまたはClang）に渡し、生成されたオブジェクトファイルをGoの実行可能ファイルにリンクします。

標準C関数と非標準C関数

  • 標準C関数: C言語の国際標準（ISO C）によって定義され、すべての標準準拠のCコンパイラとCライブラリで利用可能であることが保証されている関数です。例としては、malloc, free, printf, strlen, strcpy, memcpy, memsetなどがあります。これらは通常、<stdio.h>, <stdlib.h>, <string.h>などの標準ヘッダーファイルで宣言されています。
  • 非標準C関数: 特定のオペレーティングシステム（例: BSD、Linux）やコンパイラ（例: GCC、Clang）によって提供される拡張機能や、歴史的な理由で広く使われているが標準には含まれない関数です。これらは移植性が低く、ある環境では利用できても別の環境では利用できない場合があります。

コンパイラの組み込み関数 (Builtins)

コンパイラの組み込み関数（Builtins）は、コンパイラ自体が提供する特殊な関数です。これらは通常、標準ライブラリ関数よりも最適化されたバージョンを提供したり、ハードウェアの低レベル機能にアクセスしたりするために使用されます。例えば、ClangやGCCは、allocaのような特定の関数を組み込み関数として実装していることがあります。これにより、コンパイラはこれらの関数呼び出しを、より効率的なインラインコードや特殊な命令に置き換えることができます。しかし、組み込み関数に依存すると、コードの移植性が損なわれる可能性があります。

技術的詳細

このコミットで削除された関数は、以下の通りです。

  • alloca(size_t): スタック上にメモリを動的に割り当てる関数です。標準Cには含まれず、主にUnix系システムで利用されます。mallocとは異なり、割り当てられたメモリは関数が終了すると自動的に解放されます。Clangの組み込み関数として提供されることが多いですが、GCCや他のコンパイラでは異なる動作をしたり、利用できなかったりする場合があります。
  • bzero(void*, size_t): 指定されたメモリブロックをゼロで埋める関数です。BSD系の拡張であり、標準Cのmemset(ptr, 0, size)に相当します。
  • bcmp(const void*, const void*, size_t): 2つのメモリブロックを比較する関数です。これもBSD系の拡張であり、標準Cのmemcmpに相当します。
  • strncasecmp(const char*, const char*, size_t n): 2つの文字列を、指定された文字数まで大文字・小文字を区別せずに比較する関数です。POSIX標準には含まれますが、すべてのCライブラリで利用可能とは限りません。
  • strlcpy(char*, const char*, size_t): 安全な文字列コピー関数です。バッファオーバーフローを防ぐために、コピー先のバッファサイズを引数に取ります。BSD系で導入され、標準Cのstrcpyやstrncpyの代替として推奨されることがあります。
  • strlcat(char*, const char*, size_t): 安全な文字列連結関数です。strlcpyと同様に、バッファオーバーフローを防ぎます。

これらの関数は、特定のUnix系システムやコンパイラ環境では一般的に利用できますが、Windowsのような他のOSや、異なるCコンパイラを使用する環境では、リンカエラーや未定義参照エラーを引き起こす可能性があります。Goのビルドシステムは、様々なプラットフォームで動作するように設計されているため、このような非標準関数への依存はビルドの安定性を損なう要因となります。

特に、コミットメッセージにある「One of the great things about this bug is that even with these prototypes clang still generates the wrong debug information.」という記述は、Clangがこれらの関数のプロトタイプが存在しても、デバッグ情報の生成において問題を引き起こしていた可能性を示唆しています。これは、コンパイラの組み込み関数としての特殊な扱いが、通常の関数呼び出しとは異なる挙動をしていたことを示しているかもしれません。

このコミットは、これらの非標準関数への依存を取り除くことで、Goのテストスイートがより多くの環境で問題なくビルド・実行できるようにし、Go全体の移植性と信頼性を向上させています。

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

変更はmisc/cgo/test/issue6506.goファイルに対して行われました。具体的には、以下の行が削除されています。

--- a/misc/cgo/test/issue6506.go
+++ b/misc/cgo/test/issue6506.go
@@ -10,18 +10,6 @@ package cgotest
  /*
  #include <stdlib.h>
  #include <string.h>
--
-// These functions are clang builtins but not standard on other systems.
-// Give them prototypes so that this test can be compiled on other systems.
-// One of the great things about this bug is that even with these prototypes
-// clang still generates the wrong debug information.
-
-void *alloca(size_t);\n-void bzero(void*, size_t);\n-int bcmp(const void*, const void*, size_t);\n-int strncasecmp(const char*, const char*, size_t n);\n-size_t strlcpy(char*, const char*, size_t);\n-size_t strlcat(char*, const char*, size_t);\n */
  import "C"
  
  @@ -44,10 +32,5 @@ func test6506() {
  
  	x = C.strspn(nil, nil)
  	C.memset(nil, 0, x)
  	x = C.strlen(nil)
-	C.alloca(x)
-	C.bzero(nil, x)
-	C.strncasecmp(nil, nil, x)
-	x = C.strlcpy(nil, nil, x)
-	x = C.strlcat(nil, nil, x)
  	_ = x
  }

この差分は、Cgoプリアンブル内の非標準関数のプロトタイプ宣言と、test6506()関数内のこれらの関数への呼び出しが完全に削除されたことを示しています。

コアとなるコードの解説

このコミットのコアとなる変更は、misc/cgo/test/issue6506.goファイルから、Cgoプリアンブル内の非標準C関数のプロトタイプ宣言と、それらの関数を呼び出すGoコードを削除したことです。

元のコードでは、alloca, bzero, bcmp, strncasecmp, strlcpy, strlcatといった関数がCgoプリアンブル内でプロトタイプ宣言され、test6506()関数内でC.プレフィックスを付けて呼び出されていました。これは、GoコードからC関数を呼び出すための標準的なcgoの構文です。

しかし、これらの関数は標準Cライブラリの一部ではないため、すべてのCコンパイラやオペレーティングシステムで利用できるわけではありません。特に、allocaはスタック割り当てを行う特殊な関数であり、コンパイラによっては組み込み関数として扱われることがあります。コミットメッセージが示唆するように、Clangではこれらの関数が組み込み関数として扱われることがありましたが、それでもデバッグ情報の生成に問題があったり、他のコンパイラでは全くサポートされていなかったりしました。

これらの非標準関数への依存を削除することで、issue6506.goテストは、より広範なCコンパイラおよびOS環境でビルドおよび実行できるようになります。これにより、Goのビルドプロセス全体の堅牢性と移植性が向上し、特定の開発環境に起因するビルド失敗が解消されます。この変更は、GoのテストスイートがGo自体と同じくらいクロスプラットフォームであることを保証するための重要なステップです。

関連リンク

参考にした情報源リンク