3.5 KiB
Overview
Koffi is a fast and easy-to-use C FFI module for Node.js, featuring:
- Low-overhead and fast performance (see benchmarks)
- Support for primitive and aggregate data types (structs and fixed-size arrays), both by reference (pointer) and by value
- Javascript functions can be used as C callbacks
- Well-tested code base for popular OS/architecture combinations
If you like this project, consider supporting me:
Koffi requires Node.js version 16 or later. Use NVM to install more recent Node versions on older Linux distributions.
The following combinations of OS and architectures are officially supported and tested at the moment:
| ISA / OS | Windows | Linux (glibc) | Linux (musl) | macOS | FreeBSD | OpenBSD |
|---|---|---|---|---|---|---|
| x86 (IA32) 1 | ✅ | ✅ | 🟨 | ⬜️ | ✅ | ✅ |
| x86_64 (AMD64) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| ARM32 LE 2 | ⬜️ | ✅ | 🟨 | ⬜️ | 🟨 | 🟨 |
| ARM64 (AArch64) LE | ✅ | ✅ | ✅ | ✅ | ✅ | 🟨 |
| RISC-V 64 3 | ⬜️ | ✅ | 🟨 | ⬜️ | 🟨 | 🟨 |
| LoongArch64 | ⬜️ | ✅ | 🟨 | ⬜️ | 🟨 | 🟨 |
For all fully supported platforms (green check marks), a prebuilt binary is included in the NPM package which means you can install Koffi without a C++ compiler.
Source code
The source code is available here: https://github.com/Koromix/rygel/ (in the src/koffi subdirectory).
Note
Most of my projects live in a single repository (or monorepo), which have two killer features for me:
- Cross-project refactoring
- Simplified dependency management
You can find a more detailed rationale here: https://danluu.com/monorepo/
New releases are frequent, look at the changelog for more information.
License
This program is free software: you can redistribute it and/or modify it under the terms of the MIT License.
Find more information here: https://choosealicense.com/licenses/mit/
<style> table td:not(:first-child) { text-align: center; } </style>-
The following call conventions are supported for forward calls: cdecl, stdcall, MS fastcall, thiscall. Only cdecl and stdcall can be used for C to JS callbacks. ↩︎
-
The prebuilt binary uses the hard float ABI and expects a VFP coprocessor. Build from source to use Koffi with a different ABI (softfp, soft). ↩︎
-
The prebuilt binary uses the LP64D (double-precision float) ABI. The LP64 ABI is supported in theory if you build Koffi from source (untested), the LP64F ABI is not supported. ↩︎