Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove libp2p protocol cache #259

Merged
merged 1 commit into from
Oct 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ require (
github.com/libp2p/go-libp2p v0.13.0
github.com/libp2p/go-libp2p-core v0.8.5
github.com/libp2p/go-libp2p-record v0.1.1 // indirect
github.com/multiformats/go-multiaddr v0.3.1
github.com/stretchr/testify v1.6.1
github.com/whyrusleeping/cbor-gen v0.0.0-20210219115102-f37d292932f2
go.uber.org/atomic v1.6.0
Expand Down
2 changes: 1 addition & 1 deletion message.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ var (
// version of data-transfer (supports do-not-send-first-blocks extension)
ProtocolDataTransfer1_2 protocol.ID = "/fil/datatransfer/1.2.0"

// ProtocolDataTransfer1_2 is the protocol identifier for the version
// ProtocolDataTransfer1_1 is the protocol identifier for the version
// of data-transfer that supports the do-not-send-cids extension
// (but not the do-not-send-first-blocks extension)
ProtocolDataTransfer1_1 protocol.ID = "/fil/datatransfer/1.1.0"
Expand Down
61 changes: 16 additions & 45 deletions network/libp2p_impl.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"context"
"fmt"
"io"
"sync"
"time"

logging "github.com/ipfs/go-log/v2"
Expand All @@ -13,7 +12,6 @@ import (
"github.com/libp2p/go-libp2p-core/network"
"github.com/libp2p/go-libp2p-core/peer"
"github.com/libp2p/go-libp2p-core/protocol"
ma "github.com/multiformats/go-multiaddr"
"golang.org/x/xerrors"

datatransfer "github.com/filecoin-project/go-data-transfer"
Expand Down Expand Up @@ -53,8 +51,7 @@ type Option func(*libp2pDataTransferNetwork)
// DataTransferProtocols OVERWRITES the default libp2p protocols we use for data transfer with the given protocols.
func DataTransferProtocols(protocols []protocol.ID) Option {
return func(impl *libp2pDataTransferNetwork) {
impl.dtProtocols = nil
impl.dtProtocols = append(impl.dtProtocols, protocols...)
impl.setDataTransferProtocols(protocols)
}
}

Expand Down Expand Up @@ -87,17 +84,13 @@ func NewFromLibp2pHost(host host.Host, options ...Option) DataTransferNetwork {
minAttemptDuration: defaultMinAttemptDuration,
maxAttemptDuration: defaultMaxAttemptDuration,
backoffFactor: defaultBackoffFactor,
dtProtocols: defaultDataTransferProtocols,
peerProtocols: make(map[peer.ID]protocol.ID),
}
dataTransferNetwork.setDataTransferProtocols(defaultDataTransferProtocols)

for _, option := range options {
option(&dataTransferNetwork)
}

// Listen to network notifications
host.Network().Notify(&dataTransferNetwork)

return &dataTransferNetwork
}

Expand All @@ -114,10 +107,8 @@ type libp2pDataTransferNetwork struct {
minAttemptDuration time.Duration
maxAttemptDuration time.Duration
dtProtocols []protocol.ID
dtProtocolStrings []string
backoffFactor float64

pplk sync.RWMutex
peerProtocols map[peer.ID]protocol.ID
}

func (impl *libp2pDataTransferNetwork) openStream(ctx context.Context, id peer.ID, protocols ...protocol.ID) (network.Stream, error) {
Expand All @@ -143,9 +134,6 @@ func (impl *libp2pDataTransferNetwork) openStream(ctx context.Context, id peer.I
id, nAttempts, impl.maxStreamOpenAttempts, time.Since(start))
}

// Cache the peer's protocol version
impl.setPeerProtocol(id, s.Protocol())

return s, err
}

Expand Down Expand Up @@ -229,10 +217,7 @@ func (dtnet *libp2pDataTransferNetwork) handleNewStream(s network.Stream) {
return
}

// Cache the peer's protocol version
p := s.Conn().RemotePeer()
dtnet.setPeerProtocol(p, s.Protocol())

for {
var received datatransfer.Message
var err error
Expand Down Expand Up @@ -321,12 +306,13 @@ func (dtnet *libp2pDataTransferNetwork) msgToStream(ctx context.Context, s netwo

func (impl *libp2pDataTransferNetwork) Protocol(ctx context.Context, id peer.ID) (protocol.ID, error) {
// Check the cache for the peer's protocol version
impl.pplk.RLock()
proto, ok := impl.peerProtocols[id]
impl.pplk.RUnlock()
firstProto, err := impl.host.Peerstore().FirstSupportedProtocol(id, impl.dtProtocolStrings...)
if err != nil {
return "", err
}

if ok {
return proto, nil
if firstProto != "" {
return protocol.ID(firstProto), nil
}

// The peer's protocol version is not in the cache, so connect to the peer.
Expand All @@ -341,27 +327,12 @@ func (impl *libp2pDataTransferNetwork) Protocol(ctx context.Context, id peer.ID)
return s.Protocol(), nil
}

func (impl *libp2pDataTransferNetwork) setPeerProtocol(p peer.ID, proto protocol.ID) {
impl.pplk.Lock()
defer impl.pplk.Unlock()
func (impl *libp2pDataTransferNetwork) setDataTransferProtocols(protocols []protocol.ID) {
impl.dtProtocols = append([]protocol.ID{}, protocols...)

impl.peerProtocols[p] = proto
}

func (impl *libp2pDataTransferNetwork) clearPeerProtocol(p peer.ID) {
impl.pplk.Lock()
defer impl.pplk.Unlock()

delete(impl.peerProtocols, p)
}

// Clear the peer protocol version cache for the peer when the peer disconnects
func (impl *libp2pDataTransferNetwork) Disconnected(n network.Network, conn network.Conn) {
impl.clearPeerProtocol(conn.RemotePeer())
// Keep a string version of the protocols for performance reasons
impl.dtProtocolStrings = make([]string, 0, len(impl.dtProtocols))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dirkmc Why do we need this now ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because FirstSupportedProtocol(id, protos...) takes an array of strings (not an array of protocol.ID)

for _, proto := range impl.dtProtocols {
impl.dtProtocolStrings = append(impl.dtProtocolStrings, string(proto))
}
}

func (impl *libp2pDataTransferNetwork) Listen(n network.Network, multiaddr ma.Multiaddr) {}
func (impl *libp2pDataTransferNetwork) ListenClose(n network.Network, multiaddr ma.Multiaddr) {}
func (impl *libp2pDataTransferNetwork) Connected(n network.Network, conn network.Conn) {}
func (impl *libp2pDataTransferNetwork) OpenedStream(n network.Network, stream network.Stream) {}
func (impl *libp2pDataTransferNetwork) ClosedStream(n network.Network, stream network.Stream) {}