org.evosuite.symbolic.instrument.ConcolicInstrumentingClassLoader Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2010-2018 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.symbolic.instrument;


import static org.evosuite.dse.util.Assertions.check;
import static org.evosuite.dse.util.Assertions.notNull;

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;
import java.lang.reflect.Array;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import org.evosuite.dse.MainConfig;
import org.objectweb.asm.ClassReader;
import org.objectweb.asm.Type;

/**
 * A ClassLoader very similar to the org.evosuite.javaagent.InstrumentingClassLoader
 * It must instrument java bytecode to allow recording constraints on the program.
 * 
 * @author galeotti
 *
 */
public class ConcolicInstrumentingClassLoader extends ClassLoader {
	
	//private final static Logger logger = LoggerFactory.getLogger(DscInstrumentingClassLoader.class);

	private final ClassLoader classLoader;
	private final ConcolicBytecodeInstrumentation instrumentation;
	private final Map> classes = new HashMap>();
	
	public ConcolicInstrumentingClassLoader() {
		super(ConcolicInstrumentingClassLoader.class.getClassLoader());
		this.instrumentation = new ConcolicBytecodeInstrumentation();
		classLoader = ConcolicInstrumentingClassLoader.class.getClassLoader();
	}



	@Override
	public Class loadClass(String name) throws ClassNotFoundException {

		if (!checkIfCanInstrument(name)) {
			Class result = findLoadedClass(name);
			if (result != null) {
				return result;
			}
			result = classLoader.loadClass(name);
			return result;

		} else {
			Class result = findLoadedClass(name);
			if (result != null) {
				return result;
			} else {

				result = classes.get(name);
				if (result != null) {
					return result;
				} else {
					//logger.info("Seeing class for first time: " + name);
					Class instrumentedClass = null;
					instrumentedClass = instrumentClass(name);
					return instrumentedClass;
				}
			}

		}

	}

	
	private boolean checkIfCanInstrument(String name) {
		return !MainConfig.get().isIgnored(name);
	}



	private Class instrumentClass(String fullyQualifiedTargetClass)
	        throws ClassNotFoundException {
		//logger.info("Instrumenting class '" + fullyQualifiedTargetClass + "'.");
		try {
			String className = fullyQualifiedTargetClass.replace('.', '/');
			InputStream is = ClassLoader.getSystemResourceAsStream(className + ".class");
			if (is == null) {
				try {
					is = findTargetResource(className + ".class");
				} catch (FileNotFoundException e) {
					throw new ClassNotFoundException("Class '" + className + ".class"
					        + "' should be in target project, but could not be found!");
				}
			}
			byte[] byteBuffer = instrumentation.transformBytes(className,
			                                                   new ClassReader(is));
			Class result = defineClass(fullyQualifiedTargetClass, byteBuffer, 0,
			                              byteBuffer.length);
			classes.put(fullyQualifiedTargetClass, result);
			//logger.info("Keeping class: " + fullyQualifiedTargetClass);
			return result;
		} catch (Exception e) {
			throw new ClassNotFoundException(e.getMessage(), e);
		}
	}
	
	private InputStream findTargetResource(String name) throws FileNotFoundException {
		Collection resources = ResourceList.findResourceInClassPath(name); 
		if (resources.isEmpty())
			throw new FileNotFoundException(name);
		else {
			String fileName = resources.iterator().next();
			return new FileInputStream(fileName);
		}
	}




	/**
	 * Loads class named className, without initializing it.
	 * 
	 * @param className
	 *            either as p/q/MyClass or as p.q.MyClass
	 */
	public Class getClassForName(String className) {
		notNull(className);
	
		Class res = null;
		String classNameDot = className.replace('/', '.');
		try {
			res = this.loadClass(classNameDot);
		} catch (ClassNotFoundException cnfe) {
			check(false, cnfe);
		}
		return notNull(res);
	}



	/**
	 * Loads class whose type is aType, without initializing it.
	 * 
	 * @param aType
	 */
	public Class getClassForType(Type aType) {
		switch (aType.getSort()) {
		case Type.BOOLEAN:
			return Boolean.TYPE;
		case Type.BYTE:
			return Byte.TYPE;
		case Type.CHAR:
			return Character.TYPE;
		case Type.DOUBLE:
			return Double.TYPE;
		case Type.FLOAT:
			return Float.TYPE;
		case Type.INT:
			return Integer.TYPE;
		case Type.LONG:
			return Long.TYPE;
		case Type.SHORT:
			return Short.TYPE;
		case Type.VOID:
			return Void.TYPE;
		case Type.ARRAY: {
			Class elementClass = this.getClassForType(aType.getElementType());
			int dimensions = aType.getDimensions();
			int[] lenghts = new int[dimensions];
			Class array_class = Array.newInstance(elementClass, lenghts)
					.getClass();
			return array_class;
	
		}
		default:
			return this.getClassForName(aType.getInternalName());
	
		}
	}
	

}