336 lines
9.9 KiB
Nim
336 lines
9.9 KiB
Nim
# Nimbus
|
|
# Copyright (c) 2023-2024 Status Research & Development GmbH
|
|
# Licensed under either of
|
|
# * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
|
|
# http://www.apache.org/licenses/LICENSE-2.0)
|
|
# * MIT license ([LICENSE-MIT](LICENSE-MIT) or
|
|
# http://opensource.org/licenses/MIT)
|
|
# at your option. This file may not be copied, modified, or distributed except
|
|
# according to those terms.
|
|
|
|
{.push raises: [].}
|
|
|
|
import
|
|
std/tables,
|
|
eth/common,
|
|
results,
|
|
"../.."/[aristo, aristo/aristo_walk],
|
|
"../.."/[kvt, kvt/kvt_init/memory_only, kvt/kvt_walk],
|
|
".."/[base, base/base_desc],
|
|
./aristo_db/[common_desc, handlers_aristo, handlers_kvt, handlers_trace]
|
|
|
|
import
|
|
../../aristo/aristo_init/memory_only as aristo_memory_only
|
|
|
|
# Caveat:
|
|
# additional direct include(s) -- not import(s) -- is placed near
|
|
# the end of this source file
|
|
|
|
# Annotation helper(s)
|
|
{.pragma: noRaise, gcsafe, raises: [].}
|
|
{.pragma: rlpRaise, gcsafe, raises: [AristoApiRlpError].}
|
|
|
|
export
|
|
AristoApiRlpError,
|
|
AristoCoreDbKvtBE
|
|
|
|
type
|
|
AristoCoreDbRef* = ref object of CoreDbRef
|
|
## Main descriptor
|
|
kdbBase: KvtBaseRef ## Kvt subsystem
|
|
adbBase: AristoBaseRef ## Aristo subsystem
|
|
tracer: AristoTracerRef ## Currently active recorder
|
|
|
|
AristoTracerRef = ref object of TraceRecorderRef
|
|
## Sub-handle for tracer
|
|
parent: AristoCoreDbRef
|
|
|
|
AristoCoreDbBE = ref object of CoreDbBackendRef
|
|
|
|
proc newAristoVoidCoreDbRef*(): CoreDbRef {.noRaise.}
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Private tx and base methods
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc txMethods(
|
|
db: AristoCoreDbRef;
|
|
aTx: AristoTxRef;
|
|
kTx: KvtTxRef;
|
|
): CoreDbTxFns =
|
|
## To be constructed by some `CoreDbBaseFns` function
|
|
let
|
|
adbBase = db.adbBase
|
|
kdbBase = db.kdbBase
|
|
|
|
adbApi = adbBase.api
|
|
kdbApi = kdbBase.api
|
|
|
|
CoreDbTxFns(
|
|
levelFn: proc(): int =
|
|
aTx.level,
|
|
|
|
commitFn: proc(ignore: bool): CoreDbRc[void] =
|
|
const info = "commitFn()"
|
|
? adbApi.commit(aTx).toVoidRc(adbBase, info)
|
|
? kdbApi.commit(kTx).toVoidRc(kdbBase, info)
|
|
ok(),
|
|
|
|
rollbackFn: proc(): CoreDbRc[void] =
|
|
const info = "rollbackFn()"
|
|
? adbApi.rollback(aTx).toVoidRc(adbBase, info)
|
|
? kdbApi.rollback(kTx).toVoidRc(kdbBase, info)
|
|
ok(),
|
|
|
|
disposeFn: proc(): CoreDbRc[void] =
|
|
const info = "disposeFn()"
|
|
if adbApi.isTop(aTx): ? adbApi.rollback(aTx).toVoidRc(adbBase, info)
|
|
if kdbApi.isTop(kTx): ? kdbApi.rollback(kTx).toVoidRc(kdbBase, info)
|
|
ok(),
|
|
|
|
safeDisposeFn: proc(): CoreDbRc[void] =
|
|
const info = "safeDisposeFn()"
|
|
if adbApi.isTop(aTx): ? adbApi.rollback(aTx).toVoidRc(adbBase, info)
|
|
if kdbApi.isTop(kTx): ? kdbApi.rollback(kTx).toVoidRc(kdbBase, info)
|
|
ok())
|
|
|
|
proc cptMethods(
|
|
tracer: AristoTracerRef;
|
|
): CoreDbCaptFns =
|
|
let
|
|
tracer = tracer # So it can savely be captured
|
|
db = tracer.parent # Will not change and can be captured
|
|
log = tracer.topInst() # Ditto
|
|
|
|
CoreDbCaptFns(
|
|
recorderFn: proc(): CoreDbRef =
|
|
db,
|
|
|
|
logDbFn: proc(): TableRef[Blob,Blob] =
|
|
log.kLog,
|
|
|
|
getFlagsFn: proc(): set[CoreDbCaptFlags] =
|
|
log.flags,
|
|
|
|
forgetFn: proc() =
|
|
if tracer.pop():
|
|
tracer.restore())
|
|
|
|
|
|
proc baseMethods(
|
|
db: AristoCoreDbRef;
|
|
A: typedesc;
|
|
K: typedesc;
|
|
): CoreDbBaseFns =
|
|
|
|
proc tracerSetup(
|
|
db: AristoCoreDbRef;
|
|
flags: set[CoreDbCaptFlags];
|
|
): CoreDxCaptRef =
|
|
if db.tracer.isNil:
|
|
db.tracer = AristoTracerRef(parent: db)
|
|
db.tracer.init(db.kdbBase, db.adbBase, flags)
|
|
else:
|
|
db.tracer.push(flags)
|
|
CoreDxCaptRef(methods: db.tracer.cptMethods)
|
|
|
|
|
|
CoreDbBaseFns(
|
|
backendFn: proc(): CoreDbBackendRef =
|
|
db.bless(AristoCoreDbBE()),
|
|
|
|
destroyFn: proc(flush: bool) =
|
|
db.adbBase.destroy(flush)
|
|
db.kdbBase.destroy(flush),
|
|
|
|
levelFn: proc(): int =
|
|
db.adbBase.getLevel,
|
|
|
|
rootHashFn: proc(trie: CoreDbTrieRef): CoreDbRc[Hash256] =
|
|
db.adbBase.rootHash(trie, "rootHashFn()"),
|
|
|
|
triePrintFn: proc(vid: CoreDbTrieRef): string =
|
|
db.adbBase.triePrint(vid),
|
|
|
|
errorPrintFn: proc(e: CoreDbErrorRef): string =
|
|
e.errorPrint(),
|
|
|
|
legacySetupFn: proc() =
|
|
discard,
|
|
|
|
newKvtFn: proc(sharedTable: bool): CoreDbRc[CoreDxKvtRef] =
|
|
db.kdbBase.newKvtHandler(sharedTable, "newKvtFn()"),
|
|
|
|
newCtxFn: proc(): CoreDbCtxRef =
|
|
db.adbBase.ctx,
|
|
|
|
newCtxFromTxFn: proc(r: Hash256; k: CoreDbSubTrie): CoreDbRc[CoreDbCtxRef] =
|
|
CoreDbCtxRef.init(db.adbBase, r, k),
|
|
|
|
swapCtxFn: proc(ctx: CoreDbCtxRef): CoreDbCtxRef =
|
|
db.adbBase.swapCtx(ctx),
|
|
|
|
beginFn: proc(): CoreDbRc[CoreDxTxRef] =
|
|
const info = "beginFn()"
|
|
let
|
|
aTx = ? db.adbBase.txBegin(info)
|
|
kTx = ? db.kdbBase.txBegin(info)
|
|
ok(db.bless CoreDxTxRef(methods: db.txMethods(aTx, kTx))),
|
|
|
|
newCaptureFn: proc(flags: set[CoreDbCaptFlags]): CoreDbRc[CoreDxCaptRef] =
|
|
ok(db.bless db.tracerSetup(flags)))
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Private constructor helpers
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc create(
|
|
dbType: CoreDbType;
|
|
kdb: KvtDbRef;
|
|
K: typedesc;
|
|
adb: AristoDbRef;
|
|
A: typedesc;
|
|
): CoreDbRef =
|
|
## Constructor helper
|
|
|
|
# Local extensions
|
|
var db = AristoCoreDbRef()
|
|
db.adbBase = AristoBaseRef.init(db, adb)
|
|
db.kdbBase = KvtBaseRef.init(db, kdb)
|
|
|
|
# Base descriptor
|
|
db.dbType = dbType
|
|
db.methods = db.baseMethods(A,K)
|
|
db.bless
|
|
|
|
proc init(
|
|
dbType: CoreDbType;
|
|
K: typedesc;
|
|
A: typedesc;
|
|
qlr: QidLayoutRef;
|
|
): CoreDbRef =
|
|
dbType.create(KvtDbRef.init(K), K, AristoDbRef.init(A, qlr), A)
|
|
|
|
proc init(
|
|
dbType: CoreDbType;
|
|
K: typedesc;
|
|
A: typedesc;
|
|
): CoreDbRef =
|
|
dbType.create(KvtDbRef.init(K), K, AristoDbRef.init(A), A)
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public constructor helpers
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc init*(
|
|
dbType: CoreDbType;
|
|
K: typedesc;
|
|
A: typedesc;
|
|
path: string;
|
|
qlr: QidLayoutRef;
|
|
): CoreDbRef =
|
|
dbType.create(
|
|
KvtDbRef.init(K, path).expect "Kvt/RocksDB init() failed", K,
|
|
AristoDbRef.init(A, path, qlr).expect "Aristo/RocksDB init() failed", A)
|
|
|
|
proc init*(
|
|
dbType: CoreDbType;
|
|
K: typedesc;
|
|
A: typedesc;
|
|
path: string;
|
|
): CoreDbRef =
|
|
dbType.create(
|
|
KvtDbRef.init(K, path).expect "Kvt/RocksDB init() failed", K,
|
|
AristoDbRef.init(A, path).expect "Aristo/RocksDB init() failed", A)
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public constructor
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc newAristoMemoryCoreDbRef*(qlr: QidLayoutRef): CoreDbRef =
|
|
AristoDbMemory.init(kvt.MemBackendRef, aristo.MemBackendRef, qlr)
|
|
|
|
proc newAristoMemoryCoreDbRef*(): CoreDbRef =
|
|
AristoDbMemory.init(kvt.MemBackendRef, aristo.MemBackendRef)
|
|
|
|
proc newAristoVoidCoreDbRef*(): CoreDbRef =
|
|
AristoDbVoid.init(kvt.VoidBackendRef, aristo.VoidBackendRef)
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public helpers, e.g. for direct backend access
|
|
# ------------------------------------------------------------------------------
|
|
|
|
func toAristoProfData*(
|
|
db: CoreDbRef;
|
|
): tuple[aristo: AristoDbProfListRef, kvt: KvtDbProfListRef] =
|
|
when CoreDbEnableApiProfiling:
|
|
if db.isAristo:
|
|
result.aristo = db.AristoCoreDbRef.adbBase.api.AristoApiProfRef.data
|
|
result.kvt = db.AristoCoreDbRef.kdbBase.api.KvtApiProfRef.data
|
|
|
|
func toAristoApi*(dsc: CoreDxKvtRef): KvtApiRef =
|
|
if dsc.parent.isAristo:
|
|
return AristoCoreDbRef(dsc.parent).kdbBase.api
|
|
|
|
func toAristoApi*(dsc: CoreDxMptRef): AristoApiRef =
|
|
if dsc.parent.isAristo:
|
|
return AristoCoreDbRef(dsc.parent).adbBase.api
|
|
|
|
func toAristo*(be: CoreDbKvtBackendRef): KvtDbRef =
|
|
if be.parent.isAristo:
|
|
return be.AristoCoreDbKvtBE.kdb
|
|
|
|
func toAristo*(be: CoreDbMptBackendRef): AristoDbRef =
|
|
if be.parent.isAristo:
|
|
return be.AristoCoreDbMptBE.adb
|
|
|
|
func toAristo*(be: CoreDbAccBackendRef): AristoDbRef =
|
|
if be.parent.isAristo:
|
|
return be.AristoCoreDbAccBE.adb
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public aristo iterators
|
|
# ------------------------------------------------------------------------------
|
|
|
|
include
|
|
./aristo_db/aristo_replicate
|
|
|
|
# ------------------------
|
|
|
|
iterator aristoKvtPairsVoid*(dsc: CoreDxKvtRef): (Blob,Blob) {.rlpRaise.} =
|
|
let
|
|
api = dsc.toAristoApi()
|
|
p = api.forkTop(dsc.to(KvtDbRef)).valueOrApiError "aristoKvtPairs()"
|
|
defer: discard api.forget(p)
|
|
for (k,v) in kvt.VoidBackendRef.walkPairs p:
|
|
yield (k,v)
|
|
|
|
iterator aristoKvtPairsMem*(dsc: CoreDxKvtRef): (Blob,Blob) {.rlpRaise.} =
|
|
let
|
|
api = dsc.toAristoApi()
|
|
p = api.forkTop(dsc.to(KvtDbRef)).valueOrApiError "aristoKvtPairs()"
|
|
defer: discard api.forget(p)
|
|
for (k,v) in kvt.MemBackendRef.walkPairs p:
|
|
yield (k,v)
|
|
|
|
iterator aristoMptPairs*(dsc: CoreDxMptRef): (Blob,Blob) {.noRaise.} =
|
|
let
|
|
api = dsc.toAristoApi()
|
|
mpt = dsc.to(AristoDbRef)
|
|
for (k,v) in mpt.rightPairs LeafTie(root: dsc.rootID):
|
|
yield (api.pathAsBlob(k.path), api.serialise(mpt, v).valueOr(EmptyBlob))
|
|
|
|
iterator aristoReplicateMem*(dsc: CoreDxMptRef): (Blob,Blob) {.rlpRaise.} =
|
|
## Instantiation for `MemBackendRef`
|
|
for k,v in aristoReplicate[aristo.MemBackendRef](dsc):
|
|
yield (k,v)
|
|
|
|
iterator aristoReplicateVoid*(dsc: CoreDxMptRef): (Blob,Blob) {.rlpRaise.} =
|
|
## Instantiation for `VoidBackendRef`
|
|
for k,v in aristoReplicate[aristo.VoidBackendRef](dsc):
|
|
yield (k,v)
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# End
|
|
# ------------------------------------------------------------------------------
|