eth/tracers: package restructuring #23857
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
holiman
force-pushed
the
restructure_tracers
branch
from
ae96c74
to
50ba294
Compare
|
Please move the shared testing package to "eth/tracers/internal/tracetest". Two reasons: there is no need for packages outside of eth/tracers to import this functionality, at least for now. And calling it "testing" is not great because it conflicts with the stdlib package testing. |
holiman
force-pushed
the
restructure_tracers
branch
2 times, most recently
from
c5ac572
to
d8b80f3
Compare
|
Good points @fjl, done! |
holiman
force-pushed
the
restructure_tracers
branch
from
d8b80f3
to
4a4ab56
Compare
holiman
force-pushed
the
restructure_tracers
branch
2 times, most recently
from
d97596d
to
20674c8
Compare
holiman
force-pushed
the
restructure_tracers
branch
from
f790a68
to
5377372
Compare
s1na
reviewed
Nov 8, 2021
| // then the lookup will be placed last. This is typically meant for interpreted | ||
| // engines (js) which can evaluate dynamic user-supplied code. | ||
| func RegisterLookup(wildcard bool, lookup lookupFunc) { | ||
| if wildcard { |
There was a problem hiding this comment.
Just an observation that this won't work if there are e.g. 2 JS engines (one will starve). Not that we'll ever have 2. But I guess generally I never liked that we're using one parameter to either select from given tracers or to evaluate a JS script. I'd have preferred sth like {jscode: "{...}"} then we could have a separate function for initializing a tracer with dynamic code.
There was a problem hiding this comment.
Yes, we can only have one 'wildcard-matcher'. In hindsight, yes, it would have been nicer with a marker for it, e.g //javascript\n
holiman
commented
Nov 8, 2021
| @@ -145,6 +154,7 @@ func (t *callTracer) GetResult() (json.RawMessage, error) { | |||
| return json.RawMessage(res), t.reason | |||
| } | |||
|
|
|||
| // Stop terminates execution of the tracer at the first opportune moment. | |||
There was a problem hiding this comment.
Oh right, might want to put back that stop via interrupting the vm that I prevented you from adding previously :)
fjl
approved these changes
Nov 9, 2021
sidhujag
pushed a commit
to syscoin/go-ethereum
that referenced
this pull request
Nov 9, 2021
* eth/tracers: restructure tracer package * core/vm/runtime: load js tracers * eth/tracers: mv bigint js code to own file * eth/tracers: add method docs for native tracers * eth/tracers: minor doc fix * core,eth: cancel evm on nativecalltracer stop * core/vm: fix failing test Co-authored-by: Sina Mahmoodi <[email protected]>
|
I like |
maoueh
pushed a commit
to streamingfast/go-ethereum
that referenced
this pull request
Jan 31, 2022
* eth/tracers: implement debug.intermediateRoots (ethereum#23594) This PR implements a new debug method, which I've talked briefly about to some other client developers. It allows the caller to obtain the intermediate state roots for a block (which might be either a canon block or a 'bad' block). Signed-off-by: wenbiao <[email protected]> * core, rpc: disable memory output by default in traces (ethereum#23558) * core: cmd: invert disableMemory * core: fix missed inversion * cmd/evm: preserve Flags but change default value * Apply suggestions from code review Co-authored-by: Martin Holst Swende <[email protected]> Co-authored-by: Martin Holst Swende <[email protected]> Signed-off-by: wenbiao <[email protected]> * eth/tracers: abort evm execution when trace is aborted (ethereum#23580) Signed-off-by: wenbiao <[email protected]> * eth/tracers: avoid unsyncronized mutations on trie database (ethereum#23632) This PR fixes an issue in traceChain, where the statedb Commit operation was performed asynchronously with dereference-operations agains the underlying trie.Database instance. Due to how the reference counting works within the trie database (where parent count is recursively updated when new parents are added), doing dereferencing in the middle of Commit can cause the refcount to become wrong, leading to an inconsistent state. This was fixed by doing Commit/Deref from the same routine. Signed-off-by: wenbiao <[email protected]> * core,eth: call frame tracing (ethereum#23087) This change introduces 2 new optional methods; `enter()` and `exit()` for js tracers, and makes `step()` optiona. The two new methods are invoked when entering and exiting a call frame (but not invoked for the outermost scope, which has it's own methods). Currently these are the data fields passed to each of them: enter: type (opcode), from, to, input, gas, value exit: output, gasUsed, error The PR also comes with a re-write of the callTracer. As a backup we keep the previous tracing script under the name `callTracerLegacy`. Behaviour of both tracers are equivalent for the most part, although there are some small differences (improvements), where the new tracer is more correct / has more information. Signed-off-by: wenbiao <[email protected]> * eth/tracers: re-write of 4byte tracer using enter/exit (ethereum#23622) * eth/tracers: add re-write of 4byte tracer using enter/exit * eth/tracers: fix 4byte indent Signed-off-by: wenbiao <[email protected]> * eth/tracers: tx.BaseFee not implemented Signed-off-by: wenbiao <[email protected]> * eth/tracers: do the JSON serialization via .js to capture C faults Signed-off-by: wenbiao <[email protected]> * eth/tracers: fix callTracer fault handling (ethereum#23667) * eth/tracers: fix calltracer fault handling * eth/tracers: fix calltracer indentation Signed-off-by: wenbiao <[email protected]> * eth/tracers: invoke enter/exit on 0-value calls to inex accounts (ethereum#23828) Signed-off-by: wenbiao <[email protected]> * eth: make traceChain avoid OOM on long-running tracing (ethereum#23736) This PR changes long-running chain tracing, so that it at some points releases the memory trie db, and switch over to a fresh disk-backed trie. Signed-off-by: wenbiao <[email protected]> * eth/tracers: expose contextual infos (block hash, tx hash, tx index) Signed-off-by: wenbiao <[email protected]> * eth/tracers: redefine Context Signed-off-by: wenbiao <[email protected]> * eth/tracers: support for golang tracers + add golang callTracer (ethereum#23708) * eth/tracers: add basic native loader * eth/tracers: add GetResult to tracer interface * eth/tracers: add native call tracer * eth/tracers: fix call tracer json result * eth/tracers: minor fix * eth/tracers: fix * eth/tracers: fix benchTracer * eth/tracers: test native call tracer * eth/tracers: fix * eth/tracers: rm extra make Co-authored-by: Martin Holst Swende <[email protected]> * eth/tracers: rm extra make * eth/tracers: make callFrame private * eth/tracers: clean-up and comments * eth/tracers: add license * eth/tracers: rework the model a bit * eth/tracers: move tracecall tests to subpackage * cmd/geth: load native tracers * eth/tracers: minor fix * eth/tracers: impl stop * eth/tracers: add native noop tracer * renamings Co-authored-by: Martin Holst Swende <[email protected]> * eth/tracers: more renamings * eth/tracers: make jstracer non-exported, avoid cast * eth/tracers, core/vm: rename vm.Tracer to vm.EVMLogger for clarity * eth/tracers: minor comment fix * eth/tracers/testing: lint nitpicks * core,eth: cancel evm on nativecalltracer stop * Revert "core,eth: cancel evm on nativecalltracer stop" This reverts commit 01bb908. * eth/tracers: linter nits * eth/tracers: fix output on err Co-authored-by: Martin Holst Swende <[email protected]> Signed-off-by: wenbiao <[email protected]> * eth/tracers: make native calltracer default (ethereum#23867) Signed-off-by: wenbiao <[email protected]> * eth/tracers: package restructuring (ethereum#23857) * eth/tracers: restructure tracer package * core/vm/runtime: load js tracers * eth/tracers: mv bigint js code to own file * eth/tracers: add method docs for native tracers * eth/tracers: minor doc fix * core,eth: cancel evm on nativecalltracer stop * core/vm: fix failing test Co-authored-by: Sina Mahmoodi <[email protected]> Signed-off-by: wenbiao <[email protected]> * eth/tracers: ethapi.TransactionArgs was not merged Signed-off-by: wenbiao <[email protected]> * eth/tracers: fix the api_test with ErrInsufficientFunds to ErrInsufficientFundsForTransfer Signed-off-by: wenbiao <[email protected]> * eth/tracers: check posa before statedb.Prepare in IntermiateRoots api Signed-off-by: wenbiao <[email protected]> * eth/tracers: make js calltracer default, compatible with old version Signed-off-by: wenbiao <[email protected]> * eth/tracers: fix the default callTrace name of callTracerJs Signed-off-by: wenbiao <[email protected]> * Revert "eth/tracers: fix the default callTrace name of callTracerJs" This reverts commit 62a3bc215d9f07e422a4c659289bb3ba4f9ed2fa. Signed-off-by: wenbiao <[email protected]> * Revert "eth/tracers: make js calltracer default, compatible with old version" This reverts commit 85ef42c0ea651f0b228d4209b1b2598b24e12f1f. Signed-off-by: wenbiao <[email protected]> * eth/tracers: fix the variable race condition Signed-off-by: wenbiao <[email protected]> Co-authored-by: Martin Holst Swende <[email protected]> Co-authored-by: Marius van der Wijden <[email protected]> Co-authored-by: Sina Mahmoodi <[email protected]> Co-authored-by: Péter Szilágyi <[email protected]> Co-authored-by: Sina Mahmoodi <[email protected]>
yongjun925
pushed a commit
to DODOEX/go-ethereum
that referenced
this pull request
Dec 3, 2022
* eth/tracers: restructure tracer package * core/vm/runtime: load js tracers * eth/tracers: mv bigint js code to own file * eth/tracers: add method docs for native tracers * eth/tracers: minor doc fix * core,eth: cancel evm on nativecalltracer stop * core/vm: fix failing test Co-authored-by: Sina Mahmoodi <[email protected]>
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a follow-up to #23708. This PR restructures the tracers, so the hierarchy is
eth/tracersjs- here resides the js tracers.nativehere resides tracers written in go. The package-doc here explains how to create a new tracer and build it for inclusion in the binary.internal/tracetest/this is where tests that require both/all engines live: tests forcallTracer,callTracerLegacyandcallTracerNative.The child packages register themselves via submitting lookup-functions. The
eth/tracerspackage then invokes the lookups, and hopefully a tracer is returned.This means that in order to use tracers, one has to make sure to load the packages, since this triggers the package
initfunction. This is done ineth/tracers/testing, and also incmd/geth/.An upside of this is that we can add experimental engines, e.g. merge in a
gojaengine -- but as long as we don't import the package fromcmd/geth, we won't actually include it in the binary release. This also means that people using geth as a library will not include e.g. duktape.The api-tests were carefully rewritten to not require the tracers, but instead rely only on the results obtained via 'vanilla' tracing -- i.e with structlog output.
cc @s1na