Jacek Sieka 7b88bb3b30
Add branch cache (#2923)
Now that branches are small, we can add a branch cache that fits more
verticies in memory by only storing the branch portion (16 bytes) of the
VertexRef (136 bytes).

Where the original vertex cache hovers around a hit rate of ~60:ish,
this branch cache reaches >90% hit rate instead around block 20M which
gives a nice boost to processing.

A downside of this approach is that a new VertexRef must be allocated
for every cache hit instead of reusing an existing instance - this
causes some GC overhead that needs to be addressed.

Nice 15% improvement nonetheless, can't complain!

```
blocks: 19630784, baseline: 161h18m38s, contender: 136h23m23s
Time (total): -24h55m14s, -15.45%
```
2024-12-11 11:53:26 +01:00

144 lines
4.6 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 store data record
## ==========================
{.push raises: [].}
import
eth/common,
rocksdb,
results,
../../[aristo_blobify, aristo_desc],
../init_common,
./rdb_desc
const
extraTraceMessages = false
## Enable additional logging noise
when extraTraceMessages:
import chronicles
logScope:
topics = "aristo-rocksdb"
# ------------------------------------------------------------------------------
# Private helpers
# ------------------------------------------------------------------------------
proc disposeSession(rdb: var RdbInst) =
rdb.session.close()
rdb.session = WriteBatchRef(nil)
# ------------------------------------------------------------------------------
# Public functions
# ------------------------------------------------------------------------------
proc begin*(rdb: var RdbInst) =
if rdb.session.isNil:
rdb.session = rdb.baseDb.openWriteBatch()
proc rollback*(rdb: var RdbInst) =
if not rdb.session.isClosed():
rdb.rdKeyLru = typeof(rdb.rdKeyLru).init(rdb.rdKeySize)
rdb.rdVtxLru = typeof(rdb.rdVtxLru).init(rdb.rdVtxSize)
rdb.rdBranchLru = typeof(rdb.rdBranchLru).init(rdb.rdBranchSize)
rdb.disposeSession()
proc commit*(rdb: var RdbInst): Result[void,(AristoError,string)] =
if not rdb.session.isClosed():
defer: rdb.disposeSession()
rdb.baseDb.write(rdb.session).isOkOr:
const errSym = RdbBeDriverWriteError
when extraTraceMessages:
trace logTxt "commit", error=errSym, info=error
return err((errSym,error))
ok()
proc putAdm*(
rdb: var RdbInst;
xid: AdminTabID;
data: openArray[byte];
): Result[void,(AdminTabID,AristoError,string)] =
let dsc = rdb.session
if data.len == 0:
dsc.delete(xid.toOpenArray, rdb.admCol.handle()).isOkOr:
const errSym = RdbBeDriverDelAdmError
when extraTraceMessages:
trace logTxt "putAdm()", xid, error=errSym, info=error
return err((xid,errSym,error))
else:
dsc.put(xid.toOpenArray, data, rdb.admCol.handle()).isOkOr:
const errSym = RdbBeDriverPutAdmError
when extraTraceMessages:
trace logTxt "putAdm()", xid, error=errSym, info=error
return err((xid,errSym,error))
ok()
proc putVtx*(
rdb: var RdbInst;
rvid: RootedVertexID; vtx: VertexRef, key: HashKey
): Result[void,(VertexID,AristoError,string)] =
let dsc = rdb.session
if vtx.isValid:
dsc.put(rvid.blobify().data(), vtx.blobify(key), rdb.vtxCol.handle()).isOkOr:
# Caller must `rollback()` which will flush the `rdVtxLru` cache
const errSym = RdbBeDriverPutVtxError
when extraTraceMessages:
trace logTxt "putVtx()", vid, error=errSym, info=error
return err((rvid.vid,errSym,error))
# Update existing cached items but don't add new ones since doing so is
# likely to evict more useful items (when putting many items, we might even
# evict those that were just added)
if vtx.vType == Branch and vtx.pfx.len == 0:
rdb.rdVtxLru.del(rvid.vid)
if rdb.rdBranchLru.len < rdb.rdBranchLru.capacity:
rdb.rdBranchLru.put(rvid.vid, (vtx.startVid, vtx.used))
else:
discard rdb.rdBranchLru.update(rvid.vid, (vtx.startVid, vtx.used))
else:
rdb.rdBranchLru.del(rvid.vid)
if rdb.rdVtxLru.len < rdb.rdVtxLru.capacity:
rdb.rdVtxLru.put(rvid.vid, vtx)
else:
discard rdb.rdVtxLru.update(rvid.vid, vtx)
if key.isValid:
if rdb.rdKeyLru.len < rdb.rdKeyLru.capacity:
rdb.rdKeyLru.put(rvid.vid, key)
else:
discard rdb.rdKeyLru.update(rvid.vid, key)
else:
rdb.rdKeyLru.del rvid.vid
else:
dsc.delete(rvid.blobify().data(), rdb.vtxCol.handle()).isOkOr:
# Caller must `rollback()` which will flush the `rdVtxLru` cache
const errSym = RdbBeDriverDelVtxError
when extraTraceMessages:
trace logTxt "putVtx()", vid, error=errSym, info=error
return err((rvid.vid,errSym,error))
# Update cache, vertex will most probably never be visited anymore
rdb.rdBranchLru.del rvid.vid
rdb.rdVtxLru.del rvid.vid
rdb.rdKeyLru.del rvid.vid
ok()
# ------------------------------------------------------------------------------
# End
# ------------------------------------------------------------------------------