mirror of
https://github.com/status-im/nimbus-eth1.git
synced 2025-01-19 16:48:50 +00:00
3936d4d0ad
* Set scheduler state as part of the backend descriptor details: Moved type definitions `QidLayoutRef` and `QidSchedRef` to `desc_structural.nim` so that it shares the same folder as `desc_backend.nim` * Automatic filter queue table initialisation in backend details: Scheduler can be tweaked or completely disabled * Updated backend unit tests details: + some code clean up/beautification, reads better now + disabled persistent filters so that there is no automated filter management which will be implemented next * Prettify/update unit tests source code details: Mostly replacing the `check()` paradigm by `xCheck()` * Somewhat simplified backend type management why: Backend objects are labelled with a `BackendType` symbol where the `BackendVoid` label is implicitly assumed for a `nil` backend object reference. To make it easier, a `kind()` function is used now applicable to `nil` references as well. * Fix DB storage layout for filter objects why: Need to store the filter ID with the object * Implement reverse [] index on fifo why: An integer index argument on `[]` retrieves the QueueID (label) of the fifo item while a QueueID argument on `[]` retrieves the index (so it is inverse to the former variant). * Provide iterator over filters as fifo why: This iterator goes along the cascased fifo structure (i.e. in historical order)
82 lines
2.7 KiB
Nim
82 lines
2.7 KiB
Nim
# nimbus-eth1
|
|
# Copyright (c) 2021 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.
|
|
|
|
## Persistent constructor for Aristo DB
|
|
## ====================================
|
|
##
|
|
## This module automatically pulls in the persistent backend library at the
|
|
## linking stage (e.g. `rocksdb`) which can be avoided for pure memory DB
|
|
## applications by importing `./aristo_init/memory_only` (rather than
|
|
## `./aristo_init/persistent`.)
|
|
##
|
|
{.push raises: [].}
|
|
|
|
import
|
|
results,
|
|
../aristo_desc,
|
|
"."/[init_common, rocks_db, memory_only]
|
|
export
|
|
RdbBackendRef,
|
|
memory_only
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public database constuctors, destructor
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc newAristoDbRef*(
|
|
backend: static[BackendType];
|
|
basePath: string;
|
|
qidLayout = DefaultQidLayoutRef;
|
|
): Result[AristoDbRef, AristoError] =
|
|
## Generic constructor, `basePath` argument is ignored for `BackendNone` and
|
|
## `BackendMemory` type backend database. Also, both of these backends
|
|
## aways succeed initialising.
|
|
##
|
|
## If the `qidLayout` argument is set `QidLayoutRef(nil)`, the a backend
|
|
## database will not provide filter history management. Providing a different
|
|
## scheduler layout shoud be used with care as table access with different
|
|
## layouts might render the filter history data unmanageable.
|
|
##
|
|
when backend == BackendRocksDB:
|
|
let be = block:
|
|
let rc = rocksDbBackend(basePath, qidLayout)
|
|
if rc.isErr:
|
|
return err(rc.error)
|
|
rc.value
|
|
let vGen = block:
|
|
let rc = be.getIdgFn()
|
|
if rc.isErr:
|
|
be.closeFn(flush = false)
|
|
return err(rc.error)
|
|
rc.value
|
|
ok AristoDbRef(top: LayerRef(vGen: vGen), backend: be)
|
|
|
|
elif backend == BackendVoid:
|
|
{.error: "Use BackendNone.init() without path argument".}
|
|
|
|
elif backend == BackendMemory:
|
|
{.error: "Use BackendMemory.init() without path argument".}
|
|
|
|
else:
|
|
{.error: "Unknown/unsupported Aristo DB backend".}
|
|
|
|
# -----------------
|
|
|
|
proc to*[W: RdbBackendRef](
|
|
db: AristoDbRef;
|
|
T: type W;
|
|
): T =
|
|
## Handy helper for lew-level access to some backend functionality
|
|
db.backend.T
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# End
|
|
# ------------------------------------------------------------------------------
|