-
Notifications
You must be signed in to change notification settings - Fork 0
/
retrieval.go
404 lines (329 loc) · 10.7 KB
/
retrieval.go
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
package filclient
import (
"context"
"encoding/binary"
"errors"
"sync"
datatransfer "github.com/filecoin-project/go-data-transfer"
"github.com/filecoin-project/go-fil-markets/retrievalmarket"
"github.com/ipfs/go-blockservice"
"github.com/ipfs/go-cid"
"github.com/ipfs/go-datastore"
offline "github.com/ipfs/go-ipfs-exchange-offline"
format "github.com/ipfs/go-ipld-format"
"github.com/ipfs/go-merkledag"
selectorparse "github.com/ipld/go-ipld-prime/traversal/selector/parse"
"github.com/libp2p/go-libp2p/core/peer"
)
// retrieval.go - all retrieval-related functions
var (
ErrUnexpectedRetrievalTransferState = errors.New("unexpected retrieval transfer state")
)
type RetrievalTransferStatus uint
const (
// Unknown or invalid transfer state
RetrievalTransferStatusInvalid = iota
// Transfer was rejected up-front before it could start
RetrievalTransferStatusRejected
// Transfer is in progress
RetrievalTransferStatusInProgress
// Error occurred during transfer
RetrievalTransferStatusErrored
// Transfer has been stopped by the client
RetrievalTransferStatusCancelled
// Transfer completed successfully
RetrievalTransferStatusCompleted
)
// Whether the retrieval status is in any of the "done states"
func (status RetrievalTransferStatus) IsDone() bool {
return status == RetrievalTransferStatusCompleted ||
status == RetrievalTransferStatusCancelled ||
status == RetrievalTransferStatusErrored
}
// Operational handle for controlling and getting information about a retrieval
// transfer
type RetrievalTransfer struct {
lk sync.Mutex
client *Client
status RetrievalTransferStatus
provider peer.ID
proposal retrievalmarket.DealProposal
chanID datatransfer.ChannelID
// Bytes that were already in the blockstore before the retrieval started
cachedProgress uint64
// Bytes received since the retrieval started
retrievalProgress uint64
// Total byte size of the data being retrieved
size uint64
doneChans []chan<- struct{}
}
func (transfer *RetrievalTransfer) State() RetrievalTransferStatus {
transfer.lk.Lock()
defer transfer.lk.Unlock()
return transfer.status
}
// NOTE: progress may not end up reaching 100% of the expected size
func (transfer *RetrievalTransfer) Progress() uint64 {
transfer.lk.Lock()
defer transfer.lk.Unlock()
return transfer.cachedProgress + transfer.retrievalProgress
}
func (transfer *RetrievalTransfer) Size() uint64 {
transfer.lk.Lock()
defer transfer.lk.Unlock()
return transfer.size
}
func (handle *StorageProviderHandle) QueryRetrievalAsk(ctx context.Context, payloadCid cid.Cid) (retrievalmarket.QueryResponse, error) {
const protocol = "/fil/retrieval/qry/1.0.0"
req := retrievalmarket.Query{PayloadCID: payloadCid}
var resp retrievalmarket.QueryResponse
if err := handle.runSingleRPC(ctx, &req, &resp, retrievalmarket.QueryProtocolID); err != nil {
return retrievalmarket.QueryResponse{}, err
}
return resp, nil
}
// Start running a retrieval
func (handle *StorageProviderHandle) StartRetrievalTransfer(
ctx context.Context,
payloadCid cid.Cid,
options ...RetrievalOption,
) (*RetrievalTransfer, error) {
var cfg RetrievalConfig
for _, option := range options {
option(&cfg)
}
cfg.Clean()
// TODO(@elijaharita): allow supplying a pre-run ask result
ask, err := handle.QueryRetrievalAsk(ctx, payloadCid)
if err != nil {
return nil, err
}
// Create proposal
params, err := retrievalmarket.NewParamsV1(
ask.MinPricePerByte,
ask.MaxPaymentInterval,
ask.MaxPaymentIntervalIncrease,
cfg.selector,
nil,
ask.UnsealPrice,
)
if err != nil {
return nil, err
}
dealID, err := handle.client.nextRetrievalDealID(ctx)
if err != nil {
return nil, err
}
log.Infof("Using deal ID %d", dealID)
proposal := retrievalmarket.DealProposal{
PayloadCID: payloadCid,
ID: dealID,
Params: params,
}
peerID, err := handle.PeerID(ctx)
if err != nil {
return nil, err
}
// Compute the cached progress by walking the tree
var cachedProgress uint64
visited := cid.NewSet()
dag := merkledag.NewDAGService(blockservice.New(handle.client.bs, offline.Exchange(handle.client.bs)))
getLinks := func(ctx context.Context, cid cid.Cid) ([]*format.Link, error) {
node, err := dag.Get(ctx, cid)
if err != nil {
return nil, err
}
blockSize, err := handle.client.bs.GetSize(ctx, cid)
if err != nil {
return nil, err
}
cachedProgress += uint64(blockSize)
return node.Links(), nil
}
merkledag.Walk(ctx, getLinks, payloadCid, visited.Visit)
// Open the data channel
// NOTE: from this point to the end of the function, retrieval transfers
// mutex will be locked to prevent channel lookups before it gets registered
handle.client.retrievalTransfersLk.Lock()
defer handle.client.retrievalTransfersLk.Unlock()
log.Infof("Starting data channel...")
chanID, err := handle.client.dt.OpenPullDataChannel(
ctx,
peerID,
&proposal,
proposal.PayloadCID,
selectorparse.CommonSelector_ExploreAllRecursively,
)
if err != nil {
return nil, err
}
transfer := &RetrievalTransfer{
client: handle.client,
status: RetrievalTransferStatusInProgress,
proposal: proposal,
provider: peerID,
chanID: chanID,
cachedProgress: cachedProgress,
retrievalProgress: 0,
size: ask.Size,
}
// Register with running transfers
handle.client.retrievalTransfers[chanID] = transfer
log.Infof("Retrieval is running")
return transfer, nil
}
func (transfer *RetrievalTransfer) Cancel(ctx context.Context) error {
transfer.lk.Lock()
defer transfer.lk.Unlock()
return transfer.cancel(ctx)
}
func (transfer *RetrievalTransfer) cancel(ctx context.Context) error {
if err := transfer.close(ctx); err != nil {
return err
}
transfer.status = RetrievalTransferStatusCancelled
return nil
}
// Returns a channel that will close when the retrieval finishes (closes
// immediately if the retrieval is already done)
func (transfer *RetrievalTransfer) Done() <-chan struct{} {
transfer.lk.Lock()
defer transfer.lk.Unlock()
return transfer.done()
}
func (transfer *RetrievalTransfer) done() <-chan struct{} {
ch := make(chan struct{})
if transfer.status.IsDone() {
// If already done, signal immediately
close(ch)
} else {
// Otherwise register it in the transfer info for later
transfer.doneChans = append(transfer.doneChans, ch)
}
return ch
}
func (transfer *RetrievalTransfer) close(ctx context.Context) error {
// Ensure the channel is closed
if err := transfer.client.dt.CloseDataTransferChannel(
ctx,
transfer.chanID,
); err != nil {
return err
}
// Send done signals
for _, ch := range transfer.doneChans {
close(ch)
}
// Remove from active transfers
transfer.client.retrievalTransfersLk.Lock()
delete(transfer.client.retrievalTransfers, transfer.chanID)
transfer.client.retrievalTransfersLk.Unlock()
return nil
}
// Reads the next retrieval deal ID from the datastore (or initializes it as 1
// if a datastore entry doesn't exist yet), and increments the datastore entry
// afterwards
func (client *Client) nextRetrievalDealID(ctx context.Context) (retrievalmarket.DealID, error) {
key := datastore.NewKey("/Retrieval/NextDealID")
nextDealIDBytes, err := client.ds.Get(ctx, key)
var nextDealID retrievalmarket.DealID
if err != nil {
// If there was an error and it wasn't caused by key not found, not sure
// what to do, error out
if !errors.Is(err, datastore.ErrNotFound) {
return 0, err
}
// Otherwise if it was just key not found error, initialize deal ID as 1
// and continue
nextDealID = retrievalmarket.DealID(1)
} else {
// If loaded successfully then deserialize the deal ID bytes
nextDealID = retrievalmarket.DealID(binary.BigEndian.Uint64(nextDealIDBytes))
}
// Re-serialize the deal ID + 1 and write it back to the datastore
newNextDealIDBytes := make([]byte, 8)
binary.BigEndian.PutUint64(newNextDealIDBytes, uint64(nextDealID+1))
if err := client.ds.Put(ctx, key, newNextDealIDBytes); err != nil {
return retrievalmarket.DealID(0), err
}
return nextDealID, nil
}
func (client *Client) handleDataTransferRetrievalEvent(
ctx context.Context,
event datatransfer.Event,
channelState datatransfer.ChannelState,
) {
log.Debugf("Event code %d: %s", event.Code, datatransfer.Events[event.Code])
client.retrievalTransfersLk.Lock()
transfer, ok := client.retrievalTransfers[channelState.ChannelID()]
if !ok {
log.Errorf("Received transfer event for nonexistent channel: %s", channelState.ChannelID())
}
client.retrievalTransfersLk.Unlock()
close := func() {
transfer.lk.Lock()
defer transfer.lk.Unlock()
if err := transfer.close(ctx); err != nil {
log.Errorf("Failed to close transfer with deal ID: %d", transfer.proposal.ID)
}
}
switch event.Code {
case datatransfer.NewVoucherResult:
log.Debugf("Voucher result: %s", channelState.LastVoucherResult().Type())
switch result := channelState.LastVoucherResult().(type) {
case *retrievalmarket.DealResponse:
client.handleRetrievalDealResponse(ctx, event, channelState, result)
}
case datatransfer.DataReceived:
transfer.lk.Lock()
transfer.retrievalProgress = channelState.Received()
transfer.lk.Unlock()
case datatransfer.CleanupComplete:
if event.Message != "" {
log.Infof("Retrieval transfer completed: %s", event.Message)
} else {
log.Infof("Retrieval transfer completed")
}
transfer.lk.Lock()
transfer.status = RetrievalTransferStatusCompleted
transfer.lk.Unlock()
close()
}
}
func (client *Client) handleRetrievalDealResponse(
ctx context.Context,
event datatransfer.Event,
channelState datatransfer.ChannelState,
response *retrievalmarket.DealResponse,
) {
log := log.With("channelID", channelState.ChannelID())
close := func() {
client.retrievalTransfersLk.Lock()
defer client.retrievalTransfersLk.Unlock()
transfer, ok := client.retrievalTransfers[channelState.ChannelID()]
if !ok {
log.Errorf("Cannot close nonexistent channel: %s", channelState.ChannelID())
}
transfer.lk.Lock()
defer transfer.lk.Unlock()
if err := transfer.close(ctx); err != nil {
log.Errorf("Failed to close transfer with deal ID: %d", transfer.proposal.ID)
}
}
switch response.Status {
case retrievalmarket.DealStatusAccepted:
log.Info("Retrieval transfer accepted: %s", event.Message)
case retrievalmarket.DealStatusRejected:
log.Error("Retrieval transfer rejected: %s", event.Message)
close()
case retrievalmarket.DealStatusFundsNeededUnseal:
log.Error("UNIMPLEMENTED - Funds needed for unseal: %d", response.PaymentOwed)
close()
case retrievalmarket.DealStatusFundsNeeded:
log.Error("UNIMPLEMENTED - Funds needed: %d", response.PaymentOwed)
close()
case retrievalmarket.DealStatusFundsNeededLastPayment:
log.Error("UNIMPLEMENTED - Funds needed for last payment: %d", response.PaymentOwed)
close()
}
}