再谈CGO!

最近在kubernetes上搞集成其它team算法的事情，他们的算法是用c写的，自然地我需要用cgo去调用。本文整理了使用cgo过程中的一些函数，特此整理下来，记录。

1，给c函数传递二维整型数组

c函数需要接收一个二维整型数组作为参数，

extern bool xxx_func(int** _matrix);

最初实现如下：

goArray := [][]int{{1},{3,3},{3,3,2}}
cArray := make([][]C.int, len(goArray))
for i, _ := range goArray { 
    cArray[i] = make([]C.int, len(goArray[i])) 
    for j, _ := range goArray[i] { 
        cArray[i][j] = C.int(goArray[i][j]) 
        }
} 
C.xxx_func((**C.int)(unsafe.Pointer(&cArray[0][0]))) // 把该数组的首地址传递给c函数

这样实现对吗？当然不对！ 仔细看该函数，这个函数其实是创建了一个切片，然后里边保存了N个独立的切片，它的内存地址并不是连续的！当然这对Go本身来说是正确的，但是对c来说却大错特错，c中的二维数组内存地址必须是连续的（说白了c中的二维数组其实就是个一维数组，寻址方式不同）。所以应该按照如下方式去实现：

• 分配一个长度为N*M的slice (N和M代表二维数组的行和列)
• 用go的二维数组中的值填充这个slice
• 传递这个slice的指针传递给c函数

第一种代码实现如下：

n, m := len(goArray), 0
for _, row := range goArray {
    if len(row) > m {
        m = len(row)
    }
}

cArray := make([]C.int, n*m)
for i, row := range goArray {
    for j, v := range row {
        a[i * n + j] = v
    }  
}

C.xxx_func((**C.int)(unsafe.Pointer(&cArray[0]))) 

然后运行，发现cannot use &cArray[0] (type *C.int) as type **C.int in argument to func literal, 上述的操作其实是把go的二维数组转化为一维数组再传递给c函数，但是c函数要接收的是int**即二维数组，所以报错，最好的解决方式是把c函数的参数改为接收int*一维数组。
But, 如果不能改c函数的参数，该怎么办呢？
第二种代码实现：

        cArray := make([]*C.int, len(goArray))
        for i, row := range goArray {
                p := (*C.int)(C.malloc(C.size_t(C.sizeof_int * len(row))))

                cArray[i] = p
                pa := (*[1 << 30]C.int)(unsafe.Pointer(p))
                for j, v := range row {
                        (*pa)[j] = C.int(v)
                }
        }

这里，我们为goArray的每一行分配一个源大小的C.int数组，并给将指针p付给cArray,
然后把p类型*C.int 转化为*[1<<30]C.int类型(指向一个很大的C.int型数组)，但是这里需要注意两个问题：

• C.malloc()的内存释放
• 我们给每一行row分配了一个数组，但是数组长度信息丢失了！在go这边没问题，但是对于c来说，一个数组仅仅是一个指针，它通过这个指针没法知道指向这个内存区域的长度，你得告诉它，或者写个包含该指针和长度的结构体，这个依赖于c那边的具体实现

推荐使用第一种方法，因为cgo和c的内存释放问题就能折腾你好几天，除非你清楚地知道，哪里该释放，哪里不应该释放。

2，给c函数传递字符串数组

这个简单多了，但是需要注意内存释放。代码如下：

goString := []string{"w0", "w1", "w2", "w3"} 
cString := make([]*C.char, len(goString)) 
for i, _ := range goString { 
        cString[i] = C.CString(goString[i]) 

        // 注意这个内存释放，该不该在调用完c函数之后释放，依赖于c那边的实现，这里要小心使用！
        defer C.free(unsafe.Pointer(cString[i])) 
} 

C.xxx_func2((**C.char)(unsafe.Pointer(&cString[0])))

关于C.CString的官方文档：

// 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

3，把c字符串数组转化为go字符串切片

//你必须清楚地知道返回的c字符串数组的长度
func GoStrings(length int, argv **C.char) []string {
        if argv == nil {
                return nil
        }
        tmpslice := (*[1 << 30]*C.char)(unsafe.Pointer(argv))[:length:length]
        gostrings := make([]string, length)
        for i, s := range tmpslice {
                gostrings[i] = C.GoString(s)
        }
        return gostrings
}

C.GoString的官方文档，真简洁:(

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

参考资料：https://golang.org/cmd/cgo/
cgo wiki : https://github.com/golang/go/wiki/cgo
google大神多： https://groups.google.com/forum/#!topic/golang-nuts/Nb-nfVdAyF0