いろいろ備忘録日記

主に .NET とか Go とか Flutter とか Python絡みのメモを公開しています。

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

golang

関連記事

Goメモ-502 (cgoメモ-01)(cgoヘッダ) - いろいろ備忘録日記

Goメモ-506 (cgoメモ-02)(cgoヘッダ) - いろいろ備忘録日記

Goメモ-507 (cgoメモ-03)(C.int) - いろいろ備忘録日記

Goメモ-508 (cgoメモ-04)(C言語の構造体) - いろいろ備忘録日記

Goメモ-509 (cgoメモ-05)(C.CString)(Cの文字列) - いろいろ備忘録日記

Goメモ-510 (cgoメモ-06)(C.GoString)(Cの文字列をGoの文字列へ) - いろいろ備忘録日記

Goメモ-511 (cgoメモ-07)(C.CBytes)([]byteをCのバイト列に) - いろいろ備忘録日記

Goメモ-512 (cgoメモ-08)(C.GoBytes)(Cのバイト列をGoの[]byteへ) - いろいろ備忘録日記

Goメモ-514 (cgoメモ-09)(C.GoStringN)(C.GoStringのサイズ指定版) - いろいろ備忘録日記

GitHub - devlights/blog-summary: ブログ「いろいろ備忘録日記」のまとめ

概要

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

今回から複数回に渡って 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 *)に変換するには以下の手順を踏みます。

  1. スライスの先頭要素のポインタを取得
  2. 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.|

ちゃんと (void *) としてC側に渡って値を設定出来ていますね。

参考情報

Goのおすすめ書籍

初めてのGo言語 ―他言語プログラマーのためのイディオマティックGo実践ガイド

初めてのGo言語 ―他言語プログラマーのためのイディオマティックGo実践ガイド

  • 作者:Jon Bodner
  • オーム社
Amazon

実用 Go言語 ―システム開発の現場で知っておきたいアドバイス

実用 Go言語 ―システム開発の現場で知っておきたいアドバイス

Amazon

Go言語による並行処理

Go言語による並行処理

Amazon

Go言語 100Tips ありがちなミスを把握し、実装を最適化する impress top gearシリーズ

Go言語 100Tips ありがちなミスを把握し、実装を最適化する impress top gearシリーズ

Amazon

Goならわかるシステムプログラミング 第2版

Goならわかるシステムプログラミング 第2版

Amazon

効率的なGo ―データ指向によるGoアプリケーションの性能最適化

効率的なGo ―データ指向によるGoアプリケーションの性能最適化

Amazon

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

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