Merge pull request #136 from libp2p/fix/listen-addrs-race

fix listen addrs race
libp2p · Aug 21, 2019 · bfc3909 · bfc3909
2 parents 221d8d5 + 682bcc8
commit bfc3909
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/swarm_addr.go b/swarm_addr.go
@@ -35,8 +35,8 @@ func (s *Swarm) InterfaceListenAddresses() ([]ma.Multiaddr, error) {
 	s.listeners.RUnlock() // RLock end
 
 	if ifaceListenAddres != nil && !isEOL {
-		// Cache is valid
-		return ifaceListenAddres, nil
+		// Cache is valid, clone the slice
+		return append(ifaceListenAddres[:0:0], ifaceListenAddres...), nil
 	}
 
 	// Cache is not valid
@@ -64,5 +64,5 @@ func (s *Swarm) InterfaceListenAddresses() ([]ma.Multiaddr, error) {
 
 	s.listeners.Unlock() // Lock end
 
-	return ifaceListenAddres, nil
+	return append(ifaceListenAddres[:0:0], ifaceListenAddres...), nil
 }
diff --git a/swarm_addr_test.go b/swarm_addr_test.go
@@ -35,3 +35,21 @@ func TestDialBadAddrs(t *testing.T) {
 	test(m("/ip6/fe80::100"))              // link local
 	test(m("/ip4/127.0.0.1/udp/1234/utp")) // utp
 }
+
+func TestAddrRace(t *testing.T) {
+	ctx := context.Background()
+	s := makeSwarms(ctx, t, 1)[0]
+
+	a1, err := s.InterfaceListenAddresses()
+	if err != nil {
+		t.Fatal(err)
+	}
+	a2, err := s.InterfaceListenAddresses()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	if len(a1) > 0 && len(a2) > 0 && &a1[0] == &a2[0] {
+		t.Fatal("got the exact same address set twice; this could lead to data races")
+	}
+}