OpenHarmony Liteos_A内核之iperf3移植心得

一、iperf3工作原理

iperf3主要的功能是测试基于特定路径的带宽，在客户端和服务器端建立连接（三次握手）后，客户端发送一定大小的数据报并记下发送的时间，或者客户端在一定的时间内发送数据并记下发送的总数据。带宽的大小等于发送的总数据除以发送的总时间。对服务器端来说，在连接建立时间内，接收的总数据除以所花时间即为服务器端所测得的带宽。

iperf3测试UDP的性能时，客户端可以指定UDP数据流的速率。客户端发送数据时，将根据客户提供的速率计算数据报发送之间的时延，客户还可以指定发送数据报的大小。每个发送的数据报包含一个ID号，用来唯一地标识该报文。服务器端则根据该ID号来确定数据报丢失和乱序。当把UDP报文大小设置可以将整个报文放入IP层的包（packet）内时，那么UDP所测得的报文丢失数据即为IP层包的丢失数据。这提供了一个有效的测试包丢失情况的方法。数据报传输延迟抖动（Jitter）的测试由服务器端完成，客户发送的报文数据包含有发送时间戳，服务器端根据该时间信息和接收到报文的时间戳来计算传输延迟抖动。传输延迟抖动反映传输过程中是否平滑。由于它是一个相对值，所以并不需要客户端和服务器端时间同步。

由上介绍我们可以知道iperf3的功能增加了操作系统网络度量的能力，而携带Liteos_A内核的OpenAtom OpenHarmony（以下简称“OpenHarmony”）操作系统目前还不支持这个功能，特此尝试把iperf3移植到支持Liteos_A内核的OpenHarmony操作系统中，并作此文分享一些心得。

二、iperf3移植过程

iperf3可以运行在Linux和Windows平台下，其使用了标准的POSIX接口，因此将iperf3移植到Liteos_A上，目前Liteos_A支持用户态和内核态的命令，这个也造成了移植的很大困难，所以以下将2种添加命令的方式都记录下，供读者参考。

1. 确定库的类型

OpenHarmony有如下几种目标类型：

executable: 生成可执行文件，对于Liteos_A,在目录/bin下可以找到可执行文件

shared_library: 生成.dll或.so动态链接库、对于Liteos_A,在目录/lib或者 /usr/lib下可以找到动态库

static_library: 生成.lib或.a静态链接库

group: 生成依赖关系组

action: 运行脚本以生成文件

根据以上几种类型的描述可知，将iperf3移植成executable类型的组件最为合适。

2. 添加库到工程中

将源码下载到Linux下并解压，执行./configure，生成iperf_config.h，将iperf3的源码拷贝到OpenHarmony代码库中合适的位置,如下将iperf3添加到/third_party目录下。

需要注意的是非内核态的库不能添加到内核的目录下，不然编译和调试过程中相关的头文件可能找不到。在/vendor/厂商名/产品型号/config.json中的某一子系统下添加组件。

在 /build/lite/components/子系统名.json中添加组件，如下：

3. 编写配置BUILD.gn

移植的iperf3代码目录下需要提供一个gn文件，指明需要编译的代码。此文件可以通过import组件模板函数。一方面，很多引用到的头文件需要逐个添加到系统BUILD.GN中去，import组件模板函数可以省去很多麻烦；另一方面，头文件有多个，最终还很难确定是哪一个，使用系统配置好的组件模板函数，可以自动匹配。

4. 程序启动入口：将三方库添加到shell命令

内核态的shell功能不符合POSIX标准，仅供调试使用，本文特记录下其添加命令的方法，此方法分为静态和动态两种方式,添加方式如下：

① 命令源代码包含如下头文件

#include "shell.h"
#include "shcmd.h"

② 静态注册命令方式

第一步：调用SHELLCMD_ENTRY(l, cmdType, cmdKey, paraNum, cmdHook)，在源文件最后增加这个调用即可。

第二步：在链接选项中添加链接该新增命令项参数。

即在kernel/liteos_a/tools/build/mk/liteos_tables_ldflags.mk中增加相应选项，SHELLCMD_ENTRY的第一个参数前加-u。

此方法添加的shell,在代码编译阶段就已编译进去了，其实现原理是利用了编译器的section特性(也是代码模块化的重要手段)，将所有shell命令相关功能都放在一段连续的地址空间，将SHELLCMD_ENTRY宏一层层展开，即可得到下面原型。

LOS_HAL_TABLE_BEGIN(g_shellcmd, shellcmd); //段的起始tag
LOS_HAL_TABLE_END(g_shellcmdEnd, shellcmd); //段的结束tag
SHELLCMD_ENTRY(l, cmdType, cmdKey, paraNum, cmdHook)

如下是编译后生成的map文件中shell段的部分，可以观察到已经通过此方法加入的shell命令。

③ 动态注册命令方式

此类方式是在代码运行阶段动态的注册，osCmdReg本身是一个函数，在命令初始化的源代码增加此函数调用。

UINT32 osCmdReg(CmdT ype cmdType, CHAR *cmdKey, UINT32 paraNum, CmdCallBackFunc cmdP

函数原型在/kernel/liteos_a/shell/full/src/base/shcmd.c 可以找到，基本原理是将动态注册的shell命令加入到动态shell命令链表空间。

2）用户态的shell不用手动添加

添加目标的方式为executable，将程序下载到目标板上，在/bin目录下找到可执行的文件，只要在串口助手中输入 ./bin/可执行文件名，内核即可动态加载可执行的文件（或者输入exec /bin/可执行文件名）。

三、iperf3使用方式介绍

使用iperf3测试时必须将一台主机设置为客户端，一台主机设置为服务器。在Linux环境或者Windows或者OpenHarmony shell交互窗口输入iperf3 -h可以获取iperf3的帮助信息。以下介绍几种常见的使用方式:

1. iperf3测试TCP

在默认的情况下，iperf3客户端与指定的监听5201端口的iperf3服务器建立一个TCP会话。

服务端：iperf3 -s
客户端：iperf3 -c 服务器IP   (默认测试10秒)，使用t来设置测试时间，单位是秒。
例如：iperf3 -c 192.168.99.74 -t 20

运行结果如下：

2. iperf3测试UDP

iperf3测试UDP性能时，客户端可以指定UDP数据流的速率。客户端发送数据时，将根据客户端提供的速率计算数据报发送之间的时延。

客户端还可以指定发送数据报的大小。每个发送的数据报包含一个ID号，用来唯一标识报文，服务器端根据该ID号来确定数据报丢失和乱序。

当把UDP报文大小设置可以将整个报文放入IP层的包(packet)内时，那么UDP所测得的报文丢失数据即为IP层包的丢失数据，这提供了一个有效的测试包丢失情况的方法。

数据报传输延迟抖动(Jitter)的测试由服务器端完成，客户发送的报文数据包含有发送时间戳，服务器端根据该时间信息和接收到报文的时间戳来计算传输延迟抖动。传输延迟抖动反映传输过程中是否平滑。由于它是一个相对值，所以并不需要客户端和服务器端时间同步。测试过程如下：

服务端：iperf3 -s -p 6868  （设定服务端监听6868端口）
Liteos_A shell客户端：./bin/iperf3 -c 172.17.5.159 -p 6868 -u -b 100M

测试结果：

Jitter（延时变化）：用iperf3 UDP测试来量度
数据报丢失：用iperf3 UDP测试来量度
带宽：通过TCP测试来量度

3. 反向带宽测试

服务端使用的命令不变，客户端需要加上参数-R，在帮助信息中，可以看到-R的信息是run in reverse mode (server sends, client receives)

服务端：iperf3 -s -p 6868
客户端：./bin/iperf3 -c 172.17.5.159 -p 6868 -u -b 100M -R

测试结果如下：

4. 同步双向带宽

测试

客户端加上命令参数 -bidir

服务端：iperf3 -s -p 6868
客户端：./bin/iperf3 -c 172.17.5.159 -p 6868 -u -b 100M -bidir

测试结果如下：

四、注意事项和遇到的问题及解决方法

1. Hi3516有三种下载程序的方式：串口、USB、网口转USB。推荐使用USB来下载程序，使用串口来调试程序。

2. DevEco Device Tool工具使用USB烧录Hi3516DV300镜像时失败，怎么解决？

解决措施：

出现这个问题，主要是因为开发者将Device Tool工具安装在系统盘符，在烧录大文件时会因为没有权限导致失败，可以根据以下操作解决：

● 在Windows平台找到安装目录，如图。鼠标右键，选中属性。

● 依次操作，步骤5将红框中两个选项都勾选上。

3. Hi3516如果携带操作系统是支持Linux内核的OpenHarmony，第一次下载时，需要格式化，下载完成后，系统启动到boot，就不会引导整个系统应用程序，这时需要点击如下菜单，然后重新拔插USB才能进入整个系统。

4. 在编写.gn文件时，如果三方组件为executable，那么第三方库代码中需要有唯一个入口main函数，最终生成一个可执行的命令。

5. iperf有大版本1，2，3，目前最新的是iperf3，不同的版本间命令参数不同，工作机制有所不同，所以在测试时，服务端和客户端要求使用相同的大版本。例如iperf3服务端不支持iperf的-u,-命令。

6. 在使用iperf3进行测试过程中，需要关闭防火墙，不然可能不能进行正常测试，可以提前使用ping测试一下网络是否已通。

7. 公司网络端的控制也会对测试造成影响，如果测试中发现发送和接收到的数据一直是0，则可能是网络控制端进行了控制，在拔掉外网络的情况，测试出来的结果就会很稳定。

8. Hi3516主板作为服务端，输入iperf3 -s，然后在PC机上启动客户端进行测试，发现根本不能进行正常测试，原因也是公司网络控制导致，解决办法是将要测试的两个网络接口，接到同一交换机下，然后拔掉外网的网线，可以进行正常测试；或者需要IT开发权限，当然如果不是在公司特定网络环境下，这个现象是不会出现的。

9. Hi3516需要设置网络才能进行测试，可以使用命令ifconfig来设置，例如：ifconfig eth0 172.17.5.253 netmask 255.255.254.0 gateway 172.17.4.1

10. MSS在OpenHarmony的底层LWIP不支持，在iperf_connect函数中调用getsockopt(test->ctrl_sck, IPPROTO_TCP, TCP_MAXSEG, &opt, &len)，会通过系统调用到达kernel层中的/kernel/liteos_a/compat/posix/src/socket.c, 最终走到底层LWIP的lwip_getsockopt_impl接口，在level IPPROTO_TCP下，对于分支TCP_MAXSEG，没有实现，解决办法是先屏蔽iperf3对此处的操作。同样在调用setsockopt(s, SOL_SOCKET, SO_SNDBUF, &opt, sizeof(opt))时，SO_SNDBUF分支在LWIP也未实现，先屏蔽此处，将发送缓冲区设置成和接收缓冲区同样的大小。

11. Liteos_A未实现延时删除，所以调用unlink时会出错，目前处理是先屏蔽此处。

12. Liteos_A对fprintf的实现也不如Linux，Windows好，所以对help命令输出到stdout上，长字串显示不出来，解决办法是使用fputs替换fprintf。