-
Notifications
You must be signed in to change notification settings - Fork 792
Expand file tree
/
Copy pathsess.go
More file actions
1534 lines (1316 loc) · 43.6 KB
/
sess.go
File metadata and controls
1534 lines (1316 loc) · 43.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// The MIT License (MIT)
//
// # Copyright (c) 2015 xtaci
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
// [THE GENERALIZED DATA PIPELINE FOR KCP-GO]
//
// Outgoing Data Pipeline: Incoming Data Pipeline:
// Stream (Input Data) Packet Network (Network Interface Card)
// | |
// v v
// KCP Output (Reliable Transport Layer) Reader/Listener (Reception Queue)
// | |
// v v
// FEC Encoding (Forward Error Correction) Decryption (Data Security)
// | |
// v v
// CRC32 Checksum (Error Detection) CRC32 Checksum (Error Detection)
// | |
// v v
// Encryption (Data Security) FEC Decoding (Forward Error Correction)
// | |
// v v
// TxQueue (Transmission Queue) KCP Input (Reliable Transport Layer)
// | |
// v v
// Packet Network (Network Transmission) Stream (Input Data)
package kcp
import (
"context"
"crypto/rand"
"encoding/binary"
"hash/crc32"
"io"
"net"
"sync"
"sync/atomic"
"time"
"github.com/pkg/errors"
"golang.org/x/net/ipv4"
"golang.org/x/net/ipv6"
"golang.org/x/time/rate"
)
// Session-layer constants
const (
// 16-bytes nonce for each packet
nonceSize = 16
// 4-bytes CRC32 checksum per packet
crcSize = 4
// overall crypto header size: nonce + CRC32
cryptHeaderSize = nonceSize + crcSize
// maximum packet size (Ethernet MTU)
mtuLimit = 1500
// conversation ID field size (bytes)
convSize = 4
// accept backlog: max pending connections for Listener
acceptBacklog = 128
// devBacklog: channel buffer size for post-processing pipeline
devBacklog = 2048
// max latency for consecutive FEC encoding (ms).
// If the interval between two data packets exceeds this,
// parity generation is skipped.
maxFECEncodeLatency = 500
// max number of packets batched in a single sendmmsg/writev call
maxBatchSize = 64
)
var (
errInvalidOperation = errors.New("invalid operation")
errTimeout = timeoutError{}
errNotOwner = errors.New("not the owner of this connection")
)
// timeoutError implements net.Error
type timeoutError struct{}
func (timeoutError) Error() string { return "timeout" }
func (timeoutError) Timeout() bool { return true }
func (timeoutError) Temporary() bool { return true }
// sendRequest defines a write request before encoding and transmission
type sendRequest struct {
buffer []byte
oob bool
}
// OOB callback function
type OOBCallBackType func([]byte)
type (
// UDPSession defines a KCP session implemented by UDP
UDPSession struct {
conn net.PacketConn // the underlying packet connection
ownConn bool // true if we created conn internally, false if provided by caller
kcp *KCP // KCP ARQ protocol
l *Listener // pointing to the Listener object if it's been accepted by a Listener
block BlockCrypt // block encryption object
// kcp receiving is based on packets
// recvbuf turns packets into stream
recvbuf []byte
bufptr []byte
// FEC codec
fecDecoder *fecDecoder
fecEncoder *fecEncoder
// settings
remote net.Addr // remote peer address
rd atomic.Value // read deadline
wd atomic.Value // write deadline
headerSize int // the header size additional to a KCP frame
ackNoDelay bool // send ack immediately for each incoming packet(testing purpose)
writeDelay bool // delay kcp.flush() for Write() for bulk transfer
dup int // duplicate udp packets(testing purpose)
// notifications
die chan struct{} // notify current session has Closed
dieOnce sync.Once
chReadEvent chan struct{} // notify Read() can be called without blocking
chWriteEvent chan struct{} // notify Write() can be called without blocking
// socket error handling
socketReadError atomic.Value
socketWriteError atomic.Value
chSocketReadError chan struct{}
chSocketWriteError chan struct{}
socketReadErrorOnce sync.Once
socketWriteErrorOnce sync.Once
// packets waiting to be sent on wire
chPostProcessing chan sendRequest
// platform-dependent optimizations
platform platform
// rate limiter (bytes per second)
rateLimiter atomic.Value
mu sync.Mutex
// callbackForOOB is an optional callback for handling received out-of-band (OOB) data.
//
// OOB data bypasses the KCP reliable data path and is delivered unreliably.
// The callback is invoked synchronously from the KCP input processing path.
callbackForOOB atomic.Value
}
setReadBuffer interface {
SetReadBuffer(bytes int) error
}
setWriteBuffer interface {
SetWriteBuffer(bytes int) error
}
setDSCP interface {
SetDSCP(int) error
}
)
// newUDPSession create a new udp session for client or server
func newUDPSession(conv uint32, dataShards, parityShards int, l *Listener, conn net.PacketConn, ownConn bool, remote net.Addr, block BlockCrypt) *UDPSession {
sess := new(UDPSession)
sess.die = make(chan struct{})
sess.chReadEvent = make(chan struct{}, 1)
sess.chWriteEvent = make(chan struct{}, 1)
sess.chSocketReadError = make(chan struct{})
sess.chSocketWriteError = make(chan struct{})
sess.chPostProcessing = make(chan sendRequest, devBacklog)
sess.remote = remote
sess.conn = conn
sess.ownConn = ownConn
sess.l = l
sess.block = block
sess.recvbuf = make([]byte, mtuLimit)
sess.initPlatform()
// calculate additional header size introduced by encryption
switch block := sess.block.(type) {
case nil:
sess.headerSize = 0
case *aeadCrypt:
sess.headerSize = block.NonceSize()
default:
sess.headerSize = cryptHeaderSize
}
// FEC codec initialization
sess.fecDecoder = newFECDecoder(dataShards, parityShards)
sess.fecEncoder = newFECEncoder(dataShards, parityShards, sess.headerSize)
// calculate additional header size introduced by FEC
if sess.fecEncoder != nil {
sess.headerSize += fecHeaderSizePlus2
}
sess.kcp = NewKCP(conv, func(buf []byte, size int) {
// A basic check for the minimum packet size
if size >= IKCP_OVERHEAD {
// make a copy
bts := defaultBufferPool.Get()[:size+sess.headerSize]
// copy the data to a new buffer, and reserve header space
copy(bts[sess.headerSize:], buf)
// delivery to post processing (non-blocking to avoid deadlock under lock)
select {
case sess.chPostProcessing <- sendRequest{bts, false}:
case <-sess.die:
return
default:
// drop and recycle to avoid blocking; KCP will retransmit if needed
defaultBufferPool.Put(bts)
}
}
})
// Set Default MTU
if !sess.SetMtu(IKCP_MTU_DEF) {
panic("Overhead too large")
}
// create post-processing goroutine
go sess.postProcess()
if sess.l == nil { // it's a client connection
go sess.readLoop()
atomic.AddUint64(&DefaultSnmp.ActiveOpens, 1)
} else {
atomic.AddUint64(&DefaultSnmp.PassiveOpens, 1)
}
// start per-session updater
SystemTimedSched.Put(sess.update, time.Now())
currestab := atomic.AddUint64(&DefaultSnmp.CurrEstab, 1)
maxconn := atomic.LoadUint64(&DefaultSnmp.MaxConn)
if currestab > maxconn {
atomic.CompareAndSwapUint64(&DefaultSnmp.MaxConn, maxconn, currestab)
}
return sess
}
// Read implements net.Conn
func (s *UDPSession) Read(b []byte) (n int, err error) {
var timeout *time.Timer
var c <-chan time.Time
RESET_TIMER:
// deadline for current reading operation
if trd, ok := s.rd.Load().(time.Time); ok && !trd.IsZero() {
if timeout == nil {
timeout = time.NewTimer(time.Until(trd))
c = timeout.C
defer timeout.Stop()
} else {
// Pre-Go 1.23: Reset does not drain the channel;
// callers must drain at the goto-site before arriving here.
timeout.Reset(time.Until(trd))
}
} else if timeout != nil {
timeout.Stop()
c = nil // disable timeout select case
}
for {
s.mu.Lock()
// bufptr points to the current position of recvbuf,
// if previous 'b' is insufficient to accommodate the data, the
// remaining data will be stored in bufptr for next read.
if len(s.bufptr) > 0 {
n = copy(b, s.bufptr)
s.bufptr = s.bufptr[n:]
s.mu.Unlock()
atomic.AddUint64(&DefaultSnmp.BytesReceived, uint64(n))
return n, nil
}
if size := s.kcp.PeekSize(); size > 0 { // peek data size from kcp
// if 'b' is large enough to accommodate the data, read directly
// from kcp.recv() to 'b', like 'DMA'.
if len(b) >= size {
s.kcp.Recv(b)
s.mu.Unlock()
atomic.AddUint64(&DefaultSnmp.BytesReceived, uint64(size))
return size, nil
}
// otherwise, read to recvbuf first, then copy to 'b'.
// dynamically adjust the buffer size to the maximum of 'packet size' when necessary.
if cap(s.recvbuf) < size {
// usually recvbuf has a size of maximum packet size
s.recvbuf = make([]byte, size)
}
// resize the length of recvbuf to match the data size
s.recvbuf = s.recvbuf[:size]
s.kcp.Recv(s.recvbuf) // read data to recvbuf first
n = copy(b, s.recvbuf) // then copy bytes to 'b' as many as possible
s.bufptr = s.recvbuf[n:] // pointer update
s.mu.Unlock()
atomic.AddUint64(&DefaultSnmp.BytesReceived, uint64(n))
return n, nil
}
s.mu.Unlock()
// if it runs here, that means we have to block the call, and wait until the
// next data packet arrives.
select {
case <-s.chReadEvent:
if timeout != nil {
if !timeout.Stop() {
select {
case <-timeout.C:
default:
}
}
goto RESET_TIMER
}
case <-c:
return 0, errors.WithStack(errTimeout)
case <-s.chSocketReadError:
return 0, s.socketReadError.Load().(error)
case <-s.die:
return 0, errors.WithStack(io.ErrClosedPipe)
}
}
}
// Write implements net.Conn
func (s *UDPSession) Write(b []byte) (n int, err error) { return s.WriteBuffers([][]byte{b}) }
// WriteBuffers write a vector of byte slices to the underlying connection
func (s *UDPSession) WriteBuffers(v [][]byte) (n int, err error) {
var timeout *time.Timer
var c <-chan time.Time
RESET_TIMER:
if twd, ok := s.wd.Load().(time.Time); ok && !twd.IsZero() {
if timeout == nil {
timeout = time.NewTimer(time.Until(twd))
c = timeout.C
defer timeout.Stop()
} else {
// Pre-Go 1.23: Reset does not drain the channel;
// callers must drain at the goto-site before arriving here.
timeout.Reset(time.Until(twd))
}
} else if timeout != nil {
timeout.Stop()
c = nil // disable timeout select case
}
for {
// check for connection close and socket error
select {
case <-s.chSocketWriteError:
return 0, s.socketWriteError.Load().(error)
case <-s.die:
return 0, errors.WithStack(io.ErrClosedPipe)
default:
}
s.mu.Lock()
// make sure write do not overflow the max sliding window on both side
waitsnd := s.kcp.WaitSnd()
if waitsnd < int(s.kcp.snd_wnd) {
// transmit all data sequentially, make sure every packet size is within 'mss'
for _, b := range v {
n += len(b)
// handle each slice for packet splitting
for {
if len(b) <= int(s.kcp.mss) {
s.kcp.Send(b)
break
} else {
s.kcp.Send(b[:s.kcp.mss])
b = b[s.kcp.mss:]
}
}
}
waitsnd = s.kcp.WaitSnd()
if waitsnd >= int(s.kcp.snd_wnd) || !s.writeDelay {
// put the packets on wire immediately if the inflight window is full
// or if we've specified write no delay(NO merging of outgoing bytes)
// we don't have to wait until the periodical update() procedure uncorks.
s.kcp.flush(IKCP_FLUSH_FULL)
}
s.mu.Unlock()
atomic.AddUint64(&DefaultSnmp.BytesSent, uint64(n))
return n, nil
}
s.mu.Unlock()
// if it runs here, that means we have to block the call, and wait until the
// transmit buffer to become available again.
select {
case <-s.chWriteEvent:
if timeout != nil {
if !timeout.Stop() {
select {
case <-timeout.C:
default:
}
}
goto RESET_TIMER
}
case <-c:
return 0, errors.WithStack(errTimeout)
case <-s.chSocketWriteError:
return 0, s.socketWriteError.Load().(error)
case <-s.die:
return 0, errors.WithStack(io.ErrClosedPipe)
}
}
}
func (s *UDPSession) isClosed() bool {
select {
case <-s.die:
return true
default:
return false
}
}
// Close closes the connection.
func (s *UDPSession) Close() error {
var once bool
s.dieOnce.Do(func() {
close(s.die)
once = true
})
if !once {
return errors.WithStack(io.ErrClosedPipe)
}
atomic.AddUint64(&DefaultSnmp.CurrEstab, ^uint64(0))
// try best to send all queued messages especially the data in txqueue
s.mu.Lock()
s.kcp.flush((IKCP_FLUSH_FULL))
s.mu.Unlock()
if s.l != nil { // belongs to listener
s.l.closeSession(s.remote)
return nil
}
if s.ownConn { // client socket close
return s.conn.Close()
}
return nil
}
// LocalAddr returns the local network address. The Addr returned is shared by all invocations of LocalAddr, so do not modify it.
func (s *UDPSession) LocalAddr() net.Addr { return s.conn.LocalAddr() }
// RemoteAddr returns the remote network address. The Addr returned is shared by all invocations of RemoteAddr, so do not modify it.
func (s *UDPSession) RemoteAddr() net.Addr { return s.remote }
// SetDeadline sets the deadline associated with the listener. A zero time value disables the deadline.
func (s *UDPSession) SetDeadline(t time.Time) error {
s.rd.Store(t)
s.wd.Store(t)
s.notifyReadEvent()
s.notifyWriteEvent()
return nil
}
// SetReadDeadline implements the Conn SetReadDeadline method.
func (s *UDPSession) SetReadDeadline(t time.Time) error {
s.rd.Store(t)
s.notifyReadEvent()
return nil
}
// SetWriteDeadline implements the Conn SetWriteDeadline method.
func (s *UDPSession) SetWriteDeadline(t time.Time) error {
s.wd.Store(t)
s.notifyWriteEvent()
return nil
}
// SetWriteDelay delays write for bulk transfer until the next update interval
func (s *UDPSession) SetWriteDelay(delay bool) {
s.mu.Lock()
s.writeDelay = delay
s.mu.Unlock()
}
// SetWindowSize set maximum window size
func (s *UDPSession) SetWindowSize(sndwnd, rcvwnd int) {
s.mu.Lock()
s.kcp.WndSize(sndwnd, rcvwnd)
s.mu.Unlock()
}
// SetMtu sets the maximum transmission unit(not including UDP header)
func (s *UDPSession) SetMtu(mtu int) bool {
mtu = min(mtuLimit, mtu)
mtu -= s.headerSize
if aead, ok := s.block.(*aeadCrypt); ok {
mtu -= aead.Overhead()
}
s.mu.Lock()
defer s.mu.Unlock()
ret := s.kcp.SetMtu(mtu) // kcp mtu is not including udp header
return ret == 0
}
// Deprecated: toggles the stream mode on/off
func (s *UDPSession) SetStreamMode(enable bool) {
s.mu.Lock()
if enable {
s.kcp.stream = 1
} else {
s.kcp.stream = 0
}
s.mu.Unlock()
}
// SetACKNoDelay changes ack flush option, set true to flush ack immediately,
func (s *UDPSession) SetACKNoDelay(nodelay bool) {
s.mu.Lock()
s.ackNoDelay = nodelay
s.mu.Unlock()
}
// (deprecated)
//
// SetDUP duplicates udp packets for kcp output.
func (s *UDPSession) SetDUP(dup int) {
s.mu.Lock()
s.dup = dup
s.mu.Unlock()
}
// SetNoDelay calls nodelay() of kcp
// https://github.com/skywind3000/kcp/blob/master/README.en.md#protocol-configuration
func (s *UDPSession) SetNoDelay(nodelay, interval, resend, nc int) {
s.mu.Lock()
s.kcp.NoDelay(nodelay, interval, resend, nc)
s.mu.Unlock()
}
// SetDSCP sets the 6bit DSCP field in IPv4 header, or 8bit Traffic Class in IPv6 header.
//
// if the underlying connection has implemented `func SetDSCP(int) error`, SetDSCP() will invoke
// this function instead.
//
// It has no effect if it's accepted from Listener.
func (s *UDPSession) SetDSCP(dscp int) error {
s.mu.Lock()
defer s.mu.Unlock()
if s.l != nil {
return errInvalidOperation
}
// interface enabled
if ts, ok := s.conn.(setDSCP); ok {
return ts.SetDSCP(dscp)
}
if nc, ok := s.conn.(net.Conn); ok {
var succeed bool
if err := ipv4.NewConn(nc).SetTOS(dscp << 2); err == nil {
succeed = true
}
if err := ipv6.NewConn(nc).SetTrafficClass(dscp); err == nil {
succeed = true
}
if succeed {
return nil
}
}
return errInvalidOperation
}
// SetReadBuffer sets the socket read buffer, no effect if it's accepted from Listener
func (s *UDPSession) SetReadBuffer(bytes int) error {
s.mu.Lock()
defer s.mu.Unlock()
if s.l == nil {
if nc, ok := s.conn.(setReadBuffer); ok {
return nc.SetReadBuffer(bytes)
}
}
return errInvalidOperation
}
// SetWriteBuffer sets the socket write buffer, no effect if it's accepted from Listener
func (s *UDPSession) SetWriteBuffer(bytes int) error {
s.mu.Lock()
defer s.mu.Unlock()
if s.l == nil {
if nc, ok := s.conn.(setWriteBuffer); ok {
return nc.SetWriteBuffer(bytes)
}
}
return errInvalidOperation
}
// SetRateLimit sets the rate limit for this session in bytes per second,
// by setting to 0 will disable rate limiting.
func (s *UDPSession) SetRateLimit(bytesPerSecond uint32) {
var limiter *rate.Limiter
if bytesPerSecond == 0 {
limiter = rate.NewLimiter(rate.Inf, maxBatchSize*mtuLimit)
} else {
limiter = rate.NewLimiter(rate.Limit(bytesPerSecond), maxBatchSize*mtuLimit)
}
s.rateLimiter.Store(limiter)
}
// SetLogger configures the kcp trace logger
func (s *UDPSession) SetLogger(mask KCPLogType, logger logoutput_callback) {
s.kcp.SetLogger(mask, logger)
}
// Control applys a procedure to the underly socket fd.
// CAUTION: BE VERY CAREFUL TO USE THIS FUNCTION, YOU MAY BREAK THE PROTOCOL.
func (s *UDPSession) Control(f func(conn net.PacketConn) error) error {
if !s.ownConn {
return errNotOwner
}
s.mu.Lock()
defer s.mu.Unlock()
return f(s.conn)
}
// postProcess is the goroutine that handles the outgoing packet pipeline.
// It runs the following stages sequentially for each packet:
// 1. FEC encoding — generate parity shards (Reed-Solomon)
// 2. Encryption — AEAD (e.g. AES-GCM) or CFB mode with CRC32
// 3. TX batching — accumulate packets and flush via sendmmsg/writev
//
// Pipeline: KCP output -> chPostProcessing -> [FEC] -> [Encrypt] -> TxQueue -> Network
func (s *UDPSession) postProcess() {
txqueue := make([]ipv4.Message, 0, devBacklog)
chDie := s.die
ctx := context.Background()
bytesToSend := 0
for {
select {
case req := <-s.chPostProcessing: // dequeue from post processing
buf := req.buffer
oob := req.oob
var ecc [][]byte
// --- Stage 1: FEC encoding ---
if s.fecEncoder != nil {
if !oob {
ecc = s.fecEncoder.encode(buf, maxFECEncodeLatency)
} else {
s.fecEncoder.encodeOOB(buf)
}
}
// --- Stage 2: Encryption ---
// Two modes supported:
// - AEAD (e.g. AES-GCM): nonce + authenticated ciphertext, no separate CRC
// - CFB (legacy block ciphers): random nonce + CRC32 checksum + CFB encryption
switch block := s.block.(type) {
case nil:
case *aeadCrypt: // AEAD mode
nonceSize := block.NonceSize()
dst := buf[:nonceSize]
nonce := buf[:nonceSize]
plaintext := buf[nonceSize:]
fillRand(nonce)
buf = block.Seal(dst, nonce, plaintext, nil)
for k := range ecc {
dst := ecc[k][:nonceSize]
nonce := ecc[k][:nonceSize]
plaintext := ecc[k][nonceSize:]
fillRand(nonce)
ecc[k] = block.Seal(dst, nonce, plaintext, nil)
}
default: // Cipher Feedback (CFB) mode
fillRand(buf[:nonceSize])
checksum := crc32.ChecksumIEEE(buf[cryptHeaderSize:])
binary.LittleEndian.PutUint32(buf[nonceSize:], checksum)
block.Encrypt(buf, buf)
for k := range ecc {
fillRand(ecc[k][:nonceSize])
checksum := crc32.ChecksumIEEE(ecc[k][cryptHeaderSize:])
binary.LittleEndian.PutUint32(ecc[k][nonceSize:], checksum)
block.Encrypt(ecc[k], ecc[k])
}
}
// --- Stage 3: TX batching ---
var msg ipv4.Message
msg.Addr = s.remote
// original copy, move buf to txqueue directly
msg.Buffers = [][]byte{buf}
bytesToSend += len(buf)
txqueue = append(txqueue, msg)
// dup copies for testing if set
for i := 0; i < s.dup; i++ {
bts := defaultBufferPool.Get()[:len(buf)]
copy(bts, buf)
msg.Buffers = [][]byte{bts}
bytesToSend += len(bts)
txqueue = append(txqueue, msg)
}
// parity
for k := range ecc {
bts := defaultBufferPool.Get()[:len(ecc[k])]
copy(bts, ecc[k])
msg.Buffers = [][]byte{bts}
bytesToSend += len(bts)
txqueue = append(txqueue, msg)
}
// transmit when chPostProcessing is empty or we've reached max batch size
if len(s.chPostProcessing) == 0 || len(txqueue) >= maxBatchSize {
if limiter, ok := s.rateLimiter.Load().(*rate.Limiter); ok {
// WaitN only returns error if the limiter is misconfigured
// or context is cancelled. In either case, we continue sending.
_ = limiter.WaitN(ctx, bytesToSend)
}
s.tx(txqueue)
s.kcp.debugLog(IKCP_LOG_OUTPUT, "conv", s.kcp.conv, "datalen", bytesToSend)
// recycle
for k := range txqueue {
defaultBufferPool.Put(txqueue[k].Buffers[0])
txqueue[k].Buffers = nil
}
txqueue = txqueue[:0]
bytesToSend = 0
}
// re-enable die channel
chDie = s.die
case <-chDie:
// remaining packets in txqueue should be sent out
if len(s.chPostProcessing) > 0 {
chDie = nil // block chDie temporarily
continue
}
return
}
}
}
// sess update to trigger protocol
func (s *UDPSession) update() {
select {
case <-s.die:
default:
s.mu.Lock()
interval := s.kcp.flush(IKCP_FLUSH_FULL)
waitsnd := s.kcp.WaitSnd()
if waitsnd < int(s.kcp.snd_wnd) {
s.notifyWriteEvent()
}
s.mu.Unlock()
// self-synchronized timed scheduling
SystemTimedSched.Put(s.update, time.Now().Add(time.Duration(interval)*time.Millisecond))
}
}
// GetConv gets conversation id of a session
func (s *UDPSession) GetConv() uint32 { return s.kcp.conv }
// GetRTO gets current rto of the session
func (s *UDPSession) GetRTO() uint32 {
s.mu.Lock()
defer s.mu.Unlock()
return s.kcp.rx_rto
}
// GetSRTT gets current srtt of the session
func (s *UDPSession) GetSRTT() int32 {
s.mu.Lock()
defer s.mu.Unlock()
return s.kcp.rx_srtt
}
// GetRTTVar gets current rtt variance of the session
func (s *UDPSession) GetSRTTVar() int32 {
s.mu.Lock()
defer s.mu.Unlock()
return s.kcp.rx_rttvar
}
// SetOOBHandler registers a callback for receiving out-of-band (OOB) data.
//
// OOB data is delivered unreliably and bypasses the KCP reliable data path.
// The callback is invoked synchronously from the KCP input processing path.
//
// The callback MUST return quickly and MUST NOT perform any blocking operations.
// Blocking inside the callback will stall processing of all other KCP packets.
//
// Passing a nil callback unregisters the current OOB callback.
//
// OOB support requires FEC to be enabled, as the OOB packet format
// reuses the FEC header layout for demultiplexing.
func (s *UDPSession) SetOOBHandler(callback OOBCallBackType) error {
if s.fecEncoder == nil {
return errors.New("OOB requires FEC to be enabled")
}
if callback == nil {
s.callbackForOOB.Store(OOBCallBackType(func([]byte) {}))
return nil
}
s.callbackForOOB.Store(callback)
return nil
}
// GetOOBMaxSize returns the maximum payload size for an OOB packet.
//
// The returned value is the maximum number of bytes that can be carried as
// OOB data in a single packet, based on the current MTU and protocol layout.
//
// If FEC is not enabled, OOB is unsupported and this function returns 0.
func (s *UDPSession) GetOOBMaxSize() int {
if s.fecEncoder == nil {
return 0
}
// Packet layout: | conv (4B) | OOB payload |
return int(s.kcp.mtu) - convSize
}
// SendOOB sends an out-of-band (OOB) data packet.
//
// OOB packets:
// - Are unreliable: they are NOT retransmitted if lost.
// - Are unordered: delivery order is not guaranteed.
// - Are unacknowledged: no ACKs are generated.
// - Bypass the KCP reliable data path.
// - Reuse the FEC header layout for demultiplexing, but are NOT protected by FEC.
//
// The OOB payload MUST fit into a single packet.
// If the payload is too large, an error is returned.
//
// If the internal send queue is full, the OOB packet is dropped silently.
func (s *UDPSession) SendOOB(data []byte) error {
if s.fecEncoder == nil {
return errors.New("OOB requires FEC to be enabled")
}
// lock the session during OOB packet construction
s.mu.Lock()
defer s.mu.Unlock()
// Packet layout: | conv (4B) | OOB payload |
size := convSize + len(data)
if size > int(s.kcp.mtu) {
return errors.New("OOB payload too large")
}
// Allocate buffer with reserved header space.
// s.headerSize includes the space needed by the FEC encoder.
buf := defaultBufferPool.Get()[:size+s.headerSize]
// Encode conversation ID.
binary.LittleEndian.PutUint32(buf[s.headerSize:], s.kcp.conv)
// Copy OOB payload immediately after the conversation ID.
copy(buf[s.headerSize+convSize:], data)
// Enqueue the packet for post-processing.
// Performs OOB framing, encryption, and transmission, bypassing FEC and KCP.
select {
case s.chPostProcessing <- sendRequest{buf, true}:
return nil
case <-s.die:
// Session is closing.
defaultBufferPool.Put(buf)
return errors.WithStack(io.ErrClosedPipe)
default:
// Drop silently to avoid blocking the sender.
// OOB delivery is best-effort by design.
defaultBufferPool.Put(buf)
return nil
}
}
func (s *UDPSession) notifyReadEvent() {
select {
case s.chReadEvent <- struct{}{}:
default:
}
}
func (s *UDPSession) notifyWriteEvent() {
select {
case s.chWriteEvent <- struct{}{}:
default:
}
}
func (s *UDPSession) notifyReadError(err error) {
s.socketReadErrorOnce.Do(func() {
s.socketReadError.Store(err)
close(s.chSocketReadError)
})
}
func (s *UDPSession) notifyWriteError(err error) {
s.socketWriteErrorOnce.Do(func() {
s.socketWriteError.Store(err)
close(s.chSocketWriteError)
})
}
// -----------------------------------------------------------------------
// Packet input pipeline (decryption -> integrity check -> FEC -> KCP)
// -----------------------------------------------------------------------
// packetInput is the entry point for incoming packets.
// It handles decryption and CRC32 verification before passing data to kcpInput.
//
// Pipeline: Network -> [Decrypt] -> [CRC32] -> kcpInput
func (s *UDPSession) packetInput(data []byte) {
switch block := s.block.(type) {
case nil:
case *aeadCrypt:
nonceSize := block.NonceSize()
if len(data) < nonceSize+block.Overhead() {
return
}
nonce := data[:nonceSize]
ciphertext := data[nonceSize:]
plaintext, err := block.Open(ciphertext[:0], nonce, ciphertext, nil)
if err != nil {
atomic.AddUint64(&DefaultSnmp.InCsumErrors, 1)
return
}
data = plaintext
default:
// decryption and crc32 check
if len(data) < cryptHeaderSize {
return
}
block.Decrypt(data, data)
data = data[nonceSize:]
checksum := crc32.ChecksumIEEE(data[crcSize:])
if checksum != binary.LittleEndian.Uint32(data) {
atomic.AddUint64(&DefaultSnmp.InCsumErrors, 1)