session.go 6.54 KB
Newer Older
Jeromy's avatar
Jeromy committed
1 2 3 4 5 6 7 8 9 10 11
package bitswap

import (
	"context"
	"time"

	notifications "github.com/ipfs/go-ipfs/exchange/bitswap/notifications"

	logging "gx/ipfs/QmSpJByNKFX1sCsHBEp3R73FL4NF6FnQTEGyNAXHm2GS52/go-log"
	lru "gx/ipfs/QmVYxfoJQiZijTgPNHCHgHELvQpbsJNTg6Crmc3dQkj3yy/golang-lru"
	loggables "gx/ipfs/QmVesPmqbPp7xRGyY96tnBwzDtVV1nqv4SCVxo5zCqKyH8/go-libp2p-loggables"
Jeromy's avatar
Jeromy committed
12
	blocks "gx/ipfs/QmXxGS5QsUxpR3iqL5DjmsYPHR1Yz74siRQ4ChJqWFosMh/go-block-format"
Jeromy's avatar
Jeromy committed
13 14 15 16 17 18
	cid "gx/ipfs/Qma4RJSuh7mMeJQYCqMbKzekn6EwBo7HEs5AQYjVRMQATB/go-cid"
	peer "gx/ipfs/QmdS9KpbDyPrieswibZhkod1oXqRwZJrUPzxCofAMWpFGq/go-libp2p-peer"
)

const activeWantsLimit = 16

Jeromy's avatar
Jeromy committed
19 20 21
// Session holds state for an individual bitswap transfer operation.
// This allows bitswap to make smarter decisions about who to send wantlist
// info to, and who to request blocks from
Jeromy's avatar
Jeromy committed
22 23 24 25 26 27
type Session struct {
	ctx            context.Context
	tofetch        []*cid.Cid
	activePeers    map[peer.ID]struct{}
	activePeersArr []peer.ID

Jeromy's avatar
Jeromy committed
28 29 30 31 32
	bs           *Bitswap
	incoming     chan blkRecv
	newReqs      chan []*cid.Cid
	cancelKeys   chan []*cid.Cid
	interestReqs chan interestReq
Jeromy's avatar
Jeromy committed
33 34 35 36 37 38 39 40 41 42 43 44 45

	interest  *lru.Cache
	liveWants map[string]time.Time

	tick          *time.Timer
	baseTickDelay time.Duration

	latTotal time.Duration
	fetchcnt int

	notif notifications.PubSub

	uuid logging.Loggable
Jeromy's avatar
Jeromy committed
46 47

	id uint64
Jeromy's avatar
Jeromy committed
48 49
}

Jeromy's avatar
Jeromy committed
50 51
// NewSession creates a new bitswap session whose lifetime is bounded by the
// given context
Jeromy's avatar
Jeromy committed
52 53 54 55 56 57
func (bs *Bitswap) NewSession(ctx context.Context) *Session {
	s := &Session{
		activePeers:   make(map[peer.ID]struct{}),
		liveWants:     make(map[string]time.Time),
		newReqs:       make(chan []*cid.Cid),
		cancelKeys:    make(chan []*cid.Cid),
Jeromy's avatar
Jeromy committed
58
		interestReqs:  make(chan interestReq),
Jeromy's avatar
Jeromy committed
59 60 61 62 63 64
		ctx:           ctx,
		bs:            bs,
		incoming:      make(chan blkRecv),
		notif:         notifications.New(),
		uuid:          loggables.Uuid("GetBlockRequest"),
		baseTickDelay: time.Millisecond * 500,
Jeromy's avatar
Jeromy committed
65
		id:            bs.getNextSessionID(),
Jeromy's avatar
Jeromy committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
	}

	cache, _ := lru.New(2048)
	s.interest = cache

	bs.sessLk.Lock()
	bs.sessions = append(bs.sessions, s)
	bs.sessLk.Unlock()

	go s.run(ctx)

	return s
}

type blkRecv struct {
	from peer.ID
	blk  blocks.Block
}

Jeromy's avatar
Jeromy committed
85
func (s *Session) receiveBlockFrom(from peer.ID, blk blocks.Block) {
Jeromy's avatar
Jeromy committed
86 87 88
	s.incoming <- blkRecv{from: from, blk: blk}
}

Jeromy's avatar
Jeromy committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
type interestReq struct {
	c    *cid.Cid
	resp chan bool
}

// TODO: PERF: this is using a channel to guard a map access against race
// conditions. This is definitely much slower than a mutex, though its unclear
// if it will actually induce any noticeable slowness. This is implemented this
// way to avoid adding a more complex set of mutexes around the liveWants map.
// note that in the average case (where this session *is* interested in the
// block we received) this function will not be called, as the cid will likely
// still be in the interest cache.
func (s *Session) isLiveWant(c *cid.Cid) bool {
	resp := make(chan bool)
	s.interestReqs <- interestReq{
		c:    c,
		resp: resp,
	}
	return <-resp
}

Jeromy's avatar
Jeromy committed
110
func (s *Session) interestedIn(c *cid.Cid) bool {
Jeromy's avatar
Jeromy committed
111
	return s.interest.Contains(c.KeyString()) || s.isLiveWant(c)
Jeromy's avatar
Jeromy committed
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
}

const provSearchDelay = time.Second * 10

func (s *Session) addActivePeer(p peer.ID) {
	if _, ok := s.activePeers[p]; !ok {
		s.activePeers[p] = struct{}{}
		s.activePeersArr = append(s.activePeersArr, p)
	}
}

func (s *Session) resetTick() {
	if s.latTotal == 0 {
		s.tick.Reset(provSearchDelay)
	} else {
		avLat := s.latTotal / time.Duration(s.fetchcnt)
		s.tick.Reset(s.baseTickDelay + (3 * avLat))
	}
}

func (s *Session) run(ctx context.Context) {
	s.tick = time.NewTimer(provSearchDelay)
	newpeers := make(chan peer.ID, 16)
	for {
		select {
		case blk := <-s.incoming:
			s.tick.Stop()

			s.addActivePeer(blk.from)

			s.receiveBlock(ctx, blk.blk)

			s.resetTick()
		case keys := <-s.newReqs:
			for _, k := range keys {
				s.interest.Add(k.KeyString(), nil)
			}
Jeromy's avatar
Jeromy committed
149 150
			if len(s.liveWants) < activeWantsLimit {
				toadd := activeWantsLimit - len(s.liveWants)
Jeromy's avatar
Jeromy committed
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
				if toadd > len(keys) {
					toadd = len(keys)
				}

				now := keys[:toadd]
				keys = keys[toadd:]

				s.wantBlocks(ctx, now)
			}
			s.tofetch = append(s.tofetch, keys...)
		case keys := <-s.cancelKeys:
			s.cancel(keys)

		case <-s.tick.C:
			var live []*cid.Cid
Jeromy's avatar
Jeromy committed
166
			for c := range s.liveWants {
Jeromy's avatar
Jeromy committed
167 168 169 170 171 172
				cs, _ := cid.Cast([]byte(c))
				live = append(live, cs)
				s.liveWants[c] = time.Now()
			}

			// Broadcast these keys to everyone we're connected to
Jeromy's avatar
Jeromy committed
173
			s.bs.wm.WantBlocks(ctx, live, nil, s.id)
Jeromy's avatar
Jeromy committed
174 175

			if len(live) > 0 {
Jeromy's avatar
Jeromy committed
176 177 178 179 180 181 182
				go func(k *cid.Cid) {
					// TODO: have a task queue setup for this to:
					// - rate limit
					// - manage timeouts
					// - ensure two 'findprovs' calls for the same block don't run concurrently
					// - share peers between sessions based on interest set
					for p := range s.bs.network.FindProvidersAsync(ctx, k, 10) {
Jeromy's avatar
Jeromy committed
183 184
						newpeers <- p
					}
Jeromy's avatar
Jeromy committed
185
				}(live[0])
Jeromy's avatar
Jeromy committed
186 187 188 189
			}
			s.resetTick()
		case p := <-newpeers:
			s.addActivePeer(p)
Jeromy's avatar
Jeromy committed
190 191 192
		case lwchk := <-s.interestReqs:
			_, ok := s.liveWants[lwchk.c.KeyString()]
			lwchk.resp <- ok
Jeromy's avatar
Jeromy committed
193
		case <-ctx.Done():
Jeromy's avatar
Jeromy committed
194
			s.tick.Stop()
Jeromy's avatar
Jeromy committed
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
			return
		}
	}
}

func (s *Session) receiveBlock(ctx context.Context, blk blocks.Block) {
	ks := blk.Cid().KeyString()
	if _, ok := s.liveWants[ks]; ok {
		tval := s.liveWants[ks]
		s.latTotal += time.Since(tval)
		s.fetchcnt++
		delete(s.liveWants, ks)
		s.notif.Publish(blk)

		if len(s.tofetch) > 0 {
			next := s.tofetch[0:1]
			s.tofetch = s.tofetch[1:]
			s.wantBlocks(ctx, next)
		}
	}
}

func (s *Session) wantBlocks(ctx context.Context, ks []*cid.Cid) {
	for _, c := range ks {
		s.liveWants[c.KeyString()] = time.Now()
	}
Jeromy's avatar
Jeromy committed
221
	s.bs.wm.WantBlocks(ctx, ks, s.activePeersArr, s.id)
Jeromy's avatar
Jeromy committed
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
}

func (s *Session) cancel(keys []*cid.Cid) {
	sset := cid.NewSet()
	for _, c := range keys {
		sset.Add(c)
	}
	var i, j int
	for ; j < len(s.tofetch); j++ {
		if sset.Has(s.tofetch[j]) {
			continue
		}
		s.tofetch[i] = s.tofetch[j]
		i++
	}
	s.tofetch = s.tofetch[:i]
}

func (s *Session) cancelWants(keys []*cid.Cid) {
	s.cancelKeys <- keys
}

func (s *Session) fetch(ctx context.Context, keys []*cid.Cid) {
	select {
	case s.newReqs <- keys:
	case <-ctx.Done():
	}
}

Jeromy's avatar
Jeromy committed
251 252 253
// GetBlocks fetches a set of blocks within the context of this session and
// returns a channel that found blocks will be returned on. No order is
// guaranteed on the returned blocks.
Jeromy's avatar
Jeromy committed
254 255 256 257 258
func (s *Session) GetBlocks(ctx context.Context, keys []*cid.Cid) (<-chan blocks.Block, error) {
	ctx = logging.ContextWithLoggable(ctx, s.uuid)
	return getBlocksImpl(ctx, keys, s.notif, s.fetch, s.cancelWants)
}

Jeromy's avatar
Jeromy committed
259
// GetBlock fetches a single block
Jeromy's avatar
Jeromy committed
260 261 262
func (s *Session) GetBlock(parent context.Context, k *cid.Cid) (blocks.Block, error) {
	return getBlock(parent, k, s.GetBlocks)
}