Goメモ-528 (cgoメモ-19)(cgoを利用して作成したsoファイル経由でのinit関数の呼び出し)

概要

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

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

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

Cgo is not Go

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

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

github.com

今回は cgoを利用して作成したsoファイル経由での init() について。

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

結論を言うと「ちゃんと呼び出される」となりますが、挙動に少し注意が必要となります。

cgoヘッダで定義したC言語ネイティブの関数がC言語側で最初に呼び出された場合、まだ init() は走らない
cgo経由でエクスポートしたGo関数が初回呼び出しされた際に init() が走る

まあ、当然と言えば当然の動きとなります。cgoの境界に入った初回呼び出し時に init() が呼び出されるということですね。

サンプル

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

cfuncs.go

package main

/*
#include <stdio.h>

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

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

exports.go

package main

/*
#include <stdlib.h>
*/
import "C"
import "log"

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

//export gofunc1
func gofunc1() {
    log.Printf("[GO] gofunc1")
    log.Printf("[GO] %v", m)
}

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() {}

main.c

#include <stdlib.h>

extern void my_printf(const char *);
extern void gofunc1(void);

int main(void) {
    my_printf("hello world");
    gofunc1();

    return EXIT_SUCCESS;
}

Taskfile.yml

# https://taskfile.dev

version: "3"

env:
  LD_LIBRARY_PATH: .

tasks:
  default:
    cmds:
      - go build -o libgo.so -buildmode=c-shared .
      - gcc -c -o main.o main.c
      - gcc -o capp main.o -L. -lgo
      - ldd ./capp
      - ./capp

実行

$ task
task: [default] go build -o libgo.so -buildmode=c-shared .
task: [default] gcc -c -o main.o main.c
task: [default] gcc -o capp main.o -L. -lgo
task: [default] ldd ./capp
        linux-vdso.so.1 (0x00007fff5778a000)
        libgo.so => ./libgo.so (0x00007ff4bda66000)
        libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007ff4bd836000)
        /lib64/ld-linux-x86-64.so.2 (0x00007ff4bdc1f000)
task: [default] ./capp
[C ] hello world
>> main.init() called
>> cfuncs.init() called
>> exports.init() called
[GO] gofunc1
[GO] map[cfuncs:true exports:true main:true]