mnet 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02c89a77bbd53a45c2ad2a959619b84f620f8b6fbe46009d58cac1a86853d378
-  data.tar.gz: ae87b7f42b17168b543ee95ae4bbfc24dde6c46c45c6fe1cf9ece66a9bae4104
+  metadata.gz: d0fbab81dc8d236bf99365375204d8a88fddc69bdd739873c9a911257db6da0a
+  data.tar.gz: 55bda39f9f15c785493da5938b8c1489dd624a28da79469276cae8460422854c
 SHA512:
-  metadata.gz: eedc601d6d212724810a1c8ee7884cdde278c9f319c68d3c6fdc8b664d41e80fdd9dc6bad76da4bb3141871e13582f0c4f8105e5c115f23c4bb91752eb2b18d3
-  data.tar.gz: 75450fbd37c26607fd69f967abee32b1a157288abb41b48ae3b5190a6285b3c2a6932f27d7f686afcb49d8e6e0ee3f3d60b040c4e5f24135c7500fc8dc3b788b
+  metadata.gz: 73998b8ba73cf9d787d41576c578f44183c3f3c5365d8131d8af3912cc688cb06812dc0dae1298e2b993e3ea521c9748dc0152f50e52bcfed8377299c2683ca7
+  data.tar.gz: ec19fe682e1672d3948df00c8ea5ebb7222fac2d3527daa81ad6d48f5fc6a142cfcbdf7f621a063d49b9a1ebf930d3b10a9c42bb25cec02a246a1ce28b0b5f6b

data/README.en.md

@@ -51,6 +51,11 @@ puts sess.readpartial(1024)
 | `:mnet` | pure-Ruby ARQ, no C dependency, simple and easy to debug |
 | `:kcp` | C engine (via the `kcp` gem), ~8x faster, requires building a native extension |
 
+> With `proto: :kcp`, mnet automatically sizes the KCP engine's MTU to
+> `IP_MTU(1280) - Mnet header(41) - GCM overhead(28, only when a key is used)`, so the full
+> datagram (Mnet header + KCP packet [+ encryption]) stays within the link MTU and is never
+> IP-fragmented. Override it with the `kcp_mtu:` option if needed.
+
 ## Encryption (pre-shared key)
 
 Per-packet AES-256-GCM; both ends must pre-share the same 32-byte key:

data/README.md

@@ -49,6 +49,11 @@ puts sess.readpartial(1024)
 | `:mnet` | 纯 Ruby ARQ，无 C 依赖，简单、易调试 |
 | `:kcp` | C 引擎（依赖 `kcp` gem），快约 8 倍，需编译原生扩展 |
 
+> `proto: :kcp` 时，mnet 会自动把 KCP 引擎的 MTU 设为
+> `IP_MTU(1280) - Mnet 头(41) - 加密开销(28，仅启用 key 时)`，
+> 使「Mnet 头 + KCP 包（+ 加密）」整包不超过链路 MTU，避免 IP 分片。
+> 如需自定义可用 `kcp_mtu:` 选项覆盖。
+
 ## 加密（预共享密钥）
 
 每包 AES-256-GCM，两端需预共享同一个 32 字节密钥：

data/lib/mnet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mnet
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/lib/mnet.rb

@@ -35,6 +35,9 @@ module Mnet
   # IP(20) + UDP(8) + our header + GCM tag(16) leaves ~1190 for a segment.
   DEFAULT_MSS  = 1200
 
+  # AES-256-GCM 每包的额外开销：12 字节 nonce + 16 字节认证标签。
+  GCM_OVERHEAD = 28
+
   # RTO bounds (mosh: MIN_RTO = 50ms, MAX_RTO = 1000ms).
   MIN_RTO = 0.05
   MAX_RTO = 1.0
@@ -59,6 +62,10 @@ module Mnet
   FLAG_MIGRATE = 0x01
   FLAG_KCP     = 0x02 # session uses the KCP (C) engine instead of the Ruby ARQ
 
+  # KCP 接收窗口（ikcp.c 内 IKCP_WND_RCV，固定 128）。单次 ikcp_send 超过
+  # 窗口大小的分段数会返回 -2 丢弃，故 KcpSession#write 按此切块。
+  KCP_WND_RCV  = 128
+
   HEADER_LEN   = MAGIC_LEN + SESSION_ID_LEN + 8 + 8 + 1 + 1 + 4
 
   MAX_RETRIES  = 10
@@ -108,6 +115,13 @@ module Mnet
     OpenSSL::Digest::SHA256.digest(key)[0, SESSION_ID_LEN]
   end
 
+  # KCP 引擎的 MTU。每个 KCP 包会被整体包进 Mnet 头（HEADER_LEN）再作为单个
+  # UDP 数据报发送，加密时还要再叠加 GCM 开销，因此 KCP 自身的 MTU 必须为这些
+  # 开销留出空间，保证整包 <= IP_MTU，避免 IP 分片（移动网络/VPN 下分片极易丢）。
+  def kcp_mtu(key = nil)
+    IP_MTU - HEADER_LEN - (key ? GCM_OVERHEAD : 0)
+  end
+
   # A connected stream socket pair, portable across Windows/Linux/macOS.
   # Prefers a UNIX socketpair; falls back to a loopback TCP pair where AF_UNIX
   # socketpair is unavailable (Windows).
@@ -681,6 +695,7 @@ module Mnet
 
       @conv   = id.unpack1("N") # KCP conv derived from the session id
       @engine = Kcp::Engine.new(@conv)
+      @engine.setmtu(opts.fetch(:kcp_mtu, Mnet.kcp_mtu(@key)))
 
       @m  = Monitor.new
       @cv = @m.new_cond
@@ -715,10 +730,21 @@ module Mnet
       data = data.to_s.b
       return 0 if data.empty?
 
+      total = data.bytesize
       @m.synchronize do
         return 0 if @closed || @eof
-        @engine.send(data)
-        pump_output
+
+        # ikcp_send 单次最多接受 IKCP_WND_RCV(128) 个分段，超出会返回 -2 把整块
+        # 数据静默丢弃。这里按 (mss * (窗口-1)) 切块喂入，避免大块写被丢。
+        chunk = @engine.mss * (KCP_WND_RCV - 1)
+        offset = 0
+        while offset < total
+          n = [chunk, total - offset].min
+          queued = @engine.send(data.byteslice(offset, n))
+          break if queued <= 0
+          offset += queued
+          pump_output
+        end
       end
       # 窗口满（有积压）时让出 GVL，避免写线程紧循环饿死处理 ACK 的传输线程。
       Thread.pass if @engine.waitsnd > 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mnet
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - mnet developers