Goメモ-527 (cgoメモ-18)(cgoを利用している場合のinit関数について)

概要

以下、自分用のメモです。

今回から複数回に渡って cgo についてメモしていこうと思います。

cgo は、文字通りGoからCにアクセスすることが出来るようになるものなのですが、とても便利な反面、結構クセが強いのでメモでも残しておかないとすぐ頭から消えてしまいそうだなって思いました。

Cgo is not Go

という格言があったりするので、Go界隈で標準で推奨されていない技術かもしれません。が、実務ではC言語で作成されたライブラリなどは山のようにあります。んで、プロジェクトの方針でGoで作り直すことも出来ない場合も多々あります。そのような場合に非常に便利です。

これからのサンプルは以下のリポジトリにアップしてありますので、良ければご参考ください。

github.com

今回は cgo を利用している場合の init() について。

初期化処理などを init() に書きたいけど、ちゃんと呼び出されるのか？という話ですね。

結論を言うと「ちゃんと呼び出される」です。

サンプル

複数ファイルに init() を定義してみます。

cfuncs.go

package main

/*
#include <stdio.h>
#include <stdlib.h>

void my_printf(const char *msg) {
   printf("%s\n", msg);
}
*/
import "C"

func init() {
    println(">> cfuncs.init() called")
    m["cfuncs"] = true
}

exports.go

package main

import "C"
import "log"

func init() {
    println(">> exports.init() called")
    m["exports"] = true
}

//export func1
func func1() {
    log.Println("func1")
}

gofuncs.go

package main

/*
#include <stdlib.h>

extern void my_printf(const char *);
extern void func1();
*/
import "C"
import "unsafe"

func init() {
    println(">> gofuncs.init() called")
    m["gofuncs"] = true
}

func func2() {
    msg := C.CString("helloworld")
    defer C.free(unsafe.Pointer(msg))

    C.my_printf(msg)
    C.func1()
}

main.go

package main

import (
    "log"
)

var (
    m = make(map[string]bool)
)

func init() {
    println(">> main.init() called")
    log.SetFlags(0)
    m["main"] = true
}

func main() {
    log.Println(m)
    func2()
}

Taskfile.yml

# https://taskfile.dev

version: '3'

tasks:
  default:
    cmds:
      - go run .

実行

$ task
task: [default] go run .
>> main.init() called
>> cfuncs.init() called
>> exports.init() called
>> gofuncs.init() called
map[cfuncs:true exports:true gofuncs:true main:true]
helloworld
func1