-
Notifications
You must be signed in to change notification settings - Fork 26
/
reaper.go
1200 lines (1058 loc) · 31.6 KB
/
reaper.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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package reaper
import (
"bytes"
"context"
"encoding/base64"
"encoding/json"
"errors"
"fmt"
"io"
"io/fs"
"os"
"path"
"path/filepath"
"sync"
"time"
"github.com/gammazero/deque"
"github.com/gammazero/targz"
"github.com/ipfs/go-cid"
"github.com/ipfs/go-datastore"
"github.com/ipfs/go-datastore/query"
leveldb "github.com/ipfs/go-ds-leveldb"
logging "github.com/ipfs/go-log/v2"
"github.com/ipld/go-ipld-prime"
cidlink "github.com/ipld/go-ipld-prime/linking/cid"
indexer "github.com/ipni/go-indexer-core"
"github.com/ipni/go-libipni/dagsync"
"github.com/ipni/go-libipni/ingest/schema"
"github.com/ipni/go-libipni/pcache"
"github.com/ipni/storetheindex/carstore"
"github.com/ipni/storetheindex/filestore"
"github.com/ipni/storetheindex/fsutil"
"github.com/libp2p/go-libp2p"
"github.com/libp2p/go-libp2p/core/host"
"github.com/libp2p/go-libp2p/core/peer"
// Import so these codecs get registered.
_ "github.com/ipld/go-ipld-prime/codec/dagcbor"
_ "github.com/ipld/go-ipld-prime/codec/dagjson"
)
var log = logging.Logger("ipni-gc")
var (
ErrProviderNotFound = errors.New("provider not found")
ErrNoCarReader = errors.New("car reader not available")
)
var errIndexerWrite = errors.New("delete from valuestore failed")
type GCStats struct {
AdsProcessed int
CarsDataSize int64
CarsRemoved int
CtxIDsKept int
CtxIDsRemoved int
EmptyAds int
IndexAdsKept int
IndexAdsRemoved int
IndexesRemoved int
RemovalAds int
ReusedCtxIDs int
TimeElapsed time.Duration
}
func (s GCStats) String() string {
return fmt.Sprint(
"AdsProcessed:", s.AdsProcessed,
" CarsDataSize:", s.CarsDataSize,
" CarsRemoved:", s.CarsRemoved,
" CtxIDsKept:", s.CtxIDsKept,
" CtxIDsRemoved:", s.CtxIDsRemoved,
" EmptyAds:", s.EmptyAds,
" IndexAdsKept:", s.IndexAdsKept,
" IndexAdsRemoved:", s.IndexAdsRemoved,
" IndexesRemoved:", s.IndexesRemoved,
" RemovalAds:", s.RemovalAds,
" ReusedCtxIDs:", s.ReusedCtxIDs,
" TimeElapsed:", s.TimeElapsed,
)
}
type Reaper struct {
carDelete bool
carReader *carstore.CarReader
delNotFound bool
dsDir string
dsTmpDir string
entsFromPub bool
fileStore filestore.Interface
host host.Host
hostOwner bool
httpTimeout time.Duration
indexer indexer.Interface
pcache *pcache.ProviderCache
segmentSize int
stats GCStats
statsMutex sync.Mutex
syncSegSize int
topic string
}
type scythe struct {
reaper *Reaper
dstore datastore.Batching
dstoreTmp datastore.Batching
providerID peer.ID
publisher peer.AddrInfo
sub *dagsync.Subscriber
stats GCStats
tmpDir string
}
type GCAd struct {
Previous cid.Cid
ContextID string
Entries cid.Cid
}
type GCState struct {
LastProcessedAdCid cid.Cid
}
type adInfo struct {
cid cid.Cid
contextID []byte
empty bool
isRm bool
}
func dsContextPrefix(contextID string) string {
return fmt.Sprintf("/ctx/%s/", contextID)
}
const (
dsGCStateKey = "/state"
dsRmPrefix = "/rm/"
)
func New(idxr indexer.Interface, fileStore filestore.Interface, options ...Option) (*Reaper, error) {
opts, err := getOpts(options)
if err != nil {
return nil, err
}
var hostOwner bool
if opts.p2pHost == nil {
opts.p2pHost, err = libp2p.New()
if err != nil {
return nil, err
}
hostOwner = true
}
var carReader *carstore.CarReader
if fileStore != nil && opts.carRead {
carReader, err = carstore.NewReader(fileStore, carstore.WithCompress(opts.carCompAlg))
if err != nil {
return nil, fmt.Errorf("cannot create car file reader: %w", err)
}
} else if !opts.entsFromPub {
// No car reader and cannot get from pub, so no way to get entries.
return nil, ErrNoCarReader
}
if opts.pcache == nil {
opts.pcache, err = pcache.New(pcache.WithPreload(false),
pcache.WithRefreshInterval(0),
pcache.WithSourceURL("http://localhost:3000"))
if err != nil {
return nil, err
}
}
if opts.dstoreTmpDir == "" {
opts.dstoreTmpDir = os.TempDir()
}
return &Reaper{
carDelete: opts.carDelete,
carReader: carReader,
delNotFound: opts.deleteNotFound,
dsDir: opts.dstoreDir,
dsTmpDir: opts.dstoreTmpDir,
entsFromPub: opts.entsFromPub,
fileStore: fileStore,
host: opts.p2pHost,
hostOwner: hostOwner,
httpTimeout: opts.httpTimeout,
indexer: idxr,
pcache: opts.pcache,
segmentSize: opts.segmentSize,
syncSegSize: opts.syncSegSize,
topic: opts.topic,
}, nil
}
func (r *Reaper) Close() {
if r.hostOwner {
if err := r.host.Close(); err != nil {
log.Errorw("Failed to close libp2p host", "err", err)
}
}
}
func (r *Reaper) AddStats(a GCStats) {
r.statsMutex.Lock()
defer r.statsMutex.Unlock()
r.stats.AdsProcessed += a.AdsProcessed
r.stats.CarsDataSize += a.CarsDataSize
r.stats.CarsRemoved += a.CarsRemoved
r.stats.CtxIDsKept += a.CtxIDsKept
r.stats.CtxIDsRemoved += a.CtxIDsRemoved
r.stats.EmptyAds += a.EmptyAds
r.stats.IndexAdsKept += a.IndexAdsKept
r.stats.IndexAdsRemoved += a.IndexAdsRemoved
r.stats.IndexesRemoved += a.IndexesRemoved
r.stats.RemovalAds += a.RemovalAds
r.stats.ReusedCtxIDs += a.ReusedCtxIDs
r.stats.TimeElapsed += a.TimeElapsed
}
func (r *Reaper) ClearStats() {
r.statsMutex.Lock()
defer r.statsMutex.Unlock()
r.stats = GCStats{}
}
func (r *Reaper) Stats() GCStats {
r.statsMutex.Lock()
defer r.statsMutex.Unlock()
return r.stats
}
func (r *Reaper) Reap(ctx context.Context, providerID peer.ID) error {
pinfo, err := r.pcache.Get(ctx, providerID)
if err != nil {
return err
}
if pinfo == nil {
if r.delNotFound {
return r.removeProvider(ctx, providerID)
}
return ErrProviderNotFound
}
if pinfo.Publisher == nil {
return errors.New("provider has no publisher")
}
dstore, err := r.openDatastore(ctx, providerID)
if err != nil {
return err
}
defer func() {
if dstore != nil {
dstore.Close()
}
}()
// Create datastore for temporary ad data.
if err = fsutil.DirWritable(r.dsTmpDir); err != nil {
return err
}
tmpDir := filepath.Join(r.dsTmpDir, "gc-tmp-"+providerID.String())
dstoreTmp, err := createDatastore(tmpDir)
if err != nil {
return fmt.Errorf("failed to create temporary datastore: %w", err)
}
defer dstoreTmp.Close()
// Create ipni dagsync Subscriber for the provider.
sub, err := r.makeSubscriber(dstoreTmp)
if err != nil {
return fmt.Errorf("failed to start dagsync subscriber: %w", err)
}
defer sub.Close()
s := &scythe{
reaper: r,
dstore: dstore,
dstoreTmp: dstoreTmp,
providerID: pinfo.AddrInfo.ID,
publisher: *pinfo.Publisher,
sub: sub,
tmpDir: tmpDir,
}
startTime := time.Now()
err = s.reap(ctx, pinfo.LastAdvertisement)
if err != nil {
log.Errorw("Could not process advertisement chain for GC", "err", err)
} else {
defer os.RemoveAll(tmpDir)
}
err = s.reapRemoved(ctx)
if err != nil {
return err
}
s.stats.TimeElapsed = time.Since(startTime)
log.Infow("Finished GC for provider", "provider", providerID, "stats", s.stats.String())
r.AddStats(s.stats)
if dstore == nil {
return nil
}
dstore.Close()
dstore = nil
return s.archiveDatastore(ctx)
}
func (r *Reaper) datastoreExists(ctx context.Context, providerID peer.ID) (bool, error) {
dir := filepath.Join(r.dsDir, dstoreDirName(providerID))
fi, err := os.Stat(dir)
if err != nil {
if !errors.Is(err, fs.ErrNotExist) {
return false, err
}
_, err = r.fileStore.Head(ctx, ArchiveName(providerID))
if err != nil {
if !errors.Is(err, fs.ErrNotExist) {
return false, err
}
return false, nil
}
return true, nil
}
if !fi.IsDir() {
return false, fmt.Errorf("not a directory: %s", dir)
}
return true, nil
}
func (r *Reaper) openDatastore(ctx context.Context, providerID peer.ID) (datastore.Batching, error) {
// Check that parent directory for the gc datastore directory is writable.
err := fsutil.DirWritable(r.dsDir)
if err != nil {
return nil, err
}
// If the gc datastore dir does not already exist, try to get archive from
// filestore.
dstoreDir := filepath.Join(r.dsDir, dstoreDirName(providerID))
_, err = os.Stat(dstoreDir)
if errors.Is(err, fs.ErrNotExist) && r.fileStore != nil {
if err = r.unarchiveDatastore(ctx, providerID); err != nil {
return nil, fmt.Errorf("failed to retrieve datastore from archive: %w", err)
}
}
// Check that the extracted archive directory is readable, and if it does
// not exist create a new gc datastore directory.
dstore, err := createDatastore(dstoreDir)
if err != nil {
return nil, fmt.Errorf("failed to create ipni-gc datastore: %w", err)
}
return dstore, nil
}
func (r *Reaper) removeProvider(ctx context.Context, providerID peer.ID) error {
startTime := time.Now()
exists, err := r.datastoreExists(ctx, providerID)
if err != nil {
return err
}
if exists {
dstore, err := r.openDatastore(ctx, providerID)
if err != nil {
return err
}
defer dstore.Close()
s := &scythe{
reaper: r,
dstore: dstore,
providerID: providerID,
}
err = s.reapAllPrevRemaining(ctx)
if err != nil {
return fmt.Errorf("failed to remove remaining ads from previous gc: %w", err)
}
err = s.reapRemoved(ctx)
if err != nil {
return err
}
dstore.Close()
// Delete gc-datastore archive.
name := ArchiveName(providerID)
err = r.fileStore.Delete(ctx, name)
if err != nil && !errors.Is(err, fs.ErrNotExist) {
log.Errorw("Cannot delete datastore archive for provider", "err", err, "name", name)
}
// Delete gc-datastore.
dstoreDir := filepath.Join(r.dsDir, dstoreDirName(providerID))
err = os.RemoveAll(dstoreDir)
if err != nil && !errors.Is(err, fs.ErrNotExist) {
log.Errorw("Cannot remove datastore directory for provider", "err", err, "dir", dstoreDir)
}
r.AddStats(s.stats)
}
// Delete temporary gc-datastore.
name := filepath.Join(r.dsTmpDir, "gc-tmp-"+providerID.String())
err = os.RemoveAll(name)
if err != nil && !errors.Is(err, fs.ErrNotExist) {
log.Errorw("Cannot remove datastore directory for provider", "err", err, "dir", name)
}
if r.carReader == nil {
return ErrNoCarReader
}
carWriter, err := carstore.NewWriter(nil, r.fileStore)
if err != nil {
return err
}
adCid, err := r.carReader.ReadHead(ctx, providerID)
if err != nil {
if errors.Is(err, fs.ErrNotExist) {
// OK if head file does not exist. No CAR files to clean up.
return nil
}
if err = carWriter.DeleteHead(ctx, providerID); err != nil {
log.Errorw("Failed to delete head file for provider", "err", err, "provider", providerID)
}
return fmt.Errorf("cannot read head advertisement for provider %s: %w", providerID, err)
}
adProviderID, err := r.providerFromCar(ctx, adCid)
if err != nil {
return fmt.Errorf("cannot read provider from car: %w", err)
}
// If providerID is different from the one in the advertisement, then it
// means the publisher ID was given as providerID, since that is what head
// files were previously named with. The real providerID comes from the CAR
// file, so check that the provider does not still exist.
if adProviderID != providerID {
providerID = adProviderID
pinfo, err := r.pcache.Get(ctx, providerID)
if err != nil {
return err
}
if pinfo != nil {
return fmt.Errorf("provider %s still exists", providerID)
}
}
var stats GCStats
var newHead cid.Cid
var cleanErr error
for adCid != cid.Undef {
prevAdCid, mhCount, err := r.cleanCarIndexes(ctx, adCid)
stats.IndexesRemoved += mhCount
if err != nil {
cleanErr = fmt.Errorf("stopping gc due to error removing entries in CAR: %w", err)
break
}
size, err := r.deleteCarFile(ctx, adCid)
if err != nil {
cleanErr = fmt.Errorf("cannot delete car file: %w", err)
break
}
if size != 0 {
stats.CarsRemoved++
stats.CarsDataSize += size
}
newHead = adCid
adCid = prevAdCid
}
if adCid == cid.Undef {
if err = carWriter.DeleteHead(ctx, providerID); err != nil {
err = fmt.Errorf("failed to delete head file: %w", err)
}
stats.TimeElapsed = time.Since(startTime)
log.Infow("Finished GC for removed provider", "provider", providerID, "stats", stats.String())
} else if newHead != cid.Undef {
// Did not complete. Save head where GC left off.
_, err = carWriter.WriteHead(ctx, newHead, providerID)
if err != nil {
err = fmt.Errorf("failed to update head file: %w", err)
}
stats.TimeElapsed = time.Since(startTime)
log.Infow("Incomplete GC for removed provider", "provider", providerID, "stats", stats.String())
}
if err != nil {
if cleanErr != nil {
log.Error(err.Error())
err = cleanErr
}
}
r.AddStats(stats)
return err
}
func (r *Reaper) providerFromCar(ctx context.Context, adCid cid.Cid) (peer.ID, error) {
adBlock, err := r.carReader.Read(ctx, adCid, true)
if err != nil {
return "", err
}
ad, err := adBlock.Advertisement()
if err != nil {
return "", err
}
return peer.Decode(ad.Provider)
}
func (r *Reaper) cleanCarIndexes(ctx context.Context, adCid cid.Cid) (cid.Cid, int, error) {
// Create a context to cancel the carReader reading entries.
readCtx, cancel := context.WithCancel(ctx)
defer cancel()
adBlock, err := r.carReader.Read(readCtx, adCid, false)
if err != nil {
return cid.Undef, 0, fmt.Errorf("cannot read car file: %w", err)
}
ad, err := adBlock.Advertisement()
if err != nil {
log.Errorw("Failed to decode advertisement from car file", "err", err)
return cid.Undef, 0, nil
}
var prevAdCid cid.Cid
if ad.PreviousID != nil {
prevAdCid = ad.PreviousID.(cidlink.Link).Cid
}
if adBlock.Entries == nil {
return prevAdCid, 0, nil
}
providerID, err := peer.Decode(ad.Provider)
if err != nil {
return cid.Undef, 0, fmt.Errorf("cannot get provider from advertisement: %w", err)
}
value := indexer.Value{
ProviderID: providerID,
ContextID: ad.ContextID,
MetadataBytes: ad.Metadata,
}
indexer := r.indexer
var mhCount int
for entryBlock := range adBlock.Entries {
if entryBlock.Err != nil {
log.Errorw("Error reading entries block", "err", err)
continue
}
chunk, err := entryBlock.EntryChunk()
if err != nil {
log.Errorw("Failed to decode entry chunk from car file data", "err", err)
continue
}
if len(chunk.Entries) == 0 {
continue
}
if err = indexer.Remove(value, chunk.Entries...); err != nil {
return cid.Undef, mhCount, fmt.Errorf("%w: %w", errIndexerWrite, err)
}
mhCount += len(chunk.Entries)
}
return prevAdCid, mhCount, nil
}
func (r *Reaper) deleteCarFile(ctx context.Context, adCid cid.Cid) (int64, error) {
if r.carReader == nil || !r.carDelete {
return 0, nil
}
carPath := r.carReader.CarPath(adCid)
file, err := r.fileStore.Head(ctx, carPath)
if err != nil {
if errors.Is(err, fs.ErrNotExist) {
return 0, nil
}
return 0, err
}
if err = r.fileStore.Delete(ctx, carPath); err != nil {
return 0, fmt.Errorf("failed to remove CAR file: %w", err)
}
log.Infow("Deleted CAR file", "name", carPath, "size", file.Size)
return file.Size, nil
}
func (r *Reaper) makeSubscriber(dstoreTmp datastore.Batching) (*dagsync.Subscriber, error) {
linksys := cidlink.DefaultLinkSystem()
linksys.StorageReadOpener = func(lctx ipld.LinkContext, lnk ipld.Link) (io.Reader, error) {
c := lnk.(cidlink.Link).Cid
val, err := dstoreTmp.Get(lctx.Ctx, datastore.NewKey(c.String()))
if err != nil {
return nil, err
}
return bytes.NewBuffer(val), nil
}
linksys.StorageWriteOpener = func(lctx ipld.LinkContext) (io.Writer, ipld.BlockWriteCommitter, error) {
buf := bytes.NewBuffer(nil)
return buf, func(lnk ipld.Link) error {
c := lnk.(cidlink.Link).Cid
return dstoreTmp.Put(lctx.Ctx, datastore.NewKey(c.String()), buf.Bytes())
}, nil
}
return dagsync.NewSubscriber(r.host, dstoreTmp, linksys, r.topic,
dagsync.HttpTimeout(r.httpTimeout),
dagsync.SegmentDepthLimit(int64(r.syncSegSize)))
}
func (s *scythe) prevAdCid(adCid cid.Cid) (cid.Cid, error) {
ad, err := s.loadAd(adCid)
if err != nil {
return cid.Undef, err
}
return ad.PreviousCid(), nil
}
func (s *scythe) reap(ctx context.Context, latestAdCid cid.Cid) error {
log.Infow("Starting GC for provider", "latestAd", latestAdCid, "provider", s.providerID)
if latestAdCid == cid.Undef {
log.Info("No advertisements ingested to GC")
return nil
}
gcState, err := s.loadGCState(ctx)
if err != nil {
return fmt.Errorf("failed to load gc state for provider: %w", err)
}
if gcState.LastProcessedAdCid == latestAdCid {
log.Info("No new advertisements for GC to process. GC has already processed the latest.")
return nil
}
// Sync unprocessed portion of chain from publisher.
_, err = s.sub.SyncAdChain(ctx, s.publisher,
dagsync.WithHeadAdCid(latestAdCid),
dagsync.WithStopAdCid(gcState.LastProcessedAdCid),
dagsync.ScopedBlockHook(dagsync.MakeGeneralBlockHook(s.prevAdCid)),
)
if err != nil {
return fmt.Errorf("failed to sync advertisement chain: %w", err)
}
log.Debug("Synced unprocessed portion of advertisement chain from publisher")
defer func() {
if s.stats.IndexAdsRemoved != 0 {
s.dstore.Sync(ctx, datastore.NewKey(dsRmPrefix))
}
}()
segSize := s.reaper.segmentSize
segment := deque.New[adInfo](segSize, segSize)
for segEnd := gcState.LastProcessedAdCid; segEnd != latestAdCid; {
for adCid := latestAdCid; adCid != segEnd; {
ad, err := s.loadAd(adCid)
if err != nil {
return fmt.Errorf("failed to load advertisement %s: %w", adCid.String(), err)
}
if segment.Len() == segSize {
segment.PopFront()
}
segment.PushBack(adInfo{
cid: adCid,
contextID: ad.ContextID,
empty: ad.Entries == nil || ad.Entries == schema.NoEntries,
isRm: ad.IsRm,
})
if ad.PreviousID == nil {
break
}
adCid = ad.PreviousID.(cidlink.Link).Cid
if adCid == cid.Undef {
// This should never happen, unless the provider has a
// different chain that it did previously.
log.Errorw("Did not find last provessed advertisement in chain", "lastProcessed", segEnd, "chainEnd", adCid)
break
}
}
segEnd = segment.Front().cid
err = s.reapSegment(ctx, segment)
if err != nil {
return err
}
// Update GC state.
gcState.LastProcessedAdCid = segEnd
if err = s.saveGCState(ctx, gcState); err != nil {
return err
}
}
return nil
}
func (s *scythe) reapSegment(ctx context.Context, segment *deque.Deque[adInfo]) error {
log.Infow("Processing advertisements segment", "size", segment.Len())
removedCtxSet := make(map[string]struct{})
remaining := make(map[string][]cid.Cid)
var err error
for segment.Len() != 0 {
ad := segment.Front()
segment.PopFront()
adCid := ad.cid
contextID := base64.StdEncoding.EncodeToString(ad.contextID)
if ad.isRm {
log.Debugw("Processing removal ad", "adCid", adCid)
s.stats.RemovalAds++
reused, ok := remaining[contextID]
if ok {
s.stats.ReusedCtxIDs++
log.Warnw("ContextID reused after removal", "removedIn", adCid, "reusedIn", reused)
} else {
if _, ok = removedCtxSet[contextID]; !ok {
removedCtxSet[contextID] = struct{}{}
err = s.reapPrevRemaining(ctx, contextID)
if err != nil {
return fmt.Errorf("failed to remove ads with deleted context: %w", err)
}
}
}
// Do not keep car files for removal ads.
if err = s.deleteCarFile(ctx, adCid); err != nil {
return err
}
} else if ad.empty {
log.Debugw("Processing no-content ad", "adCid", adCid)
// Delete CAR file of empty ad.
if err = s.deleteCarFile(ctx, adCid); err != nil {
return err
}
s.stats.EmptyAds++
} else {
_, ok := removedCtxSet[contextID]
if ok {
log.Debugw("Marking index ad for removal", "adCid", adCid)
if err = s.saveRemoved(ctx, adCid); err != nil {
return err
}
} else {
log.Debugw("Keeping index content", "adCid", adCid)
s.stats.IndexAdsKept++
// Append ad cid to list of remaining for this context ID.
remaining[contextID] = append(remaining[contextID], adCid)
}
}
s.stats.AdsProcessed++
}
// Record which ads remain undeleted.
if err = s.saveRemaining(ctx, remaining); err != nil {
return err
}
s.stats.CtxIDsKept += len(remaining)
s.stats.CtxIDsRemoved += len(removedCtxSet)
log.Infow("Done processing advertisements segment", "stats", s.stats.String())
return nil
}
func (s *scythe) saveRemoved(ctx context.Context, adCid cid.Cid) error {
// Put removed ad CID in datastore for deleting later.
err := s.dstore.Put(ctx, datastore.NewKey(dsRmPrefix+adCid.String()), []byte{})
if err != nil {
return fmt.Errorf("failed to write removed ad to datastore: %w", err)
}
s.stats.IndexAdsRemoved++
return nil
}
func (s *scythe) reapRemoved(ctx context.Context) error {
log.Infow("Removing index content for all removed advertisements")
q := query.Query{
Prefix: dsRmPrefix,
KeysOnly: true,
}
results, err := s.dstore.Query(ctx, q)
if err != nil {
return err
}
defer s.dstore.Sync(ctx, datastore.NewKey(dsRmPrefix))
for r := range results.Next() {
if r.Error != nil {
results.Close()
return fmt.Errorf("error querying removed ads for provider %s: %w", s.providerID, err)
}
adCid, err := cid.Decode(path.Base(r.Entry.Key))
if err != nil {
log.Errorw("Cannot decode removed advertisement cid", "err", err)
}
// Ad's context ID is removed, so delete all multihashes for ad.
if err = s.removeEntries(ctx, adCid); err != nil {
return fmt.Errorf("could not delete advertisement content: %w", err)
}
// Do not keep CAR file with removed entries.
if err = s.deleteCarFile(ctx, adCid); err != nil {
return err
}
err = s.dstore.Delete(ctx, datastore.NewKey(r.Entry.Key))
if err != nil {
log.Errorw("Cannot delete removed advertisement cid", "err", err)
}
}
results.Close()
return nil
}
// reapAllPrevRemaining marks all previously remaining ads for removal.
func (s *scythe) reapAllPrevRemaining(ctx context.Context) error {
return s.reapPrefixedAds(ctx, "/ctx/")
}
// reapPrevRemaining marks previously remaining ads for removeal that have the
// specified context ID.
func (s *scythe) reapPrevRemaining(ctx context.Context, contextID string) error {
return s.reapPrefixedAds(ctx, dsContextPrefix(contextID))
}
func (s *scythe) reapPrefixedAds(ctx context.Context, prefix string) error {
q := query.Query{
Prefix: prefix,
KeysOnly: true,
}
results, err := s.dstore.Query(ctx, q)
if err != nil {
return err
}
ents, err := results.Rest()
if err != nil {
return err
}
if len(ents) == 0 {
return nil
}
log.Debugw("Deleting indexes from previously processed ads that have removed contextID", "ads", len(ents))
for i := range ents {
key := ents[i].Key
adCid, err := cid.Decode(path.Base(key))
if err != nil {
log.Errorw("Cannot decode remaining advertisement cid", "err", err)
if err = s.dstore.Delete(ctx, datastore.NewKey(key)); err != nil {
return err
}
continue
}
if err = s.saveRemoved(ctx, adCid); err != nil {
return err
}
if err = s.dstore.Delete(ctx, datastore.NewKey(key)); err != nil {
return err
}
}
return s.dstore.Sync(ctx, datastore.NewKey(prefix))
}
func (s *scythe) saveRemaining(ctx context.Context, remaining map[string][]cid.Cid) error {
for contextID, adCids := range remaining {
ctxPrefix := dsContextPrefix(contextID)
for _, adCid := range adCids {
remainingKey := datastore.NewKey(ctxPrefix + adCid.String())
err := s.dstore.Put(ctx, remainingKey, []byte{})
if err != nil {
return fmt.Errorf("failed to write remaining ads to datastore: %w", err)
}
}
}
return nil
}
func (s *scythe) deleteCarFile(ctx context.Context, adCid cid.Cid) error {
size, err := s.reaper.deleteCarFile(ctx, adCid)
if err != nil {
return err
}
if size != 0 {
s.stats.CarsRemoved++
s.stats.CarsDataSize += size
}
return nil
}
func (s *scythe) loadGCState(ctx context.Context) (GCState, error) {
if s.dstore == nil {
return GCState{}, nil
}
gcStateData, err := s.dstore.Get(ctx, datastore.NewKey(dsGCStateKey))
if err != nil {
if err != datastore.ErrNotFound {
return GCState{}, fmt.Errorf("could not read gc state from datastore: %w", err)
}
return GCState{}, nil
}
var gcState GCState
err = json.Unmarshal(gcStateData, &gcState)
if err != nil {
return GCState{}, fmt.Errorf("cannot decode gc state data: %w", err)
}
return gcState, nil
}
func (s *scythe) saveGCState(ctx context.Context, gcState GCState) error {
if s.dstore == nil {
return nil
}
data, err := json.Marshal(&gcState)
if err != nil {
return fmt.Errorf("cannot encode gc state data: %w", err)
}
key := datastore.NewKey(dsGCStateKey)
err = s.dstore.Put(ctx, key, data)
if err != nil {
return err
}
return s.dstore.Sync(ctx, key)
}
// removeEntries acquires the entries for the specified advertisement, either
// from a CAR file or from the publisher, and removes the corresponding
// indexes.
func (s *scythe) removeEntries(ctx context.Context, adCid cid.Cid) error {
prevRemoved := s.stats.IndexesRemoved
var err error
source := "none"
if s.reaper.carReader != nil {
err = s.removeEntriesFromCar(ctx, adCid)
if err != nil {
if errors.Is(err, errIndexerWrite) {
return err
}
log.Warnw("Cannot get advertisement from car store", "err", err, "adCid", adCid)
} else {
source = "CAR"
}
} else {
err = ErrNoCarReader
}
if err != nil && s.reaper.entsFromPub && s.sub != nil {
err = s.removeEntriesFromPublisher(ctx, adCid)
if err != nil {
if errors.Is(err, errIndexerWrite) {
return err
}
log.Warnw("Cannot get advertisement from publisher, not deleting entries", "err", err, "adCid", adCid)
return nil
} else {
source = "synced from publisher"
}
}
newRemoved := s.stats.IndexesRemoved - prevRemoved
log.Infow("Removed indexes in removed ad", "adCid", adCid, "count", newRemoved, "total", s.stats.IndexesRemoved, "source", source)
return nil
}
func (s *scythe) removeEntriesFromCar(ctx context.Context, adCid cid.Cid) error {
// Create a context to cancel the carReader reading entries.
ctx, cancel := context.WithCancel(ctx)
defer cancel()
adBlock, err := s.reaper.carReader.Read(ctx, adCid, false)
if err != nil {
return err
}
if adBlock.Entries == nil {
// This advertisement has no entries because they were removed later in
// the chain and were not saved, or the publisher was not serving