コンテンツにスキップ

Go/goコマンド/vet/cgocall

出典: フリー教科書『ウィキブックス(Wikibooks)』


go vet の cgocall アナライザ

[編集]

何を検出するか

[編集]

cgo 経由で C 関数を呼び出す際に、C に渡してはいけない Go の値を検出します。

前提知識:cgo のポインタ渡しルール

[編集]

Go と C はメモリ管理の仕組みが根本的に異なります。

Go C
メモリ管理 GC が自動管理 手動管理
ポインタの追跡 GC が把握している GC の管理外

Go の GC はオブジェクトを移動しませんが、C 側に渡ったポインタを GC が追跡できないことが問題です。

Go ヒープ上のオブジェクト
        ↓ ポインタを C に渡す
C のメモリ空間(GC の管理外)で保持される
        ↓
Go 側から参照がなくなったと GC が判断
        ↓
GC がオブジェクトを回収してしまう
        ↓
C 側のポインタがダングリングポインタに!

cgo のルールでは「C の呼び出しが返った後も、Go のポインタを C 側が保持し続けてはならない」と定められています。

渡してはいけない型

[編集]

chan・map・func・slice はいずれも内部に Go ヒープへのポインタを持つ複合型で、構造的にこのルールを守ることが困難です。

// import "C" が前提

// ⚠️ chan を直接渡す
ch := make(chan int)
C.foo(ch)

// ⚠️ map を直接渡す
m := make(map[string]int)
C.foo(m)

// ⚠️ func を直接渡す
f := func() {}
C.foo(f)

// ⚠️ slice を直接渡す
s := []int{1, 2, 3}
C.foo(s)

ポインタ・配列・構造体経由でも NG

[編集]

直接渡すだけでなく、間接的に含んでいる場合も検出されます。

// ⚠️ slice を含む構造体のポインタを渡す
type MyStruct struct {
    Data []byte
}
s := &MyStruct{}
C.foo(s)

// ⚠️ map を含む構造体を渡す
type Config struct {
    Options map[string]string
}
c := Config{}
C.foo(&c)

// ⚠️ func を含む構造体を渡す
type Handler struct {
    Callback func()
}
h := Handler{}
C.foo(&h)

正しく C にデータを渡す方法

[編集]

バイト列を渡したい場合

[編集]
// ✅ C.CBytes で C のヒープにコピーする
data := []byte("hello")
cData := C.CBytes(data)
defer C.free(cData)
C.foo(cData)

文字列を渡したい場合

[編集]
// ✅ C.CString で C のヒープにコピーする
s := "hello"
cs := C.CString(s)
defer C.free(unsafe.Pointer(cs))
C.foo(cs)

コールバックを渡したい場合

[編集]
// ✅ 関数ポインタではなく整数IDを渡し、Go 側で管理する
//export MyCallback
func MyCallback(id C.int) {
    // id で Go 側のマップから関数を引く
}

まとめ

[編集]
型 直接渡す ポインタ経由 構造体フィールド
chan ⚠️ ⚠️ ⚠️
map ⚠️ ⚠️ ⚠️
func ⚠️ ⚠️ ⚠️
slice ⚠️ ⚠️ ⚠️
int, float64 等 ✅ ✅ ✅
unsafe.Pointer 条件付き✅ 条件付き✅ 条件付き✅

cgo のポインタルール違反は GC のタイミングに依存したランダムなクラッシュやメモリ破壊として現れるため、再現性が極めて低く原因特定が非常に困難です。cgo を使う場合は cgocall を必ず通すべきです。