-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathloopback.go
More file actions
1038 lines (951 loc) · 26.6 KB
/
loopback.go
File metadata and controls
1038 lines (951 loc) · 26.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
package gonnect
import (
"context"
"errors"
"io"
"net"
"net/netip"
"strconv"
"strings"
"sync"
)
// Static type assertions
var (
_ Network = &LoopbackNetwork{}
_ UpDown = &LoopbackNetwork{}
_ io.Closer = &LoopbackNetwork{}
_ CloserSubscriber = &LoopbackNetwork{}
_ UpDownSubscriber = &LoopbackNetwork{}
)
var ErrNetworkDown = &net.OpError{
Op: "network",
Net: "down",
Err: errors.New("network is down"),
}
// LoopbackNetwork is an in-memory network implementation that simulates
// loopback network operations. It provides TCP and UDP communication using
// buffered in-memory transports for TCP and buffered channels for UDP, all without creating
// actual network sockets.
type LoopbackNetwork struct {
mu sync.Mutex
// AllowAnyHost rewrites non-loopback host names and addresses to localhost
// before Dial and Listen style address normalization. It is false by
// default to preserve the historical loopback resolver behavior.
AllowAnyHost bool
// up indicates whether the network is currently active.
up bool
// closed indicates whether the network has been permanently closed.
closed bool
tcp4reg *loopbackTCPRegistry
tcp6reg *loopbackTCPRegistry
udp4reg *loopbackUDPRegistry
udp6reg *loopbackUDPRegistry
mcast *loopbackMulticastRegistry
// nextID is the next ID to assign to a tracked connection.
nextID uint64
// closers tracks all open connections and listeners by ID.
closers map[uint64]io.Closer
nextUpDownID uint64
updowns map[uint64]UpDown
nextCloseSubID uint64
closeSubs map[uint64]io.Closer
}
// NewLoopbackNetwok creates and returns a new loopback network instance.
// The returned network provides simulated TCP and UDP communication on
// IPv4 (127.0.0.1) and IPv6 (::1) loopback addresses.
func NewLoopbackNetwok() *LoopbackNetwork {
return &LoopbackNetwork{
up: true,
tcp4reg: &loopbackTCPRegistry{
Network: "tcp4",
Host: "127.0.0.1",
},
tcp6reg: &loopbackTCPRegistry{
Network: "tcp6",
Host: "::1",
},
udp4reg: &loopbackUDPRegistry{
Network: "udp4",
Host: "127.0.0.1",
},
udp6reg: &loopbackUDPRegistry{
Network: "udp6",
Host: "::1",
},
mcast: &loopbackMulticastRegistry{},
updowns: make(map[uint64]UpDown),
closeSubs: make(map[uint64]io.Closer),
}
}
func (ln *LoopbackNetwork) IsNative() bool {
return false
}
func loopbackInterfaceAddrs() []net.Addr {
return []net.Addr{
&net.IPNet{
IP: net.IPv4(127, 0, 0, 1),
Mask: net.CIDRMask(8, 32),
},
&net.IPNet{
IP: net.IPv6loopback,
Mask: net.CIDRMask(128, 128),
},
&net.IPNet{
IP: net.ParseIP("fe80::1"),
Mask: net.CIDRMask(64, 128),
},
}
}
func loopbackInterfaceMulticastAddrs() []net.Addr {
return []net.Addr{
&net.IPAddr{IP: net.IPv4(224, 0, 0, 1)},
&net.IPAddr{IP: net.ParseIP("ff02::1")},
}
}
// Interfaces returns a slice containing the loopback network interface.
// It returns a single interface representing "lo" with index 1, MTU 65536,
// and the net.FlagLoopback and net.FlagUp flags set.
func (ln *LoopbackNetwork) Interfaces() ([]NetworkInterface, error) {
return []NetworkInterface{&LiteralInterface{
IndexVal: 1,
MTUVal: 65536,
NameVal: "lo",
HardwareAddrVal: nil,
FlagsVal: net.FlagLoopback | net.FlagUp | net.FlagRunning | net.FlagMulticast,
AddrsVal: loopbackInterfaceAddrs(),
MulticastAddrsVal: loopbackInterfaceMulticastAddrs(),
}}, nil
}
// InterfaceAddrs returns the unicast interface addresses for the loopback interface.
// It returns the IPv4 loopback range 127.0.0.0/8 to be permissive and the IPv6 loopback address.
func (ln *LoopbackNetwork) InterfaceAddrs() ([]net.Addr, error) {
return loopbackInterfaceAddrs(), nil
}
// InterfaceMulticastAddrs returns multicast addresses for the loopback interface.
func (ln *LoopbackNetwork) InterfaceMulticastAddrs() ([]net.Addr, error) {
return loopbackInterfaceMulticastAddrs(), nil
}
// InterfacesByIndex returns the network interface with the given index.
// It returns the loopback interface only if index is 1, otherwise returns
// an error indicating the interface was not found.
func (ln *LoopbackNetwork) InterfacesByIndex(
index int,
) ([]NetworkInterface, error) {
if index == 1 {
ifs, _ := ln.Interfaces()
return ifs, nil
}
return nil, &net.AddrError{Err: "interface not found", Addr: ""}
}
// InterfacesByName returns the network interface with the given name.
// It returns the loopback interface only if name is "lo", otherwise returns
// an error indicating the interface was not found.
func (ln *LoopbackNetwork) InterfacesByName(
name string,
) ([]NetworkInterface, error) {
if name == "lo" {
ifs, _ := ln.Interfaces()
return ifs, nil
}
return nil, &net.AddrError{Err: "interface not found", Addr: ""}
}
// LookupMX returns an error indicating no MX records exist for the given name.
// The loopback network does not support DNS MX record lookups.
func (ln *LoopbackNetwork) LookupMX(
ctx context.Context,
name string,
) ([]*net.MX, error) {
ln.mu.Lock()
defer ln.mu.Unlock()
if !ln.up {
return nil, &net.DNSError{
Name: name,
Err: "network is down",
IsNotFound: true,
}
}
// TODO: Better error?
return nil, &net.DNSError{
Name: name,
Err: "no such host",
IsNotFound: true,
}
}
// LookupSRV returns an error indicating no SRV records exist for the given service.
// The loopback network does not support DNS SRV record lookups.
func (ln *LoopbackNetwork) LookupSRV(
ctx context.Context,
service, proto, name string,
) (string, []*net.SRV, error) {
ln.mu.Lock()
defer ln.mu.Unlock()
if !ln.up {
return "", nil, &net.DNSError{
Name: "_svc._" + proto + "." + name,
Err: "network is down",
IsNotFound: true,
}
}
// TODO: Better error?
return "", nil, &net.DNSError{
Name: "_svc._" + proto + "." + name,
Err: "no such host",
IsNotFound: true,
}
}
// LookupTXT returns an empty slice for local addresses, or an error for non-local addresses.
// The loopback network does not support DNS TXT record lookups for external hosts.
func (ln *LoopbackNetwork) LookupTXT(
ctx context.Context,
name string,
) ([]string, error) {
ln.mu.Lock()
defer ln.mu.Unlock()
if !ln.up {
return nil, &net.DNSError{
Name: name,
Err: "network is down",
IsNotFound: true,
}
}
if IsLocal(name) {
return make([]string, 0), nil
}
// TODO: Better error?
return nil, &net.DNSError{
Name: name,
Err: "no such host",
IsNotFound: true,
}
}
// LookupAddr performs a reverse lookup for the given address.
// It returns ["localhost"] for local addresses, or an error for non-local addresses.
func (ln *LoopbackNetwork) LookupAddr(
ctx context.Context, addr string,
) (names []string, err error) {
ln.mu.Lock()
defer ln.mu.Unlock()
if !ln.up {
return nil, &net.DNSError{
Name: addr,
Err: "network is down",
IsNotFound: true,
}
}
if IsLocal(addr) {
return []string{"localhost"}, nil
}
// TODO: Better error?
return nil, &net.DNSError{
Name: addr,
Err: "no such host",
IsNotFound: true,
}
}
// LookupCNAME returns an error indicating no CNAME exists for the given host.
// The loopback network does not support DNS CNAME lookups.
func (ln *LoopbackNetwork) LookupCNAME(
ctx context.Context, host string,
) (cname string, err error) {
ln.mu.Lock()
defer ln.mu.Unlock()
if !ln.up {
return "", &net.DNSError{
Name: host,
Err: "network is down",
IsNotFound: true,
}
}
// TODO: Better error?
return "", &net.DNSError{
Name: host,
Err: "no such host",
IsNotFound: true,
}
}
// LookupPort looks up the port number for the given network and service.
// It delegates to gonnect.LookupPortOffline for offline port resolution.
func (ln *LoopbackNetwork) LookupPort(
ctx context.Context, network, service string,
) (port int, err error) {
ln.mu.Lock()
defer ln.mu.Unlock()
if !ln.up {
return 0, &net.DNSError{
Name: service,
Err: "network is down",
IsNotFound: true,
}
}
return LookupPortOffline(network, service)
}
// LookupHost looks up the host and returns a slice of IP address strings.
// It returns ["127.0.0.1", "::1"] for local hosts, or an error for non-local hosts.
func (ln *LoopbackNetwork) LookupHost(
ctx context.Context, host string,
) (addrs []string, err error) {
ln.mu.Lock()
defer ln.mu.Unlock()
if !ln.up {
return nil, &net.DNSError{
Name: host,
Err: "network is down",
IsNotFound: true,
}
}
if IsLocal(host) {
return []string{"127.0.0.1", "::1"}, nil
}
return nil, &net.DNSError{
Name: host,
Err: "no such host",
IsNotFound: true,
}
}
// LookupIP looks up the host and returns a slice of net.IP values.
// The network parameter specifies the IP version: "ip4" returns IPv4 only,
// "ip6" returns IPv6 only, and other values return both IPv4 and IPv6.
// Returns an error for non-local addresses.
func (ln *LoopbackNetwork) LookupIP(
ctx context.Context, network, address string,
) (addrs []net.IP, err error) {
ln.mu.Lock()
defer ln.mu.Unlock()
if !ln.up {
return nil, &net.DNSError{
Name: address,
Err: "network is down",
IsNotFound: true,
}
}
if IsLocal(address) {
if strings.HasSuffix(network, "4") {
return []net.IP{net.ParseIP("127.0.0.1").To4()}, nil
}
if strings.HasSuffix(network, "6") {
return []net.IP{net.ParseIP("::1").To16()}, nil
}
return []net.IP{net.ParseIP("127.0.0.1"), net.ParseIP("::1")}, nil
}
return nil, &net.DNSError{
Name: address,
Err: "no such host",
IsNotFound: true,
}
}
// LookupNetIP looks up the host and returns a slice of netip.Addr values.
// The network parameter specifies the IP version: "ip4" returns IPv4 only,
// "ip6" returns IPv6 only, and other values return both IPv4 and IPv6.
// Returns an error for non-local addresses.
func (ln *LoopbackNetwork) LookupNetIP(
ctx context.Context, network, address string,
) (addrs []netip.Addr, err error) {
ln.mu.Lock()
defer ln.mu.Unlock()
if !ln.up {
return nil, &net.DNSError{
Name: address,
Err: "network is down",
IsNotFound: true,
}
}
if IsLocal(address) {
ip4, _ := netip.AddrFromSlice(net.ParseIP("127.0.0.1").To4())
ip6, _ := netip.AddrFromSlice(net.ParseIP("::1").To4())
if strings.HasSuffix(network, "4") {
return []netip.Addr{ip4}, nil
}
if strings.HasSuffix(network, "6") {
return []netip.Addr{ip6}, nil
}
return []netip.Addr{
ip4,
ip6,
}, nil
}
return nil, &net.DNSError{
Name: address,
Err: "no such host",
IsNotFound: true,
}
}
// LookupNS returns an error indicating no NS records exist for the given name.
// The loopback network does not support DNS NS record lookups.
func (ln *LoopbackNetwork) LookupNS(
ctx context.Context,
name string,
) ([]*net.NS, error) {
ln.mu.Lock()
defer ln.mu.Unlock()
if !ln.up {
return nil, &net.DNSError{
Name: name,
Err: "network is down",
IsNotFound: true,
}
}
// TODO: Better error?
return nil, &net.DNSError{
Name: name,
Err: "no such host",
IsNotFound: true,
}
}
// LookupIPAddr looks up the host and returns a slice of net.IPAddr values.
// It returns both IPv4 and IPv6 loopback addresses for local hosts,
// or an error for non-local hosts.
func (ln *LoopbackNetwork) LookupIPAddr(
ctx context.Context, host string,
) (addrs []net.IPAddr, err error) {
ln.mu.Lock()
defer ln.mu.Unlock()
if !ln.up {
return nil, &net.DNSError{
Name: host,
Err: "network is down",
IsNotFound: true,
}
}
if IsLocal(host) {
return []net.IPAddr{
{IP: net.ParseIP("127.0.0.1")},
{IP: net.ParseIP("::1")},
}, nil
}
return nil, &net.DNSError{
Name: host,
Err: "no such host",
IsNotFound: true,
}
}
// Listen announces on the specified network and address.
// It delegates to ListenTCP for TCP-based networks.
// The returned listener is wrapped with loopback-specific error handling.
func (ln *LoopbackNetwork) Listen(
ctx context.Context,
network, address string,
) (net.Listener, error) {
ln.mu.Lock()
err := ln.checkUp()
if err != nil {
ln.mu.Unlock()
return nil, loopbackListenErrWrap(err, network, address)
}
ln.mu.Unlock()
l, err := ln.ListenTCP(ctx, network, address)
if err != nil {
return nil, loopbackListenErrWrap(err, network, address)
}
return l, err
}
// ListenTCP announces on the specified TCP network and address.
// It accepts "tcp", "tcp4", or "tcp6" as valid network types.
// The returned TCPListener is an in-memory listener that accepts
// connections via a buffered in-memory TCP transport.
func (ln *LoopbackNetwork) ListenTCP(
ctx context.Context,
network, laddr string,
) (TCPListener, error) {
ln.mu.Lock()
err := ln.checkUp()
if err != nil {
ln.mu.Unlock()
return nil, loopbackListenErrWrap(err, network, laddr)
}
ln.mu.Unlock()
if network != "tcp" && network != "tcp4" && network != "tcp6" {
return nil, net.UnknownNetworkError(network)
}
host, port, err := loopbackListenPrep(network, laddr, ln.AllowAnyHost)
if err != nil {
return nil, loopbackListenErrWrap(err, network, laddr)
}
reg := ln.tcp4reg
if host == "::1" {
reg = ln.tcp6reg
network = "tcp6"
} else {
network = "tcp4"
}
listener, err := newLoopbackTCPListener(reg, port)
if err != nil {
return nil, loopbackListenErrWrap(err, network, laddr)
}
// Wrap with callbacks for tracking
ln.mu.Lock()
id := ln.getID()
wrapped := TCPListenerWithCallbacks(listener, &Callbacks{
BeforeClose: ln.buildUnregCallback(id),
OnAcceptTCP: ln.registerTCPConnCallback,
})
ln.register(id, wrapped)
ln.mu.Unlock()
return wrapped, err
}
// ListenPacket announces on the specified network and address for packet-oriented protocols.
// It delegates to ListenUDP for UDP-based networks.
// The returned PacketConn is wrapped with loopback-specific error handling.
func (ln *LoopbackNetwork) ListenPacket(
ctx context.Context,
network, address string,
) (PacketConn, error) {
ln.mu.Lock()
err := ln.checkUp()
if err != nil {
ln.mu.Unlock()
return nil, loopbackListenErrWrap(err, network, address)
}
ln.mu.Unlock()
conn, err := ln.ListenUDP(ctx, network, address)
if err != nil {
return nil, loopbackListenErrWrap(err, network, address)
}
return conn, err
}
// ListenUDP announces on the specified UDP network and address.
// It accepts "udp", "udp4", or "udp6" as valid network types.
// The returned UDPConn is an in-memory UDP connection that communicates
// via buffered channels.
func (ln *LoopbackNetwork) ListenUDP(
ctx context.Context,
network, laddr string,
) (UDPConn, error) {
ln.mu.Lock()
err := ln.checkUp()
if err != nil {
ln.mu.Unlock()
return nil, loopbackListenErrWrap(err, network, laddr)
}
ln.mu.Unlock()
if network != "udp" && network != "udp4" && network != "udp6" {
return nil, net.UnknownNetworkError(network)
}
host, port, err := loopbackListenPrep(network, laddr, ln.AllowAnyHost)
if err != nil {
return nil, loopbackListenErrWrap(err, network, laddr)
}
reg := ln.udp4reg
if host == "::1" {
reg = ln.udp6reg
network = "udp6"
} else {
network = "udp4"
}
conn, err := newLoopbackUDPConn(reg, port, nil)
if err != nil {
return nil, loopbackListenErrWrap(err, network, laddr)
}
// Wrap with callbacks for tracking
ln.mu.Lock()
id := ln.getID()
wrapped := UDPConnWithCallbacks(conn, &Callbacks{
BeforeClose: ln.buildUnregCallback(id),
})
ln.register(id, wrapped)
ln.mu.Unlock()
return wrapped, err
}
// ListenPacketConfig announces on the specified network and address for
// packet-oriented protocols. Loopback networking has no socket control layer,
// so lc is accepted for interface compatibility and otherwise ignored.
func (ln *LoopbackNetwork) ListenPacketConfig(
ctx context.Context,
lc *ListenConfig,
network, address string,
) (PacketConn, error) {
return ln.ListenPacket(ctx, network, address)
}
// ListenUDPConfig announces on the specified UDP network and address. Loopback
// networking has no socket control layer, so lc is accepted for interface
// compatibility and otherwise ignored.
func (ln *LoopbackNetwork) ListenUDPConfig(
ctx context.Context,
lc *ListenConfig,
network, laddr string,
) (UDPConn, error) {
return ln.ListenUDP(ctx, network, laddr)
}
// DialTCP establishes a TCP connection to the remote address using the specified network.
// It accepts "tcp", "tcp4", or "tcp6" as valid network types.
// If laddr is not empty, it is used as the local address for the connection.
// The connection is established using a buffered in-memory transport between
// the client and server.
// Returns an error if no listener is bound to the remote address.
func (ln *LoopbackNetwork) DialTCP(
ctx context.Context,
network, laddr, raddr string,
) (TCPConn, error) {
ln.mu.Lock()
err := ln.checkUp()
if err != nil {
ln.mu.Unlock()
return nil, loopbackDialErrWrap(err, network, laddr, raddr)
}
ln.mu.Unlock()
if network != "tcp" && network != "tcp4" && network != "tcp6" {
return nil, net.UnknownNetworkError(network)
}
host, lport, rport, err := loopbackDialPrep(
network,
laddr,
raddr,
ln.AllowAnyHost,
)
if err != nil {
return nil, loopbackDialErrWrap(err, network, laddr, raddr)
}
reg := ln.tcp4reg
if host == "::1" {
reg = ln.tcp6reg
network = "tcp6"
} else {
network = "tcp4"
}
raddr = net.JoinHostPort(host, strconv.Itoa(rport))
serverAddr := &NetAddr{Net: network, Addr: raddr}
listener := reg.Lookup(serverAddr)
if listener == nil {
return nil, ConnRefused(network, raddr)
}
clientPipe, serverPipe := newLoopbackTCPPipePair(
&NetAddr{Net: network, Addr: "pipe:client"},
serverAddr,
)
serverConn := &loopbackTCPConn{
Conn: serverPipe,
Laddr: serverAddr,
}
clientConn := &loopbackTCPConn{
Conn: clientPipe,
Raddr: serverAddr,
}
err = reg.RegConn(lport, clientConn)
if err != nil {
_ = serverPipe.Close()
_ = clientPipe.Close()
return nil, loopbackDialErrWrap(err, network, laddr, raddr)
}
serverConn.Raddr = clientConn.Laddr
err = listener.NewConn(serverConn)
if err != nil {
_ = serverPipe.Close()
_ = clientConn.Close()
return nil, loopbackDialErrWrap(err, network, laddr, raddr)
}
// Wrap with callbacks for tracking
ln.mu.Lock()
id := ln.getID()
wrapped := TCPConnWithCallbacks(clientConn, &Callbacks{
BeforeClose: ln.buildUnregCallback(id),
})
ln.register(id, wrapped)
ln.mu.Unlock()
return wrapped, nil
}
// PacketDial establishes a UDP connection to the remote address using the specified network.
// The returned PacketConn is wrapped with callbacks for automatic tracking.
func (ln *LoopbackNetwork) PacketDial(
ctx context.Context, network, address string,
) (PacketConn, error) {
return ln.DialUDP(ctx, network, "", address)
}
// DialUDP establishes a UDP connection to the remote address using the specified network.
// It accepts "udp", "udp4", or "udp6" as valid network types.
// If laddr is not empty, it is used as the local address for the connection.
// The returned UDPConn is an in-memory UDP connection that communicates
// via buffered channels.
func (ln *LoopbackNetwork) DialUDP(
ctx context.Context,
network, laddr, raddr string,
) (UDPConn, error) {
ln.mu.Lock()
err := ln.checkUp()
if err != nil {
ln.mu.Unlock()
return nil, loopbackDialErrWrap(err, network, laddr, raddr)
}
ln.mu.Unlock()
if network != "udp" && network != "udp4" && network != "udp6" {
return nil, net.UnknownNetworkError(network)
}
host, lport, rport, err := loopbackDialPrep(
network,
laddr,
raddr,
ln.AllowAnyHost,
)
if err != nil {
return nil, loopbackDialErrWrap(err, network, laddr, raddr)
}
reg := ln.udp4reg
if host == "::1" {
reg = ln.udp6reg
network = "udp6"
} else {
network = "udp4"
}
if rport < 0 || rport > 65535 {
return nil, loopbackDialErrWrap(&net.AddrError{
Err: "invalid port",
Addr: raddr,
}, network, laddr, raddr)
}
port := uint16(rport)
con, err := newLoopbackUDPConn(reg, lport, &port)
if err != nil {
return nil, loopbackDialErrWrap(err, network, laddr, raddr)
}
// Wrap with callbacks for tracking
ln.mu.Lock()
id := ln.getID()
wrapped := UDPConnWithCallbacks(con, &Callbacks{
BeforeClose: ln.buildUnregCallback(id),
})
ln.register(id, wrapped)
ln.mu.Unlock()
return wrapped, loopbackDialErrWrap(err, network, laddr, raddr)
}
// Dial establishes a connection to the address on the specified network.
// It routes to DialTCP for TCP networks ("tcp", "tcp4", "tcp6") or
// to DialUDP for UDP networks ("udp", "udp4", "udp6").
// Returns an error for unknown network types.
func (ln *LoopbackNetwork) Dial(
ctx context.Context,
network, address string,
) (net.Conn, error) {
ln.mu.Lock()
err := ln.checkUp()
if err != nil {
ln.mu.Unlock()
return nil, loopbackDialErrWrap(err, network, address, "")
}
ln.mu.Unlock()
var conn net.Conn
var dialErr error
switch {
case strings.HasPrefix(network, "tcp"):
conn, dialErr = ln.DialTCP(ctx, network, "", address)
case strings.HasPrefix(network, "udp"):
conn, dialErr = ln.DialUDP(ctx, network, "", address)
default:
return nil, net.UnknownNetworkError(network)
}
if dialErr != nil {
return nil, loopbackDialErrWrap(dialErr, network, address, "")
}
return conn, dialErr
}
// Down shuts down the network by closing all tracked connections and listeners.
// After calling Down, the network will reject new operations until Up() is called.
func (ln *LoopbackNetwork) Down() error {
ln.mu.Lock()
if ln.closed {
ln.mu.Unlock()
return nil
}
ln.mu.Unlock()
closers, updowns := ln.downPrep()
for _, c := range closers {
_ = c.Close()
}
return downAll(updowns)
}
// Up re-enables the network after it has been shut down with Down().
func (ln *LoopbackNetwork) Up() error {
ln.mu.Lock()
if ln.closed {
ln.mu.Unlock()
return net.ErrClosed
}
if ln.up {
ln.mu.Unlock()
return nil
}
ln.up = true
updowns := make([]UpDown, 0, len(ln.updowns))
for _, u := range ln.updowns {
updowns = append(updowns, u)
}
ln.mu.Unlock()
return upAll(updowns)
}
// Close permanently closes this network.
func (ln *LoopbackNetwork) Close() error {
closers, updowns, closeSubs := ln.closePrep()
return errors.Join(closeAll(closers), downAll(updowns), closeAll(closeSubs))
}
// SubscribeCloser registers c to be closed when this network is closed.
//
// The returned unsubscribe function removes c without closing it. If this
// network is already closed, c is closed before SubscribeCloser returns
// net.ErrClosed.
func (ln *LoopbackNetwork) SubscribeCloser(c io.Closer) (func(), error) {
ln.mu.Lock()
if ln.closed {
ln.mu.Unlock()
_ = c.Close()
return nil, net.ErrClosed
}
id := ln.nextCloseSubID
ln.nextCloseSubID++
if ln.closeSubs == nil {
ln.closeSubs = make(map[uint64]io.Closer)
}
ln.closeSubs[id] = c
ln.mu.Unlock()
var once sync.Once
return func() {
once.Do(func() { ln.unregisterCloseSub(id) })
}, nil
}
// SubscribeUpDown registers u to follow this network's up/down state.
//
// The returned unsubscribe function removes u without changing it. The
// subscription persists across Down and Up cycles. If this network is already
// down or closed, u.Down is called before SubscribeUpDown returns.
func (ln *LoopbackNetwork) SubscribeUpDown(u UpDown) (func(), error) {
ln.mu.Lock()
id := ln.nextUpDownID
ln.nextUpDownID++
if ln.updowns == nil {
ln.updowns = make(map[uint64]UpDown)
}
ln.updowns[id] = u
down := !ln.up || ln.closed
ln.mu.Unlock()
var err error
if down {
err = u.Down()
}
var once sync.Once
return func() {
once.Do(func() { ln.unregisterUpDown(id) })
}, err
}
// IsUp returns whether the network is currently active.
func (ln *LoopbackNetwork) IsUp() (bool, error) {
ln.mu.Lock()
defer ln.mu.Unlock()
return ln.up && !ln.closed, nil
}
// downPrep prepares the network for shutdown by marking it as down
// and collecting all tracked closers for cleanup.
// It returns the closers that should be closed after releasing the lock.
func (ln *LoopbackNetwork) downPrep() (
closers []io.Closer,
updowns []UpDown,
) {
ln.mu.Lock()
defer ln.mu.Unlock()
if !ln.up || ln.closed {
return
}
ln.up = false
closers = make([]io.Closer, 0, len(ln.closers))
for id, c := range ln.closers {
delete(ln.closers, id)
closers = append(closers, c)
}
updowns = make([]UpDown, 0, len(ln.updowns))
for _, u := range ln.updowns {
updowns = append(updowns, u)
}
return
}
// getID returns the next unique ID for tracking connections.
// WARN: NOT thread safe - caller must hold ln.mu lock.
func (ln *LoopbackNetwork) getID() uint64 {
id := ln.nextID
ln.nextID += 1
return id
}
// register stores a connection or listener with the given ID for tracking.
// WARN: NOT thread safe - caller must hold ln.mu lock.
func (ln *LoopbackNetwork) register(id uint64, c io.Closer) {
if ln.closers == nil {
ln.closers = make(map[uint64]io.Closer)
}
ln.closers[id] = c
}
// unregister removes a connection or listener from tracking by ID.
func (ln *LoopbackNetwork) unregister(id uint64) {
ln.mu.Lock()
defer ln.mu.Unlock()
delete(ln.closers, id)
}
func (ln *LoopbackNetwork) unregisterUpDown(id uint64) {
ln.mu.Lock()
defer ln.mu.Unlock()
delete(ln.updowns, id)
}
func (ln *LoopbackNetwork) unregisterCloseSub(id uint64) {
ln.mu.Lock()
defer ln.mu.Unlock()
delete(ln.closeSubs, id)
}
func (ln *LoopbackNetwork) closePrep() (
closers []io.Closer,
updowns []UpDown,
closeSubs []io.Closer,
) {
ln.mu.Lock()
defer ln.mu.Unlock()
if ln.closed {
return nil, nil, nil
}
wasUp := ln.up
ln.closed = true
ln.up = false
closers = make([]io.Closer, 0, len(ln.closers))
for id, c := range ln.closers {
delete(ln.closers, id)
closers = append(closers, c)
}
if wasUp {
updowns = make([]UpDown, 0, len(ln.updowns))
for _, u := range ln.updowns {
updowns = append(updowns, u)
}
}
closeSubs = make([]io.Closer, 0, len(ln.closeSubs))
for id, c := range ln.closeSubs {
delete(ln.closeSubs, id)
closeSubs = append(closeSubs, c)
}
return closers, updowns, closeSubs
}