diff --git a/experimental/quasar-hook/src/main/kotlin/net/corda/quasarhook/QuasarInstrumentationHook.kt b/experimental/quasar-hook/src/main/kotlin/net/corda/quasarhook/QuasarInstrumentationHook.kt index c32328ba4a..acd586fa31 100644 --- a/experimental/quasar-hook/src/main/kotlin/net/corda/quasarhook/QuasarInstrumentationHook.kt +++ b/experimental/quasar-hook/src/main/kotlin/net/corda/quasarhook/QuasarInstrumentationHook.kt @@ -32,7 +32,7 @@ fun recordUsedInstrumentedCallStack() { val throwable = Throwable() var index = 0 while (true) { - require (index < throwable.stackTrace.size) { "Can't find getStack call" } + require(index < throwable.stackTrace.size) { "Can't find getStack call" } val stackElement = throwable.stackTrace[index] if (stackElement.className == "co.paralleluniverse.fibers.Stack" && stackElement.methodName == "getStack") { break @@ -129,7 +129,7 @@ class QuasarInstrumentationHookAgent { // The separator append is a hack, it causes a package with an empty name to be added to the exclude tree, // which practically causes that level of the tree to be always expanded in the output globs. val expand = arguments.expand?.let { PackageTree.fromStrings(it.map { "$it${arguments.separator}" }, arguments.separator) } - val truncatedTree = truncate?.let { scannedTree.truncate(it)} ?: scannedTree + val truncatedTree = truncate?.let { scannedTree.truncate(it) } ?: scannedTree val expandedTree = expand?.let { alwaysExcludedTree.merge(it) } ?: alwaysExcludedTree val globs = truncatedTree.toGlobs(expandedTree) globs.forEach { @@ -152,7 +152,7 @@ object QuasarInstrumentationHook : ClassFileTransformer { val instrumentMap = mapOf Unit>( "co/paralleluniverse/fibers/Stack" to { clazz -> // This is called on each suspend, we hook into it to get the stack trace of actually used Suspendables - val getStackMethod = clazz.methods.single { it.name == "getStack" } + val getStackMethod = clazz.methods.single { it.name == "getStack" } getStackMethod.insertBefore( "$hookClassName.${::recordUsedInstrumentedCallStack.name}();" ) @@ -194,7 +194,7 @@ object QuasarInstrumentationHook : ClassFileTransformer { throwable.printStackTrace(System.out) classfileBuffer } - } + } } data class Glob(val parts: List, val isFull: Boolean) { @@ -271,6 +271,7 @@ data class PackageTree(val branches: Map) { val exclude: PackageTree, val globSoFar: List ) + val toExpandList = LinkedList(listOf(State(this, excludeTree, emptyList()))) val globs = ArrayList() while (true) { diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/CandidacyStatus.java b/experimental/sandbox/src/main/java/net/corda/sandbox/CandidacyStatus.java index 7bcaf86684..f0fd4bf668 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/CandidacyStatus.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/CandidacyStatus.java @@ -43,7 +43,6 @@ public class CandidacyStatus { } /** - * * @param signature * @return true if the input was absent from the underlying map */ @@ -52,7 +51,6 @@ public class CandidacyStatus { } /** - * * @param methodSignature * @return true if the input was absent from the underlying map */ @@ -62,7 +60,7 @@ public class CandidacyStatus { /** * Static factory method - * + * * @param startingSet * @return a candidacy status based on the starting set */ @@ -81,7 +79,7 @@ public class CandidacyStatus { /** * Static factory method - * + * * @return a candidacy status based on the starting set */ public static CandidacyStatus of() { @@ -90,8 +88,8 @@ public class CandidacyStatus { /** * Add additional methods that are known to be deterministic - * - * @param methodNames + * + * @param methodNames */ public void addKnownDeterministicMethods(final Set methodNames) { for (String known : methodNames) { @@ -101,7 +99,7 @@ public class CandidacyStatus { /** * Getter method for candidate methods - * + * * @param methodSignature * @return the candidate method corresponding to a method signature */ @@ -149,10 +147,10 @@ public class CandidacyStatus { } /** - * Increases the recursive depth of this classloading process, throwing a + * Increases the recursive depth of this classloading process, throwing a * ClassNotFoundException if it becomes too high - * - * @throws ClassNotFoundException + * + * @throws ClassNotFoundException */ public void incRecursiveCount() throws ClassNotFoundException { if (recursiveDepth >= MAX_CLASSLOADING_RECURSIVE_DEPTH - 1) { @@ -174,7 +172,7 @@ public class CandidacyStatus { out.add(candidateName); } } - + return out; } diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/CandidateMethod.java b/experimental/sandbox/src/main/java/net/corda/sandbox/CandidateMethod.java index 49e5091fbe..b806d58b65 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/CandidateMethod.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/CandidateMethod.java @@ -6,15 +6,14 @@ import java.util.Set; /** * A candidate method that is under evaluation. Candidate methods have one of the following states: - * + *

*

    - *
  • {@link CandidateMethod.State#DETERMINISTIC} - It's deterministic and therefore is allowed to be loaded.
    • - *
  • {@link CandidateMethod.State#DISALLOWED} - It's not deterministic and won't be allowed to be loaded.
    • - *
  • {@link CandidateMethod.State#SCANNED} - We're not sure if it's deterministic or not.
    • + *
  • {@link CandidateMethod.State#DETERMINISTIC} - It's deterministic and therefore is allowed to be loaded.
    • + *
  • {@link CandidateMethod.State#DISALLOWED} - It's not deterministic and won't be allowed to be loaded.
    • + *
  • {@link CandidateMethod.State#SCANNED} - We're not sure if it's deterministic or not.
    • *
- * + *

* CandidateMethods themselves reference other CandidateMethods which are be checked for their deterministic state - * */ public final class CandidateMethod { @@ -43,7 +42,7 @@ public final class CandidateMethod { private final Set referencedCandidateMethods = new HashSet<>(); - + public State getCurrentState() { return currentState; } @@ -59,7 +58,7 @@ public final class CandidateMethod { public void deterministic() { if (currentState == State.DISALLOWED) { - throw new IllegalArgumentException("Method "+ internalMethodName +" attempted to transition from DISALLOWED to DETERMINISTIC"); + throw new IllegalArgumentException("Method " + internalMethodName + " attempted to transition from DISALLOWED to DETERMINISTIC"); } currentState = State.DETERMINISTIC; } @@ -79,7 +78,7 @@ public final class CandidateMethod { public String getInternalMethodName() { return internalMethodName; } - + public void addReferencedCandidateMethod(final CandidateMethod referenceCandidateMethod) { referencedCandidateMethods.add(referenceCandidateMethod); } @@ -94,8 +93,9 @@ public final class CandidateMethod { /** * This factory constructor is only called for methods that are known to be deterministic in advance + * * @param methodSignature - * @return + * @return */ public static CandidateMethod proven(String methodSignature) { final CandidateMethod provenCandidateMethod = new CandidateMethod(methodSignature); diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/SandboxAwareClassWriter.java b/experimental/sandbox/src/main/java/net/corda/sandbox/SandboxAwareClassWriter.java index 03e3cf9d56..f5e742b95c 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/SandboxAwareClassWriter.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/SandboxAwareClassWriter.java @@ -1,11 +1,11 @@ package net.corda.sandbox; import static net.corda.sandbox.Utils.*; + import org.objectweb.asm.ClassReader; import org.objectweb.asm.ClassWriter; /** - * * @author ben */ public final class SandboxAwareClassWriter extends ClassWriter { @@ -25,17 +25,15 @@ public final class SandboxAwareClassWriter extends ClassWriter { * without actually loading any class, or to take into account the class * that is currently being generated by this ClassWriter, which can of * course not be loaded since it is under construction. - * - * @param type1 - * the internal name of a class. - * @param type2 - * the internal name of another class. + * + * @param type1 the internal name of a class. + * @param type2 the internal name of another class. * @return the internal name of the common super class of the two given - * classes. + * classes. */ @Override public String getCommonSuperClass(final String type1, final String type2) { - if (OBJECT.equals(type1) || OBJECT.equals(type2) + if (OBJECT.equals(type1) || OBJECT.equals(type2) || OBJECT.equals(unsandboxNameIfNeedBe(type1)) || OBJECT.equals(unsandboxNameIfNeedBe(type2))) { return OBJECT; } @@ -58,7 +56,7 @@ public final class SandboxAwareClassWriter extends ClassWriter { c = Class.forName(type1.replace('/', '.'), false, loader); d = Class.forName(type2.replace('/', '.'), false, loader); } catch (Exception e) { - + c = Class.forName(unsandboxNameIfNeedBe(type1).replace('/', '.'), false, loader); d = Class.forName(unsandboxNameIfNeedBe(type2).replace('/', '.'), false, loader); diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/SandboxRemapper.java b/experimental/sandbox/src/main/java/net/corda/sandbox/SandboxRemapper.java index 2f55c4edb6..32157b6ff5 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/SandboxRemapper.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/SandboxRemapper.java @@ -3,7 +3,6 @@ package net.corda.sandbox; import org.objectweb.asm.commons.Remapper; /** - * * @author ben */ public final class SandboxRemapper extends Remapper { diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/Utils.java b/experimental/sandbox/src/main/java/net/corda/sandbox/Utils.java index 85fa4fc078..08cbbd794b 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/Utils.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/Utils.java @@ -4,7 +4,6 @@ import java.util.regex.Matcher; import java.util.regex.Pattern; /** - * * @author ben */ public final class Utils { @@ -12,7 +11,7 @@ public final class Utils { public final static String SANDBOX_PREFIX_INTERNAL = "sandbox/"; public final static String CLASSFILE_NAME_SUFFIX = "^(.*)\\.class$"; - + public static final Pattern JAVA_LANG_PATTERN_INTERNAL = Pattern.compile("^java/lang/(.*)"); public static final Pattern SANDBOX_PATTERN_INTERNAL = Pattern.compile("^" + SANDBOX_PREFIX_INTERNAL + "(.*)"); @@ -28,13 +27,13 @@ public final class Utils { public static final Pattern CLASSNAME_PATTERN_QUALIFIED = Pattern.compile("([^\\.]+)\\."); public static final String OBJECT = "java/lang/Object"; - + public static final String THROWABLE = "java/lang/Throwable"; - + public static final String ERROR = "java/lang/Error"; - + public static final String THREAD_DEATH = "java/lang/ThreadDeath"; - + // Hide constructor private Utils() { } @@ -43,6 +42,7 @@ public final class Utils { * Helper method that converts from the internal class name format (as used in the * Constant Pool) to a fully-qualified class name. No obvious library method to do this * appears to exist, hence this code. If one exists, rip this out. + * * @param classInternalName * @return */ @@ -52,12 +52,11 @@ public final class Utils { } /** - * This method takes in an internal method name but needs to return a qualified + * This method takes in an internal method name but needs to return a qualified * classname (suitable for loading) - * - * + * * @param internalMethodName - * @return + * @return */ public static String convertInternalMethodNameToQualifiedClassName(final String internalMethodName) { final Matcher classMatch = CLASSNAME_PATTERN_QUALIFIED.matcher(internalMethodName); @@ -72,6 +71,7 @@ public final class Utils { * Helper method that converts from a fully-qualified class name to the internal class * name format (as used in the Constant Pool). No obvious library method to do this * appears to exist, hence this code. If one exists, rip this out. + * * @param qualifiedClassName * @return */ @@ -81,7 +81,7 @@ public final class Utils { } /** - * This method potentially rewrites the classname. + * This method potentially rewrites the classname. * * @param internalClassname - specified in internal form * @return @@ -102,9 +102,8 @@ public final class Utils { } /** - * * @param qualifiedTypeName - * @return + * @return */ public static String sandboxQualifiedTypeName(final String qualifiedTypeName) { final String internal = convertQualifiedClassNameToInternalForm(qualifiedTypeName); @@ -118,7 +117,7 @@ public final class Utils { /** * This method removes the sandboxing prefix from a method or type name, if it has * one, otherwise it returns the input string. - * + * * @param internalClassname * @return the internal classname, unsandboxed if that was required */ @@ -131,7 +130,6 @@ public final class Utils { } /** - * * @param desc - internal * @return the rewritten desc string */ @@ -169,9 +167,9 @@ public final class Utils { * loading. This should not attempt to load a classname that starts with java. as * the only permissable classes have already been transformed into sandboxed * methods - * + * * @param qualifiedClassName - * @return + * @return */ public static boolean shouldAttemptToTransitivelyLoad(final String qualifiedClassName) { return !JAVA_PATTERN_QUALIFIED.asPredicate().test(qualifiedClassName); @@ -179,7 +177,7 @@ public final class Utils { /** * Helper method that determines whether this class requires sandboxing - * + * * @param clazzName - specified in internal form * @return true if the class should be sandboxed */ diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/WhitelistClassLoader.java b/experimental/sandbox/src/main/java/net/corda/sandbox/WhitelistClassLoader.java index 171c2770f9..2a99ffbdca 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/WhitelistClassLoader.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/WhitelistClassLoader.java @@ -2,6 +2,7 @@ package net.corda.sandbox; import net.corda.sandbox.visitors.CostInstrumentingMethodVisitor; import net.corda.sandbox.visitors.WhitelistCheckingClassVisitor; + import java.io.IOException; import java.io.InputStream; import java.net.URI; @@ -9,13 +10,13 @@ import java.net.URISyntaxException; import java.net.URL; import java.nio.file.*; import java.util.*; + import org.objectweb.asm.*; import org.objectweb.asm.commons.ClassRemapper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * * @author ben */ public final class WhitelistClassLoader extends ClassLoader { @@ -61,8 +62,8 @@ public final class WhitelistClassLoader extends ClassLoader { } /** - * Static factory method. Throws URISyntaxException currently, as this method is - * called with user data, so a checked exception is not unreasonable. Could use a + * Static factory method. Throws URISyntaxException currently, as this method is + * called with user data, so a checked exception is not unreasonable. Could use a * runtime exception instead. * * @param auxiliaryClassPath @@ -70,7 +71,7 @@ public final class WhitelistClassLoader extends ClassLoader { * methods to be deterministic, instead the classloader * will remove all non-deterministic methods. * @return a suitably constructed whitelisting classloader - * @throws URISyntaxException + * @throws URISyntaxException */ public static WhitelistClassLoader of(final String auxiliaryClassPath, final boolean stripNonDeterministic) throws URISyntaxException { final WhitelistClassLoader out = new WhitelistClassLoader(stripNonDeterministic); @@ -96,10 +97,10 @@ public final class WhitelistClassLoader extends ClassLoader { /** * Static factory method. Used for recursive classloading - * + * * @param other * @return a suitably constructed whitelisting classloader based on the state - * of the passed classloader + * of the passed classloader */ public static WhitelistClassLoader of(final WhitelistClassLoader other) { final WhitelistClassLoader out = new WhitelistClassLoader(other); @@ -110,7 +111,7 @@ public final class WhitelistClassLoader extends ClassLoader { /** * Helper method that adds a jar to the path to be searched * - * @param knownGoodJar + * @param knownGoodJar */ void addJarToSandbox(final Path knownGoodJar) { fileSystemSearchPath.add(knownGoodJar); @@ -120,9 +121,9 @@ public final class WhitelistClassLoader extends ClassLoader { * Setup the auxiliary classpath so that classes that are not on the original * classpath can be scanned for. * Note that this this method hardcodes Unix conventions, so won't work on e.g. Windows - * + * * @param auxiliaryClassPath - * @throws URISyntaxException + * @throws URISyntaxException */ void setupClasspath(final String auxiliaryClassPath) throws URISyntaxException { for (String entry : auxiliaryClassPath.split(":")) { @@ -136,11 +137,10 @@ public final class WhitelistClassLoader extends ClassLoader { } /** - * * @param qualifiedClassName * @return a class object that has been whitelist checked and is known to be - * deterministic - * @throws ClassNotFoundException + * deterministic + * @throws ClassNotFoundException */ @Override public Class findClass(final String qualifiedClassName) throws ClassNotFoundException { @@ -244,10 +244,10 @@ public final class WhitelistClassLoader extends ClassLoader { * around a limitation of the ASM library that does not integrate cleanly with Java 7 * NIO.2 Path APIs. This method also performs a couple of basic sanity check on the * class file (e.g. that it exists, is a regular file and is readable). - * + * * @param internalClassName * @return a path object that corresponds to a class that has been found - * @throws ClassNotFoundException + * @throws ClassNotFoundException */ Path locateClassfileDir(final String internalClassName) throws ClassNotFoundException { // Check the primaryClasspathSearchPath @@ -300,7 +300,7 @@ public final class WhitelistClassLoader extends ClassLoader { /** * Creates a jar archive of all the transformed classes that this classloader * has loaded. - * + * * @return true on success, false on failure * @throws java.io.IOException * @throws java.net.URISyntaxException @@ -328,7 +328,8 @@ public final class WhitelistClassLoader extends ClassLoader { /** * Getter method for the reason for failure - * @return + * + * @return */ public WhitelistClassloadingException reason() { return candidacyStatus.getReason(); @@ -336,7 +337,8 @@ public final class WhitelistClassLoader extends ClassLoader { /** * Getter method for the method candidacy status - * @return + * + * @return */ public CandidacyStatus getCandidacyStatus() { return candidacyStatus; diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/WhitelistClassloadingException.java b/experimental/sandbox/src/main/java/net/corda/sandbox/WhitelistClassloadingException.java index 5f6c13ca9f..9705d4bf0e 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/WhitelistClassloadingException.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/WhitelistClassloadingException.java @@ -4,7 +4,7 @@ package net.corda.sandbox; * */ public class WhitelistClassloadingException extends Exception { - + public WhitelistClassloadingException() { super(); } @@ -22,10 +22,10 @@ public class WhitelistClassloadingException extends Exception { } protected WhitelistClassloadingException(String message, Throwable cause, - boolean enableSuppression, - boolean writableStackTrace) { + boolean enableSuppression, + boolean writableStackTrace) { super(message, cause, enableSuppression, writableStackTrace); } - + } diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/costing/Contract.java b/experimental/sandbox/src/main/java/net/corda/sandbox/costing/Contract.java index ec098ecfbd..f20aaa0b79 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/costing/Contract.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/costing/Contract.java @@ -5,7 +5,7 @@ import org.slf4j.LoggerFactory; /** * This class is the runtime representation of a running contract. - * + * * @author ben */ public class Contract { diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/costing/ContractExecutor.java b/experimental/sandbox/src/main/java/net/corda/sandbox/costing/ContractExecutor.java index 243a3ddf11..5b719978a4 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/costing/ContractExecutor.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/costing/ContractExecutor.java @@ -3,17 +3,17 @@ package net.corda.sandbox.costing; /** * This interface is to decouple the actual executable code from the entry point and * how vetted deterministic code will be used inside the sandbox - * + * * @author ben */ public interface ContractExecutor { /** * Executes a smart contract - * + * * @param contract the contract to be executed */ void execute(Contract contract); - + /** * Checks to see if the supplied Contract is suitable * diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/costing/RuntimeCostAccounter.java b/experimental/sandbox/src/main/java/net/corda/sandbox/costing/RuntimeCostAccounter.java index f00c39defa..7274d914c7 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/costing/RuntimeCostAccounter.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/costing/RuntimeCostAccounter.java @@ -4,7 +4,6 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * * @author ben */ public class RuntimeCostAccounter { diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/tools/SandboxCreator.java b/experimental/sandbox/src/main/java/net/corda/sandbox/tools/SandboxCreator.java index 01b0906dc2..33ab308a2e 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/tools/SandboxCreator.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/tools/SandboxCreator.java @@ -2,6 +2,7 @@ package net.corda.sandbox.tools; import net.corda.sandbox.WhitelistClassLoader; import net.corda.sandbox.visitors.SandboxPathVisitor; + import java.io.FileInputStream; import java.io.IOException; import java.net.URISyntaxException; @@ -18,7 +19,6 @@ import joptsimple.OptionSet; * This class takes in an exploded set of JRE classes, and a whitelist, and rewrites all * classes (note: not methods) that have at least one whitelisted method to create a * sandboxed version of the class. - * */ // java8.scan.java.lang_and_util java8.interfaces_for_compat java8 sandbox public final class SandboxCreator { @@ -30,7 +30,7 @@ public final class SandboxCreator { private final String outputJarName; private final WhitelistClassLoader wlcl; private final boolean hasInputJar; - + private final static OptionParser parser = new OptionParser(); private static void usage() { @@ -53,7 +53,7 @@ public final class SandboxCreator { static String unpackJar(final String zipFilePath) throws IOException { final Path tmpDir = Files.createTempDirectory(Paths.get("/tmp"), "wlcl-extract"); - + try (final ZipInputStream zipIn = new ZipInputStream(new FileInputStream(zipFilePath))) { ZipEntry entry = zipIn.getNextEntry(); @@ -68,13 +68,13 @@ public final class SandboxCreator { entry = zipIn.getNextEntry(); } } - + return tmpDir.toString(); } - + void cleanup() { if (hasInputJar) { - + } } @@ -107,10 +107,9 @@ public final class SandboxCreator { } /** - * * @param basePath * @param packageName - * @throws IOException + * @throws IOException */ void walk() throws IOException { final Path scanDir = Paths.get(basePathName); diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/CostInstrumentingMethodVisitor.java b/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/CostInstrumentingMethodVisitor.java index 5f7dc3fdea..8b108fed89 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/CostInstrumentingMethodVisitor.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/CostInstrumentingMethodVisitor.java @@ -9,7 +9,6 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * * @author ben */ public final class CostInstrumentingMethodVisitor extends GeneratorAdapter { @@ -34,9 +33,10 @@ public final class CostInstrumentingMethodVisitor extends GeneratorAdapter { } /** - * This method replaces MONITORENTER / MONITOREXIT opcodes with POP - basically + * This method replaces MONITORENTER / MONITOREXIT opcodes with POP - basically * stripping the synchronization out of any sandboxed code. - * @param opcode + * + * @param opcode */ @Override public void visitInsn(final int opcode) { @@ -60,7 +60,7 @@ public final class CostInstrumentingMethodVisitor extends GeneratorAdapter { * For our purposes this is a NEWARRAY opcode. * * @param opcode - * @param operand + * @param operand */ @Override public void visitIntInsn(final int opcode, final int operand) { @@ -103,11 +103,11 @@ public final class CostInstrumentingMethodVisitor extends GeneratorAdapter { /** * This method is called when visiting an opcode with a single operand, that * is a type (represented here as a String). - * + *

* For our purposes this is either a NEW opcode or a ANEWARRAY * - * @param opcode - * @param type + * @param opcode + * @param type */ @Override public void visitTypeInsn(final int opcode, final String type) { diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/DefinitelyDisallowedMethodVisitor.java b/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/DefinitelyDisallowedMethodVisitor.java index 62b882f269..d4ade3415a 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/DefinitelyDisallowedMethodVisitor.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/DefinitelyDisallowedMethodVisitor.java @@ -11,5 +11,5 @@ class DefinitelyDisallowedMethodVisitor extends MethodVisitor { DefinitelyDisallowedMethodVisitor(MethodVisitor baseMethodVisitor) { super(Opcodes.ASM5, baseMethodVisitor); } - + } diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/SandboxPathVisitor.java b/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/SandboxPathVisitor.java index bdc81bf995..e5528acbd9 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/SandboxPathVisitor.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/SandboxPathVisitor.java @@ -2,15 +2,17 @@ package net.corda.sandbox.visitors; import net.corda.sandbox.Utils; import net.corda.sandbox.WhitelistClassLoader; + import java.nio.file.*; import java.nio.file.attribute.BasicFileAttributes; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * This helper class visits each file (represented as a Path) in some directory * tree containing classes to be sandboxed. - * + * * @author ben */ public final class SandboxPathVisitor extends SimpleFileVisitor { @@ -30,10 +32,10 @@ public final class SandboxPathVisitor extends SimpleFileVisitor { public FileVisitResult visitFile(final Path path, final BasicFileAttributes attr) { // Check that this is a class file if (!path.toString().matches(Utils.CLASSFILE_NAME_SUFFIX)) { - System.out.println("Skipping: "+ path); + System.out.println("Skipping: " + path); return FileVisitResult.CONTINUE; } - + // Check to see if this path corresponds to an allowedClass final String classFileName = startFrom.relativize(path).toString().replace(".class", ""); diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/WhitelistCheckingClassVisitor.java b/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/WhitelistCheckingClassVisitor.java index 5994b445a6..534c89bc6b 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/WhitelistCheckingClassVisitor.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/WhitelistCheckingClassVisitor.java @@ -2,10 +2,12 @@ package net.corda.sandbox.visitors; import net.corda.sandbox.WhitelistClassLoader; import net.corda.sandbox.CandidacyStatus; + import java.util.Arrays; import net.corda.sandbox.CandidateMethod; import net.corda.sandbox.Utils; + import java.util.HashSet; import java.util.Set; @@ -14,6 +16,7 @@ import org.objectweb.asm.MethodVisitor; import org.objectweb.asm.Opcodes; import org.slf4j.Logger; import org.slf4j.LoggerFactory; + import static org.objectweb.asm.Opcodes.*; /** @@ -57,7 +60,7 @@ public final class WhitelistCheckingClassVisitor extends ClassVisitor { /** * We initially take the method passed in and store an internal representation of * the method signature in the our CandidacyStatus working set. - * + *

* We then get an ASM MethodVisitor (which can read the byte code of the method) and pass that to our * custom method visitor which perform additional checks. * @@ -66,7 +69,7 @@ public final class WhitelistCheckingClassVisitor extends ClassVisitor { * @param desc * @param signature * @param exceptions - * @return + * @return */ @Override public MethodVisitor visitMethod(final int access, final String name, final String desc, final String signature, final String[] exceptions) { @@ -77,7 +80,7 @@ public final class WhitelistCheckingClassVisitor extends ClassVisitor { // Force new access control flags - for now just strictfp for deterministic // compliance to IEEE 754 final int maskedAccess = access | ACC_STRICT; - + final String internalName = classname + "." + name + ":" + desc; internalMethodNames.add(internalName); candidacyStatus.putIfAbsent(internalName); @@ -151,10 +154,10 @@ public final class WhitelistCheckingClassVisitor extends ClassVisitor { } /** - * Take the name of a class and attempts to load it using a WLCL. - * + * Take the name of a class and attempts to load it using a WLCL. + * * @param qualifiedClassname - * @return + * @return */ CandidateMethod.State resolveState(final String qualifiedClassname) { Class clz = null; diff --git a/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/WhitelistCheckingMethodVisitor.java b/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/WhitelistCheckingMethodVisitor.java index 28338f5285..0d392f342b 100644 --- a/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/WhitelistCheckingMethodVisitor.java +++ b/experimental/sandbox/src/main/java/net/corda/sandbox/visitors/WhitelistCheckingMethodVisitor.java @@ -13,7 +13,6 @@ import org.objectweb.asm.Label; /** * A MethodVisitor which checks method instructions in order to determine if this * method is deterministic or not - * */ final class WhitelistCheckingMethodVisitor extends MethodVisitor { @@ -29,7 +28,7 @@ final class WhitelistCheckingMethodVisitor extends MethodVisitor { } /** - * Visits a method instruction. A method instruction is an instruction that + * Visits a method instruction. A method instruction is an instruction that * invokes a method. *

* Some method instructions are by their nature un-deterministic, so we set those methods to have a @@ -84,15 +83,15 @@ final class WhitelistCheckingMethodVisitor extends MethodVisitor { } /** - * Currently a no-op. - * + * Currently a no-op. + *

* The JVMspec seems to permit the possibility of using a backwards branch in a - * tableswitch to try to create an infinite loop. However, it seems to be + * tableswitch to try to create an infinite loop. However, it seems to be * impossible in practice - the specification of StackMapFrame seems to prevent * it in modern classfile formats, and even by explicitly generating a version * 49 (Java 5) classfile, the verifier seems to be specifically resistant to a - * backwards branch from a tableswitch. - * + * backwards branch from a tableswitch. + *

* We could still add a belt-and-braces static instrumentation to protect * against this but it currently seems unnecessary - at worse it is a branch that * should count against the branch limit, or an explicit disallow of a backwards @@ -102,7 +101,7 @@ final class WhitelistCheckingMethodVisitor extends MethodVisitor { * @param min * @param max * @param dflt - * @param labels + * @param labels */ @Override public void visitTableSwitchInsn(int min, int max, Label dflt, Label... labels) { @@ -112,11 +111,11 @@ final class WhitelistCheckingMethodVisitor extends MethodVisitor { /** * Visits an invokedynamic instruction - which is specifically disallowed for * deterministic apps. - * + * * @param name * @param desc * @param bsm - * @param bsmArgs + * @param bsmArgs */ @Override public void visitInvokeDynamicInsn(final String name, final String desc, final Handle bsm, final Object... bsmArgs) { diff --git a/experimental/sandbox/src/main/java/sandbox/net/corda/sandbox/costing/RuntimeCostAccounter.java b/experimental/sandbox/src/main/java/sandbox/net/corda/sandbox/costing/RuntimeCostAccounter.java index 7acc1f445d..22e895c41b 100644 --- a/experimental/sandbox/src/main/java/sandbox/net/corda/sandbox/costing/RuntimeCostAccounter.java +++ b/experimental/sandbox/src/main/java/sandbox/net/corda/sandbox/costing/RuntimeCostAccounter.java @@ -4,7 +4,7 @@ package sandbox.net.corda.sandbox.costing; * A helper class that just forwards any static sandboxed calls to the real runtime * cost accounting class. This removes the need to special case the accounting * method calls during rewriting of method names - * + * * @author ben */ public class RuntimeCostAccounter { diff --git a/experimental/sandbox/src/test/java/net/corda/sandbox/TestUtils.java b/experimental/sandbox/src/test/java/net/corda/sandbox/TestUtils.java index d8e0fd0007..16cbda6e84 100644 --- a/experimental/sandbox/src/test/java/net/corda/sandbox/TestUtils.java +++ b/experimental/sandbox/src/test/java/net/corda/sandbox/TestUtils.java @@ -22,7 +22,7 @@ public class TestUtils { // Copy resource jar to tmp dir tmpdir = Files.createTempDirectory("wlcl-tmp-test"); Path copiedJar = tmpdir.resolve("tmp-resource.jar"); - try(final InputStream in = TestUtils.class.getResourceAsStream(resourcePathToJar)) { + try (final InputStream in = TestUtils.class.getResourceAsStream(resourcePathToJar)) { Files.copy(in, copiedJar, StandardCopyOption.REPLACE_EXISTING); } final FileSystem fs = FileSystems.newFileSystem(copiedJar, null); @@ -33,20 +33,20 @@ public class TestUtils { public static Path copySandboxJarToTmpDir(final String resourcePathToJar) throws IOException { Path sandboxJar = tmpdir.resolve("tmp-sandbox.jar"); - try(final InputStream in = TestUtils.class.getResourceAsStream(resourcePathToJar)) { + try (final InputStream in = TestUtils.class.getResourceAsStream(resourcePathToJar)) { Files.copy(in, sandboxJar, StandardCopyOption.REPLACE_EXISTING); } final FileSystem sandboxFs = FileSystems.newFileSystem(sandboxJar, null); tmpFileSystems.add(sandboxFs); return sandboxFs.getRootDirectories().iterator().next(); } - + public static Path getJarFSRoot() { return jarFSDir; } public static void cleanupTmpJar() throws IOException { - for (FileSystem fs: tmpFileSystems) { + for (FileSystem fs : tmpFileSystems) { fs.close(); } tmpFileSystems.clear(); @@ -92,15 +92,15 @@ public class TestUtils { // Helper for finding the correct offsets if they change public static void printBytes(byte[] data) { byte[] datum = new byte[1]; - for (int i=0; i < data.length; i++) { + for (int i = 0; i < data.length; i++) { datum[0] = data[i]; - System.out.println(i +" : "+ DatatypeConverter.printHexBinary(datum)); + System.out.println(i + " : " + DatatypeConverter.printHexBinary(datum)); } } public static int findOffset(byte[] classBytes, byte[] originalSeq) { int offset = 0; - for (int i=415; i < classBytes.length; i++) { + for (int i = 415; i < classBytes.length; i++) { if (classBytes[i] != originalSeq[offset]) { offset = 0; continue; @@ -110,7 +110,7 @@ public class TestUtils { } offset++; } - + return -1; } @@ -119,7 +119,7 @@ public class TestUtils { return wlcl.instrumentWithCosts(basic, hashSet); } - + public static final class MyClassloader extends ClassLoader { public Class byPath(Path p) throws IOException { diff --git a/experimental/sandbox/src/test/java/net/corda/sandbox/WhitelistClassLoaderTest.java b/experimental/sandbox/src/test/java/net/corda/sandbox/WhitelistClassLoaderTest.java index 91d455b0d2..bcc5e94172 100644 --- a/experimental/sandbox/src/test/java/net/corda/sandbox/WhitelistClassLoaderTest.java +++ b/experimental/sandbox/src/test/java/net/corda/sandbox/WhitelistClassLoaderTest.java @@ -1,10 +1,13 @@ package net.corda.sandbox; import static org.junit.Assert.*; + import org.junit.Test; + import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.util.concurrent.atomic.AtomicBoolean; + import org.junit.*; public class WhitelistClassLoaderTest { @@ -123,8 +126,8 @@ public class WhitelistClassLoaderTest { final Class clz = wlcl.loadClass("resource.ThrowExceptions"); assertNotNull("ThrowExceptions class could not be transformed and loaded", clz); } - - + + // TODO Test cases that terminate when other resource limits are broken @Test public void when_too_much_memory_is_allocated_then_thread_dies() throws Exception { diff --git a/experimental/sandbox/src/test/java/net/corda/sandbox/costing/DeterministicClassInstrumenterTest.java b/experimental/sandbox/src/test/java/net/corda/sandbox/costing/DeterministicClassInstrumenterTest.java index c276907870..15130086d3 100644 --- a/experimental/sandbox/src/test/java/net/corda/sandbox/costing/DeterministicClassInstrumenterTest.java +++ b/experimental/sandbox/src/test/java/net/corda/sandbox/costing/DeterministicClassInstrumenterTest.java @@ -11,7 +11,6 @@ import java.util.*; import static org.junit.Assert.*; /** - * * @author ben */ public class DeterministicClassInstrumenterTest { @@ -66,7 +65,7 @@ public class DeterministicClassInstrumenterTest { // TestUtils.printBytes(basic); final int origOffset = TestUtils.findOffset(basic, originalSeq); final int tmfdOffset = TestUtils.findOffset(tfmd, tfmdSeq); - + for (int i = 0; i < originalSeq.length; i++) { assertEquals(originalSeq[i], basic[origOffset + i]); assertEquals(tfmdSeq[i], tfmd[tmfdOffset + i]); diff --git a/experimental/sandbox/src/test/java/net/corda/sandbox/costing/SandboxedRewritingTest.java b/experimental/sandbox/src/test/java/net/corda/sandbox/costing/SandboxedRewritingTest.java index 15bd7dafe2..16b3972390 100644 --- a/experimental/sandbox/src/test/java/net/corda/sandbox/costing/SandboxedRewritingTest.java +++ b/experimental/sandbox/src/test/java/net/corda/sandbox/costing/SandboxedRewritingTest.java @@ -1,19 +1,24 @@ package net.corda.sandbox.costing; import net.corda.sandbox.TestUtils; + import static net.corda.sandbox.TestUtils.*; + import net.corda.sandbox.Utils; + import java.io.IOException; import java.lang.reflect.Method; import java.net.URISyntaxException; + import org.junit.AfterClass; import org.junit.Test; + import static org.junit.Assert.*; + import org.junit.Before; import org.junit.BeforeClass; /** - * * @author ben */ public class SandboxedRewritingTest { diff --git a/experimental/sandbox/src/test/java/sandbox/greymalkin/StringReturner.java b/experimental/sandbox/src/test/java/sandbox/greymalkin/StringReturner.java index e0aee3b576..d34132570e 100644 --- a/experimental/sandbox/src/test/java/sandbox/greymalkin/StringReturner.java +++ b/experimental/sandbox/src/test/java/sandbox/greymalkin/StringReturner.java @@ -1,7 +1,6 @@ package sandbox.greymalkin; /** - * * @author ben */ // Simple hack for now, generalise to lambdas later...