Dev -> main

.clabot

@@ -15,7 +15,7 @@
     "xvzcf": "Cryspen",
     "msprotz": "Microsoft",
     "R1kM": "Inria",
-    "samuel-lee-msft": "Microsoft
+    "samuel-lee-msft": "Microsoft"
   },
   "contributors": [
     "franziskuskiefer",

.gitignore

@@ -27,3 +27,5 @@ rust/.c
 .idea
 cmake-build-debug
 
+# ctags
+tags

CMakeLists.txt

@@ -49,14 +49,19 @@ endif()
 
 set(hacl_VERSION_TWEAK "")
 
-# Load global config from exteral file.
-# This file must be generated before running cmake with ./mach.py --configure
+# Load global config from external file.
+# For a Clang build, this file can be generated before running cmake with
+# ./mach.py --configure
 # If the build is invoked through ./mach.py, a separate configuration is not
 # needed.
-# If the file is not present, i.e. cmake was invoked directly, we copy the default
-# config from config/default_config.cmake
+# We copy a default config from config/default_config.cmake or
+# config/default_config_msvc.cmake
 if(NOT EXISTS ${PROJECT_SOURCE_DIR}/build/config.cmake)
-    configure_file(${PROJECT_SOURCE_DIR}/config/default_config.cmake ${PROJECT_SOURCE_DIR}/build/config.cmake COPYONLY)
+    if(USE_MSVC)
+        configure_file(${PROJECT_SOURCE_DIR}/config/default_config_msvc.cmake ${PROJECT_SOURCE_DIR}/build/config.cmake COPYONLY)
+    else()
+        configure_file(${PROJECT_SOURCE_DIR}/config/default_config.cmake ${PROJECT_SOURCE_DIR}/build/config.cmake COPYONLY)
+    endif()
 endif()
 
 # Now include the config.
@@ -85,8 +90,11 @@ set(CMAKE_C_STANDARD_REQUIRED True)
 include(build/config.cmake)
 
 # Configure different targets
-# TODO: Set flags for MSVC
-if(NOT MSVC)
+if(MSVC)
+    add_compile_options(
+        $<$<COMPILE_LANGUAGE:C,CXX>:/Ob3>
+    )
+else()
     add_compile_options(
         # -Wall
         # -Wextra
@@ -99,12 +107,20 @@ if(NOT MSVC)
     )
 endif()
 
-if(WIN32 AND NOT MSVC)
-    # Enable everywhere for windows as long as libintvector.h is not included correctly.
-    add_compile_options(
-        -mavx
-        -mavx2
-    )
+if(WIN32)
+    # Enable AVX and AVX2 everywhere for Windows as long as libintvector.h is not included correctly.
+    if(MSVC)
+        add_compile_options(
+            $<$<COMPILE_LANGUAGE:C,CXX>:/arch:AVX>
+            $<$<COMPILE_LANGUAGE:C,CXX>:/arch:AVX2>
+        )
+    else()
+        # On Windows with clang-cl (our default) we take the Linux assembly
+        add_compile_options(
+            -mavx
+            -mavx2
+        )
+    endif()
 endif()
 
 # Set include paths
@@ -168,6 +184,11 @@ if(ENABLE_UBSAN)
     add_link_options(-fsanitize=undefined)
 endif()
 
+if(ENABLE_MSAN)
+    add_compile_options(-fsanitize=memory -fsanitize-memory-track-origins)
+    add_link_options(-fsanitize=memory)
+endif()
+
 # Sources are written by mach.py into the following lists
 # - SOURCES_std: All regular files
 # - SOURCES_vec128: Files that require vec128 hardware
@@ -335,7 +356,7 @@ configure_file(config/Config.h.in config.h)
 # # Dynamic library
 add_library(hacl SHARED ${SOURCES_std} ${VALE_OBJECTS})
 if(NOT MSVC)
-    target_compile_options(hacl PRIVATE -Wsign-conversion -Wconversion -Wall -Wextra -pedantic)
+    target_compile_options(hacl PRIVATE -Wall -Wextra -pedantic)
 endif()
 
 if(TOOLCHAIN_CAN_COMPILE_VEC128 AND HACL_VEC128_O)
@@ -359,6 +380,13 @@ if(TOOLCHAIN_CAN_COMPILE_VEC256 AND HACL_VEC256_O)
     target_sources(hacl_static PRIVATE $<TARGET_OBJECTS:hacl_vec256>)
 endif()
 
+if(BUILD_LIBCRUX)
+    add_library(libcrux_static STATIC ${LIBCRUX_SOURCES})
+    if(NOT MSVC)
+        target_compile_options(libcrux_static PRIVATE -Wall -Wextra -pedantic -Wshadow -Wunused-function)
+    endif()
+endif()
+
 # Install
 # # This allows package maintainers to control the install destination by setting
 # # the appropriate cache variables.
@@ -465,10 +493,11 @@ if(ENABLE_TESTS)
             target_compile_options(${TEST_NAME} PRIVATE /std:c++20)
         endif(MSVC)
 
-        add_dependencies(${TEST_NAME} hacl hacl_cpu_features)
+        add_dependencies(${TEST_NAME} hacl libcrux_static hacl_cpu_features)
         target_link_libraries(${TEST_NAME} PRIVATE
             gtest_main
             hacl_static
+            libcrux_static
             hacl_cpu_features
             nlohmann_json::nlohmann_json
         )
@@ -482,6 +511,43 @@ if(ENABLE_TESTS)
                 ${PROJECT_SOURCE_DIR}/tests/${TEST_NAME} $<TARGET_FILE_DIR:${TEST_NAME}>)
         endif()
     endforeach()
+
+    if(BUILD_LIBCRUX)
+        foreach(TEST_FILE IN LISTS LIBCRUX_TEST_SOURCES)
+            get_filename_component(TEST_NAME ${TEST_FILE} NAME_WE)
+            add_executable(${TEST_NAME}
+                ${TEST_FILE}
+            )
+
+            # Coverage
+            if(ENABLE_COVERAGE)
+                target_compile_options(${TEST_NAME} PRIVATE -fprofile-instr-generate -fcoverage-mapping)
+                target_link_options(${TEST_NAME} PRIVATE -fprofile-instr-generate -fcoverage-mapping)
+            endif()
+
+            if(MSVC)
+                # MSVC needs a modern C++ for designated initializers.
+                target_compile_options(${TEST_NAME} PRIVATE /std:c++20)
+            endif(MSVC)
+
+            add_dependencies(${TEST_NAME} hacl libcrux_static hacl_cpu_features)
+            target_link_libraries(${TEST_NAME} PRIVATE
+                gtest_main
+                hacl_cpu_features
+                nlohmann_json::nlohmann_json
+                libcrux_static
+                hacl_static
+            )
+
+            if(EXISTS ${PROJECT_SOURCE_DIR}/tests/${TEST_NAME})
+                # Copy test input files. They must be in a directory with the same
+                # name as the test and get copied to the build directory.
+                add_custom_command(TARGET ${TEST_NAME} POST_BUILD
+                    COMMAND ${CMAKE_COMMAND} -E copy_directory
+                    ${PROJECT_SOURCE_DIR}/tests/${TEST_NAME} $<TARGET_FILE_DIR:${TEST_NAME}>)
+            endif()
+        endforeach()
+    endif()
 endif()
 
 # Benchmarks
@@ -504,7 +570,8 @@ if(ENABLE_BENCHMARKS)
     FetchContent_Populate(benchmark
         GIT_REPOSITORY  https://github.com/google/benchmark.git
         # The latest release 1.7.1 is broken due to https://github.com/google/benchmark/pull/1517
-        GIT_TAG         b177433f3ee2513b1075140c723d73ab8901790f
+        # But also: need the fix for https://github.com/google/benchmark/pull/1669
+        GIT_TAG         bc946b919cac6f25a199a526da571638cfde109f
     )
     add_subdirectory(${benchmark_SOURCE_DIR} ${benchmark_BINARY_DIR})
 
@@ -542,14 +609,43 @@ if(ENABLE_BENCHMARKS)
             target_compile_options(${BENCH_NAME} PRIVATE /std:c++20)
         endif(NOT MSVC)
 
-        add_dependencies(${BENCH_NAME} hacl hacl_cpu_features)
+        add_dependencies(${BENCH_NAME} hacl libcrux_static hacl_cpu_features)
         target_link_libraries(${BENCH_NAME} PRIVATE
             hacl_static
+            libcrux_static
             ecckiila
             blake2
             digestif
             hacl_cpu_features
             benchmark::benchmark
         )
     endforeach()
+
+    if(BUILD_LIBCRUX)
+        foreach(BENCH_FILE IN LISTS LIBCRUX_BENCHMARK_SOURCES)
+            get_filename_component(BENCH_NAME ${BENCH_FILE} NAME_WE)
+            set(BENCH_NAME ${BENCH_NAME}_benchmark)
+            add_executable(${BENCH_NAME}
+                ${BENCH_FILE}
+            )
+
+            # Use modern C++
+            if(NOT MSVC)
+                target_compile_options(${BENCH_NAME} PRIVATE -std=c++17)
+            else()
+                # MSVC needs a modern C++ for designated initializers.
+                target_compile_options(${BENCH_NAME} PRIVATE /std:c++20)
+            endif(NOT MSVC)
+
+            target_compile_definitions(${BENCH_NAME} PUBLIC NO_OPENSSL)
+
+            add_dependencies(${BENCH_NAME} hacl libcrux_static hacl_cpu_features)
+            target_link_libraries(${BENCH_NAME} PRIVATE
+                hacl_cpu_features
+                benchmark::benchmark
+                libcrux_static
+                hacl_static
+            )
+        endforeach()
+    endif()
 endif(ENABLE_BENCHMARKS)

CMakePresets.json

@@ -0,0 +1,110 @@
+{
+  "version": 6,
+  "cmakeMinimumRequired": {
+    "major": 3,
+    "minor": 19,
+    "patch": 0
+  },
+  "configurePresets": [
+    {
+      "name": "default",
+      "displayName": "Default Config",
+      "hidden": true,
+      "binaryDir": "${sourceDir}/build/${presetName}",
+      "generator": "Ninja Multi-Config",
+      "cacheVariables": {
+        "CMAKE_INSTALL_PREFIX": "${sourceDir}/install/${presetName}",
+        "BUILD_LIBCRUX": "ON",
+        "ENABLE_TESTS": "ON",
+        "ENABLE_BENCHMARKS": "ON"
+      },
+      "architecture": {
+        "value": "x64",
+        "strategy": "external"
+      },
+      "condition": {
+        "type": "equals",
+        "lhs": "${hostSystemName}",
+        "rhs": "Windows"
+      },
+      "vendor": {
+        "microsoft.com/VisualStudioSettings/CMake/1.0": {
+          "hostOS": [ "Windows" ]
+        }
+      }
+    },
+    {
+      "name": "ninja.msvc",
+      "inherits": "default",
+      "displayName": "x64 Ninja Multi-Config MSVC",
+      "description": "x64 MSVC build using Ninja Multi-Config generator",
+      "cacheVariables": {
+        "USE_MSVC": "ON"
+      }
+    },
+    {
+      "name": "ninja.clang",
+      "inherits": "default",
+      "displayName": "x64 Ninja Multi-Config Clang",
+      "description": "x64 Clang build using Ninja Multi-Config generator"
+    }
+  ],
+  "buildPresets": [
+    {
+      "name": "ninja.msvc.Release",
+      "description": "x64 MSVC build using Ninja Multi-Config generator - Release",
+      "displayName": "Release",
+      "configurePreset": "ninja.msvc",
+      "configuration": "Release"
+    },
+    {
+      "name": "ninja.msvc.Debug",
+      "description": "x64 MSVC build using Ninja Multi-Config generator - Debug",
+      "displayName": "Debug",
+      "configurePreset": "ninja.msvc",
+      "configuration": "Debug"
+    },
+    {
+      "name": "ninja.msvc.MinSizeRel",
+      "description": "x64 MSVC build using Ninja Multi-Config generator - MinSizeRel",
+      "displayName": "MinSizeRel",
+      "configurePreset": "ninja.msvc",
+      "configuration": "MinSizeRel"
+    },
+    {
+      "name": "ninja.msvc.RelWithDebInfo",
+      "description": "x64 MSVC build using Ninja Multi-Config generator - RelWithDebInfo",
+      "displayName": "RelWithDebInfo",
+      "configurePreset": "ninja.msvc",
+      "configuration": "RelWithDebInfo"
+    },
+    {
+      "name": "ninja.clang.Release",
+      "description": "x64 Clang build using Ninja Multi-Config generator - Release",
+      "displayName": "Release",
+      "configurePreset": "ninja.clang",
+      "configuration": "Release"
+    },
+    {
+      "name": "ninja.clang.Debug",
+      "description": "x64 Clang build using Ninja Multi-Config generator - Debug",
+      "displayName": "Debug",
+      "configurePreset": "ninja.clang",
+      "configuration": "Debug"
+    },
+    {
+      "name": "ninja.clang.MinSizeRel",
+      "description": "x64 Clang build using Ninja Multi-Config generator - MinSizeRel",
+      "displayName": "MinSizeRel",
+      "configurePreset": "ninja.clang",
+      "configuration": "MinSizeRel"
+    },
+    {
+      "name": "ninja.clang.RelWithDebInfo",
+      "description": "x64 Clang build using Ninja Multi-Config generator - RelWithDebInfo",
+      "displayName": "RelWithDebInfo",
+      "configurePreset": "ninja.clang",
+      "configuration": "RelWithDebInfo"
+    }
+  ]
+}