共享内存通信（SMC）常见问题

启用SMC后应用性能对比TCP没有提升

问题描述

使用SMC加速应用TCP连接之后，应用的性能与直接使用TCP对比并没有提升。

问题原因及解决方案

• 由于某些原因，导致应用创建的SMC连接回退到TCP，此时无法使用RDMA加速网络通信。详细的回退排查和解决方法，请参见启用SMC后回退无法使用RDMA加速。

• 应用的网络通信开销在整个应用中占比较小。例如应用是倾向于CPU密集型，网络通信在应用中占比较低。

• 应用的网络通信模型不适用SMC。例如：

  • 频繁建立、销毁连接（短连接）的场景。SMC创建连接涉及到RDMA资源创建和申请等慢速路径，根据不同应用短连接的占比，性能对比TCP可能没有收益。

  • 资源受限的场景。SMC通信所使用的资源受限于机器内存和eRDMA网卡规格，资源不足可能导致SMC回退到TCP。更多信息，请参见共享内存通信（SMC）使用说明。

启用SMC后无法正常通信

问题描述

使用Alibaba Cloud Linux 3开启SMC之后，访问某些地址（例如某些公网服务）不通，但是可以ping通。关闭SMC之后恢复正常。

问题原因

某些服务器实现上没有严格准守TCP规范，在处理TCP options时，可能重放TCP options，导致SMC协议识别出现问题。

如果用于表征支持SMC的TCP option被重放，就会使得本端误认为对端服务具备SMC能力，引起握手错误，导致请求（例如curl）失败，而ping（ICMP协议）成功的现象。

您可以通过check_tcpoption_replay.py工具诊断此类问题：

from scapy.all import *
import time
import argparse

# Set up command line arguments
parser = argparse.ArgumentParser(description='Check if the server replays with the same TCP option.')
parser.add_argument('-i', '--ip', required=True, help='Target IP address')
parser.add_argument('-p', '--port', required=True, type=int, help='Target port number')
parser.add_argument('-v', '--verbose', action='store_true', help='Print verbose output')
args = parser.parse_args()

# Target IP and port
target_ip = args.ip  # Get target IP from command line arguments
target_port = args.port  # Get target port from command line arguments
verbose = args.verbose  # Get verbose flag from command line arguments

# Create a TCP SYN packet that includes a special TCP Option
ip = IP(dst=target_ip)
syn = TCP(sport=RandShort(), dport=target_port, flags='S', options=[(254, b'xxxx')])
syn_ack_pkt = sr1(ip/syn, timeout=1, verbose=verbose)

# Check if the returned packet is a TCP SYN-ACK
if syn_ack_pkt and TCP in syn_ack_pkt and syn_ack_pkt[TCP].flags & 18:  # SYN-ACK flags
    # Check for the special TCP Option
    if any(opt[0] == 254 and opt[1] == b'xxxx' for opt in syn_ack_pkt[TCP].options):
        print("The server has replayed the TCP option")
    else:
        print("The server did not replay the TCP option")
else:
    print("Failed to receive SYN-ACK, please make sure the IP and port are correct")
    sys.exit(1)

# Complete the TCP handshake
if syn_ack_pkt:
    ack = TCP(sport=syn_ack_pkt[TCP].dport, dport=target_port, flags='A', seq=syn_ack_pkt[TCP].ack, ack=syn_ack_pkt[TCP].seq + 1)
    send(ip/ack, verbose=verbose)

# Wait for 1 second before disconnecting
time.sleep(1)

# Send TCP FIN to close the connection
if syn_ack_pkt:
    fin = TCP(sport=syn_ack_pkt[TCP].dport, dport=target_port, flags='FA', seq=syn_ack_pkt[TCP].ack, ack=syn_ack_pkt[TCP].seq + 1)
    last_ack_pkt = sr1(ip/fin, timeout=1, verbose=verbose)

# Complete the four-way handshake
if last_ack_pkt and TCP in last_ack_pkt and last_ack_pkt[TCP].flags & 16:  # ACK flag
    last_ack = TCP(sport=syn_ack_pkt[TCP].dport, dport=target_port, flags='A', seq=last_ack_pkt[TCP].ack, ack=last_ack_pkt[TCP].seq + 1)
    send(ip/last_ack, verbose=verbose)

1. 安装Python 3和scapy库。

   yum install python3 -y
   python3 -m pip install scapy

2. 运行check_tcpoption_replay.py工具。

   python3 check_tcpoption_replay.py -i <服务端IP> -p <服务端port>

   如果服务端存在重放问题则输出The server has replayed the TCP option，否则输出The server did not replay the TCP option。

解决方案

对于重放SMC TCP option的非预期现象，由于是网络中间节点或对端的错误行为，无法从根本上避免，建议避免在访问这类服务时使用SMC。

通过smc_run启用SMC无效

问题描述

根据 共享内存通信（SMC）使用说明通过smc_run ./foo在应用程序维度启用SMC后，使用smcr l观察发现没有成功创建的link group，使用smcss -a也看不到连接或是看到一侧连接出现回退。

问题原因

smc_run透明启用SMC的原理是通过LD_PRELOAD将smc-tools中提供的动态链接库优先于其他库之前加载，在优先加载的动态链接库的socket(2)中对socket的family和protocol进行修改。因此，若应用程序并非通过动态方式链接（如静态链接），则smc_run无法成功透明启用SMC。

解决方案

根据共享内存通信（SMC）使用说明提供的sysctl net.smc.tcp2smc启用SMC。

启用SMC后导致部分端口不可用

问题描述

加载SMC后，65500后的16个端口（即65500～65515）不可用，bind(2)这些端口会导致返回EADDRINUSE。

问题原因

由于SMC-R+eRDMA实现方式的特殊性，SMC模块将会占用ERI所在net namespace下65500开始的16个端口作为OOB建连的预留端口，在dmesg中可以查看到如下提示信息：

smc: smc: load SMC module with reserve_mode
NET: Registered protocol family 43
smc: netns <netns ID> reserved ports [65500 ~ 65515] for eRDMA OOB
smc: adding ib device erdma_0 with port count 1
smc: ib device erdma_0 port 1 has pnetid

如果端口占用失败则SMC模块无法使用eRDMA设备。

解决方案

卸载SMC模块后将会释放这些端口。卸载方法请参见使用说明。

启用SMC后回退无法使用RDMA加速

问题描述

启用SMC并替换应用的TCP连接，此时运行smcss -a命令可以看到建立的连接已经自动回退（fallback）到TCP。

问题原因

SMC建立连接时，如果发生异常会自动回退到TCP连接，此时SMC连接仍然可以正常通信，但是无法享受RDMA带来的性能提升。SMC发生回退时会提供回退原因编号，根据回退编号可以帮助分析和定位问题。

解决方案

1. 运行smcss -a命令，查看SMC连接的回退编号。

   返回结果示例：

   State          UID   Inode   Local Address           Peer Address            Intf Mode
   ACTIVE         00000 0156721 192.168.99.21:60188     192.168.99.22:8090      0000 TCP 0x03010000
   ACTIVE         00000 1202539 172.16.4.189:44780      172.16.4.190:1811       0000 SMCR

   其中第一条记录Mode列为TCP，意味着该SMC连接回退到TCP，同时回退编号为0x03010000。第二条记录Mode列为SMCR，则说明已经正常建立SMC-R连接。如果Mode列显示的回退编号为两个（例如0x05000000/0x03030001），其中第一个回退编号为本地的回退原因，第二个回退编号为对端的回退原因，通常是由于对端回退导致了本机无法正常建立SMC连接而回退。

2. 根据回退编号，从下表中查看可能的原因和解决方案。

   启用SMC后回退无法使用RDMA加速的原因和解决方案

   回退原因编号	说明	可能原因和解决方案
   0x01010000	机器内存不足，导致资源创建失败。	原因：机器的空余内存不足，不足以创建SMC建立连接所需要的数据结构和读写内存。 解决方案：释放机器的内存，例如停止不必要的进程。
   0x02010000	通过CLC或者LLC握手时，等待RDMA链路确认超时。	原因1：RDMA网卡或者链路发生故障，导致LLC连接（通过RDMA链路通信）消息回复超时。 解决方案1：确认RDMA网卡的状态是否正常。 原因2：以太网卡或者TCP/IP网络发生故障或者异常，导致CLC连接（通过TCP连接通信）消息回复超时。 解决方案2：确认以太网卡的状态是否正常。
   0x02020000	通过LLC创建link超时。	预留字段，当前未使用。
   0x03000000	配置错误，无法获取正确的IP地址。	原因：建立连接时，构建proposal时获取CLC socket对应的IP地址失败。 解决方案：检查当前CLC连接（基于TCP协议）和所对应的设备是否正常后重试。
   0x03010000	对端不支持或未使用SMC。	原因：如果支持SMC协议，将会在建立连接时的CLC连接（基于TCP协议）的SYN（客户端）或SYNACK（服务端）报文头中携带SMC TCP option标志位。 解决方案：检测本地或者对端是否已将应用的协议栈替换为SMC，通过 smcss命令（smc-tools包提供）可查看当前SMC的连接状态。如果没有找到应用的连接和端口，请重新替换为SMC并创建新的连接。
   0x03020000	不支持IPSec。	原因：替换的连接使用IPSec，但是当前SMC并不支持IPSec。 解决方案：不使用IPSec。
   0x03030000	未找到可用的SMC-D或SMC-R设备。	原因1：SMC建立连接使用时，未找到可用的SMC-R（RDMA）设备。 解决方案1：执行smcr d命令，检查当前是否有SMC-R（RDMA）设备。如果没有返回任何设备，在使用阿里云eRDMA的场景下，请检查ECS控制台是否正确配置ERI设备，并确保操作系统中正确安装ERI的驱动。 原因2：在多以太网卡环境中，连接所用的以太网卡不具备ERI功能，无法找到eRDMA设备。 解决方案2：通过ibv_devinfo命令查看eRDMA设备的node_guid，再通过ip addr命令查看以太网卡的MAC地址，对比两者确认连接所用的以太网设备具备ERI eRDMA功能。 原因3：如果启用RDMA设备的独占模式，SMC只会在当前创建socket的net namespace中寻找RDMA设备。 解决方案3：执行rdma system命令，如果返回的结果中包含netns exclusive则说明为独占模式。如果需要在某个netns中使用该RDMA设备，请执行命令rdma dev set <RDMA 设备名> netns <NETNS 名>，将RDMA设备移至该netns。如果RDMA设备为RoCE和iWARP，请将所需的以太网设备也一并移动到该netns。 原因4：使用eRDMA设备时，客户端尝试将AF_INET6连接替换为SMC连接。 解决方案4：eRDMA设备只能配合SMCv2协议使用，而SMCv2协议目前不支持替换AF_INET6协议族连接，因此回退到TCP。此时请将应用程序切换为AF_INET协议族。
   0x03030001	未找到可用的SMC-D设备。	当前云场景暂未提供可用的SMC-D设备，如出现该错误请联系阿里云技术支持。
   0x03030002	未找到可用的SMC-R设备。	原因1：SMC创建连接过程中，已经选中的RDMA设备失效。 解决方案1：执行smcr d命令，检查当前系统中是否有可用的 SMC-R（RDMA）设备，如果所需的RDMA设备为阿里云eRDMA设备，请确保该ERI设备已经在ECS控制台中添加并正确安装和配置ERI驱动。 原因2：在多以太网卡环境中，连接所用的以太网卡不具备ERI功能，无法找到eRDMA设备。 解决方案2：通过ibv_devinfo命令查看eRDMA设备的node_guid，再通过ip addr命令查看以太网卡的MAC地址，对比两者确认连接所用的以太网设备具备ERI eRDMA功能。 原因3：如果启用RDMA设备的独占模式，SMC只会在当前创建socket的net namespace中寻找RDMA设备。 解决方案3：执行rdma system命令，如果返回的结果中包含netns exclusive则说明为独占模式。如果需要在某个netns中使用该RDMA设备，请执行命令rdma dev set <RDMA 设备名> netns <NETNS 名>，将RDMA设备移至该netns。如果RDMA设备为RoCE和iWARP，请将所需的以太网设备也一并移动到该netns。
   0x03030003	SMC-D设备不支持ISMv2协议。	当前云场景暂未提供可用的SMC-D设备，如出现该错误请联系阿里云技术支持。
   0x03030004	对端不支持SMCv2协议的拓展。	原因：本地启用了SMC v2协议，但对端不支持SMC v2协议。SMC协议栈通过底层设备能力自动选择使用SMC v1或SMC v2协议。在使用阿里云eRDMA和RoCE v2的场景下，将使用SMC v2协议。 解决方案：保证通信两端所有RDMA设备类型相同，则两端SMC协议版本相同。可通过smcr d查看SMC-R所用设备，在type一栏中可以看到设备类型，如RoCE_Express、RoCE_Express2、或0x107f（即阿里云eRDMA）。
   0x03030005	对端不支持SMC-Dv2协议的拓展。	当前云场景暂未提供可用的SMC-D设备，如出现该错误请联系阿里云技术支持。
   0x03030006	对端缺失SEID。	预留字段，当前未使用。
   0x03030007	未找到可用的SMC-D v2设备。	当前云场景暂未提供可用的SMC-D设备，如出现该错误请联系阿里云技术支持。
   0x03030008	对端缺少UEID。	原因：启用了SMC v2协议，但没有设置UEID。 解决方案：在两侧通过smc-tools设置相同的UEID，指令为smcr ueid {show | add | del}。
   0x03030009	本地和对端协商SMC版本失败。	原因：两侧协商SMC版本的结果在CLC握手过程中发生变化。 解决方案：确认两端OS发行版一致。
   0x0303000a	LGR可容纳连接数量协商失败。	原因：SMCv2.1支持两端协商LGR可容纳连接数量。若协商结果不可接受，如连接数量为0或超过本地最大支持值，出现该回退。 解决方案：确认两端OS发行版一致。
   0x0303000b	LGR可容纳link数量协商失败。	原因：SMCv2.1支持两端协商LGR可容纳link数量。若协商结果不可接受，如link数量为0或超过本地最大支持值，出现该回退。 解决方案：确认两端OS发行版一致。
   0x0303000c	本地与对端协商SMC vendor特性失败。	原因：两侧协商SMC vendor特性的结果在CLC握手过程中发生变化。 解决方案：首先确认两端OS发行版一致；其次通过uname -r命令确认内核版本，若内核版本为5.10.134-015，则确保在建连过程中不要主动修改sysctl net.smc.vendor_exp_options的值，若内核版本大于等于5.10.134-016，则确保在建连过程中不要主动修改sysctl net.smc.experiment_vendor_options的值。
   0x03040000	本地和对端的SMC设备模式不匹配 （SMC-D 或 SMC-R）。	当前云场景暂未提供可用的SMC-D设备，如出现该错误请联系阿里云技术支持。
   0x03050000	对端RMBE中包含eyecatcher非法字段。	预留字段，Linux实现中未使用。
   0x03060000	连接使用了不支持MSG_FASTOPEN。	原因：SMC暂不支持MSG_FASTOPEN选项。 解决方案：创建socket时移除MSG_FASTOPEN选项。
   0x03070000	本地和对端的IP前缀/子网不匹配。	原因：所用RDMA设备是RoCEv1设备时，SMC自动使用SMCv1协议。SMCv1仅支持子网内通信。当两侧不在同一子网内时，将出现该回退。 解决方案：若所用RDMA设备为RoCEv1，则确保通信两侧处在同一子网内；若所用RDMA设备为阿里云eRDMA，则SMC默认使用SMCv2协议，不会有子网限制与相关回退。
   0x03080000	获取设备VLAN ID失败。	原因：创建连接时，SMC会尝试获取socket对应设备的VLAN ID。 解决方案：检查该五元组创建的TCP连接和对应的以太网设备是否正常。
   0x03090000	ISM设备注册VLAN ID失败。	当前云场景暂未提供可用的SMC-D设备，如出现该错误请联系阿里云技术支持。
   0x030a0000	LGR中无可用SMC-R RDMA链路。	原因：创建连接时，将会为每一个连接指定一个该连接所属LGR的link，如果没有可用的link，则无法使用RDMA加速。 解决方案：执行smcr d命令，检查ECS的RDMA卡是否正常。如果所需的RDMA设备为阿里云eRDMA设备，请确保该ERI设备已经在ECS控制台中添加并正确安装和配置ERI驱动。
   0x030b0000	客户端找不到服务端提供的RDMA链路。	原因：客户端创建连接时，根据服务端提供的QPN、GID和MAC等信息寻找对应的link并创建连接，如果找不到正确的RDMA link则无法使用RDMA加速。 解决方案：执行smcr d命令，检查ECS的RDMA卡是否正常。如果所需的RDMA设备为阿里云eRDMA设备，请确保该ERI设备已经在ECS控制台中添加并正确安装和配置ERI驱动。
   0x030c0000	协商SMC版本失败。	原因：通信两端SMC版本协商结果超出可接受范围。 解决方案：确认两端OS发行版一致。
   0x030d0000	SMC-D DMB数量超越上限。	当前云场景暂未提供可用的SMC-D设备，如出现该错误请联系阿里云技术支持。
   0x030e0000	SMC-R v2连接对端不可达。	原因：建连过程中，SMCv2协议中，客户端需要根据服务端提供的地址寻找正确的路由信息，当前无法根据本地和远端IP地址找到对应的路由项。 解决方案：检查该五元组创建的TCP连接和对应的以太网设备是否正常、可达，例如系统的以太网卡、IP配置和路由项配置等。
   0x030f0000	SMC-R v2连接非直连标志位设置错误。	原因：建连过程中，SMCv2 协议中，客户端根据服务器设置的gateway标志位判断是否经过网关，但是根据本地和远端IP查到的路由项指出并没有经过网关，二者不一致。 解决方案：检查该五元组创建的TCP连接和对应的以太网设备是否正常、可达，是否经过相同的网络路径，例如系统的以太网卡、IP配置和路由项配置等。
   0x04000000	服务端和客户端复用LGR错误。	原因：建连过程中，服务端复用LGR，但是客户端想要创建LGR，二者行为错误。 解决方案：执行smcr d命令，检查ECS的RDMA卡是否正常。如果所需的RDMA设备为阿里云eRDMA设备，请确保该ERI设备已经在ECS控制台中添加并正确安装和配置ERI驱动。
   0x05000000	握手过程中对端拒绝。	原因：建立连接过程中，对端回复的CLC消息拒绝建立RDMA连接。 解决方案：执行smcss命令，根据五元组信息找到对应的连接，并找到回退原因，包含本地和对端回退原因，根据对端回退编号确定具体原因。
   0x09990000	RDMA相关资源创建错误。	原因：RDMA资源创建、初始化失败。 解决方案：通过RDMA监控工具查看资源申请失败统计。若所用设备为阿里云eRDMA设备，可以使用eadm stat查看错误统计。
   0x09990001	RDMA rtoken增加失败。	SMC协议栈错误，如出现该错误请联系阿里云技术支持。
   0x09990002	初始化RDMA QP资源失败。	原因：建立连接时，如果需要创建新的link（对应为一个RDMA QP）资源，SMC会依次调用IB verbs接口初始化并修改RDMA QP，而在此过程中发生异常。 解决方案：执行smcr d命令，检查当前是否有SMC-R（RDMA）设备。如果使用阿里云eRDMA，请检查ECS控制台是否正确配置ERI设备，并确保操作系统中正确安装ERI的驱动。
   0x09990003	RDMA内存注册（MR）失败。	原因：使用RDMA通信时，需要注册内存区域用以RDMA网卡访问和写入数据，如果使用的MR数量或者大小超过了RDMA设备的规格，则会报错。 解决方案：执行smcr d命令，找到SMC所使用的RDMA设备名。再执行ibv_devinfo -d <RDMA 设备名> -v | grep max_mr，其中 max_mr为RDMA设备支持的最多MR数量，max_mr_size为 RDMA设备支持的最大MR大小；通常情况下为MR的数量达到瓶颈，此时请减少SMC的连接数量。
   0x09990004	SMC流控所需的credit初始化失败。	原因：RDMA网卡或者链路发生故障，导致credit通告消息（通过RDMA链路通信）发送失败。 解决方案：确认RDMA网卡的状态是否正常。

启用SMC后常见网络运维工具的数据与预期不符

问题描述

使用Alibaba Cloud Linux 3开启SMC-R之后，常见的网络分析工具tcpdump、Wireshark等，网络监控工具ss（Socket Statistics）、netstat等，观察到的网络流量与预期不符或无法观察到预期流量。

问题原因

这是因为SMC-R是基于RDMA的网络通信技术，目前常见的网络运维工具只能分析或监控TCP流量，无法识别RDMA的网络数据报文。这会导致实际的网络数据和网络运维工具中显示的数据不匹配。

解决方案

可以尝试使用RDMA相关的运维工具进行数据分析或监控。更多信息，请参见监测和诊断eRDMA。

在GPU或SCC实例上加载SMC模块不可用

问题描述

在GPU或SCC实例上加载SMC模块，模块不可用。

问题原因

这类实例中安装了Mellanox厂商版本OFED驱动，默认加载的是OFED中的SMC模块，不具备实际功能。且由于安装Mellanox OFED驱动后RDMA相关函数的符号发生变化，加载内核自带的SMC模块会出现Unknow symbol错误而无法加载成功。

解决方案

目前Alibaba Cloud Linux 3 SMC模块不支持在GPU或SCC等实例中使用。

启用SMC后setsockopt/getsockopt部分SOL_SOCKET或SOL_TCP层选项效果与预期不符

问题描述

启用SMC并替换应用的TCP连接后，原本作用于TCP连接的部分SOL_SOCKET或SOL_TCP层选项通过setsockopt或getsockopt设置失败，或设置成功但无法起到预期效果。

问题原因

使用SMC替换TCP协议栈后，数据路径上基于共享内存完成通信，协议栈设计和数据传递方式都与TCP有着很大的不同。因此，部分SOL_SOCKET或SOL_TCP层选项不再适用。

解决方案

对照下表查看Alibaba Cloud Linux 3中SMC对SOL_SOCKET或SOL_TCP层选项的支持情况。

SMC对SOL_SOCKET或SOL_TCP层选项的支持情况可以分为以下3种类型：

• Y：支持，设置/获取选项返回成功，并且能够达到预期效果。

• M：不支持，设置/获取返回成功，但由于SMC与TCP设计的不同，无法达到预期效果。

• N：不支持，设置/获取返回失败，回退到TCP（回退原因编号：0x03060000或0x03010001）。