kcp/README.md
2014-12-30 22:38:15 +08:00

189 lines
7.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

KCP - A Fast and Reliable ARQ Protocol
======================================
# 简介
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都能流畅传输的效果。
# 基本使用
1. 创建 KCP对象
```cpp
// 初始化 kcp对象conv为一个表示会话编号的整数和tcp的 conv一样通信双
// 方需保证 conv相同相互的数据包才能够被认可user是一个给回调函数的指针
ikcpcb *kcp = ikcp_create(conv, user);
```
2. 设置回调函数:
```cpp
// 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
```cpp
// 以一定频率调用 ikcp_update来更新 kcp状态并且传入当前时钟毫秒单位
// 如 10ms调用一次或用 ikcp_check确定下次调用 update的时间不必每次调用
ikcp_update(kcp, millisec);
```
4. 输入一个下层数据包:
```cpp
// 收到一个下层数据包比如UDP包时需要调用
ikcp_input(kcp, received_udp_packet, received_udp_size);
```
处理了下层协议的输出/输入后 KCP协议就可以正常工作了使用 ikcp_send 来向
远端发送数据。而另一端使用 ikcp_recv(kcp, ptr, size)来接收数据。
# 协议配置
协议默认模式是一个标准的 ARQ需要通过配置打开各项加速开关
1. 工作模式:
```cpp
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. 最大窗口:
```cpp
int ikcp_wndsize(ikcpcb *kcp, int sndwnd, int rcvwnd);
```
该调用将会设置协议的最大发送窗口和最大接收窗口大小默认为32.
3. 最大传输单元:
纯算法协议并不负责探测 MTU默认 mtu是1400字节可以使用ikcp_setmtu来设置
该值。该值将会影响数据包归并及分片时候的最大传输单元。
4. 最小RTO
不管是 TCP还是 KCP计算 RTO时都有最小 RTO的限制即便计算出来RTO为40ms
于默认的 RTO是100ms协议只有在100ms后才能检测到丢包快速模式下为30ms
以手动更改该值:
```cpp
kcp->rx_minrto = 10;
```
# 最佳实践
#### 内存分配器
默认KCP协议使用 malloc/free进行内存分配释放如果应用层接管了内存分配可以
用ikcp_allocator来设置新的内存分配器注意要在一开始设置
> ikcp_allocator(my_new_malloc, my_new_free);
#### 前向纠错注意
为了进一步提高传输速度,下层协议也许会使用前向纠错技术。需要注意,前向纠错会根
据冗余信息解出原始数据包。相同的原始数据包不要两次input到KCP否则将会导致kcp
以为对方重发了这样会产生更多的ack占用额外带宽。
比如下层协议使用最简单的冗余包:单个数据包除了自己外,还会重复存储一次上一个数
据包,以及上上一个数据包的内容:
```cpp
Fn = (Pn, Pn-1, Pn-2)
P0 = (0, X, X)
P1 = (1, 0, X)
P2 = (2, 1, 0)
P3 = (3, 2, 1)
```
这样几个包发送出去接收方对于单个原始包都可能被解出3次来后面两个包任然会重
复该包内容那么这里需要记录一下一个下层数据包只会input给kcp一次避免过
多重复ack带来的浪费。
#### 管理大规模连接
如果需要同时管理大规模的 KCP连接比如大于3000个比如你正在实现一套类 epoll
的机制,那么为了避免每秒钟对每个连接调用大量的调用 ikcp_update我们可以使用
ikcp_check来大大减少 ikcp_update调用的次数。 ikcp_check返回值会告诉你需要
在什么时间点再次调用 ikcp_update如果中途没有 ikcp_send, ikcp_input的话
否则中途调用了 ikcp_send, ikcp_input的话需要在下一次interval时调用 update
标准顺序是每次调用了 ikcp_update后使用 ikcp_check决定下次什么时间点再次调用
ikcp_update而如果中途发生了 ikcp_send, ikcp_input的话在下一轮 interval
立马调用 ikcp_update和 ikcp_check。 使用该方法原来在处理2000个 kcp连接且每
个连接每10ms调用一次update改为 check机制后cpu从 60%降低到 15%。
# 欢迎捐赠
![欢迎使用支付宝对该项目进行捐赠](https://raw.githubusercontent.com/skywind3000/kcp/master/donation.png)
欢迎使用支付宝手扫描上面的二维码,对该项目进行捐赠。捐赠款项将用于改进 KCP性能以及
后续持续优化。