JPF_gov_nasa_jpf_test_MemoryGoal.java

//
// Copyright (C) 2007 United States Government as represented by the
// Administrator of the National Aeronautics and Space Administration
// (NASA).  All Rights Reserved.
// 
// This software is distributed under the NASA Open Source Agreement
// (NOSA), version 1.3.  The NOSA has been approved by the Open Source
// Initiative.  See the file NOSA-1.3-JPF at the top of the distribution
// directory tree for the complete NOSA document.
// 
// THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY
// KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT
// LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO
// SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR
// A PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT
// THE SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY THAT
// DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE.
//

package gov.nasa.jpf.vm;

import de.fosd.typechef.featureexpr.FeatureExpr;
import gov.nasa.jpf.ListenerAdapter;
import gov.nasa.jpf.annotation.MJI;
import gov.nasa.jpf.jvm.bytecode.ReturnInstruction;

/**
 * native peer for MemoryGoal tests
 */
public class JPF_gov_nasa_jpf_test_MemoryGoal extends NativePeer {

  Listener listener;
  
  // <2do> that's too simple, because we should only measure what is
  // allocated from the invoked method, not the MethodTester. Needs a listener
  
  static class Listener extends ListenerAdapter {
    
    MethodInfo mi;
    boolean active;
    
    long nAllocBytes;
    long nFreeBytes;
    long nAlloc;
    long nFree;
    
    Listener (MethodInfo mi){
      this.mi = mi;
    }
    
    @Override
    public void objectCreated (VM vm, ThreadInfo ti, ElementInfo ei){
      if (active){        
        nAlloc++;
        nAllocBytes += ei.getHeapSize(); // just an approximation
      }
    }
    
    @Override
    public void objectReleased (VM vm, ThreadInfo ti, ElementInfo ei){
      if (active){
        nFree++;
        nFreeBytes += ei.getHeapSize(); // just an approximation
      }      
    }

    @Override
    public void instructionExecuted (VM vm, ThreadInfo ti, Instruction nextInsn, Instruction executedInsn){
      if (!active) {
        if (executedInsn.getMethodInfo() == mi){
          active = true;
        }
      } else {
        if ((executedInsn instanceof ReturnInstruction) && (executedInsn.getMethodInfo() == mi)){
          active = false;
        }
      }
    }
    
    long totalAllocBytes() {
      return nAllocBytes - nFreeBytes;
    }
  }
  
  @MJI
  public boolean preCheck__Lgov_nasa_jpf_test_TestContext_2Ljava_lang_reflect_Method_2__Z
                      (MJIEnv env, int objRef, int testContextRef, int methodRef, FeatureExpr ctx){
    MethodInfo mi = JPF_java_lang_reflect_Method.getMethodInfo(ctx, env, methodRef);
    
    listener = new Listener(mi);
    env.addListener(listener);
    return true;
  }
  
  // what a terrible name!
  @MJI
  public boolean postCheck__Lgov_nasa_jpf_test_TestContext_2Ljava_lang_reflect_Method_2Ljava_lang_Object_2Ljava_lang_Throwable_2__Z 
           (MJIEnv env, int objRef, int testContextRef, int methdRef, int resultRef, int exRef, FeatureExpr ctx){

    long nMax = env.getLongField(objRef, "maxGrowth").getValue();

    Listener l = listener;
    env.removeListener(l);
    listener = null;
    
    return (l.totalAllocBytes() <= nMax);
  }
}