-
Notifications
You must be signed in to change notification settings - Fork 200
/
oldDatabaseCleaner.go
277 lines (225 loc) · 7.22 KB
/
oldDatabaseCleaner.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
package clean
import (
"math"
"os"
"path"
"sort"
"strconv"
"strings"
"sync"
"github.com/ElrondNetwork/elrond-go-core/core/check"
"github.com/ElrondNetwork/elrond-go-core/data"
logger "github.com/ElrondNetwork/elrond-go-logger"
"github.com/ElrondNetwork/elrond-go/common"
"github.com/ElrondNetwork/elrond-go/epochStart/notifier"
"github.com/ElrondNetwork/elrond-go/storage"
"github.com/ElrondNetwork/elrond-go/storage/factory/directoryhandler"
)
var log = logger.GetOrCreate("storage/clean")
// ArgsOldDatabaseCleaner holds the arguments needed for creating an oldDatabaseCleaner
type ArgsOldDatabaseCleaner struct {
DatabasePath string
StorageListProvider StorageListProviderHandler
EpochStartNotifier EpochStartNotifier
OldDataCleanerProvider OldDataCleanerProvider
}
type oldDatabaseCleaner struct {
sync.RWMutex
databasePath string
storageListProvider StorageListProviderHandler
pathRemover func(file string) error
directoryReader storage.DirectoryReaderHandler
oldDataCleanerProvider OldDataCleanerProvider
oldestEpochsToKeep map[uint32]uint32
}
// NewOldDatabaseCleaner returns a new instance of oldDatabaseCleaner
func NewOldDatabaseCleaner(args ArgsOldDatabaseCleaner) (*oldDatabaseCleaner, error) {
if check.IfNil(args.StorageListProvider) {
return nil, storage.ErrNilStorageListProvider
}
if check.IfNil(args.EpochStartNotifier) {
return nil, storage.ErrNilEpochStartNotifier
}
if check.IfNil(args.OldDataCleanerProvider) {
return nil, storage.ErrNilOldDataCleanerProvider
}
pathRemoverFunc := func(file string) error {
return os.RemoveAll(file)
}
directoryReader := directoryhandler.NewDirectoryReader()
odc := &oldDatabaseCleaner{
databasePath: args.DatabasePath,
storageListProvider: args.StorageListProvider,
pathRemover: pathRemoverFunc,
directoryReader: directoryReader,
oldDataCleanerProvider: args.OldDataCleanerProvider,
oldestEpochsToKeep: make(map[uint32]uint32),
}
odc.registerHandler(args.EpochStartNotifier)
return odc, nil
}
// registerHandler will register a new function to the epoch start notifier
func (odc *oldDatabaseCleaner) registerHandler(handler EpochStartNotifier) {
subscribeHandler := notifier.NewHandlerForEpochStart(
odc.epochChangeActionHandler,
odc.epochChangePrepareHandler,
common.OldDatabaseCleanOrder)
handler.RegisterHandler(subscribeHandler)
}
func (odc *oldDatabaseCleaner) epochChangeActionHandler(hdr data.HeaderHandler) {
err := odc.handleEpochChangeAction(hdr.GetEpoch())
if err != nil {
log.Debug("oldDatabaseCleaner: handleEpochChangeAction", "error", err)
}
}
func (odc *oldDatabaseCleaner) epochChangePrepareHandler(_ data.HeaderHandler) {
}
func (odc *oldDatabaseCleaner) handleEpochChangeAction(epoch uint32) error {
newOldestEpoch, err := odc.computeOldestEpochToKeep()
if err != nil {
return err
}
odc.Lock()
odc.oldestEpochsToKeep[epoch] = newOldestEpoch
odc.Unlock()
shouldClean := odc.shouldCleanOldData(epoch, newOldestEpoch)
log.Debug("old database cleaner", "epoch", epoch, "should clean", shouldClean, "inner map", odc.oldestEpochsToKeep)
if !shouldClean {
return nil
}
err = odc.cleanOldEpochs(epoch)
if err != nil {
return err
}
return nil
}
func (odc *oldDatabaseCleaner) shouldCleanOldData(currentEpoch uint32, newOldestEpoch uint32) bool {
odc.RLock()
defer odc.RUnlock()
if !odc.oldDataCleanerProvider.ShouldClean() {
return false
}
epochForDeletion := currentEpoch - 1
previousOldestEpoch, epochExists := odc.oldestEpochsToKeep[epochForDeletion]
if !epochExists {
log.Debug("cannot delete old databases as the previous epoch does not exist in configuration",
"epoch", epochForDeletion,
"epochs configuration", odc.oldestEpochsToKeep)
return false
}
if previousOldestEpoch > newOldestEpoch {
log.Debug("skipping cleaning of old databases because new oldest epoch is older than previous",
"previous older epoch", previousOldestEpoch,
"actual older epoch", newOldestEpoch)
return false
}
return true
}
func (odc *oldDatabaseCleaner) computeOldestEpochToKeep() (uint32, error) {
odc.RLock()
defer odc.RUnlock()
oldestEpoch := uint32(math.MaxUint32)
storers := odc.storageListProvider.GetAllStorers()
for _, storer := range storers {
localEpoch, err := storer.GetOldestEpoch()
if err != nil {
logOldestEpochCompute(err)
continue
}
if localEpoch < oldestEpoch {
oldestEpoch = localEpoch
}
}
if oldestEpoch == uint32(math.MaxUint32) {
return 0, storage.ErrCannotComputeStorageOldestEpoch
}
return oldestEpoch, nil
}
func logOldestEpochCompute(err error) {
if err != storage.ErrOldestEpochNotAvailable {
log.Debug("cannot compute oldest epoch for storer", "error", err)
}
}
func (odc *oldDatabaseCleaner) cleanOldEpochs(currentEpoch uint32) error {
odc.Lock()
defer odc.Unlock()
epochForDeletion := currentEpoch - 1
epochToDeleteTo := odc.oldestEpochsToKeep[epochForDeletion]
epochDirectories, err := odc.directoryReader.ListDirectoriesAsString(odc.databasePath)
if err != nil {
return err
}
if len(epochDirectories) == 0 {
return nil
}
sortedEpochDirectories, sortedEpochs, found := getSortedEpochDirectories(epochDirectories)
if !found {
return nil
}
for idx, epoch := range sortedEpochs {
if epoch >= epochToDeleteTo {
break
}
fullDirectoryPath := path.Join(odc.databasePath, sortedEpochDirectories[idx])
log.Debug("removing old database", "db path", fullDirectoryPath)
err := odc.pathRemover(fullDirectoryPath)
if err != nil {
log.Warn("cannot remove old DB", "path", fullDirectoryPath, "error", err)
}
}
odc.cleanMap(currentEpoch)
return nil
}
// cleanMap will remove all the entries from the map that aren't for current epoch.
// should be called under mutex protection
func (odc *oldDatabaseCleaner) cleanMap(currentEpoch uint32) {
epochsToRemove := make([]uint32, 0)
for epoch := range odc.oldestEpochsToKeep {
if epoch == currentEpoch {
continue
}
epochsToRemove = append(epochsToRemove, epoch)
}
for _, epochToRemove := range epochsToRemove {
delete(odc.oldestEpochsToKeep, epochToRemove)
}
}
func getSortedEpochDirectories(directories []string) ([]string, []uint32, bool) {
epochToDirMap := make(map[uint32]string)
epochs := make([]uint32, 0)
for _, dir := range directories {
epoch, ok := extractEpochFromDirName(dir)
if !ok {
continue
}
epochToDirMap[epoch] = dir
epochs = append(epochs, epoch)
}
sort.SliceStable(epochs, func(i, j int) bool {
return epochs[i] < epochs[j]
})
sortedDirectories := make([]string, 0, len(epochs))
for _, epoch := range epochs {
sortedDirectories = append(sortedDirectories, epochToDirMap[epoch])
}
notOkResults := len(sortedDirectories) != len(epochs) || len(sortedDirectories) == 0 || len(epochs) == 0
if notOkResults {
return nil, nil, false
}
return sortedDirectories, epochs, true
}
func extractEpochFromDirName(dirName string) (uint32, bool) {
splitStr := strings.Split(dirName, "_")
if len(splitStr) != 2 {
return 0, false
}
epoch, err := strconv.ParseInt(splitStr[1], 10, 64)
if err != nil {
return 0, false
}
return uint32(epoch), true
}
// IsInterfaceNil returns true if there is no value under interface
func (odc *oldDatabaseCleaner) IsInterfaceNil() bool {
return odc == nil
}