Foreign Function Interface (FFI)

Deno's Foreign Function Interface (FFI) allows JavaScript and TypeScript code to call functions in dynamic libraries written in languages like C, C++, or Rust. This enables you to integrate native code performance and capabilities directly into your Deno applications.

Deno FFI Reference Docs

Introduction to FFI Jump to heading#

FFI provides a bridge between Deno's JavaScript runtime and native code. This allows you to:

• Use existing native libraries within your Deno applications
• Implement performance-critical code in languages like Rust or C
• Access operating system APIs and hardware features not directly available in JavaScript

Deno's FFI implementation is based on the Deno.dlopen API, which loads dynamic libraries and creates JavaScript bindings to the functions they export.

Security considerations Jump to heading#

FFI requires explicit permission using the --allow-ffi flag, as native code runs outside of Deno's security sandbox:

deno run --allow-ffi my_ffi_script.ts

Basic usage Jump to heading#

The basic pattern for using FFI in Deno involves:

1. Defining the interface for the native functions you want to call
2. Loading the dynamic library using Deno.dlopen()
3. Calling the loaded functions

Here's a simple example loading a C library:

const dylib = Deno.dlopen("libexample.so", {
  add: { parameters: ["i32", "i32"], result: "i32" },
});

console.log(dylib.symbols.add(5, 3)); // 8

dylib.close();

Supported types Jump to heading#

Deno's FFI supports a variety of data types for parameters and return values:

As of Deno 1.25, the pointer type has been split into a pointer and a buffer type to ensure users take advantage of optimizations for Typed Arrays, and as of Deno 1.31 the JavaScript representation of pointer has become an opaque pointer object or null for null pointers.

• [1] void type can only be used as a result type.
• [2] buffer type accepts TypedArrays as parameter, but it always returns a pointer object or null when used as result type like the pointer type.
• [3] function type works exactly the same as the pointer type as a parameter and result type.
• [4] struct type is for passing and returning C structs by value (copy). The struct array must enumerate each of the struct's fields' type in order. The structs are padded automatically: Packed structs can be defined by using an appropriate amount of u8 fields to avoid padding. Only TypedArrays are supported as structs, and structs are always returned as Uint8Arrays.

Working with structs Jump to heading#

You can define and use C structures in your FFI code:

// Define a struct type for a Point
const pointStruct = {
  fields: {
    x: "f64",
    y: "f64",
  },
} as const;

// Define the library interface
const signatures = {
  distance: {
    parameters: [
      { struct: pointStruct },
      { struct: pointStruct },
    ],
    result: "f64",
  },
} as const;

// Create struct instances
const point1 = new Deno.UnsafePointer(
  new BigUint64Array([
    BigInt(Float64Array.of(1.0).buffer),
    BigInt(Float64Array.of(2.0).buffer),
  ]).buffer,
);

const point2 = new Deno.UnsafePointer(
  new BigUint64Array([
    BigInt(Float64Array.of(4.0).buffer),
    BigInt(Float64Array.of(6.0).buffer),
  ]).buffer,
);

// Call the function with structs
const dist = dylib.symbols.distance(point1, point2);

Working with callbacks Jump to heading#

You can pass JavaScript functions as callbacks to native code:

const signatures = {
  setCallback: {
    parameters: ["function"],
    result: "void",
  },
  runCallback: {
    parameters: [],
    result: "void",
  },
} as const;

// Create a callback function
const callback = new Deno.UnsafeCallback(
  { parameters: ["i32"], result: "void" } as const,
  (value) => {
    console.log("Callback received:", value);
  },
);

// Pass the callback to the native library
dylib.symbols.setCallback(callback.pointer);

// Later, this will trigger our JavaScript function
dylib.symbols.runCallback();

// Always clean up when done
callback.close();

Best practices with FFI Jump to heading#

1. Always close resources. Close libraries with dylib.close() and callbacks with callback.close() when done.

2. Prefer TypeScript. Use TypeScript for better type-checking when working with FFI.

3. Wrap FFI calls in try/catch blocks to handle errors gracefully.

4. Be extremely careful when using FFI, as native code can bypass Deno's security sandbox.

5. Keep the FFI interface as small as possible to reduce the attack surface.

Examples Jump to heading#

Using a Rust library Jump to heading#

Here's an example of creating and using a Rust library with Deno:

First, create a Rust library:

// lib.rs
#[no_mangle]
pub extern "C" fn fibonacci(n: u32) -> u32 {
  if n <= 1 {
    return n;
  }
  fibonacci(n - 1) + fibonacci(n - 2)
}

Compile it as a dynamic library:

rustc --crate-type cdylib lib.rs

Then use it from Deno:

const libName = {
  windows: "./lib.dll",
  linux: "./liblib.so",
  darwin: "./liblib.dylib",
}[Deno.build.os];

const dylib = Deno.dlopen(
  libName,
  {
    fibonacci: { parameters: ["u32"], result: "u32" },
  } as const,
);

// Calculate the 10th Fibonacci number
const result = dylib.symbols.fibonacci(10);
console.log(`Fibonacci(10) = ${result}`); // 55

dylib.close();

Examples Jump to heading#

• Netsaur
• WebView_deno
• Deno_sdl2
• Deno FFI examples repository

These community-maintained repos includes working examples of FFI integrations with various native libraries across different operating systems.

Related Approaches to Native Code Integration Jump to heading#

While Deno's FFI provides a direct way to call native functions, there are other approaches to integrate native code:

Using Node-API (N-API) with Deno Jump to heading#

Deno supports Node-API (N-API) for compatibility with native Node.js addons. This enables you to use existing native modules written for Node.js.

Directly loading a Node-API addon:

import process from "node:process";
process.dlopen(module, "./native_module.node", 0);

Using an npm package that uses a Node-API addon:

import someNativeAddon from "npm:some-native-addon";
console.log(someNativeAddon.doSomething());

How is this different from FFI?

Node-API support is ideal for leveraging existing Node.js native modules, whereas FFI is best for direct, lightweight calls to native libraries.

Alternatives to FFI Jump to heading#

Before using FFI, consider these alternatives:

• WebAssembly, for portable native code that runs within Deno's sandbox.
• Use Deno.command to execute external binaries and subprocesses with controlled permissions.
• Check whether Deno's native APIs already provide the functionality you need.

Deno's FFI capabilities provide powerful integration with native code, enabling performance optimizations and access to system-level functionality. However, this power comes with significant security considerations. Always be cautious when working with FFI and ensure you trust the native libraries you're using.