いろいろ備忘録日記

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

Goメモ-356 (Go側からsoファイルを作成してPythonとCで利用)(c-shared)

関連記事

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

概要

以下、自分用のメモです。よく忘れるのでここにメモメモ。。。

たまーに、Go側の処理をsoファイルにして、他の言語(Pythonとか)から呼びたい場合があったりします。

その際の手順をいつも忘れるので、ここにメモメモ。。。

試してみる

まずは公開する関数を定義しておきます。パッケージはmainじゃないと多分ダメです。

Cパッケージをインポートして、公開関数に //export 関数名 を付与します。

package main

import "C"
import (
    "log"
)

//export GoAdd
func GoAdd(x, y int) int {
    return x + y
}

func init() {
    log.SetFlags(0)
    log.Println("[FROM GOLANG] library loaded!")
}

func main() {
}

あとはビルドします。

buildmodeを c-shared にして、soファイルとして出力

$ go build -buildmode=c-shared -o libgoadd.so main.go

これで、ヘッダファイルとsoファイルが出力されます。

/* Code generated by cmd/cgo; DO NOT EDIT. */

/* package command-line-arguments */


#line 1 "cgo-builtin-export-prolog"

#include <stddef.h>

#ifndef GO_CGO_EXPORT_PROLOGUE_H
#define GO_CGO_EXPORT_PROLOGUE_H

#ifndef GO_CGO_GOSTRING_TYPEDEF
typedef struct { const char *p; ptrdiff_t n; } _GoString_;
#endif

#endif

/* Start of preamble from import "C" comments.  */




/* End of preamble from import "C" comments.  */


/* Start of boilerplate cgo prologue.  */
#line 1 "cgo-gcc-export-header-prolog"

#ifndef GO_CGO_PROLOGUE_H
#define GO_CGO_PROLOGUE_H

typedef signed char GoInt8;
typedef unsigned char GoUint8;
typedef short GoInt16;
typedef unsigned short GoUint16;
typedef int GoInt32;
typedef unsigned int GoUint32;
typedef long long GoInt64;
typedef unsigned long long GoUint64;
typedef GoInt64 GoInt;
typedef GoUint64 GoUint;
typedef size_t GoUintptr;
typedef float GoFloat32;
typedef double GoFloat64;
#ifdef _MSC_VER
#include <complex.h>
typedef _Fcomplex GoComplex64;
typedef _Dcomplex GoComplex128;
#else
typedef float _Complex GoComplex64;
typedef double _Complex GoComplex128;
#endif

/*
  static assertion to make sure the file is being used on architecture
  at least with matching size of GoInt.
*/
typedef char _check_for_64_bit_pointer_matching_GoInt[sizeof(void*)==64/8 ? 1:-1];

#ifndef GO_CGO_GOSTRING_TYPEDEF
typedef _GoString_ GoString;
#endif
typedef void *GoMap;
typedef void *GoChan;
typedef struct { void *t; void *v; } GoInterface;
typedef struct { void *data; GoInt len; GoInt cap; } GoSlice;

#endif

/* End of boilerplate cgo prologue.  */

#ifdef __cplusplus
extern "C" {
#endif

extern GoInt GoAdd(GoInt x, GoInt y);

#ifdef __cplusplus
}
#endif

C言語とPythonから呼び出しするようにしてみます。

#include <stdio.h>
#include <stdlib.h>
#include "libgoadd.h"

int main() {
    int x = 111;
    int y = 222;
    int z = 0;

    z = GoAdd(x, y);
    printf("[FROM      C] %d\n", z);

    return EXIT_SUCCESS;
}
import ctypes

def main():
    lib = ctypes.CDLL('./libgoadd.so')

    x = 111
    y = 222
    z = lib.GoAdd(x, y)
    
    print(f'[FROM PYTHON] {z}')

if __name__ == '__main__':
    main()

最終的に以下のようなタスクファイルを作成して実行してみます。

# https://taskfile.dev

version: '3'

tasks:
  default:
    cmds:
      - task: run
  run:
    cmds:
      - task: build
      - task: show
      - task: use
  build:
    cmds:
      - go build -buildmode=c-shared -o libgoadd.so main.go
  show:
    cmds:
      - ls -lh libgoadd.so
      - file libgoadd.so
      - ldd libgoadd.so
      - nm -D libgoadd.so | grep 'T GoAdd'
  use:
    cmds:
      - python3 use.py
      - gcc -o use-c use.c -L . -l goadd
      - LD_LIBRARY_PATH=. ./use-c
  clean:
    cmds:
      - rm -f libgoadd*
      - rm -f use-c*
$ task
task: [build] go build -buildmode=c-shared -o libgoadd.so main.go
task: [show] ls -lh libgoadd.so
-rw-r--r-- 1 gitpod gitpod 2.0M Nov 27 02:57 libgoadd.so
task: [show] file libgoadd.so
libgoadd.so: ELF 64-bit LSB shared object, x86-64, version 1 (SYSV), dynamically linked, BuildID[sha1]=607341834dabab90e0d42d26482b80c9ae4553c5, with debug_info, not stripped
task: [show] ldd libgoadd.so
        linux-vdso.so.1 (0x00007fff2437c000)
        libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007fe37d210000)
        /lib64/ld-linux-x86-64.so.2 (0x00007fe37d5c2000)
task: [show] nm -D libgoadd.so | grep 'T GoAdd'
00000000000a1e00 T GoAdd
task: [use] python3 use.py
[FROM GOLANG] library loaded!
[FROM PYTHON] 333
task: [use] gcc -o use-c use.c -L . -l goadd
task: [use] LD_LIBRARY_PATH=. ./use-c
[FROM GOLANG] library loaded!
[FROM      C] 333

参考情報

github.com

Goのおすすめ書籍

Go言語による並行処理

Go言語による並行処理

Amazon

上の書籍の日本語版が下です。


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

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