2018年08月28日

by smallnest

C和Go相互调用

C可以调用Go，并且Go可以调用C，如果更进一步呢， C-->Go-->C 或者 Go-->C-->Go的调用如何实现？

本文通过两个简单的例子帮助你了解这两种复杂的调用关系。本文不涉及两者之间的复杂的数据转换，官方文章C? Go? Cgo!、wiki/cgo和cmd/cgo有一些介绍。

Go-->C-->Go

Go程序调用C实现的函数，然后C实现的函数又调用Go实现的函数。

1、首先，我们新建一个hello.go的文件：

hello.go

package main
import "C"
import "fmt"
//export HelloFromGo
func HelloFromGo() {
	fmt.Printf("Hello from Go!\n")
}

它定义了一个HelloFromGo函数，注意这个函数是一个纯的Go函数，我们定义它的输出符号为HelloFromGo。

2、接着我们新建一个hello.c的文件：

hello.c

#include <stdio.h>
#include "_cgo_export.h"
int helloFromC() {
    printf("Hi from C\n");
    //call Go function
    HelloFromGo();
    return 0;
}

这个c文件定义了一个C函数helloFromC,内部它会调用我们刚才定义的HelloFromGo函数。

这样，我们实现了C调用Go: C-->Go,下面我们再实现Go调用C。

3、最后新建一个main.go文件：

main.go

package main
/*
extern int helloFromC();
*/
import "C"
func main() {
	//call c function
	C.helloFromC()
}

它调用第二步实现的C函数helloFromC。

运行测试一下：

1
2
3

$ go run .
Hi from C
Hello from Go!

可以看到，期望的函数调用正常的运行。第一行是C函数的输出，第二行是Go函数的输出。

C-->Go-->C

第二个例子演示了C程序调用Go实现的函数，然后Go实现的函数又调用C实现的函数。

1、首先新建一个hello.c文件：

hello.c

#include <stdio.h>
int helloFromC() {
    printf("Hi from C\n");
    return 0;
}

它定义了一个纯C实现的函数。

2、接着新建一个hello.go文件：

// go build -o hello.so -buildmode=c-shared .
package main
/*
extern int helloFromC();
*/
import "C"
import "fmt"
//export HelloFromGo
func HelloFromGo() {
	fmt.Printf("Hello from Go!\n")
	C.helloFromC()
}
func main() {
}

它实现了一个Go函数HelloFromGo,内部实现调用了C实现的函数helloFromC,这样我们就实现了Go-->C。

注意包名设置为package main，并且增加一个空的main函数。

运行go build -o hello.so -buildmode=c-shared .生成一个C可以调用的库，这调命令执行完后会生成hello.so文件和hello.h文件。

3、最后新建一个文件夹，随便起个名字，比如main

将刚才生成的hello.so文件和hello.h文件复制到main文件夹，并在main文件夹中新建一个文件main.c:

main.c

#include <stdio.h>
#include "hello.h"
int main() {
    printf("use hello lib from C:\n");
   
    HelloFromGo();
    
    return 0;
}

运行gcc -o main main.c hello.so生成可执行文件main, 运行main:

$ ./main
use hello lib from C:
Hello from Go!
Hi from C

第一行输出来自main.c,第二行来自Go函数，第三行来自hello.c中的C函数，这样我们就实现了C-->Go--C的复杂调用。

`C-->Go-->C`的状态变量

我们来分析第二步中的一个特殊的场景，为了下面我们好区分，我们给程序标记一下，记为C1-->Go-->C2, C2的程序修改一下，加入一个状态变量a,并且函数helloFromC中会打印a的地址和值，也会将a加一。

hello.c

#include <stdio.h>
int  a = 1;
int helloFromC() {
    printf("Hi from C: %p, %d\n", &a, a++);
    return 0;
}

然后修改main.c程序,让它既通过Go嗲用C1.helloFromC,又直接调用C1.helloFromC,看看多次调用的时候a的指针是否一致，并且a的值是否有变化。

main.c

#include <stdio.h>
#include "hello.h"
int main() {
    printf("use hello lib from C:\n");
   
    // 1. 直接调用C函数
    helloFromC();
    // 2. 调用Go函数
    HelloFromGo();
    
    // 3. 直接调用C函数
    helloFromC();
    return 0;
}

激动人心的时候到了。我们不同的编译方式会产生不同的结果。

1、gcc -o main main.c hello.so

和第二步相同的编译方式，编译出main并执行，因为hello.so中包含C1.helloFromC实现，所以可以正常执行。

./main
use hello lib from C:
Hi from C: 0x10092a370, 1
Hello from Go!
Hi from C: 0x10092a370, 2
Hi from C: 0x10092a370, 3

可以看到a的指针是同一个值，无论通过Go函数改变还是通过C函数改变都是更改的同一个变量。

nm可以查看生成的main的符号：

nm main
                 U _HelloFromGo
0000000100000000 T __mh_execute_header
                 U _helloFromC
0000000100000f10 T _main
                 U _printf
                 U dyld_stub_binder

U代表这个符号是未定义的符号，通过动态库链接进来。

2、 gcc -o main main.c hello.so ../hello.c

我们编译的时候直接链接hello.c的实现，然后运行main:

./main
use hello lib from C:
Hi from C: 0x104888020, 1
Hello from Go!
Hi from C: 0x1049f7370, 1
Hi from C: 0x104888020, 2

可以看到a是不同的两个变量。

nm可以查看生成的main的符号：

nm main
                 U _HelloFromGo
0000000100000000 T __mh_execute_header
0000000100001020 D _a
0000000100000f10 T _helloFromC
0000000100000ec0 T _main
                 U _printf
                 U dyld_stub_binder

可以看到_a是初始化的环境变量，_helloFromC的类型是T而不是U,代表它是一个全局的Text符号,这和上一步是不一样的。