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

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

このドキュメントは、Go言語のコミットインデックス10035、ハッシュ389d55fadf8ed166cc06c016d9eae3dda5e249b8に関する包括的な技術解説を提供します。このコミットは、GoコンパイラにGCFLAGSを渡す機能を追加することで、デバッグや特定のテストシナリオを容易にすることを目的としています。特に、最適化のデバッグやrune safetyのテストといった用途が想定されています。

コミット

commit 389d55fadf8ed166cc06c016d9eae3dda5e249b8
Author: Russ Cox <rsc@golang.org>
Date:   Tue Oct 18 14:55:10 2011 -0400

    build: pass $GCFLAGS to compiler
    
    For example, if you are debugging an optimization
    problem you can now run
    
            GCFLAGS=-N gotest
    
    This is a convention for make, not for the general build,
    so it may go away or be done differently in the eventual
    'go' command.
    
    The plan is that people will be able to test their code for
    rune safety by doing GCFLAGS=-r.
    
    R=golang-dev, bradfitz, lvd
    CC=golang-dev
    https://golang.org/cl/5294042

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

https://github.com/golang/go/commit/389d55fadf8ed166cc06c016d9eae3dda5e249b8

元コミット内容

このコミットは、Goのビルドシステムにおいて、$GCFLAGS環境変数をコンパイラに渡すように変更します。これにより、例えば最適化の問題をデバッグする際にGCFLAGS=-N gotestのように実行できるようになります。これはmakeコマンドの慣習であり、将来のgoコマンドでは異なる方法になる可能性が示唆されています。また、GCFLAGS=-rとすることで、コードのrune safetyをテストできるようになるという計画も述べられています。

変更の背景

この変更の主な背景は、Go言語のコンパイラ（gc）の挙動を、ビルド時に外部から制御できるようにすることです。特に、以下の2つのシナリオが挙げられています。

  1. 最適化のデバッグ: コンパイラの最適化が原因で発生する可能性のあるバグや予期せぬ挙動をデバッグする際に、一時的に最適化を無効化する機能が必要とされました。GCFLAGS=-Nというオプションがその目的で導入されています。
  2. rune safetyのテスト: Go言語における文字列の扱い、特にUnicode文字（rune）の安全な処理は、多言語対応のアプリケーション開発において非常に重要です。開発者が自身のコードがrune safetyを適切に満たしているかを確認するためのメカニズムが求められていました。GCFLAGS=-rというオプションがその目的で計画されていました。

このコミットは、当時のGoのビルドシステムがmakeベースであったため、Makefileにこれらの変更を組み込むことで、開発者がこれらのデバッグ・テスト機能を活用できるようにすることを意図しています。将来的には、より統合されたgoコマンドで同様の機能が提供されることが見込まれていました。

前提知識の解説

Goコンパイラ (gc)

Go言語の標準コンパイラはgcと呼ばれます。これはGo言語で書かれたソースコードを機械語に変換する役割を担っています。gcは、コードの最適化、インライン化、エスケープ解析など、様々なコンパイル時処理を行います。

GCFLAGS

GCFLAGSは、Goコンパイラ（gc）に渡すことができるオプション（フラグ）の集合です。これらのフラグを使用することで、コンパイル時の挙動を細かく制御できます。

  • GCFLAGS=-N: このフラグは、コンパイラの最適化を無効化するために使用されます。最適化は通常、プログラムの実行速度を向上させますが、デバッグ時にはコードの実行パスが複雑になり、問題の特定が困難になることがあります。-Nを使用することで、最適化による影響を排除し、より直接的にコードの挙動を追跡できるようになります。ただし、Web検索の結果によると、-Nは公式に広く文書化されているフラグではない可能性があり、内部的な用途や特定のバージョンでのみ有効な場合もあります。
  • GCFLAGS=-r: コミットメッセージでは、このフラグが「rune safety」のテストのために計画されていると述べられています。Web検索の結果では、Goコンパイラの標準的なGCFLAGSとして-rは一般的に文書化されていません。これは、Goコンパイラの内部デバッグフラグであるか、あるいはこのコミット時点での将来の計画であり、最終的に異なる形で実装されたか、あるいは廃止された可能性が考えられます。

rune safety

Go言語における「rune safety」とは、Unicode文字（rune）を文字列として扱う際に、文字の境界を正しく認識し、意図しないデータ破損や誤った処理を防ぐことを指します。Goの文字列はUTF-8エンコードされたバイト列であり、1つのUnicode文字が1バイトから4バイトの可変長で表現されます。

  • 文字列とバイト列: Goのstring型は、読み取り専用のバイトスライスです。len()関数は文字列のバイト数を返し、文字数ではありません。例えば、日本語の「こんにちは」はUTF-8で15バイトですが、文字数は5文字です。
  • runeの概念: runeはint32のエイリアスであり、単一のUnicodeコードポイントを表します。Goでは、文字列をfor rangeループでイテレートすると、各runeとその開始バイトインデックスが返されます。これにより、マルチバイト文字を正しく処理できます。
  • 一般的な落とし穴:
    • len()を文字数と誤解する。
    • 文字列を直接インデックスアクセス（例: s[0]）すると、バイト単位でアクセスしてしまうため、マルチバイト文字の途中で切れてしまう可能性がある。
    • 従来のforループでs[i]のようにイテレートすると、バイト単位の処理となり、文字の境界を無視してしまう。
  • rune safetyを確保する方法:
    • for rangeループの使用: 文字列をイテレートする際は、常にfor rangeループを使用し、各runeを正しく取得する。
    • unicode/utf8パッケージの利用: utf8.RuneCountInString()で正確な文字数を取得したり、utf8.DecodeRuneInString()でルーンをデコードしたりする。
    • []runeへの変換: 文字列を文字単位で操作（例: 文字列の反転）する必要がある場合は、[]rune型に変換してから操作する。

Makefile

Makefileは、ソフトウェアのビルドプロセスを自動化するためのファイルです。makeコマンドによって解釈され、ソースコードのコンパイル、リンク、テストなどの一連のタスクを定義します。このコミットでは、Goのビルドプロセスを制御するMakefileが変更され、GCFLAGSがコンパイラに渡されるように設定されています。

技術的詳細

このコミットの技術的詳細は、Goのビルドシステムがmakeベースであった当時の状況を反映しています。変更は主に以下の3つのファイルにわたります。

  1. src/Make.cmd: Goのコマンド（実行可能ファイル）をビルドするためのMakefileのルールを定義しています。
  2. src/Make.pkg: Goのパッケージ（ライブラリ）をビルドするためのMakefileのルールを定義しています。
  3. test/run: Goのテストを実行するためのシェルスクリプトです。

これらのファイルにおいて、Goコンパイラ（$(GC)）を呼び出す際に、新たに$(GCFLAGS)変数が引数として追加されています。これにより、makeコマンドを実行する際にGCFLAGS環境変数を設定することで、コンパイラの挙動を外部から制御できるようになります。

例えば、GCFLAGS=-N makeのように実行すると、makeプロセス内でGCFLAGSが-Nに設定され、それがMake.cmdやMake.pkg内のコンパイルコマンドに引き継がれ、結果としてコンパイラが最適化を無効にしてビルドを行うようになります。

また、test/runスクリプトの変更は、テスト実行環境においてもGCFLAGSがGoコンパイラに適切に渡されるようにするためのものです。具体的には、Gという環境変数（Goコンパイラへのパスとフラグを含む）にGCFLAGSが追加されています。

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

--- a/src/Make.cmd
+++ b/src/Make.cmd
@@ -20,7 +20,7 @@ $(TARG): _go_.$O
  	$(LD) $(LDIMPORTS) -o $@ _go_.$O
 
 _go_.$O: $(GOFILES) $(PREREQ)
-	$(GC) $(GCIMPORTS) -o $@ $(GOFILES)
+	$(GC) $(GCFLAGS) $(GCIMPORTS) -o $@ $(GOFILES)
 
 install: $(TARGDIR)/$(TARG)
 
@@ -44,7 +44,7 @@ _test/main.a: _gotest_.$O
  	gopack grc $@ _gotest_.$O
 
 _gotest_.$O: $(GOFILES) $(GOTESTFILES)
-	$(GC) $(GCIMPORTS) -o $@ $(GOFILES) $(GOTESTFILES)
+	$(GC) $(GCFLAGS) $(GCIMPORTS) -o $@ $(GOFILES) $(GOTESTFILES)
 
 importpath:
 	echo main
--- a/src/Make.pkg
+++ b/src/Make.pkg
@@ -83,10 +83,10 @@ $(TARGDIR)/$(TARG).a: _obj/$(TARG).a
  	cp _obj/$(TARG).a "$@"
 
 _go_.$O: $(GOFILES) $(PREREQ)
-	$(GC) $(GCIMPORTS) -p $(TARG) -o $@ $(GOFILES)
+	$(GC) $(GCFLAGS) $(GCIMPORTS) -p $(TARG) -o $@ $(GOFILES)
 
 _gotest_.$O: $(GOFILES) $(GOTESTFILES) $(PREREQ)
-\t$(GC) $(GCIMPORTS) -p $(TARG) -o $@ $(GOFILES) $(GOTESTFILES)
+\t$(GC) $(GCFLAGS) $(GCIMPORTS) -p $(TARG) -o $@ $(GOFILES) $(GOTESTFILES)
 
 _obj/$(TARG).a: _go_.$O $(OFILES)
  	@mkdir -p _obj/$(dir)
--- a/test/run
+++ b/test/run
@@ -23,7 +23,7 @@ Xarm)
  	exit 1
  esac
  
-export G=${A}g
+export G="${A}g ${GCFLAGS}"
 export L=${A}l
 export GOTRACEBACK=0
 export LANG=C

コアとなるコードの解説

src/Make.cmd および src/Make.pkg の変更

これらのファイルは、Goの実行可能ファイルやパッケージをビルドする際のMakefileのルールを定義しています。変更は、Goコンパイラ（$(GC)）を呼び出す行に集中しています。

  • 変更前: 
    $(GC) $(GCIMPORTS) -o $@ $(GOFILES)
  • 変更後: 
    $(GC) $(GCFLAGS) $(GCIMPORTS) -o $@ $(GOFILES)

この変更により、$(GC)コマンドの引数リストに$(GCFLAGS)が追加されました。$(GCFLAGS)は、makeコマンドが実行される環境で設定されたGCFLAGS環境変数の値に展開されます。例えば、シェルでGCFLAGS="-N"と設定してからmakeを実行すると、コンパイラは-Nオプション付きで呼び出され、最適化が無効化されます。

同様の変更が、通常のビルドターゲットである_go_.$Oと、テストビルドターゲットである_gotest_.$Oの両方に対して行われています。これは、通常のアプリケーションコードのコンパイル時だけでなく、テストコードのコンパイル時にもGCFLAGSを適用できるようにするためです。

test/run の変更

test/runスクリプトは、Goのテストスイートを実行するためのシェルスクリプトです。このスクリプトでは、Goコンパイラへのパスとオプションを保持するGという環境変数が設定されています。

  • 変更前: 
    export G=${A}g
  • 変更後: 
    export G="${A}g ${GCFLAGS}"

この変更により、G環境変数の値にGCFLAGSが追加されました。Aはアーキテクチャ固有のプレフィックス（例: 6g、8gなど）を表し、${A}gはGoコンパイラへのパス（例: /path/to/6g）を指します。変更後は、このパスに加えて、GCFLAGS環境変数の値もGに含められるようになります。

これにより、test/runスクリプト内でGoコンパイラが呼び出される際に、GCFLAGSが自動的に適用されるようになります。これは、gotestコマンド（Goのテスト実行ツール）が内部的にG環境変数を利用してコンパイラを呼び出すため、テスト実行時にもGCFLAGSによるコンパイラの挙動制御が可能になることを意味します。

関連リンク

参考にした情報源リンク