WW48'24 source code update

Author: ipl_ci

BUILD.md

@@ -223,6 +223,9 @@ To build the Intel® Cryptography Primitives Library on macOS\*, complete the fo
 
     - Example for Linux\* OS and the Intel® 64 architecture:
         `-DPLATFORM_LIST="m7;n8;y8;e9;l9;k0;k1"`
+- `-DMBX_PLATFORM_LIST="<platform list>"` - optional, works only if `-DMERGED_BLD:BOOL=off` is set. Sets target platforms for the code to be compiled for [Crypto Multi Buffer library](./sources/ippcp/crypto_mb/Readme.md). Please, refer to [Crypto Multi Buffer library target platforms list](./sources/ippcp/crypto_mb/Readme.md/#target-optimization-codes-in-function-names) to check the supported platforms.
+    - Example:
+        `-DMBX_PLATFORM_LIST="k1;l9"`
 - `-DNO_CRYPTO_MB:BOOL=TRUE` - optional, turns off the build of [Crypto Multi Buffer library](./sources/ippcp/crypto_mb/Readme.md) and, as a consequence, removes all dependencies on OpenSSL library.
 - `-DTONGSUO:BOOL=on`, `-DBORINGSSL:BOOL=on` - required only if forks of OpenSSL library are used to resolve OpenSSL dependencies - Tongsuo and BoringSSL respectively. These flags make sense when [Crypto Multi Buffer library](./sources/ippcp/crypto_mb/Readme.md) is built.
 > **NOTE:** -DBABASSL:BOOL=on flag is deprecated and targeted to be removed in the future releases. Please use -DTONGSUO:BOOL=on instead.\*.

CHANGELOG.md

@@ -3,7 +3,12 @@
 This is a list of notable changes to Intel® Cryptography Primitives Library, in reverse chronological order.
 
 ## Intel(R) Cryptography Primitives Library 1.1.0
+
 - Added single buffer SHA384, SHA512, SHA512/224, SHA512/256 hash algorithm optimizations with the new SHA512 instructions for Lunar Lake and Arrow Lake S CPUs.
+- Enabled support of [specific ISA library](./OVERVIEW.md#specific-isa-library) build for Crypto Multi buffer library.
+Cmake build options `-DMERGED_BLD:BOOL=off -DMBX_PLATFORM_LIST="k1;l9"` may be used. Please refer to
+[BUILD.md](./BUILD.md) for the details.
+- Fixed AVX512 IFMA implementation (k1 branch) of SM2 signature and verification single-buffer algorithm. The optimized path is re-enabled.
 
 ## Intel(R) Cryptography Primitives Library 1.0.0
 - Intel® Integrated Performance Primitives Cryptography (Intel® IPP Cryptography) was renamed to Intel(R) Cryptography Primitives Library.

CMakeLists.txt

@@ -91,6 +91,10 @@ endif()
 if("${MERGED_BLD}" STREQUAL "")
   set(MERGED_BLD ON)
 endif()
+# Crypto_mb merged build flag is set same as IPPCP by default
+if(MERGED_BLD)
+  set(MBX_MERGED_BLD ON)
+endif()
 
 # Set default installation directories
 if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
@@ -244,7 +248,6 @@ if (NOT (CRYPTO_USE_CLANG_TIDY))
   endif()
 endif()
 
-
 if(BUILD_EXAMPLES)
   # This helps to organize examples projects structure in IDE by folders
   set_property(GLOBAL PROPERTY USE_FOLDERS ON)

sources/ippcp/CMakeLists.txt

@@ -22,7 +22,7 @@ include (GenerateExportHeader)
 
 set(TARGET_NAME ${LIB_NAME})
 
-#Set platform list
+# Set platform list (order is important for dispatcher generation!!!)
 if (NOT MERGED_BLD)
   if(${ARCH} MATCHES "ia32")
     set(BASE_PLATFORM_LIST px)
@@ -672,3 +672,8 @@ if ((NOT NO_CRYPTO_MB) AND ("${ARCH}" STREQUAL "intel64"))
       message(SEND_ERROR  "IPPCP_INTERFACE_VERSION and MBX_INTERFACE_VERSION don't match")
     endif()
 endif()
+
+# Forward crypto_mb's list of platforms to the parent scope
+if(NOT MBX_MERGED_BLD)
+  set(MBX_PLATFORM_LIST ${MBX_PLATFORM_LIST} PARENT_SCOPE)
+endif()

sources/ippcp/crypto_mb/CMakeLists.txt

@@ -60,8 +60,53 @@ endif()
 set(l9_def "_L9" "SIMD_LEN=256")
 set(k1_def "_K1" "USE_AMS_5x" "SIMD_LEN=512")
 
+# Check MERGED_BLD flag for the standalone build case (otherwise it is set in the parent project)
+if(MB_STANDALONE)
+  if("${MERGED_BLD}" STREQUAL "") # MERGED_BLD is on by default
+    set(MERGED_BLD ON)
+  endif()
+  if(MERGED_BLD) # MERGED_BLD is on by default or by user settings
+    set(MBX_MERGED_BLD ON)
+    message (STATUS "MERGED_BLD ............................ on")
+  else()
+    message (STATUS "MERGED_BLD ............................ off")
+  endif()
+endif()
+
 # Proper dispatching requires several optimization paths
-set(MBX_PLATFORM_LIST k1 l9)
+# Set platform list (order is important for dispacther generation!!!)
+set(MBX_BASE_PLATFORM_LIST k1 l9)
+
+if(MBX_PLATFORM_LIST) # MBX_PLATFORM_LIST may be set by user
+  if (NOT MBX_MERGED_BLD)
+    foreach(opt ${MBX_PLATFORM_LIST})
+      set(FOUND_PLATFORM false)
+      foreach(base_opt ${MBX_BASE_PLATFORM_LIST})
+        string(STRIP "${opt}" opt_strip)
+        if(opt_strip STREQUAL base_opt)
+          set(FOUND_PLATFORM true)
+        endif()
+      endforeach(base_opt ${MBX_BASE_PLATFORM_LIST})
+      if(NOT FOUND_PLATFORM)
+        message (FATAL_ERROR "Incorrect platform: " ${opt})
+      endif()
+    endforeach(opt ${MBX_PLATFORM_LIST})
+    if (MBX_PLATFORM_LIST STREQUAL "")
+      message (FATAL_ERROR "MBX_PLATFORM_LIST cannot be empty")
+    endif(MBX_PLATFORM_LIST STREQUAL "")
+    message (STATUS "MBX Platform list ......................... " ${MBX_PLATFORM_LIST})
+  else()
+    message (FATAL_ERROR "MBX_PLATFORM_LIST cannot be set, when MERGED_BLD is on")
+  endif(NOT MBX_MERGED_BLD)
+else()
+  set(MBX_PLATFORM_LIST ${MBX_BASE_PLATFORM_LIST})
+endif()
+
+if (NOT MB_STANDALONE)
+  if (NOT MBX_MERGED_BLD)
+    set(MBX_PLATFORM_LIST ${MBX_PLATFORM_LIST} PARENT_SCOPE)
+  endif()
+endif()
 
 # check if L9 is supported by the compiler
 set(MBX_CC_AVXIFMA_SUPPORT 0)

sources/ippcp/crypto_mb/Readme.md

@@ -109,6 +109,18 @@ You can find the installed files in:
 > In this case to resolve the Crypto Multi-buffer Library dependency on OpenSSL it is
 > necessary to update `LD_LIBRARY_PATH` with the path to the target OpenSSL library.
 
+## Supported Platforms
+
+Crypto multi-buffer library uses multiple implementations of each function, optimized
+for various CPUs. Please, refer to [OVERVIEW.md](../../../OVERVIEW.md#cpu-dispatching)
+for the detailed information about code dispatching.
+
+### Target Optimization Codes in Function Names
+
+| Intel® 64 architecture | Meaning                                                                                                                                  |
+| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| l9                     | Optimized for processors with Intel® Advanced Vector Extensions 2 (Intel® AVX2) with Intel® AVX-IFMA (formerly codenamed Sierra Forest) |
+| k1                     | Optimized for processors with Intel® Advanced Vector Extensions 512 (Intel® AVX-512) (formerly codenamed IceLake)                        |
 
 ## How to Build
 
@@ -137,7 +149,9 @@ You can find the installed files in:
 
 ### Building with Intel® Cryptography Primitives Library
 
-The Crypto Multi-buffer library will be built automatically with Intel® Cryptography Primitives Library if optimization for Intel® Microarchitecture Code Named Ice Lake is available. For more information see [Intel Cryptography Primitives Library Build Instructions](../../../BUILD.md)
+The Crypto Multi-buffer library will be built automatically with Intel® Cryptography Primitives Library if
+optimization for Intel® Microarchitecture Code Named Ice Lake/Code Named Sierra Forest are available.
+For more information see [Intel Cryptography Primitives Library Build Instructions](../../../BUILD.md)
 
 ### CMake Build Options
 
@@ -151,3 +165,11 @@ The Crypto Multi-buffer library will be built automatically with Intel® Cryptog
    ```
 
 - Set `-DOPENSSL_USE_STATIC_LIBS=TRUE` if static OpenSSL libraries are preferred.
+
+- Use `-DMERGED_BLD:BOOL=off` to build of one static/dynamic library per optimization;
+See [specific ISA library](../../../OVERVIEW.md#specific-isa-library) for the details about 1CPU libraries build.
+
+- Use `-DMBX_PLATFORM_LIST="<platform list>"` to set target platforms for the code to be compiled.
+The flag works only if `-DMERGED_BLD:BOOL=off` is set. Please, refer to [Target Optimization Codes in Function Names](#target-optimization-codes-in-function-names) for the supported platforms list.
+    - Example:
+        `-DMBX_PLATFORM_LIST="k1;l9"`

sources/ippcp/crypto_mb/include/internal/common/internal_defs.h

@@ -35,11 +35,19 @@
    #include "x25519_cpuspc.h"
 #endif
 
+#if defined(_MBX_MERGED_BLD)
 #if defined( _L9 ) /* Intel® AVX2 */
    #define OWNAPI(name) l9_##name
-   #define _MBX _MBX_L9
 #elif defined( _K1 )
    #define OWNAPI(name) k1_##name
+#endif
+#else /* 1CPU build */
+  #define OWNAPI(name) name
+#endif
+
+#if defined( _L9 ) /* Intel® AVX2 */
+   #define _MBX _MBX_L9
+#elif defined( _K1 )
    #define _MBX _MBX_K1
 #endif