Goメモ-515 (cgoメモ-10)([]byteを(void *)へ変換)

概要

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

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

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

Cgo is not Go

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

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

github.com

今回は cgo で []byte を (void *) へ変換するやり方について。

Goの []byte を C言語側のバイト列にするには以前書いた C.CBytes() を使えば可能なのですが、これを利用せずにやってみましょうって話です。

C言語側のAPIは往々にして (void *) が沢山出てくるものです。なので、Goから (void *) を取る方法を覚えておくとAPIラッパーなどの作成がやりやすくなります。

C.CBytes()を用いずに、[]byteを(void *)に変換するには以下の手順を踏みます。

スライスの先頭要素のポインタを取得
unsafe.Pointerを取得

cgoでは、unsafe.Pointer() がCの (void *) に当たります。

C言語では式の中で使う配列は、「先頭要素のポインタ」に読み替えてもらえますので、C言語上では配列名をそのまま指定すれば良いのですが、GoはC言語では無いので当然それが出来ません。

なので、明示的に先頭要素のポインタを指定する必要があります。

サンプル

main.go

package main

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

const int BUF_SIZE = 11;

void setBuf(void *buf) {
   strncpy((char *)buf, "helloworld", BUF_SIZE-1);
}
*/
import "C"
import (
    "encoding/hex"
    "fmt"
    "unsafe"
)

func main() {
    var (
        buf      = make([]byte, int(C.BUF_SIZE))
        bufPtr   = unsafe.Pointer(&buf[0]) //明示的に先頭要素のポインタを渡す
        printBuf = func() {
            fmt.Println(string(buf))
            fmt.Println(hex.Dump(buf))
        }
    )

    printBuf()
    {
        // C側の宣言では (void *) を引数に要求しているため、unsafe.Pointer を渡す.
        // unsafe.Pointer は、 (void *) を表す.
        C.setBuf(bufPtr)
    }
    printBuf()
}

Taskfile.yml

# https://taskfile.dev

version: '3'

tasks:
  default:
    cmds:
      - go run main.go

実行

$ task
task: [default] go run main.go

00000000  00 00 00 00 00 00 00 00  00 00 00                 |...........|

helloworld
00000000  68 65 6c 6c 6f 77 6f 72  6c 64 00                 |helloworld.|