src/main/gov/nasa/jpf/listener/StackDepthChecker.java

   1 /*
   2  * Copyright (C) 2014, United States Government, as represented by the
   3  * Administrator of the National Aeronautics and Space Administration.
   4  * All rights reserved.
   5  *
   6  * The Java Pathfinder core (jpf-core) platform is licensed under the
   7  * Apache License, Version 2.0 (the "License"); you may not use this file except
   8  * in compliance with the License. You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0.
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package gov.nasa.jpf.listener;
  19
  20 import gov.nasa.jpf.Config;
  21 import gov.nasa.jpf.JPF;
  22 import gov.nasa.jpf.ListenerAdapter;
  23 import gov.nasa.jpf.util.JPFLogger;
  24 import gov.nasa.jpf.vm.Instruction;
  25 import gov.nasa.jpf.vm.MethodInfo;
  26 import gov.nasa.jpf.vm.VM;
  27 import gov.nasa.jpf.vm.StackFrame;
  28 import gov.nasa.jpf.vm.ThreadInfo;
  29
  30 /**
  31  * listener that throws a java.lang.StackOverflowError in case a thread
  32  * exceeds a configured max stack depth
  33  *
  34  * <2do> - maybe we should only count visible stackframes, i.e. the ones for
  35  * which we have invoke insns on the stack
  36  */
  37 public class StackDepthChecker extends ListenerAdapter {
  38
  39   static JPFLogger log = JPF.getLogger("gov.nasa.jpf.listener.StackDepthChecker");
  40
  41   protected int maxDepth;
  42
  43   public StackDepthChecker (Config config, JPF jpf){
  44     maxDepth = config.getInt( "sdc.max_stack_depth", 42);
  45   }
  46
  47   @Override
  48   public void methodEntered (VM vm, ThreadInfo thread, MethodInfo mi){
  49
  50     ThreadInfo ti = ThreadInfo.getCurrentThread();
  51     int depth = ti.getStackDepth(); // note this is only an approximation since it also returns natives and overlays
  52
  53     if (depth > maxDepth){
  54       log.info("configured vm.max_stack_depth exceeded: ", depth);
  55
  56       // NOTE - we get this notification from inside of the InvokeInstruction.enter(),
  57       // i.e. before we get the instructionExecuted(). Throwing exceptions is
  58       // therefore a bit harder since we have to set the next pc explicitly
  59
  60       Instruction nextPc = ti.createAndThrowException("java.lang.StackOverflowError");
  61       StackFrame topFrame = ti.getModifiableTopFrame();
  62       topFrame.setPC(nextPc);
  63     }
  64   }
  65 }