@ -7,6 +7,16 @@ import { parseType } from './decodeInfo'
import { isContractCreation , isCallInstruction , isCreateInstruction , isJumpDestInstruction } from '../trace/traceHelper' import { isContractCreation , isCallInstruction , isCreateInstruction , isJumpDestInstruction } from '../trace/traceHelper'
import { extractLocationFromAstVariable } from './types/util' import { extractLocationFromAstVariable } from './types/util'
export type StepDetail = {
depth : number ,
gas : number | string ,
gasCost : number ,
memory : number [ ] ,
op : string ,
pc : number ,
stack : number [ ] ,
}
/ * * / * *
* Tree representing internal jump into function . * Tree representing internal jump into function .
* Triggers ` callTreeReady ` event when tree is ready * Triggers ` callTreeReady ` event when tree is ready
@ -27,6 +37,15 @@ export class InternalCallTree {
functionDefinitionByFile functionDefinitionByFile
astWalker astWalker
reducedTrace reducedTrace
locationAndOpcodePerVMTraceIndex : {
[ Key : number ] : any
}
gasCostPerLine
offsetToLineColumnConverter
pendingConstructorExecutionAt : number
pendingConstructorId : number
pendingConstructor
constructorsStartExecution
/ * * / * *
* constructor * constructor
@ -37,14 +56,16 @@ export class InternalCallTree {
* @param { Object } codeManager - code manager * @param { Object } codeManager - code manager
* @param { Object } opts - { includeLocalVariables , debugWithGeneratedSources } * @param { Object } opts - { includeLocalVariables , debugWithGeneratedSources }
* / * /
constructor ( debuggerEvent , traceManager , solidityProxy , codeManager , opts ) { constructor ( debuggerEvent , traceManager , solidityProxy , codeManager , opts , offsetToLineColumnConverter ? ) {
this . includeLocalVariables = opts . includeLocalVariables this . includeLocalVariables = opts . includeLocalVariables
this . debugWithGeneratedSources = opts . debugWithGeneratedSources this . debugWithGeneratedSources = opts . debugWithGeneratedSources
this . event = new EventManager ( ) this . event = new EventManager ( )
this . solidityProxy = solidityProxy this . solidityProxy = solidityProxy
this . traceManager = traceManager this . traceManager = traceManager
this . offsetToLineColumnConverter = offsetToLineColumnConverter
this . sourceLocationTracker = new SourceLocationTracker ( codeManager , { debugWithGeneratedSources : opts.debugWithGeneratedSources } ) this . sourceLocationTracker = new SourceLocationTracker ( codeManager , { debugWithGeneratedSources : opts.debugWithGeneratedSources } )
debuggerEvent . register ( 'newTraceLoaded' , ( trace ) = > { debuggerEvent . register ( 'newTraceLoaded' , ( trace ) = > {
const time = Date . now ( )
this . reset ( ) this . reset ( )
if ( ! this . solidityProxy . loaded ( ) ) { if ( ! this . solidityProxy . loaded ( ) ) {
this . event . trigger ( 'callTreeBuildFailed' , [ 'compilation result not loaded. Cannot build internal call tree' ] ) this . event . trigger ( 'callTreeBuildFailed' , [ 'compilation result not loaded. Cannot build internal call tree' ] )
@ -52,11 +73,17 @@ export class InternalCallTree {
// each recursive call to buildTree represent a new context (either call, delegatecall, internal function)
// each recursive call to buildTree represent a new context (either call, delegatecall, internal function)
const calledAddress = traceManager . getCurrentCalledAddressAt ( 0 ) const calledAddress = traceManager . getCurrentCalledAddressAt ( 0 )
const isCreation = isContractCreation ( calledAddress ) const isCreation = isContractCreation ( calledAddress )
buildTree ( this , 0 , '' , true , isCreation ) . then ( ( result ) = > {
const scopeId = '1'
this . scopeStarts [ 0 ] = scopeId
this . scopes [ scopeId ] = { firstStep : 0 , locals : { } , isCreation , gasCost : 0 }
buildTree ( this , 0 , scopeId , isCreation ) . then ( ( result ) = > {
if ( result . error ) { if ( result . error ) {
this . event . trigger ( 'callTreeBuildFailed' , [ result . error ] ) this . event . trigger ( 'callTreeBuildFailed' , [ result . error ] )
} else { } else {
createReducedTrace ( this , traceManager . trace . length - 1 ) createReducedTrace ( this , traceManager . trace . length - 1 )
console . log ( 'call tree build lasts ' , ( Date . now ( ) - time ) / 1000 )
this . event . trigger ( 'callTreeReady' , [ this . scopes , this . scopeStarts ] ) this . event . trigger ( 'callTreeReady' , [ this . scopes , this . scopeStarts ] )
} }
} , ( reason ) = > { } , ( reason ) = > {
@ -85,10 +112,16 @@ export class InternalCallTree {
this . functionCallStack = [ ] this . functionCallStack = [ ]
this . functionDefinitionsByScope = { } this . functionDefinitionsByScope = { }
this . scopeStarts = { } this . scopeStarts = { }
this . gasCostPerLine = { }
this . variableDeclarationByFile = { } this . variableDeclarationByFile = { }
this . functionDefinitionByFile = { } this . functionDefinitionByFile = { }
this . astWalker = new AstWalker ( ) this . astWalker = new AstWalker ( )
this . reducedTrace = [ ] this . reducedTrace = [ ]
this . locationAndOpcodePerVMTraceIndex = { }
this . pendingConstructorExecutionAt = - 1
this . pendingConstructorId = - 1
this . constructorsStartExecution = { }
this . pendingConstructor = null
} }
/ * * / * *
@ -123,6 +156,7 @@ export class InternalCallTree {
const scope = this . findScope ( vmtraceIndex ) const scope = this . findScope ( vmtraceIndex )
if ( ! scope ) return [ ] if ( ! scope ) return [ ]
let scopeId = this . scopeStarts [ scope . firstStep ] let scopeId = this . scopeStarts [ scope . firstStep ]
const scopeDetail = this . scopes [ scopeId ]
const functions = [ ] const functions = [ ]
if ( ! scopeId ) return functions if ( ! scopeId ) return functions
let i = 0 let i = 0
@ -132,7 +166,7 @@ export class InternalCallTree {
if ( i > 1000 ) throw new Error ( 'retrieFunctionStack: recursion too deep' ) if ( i > 1000 ) throw new Error ( 'retrieFunctionStack: recursion too deep' )
const functionDefinition = this . functionDefinitionsByScope [ scopeId ] const functionDefinition = this . functionDefinitionsByScope [ scopeId ]
if ( functionDefinition !== undefined ) { if ( functionDefinition !== undefined ) {
functions . push ( functionDefinition ) functions . push ( { . . . functionDefinition , . . . scopeDetail } )
} }
const parent = this . parentScope ( scopeId ) const parent = this . parentScope ( scopeId )
if ( ! parent ) break if ( ! parent ) break
@ -141,31 +175,41 @@ export class InternalCallTree {
return functions return functions
} }
async extractSourceLocation ( step ) { async extractSourceLocation ( step : number , address? : string ) {
try { try {
const address = this . traceManager . getCurrentCalledAddressAt ( step ) if ( ! address ) address = this . traceManager . getCurrentCalledAddressAt ( step )
const location = await this . sourceLocationTracker . getSourceLocationFromVMTraceIndex ( address , step , this . solidityProxy . contracts ) return await this . sourceLocationTracker . getSourceLocationFromVMTraceIndex ( address , step , this . solidityProxy . contracts )
return location
} catch ( error ) { } catch ( error ) {
throw new Error ( 'InternalCallTree - Cannot retrieve sourcelocation for step ' + step + ' ' + error ) throw new Error ( 'InternalCallTree - Cannot retrieve sourcelocation for step ' + step + ' ' + error )
} }
} }
async extractValidSourceLocation ( step ) { async extractValidSourceLocation ( step : number , address? : string ) {
try { try {
const address = this . traceManager . getCurrentCalledAddressAt ( step ) if ( ! address ) address = this . traceManager . getCurrentCalledAddressAt ( step )
const location = await this . sourceLocationTracker . getValidSourceLocationFromVMTraceIndex ( address , step , this . solidityProxy . contracts ) return await this . sourceLocationTracker . getValidSourceLocationFromVMTraceIndex ( address , step , this . solidityProxy . contracts )
return location
} catch ( error ) { } catch ( error ) {
throw new Error ( 'InternalCallTree - Cannot retrieve valid sourcelocation for step ' + step + ' ' + error ) throw new Error ( 'InternalCallTree - Cannot retrieve valid sourcelocation for step ' + step + ' ' + error )
} }
} }
async getValidSourceLocationFromVMTraceIndexFromCache ( address : string , step : number , contracts : any ) {
return await this . sourceLocationTracker . getValidSourceLocationFromVMTraceIndexFromCache ( address , step , contracts , this . locationAndOpcodePerVMTraceIndex )
}
async getGasCostPerLine ( file : number , line : number ) {
if ( this . gasCostPerLine [ file ] && this . gasCostPerLine [ file ] [ line ] ) {
return this . gasCostPerLine [ file ] [ line ]
}
throw new Error ( 'Could not find gas cost per line' )
}
} }
async function buildTree ( tree , step , scopeId , isExternalCall , isCreation ) { async function buildTree ( tree , step , scopeId , isCreation , functionDefinition ? , contractObj ? , sourceLocation ? , validSourceLocation ? ) {
let subScope = 1 let subScope = 1
tree . scopeStarts [ step ] = scopeId if ( functionDefinition ) {
tree . scopes [ scopeId ] = { firstStep : step , locals : { } , isCreation } await registerFunctionParameters ( tree , functionDefinition , step , scopeId , contractObj , validSourceLocation )
}
function callDepthChange ( step , trace ) { function callDepthChange ( step , trace ) {
if ( step + 1 < trace . length ) { if ( step + 1 < trace . length ) {
@ -183,30 +227,104 @@ async function buildTree (tree, step, scopeId, isExternalCall, isCreation) {
included . file === source . file ) included . file === source . file )
} }
let currentSourceLocation = { start : - 1 , length : - 1 , file : - 1 } let currentSourceLocation = sourceLocation || { start : - 1 , length : - 1 , file : - 1 , jump : '-' }
let previousSourceLocation = currentSourceLocation let previousSourceLocation = currentSourceLocation
let previousValidSourceLocation = validSourceLocation || currentSourceLocation
while ( step < tree . traceManager . trace . length ) { while ( step < tree . traceManager . trace . length ) {
let sourceLocation let sourceLocation
let newLocation = false let validSourceLocation
let address
try { try {
sourceLocation = await tree . extractSourceLocation ( step ) address = tree . traceManager . getCurrentCalledAddressAt ( step )
sourceLocation = await tree . extractSourceLocation ( step , address )
if ( ! includedSource ( sourceLocation , currentSourceLocation ) ) { if ( ! includedSource ( sourceLocation , currentSourceLocation ) ) {
tree . reducedTrace . push ( step ) tree . reducedTrace . push ( step )
currentSourceLocation = sourceLocation currentSourceLocation = sourceLocation
newLocation = true
} }
const amountOfSources = tree . sourceLocationTracker . getTotalAmountOfSources ( address , tree . solidityProxy . contracts )
if ( tree . sourceLocationTracker . isInvalidSourceLocation ( currentSourceLocation , amountOfSources ) ) { // file is -1 or greater than amount of sources
validSourceLocation = previousValidSourceLocation
} else
validSourceLocation = currentSourceLocation
} catch ( e ) { } catch ( e ) {
return { outStep : step , error : 'InternalCallTree - Error resolving source location. ' + step + ' ' + e } return { outStep : step , error : 'InternalCallTree - Error resolving source location. ' + step + ' ' + e }
} }
if ( ! sourceLocation ) { if ( ! sourceLocation ) {
return { outStep : step , error : 'InternalCallTree - No source Location. ' + step } return { outStep : step , error : 'InternalCallTree - No source Location. ' + step }
} }
const isCallInstrn = isCallInstruction ( tree . traceManager . trace [ step ] ) const stepDetail : StepDetail = tree . traceManager . trace [ step ]
const isCreateInstrn = isCreateInstruction ( tree . traceManager . trace [ step ] ) const nextStepDetail : StepDetail = tree . traceManager . trace [ step + 1 ]
if ( stepDetail && nextStepDetail ) {
stepDetail . gasCost = parseInt ( stepDetail . gas as string ) - parseInt ( nextStepDetail . gas as string )
}
// gas per line
let lineColumnPos
if ( tree . offsetToLineColumnConverter ) {
try {
const generatedSources = tree . sourceLocationTracker . getGeneratedSourcesFromAddress ( address )
const astSources = Object . assign ( { } , tree . solidityProxy . sources )
const sources = Object . assign ( { } , tree . solidityProxy . sourcesCode )
if ( generatedSources ) {
for ( const genSource of generatedSources ) {
astSources [ genSource . name ] = { id : genSource.id , ast : genSource.ast }
sources [ genSource . name ] = { content : genSource.contents }
}
}
lineColumnPos = await tree . offsetToLineColumnConverter . offsetToLineColumn ( validSourceLocation , validSourceLocation . file , sources , astSources )
if ( ! tree . gasCostPerLine [ validSourceLocation . file ] ) tree . gasCostPerLine [ validSourceLocation . file ] = { }
if ( ! tree . gasCostPerLine [ validSourceLocation . file ] [ lineColumnPos . start . line ] ) {
tree . gasCostPerLine [ validSourceLocation . file ] [ lineColumnPos . start . line ] = {
gasCost : 0 ,
indexes : [ ]
}
}
tree . gasCostPerLine [ validSourceLocation . file ] [ lineColumnPos . start . line ] . gasCost += stepDetail . gasCost
tree . gasCostPerLine [ validSourceLocation . file ] [ lineColumnPos . start . line ] . indexes . push ( step )
} catch ( e ) {
console . log ( e )
}
}
tree . locationAndOpcodePerVMTraceIndex [ step ] = { sourceLocation , stepDetail , lineColumnPos }
tree . scopes [ scopeId ] . gasCost += stepDetail . gasCost
const contractObj = await tree . solidityProxy . contractObjectAtAddress ( address )
const generatedSources = getGeneratedSources ( tree , scopeId , contractObj )
const functionDefinition = resolveFunctionDefinition ( tree , sourceLocation , generatedSources )
const isInternalTxInstrn = isCallInstruction ( stepDetail )
const isCreateInstrn = isCreateInstruction ( stepDetail )
// we are checking if we are jumping in a new CALL or in an internal function
// we are checking if we are jumping in a new CALL or in an internal function
if ( isCallInstrn || sourceLocation . jump === 'i' ) {
const constructorExecutionStarts = tree . pendingConstructorExecutionAt > - 1 && tree . pendingConstructorExecutionAt < validSourceLocation . start
if ( functionDefinition && functionDefinition . kind === 'constructor' && tree . pendingConstructorExecutionAt === - 1 && ! tree . constructorsStartExecution [ functionDefinition . id ] ) {
tree . pendingConstructorExecutionAt = validSourceLocation . start
tree . pendingConstructorId = functionDefinition . id
tree . pendingConstructor = functionDefinition
// from now on we'll be waiting for a change in the source location which will mark the beginning of the constructor execution.
// constructorsStartExecution allows to keep track on which constructor has already been executed.
}
const internalfunctionCall = functionDefinition && previousSourceLocation . jump === 'i'
if ( constructorExecutionStarts || isInternalTxInstrn || internalfunctionCall ) {
try { try {
const externalCallResult = await buildTree ( tree , step + 1 , scopeId === '' ? subScope . toString ( ) : scopeId + '.' + subScope , isCallInstrn , isCreateInstrn ) const newScopeId = scopeId === '' ? subScope . toString ( ) : scopeId + '.' + subScope
tree . scopeStarts [ step ] = newScopeId
tree . scopes [ newScopeId ] = { firstStep : step , locals : { } , isCreation , gasCost : 0 }
// for the ctor we we are at the start of its trace, we have to replay this step in order to catch all the locals:
const nextStep = constructorExecutionStarts ? step : step + 1
if ( constructorExecutionStarts ) {
tree . constructorsStartExecution [ tree . pendingConstructorId ] = tree . pendingConstructorExecutionAt
tree . pendingConstructorExecutionAt = - 1
tree . pendingConstructorId = - 1
await registerFunctionParameters ( tree , tree . pendingConstructor , step , newScopeId , contractObj , previousValidSourceLocation )
tree . pendingConstructor = null
}
const externalCallResult = await buildTree ( tree , nextStep , newScopeId , isCreateInstrn , functionDefinition , contractObj , sourceLocation , validSourceLocation )
if ( externalCallResult . error ) { if ( externalCallResult . error ) {
return { outStep : step , error : 'InternalCallTree - ' + externalCallResult . error } return { outStep : step , error : 'InternalCallTree - ' + externalCallResult . error }
} else { } else {
@ -216,7 +334,7 @@ async function buildTree (tree, step, scopeId, isExternalCall, isCreation) {
} catch ( e ) { } catch ( e ) {
return { outStep : step , error : 'InternalCallTree - ' + e . message } return { outStep : step , error : 'InternalCallTree - ' + e . message }
} }
} else if ( ( isExternalCall && callDepthChange ( step , tree . traceManager . trace ) ) || ( ! isExternalCall && sourceLocation . jump === 'o' ) ) { } else if ( callDepthChange ( step , tree . traceManager . trace ) || ( sourceLocation . jump === 'o' && functionDefinition ) ) {
// if not, we might be returning from a CALL or internal function. This is what is checked here.
// if not, we might be returning from a CALL or internal function. This is what is checked here.
tree . scopes [ scopeId ] . lastStep = step tree . scopes [ scopeId ] . lastStep = step
return { outStep : step + 1 } return { outStep : step + 1 }
@ -224,9 +342,10 @@ async function buildTree (tree, step, scopeId, isExternalCall, isCreation) {
// if not, we are in the current scope.
// if not, we are in the current scope.
// We check in `includeVariableDeclaration` if there is a new local variable in scope for this specific `step`
// We check in `includeVariableDeclaration` if there is a new local variable in scope for this specific `step`
if ( tree . includeLocalVariables ) { if ( tree . includeLocalVariables ) {
await includeVariableDeclaration ( tree , step , sourceLocation , scopeId , newLocation , previousSourceLocation ) await includeVariableDeclaration ( tree , step , sourceLocation , scopeId , contractObj , generatedSources )
} }
previousSourceLocation = sourceLocation previousSourceLocation = sourceLocation
previousValidSourceLocation = validSourceLocation
step ++ step ++
} }
} }
@ -245,10 +364,33 @@ function getGeneratedSources (tree, scopeId, contractObj) {
return null return null
} }
async function includeVariableDeclaration ( tree , step , sourceLocation , scopeId , newLocation , previousSourceLocation ) { async function registerFunctionParameters ( tree , functionDefinition , step , scopeId , contractObj , sourceLocation ) {
const contractObj = await tree . solidityProxy . contractObjectAt ( step ) tree . functionCallStack . push ( step )
const functionDefinitionAndInputs = { functionDefinition , inputs : [ ] }
// means: the previous location was a function definition && JUMPDEST
// => we are at the beginning of the function and input/output are setup
try {
const stack = tree . traceManager . getStackAt ( step )
const states = tree . solidityProxy . extractStatesDefinitions ( )
if ( functionDefinition . parameters ) {
const inputs = functionDefinition . parameters
const outputs = functionDefinition . returnParameters
// input params
if ( inputs && inputs . parameters ) {
functionDefinitionAndInputs . inputs = addParams ( inputs , tree , scopeId , states , contractObj , sourceLocation , stack . length , inputs . parameters . length , - 1 )
}
// output params
if ( outputs ) addParams ( outputs , tree , scopeId , states , contractObj , sourceLocation , stack . length , 0 , 1 )
}
} catch ( error ) {
console . log ( error )
}
tree . functionDefinitionsByScope [ scopeId ] = functionDefinitionAndInputs
}
async function includeVariableDeclaration ( tree , step , sourceLocation , scopeId , contractObj , generatedSources ) {
let states = null let states = null
const generatedSources = getGeneratedSources ( tree , scopeId , contractObj )
const variableDeclarations = resolveVariableDeclaration ( tree , sourceLocation , generatedSources ) const variableDeclarations = resolveVariableDeclaration ( tree , sourceLocation , generatedSources )
// using the vm trace step, the current source location and the ast,
// using the vm trace step, the current source location and the ast,
// we check if the current vm trace step target a new ast node of type VariableDeclaration
// we check if the current vm trace step target a new ast node of type VariableDeclaration
@ -278,49 +420,6 @@ async function includeVariableDeclaration (tree, step, sourceLocation, scopeId,
} }
} }
} }
// we check here if we are at the beginning inside a new function.
// if that is the case, we have to add to locals tree the inputs and output params
const functionDefinition = resolveFunctionDefinition ( tree , previousSourceLocation , generatedSources )
if ( ! functionDefinition ) return
const previousIsJumpDest2 = isJumpDestInstruction ( tree . traceManager . trace [ step - 2 ] )
const previousIsJumpDest1 = isJumpDestInstruction ( tree . traceManager . trace [ step - 1 ] )
const isConstructor = functionDefinition . kind === 'constructor'
if ( newLocation && ( previousIsJumpDest1 || previousIsJumpDest2 || isConstructor ) ) {
tree . functionCallStack . push ( step )
const functionDefinitionAndInputs = { functionDefinition , inputs : [ ] }
// means: the previous location was a function definition && JUMPDEST
// => we are at the beginning of the function and input/output are setup
try {
const stack = tree . traceManager . getStackAt ( step )
states = tree . solidityProxy . extractStatesDefinitions ( )
if ( functionDefinition . parameters ) {
const inputs = functionDefinition . parameters
const outputs = functionDefinition . returnParameters
// for (const element of functionDefinition.parameters) {
// if (element.nodeType === 'ParameterList') {
// if (!inputs) inputs = element
// else {
// outputs = element
// break
// }
// }
// }
// input params
if ( inputs && inputs . parameters ) {
functionDefinitionAndInputs . inputs = addParams ( inputs , tree , scopeId , states , contractObj , previousSourceLocation , stack . length , inputs . parameters . length , - 1 )
}
// output params
if ( outputs ) addParams ( outputs , tree , scopeId , states , contractObj , previousSourceLocation , stack . length , 0 , 1 )
}
} catch ( error ) {
console . log ( error )
}
tree . functionDefinitionsByScope [ scopeId ] = functionDefinitionAndInputs
}
} }
// this extract all the variable declaration for a given ast and file
// this extract all the variable declaration for a given ast and file
@ -388,7 +487,8 @@ function addParams (parameterList, tree, scopeId, states, contractObj, sourceLoc
type : parseType ( param . typeDescriptions . typeString , states , contractName , location ) , type : parseType ( param . typeDescriptions . typeString , states , contractName , location ) ,
stackDepth : stackDepth , stackDepth : stackDepth ,
sourceLocation : sourceLocation , sourceLocation : sourceLocation ,
abi : contractObj.contract.abi abi : contractObj.contract.abi ,
isParameter : true
} }
params . push ( attributesName ) params . push ( attributesName )
} }
filip mertens
2 years ago