aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/storage/localstore.go
blob: fa98848ddcf9105be1d620e53b72a5e8d0d8595b (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
// 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 storage

import (
    "context"
    "path/filepath"
    "sync"

    "github.com/ethereum/go-ethereum/metrics"
    "github.com/ethereum/go-ethereum/swarm/log"
    "github.com/ethereum/go-ethereum/swarm/storage/mock"
)

type LocalStoreParams struct {
    *StoreParams
    ChunkDbPath string
    Validators  []ChunkValidator `toml:"-"`
}

func NewDefaultLocalStoreParams() *LocalStoreParams {
    return &LocalStoreParams{
        StoreParams: NewDefaultStoreParams(),
    }
}

//this can only finally be set after all config options (file, cmd line, env vars)
//have been evaluated
func (p *LocalStoreParams) Init(path string) {
    if p.ChunkDbPath == "" {
        p.ChunkDbPath = filepath.Join(path, "chunks")
    }
}

// LocalStore is a combination of inmemory db over a disk persisted db
// implements a Get/Put with fallback (caching) logic using any 2 ChunkStores
type LocalStore struct {
    Validators []ChunkValidator
    memStore   *MemStore
    DbStore    *LDBStore
    mu         sync.Mutex
}

// This constructor uses MemStore and DbStore as components
func NewLocalStore(params *LocalStoreParams, mockStore *mock.NodeStore) (*LocalStore, error) {
    ldbparams := NewLDBStoreParams(params.StoreParams, params.ChunkDbPath)
    dbStore, err := NewMockDbStore(ldbparams, mockStore)
    if err != nil {
        return nil, err
    }
    return &LocalStore{
        memStore:   NewMemStore(params.StoreParams, dbStore),
        DbStore:    dbStore,
        Validators: params.Validators,
    }, nil
}

func NewTestLocalStoreForAddr(params *LocalStoreParams) (*LocalStore, error) {
    ldbparams := NewLDBStoreParams(params.StoreParams, params.ChunkDbPath)
    dbStore, err := NewLDBStore(ldbparams)
    if err != nil {
        return nil, err
    }
    localStore := &LocalStore{
        memStore:   NewMemStore(params.StoreParams, dbStore),
        DbStore:    dbStore,
        Validators: params.Validators,
    }
    return localStore, nil
}

// isValid returns true if chunk passes any of the LocalStore Validators.
// isValid also returns true if LocalStore has no Validators.
func (ls *LocalStore) isValid(chunk Chunk) bool {
    // by default chunks are valid. if we have 0 validators, then all chunks are valid.
    valid := true

    // ls.Validators contains a list of one validator per chunk type.
    // if one validator succeeds, then the chunk is valid
    for _, v := range ls.Validators {
        if valid = v.Validate(chunk.Address(), chunk.Data()); valid {
            break
        }
    }
    return valid
}

// Put is responsible for doing validation and storage of the chunk
// by using configured ChunkValidators, MemStore and LDBStore.
// If the chunk is not valid, its GetErrored function will
// return ErrChunkInvalid.
// This method will check if the chunk is already in the MemStore
// and it will return it if it is. If there is an error from
// the MemStore.Get, it will be returned by calling GetErrored
// on the chunk.
// This method is responsible for closing Chunk.ReqC channel
// when the chunk is stored in memstore.
// After the LDBStore.Put, it is ensured that the MemStore
// contains the chunk with the same data, but nil ReqC channel.
func (ls *LocalStore) Put(ctx context.Context, chunk Chunk) error {
    if !ls.isValid(chunk) {
        return ErrChunkInvalid
    }

    log.Trace("localstore.put", "key", chunk.Address())
    ls.mu.Lock()
    defer ls.mu.Unlock()

    _, err := ls.memStore.Get(ctx, chunk.Address())
    if err == nil {
        return nil
    }
    if err != nil && err != ErrChunkNotFound {
        return err
    }
    ls.memStore.Put(ctx, chunk)
    err = ls.DbStore.Put(ctx, chunk)
    return err
}

// Get(chunk *Chunk) looks up a chunk in the local stores
// This method is blocking until the chunk is retrieved
// so additional timeout may be needed to wrap this call if
// ChunkStores are remote and can have long latency
func (ls *LocalStore) Get(ctx context.Context, addr Address) (chunk Chunk, err error) {
    ls.mu.Lock()
    defer ls.mu.Unlock()

    return ls.get(ctx, addr)
}

func (ls *LocalStore) get(ctx context.Context, addr Address) (chunk Chunk, err error) {
    chunk, err = ls.memStore.Get(ctx, addr)

    if err != nil && err != ErrChunkNotFound {
        metrics.GetOrRegisterCounter("localstore.get.error", nil).Inc(1)
        return nil, err
    }

    if err == nil {
        metrics.GetOrRegisterCounter("localstore.get.cachehit", nil).Inc(1)
        go ls.DbStore.MarkAccessed(addr)
        return chunk, nil
    }

    metrics.GetOrRegisterCounter("localstore.get.cachemiss", nil).Inc(1)
    chunk, err = ls.DbStore.Get(ctx, addr)
    if err != nil {
        metrics.GetOrRegisterCounter("localstore.get.error", nil).Inc(1)
        return nil, err
    }

    ls.memStore.Put(ctx, chunk)
    return chunk, nil
}

func (ls *LocalStore) FetchFunc(ctx context.Context, addr Address) func(context.Context) error {
    ls.mu.Lock()
    defer ls.mu.Unlock()

    _, err := ls.get(ctx, addr)
    if err == nil {
        return nil
    }
    return func(context.Context) error {
        return err
    }
}

func (ls *LocalStore) BinIndex(po uint8) uint64 {
    return ls.DbStore.BinIndex(po)
}

func (ls *LocalStore) Iterator(from uint64, to uint64, po uint8, f func(Address, uint64) bool) error {
    return ls.DbStore.SyncIterator(from, to, po, f)
}

// Close the local store
func (ls *LocalStore) Close() {
    ls.DbStore.Close()
}

// Migrate checks the datastore schema vs the runtime schema, and runs migrations if they don't match
func (ls *LocalStore) Migrate() error {
    actualDbSchema, err := ls.DbStore.GetSchema()
    if err != nil {
        log.Error(err.Error())
        return err
    }

    log.Debug("running migrations for", "schema", actualDbSchema, "runtime-schema", CurrentDbSchema)

    if actualDbSchema == CurrentDbSchema {
        return nil
    }

    if actualDbSchema == DbSchemaNone {
        ls.migrateFromNoneToPurity()
        actualDbSchema = DbSchemaPurity
    }

    if err := ls.DbStore.PutSchema(actualDbSchema); err != nil {
        return err
    }

    if actualDbSchema == DbSchemaPurity {
        if err := ls.migrateFromPurityToHalloween(); err != nil {
            return err
        }
        actualDbSchema = DbSchemaHalloween
    }

    if err := ls.DbStore.PutSchema(actualDbSchema); err != nil {
        return err
    }
    return nil
}

func (ls *LocalStore) migrateFromNoneToPurity() {
    // delete chunks that are not valid, i.e. chunks that do not pass
    // any of the ls.Validators
    ls.DbStore.Cleanup(func(c *chunk) bool {
        return !ls.isValid(c)
    })
}

func (ls *LocalStore) migrateFromPurityToHalloween() error {
    return ls.DbStore.CleanGCIndex()
}