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

このコミットは、Goランタイムにcgocallback_gofuncという新しい関数を追加し、C言語からGoの関数値（Go func value）を呼び出すメカニズムを改善することを目的としています。特に、Windows環境におけるCからのコールバック処理の修正と、将来的なGo関数値のコールバック対応を見据えた変更です。

コミット

commit 3d2dfc5a7b254295d41d9104d6a53ebad5125afc
Author: Russ Cox <rsc@golang.org>
Date:   Fri Feb 22 16:08:56 2013 -0500

    runtime: add cgocallback_gofunc that can call Go func value
    
    For now, all the callbacks from C use top-level Go functions,
    so they use the equivalent C function pointer, and will continue
    to do so. But perhaps some day this will be useful for calling
    a Go func value (at least if the type is already known).
    
    More importantly, the Windows callback code needs to be able
    to use cgocallback_gofunc to call a Go func value.
    Should fix the Windows build.
    
    R=ken2
    CC=golang-dev
    https://golang.org/cl/7388049

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

https://github.com/golang/go/commit/3d2dfc5a7b254295d41d9104d6a53ebad5125afc

元コミット内容

runtime: add cgocallback_gofunc that can call Go func value

このコミットは、Goランタイムにcgocallback_gofuncという新しい関数を追加し、Goの関数値（Go func value）をC言語から呼び出せるようにするものです。現状ではCからのコールバックはトップレベルのGo関数を使用していますが、将来的にはGoの関数値を呼び出す際に役立つ可能性があります。特に、WindowsのコールバックコードがGoの関数値を呼び出すためにcgocallback_gofuncを使用する必要があり、これによりWindowsビルドの問題が解決される見込みです。

変更の背景

この変更の主な背景は、GoのCGO（C Foreign Function Interface）メカニズムにおける、C言語からGo言語へのコールバック処理の改善と、特にWindows環境での特定の課題解決です。

Go関数値のコールバック対応: 従来のCGOコールバックは、主にGoのトップレベル関数（つまり、静的にアドレスが決定できる関数）を対象としていました。しかし、Goには実行時に生成される匿名関数や、構造体のメソッドなど、いわゆる「関数値（function value）」が存在します。これらの関数値をCから直接コールバックするメカニズムは、このコミット以前は限定的でした。このコミットは、将来的にGoの関数値をCからより柔軟に呼び出せるようにするための基盤を築くことを意図しています。
Windowsビルドの修正: コミットメッセージに明記されているように、Windows環境でのCGOコールバックに問題があり、このcgocallback_gofuncの導入がその解決策として必要とされていました。Windowsの特定のAPIやコールバックメカニズムが、Goの関数値の呼び出しを必要とするケースがあったと考えられます。この変更により、Windows上でのGoプログラムのCGO関連の安定性が向上します。
コードの整理と抽象化: cgocallbackとcgocallback_gofuncを分離することで、CからGoへのコールバック処理のロジックがより明確になり、将来的な拡張やメンテナンスが容易になります。cgocallbackは引き続きトップレベル関数へのコールバックを処理し、cgocallback_gofuncはより汎用的なGo関数値の呼び出しを担うという役割分担がなされます。

前提知識の解説

このコミットを理解するためには、以下のGo言語およびシステムプログラミングに関する前提知識が必要です。

CGO (C Foreign Function Interface):
- Go言語とC言語の間で相互に関数を呼び出すためのメカニズムです。GoプログラムからCのライブラリ関数を呼び出したり、CのコードからGoの関数をコールバックしたりするために使用されます。
- CGOは、GoのランタイムとCのランタイムの間でスタックやレジスタの状態を適切に切り替える必要があり、そのためにアセンブリ言語による低レベルな処理が関与します。
- Goの関数をCから呼び出す場合、Goの関数はCの関数ポインタとしてエクスポートされる必要があります。
Goランタイム (Go Runtime):
- Goプログラムの実行を管理するシステムです。ガベージコレクション、スケジューラ（ゴルーチンの管理）、メモリ管理、CGOとの連携など、Goプログラムの動作に必要な多くの低レベルな機能を提供します。
- ランタイムの多くの部分はGo言語で書かれていますが、OSとのインタラクションやパフォーマンスが重要な部分はC言語やアセンブリ言語で書かれています。
アセンブリ言語 (Assembly Language):
- CPUが直接実行できる機械語に非常に近い低レベルなプログラミング言語です。Goランタイムでは、異なるCPUアーキテクチャ（x86, AMD64, ARMなど）に対応するため、アセンブリ言語が使用されます。
- 特に、関数呼び出し規約（引数の渡し方、戻り値の受け取り方、レジスタの使用方法など）や、スタックフレームの操作といった、言語間のインターフェース部分で重要な役割を果たします。
- Goのアセンブリは、Plan 9アセンブリの記法に似ています。TEXTは関数の定義、MOVL/MOVQ/MOVWはデータ転送命令、CALL/BLは関数呼び出し命令、RETは関数からのリターンを意味します。SBは静的ベースポインタ、FPはフレームポインタを表します。
Goの関数値 (Go Func Value):
- Go言語では、関数は第一級オブジェクトであり、変数に代入したり、引数として渡したり、戻り値として返したりすることができます。このような関数を「関数値」と呼びます。
- Goの関数値は、単なるコードへのポインタだけでなく、その関数がキャプチャした環境（クロージャ）や、レシーバを持つメソッドの場合はそのレシーバのインスタンスへのポインタなど、追加の情報を内部に持っています。
- Goランタイム内部では、関数値はFuncValという構造体で表現されることがあります。これは、関数へのポインタと、その関数がクロージャである場合にキャプチャされた変数のポインタなどを含む可能性があります。
Windowsのコールバックメカニズム:
- Windows APIでは、特定のイベントが発生した際にアプリケーションが提供する関数を呼び出す「コールバック」が頻繁に利用されます。例えば、ウィンドウプロシージャやタイマーコールバックなどです。
- これらのコールバックは通常、C言語の関数ポインタとして渡されます。Goの関数をWindowsのコールバックとして登録する場合、Goの関数をCの関数ポインタとしてラップし、Windowsが呼び出せる形式にする必要があります。

これらの知識を前提として、このコミットがGoランタイムのCGO部分でどのように低レベルな変更を行い、Goの関数値をCから呼び出すことを可能にしているかを理解することができます。

技術的詳細

このコミットの技術的詳細を掘り下げると、GoランタイムがCGOコールバックをどのように処理し、Goの関数値をCから呼び出すための新しいパスをどのように導入したかが明らかになります。

`cgocallback`と`cgocallback_gofunc`の分離

runtime·cgocallback: 従来のCからGoへのコールバックのエントリポイントです。このコミット以前は、CからGoのトップレベル関数を呼び出すための汎用的なパスでした。このコミットでは、runtime·cgocallbackは、引数として受け取ったCの関数ポインタ（fn）をGoの関数値（FuncVal*）に変換し、その上で新しく導入されたruntime·cgocallback_gofuncを呼び出すラッパー関数として再定義されました。
runtime·cgocallback_gofunc: このコミットで新しく追加された関数で、Goの関数値（FuncVal*）を直接受け取り、それをGoランタイムのreflect·callメカニズムを使って実行します。これが、Goの関数値をCからコールバックするための新しい、より直接的なエントリポイントとなります。

アセンブリコードの変更 (`asm_386.s`, `asm_amd64.s`, `asm_arm.s`)

各アーキテクチャのアセンブリファイルにおいて、runtime·cgocallbackの定義が変更され、runtime·cgocallback_gofuncが新しく追加されています。

runtime·cgocallbackの変更:
- 以前は、この関数が直接Goのコールバック処理の大部分を行っていました。
- 変更後、runtime·cgocallbackは、Cから渡された関数ポインタfnをGoのFuncVal*形式に変換し、そのFuncVal*、frame、framesizeを引数としてruntime·cgocallback_gofuncを呼び出すだけのシンプルなラッパーになりました。
- 具体的には、fnのアドレスをレジスタ（386/AMD64ではAX、ARMではR0）にロードし、それをスタックにプッシュしてcgocallback_gofuncに渡しています。
runtime·cgocallback_gofuncの追加:
- この新しいアセンブリ関数が、実際のGoランタイムへのエントリポイントとなります。
- この関数は、CGOコールバックに必要なGoランタイムのセットアップ（例えば、現在のM（マシン）とG（ゴルーチン）のロード、スタックの切り替えなど）を行います。
- そして、最終的にC言語のruntime·cgocallbackg関数（後述）を呼び出し、Goの関数値の実行を委ねます。

このアセンブリレベルでの変更は、Cの呼び出し規約とGoの呼び出し規約の間で引数を適切に変換し、Goランタイムのコンテキスト（MとG）を確立するために不可欠です。

C言語コードの変更 (`callback_windows_386.c`, `callback_windows_amd64.c`, `cgocall.c`)

callback_windows_*.cの変更:
- Windows固有のコールバック処理において、runtime·compilecallback関数がGoのEface（インターフェース値）から関数ポインタを抽出する部分が変更されています。
- 以前は*(byte**)fn.dataのように、fn.dataが指すポインタのポインタをデリファレンスして関数アドレスを取得していましたが、変更後はfn.dataを直接uint32またはuint64にキャストして使用しています。これは、EfaceがGoの関数値を保持している場合、fn.dataが直接FuncVal構造体へのポインタを指すようになったためと考えられます。これにより、Goの関数値がCのコールバックとしてより直接的に扱えるようになります。
cgocall.cの変更:
- runtime·cgocallbackg関数のシグネチャが変更されました。
- 以前はvoid (*fn)(void)（Cの関数ポインタ）を受け取っていましたが、変更後はFuncVal *fn（Goの関数値へのポインタ）を受け取るようになりました。
- これにより、runtime·cgocallbackgは直接Goの関数値を受け取り、それをreflect·call関数に渡して実行できるようになりました。reflect·callはGoのリフレクション機能を使って、任意のGo関数値を呼び出すためのランタイム関数です。
- この変更は、cgocallback_gofuncがGoの関数値をcgocallbackgに渡すという新しいフローをサポートするために必要です。

Windowsシステムコールのアセンブリ変更 (`sys_windows_386.s`, `sys_windows_amd64.s`)

Windowsのシステムコールに関連するアセンブリファイルにおいて、CGOコールバックのエントリポイントがruntime·cgocallbackからruntime·cgocallback_gofuncに変更されています。
これは、WindowsがGoのコールバック関数を呼び出す際に、新しいcgocallback_gofuncのエントリポイントを使用するように指示するものです。これにより、WindowsのコールバックがGoの関数値を正しく呼び出せるようになります。

これらの変更は、GoランタイムのCGOスタックフレーム管理、レジスタの保存/復元、Goスケジューラとの連携といった低レベルな詳細に深く関わっています。特に、Goの関数値が持つ「クロージャ」のような追加情報を考慮しつつ、Cの呼び出し規約とGoの呼び出し規約の間でシームレスな移行を実現するために、アセンブリとCのコードが連携して動作しています。

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

このコミットで変更された主要なファイルと、その変更の概要は以下の通りです。

src/pkg/runtime/asm_386.s
- runtime·cgocallback関数の実装が変更され、runtime·cgocallback_gofuncを呼び出すラッパーになりました。
- runtime·cgocallback_gofuncという新しい関数が追加され、Goの関数値を受け取るエントリポイントとして機能します。
src/pkg/runtime/asm_amd64.s
- src/pkg/runtime/asm_386.sと同様に、runtime·cgocallbackがruntime·cgocallback_gofuncを呼び出すように変更され、runtime·cgocallback_gofuncが追加されました。
src/pkg/runtime/asm_arm.s
- src/pkg/runtime/asm_386.sと同様に、runtime·cgocallbackがruntime·cgocallback_gofuncを呼び出すように変更され、runtime·cgocallback_gofuncが追加されました。
src/pkg/runtime/callback_windows_386.c
- runtime·compilecallback関数内で、GoのEfaceから関数ポインタを抽出するロジックが変更されました。*(uint32*)p = (uint32)(*(byte**)fn.data); から *(uint32*)p = (uint32)(fn.data); へと変更されています。
src/pkg/runtime/callback_windows_amd64.c
- src/pkg/runtime/callback_windows_386.cと同様に、runtime·compilecallback関数内で、GoのEfaceから関数ポインタを抽出するロジックが変更されました。*(uint64*)p = (uint64)(*(byte**)fn.data); から *(uint64*)p = (uint64)(fn.data); へと変更されています。
src/pkg/runtime/cgocall.c
- runtime·cgocallbackg関数のシグネチャが変更されました。void (*fn)(void)（C関数ポインタ）を受け取る代わりに、FuncVal *fn（Go関数値へのポインタ）を受け取るようになりました。
- これにより、reflect·call関数に直接FuncValを渡せるようになりました。
src/pkg/runtime/sys_windows_386.s
- Windowsのコールバックアセンブリコード内で、runtime·cgocallbackへの呼び出しがruntime·cgocallback_gofuncへの呼び出しに変更されました。
src/pkg/runtime/sys_windows_amd64.s
- src/pkg/runtime/sys_windows_386.sと同様に、Windowsのコールバックアセンブリコード内で、runtime·cgocallbackへの呼び出しがruntime·cgocallback_gofuncへの呼び出しに変更されました。

これらの変更は、GoランタイムのCGOコールバックメカニズムの根幹に関わるもので、特にアセンブリ言語とC言語の連携によって、Goの関数値をCから安全かつ効率的に呼び出すための新しいパスが確立されています。

コアとなるコードの解説

このコミットのコアとなるコード変更は、主にGoランタイムのアセンブリファイルとcgocall.cに見られます。

アセンブリファイルの変更 (`asm_386.s`, `asm_amd64.s`, `asm_arm.s`)

各アーキテクチャのアセンブリファイルでは、runtime·cgocallbackとruntime·cgocallback_gofuncという2つの重要な関数が定義されています。

変更前（概念）:

TEXT runtime·cgocallback(SB),7,$12 // or $24 for amd64
    // Cから渡された関数ポインタfnを直接処理し、Goランタイムのコンテキストをセットアップ
    // その後、Goの関数を呼び出すロジック
    // ...
    CALL reflect·call // 概念的な呼び出し
    RET

変更後（概念）:

// runtime·cgocallback(void (*fn)(void*), void *frame, uintptr framesize)
// Cから呼び出されるエントリポイント
TEXT runtime·cgocallback(SB),7,$12 // or $24 for amd64
    // Cの関数ポインタfnをGoのFuncVal*形式に変換し、スタックにプッシュ
    LEAL    fn+0(FP), AX // fnのアドレスをAXにロード (386/amd64)
    MOVL    AX, 0(SP)    // AXの値をスタックにプッシュ (386)
    // frameとframesizeも同様にスタックにプッシュ
    MOVL    frame+4(FP), AX
    MOVL    AX, 4(SP)
    MOVL    framesize+8(FP), AX
    MOVL    AX, 8(SP)

    // 新しいcgocallback_gofuncを呼び出す
    MOVL    $runtime·cgocallback_gofunc(SB), AX // cgocallback_gofuncのアドレスをAXにロード
    CALL    AX // cgocallback_gofuncを呼び出す
    RET

// runtime·cgocallback_gofunc(FuncVal*, void *frame, uintptr framesize)
// Goの関数値を受け取る新しいエントリポイント
TEXT runtime·cgocallback_gofunc(SB),7,$12 // or $24 for amd64
    // Goランタイムのコンテキスト（MとG）をセットアップ
    // ...
    // 最終的にC言語のruntime·cgocallbackgを呼び出す
    CALL    runtime·cgocallbackg(SB) // cgocallbackgを呼び出す
    RET

このアセンブリの変更のポイントは、runtime·cgocallbackがCの関数ポインタをGoのFuncVal*に変換し、その変換されたFuncVal*を新しいruntime·cgocallback_gofuncに渡すという役割分担がなされた点です。runtime·cgocallback_gofuncは、Goの関数値を受け取り、Goランタイムのコンテキストを確立した上で、C言語で実装されたruntime·cgocallbackgを呼び出します。

`cgocall.c`の変更

runtime·cgocallbackg関数のシグネチャが変更されました。

変更前:

void
runtime·cgocallbackg(void (*fn)(void), void *arg, uintptr argsize)
{
    // ...
    FuncVal fv;
    fv.fn = fn; // Cの関数ポインタをFuncValに代入
    reflect·call(&fv, arg, argsize); // reflect·callで呼び出し
    // ...
}

変更後:

void
runtime·cgocallbackg(FuncVal *fn, void *arg, uintptr argsize)
{
    // ...
    // 直接FuncVal*を受け取る
    if(m->racecall) {
        reflect·call(fn, arg, argsize); // reflect·callで呼び出し
        return;
    }
    // ...
    reflect·call(fn, arg, argsize); // reflect·callで呼び出し
    // ...
}

この変更により、runtime·cgocallbackgはCの関数ポインタをFuncValにラップする手間が省かれ、直接Goの関数値へのポインタを受け取ってreflect·callに渡せるようになりました。これは、アセンブリ層で既にCの関数ポインタがGoのFuncVal*に変換されているため、よりクリーンなインターフェースとなります。

Windows固有のコールバック処理の変更 (`callback_windows_*.c`)

Windowsのコールバックをコンパイルする際に、GoのEfaceから関数ポインタを抽出する方法が変更されました。