Merge pull request #463 from qubic/develop (Release v1.249.0)

Release v1.249.0

Author: Franziska-Mueller

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.14)
+cmake_minimum_required(VERSION 3.15)
 project(qubic CXX)
 
 # Set C++ standard
@@ -11,6 +11,7 @@ include(CompilerSetup)
 
 # Build options
 option(BUILD_TESTS "Build the test suite" ON)
+option(BUILD_BENCHMARK "Build the EFI benchmark application" OFF)
 option(BUILD_EFI "Build the EFI application" ON)
 option(USE_SANITIZER "Build test with sanitizer support (clang only)" ON)
 
@@ -24,27 +25,33 @@ endif()
 # Always include platform_common as it's needed for both application and tests
 add_subdirectory(lib/platform_common)
 
-if(BUILD_EFI OR BUILD_TESTS)
+if(BUILD_EFI OR BUILD_BENCHMARK)
     add_subdirectory(lib/platform_efi)
 endif()
 
 # Build the tests first. On fail, the build will fail completely
 if(BUILD_TESTS)
-    message(STATUS "Building test suite")
+    message(STATUS "--- Test suite ---")
     enable_testing()
     add_subdirectory(lib/platform_os)
-    
+
     # If we're not building the application, we still need src for tests
     # but don't make it a default target
     if(NOT BUILD_EFI)
         add_subdirectory(src EXCLUDE_FROM_ALL)
     endif()
-    
+
     add_subdirectory(test)
 endif()
 
 # Build the application if requested
 if(BUILD_EFI)
-    message(STATUS "Building EFI application")
+    message(STATUS "--- EFI Core application ---")
     add_subdirectory(src)
 endif()
+
+# Add the UEFI m256i benchmark
+if(BUILD_BENCHMARK)
+    message(STATUS "-- EFI Benchmark ---")
+    add_subdirectory(benchmark_uefi)
+endif()

Qubic.sln

@@ -16,6 +16,8 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "platform_efi", "lib\platfor
 EndProject
 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "platform_os", "lib\platform_os\platform_os.vcxproj", "{88B4CDA8-8248-44D0-848E-0E938A2AAD6D}"
 EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "benchmark", "benchmark_uefi\benchmark.vcxproj", "{AD7B4795-A54D-631F-A159-B0324B09BE5E}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|x64 = Debug|x64
@@ -53,6 +55,12 @@ Global
 		{88B4CDA8-8248-44D0-848E-0E938A2AAD6D}.Release|x64.Build.0 = Release|x64
 		{88B4CDA8-8248-44D0-848E-0E938A2AAD6D}.ReleaseAVX512|x64.ActiveCfg = Release|x64
 		{88B4CDA8-8248-44D0-848E-0E938A2AAD6D}.ReleaseAVX512|x64.Build.0 = Release|x64
+		{AD7B4795-A54D-631F-A159-B0324B09BE5E}.Debug|x64.ActiveCfg = Debug|x64
+		{AD7B4795-A54D-631F-A159-B0324B09BE5E}.Debug|x64.Build.0 = Debug|x64
+		{AD7B4795-A54D-631F-A159-B0324B09BE5E}.Release|x64.ActiveCfg = Release|x64
+		{AD7B4795-A54D-631F-A159-B0324B09BE5E}.Release|x64.Build.0 = Release|x64
+		{AD7B4795-A54D-631F-A159-B0324B09BE5E}.ReleaseAVX512|x64.ActiveCfg = ReleaseAVX512|x64
+		{AD7B4795-A54D-631F-A159-B0324B09BE5E}.ReleaseAVX512|x64.Build.0 = ReleaseAVX512|x64
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

README_CLANG.md

@@ -51,6 +51,10 @@ For a example compilation execute the following commands:
     * **Values:** `ON`, `OFF`
     * **Meaning:** `ON` builds the EFI file, `OFF` skips building EFI file. Currently this build is not working.
 
+* **`-D BUILD_BENCHMARK=<ON|OFF>`**
+    * **Values:** `ON`, `OFF`
+    * **Meaning:** `ON` builds a EFI file that allows to run a benchmark directly in the uefi. `OFF` skips building this EFI Benchmark.
+
 * **`-D CMAKE_BUILD_TYPE=<Type>`**
     * **Values:** `Debug`, `Release`, `RelWithDebInfo`, `MinSizeRel`
     * **Meaning:** Sets the build mode for optimization and debug info (e.g., `Debug` for debugging, `Release` for performance).
@@ -59,6 +63,10 @@ For a example compilation execute the following commands:
     * **Values:** `ON`, `OFF`
     * **Meaning:** `ON` enables code using AVX-512 CPU instructions (requires support), `OFF` disables it.
 
+* **`-D USE_SANITIZER=<ON|OFF>`**
+    * **Values:** `ON`, `OFF`
+    * **Meaning:** `ON` enables linking to santizers when building with clang, `OFF` disables sanitizers.
+
 4.  **Build the Project:**
     Use the CMake `--build` command to invoke the underlying build tool (like `make` or `ninja`).
 
@@ -85,9 +93,9 @@ Current state of the working tests:
 | Contract qVault    | `contract_qvault.cpp`   | Pending     |
 | Contract qX        | `contract_qx.cpp`       | Pending     |
 | KangarooTwelve     | `kangaroo_twelve.cpp`   | Pending     |
-| M256               | `m256.cpp`              | Pending     |
+| M256               | `m256.cpp`              | **Working** |
 | Math Lib           | `math_lib.cpp`          | **Working** |
-| Network Messages   | `network_messages.cpp`  | Pending     |
+| Network Messages   | `network_messages.cpp`  | **Working** |
 | Platform           | `platform.cpp`          | Pending     |
 | QPI Collection     | `qpi_collection.cpp`    | Pending     |
 | QPI                | `qpi.cpp`               | Pending     |
@@ -98,4 +106,4 @@ Current state of the working tests:
 | Stdlib Impl        | `stdlib_impl.cpp`       | Pending     |
 | Tick Storage       | `tick_storage.cpp`      | Pending     |
 | TX Status Request  | `tx_status_request.cpp` | Pending     |
-| Vote Counter       | `vote_counter.cpp`      | Pending     |
+| Vote Counter       | `vote_counter.cpp`      | Pending     |

benchmark_uefi/CMakeLists.txt

@@ -0,0 +1,59 @@
+cmake_minimum_required(VERSION 3.10)
+
+project(M256UefiBenchmark CXX)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+add_executable(m256_uefi_benchmark benchmark_main.cpp)
+
+apply_efi_compiler_flags(m256_uefi_benchmark)
+
+
+include_directories(${CMAKE_CURRENT_SOURCE_DIR})
+include_directories(${CMAKE_SOURCE_DIR}/lib)
+include_directories(${CMAKE_SOURCE_DIR}/src)
+
+# Add additional compiler-specific flags for the main application
+if(IS_CLANG)
+    # Clang-specific flags
+    target_compile_options(m256_uefi_benchmark PRIVATE
+        -mrdrnd
+        -target x86_64-unknown-windows
+        $<$<BOOL:${CLANG_SYSROOT}>:--sysroot="${CLANG_SYSROOT}">
+        -Werror
+        -Wno-unused-parameter
+    )
+elseif(IS_MSVC)
+    # MSVC-specific flags
+    target_compile_options(m256_uefi_benchmark PRIVATE)
+endif()
+
+# Link with platform libraries
+  # When building the application, link with platform_common and platform_efi
+target_link_libraries(m256_uefi_benchmark
+    platform_common
+    platform_efi
+)
+
+# Configure linker settings based on compiler
+if(IS_MSVC)
+    # MSVC-specific linker settings
+    set_target_properties(m256_uefi_benchmark PROPERTIES SUFFIX ".efi")
+    
+elseif(IS_CLANG)
+    # Clang-specific linker settings
+    set(CMAKE_LINKER "lld")
+    set(CMAKE_CXX_LINK_EXECUTABLE
+        "${CMAKE_LINKER} -flavor link \
+        -subsystem:efi_application \
+        -entry:efi_main \
+        <OBJECTS> \
+        -out:<TARGET>"
+    )
+    
+    # Set output suffix to .efi
+    set_target_properties(m256_uefi_benchmark PROPERTIES
+        SUFFIX ".efi"
+    )
+endif()