aboutsummaryrefslogtreecommitdiffstats
path: root/eth/db_upgrade.go
blob: ce8ce699ab2654bb2ae853725a577899ecb360a3 (plain) (blame)
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
// Copyright 2016 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 eth implements the Ethereum protocol.
package eth

import (
    "bytes"
    "time"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/common/bitutil"
    "github.com/ethereum/go-ethereum/core"
    "github.com/ethereum/go-ethereum/core/bloombits"
    "github.com/ethereum/go-ethereum/core/types"
    "github.com/ethereum/go-ethereum/ethdb"
    "github.com/ethereum/go-ethereum/log"
    "github.com/ethereum/go-ethereum/rlp"
)

var deduplicateData = []byte("dbUpgrade_20170714deduplicateData")

// upgradeDeduplicateData checks the chain database version and
// starts a background process to make upgrades if necessary.
// Returns a stop function that blocks until the process has
// been safely stopped.
func upgradeDeduplicateData(db ethdb.Database) func() error {
    // If the database is already converted or empty, bail out
    data, _ := db.Get(deduplicateData)
    if len(data) > 0 && data[0] == 42 {
        return nil
    }
    if data, _ := db.Get([]byte("LastHeader")); len(data) == 0 {
        db.Put(deduplicateData, []byte{42})
        return nil
    }
    // Start the deduplication upgrade on a new goroutine
    log.Warn("Upgrading database to use lookup entries")
    stop := make(chan chan error)

    go func() {
        // Create an iterator to read the entire database and covert old lookup entires
        it := db.(*ethdb.LDBDatabase).NewIterator()
        defer func() {
            if it != nil {
                it.Release()
            }
        }()

        var (
            converted uint64
            failed    error
        )
        for failed == nil && it.Next() {
            // Skip any entries that don't look like old transaction meta entires (<hash>0x01)
            key := it.Key()
            if len(key) != common.HashLength+1 || key[common.HashLength] != 0x01 {
                continue
            }
            // Skip any entries that don't contain metadata (name clash between <hash>0x01 and <some-prefix><hash>)
            var meta struct {
                BlockHash  common.Hash
                BlockIndex uint64
                Index      uint64
            }
            if err := rlp.DecodeBytes(it.Value(), &meta); err != nil {
                continue
            }
            // Skip any already upgraded entries (clash due to <hash> ending with 0x01 (old suffix))
            hash := key[:common.HashLength]

            if hash[0] == byte('l') {
                // Potential clash, the "old" `hash` must point to a live transaction.
                if tx, _, _, _ := core.GetTransaction(db, common.BytesToHash(hash)); tx == nil || !bytes.Equal(tx.Hash().Bytes(), hash) {
                    continue
                }
            }
            // Convert the old metadata to a new lookup entry, delete duplicate data
            if failed = db.Put(append([]byte("l"), hash...), it.Value()); failed == nil { // Write the new looku entry
                if failed = db.Delete(hash); failed == nil { // Delete the duplicate transaction data
                    if failed = db.Delete(append([]byte("receipts-"), hash...)); failed == nil { // Delete the duplicate receipt data
                        if failed = db.Delete(key); failed != nil { // Delete the old transaction metadata
                            break
                        }
                    }
                }
            }
            // Bump the conversion counter, and recreate the iterator occasionally to
            // avoid too high memory consumption.
            converted++
            if converted%100000 == 0 {
                it.Release()
                it = db.(*ethdb.LDBDatabase).NewIterator()
                it.Seek(key)

                log.Info("Deduplicating database entries", "deduped", converted)
            }
            // Check for termination, or continue after a bit of a timeout
            select {
            case errc := <-stop:
                errc <- nil
                return
            case <-time.After(time.Microsecond * 100):
            }
        }
        // Upgrade finished, mark a such and terminate
        if failed == nil {
            log.Info("Database deduplication successful", "deduped", converted)
            db.Put(deduplicateData, []byte{42})
        } else {
            log.Error("Database deduplication failed", "deduped", converted, "err", failed)
        }
        it.Release()
        it = nil

        errc := <-stop
        errc <- failed
    }()
    // Assembly the cancellation callback
    return func() error {
        errc := make(chan error)
        stop <- errc
        return <-errc
    }
}

// BloomBitsIndex implements ChainIndex
type BloomBitsIndex struct {
    db                   ethdb.Database
    bc                   *bloombits.BloomBitsCreator
    section, sectionSize uint64
    sectionHead          common.Hash
}

// number of confirmation blocks before a section is considered probably final and its bloom bits are calculated
const bloomBitsConfirmations = 256

// NewBloomBitsProcessor returns a chain processor that generates bloom bits data for the canonical chain
func NewBloomBitsProcessor(db ethdb.Database, sectionSize uint64) *core.ChainIndexer {
    backend := &BloomBitsIndex{db: db, sectionSize: sectionSize}
    return core.NewChainIndexer(db, ethdb.NewTable(db, "bbIndex-"), backend, sectionSize, bloomBitsConfirmations, time.Millisecond*100, "bloombits")
}

func (b *BloomBitsIndex) Reset(section uint64, lastSectionHead common.Hash) {
    b.bc = bloombits.NewBloomBitsCreator(b.sectionSize)
    b.section = section
}

func (b *BloomBitsIndex) Process(header *types.Header) {
    b.bc.AddHeaderBloom(header.Bloom)
    b.sectionHead = header.Hash()
}

func (b *BloomBitsIndex) Commit() error {
    for i := 0; i < bloombits.BloomLength; i++ {
        compVector := bitutil.CompressBytes(b.bc.GetBitVector(uint(i)))
        core.StoreBloomBits(b.db, uint64(i), b.section, b.sectionHead, compVector)
    }
    return nil
}