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

fix(bitswap/client/msgq): prevent duplicate requests #691

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
39 changes: 28 additions & 11 deletions bitswap/client/internal/messagequeue/messagequeue.go
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,23 @@ func (r *recallWantlist) ClearSentAt(c cid.Cid) {
delete(r.sentAt, c)
}

// Refresh moves wants from the sent list back to the pending list.
// If a want has been sent for longer than the interval, it is moved back to the pending list.
// Returns the number of wants that were refreshed.
func (r *recallWantlist) Refresh(now time.Time, interval time.Duration) int {
var refreshed int
for _, want := range r.sent.Entries() {
sentAt, ok := r.sentAt[want.Cid]
if ok && now.Sub(sentAt) >= interval {
r.pending.Add(want.Cid, want.Priority, want.WantType)
r.sent.Remove(want.Cid)
refreshed++
}
}

return refreshed
}

type peerConn struct {
p peer.ID
network MessageNetwork
Expand Down Expand Up @@ -476,27 +493,27 @@ func (mq *MessageQueue) rebroadcastWantlist() {
mq.rebroadcastIntervalLk.Unlock()

// If some wants were transferred from the rebroadcast list
if mq.transferRebroadcastWants() {
if toRebroadcast := mq.transferRebroadcastWants(); toRebroadcast > 0 {
// Send them out
mq.sendMessage()
log.Infow("Rebroadcasting wants", "amount", toRebroadcast, "peer", mq.p)
}
}

// Transfer wants from the rebroadcast lists into the pending lists.
func (mq *MessageQueue) transferRebroadcastWants() bool {
func (mq *MessageQueue) transferRebroadcastWants() int {
mq.wllock.Lock()
defer mq.wllock.Unlock()

// Check if there are any wants to rebroadcast
if mq.bcstWants.sent.Len() == 0 && mq.peerWants.sent.Len() == 0 {
return false
Comment on lines -491 to -492
Copy link
Contributor

Choose a reason for hiding this comment

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

This is probably good to leave since it avoids Lock/Unlock of mq.rebroadcastIntervalLk and time.Now().

	if mq.bcstWants.sent.Len() == 0 && mq.peerWants.sent.Len() == 0 {
		return 0
	}

Copy link
Member Author

Choose a reason for hiding this comment

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

The lock exists only for testing. The interval is never changed outside of the unit test. Thus, I don't see any contention zero length check could prevent.

}

// Copy sent wants into pending wants lists
mq.bcstWants.pending.Absorb(mq.bcstWants.sent)
mq.peerWants.pending.Absorb(mq.peerWants.sent)
mq.rebroadcastIntervalLk.Lock()
rebroadcastInterval := mq.rebroadcastInterval
Copy link
Member Author

@Wondertan Wondertan Oct 17, 2024

Choose a reason for hiding this comment

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

Alternatively, this could be a different new parameter/constant

mq.rebroadcastIntervalLk.Unlock()

return true
now := mq.clock.Now()
// Transfer sent wants into pending wants lists
transferred := mq.bcstWants.Refresh(now, rebroadcastInterval)
transferred += mq.peerWants.Refresh(now, rebroadcastInterval)
return transferred
}

func (mq *MessageQueue) signalWorkReady() {
Expand Down
10 changes: 0 additions & 10 deletions bitswap/client/wantlist/wantlist.go
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,3 @@ func (w *Wantlist) Entries() []Entry {
w.cached = es
return es[0:len(es):len(es)]
}

// Absorb all the entries in other into this want list
func (w *Wantlist) Absorb(other *Wantlist) {
Comment on lines -134 to -135
Copy link
Member Author

Choose a reason for hiding this comment

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

Deleted as deadcode

// Invalidate the cache up-front to avoid doing any work trying to keep it up-to-date.
w.cached = nil

for _, e := range other.Entries() {
w.Add(e.Cid, e.Priority, e.WantType)
}
}
46 changes: 0 additions & 46 deletions bitswap/client/wantlist/wantlist_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -157,52 +157,6 @@ func TestAddBlockThenRemoveAny(t *testing.T) {
}
}

func TestAbsort(t *testing.T) {
wl := New()
wl.Add(testcids[0], 5, pb.Message_Wantlist_Block)
wl.Add(testcids[1], 4, pb.Message_Wantlist_Have)
wl.Add(testcids[2], 3, pb.Message_Wantlist_Have)

wl2 := New()
wl2.Add(testcids[0], 2, pb.Message_Wantlist_Have)
wl2.Add(testcids[1], 1, pb.Message_Wantlist_Block)

wl.Absorb(wl2)

e, ok := wl.Contains(testcids[0])
if !ok {
t.Fatal("expected to have ", testcids[0])
}
if e.Priority != 5 {
t.Fatal("expected priority 5")
}
if e.WantType != pb.Message_Wantlist_Block {
t.Fatal("expected type ", pb.Message_Wantlist_Block)
}

e, ok = wl.Contains(testcids[1])
if !ok {
t.Fatal("expected to have ", testcids[1])
}
if e.Priority != 1 {
t.Fatal("expected priority 1")
}
if e.WantType != pb.Message_Wantlist_Block {
t.Fatal("expected type ", pb.Message_Wantlist_Block)
}

e, ok = wl.Contains(testcids[2])
if !ok {
t.Fatal("expected to have ", testcids[2])
}
if e.Priority != 3 {
t.Fatal("expected priority 3")
}
if e.WantType != pb.Message_Wantlist_Have {
t.Fatal("expected type ", pb.Message_Wantlist_Have)
}
}

func TestSortEntries(t *testing.T) {
wl := New()

Expand Down
Loading