# HG changeset patch # User Doug Simon # Date 1433794872 -7200 # Node ID 5d589f7383a640834e645c16e2aaad98a75f225f # Parent 483b357016a612bcb9ec74c2009c6a2830a7ba7d converted OptionsVerifier to be a unit test diff -r 483b357016a6 -r 5d589f7383a6 graal/com.oracle.graal.compiler.test/src/com/oracle/graal/compiler/test/OptionsVerifierTest.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/graal/com.oracle.graal.compiler.test/src/com/oracle/graal/compiler/test/OptionsVerifierTest.java Mon Jun 08 22:21:12 2015 +0200 @@ -0,0 +1,252 @@ +/* + * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code 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 General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ +package com.oracle.graal.compiler.test; + +import static java.lang.String.*; + +import java.io.*; +import java.lang.reflect.*; +import java.nio.file.*; +import java.util.*; +import java.util.zip.*; + +import jdk.internal.org.objectweb.asm.*; +import jdk.internal.org.objectweb.asm.Type; + +import org.junit.*; + +import com.oracle.jvmci.options.*; + +/** + * Verifies a class declaring one or more {@linkplain OptionValue options} has a class initializer + * that only initializes the option(s). This sanity check mitigates the possibility of an option + * value being used before being set. + */ +public class OptionsVerifierTest { + + @Test + public void verifyOptions() throws IOException { + try (Classpath cp = new Classpath()) { + HashSet> checked = new HashSet<>(); + for (Options opts : ServiceLoader.load(Options.class, getClass().getClassLoader())) { + for (OptionDescriptor desc : opts) { + OptionsVerifier.checkClass(desc.getDeclaringClass(), desc, checked, cp); + } + } + } + } + + static class Classpath implements AutoCloseable { + private final Map entries = new LinkedHashMap<>(); + + public Classpath() throws ZipException, IOException { + String[] names = (System.getProperty("sun.boot.class.path") + File.pathSeparatorChar + System.getProperty("java.class.path")).split(File.pathSeparator); + for (String n : names) { + File path = new File(n); + if (path.exists()) { + if (path.isDirectory()) { + entries.put(n, path); + } else if (n.endsWith(".jar") || n.endsWith(".zip")) { + entries.put(n, new ZipFile(path)); + } + } + } + } + + public void close() throws IOException { + for (Object e : entries.values()) { + if (e instanceof ZipFile) { + ((ZipFile) e).close(); + } + } + } + + public byte[] getInputStream(String classFilePath) throws IOException { + for (Object e : entries.values()) { + if (e instanceof File) { + File path = new File((File) e, classFilePath.replace('/', File.separatorChar)); + if (path.exists()) { + return Files.readAllBytes(path.toPath()); + } + } else if (e instanceof ZipFile) { + ZipFile zf = (ZipFile) e; + ZipEntry ze = zf.getEntry(classFilePath); + if (ze != null) { + byte[] res = new byte[(int) ze.getSize()]; + DataInputStream dis = new DataInputStream(zf.getInputStream(ze)); + dis.readFully(res); + dis.close(); + return res; + } + } + } + return null; + } + } + + static final class OptionsVerifier extends ClassVisitor { + + public static void checkClass(Class cls, OptionDescriptor option, Set> checked, Classpath cp) throws IOException { + if (!checked.contains(cls)) { + checked.add(cls); + Class superclass = cls.getSuperclass(); + if (superclass != null && !superclass.equals(Object.class)) { + checkClass(superclass, option, checked, cp); + } + + String classFilePath = cls.getName().replace('.', '/') + ".class"; + ClassReader cr = new ClassReader(Objects.requireNonNull(cp.getInputStream(classFilePath), "Could not find class file for " + cls.getName())); + + ClassVisitor cv = new OptionsVerifier(cls, option); + cr.accept(cv, 0); + } + } + + /** + * The option field context of the verification. + */ + private final OptionDescriptor option; + + /** + * The class in which {@link #option} is declared or a super-class of that class. This is + * the class whose {@code } method is being verified. + */ + private final Class cls; + + /** + * Source file context for error reporting. + */ + String sourceFile = null; + + /** + * Line number for error reporting. + */ + int lineNo = -1; + + final Class[] boxingTypes = {Boolean.class, Byte.class, Short.class, Character.class, Integer.class, Float.class, Long.class, Double.class}; + + private static Class resolve(String name) { + try { + return Class.forName(name.replace('/', '.')); + } catch (ClassNotFoundException e) { + throw new InternalError(e); + } + } + + OptionsVerifier(Class cls, OptionDescriptor desc) { + super(Opcodes.ASM5); + this.cls = cls; + this.option = desc; + } + + @Override + public void visitSource(String source, String debug) { + this.sourceFile = source; + } + + void verify(boolean condition, String message) { + if (!condition) { + error(message); + } + } + + void error(String message) { + String errorMessage = format( + "%s:%d: Illegal code in %s. which may be executed when %s.%s is initialized:%n%n %s%n%n" + "The recommended solution is to move " + option.getName() + + " into a separate class (e.g., %s.Options).%n", sourceFile, lineNo, cls.getSimpleName(), option.getDeclaringClass().getSimpleName(), option.getName(), + message, option.getDeclaringClass().getSimpleName()); + throw new InternalError(errorMessage); + + } + + @Override + public MethodVisitor visitMethod(int access, String name, String d, String signature, String[] exceptions) { + if (name.equals("")) { + return new MethodVisitor(Opcodes.ASM5) { + + @Override + public void visitLineNumber(int line, Label start) { + lineNo = line; + } + + @Override + public void visitFieldInsn(int opcode, String owner, String fieldName, String fieldDesc) { + if (opcode == Opcodes.PUTFIELD || opcode == Opcodes.PUTSTATIC) { + verify(resolve(owner).equals(option.getDeclaringClass()), format("store to field %s.%s", resolve(owner).getSimpleName(), fieldName)); + verify(opcode != Opcodes.PUTFIELD, format("store to non-static field %s.%s", resolve(owner).getSimpleName(), fieldName)); + } + } + + private Executable resolveMethod(String owner, String methodName, String methodDesc) { + Class declaringClass = resolve(owner); + if (methodName.equals("")) { + for (Constructor c : declaringClass.getDeclaredConstructors()) { + if (methodDesc.equals(Type.getConstructorDescriptor(c))) { + return c; + } + } + } else { + Type[] argumentTypes = Type.getArgumentTypes(methodDesc); + for (Method m : declaringClass.getDeclaredMethods()) { + if (m.getName().equals(methodName)) { + if (Arrays.equals(argumentTypes, Type.getArgumentTypes(m))) { + if (Type.getReturnType(methodDesc).equals(Type.getReturnType(m))) { + return m; + } + } + } + } + } + throw new NoSuchMethodError(declaringClass + "." + methodName + methodDesc); + } + + /** + * Checks whether a given method is allowed to be called. + */ + private boolean checkInvokeTarget(Executable method) { + Class holder = method.getDeclaringClass(); + if (method instanceof Constructor) { + if (OptionValue.class.isAssignableFrom(holder)) { + return true; + } + } else if (Arrays.asList(boxingTypes).contains(holder)) { + return method.getName().equals("valueOf"); + } else if (method.getDeclaringClass().equals(Class.class)) { + return method.getName().equals("desiredAssertionStatus"); + } + return false; + } + + @Override + public void visitMethodInsn(int opcode, String owner, String methodName, String methodDesc, boolean itf) { + Executable callee = resolveMethod(owner, methodName, methodDesc); + verify(checkInvokeTarget(callee), "invocation of " + callee); + } + }; + } else { + return null; + } + } + } + +} diff -r 483b357016a6 -r 5d589f7383a6 graal/com.oracle.jvmci.options.processor/src/com/oracle/jvmci/options/processor/OptionsVerifier.java --- a/graal/com.oracle.jvmci.options.processor/src/com/oracle/jvmci/options/processor/OptionsVerifier.java Mon Jun 08 20:30:39 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,184 +0,0 @@ -/* - * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved. - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * This code is free software; you can redistribute it and/or modify it - * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. - * - * This code 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 General Public License - * version 2 for more details (a copy is included in the LICENSE file that - * accompanied this code). - * - * You should have received a copy of the GNU General Public License version - * 2 along with this work; if not, write to the Free Software Foundation, - * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. - * - * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA - * or visit www.oracle.com if you need additional information or have any - * questions. - */ -package com.oracle.jvmci.options.processor; - -import static java.lang.String.*; - -import java.io.*; -import java.lang.reflect.*; -import java.util.*; - -import jdk.internal.org.objectweb.asm.*; -import jdk.internal.org.objectweb.asm.Type; - -import com.oracle.jvmci.options.*; - -/** - * A {@link ClassVisitor} that verifies a class declaring one or more {@linkplain OptionValue - * options} has a class initializer that only initializes the option(s). This sanity check mitigates - * the possibility of an option value being used before the code that sets the value (e.g., from the - * command line) has been executed. - */ -final class OptionsVerifier extends ClassVisitor { - - public static void checkClass(Class cls, OptionDescriptor option, Set> checked, JVMCIJars jvmciJars) throws IOException { - if (!checked.contains(cls)) { - checked.add(cls); - Class superclass = cls.getSuperclass(); - if (superclass != null && !superclass.equals(Object.class)) { - checkClass(superclass, option, checked, jvmciJars); - } - - String classFilePath = cls.getName().replace('.', '/') + ".class"; - ClassReader cr = new ClassReader(Objects.requireNonNull(jvmciJars.getInputStream(classFilePath), "Could not find class file for " + cls.getName())); - - ClassVisitor cv = new OptionsVerifier(cls, option); - cr.accept(cv, 0); - } - } - - /** - * The option field context of the verification. - */ - private final OptionDescriptor option; - - /** - * The class in which {@link #option} is declared or a super-class of that class. This is the - * class whose {@code } method is being verified. - */ - private final Class cls; - - /** - * Source file context for error reporting. - */ - String sourceFile = null; - - /** - * Line number for error reporting. - */ - int lineNo = -1; - - final Class[] boxingTypes = {Boolean.class, Byte.class, Short.class, Character.class, Integer.class, Float.class, Long.class, Double.class}; - - private static Class resolve(String name) { - try { - return Class.forName(name.replace('/', '.')); - } catch (ClassNotFoundException e) { - throw new InternalError(e); - } - } - - OptionsVerifier(Class cls, OptionDescriptor desc) { - super(Opcodes.ASM5); - this.cls = cls; - this.option = desc; - } - - @Override - public void visitSource(String source, String debug) { - this.sourceFile = source; - } - - void verify(boolean condition, String message) { - if (!condition) { - error(message); - } - } - - void error(String message) { - String errorMessage = format("%s:%d: Illegal code in %s. which may be executed when %s.%s is initialized:%n%n %s%n%n" + "The recommended solution is to move " + option.getName() + - " into a separate class (e.g., %s.Options).%n", sourceFile, lineNo, cls.getSimpleName(), option.getDeclaringClass().getSimpleName(), option.getName(), message, - option.getDeclaringClass().getSimpleName()); - throw new InternalError(errorMessage); - - } - - @Override - public MethodVisitor visitMethod(int access, String name, String d, String signature, String[] exceptions) { - if (name.equals("")) { - return new MethodVisitor(Opcodes.ASM5) { - - @Override - public void visitLineNumber(int line, Label start) { - lineNo = line; - } - - @Override - public void visitFieldInsn(int opcode, String owner, String fieldName, String fieldDesc) { - if (opcode == Opcodes.PUTFIELD || opcode == Opcodes.PUTSTATIC) { - verify(resolve(owner).equals(option.getDeclaringClass()), format("store to field %s.%s", resolve(owner).getSimpleName(), fieldName)); - verify(opcode != Opcodes.PUTFIELD, format("store to non-static field %s.%s", resolve(owner).getSimpleName(), fieldName)); - } - } - - private Executable resolveMethod(String owner, String methodName, String methodDesc) { - Class declaringClass = resolve(owner); - if (methodName.equals("")) { - for (Constructor c : declaringClass.getDeclaredConstructors()) { - if (methodDesc.equals(Type.getConstructorDescriptor(c))) { - return c; - } - } - } else { - Type[] argumentTypes = Type.getArgumentTypes(methodDesc); - for (Method m : declaringClass.getDeclaredMethods()) { - if (m.getName().equals(methodName)) { - if (Arrays.equals(argumentTypes, Type.getArgumentTypes(m))) { - if (Type.getReturnType(methodDesc).equals(Type.getReturnType(m))) { - return m; - } - } - } - } - } - throw new NoSuchMethodError(declaringClass + "." + methodName + methodDesc); - } - - /** - * Checks whether a given method is allowed to be called. - */ - private boolean checkInvokeTarget(Executable method) { - Class holder = method.getDeclaringClass(); - if (method instanceof Constructor) { - if (OptionValue.class.isAssignableFrom(holder)) { - return true; - } - } else if (Arrays.asList(boxingTypes).contains(holder)) { - return method.getName().equals("valueOf"); - } else if (method.getDeclaringClass().equals(Class.class)) { - return method.getName().equals("desiredAssertionStatus"); - } - return false; - } - - @Override - public void visitMethodInsn(int opcode, String owner, String methodName, String methodDesc, boolean itf) { - Executable callee = resolveMethod(owner, methodName, methodDesc); - verify(checkInvokeTarget(callee), "invocation of " + callee); - } - }; - } else { - return null; - } - } -}