11 Star 30 Fork 16

anolis / libxudp

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

Express UDP

Express UDP 是基于 XDP Socket 实现的 UDP 通信软件库.

收包

基于 XDP 在网卡驱动层对包进行过滤, 把指定 ip:port 的 udp 包传递给 XSK, 应用层 Express UDP 从 XSK 中收包。

发包

Express UDP 传递包给 XSK, XSK 把包构建 skb 并放入网卡队列中进行发包。XSK ZEROCOPY 模式下可以跳过构建 skb 的过程直接把包传递给网卡, 这样性能会更好。

构建与安装

yum install libnl3-devel elfutils-libelf-devel clang llvm libcap-devel
make

所有的输出在 objs 目录下面。 同时输出有 libxudp.a 和 libxudp.so 文件以及头文件 xudp.h。

体验一下

tools/xudp_echo_server.c 是一个简单的 echo 服务实现。编译后的文件在在 objs 下面, 命令格式:

./xudp-echo-server <ip> <port>

ip 为要 bind 的本地地址, 如果使用 0.0.0.0 会监听所有的网卡, 详细后面还会介绍。 启动之后可以使用如下命令进行测试:

nc -u <ip> <port>

发送 udp 消息给服务端, server 会打印消息并 echo 给客户端。

更多实践信息可见: 阿里云实践

bind

这个过程主要是把 ebpf 与网卡进行绑定, 并且创建 xsk 再与和 ebpf 进行绑定。

注意, 一些网卡并不支持 xdp 如 lo, 所以目前 xudp 不能工作于这些网卡。

指定 ip 绑定

bind 过程中, Express UDP 会过滤所有的网卡, 对所有的符合 ip 指定的网卡都进行 bind 操作. 比如 0.0.0.0, xudp 会尝试 bind 所有的非 lo 网卡, 如果有一个网卡 bind 失败, 整个操作都视为失败。 bind 可以指定多个 struct sockaddr, 由参数 num 控制, 目前最多只支持 10 个。

int xudp_bind(xudp *x, struct sockaddr *a, socklen_t addrlen, int num);

多线程与多进程

由于现在一般网卡都是支持多队列的, 最好可以使用多线程或多进程进程编程。 recv/send 分别有两个接口, 默认情况下会轮询地对 channel 进行 recv/send 操作。带有 channel 后缀的接口, 只对指定的 channel 进行 recv/send 操作。

多线程或多进程的情况下, 一个线程或进程操作一个 channel, 会获得比较好的性能。

epoll/poll/select

每一个 channel 可以基于 xudp_channel_getfd 获得对应的 xsk 的 fd, 这个 fd 支持epoll 操作, 可以用于 epoll/poll/select 对读写事件进行监听。

tools/xudp_echo_server.c 代码里有 epoll 的例子。

查看 XDP 的情况

新的版本的 iproute 可以直接查看, 配置网卡的 XDP. 笔者本地 iproute2-ss170501 已经支持这个功能了.

如果网卡有配置 xdp, 在 ip link 输出中有显示 xdp 字样。

命令 ip link set <dev> xdp off 可以关闭指定网卡的 XDP.

路由

目前 libxudp 已经支持路由, 也就是 client 和 server 可以不在同个网段, 也可以工作 于公网了。

Express UDP 在启动的时候获取本机的路由, 并保存在内存里面, 目前并不支持的路由修改和 同步。

路由的查找基于 hash 实现, 速度很快, 但是代价是要占用多一些内存空间。

ARP

目前有一个简陋的 ARP 实现, 由于阿里云有 ARP Proxy 支持, 所以打开 libxudp noarp 选项可以正常工作于阿里云, 并且没有 arp 的相关开销。

目前推荐在阿里云上打开 noarp 选项使用。

木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件” 是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献” 是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者” 是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体” 是指提交贡献的机构及其“关联实体”。 “关联实体” 是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) 2021 Alibaba Group Holding Limited Express UDP is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; Create a file named "LICENSE" which contains the whole context of this License in the first directory of your software package; Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) 2021 Alibaba Group Holding Limited Express UDP is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

Express UDP 是基于 XDP Socket 实现的 UDP 通信软件库. 展开 收起
C 等 4 种语言
MulanPSL-2.0
取消

发行版 (4)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/anolis/libxudp.git
git@gitee.com:anolis/libxudp.git
anolis
libxudp
libxudp
master

搜索帮助

14c37bed 8189591 565d56ea 8189591