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

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

このコミットは、Go言語のビルドシステムの一部である cmd/dist において、Clangコンパイラを使用する際に不要となった特定のコンパイラフラグを削除するものです。具体的には、src/cmd/dist/build.c ファイルから -Wno-dangling-else-Wno-unused-value という警告抑制フラグが削除されています。これにより、GoのソースコードがClangでクリーンにビルドされるためにこれらのフラグがもはや必要ないことが示されています。

コミット

commit 4ba27df69c4bf9ce00eb34bb69860a248319be11
Author: Dave Cheney <dave@cheney.net>
Date:   Thu Jan 10 08:00:03 2013 +1100

    cmd/dist: drop unneeded clang flags
    
    Our source no longer needs these flags set to build cleanly using clang.
    
    Tested with
    
    * Ubuntu clang version 3.0-6ubuntu3 (tags/RELEASE_30/final) (based on LLVM 3.0) on i386
    * clang version 3.2 (tags/RELEASE_32/final) on amd64 cross compiling all platforms
    
    R=golang-dev, rsc
    CC=golang-dev
    https://golang.org/cl/7058053

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

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

元コミット内容

cmd/dist: drop unneeded clang flags

Our source no longer needs these flags set to build cleanly using clang.

Tested with

* Ubuntu clang version 3.0-6ubuntu3 (tags/RELEASE_30/final) (based on LLVM 3.0) on i386
* clang version 3.2 (tags/RELEASE_32/final) on amd64 cross compiling all platforms

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

変更の背景

この変更の背景には、Go言語のコンパイラおよびツールチェインの継続的な改善があります。Goプロジェクトは、その初期段階から様々なプラットフォームやコンパイラでのビルドをサポートするために、特定のコンパイラフラグやワークアラウンドを必要とすることがありました。特に、Goのツールチェイン自体がC言語で書かれた部分(例えば cmd/dist や一部のランタイムコード)を含んでいたため、これらのCコードをコンパイルする際に、使用するCコンパイラ(GCCやClangなど)の特性に合わせた調整が必要でした。

過去には、Clangコンパイラが特定のコードパターンに対して警告を発することがあり、Goのビルドプロセスをクリーンに保つために、これらの警告を抑制するフラグ(-Wno-dangling-else-Wno-unused-value)が cmd/dist/build.c に明示的に追加されていました。

しかし、Goのソースコード自体が進化し、あるいはClangコンパイラ自体の改善(新しいバージョンでの警告の挙動変更やバグ修正など)により、これらの警告がもはや発生しなくなった、または警告の原因となっていたコードパターンがGoのソースコードから修正・削除された可能性があります。このコミットは、そのような状況の変化を反映し、不要になったコンパイラフラグを削除することで、ビルド設定の簡素化とクリーンアップを図るものです。これは、ビルドシステムの保守性を高め、将来的なコンパイラの更新に対する互換性を向上させるための一般的なプラクティスです。

前提知識の解説

Go言語のビルドシステム (cmd/dist)

Go言語のビルドプロセスは、他の多くの言語とは異なり、独自のツールチェインによって管理されています。その中心的な役割を担うのが cmd/dist です。cmd/dist は、GoのソースコードからGoコンパイラ、アセンブラ、リンカなどのツールチェイン自体をビルドするためのブートストラップツールです。

Goの初期のバージョンでは、Goコンパイラ自体がまだGo言語で完全に書かれていなかったため、一部のコアツールやランタイムはC言語で実装されていました。cmd/dist は、これらのC言語で書かれた部分を、システムにインストールされているCコンパイラ(GCCやClangなど)を使ってコンパイルする役割を担っていました。

cmd/dist/build.c は、cmd/dist のC言語部分のソースコードの一つであり、ビルドプロセスにおけるCコンパイラの呼び出しやフラグの設定など、低レベルなビルドロジックを定義しています。

Clangコンパイラ

Clangは、LLVMプロジェクトの一部として開発されているC、C++、Objective-C、Objective-C++言語のコンパイラフロントエンドです。GCC(GNU Compiler Collection)の代替として広く利用されており、高速なコンパイル、優れたエラー診断、モジュール性などの特徴を持っています。

コンパイラ警告と警告抑制フラグ

コンパイラは、プログラムのコンパイル時に、潜在的な問題や非推奨の構文などに対して「警告(warning)」を発することがあります。警告はエラーとは異なり、通常はプログラムのコンパイルを妨げませんが、実行時の未定義動作やバグにつながる可能性があるため、開発者はこれらの警告に注意を払うべきです。

コンパイラには、特定の警告を抑制するためのフラグが用意されています。例えば、ClangやGCCでは -Wno- プレフィックスを使って警告を無効にできます。

  • -Wno-dangling-else: このフラグは、「dangling else」(宙ぶらりんのelse)警告を抑制します。これは、if 文と else 文の間に曖昧さがある場合に発生する警告です。例えば、ネストされた if 文で else がどの if に対応するかが不明瞭な場合にコンパイラが警告を発することがあります。

    if (condition1)
        if (condition2)
            do_something();
    else // このelseがcondition1に対応するのか、condition2に対応するのか曖昧
        do_another_thing();
    

    C言語の仕様では、else は最も近い if に結合されると定められていますが、視覚的なインデントと異なる場合に混乱を招くため、コンパイラが警告を発することがあります。

  • -Wno-unused-value: このフラグは、計算された値が使用されない場合に発生する警告を抑制します。例えば、関数の戻り値が無視されたり、式の結果が変数に代入されずに破棄されたりする場合に警告が出ます。

    int func() { return 10; }
    // ...
    func(); // 戻り値が使用されていない
    

    このような警告は、意図しないバグや非効率なコードを示唆することがありますが、時には意図的に値を無視する場合もあるため、開発者が明示的に抑制することもあります。

これらのフラグが削除されたということは、Goのソースコードがこれらの警告を発生させるようなパターンを含まなくなったか、あるいはClangの新しいバージョンがこれらの警告をより賢く処理するようになったことを意味します。

技術的詳細

このコミットは、GoのビルドシステムにおけるClangコンパイラの利用に関する最適化とクリーンアップです。src/cmd/dist/build.c ファイルは、Goのツールチェインをビルドする際にCコンパイラ(この場合はClang)をどのように呼び出すかを定義しています。

変更前のコードでは、CコンパイラがClangであると検出された場合、以下の2つの警告抑制フラグが gccargs(Cコンパイラへの引数リスト)に追加されていました。

  1. -Wno-dangling-else: ifelse の結合に関する曖昧さによる警告を抑制。
  2. -Wno-unused-value: 計算された値が使用されないことによる警告を抑制。

これらのフラグは、GoのC言語ソースコードが特定のClangの警告ルールに抵触していたために、ビルドを警告なしで完了させる目的で追加されていたと考えられます。しかし、コミットメッセージにあるように、「Our source no longer needs these flags set to build cleanly using clang.」(我々のソースはもはやClangを使ってクリーンにビルドするためにこれらのフラグを必要としない)という状況になったため、これらのフラグが削除されました。

この変更は、以下のいずれかの理由によるものと考えられます。

  • Goソースコードの改善: cmd/dist やその他のC言語で書かれたGoのコンポーネントのソースコードがリファクタリングされ、dangling elseunused value の警告を引き起こすようなコードパターンが修正された。
  • Clangコンパイラの進化: Clangコンパイラ自体が進化し、これらの警告の検出ロジックが改善された、またはデフォルトの警告レベルが変更された結果、Goの既存のコードがもはやこれらの警告をトリガーしなくなった。特に、Clang 3.0および3.2でのテストが言及されていることから、これらのバージョンでの挙動の変化が影響している可能性が高いです。

フラグの削除は、ビルドスクリプトの複雑さを軽減し、よりクリーンなビルドプロセスを実現します。また、将来的にClangの新しいバージョンがリリースされた際に、これらの特定の警告抑制フラグが原因で予期せぬ問題が発生するリスクを低減します。

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

--- a/src/cmd/dist/build.c
+++ b/src/cmd/dist/build.c
@@ -601,10 +601,6 @@ install(char *dir)
 		splitfields(&gccargs, bstr(&b));
 		for(i=0; i<nelem(proto_gccargs); i++)
 			vadd(&gccargs, proto_gccargs[i]);
-		if(xstrstr(bstr(&b), "clang") != nil) {
-			vadd(&gccargs, "-Wno-dangling-else");
-			vadd(&gccargs, "-Wno-unused-value");
-		}
 	}
 
 islib = hasprefix(dir, "lib") || streq(dir, "cmd/cc") || streq(dir, "cmd/gc");

コアとなるコードの解説

変更されたコードは src/cmd/dist/build.c ファイル内の install 関数の一部です。この関数は、Goのツールチェインのコンポーネントをビルドし、インストールするプロセスを管理しています。

変更前のコードでは、以下の if ブロックが存在していました。

		if(xstrstr(bstr(&b), "clang") != nil) {
			vadd(&gccargs, "-Wno-dangling-else");
			vadd(&gccargs, "-Wno-unused-value");
		}

このブロックは、Cコンパイラの出力(bstr(&b) で取得される文字列、おそらくコンパイラのバージョン情報などを含む)に "clang" という文字列が含まれているかどうかを xstrstr 関数でチェックしていました。もし "clang" が見つかった場合、それは現在使用しているCコンパイラがClangであることを意味します。

Clangが検出された場合、vadd(&gccargs, ...) を使って、gccargs という引数リストに2つのフラグが追加されていました。

  • -Wno-dangling-else
  • -Wno-unused-value

これらの vadd 呼び出しは、Clangコンパイラに特定の警告を抑制するように指示するためのものでした。

このコミットでは、上記の if ブロック全体が削除されています。これは、Goのソースコードがもはやこれらの警告をClangで発生させないようになったため、これらの警告抑制フラグが不要になったことを意味します。結果として、ビルドスクリプトが簡素化され、よりクリーンな状態になりました。

関連リンク

参考にした情報源リンク

  • Clang Compiler User's Manual: https://clang.llvm.org/docs/UsersManual.html (Clangの警告フラグに関する一般的な情報)
  • Go言語のビルドシステムに関するドキュメントや議論(一般的な知識として)
  • GCCの警告オプションに関するドキュメント(Clangと共通する部分があるため)