Merge branch 'master' of https://github.com/xtaci/kcptun

This reverts commit 2f479b788c.

README.en.md

@@ -28,10 +28,13 @@ A tool for converting tcp stream into kcp+udp stream, :zap: ***[download address
 ***kcptun is based on [kcp-go](https://github.com/xtaci/kcp-go)***   
 
 ### *QuickStart* :lollipop:
+Client, server, respectively, download the corresponding platform binary compression package, and extract, through the following command to start port forwarding.
 ```
-Server Side: ./server_linux_amd64 -t "127.0.0.1:1080" -l ":4000" -mode fast2  // forwarding to local port 1080
-Client Side: ./client_darwin_amd64 -r "SERVERIP:4000" -l ":1080" -mode fast2  // listening on port 1080
+Server: ./server_linux_amd64 -t "SERVER_IP:8388" -l ":4000" -mode fast2
+Client: ./client_darwin_amd64 -r "SERVER_IP:4000" -l ":8388" -mode fast2
 ```
+The above command can establish 8388/tcp port forwarding (through 4000/udp port).
+
 
 ### *Performance* :lollipop:
 <img src="fast.png" alt="fast.com" height="256px" />       
@@ -44,13 +47,13 @@ Help output under MacOS X:
 ```
 $ ./client_darwin_amd64 -h
 NAME:
-   kcptun - kcptun client
+   kcptun - client(with SMUX)
 
 USAGE:
    client_darwin_amd64 [global options] command [command options] [arguments...]
 
 VERSION:
-   20160820
+   20160922
 
 COMMANDS:
      help, h  Shows a list of commands or help for one command
@@ -58,30 +61,32 @@ COMMANDS:
 GLOBAL OPTIONS:
    --localaddr value, -l value   local listen address (default: ":12948")
    --remoteaddr value, -r value  kcp server address (default: "vps:29900")
-   --key value                   pre-shared secret for client and server (default: "it's a secrect") [$KCPTUN_KEY]
+   --key value                   pre-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY]
    --crypt value                 aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, none (default: "aes")
    --mode value                  profiles: fast3, fast2, fast, normal (default: "fast")
    --conn value                  set num of UDP connections to server (default: 1)
-   --mtu value                   set maximum transmission unit of UDP packets (default: 1350)
+   --autoexpire value            set auto expiration time(in seconds) for a single UDP connection, 0 to disable (default: 0)
+   --mtu value                   set maximum transmission unit for UDP packets (default: 1350)
    --sndwnd value                set send window size(num of packets) (default: 128)
    --rcvwnd value                set receive window size(num of packets) (default: 1024)
    --datashard value             set reed-solomon erasure coding - datashard (default: 10)
    --parityshard value           set reed-solomon erasure coding - parityshard (default: 3)
    --dscp value                  set DSCP(6bit) (default: 0)
    --nocomp                      disable compression
+   --log value                   specify a log file to output, default goes to stderr
+   -c value                      config from json file, which will override the command from shell
    --help, -h                    show help
    --version, -v                 print the version
 
-
 $ ./server_darwin_amd64 -h
 NAME:
-   kcptun - kcptun server
+   kcptun - server(with SMUX)
 
 USAGE:
    server_darwin_amd64 [global options] command [command options] [arguments...]
 
 VERSION:
-   20160820
+   20160922
 
 COMMANDS:
      help, h  Shows a list of commands or help for one command
@@ -89,19 +94,24 @@ COMMANDS:
 GLOBAL OPTIONS:
    --listen value, -l value  kcp server listen address (default: ":29900")
    --target value, -t value  target server address (default: "127.0.0.1:12948")
-   --key value               pre-shared secret for client and server (default: "it's a secrect") [$KCPTUN_KEY]
+   --key value               pre-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY]
    --crypt value             aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, none (default: "aes")
    --mode value              profiles: fast3, fast2, fast, normal (default: "fast")
-   --mtu value               set maximum transmission unit of UDP packets (default: 1350)
+   --mtu value               set maximum transmission unit for UDP packets (default: 1350)
    --sndwnd value            set send window size(num of packets) (default: 1024)
    --rcvwnd value            set receive window size(num of packets) (default: 1024)
    --datashard value         set reed-solomon erasure coding - datashard (default: 10)
    --parityshard value       set reed-solomon erasure coding - parityshard (default: 3)
    --dscp value              set DSCP(6bit) (default: 0)
    --nocomp                  disable compression
+   --log value               specify a log file to output, default goes to stderr
+   -c value                  config from json file, which will override the command from shell
    --help, -h                show help
    --version, -v             print the version
 ```
+#### *Parameters by Layers* :lollipop:   
+
+<p align="left"><img src="layeredparams.png" alt="params" height="450px"/></p>
 
 ### *Applications* :lollipop:   
 1. Real-time gaming.
@@ -174,7 +184,7 @@ It is able to detect and correct multiple symbol errors. By adding t check symbo
 
 ![reed-solomon](rs.png)
 
-Setting parameters of RS-Code with ```-datashard 10 -parityshard 3``` 
+Setting parameters of RS-Code with ```-datashard m -parityshard n```
 
 ### *Snappy Stream Compression* :lollipop: 
 > Snappy is a compression/decompression library. It does not aim for maximum
@@ -222,7 +232,7 @@ Of which ```RetransSegs,FastRetransSegs,LostSegs,OutSegs``` is the most useful.
 ### *Donations* :dollar:
 ![donate](donate.png)          
 
-All donations to this project will be used on the R&D of [gonet/2](http://gonet2.github.io/).
+Best wishes to you all.
 
 ### *References* :paperclip:
 1. https://github.com/skywind3000/kcp -- KCP - A Fast and Reliable ARQ Protocol.

README.md

@@ -1,4 +1,8 @@
-# <img src="logo.png" alt="kcptun" height="60px" /> 
+<p align="center"><img src="logo.png" alt="kcptun" height="60px" /></p>
+<p align="center"><em>也许是世界上最快的UDP传输工具</em></p>
+
+-
+
 [![Release][13]][14] [![Powered][17]][18] [![MIT licensed][11]][12] [![Build Status][3]][4] [![Go Report Card][5]][6] [![Downloads][15]][16] [![Gitter][19]][20] [![Docker][1]][2]
 [1]: https://images.microbadger.com/badges/image/xtaci/kcptun.svg
 [2]: https://microbadger.com/images/xtaci/kcptun
@@ -19,35 +23,42 @@
 [19]: https://badges.gitter.im/xtaci/kcptun.svg
 [20]: https://gitter.im/xtaci/kcptun?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
 
-***[kcp-go](https://github.com/xtaci/kcp-go)协议测试小工具 :zap: [官方下载地址](https://github.com/xtaci/kcptun/releases/latest):zap:***
+<p align="center"><img src="kcptun.png" alt="kcptun" height="200px"/></p>
+<p align="center"><a href="https://github.com/xtaci/kcptun/releases/latest">立即安装</a></p>
+<p align="center"><em>支持macOS/Linux/Windows/FreeBSD/ARM/Raspberry Pi/OpenWrt</em></p>
+<p align="right"><a href="https://github.com/xtaci/kcptun/blob/master/README.en.md">ENG</a></p>
 
-![kcptun](kcptun.png)
-[English Readme](README.en.md)
-### *快速设定* :lollipop:
+-
+
+### 快速设定
+
+客户端、服务器分别**下载**对应平台的二进制压缩包，并**解压**，通过下面的命令**启动**端口转发。
 ```
-服务器: ./server_linux_amd64 -t "127.0.0.1:8388" -l ":4000" -mode fast2  // 转发到服务器的本地8388端口
-客户端: ./client_darwin_amd64 -r "服务器IP地址:4000" -l ":8388" -mode fast2    // 监听客户端的本地8388端口
-注: 服务器端需要有服务监听8388端口
+服务器: ./server_linux_amd64 -t "服务器IP地址:8388" -l ":4000" -mode fast2
+客户端: ./client_darwin_amd64 -r "服务器IP地址:4000" -l ":8388" -mode fast2
 ```
+以上命令可以实现8388/tcp端口的转发（通过4000/udp端口）。
+
+### 速度对比
 
-### *速度对比* :lollipop:
 <img src="fast.png" alt="fast.com" height="256px" />       
 * 测速网站: https://fast.com
-* 接入: 100M ADSL
+* 接入速度: 100Mbps
 * WIFI: 5GHz TL-WDR3320
 
-### *使用方法* :lollipop:
-在Mac OS X El Capitan下的帮助输出: 
+### 使用方法
+
+在Mac OS X El Capitan下的帮助输出，注意默认值: 
 ```
 $ ./client_darwin_amd64 -h
 NAME:
-   kcptun - kcptun client
+   kcptun - client(with SMUX)
 
 USAGE:
    client_darwin_amd64 [global options] command [command options] [arguments...]
 
 VERSION:
-   20160820
+   20161025
 
 COMMANDS:
      help, h  Shows a list of commands or help for one command
@@ -55,30 +66,32 @@ COMMANDS:
 GLOBAL OPTIONS:
    --localaddr value, -l value   local listen address (default: ":12948")
    --remoteaddr value, -r value  kcp server address (default: "vps:29900")
-   --key value                   pre-shared secret for client and server (default: "it's a secrect") [$KCPTUN_KEY]
+   --key value                   pre-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY]
    --crypt value                 aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, none (default: "aes")
    --mode value                  profiles: fast3, fast2, fast, normal (default: "fast")
    --conn value                  set num of UDP connections to server (default: 1)
-   --mtu value                   set maximum transmission unit of UDP packets (default: 1350)
+   --autoexpire value            set auto expiration time(in seconds) for a single UDP connection, 0 to disable (default: 0)
+   --mtu value                   set maximum transmission unit for UDP packets (default: 1350)
    --sndwnd value                set send window size(num of packets) (default: 128)
    --rcvwnd value                set receive window size(num of packets) (default: 1024)
    --datashard value             set reed-solomon erasure coding - datashard (default: 10)
    --parityshard value           set reed-solomon erasure coding - parityshard (default: 3)
    --dscp value                  set DSCP(6bit) (default: 0)
    --nocomp                      disable compression
+   --log value                   specify a log file to output, default goes to stderr
+   -c value                      config from json file, which will override the command from shell
    --help, -h                    show help
    --version, -v                 print the version
 
-
 $ ./server_darwin_amd64 -h
 NAME:
-   kcptun - kcptun server
+   kcptun - server(with SMUX)
 
 USAGE:
    server_darwin_amd64 [global options] command [command options] [arguments...]
 
 VERSION:
-   20160820
+   20161025
 
 COMMANDS:
      help, h  Shows a list of commands or help for one command
@@ -86,72 +99,131 @@ COMMANDS:
 GLOBAL OPTIONS:
    --listen value, -l value  kcp server listen address (default: ":29900")
    --target value, -t value  target server address (default: "127.0.0.1:12948")
-   --key value               pre-shared secret for client and server (default: "it's a secrect") [$KCPTUN_KEY]
+   --key value               pre-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY]
    --crypt value             aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, none (default: "aes")
    --mode value              profiles: fast3, fast2, fast, normal (default: "fast")
-   --mtu value               set maximum transmission unit of UDP packets (default: 1350)
+   --mtu value               set maximum transmission unit for UDP packets (default: 1350)
    --sndwnd value            set send window size(num of packets) (default: 1024)
    --rcvwnd value            set receive window size(num of packets) (default: 1024)
    --datashard value         set reed-solomon erasure coding - datashard (default: 10)
    --parityshard value       set reed-solomon erasure coding - parityshard (default: 3)
    --dscp value              set DSCP(6bit) (default: 0)
    --nocomp                  disable compression
+   --log value               specify a log file to output, default goes to stderr
+   -c value                  config from json file, which will override the command from shell
    --help, -h                show help
    --version, -v             print the version
 ```
+#### 分层参数图
 
-### *参数调整* :lollipop: 
-***两端参数必须一致的有:***
-* datashard
-* parityshard
-* nocomp
-* key
-* crypt
+<p align="left"><img src="layeredparams.png" alt="params" height="450px"/></p>
+
+### 内置模式
+
+响应速度:     
+*fast3 > fast2 >* **[fast]** *> normal > default*        
+有效载荷比:     
+*default > normal >* **[fast]** *> fast2 > fast3*       
+中间mode参数比较均衡，总之就是越快，包重传越激进。       
+更高级的 **手动档** 需要理解KCP协议，并通过 **隐藏参数** 调整，例如:
+```
+ -mode manual -nodelay 1 -resend 2 -nc 1 -interval 20
+```
+
+* 搭配1. fast + FEC(5,5)
+* 搭配2. fast2 + FEC(10,3)
+* 搭配3. fast2 + FEC(0,0)
+
+默认profile参考: https://github.com/xtaci/kcptun/blob/master/client/main.go#L248
+
+### 前向纠错
+
+前向纠错采用Reed Solomon纠删码, 它的基本原理如下： 给定n个数据块d1, d2,…, dn，n和一个正整数m， RS根据n个数据块生成m个校验块， c1, c2,…, cm。 对于任意的n和m， 从n个原始数据块和m 个校验块中任取n块就能解码出原始数据， 即RS最多**容忍m个数据块或者校验块同时丢失**。
+
+![reed-solomon](rs.png)
+
+通过参数```-datashard n -parityshard m``` 在两端同时设定。
+
+数据包发送顺序严格遵循: n个datashard紧接m个parityshard，重复。
+
+注意：为了发挥FEC最佳效果，设置 parityshard/(parity+datashard) > packet loss，比如5/(5+5) > 30%
+
+### 窗口调整
+
+**两端参数必须一致的有**:
+
+* datashard --前向纠错
+* parityshard --前向纠错
+* nocomp --压缩
+* key --密钥
+* crypt --加密算法
 
 其余为两边可独立设定的参数
 
-*简易自我调优方法*：
+**简易窗口自我调优方法**：
+
 > 第一步：同时在两端逐步增大client rcvwnd和server sndwnd;        
 > 第二步：尝试下载，观察如果带宽利用率（服务器＋客户端两端都要观察）接近物理带宽则停止，否则跳转到第一步。
 
-***注意：产生大量重传时，一定是窗口偏大了***
+**注意：产生大量重传时，一定是窗口偏大了**
+
+### 安全
+
+无论你上层如何加密，如果```-crypt none```，那么**协议头部**都是**明文**的，建议至少采用```-crypt aes-128```加密，并修改密码。
+
+密码可以通过`-key`指定，也可以通过环境变量`KCPTUN_KEY`指定。
+
+注意: ```-crypt xor``` 也是不安全的，除非你知道你在做什么。 
+
+附加密速度Benchmark：
 
-*带宽计算公式*：
 ```
-在不丢包的情况下，有最大-rcvwnd 个数据包在网络上正在向你传输，以平均数据包大小avgsize计算，在任意时刻，有：     
-
-		network_cap = rcvwnd*avgsize
-
-数据流向你，这个值再除以ping值(rtt)，等于最大带宽使用量。
-
-		max_bandwidth = network_cap/rtt = rcvwnd*avgsize/rtt
-		
-举例，设rcvwnd = 1024, avgsize = 1KB, rtt = 400ms，则：
-
-		max_bandwidth = 1024 * 1KB / 400ms = 2.5MB/s ~= 25Mbps
-		
-（注：以上计算不包括前向纠错的数据量）
-
-前向纠错是最大带宽量的一个固定比例增加：
-
-		max_bandwidth_fec = max_bandwidth*(datashard+parityshard)/datashard
-
-举例，设datashard = 10 , partiyshard = 3，则：
-
-		max_bandwidth_fec = max_bandwidth * (10 + 3) /10 = 1.3*max_bandwidth ＝ 1.3 * 25Mbps = 32.5Mbps
+BenchmarkAES128-4      	  200000	     11182 ns/op
+BenchmarkAES192-4      	  200000	     12699 ns/op
+BenchmarkAES256-4      	  100000	     13757 ns/op
+BenchmarkTEA-4         	   50000	     26441 ns/op
+BenchmarkSimpleXOR-4   	 3000000	       441 ns/op
+BenchmarkBlowfish-4    	   30000	     48036 ns/op
+BenchmarkNone-4        	20000000	       106 ns/op
+BenchmarkCast5-4       	   20000	     60222 ns/op
+BenchmarkTripleDES-4   	    2000	    878759 ns/op
+BenchmarkTwofish-4     	   20000	     68501 ns/op
+BenchmarkXTEA-4        	   20000	     77417 ns/op
+BenchmarkSalsa20-4     	  300000	      4998 ns/op
 ```
 
-### *安全* :lollipop: 
-无论你上层如何加密，如果```-crypt none```，那么协议头部都是***明文***的，建议至少采用```-crypt aes-128```加密。
+### 内存控制
 
-注意: ```-crypt xor``` 也是不安全的，除非你知道你在做什么。
-
-### *内存控制* :lollipop: 
-路由器，手机等嵌入式设备通常对内存用量敏感，通过调节环境变量GOGC（例如GOGC=20)后启动client，可以降低内存使用。      
+路由器，手机等嵌入式设备通常对**内存用量敏感**，通过调节环境变量GOGC（例如GOGC=20)后启动client，可以降低内存使用。      
 参考：https://blog.golang.org/go15gc
 
-### *流量控制* :lollipop: 
-***必要性: 针对流量敏感的服务器，做双保险。***      
+
+### DSCP
+
+DSCP差分服务代码点（Differentiated Services Code Point），IETF于1998年12月发布了Diff-Serv（Differentiated Service）的QoS分类标准。它在每个数据包IP头部的服务类别TOS标识字节中，利用已使用的**6比特**和未使用的2比特，通过编码值来区分优先级。     
+常用DSCP值可以参考[Wikipedia DSCP](https://en.wikipedia.org/wiki/Differentiated_services#Commonly_used_DSCP_values)，至于有没有用，完全取决于数据包经过的设备。 
+
+通过 ```-dscp ``` 参数指定dscp值，两端可分别设定。
+
+注意：设置dscp不一定会更好，需要尝试。
+
+### Snappy数据流压缩
+
+> Snappy is a compression/decompression library. It does not aim for maximum
+> compression, or compatibility with any other compression library; instead,
+> it aims for very high speeds and reasonable compression. For instance,
+> compared to the fastest mode of zlib, Snappy is an order of magnitude faster
+> for most inputs, but the resulting compressed files are anywhere from 20% to
+> 100% bigger.
+
+> Reference: http://google.github.io/snappy/
+
+通过参数 ```-nocomp``` 在两端同时设定以关闭压缩。
+> 提示: 关闭压缩可能会降低延迟。
+
+### 流量控制
+
+**必要性: 针对流量敏感的服务器，做双保险。**      
 
 > 基本原则: SERVER的发送速率不能超过ADSL下行带宽，否则只会浪费您的服务器带宽。  
 
@@ -168,46 +240,8 @@ root@kcptun:~#
 ```
 其中eth0为网卡，有些服务器为ens3，有些为p2p1，通过ifconfig查询修改。
 
+### SNMP
 
-### *DSCP* :lollipop: 
-DSCP差分服务代码点（Differentiated Services Code Point），IETF于1998年12月发布了Diff-Serv（Differentiated Service）的QoS分类标准。它在每个数据包IP头部的服务类别TOS标识字节中，利用已使用的6比特和未使用的2比特，通过编码值来区分优先级。     
-常用DSCP值可以参考[Wikipedia DSCP](https://en.wikipedia.org/wiki/Differentiated_services#Commonly_used_DSCP_values)，至于有没有用，完全取决于数据包经过的设备。 
-
-通过 ```-dscp ``` 参数指定dscp值，两端可分别设定。
-
-### *前向纠错* :lollipop: 
-前向纠错采用Reed Solomon纠删码, 它的基本原理如下： 给定n个数据块d1, d2,…, dn，n和一个正整数m， RS根据n个数据块生成m个校验块， c1, c2,…, cm。 对于任意的n和m， 从n个原始数据块和m 个校验块中任取n块就能解码出原始数据， 即RS最多容忍m个数据块或者校验块同时丢失。
-
-![reed-solomon](rs.png)
-
-通过参数```-datashard 10 -parityshard 3``` 在两端同时设定。
-
-### *Snappy数据流压缩* :lollipop: 
-> Snappy is a compression/decompression library. It does not aim for maximum
-> compression, or compatibility with any other compression library; instead,
-> it aims for very high speeds and reasonable compression. For instance,
-> compared to the fastest mode of zlib, Snappy is an order of magnitude faster
-> for most inputs, but the resulting compressed files are anywhere from 20% to
-> 100% bigger.
-
-> Reference: http://google.github.io/snappy/
-
-通过参数 ```-nocomp``` 在两端同时设定以关闭压缩。
-> 提示: 关闭压缩可能会降低延迟。
-
-### *内置模式* :lollipop: 
-响应速度:     
-*fast3 >* ***[fast2]*** *> fast > normal > default*        
-有效载荷比:     
-*default > normal > fast >* ***[fast2]*** *> fast3*       
-中间mode参数比较均衡，总之就是越快越浪费带宽，推荐模式 ***fast2***         
-更高级的 ***手动档*** 需要理解KCP协议，并通过 ***隐藏参数*** 调整，例如:
-```
- -mode manual -nodelay 1 -resend 2 -nc 1 -interval 20
-```
-高丢包率的网络建议采用fast2, 低丢包率的网络，建议采用normal。
-
-### *SNMP* :lollipop:
 ```go
 // Snmp defines network statistics indicator
 type Snmp struct {
@@ -233,32 +267,74 @@ type Snmp struct {
 }
 ```
 
-使用```kill -SIGUSR1 pid``` 可以在控制台打印出SNMP信息，通常用于精细调整***当前链路的有效载荷比***。        
-观察```RetransSegs,FastRetransSegs,LostSegs,OutSegs```这几者的数值比例，用于参考调整```-mode manual,fec```的参数。        
+使用```kill -SIGUSR1 pid``` 可以在控制台打印出SNMP信息，通常用于精细调整**当前链路的有效载荷比**。        
+观察```RetransSegs,FastRetransSegs,LostSegs,OutSegs```这几者的数值比例，用于参考调整```-mode manual,fec```的参数。    
 
-### *故障排除* :lollipop:
-> Q: 客户端和服务器端***皆无*** ```stream opened```信息。       
+#### 带宽计算公式
+
+```
+在不丢包的情况下，有最大-rcvwnd 个数据包在网络上正在向你传输，以平均数据包大小avgsize计算，在任意时刻，有：     
+
+		network_cap = rcvwnd*avgsize
+
+数据流向你，这个值再除以ping值(rtt)，等于最大带宽使用量。
+
+		max_bandwidth = network_cap/rtt = rcvwnd*avgsize/rtt
+		
+举例，设rcvwnd = 1024, avgsize = 1KB, rtt = 400ms，则：
+
+		max_bandwidth = 1024 * 1KB / 400ms = 2.5MB/s ~= 25Mbps
+		
+（注：以上计算不包括前向纠错的数据量）
+
+前向纠错是最大带宽量的一个固定比例增加：
+
+		max_bandwidth_fec = max_bandwidth*(datashard+parityshard)/datashard
+
+举例，设datashard = 10 , partiyshard = 3，则：
+
+		max_bandwidth_fec = max_bandwidth * (10 + 3) /10 = 1.3*max_bandwidth ＝ 1.3 * 25Mbps = 32.5Mbps
+```
+
+### 故障排除
+
+> Q: 客户端和服务器端**皆无** ```stream opened```信息。       
 > A: 连接客户端程序的端口设置错误。     
 
 > Q: 客户端有 ```stream opened```信息，服务器端没有。     
 > A: 连接服务器的端口设置错误，或者被防火墙拦截。     
 
-> Q: 客户端服务器***皆有*** ```stream opened```信息，但无法通信。      
+> Q: 客户端服务器**皆有** ```stream opened```信息，但无法通信。      
 > A: 上层软件的设定错误。     
 
-### *免责申明* :warning:
-用户以各种方式使用本软件（包括但不限于修改使用、直接使用、通过第三方使用）的过程中，不得以任何方式利用本软件直接或间接从事违反中国法律、以及社会公德的行为。软件的使用者需对自身行为负责，因使用软件引发的一切纠纷，由使用者承担全部法律及连带责任。作者不承担任何法律及连带责任。       
+### 免责申明
 
-对免责声明的解释、修改及更新权均属于作者本人所有。
+**用户以各种方式使用本软件（包括但不限于修改使用、直接使用、通过第三方使用）的过程中，不得以任何方式利用本软件直接或间接从事违反中国法律、以及社会公德的行为。软件的使用者需对自身行为负责，因使用软件引发的一切纠纷，由使用者承担全部法律及连带责任。作者不承担任何法律及连带责任。**       
+
+**对免责声明的解释、修改及更新权均属于作者本人所有。**
+
+### 捐赠
 
-### *捐赠* :dollar:
 ![donate](donate.png)          
 
-对该项目的捐款将用于[gonet/2](http://gonet2.github.io/)游戏服务器框架的研发。     
+### 特别鸣谢
 
-```特别感谢: 郑H立, 南D风, Li, 七q, 凌J，昶，Les*ables, Ky*n, 噼**啦, *斌, 小苍** 等，名字已做特殊处理。```
+> 郑H立, 南东风, Li, 七七, 凌君, 昶，LesMiserables, KyOn, 噼里啪啦, 继斌, 小苍辛苦, **Ken**, 
+> 乔槁, 佳晨, 猪肉佬, lcx, 昊文, 冰峰, 凡, alex, **海豹叔叔**, 奥姐, 张冰, 司成, 
+> 武子, **慎**，Alex43211，**Coxxs**，荣，NeroNg，吴骁，定一，我不是林J，Patrick, 超, 陈，windfarer, 宇。
+
+好人一生平安!
+
+### 相关软件
+
+1. https://github.com/bettermanbao/openwrt-kcptun
+2. https://github.com/EasyPi/openwrt-kcptun
+3. https://github.com/kuoruan/luci-app-kcptun
+4. https://github.com/dfdragon/kcptun_gclient
+5. https://github.com/dfdragon/kcptun_xclient
+
+### 参考资料
 
-### *参考资料* :paperclip:
 1. https://github.com/skywind3000/kcp -- KCP - A Fast and Reliable ARQ Protocol.
 2. https://github.com/klauspost/reedsolomon -- Reed-Solomon Erasure Coding in Go.
 3. https://en.wikipedia.org/wiki/Differentiated_services -- DSCP.
@@ -272,3 +348,4 @@ type Snmp struct {
 11. https://tools.ietf.org/html/rfc5827 -- Early Retransmit for TCP and Stream Control Transmission Protocol (SCTP).
 12. http://http2.github.io/ -- What is HTTP/2?
 13. http://www.lartc.org/LARTC-zh_CN.GB2312.pdf -- Linux Advanced Routing & Traffic Control
+14. https://en.wikipedia.org/wiki/Noisy-channel_coding_theorem -- Noisy channel coding theorem

build-release.sh

@@ -12,7 +12,7 @@ fi
 
 VERSION=`date -u +%Y%m%d`
 LDFLAGS="-X main.VERSION=$VERSION -s -w"
-GCFLAGS="-B"
+GCFLAGS=""
 
 OSES=(linux darwin windows freebsd)
 ARCHS=(amd64 386)
@@ -40,3 +40,11 @@ done
 if $UPX; then upx -9 client_linux_arm* server_linux_arm*;fi
 tar -zcf kcptun-linux-arm-$VERSION.tar.gz client_linux_arm* server_linux_arm*
 $MD5 kcptun-linux-arm-$VERSION.tar.gz
+
+#MIPS32LE
+env CGO_ENABLED=0 GOOS=linux GOARCH=mipsle go build -ldflags "$LDFLAGS" -gcflags "$GCFLAGS" -o client_linux_mipsle github.com/xtaci/kcptun/client
+env CGO_ENABLED=0 GOOS=linux GOARCH=mipsle go build -ldflags "$LDFLAGS" -gcflags "$GCFLAGS" -o server_linux_mipsle github.com/xtaci/kcptun/server
+
+if $UPX; then upx -9 client_linux_mipsle server_linux_mipsle;fi
+tar -zcf kcptun-linux-mipsle-$VERSION.tar.gz client_linux_mipsle server_linux_mipsle
+$MD5 kcptun-linux-mipsle-$VERSION.tar.gz

client/config.go

@@ -5,6 +5,7 @@ import (
 	"os"
 )
 
+// Config for client
 type Config struct {
 	LocalAddr    string `json:"localaddr"`
 	RemoteAddr   string `json:"remoteaddr"`
@@ -27,18 +28,15 @@ type Config struct {
 	NoCongestion int    `json:"nc"`
 	SockBuf      int    `json:"sockbuf"`
 	KeepAlive    int    `json:"keepalive"`
+	Log          string `json:"log"`
 }
 
-func parseJsonConfig(config *Config, path string) error {
+func parseJSONConfig(config *Config, path string) error {
 	file, err := os.Open(path) // For read access.
 	if err != nil {
 		return err
 	}
 	defer file.Close()
 
-	if err = json.NewDecoder(file).Decode(config); err != nil {
-		return err
-	}
-
-	return err
+	return json.NewDecoder(file).Decode(config)
 }

client/main.go

@@ -7,15 +7,15 @@ import (
 	"math/rand"
 	"net"
 	"os"
-	"runtime"
 	"time"
 
 	"golang.org/x/crypto/pbkdf2"
 
-	"github.com/golang/snappy"
+	"github.com/klauspost/compress/snappy"
+	"github.com/pkg/errors"
 	"github.com/urfave/cli"
 	kcp "github.com/xtaci/kcp-go"
-	"github.com/xtaci/yamux"
+	"github.com/xtaci/smux"
 )
 
 var (
@@ -61,16 +61,10 @@ func handleClient(p1, p2 io.ReadWriteCloser) {
 
 	// start tunnel
 	p1die := make(chan struct{})
-	go func() {
-		io.Copy(p1, p2)
-		close(p1die)
-	}()
+	go func() { io.Copy(p1, p2); close(p1die) }()
 
 	p2die := make(chan struct{})
-	go func() {
-		io.Copy(p2, p1)
-		close(p2die)
-	}()
+	go func() { io.Copy(p2, p1); close(p2die) }()
 
 	// wait for tunnel termination
 	select {
@@ -94,7 +88,7 @@ func main() {
 	}
 	myApp := cli.NewApp()
 	myApp.Name = "kcptun"
-	myApp.Usage = "kcptun client"
+	myApp.Usage = "client(with SMUX)"
 	myApp.Version = VERSION
 	myApp.Flags = []cli.Flag{
 		cli.StringFlag{
@@ -202,6 +196,11 @@ func main() {
 			Value:  10, // nat keepalive interval in seconds
 			Hidden: true,
 		},
+		cli.StringFlag{
+			Name:  "log",
+			Value: "",
+			Usage: "specify a log file to output, default goes to stderr",
+		},
 		cli.StringFlag{
 			Name:  "c",
 			Value: "", // when the value is not empty, the config path must exists
@@ -231,12 +230,21 @@ func main() {
 		config.NoCongestion = c.Int("nc")
 		config.SockBuf = c.Int("sockbuf")
 		config.KeepAlive = c.Int("keepalive")
+		config.Log = c.String("log")
 
 		if c.String("c") != "" {
-			err := parseJsonConfig(&config, c.String("c"))
+			err := parseJSONConfig(&config, c.String("c"))
 			checkError(err)
 		}
 
+		// log redirect
+		if config.Log != "" {
+			f, err := os.OpenFile(config.Log, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
+			checkError(err)
+			defer f.Close()
+			log.SetOutput(f)
+		}
+
 		switch config.Mode {
 		case "normal":
 			config.NoDelay, config.Interval, config.Resend, config.NoCongestion = 0, 30, 2, 1
@@ -299,17 +307,14 @@ func main() {
 		log.Println("conn:", config.Conn)
 		log.Println("autoexpire:", config.AutoExpire)
 
-		yconfig := &yamux.Config{
-			AcceptBacklog:          256,
-			EnableKeepAlive:        true,
-			KeepAliveInterval:      30 * time.Second,
-			ConnectionWriteTimeout: 10 * time.Second,
-			MaxStreamWindowSize:    uint32(config.SockBuf),
-			LogOutput:              os.Stderr,
-		}
-		createConn := func() *yamux.Session {
+		smuxConfig := smux.DefaultConfig()
+		smuxConfig.MaxReceiveBuffer = config.SockBuf
+
+		createConn := func() (*smux.Session, error) {
 			kcpconn, err := kcp.DialWithOptions(config.RemoteAddr, block, config.DataShard, config.ParityShard)
-			checkError(err)
+			if err != nil {
+				return nil, errors.Wrap(err, "createConn()")
+			}
 			kcpconn.SetStreamMode(true)
 			kcpconn.SetNoDelay(config.NoDelay, config.Interval, config.Resend, config.NoCongestion)
 			kcpconn.SetWindowSize(config.SndWnd, config.RcvWnd)
@@ -328,30 +333,44 @@ func main() {
 			}
 
 			// stream multiplex
-			var session *yamux.Session
+			var session *smux.Session
 			if config.NoComp {
-				session, err = yamux.Client(kcpconn, yconfig)
+				session, err = smux.Client(kcpconn, smuxConfig)
 			} else {
-				session, err = yamux.Client(newCompStream(kcpconn), yconfig)
+				session, err = smux.Client(newCompStream(kcpconn), smuxConfig)
+			}
+			if err != nil {
+				return nil, errors.Wrap(err, "createConn()")
+			}
+			return session, nil
+		}
+
+		// wait until a connection is ready
+		waitConn := func() *smux.Session {
+			for {
+				if session, err := createConn(); err == nil {
+					return session
+				} else {
+					time.Sleep(time.Second)
+				}
 			}
-			checkError(err)
-			runtime.SetFinalizer(session, func(s *yamux.Session) {
-				s.Close()
-			})
-			return session
 		}
 
 		numconn := uint16(config.Conn)
 		muxes := make([]struct {
-			session *yamux.Session
+			session *smux.Session
 			ttl     time.Time
 		}, numconn)
 
 		for k := range muxes {
-			muxes[k].session = createConn()
+			sess, err := createConn()
+			checkError(err)
+			muxes[k].session = sess
 			muxes[k].ttl = time.Now().Add(time.Duration(config.AutoExpire) * time.Second)
 		}
 
+		chScavenger := make(chan *smux.Session, 128)
+		go scavenger(chScavenger)
 		rr := uint16(0)
 		for {
 			p1, err := listener.AcceptTCP()
@@ -367,15 +386,16 @@ func main() {
 		OPEN_P2:
 			// do auto expiration
 			if config.AutoExpire > 0 && time.Now().After(muxes[idx].ttl) {
-				log.Println("autoexpired")
-				muxes[idx].session = createConn()
+				chScavenger <- muxes[idx].session
+				muxes[idx].session = waitConn()
 				muxes[idx].ttl = time.Now().Add(time.Duration(config.AutoExpire) * time.Second)
 			}
 
 			// do session open
-			p2, err := muxes[idx].session.Open()
-			if err != nil { // yamux failure
-				muxes[idx].session = createConn()
+			p2, err := muxes[idx].session.OpenStream()
+			if err != nil { // mux failure
+				chScavenger <- muxes[idx].session
+				muxes[idx].session = waitConn()
 				muxes[idx].ttl = time.Now().Add(time.Duration(config.AutoExpire) * time.Second)
 				goto OPEN_P2
 			}
@@ -385,3 +405,36 @@ func main() {
 	}
 	myApp.Run(os.Args)
 }
+
+type scavengeSession struct {
+	session *smux.Session
+	ttl     time.Time
+}
+
+const (
+	maxScavengeTTL = 10 * time.Minute
+)
+
+func scavenger(ch chan *smux.Session) {
+	ticker := time.NewTicker(30 * time.Second)
+	defer ticker.Stop()
+	var sessionList []scavengeSession
+	for {
+		select {
+		case sess := <-ch:
+			sessionList = append(sessionList, scavengeSession{sess, time.Now()})
+		case <-ticker.C:
+			var newList []scavengeSession
+			for k := range sessionList {
+				s := sessionList[k]
+				if s.session.NumStreams() == 0 || s.session.IsClosed() || time.Since(s.ttl) > maxScavengeTTL {
+					log.Println("session scavenged")
+					s.session.Close()
+				} else {
+					newList = append(newList, sessionList[k])
+				}
+			}
+			sessionList = newList
+		}
+	}
+}

server/config.go

@@ -5,6 +5,7 @@ import (
 	"os"
 )
 
+// Config for server
 type Config struct {
 	Listen       string `json:"listen"`
 	Target       string `json:"target"`
@@ -25,18 +26,15 @@ type Config struct {
 	NoCongestion int    `json:"nc"`
 	SockBuf      int    `json:"sockbuf"`
 	KeepAlive    int    `json:"keepalive"`
+	Log          string `json:"log"`
 }
 
-func parseJsonConfig(config *Config, path string) error {
+func parseJSONConfig(config *Config, path string) error {
 	file, err := os.Open(path) // For read access.
 	if err != nil {
 		return err
 	}
 	defer file.Close()
 
-	if err = json.NewDecoder(file).Decode(config); err != nil {
-		return err
-	}
-
-	return err
+	return json.NewDecoder(file).Decode(config)
 }

server/main.go

@@ -11,10 +11,10 @@ import (
 
 	"golang.org/x/crypto/pbkdf2"
 
-	"github.com/golang/snappy"
+	"github.com/klauspost/compress/snappy"
 	"github.com/urfave/cli"
 	kcp "github.com/xtaci/kcp-go"
-	"github.com/xtaci/yamux"
+	"github.com/xtaci/smux"
 )
 
 var (
@@ -53,35 +53,34 @@ func newCompStream(conn net.Conn) *compStream {
 }
 
 // handle multiplex-ed connection
-func handleMux(conn io.ReadWriteCloser, target string, config *yamux.Config) {
+func handleMux(conn io.ReadWriteCloser, config *Config) {
 	// stream multiplex
-	mux, err := yamux.Server(conn, config)
+	smuxConfig := smux.DefaultConfig()
+	smuxConfig.MaxReceiveBuffer = config.SockBuf
+	mux, err := smux.Server(conn, smuxConfig)
 	if err != nil {
 		log.Println(err)
 		return
 	}
 	defer mux.Close()
 	for {
-		p1, err := mux.Accept()
+		p1, err := mux.AcceptStream()
 		if err != nil {
 			log.Println(err)
 			return
 		}
-		sockbuf := int(config.MaxStreamWindowSize)
-		p2, err := net.DialTimeout("tcp", target, 5*time.Second)
+		p2, err := net.DialTimeout("tcp", config.Target, 5*time.Second)
 		if err != nil {
 			p1.Close()
 			log.Println(err)
 			continue
 		}
-
-		if err := p2.(*net.TCPConn).SetReadBuffer(sockbuf); err != nil {
+		if err := p2.(*net.TCPConn).SetReadBuffer(config.SockBuf); err != nil {
 			log.Println("TCP SetReadBuffer:", err)
 		}
-		if err := p2.(*net.TCPConn).SetWriteBuffer(sockbuf); err != nil {
+		if err := p2.(*net.TCPConn).SetWriteBuffer(config.SockBuf); err != nil {
 			log.Println("TCP SetWriteBuffer:", err)
 		}
-
 		go handleClient(p1, p2)
 	}
 }
@@ -94,16 +93,10 @@ func handleClient(p1, p2 io.ReadWriteCloser) {
 
 	// start tunnel
 	p1die := make(chan struct{})
-	go func() {
-		io.Copy(p1, p2)
-		close(p1die)
-	}()
+	go func() { io.Copy(p1, p2); close(p1die) }()
 
 	p2die := make(chan struct{})
-	go func() {
-		io.Copy(p2, p1)
-		close(p2die)
-	}()
+	go func() { io.Copy(p2, p1); close(p2die) }()
 
 	// wait for tunnel termination
 	select {
@@ -127,7 +120,7 @@ func main() {
 	}
 	myApp := cli.NewApp()
 	myApp.Name = "kcptun"
-	myApp.Usage = "kcptun server"
+	myApp.Usage = "server(with SMUX)"
 	myApp.Version = VERSION
 	myApp.Flags = []cli.Flag{
 		cli.StringFlag{
@@ -225,6 +218,11 @@ func main() {
 			Value:  10, // nat keepalive interval in seconds
 			Hidden: true,
 		},
+		cli.StringFlag{
+			Name:  "log",
+			Value: "",
+			Usage: "specify a log file to output, default goes to stderr",
+		},
 		cli.StringFlag{
 			Name:  "c",
 			Value: "", // when the value is not empty, the config path must exists
@@ -252,13 +250,22 @@ func main() {
 		config.NoCongestion = c.Int("nc")
 		config.SockBuf = c.Int("sockbuf")
 		config.KeepAlive = c.Int("keepalive")
+		config.Log = c.String("log")
 
 		if c.String("c") != "" {
 			//Now only support json config file
-			err := parseJsonConfig(&config, c.String("c"))
+			err := parseJSONConfig(&config, c.String("c"))
 			checkError(err)
 		}
 
+		// log redirect
+		if config.Log != "" {
+			f, err := os.OpenFile(config.Log, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
+			checkError(err)
+			defer f.Close()
+			log.SetOutput(f)
+		}
+
 		switch config.Mode {
 		case "normal":
 			config.NoDelay, config.Interval, config.Resend, config.NoCongestion = 0, 30, 2, 1
@@ -325,14 +332,6 @@ func main() {
 		if err := lis.SetWriteBuffer(config.SockBuf); err != nil {
 			log.Println("SetWriteBuffer:", err)
 		}
-		yconfig := &yamux.Config{
-			AcceptBacklog:          256,
-			EnableKeepAlive:        true,
-			KeepAliveInterval:      30 * time.Second,
-			ConnectionWriteTimeout: 10 * time.Second,
-			MaxStreamWindowSize:    uint32(config.SockBuf),
-			LogOutput:              os.Stderr,
-		}
 		for {
 			if conn, err := lis.AcceptKCP(); err == nil {
 				log.Println("remote address:", conn.RemoteAddr())
@@ -344,9 +343,9 @@ func main() {
 				conn.SetKeepAlive(config.KeepAlive)
 
 				if config.NoComp {
-					go handleMux(conn, config.Target, yconfig)
+					go handleMux(conn, &config)
 				} else {
-					go handleMux(newCompStream(conn), config.Target, yconfig)
+					go handleMux(newCompStream(conn), &config)
 				}
 			} else {
 				log.Printf("%+v", err)