reference-helib-backend

HEBench - HElib CPU Reference Backend - Quickstart Guide

Benchmarking a Reference Backend

This guide will walk you through the steps of running the benchmark for the reference HElib backend. Note the default configuration for this backend may take an extended amount of time on some systems. If you’d like to reduce the amount of workloads run, please refer to the Test Harness User Guide and the Benchmark Configuration File Reference on modifying backend configuration files.

  1. Pick the HElib backend repository from the list of published backends, or visit direct link to HElib backend repository.

  2. Check the readme for requirements to build the backend. Make sure the machine where the build will occur meets such requirements.

  3. Clone the repo to your local machine*.

    Assume the repo will be cloned to the location contained in environment variable $HELIB_BACKEND.

    Note that repo URL may change. Obtain the correct URL from the GitHub repo itself.

cd $HELIB_BACKEND
git clone https://github.com/hebench/reference-helib-backend.git

*Users must have, at least, read access to the GitHub repository. Otherwise, cloning and/or building steps may fail.

  1. Build with default settings.

    The following commands will create a build directory, pull down all the required dependencies, build all dependencies and the backend itself, and install the backend and Test Harness.

cd $HELIB_BACKEND/reference-helib-backend
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=$HELIB_BACKEND/reference-helib-backend/install -DCMAKE_BUILD_TYPE=Release ..
make -j
make install
  1. Create a directory to hold the report of the benchmark we are about to run:
mkdir $HOME/reference-helib-backend-report
  1. Navigate to directory where the test harness was installed:
cd $HELIB_BACKEND/reference-helib-backend/install/bin

  1. Run the benchmark by executing test_harness while pointing it to the shared library containing the compiled HElib reference backend.

    If these instructions have been followed correctly, the shared library for the HElib reference backend should have been installed in $HELIB_BACKEND/reference-helib-backend/install/lib .

./test_harness --backend_lib_path $HELIB_BACKEND/reference-helib-backend/install/lib/libhebench_helib_backend.so --report_root_path $HOME/reference-helib-backend-report

  1. After the execution completes, the report will be saved to the specified location $HOME/reference-helib-backend-report.

    The report is a collection of CSV files organized in directories that represent the benchmark parameters used for each workload benchmarked. Each report has a report.csv file and, if the corresponding benchmark completed successfully, a summary.csv file in the same location. View the summary.csv for the readable information about the benchmark, or report.csv if the benchmark failed for the cause of failure.


While this quickstart guide is specific to the HElib Reference Backend, you may find a more general quickstart guide at the HEBench Getting Started Page.


Back to HEBench Home.

This site is open source. Improve this page.