# 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. {.push raises: [].} import std/[algorithm, sequtils, sets, strutils, tables], eth/[common, trie/nibbles], results, stew/[byteutils, interval_set], ./aristo_desc/desc_backend, ./aristo_init/[memory_db, memory_only, rocks_db], "."/[aristo_desc, aristo_hike, aristo_layers] # ------------------------------------------------------------------------------ # Private functions # ------------------------------------------------------------------------------ proc orDefault(db: AristoDbRef): AristoDbRef = if db.isNil: AristoDbRef(top: LayerRef.init()) else: db proc add( xMap: var Table[HashKey,HashSet[VertexID]]; key: HashKey; vid: VertexID; ) = xMap.withValue(key,value): value[].incl vid do: # else if not found xMap[key] = @[vid].toHashSet # -------------------------- proc toHex(w: VertexID): string = w.uint64.toHex proc toHexLsb(w: int8): string = $"0123456789abcdef"[w and 15] proc sortedKeys[T](tab: Table[VertexID,T]): seq[VertexID] = tab.keys.toSeq.sorted proc sortedKeys(pPrf: HashSet[VertexID]): seq[VertexID] = pPrf.toSeq.sorted proc toPfx(indent: int; offset = 0): string = if 0 < indent+offset: "\n" & " ".repeat(indent+offset) else: "" proc squeeze(s: string; hex = false; ignLen = false): string = ## For long strings print `begin..end` only if hex: let n = (s.len + 1) div 2 result = if s.len < 20: s else: s[0 .. 5] & ".." & s[s.len-8 .. ^1] if not ignLen: result &= "[" & (if 0 < n: "#" & $n else: "") & "]" elif s.len <= 30: result = s else: result = if (s.len and 1) == 0: s[0 ..< 8] else: "0" & s[0 ..< 7] if not ignLen: result &= "..(" & $s.len & ")" result &= ".." & s[s.len-16 .. ^1] proc stripZeros(a: string; toExp = false): string = if 0 < a.len: result = a.strip(leading=true, trailing=false, chars={'0'}) if result.len == 0: result = "0" elif result[^1] == '0' and toExp: var n = 0 while result[^1] == '0': let w = result.len result.setLen(w-1) n.inc if n == 1: result &= "0" elif n == 2: result &= "00" elif 2 < n: result &= "↑" & $n proc vidCode(key: HashKey, db: AristoDbRef): uint64 = if key.isValid: block: let vid = db.layerGetProofVidOrVoid key if vid.isValid: db.xMap.add(key, vid) return vid.uint64 block: let vids = db.xMap.getOrVoid key if vids.isValid: return vids.sortedKeys[0].uint64 # --------------------- proc ppKeyOk( db: AristoDbRef; key: HashKey; vid: VertexID; ): string = if key.isValid and vid.isValid: block: let vid = db.layerGetProofVidOrVoid key if vid.isValid: db.xMap.add(key, vid) return block: let vids = db.xMap.getOrVoid key if vids.isValid: if vid notin vids: result = "(!)" return db.xMap.add(key,vid) proc ppVid(vid: VertexID; pfx = true): string = if pfx: result = "$" if vid.isValid: result &= vid.toHex.stripZeros.toLowerAscii else: result &= "ø" proc ppVids(vids: HashSet[VertexID]): string = result = "{" if vids.len == 0: result &= "}" else: for vid in vids.toSeq.sorted: result &= "$" if vid.isValid: result &= vid.toHex.stripZeros.toLowerAscii else: result &= "ø" result &= "," result[^1] = '}' func ppCodeHash(h: Hash256): string = result = "¢" if h == Hash256(): result &= "©" elif h == EMPTY_CODE_HASH: result &= "ø" else: result &= h.data.toHex.squeeze(hex=true,ignLen=true) proc ppVidList(vLst: openArray[VertexID]): string = result = "[" if vLst.len <= 250: result &= vLst.mapIt(it.ppVid).join(",") else: result &= vLst[0 .. 99].mapIt(it.ppVid).join(",") result &= ",.." result &= vLst[^100 .. ^1].mapIt(it.ppVid).join(",") result &= "]" proc ppKey(key: HashKey; db: AristoDbRef; pfx = true): string = proc getVids(): tuple[vids: HashSet[VertexID], xMapTag: string] = block: let vid = db.layerGetProofVidOrVoid key if vid.isValid: db.xMap.add(key, vid) return (@[vid].toHashSet, "") block: let vids = db.xMap.getOrVoid key if vids.isValid: return (vids, "+") if pfx: result = "£" if key.to(Hash256) == Hash256(): result &= "©" elif not key.isValid: result &= "ø" else: let tag = if key.len < 32: "[#" & $key.len & "]" else: "" (vids, xMapTag) = getVids() if vids.isValid: if not pfx and 0 < tag.len: result &= "$" if 1 < vids.len: result &= "{" result &= vids.sortedKeys.mapIt(it.ppVid(pfx=false) & xMapTag).join(",") if 1 < vids.len: result &= "}" result &= tag return result &= @(key.data).toHex.squeeze(hex=true,ignLen=true) & tag proc ppLeafTie(lty: LeafTie, db: AristoDbRef): string = let pfx = lty.path.to(NibblesSeq) "@" & lty.root.ppVid(pfx=false) & ":" & ($pfx).squeeze(hex=true,ignLen=(pfx.len==64)) proc ppPathPfx(pfx: NibblesSeq): string = let s = $pfx if s.len < 20: s else: s[0 .. 5] & ".." & s[s.len-8 .. ^1] & ":" & $s.len proc ppNibble(n: int8): string = if n < 0: "ø" elif n < 10: $n else: n.toHexLsb proc ppPayload(p: PayloadRef, db: AristoDbRef): string = if p.isNil: result = "n/a" else: case p.pType: of RawData: result &= p.rawBlob.toHex.squeeze(hex=true) of RlpData: result &= "[#" & p.rlpBlob.toHex.squeeze(hex=true) & "]" of AccountData: result = "(" result &= ($p.account.nonce).stripZeros(toExp=true) & "," result &= ($p.account.balance).stripZeros(toExp=true) & "," result &= p.account.storageID.ppVid & "," result &= p.account.codeHash.ppCodeHash & ")" proc ppVtx(nd: VertexRef, db: AristoDbRef, vid: VertexID): string = if not nd.isValid: result = "ø" else: if not vid.isValid or vid in db.pPrf: result = ["L(", "X(", "B("][nd.vType.ord] elif db.layersGetKey(vid).isOk: result = ["l(", "x(", "b("][nd.vType.ord] else: result = ["ł(", "€(", "þ("][nd.vType.ord] case nd.vType: of Leaf: result &= nd.lPfx.ppPathPfx & "," & nd.lData.ppPayload(db) of Extension: result &= nd.ePfx.ppPathPfx & "," & nd.eVid.ppVid of Branch: for n in 0..15: if nd.bVid[n].isValid: result &= nd.bVid[n].ppVid if n < 15: result &= "," result &= ")" proc ppSTab( sTab: Table[VertexID,VertexRef]; db: AristoDbRef; indent = 4; ): string = "{" & sTab.sortedKeys .mapIt((it, sTab.getOrVoid it)) .mapIt("(" & it[0].ppVid & "," & it[1].ppVtx(db,it[0]) & ")") .join(indent.toPfx(1)) & "}" proc ppPPrf(pPrf: HashSet[VertexID]): string = result = "{" if 0 < pPrf.len: let isr = IntervalSetRef[VertexID,uint64].init() for w in pPrf: doAssert isr.merge(w,w) == 1 for iv in isr.increasing(): result &= iv.minPt.ppVid if 1 < iv.len: result &= ".. " & iv.maxPt.ppVid result &= ", " result.setlen(result.len - 2) #result &= pPrf.sortedKeys.mapIt(it.ppVid).join(",") result &= "}" proc ppXMap*( db: AristoDbRef; kMap: Table[VertexID,HashKey]; indent: int; ): string = let pfx = indent.toPfx(1) var multi: HashSet[VertexID] oops: HashSet[VertexID] block: var vids: HashSet[VertexID] for w in db.xMap.values: for v in w: if v in vids: oops.incl v else: vids.incl v if 1 < w.len: multi = multi + w # Vertex IDs without forward mapping `kMap: VertexID -> HashKey` var revOnly: Table[VertexID,HashKey] for (key,vids) in db.xMap.pairs: for vid in vids: if not kMap.hasKey vid: revOnly[vid] = key let revKeys =revOnly.keys.toSeq.sorted proc ppNtry(n: uint64): string = var s = VertexID(n).ppVid let key = kMap.getOrVoid VertexID(n) if key.isValid: let vids = db.xMap.getOrVoid key if VertexID(n) notin vids or 1 < vids.len: s = "(" & s & "," & key.ppKey(db) elif key.len < 32: s &= "[#" & $key.len & "]" else: s &= "£ø" if s[0] == '(': s &= ")" s & "," result = "{" # Extra reverse lookups if 0 < revKeys.len: proc ppRevKey(vid: VertexID): string = "(ø," & revOnly.getOrVoid(vid).ppKey(db) & ")" var (i, r) = (0, revKeys[0]) result &= revKeys[0].ppRevKey for n in 1 ..< revKeys.len: let vid = revKeys[n] r.inc if r != vid: if i+1 != n: if i+1 == n-1: result &= pfx else: result &= ".. " result &= revKeys[n-1].ppRevKey result &= pfx & vid.ppRevKey (i, r) = (n, vid) if i < revKeys.len - 1: if i+1 != revKeys.len - 1: result &= ".. " else: result &= pfx result &= revKeys[^1].ppRevKey # Forward lookups var cache: seq[(uint64,uint64,bool)] for vid in kMap.sortedKeys: let key = kMap.getOrVoid vid if key.isValid: cache.add (vid.uint64, key.vidCode(db), vid in multi) let vids = db.xMap.getOrVoid key if (0 < vids.len and vid notin vids) or key.len < 32: cache[^1][2] = true else: cache.add (vid.uint64, 0u64, true) if 0 < cache.len: var (i, r) = (0, cache[0]) if 0 < revKeys.len: result &= pfx result &= cache[i][0].ppNtry for n in 1 ..< cache.len: let m = cache[n-1] w = cache[n] r = (r[0]+1, r[1]+1, r[2]) if r != w or w[2]: if i+1 != n: if i+1 == n-1: result &= pfx else: result &= ".. " result &= m[0].ppNtry result &= pfx & w[0].ppNtry (i, r) = (n, w) if i < cache.len - 1: if i+1 != cache.len - 1: result &= ".. " else: result &= pfx result &= cache[^1][0].ppNtry result[^1] = '}' else: result &= "}" proc ppFRpp( fRpp: Table[HashKey,VertexID]; db: AristoDbRef; indent = 4; ): string = let xMap = fRpp.pairs.toSeq.mapIt((it[1],it[0])).toTable xStr = db.ppXMap(xMap, indent) "<" & xStr[1..^2] & ">" proc ppFilter( fl: LayerDeltaRef; db: AristoDbRef; indent: int; ): string = ## Walk over filter tables let pfx = indent.toPfx pfx1 = indent.toPfx(1) pfx2 = indent.toPfx(2) result = "" if fl.isNil: result &= " n/a" return result &= pfx & "src=" & fl.src.ppKey(db) result &= pfx & "vTop=" & fl.vTop.ppVid result &= pfx & "sTab" & pfx1 & "{" for n,vid in fl.sTab.sortedKeys: let vtx = fl.sTab.getOrVoid vid if 0 < n: result &= pfx2 result &= $(1+n) & "(" & vid.ppVid & "," & vtx.ppVtx(db,vid) & ")" result &= "}" & pfx & "kMap" & pfx1 & "{" for n,vid in fl.kMap.sortedKeys: let key = fl.kMap.getOrVoid vid if 0 < n: result &= pfx2 result &= $(1+n) & "(" & vid.ppVid & "," & key.ppKey(db) & ")" result &= "}" proc ppBe[T](be: T; db: AristoDbRef; limit: int; indent: int): string = ## Walk over backend tables let pfx = indent.toPfx pfx1 = indent.toPfx(1) pfx2 = indent.toPfx(2) result = "<" & $be.kind & ">" var (dump,dataOk) = ("",false) block: let rc = be.getTuvFn() if rc.isOk: dump &= pfx & "vTop=" & rc.value.ppVid dataOk = true block: dump &= pfx & "sTab" var (n, data) = (0, "") for (vid,vtx) in be.walkVtx: n.inc if n < limit: if 1 < n: data &= pfx2 data &= $n & "(" & vid.ppVid & "," & vtx.ppVtx(db,vid) & ")" elif n == limit: data &= pfx2 & ".." dump &= "(" & $n & ")" if 0 < n: dataOk = true dump &= pfx1 dump &= "{" & data & "}" block: dump &= pfx & "kMap" var (n, data) = (0, "") for (vid,key) in be.walkKey: n.inc if n < limit: if 1 < n: data &= pfx2 data &= $n & "(" & vid.ppVid & "," & key.ppKey(db) & ")" elif n == limit: data &= pfx2 & ".." dump &= "(" & $n & ")" if 0 < n: dataOk = true dump &= pfx1 dump &= "{" & data & "}" if dataOk: result &= dump else: result &= "[]" proc ppLayer( layer: LayerRef; db: AristoDbRef; vTopOk: bool; sTabOk: bool; kMapOk: bool; pPrfOk: bool; fRppOk: bool; indent = 4; ): string = let pfx1 = indent.toPfx(1) pfx2 = indent.toPfx(2) nOKs = vTopOk.ord + sTabOk.ord + kMapOk.ord + pPrfOk.ord + fRppOk.ord tagOk = 1 < nOKs var pfy = "" proc doPrefix(s: string; dataOk: bool): string = var rc: string if tagOk: rc = pfy if 0 < s.len: rc &= s & (if dataOk: pfx2 else: "") pfy = pfx1 else: rc = pfy pfy = pfx2 rc if not layer.isNil: if 2 < nOKs: result &= "".doPrefix(false) if vTopOk: result &= "".doPrefix(true) & "vTop=" & layer.delta.vTop.ppVid if sTabOk: let tLen = layer.delta.sTab.len info = "sTab(" & $tLen & ")" result &= info.doPrefix(0 < tLen) & layer.delta.sTab.ppSTab(db,indent+2) if kMapOk: let tLen = layer.delta.kMap.len uLen = db.xMap.len lInf = if tLen == uLen: $tLen else: $tLen & "," & $uLen info = "kMap(" & lInf & ")" result &= info.doPrefix(0 < tLen + uLen) result &= db.ppXMap(layer.delta.kMap, indent+2) if pPrfOk: let tLen = layer.final.pPrf.len info = "pPrf(" & $tLen & ")" result &= info.doPrefix(0 < tLen) & layer.final.pPrf.ppPPrf if fRppOk: let tLen = layer.final.fRpp.len info = "fRpp(" & $tLen & ")" result &= info.doPrefix(0 < tLen) & layer.final.fRpp.ppFRpp(db,indent+2) if 0 < nOKs: let info = if layer.final.dirty.len == 0: "clean" else: "dirty" & layer.final.dirty.ppVids result &= info.doPrefix(false) # ------------------------------------------------------------------------------ # Public functions # ------------------------------------------------------------------------------ proc pp*(w: Hash256; codeHashOk = false): string = if codeHashOk: w.ppCodeHash elif w == EMPTY_ROOT_HASH: "EMPTY_ROOT_HASH" elif w == Hash256(): "Hash256()" else: w.data.toHex.squeeze(hex=true,ignLen=true) proc pp*(w: HashKey; sig: MerkleSignRef): string = w.ppKey(sig.db) proc pp*(w: HashKey; db = AristoDbRef(nil)): string = w.ppKey(db.orDefault) proc pp*(w: openArray[HashKey]; db = AristoDbRef(nil)): string = "[" & @w.mapIt(it.ppKey(db.orDefault)).join(",") & "]" proc pp*(lty: LeafTie, db = AristoDbRef(nil)): string = lty.ppLeafTie(db.orDefault) proc pp*(vid: VertexID): string = vid.ppVid proc pp*(vLst: openArray[VertexID]): string = vLst.ppVidList proc pp*(p: PayloadRef, db = AristoDbRef(nil)): string = p.ppPayload(db.orDefault) proc pp*(nd: VertexRef, db = AristoDbRef(nil)): string = nd.ppVtx(db.orDefault, VertexID(0)) proc pp*(nd: NodeRef; db: AristoDbRef): string = if not nd.isValid: result = "n/a" elif nd.error != AristoError(0): result = "(!" & $nd.error else: result = ["L(", "X(", "B("][nd.vType.ord] case nd.vType: of Leaf: result &= $nd.lPfx.ppPathPfx & "," & nd.lData.pp(db) of Extension: result &= $nd.ePfx.ppPathPfx & "," & nd.eVid.ppVid & "," result &= nd.key[0].ppKey(db) result &= db.ppKeyOk(nd.key[0], nd.eVid) of Branch: result &= "[" for n in 0..15: if nd.bVid[n].isValid or nd.key[n].isValid: result &= nd.bVid[n].ppVid result &= db.ppKeyOk(nd.key[n], nd.bVid[n]) & "," result[^1] = ']' result &= ",[" for n in 0..15: if nd.bVid[n].isValid or nd.key[n].isValid: result &= nd.key[n].ppKey(db) result &= "," result[^1] = ']' result &= ")" proc pp*[T](rc: Result[T,(VertexID,AristoError)]): string = if rc.isOk: result = "ok(" when T isnot void: result &= ".." result &= ")" else: result = "err((" & rc.error[0].pp & "," & $rc.error[1] & "))" proc pp*(nd: NodeRef): string = nd.pp(AristoDbRef(nil).orDefault) proc pp*( sTab: Table[VertexID,VertexRef]; db = AristoDbRef(nil); indent = 4; ): string = sTab.ppSTab(db.orDefault) proc pp*(pPrf: HashSet[VertexID]): string = pPrf.ppPPrf proc pp*(leg: Leg; db = AristoDbRef(nil)): string = let db = db.orDefault() result = "(" & leg.wp.vid.ppVid & "," block: let key = db.layersGetKeyOrVoid leg.wp.vid if not key.isValid: result &= "ø" elif leg.wp.vid notin db.xMap.getOrVoid key: result &= key.ppKey(db) result &= "," if 0 <= leg.nibble: result &= $leg.nibble.ppNibble result &= "," & leg.wp.vtx.pp(db) & ")" proc pp*(hike: Hike; db = AristoDbRef(nil); indent = 4): string = let db = db.orDefault() pfx = indent.toPfx(1) result = "[" if hike.legs.len == 0: result &= "(" & hike.root.ppVid & ")" else: if hike.legs[0].wp.vid != hike.root: result &= "(" & hike.root.ppVid & ")" & pfx result &= hike.legs.mapIt(it.pp(db)).join(pfx) result &= pfx & "(" & hike.tail.ppPathPfx & ")" result &= "]" proc pp*(kMap: Table[VertexID,HashKey]; indent = 4): string = let db = AristoDbRef(nil).orDefault "{" & kMap.sortedKeys .mapIt((it, kMap.getOrVoid it)) .mapIt("(" & it[0].ppVid & "," & it[1].ppKey(db) & ")") .join("," & indent.toPfx(1)) & "}" proc pp*(kMap: Table[VertexID,HashKey]; db: AristoDbRef; indent = 4): string = db.ppXMap(kMap, indent) # --------------------- proc pp*(tx: AristoTxRef): string = result = "(uid=" & $tx.txUid & ",level=" & $tx.level if not tx.parent.isNil: result &= ", par=" & $tx.parent.txUid result &= ")" proc pp*(wp: VidVtxPair; db: AristoDbRef): string = "(" & wp.vid.pp & "," & wp.vtx.pp(db) & ")" proc pp*( layer: LayerRef; db: AristoDbRef; indent = 4; ): string = layer.ppLayer( db, vTopOk=true, sTabOk=true, kMapOk=true, pPrfOk=true, fRppOk=true) proc pp*( layer: LayerRef; db: AristoDbRef; xTabOk: bool; indent = 4; ): string = layer.ppLayer( db, vTopOk=true, sTabOk=xTabOk, kMapOk=true, pPrfOk=true, fRppOk=true) proc pp*( layer: LayerRef; db: AristoDbRef; xTabOk: bool; kMapOk: bool; other = false; indent = 4; ): string = layer.ppLayer( db, vTopOk=other, sTabOk=xTabOk, kMapOk=kMapOk, pPrfOk=other, fRppOk=other) proc pp*( db: AristoDbRef; xTabOk: bool; indent = 4; ): string = db.layersCc.pp(db, xTabOk=xTabOk, indent=indent) proc pp*( db: AristoDbRef; xTabOk: bool; kMapOk: bool; other = false; indent = 4; ): string = db.layersCc.pp(db, xTabOk=xTabOk, kMapOk=kMapOk, other=other, indent=indent) proc pp*( filter: LayerDeltaRef; db = AristoDbRef(nil); indent = 4; ): string = filter.ppFilter(db.orDefault(), indent) proc pp*( be: BackendRef; db: AristoDbRef; limit = 100; indent = 4; ): string = result = db.balancer.ppFilter(db, indent+1) & indent.toPfx case be.kind: of BackendMemory: result &= be.MemBackendRef.ppBe(db, limit, indent+1) of BackendRocksDB, BackendRdbHosting: result &= be.RdbBackendRef.ppBe(db, limit, indent+1) of BackendVoid: result &= "" proc pp*( db: AristoDbRef; indent = 4; backendOk = false; balancerOk = true; topOk = true; stackOk = true; kMapOk = true; limit = 100; ): string = if topOk: result = db.layersCc.pp( db, xTabOk=true, kMapOk=kMapOk, other=true, indent=indent) let stackOnlyOk = stackOk and not (topOk or balancerOk or backendOk) if not stackOnlyOk: result &= indent.toPfx & " level=" & $db.stack.len if (stackOk and 0 < db.stack.len) or stackOnlyOk: let layers = @[db.top] & db.stack.reversed var lStr = "" for n,w in layers: let m = layers.len - n - 1 l = db.layersCc m a = w.delta.kMap.values.toSeq.filterIt(not it.isValid).len c = l.delta.kMap.values.toSeq.filterIt(not it.isValid).len result &= "(" & $(w.delta.kMap.len - a) & "," & $a & ")" lStr &= " " & $m & "=(" & $(l.delta.kMap.len - c) & "," & $c & ")" result &= " =>" & lStr if backendOk: result &= indent.toPfx & db.backend.pp(db, limit=limit, indent) elif balancerOk: result &= indent.toPfx & db.balancer.ppFilter(db, indent+1) proc pp*(sdb: MerkleSignRef; indent = 4): string = "count=" & $sdb.count & " root=" & sdb.root.pp & " error=" & $sdb.error & "\n db\n " & sdb.db.pp(indent=indent+1) # ------------------------------------------------------------------------------ # End # ------------------------------------------------------------------------------