Go 博客

C?Go?Cgo!

Andrew Gerrand
2011 年 3 月 17 日

简介

cgo 允许 Go 包调用 C 代码。给定一个使用一些特殊功能编写的 Go 源文件,cgo 会输出 Go 和 C 文件,这些文件可以组合成一个 Go 包。

为了以示例开头,这是一个 Go 包,它提供两个函数 - RandomSeed - 它们包装了 C 的 randomsrandom 函数。

package rand

/*
#include <stdlib.h>
*/
import "C"

func Random() int {
    return int(C.random())
}

func Seed(i int) {
    C.srandom(C.uint(i))
}

让我们看看这里发生了什么,从导入语句开始。

rand 包导入 "C",但你会发现 Go 标准库中没有这样的包。这是因为 C 是一个“伪包”,cgo 将其解释为对 C 命名空间的引用。

rand 包包含四个对 C 包的引用:对 C.randomC.srandom 的调用、转换 C.uint(i)import 语句。

Random 函数调用标准 C 库的 random 函数并返回结果。在 C 中,random 返回 C 类型 long 的值,cgo 将其表示为类型 C.long。它必须在 Go 代码可以使用它之前转换为 Go 类型,使用普通的 Go 类型转换,才能在该包之外使用。

func Random() int {
    return int(C.random())
}

这是一个使用临时变量更明确地说明类型转换的等效函数

func Random() int {
    var r C.long = C.random()
    return int(r)
}

Seed 函数以某种方式执行反向操作。它接收一个普通的 Go int,将其转换为 C unsigned int 类型,并将其传递给 C 函数 srandom

func Seed(i int) {
    C.srandom(C.uint(i))
}

请注意,cgo 将 unsigned int 类型识别为 C.uint;有关这些数字类型名称的完整列表,请参阅cgo 文档

我们尚未检查此示例的一个细节是 import 语句上面的注释。

/*
#include <stdlib.h>
*/
import "C"

Cgo 识别此注释。任何以 #cgo 后跟空格字符开头的行都将被删除;这些成为 cgo 的指令。剩余的行在编译包的 C 部分时用作标题。在本例中,这些行只是一个 #include 语句,但它们几乎可以是任何 C 代码。#cgo 指令用于在构建包的 C 部分时为编译器和链接器提供标志。

有一个限制:如果你的程序使用了任何 //export 指令,那么注释中的 C 代码只能包含声明(extern int f();),而不是定义(int f() { return 1; })。你可以使用 //export 指令使 Go 函数可供 C 代码访问。

#cgo//export 指令在cgo 文档中进行了说明。

字符串和其他

与 Go 不同,C 没有显式的字符串类型。C 中的字符串由以零结尾的字符数组表示。

Go 和 C 字符串之间的转换是使用 C.CStringC.GoStringC.GoStringN 函数完成的。这些转换会复制字符串数据。

下一个示例实现了一个 Print 函数,该函数使用 C 的 stdio 库中的 fputs 函数将字符串写入标准输出

package print

// #include <stdio.h>
// #include <stdlib.h>
import "C"
import "unsafe"

func Print(s string) {
    cs := C.CString(s)
    C.fputs(cs, (*C.FILE)(C.stdout))
    C.free(unsafe.Pointer(cs))
}

C 代码进行的内存分配对 Go 的内存管理器是未知的。当你使用 C.CString(或任何 C 内存分配)创建 C 字符串时,你必须记住在你完成后释放内存,方法是调用 C.free

C.CString 的调用返回指向 char 数组开头的指针,因此在函数退出之前,我们将其转换为unsafe.Pointer 并使用 C.free 释放内存分配。cgo 程序中一个常见的习惯用法是在分配后立即defer 释放(尤其是在后续代码比单个函数调用更复杂时),就像在这个 Print 的重写中一样

func Print(s string) {
    cs := C.CString(s)
    defer C.free(unsafe.Pointer(cs))
    C.fputs(cs, (*C.FILE)(C.stdout))
}

构建 cgo 包

要构建 cgo 包,只需像往常一样使用go buildgo install。go 工具识别特殊的 "C" 导入并自动为这些文件使用 cgo。

更多 cgo 资源

cgo 命令文档提供了有关 C 伪包和构建过程的更多详细信息。Go 树中的cgo 示例演示了更高级的概念。

最后,如果你好奇这一切在内部是如何工作的,请查看运行时包的cgocall.go的介绍性注释。

下一篇文章:大量数据
上一篇文章:Go 变得更加稳定
博客索引