Trigger OperationTracer on contexts enter & exit

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Add ABI-decoded revert reason to `eth_call` and `eth_estimateGas` responses [#5705](https://github.com/hyperledger/besu/issues/5705)
 
 ### Additions and Improvements
+- Add new methods to `OperationTracer` to capture contexts enter/exit [#5756](https://github.com/hyperledger/besu/pull/5756)
 
 ### Bug Fixes
 - Make smart contract permissioning features work with london fork [#5727](https://github.com/hyperledger/besu/pull/5727)

evm/src/main/java/org/hyperledger/besu/evm/processor/AbstractMessageProcessor.java

@@ -58,10 +58,10 @@
  * </tr>
  * <tr>
  * <td>{@link MessageFrame.State#COMPLETED_FAILED}</td>
- * <td>{@link AbstractMessageProcessor#completedFailed(MessageFrame)}</td>
+ * <td>{@link AbstractMessageProcessor#completedFailed(MessageFrame, OperationTracer)}</td>
  * <tr>
  * <td>{@link MessageFrame.State#COMPLETED_SUCCESS}</td>
- * <td>{@link AbstractMessageProcessor#completedSuccess(MessageFrame)}</td>
+ * <td>{@link AbstractMessageProcessor#completedSuccess(MessageFrame, OperationTracer)}</td>
  * </tr>
  * </table>
  */
@@ -124,7 +124,10 @@ private void clearAccumulatedStateBesidesGasAndOutput(final MessageFrame frame)
    *
    * @param frame The message frame
    */
-  private void exceptionalHalt(final MessageFrame frame) {
+  private void exceptionalHalt(final MessageFrame frame, final OperationTracer operationTracer) {
+    if (operationTracer != null) {
+      operationTracer.traceContextExit(frame);
+    }
     clearAccumulatedStateBesidesGasAndOutput(frame);
     frame.clearGasRemaining();
     frame.clearOutputData();
@@ -136,7 +139,10 @@ private void exceptionalHalt(final MessageFrame frame) {
    *
    * @param frame The message frame
    */
-  protected void revert(final MessageFrame frame) {
+  protected void revert(final MessageFrame frame, final OperationTracer operationTracer) {
+    if (operationTracer != null) {
+      operationTracer.traceContextExit(frame);
+    }
     clearAccumulatedStateBesidesGasAndOutput(frame);
     frame.setState(MessageFrame.State.COMPLETED_FAILED);
   }
@@ -146,7 +152,10 @@ protected void revert(final MessageFrame frame) {
    *
    * @param frame The message frame
    */
-  private void completedSuccess(final MessageFrame frame) {
+  private void completedSuccess(final MessageFrame frame, final OperationTracer operationTracer) {
+    if (operationTracer != null) {
+      operationTracer.traceContextExit(frame);
+    }
     frame.getWorldUpdater().commit();
     frame.commitTransientStorage();
     frame.getMessageFrameStack().removeFirst();
@@ -158,7 +167,10 @@ private void completedSuccess(final MessageFrame frame) {
    *
    * @param frame The message frame
    */
-  private void completedFailed(final MessageFrame frame) {
+  private void completedFailed(final MessageFrame frame, final OperationTracer operationTracer) {
+    if (operationTracer != null) {
+      operationTracer.traceContextExit(frame);
+    }
     frame.getMessageFrameStack().removeFirst();
     frame.notifyCompletion();
   }
@@ -184,6 +196,10 @@ private void codeExecute(final MessageFrame frame, final OperationTracer operati
    * @param operationTracer the operation tracer
    */
   public void process(final MessageFrame frame, final OperationTracer operationTracer) {
+    if (operationTracer != null) {
+      operationTracer.traceContextEnter(frame);
+    }
+
     if (frame.getState() == MessageFrame.State.NOT_STARTED) {
       start(frame, operationTracer);
     }
@@ -192,6 +208,9 @@ public void process(final MessageFrame frame, final OperationTracer operationTra
       codeExecute(frame, operationTracer);
 
       if (frame.getState() == MessageFrame.State.CODE_SUSPENDED) {
+        if (operationTracer != null) {
+          operationTracer.traceContextExit(frame);
+        }
         return;
       }
 
@@ -201,19 +220,19 @@ public void process(final MessageFrame frame, final OperationTracer operationTra
     }
 
     if (frame.getState() == MessageFrame.State.EXCEPTIONAL_HALT) {
-      exceptionalHalt(frame);
+      exceptionalHalt(frame, operationTracer);
     }
 
     if (frame.getState() == MessageFrame.State.REVERT) {
-      revert(frame);
+      revert(frame, operationTracer);
     }
 
     if (frame.getState() == MessageFrame.State.COMPLETED_SUCCESS) {
-      completedSuccess(frame);
+      completedSuccess(frame, operationTracer);
     }
 
     if (frame.getState() == MessageFrame.State.COMPLETED_FAILED) {
-      completedFailed(frame);
+      completedFailed(frame, operationTracer);
     }
   }
 

evm/src/main/java/org/hyperledger/besu/evm/tracing/OperationTracer.java

@@ -80,6 +80,20 @@ default void traceStartTransaction(final Transaction transaction) {}
    */
   default void traceEndTransaction(final Bytes output, final long gasUsed, final long timeNs) {}
 
+  /**
+   * Trace the entering of a new context
+   *
+   * @param frame the frame
+   */
+  default void traceContextEnter(@SuppressWarnings("unused") final MessageFrame frame) {}
+
+  /**
+   * Trace the exiting of a context
+   *
+   * @param frame the frame
+   */
+  default void traceContextExit(@SuppressWarnings("unused") final MessageFrame frame) {}
+
   /**
    * Returns a boolean indicating whether extended tracing is enabled.
    *