https://devlights.hatenablog.com/entry/2025/01/16/073000

概要

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

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

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

Cgo is not Go

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

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

github.com

今回は cgo ヘッダで利用できる ${SRCDIR} 変数について。

cgoでは、cgoヘッダーのcgoディレクティブにて ${SRCDIR} という変数が利用できます。

/*
#cgo LDFLAGS: -L${SRCDIR}/libs -llibs
*/
import "C"

#includeの部分には利用出来ません。つまり以下は駄目です。

/*
// これはオッケイ
#cgo LDFLAGS: -L${SRCDIR}/libs -llibs

// 以下は駄目
#include "${SRCDIR}/libs/libs.h"
*/
import "C"

この場合は、以下のようにします。

/*
#cgo CFLAGS:  -I${SRCDIR}/libs
#cgo LDFLAGS: -L${SRCDIR}/libs -llibs

#include "libs.h"
*/
import "C"

この値は、実行時に現在のソースファイルのディレクトリに置換されます。ディレクトリパスは絶対パスで展開されます。

https://pkg.go.dev/cmd/cgo に以下の記載で記されています。

When the cgo directives are parsed, any occurrence of the string ${SRCDIR} will be replaced by the absolute path to the directory containing the source file.

(cgoディレクティブが解析されるとき、${SRCDIR}という文字列は、ソースファイルを含むディレクトリへの絶対パスに置き換えられます。)

サンプル

あらかじめ、ソースディレクトリの直下に libs というディレクトリを作り、その中にcgo経由で呼び出されるCの共有ライブラリがあるとします。ライブラリのヘッダーファイルもこのディレクトリにあります。

main.go

package main

/*
#cgo CFLAGS:  -I${SRCDIR}/libs
#cgo LDFLAGS: -L${SRCDIR}/libs -llibs

#include "libs.h"
*/
import "C"
import "log"

func init() {
    log.SetFlags(0)
}

func main() {
    var (
        x = C.int(10)
        y = C.int(20)
    )

    log.Println(int(C.add(x, y)))
}

Taskfile.yml

# https://taskfile.dev

version: '3'

tasks:
  default:
    cmds:
      - task: build-lib
      - task: build-goapp
      - task: run-goapp
  clean:
    cmds:
      - make -C libs clean
      - rm -f ./app
  build-lib:
    dir: libs
    cmds:
      - make build
  build-goapp:
    cmds:
      - go build -o app
  run-goapp:
    cmds:
      - ./app
    env:
      LD_LIBRARY_PATH: libs

実行

$ task
task: [build-lib] make build
gcc -g -O0 -Wall -Wextra -std=c17 -c /workspace/try-golang-cgo/22.C_SRCDIR/libs/libs.c -o /workspace/try-golang-cgo/22.C_SRCDIR/libs/libs.o 
gcc -g -O0 -Wall -Wextra -std=c17 -fPIC -shared  -o ./liblibs.so /workspace/try-golang-cgo/22.C_SRCDIR/libs/libs.o 
task: [build-goapp] go build -o app
task: [run-goapp] ./app
30

ちゃんとコンパイル出来て実行もできていますね。

参考情報

個人的Goのおすすめ書籍

個人的に読んでとても勉強になった書籍さんたちです。

作者:Jon Bodner
オーム社

作者:渋川よしき,辻大志郎,真野隼記
オライリージャパン

作者:Katherine Cox-Buday
オライリージャパン

作者:Teiva Harsanyi,柴田芳樹
インプレス

作者:渋川よしき
ラムダノート

作者:Bartłomiej Płotka
オライリージャパン

作者:James Cutajar
インプレス

過去の記事については、以下のページからご参照下さい。

ブログ「いろいろ備忘録日記」の記事まとめ | ブログ「いろいろ備忘録日記」のまとめ

サンプルコードは、以下の場所で公開しています。

Goメモ-532 (cgoメモ-23)(CGOヘッダで使えるSRCDIR変数)

関連記事

概要

サンプル

main.go

Taskfile.yml

実行

参考情報

個人的Goのおすすめ書籍