golang调用c库，cgo（一）

最新推荐文章于 2024-06-02 15:11:41 发布
最新推荐文章于 2024-06-02 15:11:41 发布
阅读量3.5k 收藏 13
点赞数 1
分类专栏： golang 文章标签： golang
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/raoxiaoya/article/details/130579103
版权
基本使用

有时候我们需要使用golang去调用一些c的类库，因为使用golang重复实现一遍比较耗时，一些成熟的功能直接调用更好。当然前提是要先安装该c库。CGO可以直接用C的代码，或者C的静态库，或者动态库，当然C++也是可以的。

golang中的CGO特性，能够创建调用C代码的Go包。

package main

import "C"

func main() {

}

然后在编译的时候，需要指定CGO_ENABLED=1，当然，默认值就是1，因此不用指定。

> go env |grep CGO
GCCGO="gccgo"
CGO_ENABLED="1"
CGO_CFLAGS="-O2 -g"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-O2 -g"
CGO_FFLAGS="-O2 -g"
CGO_LDFLAGS="-O2 -g"

默认的C编译器是 gcc。

一旦关闭就会影响 CGO 编译。需要特别留意，交叉编译时会默认关闭 CGO。

package main

/*

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

*/
import "C"

func main() {
	s := C.CString("hello world.")
	C.puts(s)
    C.free(unsafe.Pointer(s))
}

> go run main.go
hello world.

注意，注释要紧挨着import "C"，否则就是普通的注释，而不是指令。

C.puts(s)是调用stdio.h中的puts()函数，但是，需要先将go字符串转换成c字符串，所以C.CString()是由伪包C提供的函数。

cgo将当前包引用的C语言符号都放到了虚拟的C包中，同时当前包依赖的其它Go语言包内部可能也通过cgo引入了相似的虚拟C包，但是不同的Go语言包引入的虚拟的C包之间的类型是不能通用的。这个约束对于要自己构造一些cgo辅助函数时有可能会造成一点的影响。

在import "C"语句前的注释中可以通过#cgo语句设置编译阶段和链接阶段的相关参数。编译阶段的参数主要用于定义相关宏和指定头文件检索路径。链接阶段的参数主要是指定库文件检索路径和要链接的库文件。

// #cgo CFLAGS: -DPNG_DEBUG=1 -I./include
// #cgo LDFLAGS: -L/usr/local/lib -lpng
// #include <png.h>
import "C"
基本数据类型

golang 和 C 的基本数值类型转换对照表如下：

C 语言类型CGO 类型Go语言类型
charC.charbyte
singed charC.scharint8
unsigned charC.ucharuint8
shortC.shortint16
unsigned shortC.ushortuint16
intC.intint32
unsigned intC.uintuint32
longC.longint32
unsigned longC.ulonguint32
long long intC.longlongint64
unsigned long long intC.ulonglonguint64
floatC.floatfloat32
doubleC.doublefloat64
size_tC.size_tuint

注意 C 中的整形比如 int 在标准中是没有定义具体字长的，但一般默认认为是 4 字节，对应 CGO 类型中 C.int 则明确定义了字长是 4 ，但 golang 中的 int 字长则是 8 ，因此对应的 golang 类型不是 int 而是 int32 。为了避免误用，C 代码最好使用 C99 标准的数值类型，对应的转换关系如下：

C语言类型CGO类型Go语言类型
int8_tC.int8_tint8
uint8_tC.uint8_tuint8
int16_tC.int16_tint16
uint16_tC.uint16_tuint16
int32_tC.int32_tint32
uint32_tC.uint32_tuint32
int64_tC.int64_tint64
uint64_tC.uint64_tuint64

C类型是使用在C代码中的，CGO类型和GO类型都是用在GO代码中的，CGO类型是在GO代码中GO类型转换成C类型然后传递给C函数使用。然后在GO代码中C函数的返回值也是CGO类型的。

package main

/*

#include <stdint.h>
static int32_t add(int32_t a, int32_t b) {
	return a + b;
}

*/
import "C"
import "fmt"

func main() {
	var a, b int32 = 1, 2
	var c int32 = int32(C.add(C.int32_t(a), C.int32_t(b)))
	fmt.Println(c)
}
字符串

c语言没有字符串类型，使用char数组代替，于是CGO提供了用于转换 Go 和 C 类型的字符串的函数，都是通过复制数据来实现。

// Go string to C string
// The C string is allocated in the C heap using malloc.
// It is the caller's responsibility to arrange for it to be
// freed, such as by calling C.free (be sure to include stdlib.h
// if C.free is needed).
func C.CString(string) *C.char

// Go []byte slice to C array
// The C array is allocated in the C heap using malloc.
// It is the caller's responsibility to arrange for it to be
// freed, such as by calling C.free (be sure to include stdlib.h
// if C.free is needed).
func C.CBytes([]byte) unsafe.Pointer

// C string to Go string
func C.GoString(*C.char) string

// C data with explicit length to Go string
func C.GoStringN(*C.char, C.int) string

// C data with explicit length to Go []byte
func C.GoBytes(unsafe.Pointer, C.int) []byte

注意，如果程序常驻内存的话需要使用C.free(unsafe.Pointer(s))来释放由C.CString()创建的内存。

package main

/*

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

static void SayHello(const char* s) {
	puts(s);
}
*/
import "C"
import "unsafe"

func main() {
	s := C.CString("hello world.")
	C.SayHello(s)
	C.free(unsafe.Pointer(s))
}

我们也可以将SayHello函数放到当前目录下的一个C语言源文件中。因为是编写在独立的C文件中，为了允许外部引用，所以需要去掉函数的static修饰符，因为static函数只能在声明它的文件中可见，其他文件不能引用该函数。hello.c

#include <stdio.h>

void SayHello(const char* s) {
	puts(s);
}

然后在CGO部分先声明SayHello函数

package main

/*
#include "hello.c"
*/
import "C"

func main() {
	C.SayHello(C.CString("hello world."))
}

或者模块化

hello.h

void SayHello(const char* s);

hello.c

#include "hello.h"
#include <stdio.h>

void SayHello(const char* s) {
	puts(s);
}

也可以使用c++来实现hello.h接口

#include <iostream>

extern "C" {
	#include "hello.h"
}

void SayHello(const char* s) {
	std::cout << s;
}

或者golang实现

hello.h

void SayHello(char* s);

main.go

//export SayHello
func SayHello(s *C.char) {
	fmt.Print(C.GoString(s))
}

CGO不仅仅用于Go语言中调用C语言函数，还可以用于导出Go语言函数给C语言函数调用。我们通过CGO的//export SayHello指令将Go语言实现的函数SayHello导出为C语言函数。为了适配CGO导出的C语言函数，我们禁止了在函数的声明语句中的const修饰符。

或者简化一下

package main

//void SayHello(char* s);
import "C"

import (
	"fmt"
)

func main() {
	C.SayHello(C.CString("Hello, World\n"))
}

//export SayHello
func SayHello(s *C.char) {
	fmt.Print(C.GoString(s))
}

在Go1.10中CGO新增加了一个_GoString_预定义的C语言类型，用来表示Go语言字符串。下面是改进后的代码：

package main

//void SayHello(_GoString_ s);
import "C"

import (
	"fmt"
)

func main() {
	C.SayHello("Hello, World")
}

//export SayHello
func SayHello(s string) {
	fmt.Print(s)
}
切片

golang 中切片用起来有点像 C 中的数组，但实际的内存模型还是有点区别的。C 中的数组就是一段连续的内存，数组的值实际上就是这段内存的首地址。golang 切片还包含cap和len。

由于底层内存模型的差异，不能直接将 golang 切片的指针传给 C 函数调用，而是需要将存储切片数据的内部缓冲区的首地址及切片长度取出传递，然后在C代码里面重新构建数组：

package main

/*
#include <stdint.h>

static void fill_255(char* buf, int32_t len) {
	int32_t i;
	for (i = 0; i < len; i++) {
		buf[i] = 255;
	}
}
*/
import "C"
import (
	"fmt"
	"unsafe"
)

func main() {
	b := make([]byte, 5)
	fmt.Println(b) // [0 0 0 0 0]
	C.fill_255((*C.char)(unsafe.Pointer(&b[0])), C.int32_t(len(b)))
	fmt.Println(b) // [255 255 255 255 255]
}
C函数的返回值

对于有返回值的C函数，我们可以正常获取返回值。

/*
static int div(int a, int b) {
	return a/b;
}
*/
import "C"
import "fmt"

func main() {
	v := C.div(6, 3)
	fmt.Println(v) // 2
}

上面的div函数实现了一个整数除法的运算，然后通过返回值返回除法的结果。

不过如果对于除数为0的情形并没有做特殊处理。如果希望在除数为0的时候返回一个错误，其余时候返回正常的结果。因为C语言不支持返回多个结果，因此<errno.h>标准库提供了一个errno宏用于返回错误状态。我们可以近似地将errno看着一个线程安全的全局变量，可以用于记录最近一次错误的状态码。

改进后的div函数实现如下：

/*
#include <errno.h>

static int div(int a, int b) {
	if(b == 0) {
		errno = EINVAL;
		return 0;
	}
	return a/b;
}
*/
import "C"
import "fmt"

func main() {
	v0, err0 := C.div(2, 1)
	fmt.Println(v0, err0) // 2 <nil>

	v1, err1 := C.div(1, 0)
	fmt.Println(v1, err1) // 0 The device does not recognize the command.
}

CGO也针对<errno.h>标准库的errno宏做的特殊支持：在CGO调用C函数时如果有两个返回值，那么第二个返回值将对应errno错误状态。

void函数的返回值

C语言函数还有一种没有返回值类型的函数，用void表示返回值类型。一般情况下，我们无法获取void类型函数的返回值，因为没有返回值可以获取。前面的例子中提到，cgo对errno做了特殊处理，可以通过第二个返回值来获取C语言的错误状态。对于void类型函数，这个特性依然有效。

//static void noreturn() {}
import "C"
import "fmt"

func main() {
	_, err := C.noreturn()
	fmt.Println(err)
}

我们也可以尝试获取第一个返回值，它对应的是C语言的void对应的Go语言类型：

//static void noreturn() {}
import "C"
import "fmt"

func main() {
	v, _ := C.noreturn()
	fmt.Printf("%#v", v) // main._Ctype_void{}
}

关于cgo的内部实现机制可以阅读 https://www.cntofu.com/book/73/ch2-cgo/ch2-05-internal.md

链接静态库和动态库 https://www.cntofu.com/book/73/ch2-cgo/ch2-09-static-shared-lib.md

raoxiaoya
关注
  • 1
    点赞
  • 踩
  • 13
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Golang基于CGO的动态链接库调用利用CGO特性编写可跨平台调用的动态链接库
禅与计算机程序设计艺术
07-29 1543
在Go语言中，支持CGO，也就是说可以通过调用C语言函数来实现Go语言代码。通过调用C语言函数可以节省资源，提升性能。但是，在调用C语言函数的时候需要注意一些细节。需要写C语言的头文件，该头文件需要包含要调用的C语言函数声明，并在源代码中包含这个头文件；在编译Go语言源码时，需要指定相应的链接参数，包括导入的静态库（如libm.a）、动态库（如libcrypto.so）等；虽然可以使用cgo关键字导入头文件，但仍然需要手工处理动态库的导入和链接。
Go语言中的CGO与C语言交互详解
程序员墨松
05-21 947
CGO为Go语言和C语言之间的交互提供了一个强大的工具。通过使用CGO，我们可以利用现有的C库或C语言编写的代码，以获得更多的功能和灵活性。无论是封装C库、性能优化、跨平台兼容性，还是利用已有的C工具链，CGO都能帮助我们轻松实现目标。通过上面的示例代码，我们可以看到CGO与C语言交互的简单性和实用性。希望这篇文章能帮助你更好地理解和使用CGO与C语言的交互。推荐阅读我的博客首页Golang专栏。
golang cgo 使用总结
darlingtangli的专栏
11-18 8442
原文地址 CGO 提供了 golang 和 C 语言相互调用的机制。某些第三方库可能只有 C/C++ 的实现，完全用纯 golang 的实现可能工程浩大，这时候 CGO 就派上用场了。可以通 CGO 在 golang 在调用 C 的接口，C++ 的接口可以用 C 包装一下提供给 golang 调用。被调用的 C 代码可以直接以源代码形式提供或者打包静态库或动态库在编译时链接。推荐使用静态库的方式，...
Winddow系统下关于Golang使用Cgo的配置
最新发布
cbzhunian
06-02 1055
可以设置GOOS=windows。添加路径到path。
Golang cgo：如何在Go代码中调用C语言代码？
梦~'
01-12 3896
Golang cgo：如何在Go代码中调用C语言代码？
golang 调用 c++ （cgo）
LRZ的博客
08-15 4144
golang调用c++ (cgo)
Go：优雅处理项目中的cgo依赖问题(1)，2024年最新Golang入门零基础
2401_84252890的博客
04-13 455
在Go项目中处理cgo依赖的问题可以采取多种策略。从条件编译到依赖注入，再到使用Docker容器，每种方法都有其适用场景。选择最适合我们项目和开发流程的方法，可以显著提高开发效率，减少因环境差异引起的编译和运行时错误。自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。深知大多数Go语言工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。
golang 通过 cgo 调用 C++ 库
xchenhao 的博客
02-06 1503
golang 通过 cgo 调用 C++ 库
golang调用 xx.so 动态库 DEMO sdk.tar
06-12
编译一个 xx.so 动态库，使用cgo调用so库输入和输出数据。 开发环境: golang调用 xx.so 动态库 DEMO, Centos7, go1.14.4
Golang如何调用Python代码详解
01-03
go 中的 cgo 模块可以让 go 无缝调用 c 或者 c++ 的代码，而 python 本身就是个 c 库，自然也可以由 cgo 直接调用，前提是指定正确的编译条件，如 Python.h 头文件（），以及要链接的库文件。本文以 Ubuntu 18.04 ...
Jni-Golang:java调用golang（通过Go1.5共享库）
05-05
在 Go 1.5 版本之后，Go 语言引入了 cgo，这是一个工具，它允许 Go 代码调用 C 代码，并且可以生成可链接到其他 C 代码的库。借助 cgo，我们可以创建一个可被 Java 通过 JNI 调用的 Golang 共享库。 以下是实现步骤...
go调用c动态库dll源码demo
05-19
本文将详细介绍如何使用Golang调用C动态库，并提供一个实际的示例。 首先，我们需要了解cgo。cgo是Go语言的标准库之一，它允许Go代码直接引用C代码。通过cgo，Go编译器会生成C代码，然后链接到C编译器生成的目标...
Golang 中的 cgo 使用方法，调用 mysql (c语言类库)为案例.pdf
12-16
Golang 中的 cgo 使用方法，调用 mysql (c语言类库)为案例
CGO:让Go程序调用C函数的神器
qq_42538588的博客
06-12 1349
在现代软件开发中，多语言编程已经成为了一种趋势。而在多语言编程中，Go语言作为一种高效、简洁、安全的语言，越来越受到开发者的青睐。但是，由于Go语言本身并不支持直接调用C函数，因此需要借助CGO这个工具来实现这一功能。本文将详细介绍如何使用CGO来调用C函数，让你的Go程序更加强大！
Go：优雅处理项目中的cgo依赖问题，2024年最新Golang组件化开发教程
2401_84252890的博客
04-13 335
在Go项目中处理cgo依赖的问题可以采取多种策略。从条件编译到依赖注入，再到使用Docker容器，每种方法都有其适用场景。选择最适合我们项目和开发流程的方法，可以显著提高开发效率，减少因环境差异引起的编译和运行时错误。自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。深知大多数Go语言工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。
快速上手 CGO，掌握在 Go 里写 C！
kevin_tech的博客，微信搜「网管叨bi叨」
05-29 1487
大家好，最近因为各种奇怪的原因，接触到了 Go 特色之一 CGO。这方面的相关内容也相对少一些，给大家抛砖引玉，有经验的大佬欢迎补充。图片来源于 marlin毕竟很多跨语言调用，还是会依赖 CGO 这个特性。希望大家在真正要用时有个前置知识垫肚子。CGO 是什么CGO 就是 C 和 Go，两个编程语言。指的是能够创建调用 C 代码的 Go 包。对照着 Go 代码中的 “C”：packagemai...
cgo 机制 - 从 c 调用 go
金融级分布式架构
10-04 1855
文｜朱德江（GitHub ID：doujiang24)MOSN 项目核心开发者蚂蚁集团技术专家专注于云原生网关研发的相关工作本文4656字 阅读12分钟一、前言去年刚学 go 语言的时候，写了这篇 cgo 实现机制[1]，介绍了 cgo 的基本情况。主要介绍的是go=>c这个调用方式，属于比较浅的层次。随着了解的深入，发现c=>go的复杂度又高了一级，所以有了这篇文章...
CGO的介绍
jikechong的专栏
02-15 2250
该字符串在C语言函数中完全跨越了Go语言的内存管理，在PrintGoString调用前即使发生了栈伸缩导致的Go字符串地址发生变化也依然可以正常工作，因为该字符串对应的id是稳定的，在Go语言空间通过id解码得到的字符串也就是有效的。假设一个极端场景：我们将一块位于某goroutinue的栈上的Go语言内存传入了C语言函数后，在此C语言函数执行期间，此goroutinue的栈因为空间不足的原因发生了扩展，也就是导致了原来的Go语言内存被移动到了新的位置。对于指定了特殊对齐规则的结构体，无法在CGO中访问。
cgo的效率 golang_golang cgo 使用总结
weixin_39974557的博客
12-19 863
CGO 提供了 golang 和 C 语言相互调用的机制。某些第三方库可能只有 C/C++ 的实现，完全用纯 golang 的实现可能工程浩大，这时候 CGO 就派上用场了。可以通 CGO 在 golang 在调用 C 的接口，C++ 的接口可以用 C 包装一下提供给 golang 调用。被调用的 C 代码可以直接以源代码形式提供或者打包静态库或动态库在编译时链接。推荐使用静态库的方式，这样方便代...
windows系统下，golang调用C语言开源库libxslt
05-25
在 Windows 系统下，使用 Golang 调用 C 语言开源库 libxslt 可以通过以下步骤完成： 1. 安装 libxslt 在 Windows 上，可以通过 Cygwin 或 MinGW 等工具链来安装 libxslt 库。 2. 编写 C 语言代码 编写 C 语言代码，实现 libxslt 库的功能，并将其编译为动态链接库（.dll）文件。 例如，以下是一个使用 libxslt 库将 XML 文件转换为 HTML 文件的 C 语言代码： ```c #include <stdio.h> #include <string.h> #include <libxslt/xslt.h> #include <libxslt/transform.h> int transform(char *xml, char *xsl, char *output) { xmlDocPtr doc, res; xsltStylesheetPtr sty; const char *params[1] = { NULL }; int ret; xmlInitParser(); LIBXML_TEST_VERSION doc = xmlReadMemory(xml, strlen(xml), "noname.xml", NULL, 0); sty = xsltParseStylesheetFile((const xmlChar *)xsl); res = xsltApplyStylesheet(sty, doc, params); xmlSaveFormatFile(output, res, 1); xsltFreeStylesheet(sty); xmlFreeDoc(doc); xmlFreeDoc(res); xmlCleanupParser(); return ret; } ``` 将上述代码编译为动态链接库，可使用以下命令： ``` gcc -shared -o libxslt.dll -I/path/to/libxslt/include -L/path/to/libxslt/lib -lxslt -lz -lm xslt.c ``` 其中，`/path/to/libxslt` 为 libxslt 库的安装目录。 3. 使用 CGO 调用 C 函数 在 Golang 中，使用 CGO 可以调用 C 函数。在调用 C 函数前，需要将 C 函数声明为外部函数。 例如，以下是一个使用 CGO 调用上述 C 函数的 Golang 代码： ```go package main // #cgo LDFLAGS: -L./ -lxslt // int transform(char *xml, char *xsl, char *output); import "C" import "fmt" func main() { xml := "<xml>...</xml>" xsl := "<xsl>...</xsl>" output := "output.html" ret := C.transform(C.CString(xml), C.CString(xsl), C.CString(output)) fmt.Println(ret) } ``` 在编译 Golang 代码时，需要指定 libxslt 库的链接标志 `-L` 和 `lxslt`。 以上就是在 Windows 系统下，使用 Golang 调用 C 语言开源库 libxslt 的步骤。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值