UMS ​

1. 编程接口 ​

UMS是一种北向兼容标准socket API，南向基于UB网络进行数据传输，透明加速TCP通信的内核网络协议栈。当前UMS支持的标准socket API如下所示。

1.1 int socket(int domain, int type, int protocal); ​

创建一个socket：

1. type仅支持SOCK_STREAM，protocol仅支持IPPROTO_IP或IPPROTO_TCP
2. 在直接使用UMS的场景，需指定domain为AF_SMC，在透明替换的场景，需指定domain值为AF_INET或AF_INET6，两种场景详情见UMS使用手册。

1.2 ssize_t send(int sockfd, const void *buf, size_t len, int flags); ​

通过socket fd发送数据

1.3 ssize_t recv(int sockfd, void *buf, size_t len, int flags); ​

通过socket fd接收数据

1.4 ssize_t write(int fd, const void *buf, size_t count); ​

通过socket fd发送消息。

1.5 ssize_t read(int fd, void *buf, size_t count); ​

通过socket fd接收消息。

1.6 int connect(int socket, const struct sockaddr *addr, socklen_t addrlen); ​

与对端server建立tcp连接。

1.7 int bind(int sockfd, const struct sockaddr *addr, socklen_t addrlen); ​

将本地地址与socket fd绑定。

1.8 int listen(int sockfd, int backlog); ​

将socket转换成可以接收连接的server端socket。

1.9 int accept(int listenfd, struct sockaddr *addr, int *addrlen); ​

接收client端的连接。

1.10 int shutdown(int sockfd, int howto); ​

断开socket部分数据传输通道。

1.11 int close(int fd); ​

关闭socket连接。

1.12 int setsockopt(int sockfd, int level, int optname, const void *optval, socklen_t optlen); ​

设置与套接字相关的参数，目前并不支持所有socket选项，选项支持情况如下表:

1.13 int getsockopt(int sockfd, int level, int optname, void *optval, socklen_t *optlen); ​

获取与套接字相关的参数。

2. 服务接口 ​

2.1 UMS proc接口 ​

UMS支持使用proc file system输出当前系统中的链接状态，IPV4类型的连接，使用方式为：

cat /proc/net/ums

支持输出的状态项见下表：

IPV6类型的连接，使用方式为：

cat /proc/net/ums6

支持输出的状态项见下表:

2.2 UMS sysctl接口 ​

UMS支持使用sysctl接口配置部分属性。使用方法包括:
查询

cat /proc/sys/net/ums/[属性名]
# or
sysctl net.ums.[属性名]

配置

echo [值] > /proc/sys/net/ums/[属性名]
# or
sysctl -w net.ums.[属性名]=[值]

支持的属性名和配置值范围见下表:

注意

1. 聚合大小实际使用时不会超过发送缓冲区的一半。如果配置过大，该字段的配置不会生效，会直接使用发送缓冲区的一半的值作为实际聚合大小。
2. 建议用户根据需求在模块挂载后进行配置，配置后生效一次。

2.3 UMS 运行时模块参数 ​

UMS 内核模块参数的语义、取值与加载时配置详见 UMS User Guide - 3.4 内核模块参数配置，本节仅说明运行时访问方式。

仅加载时指定的参数（权限 0）

以下参数在 UMS 内核模块加载运行后不可读写，只能在模块加载时指定（通过 insmod/modprobe 命令传参，或写入 /etc/modprobe.d/ums.conf）：

如需查看加载后实际生效的 token 模式，可通过内核日志确认：模块加载时会打印 ub_token_mode=SECURE/LEGACY/DISABLE(<值>)。

dmesg | grep "UMS_" | grep "ub_token_mode="

可读写参数（权限 0644）

以下参数指定允许注册为 ums_agent 的进程 UID/GID（仅 ub_token_mode=0 即 SECURE 模式下生效）。可通过 /sys/module/ums/parameters/<参数名> 查询与修改：

# 查询
cat /sys/module/ums/parameters/ums_agent_uid
cat /sys/module/ums/parameters/ums_agent_gid

# 修改（仅 ums_agent 离线时可修改，ums_agent 在线时写入返回 -EBUSY）
echo <UID> > /sys/module/ums/parameters/ums_agent_uid
echo <GID> > /sys/module/ums/parameters/ums_agent_gid