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

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

このコミットは、Go言語のランタイムにおけるpanic、defer、recoverに関連するコードを、既存のproc.cおよびruntime.cファイルから、新しく作成されたpanic.cという独立したファイルに移動するものです。この変更は、コードのセマンティクス（動作）には影響を与えず、主にコードの整理と保守性の向上を目的としています。特に、proc.cが1800行を超える大規模なファイルであり、その複雑さを軽減することが意図されています。

コミット

commit a54f920bfe473721ef98d94feb88f395cb642cd4
Author: Dmitriy Vyukov <dvyukov@google.com>
Date:   Wed Jul 4 14:52:51 2012 +0400

    runtime: move panic/defer/recover-related stuff to a separate file
    Move panic/defer/recover-related stuff from proc.c/runtime.c to a new file panic.c.
    No semantic changes.
    proc.c is 1800+ LOC and is a bit difficult to work with.
    
    R=golang-dev, dave, r
    CC=golang-dev
    https://golang.org/cl/6343071

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

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

元コミット内容

runtime: move panic/defer/recover-related stuff to a separate file
Move panic/defer/recover-related stuff from proc.c/runtime.c to a new file panic.c.
No semantic changes.
proc.c is 1800+ LOC and is a bit difficult to work with.

R=golang-dev, dave, r
CC=golang-dev
https://golang.org/cl/6343071

変更の背景

この変更の主な背景は、Goランタイムのソースコードの保守性と可読性の向上です。コミットメッセージに明記されているように、proc.cファイルは当時1800行を超える非常に大きなファイルであり、その巨大さゆえにコードの理解や変更が困難になっていました。panic、defer、recoverといった機能は、Go言語の例外処理とリソース管理において非常に重要な役割を担っていますが、これらに関連するコードが他の多くのランタイム処理と混在している状態でした。

コードを機能ごとに分割し、独立したファイルにまとめることで、以下のメリットが期待されます。

  • 可読性の向上: 特定の機能に関連するコードが1箇所に集約されるため、その機能の全体像を把握しやすくなります。
  • 保守性の向上: 変更が必要な際に、影響範囲を限定しやすくなり、バグの混入リスクを低減できます。
  • 開発効率の向上: 開発者が特定の機能に取り組む際に、関連するコードを素早く見つけ、理解することができます。
  • コンパイル時間の最適化: 厳密にはこのコミット単体での大きな影響はないかもしれませんが、一般的に大規模なCファイルはコンパイルに時間がかかる傾向があり、ファイルの分割は長期的なビルド時間の最適化に寄与する可能性があります。

このコミットは、Goランタイムの継続的な改善と、よりクリーンで管理しやすいコードベースを目指す取り組みの一環として行われました。

前提知識の解説

このコミットを理解するためには、以下のGo言語の概念と、Goランタイムの基本的な構造に関する知識が必要です。

Go言語のpanic、defer、recover

  • panic: Go言語における「パニック」は、プログラムの実行中に回復不可能なエラーが発生したことを示すメカニズムです。例えば、配列の範囲外アクセスやnilポインタのデリファレンスなど、通常はプログラムの異常終了を引き起こすような状況で発生します。panicが発生すると、現在の関数の実行は即座に中断され、遅延関数（deferで登録された関数）が実行されながら、呼び出し元の関数へとスタックが巻き戻されていきます。最終的に、どの関数もパニックを処理しない場合、プログラムはエラーメッセージと共に終了します。
  • defer: deferステートメントは、そのステートメントを含む関数が終了する直前（returnステートメントの実行後、またはpanic発生時）に、指定された関数（遅延関数）を実行することを保証します。これは、ファイルハンドルのクローズ、ロックの解放、データベース接続の終了など、リソースのクリーンアップ処理によく利用されます。複数のdeferステートメントがある場合、それらはLIFO（Last-In, First-Out）の順序で実行されます。
  • recover: recoverは、panicが発生したゴルーチン内で、遅延関数の中からのみ呼び出すことができる組み込み関数です。recoverが呼び出されると、現在のパニックを捕捉し、パニックの連鎖を停止させ、プログラムの正常な実行を再開させることができます。recoverがパニック中に呼び出された場合、パニックの値（panicに渡された引数）を返します。パニック中でない場合、またはdefer関数以外から呼び出された場合はnilを返します。

これらの機能は、Go言語におけるエラーハンドリングとリソース管理の重要な要素であり、特に予期せぬエラーからの回復や、堅牢なアプリケーションの構築に不可欠です。

Goランタイムの構造（C言語部分）

Go言語のランタイムは、Go言語自体で書かれた部分と、C言語（またはアセンブリ言語）で書かれた低レベルな部分から構成されています。このコミットで変更されているファイルは、C言語で書かれたランタイムのコア部分です。

  • proc.c: プロセス（Goにおけるゴルーチンやスケジューラ）の管理に関するコードが含まれるファイルです。ゴルーチンの生成、スケジューリング、コンテキストスイッチなど、Goプログラムの並行実行を支える基盤的な処理が実装されています。
  • runtime.c: ランタイムの一般的なユーティリティ関数や、メモリ管理、ガベージコレクション、シグナルハンドリングなど、Goプログラムの実行環境全体を管理するコードが含まれるファイルです。
  • runtime.h: ランタイムのC言語部分で使用される共通の型定義や関数プロトタイプが宣言されているヘッダファイルです。

これらのC言語ファイルは、Go言語のコードからは直接呼び出されませんが、Goコンパイラによって生成されたコードが、これらのランタイム関数を呼び出すことで、Goプログラムが動作します。

技術的詳細

このコミットの技術的な詳細は、Goランタイムの内部構造におけるモジュール化の推進にあります。

コードの移動とファイル分割

コミットの核心は、panic、defer、recoverに関連するすべてのC言語コードを、src/pkg/runtime/panic.cという新しいファイルに集約したことです。これには、以下の主要な関数が含まれます。

  • runtime·deferproc: deferステートメントがコンパイル時に変換される関数で、遅延関数をゴルーチンの遅延リストに登録します。
  • runtime·deferreturn: 関数が終了する際に呼び出され、登録された遅延関数を実行します。
  • rundefer: 現在のゴルーチンに登録されているすべての遅延関数を実行します。
  • runtime·panic: Goのpanic組み込み関数のC言語実装です。パニックの発生を処理し、遅延関数を実行しながらスタックを巻き戻します。
  • recovery: recoverが呼び出された際に、スタックの巻き戻しを停止し、正常な実行フローに戻すための処理を行います。
  • runtime·recover: Goのrecover組み込み関数のC言語実装です。
  • runtime·unwindstack: スタックを巻き戻すためのヘルパー関数。
  • printpanics: パニック発生時に、現在アクティブなパニック情報を出力します。
  • runtime·startpanic, runtime·dopanic: パニック処理の開始と終了に関連する低レベルな関数。
  • runtime·panicindex, runtime·panicslice, runtime·throwreturn, runtime·throwinit, runtime·throw, runtime·panicstring: 特定のエラー状況（インデックス範囲外、スライス範囲外、コンパイラエラーなど）でパニックを発生させるためのヘルパー関数。
  • runtime·Goexit: runtime.Goexit()関数のC言語実装で、現在のゴルーチンを終了する前に遅延関数を実行します。

これらの関数は、以前はsrc/pkg/runtime/proc.cとsrc/pkg/runtime/runtime.cに分散して存在していました。この移動により、proc.cからは314行、runtime.cからは126行のコードが削除され、panic.cに392行が追加されました。全体として、コードの行数に大きな変化はありませんが、論理的なまとまりが改善されました。

依存関係の調整

コードの移動に伴い、関連するヘッダファイルのインクルードや関数プロトタイプの宣言も調整されています。

  • src/pkg/runtime/panic.cには、新しくruntime.h、arch_GOARCH.h、stack.hがインクルードされています。
  • src/pkg/runtime/proc.cからは、unwindstack関数のプロトタイプ宣言が削除され、代わりにruntime·unwindstackとしてruntime.hで宣言された関数を呼び出すように変更されています。
  • src/pkg/runtime/runtime.cからは、panic関連のグローバル変数（runtime·panicking）やロック（paniclk）、およびpanic関連の関数の定義が削除されています。
  • src/pkg/runtime/runtime.hには、新しくruntime·unwindstack関数のプロトタイプが追加されています。

これらの変更は、新しいファイル構造に合わせて、コンパイルエラーが発生しないようにするための最小限の調整です。

セマンティクスへの影響なし

コミットメッセージで「No semantic changes.」と明記されている通り、この変更はGoプログラムの実行時の動作に一切影響を与えません。これは、単にコードの物理的な配置を変更しただけであり、関数の呼び出し関係や内部ロジックはそのまま維持されているためです。Goランタイムの安定性を損なうことなく、内部的なコードベースの改善が行われたことを意味します。

proc.cの複雑性軽減

proc.cが1800行を超える大規模なファイルであったという問題は、Goランタイム開発者にとって長年の課題でした。このファイルには、ゴルーチンのスケジューリング、M（マシン）とP（プロセッサ）の管理、システムコール、シグナルハンドリングなど、多岐にわたる低レベルな処理が詰め込まれていました。panic、defer、recover関連のコードを分離することで、proc.cの行数が減少し、その複雑性が軽減されました。これにより、proc.cのコードを理解し、変更する際の負担が軽減され、将来的な開発やデバッグが容易になります。

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

このコミットにおけるコアとなるコードの変更は、以下の3つのファイルにおけるコードの移動と、1つのファイルへのプロトタイプ宣言の追加です。

  1. src/pkg/runtime/panic.c (新規作成)

    • runtime·deferproc
    • runtime·deferreturn
    • rundefer
    • printpanics
    • recovery
    • runtime·panic
    • runtime·unwindstack
    • runtime·recover
    • runtime·startpanic
    • runtime·dopanic
    • runtime·panicindex
    • runtime·panicslice
    • runtime·throwreturn
    • runtime·throwinit
    • runtime·throw
    • runtime·panicstring
    • runtime·Goexit これらの関数が、proc.cとruntime.cから移動され、この新しいファイルに集約されました。

  2. src/pkg/runtime/proc.c (変更)

    • static void unwindstack(G*, byte*); の宣言が削除され、runtime·unwindstack(gp, nil); の呼び出しが runtime·unwindstack(gp, nil); に変更されました。これは、unwindstackがpanic.cに移動され、runtime.hでグローバルに宣言されたためです。
    • runtime·deferproc、runtime·deferreturn、rundefer、unwindstack、printpanics、recovery、runtime·panic、runtime·recover、runtime·Goexit の定義がこのファイルから削除されました。

  3. src/pkg/runtime/runtime.c (変更)

    • runtime·panicking グローバル変数、paniclk ロック、および runtime·startpanic、runtime·dopanic、runtime·panicindex、runtime·panicslice、runtime·throwreturn、runtime·throwinit、runtime·throw、runtime·panicstring の定義がこのファイルから削除されました。

  4. src/pkg/runtime/runtime.h (変更)

    • void runtime·unwindstack(G*, byte*); のプロトタイプ宣言が追加されました。これにより、unwindstack関数が他のファイルから呼び出せるようになりました。

これらの変更は、コードの機能的な分離と、それに伴う依存関係の整理を明確に示しています。

コアとなるコードの解説

移動された主要な関数群について、その役割を詳細に解説します。これらの関数はGo言語のpanic、defer、recoverの挙動を低レベルで支えるものです。

runtime·deferproc(int32 siz, byte* fn, ...)

  • 役割: Go言語のdeferステートメントがコンパイル時に呼び出すランタイム関数です。遅延関数（fn）とその引数（sizバイト）を現在のゴルーチン（g）の遅延リスト（g->defer）に登録します。
  • 詳細:
    • Defer構造体（遅延関数の情報を持つ）をアロケートし、関数ポインタfn、引数のサイズsiz、呼び出し元のプログラムカウンタpc、引数ポインタargpを設定します。
    • 引数はd->argsにコピーされます。
    • 新しく作成されたDeferエントリは、現在のゴルーチンの遅延リストの先頭にリンクされます。
    • この関数は通常0を返しますが、パニックを停止する遅延関数が実行された場合は1を返します。コンパイラは、この戻り値をチェックして、必要に応じて関数の終端にジャンプするコードを生成します。
  • スタック分割の制約: pragma textflag 7は、この関数がスタックを分割しないことを示します。これは、引数が&fnの直後に連続して配置されていることを前提としているためです。スタック分割が発生すると、引数がコピーされず、不正なメモリ参照につながる可能性があります。

runtime·deferreturn(uintptr arg0)

  • 役割: deferステートメントを含む関数が終了する際に、コンパイラによって挿入されるランタイム関数です。現在のゴルーチンに登録されている最も新しい遅延関数を実行します。
  • 詳細:
    • 現在のゴルーチンの遅延リストの先頭にあるDeferエントリ（d）を取得します。
    • d->argsに保存されている引数を、呼び出し元のスタックフレーム（arg0が指す場所）にコピーし直します。これにより、遅延関数が元の関数のコンテキストで実行されるように見せかけます。
    • g->deferを次の遅延エントリに更新し、現在のDeferエントリを解放します（d->nofreeがfalseの場合）。
    • runtime·jmpdeferを呼び出し、遅延関数d->fnにジャンプします。このjmpdeferは、遅延関数がdeferreturnの呼び出し元から直接呼び出されたかのように見せかけるためのアセンブリレベルのジャンプです。
    • この関数は、遅延関数がなくなるまで繰り返し呼び出されるように設計されています。
  • スタック分割の制約: deferprocと同様に、スタック分割の制約があります。これは、呼び出し元のフレームを再利用して遅延関数を呼び出すためです。

rundefer(void)

  • 役割: 現在のゴルーチンに登録されているすべての遅延関数を順番に実行します。主にruntime·Goexitやパニック処理の際に呼び出されます。
  • 詳細:
    • ゴルーチンの遅延リスト（g->defer）をループで辿り、各Deferエントリに対してreflect·callを使用して遅延関数を実行します。
    • 実行後、Deferエントリをリストから削除し、解放します。

runtime·panic(Eface e)

  • 役割: Goのpanic組み込み関数のC言語実装です。指定された値eでパニックを発生させます。
  • 詳細:
    • 新しいPanic構造体（パニック情報を持つ）をアロケートし、パニック値eと現在のゴルーチンのスタックベースを設定します。
    • このPanicエントリを現在のゴルーチンのパニックリスト（g->panic）の先頭にリンクします。
    • ループ内で、現在のゴルーチンに登録されている遅延関数を一つずつ実行します。
    • 遅延関数がrecoverを呼び出してパニックを捕捉した場合（p->recoveredがtrue）、パニックリストから現在のパニックを削除し、recovery関数を呼び出してスタックを巻き戻し、正常な実行フローに戻します。
    • すべての遅延関数が実行されてもパニックが捕捉されない場合、runtime·startpanicを呼び出してパニック処理を開始し、printpanicsでパニック情報を出力した後、runtime·dopanicを呼び出してプログラムを終了させます。

recovery(G *gp)

  • 役割: panic中に遅延関数がrecoverを呼び出してパニックを捕捉した際に、スタックを巻き戻し、正常な実行フローに戻すための内部関数です。
  • 詳細:
    • m->g0（スケジューラのスタック）上で実行され、パニックを起こしたゴルーチンgpのスタックを巻き戻します。
    • gp->deferから現在の遅延エントリを取得し、リストから削除します。
    • runtime·unwindstackを呼び出して、遅延関数の引数が存在するスタックフレームまでスタックを巻き戻します。
    • gp->sched.spとgp->sched.pcを調整し、deferprocが1を返したかのように見せかけ、呼び出し元の関数が通常の戻りエピローグにジャンプするようにします。
    • runtime·gogo(&gp->sched, 1)を呼び出し、gpの実行コンテキストを復元し、deferprocが1を返したかのように実行を再開させます。

runtime·recover(byte *argp, Eface ret)

  • 役割: Goのrecover組み込み関数のC言語実装です。現在のパニックを捕捉し、その値を返します。
  • 詳細:
    • 現在パニックが発生しているか（g->panicがnilでないか、かつp->recoveredがfalse）を確認します。
    • 呼び出し元のスタックフレームが、パニックによって作成されたスタックセグメントのトップにあることを確認します。
    • 条件が満たされた場合、現在のパニックのrecoveredフラグを1に設定し、パニックの値p->argを戻り値retに設定します。
    • 条件が満たされない場合（recoverがパニック中でない、または不正なコンテキストで呼び出された場合）、retをnilに設定します。
  • スタック分割の制約: この関数もスタック分割の制約があります。これは、呼び出し元のスタックセグメントを確実に特定する必要があるためです。

runtime·unwindstack(G *gp, byte *sp)

  • 役割: 指定されたゴルーチンgpのスタックを、特定のスタックポインタspまで巻き戻します。
  • 詳細:
    • 通常、m->g0（スケジューラのスタック）から呼び出されます。
    • ゴルーチンgpのスタックトップ（Stktop）を辿り、spが指す位置を含むスタックフレームが見つかるか、スタックの終端に達するまでスタックフレームを解放します。
    • 解放されたスタック領域はruntime·stackfreeでシステムに返却されます。
    • 不正なスタックポインタが指定された場合は、エラーをスローします。

その他のpanic関連関数

  • runtime·startpanic(): パニック処理の開始時に呼び出され、ランタイムのパニック状態を初期化し、パニックロックを取得します。
  • runtime·dopanic(int32 unused): パニック処理の終了時に呼び出され、スタックトレースの出力、他のゴルーチンのトレースバック、そしてプログラムの終了を行います。
  • runtime·panicindex(), runtime·panicslice(): 配列やスライスのインデックスが範囲外の場合に呼び出されるヘルパー関数。
  • runtime·throwreturn(), runtime·throwinit(): コンパイラやリンカの異常な状態を示すエラーで、通常は発生しないはずのパニックを発生させます。
  • runtime·throw(int8 *s): 一般的な致命的エラーでプログラムを終了させる際に呼び出されます。
  • runtime·panicstring(int8 *s): 文字列を引数としてパニックを発生させるヘルパー関数。
  • runtime·Goexit(): runtime.Goexit()関数のC言語実装で、現在のゴルーチンを終了する前にすべての遅延関数を実行します。

これらの関数は、Go言語のランタイムがpanic、defer、recoverという強力な機能をどのように低レベルで実現しているかを示しています。コードの移動は、これらの複雑な相互作用を持つ関数群を論理的にまとめることで、ランタイムの内部構造をより理解しやすくすることを目的としています。

関連リンク

参考にした情報源リンク

  • Go言語のソースコード (特にsrc/pkg/runtime/panic.c, src/pkg/runtime/proc.c, src/pkg/runtime/runtime.c, src/pkg/runtime/runtime.h)
  • Go言語の公式ドキュメント (panic, defer, recoverに関する記述)
  • Go言語のランタイムに関する一般的な知識 (Goスケジューラ、ゴルーチンスタックなど)
  • コミットメッセージと差分情報