nimbus-eth1/nimbus/vm_state.nim

168 lines
6.0 KiB
Nim
Raw Normal View History

# Nimbus
# Copyright (c) 2018 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.
import
macros, strformat, tables, sets,
2019-11-13 14:49:39 +00:00
eth/common,
./constants, ./db/[db_chain, state_db],
2019-02-26 07:04:12 +00:00
./utils, json, vm_types, vm/transaction_tracer
2018-02-13 17:18:08 +00:00
proc newAccessLogs*: AccessLogs =
AccessLogs(reads: initTable[string, string](), writes: initTable[string, string]())
proc update*[K, V](t: var Table[K, V], elements: Table[K, V]) =
for k, v in elements:
t[k] = v
proc `$`*(vmState: BaseVMState): string =
if vmState.isNil:
result = "nil"
else:
result = &"VMState {vmState.name}:\n header: {vmState.blockHeader}\n chaindb: {vmState.chaindb}"
2019-02-22 08:52:53 +00:00
proc init*(self: BaseVMState, prevStateRoot: Hash256, header: BlockHeader,
chainDB: BaseChainDB, tracerFlags: set[TracerFlags] = {}) =
self.prevHeaders = @[]
self.name = "BaseVM"
self.accessLogs = newAccessLogs()
self.blockHeader = header
self.chaindb = chainDB
self.tracer.initTracer(tracerFlags)
self.tracingEnabled = TracerFlags.EnableTracing in tracerFlags
self.logEntries = @[]
self.blockHeader.stateRoot = prevStateRoot
self.accountDb = newAccountStateDB(chainDB.db, prevStateRoot, chainDB.pruneTrie)
2019-11-13 14:49:39 +00:00
self.touchedAccounts = initHashSet[EthAddress]()
2019-02-22 08:52:53 +00:00
2019-02-14 15:20:41 +00:00
proc newBaseVMState*(prevStateRoot: Hash256, header: BlockHeader,
chainDB: BaseChainDB, tracerFlags: set[TracerFlags] = {}): BaseVMState =
Refactor interpreter dispatch (#65) * move forks constants, rename errors * Move vm/utils to vm/interpreter/utils * initial opcodes refactoring * Add refactored Comparison & Bitwise Logic Operations * Add sha3 and address, simplify macro, support pop 0 * balance, origin, caller, callValue * fix gas copy opcodes gas costs, add callDataLoad/Size/Copy, CodeSize/Copy and gas price opcode * Update with 30s, 40s, 50s opcodes + impl of balance + stack improvement * add push, dup, swap, log, create and call operations * finish opcode implementation * Add the new dispatching logic * Pass the opcode test * Make test_vm_json compile * halt execution without exceptions for Return, Revert, selfdestruct (fix #62) * Properly catch and recover from EVM exceptions (stack underflow ...) * Fix byte op * Fix jump regressions * Update for latest devel, don't import old dispatch code as quasiBoolean macro is broken by latest devel * Fix sha3 regression on empty memory slice and until end of range slice * Fix padding / range error on expXY_success (gas computation left) * update logging procs * Add tracing - expXY_success is not a regression, sload stub was accidentally passing the test * Reuse the same stub as OO implementation * Delete previous opcode implementation * Delete object oriented fork code * Delete exceptions that were used as control flows * delete base.nim :fire:, yet another OO remnants * Delete opcode table * Enable omputed gotos and compile-time gas fees * Revert const gasCosts -> generates SIGSEGV * inline push, swap and dup opcodes * loggers are now template again, why does this pass new tests? * Trigger CI rebuild after rocksdb fix https://github.com/status-im/nim-rocksdb/pull/5 * Address review comment on "push" + VMTests in debug mode (not release) * Address review comment: don't tag fork by default, make opcode impl grepable * Static compilation fixes after rebasing * fix the initialization of the VM database * add a missing import * Deactivate balance and sload test following #59 * Reactivate stack check (deactivated in #59, necessary to pass tests) * Merge remaining opcodes implementation from #59 * Merge callDataLoad and codeCopy fixes, todo simplify see #67
2018-07-06 07:52:31 +00:00
new result
2019-02-22 08:52:53 +00:00
result.init(prevStateRoot, header, chainDB, tracerFlags)
2018-12-31 03:27:02 +00:00
proc stateRoot*(vmState: BaseVMState): Hash256 =
vmState.blockHeader.stateRoot
method blockhash*(vmState: BaseVMState): Hash256 {.base, gcsafe.} =
vmState.blockHeader.hash
method coinbase*(vmState: BaseVMState): EthAddress {.base, gcsafe.} =
vmState.blockHeader.coinbase
method timestamp*(vmState: BaseVMState): EthTime {.base, gcsafe.} =
vmState.blockHeader.timestamp
method blockNumber*(vmState: BaseVMState): BlockNumber {.base, gcsafe.} =
2019-02-06 07:47:05 +00:00
# it should return current block number
# and not head.blockNumber
2019-02-07 03:56:57 +00:00
vmState.blockHeader.blockNumber
method difficulty*(vmState: BaseVMState): UInt256 {.base, gcsafe.} =
vmState.blockHeader.difficulty
method gasLimit*(vmState: BaseVMState): GasInt {.base, gcsafe.} =
vmState.blockHeader.gasLimit
method getAncestorHash*(vmState: BaseVMState, blockNumber: BlockNumber): Hash256 {.base, gcsafe.} =
var ancestorDepth = vmState.blockHeader.blockNumber - blockNumber - 1
2019-09-25 09:29:44 +00:00
if ancestorDepth >= constants.MAX_PREV_HEADER_DEPTH:
return
if blockNumber >= vmState.blockHeader.blockNumber:
2018-05-30 16:11:15 +00:00
return
2019-02-15 02:08:50 +00:00
result = vmState.chainDB.getBlockHash(blockNumber)
#TODO: should we use deque here?
2019-02-16 07:00:50 +00:00
# someday we may revive this code when
# we already have working miner
2019-02-15 02:08:50 +00:00
when false:
let idx = ancestorDepth.toInt
if idx >= vmState.prevHeaders.len:
return
var header = vmState.prevHeaders[idx]
result = header.hash
2018-02-13 17:18:08 +00:00
when false:
# this was an older version of `mutateStateDB`, kept here for reference
# until `mutateStateDB` is fully implemented.
macro db*(vmState: untyped, readOnly: bool, handler: untyped): untyped =
# vm.state.db:
# setupStateDB(fixture{"pre"}, stateDb)
# code = db.getCode(fixture{"exec"}{"address"}.getStr)
let db = ident("db")
result = quote:
block:
var `db` = `vmState`.chaindb.getStateDB(`vmState`.blockHeader.stateRoot, `readOnly`)
`handler`
if `readOnly`:
# This acts as a secondary check that no mutation took place for
# read_only databases.
2019-03-13 21:36:54 +00:00
doAssert `db`.rootHash == `vmState`.blockHeader.stateRoot
elif `vmState`.blockHeader.stateRoot != `db`.rootHash:
`vmState`.blockHeader.stateRoot = `db`.rootHash
# TODO
# `vmState`.accessLogs.reads.update(`db`.db.accessLogs.reads)
# `vmState`.accessLogs.writes.update(`db`.db.accessLogs.writes)
# remove the reference to the underlying `db` object to ensure that no
# further modifications can occur using the `State` object after
# leaving the context.
# TODO `db`.db = nil
# state._trie = None
2018-12-31 03:27:02 +00:00
proc getStateDb*(vmState: BaseVMState; stateRoot: Hash256): AccountStateDB =
# TODO: use AccountStateDB revert/commit after JournalDB implemented
vmState.accountDb.rootHash = stateRoot
vmState.accountDb
proc readOnlyStateDB*(vmState: BaseVMState): ReadOnlyStateDB {.inline.} =
ReadOnlyStateDB(vmState.accountDb)
template mutateStateDB*(vmState: BaseVMState, body: untyped) =
# This should provide more clever change handling in the future
2018-12-31 03:27:02 +00:00
# TODO: use AccountStateDB revert/commit after JournalDB implemented
block:
let initialStateRoot = vmState.blockHeader.stateRoot
2018-12-31 03:27:02 +00:00
var db {.inject.} = vmState.getStateDB(initialStateRoot)
body
let finalStateRoot = db.rootHash
if finalStateRoot != initialStateRoot:
vmState.blockHeader.stateRoot = finalStateRoot
2018-12-03 10:54:19 +00:00
proc getTracingResult*(vmState: BaseVMState): JsonNode =
2019-03-13 21:36:54 +00:00
doAssert(vmState.tracingEnabled)
2018-12-03 10:54:19 +00:00
vmState.tracer.trace
2018-12-10 12:04:34 +00:00
2019-02-27 14:04:42 +00:00
proc addLogs*(vmState: BaseVMState, logs: seq[Log]) =
shallowCopy(vmState.logEntries, logs)
2018-12-10 12:04:34 +00:00
proc getAndClearLogEntries*(vmState: BaseVMState): seq[Log] =
shallowCopy(result, vmState.logEntries)
vmState.logEntries = @[]
2018-12-11 09:27:22 +00:00
proc enableTracing*(vmState: BaseVMState) =
vmState.tracingEnabled = true
proc disableTracing*(vmState: BaseVMState) =
vmState.tracingEnabled = false
2018-12-25 07:31:12 +00:00
iterator tracedAccounts*(vmState: BaseVMState): EthAddress =
for acc in vmState.tracer.accounts:
yield acc
iterator tracedAccountsPairs*(vmState: BaseVMState): (int, EthAddress) =
var idx = 0
for acc in vmState.tracer.accounts:
2018-12-25 07:31:12 +00:00
yield (idx, acc)
inc idx
proc removeTracedAccounts*(vmState: BaseVMState, accounts: varargs[EthAddress]) =
for acc in accounts:
vmState.tracer.accounts.excl acc