Skip to main content
bun:ffi 具有从 JavaScript 以低开销编译和运行 C 代码的实验性支持。

​
使用方法（bun:ffi 中的 cc）

更多信息请参阅介绍博客文章。 JavaScript 代码：
hello.ts
import { cc } from "bun:ffi";
import source from "./hello.c" with { type: "file" };

const {
  symbols: { hello },
} = cc({
  source,
  symbols: {
    hello: {
      args: [],
      returns: "int",
    },
  },
});

console.log("宇宙的答案是什么？", hello());
C 源代码：
hello.c
int hello() {
  return 42;
}
运行 hello.js 时，将打印：
terminal
bun hello.js
宇宙的答案是什么？ 42
底层，cc 使用 TinyCC 来编译 C 代码，然后与 JavaScript 运行时链接，高效地进行类型原地转换。

​
基本类型

cc 支持 dlopen 中相同的 FFIType 值。
FFITypeC 类型别名
cstringchar*
function(void*)(*)()fn，callback
ptrvoid*pointer，void*，char*
i8int8_tint8_t
i16int16_tint16_t
i32int32_tint32_t，int
i64int64_tint64_t
i64_fastint64_t
u8uint8_tuint8_t
u16uint16_tuint16_t
u32uint32_tuint32_t
u64uint64_tuint64_t
u64_fastuint64_t
f32floatfloat
f64doubledouble
boolbool
charchar
napi_envnapi_env
napi_valuenapi_value

​
字符串、对象及非基本类型

为方便操作字符串、对象以及其他无法 1:1 映射到 C 类型的非基本类型，cc 支持 N-API。 如果想在 C 函数中传递或接收 JavaScript 值且不进行任何类型转换，可以使用 napi_value。 你也可以传递一个 napi_env，用以接收调用 JavaScript 函数时使用的 N-API 环境。

​
从 C 返回字符串到 JavaScript

例如，如果 C 中有一个字符串，可以这样返回给 JavaScript：
hello.ts
import { cc } from "bun:ffi";
import source from "./hello.c" with { type: "file" };

const {
  symbols: { hello },
} = cc({
  source,
  symbols: {
    hello: {
      args: ["napi_env"],
      returns: "napi_value",
    },
  },
});

const result = hello();
对应的 C 代码：
hello.c
#include <node/node_api.h>

napi_value hello(napi_env env) {
  napi_value result;
  napi_create_string_utf8(env, "Hello, Napi!", NAPI_AUTO_LENGTH, &result);
  return result;
}
你也可以用此方式返回其他类型，比如对象和数组：
hello.c
#include <node/node_api.h>

napi_value hello(napi_env env) {
  napi_value result;
  napi_create_object(env, &result);
  return result;
}

​
cc 参考文档

​
library: string[]

library 数组用于指定应与 C 代码链接的库。 
type Library = string[];

cc({
  source: "hello.c",
  library: ["sqlite3"],
});

​
symbols

symbols 对象用于指定应向 JavaScript 公开的函数和变量。 
type Symbols = {
  [key: string]: {
    args: FFIType[];
    returns: FFIType;
  };
};

​
source

source 是要编译并与 JavaScript 运行时链接的 C 代码文件路径。 
type Source = string | URL | BunFile;

cc({
  source: "hello.c",
  symbols: {
    hello: {
      args: [],
      returns: "int",
    },
  },
});

​
flags: string | string[]

flags 是一个可选的字符串数组，传递给 TinyCC 编译器。 
type Flags = string | string[];
这些是类似 -I 指定包含目录和 -D 预处理定义的标志。

​
define: Record<string, string>

define 是一个可选对象，传递给 TinyCC 编译器。 
type Defines = Record<string, string>;

cc({
  source: "hello.c",
  define: {
    NDEBUG: "1",
  },
});
这些是传递给 TinyCC 编译器的预处理定义。