openfheorg/openfhe-configurator

Provides a user-friendly interface for choosing the hardware backend and release of OpenFHE (works with multiple OpenFHEOrg repositories).

OpenFHE Configurator

Use this repository to configure and build OpenFHE for supported hardware acceleration modes.

Before following the steps below, we recommend following the guidelines outlined in the Accelerating OpenFHE using Specialized Hardware Backends section of Building OpenFHE for Best Performance.

How To Use

% git clone https://github.com/openfheorg/openfhe-configurator.git
% cd openfhe-configurator
% scripts/configure.sh

OpenFHE configurator

Would you like to stage an openfhe-development build?     [y/n] : n
Would you like to stage an openfhe-hexl build?            [y/n] : y

===============================================================================

Cloning openfhe-development repository.

===============================================================================

Switching to openfhe-development branch v1.2.0.

===============================================================================

Status of openfhe-development brach v1.2.0.

===============================================================================

Staging [default] build.

===============================================================================

Build [default] is staged.
You may now run scripts/build-openfhe-development.sh to perform a default build.

===============================================================================

Cloning openfhe-hexl repository.

===============================================================================

Switching to openfhe-hexl branch v1.2.0.0.

===============================================================================

Status of openfhe-hexl branch v1.2.0.0.

===============================================================================

Staging [hexl-enabled] build.

===============================================================================

Build [hexl-enabled] is staged.
You may now run scripts/build-openfhe-development.sh to perform a hexl-enabled build.

% scripts/build-openfhe-development.sh
[ OpenFHE HEXL-enabled build commences]

By default, the OpenFHE and HEXL libraries are built and installed at openfhe-configurator/openfhe-staging/install. If you want to change the install location, pass an OPENFHE_INSTALL_DIR value to the build script e.g.,

% OPENFHE_INSTALL_DIR=~/local scripts/build-openfhe-development.sh

If you want to change OpenFHE build paramaters, pass those changes as CMAKE_FLAGS e.g.,

% CMAKE_FLAGS="-DWITH_OPENMP=OFF -DCMAKE_BUILD_TYPE=Debug" scripts/build-openfhe-development.sh

If you want to use a preinstalled build of the Intel HEXL library with your openfhe-hexl build, include the following:

% CMAKE_FLAGS="-DINTEL_HEXL_PREBUILT=ON -DINTEL_HEXL_HINT_DIR=[PATH TO INTEL HEXL]" scripts/build-openfhe-development.sh

For More Information

Please see OpenFHE Development and OpenFHE HEXL

openfhe-configurator's Issues

Build fails with newer version of util-linux

Due to a change in the output of lscpu, building will fail. This is due to the build script retreiving the number of CPUs by parsing the human-intended output of lscpu and that having a new "CPU(s) scaling MHz:" line which also matches the grep.

Build scripts are not working properly

The build seems to be broken, build scripts search for open-staging folder while the cloned repositories are under repos directory. This happens on OSX only, but even in Ubuntu there are two folders open-staging and repos.

I did some tweaks to fix this, but still the versions are not alligned, hexl is 1.2.4 while 1.2.5 is needed. This happens both on Ubuntu 22.04 and OSX.

Could you please check the above two points?