-
Notifications
You must be signed in to change notification settings - Fork 339
/
gc.go
413 lines (357 loc) · 11.1 KB
/
gc.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
// Copyright 2018 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
package localstore
import (
"context"
"errors"
"time"
"github.com/ethersphere/bee/pkg/sharky"
"github.com/ethersphere/bee/pkg/shed"
"github.com/ethersphere/bee/pkg/swarm"
"github.com/syndtr/goleveldb/leveldb"
)
var (
// gcTargetRatio defines the target number of items
// in garbage collection index that will not be removed
// on garbage collection. The target number of items
// is calculated by gcTarget function. This value must be
// in range (0,1]. For example, with 0.9 value,
// garbage collection will leave 90% of defined capacity
// in database after its run. This prevents frequent
// garbage collection runs.
gcTargetRatio = 0.9
// gcBatchSize limits the number of chunks in a single
// transaction on garbage collection.
gcBatchSize uint64 = 10_000
reserveEvictionBatch uint64 = 200
)
// collectGarbageWorker is a long running function that waits for
// collectGarbageTrigger channel to signal a garbage collection
// run. GC run iterates on gcIndex and removes older items
// form retrieval and other indexes.
func (db *DB) collectGarbageWorker() {
defer close(db.collectGarbageWorkerDone)
for {
select {
case <-db.collectGarbageTrigger:
// run a single collect garbage run and
// if done is false, gcBatchSize is reached and
// another collect garbage run is needed
collectedCount, done, err := db.collectGarbage()
if err != nil {
db.logger.Error(err, "collect garbage failed")
}
// check if another gc run is needed
if !done {
db.triggerGarbageCollection()
}
if testHookCollectGarbage != nil {
testHookCollectGarbage(collectedCount)
}
case <-db.close:
return
}
}
}
// collectGarbage removes chunks from retrieval and other
// indexes if maximal number of chunks in database is reached.
// This function returns the number of removed chunks. If done
// is false, another call to this function is needed to collect
// the rest of the garbage as the batch size limit is reached.
// This function is called in collectGarbageWorker.
// collected count should reflect how many
func (db *DB) collectGarbage() (evicted uint64, done bool, err error) {
db.metrics.GCCounter.Inc()
defer func(start time.Time) {
if err != nil {
db.metrics.GCErrorCounter.Inc()
}
totalTimeMetric(db.metrics.TotalTimeCollectGarbage, start)
}(time.Now())
batch := new(leveldb.Batch)
target := db.gcTarget()
// tell the localstore to start logging dirty addresses
db.lock.Lock(GC)
db.gcRunning = true
db.lock.Unlock(GC)
defer func() {
db.lock.Lock(GC)
db.gcRunning = false
db.dirtyAddresses = nil
db.lock.Unlock(GC)
}()
gcSize, err := db.gcSize.Get()
if err != nil {
return 0, true, err
}
if gcSize == target {
return 0, true, nil
}
db.metrics.GCSize.Set(float64(gcSize))
first := true
start := time.Now()
candidates := make([]shed.Item, 0, gcBatchSize)
err = db.gcIndex.Iterate(func(item shed.Item) (stop bool, err error) {
if first {
totalTimeMetric(db.metrics.TotalTimeGCFirstItem, start)
first = false
}
if len(candidates) == cap(candidates) {
return true, nil
}
candidates = append(candidates, item)
return false, nil
}, nil)
if err != nil {
return 0, false, err
}
db.metrics.GCCollectedCounter.Add(float64(len(candidates)))
if testHookGCIteratorDone != nil {
testHookGCIteratorDone()
}
// protect database from changing idexes and gcSize
db.lock.Lock(GC)
defer totalTimeMetric(db.metrics.TotalTimeGCLock, time.Now())
defer db.lock.Unlock(GC)
// refresh gcSize value, since it might have
// changed in the meanwhile
gcSize, err = db.gcSize.Get()
if err != nil {
return 0, false, err
}
var totalChunksEvicted uint64
locations := make([]sharky.Location, 0, len(candidates))
// get rid of dirty entries
for _, item := range candidates {
if swarm.NewAddress(item.Address).MemberOf(db.dirtyAddresses) {
continue
}
// candidates are intentionally oversized so that we can afford the
// possible discrepancy in gcSize between the candidates collection phase
// and the actual critical section under lock. we therefore work our way through
// the candidates and stop once the target gc size is reached. the rest of the candidates
// will be iterated upon next time the gc is called. while this is a minor inefficiency in the
// last iteration of the gc eviction, it gets around the edge case of the last iteration never reaching
// the target since the gc size always is bound to change even if to a minor degree in the time between
// candidate collection and the mutex acquisition.
if gcSize-totalChunksEvicted <= target {
done = true
break
}
totalChunksEvicted++
storedItem, err := db.retrievalDataIndex.Get(item)
if err != nil {
if errors.Is(err, leveldb.ErrNotFound) {
if err = db.gcIndex.DeleteInBatch(batch, item); err != nil {
return 0, false, err
}
continue
}
return 0, false, err
}
db.metrics.GCStoreTimeStamps.Set(float64(storedItem.StoreTimestamp))
db.metrics.GCStoreAccessTimeStamps.Set(float64(item.AccessTimestamp))
// delete from retrieve, pull, gc
err = db.retrievalDataIndex.DeleteInBatch(batch, item)
if err != nil {
return 0, false, err
}
err = db.retrievalAccessIndex.DeleteInBatch(batch, item)
if err != nil {
return 0, false, err
}
err = db.pushIndex.DeleteInBatch(batch, storedItem)
if err != nil {
return 0, false, err
}
err = db.pullIndex.DeleteInBatch(batch, item)
if err != nil {
return 0, false, err
}
err = db.gcIndex.DeleteInBatch(batch, item)
if err != nil {
return 0, false, err
}
err = db.postageIndexIndex.DeleteInBatch(batch, storedItem)
if err != nil {
return 0, false, err
}
err = db.postageChunksIndex.DeleteInBatch(batch, item)
if err != nil {
return 0, false, err
}
loc, err := sharky.LocationFromBinary(storedItem.Location)
if err != nil {
return 0, false, err
}
locations = append(locations, loc)
}
db.metrics.GCCommittedCounter.Add(float64(totalChunksEvicted))
db.gcSize.PutInBatch(batch, gcSize-totalChunksEvicted)
err = db.shed.WriteBatch(batch)
if err != nil {
db.metrics.GCErrorCounter.Inc()
return 0, false, err
}
for _, loc := range locations {
err = db.sharky.Release(context.Background(), loc)
if err != nil {
db.logger.Warning("failed releasing sharky location", "location", loc)
}
}
return totalChunksEvicted, done, nil
}
// gcTarget retruns the absolute value for garbage collection
// target value, calculated from db.capacity and gcTargetRatio.
func (db *DB) gcTarget() (target uint64) {
return uint64(float64(db.cacheCapacity) * gcTargetRatio)
}
// triggerGarbageCollection signals collectGarbageWorker
// to call collectGarbage.
func (db *DB) triggerGarbageCollection() {
select {
case db.collectGarbageTrigger <- struct{}{}:
case <-db.close:
default:
}
}
// incGCSizeInBatch changes gcSize field value
// by change which can be negative. This function
// must be called under batchMu lock.
func (db *DB) incGCSizeInBatch(batch *leveldb.Batch, change int64) (err error) {
if change == 0 {
return nil
}
gcSize, err := db.gcSize.Get()
if err != nil && !errors.Is(err, leveldb.ErrNotFound) {
return err
}
var newSize uint64
if change > 0 {
newSize = gcSize + uint64(change)
} else {
// 'change' is an int64 and is negative
// a conversion is needed with correct sign
c := uint64(-change)
if c > gcSize {
// protect uint64 undeflow
return nil
}
newSize = gcSize - c
}
db.gcSize.PutInBatch(batch, newSize)
db.metrics.GCSize.Set(float64(newSize))
// trigger garbage collection if we reached the capacity
if newSize >= db.cacheCapacity {
db.triggerGarbageCollection()
}
return nil
}
func (db *DB) reserveEvictionWorker() {
defer close(db.reserveEvictionWorkerDone)
for {
select {
case <-db.reserveEvictionTrigger:
evictedCount, done, err := db.evictReserve()
if err != nil {
db.logger.Error(err, "evict reserve failed")
}
db.metrics.EvictReserveCollectedCounter.Add(float64(evictedCount))
if !done {
db.triggerReserveEviction()
}
if testHookEviction != nil {
testHookEviction(evictedCount)
}
case <-db.close:
return
}
}
}
func (db *DB) triggerReserveEviction() {
select {
case db.reserveEvictionTrigger <- struct{}{}:
case <-db.close:
default:
}
}
func (db *DB) evictReserve() (totalEvicted uint64, done bool, err error) {
var target uint64
db.metrics.EvictReserveCounter.Inc()
defer func(start time.Time) {
if err != nil {
db.metrics.EvictReserveErrorCounter.Inc()
}
totalTimeMetric(db.metrics.TotalTimeEvictReserve, start)
}(time.Now())
// reserve eviction affects the reserve indexes as well as the GC indexes
db.lock.Lock(Write)
defer db.lock.Unlock(Write)
target = db.reserveCapacity
reserveSizeStart, err := db.reserveSize.Get()
if err != nil {
return 0, false, err
}
db.logger.Debug("gc: reserve eviction", "reserve_size_start", reserveSizeStart, "target", target)
if reserveSizeStart <= target {
return 0, true, nil
}
// if we dont get any entries at all then there's no use
// of triggering subsequent runs in case we're not done
totalCallbacks := 0
err = db.unreserveFunc(func(batchID []byte, radius uint8) (bool, error) {
// if we start evicting chunks from the reserve during sampling, we should
// fail the sampling process and not participate in the current round.
db.stopSamplingIfStarted()
totalCallbacks++
e, err := db.unreserveBatch(batchID, radius)
if err != nil {
return true, err
}
totalEvicted += e
if reserveSizeStart-totalEvicted <= target {
done = true
return true, nil
}
if totalEvicted >= reserveEvictionBatch {
// stop collecting when we reach the eviction
// batch size so that we can avoid lock contention
// on localstore.
return true, nil
}
return false, nil
})
if err != nil {
return 0, false, err
}
if totalCallbacks == 0 {
// if we did not get any items from the batchstore
// it means there's no point of trigerring a subsequent
// round
done = true
}
return totalEvicted, done, nil
}
// testHookCollectGarbage is a hook that can provide
// information when a garbage collection run is done
// and how many items it removed.
var testHookCollectGarbage func(collectedCount uint64)
// testHookGCIteratorDone is a hook which is called
// when the GC is done collecting candidate items for
// eviction.
var testHookGCIteratorDone func()
var withinRadiusFn func(*DB, shed.Item) bool
var testHookEviction func(count uint64)