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

このコミットは、Goランタイムにおけるスタックトレース出力時の関数引数の表示制限を緩和するものです。具体的には、スタックトレースに表示される関数引数の「ワード」数（uintptrのサイズ単位）の上限を、従来の5ワードから10ワードに倍増させています。これにより、デバッグ時に、より多くの引数情報を確認できるようになり、特にインターフェース値、文字列、スライスといった複数のワードを占める引数の可読性が向上します。

コミット

commit c40480ddd9489f4c8c74b061d4397567ccb835cd
Author: Russ Cox <rsc@golang.org>
Date:   Wed Apr 2 23:00:40 2014 -0400

    runtime: print up to 10 words of arguments

    The old limit of 5 was chosen because we didn't actually know how
    many bytes of arguments there were; 5 was a halfway point between
    printing some useful information and looking ridiculous.

    Now we know how many bytes of arguments there are, and we stop
    the printing when we reach that point, so the "looking ridiculous" case
    doesn't happen anymore: we only print actual argument words.
    The cutoff now serves only to truncate very long (but real) argument lists.

    In multiple debugging sessions recently (completely unrelated bugs)
    I have been frustrated by not seeing more of the long argument lists:
    5 words is only 2.5 interface values or strings, and not even 2 slices.
    Double the max amount we'll show.

    LGTM=bradfitz
    R=golang-codereviews, bradfitz
    CC=golang-codereviews, iant, r
    https://golang.org/cl/83850043

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

https://github.com/golang/go/commit/c40480ddd9489f4c8c74b061d4397567ccb835cd

元コミット内容

Goランタイムにおいて、スタックトレース出力時に表示される関数引数のワード数を5から10に増やします。

以前の5ワードという制限は、引数のバイト数が正確に分からなかったため、有用な情報と不自然な表示の中間点として設定されていました。

現在では、引数のバイト数が正確に把握できるようになったため、そのバイト数に達した時点で表示を停止できます。これにより、「不自然な表示」になるケースは発生せず、実際の引数ワードのみが表示されるようになりました。この表示制限は、非常に長い（しかし実際の）引数リストを切り詰めるためだけに機能します。

最近の複数のデバッグセッション（全く関係のないバグ）において、長い引数リストのより多くの部分が見えないことに不満を感じていました。5ワードでは、インターフェース値や文字列は2.5個分、スライスに至っては2個分にも満たない情報しか表示されません。表示する最大量を倍増させます。

変更の背景

この変更の背景には、Goランタイムのスタックトレース出力におけるデバッグ情報の不足がありました。従来のスタックトレースでは、関数呼び出し時の引数が最大5ワード（uintptrのサイズ単位）までしか表示されませんでした。

コミットメッセージによると、この5ワードという制限は、以前は引数の正確なバイト数が不明であったため、有用な情報を提供しつつも、不自然な表示にならないようにするための妥協点として設定されていました。しかし、Goランタイムの進化により、引数の正確なバイト数を把握できるようになったため、この制限を緩和しても不自然な表示になるリスクがなくなりました。

コミットの作者であるRuss Cox氏は、複数のデバッグセッションにおいて、この5ワードという制限がデバッグ作業の妨げになっていると感じていました。特に、インターフェース値、文字列、スライスといったデータ型は、内部的に複数のワードを占めることが多いため、5ワードではこれらの引数の内容を十分に把握できませんでした。例えば、インターフェース値や文字列は通常2ワード（型情報とデータポインタ）、スライスは3ワード（データポインタ、長さ、容量）を占めます。そのため、5ワードの制限では、これらの引数が途中で切り詰められてしまい、デバッグに必要な情報が得られないことが頻繁に発生していました。

この問題を解決し、デバッグ時の利便性を向上させるために、引数の表示制限を10ワードに倍増させる決定がなされました。これにより、より多くの引数情報がスタックトレースに表示されるようになり、デバッグ作業の効率化が期待されます。

前提知識の解説

このコミットを理解するためには、以下のGoランタイムとスタックトレースに関する基本的な知識が必要です。

1. Goランタイム (Go Runtime): Goランタイムは、Goプログラムの実行を管理する低レベルのシステムです。これには、ガベージコレクション、スケジューリング（ゴルーチンの管理）、メモリ管理、そしてスタックトレースの生成などが含まれます。Goプログラムは、OS上で直接実行されるのではなく、このランタイム上で動作します。

2. スタックトレース (Stack Trace): スタックトレースは、プログラムが特定の時点（例えば、パニック発生時やデバッガで停止した時）に実行していた関数呼び出しのシーケンス（呼び出し履歴）を示すものです。各フレームは、呼び出し元の関数、その関数が呼び出されたプログラムカウンタ（PC）、そしてその関数に渡された引数などの情報を含みます。デバッグにおいて、問題発生時のプログラムの状態を把握するために不可欠な情報です。

3. uintptr: uintptrは、Goにおける符号なし整数型で、ポインタを保持するのに十分な大きさがあります。これは、メモリ上のアドレスを表現するために使用されます。Goのランタイムコードでは、メモリ上のデータ（例えば、関数引数）をワード単位で扱う際に、uintptrのサイズが基準となります。32ビットシステムでは4バイト、64ビットシステムでは8バイトです。

4. 関数引数のメモリ表現: Goの関数に渡される引数は、通常、スタック上に配置されます。引数のサイズは、その型によって異なります。例えば、intやboolのようなプリミティブ型は1ワードを占めることが多いですが、string、interface{}、[]byte（スライス）のような複合型は、その実体がヒープに置かれ、スタック上にはその実体へのポインタや長さ、容量などのメタデータが格納されます。これらのメタデータが複数のワードを占めるため、5ワードの制限では、これらの複合型の引数全体を表示しきれないことがありました。

5. traceback_arm.c および traceback_x86.c: これらはGoランタイムのソースコードの一部で、それぞれARMアーキテクチャとx86アーキテクチャにおけるスタックトレースの生成ロジックをC言語で記述しています。Goランタイムの低レベルな部分は、パフォーマンスとOSとの連携のためにC言語（またはアセンブリ言語）で実装されていることがあります。これらのファイルには、スタックフレームを解析し、関数名、プログラムカウンタ、そして引数などの情報を抽出して整形する処理が含まれています。

6. runtime·gentraceback 関数: この関数は、Goランタイム内でスタックトレースを生成する主要な関数の一つです。引数として、プログラムカウンタ（pc0）、スタックポインタ（sp0）、リンクレジスタ（lr0、ARMの場合）、ゴルーチン（gp）、スキップするフレーム数（skip）などを受け取り、スタックフレームを遡ってトレース情報を構築します。この関数内で、各スタックフレームの引数情報を抽出し、表示するロジックが実装されています。

7. frame.arglen: frame.arglenは、現在のスタックフレームにおける引数領域の合計バイト長を示します。この値は、関数に渡されたすべての引数がスタック上で占めるメモリ領域のサイズを表します。

技術的詳細

このコミットの技術的な核心は、Goランタイムがスタックトレースを生成する際に、関数引数の表示をどのように制御しているか、そしてその制御ロジックがどのように変更されたかにあります。

Goランタイムは、プログラムがパニックを起こしたり、デバッガによって停止されたりした際に、現在のゴルーチンのスタックトレースを生成します。このプロセスは、主にruntime·gentraceback関数によって行われます。この関数は、スタックフレームを一つずつ遡り、各フレームの情報を解析します。

各スタックフレームには、その関数に渡された引数が格納されているメモリ領域があります。Goランタイムは、この引数領域の開始アドレスと合計バイト長（frame.arglen）を把握しています。

変更前のコードでは、runtime·gentraceback関数内で、引数をワード単位（sizeof(uintptr)）でループ処理し、スタックトレースに出力していました。しかし、このループにはif(i >= 5)という条件があり、i（ワードのインデックス）が5以上になると、それ以降の引数は表示せずに「, ...」と省略していました。これは、引数の正確なバイト数が不明だった時代に、表示が不自然になるのを避けるための暫定的な措置でした。

コミットメッセージにあるように、Goランタイムは現在、frame.arglenを通じて引数領域の正確なバイト数を把握できるようになっています。これにより、表示する引数が実際の引数領域を超えてしまうという「不自然な表示」のケースは発生しなくなりました。したがって、5ワードという固定の制限は、もはや技術的な制約ではなく、単に表示を切り詰めるための人為的な制限となっていました。

このコミットでは、その人為的な制限をif(i >= 5)からif(i >= 10)へと変更しています。これにより、スタックトレースに表示される引数のワード数が倍増し、より多くの引数情報がデバッグ時に利用可能になります。特に、複数のワードを占める複合型の引数（例: string, interface{}, []byte）の場合、この変更によって、それらの引数の内容がより完全に表示されるようになり、デバッグの効率が向上します。

この変更は、src/pkg/runtime/traceback_arm.cとsrc/pkg/runtime/traceback_x86.cという、異なるCPUアーキテクチャ向けのスタックトレース生成ロジックを記述したファイルの両方に適用されています。これは、スタックトレースの生成ロジックがアーキテクチャに依存する部分があるためですが、引数表示の制限ロジック自体は共通しているため、両方のファイルで同様の変更が行われています。

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

変更は、src/pkg/runtime/traceback_arm.cとsrc/pkg/runtime/traceback_x86.cの2つのファイルにわたっています。それぞれのファイルで、関数引数の表示を制御するループ内の条件が変更されています。

src/pkg/runtime/traceback_arm.c

--- a/src/pkg/runtime/traceback_arm.c
+++ b/src/pkg/runtime/traceback_arm.c
@@ -156,7 +156,7 @@ runtime·gentraceback(uintptr pc0, uintptr sp0, uintptr lr0, G *gp, int32 skip,
 					tracepc -= sizeof(uintptr);
 					runtime·printf("%s(", runtime·funcname(f));
 					for(i = 0; i < frame.arglen/sizeof(uintptr); i++) {
-						if(i >= 5) {
+						if(i >= 10) {
 							runtime·prints(", ...");
 							break;
 						}

src/pkg/runtime/traceback_x86.c

--- a/src/pkg/runtime/traceback_x86.c
+++ b/src/pkg/runtime/traceback_x86.c
@@ -217,7 +217,7 @@ runtime·gentraceback(uintptr pc0, uintptr sp0, uintptr pc, G *gp, int32 skip,
 					tracepc--;
 					runtime·printf("%s(", runtime·funcname(f));
 					for(i = 0; i < frame.arglen/sizeof(uintptr); i++) {
-						if(i >= 5) {
+						if(i >= 10) {
 							runtime·prints(", ...");
 							break;
 						}

コアとなるコードの解説

上記の変更箇所は、Goランタイムがスタックトレースを生成する際に、関数引数をフォーマットして出力する部分です。

runtime·gentraceback関数は、スタックフレームを解析し、各関数の情報を取得します。その中で、for(i = 0; i < frame.arglen/sizeof(uintptr); i++)というループがあります。

• frame.arglen: 現在のスタックフレームにおける引数領域の合計バイト長です。
• sizeof(uintptr): uintptr型のサイズ（通常、32ビットシステムでは4バイト、64ビットシステムでは8バイト）です。

このループは、引数領域をuintptrのサイズ単位で区切り、各「ワード」を順に処理しています。変数iは、現在処理しているワードのインデックスを表します。

変更前のコードでは、if(i >= 5)という条件がありました。これは、「もし現在処理しているワードのインデックスiが5以上になったら」という意味です。この条件が真になると、runtime·prints(", ...")が呼び出されて引数の表示が「, ...」と省略され、breakによってループが終了していました。つまり、最大で5ワード分の引数しか表示されないようになっていました。

このコミットでは、この条件がif(i >= 10)に変更されています。これにより、iが10以上になるまで引数の表示が続けられるようになります。結果として、スタックトレースには最大で10ワード分の引数が表示されるようになり、より詳細な引数情報がデバッグ時に利用可能になります。

この変更は、ARMとx86という異なるアーキテクチャのスタックトレース生成コードの両方に適用されており、Goがサポートする主要なプラットフォームで一貫したデバッグ体験を提供することを目指しています。

関連リンク

• Go言語の公式ドキュメント: https://golang.org/doc/
• Goのランタイムソースコード (GitHub): https://github.com/golang/go/tree/master/src/runtime

参考にした情報源リンク

• Goのコミットメッセージ (CL 83850043): https://golang.org/cl/83850043
• Google Web Search (for initial context)