探索C到Go汇编的神奇之旅:c2goasm
开篇介绍
c2goasm 是一个独特的工具,它能将C或C++编译器生成的汇编代码转化为Go语言的汇编代码。这个项目与asm2plan9s协同工作,用于自动生成C/C++代码(如利用SIMD内联指令或模板)的纯Go包装器。
操作模式:
$ c2goasm -a /path/to/some/great/c-code.s /path/to/now/great/golang-code_amd64.s
为了获得更美观的代码布局,你可以通过传递-f
标志来调用asmfmt。
该项目在开发Simd的Go封装过程中诞生,但同样适用于其他项目和库。请注意,它的设计不是一次性移植整个C/C++项目,而是逐个函数或源文件进行操作,并创建高阶Go代码来调用汇编代码。
命令行选项
$ c2goasm --help
Usage of c2goasm:
-a Immediately invoke asm2plan9s
-c Compact byte codes
-f Format using asmfmt
-s Strip comments
实例展示
让我们看一个简单的例子,该示例展示了如何使用AVX2内联向量运算符:
void MultiplyAndAdd(float* arg1, float* arg2, float* arg3, float* result) {
__m256 vec1 = _mm256_load_ps(arg1);
__m256 vec2 = _mm256_load_ps(arg2);
__m256 vec3 = _mm256_load_ps(arg3);
__m256 res = _mm256_fmadd_ps(vec1, vec2, vec3);
_mm256_storeu_ps(result, res);
}
将其编译为汇编代码后,通过c2goasm
可以转换成Go汇编代码,例如保存为MultiplyAndAdd_amd64.s
:
//+build !noasm !appengine
// AUTO-GENERATED BY C2GOASM -- DO NOT EDIT
TEXT ·_MultiplyAndAdd(SB), $0-32
...
并配合MultiplyAndAdd_amd64.go
中的Go代码:
//go:noescape
func _MultiplyAndAdd(vec1, vec2, vec3, result unsafe.Pointer)
func MultiplyAndAdd(someObj Object) {
_MultiplyAndAdd(someObj.GetVec1(), someObj.GetVec2(), someObj.GetVec3(), someObj.GetResult())
}
性能比较
在Go版本1.7.5和1.8.1上,我们对比了c2goasm
与cgo
的性能。结果表明c2goasm
在速度上显著优于cgo
,在1.8.1中甚至达到了约20倍的提升。
已转换项目
内部机制
转化过程主要包括:在程序开头设置C代码期望的栈和寄存器状态,然后退出子程序时恢复到Go世界并传递返回值(如果需要)。具体包括:
- 定义Go装饰的汇编子程序,考虑到所需的栈空间和参数及返回值的总体大小。
- 函数参数从Go栈加载到寄存器中,并在执行C代码之前将超过6个的参数存储在C栈空间中。
- 预留栈空间以满足C代码的需求。根据C代码,堆栈指针可能需要对齐到特定边界,特别是在使用AVX等SIMD指令的情况下。
- 如果需要,生成常量表,并替换
rip
基于的引用,使其指向Go放置表的地方。
限制
- 参数目前必须为64位大小,意味着是值或指针(这一要求未来可能会放宽)
- 最多14个参数(硬限制——如果你遇到这个问题,也许应该重新考虑你的API)
- 一般不支持
call
语句(除了像memset
和memcpy
这样的例外,见clib_amd64.s
)
从C/C++生成汇编代码
对于使用cmake的项目,可以通过以下命令查看汇编目标列表:
$ make help | grep "\.s"
要查看实际的生成命令,请运行:
$ make -n SimdAvx2BgraToGray.s
支持的Go架构
目前仅支持AMD64架构。ARM64理论上也可以工作,但目前尚无支持。
兼容的编译器
已测试的编译器包括:
- Apple LLVM 版本的
clang
(在OSX/darwin上) clang
(在Linux上)
编译器标志:
-masm=intel -mno-red-zone -mstackrealign -mllvm -inline-threshold=1000 -fno-asynchronous-unwind-tables -fno-exceptions -fno-rtti
更进一步优化
你可以使用LLVM优化器(opt)进一步优化代码生成。更多可用选项,请参阅opt --help
或opt --help-hidden
。
资源
许可证
c2goasm遵循Apache许可证v2.0。完整文本可在LICENSE文件中找到。
贡献
欢迎贡献,如有改进建议请发送PR。