Trace hook support for the nim vm

Author: dsrw

compiler/vm.nim

@@ -535,6 +535,12 @@ proc rawExecute(c: PCtx, start: int, tos: PStackFrame): TFullReg =
       move(regs, tos.slots)
     var regs: seq[TFullReg] # alias to tos.slots for performance
     updateRegsAlias
+
+  when callVMExecHooks:
+    defer:
+      if not c.exitHook.isNil:
+        c.exitHook(c, pc, tos)
+
   #echo "NEW RUN ------------------------"
   while true:
     #{.computedGoto.}
@@ -556,6 +562,11 @@ proc rawExecute(c: PCtx, start: int, tos: PStackFrame): TFullReg =
       # other useful variables: c.loopIterations
       echo "$# [$#] $#" % [c.config$info, $instr.opcode, c.config.sourceLine(info)]
     c.profiler.enter(c, tos)
+
+    when callVMExecHooks:
+      if not c.enterHook.isNil:
+        c.enterHook(c, pc, tos, instr)
+
     case instr.opcode
     of opcEof: return regs[ra]
     of opcRet:
@@ -2109,14 +2120,19 @@ proc rawExecute(c: PCtx, start: int, tos: PStackFrame): TFullReg =
       storeAny(regs[ra].node.strVal, typ, regs[rb].regToNode, c.config)
 
     c.profiler.leave(c)
-
+    when callVMExecHooks:
+     if not c.leaveHook.isNil:
+       c.leaveHook(c, pc, tos, instr)
     inc pc
 
 proc execute(c: PCtx, start: int): PNode =
   var tos = PStackFrame(prc: nil, comesFrom: 0, next: nil)
   newSeq(tos.slots, c.prc.regInfo.len)
   result = rawExecute(c, start, tos).regToNode
 
+proc execFromCtx*(c: PCtx, pc: int, tos: PStackFrame): PNode =
+  result = rawExecute(c, pc, tos).regToNode
+
 proc execProc*(c: PCtx; sym: PSym; args: openArray[PNode]): PNode =
   c.loopIterations = c.config.maxLoopIterationsVM
   if sym.kind in routineKinds:

compiler/vmdef.nim

@@ -44,6 +44,8 @@ const
   regBxMin* = -wordExcess+1
   regBxMax* =  wordExcess-1
 
+  callVMExecHooks* = defined(vmExecHooks)
+
 type
   TRegister* = range[0..regAMask.int]
   TDest* = range[-1..regAMask.int]
@@ -269,6 +271,11 @@ type
     vmstateDiff*: seq[(PSym, PNode)] # we remember the "diff" to global state here (feature for IC)
     procToCodePos*: Table[int, int]
 
+    when callVMExecHooks:
+      exitHook*: proc (c: PCtx, pc: int, tos: PStackFrame)
+      enterHook*: proc (c: PCtx, pc: int, tos: PStackFrame, instr: TInstr)
+      leaveHook*: proc (c: PCtx, pc: int, tos: PStackFrame, instr: TInstr)
+
   PStackFrame* = ref TStackFrame
   TStackFrame* {.acyclic.} = object
     prc*: PSym                 # current prc; proc that is evaluated