org.evosuite.runtime.LoopCounter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of evosuite-runtime Show documentation
There is a newer version: 1.0.6
/**
 * Copyright (C) 2010-2016 Gordon Fraser, Andrea Arcuri and EvoSuite
 * contributors
 *
 * This file is part of EvoSuite.
 *
 * EvoSuite is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3.0 of the License, or
 * (at your option) any later version.
 *
 * EvoSuite is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with EvoSuite. If not, see .
 */
package org.evosuite.runtime;

import java.util.LinkedList;
import java.util.List;

/**
 * In some cases, we can end up with infinite loops: eg due to a bug, a seeded mutation,
 * a very large input parameter, or simply it is the expected behavior of the CUT.
 * In such cases, we will every time hit the test timeout, which will hinder the search.
 *
 * 
 * Therefore, for each loop in the instrumented CUTs, we can have a limit, and throw an exception
 * if too many iterations have occurred
 *
 * Created by Andrea Arcuri on 29/03/15.
 */
public class LoopCounter {

    private static final LoopCounter singleton = new LoopCounter();

    private boolean activated = true;
    
    /**
     * Number of iterations so far
     */
    private List counters;


    private LoopCounter(){
        counters = new LinkedList<>();
    }

    public static LoopCounter getInstance(){
        return singleton;
    }

    public void reset(){
        counters.clear();
    }
    
    public void setActive(boolean active) {
    	this.activated = active;
    }

    public boolean isActivated() {
        return activated;
    }

    /**
     * This is called during bytecode instrumentation to determine which index
     * to assign to a new parsed loop
     *
     * @return the next valid index for a new loop
     */
    public int getNewIndex(){
        int index = counters.size();
        counters.add(0l);
        return index;
    }


    /**
     * This is added directly in the instrumented CUT after each loop statement
     *
     * @param index
     * @throws TooManyResourcesException if this loop has executed too many iterations
     * @throws IllegalArgumentException
     */
    public void checkLoop(int index) throws TooManyResourcesException, IllegalArgumentException{
        if(index < 0){
            throw new IllegalArgumentException("Loop index cannot be negative");
        }
        
        if(!activated)
        	return;

        if(RuntimeSettings.maxNumberOfIterationsPerLoop < 0){
            return; //do nothing, no check
        }
        
        //first check initialization
        int size = counters.size();
        if(index >= size){
            for(int i=0; i < 1 + (index - size); i++){
                counters.add(0l);
            }
        }
        assert index < counters.size();

        //do increment
        long value = counters.get(index) + 1l;
        counters.set(index , value);

        if(value >= RuntimeSettings.maxNumberOfIterationsPerLoop && !isInStaticInit()) {
            this.reset();
            throw new TooManyResourcesException("Loop has been executed more times than the allowed " +
                    RuntimeSettings.maxNumberOfIterationsPerLoop);
        }
    }


    private boolean isInStaticInit() {
        for (StackTraceElement elem : Thread.currentThread().getStackTrace()) {
            if (elem.getMethodName().startsWith(""))
                return true;
        }
        return false;
    }
}