安装指南

环境要求

在安装SPDK之前，需要先安装KAE2.0，安装前请确保使用的环境满足KAE支持的软硬件环境，并且正确安装相应的License，License安装成功后，操作系统才能识别到加速器设备。

硬件要求

项目	规格
CPU型号	鲲鹏920处理器
其它	iBMC版本：V365及以上
其它	BIOS版本：V105及以上

操作系统要求

项目	版本
操作系统	openEuler 22.03 SP1 openEuler 22.03 SP2

软件要求

项目	版本	获取路径
KAE	2.0.0	获取链接
SPDK	21.01.1	获取链接
OpenSSL	1.1.1a及以上	获取链接

License获取

鲲鹏服务器主板K系列硬件加速引擎已默认开启，无需申请License。

License申请和安装操作请参见《华为服务器 iBMC 许可证使用指导》。

安装KAE

鲲鹏加速引擎KAE是基于鲲鹏920处理器提供的硬件加速解决方案，包含了KAE加解密和KAEzip，KAE加解密模块是基于OpenSSL的，因此在安装和使用KAE加解密模块前请正确安装OpenSSL。

具体的OpenSSL安装步骤请参见安装OpenSSL。

操作步骤

使用远程登录工具，以root账号进入Linux操作系统命令行界面。
在/home目录下拉取KAE2.0代码。
```
git clone https://gitcode.com/boostkit/KAE.git -b kae2
```
kae2分支适用于openEuler 22.03 LTS SP2，若操作系统为openEuler 22.03 LTS SP1，请使用KAE 2.0.0版本进行安装使用。
进入克隆下来的KAE目录，一键安装所有模块。
```
sh build.sh all
```
代码脚本提供一键式安装命令。进入KAE源码包目录，使用sh build.sh all命令安装KAE中所有组件内容，由于加解密和解压缩模块都需要安装，所以此处一键安装所有模块，详细安装流程请参见《源码安装（KAE2.0）》。

验证KAE是否安装成功

进入KAE目录，执行env-check.sh脚本。

sh env-check.sh

执行build.sh脚本后，即使过程中没有报错，KAE仍然有可能未安装成功，要验证KAE是否安装成功，可以运行KAE目录下的env-check.sh脚本文件，该脚本会检测KAE环境是否正常，如果检测到环境不正常会提示用户出现的问题，反之则KAE安装成功。

编译SPDK

正确安装完KAE软件之后，开始编译SPDK。SPDK软件不需要安装，只需要进行编译操作就可以生成可执行文件。

操作步骤

使用远程登录工具，以root账号进入Linux操作系统命令行界面。

在/home目录下拉取SPDK代码。

git clone https://github.com/spdk/spdk.git

进入克隆下来的SPDK目录，切换到指定的commitID，下载并合入patch。

cd spdk
git checkout 1f0dd58a43b5bc8118b123eca1b07781b052293d
wget https://gitcode.com/boostkit/spdk/blob/master/spdk-21.01.1-for-KAE.patch
git apply spdk-21.01.1-for-KAE.patch

加载dpdk、isal等模块。
```
git submodule update --init
```
安装SPDK所需要的依赖。
```
./scripts/pkgdep.sh
```
pkgdep.sh中没有适配openEuler系统，需要手动添加命令适配openEuler系统，打开pkgdep.sh，找到如下命令行：
```
if [[ ${ID,,} == *"suse"* ]]; then
       ID="sles"
fi
```
随后在命令行下方添加如下命令：
```
if [[ ${ID,,} == *"openeuler"* ]]; then
       ID="rhel"
fi
```
配置编译选项。
```
./configure --with-crypto --with-reduce --with-ksal --with-crypto_openssl
```
1. ./configure是执行配置编译选项功能，如--with-ksal为加载ksal模块， --with-crypto、--with-crypto_openssl为加载加解密模块， --with-reduce为加载解压缩模块。详细配置可通过执行./configure -h查看。
2. --with-reduce是加载解压缩模块，如果要加载该模块，需要配置环境变量export CFLAGS="-DZLIB\_MEM\_SIMU\_PMEM"。
3. --with-crypto、--with-crypto_openssl是加载加解密模块，如果需要加载该模块，需要合入两个补丁。单击获取链接获取补丁0001-fix-openssl-engine-double-free-bug.patch、spdk_v21.01.1_dpdk_compress_kae.patch放置在spdk/dpdk目录下，执行如下命令即可。
```
patch -p1 < 0001-fix-openssl-engine-double-free-bug.patch
 patch -p1 < spdk_v21.01.1_dpdk_compress_kae.patch
```
4. --with-ksal是加载ksal算法模块，KSAL是华为自研的高性能crc算法，对外闭源，采取动态库的形式集成，因此需要先安装KSAL算法包，加载KSAL动态库才能正常配置与编译，执行编译操作，单击下载rpm包。
执行编译操作。
```
make -j
```

修订记录

发布日期	修改说明
2024-09-30	第一次正式发布。