kcp/README.md
2024-11-30 15:30:24 +00:00

20 KiB
Raw Permalink Blame History

KCP - A Fast and Reliable ARQ Protocol

Powered GitHub license Backers on Open Collective Sponsors on Open Collective

README in English

简介

KCP是一个快速可靠协议能以比 TCP 浪费 10%-20% 的带宽的代价,换取平均延迟降低 30%-40%且最大延迟降低三倍的传输效果。纯算法实现并不负责底层协议如UDP的收发需要使用者自己定义下层数据包的发送方式以 callback的方式提供给 KCP。 连时钟都需要外部传递进来,内部不会有任何一次系统调用。

整个协议只有 ikcp.h, ikcp.c两个源文件可以方便的集成到用户自己的协议栈中。也许你实现了一个P2P或者某个基于 UDP的协议而缺乏一套完善的ARQ可靠协议实现那么简单的拷贝这两个文件到现有项目中稍微编写两行代码即可使用。

技术特性

TCP是为流量设计的每秒内可以传输多少KB的数据讲究的是充分利用带宽。而 KCP是为流速设计的单个数据包从一端发送到一端需要多少时间以10%-20%带宽浪费的代价换取了比 TCP快30%-40%的传输速度。TCP信道是一条流速很慢但每秒流量很大的大运河而KCP是水流湍急的小激流。KCP有正常模式和快速模式两种通过以下策略达到提高流速的结果

RTO翻倍vs不翻倍

TCP超时计算是RTOx2这样连续丢三次包就变成RTOx8了十分恐怖而KCP启动快速模式后不x2只是x1.5实验证明1.5这个值相对比较好),提高了传输速度。

选择性重传 vs 全部重传:

TCP丢包时会全部重传从丢的那个包开始以后的数据KCP是选择性重传只重传真正丢失的数据包。

快速重传:

发送端发送了1,2,3,4,5几个包然后收到远端的ACK: 1, 3, 4, 5当收到ACK3时KCP知道2被跳过1次收到ACK4时知道2被跳过了2次此时可以认为2号丢失不用等超时直接重传2号包大大改善了丢包时的传输速度。

延迟ACK vs 非延迟ACK

TCP为了充分利用带宽延迟发送ACKNODELAY都没用这样超时计算会算出较大 RTT时间延长了丢包时的判断过程。KCP的ACK是否延迟发送可以调节。

UNA vs ACK+UNA

ARQ模型响应有两种UNA此编号前所有包已收到如TCP和ACK该编号包已收到光用UNA将导致全部重传光用ACK则丢失成本太高以往协议都是二选其一而 KCP协议中除去单独的 ACK包外所有包都有UNA信息。

非退让流控:

KCP正常模式同TCP一样使用公平退让法则即发送窗口大小由发送缓存大小、接收端剩余接收缓存大小、丢包退让及慢启动这四要素决定。但传送及时性要求很高的小数据时可选择通过配置跳过后两步仅用前两项来控制发送频率。以牺牲部分公平性及带宽利用率之代价换取了开着BT都能流畅传输的效果。

快速安装

您可以使用vcpkg库管理器下载并安装kcp:

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
./vcpkg install kcp

vcpkg中的kcp库由Microsoft团队成员和社区贡献者保持最新状态。如果版本过时请在vcpkg存储库上创建issue或提出PR

基本使用

  1. 创建 KCP对象

    // 初始化 kcp对象conv为一个表示会话编号的整数和tcp的 conv一样通信双
    // 方需保证 conv相同相互的数据包才能够被认可user是一个给回调函数的指针
    ikcpcb *kcp = ikcp_create(conv, user);
    
  2. 设置回调函数:

    // KCP的下层协议输出函数KCP需要发送数据时会调用它
    // buf/len 表示缓存和长度
    // user指针为 kcp对象创建时传入的值用于区别多个 KCP对象
    int udp_output(const char *buf, int len, ikcpcb *kcp, void *user)
    {
      ....
    }
    // 设置回调函数
    kcp->output = udp_output;
    
  3. 循环调用 update

    // 以一定频率调用 ikcp_update来更新 kcp状态并且传入当前时钟毫秒单位
    // 如 10ms调用一次或用 ikcp_check确定下次调用 update的时间不必每次调用
    ikcp_update(kcp, millisec);
    
  4. 输入一个下层数据包:

    // 收到一个下层数据包比如UDP包时需要调用
    ikcp_input(kcp, received_udp_packet, received_udp_size);
    

    处理了下层协议的输出/输入后 KCP协议就可以正常工作了使用 ikcp_send 来向 远端发送数据。而另一端使用 ikcp_recv(kcp, ptr, size)来接收数据。

协议配置

协议默认模式是一个标准的 ARQ需要通过配置打开各项加速开关

  1. 工作模式:

    int ikcp_nodelay(ikcpcb *kcp, int nodelay, int interval, int resend, int nc)
    
    • nodelay :是否启用 nodelay模式0不启用1启用。
    • interval :协议内部工作的 interval单位毫秒比如 10ms或者 20ms
    • resend 快速重传模式默认0关闭可以设置22次ACK跨越将会直接重传
    • nc 是否关闭流控默认是0代表不关闭1代表关闭。
    • 普通模式: ikcp_nodelay(kcp, 0, 40, 0, 0);
    • 极速模式: ikcp_nodelay(kcp, 1, 10, 2, 1);
  2. 最大窗口:

    int ikcp_wndsize(ikcpcb *kcp, int sndwnd, int rcvwnd);
    

    该调用将会设置协议的最大发送窗口和最大接收窗口大小默认为32. 这个可以理解为 TCP的 SND_BUF 和 RCV_BUF只不过单位不一样 SND/RCV_BUF 单位是字节,这个单位是包。

  3. 最大传输单元:

    纯算法协议并不负责探测 MTU默认 mtu是1400字节可以使用ikcp_setmtu来设置该值。该值将会影响数据包归并及分片时候的最大传输单元。

  4. 最小RTO

    不管是 TCP还是 KCP计算 RTO时都有最小 RTO的限制即便计算出来RTO为40ms由于默认的 RTO是100ms协议只有在100ms后才能检测到丢包快速模式下为30ms可以手动更改该值

    kcp->rx_minrto = 10;
    

文档索引

协议的使用和配置都是很简单的,大部分情况看完上面的内容基本可以使用了。如果你需要进一步进行精细的控制,比如改变 KCP的内存分配器或者你需要更有效的大规模调度 KCP链接比如 3500个以上或者如何更好的同 TCP结合那么可以继续延伸阅读

开源案例

  • kcptun: 基于 kcp-go做的高速远程端口转发(隧道) 配合ssh -D可以比 shadowsocks 更流畅的看在线视频。
  • dog-tunnel: GO开发的网络隧道使用 KCP极大的改进了传输速度并移植了一份 GO版本 KCP
  • v2ray: 著名代理软件Shadowsocks 代替者1.17后集成了 kcp协议使用UDP传输无数据包特征。
  • HP-Socket: 高性能网络通信框架 HP-Socket。
  • frp: 高性能内网穿透的反向代理软件,可将将内网服务暴露映射到外网服务器。
  • asio-kcp: 使用 KCP的完整 UDP网络库完整实现了基于 UDP的链接状态管理会话控制KCP协议调度等
  • kcp-java: Java版本 KCP协议实现。
  • kcp-netty: kcp的Java语言实现基于netty。
  • java-kcp: JAVA版本KCP,基于netty实现(包含fec功能)
  • csharp-kcp: csharp版本KCP,基于dotNetty实现(包含fec功能)
  • kcp-cpp: KCP 的多平台Windows、MacOS、LinuxC++ 实现作为应用程序中的简单库。包含适用于所有平台的套接字处理和辅助函数。
  • kcp-perl: kcp的Perl实现其是面向对象的Perl-Like的。
  • kcp-go: 高安全性的kcp的 GO语言实现包含 UDP会话管理的简单实现可以作为后续开发的基础库。
  • kcp-csharp: kcp的 csharp移植同时包含一份回话管理可以连接上面kcp-go的服务端。
  • kcp-csharp: 新版本 Kcp的 csharp移植。线程安全运行时无alloc对gc无压力。
  • KcpTransport: kcp的csharp移植实现了 Syn Cookie 握手、连接管理、不可靠通信、KeepAlive未来还将支持加密。
  • Kcp-CSharp: kcp的csharp移植非托管包装器。
  • kcp2k: Line-by-line translation to C#, with optional Server/Client on top.
  • kcp-rs: KCP的 rust移植
  • kcp-rust:新版本 KCP的 rust 移植
  • tokio-kcprust tokio 的 kcp 集成
  • kcp-rust-nativerust 的 kcp bindings
  • lua-kcp: KCP的 Lua扩展用于 Lua服务器
  • node-kcp: node-js 的 KCP 接口
  • nysocks: 基于libuv实现的node-addon提供nodejs版本的代理服务客户端接入支持SOCKS5和ss两种协议
  • shadowsocks-android: Shadowsocks for android 集成了 kcptun 使用 kcp协议加速 shadowsocks效果不错
  • kcpuv: 使用 libuv开发的kcpuv库目前还在 Demo阶段
  • Lantern:更好的 VPNGithub 50000 星,使用 kcpgo 加速
  • rpcx RPC 框架1000+ 星,使用 kcpgo 加速 RPC
  • xkcptun: c语言实现的kcptun主要用于OpenWrt, LEDE开发的路由器项目上
  • et-frame: C#前后端框架(前端unity3d)统一用C#开发游戏实现了前后端kcp协议
  • yasio: 一个跨平台专注于任意客户端程序的异步socket库, 易于使用相同的API操作KCP/TCP/UDP, 性能测试结果: benchmark-pump.
  • gouxp: 用Go实现基于回调方式的KCP开发包包含加解密和FEC支持简单易用。
  • skcp: 基于libev实现的库具备传输加密及基本的连接管理能力。
  • pykcp: Python 版本的 KCP 实现
  • php-ext-kcp: php 的 KCP 扩展
  • asio-kcp(new): c++的asio/kcp支持支持asio协程等现代c++异步模型

商业案例

  • 原神:米哈游的《原神》使用 KCP 降低游戏消息的传输耗时,提升操作的体验。
  • SpatialOS: 大型多人分布式游戏服务端引擎BigWorld 的后继者,使用 KCP 加速数据传输。
  • 西山居:使用 KCP 进行游戏数据加速。
  • CC:网易 CC 使用 kcp 加速视频推流,有效提高流畅性
  • BOBO:网易 BOBO 使用 kcp 加速主播推流
  • UU:网易 UU 加速器使用 KCP/KCPTUN 经行远程传输加速。
  • 阿里云:阿里云的视频传输加速服务 GRTN 使用 KCP 进行音视频数据传输优化,动态加速产品也使用 KCP。
  • 云帆加速:使用 KCP 加速文件传输和视频推流,优化了台湾主播推流的流畅度。
  • 明日帝国Game K17 的 《明日帝国》 Google Play使用 KCP 加速游戏消息,让全球玩家流畅联网
  • 仙灵大作战4399 的 MOBA游戏使用 KCP 优化游戏同步

相关阅读:《原神》也在使用 KCP 加速游戏消息

KCP 成功的运行在多个用户规模上亿的项目上,为他们提供了更加灵敏和丝滑网络体验。

欢迎告知更多案例

协议比较

如果网络永远不卡,那 KCP/TCP 表现类似但是网络本身就是不可靠的丢包和抖动无法避免否则还要各种可靠协议干嘛。在内网这种几乎理想的环境里直接比较大家都差不多但是放到公网上放到3G/4G网络情况下或者使用内网丢包模拟差距就很明显了。公网在高峰期有平均接近10%的丢包wifi/3g/4g下更糟糕这些都会让传输变卡。

感谢 asio-kcp 的作者 zhangyuan 对 KCP 与 enet, udt做过的一次横向评测结论如下

  • ASIO-KCP has good performace in wifi and phone network(3G, 4G).
  • The kcp is the first choice for realtime pvp game.
  • The lag is less than 1 second when network lag happen. 3 times better than enet when lag happen.
  • The enet is a good choice if your game allow 2 second lag.
  • UDT is a bad idea. It always sink into badly situation of more than serval seconds lag. And the recovery is not expected.
  • enet has the problem of lack of doc. And it has lots of functions that you may intrest.
  • kcp's doc is chinese. Good thing is the function detail which is writen in code is english. And you can use asio_kcp which is a good wrap.
  • The kcp is a simple thing. You will write more code if you want more feature.
  • UDT has a perfect doc. UDT may has more bug than others as I feeling.

具体见:横向比较评测数据,为犹豫选择的人提供了更多指引。

大型多人游戏服务端引擎 SpatialOS 在集成 KCP 协议后做了同 TCP/RakNet 的评测:

对比了在服务端刷新率为 60 Hz 同时维护 50 个角色时的响应时间,详细对比报告见:

关于协议

近年来,网络游戏和各类社交网络都在成几何倍数的增长,不管网络游戏还是各类互动社交网络,交互性和复杂度都在迅速提高,都需要在极短的时间内将数据同时投递给大量用户,因此传输技术自然变为未来制约发展的一个重要因素,而开源界里各种著名的传输协议,如 raknet/enet 之类,一发布都是整套协议栈一起发布,这种形式是不利于多样化的,我的项目只能选择用或者不用你,很难选择 “部分用你”,然而你一套协议栈设计的再好,是非常难以满足不同角度的各种需求的。

因此 KCP 的方式是把协议栈 “拆开”,让大家可以根据项目需求进行灵活的调整和组装,你可以下面加一层 reed solomon 的纠删码做 FEC上面加一层类 RC4/Salsa20 做流加密,握手处再设计一套非对称密钥交换,底层 UDP 传输层再做一套动态路由系统,同时探测多条路径,选最好路径进行传输。这些不同的 “协议单元” 可以像搭建积木一般根据需要自由组合,保证 “简单性” 和 “可拆分性”,这样才能灵活适配多变的业务需求,哪个模块不好,换了就是。

未来传输方面的解决方案必然是根据使用场景深度定制的,因此给大家一个可以自由组合的 “协议单元” ,方便大家集成在自己的协议栈中。

For more information, please see the Success Stories.

关于作者

作者:林伟 (skywind3000)

欢迎关注我的:个人博客推特

我在多年的开发经历中一直都喜欢研究解决程序中的一些瓶颈问题早年喜欢游戏开发照着《VGA编程》来做游戏图形读 Michael Abrash 的《图形程序开发人员指南》做软渲染器,爱好摆弄一些能够榨干 CPU 能够运行更快的代码,参加工作后,兴趣转移到服务端和网络相关的技术。

2007 年时做了几个传统游戏后开始研究快速动作游戏的同步问题,期间写过不少文章,算是国内比较早研究同步问题的人,然而发现不管怎么解决同步都需要在网络传输方面有所突破,后来离开游戏转行互联网后也发现不少领域有这方面的需求,于是开始花时间在网络传输这个领域上,尝试基于 UDP 实现一些保守的可靠协议,仿照 BSD Lite 4.4 的代码实现一些类 TCP 协议,觉得比较有意思,又接着实现一些 P2P 和动态路由网相关的玩具。KCP 协议诞生于 2011 年,基本算是自己传输方面做的几个玩具中的一个。

Kcptun 的作者 xtaci 是我的大学同学,我俩都是学通信的,经常在一起研究如何进行传输优化。

欢迎捐赠

欢迎使用支付宝对该项目进行捐赠

欢迎使用支付宝手扫描上面的二维码,对该项目进行捐赠。捐赠款项将用于持续优化 KCP协议以及完善文档。

感谢:明明、星仔、进、帆、颁钊、斌铨、晓丹、余争、虎、晟敢、徐玮、王川、赵刚强、胡知锋、万新朝、何新超、刘旸、侯宪辉、吴佩仪、华斌、如涛、胡坚。。。(早先的名单实在不好意思没记录下来)等同学的捐助与支持。

欢迎关注

KCP交流群364933586QQ群号KCP集成调优网络传输以及相关技术讨论

Gitter 群:https://gitter.im/skywind3000/KCP

blog: http://www.skywind.me

Contributors

This project exists thanks to all the people who contribute.