125 lines
4.4 KiB
Nim
125 lines
4.4 KiB
Nim
# nimbus-eth1
|
|
# 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.
|
|
|
|
## Rocks DB internal driver descriptor
|
|
## ===================================
|
|
|
|
{.push raises: [].}
|
|
|
|
import
|
|
std/os,
|
|
std/concurrency/atomics,
|
|
eth/common,
|
|
rocksdb,
|
|
stew/endians2,
|
|
../../aristo_desc,
|
|
../init_common,
|
|
minilru
|
|
|
|
export minilru
|
|
|
|
type
|
|
RdbWriteEventCb* =
|
|
proc(session: WriteBatchRef): bool {.gcsafe, raises: [].}
|
|
## Call back closure function that passes the the write session handle
|
|
## to a guest peer right after it was opened. The guest may store any
|
|
## data on its own column family and return `true` if that worked
|
|
## all right. Then the `Aristo` handler will stor its own columns and
|
|
## finalise the write session.
|
|
##
|
|
## In case of an error when `false` is returned, `Aristo` will abort the
|
|
## write session and return a session error.
|
|
|
|
RdbInst* = object
|
|
admCol*: ColFamilyReadWrite ## Admin column family handler
|
|
vtxCol*: ColFamilyReadWrite ## Vertex column family handler
|
|
keyCol*: ColFamilyReadWrite ## Hash key column family handler
|
|
session*: WriteBatchRef ## For batched `put()`
|
|
|
|
# Note that the key type `VertexID` for LRU caches requires that there is
|
|
# strictly no vertex ID re-use.
|
|
#
|
|
# Otherwise, in some fringe cases one might remove a vertex with key
|
|
# `(root1,vid)` and insert another vertex with key `(root2,vid)` while
|
|
# re-using the vertex ID `vid`. Without knowledge of `root1` and `root2`,
|
|
# the LRU cache will return the same vertex for `(root2,vid)` also for
|
|
# `(root1,vid)`.
|
|
#
|
|
# The other alternaive would be to use the key type `RootedVertexID` which
|
|
# is less memory and time efficient (the latter one due to internal LRU
|
|
# handling of the longer key.)
|
|
#
|
|
rdKeyLru*: LruCache[VertexID,HashKey] ## Read cache
|
|
rdKeySize*: int
|
|
rdVtxLru*: LruCache[VertexID,VertexRef] ## Read cache
|
|
rdVtxSize*: int
|
|
|
|
basePath*: string ## Database directory
|
|
trgWriteEvent*: RdbWriteEventCb ## Database piggiback call back handler
|
|
|
|
AristoCFs* = enum
|
|
## Column family symbols/handles and names used on the database
|
|
AdmCF = "AriAdm" ## Admin column family name
|
|
VtxCF = "AriVtx" ## Vertex column family name
|
|
KeyCF = "AriKey" ## Hash key column family name
|
|
|
|
RdbLruCounter* = array[bool, Atomic[uint64]]
|
|
|
|
RdbStateType* = enum
|
|
Account
|
|
World
|
|
|
|
const
|
|
BaseFolder* = "nimbus" ## Same as for Legacy DB
|
|
DataFolder* = "aristo" ## Legacy DB has "data"
|
|
|
|
var
|
|
# Hit/miss counters for LRU cache - global so as to integrate easily with
|
|
# nim-metrics and `uint64` to ensure that increasing them is fast - collection
|
|
# happens from a separate thread.
|
|
# TODO maybe turn this into more general framework for LRU reporting since
|
|
# we have lots of caches of this sort
|
|
rdbVtxLruStats*: array[RdbStateType, array[VertexType, RdbLruCounter]]
|
|
rdbKeyLruStats*: array[RdbStateType, RdbLruCounter]
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public functions
|
|
# ------------------------------------------------------------------------------
|
|
|
|
template logTxt*(info: static[string]): static[string] =
|
|
"RocksDB/" & info
|
|
|
|
template baseDb*(rdb: RdbInst): RocksDbReadWriteRef =
|
|
rdb.admCol.db
|
|
|
|
|
|
func baseDir*(rdb: RdbInst): string =
|
|
rdb.basePath / BaseFolder
|
|
|
|
func dataDir*(rdb: RdbInst): string =
|
|
rdb.baseDir / DataFolder
|
|
|
|
|
|
template toOpenArray*(xid: AdminTabID): openArray[byte] =
|
|
xid.uint64.toBytesBE.toOpenArray(0,7)
|
|
|
|
template to*(v: RootedVertexID, T: type RdbStateType): RdbStateType =
|
|
if v.root == VertexID(1): RdbStateType.World else: RdbStateType.Account
|
|
|
|
template inc*(v: var RdbLruCounter, hit: bool) =
|
|
discard v[hit].fetchAdd(1, moRelaxed)
|
|
|
|
template get*(v: RdbLruCounter, hit: bool): uint64 =
|
|
v[hit].load(moRelaxed)
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# End
|
|
# ------------------------------------------------------------------------------
|