Installation

This document provides instructions to set up TFHE-rs in your project.

Importing

First, add TFHE-rs as a dependency in your Cargo.toml.

tfhe = { version = "~1.8.1", features = ["boolean", "shortint", "integer"] }

Rust version: a minimum Rust version of 1.84 is required to compile TFHE-rs.

Performance: for optimal performance, it is highly recommended to run code that uses TFHE-rs in release mode with cargo's --release flag.

Performance: on Linux, enabling transparent huge pages also gives a noticeable speedup. See System tuning.

Supported platforms

TFHE-rs currently supports the following platforms:

OS	x86_64	aarch64
Linux	Supported	Supported*
macOS	Supported	Supported*
Windows	Supported with RDSEED instruction	Unsupported

By default, TFHE-rs makes the assumption that hardware AES features are enabled on the target CPU. The required CPU features are:

• x86_64: sse2, aesni

• aarch64: aes, neon

To add support for older CPUs, import TFHE-rs with the software-prng feature in your Cargo.toml:

tfhe = { version = "~1.8.1", features = ["boolean", "shortint", "integer", "software-prng"] }

Hardware acceleration

TFHE-rs now features hardware-accelerated backends.

You can refer to the:

• GPU backend instructions to benefit from GPU accelerated primitives.

• HPU backend instructions to benefit from custom FPGA accelerated primitives.