Goメモ-641 (cgoメモ-34)(C側で定義された配列の操作)(アクセサ関数を用意)

今回は C側で定義された配列を操作するについて。基本的にcgo上ではC側で定義された配列に普通にアクセス出来ますが、cgoでは制約としてC側で定義されている define が見えないなどの制約事項があります。Cで配列操作する際に大抵は define で要素数などを定義していることが多いので無理に Go 側で頑張るよりも C 側にアクセサ関数などを定義して処理したほうが楽なときが多いです。

また、元の配列の型が例えば struct A item_list[ITEM_COUNT]; ってなってたとして、いつのまにか struct A *item_list[ITEM_COUNT]; などになってたりすると、Go側では気づかないときもあったりします。Cでは具象の場合とポインタの場合で . と -> で使い分けしてアクセスしますが、Goの場合はどちらも . でアクセス出来てしまうので、いつのまにか既定の型が変わってしまっても気づかずにバグってしまうことも有りえます。(何かの関数に引数で指定してたりすると、そこでコンパイルエラー出るので発見できたりしますが）

サンプル

main.go

package main

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

#define ITEM_COUNT (3)
#define KEY_LENGTH (32)

typedef struct Item {
   char key[KEY_LENGTH];
   int value;
} Item;

Item item_list[ITEM_COUNT];

// 初期化関数
void init_item_list(void) {
   for (size_t i = 0; i < ITEM_COUNT; i++) {
       Item *item = &item_list[i];

       char buf[KEY_LENGTH];
       int len = snprintf(buf, KEY_LENGTH, "item-%02d", i);
       strncpy(item->key, buf, len);
       item->key[len] = '\0';

       item->value = (int)i;
   }
}

// 表示関数
void disp_item_list(void) {
   for (size_t i = 0; i < ITEM_COUNT; i++) {
       Item *item = &item_list[i];
       printf("[C ] key=%s, value=%d\n", item->key, item->value);
   }
}

// アクセサ関数
Item *get_item(size_t index) {
   return &item_list[index];
}

// 設定関数
void mod_item(Item *item, const char *key, int value) {
   strcpy(item->key, key);
   item->value = value;
}
*/
import "C"
import (
    "fmt"
    "unsafe"
)

const (
    ITEM_COUNT = 3
)

func main() {
    //
    // cgoで配列を扱う場合は、できれば要素を取得する アクセサ関数 を用意したほうが安全
    //

    C.init_item_list()

    display("init")
    modify()
    display("modify")
}

func display(msg string) {
    fmt.Printf("======[%s]======\n", msg)
    C.disp_item_list()

    for i := range ITEM_COUNT {
        item := C.get_item(C.size_t(i))
        fmt.Printf("[Go] key=%s, value=%d\n", C.GoString(&item.key[0]), int(item.value))
    }
    fmt.Println("==================")
}

func modify() {
    for i := range ITEM_COUNT {
        func() {
            item := C.get_item(C.size_t(i))

            key := fmt.Sprintf("ITEM-%02d", i)
            keyPtr := C.CString(key)
            defer C.free(unsafe.Pointer(keyPtr))

            C.mod_item(item, keyPtr, C.int(0xFF-i))
        }()
    }
}

Taskfile.yml

# https://taskfile.dev

version: '3'

vars:
  APP: app

tasks:
  default:
    cmds:
      - go build -o {{.APP}} main.go
      - ./{{.APP}}

実行

$ task
task: [default] go build -o app main.go
task: [default] ./app
======[init]======
[C ] key=item-00, value=0
[C ] key=item-01, value=1
[C ] key=item-02, value=2
[Go] key=item-00, value=0
[Go] key=item-01, value=1
[Go] key=item-02, value=2
==================
======[modify]======
[C ] key=ITEM-00, value=255
[C ] key=ITEM-01, value=254
[C ] key=ITEM-02, value=253
[Go] key=ITEM-00, value=255
[Go] key=ITEM-01, value=254
[Go] key=ITEM-02, value=253
==================