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

# Conflicts:
#	server/main.go

Author: flynaj

.github/ISSUE_TEMPLATE

@@ -1,27 +1,29 @@
 问问题前先搜索ISSUE，并搞清楚下面的问题:
 
 1. 检查 ```-key xxx``` 至少三遍, ***保证***两边一致。
-2. 保证```-nocomp, -datashard, -parityshard,  -key, -crypt```两边一致。
+2. 保证```-nocomp, -datashard, -parityshard,  -key, -crypt, -smuxver```两边一致。
 3. 是否在服务器端，正确设定了转发的目标服务器地址 ***--target***。
-4. 如果第3条不确定，尝试在服务器上telnet target port试试。
-5. 防火墙是否关闭了UDP通信。
-6. 两端的版本是否一致？
-7. 是不是最新版本？
-8. 两端分别是什么操作系统？
-9. 两端的输出日志是什么？
+4. 是否在客户端，正确的连接到了 client的监听端口。
+5. 如果第3条不确定，尝试在服务器上telnet target port试试。
+6. 防火墙是否关闭了UDP通信，或者设置了UDP的最大发包速率？
+7. 两端的版本是否一致？
+8. 是不是最新版本？
+9. 两端分别是什么操作系统？
+10. 两端的输出日志是什么？
 
 Before firing issue, make sure you figured out the following common questions.
 
 PLEASE DO SEARCH FIRST.
 
 1. Check your ```-key xxx``` for at least 3 times, ***MAKE SURE*** both sides share the same secret.
-2. ```-nocomp, -datashard, -parityshard,  -key, -crypt``` ***must be the same*** on both side.
+2. ```-nocomp, -datashard, -parityshard,  -key, -crypt, -smuxver``` ***must be the same*** on both side.
 3. Did you correctly set the ***-target*** on the server side?
-4. ***MAKE SURE*** ```telnet target port``` on your server successful(don't ask me why couldn't).
-5. Does your ***firewall allows UDP*** communications? (including your ISP Cable-Modem)
-6. Are you using the **same version** for both client & server
-7. Are you using the **latest release**?
-8. Which **OS** do you use?
-9. Which end for this issue related to, **client or server**?
+4. Did you correctly connected to the listening port on client side?
+5. ***MAKE SURE*** ```telnet target port``` on your server successful(don't ask me why couldn't).
+6. Does your ***firewall allows UDP*** communications? (including your ISP Cable-Modem)
+7. Are you using the **same version** for both client & server
+8. Are you using the **latest release**?
+9. Which **OS** do you use?
+10. Which end for this issue related to, **client or server**?
 
 

.travis.yml

@@ -1,18 +1,18 @@
 language: go
 go:
-    - 1.10.x
     - 1.11.x
     - 1.12.x
+    - 1.13.x
 before_install:
     - go get github.com/mattn/goveralls
     - go get golang.org/x/tools/cmd/cover
 install:
-    - go get github.com/xtaci/kcptun/client
-    - go get github.com/xtaci/kcptun/server
+    - env GO111MODULE=on go get github.com/xtaci/kcptun/client
+    - env GO111MODULE=on go get github.com/xtaci/kcptun/server
 before_script:
 script:
     - cd $HOME/gopath/src/github.com/xtaci/kcptun/client
-    - $HOME/gopath/bin/goveralls -service=travis-ci
+    - env GO111MODULE=on $HOME/gopath/bin/goveralls -service=travis-ci
     - cd $HOME/gopath/src/github.com/xtaci/kcptun/server
-    - $HOME/gopath/bin/goveralls -service=travis-ci
+    - env GO111MODULE=on $HOME/gopath/bin/goveralls -service=travis-ci
     - exit 0

Dockerfile

@@ -1,5 +1,6 @@
 FROM golang:alpine as builder
 MAINTAINER xtaci <[email protected]>
+ENV GO111MODULE=on
 RUN apk update && \
     apk upgrade && \
     apk add git gcc libc-dev linux-headers

README.md

@@ -8,13 +8,11 @@
 [4]: https://travis-ci.org/xtaci/kcptun
 [5]: https://goreportcard.com/badge/github.com/xtaci/kcptun
 [6]: https://goreportcard.com/report/github.com/xtaci/kcptun
-[7]: https://img.shields.io/badge/license-MIT-blue.svg
-[8]: https://raw.githubusercontent.com/xtaci/kcptun/master/LICENSE.md
-[11]: https://img.shields.io/badge/license-MIT-blue.svg
+[11]: https://img.shields.io/github/license/xtaci/kcptun
 [12]: LICENSE.md
-[13]: https://img.shields.io/github/release/xtaci/kcptun.svg
+[13]: https://img.shields.io/github/v/release/xtaci/kcptun?color=orange
 [14]: https://github.com/xtaci/kcptun/releases/latest
-[15]: https://img.shields.io/github/downloads/xtaci/kcptun/total.svg?maxAge=1800
+[15]: https://img.shields.io/github/downloads/xtaci/kcptun/total.svg?maxAge=1800&color=red
 [16]: https://github.com/xtaci/kcptun/releases
 [17]: https://img.shields.io/badge/KCP-Powered-blue.svg
 [18]: https://github.com/skywind3000/kcp
@@ -23,6 +21,15 @@
 
 > *Disclaimer: kcptun maintains a single website — [github.com/xtaci/kcptun](https://github.com/xtaci/kcptun). Any websites other than [github.com/xtaci/kcptun](https://github.com/xtaci/kcptun) are not endorsed by xtaci.*
 
+### Requirements
+
+| Target | Minimum | Recommended |
+| --- | --- | --- |
+| System | aix darwin dragonfly freebsd linux netbsd openbsd solaris windows | linux |
+| Memory | >20MB | >32MB |
+| CPU | ANY | amd64 with AES-NI & AVX2 |
+
+
 ### QuickStart
 
 Increase the number of open files on your server, as:
@@ -59,10 +66,13 @@ which tunnels the original connection:
 
 > Application -> Target Server(8388/tcp) 
 
-### Install from source
+### Build from source
 
 ```
-$go get -u github.com/xtaci/kcptun/...
+$ git clone https://github.com/xtaci/kcptun.git
+$ cd kcptun
+$ ./build-release.sh
+$ cd build
 ```
 
 All precompiled releases are genereated from `build-release.sh` script.
@@ -105,6 +115,8 @@ All precompiled releases are genereated from `build-release.sh` script.
 Since streams are multiplexed into a single physical channel, head of line blocking may appear under certain circumstances, by
 increasing `-smuxbuf` to a larger value (default 4MB) may mitigate this problem, obviously this will costs more memory.
 
+For versions >= v20190924, you can switch to smux version 2, smux v2 has options to limit per-stream memory usage, now set `-smuxver 2` to enable smux v2, and adjust `-streambuf` to limit per-stream memory usage, eg: `-streambuf 2097152` can limit per-stream memory usage to 2MB. By limiting stream buffer on the receiver side, a back-pressure will be conducted to the sender and limits reading, and finally prevent source from sending too much data to occupy every bits of buffer along the link. (Setting -smuxver **MUST** be **IDENTICAL** on both side, default is 1. )
+
 #### Slow Devices
 
 kcptun made use of **ReedSolomon-Codes** to recover lost packets, which requires massive amount of computation, a low-end ARM device cannot satisfy kcptun well. To unleash the full potential of kcptun, a multi-core x86 homeserver CPU like AMD Opteron is recommended.
@@ -119,18 +131,18 @@ If you insist on running under some ARM routers, you'd better turn off `FEC` and
 #### Usage
 
 ```
-xtaci@gw:~$ ./client_linux_amd64 -h
+➜  ~ ./client_linux_amd64 -h
 NAME:
    kcptun - client(with SMUX)
 
 USAGE:
    client_linux_amd64 [global options] command [command options] [arguments...]
 
 VERSION:
-   20190409
+   20190924
 
 COMMANDS:
-     help, h  Shows a list of commands or help for one command
+   help, h  Shows a list of commands or help for one command
 
 GLOBAL OPTIONS:
    --localaddr value, -l value      local listen address (default: ":12948")
@@ -149,32 +161,35 @@ GLOBAL OPTIONS:
    --dscp value                     set DSCP(6bit) (default: 0)
    --nocomp                         disable compression
    --sockbuf value                  per-socket buffer in bytes (default: 4194304)
+   --smuxver value                  specify smux version, available 1,2 (default: 1)
    --smuxbuf value                  the overall de-mux buffer in bytes (default: 4194304)
+   --streambuf value                per stream receive buffer in bytes, smux v2+ (default: 2097152)
    --keepalive value                seconds between heartbeats (default: 10)
    --snmplog value                  collect snmp to file, aware of timeformat in golang, like: ./snmp-20060102.log
    --snmpperiod value               snmp collect period, in seconds (default: 60)
    --log value                      specify a log file to output, default goes to stderr
    --quiet                          to suppress the 'stream open/close' messages
+   --tcp                            to emulate a TCP connection(linux)
    -c value                         config from json file, which will override the command from shell
    --help, -h                       show help
    --version, -v                    print the version
    
-xtaci@gw:~$ ./server_linux_amd64 -h
+➜  ~ ./server_linux_amd64 -h
 NAME:
    kcptun - server(with SMUX)
 
 USAGE:
    server_linux_amd64 [global options] command [command options] [arguments...]
 
 VERSION:
-   20190409
+   20190924
 
 COMMANDS:
-     help, h  Shows a list of commands or help for one command
+   help, h  Shows a list of commands or help for one command
 
 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")
+   --target value, -t value         target server address, or path/to/unix_socket (default: "127.0.0.1:12948")
    --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, sm4, none (default: "aes")
    --mode value                     profiles: fast3, fast2, fast, normal, manual (default: "fast")
@@ -186,13 +201,16 @@ GLOBAL OPTIONS:
    --dscp value                     set DSCP(6bit) (default: 0)
    --nocomp                         disable compression
    --sockbuf value                  per-socket buffer in bytes (default: 4194304)
+   --smuxver value                  specify smux version, available 1,2 (default: 1)
    --smuxbuf value                  the overall de-mux buffer in bytes (default: 4194304)
+   --streambuf value                per stream receive buffer in bytes, smux v2+ (default: 2097152)
    --keepalive value                seconds between heartbeats (default: 10)
    --snmplog value                  collect snmp to file, aware of timeformat in golang, like: ./snmp-20060102.log
    --snmpperiod value               snmp collect period, in seconds (default: 60)
    --pprof                          start profiling server on :6060
    --log value                      specify a log file to output, default goes to stderr
    --quiet                          to suppress the 'stream open/close' messages
+   --tcp                            to emulate a TCP connection(linux)
    -c value                         config from json file, which will override the command from shell
    --help, -h                       show help
    --version, -v                    print the version
@@ -346,6 +364,7 @@ The parameters below **MUST** be **IDENTICAL** on **BOTH** side:
 1. -nocomp
 1. -datashard
 1. -parityshard
+1. -smuxver
 
 ### References
 
@@ -366,14 +385,5 @@ The parameters below **MUST** be **IDENTICAL** on **BOTH** side:
 1. https://en.wikipedia.org/wiki/Noisy-channel_coding_theorem -- Noisy channel coding theorem
 1. https://zhuanlan.zhihu.com/p/53849089 -- kcptun开发小记
 
-### Donate 
-
-via Ethereum(ETH): Address: 0x2e4b43ab3d0983da282592571eef61ae5e60f726 , Or scan here:
-
-<img src="0x2e4b43ab3d0983da282592571eef61ae5e60f726.png" alt="kcptun" height="120px" /> 
-
-via WeChat
-
-<img src="wechat_donate.jpg" alt="kcptun" height="120px" /> 
 
 （注意：我没有任何社交网站的账号，请小心骗子。）

build-release.sh

@@ -6,11 +6,8 @@ cd $BUILD_DIR
 
 sum="sha1sum"
 
-if [ "$GO111MODULE" != "on" ]; then
-	echo "GO111MODULE is off"
-else
-	echo "GO111MODULE is on"
-fi 
+export GO111MODULE=on
+echo "Setting GO111MODULE to" $GO111MODULE
 
 if ! hash sha1sum 2>/dev/null; then
 	if ! hash shasum 2>/dev/null; then

client/config.go

@@ -28,7 +28,9 @@ type Config struct {
 	Resend       int    `json:"resend"`
 	NoCongestion int    `json:"nc"`
 	SockBuf      int    `json:"sockbuf"`
+	SmuxVer      int    `json:"smuxver"`
 	SmuxBuf      int    `json:"smuxbuf"`
+	StreamBuf    int    `json:"streambuf"`
 	KeepAlive    int    `json:"keepalive"`
 	Log          string `json:"log"`
 	SnmpLog      string `json:"snmplog"`

client/dial.go

@@ -2,7 +2,7 @@ package main
 
 import (
 	"github.com/pkg/errors"
-	kcp "github.com/xtaci/kcp-go"
+	kcp "github.com/xtaci/kcp-go/v5"
 	"github.com/xtaci/tcpraw"
 )