https://github.com/nitrix/fastcgo
A library for fast Cgo calls.
https://github.com/nitrix/fastcgo
Last synced: 2 days ago
JSON representation
A library for fast Cgo calls.
- Host: GitHub
- URL: https://github.com/nitrix/fastcgo
- Owner: nitrix
- License: unlicense
- Created: 2024-04-17T01:07:11.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T18:43:55.000Z (over 1 year ago)
- Last Synced: 2024-08-14T20:25:24.796Z (over 1 year ago)
- Language: Assembly
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fastcgo
Fast Cgo calls using an assembly trampoline.
## Supported
| | Window | MacOS | Linux |
|--------|--------|-------|-------|
| x86_64 | ✅ | ✅ | ✅ |
| ARM64 | ❌ | ✅ | ❓ |
✅ = Working and tested.
❓ = May work, unknown, no tests.
❌ = Not currently supported.
## Warning
This is **very unsafe** and lets you call C using the current's goroutine thread's system stack internal to Go. It monopolizes the thread to itself and completly bypass the regular scheduler premptions. It also disrupts the GC while blocked inside C code. Use at your own risk.
## Why?
Two reasons:
* Workaround for a [scheduling issue](https://dqlite.io/docs/explanation/faq#why-c-7) when the call lasts longer than 20 microseconds which is causing me visible stutter when calling [glfwSwapBuffers()](https://github.com/go-gl/glfw) with VSync enabled.
* Bring down the [Cgo overhead](https://github.com/golang/go/issues/19574) from 50ns to 3ns (see below).
## Benchmark
With `go test -run=- -bench=. ./bench`:
```
cpu: Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz
BenchmarkGO-8 1000000000 0.4139 ns/op
BenchmarkCGO-8 23076256 51.72 ns/op
BenchmarkFastCGO-8 414632949 2.885 ns/op
```
## Example
```go
package main
/*
#include
void example(int x) {
printf("Hello %d", x);
}
*/
import "C"
import "github.com/nitrix/fastcgo"
func main() {
fastcgo.UnsafeCall1(C.example, 42)
}
```
## API
```go
func UnsafeCall1(fn unsafe.Pointer, arg0 uintptr)
func UnsafeCall2(fn unsafe.Pointer, arg0 uintptr, arg1 uintptr)
func UnsafeCall3(fn unsafe.Pointer, arg0 uintptr, arg1 uintptr, arg2 uintptr)
func UnsafeCall4(fn unsafe.Pointer, arg0 uintptr, arg1 uintptr, arg2 uintptr, arg3 uintptr)
func UnsafeCall1Return1(fn unsafe.Pointer, arg0 uintptr) uintptr
func UnsafeCall2Return1(fn unsafe.Pointer, arg0 uintptr, arg1 uintptr) uintptr
func UnsafeCall3Return1(fn unsafe.Pointer, arg0 uintptr, arg1 uintptr, arg2 uintptr) uintptr
func UnsafeCall4Return1(fn unsafe.Pointer, arg0 uintptr, arg1 uintptr, arg2 uintptr, arg3 uintptr) uintptr
```
## License
This is free and unencumbered software released into the public domain. See the [UNLICENSE](UNLICENSE) file for more details.