Added multi-buffer implementation of AES-CFB optimized with Intel(R) AES-NI and vector extensions of Intel(R) AES-NI instruction sets

Author: amatyuko-intc

BUILD.md

@@ -1,43 +1,43 @@
 # How to Build Intel® Integrated Performance Primitives Cryptography (Intel® IPP Cryptography) <!-- omit in toc -->
 
 - [Software Requirements](#software-requirements)
-  - [Common](#common)
-  - [Linux* OS](#linux-os)
-  - [Windows* OS](#windows-os)
-  - [macOS*](#macos)
+    - [Common tools](#common-tools)
+    - [Linux* OS](#linux-os)
+    - [Windows* OS](#windows-os)
+    - [macOS*](#macos)
 - [Building Intel IPP Cryptography on Linux\* OS](#building-intel-ipp-cryptography-on-linux-os)
 - [Building Intel IPP Cryptography on Windows\* OS](#building-intel-ipp-cryptography-on-windows-os)
 - [Building Intel IPP Cryptography on macOS\*](#building-intel-ipp-cryptography-on-macos)
 - [CMake Build Options](#cmake-build-options)
-  - [Common for all operating systems](#common-for-all-operating-systems)
-  - [Windows\* OS](#windows-os-1)
-  - [Linux\* OS](#linux-os-1)
+    - [Common for all operating systems](#common-for-all-operating-systems)
+    - [Windows\* OS](#windows-os)
+    - [Linux\* OS](#linux-os)
 - [CMake Commands FAQ](#cmake-commands-faq)
-  - [How to build a 32-bit library?](#how-to-build-a-32-bit-library)
-  - [How to build a 64-bit generic library without any CPU-specific optimizations?](#how-to-build-a-64-bit-generic-library-without-any-cpu-specific-optimizations)
-  - [How to build two libraries with optimizations for Intel® Advanced Vector Extensions 2 and Intel® Advanced Vector Extensions 512 instruction sets?](#how-to-build-two-libraries-with-optimizations-for-intel%c2%ae-advanced-vector-extensions-2-and-intel%c2%ae-advanced-vector-extensions-512-instruction-sets)
-  - [How to build a library to work in a kernel space?](#how-to-build-a-library-to-work-in-a-kernel-space)
-- [Incorporating Intel IPP Cryptography sources into custom build system](#incorporating-intel%c2%ae-ipp-cryptography-sources-into-custom-build-system)
+    - [How to build a 32-bit library?](#how-to-build-a-32-bit-library)
+    - [How to build a 64-bit generic library without any CPU-specific optimizations?](#how-to-build-a-64-bit-generic-library-without-any-cpu-specific-optimizations)
+    - [How to build two libraries with optimizations for Intel® Advanced Vector Extensions 2 and Intel® Advanced Vector Extensions 512 instruction sets?](#how-to-build-two-libraries-with-optimizations-for-intel-advanced-vector-extensions-2-and-intel-advanced-vector-extensions-512-instruction-sets)
+    - [How to build a library to work in a kernel space?](#how-to-build-a-library-to-work-in-a-kernel-space)
+- [Incorporating Intel® IPP Cryptography sources into custom build system](#incorporating-intel-ipp-cryptography-sources-into-custom-build-system)
+
 
 ## Software Requirements
-### Common
+### Common tools
 - [CMake\*](https://cmake.org/download) 3.15 or higher
 - Python 2.7.15
-- The Netwide Assembler (NASM) 2.15\*
+- The Netwide Assembler (NASM) 2.15
 
-> **NOTE**: Until NASM 2.15 is officially released, please use [this](https://www.nasm.us/pub/nasm/snapshots/20191023/) NASM snapshot.
 ### Linux* OS
-- [Common tools](#common-software-requirements)
+- [Common tools](#common-tools)
 - Intel® C++ Compiler 19.0 Update 4 for Linux\* OS
 - GCC 8.3
 - GCC 9.1
 - GNU binutils 2.32
 ### Windows* OS
-- [Common tools](#common-software-requirements)
+- [Common tools](#common-tools)
 - Intel® C++ Compiler 19.0 Update 4 for Windows\* OS
 - Microsoft Visual C++ Compiler\* version 19.16 provided by Microsoft Visual Studio\* 2017 version 15.9
 ### macOS*
-- [Common tools](#common-software-requirements)
+- [Common tools](#common-tools)
 - Intel® C++ Compiler 19.0 Update 4 for macOS\* 
 ## Building Intel IPP Cryptography on Linux\* OS
 
@@ -188,7 +188,7 @@ To build the Intel IPP Cryptography library on macOS*, complete the following st
 - `-B<build-dir>` - defines the build directory. This is the directory where CMake puts the generated Microsoft Visual Studio\* solution or makefiles.
 
 - `-DARCH=<ia32|intel64>` - on Linux* OS and macOS*, defines the target architecture for the build of the Intel IPP Cryptography library.
-    > **NOTE:** On Windows* OS, use `-G`/`-A`  instead. See the description of these options [below](#windows-os-specific).
+    > **NOTE:** On Windows* OS, use `-G`/`-A`  instead. See the description of these options [below](#windows-os-1).
 
 - `-DMERGED_BLD:BOOL=<on|off>` - optional. Defines the configuration of the Intel IPP Cryptography library to build:
 
@@ -280,4 +280,4 @@ endif()
 #     `IPPCRYPTO_LIBRARIES` - static library name
 #     `IPPCRYPTO_INCLUDE_DIRS` - path to Intel IPP Cryptography headers
 #     `IPPCRYPTO_ROOT_DIR` - library root dir (a folder with 'include' and 'lib' directories)
-```
+```

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 This is a list of notable changes to Intel(R) IPP Cryptography, in reverse chronological order.
 
+## YYYY-MM-DD
+
+## 2020-08-19
+- Added multi-buffer implementation of AES-CFB optimized with Intel(R) AES-NI and vector extensions of Intel(R) AES-NI instruction sets.
+- Fixed compatibility issue with x64 ABI (restored non-volatile registers after function call in AVX/AVX2 assembly code).
+- Updated Intel IPP Custom Library Tool.
+
 ## 2020-06-09
 - AES-GCM algorithm was optimized for Intel(R) Microarchitecture Code Named Cascade Lake with Intel(R) AES New Instructions (Intel(R) AES-NI).
 - Crypto Multi-buffer library installation instructions update.

CMakeLists.txt

@@ -22,7 +22,7 @@ cmake_minimum_required(VERSION 3.1)
 
 set(PROJECT_FULL_NAME "Intel® Integrated Performance Primitives Cryptography (Intel® IPP Cryptography)")
 set(PROJECT_NAME "Intel(R) IPP Crypto")
-set(PROJECT_VERSION, "2020.0.0")
+set(PROJECT_VERSION "2020.0.2")
 
 set(LIB_NAME ippcp)
 
@@ -41,7 +41,9 @@ if("${CMAKE_GENERATOR}" STREQUAL "NMake Makefiles")
   endif()
 endif()
 
-project(${PROJECT_NAME} C CXX)
+project(${PROJECT_NAME}
+        VERSION ${PROJECT_VERSION}
+        LANGUAGES C CXX)
 
 if("${CMAKE_BUILD_TYPE}" STREQUAL "")
   message(STATUS "CMAKE_BUILD_TYPE is unset, defaulting to Release")
@@ -80,6 +82,15 @@ if("${MERGED_BLD}" STREQUAL "")
   set(MERGED_BLD ON)
 endif()
 
+# Set default installation directories
+if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
+  if (UNIX)
+    set(CMAKE_INSTALL_PREFIX "$ENV{HOME}/intel/ippcp_${PROJECT_VERSION}" CACHE PATH "..." FORCE)
+  else()
+    set(CMAKE_INSTALL_PREFIX "c:/Program Files (x86)/IntelSWTools/ippcp_${PROJECT_VERSION}" CACHE PATH "..." FORCE)
+  endif()
+endif()
+
 set(IPP_CRYPTO_DIR                  "${CMAKE_CURRENT_SOURCE_DIR}")
 set(IPP_CRYPTO_INCLUDE_DIR          "${CMAKE_CURRENT_SOURCE_DIR}/include")
 set(IPP_CRYPTO_SOURCES_INCLUDE_DIR  "${CMAKE_CURRENT_SOURCE_DIR}/sources/include")
@@ -136,6 +147,7 @@ message (STATUS "IPP_CRYPTO_SOURCES_INCLUDE_DIR ........ " ${IPP_CRYPTO_SOURCES_
 message (STATUS "IPP_CRYPTO_SOURCES_DIR ................ " ${IPP_CRYPTO_SOURCES_DIR})
 message (STATUS "ARCH .................................. " ${ARCH})
 message (STATUS "DYNAMIC_LIB ........................... " ${DYNAMIC_LIB})
+message (STATUS "CMAKE_INSTALL_PREFIX .................. " ${CMAKE_INSTALL_PREFIX})
 
 if(Python_Interpreter_FOUND)
   message (STATUS "PYTHON_VERSION_STRING ................. " ${Python_VERSION})

include/ippcp.h

@@ -14,10 +14,10 @@
 * limitations under the License.
 *******************************************************************************/
 
-/* 
+/*
 //
 //   Intel® Integrated Performance Primitives Cryptography (Intel® IPP Cryptography)
-// 
+//
 */
 
 #if !defined( IPPCP_H__ ) || defined( _OWN_BLDPCS )
@@ -209,6 +209,12 @@ IPPAPI(IppStatus, ippsAESDecryptXTS_Direct,(const Ipp8u* pSrc, Ipp8u* pDst, int
                                      const Ipp8u* pKey, int keyBitsize,
                                      int dataUnitBitsize))
 
+/* AES multi-buffer functions */
+IPPAPI(IppStatus, ippsAES_EncryptCFB16_MB, (const Ipp8u* pSrc[], Ipp8u* pDst[], int len[],
+                                            const IppsAESSpec* pCtx[],
+                                            const Ipp8u* pIV[],
+                                            IppStatus status[],
+                                            int numBuffers))
 
 /* SMS4 */
 IPPAPI(IppStatus, ippsSMS4GetSize,(int *pSize))
@@ -825,7 +831,7 @@ IPPAPI(IppStatus, ippsRSA_ValidateKeys,(int* pResult,
 /* encryption scheme: RSAES-OAEP */
 IPP_DEPRECATED(OBSOLETE_API) \
 IPPAPI(IppStatus, ippsRSAEncrypt_OAEP,(const Ipp8u* pSrc, int srcLen,
-                                       const Ipp8u* pLabel, int labLen, 
+                                       const Ipp8u* pLabel, int labLen,
                                        const Ipp8u* pSeed,
                                              Ipp8u* pDst,
                                        const IppsRSAPublicKeyState* pKey,
@@ -841,7 +847,7 @@ IPPAPI(IppStatus, ippsRSADecrypt_OAEP,(const Ipp8u* pSrc,
                                              Ipp8u* pBuffer))
 
 IPPAPI(IppStatus, ippsRSAEncrypt_OAEP_rmf,(const Ipp8u* pSrc, int srcLen,
-                                       const Ipp8u* pLabel, int labLen, 
+                                       const Ipp8u* pLabel, int labLen,
                                        const Ipp8u* pSeed,
                                              Ipp8u* pDst,
                                        const IppsRSAPublicKeyState* pKey,