aboutsummaryrefslogtreecommitdiffstats
path: root/eth/backend.go
blob: f43dea7775685a0fbcd9834af393cfb441956aad (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
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
// Copyright 2014 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"
    "errors"
    "fmt"
    "math/big"
    "os"
    "path/filepath"
    "regexp"
    "strings"
    "time"

    "github.com/ethereum/ethash"
    "github.com/ethereum/go-ethereum/accounts"
    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/common/compiler"
    "github.com/ethereum/go-ethereum/common/httpclient"
    "github.com/ethereum/go-ethereum/common/registrar/ethreg"
    "github.com/ethereum/go-ethereum/core"
    "github.com/ethereum/go-ethereum/core/types"
    "github.com/ethereum/go-ethereum/core/vm"
    "github.com/ethereum/go-ethereum/eth/downloader"
    "github.com/ethereum/go-ethereum/eth/filters"
    "github.com/ethereum/go-ethereum/ethdb"
    "github.com/ethereum/go-ethereum/event"
    "github.com/ethereum/go-ethereum/logger"
    "github.com/ethereum/go-ethereum/logger/glog"
    "github.com/ethereum/go-ethereum/miner"
    "github.com/ethereum/go-ethereum/node"
    "github.com/ethereum/go-ethereum/p2p"
    "github.com/ethereum/go-ethereum/rlp"
    "github.com/ethereum/go-ethereum/rpc"
)

const (
    epochLength    = 30000
    ethashRevision = 23

    autoDAGcheckInterval = 10 * time.Hour
    autoDAGepochHeight   = epochLength / 2
)

var (
    datadirInUseErrnos = map[uint]bool{11: true, 32: true, 35: true}
    portInUseErrRE     = regexp.MustCompile("address already in use")
)

type Config struct {
    ChainConfig *core.ChainConfig // chain configuration

    NetworkId int    // Network ID to use for selecting peers to connect to
    Genesis   string // Genesis JSON to seed the chain database with
    FastSync  bool   // Enables the state download based fast synchronisation algorithm

    BlockChainVersion  int
    SkipBcVersionCheck bool // e.g. blockchain export
    DatabaseCache      int
    DatabaseHandles    int

    NatSpec   bool
    DocRoot   string
    AutoDAG   bool
    PowTest   bool
    PowShared bool
    ExtraData []byte

    AccountManager *accounts.Manager
    Etherbase      common.Address
    GasPrice       *big.Int
    MinerThreads   int
    SolcPath       string

    GpoMinGasPrice          *big.Int
    GpoMaxGasPrice          *big.Int
    GpoFullBlockRatio       int
    GpobaseStepDown         int
    GpobaseStepUp           int
    GpobaseCorrectionFactor int

    EnableJit bool
    ForceJit  bool

    TestGenesisBlock *types.Block   // Genesis block to seed the chain database with (testing only!)
    TestGenesisState ethdb.Database // Genesis state to seed the database with (testing only!)
}

type Ethereum struct {
    chainConfig *core.ChainConfig
    // Channel for shutting down the ethereum
    shutdownChan chan bool

    // DB interfaces
    chainDb ethdb.Database // Block chain database
    dappDb  ethdb.Database // Dapp database

    // Handlers
    txPool          *core.TxPool
    blockchain      *core.BlockChain
    accountManager  *accounts.Manager
    pow             *ethash.Ethash
    protocolManager *ProtocolManager
    SolcPath        string
    solc            *compiler.Solidity
    gpo             *GasPriceOracle

    GpoMinGasPrice          *big.Int
    GpoMaxGasPrice          *big.Int
    GpoFullBlockRatio       int
    GpobaseStepDown         int
    GpobaseStepUp           int
    GpobaseCorrectionFactor int

    httpclient *httpclient.HTTPClient

    eventMux *event.TypeMux
    miner    *miner.Miner

    Mining        bool
    MinerThreads  int
    NatSpec       bool
    AutoDAG       bool
    PowTest       bool
    autodagquit   chan bool
    etherbase     common.Address
    netVersionId  int
    netRPCService *PublicNetAPI
}

func New(ctx *node.ServiceContext, config *Config) (*Ethereum, error) {
    // Open the chain database and perform any upgrades needed
    chainDb, err := ctx.OpenDatabase("chaindata", config.DatabaseCache, config.DatabaseHandles)
    if err != nil {
        return nil, err
    }
    if db, ok := chainDb.(*ethdb.LDBDatabase); ok {
        db.Meter("eth/db/chaindata/")
    }
    if err := upgradeChainDatabase(chainDb); err != nil {
        return nil, err
    }
    if err := addMipmapBloomBins(chainDb); err != nil {
        return nil, err
    }

    dappDb, err := ctx.OpenDatabase("dapp", config.DatabaseCache, config.DatabaseHandles)
    if err != nil {
        return nil, err
    }
    if db, ok := dappDb.(*ethdb.LDBDatabase); ok {
        db.Meter("eth/db/dapp/")
    }
    glog.V(logger.Info).Infof("Protocol Versions: %v, Network Id: %v", ProtocolVersions, config.NetworkId)

    // Load up any custom genesis block if requested
    if len(config.Genesis) > 0 {
        block, err := core.WriteGenesisBlock(chainDb, strings.NewReader(config.Genesis))
        if err != nil {
            return nil, err
        }
        glog.V(logger.Info).Infof("Successfully wrote custom genesis block: %x", block.Hash())
    }

    // Load up a test setup if directly injected
    if config.TestGenesisState != nil {
        chainDb = config.TestGenesisState
    }
    if config.TestGenesisBlock != nil {
        core.WriteTd(chainDb, config.TestGenesisBlock.Hash(), config.TestGenesisBlock.Difficulty())
        core.WriteBlock(chainDb, config.TestGenesisBlock)
        core.WriteCanonicalHash(chainDb, config.TestGenesisBlock.Hash(), config.TestGenesisBlock.NumberU64())
        core.WriteHeadBlockHash(chainDb, config.TestGenesisBlock.Hash())
    }

    if !config.SkipBcVersionCheck {
        bcVersion := core.GetBlockChainVersion(chainDb)
        if bcVersion != config.BlockChainVersion && bcVersion != 0 {
            return nil, fmt.Errorf("Blockchain DB version mismatch (%d / %d). Run geth upgradedb.\n", bcVersion, config.BlockChainVersion)
        }
        core.WriteBlockChainVersion(chainDb, config.BlockChainVersion)
    }
    glog.V(logger.Info).Infof("Blockchain DB Version: %d", config.BlockChainVersion)

    eth := &Ethereum{
        shutdownChan:            make(chan bool),
        chainDb:                 chainDb,
        dappDb:                  dappDb,
        eventMux:                ctx.EventMux,
        accountManager:          config.AccountManager,
        etherbase:               config.Etherbase,
        netVersionId:            config.NetworkId,
        NatSpec:                 config.NatSpec,
        MinerThreads:            config.MinerThreads,
        SolcPath:                config.SolcPath,
        AutoDAG:                 config.AutoDAG,
        PowTest:                 config.PowTest,
        GpoMinGasPrice:          config.GpoMinGasPrice,
        GpoMaxGasPrice:          config.GpoMaxGasPrice,
        GpoFullBlockRatio:       config.GpoFullBlockRatio,
        GpobaseStepDown:         config.GpobaseStepDown,
        GpobaseStepUp:           config.GpobaseStepUp,
        GpobaseCorrectionFactor: config.GpobaseCorrectionFactor,
        httpclient:              httpclient.New(config.DocRoot),
    }
    switch {
    case config.PowTest:
        glog.V(logger.Info).Infof("ethash used in test mode")
        eth.pow, err = ethash.NewForTesting()
        if err != nil {
            return nil, err
        }
    case config.PowShared:
        glog.V(logger.Info).Infof("ethash used in shared mode")
        eth.pow = ethash.NewShared()

    default:
        eth.pow = ethash.New()
    }

    // load the genesis block or write a new one if no genesis
    // block is prenent in the database.
    genesis := core.GetBlock(chainDb, core.GetCanonicalHash(chainDb, 0))
    if genesis == nil {
        genesis, err = core.WriteDefaultGenesisBlock(chainDb)
        if err != nil {
            return nil, err
        }
        glog.V(logger.Info).Infoln("WARNING: Wrote default ethereum genesis block")
    }

    if config.ChainConfig == nil {
        return nil, errors.New("missing chain config")
    }
    eth.chainConfig = config.ChainConfig
    eth.chainConfig.VmConfig = vm.Config{
        EnableJit: config.EnableJit,
        ForceJit:  config.ForceJit,
    }

    eth.blockchain, err = core.NewBlockChain(chainDb, eth.chainConfig, eth.pow, eth.EventMux())
    if err != nil {
        if err == core.ErrNoGenesis {
            return nil, fmt.Errorf(`No chain found. Please initialise a new chain using the "init" subcommand.`)
        }
        return nil, err
    }
    eth.gpo = NewGasPriceOracle(eth)

    newPool := core.NewTxPool(eth.chainConfig, eth.EventMux(), eth.blockchain.State, eth.blockchain.GasLimit)
    eth.txPool = newPool

    if eth.protocolManager, err = NewProtocolManager(eth.chainConfig, config.FastSync, config.NetworkId, eth.eventMux, eth.txPool, eth.pow, eth.blockchain, chainDb); err != nil {
        return nil, err
    }
    eth.miner = miner.New(eth, eth.chainConfig, eth.EventMux(), eth.pow)
    eth.miner.SetGasPrice(config.GasPrice)
    eth.miner.SetExtra(config.ExtraData)

    return eth, nil
}

// APIs returns the collection of RPC services the ethereum package offers.
// NOTE, some of these services probably need to be moved to somewhere else.
func (s *Ethereum) APIs() []rpc.API {
    return []rpc.API{
        {
            Namespace: "eth",
            Version:   "1.0",
            Service:   NewPublicEthereumAPI(s),
            Public:    true,
        }, {
            Namespace: "eth",
            Version:   "1.0",
            Service:   NewPublicAccountAPI(s.accountManager),
            Public:    true,
        }, {
            Namespace: "personal",
            Version:   "1.0",
            Service:   NewPrivateAccountAPI(s.accountManager),
            Public:    false,
        }, {
            Namespace: "eth",
            Version:   "1.0",
            Service:   NewPublicBlockChainAPI(s.chainConfig, s.blockchain, s.miner, s.chainDb, s.gpo, s.eventMux, s.accountManager),
            Public:    true,
        }, {
            Namespace: "eth",
            Version:   "1.0",
            Service:   NewPublicTransactionPoolAPI(s),
            Public:    true,
        }, {
            Namespace: "eth",
            Version:   "1.0",
            Service:   NewPublicMinerAPI(s),
            Public:    true,
        }, {
            Namespace: "eth",
            Version:   "1.0",
            Service:   downloader.NewPublicDownloaderAPI(s.protocolManager.downloader, s.eventMux),
            Public:    true,
        }, {
            Namespace: "miner",
            Version:   "1.0",
            Service:   NewPrivateMinerAPI(s),
            Public:    false,
        }, {
            Namespace: "txpool",
            Version:   "1.0",
            Service:   NewPublicTxPoolAPI(s),
            Public:    true,
        }, {
            Namespace: "eth",
            Version:   "1.0",
            Service:   filters.NewPublicFilterAPI(s.chainDb, s.eventMux),
            Public:    true,
        }, {
            Namespace: "admin",
            Version:   "1.0",
            Service:   NewPrivateAdminAPI(s),
        }, {
            Namespace: "debug",
            Version:   "1.0",
            Service:   NewPublicDebugAPI(s),
            Public:    true,
        }, {
            Namespace: "debug",
            Version:   "1.0",
            Service:   NewPrivateDebugAPI(s.chainConfig, s),
        }, {
            Namespace: "net",
            Version:   "1.0",
            Service:   s.netRPCService,
            Public:    true,
        }, {
            Namespace: "admin",
            Version:   "1.0",
            Service:   ethreg.NewPrivateRegistarAPI(s.chainConfig, s.blockchain, s.chainDb, s.txPool, s.accountManager),
        },
    }
}

func (s *Ethereum) ResetWithGenesisBlock(gb *types.Block) {
    s.blockchain.ResetWithGenesisBlock(gb)
}

func (s *Ethereum) Etherbase() (eb common.Address, err error) {
    eb = s.etherbase
    if (eb == common.Address{}) {
        firstAccount, err := s.AccountManager().AccountByIndex(0)
        eb = firstAccount.Address
        if err != nil {
            return eb, fmt.Errorf("etherbase address must be explicitly specified")
        }
    }
    return eb, nil
}

// set in js console via admin interface or wrapper from cli flags
func (self *Ethereum) SetEtherbase(etherbase common.Address) {
    self.etherbase = etherbase
    self.miner.SetEtherbase(etherbase)
}

func (s *Ethereum) StopMining()         { s.miner.Stop() }
func (s *Ethereum) IsMining() bool      { return s.miner.Mining() }
func (s *Ethereum) Miner() *miner.Miner { return s.miner }

func (s *Ethereum) AccountManager() *accounts.Manager  { return s.accountManager }
func (s *Ethereum) BlockChain() *core.BlockChain       { return s.blockchain }
func (s *Ethereum) TxPool() *core.TxPool               { return s.txPool }
func (s *Ethereum) EventMux() *event.TypeMux           { return s.eventMux }
func (s *Ethereum) ChainDb() ethdb.Database            { return s.chainDb }
func (s *Ethereum) DappDb() ethdb.Database             { return s.dappDb }
func (s *Ethereum) IsListening() bool                  { return true } // Always listening
func (s *Ethereum) EthVersion() int                    { return int(s.protocolManager.SubProtocols[0].Version) }
func (s *Ethereum) NetVersion() int                    { return s.netVersionId }
func (s *Ethereum) Downloader() *downloader.Downloader { return s.protocolManager.downloader }

// Protocols implements node.Service, returning all the currently configured
// network protocols to start.
func (s *Ethereum) Protocols() []p2p.Protocol {
    return s.protocolManager.SubProtocols
}

// Start implements node.Service, starting all internal goroutines needed by the
// Ethereum protocol implementation.
func (s *Ethereum) Start(srvr *p2p.Server) error {
    if s.AutoDAG {
        s.StartAutoDAG()
    }
    s.protocolManager.Start()
    s.netRPCService = NewPublicNetAPI(srvr, s.NetVersion())
    return nil
}

// Stop implements node.Service, terminating all internal goroutines used by the
// Ethereum protocol.
func (s *Ethereum) Stop() error {
    s.blockchain.Stop()
    s.protocolManager.Stop()
    s.txPool.Stop()
    s.miner.Stop()
    s.eventMux.Stop()

    s.StopAutoDAG()

    s.chainDb.Close()
    s.dappDb.Close()
    close(s.shutdownChan)

    return nil
}

// This function will wait for a shutdown and resumes main thread execution
func (s *Ethereum) WaitForShutdown() {
    <-s.shutdownChan
}

// StartAutoDAG() spawns a go routine that checks the DAG every autoDAGcheckInterval
// by default that is 10 times per epoch
// in epoch n, if we past autoDAGepochHeight within-epoch blocks,
// it calls ethash.MakeDAG  to pregenerate the DAG for the next epoch n+1
// if it does not exist yet as well as remove the DAG for epoch n-1
// the loop quits if autodagquit channel is closed, it can safely restart and
// stop any number of times.
// For any more sophisticated pattern of DAG generation, use CLI subcommand
// makedag
func (self *Ethereum) StartAutoDAG() {
    if self.autodagquit != nil {
        return // already started
    }
    go func() {
        glog.V(logger.Info).Infof("Automatic pregeneration of ethash DAG ON (ethash dir: %s)", ethash.DefaultDir)
        var nextEpoch uint64
        timer := time.After(0)
        self.autodagquit = make(chan bool)
        for {
            select {
            case <-timer:
                glog.V(logger.Info).Infof("checking DAG (ethash dir: %s)", ethash.DefaultDir)
                currentBlock := self.BlockChain().CurrentBlock().NumberU64()
                thisEpoch := currentBlock / epochLength
                if nextEpoch <= thisEpoch {
                    if currentBlock%epochLength > autoDAGepochHeight {
                        if thisEpoch > 0 {
                            previousDag, previousDagFull := dagFiles(thisEpoch - 1)
                            os.Remove(filepath.Join(ethash.DefaultDir, previousDag))
                            os.Remove(filepath.Join(ethash.DefaultDir, previousDagFull))
                            glog.V(logger.Info).Infof("removed DAG for epoch %d (%s)", thisEpoch-1, previousDag)
                        }
                        nextEpoch = thisEpoch + 1
                        dag, _ := dagFiles(nextEpoch)
                        if _, err := os.Stat(dag); os.IsNotExist(err) {
                            glog.V(logger.Info).Infof("Pregenerating DAG for epoch %d (%s)", nextEpoch, dag)
                            err := ethash.MakeDAG(nextEpoch*epochLength, "") // "" -> ethash.DefaultDir
                            if err != nil {
                                glog.V(logger.Error).Infof("Error generating DAG for epoch %d (%s)", nextEpoch, dag)
                                return
                            }
                        } else {
                            glog.V(logger.Error).Infof("DAG for epoch %d (%s)", nextEpoch, dag)
                        }
                    }
                }
                timer = time.After(autoDAGcheckInterval)
            case <-self.autodagquit:
                return
            }
        }
    }()
}

// stopAutoDAG stops automatic DAG pregeneration by quitting the loop
func (self *Ethereum) StopAutoDAG() {
    if self.autodagquit != nil {
        close(self.autodagquit)
        self.autodagquit = nil
    }
    glog.V(logger.Info).Infof("Automatic pregeneration of ethash DAG OFF (ethash dir: %s)", ethash.DefaultDir)
}

// HTTPClient returns the light http client used for fetching offchain docs
// (natspec, source for verification)
func (self *Ethereum) HTTPClient() *httpclient.HTTPClient {
    return self.httpclient
}

func (self *Ethereum) Solc() (*compiler.Solidity, error) {
    var err error
    if self.solc == nil {
        self.solc, err = compiler.New(self.SolcPath)
    }
    return self.solc, err
}

// set in js console via admin interface or wrapper from cli flags
func (self *Ethereum) SetSolc(solcPath string) (*compiler.Solidity, error) {
    self.SolcPath = solcPath
    self.solc = nil
    return self.Solc()
}

// dagFiles(epoch) returns the two alternative DAG filenames (not a path)
// 1) <revision>-<hex(seedhash[8])> 2) full-R<revision>-<hex(seedhash[8])>
func dagFiles(epoch uint64) (string, string) {
    seedHash, _ := ethash.GetSeedHash(epoch * epochLength)
    dag := fmt.Sprintf("full-R%d-%x", ethashRevision, seedHash[:8])
    return dag, "full-R" + dag
}

// upgradeChainDatabase ensures that the chain database stores block split into
// separate header and body entries.
func upgradeChainDatabase(db ethdb.Database) error {
    // Short circuit if the head block is stored already as separate header and body
    data, err := db.Get([]byte("LastBlock"))
    if err != nil {
        return nil
    }
    head := common.BytesToHash(data)

    if block := core.GetBlockByHashOld(db, head); block == nil {
        return nil
    }
    // At least some of the database is still the old format, upgrade (skip the head block!)
    glog.V(logger.Info).Info("Old database detected, upgrading...")

    if db, ok := db.(*ethdb.LDBDatabase); ok {
        blockPrefix := []byte("block-hash-")
        for it := db.NewIterator(); it.Next(); {
            // Skip anything other than a combined block
            if !bytes.HasPrefix(it.Key(), blockPrefix) {
                continue
            }
            // Skip the head block (merge last to signal upgrade completion)
            if bytes.HasSuffix(it.Key(), head.Bytes()) {
                continue
            }
            // Load the block, split and serialize (order!)
            block := core.GetBlockByHashOld(db, common.BytesToHash(bytes.TrimPrefix(it.Key(), blockPrefix)))

            if err := core.WriteTd(db, block.Hash(), block.DeprecatedTd()); err != nil {
                return err
            }
            if err := core.WriteBody(db, block.Hash(), block.Body()); err != nil {
                return err
            }
            if err := core.WriteHeader(db, block.Header()); err != nil {
                return err
            }
            if err := db.Delete(it.Key()); err != nil {
                return err
            }
        }
        // Lastly, upgrade the head block, disabling the upgrade mechanism
        current := core.GetBlockByHashOld(db, head)

        if err := core.WriteTd(db, current.Hash(), current.DeprecatedTd()); err != nil {
            return err
        }
        if err := core.WriteBody(db, current.Hash(), current.Body()); err != nil {
            return err
        }
        if err := core.WriteHeader(db, current.Header()); err != nil {
            return err
        }
    }
    return nil
}

func addMipmapBloomBins(db ethdb.Database) (err error) {
    const mipmapVersion uint = 2

    // check if the version is set. We ignore data for now since there's
    // only one version so we can easily ignore it for now
    var data []byte
    data, _ = db.Get([]byte("setting-mipmap-version"))
    if len(data) > 0 {
        var version uint
        if err := rlp.DecodeBytes(data, &version); err == nil && version == mipmapVersion {
            return nil
        }
    }

    defer func() {
        if err == nil {
            var val []byte
            val, err = rlp.EncodeToBytes(mipmapVersion)
            if err == nil {
                err = db.Put([]byte("setting-mipmap-version"), val)
            }
            return
        }
    }()
    latestBlock := core.GetBlock(db, core.GetHeadBlockHash(db))
    if latestBlock == nil { // clean database
        return
    }

    tstart := time.Now()
    glog.V(logger.Info).Infoln("upgrading db log bloom bins")
    for i := uint64(0); i <= latestBlock.NumberU64(); i++ {
        hash := core.GetCanonicalHash(db, i)
        if (hash == common.Hash{}) {
            return fmt.Errorf("chain db corrupted. Could not find block %d.", i)
        }
        core.WriteMipmapBloom(db, i, core.GetBlockReceipts(db, hash))
    }
    glog.V(logger.Info).Infoln("upgrade completed in", time.Since(tstart))
    return nil
}