CGO基础介绍
Go语言通过自带的一个叫CGO的工具来支持C语言函数调用，像go调用一些著名的开源库 ffmpeg、opencv 等都可以利用CGO特性，同时我们可以用Go语言导出C动态库接口给其它语言使用。
要使用CGO特性，需要安装C/C++构建工具链，在macOS和Linux下是要安装GCC，在windows下是需要安装MinGW工具。同时需要保证环境变量CGO_ENABLED被设置为1，这表示CGO是被启用的状态。在本地构建时CGO_ENABLED默认是启用的，当交叉构建时CGO默认是禁止的。比如要交叉构建ARM环境运行的Go程序，需要手工设置好C/C++交叉构建的工具链，同时开启CGO_ENABLED环境变量。然后通过import "C"语句启用CGO特性。
go调用C/C++的几种方式
1 go的源代码中直接声明C代码
比较简单的测试可以直接使用这种方法。没什么实用性
C代码直接写在go代码的注释中
注释之后紧跟import "C" 通过C.xxx来引用C的结构和函数
demo 创建fileserver1项目，建个main.go
package main
/*
#include <stdio.h>
int add(int a, int b) {
return a+b;
}
*/
import "C"
import "fmt"
func main() {
fmt.Println(C.add(1, 3))
}
编译和执行go
go build main.go
./main
2 直接引用C文件的形式
C代码量比较少的情况可以使用这种方法。实用性一般
C代码和go代码放在一个项目中
demo 目录如下图，在fileserver2项目中的把c代码直接放在utils目录中
mmath.h
#ifndef MMATH_H_
#define MMATH_H_
int sum(int a, int b);
int sub(int a, int b);
#endif // MMATH_H_
mmath.c
#include "mmath.h"
int sum(int a, int b)
{
return a + b;
}
int sub(int a, int b)
{
return a - b;
}
mmath.go
package utils
/*
#include "mmath.h"
*/
import "C"
func Sum(a, b int) int {
ret := C.sum(C.int(a), C.int(b))
return int(ret)
}
func Sub(a, b int) int {
ret := C.sub(C.int(a), C.int(b))
return int(ret)
}
main.go
package main
import (
"fmt"
"goslice/fileserver2/utils"
)
func Test_mmath() {
fmt.Println(utils.Sum(11, 33))
fmt.Println(utils.Sub(11, 3))
}
func main() {
Test_mmath()
}
3 导入动态库 xxx.so 的形式
C/C++项目和go项目各自独立分开。实用性较好
使用的地方需要加头文件和库的引用处理
/*
#cgo CFLAGS: -I/opt/creality_wrapper/include
#cgo LDFLAGS: -L/opt/creality_wrapper/lib -lslicer
#include "slicer_wrapper.h"
*/
CFLAGS: -I路径 这句话指明头文件所在路径
LDFLAGS: -L路径 指明动态库的所在路径，-l动态库名
demo 的c/c++项目目录如下图
slicer.h/slicer.cpp 是c++具体功能实现的类
slicer_wrapper.h/slicer_wrapper.cpp 是对c++实现功能的c接口包装
build.sh 是cloudslicer项目生成动态库的编译脚本
slicer.h
#include <string>
class Slicer {
public:
Slicer();
~Slicer();
void setArg1(int aa);
void setArg2(std::string bb);
int slice();
private:
int aa_;
std::string bb_;
};
slicer.cpp
#include "slicer.h"
#include <iostream>
Slicer::Slicer()
{
}
Slicer::~Slicer()
{
}
void Slicer::setArg1(int aa)
{
aa_ = aa;
}
void Slicer::setArg2(std::string bb)
{
bb_ = bb;
}
int Slicer::slice()
{
std::cout << "arg1:" << aa_ << std::endl;
std::cout << "arg2:" << bb_ << std::endl;
return 0;
}
slicer_wrapper.h
#ifndef SLICER_WRAPPER_H_
#define SLICER_WRAPPER_H_
#ifdef __cplusplus
extern "C"
{
#endif
void* slicerCreate();
void slicerDestroy(void* p);
void setArg1(void* p, int aa);
void setArg2(void* p, char* bb);
int slice(void* p);
#ifdef __cplusplus
}
#endif
#endif // SLICER_WRAPPER_H_
slicer_wrapper.cpp
#include "slicer_wrapper.h"
#include "slicer.h"
void* slicerCreate()
{
return new Slicer();
}
void slicerDestroy(void* p)
{
delete static_cast<Slicer*>(p);
}
void setArg1(void* p, int aa)
{
static_cast<Slicer*>(p)->setArg1(aa);
}
void setArg2(void* p, char* bb)
{
static_cast<Slicer*>(p)->setArg2(bb);
}
int slice(void* p)
{
return static_cast<Slicer*>(p)->slice();
}
build.sh
#!/bin/bash
ROOT_DIR=$PWD
cd ${ROOT_DIR}
# 生成动态库文件 libslicer.so
g++ -c -fPIC slicer.cpp slicer_wrapper.cpp
g++ -shared -fPIC -o libslicer.so slicer.o slicer_wrapper.o -L/opt/creality_wrapper/lib
rm -rf *.o
# 动态库和头文件放在/opt/creality_wrapper目录下
sudo mv -f libslicer.so /opt/creality_wrapper/lib
sudo cp -f slicer_wrapper.h /opt/creality_wrapper/include
创建go项目fileserver3，建个main.go 来使用 libslicer.so 库
main.go
package main
/*
#cgo CFLAGS: -I/opt/creality_wrapper/include
#cgo LDFLAGS: -L/opt/creality_wrapper/lib -lslicer -Wl,-rpath=/opt/creality_wrapper/lib
#include "slicer_wrapper.h"
*/
import "C"
import (
"fmt"
)
func main() {
slicer := C.slicerCreate()
defer C.slicerDestroy(slicer)
C.setArg1(slicer, 22)
C.setArg2(slicer, C.CString("cgo"))
C.slice(slicer)
fmt.Println("slice ok.")
}
如果动态库找不到，将会类似下面错误信息
error while loading shared libraries: libslicer.so: cannot open shared object file: No such file or directory
解决方案4种方法：
1. 修改/etc/ld.so.conf
sudo vim /etc/ld.so.conf
加入 /opt/creality_wrapper/lib
sudo ldconfig
2. 用ln将需要的so文件链接到 /usr/lib 或 /usr/local/lib 这两个默认的目录下边
sudo ln -s /opt/creality_wrapper/lib/libslicer.so /usr/local/lib
sudo ldconfig
3. 修改LD_LIBRARY_PATH
export LD_LIBRARY_PATH=/opt/creality_wrapper/lib:$LD_LIBRARY_PATH，然后执行 sudo ldconfig
或者在 /etc/profile 中增加，然后执行 source /etc/profile
或者在 编译go的脚本里面增加 export LD_LIBRARY_PATH=/opt/creality_wrapper/lib:$LD_LIBRARY_PATH
4. cgo运行时指定链接的位置，最佳方法
#cgo LDFLAGS: -L/opt/creality_wrapper/lib -lslicer -Wl,-rpath=/opt/creality_wrapper/lib
CGO内部机制
CGO特性主要是通过一个叫cgo的命令行工具来辅助输出go和C之间的桥接代码。
要了解CGO技术的底层秘密首先需要了解CGO生成了哪些中间文件。像demo中fileserver1项目比较简单的cgo代码可以直接通过手工调用go tool cgo命令来查看生成的中间文件。
go tool cgo main.go
在一个go源文件中，如果出现了import "C"指令则表示将调用cgo命令生成对应的中间文件。下图是cgo生成的中间文件在_obj目录下
main.go 会分别创建 main.cgo1.go 和 main.cgo2.c 两个中间文件。然后会为整个包创建一个 _cgo_gotypes.go go文件，其中包含go语言部分辅助代码。此外还会创建一个 _cgo_export.h 和 _cgo_export.c 文件，对应go语言导出到C语言的类型和函数。
查看生成的代码可以看出整个调用流程如下
main.cgo1.go 中调用 _Cfunc_add
func main() {
fmt.Println(( /*line :14:14*/_Cfunc_add /*line :14:18*/)(1, 3))
}
_cgo_gotypes.go 中调用 _cgo_runtime_cgocall -> _cgo_2cb47aa99e9f_Cfunc_add
//go:cgo_unsafe_args
func _Cfunc_add(p0 _Ctype_int, p1 _Ctype_int) (r1 _Ctype_int) {
_cgo_runtime_cgocall(_cgo_2cb47aa99e9f_Cfunc_add, uintptr(unsafe.Pointer(&p0)))
if _Cgo_always_false {
_Cgo_use(p0)
_Cgo_use(p1)
}
return
}
main.cgo2.c 中 _cgo_2cb47aa99e9f_Cfunc_add -> add(_cgo_a->p0, _cgo_a->p1)
CGO_NO_SANITIZE_THREAD
void
_cgo_2cb47aa99e9f_Cfunc_add(void *v)
{
struct {
int p0;
int p1;
int r;
char __pad12[4];
} __attribute__((__packed__, __gcc_struct__)) *_cgo_a = v;
char *_cgo_stktop = _cgo_topofstack();
__typeof__(_cgo_a->r) _cgo_r;
_cgo_tsan_acquire();
_cgo_r = add(_cgo_a->p0, _cgo_a->p1);
_cgo_tsan_release();
_cgo_a = (void*)((char*)_cgo_a + (_cgo_topofstack() - _cgo_stktop));
_cgo_a->r = _cgo_r;
_cgo_msan_write(&_cgo_a->r, sizeof(_cgo_a->r));
}
main.cgo2.c中 add实现
int add(int a, int b) {
return a+b;
}
