用户态协议栈Gazelle用户指南

简介

Gazelle是一款高性能用户态协议栈。它基于DPDK在用户态直接读写网卡报文,共享大页内存传递报文,使用轻量级LwIP协议栈。能够大幅提高应用的网络I/O吞吐能力。专注于数据库网络性能加速,如MySQL、redis等。

  • 高性能
    报文零拷贝,无锁,灵活scale-out,自适应调度。
  • 通用性
    完全兼容POSIX,零修改,适用不同类型的应用。

单进程且网卡支持多队列时,只需使用liblstack.so,以缩短报文路径。其余场景使用ltran进程分发报文到各个线程。

安装

配置openEuler的yum源,直接使用yum命令安装

yum install dpdk
yum install libconfig
yum install numactl
yum install libboundscheck
yum install libpcap
yum install gazelle

说明:
dpdk >= 21.11-2

使用方法

配置运行环境,使用Gazelle加速应用程序步骤如下:

1. 使用root权限安装ko

根据实际情况选择使用ko,提供虚拟网口、绑定网卡到用户态功能。
若使用虚拟网口功能,则使用rte_kni.ko

modprobe rte_kni carrier="on"

配置NetworkManager不托管kni网卡

[root@localhost ~]# cat /etc/NetworkManager/conf.d/99-unmanaged-devices.conf
[keyfile]
unmanaged-devices=interface-name:kni
[root@localhost ~]# systemctl reload NetworkManager

网卡从内核驱动绑为用户态驱动的ko,根据实际情况选择一种。

#若IOMMU能使用
modprobe vfio-pci

#若IOMMU不能使用,且VFIO支持noiommu
modprobe vfio enable_unsafe_noiommu_mode=1
modprobe vfio-pci

#其它情况
modprobe igb_uio

说明:
可根据机器BIOS配置,查看是否启用IOMMU。

2. dpdk绑定网卡

将网卡绑定到步骤1选择的驱动。为用户态网卡驱动提供网卡资源访问接口。

#使用vfio-pci
dpdk-devbind -b vfio-pci enp3s0 

#使用igb_uio
dpdk-devbind -b igb_uio enp3s0

3. 大页内存配置

Gazelle使用大页内存提高效率。使用root权限配置系统预留大页内存,可选用任意页大小。因每页内存都需要一个fd,使用内存较大时,建议使用1G的大页,避免占用过多fd。
根据实际情况,选择一种页大小,配置足够的大页内存即可。配置大页操作如下:

#配置2M大页内存:在node0上配置 2M * 1024 = 2G
echo 1024 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages

#配置1G大页内存:在node0上配置1G * 5 = 5G
echo 5 > /sys/devices/system/node/node0/hugepages/hugepages-1048576kB/nr_hugepages

说明:
cat查询实际预留页个数,连续内存不足时可能比预期少

4. 挂载大页内存

创建两个目录,分别给lstack的进程、ltran进程访问大页内存使用。操作步骤如下:

mkdir -p /mnt/hugepages-ltran
mkdir -p /mnt/hugepages-lstack
chmod -R 700 /mnt/hugepages-ltran
chmod -R 700 /mnt/hugepages-lstack

mount -t hugetlbfs nodev /mnt/hugepages-ltran -o pagesize=2M
mount -t hugetlbfs nodev /mnt/hugepages-lstack -o pagesize=2M

说明:
/mnt/hugepages-ltran和/mnt/hugepages-lstack必须挂载同样pagesize大页

5. 应用程序使用Gazelle

有两种使用Gazelle方法,根据需要选择其一

  • 重新编译应用程序,替换sockets接口
#makefile中添加Gazelle的Makefile
-include /etc/gazelle/lstack.Makefile

#编译添加LSTACK_LIBS变量
gcc test.c -o test ${LSTACK_LIBS}
  • 使用LD_PRELOAD加载Gazelle库
    GAZELLE_BIND_PROCNAME环境变量指定进程名,LD_PRELOAD指定Gazelle库路径。
GAZELLE_BIND_PROCNAME=test LD_PRELOAD=/usr/lib64/liblstack.so ./test
  • 使用GAZELLE_THREAD_NAME指定Gazelle绑定的线程名
    同一进程中的多个线程中,仅有某个线程满足gazelle的使用条件时,可以使用GAZELLE_THREAD_NAME来指定仅由对应的线程名使用gazelle,而其他线程走内核态协议栈。
GAZELLE_BIND_PROCNAME=test GAZELLE_THREAD_NAME=test_thread LD_PRELOAD=/usr/lib64/liblstack.so ./test

6. 配置文件

  • lstack.conf用于指定lstack的启动参数,默认路径为/etc/gazelle/lstack.conf, 配置文件参数如下
选项参数格式说明
dpdk_args–socket-mem(必需)
–huge-dir(必需)
–proc-type(必需)
–legacy-mem
–map-perfect
-d
dpdk初始化参数,参考dpdk说明
–map-perfect为扩展特性,用于防止dpdk占用多余的地址空间,保证ltran有额外的地址空间分配给lstack。
-d参数加载指定so库文件
listen_shadow0/1是否使用影子fd监听。单listen线程,多协议栈线程时是能
use_ltran0/1是否使用ltran
num_cpus“0,2,4 …”lstack线程绑定的cpu编号,编号的数量为lstack线程个数(小于等于网卡多队列数量)。可按NUMA选择cpu
num_wakeup“1,3,5 …”wakeup线程绑定的cpu编号,编号的数量为wakeup线程个数,与lstack线程的数量保持一致。与numcpus选择对应NUMA的cpu。不配置则为不使用唤醒线程
low_power_mode0/1是否开启低功耗模式,暂不支持
kni_switch0/1rte_kni开关,默认为0。只有不使用ltran时才能开启
unix_prefix“string”gazelle进程间通信使用的unix socket文件前缀字符串,默认为空,和需要通信的ltran.conf的unix_prefix或gazellectl的-u参数配置一致。不能含有特殊字符,最大长度为128。
host_addr“192.168.xx.xx”协议栈的IP地址,也是应用程序的IP地址
mask_addr“255.255.xx.xx”掩码地址
gateway_addr“192.168.xx.1”网关地址
devices“aa:bb:cc:dd:ee:ff”网卡通信的mac地址,需要与ltran.conf的bond_macs配置一致
app_bind_numa0/1应用的epoll和poll线程是否绑定到协议栈所在的numa,默认值是1,即绑定
send_connect_number4设置为正整数,表示每次协议栈循环中发包处理的连接个数
read_connect_number4设置为正整数,表示每次协议栈循环中收包处理的连接个数
rpc_number4设置为正整数,表示每次协议栈循环中rpc消息处理的个数
nic_read_num128设置为正整数,表示每次协议栈循环中从网卡读取的数据包的个数
mbuf_pool_size1024000设置为小于5120000的正整数,表示初始化时申请的mbuf地址池大小,需要根据网卡硬件支持进行合理配置,配置过小会启动失败

lstack.conf示例:

dpdk_args=["--socket-mem", "2048,0,0,0", "--huge-dir", "/mnt/hugepages-lstack", "--proc-type", "primary", "--legacy-mem", "--map-perfect"]

use_ltran=1
kni_switch=0

low_power_mode=0

num_cpus="2,22"
num_wakeup="3,23"

host_addr="192.168.1.10"
mask_addr="255.255.255.0"
gateway_addr="192.168.1.1"
devices="aa:bb:cc:dd:ee:ff"

send_connect_number=4
read_connect_number=4
rpc_number=4
nic_read_num=128
mbuf_pool_size=1024000
  • ltran.conf用于指定ltran启动的参数,默认路径为/etc/gazelle/ltran.conf。使用ltran时,lstack.conf内配置use_ltran=1,配置参数如下:
选项参数格式说明
forward_kit“dpdk”指定网卡收发模块。
保留字段,目前未使用。
forward_kit_args-l
–socket-mem(必需)
–huge-dir(必需)
–proc-TYPE(必需)
–legacy-mem(必需)
–map-perfect(必需)
-d
dpdk初始化参数,参考dpdk说明。
–map-perfect为扩展特性,用于防止dpdk占用多余的地址空间,保证ltran有额外的地址空间分配给lstack。
-d参数加载指定so库文件
kni_switch0/1rte_kni开关,默认为0
unix_prefix“string”gazelle进程间通信使用的unix socket文件前缀字符串,默认为空,和需要通信的lstack.conf的unix_prefix或gazellectl的-u参数配置一致
dispatch_max_clientsnltran支持的最大client数。
lstack的协议栈线程总数不大于32
dispatch_subnet192.168.xx.xx子网掩码,表示ltran能识别的IP所在子网网段。参数为样例,子网按实际值配置。
dispatch_subnet_lengthn子网长度,表示ltran能识别的子网长度,例如length为4时,192.168.1.1-192.168.1.16
bond_modenbond模式,目前只支持Active Backup(Mode1),取值为1
bond_miimonnbond链路监控时间,单位为ms,取值范围为1到2^64 - 1 - (1000 * 1000)
bond_ports“0x01”使用的dpdk网卡,0x01表示第一块
bond_macs“aa:bb:cc:dd:ee:ff”绑定的网卡mac地址,需要跟kni的mac地址保持一致
bond_mtun最大传输单元,默认是1500,不能超过1500,最小值为68,不能低于68

ltran.conf示例:

forward_kit_args="-l 0,1 --socket-mem 1024,0,0,0 --huge-dir /mnt/hugepages-ltran --proc-type primary --legacy-mem --map-perfect --syslog daemon"
forward_kit="dpdk"

kni_switch=0

dispatch_max_clients=30
dispatch_subnet="192.168.1.0"
dispatch_subnet_length=8

bond_mode=1
bond_mtu=1500
bond_miimon=100
bond_macs="aa:bb:cc:dd:ee:ff"
bond_ports="0x1"

tcp_conn_scan_interval=10

7. 启动应用程序

  • 启动ltran进程
    单进程且网卡支持多队列,则直接使用网卡多队列分发报文到各线程,不启动ltran进程,lstack.conf的use_ltran配置为0.
    启动ltran时不使用-config-file指定配置文件,则使用默认路径/etc/gazelle/ltran.conf
ltran --config-file ./ltran.conf
  • 启动应用程序
    启动应用程序前不使用环境变量LSTACK_CONF_PATH指定配置文件,则使用默认路径/etc/gazelle/lstack.conf
export LSTACK_CONF_PATH=./lstack.conf
LD_PRELOAD=/usr/lib64/liblstack.so  GAZELLE_BIND_PROCNAME=redis-server redis-server redis.conf

8. API

Gazelle wrap应用程序POSIX接口,应用程序无需修改代码。

9. 调测命令

  • 不使用ltran模式时不支持gazellectl ltran xxx命令,以及gazellectl lstack show {ip | pid} -r命令
Usage: gazellectl [-h | help]
  or:  gazellectl ltran  {quit | show | set} [LTRAN_OPTIONS] [time] [-u UNIX_PREFIX]
  or:  gazellectl lstack {show | set} {ip | pid} [LSTACK_OPTIONS] [time] [-u UNIX_PREFIX]

  quit            ltran process exit

  where  LTRAN_OPTIONS :=
                  show ltran all statistics
  -r, rate        show ltran statistics per second
  -i, instance    show ltran instance register info
  -b, burst       show ltran NIC packet len per second
  -l, latency     show ltran latency
  set:
  loglevel        {error | info | debug} set ltran loglevel

  where  LSTACK_OPTIONS :=
                  show lstack all statistics
  -r, rate        show lstack statistics per second
  -s, snmp        show lstack snmp
  -c, connetct    show lstack connect
  -l, latency     show lstack latency
  set:
  loglevel        {error | info | debug} set lstack loglevel
  lowpower        {0 | 1} set lowpower enable
  [time]          measure latency time default 1S

-u参数指定gazelle进程间通信的unix socket前缀,和需要通信的ltran.conf或lstack.conf的unix_prefix配置一致。

抓包工具
gazelle使用的网卡由dpdk接管,因此普通的tcpdump无法抓到gazelle的数据包。作为替代,gazelle使用dpdk-tools软件包中提供的gazelle-pdump作为数据包捕获工具,它使用dpdk的多进程模式和lstack/ltran进程共享内存。在ltran模式下,gazelle-pdump只能抓取和网卡直接通信的ltran的数据包,通过tcpdump的数据包过滤,可以过滤特定lstack的数据包。 详细使用方法

线程名绑定
lstack启动时可以通过指定环境变量GAZELLE_THREAD_NAME来指定lstack绑定的线程名,在业务进程中有多个不同线程时,可以通过使用此参数来指定需要lstack接管网络接口的线程名,未指定的线程将走内核态协议栈。默认为空,即绑定进程内的所有线程。

10. 使用注意

1. dpdk配置文件的位置

如果是root用户,dpdk启动后的配置文件将会放到/var/run/dpdk目录下; 如果是非root用户,dpdk配置文件的路径将由环境变量XDG_RUNTIME_DIR决定;

  • 如果XDG_RUNTIME_DIR为空,dpdk配置文件放到/tmp/dpdk目录下;
  • 如果XDG_RUNTIME_DIR不为空,dpdk配置文件放到变量XDG_RUNTIME_DIR下;
  • 注意有些机器会默认设置XDG_RUNTIME_DIR

约束限制

使用 Gazelle 存在一些约束限制:

功能约束

  • 不支持accept阻塞模式或者connect阻塞模式。
  • 最多支持1500个TCP连接。
  • 当前仅支持TCP、ICMP、ARP、IPv4 协议。
  • 在对端ping Gazelle时,要求指定报文长度小于等于14000B。
  • 不支持使用透明大页。
  • ltran不支持使用多种类型的网卡混合组bond。
  • ltran的bond1主备模式,只支持链路层故障主备切换(例如网线断开),不支持物理层故障主备切换(例如网卡下电、拔网卡)。
  • 虚拟机网卡不支持多队列。

操作约束

  • 提供的命令行、配置文件默认root权限。非root用户使用,需先提权以及修改文件所有者。
  • 将用户态网卡绑回到内核驱动,必须先退出Gazelle。
  • 大页内存不支持在挂载点里创建子目录重新挂载。
  • ltran需要最低大页内存为1GB。
  • 每个应用实例协议栈线程最低大页内存为800MB 。
  • 仅支持64位系统。
  • 构建x86版本的Gazelle使用了-march=native选项,基于构建环境的CPU(Intel® Xeon® Gold 5118 CPU @ 2.30GHz指令集进行优化。要求运行环境CPU支持 SSE4.2、AVX、AVX2、AVX-512 指令集。
  • 最大IP分片数为10(ping 最大包长14790B),TCP协议不使用IP分片。
  • sysctl配置网卡rp_filter参数为1,否则可能不按预期使用Gazelle协议栈,而是依然使用内核协议栈。
  • 不使用ltran模式,KNI网口不可配置只支持本地通讯使用,且需要启动前配置NetworkManager不管理KNI网卡。
  • 虚拟KNI网口的IP及mac地址,需要与lstack.conf配置文件保持一致 。

注意事项

用户根据使用场景评估使用Gazelle

共享内存

  • 现状
    大页内存 mount 至 /mnt/hugepages-lstack 目录,进程初始化时在 /mnt/hugepages-lstack 目录下创建文件,每个文件对应一个大页,并 mmap 这些文件。ltran 在收到 lstask 的注册信息后,根据大页内存配置信息也 mmap 目录下文件,实现大页内存共享。 ltran 在 /mnt/hugepages-ltran 目录的大页内存同理。
  • 当前消减措施
    大页文件权限 600,只有 OWNER 用户才能访问文件,默认 root 用户,支持配置成其它用户; 大页文件有 DPDK 文件锁,不能直接写或者映射。
  • 注意
    属于同一用户的恶意进程模仿DPDK实现逻辑,通过大页文件共享大页内存,写破坏大页内存,导致Gazelle程序crash。建议用户下的进程属于同一信任域。

流量限制
Gazelle没有做流量限制,用户有能力发送最大网卡线速流量的报文到网络,可能导致网络流量拥塞。

进程仿冒
合法注册到ltran的两个lstack进程,进程A可仿冒进程B发送仿冒消息给ltran,修改ltran的转发控制信息,造成进程B通讯异常,进程B报文转发给进程A信息泄露等问题。建议lstack进程都为可信任进程。

文档捉虫

“有虫”文档片段

问题描述

提交类型 issue
有点复杂...
找人问问吧。
PR
小问题,全程线上修改...
一键搞定!
问题类型
规范和低错类

● 错别字或拼写错误;标点符号使用错误;

● 链接错误、空单元格、格式错误;

● 英文中包含中文字符;

● 界面和描述不一致,但不影响操作;

● 表述不通顺,但不影响理解;

● 版本号不匹配:如软件包名称、界面版本号;

易用性

● 关键步骤错误或缺失,无法指导用户完成任务;

● 缺少必要的前提条件、注意事项等;

● 图形、表格、文字等晦涩难懂;

● 逻辑不清晰,该分类、分项、分步骤的没有给出;

正确性

● 技术原理、功能、规格等描述和软件不一致,存在错误;

● 原理图、架构图等存在错误;

● 命令、命令参数等错误;

● 代码片段错误;

● 命令无法完成对应功能;

● 界面错误,无法指导操作;

风险提示

● 对重要数据或系统存在风险的操作,缺少安全提示;

内容合规

● 违反法律法规,涉及政治、领土主权等敏感词;

● 内容侵权;

您对文档的总体满意度

非常不满意
非常满意
提交
根据您的反馈,会自动生成issue模板。您只需点击按钮,创建issue即可。