Skip to content

BUILDING.md

Latest commit

 

History

History
90 lines (60 loc) · 2.5 KB

BUILDING.md

File metadata and controls

90 lines (60 loc) · 2.5 KB

Building mlkem-native

Prerequisites

To build mlkem-native, you need make and a C90 compiler. To use the test scripts, you need Python3 (>= 3.7).

By hand

See mlkem.

Using make

You can build and test mlkem-native as follows:

make test       # With native code backend (if available)
make OPT=0 test # With C backend

To merely build test components, use the following make targets:

make func
make kat
make acvp

To run them, add run_:

make run_func
make run_kat
make run_acvp

The resulting binaries can be found in test/build (their full path is printed by make).

For benchmarking, specify the cycle counting method. Currently, mlkem-native is supporting NO, PERF, PMU, and MAC:

  • NO means that no cycle counting will be used; this can be used to confirm that benchmarks compile fine.
  • PERF uses the perf kernel module for cycle counting. Does not work on Apple platforms.
  • PMU uses direct PMU access if available. On AArch64, this may require you to load a kernel module first, see here. Does not work on Apple platforms.
  • MAC is perf-based and works on some Apple platforms, at least Apple M1.
# CYCLES has to be one of PERF, PMU, MAC, NO
sudo make run_bench CYCLES=PERF
sudo make run_bench_components CYCLES=PERF

Using tests script

For convenience, you can also use the ./scripts/tests script as a wrapper around make. For example,

./scripts/tests func

will compile and run functionality tests. Similarly,

./scripts/tests bench -c PERF -r

will compile and run benchmarks, using PERF for cycle counting (-c PERF) and running as root (-r).

For detailed information on how to use the script, please refer to ./scripts/tests --help.

Windows

You can also build mlkem-native on Windows using nmake and an MSVC compiler.

To build and run the tests (only support functional testing for non-opt implementation for now), use the following nmake targets:

nmke /f .\Makefile.Microsoft_nmake quickcheck

Checking the proofs

Prerequisites

To run the CBMC proofs, you need the CBMC version as specified in our nix development environment. Please setup nix as described in CONTRIBUTING.md.

Running CBMC

To check the CBMC proofs, enter the nix development environment and use tests cbmc.