-
Notifications
You must be signed in to change notification settings - Fork 8.8k
/
rollback.go
303 lines (262 loc) · 9.75 KB
/
rollback.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
/*
Copyright IBM Corp. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
package fsblkstorage
import (
"os"
"github.com/hyperledger/fabric/common/ledger/blkstorage"
"github.com/hyperledger/fabric/common/ledger/util"
"github.com/hyperledger/fabric/common/ledger/util/leveldbhelper"
"github.com/pkg/errors"
)
type rollbackMgr struct {
ledgerID string
ledgerDir string
indexDir string
dbProvider *leveldbhelper.Provider
indexStore *blockIndex
targetBlockNum uint64
}
// Rollback reverts changes made to the block store beyond a given block number.
func Rollback(blockStorageDir, ledgerID string, targetBlockNum uint64, indexConfig *blkstorage.IndexConfig) error {
r, err := newRollbackMgr(blockStorageDir, ledgerID, indexConfig, targetBlockNum)
if err != nil {
return err
}
defer r.dbProvider.Close()
if err := recordHeightIfGreaterThanPreviousRecording(r.ledgerDir); err != nil {
return err
}
logger.Infof("Rolling back block index to block number [%d]", targetBlockNum)
if err := r.rollbackBlockIndex(); err != nil {
return err
}
logger.Infof("Rolling back block files to block number [%d]", targetBlockNum)
if err := r.rollbackBlockFiles(); err != nil {
return err
}
return nil
}
func newRollbackMgr(blockStorageDir, ledgerID string, indexConfig *blkstorage.IndexConfig, targetBlockNum uint64) (*rollbackMgr, error) {
r := &rollbackMgr{}
r.ledgerID = ledgerID
conf := &Conf{blockStorageDir: blockStorageDir}
r.ledgerDir = conf.getLedgerBlockDir(ledgerID)
r.targetBlockNum = targetBlockNum
r.indexDir = conf.getIndexDir()
r.dbProvider = leveldbhelper.NewProvider(&leveldbhelper.Conf{DBPath: r.indexDir})
var err error
indexDB := r.dbProvider.GetDBHandle(ledgerID)
r.indexStore, err = newBlockIndex(indexConfig, indexDB)
return r, err
}
func (r *rollbackMgr) rollbackBlockIndex() error {
lastBlockNumber, err := r.indexStore.getLastBlockIndexed()
if err == errIndexEmpty {
return nil
}
if err != nil {
return err
}
// we remove index associated with only 10 blocks at a time
// to avoid overuse of memory occupied by the leveldb batch.
// If we assume a block size of 2000 transactions and 4 indices
// per transaction and 2 index per block, the total number of
// index keys to be added in the batch would be 80020. Even if a
// key takes 100 bytes (overestimation), the memory utilization
// of a batch of 10 blocks would be 7 MB only.
batchLimit := uint64(10)
// start each iteration of the loop with full range for deletion
// and shrink the range to batchLimit if the range is greater than batchLimit
start, end := r.targetBlockNum+1, lastBlockNumber
for end >= start {
if end-start >= batchLimit {
start = end - batchLimit + 1 // 1 is added as range is inclusive
}
logger.Infof("Deleting index associated with block number [%d] to [%d]", start, end)
if err := r.deleteIndexEntriesRange(start, end); err != nil {
return err
}
start, end = r.targetBlockNum+1, start-1
}
return nil
}
func (r *rollbackMgr) deleteIndexEntriesRange(startBlkNum, endBlkNum uint64) error {
// TODO: when more than half of the blocks' indices are to be deleted, it
// might be efficient to drop the whole index database rather than deleting
// entries. However, if there is more than more than 1 channel, dropping of
// index would impact the time taken to recover the peer. We need to analyze
// a bit before making a decision on rollback vs drop of index. FAB-15672
batch := leveldbhelper.NewUpdateBatch()
lp, err := r.indexStore.getBlockLocByBlockNum(startBlkNum)
if err != nil {
return err
}
stream, err := newBlockStream(r.ledgerDir, lp.fileSuffixNum, int64(lp.offset), -1)
defer stream.close()
numberOfBlocksToRetrieve := endBlkNum - startBlkNum + 1
for numberOfBlocksToRetrieve > 0 {
blockBytes, placementInfo, err := stream.nextBlockBytesAndPlacementInfo()
if err != nil {
return err
}
blockInfo, err := extractSerializedBlockInfo(blockBytes)
if err != nil {
return err
}
err = populateBlockInfoWithDuplicateTxids(blockInfo, placementInfo, r.indexStore)
if err != nil {
return err
}
addIndexEntriesToBeDeleted(batch, blockInfo, r.indexStore)
numberOfBlocksToRetrieve--
}
batch.Put(indexCheckpointKey, encodeBlockNum(startBlkNum-1))
return r.indexStore.db.WriteBatch(batch, true)
}
func populateBlockInfoWithDuplicateTxids(blockInfo *serializedBlockInfo, placementInfo *blockPlacementInfo, indexStore *blockIndex) error {
// to detect duplicate txID, BlockTxID index must have been enabled.
if !indexStore.isAttributeIndexed(blkstorage.IndexableAttrBlockTxID) {
return nil
}
for _, txOffset := range blockInfo.txOffsets {
blockLoc, err := indexStore.getBlockLocByTxID(txOffset.txID)
// There is a situations where the txid entries for a config transaction may not present in the index. This is caused
// by the fact that in the data produced by a release prior to 1.4.2, the txID for a config transaction is used as
// an empty string. However, in the data produced by release 1.4.2 (and up), the real txID is used by computing in the
// indexing code. So, a mismatch is possible where the generated txID is not present in the index
if err == blkstorage.ErrNotFoundInIndex {
logger.Warnf("TxID [%s] not found in index... skipping this TxID", txOffset.txID)
continue
}
if err != nil {
return err
}
// if the existing index entry points to a different block number, then the txID is duplicate
if blockLoc.fileSuffixNum != placementInfo.fileNum || blockLoc.offset != int(placementInfo.blockStartOffset) {
txOffset.isDuplicate = true
}
}
return nil
}
func addIndexEntriesToBeDeleted(batch *leveldbhelper.UpdateBatch, blockInfo *serializedBlockInfo, indexStore *blockIndex) error {
if indexStore.isAttributeIndexed(blkstorage.IndexableAttrBlockHash) {
batch.Delete(constructBlockHashKey(blockInfo.blockHeader.Hash()))
}
if indexStore.isAttributeIndexed(blkstorage.IndexableAttrBlockNum) {
batch.Delete(constructBlockNumKey(blockInfo.blockHeader.Number))
}
if indexStore.isAttributeIndexed(blkstorage.IndexableAttrBlockNumTranNum) {
for txIndex := range blockInfo.txOffsets {
batch.Delete(constructBlockNumTranNumKey(blockInfo.blockHeader.Number, uint64(txIndex)))
}
}
for _, txOffset := range blockInfo.txOffsets {
if txOffset.isDuplicate {
continue
}
if indexStore.isAttributeIndexed(blkstorage.IndexableAttrTxID) {
batch.Delete(constructTxIDKey(txOffset.txID))
}
if indexStore.isAttributeIndexed(blkstorage.IndexableAttrBlockTxID) {
batch.Delete(constructBlockTxIDKey(txOffset.txID))
}
if indexStore.isAttributeIndexed(blkstorage.IndexableAttrTxValidationCode) {
batch.Delete(constructTxValidationCodeIDKey(txOffset.txID))
}
}
return nil
}
func (r *rollbackMgr) rollbackBlockFiles() error {
logger.Infof("Deleting checkpointInfo")
if err := r.indexStore.db.Delete(blkMgrInfoKey, true); err != nil {
return err
}
// must not use index for block location search since the index can be behind the target block
targetFileNum, err := binarySearchFileNumForBlock(r.ledgerDir, r.targetBlockNum)
if err != nil {
return err
}
lastFileNum, err := retrieveLastFileSuffix(r.ledgerDir)
if err != nil {
return err
}
logger.Infof("Removing all block files with suffixNum in the range [%d] to [%d]",
targetFileNum+1, lastFileNum)
for n := lastFileNum; n >= targetFileNum+1; n-- {
filepath := deriveBlockfilePath(r.ledgerDir, n)
if err := os.Remove(filepath); err != nil {
return errors.Wrapf(err, "error removing the block file [%s]", filepath)
}
}
logger.Infof("Truncating block file [%d] to the end boundary of block number [%d]", targetFileNum, r.targetBlockNum)
endOffset, err := calculateEndOffSet(r.ledgerDir, targetFileNum, r.targetBlockNum)
if err != nil {
return err
}
filePath := deriveBlockfilePath(r.ledgerDir, targetFileNum)
if err := os.Truncate(filePath, endOffset); err != nil {
return errors.Wrapf(err, "error trucating the block file [%s]", filePath)
}
return nil
}
func calculateEndOffSet(ledgerDir string, targetBlkFileNum int, blockNum uint64) (int64, error) {
stream, err := newBlockfileStream(ledgerDir, targetBlkFileNum, 0)
if err != nil {
return 0, err
}
defer stream.close()
for {
blockBytes, err := stream.nextBlockBytes()
if err != nil {
return 0, err
}
blockInfo, err := extractSerializedBlockInfo(blockBytes)
if err != nil {
return 0, err
}
if blockInfo.blockHeader.Number == blockNum {
break
}
}
return stream.currentOffset, nil
}
// ValidateRollbackParams performs necessary validation on the input given for
// the rollback operation.
func ValidateRollbackParams(blockStorageDir, ledgerID string, targetBlockNum uint64) error {
logger.Infof("Validating the rollback parameters: ledgerID [%s], block number [%d]",
ledgerID, targetBlockNum)
conf := &Conf{blockStorageDir: blockStorageDir}
ledgerDir := conf.getLedgerBlockDir(ledgerID)
if err := validateLedgerID(ledgerDir, ledgerID); err != nil {
return err
}
if err := validateTargetBlkNum(ledgerDir, targetBlockNum); err != nil {
return err
}
return nil
}
func validateLedgerID(ledgerDir, ledgerID string) error {
logger.Debugf("Validating the existance of ledgerID [%s]", ledgerID)
exists, _, err := util.FileExists(ledgerDir)
if err != nil {
return err
}
if !exists {
return errors.Errorf("ledgerID [%s] does not exist", ledgerID)
}
return nil
}
func validateTargetBlkNum(ledgerDir string, targetBlockNum uint64) error {
logger.Debugf("Validating the given block number [%d] agains the ledger block height", targetBlockNum)
cpInfo, err := constructCheckpointInfoFromBlockFiles(ledgerDir)
if err != nil {
return err
}
if cpInfo.lastBlockNumber <= targetBlockNum {
return errors.Errorf("target block number [%d] should be less than the biggest block number [%d]",
targetBlockNum, cpInfo.lastBlockNumber)
}
return nil
}