Skip to content

Latest commit

 

History

History
204 lines (159 loc) · 6.46 KB

BUILD_Windows.md

File metadata and controls

204 lines (159 loc) · 6.46 KB
Raw

AOCL Crypto Library Build for Windows

Following software should be installed prior to build AOCL CRYPTOGRAPHY

  • MS Visual Studio (2019 or greater)
  • Clang 15.0 or above
  • Cmake 3.21 or greater
  • Git
  • Ninja(Alternative to Visual Studio Build System)

Environment Setup:

  1. Install visual Studio with workload: Desktop development with c++
    • Enable Clang/cl tools(required) & Address Santizer(if require)
  2. If using LLVM/Clang as external toolset:

Windows Build with LLVM/Clang:

Using Powershell:

  1. Checkout the latest code.
  2. Open the powershell.exe (as administrator)
  3. Set path to current working directory/cmake_source_directory

Build

Using VS-Studio Generator

Run from source directory

PS > cmake -A [platform: x86/x64] -B [build_directory] [Enable features] -DCMAKE_BUILD_TYPE=[RELEASE] -G "[generator: Visual Studio 17 2022]" -T [toolset:ClangCl/LLVM]

Default set values:

  • Generator:'Visual Studio Generator'
  • platform: 'x64' if external LLVM toolset use: -T LLVM (otherwise,ClangCl)
  • Available features: EXAMPLES, ADDRESS SANITIZER, TESTS, BENCH

Using Ninja build System

PS > cmake -B [build_directory] [Enable features] -DCMAKE_BUILD_TYPE=[RELEASE/DEBUG] -DCMAKE_C_COMPILER:FILEPATH=[path to C compiler] -DCMAKE_CXX_COMPILER:FILEPATH=[path_to_cxx_compiler] -G "Ninja"

Powershell

* 1. cmake -A x64 -DCMAKE_BUILD_TYPE=RELEASE -B build -T ClangCl
		`-Build binaries will be written to cmake_source_directory/build`
* 2. cmake --build .\build --config=release

Enabling features of AOCL Cryptography

  1. Enable Examples - To compile example/demo code.
  2. Enable AOCL-UTILS - To dispatch correct kernel with CPU identification.
  3. Enable DEBUG Build - To compile code in Debug Mode.
  4. Enable Address Sanitizer Support
  5. Enable Tests - To compile test code
  6. Enable Bench - To compile bench code.
  7. Enable Compat - To compare with compat libs.
  8. Disabling/Enabling Optional Features

Steps to find binaries/dll's by setting an environment variable

After build, alcp & gtests dll's are not found by feature's *.exe. Run the batch file(Set_Env_Path.bat) to set the environment path required by examples, tests & bench.

PS> scripts\Set_Env_Path.bat
-Restart the powershell & run any feature .exe from build directory or directly.

Enable Examples

PS> cmake -DALCP_ENABLE_EXAMPLES=ON -B build 
PS> cmake --build .\build --config=release

Run Examples

Run from build directory after setting an environment path.

$ .\examples\{algorithm_type}\release\*.exe

Enable AOCL-UTILS

PS> cmake -DENABLE_AOCL_UTILS=ON -DAOCL_UTILS_INSTALL_DIR=path/to/aocl/utils/source -B build
PS> cmake --build .\build --config=release

For Debug Build

PS> cmake -DCMAKE_BUILD_TYPE=DEBUG -B build
PS> cmake --build .\build --config=debug

For Compiling with Address Sanitizer Support

PS> cmake -DALCP_SANITIZE=ON -B build
PS> cmake --build .\build --config=release

Running from build directory PS>cd build

To Build Tests (using KAT vectors)

$ Append the argument '-DALCP_ENABLE_TESTS=ON'
PS> cmake -DALCP_ENABLE_TESTS=ON ./
PS> cmake --build . --config=release

This will create test executable:

 .\build\tests\{algorithm_type}\release\*.exe

To Run Tests:

$ .\tests\{algorithm_type}\release\test_{algorithm_type}

For running all tests

PS> ctest -C release

Build Benchmarks

To Build Bench
$ Append the argument -DALCP_ENABLE_BENCH=ON
PS> cmake -DALCP_ENABLE_BENCH=ON ./
PS> cmake --build . --config=release

This will create bench executable into:

  .\build\bench\{algorithm_type}\{build_type}\*.exe
To Run Bench:
$ .\bench\{algorithm_type}\release\bench_{algorithm_type}
Arguments can be provided as:
$ .\bench\{algorithm_type}\release\bench_{algorithm_type} --benchmark_filter=SHA2_<SHA SCHEME>_<Block Size>
$ .\bench\{algorithm_type}\release\bench_{algorithm_type} --benchmark_filter=SHA2_512 (runs SHA512 schemes for all block size)
$ .\bench\{algorithm_type}\release\bench_{algorithm_type} --benchmark_filter=SHA2 (runs for all SHA2 schemes and block sizes)

Disabling/Enabling Optional Features

By default all of the below features are OFF and they can be enabled optionally by setting their corresponding flags to ON

  • To enable multi update feature for all supported ciphers append -DALCP_ENABLE_CIPHER_MULTI_UPDATE=ON to build flags.
  • To Enable CCM multi update feature append flag -DALCP_ENABLE_CCM_MULTI_UPDATE=ON to build flags.
  • To Enable OFB multi update feature append flag -DALCP_ENABLE_OFB_MULTI_UPDATE=ON to build flags.

Enabling compat libs

  1. Enable OpenSSL - To compare performance .
  2. Enable IPPCP - To compare performance.

Build after enabling compat libs

Building OpenSSL Compatibility Libs

Enabling openSSL

PS> cd aocl-crypto/build
PS> cmake -DAOCL_COMPAT_LIBS=openssl ../
PS> cmake --build build --config=release

After running all the above commands you should see a openssl-compat.dll in \lib\compat\openssl\Release directory

Benchmarking

​ To bench using provider path, use the following example assuming you are executing command from the openssl bin directory.

.\openssl.exe speed -provider-path {path_to_openssl-compat} -provider openssl-compat -evp aes-128-cbc

Building IPP-CP Compatibility Libs

Enabling IPP-Crypto

PS> cd aocl-crypto/build
PS> cmake --DAOCL_COMPAT_LIBS=ipp ../
PS> cmake --build build --config=release

NOTES:

1. Use '-o' for OpenSSL & '-i' for IPPCP to run tests & bench for them. And also set bin path of compat libs in PATH variable.
2. Run *scripts\Set_Env_Path.bat* to set the path of binaries in environment variable.
3. To Enable examples, tests & bench:
>cmake -A x64 -DALCP_ENABLE_EXAMPLES=ON -DALCP_ENABLE_TESTS=ON -DALCP_ENABLE_BENCH=ON -DCMAKE_BUILD_TYPE=RELEASE -B build -T ClangCl
4. Few non-critical warnings are expected in Windows build with Clang while integrating other libs.