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

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

このコミットは、Go言語の標準ライブラリ crypto/tls パッケージ内の root_darwin.go ファイルに対する変更です。具体的には、macOS環境でのビルド時に発生する警告を抑制するためのCコンパイラフラグの追加が行われています。

コミット

このコミットは、Go言語の crypto/tls パッケージがmacOS上でビルドされる際に発生する警告を抑制することを目的としています。特に、macOSの異なるバージョン（10.6と10.7）間でのAPIの互換性を維持しつつ、非推奨となった関数を使用していることによる警告を無視するように設定されています。これにより、ビルドプロセスが「静か」になり、警告が原因でビルドが失敗したり、開発者が不要な警告に煩わされたりするのを防ぎます。

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

https://github.com/golang/go/commit/6699aa4aeea17acb4751f1bdbf259e16f9ad0033

元コミット内容

commit 6699aa4aeea17acb4751f1bdbf259e16f9ad0033
Author: Russ Cox <rsc@golang.org>
Date:   Thu Dec 15 18:37:31 2011 -0500

    crypto/tls: quiet build
    
    On a Mac, all the useful functions are deprecated.
    
    R=golang-dev, adg
    CC=golang-dev
    https://golang.org/cl/5493054

変更の背景

この変更の背景には、macOSのオペレーティングシステムにおけるAPIの進化と、Go言語の crypto/tls パッケージがその変化に対応する必要があったという事情があります。

crypto/tls パッケージは、TLS (Transport Layer Security) プロトコルを実装しており、セキュアな通信を提供します。macOS環境では、システムが提供するセキュリティフレームワーク（特に Security.framework や CoreFoundation.framework）を利用して、ルート証明書ストアへのアクセスなどを行います。

コミットメッセージにある「On a Mac, all the useful functions are deprecated.」という記述は、当時のmacOSのバージョンアップ（特にMac OS X 10.6から10.7への移行期）において、以前のバージョンで利用されていたAPIが非推奨（deprecated）とされたことを示唆しています。非推奨のAPIを使用しているコードは、コンパイル時に警告を生成します。通常、警告はビルドの成功を妨げませんが、開発プロセスにおいてはノイズとなり、重要な警告を見落とす原因となる可能性があります。また、一部のビルドシステムやCI/CDパイプラインでは、警告をエラーとして扱い、ビルドを中断する設定（例: -Werror フラグ）がされている場合があります。

Go言語の標準ライブラリとして、幅広いmacOSバージョンで安定して動作し、かつクリーンなビルドを維持することは重要です。このコミットは、非推奨APIの使用を直ちに修正するのではなく、一時的な措置として警告を抑制することで、ビルドの安定性と開発者の体験を向上させることを目的としています。

前提知識の解説

このコミットを理解するためには、以下の前提知識が役立ちます。

  1. TLS (Transport Layer Security): インターネット上でデータを安全にやり取りするための暗号化プロトコルです。ウェブサイトのHTTPS接続などで広く利用されています。TLSは、通信相手の認証、データの暗号化、データ改ざんの検出などの機能を提供します。

  2. ルート証明書ストア: 信頼できる認証局（CA）の公開鍵証明書が保存されている場所です。TLS通信において、サーバーから提示された証明書が信頼できるものであるかを確認するために利用されます。macOSでは、システムレベルでこのストアが管理されています。

  3. Cgo: Go言語の機能の一つで、C言語のコードをGoプログラムから呼び出すことを可能にします。Go言語の標準ライブラリには、OS固有の機能やパフォーマンスが要求される部分でCgoが利用されることがあります。crypto/tls パッケージがmacOSのセキュリティフレームワークを利用する際にCgoが使われています。

  4. コンパイラフラグ (CGO_CFLAGS, CGO_LDFLAGS): Cgoを使用する際、GoのビルドシステムはCコンパイラ（通常はGCCやClang）を呼び出してCコードをコンパイルします。この際、Cコンパイラに渡すオプションを指定するために CGO_CFLAGS (Cコンパイラフラグ) や CGO_LDFLAGS (リンカフラグ) が使われます。

    • -Wno-error: コンパイル時に発生するすべての警告をエラーとして扱わないようにするフラグです。通常、-Werror は警告をエラーに昇格させ、ビルドを失敗させますが、このフラグはその逆の動作をします。
    • -Wno-deprecated-declarations: 非推奨（deprecated）とマークされた関数や変数を使用していることによる警告を抑制するフラグです。

  5. 非推奨 (Deprecated) API: ソフトウェア開発において、API（Application Programming Interface）が「非推奨」とマークされることがあります。これは、そのAPIが将来のバージョンで削除される可能性があること、またはより良い代替手段が存在することを示します。開発者は非推奨APIの使用を避けることが推奨されますが、後方互換性を維持するために一時的に使用し続けることもあります。

技術的詳細

このコミットの技術的詳細を掘り下げます。

src/pkg/crypto/tls/root_darwin.go ファイルは、Goの crypto/tls パッケージがmacOS上で動作する際に、システムのルート証明書ストアにアクセスするためのロジックを含んでいます。macOSでは、この機能はCore FoundationおよびSecurityフレームワークを通じて提供されます。

Goのビルドシステムは、root_darwin.go 内のCgoディレクティブを解釈し、Cコンパイラを呼び出して関連するCコードをコンパイルします。

変更前の root_darwin.go には、以下のCgoディレクティブが含まれていました。

// Note: We disable -Werror here because the code in this file uses a deprecated API to stay
// compatible with both Mac OS X 10.6 and 10.7. Using a deprecated function on Darwin generates
// a warning.
#cgo CFLAGS: -Wno-error
#cgo LDFLAGS: -framework CoreFoundation -framework Security
#include <CoreFoundation/CoreFoundation.h>
#include <Security/Security.h>

この設定では、-Wno-error フラグが指定されており、すべての警告がエラーとして扱われるのを防いでいました。しかし、コミットメッセージにあるように、非推奨の関数を使用していること自体が警告を生成し、その警告がビルドの「ノイズ」となっていました。

このコミットでは、CGO_CFLAGS に -Wno-deprecated-declarations フラグが追加されました。

#cgo CFLAGS: -Wno-error -Wno-deprecated-declarations

この追加により、Cコンパイラは非推奨の宣言を使用していることによる警告を明示的に抑制するようになります。これにより、ビルド出力からこれらの警告が消え、より「静かな」ビルドが実現されます。

このアプローチは、非推奨APIの使用を根本的に解決するものではありませんが、当時のGoのバージョンがmacOS 10.6と10.7の両方で互換性を維持する必要があったため、実用的な解決策でした。新しいAPIに完全に移行するには、より複雑な条件分岐や、古いOSバージョンでの動作を保証するための追加の作業が必要になる場合があります。このコミットは、そのような大規模な変更を行うことなく、ビルドの健全性を一時的に改善するためのものです。

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

変更は src/pkg/crypto/tls/root_darwin.go ファイルの1行のみです。

--- a/src/pkg/crypto/tls/root_darwin.go
+++ b/src/pkg/crypto/tls/root_darwin.go
@@ -8,7 +8,7 @@ package tls
 // Note: We disable -Werror here because the code in this file uses a deprecated API to stay
 // compatible with both Mac OS X 10.6 and 10.7. Using a deprecated function on Darwin generates
 // a warning.
-#cgo CFLAGS: -Wno-error
+#cgo CFLAGS: -Wno-error -Wno-deprecated-declarations
 #cgo LDFLAGS: -framework CoreFoundation -framework Security
 #include <CoreFoundation/CoreFoundation.h>
 #include <Security/Security.h.h>

コアとなるコードの解説

変更された行は、Cgoディレクティブの一部である CGO_CFLAGS の定義です。

  • 変更前: #cgo CFLAGS: -Wno-error これは、Cコンパイラに対して、すべての警告をエラーとして扱わないように指示していました。つまり、警告が発生してもビルドは中断されません。

  • 変更後: #cgo CFLAGS: -Wno-error -Wno-deprecated-declarations 既存の -Wno-error に加えて、-Wno-deprecated-declarations フラグが追加されました。この新しいフラグは、特に「非推奨とされた宣言（関数、変数など）を使用している」という種類の警告を抑制します。

この変更により、root_darwin.go 内のCコードがmacOSの非推奨APIを使用していることによって発生していたコンパイル時の警告が、ビルド出力に表示されなくなります。これにより、開発者はビルドログから不要な警告ノイズを取り除き、より重要な情報に集中できるようになります。

関連リンク

  • Go言語の公式ドキュメント: https://golang.org/
  • Go言語のCgoに関するドキュメント: https://pkg.go.dev/cmd/cgo (現在のドキュメントは当時のものと異なる可能性がありますが、Cgoの基本的な概念は共通です)
  • Clang Compiler User's Manual (GCC/Clangの-Wno-deprecated-declarationsに関する情報): https://clang.llvm.org/docs/UsersManual.html (当時のバージョンと完全に一致するとは限りませんが、フラグの一般的な意味は共通です)

参考にした情報源リンク

  • Go言語のソースコードリポジトリ (GitHub): https://github.com/golang/go
  • Go言語のコードレビューシステム (Gerrit): https://go-review.googlesource.com/ (コミットメッセージに記載されている https://golang.org/cl/5493054 は、当時のGerritのURL形式です。現在は go-review.googlesource.com にリダイレクトされるか、直接アクセスできます。)
  • macOS Developer Documentation (Apple Developer): 非推奨APIに関する一般的な情報や、Core Foundation/SecurityフレームワークのAPIリファレンス。