update doc

README.md

@@ -3,57 +3,38 @@ KCP - A Fast and Reliable ARQ Protocol
 
 # 简介
 
-KCP是一个快速可靠协议，能以比 TCP浪费10%-20%的带宽的代价，换取平均延迟降低
-30%-40%，且最大延迟降低三倍的传输效果。纯算法实现，并不负责底层协议（如UDP）
-的收发，需要使用者自己定义下层数据包的发送方式，以 callback的方式提供给 KCP。
-连时钟都需要外部传递进来，内部不会有任何一次系统调用。
+KCP是一个快速可靠协议，能以比 TCP浪费10%-20%的带宽的代价，换取平均延迟降低 30%-40%，且最大延迟降低三倍的传输效果。纯算法实现，并不负责底层协议（如UDP）的收发，需要使用者自己定义下层数据包的发送方式，以 callback的方式提供给 KCP。 连时钟都需要外部传递进来，内部不会有任何一次系统调用。
 
-整个协议只有 ikcp.h, ikcp.c两个源文件，可以方便的集成到用户自己的协议栈中。
-也许你实现了一个P2P，或者某个基于 UDP的协议，而缺乏一套完善的ARQ可靠协议实现，
-那么简单的拷贝这两个文件到现有项目中，稍微编写两行代码，即可使用。
+整个协议只有 ikcp.h, ikcp.c两个源文件，可以方便的集成到用户自己的协议栈中。也许你实现了一个P2P，或者某个基于 UDP的协议，而缺乏一套完善的ARQ可靠协议实现，那么简单的拷贝这两个文件到现有项目中，稍微编写两行代码，即可使用。
 
 
 # 技术特性
 
-TCP是为流量设计的（每秒内可以传输多少KB的数据），讲究的是充分利用带宽。而KCP
-是为流速设计的（单个数据包从一端发送到一端需要多少时间），以10%-20%带宽浪费
-的代价换取了比 TCP快30%-40%的传输速度。TCP信道是一条流速很慢，但每秒流量很大
-的大运河，而KCP是水流湍急的小激流。KCP有正常模式和快速模式两种，通过以下策略
-达到提高流速的结果：
+TCP是为流量设计的（每秒内可以传输多少KB的数据），讲究的是充分利用带宽。而 KCP是为流速设计的（单个数据包从一端发送到一端需要多少时间），以10%-20%带宽浪费的代价换取了比 TCP快30%-40%的传输速度。TCP信道是一条流速很慢，但每秒流量很大的大运河，而KCP是水流湍急的小激流。KCP有正常模式和快速模式两种，通过以下策略达到提高流速的结果：
 
 #### RTO翻倍vs不翻倍：
 
-   TCP超时计算是RTOx2，这样连续丢三次包就变成RTOx8了，十分恐怖，而KCP启动快速
-   模式后不x2，只是x1.5（实验证明1.5这个值相对比较好），提高了传输速度。
+   TCP超时计算是RTOx2，这样连续丢三次包就变成RTOx8了，十分恐怖，而KCP启动快速模式后不x2，只是x1.5（实验证明1.5这个值相对比较好），提高了传输速度。
 
 #### 选择性重传 vs 全部重传：
 
-   TCP丢包时会全部重传从丢的那个包开始以后的数据，KCP是选择性重传，只重传真正
-   丢失的数据包。
+   TCP丢包时会全部重传从丢的那个包开始以后的数据，KCP是选择性重传，只重传真正丢失的数据包。
 
 #### 快速重传：
 
-   发送端发送了1,2,3,4,5几个包，然后收到远端的ACK: 1, 3, 4, 5，当收到ACK3时，
-   KCP知道2被跳过1次，收到ACK4时，知道2被跳过了2次，此时可以认为2号丢失，不用
-   等超时，直接重传2号包，大大改善了丢包时的传输速度。
+   发送端发送了1,2,3,4,5几个包，然后收到远端的ACK: 1, 3, 4, 5，当收到ACK3时，KCP知道2被跳过1次，收到ACK4时，知道2被跳过了2次，此时可以认为2号丢失，不用等超时，直接重传2号包，大大改善了丢包时的传输速度。
 
 #### 延迟ACK vs 非延迟ACK：
 
-   TCP为了充分利用带宽，延迟发送ACK（NODELAY都没用），这样超时计算会算出较大
-   RTT时间，延长了丢包时的判断过程。KCP的ACK是否延迟发送可以调节。
+   TCP为了充分利用带宽，延迟发送ACK（NODELAY都没用），这样超时计算会算出较大 RTT时间，延长了丢包时的判断过程。KCP的ACK是否延迟发送可以调节。
 
 #### UNA vs ACK+UNA：
 
-   ARQ模型响应有两种，UNA（此编号前所有包已收到，如TCP）和ACK（该编号包已收到
-   ），光用UNA将导致全部重传，光用ACK则丢失成本太高，以往协议都是二选其一，而
-   KCP协议中，除去单独的 ACK包外，所有包都有UNA信息。
+   ARQ模型响应有两种，UNA（此编号前所有包已收到，如TCP）和ACK（该编号包已收到），光用UNA将导致全部重传，光用ACK则丢失成本太高，以往协议都是二选其一，而 KCP协议中，除去单独的 ACK包外，所有包都有UNA信息。
 
 #### 非退让流控：
 
-   KCP正常模式同TCP一样使用公平退让法则，即发送窗口大小由：发送缓存大小、接收
-   端剩余接收缓存大小、丢包退让及慢启动这四要素决定。但传送及时性要求很高的小
-   数据时，可选择通过配置跳过后两步，仅用前两项来控制发送频率。以牺牲部分公平
-   性及带宽利用率之代价，换取了开着BT都能流畅传输的效果。
+   KCP正常模式同TCP一样使用公平退让法则，即发送窗口大小由：发送缓存大小、接收端剩余接收缓存大小、丢包退让及慢启动这四要素决定。但传送及时性要求很高的小数据时，可选择通过配置跳过后两步，仅用前两项来控制发送频率。以牺牲部分公平性及带宽利用率之代价，换取了开着BT都能流畅传输的效果。
 
 
 # 基本使用
@@ -118,71 +99,69 @@ TCP是为流量设计的（每秒内可以传输多少KB的数据），讲究的
    ```cpp
    int ikcp_wndsize(ikcpcb *kcp, int sndwnd, int rcvwnd);
    ```
-   该调用将会设置协议的最大发送窗口和最大接收窗口大小，默认为32.
+   该调用将会设置协议的最大发送窗口和最大接收窗口大小，默认为32. 这个可以理解为 TCP的 SND_BUF 和 RCV_BUF，只不过单位不一样 SND/RCV_BUF 单位是字节，这个单位是包。
 
 3. 最大传输单元：
 
-   纯算法协议并不负责探测 MTU，默认 mtu是1400字节，可以使用ikcp_setmtu来设置
-   该值。该值将会影响数据包归并及分片时候的最大传输单元。
+   纯算法协议并不负责探测 MTU，默认 mtu是1400字节，可以使用ikcp_setmtu来设置该值。该值将会影响数据包归并及分片时候的最大传输单元。
 
 4. 最小RTO：
 
-   不管是 TCP还是 KCP计算 RTO时都有最小 RTO的限制，即便计算出来RTO为40ms，由
-   于默认的 RTO是100ms，协议只有在100ms后才能检测到丢包，快速模式下为30ms，可
-   以手动更改该值：
+   不管是 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);
+协议的使用和配置都是很简单的，大部分情况看完上面的内容基本可以使用了。如果你需要进一步进行精细的控制，比如改变 KCP的内存分配器，或者你需要更有效的大规模调度 KCP链接（比如 3500个以上），或者如何更好的同 TCP结合，那么可以继续延伸阅读：
+
+- [Wiki Home](https://github.com/skywind3000/kcp/wiki)
+- [KCP 最佳实践](https://github.com/skywind3000/kcp/wiki/KCP-Best-Practice)
+- [同现有TCP服务器集成](https://github.com/skywind3000/kcp/wiki/Cooperate-With-Tcp-Server)
+- [传输数据加密](https://github.com/skywind3000/kcp/wiki/Network-Encryption)
+- [应用层流量控制](https://github.com/skywind3000/kcp/wiki/Flow-Control-for-Users)
+- [性能评测](https://github.com/skywind3000/kcp/wiki/KCP-Benchmark)
 
 
-#### 前向纠错注意
+# 相关应用
 
-为了进一步提高传输速度，下层协议也许会使用前向纠错技术。需要注意，前向纠错会根
-据冗余信息解出原始数据包。相同的原始数据包不要两次input到KCP，否则将会导致kcp
-以为对方重发了，这样会产生更多的ack占用额外带宽。
+- [dog-tunnel](https://github.com/vzex/dog-tunnel): GO开发的网络隧道，使用 KCP极大的改进了传输速度，并移植了一份 GO版本 KCP
+- [lua-kcp](https://github.com/linxiaolong/lua-kcp)：KCP的 Lua扩展，用于 Lua服务器
+- [asio-kcp](https://github.com/libinzhangyuan/asio_kcp): 使用 KCP的完整 UDP网络库，完整实现了基于 UDP的链接状态管理，会话控制，KCP协议调度等
 
-比如下层协议使用最简单的冗余包：单个数据包除了自己外，还会重复存储一次上一个数
-据包，以及上上一个数据包的内容：
+# 协议比较
 
-```cpp
-Fn = (Pn, Pn-1, Pn-2)
+如果永远不丢包那么 KCP和 TCP性能差不多，但网络会卡，造成卡的原因就是丢包和抖动。在内网里直接比较，大家都差不多，但是放到公网上，放到3G/4G网络情况下，或者使用内网丢包模拟，差距就很明显了。公网在高峰期有平均接近10%的丢包，wifi/3g/4g下更糟糕，这正是造成各种网络卡顿的元凶。
 
-P0 = (0, X, X)
-P1 = (1, 0, X)
-P2 = (2, 1, 0)
-P3 = (3, 2, 1)
-```
+感谢 [asio-kcp](https://github.com/libinzhangyuan/asio_kcp) 的作者 [zhangyuan](https://github.com/libinzhangyuan) 对 KCP 与 enet, udt做过的一次横向评测，结论如下：
+
+- ASIO-KCP **has good performace in wifi and phone network(3G, 4G)**.
+- Extra using 20% ~ 50% network flow for speed improvement.
+- 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.
 
-这样几个包发送出去，接收方对于单个原始包都可能被解出3次来（后面两个包任然会重
-复该包内容），那么这里需要记录一下，一个下层数据包只会input给kcp一次，避免过
-多重复ack带来的浪费。
+具体见：[横向比较](https://github.com/libinzhangyuan/reliable_udp_bench_mark) 和 [评测数据](https://github.com/skywind3000/kcp/wiki/KCP-Benchmark)，为犹豫选择的人提供了更多指引。
 
-#### 管理大规模连接
-
-如果需要同时管理大规模的 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性能以及
-后续持续优化。
+欢迎使用支付宝手扫描上面的二维码，对该项目进行捐赠。捐赠款项将用于持续优化 KCP协议以及完善文档。
+
+
+欢迎关注
+
+blog: http://www.skywind.me
+
+zhihu: https://www.zhihu.com/people/skywind3000 
 

ikcp.c

@@ -793,7 +793,7 @@ int ikcp_input(ikcpcb *kcp, const char *data, long size)
 			}	else {
 				if (kcp->incr < mss) kcp->incr = mss;
 				kcp->incr += (mss * mss) / kcp->incr + (mss / 16);
-				if ((kcp->cwnd + 1) * mss >= kcp->incr) {
+				if ((kcp->cwnd + 1) * mss <= kcp->incr) {
 					kcp->cwnd++;
 				}
 			}
@@ -865,7 +865,7 @@ void ikcp_flush(ikcpcb *kcp)
 	count = kcp->ackcount;
 	for (i = 0; i < count; i++) {
 		size = (int)(ptr - buffer);
-		if (size > (int)kcp->mtu) {
+		if (size + IKCP_OVERHEAD > (int)kcp->mtu) {
 			ikcp_output(kcp, buffer, size);
 			ptr = buffer;
 		}
@@ -901,7 +901,7 @@ void ikcp_flush(ikcpcb *kcp)
 	if (kcp->probe & IKCP_ASK_SEND) {
 		seg.cmd = IKCP_CMD_WASK;
 		size = (int)(ptr - buffer);
-		if (size > (int)kcp->mtu) {
+		if (size + IKCP_OVERHEAD > (int)kcp->mtu) {
 			ikcp_output(kcp, buffer, size);
 			ptr = buffer;
 		}
@@ -912,7 +912,7 @@ void ikcp_flush(ikcpcb *kcp)
 	if (kcp->probe & IKCP_ASK_TELL) {
 		seg.cmd = IKCP_CMD_WINS;
 		size = (int)(ptr - buffer);
-		if (size > (int)kcp->mtu) {
+		if (size + IKCP_OVERHEAD > (int)kcp->mtu) {
 			ikcp_output(kcp, buffer, size);
 			ptr = buffer;
 		}
@@ -992,7 +992,7 @@ void ikcp_flush(ikcpcb *kcp)
 			size = (int)(ptr - buffer);
 			need = IKCP_OVERHEAD + segment->len;
 
-			if (size + need >= (int)kcp->mtu) {
+			if (size + need > (int)kcp->mtu) {
 				ikcp_output(kcp, buffer, size);
 				ptr = buffer;
 			}

ikcp.h

@@ -12,7 +12,7 @@
 #ifndef __IKCP_H__
 #define __IKCP_H__
 
-#include <stdio.h>
+#include <stddef.h>
 #include <stdlib.h>
 #include <assert.h>
 
@@ -238,7 +238,8 @@ typedef struct IQUEUEHEAD iqueue_head;
             defined(__m68k__) || defined(mc68000) || defined(_M_M68K) || \
             (defined(__MIPS__) && defined(__MISPEB__)) || \
             defined(__ppc__) || defined(__POWERPC__) || defined(_M_PPC) || \
-            defined(__sparc__) 
+            defined(__sparc__) || defined(__powerpc__) || \
+            defined(__mc68000__) || defined(__s390x__) || defined(__s390__)
             #define IWORDS_BIG_ENDIAN 1
         #endif
     #endif
@@ -357,8 +358,11 @@ IUINT32 ikcp_check(const ikcpcb *kcp, IUINT32 current);
 
 // when you received a low level packet (eg. UDP packet), call it
 int ikcp_input(ikcpcb *kcp, const char *data, long size);
+
+// flush pending data
 void ikcp_flush(ikcpcb *kcp);
 
+// check the size of next message in the recv queue
 int ikcp_peeksize(const ikcpcb *kcp);
 
 // change MTU size, default is 1400
@@ -382,6 +386,10 @@ int ikcp_sndbuf_count(const ikcpcb *kcp);
 
 void ikcp_log(ikcpcb *kcp, int mask, const char *fmt, ...);
 
+// setup allocator
+void ikcp_allocator(void* (*new_malloc)(size_t), void (*new_free)(void*));
+
+
 #ifdef __cplusplus
 }
 #endif