2023-09-12 19:44:45 +01:00
|
|
|
# nimbus-eth1
|
2024-03-14 22:17:43 +00:00
|
|
|
# Copyright (c) 2023-2024 Status Research & Development GmbH
|
2023-09-12 19:44:45 +01:00
|
|
|
# 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.
|
|
|
|
|
|
|
|
|
|
## Kvt DB -- key-value table
|
|
|
|
|
## =========================
|
|
|
|
|
##
|
|
|
|
|
{.push raises: [].}
|
|
|
|
|
|
|
|
|
|
import
|
2024-12-18 11:56:46 +01:00
|
|
|
std/[hashes, tables],
|
2023-09-12 19:44:45 +01:00
|
|
|
./kvt_constants,
|
|
|
|
|
./kvt_desc/[desc_error, desc_structural]
|
|
|
|
|
|
|
|
|
|
from ./kvt_desc/desc_backend
|
|
|
|
|
import BackendRef
|
|
|
|
|
|
|
|
|
|
# Not auto-exporting backend
|
|
|
|
|
export
|
2024-12-18 11:56:46 +01:00
|
|
|
tables, kvt_constants, desc_error, desc_structural
|
2023-09-12 19:44:45 +01:00
|
|
|
|
|
|
|
|
type
|
|
|
|
|
KvtTxRef* = ref object
|
|
|
|
|
## Transaction descriptor
|
|
|
|
|
db*: KvtDbRef ## Database descriptor
|
|
|
|
|
parent*: KvtTxRef ## Previous transaction
|
|
|
|
|
txUid*: uint ## Unique ID among transactions
|
|
|
|
|
level*: int ## Stack index for this transaction
|
|
|
|
|
|
2024-06-13 18:15:11 +00:00
|
|
|
KvtDbRef* = ref object of RootRef
|
2023-09-12 19:44:45 +01:00
|
|
|
## Three tier database object supporting distributed instances.
|
|
|
|
|
top*: LayerRef ## Database working layer, mutable
|
|
|
|
|
stack*: seq[LayerRef] ## Stashed immutable parent layers
|
2024-07-18 21:32:32 +00:00
|
|
|
balancer*: LayerRef ## Balance out concurrent backend access
|
2023-09-12 19:44:45 +01:00
|
|
|
backend*: BackendRef ## Backend database (may well be `nil`)
|
|
|
|
|
|
|
|
|
|
txRef*: KvtTxRef ## Latest active transaction
|
|
|
|
|
txUidGen*: uint ## Tx-relative unique number generator
|
|
|
|
|
|
Core db and aristo updates for destructor and tx logic (#1894)
* Disable `TransactionID` related functions from `state_db.nim`
why:
Functions `getCommittedStorage()` and `updateOriginalRoot()` from
the `state_db` module are nowhere used. The emulation of a legacy
`TransactionID` type functionality is administratively expensive to
provide by `Aristo` (the legacy DB version is only partially
implemented, anyway).
As there is no other place where `TransactionID`s are used, they will
not be provided by the `Aristo` variant of the `CoreDb`. For the
legacy DB API, nothing will change.
* Fix copyright headers in source code
* Get rid of compiler warning
* Update Aristo code, remove unused `merge()` variant, export `hashify()`
why:
Adapt to upcoming `CoreDb` wrapper
* Remove synced tx feature from `Aristo`
why:
+ This feature allowed to synchronise transaction methods like begin,
commit, and rollback for a group of descriptors.
+ The feature is over engineered and not needed for `CoreDb`, neither
is it complete (some convergence features missing.)
* Add debugging helpers to `Kvt`
also:
Update database iterator, add count variable yield argument similar
to `Aristo`.
* Provide optional destructors for `CoreDb` API
why;
For the upcoming Aristo wrapper, this allows to control when certain
smart destruction and update can take place. The auto destructor works
fine in general when the storage/cache strategy is known and acceptable
when creating descriptors.
* Add update option for `CoreDb` API function `hash()`
why;
The hash function is typically used to get the state root of the MPT.
Due to lazy hashing, this might be not available on the `Aristo` DB.
So the `update` function asks for re-hashing the gurrent state changes
if needed.
* Update API tracking log mode: `info` => `debug
* Use shared `Kvt` descriptor in new Ledger API
why:
No need to create a new descriptor all the time
2023-11-16 19:35:03 +00:00
|
|
|
# Debugging data below, might go away in future
|
|
|
|
|
xIdGen*: uint64
|
2024-10-01 21:03:10 +00:00
|
|
|
xMap*: Table[seq[byte],uint64] ## For pretty printing
|
|
|
|
|
pAmx*: Table[uint64,seq[byte]] ## For pretty printing
|
Core db and aristo updates for destructor and tx logic (#1894)
* Disable `TransactionID` related functions from `state_db.nim`
why:
Functions `getCommittedStorage()` and `updateOriginalRoot()` from
the `state_db` module are nowhere used. The emulation of a legacy
`TransactionID` type functionality is administratively expensive to
provide by `Aristo` (the legacy DB version is only partially
implemented, anyway).
As there is no other place where `TransactionID`s are used, they will
not be provided by the `Aristo` variant of the `CoreDb`. For the
legacy DB API, nothing will change.
* Fix copyright headers in source code
* Get rid of compiler warning
* Update Aristo code, remove unused `merge()` variant, export `hashify()`
why:
Adapt to upcoming `CoreDb` wrapper
* Remove synced tx feature from `Aristo`
why:
+ This feature allowed to synchronise transaction methods like begin,
commit, and rollback for a group of descriptors.
+ The feature is over engineered and not needed for `CoreDb`, neither
is it complete (some convergence features missing.)
* Add debugging helpers to `Kvt`
also:
Update database iterator, add count variable yield argument similar
to `Aristo`.
* Provide optional destructors for `CoreDb` API
why;
For the upcoming Aristo wrapper, this allows to control when certain
smart destruction and update can take place. The auto destructor works
fine in general when the storage/cache strategy is known and acceptable
when creating descriptors.
* Add update option for `CoreDb` API function `hash()`
why;
The hash function is typically used to get the state root of the MPT.
Due to lazy hashing, this might be not available on the `Aristo` DB.
So the `update` function asks for re-hashing the gurrent state changes
if needed.
* Update API tracking log mode: `info` => `debug
* Use shared `Kvt` descriptor in new Ledger API
why:
No need to create a new descriptor all the time
2023-11-16 19:35:03 +00:00
|
|
|
|
2023-09-26 10:21:13 +01:00
|
|
|
KvtDbAction* = proc(db: KvtDbRef) {.gcsafe, raises: [].}
|
2023-09-12 19:44:45 +01:00
|
|
|
## Generic call back function/closure.
|
|
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
|
# Public helpers
|
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
|
|
2024-10-01 21:03:10 +00:00
|
|
|
func getOrVoid*(tab: Table[seq[byte],seq[byte]]; w: seq[byte]): seq[byte] =
|
2023-09-12 19:44:45 +01:00
|
|
|
tab.getOrDefault(w, EmptyBlob)
|
|
|
|
|
|
2024-10-01 21:03:10 +00:00
|
|
|
func isValid*(key: seq[byte]): bool =
|
2023-09-12 19:44:45 +01:00
|
|
|
key != EmptyBlob
|
|
|
|
|
|
2024-07-18 21:32:32 +00:00
|
|
|
func isValid*(layer: LayerRef): bool =
|
|
|
|
|
layer != LayerRef(nil)
|
|
|
|
|
|
2023-09-18 21:20:28 +01:00
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
|
# Public functions, miscellaneous
|
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
# Hash set helper
|
|
|
|
|
func hash*(db: KvtDbRef): Hash =
|
|
|
|
|
## Table/KeyedQueue/HashSet mixin
|
|
|
|
|
cast[pointer](db).hash
|
|
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
|
# Public functions, `dude` related
|
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
|
|
2024-05-23 17:37:51 +02:00
|
|
|
iterator rstack*(db: KvtDbRef): LayerRef =
|
|
|
|
|
# Stack in reverse order
|
|
|
|
|
for i in 0..<db.stack.len:
|
|
|
|
|
yield db.stack[db.stack.len - i - 1]
|
|
|
|
|
|
2023-09-12 19:44:45 +01:00
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
|
# End
|
|
|
|
|
# ------------------------------------------------------------------------------
|
