-
Notifications
You must be signed in to change notification settings - Fork 115
/
core_db.nim
162 lines (143 loc) · 4.42 KB
/
core_db.nim
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
# Nimbus
# Copyright (c) 2018 Status Research & Development GmbH
# Licensed under either of
# * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
# https://www.apache.org/licenses/LICENSE-2.0)
# * MIT license ([LICENSE-MIT](LICENSE-MIT) or
# https://opensource.org/licenses/MIT)
# at your option. This file may not be copied, modified, or distributed except
# according to those terms.
## Core database replacement wrapper object
## ========================================
##
## See `core_db/README.md`
##
{.push raises: [].}
import
chronicles,
eth/[common, trie/db],
./core_db/[base, core_apps, legacy]
export
common,
core_apps,
# Not all symbols from the object sources will be exported by default
CoreDbCaptFlags,
CoreDbCaptRef,
CoreDbKvtRef,
CoreDbMptRef,
CoreDbPhkRef,
CoreDbRef,
CoreDbTxID,
CoreDbTxRef,
CoreDbType,
LegacyCoreDbRef, # for shortTimeReadOnly()
beginTransaction,
commit,
compensateLegacySetup,
contains,
dbType,
del,
dispose,
get,
getTransactionID,
isPruning,
kvt,
maybeGet,
mpt,
mptPrune,
newCoreDbCaptRef,
parent,
phk,
phkPrune,
put,
recorder,
rollback,
rootHash,
safeDispose,
setTransactionID
logScope:
topics = "core_db"
# ------------------------------------------------------------------------------
# Private functions: helpers
# ------------------------------------------------------------------------------
template logTxt(info: static[string]): static[string] =
"ChainDB " & info
proc itNotImplemented(db: CoreDbRef|CoreDbKvtRef, name: string) {.used.} =
debug logTxt "iterator not implemented", dbType=db.dbType, meth=name
proc tmplNotImplemented*(db: CoreDbRef, name: string) {.used.} =
debug logTxt "template not implemented", dbType=db.dbType, meth=name
# ------------------------------------------------------------------------------
# Public constructor
# ------------------------------------------------------------------------------
proc newCoreDbRef*(
db: TrieDatabaseRef;
): CoreDbRef
{.gcsafe, deprecated: "use newCoreDbRef(LegacyDbPersistent,<path>)".} =
## Legacy constructor.
##
## Note: Using legacy notation `newCoreDbRef()` rather than
## `CoreDbRef.init()` because of compiler coughing.
db.newLegacyCoreDbRef()
proc newCoreDbRef*(
dbType: static[CoreDbType];
): CoreDbRef =
## Constructor for volatile/memory type DB
##
## Note: Using legacy notation `newCoreDbRef()` rather than
## `CoreDbRef.init()` because of compiler coughing.
when dbType == LegacyDbMemory:
newLegacyMemoryCoreDbRef()
else:
{.error: "Unsupported dbType for CoreDbRef.init()".}
proc newCoreDbRef*(
dbType: static[CoreDbType];
path: string;
): CoreDbRef =
## General constructor (the `path` argument is ignored for volatile/memory
## type DB)
##
## Note: Using legacy notation `newCoreDbRef()` rather than
## `CoreDbRef.init()` because of compiler coughing.
when dbType == LegacyDbMemory:
newLegacyMemoryCoreDbRef()
elif dbType == LegacyDbPersistent:
newLegacyPersistentCoreDbRef path
else:
{.error: "Unsupported dbType for CoreDbRef.init()".}
# ------------------------------------------------------------------------------
# Public template wrappers
# ------------------------------------------------------------------------------
template shortTimeReadOnly*(db: CoreDbRef; id: CoreDbTxID; body: untyped) =
proc action() {.gcsafe, raises: [CatchableError].} =
body
case db.dbType:
of LegacyDbMemory, LegacyDbPersistent:
db.LegacyCoreDbRef.shortTimeReadOnly(id, action)
else:
db.tmplNotImplemented "shortTimeReadOnly"
# ------------------------------------------------------------------------------
# Public iterators
# ------------------------------------------------------------------------------
iterator pairs*(
db: CoreDbKvtRef;
): (Blob, Blob)
{.gcsafe.} =
case db.dbType:
of LegacyDbMemory:
for k,v in db.LegacyCoreDbKvtRef:
yield (k,v)
else:
db.itNotImplemented "pairs/kvt"
iterator pairs*(
db: CoreDbMptRef;
): (Blob, Blob)
{.gcsafe, raises: [RlpError].} =
case db.parent.dbType:
of LegacyDbMemory, LegacyDbPersistent:
for k,v in db.LegacyCoreDbMptRef:
yield (k,v)
else:
db.parent.itNotImplemented "pairs/mpt"
# ------------------------------------------------------------------------------
# End
# ------------------------------------------------------------------------------