mirror of
https://github.com/status-im/nimbus-eth1.git
synced 2025-01-10 12:26:02 +00:00
465d694834
* Rename FilterID => QueueID why: The current usage does not identify a particular filter but uses it as storage tag to manage it on the database (to be organised in a set of FIFOs or queues.) * Split `aristo_filter` source into sub-files why: Make space for filter management API * Store filter queue IDs in pairs on the backend why: Any pair will will describe a FIFO accessed by bottom/top IDs * Reorg some source file names why: The "aristo_" prefix for make local/private files is tedious to use, so removed. * Implement filter slot scheduler details: Filters will be stored on the database on cascaded FIFOs. When a FIFO queue is full, some filter items are bundled together and stored on the next FIFO.
88 lines
3.0 KiB
Nim
88 lines
3.0 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.
|
|
{.push raises: [].}
|
|
|
|
import
|
|
../aristo_desc,
|
|
../aristo_desc/desc_backend
|
|
|
|
const
|
|
verifyIxId = true # and false
|
|
## Enforce session tracking
|
|
|
|
type
|
|
BackendType* = enum
|
|
BackendVoid ## For providing backend-less constructor
|
|
BackendMemory
|
|
BackendRocksDB
|
|
|
|
StorageType* = enum
|
|
## Storage types, key prefix
|
|
Oops = 0
|
|
AdmPfx = 1 ## Admin data, e.g. ID generator
|
|
VtxPfx = 2 ## Vertex data
|
|
KeyPfx = 3 ## Key/hash data
|
|
FilPfx = 4 ## Filter logs (to revert to earlier state)
|
|
|
|
AdminTabID* = distinct uint64
|
|
## Access keys for admin table records. When exposed (e.g. when itereating
|
|
## over the tables), this data type is to be used.
|
|
|
|
TypedBackendRef* = ref object of BackendRef
|
|
kind*: BackendType ## Backend type identifier
|
|
when verifyIxId:
|
|
txGen: uint ## Transaction ID generator (for debugging)
|
|
txId: uint ## Active transaction ID (for debugging)
|
|
|
|
TypedPutHdlErrRef* = ref object of RootRef
|
|
case pfx*: StorageType ## Error sub-table
|
|
of VtxPfx, KeyPfx:
|
|
vid*: VertexID ## Vertex ID where the error occured
|
|
of FilPfx:
|
|
qid*: QueueID ## Ditto
|
|
of AdmPfx, Oops:
|
|
discard
|
|
code*: AristoError ## Error code (if any)
|
|
|
|
TypedPutHdlRef* = ref object of PutHdlRef
|
|
error*: TypedPutHdlErrRef ## Track error while collecting transaction
|
|
when verifyIxId:
|
|
txId: uint ## Transaction ID (for debugging)
|
|
|
|
const
|
|
AdmTabIdIdg* = AdminTabID(0) ## Access key for vertex ID generator state
|
|
AdmTabIdFqs* = AdminTabID(1) ## Access key for filter queue states
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Public helpers
|
|
# ------------------------------------------------------------------------------
|
|
|
|
proc beginSession*(hdl: TypedPutHdlRef; db: TypedBackendRef) =
|
|
when verifyIxId:
|
|
doAssert db.txId == 0
|
|
if db.txGen == 0:
|
|
db.txGen = 1
|
|
db.txId = db.txGen
|
|
hdl.txId = db.txGen
|
|
db.txGen.inc
|
|
|
|
proc verifySession*(hdl: TypedPutHdlRef; db: TypedBackendRef) =
|
|
when verifyIxId:
|
|
doAssert db.txId == hdl.txId
|
|
|
|
proc finishSession*(hdl: TypedPutHdlRef; db: TypedBackendRef) =
|
|
when verifyIxId:
|
|
doAssert db.txId == hdl.txId
|
|
db.txId = 0
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# End
|
|
# ------------------------------------------------------------------------------
|