EVMC tracing for interpreter #5065

chfast · 2018-06-05T16:26:50Z

This is a preview of the EVMC feature ipsilon/evmc#32.

Changes

The trace reflects the state of the VM after the execution of an opcode.
This allows to include the error code in the trace.
You can also show the result of the opcode execution (top stack item).
The full VM stack is not reported, only the result of the opcode pushed on the stack (if any). This limits the amount of data transferred, but tracking SWAP and DUP instructions requires some work on the Client side.
Only the fragment of the memory modified by the opcode is reported to the Client. It is easy to incrementally patch the Client's memory view if needed.
The opcode is not reported. The Client knows what code is executed and can get the opcode using the code_offset. It might be convenient to revert this decision and send the opcode to the Client.
The tracing data collection is separated from formatting.
I believe you can construct a formatter which will replicate the behavior of legacy traces.

Examples

testeth -t GeneralStateTests/stCallCodes -- --verbosity 2 --singlenet Byzantium --singletest callcallcallcode_001_SuicideMiddle --vmtrace --vm interpreter

>>>> CALL gas: 2979000
0000  PUSH1 (40)
0002  PUSH1 (0)
0004  PUSH1 (40)
0006  PUSH1 (0)
0008  PUSH1 (0)
000a  PUSH20 (1000000000000000000000000000000000000001)
001f  PUSH3 (249F0)
0023  CALL (40)
>>>>  CALL gas: 150000
0000   PUSH1 (40)
0002   PUSH1 (0)
0004   PUSH1 (40)
0006   PUSH1 (0)
0008   PUSH1 (0)
000a   PUSH20 (1000000000000000000000000000000000000002)
001f   PUSH3 (186A0)
0023   CALL (40)
>>>>   CALL gas: 100000
0000    PUSH20 (1000000000000000000000000000000000000000)
0015    SELFDESTRUCT
<<<<
0024   PUSH1 (1)
0026   SSTORE
<<<<
0024  PUSH1 (0)
0026  SSTORE
<<<<

test/testeth -t 'GeneralStateTests/stCreateTest' -- --verbosity 2 --singlenet Byzantium --singletest CREATE_EmptyContractWithStorageAndCallIt_0wei --vmtrace --vm interpreter

>>>> CALL gas: 579000
0000  GAS (8D5B6)
0001  PUSH1 (0)
0003  SSTORE
0004  PUSH32 (600C6000556000600060006000600073C94F5374FCE5EDBC8E2A8697C1533167)
0025  PUSH1 (0)
0027  MSTORE
0028  PUSH32 (7E6EBF0B61EA60F1000000000000000000000000000000000000000000000000)
0049  PUSH1 (20)
004b  MSTORE
004c  PUSH1 (40)
004e  PUSH1 (0)
0050  PUSH1 (0)
0052  CREATE (40)
>>>>  CREATE gas: 518729
0000   PUSH1 (C)
0002   PUSH1 (0)
0004   SSTORE
0005   PUSH1 (0)
0007   PUSH1 (0)
0009   PUSH1 (0)
000b   PUSH1 (0)
000d   PUSH1 (0)
000f   PUSH20 (C94F5374FCE5EDBC8E2A8697C15331677E6EBF0B)
0024   PUSH2 (EA60)
0027   CALL (0)
>>>>   CALL gas: 60000
0000    PUSH1 (C)
0002    PUSH1 (1)
0004    SSTORE
<<<<
0028   STOP
<<<<
0053  PUSH1 (1)
0055  SSTORE
0056  GAS (71D30)
0057  PUSH1 (2)
0059  SSTORE
005a  PUSH1 (0)
005c  PUSH1 (0)
005e  PUSH1 (0)
0060  PUSH1 (0)
0062  PUSH1 (0)
0064  PUSH1 (1)
0066  SLOAD (F1ECF98489FA9ED60A664FC4998DB699CFA39D40)
0067  PUSH2 (EA60)
006a  CALL (0)
006b  PUSH1 (3)
006d  SSTORE
006e  GAS (67D4F)
006f  PUSH1 (64)
0071  SSTORE
<<<<

As you may see, there are at least 2 nice features here:

Internal calls are properly attached to call instructions.
You can see the outcome of an instruction, e.g. ADD (3) means that the result of the addition was 3.

The call instructions are not handled correctly yet. Now they are reported just before the internal call, but I want them to be reported after because this is more consistent and allows showing the returned values (CALL (1), CALL (0), CREATE (<created address>)).

chfast · 2018-06-05T16:35:09Z

cc @cdetrio

libevm/EVMC.cpp

chfast · 2018-06-07T13:25:50Z

@gumb0 The cpp-ethereum part is a prototype to check if the EVMC API is ok.

axic · 2018-07-25T16:56:59Z

Needs to be rebased and adapted to the latest version of ipsilon/evmc#32.

chfast · 2018-07-26T08:19:54Z

@gumb0 Do you maybe have some spare time to take it over?

libevm/VM.cpp

codecov-io · 2018-08-02T10:15:58Z

Codecov Report

Merging #5065 into master will decrease coverage by 0.08%.
The diff coverage is 73.82%.

@@            Coverage Diff             @@
##           master    #5065      +/-   ##
==========================================
- Coverage   60.81%   60.73%   -0.09%     
==========================================
  Files         341      341              
  Lines       28127    28307     +180     
  Branches     3247     3260      +13     
==========================================
+ Hits        17106    17192      +86     
- Misses       9891     9975      +84     
- Partials     1130     1140      +10

addressed my own notes

libevm/EVMC.h

axic · 2018-09-14T11:03:48Z

libevm/EVMC.cpp

+        LOG(evmc->m_vmTraceLogger) << logMessage.str();
+    };
+
+    _instance->set_tracer(_instance, tracer, reinterpret_cast<evmc_tracer_context*>(this));


Could use evmc_set_tracer here.

chfast · 2018-11-20T15:28:04Z

Updated, please check the description.
cc @holiman @karalabe.

Store them as member variables of a class wrapping evmc_instance.

…stead of repeating it in every opcode implementation.

gumb0 · 2019-06-17T09:22:02Z

Here's the summary of what is affected in aleth by changes in tracing:

VM trace output in logs at TRACE verbosity for aleth and testeth
--jsontrace option of testeth
Trace output and opcode stats counting in aleth-vm tool
admin_eth_vmTrace and debug_trace* RPC methods
some VM unit tests use trace callback to check the opcode price

chfast · 2019-06-17T09:25:36Z

The tracing API in EVMC has some flaws and will have to redesigned. But the amount of data transferred from the VM is good.

chfast requested review from axic, gumb0, holiman, karalabe, winsvega and yann300 June 5, 2018 16:35

gumb0 previously requested changes Jun 7, 2018

View reviewed changes

libevm/EVMC.cpp Outdated Show resolved Hide resolved

libevm/EVMC.cpp Outdated Show resolved Hide resolved

libevm/EVMC.cpp Outdated Show resolved Hide resolved

chfast force-pushed the evmc-tracing branch from 826680d to 5f0f14e Compare June 18, 2018 12:26

chfast mentioned this pull request Jun 18, 2018

Tracing API ipsilon/evmc#32

Merged

chfast removed request for holiman, karalabe and yann300 June 18, 2018 12:28

chfast mentioned this pull request Jun 19, 2018

aleth-interpreter library #5080

Merged

axic reviewed Jul 30, 2018

View reviewed changes

libevm/VM.cpp Outdated Show resolved Hide resolved

axic reviewed Jul 30, 2018

View reviewed changes

libevm/VM.cpp Outdated Show resolved Hide resolved

gumb0 added the in progress label Aug 1, 2018

gumb0 force-pushed the evmc-tracing branch 2 times, most recently from e097de1 to f324cc2 Compare August 1, 2018 16:48

chfast changed the base branch from develop to master August 2, 2018 08:37

gumb0 force-pushed the evmc-tracing branch from f324cc2 to 0e83df0 Compare August 2, 2018 10:15

gumb0 force-pushed the evmc-tracing branch from 0e83df0 to b9628a7 Compare August 2, 2018 10:54

gumb0 force-pushed the evmc-tracing branch 3 times, most recently from 7dd24d3 to 7042f6a Compare August 7, 2018 13:21

This comment has been minimized.

Sign in to view

axic reviewed Sep 14, 2018

View reviewed changes

libevm/EVMC.h Show resolved Hide resolved

axic reviewed Sep 14, 2018

View reviewed changes

chfast force-pushed the evmc-tracing branch from 7042f6a to 917d4b5 Compare November 13, 2018 15:06

chfast force-pushed the evmc-tracing branch from 1053ead to 57531b9 Compare November 20, 2018 15:10

chfast and others added 13 commits November 28, 2018 11:58

EVMC tracing for interpreter

289755f

Formatting fixes in tracer function

a53eaf7

Log EVMC trace messages to vmtrace channel

07fc1cc

Minor fixes in tracing

fd2659b

Get rid of global variables for trace function and context.

4ad84c4

Store them as member variables of a class wrapping evmc_instance.

Move trace() call to common place (NEXT / CONTINUE / BREAK macros) in…

95fc2c6

…stead of repeating it in every opcode implementation.

tracing: random dump

9715362

interpreter: Fix tracing PC

b58625f

evm: Tune EVMC tracing dump

505992f

evm: Make interpreter a singleton

ea6fedc

evm: Proper call nesting in tracing

72391b5

evm: Restore previous code for tracing

4818a99

evm: Remove unused field from EVMC

75732d2

chfast force-pushed the evmc-tracing branch from 57531b9 to 75732d2 Compare November 28, 2018 10:59

chfast added 6 commits November 28, 2018 13:49

evm: In tracing handle call after they are finished

868258a

evm: Better text output of trace

1a37110

evm: Report status code in EVMC tracing

c27cfb8

evm: Properly reset prev call

9a39253

evm: Only provide top stack item in trace with execution was successful

01ce909

evm: Handle undefined opcodes in tracing

cb39b51

Uh oh!

EVMC tracing for interpreter #5065

Are you sure you want to change the base?

EVMC tracing for interpreter #5065

Uh oh!

Conversation

chfast commented Jun 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Examples

Uh oh!

chfast commented Jun 5, 2018

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chfast commented Jun 7, 2018

Uh oh!

axic commented Jul 25, 2018

Uh oh!

chfast commented Jul 26, 2018

Uh oh!

Uh oh!

Uh oh!

codecov-io commented Aug 2, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Uh oh!

axic Sep 14, 2018

Choose a reason for hiding this comment

Uh oh!

chfast commented Nov 20, 2018

Uh oh!

gumb0 commented Jun 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chfast commented Jun 17, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

chfast commented Jun 5, 2018 •

edited

Loading

codecov-io commented Aug 2, 2018 •

edited

Loading

gumb0 commented Jun 17, 2019 •

edited

Loading