Automatic dependency clone & build using make depend.

Add openssl, ipp-crypto, intel-ipsec-mb as submodules
which will clone dependencies when submodules are inited.
`make depend` will build and install dependant libraries
from the  submodule path. Refer Build QAT Engine section
Example 5.

Signed-off-by: Nagha Abirami <naghax.abirami@intel.com>
Co-authored-by: Yogaraj Alamenda <yogarajx.alamenda@intel.com>

Author: naghaabirami

.gitignore

@@ -17,6 +17,8 @@ TAGS
 cscope.out
 /.dir-locals.el
 testapp.log
+QAT_HW.tar.gz
+QAT_HW/
 
 # Top level and qat_contig_mem excludes
 *.mod*

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "openssl"]
+	path = openssl
+	url = https://github.com/openssl/openssl.git
+[submodule "intel-ipsec-mb"]
+	path = intel-ipsec-mb
+	url = https://github.com/intel/intel-ipsec-mb.git
+[submodule "ipp-crypto"]
+	path = ipp-crypto
+	url = https://github.com/intel/ipp-crypto

Makefile.am

@@ -222,3 +222,29 @@ intkat:
 endif
 include test.am
 
+if QAT_HW
+depend: OpenSSL qat_hw_driver
+endif
+if QAT_SW
+depend: OpenSSL ipsec_mb crypto_mb
+endif
+OpenSSL:
+	cd openssl && ./config -Wl,-rpath,$(with_openssl_install_dir)/lib64 --prefix=$(with_openssl_install_dir) && make clean && make -j$(nproc) && make install -j$(nproc)
+
+if QAT_HW
+qat_hw_driver:
+	bash ./driver_install.sh $(with_qat_hw_dir)
+if QAT_4XXX
+if !QAT_HW_INTREE
+cflags_qat_hw += "-DQAT20_OOT"
+endif
+endif
+endif
+
+if QAT_SW
+ipsec_mb:
+	cd intel-ipsec-mb && make uninstall && make clean && make -j$(nproc) && make install -j$(nproc)
+
+crypto_mb:
+	cd ipp-crypto/sources/ippcp/crypto_mb && rm -rf build && cmake . -B"build" -DOPENSSL_INCLUDE_DIR=$(with_openssl_install_dir)/include -DOPENSSL_LIBRARIES=$(with_openssl_install_dir) -DOPENSSL_ROOT_DIR=$(PWD)/openssl && cd build && make clean && make -j$(nproc) && make install -j$(nproc)
+endif

README.md

@@ -42,6 +42,8 @@ Installation consists of the following:
 <details>
 <summary markdown="span">Install Prerequisites</summary>
 
+<br> Switch to Build the Intel® QuickAssist Technology OpenSSL* Engine - Example 5  and use the `make depend` target to clone and build the latest compatible versions of the dependant libraries automatically based on the target in the QAT Engine build configure.
+
 <details>
 <summary markdown="span">qat_hw Prerequisites </summary>
 
@@ -395,6 +397,42 @@ is not installed then their corresponding algorithm support is disabled
 <br><br>
 </details>
 
+<details>
+<summary>Example 5: Using `make depend` for building dependant libraries and build QAT Engine
+<br>
+
+This QAT Engine supports building and installing the dependant libraries automatically when
+the make option `make depend` is specified before make which clones the latest release of
+dependant libraries (OpenSSL, QAT_HW(QAT1.7, QAT1.8 & QAT2.0 OOT Linux driver),
+QAT_SW(ipp-crypto & ipsec_mb) based on the flags enabled in the QAT Engine build configure.
+
+```bash
+cd /QAT_Engine
+git submodule update --init
+./configure \
+--with-qat_hw_dir=/QAT \  #For QAT_HW supported platforms
+--enable-qat_sw \ #For QAT_SW supported platforms
+--with-openssl_install_dir=/usr/local/ssl # OpenSSL install path
+make depend
+make
+make install
+```
+
+In the above example this will clone and install QAT Engine(qat_hw + qat_sw)
+along with their dependant libraries installed in the path specifed for QAT_HW
+and default path for QAT_SW (`/usr/local` for ipp-crypto & `/usr` for ipsec_mb) with
+qatengine.so library installed in the path `/usr/local/ssl/lib64/engines-3`.
+The dependant libaries are built and installed based on the QAT Engine build configure
+flags provided for qat_hw, qat_sw or qat_hw + qat_sw target using OpenSSL3.0.
+
+Please note `make depend` target is not supported in FreeBSD OS, Virtualized environment,
+BoringSSL, BabaSSL and qatlib dependency build. The Dependant library versions used are updated in
+[Software Requirements section](https://github.com/intel/QAT_Engine/blob/master/docs/software_requirements.md)
+and OpenSSL version is latest of 3.0
+
+<br>
+</details>
+
 <details>
 <summary>Enable plock optimization in QAT Engine for Multithread applications</summary>
 <br>

configure.ac

@@ -325,6 +325,7 @@ then
     AC_MSG_NOTICE([QAT intree driver using QATlib in ${with_qat_hw_dir}])
   fi
 fi
+AM_CONDITIONAL([QAT_HW_INTREE], [test "x$cflags_qat_hw_intree" != "x"])
 
 # ERROR message if mandatory options are not provided
 if test "x$cflags_qat_hw_intree" = "x"
@@ -357,9 +358,14 @@ then
     fi
   else
     ac_default_prefix=$with_openssl_install_dir
-    #OPENSSL 3.0
-    if test "`grep "define OPENSSL_VERSION_MAJOR" $with_openssl_install_dir/include/openssl/opensslv.h | awk '{print $4}'`" = "3"
+    if test "`grep "define OPENSSL_VERSION_NUMBER  0x1010"  $with_openssl_install_dir/include/openssl/opensslv.h | wc -l`" = "1"
     then
+      #OPENSSL 1.1.1
+      AC_MSG_NOTICE([Build QAT engine against OpenSSL 1.1.1])
+      libdir="\$(with_openssl_install_dir)/lib/engines-1.1"
+      AC_SUBST([OPENSSL_LIB], ["-Wl,-rpath,\$(with_openssl_install_dir)/lib -L\$(with_openssl_install_dir)/lib -lcrypto"])
+    else
+      #OPENSSL 3.0
       if test "x$enable_qat_provider" = "xyes"
       then
         AC_MSG_NOTICE([Build QAT Provider against OpenSSL 3.0])
@@ -373,11 +379,6 @@ then
         AC_SUBST([cflags_openssl_3], ["-DQAT_OPENSSL_3 -DOPENSSL_SUPPRESS_DEPRECATED"])
         AC_SUBST([OPENSSL_LIB], ["-Wl,-rpath,\$(with_openssl_install_dir)/\$(openssl3_lib) -L\$(with_openssl_install_dir)/\$(openssl3_lib) -lcrypto"])
       fi
-    else
-      #OPENSSL 1.1.1
-      AC_MSG_NOTICE([Build QAT engine against OpenSSL 1.1.1])
-      libdir="\$(with_openssl_install_dir)/lib/engines-1.1"
-      AC_SUBST([OPENSSL_LIB], ["-Wl,-rpath,\$(with_openssl_install_dir)/lib -L\$(with_openssl_install_dir)/lib -lcrypto"])
     fi
   fi
   AC_SUBST([includes_openssl], ["-I\$(with_openssl_install_dir)/include"])
@@ -387,16 +388,18 @@ else
   AS_IF([test "x$PKGCONFIG" = "x"], [AC_MSG_ERROR(pkg-config not found.)], )
   libdir="`pkg-config --variable=enginesdir libcrypto`"
   includes_openssl="`pkg-config --variable=includedir libcrypto`"
-  if test "`grep "define OPENSSL_VERSION_MAJOR" $includes_openssl/openssl/opensslv.h | awk '{print $4}'`" = "3"
+  if test "`grep "define OPENSSL_VERSION_NUMBER  0x1010" $includes_openssl/openssl/opensslv.h | wc -l`" = "1"
   then
+      AC_MSG_NOTICE([Build QAT Engine against system OpenSSL 1.1.1])
+  else
     if test "x$enable_qat_provider" = "xyes"
     then
-      AC_MSG_NOTICE([Build QAT Provider against OpenSSL 3.0])
+      AC_MSG_NOTICE([Build QAT Provider against system OpenSSL 3.0])
       AC_SUBST([cflags_openssl_3], ["-DQAT_OPENSSL_3 -DOPENSSL_SUPPRESS_DEPRECATED -DQAT_OPENSSL_PROVIDER"])
       openssl3_lib="`pkg-config --variable=libdir libcrypto`"
       libdir="\$(openssl3_lib)/ossl-modules"
     else
-      AC_MSG_NOTICE([Build QAT Engine against OpenSSL 3.0])
+      AC_MSG_NOTICE([Build QAT Engine against system OpenSSL 3.0])
       AC_SUBST([cflags_openssl_3], ["-DQAT_OPENSSL_3 -DOPENSSL_SUPPRESS_DEPRECATED"])
       libdir="`pkg-config --variable=enginesdir libcrypto`"
     fi
@@ -424,6 +427,11 @@ then
   fi
 fi
 AM_CONDITIONAL([QAT_HW], [test "x$cflags_qat_hw" != "x"])
+case "$host_os" in
+linux*)
+    AS_IF([test `lspci -vnd 8086: | grep -c 4940` != "0"], [AC_SUBST([enable_qat20_oot], ["-DQAT20_OOT"])])
+esac
+AM_CONDITIONAL([QAT_4XXX], [test "x$enable_qat20_oot" != "x"])
 
 # QAT_SW acceleration enabled
 if test "x$enable_qat_sw" = "xyes"
@@ -445,6 +453,7 @@ then
                    [AC_SUBST([QAT_SW_CRYPTO_MB_LIB], ["-Wl,-rpath,/usr/local/lib -L/usr/local/lib -lcrypto_mb"])],
                    [AC_SUBST([QAT_SW_CRYPTO_MB_LIB], ["-lcrypto_mb"])])
     fi
+    AC_SUBST([cflags_qat_sw], ["-DQAT_SW"])
   fi
 
 #IPSEC_MB install path provided

driver_install.sh

@@ -0,0 +1,76 @@
+#!/bin/sh
+
+#QAT_HW OOT driver Location
+QAT17_DRIVER=https://downloadmirror.intel.com/780675/QAT.L.4.22.0-00001.tar.gz
+QAT20_DRIVER=https://downloadmirror.intel.com/783270/QAT20.L.1.0.50-00003.tar.gz
+
+#Supported Devices
+numC62xDevice=`lspci -vnd 8086: | grep -c "37c8\|37c9"`
+numDh895xDevice=`lspci -vnd 8086: | grep -c "0435\|0443"`
+numC3xxxDevice=`lspci -vnd 8086: | grep -c "19e2\|19e3"`
+num200xxDevice=`lspci -vnd 8086: | grep -c "18ee\|18ef"`
+numC4xxxDevice=`lspci -vnd 8086: | grep -c "18a0\|18a1"`
+num4xxxDevice=`lspci -vnd 8086: | grep -c "4940"`
+
+QAT_ENGINE_ROOT=$PWD
+
+#Install QAT_HW OOT Driver and copy config files
+if [ "$numC62xDevice" -gt 0 -o "$numDh895xDevice" -gt 0 -o "$numC3xxxDevice" -gt 0 -o "$numC4xxxDevice" -gt 0 -o "$num200xxDevice" -gt 0 -o "$num4xxxDevice" -gt 0 ]
+then
+    if [ "$num4xxxDevice" -gt 0 ]
+    then
+        echo "QAT2.0 Driver"
+        wget -O QAT_HW.tar.gz $QAT20_DRIVER
+    else
+        echo "QAT1.7 Driver"
+        wget -O QAT_HW.tar.gz $QAT17_DRIVER
+    fi
+    mkdir -p $1
+    tar -zxvf QAT_HW.tar.gz -C $1
+    unset ICP_ROOT
+    unset ICP_BUILD_OUTPUT
+    cd $1
+    ./configure
+    make uninstall; make clean; make install -j
+    if [ "$numC62xDevice" -gt 0 ]
+    then
+        for(( i=0; i<$numC62xDevice; i++ ))
+        do
+           sudo cp -rf $QAT_ENGINE_ROOT/qat_hw_config/c6xx/multi_process/c6xx_dev0.conf /etc/c6xx_dev$i.conf
+        done
+    elif [ "$numDh895xDevice" -gt 0 ]
+    then
+        for(( i=0; i<"$numDh895xDevice"; i++ ))
+        do
+           sudo cp -rf $QAT_ENGINE_ROOT/qat_hw_config/dh895xcc/multi_process/dh895xcc_dev0.conf /etc/dh895xcc_dev$i.conf
+        done
+    elif [ "$numC3xxxDevice" -gt 0 ]
+    then
+        for(( i=0; i<"$numC3xxxDevice"; i++ ))
+        do
+           sudo cp -rf $QAT_ENGINE_ROOT/qat_hw_config/c3xxx/multi_process/c3xxx_dev0.conf /etc/c3xxx_dev$i.conf
+        done
+    elif [ "$numC4xxxDevice" -gt 0 ]
+    then
+        for(( i=0; i<"$numC4xxxDevice"; i++ ))
+        do
+           sudo cp -rf $QAT_ENGINE_ROOT/qat_hw_config/c4xxx/multi_process/c4xxx_dev0.conf /etc/c4xxx_dev$i.conf
+        done
+    elif [ "$num200xxDevice" -gt 0 ]
+    then
+        for(( i=0; i<"$num200xxDevice"; i++ ))
+        do
+           sudo cp -rf $QAT_ENGINE_ROOT/qat_hw_config/200xx/multi_process/200xx_dev0.conf /etc/200xx_dev$i.conf
+        done
+    elif [ "$num4xxxDevice" -gt 0 ]
+    then
+        for(( i=0; i<$num4xxxDevice; i++ ))
+        do
+           sudo cp -rf $QAT_ENGINE_ROOT/qat_hw_config/4xxx/multi_process/4xxx_dev0.conf /etc/4xxx_dev$i.conf
+        done
+    fi
+    adf_ctl restart
+    echo "QAT_HW Driver installed successfully!"
+else
+    echo "QAT_HW Device not supported to install from make depend ! Install driver manually"
+fi

e_qat.c

@@ -1061,7 +1061,7 @@ int bind_qat(ENGINE *e, const char *id)
 
     /* For QAT_HW, Check if the QAT_HW device is available */
 #ifdef QAT_HW
-# if defined(QAT20_OOT) || defined(__FreeBSD__)
+# if !defined(QAT_HW_INTREE) && (defined(QAT20_OOT) || defined(__FreeBSD__))
     if (icp_adf_get_numDevices(&dev_count) == CPA_STATUS_SUCCESS) {
         if (dev_count > 0) {
             qat_hw_offload = 1;