diff --git a/build.gradle.kts b/build.gradle.kts index 2b92afd..8f5152a 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,5 +1,6 @@ plugins { id("java") + id("io.freefair.lombok") version "9.1.0" } group = "org.example" @@ -10,10 +11,10 @@ repositories { } dependencies { - implementation("org.ow2.asm:asm:9.5") - implementation("org.ow2.asm:asm-tree:9.5") - implementation("org.ow2.asm:asm-analysis:9.5") - implementation("org.ow2.asm:asm-util:9.5") + implementation("org.ow2.asm:asm:9.7.1") + implementation("org.ow2.asm:asm-tree:9.7.1") + implementation("org.ow2.asm:asm-analysis:9.7.1") + implementation("org.ow2.asm:asm-util:9.7.1") testImplementation(platform("org.junit:junit-bom:5.10.0")) testImplementation("org.junit.jupiter:junit-jupiter") @@ -22,4 +23,4 @@ dependencies { tasks.test { useJUnitPlatform() -} \ No newline at end of file +} diff --git a/gradlew b/gradlew old mode 100644 new mode 100755 diff --git a/results/fescar.txt b/results/fescar.txt new file mode 100644 index 0000000..467d030 --- /dev/null +++ b/results/fescar.txt @@ -0,0 +1,8 @@ +{ + "maxInheritanceDepth": 5, + "averageInheritanceDepth": 1.44, + "abc": 7463.05, + "averageOverriddenMethodsNumber": 0.28, + "averageFieldsNumber": 2.61 +} + diff --git a/results/guava.txt b/results/guava.txt new file mode 100644 index 0000000..ba42b25 --- /dev/null +++ b/results/guava.txt @@ -0,0 +1,8 @@ +{ + "maxInheritanceDepth": 7, + "averageInheritanceDepth": 1.81, + "abc": 189362.57, + "averageOverriddenMethodsNumber": 0.87, + "averageFieldsNumber": 1.75 +} + diff --git a/results/sample.txt b/results/sample.txt new file mode 100644 index 0000000..d048d95 --- /dev/null +++ b/results/sample.txt @@ -0,0 +1,8 @@ +{ + "maxInheritanceDepth": 2, + "averageInheritanceDepth": 1.50, + "abc": 29.48, + "averageOverriddenMethodsNumber": 0.00, + "averageFieldsNumber": 0.70 +} + diff --git a/src/main/java/org/example/Example.java b/src/main/java/org/example/Example.java deleted file mode 100644 index 52d0abe..0000000 --- a/src/main/java/org/example/Example.java +++ /dev/null @@ -1,29 +0,0 @@ -package org.example; - -import org.example.visitor.ClassPrinter; -import org.objectweb.asm.ClassReader; - -import java.io.IOException; -import java.util.Enumeration; -import java.util.jar.JarEntry; -import java.util.jar.JarFile; - -public class Example { - - public static void main(String[] args) throws IOException { -// var printer = new ByteCodePrinter(); -// printer.printBubbleSortBytecode(); - try (JarFile sampleJar = new JarFile("src/main/resources/sample.jar")) { - Enumeration enumeration = sampleJar.entries(); - - while (enumeration.hasMoreElements()) { - JarEntry entry = enumeration.nextElement(); - if (entry.getName().endsWith(".class")) { - ClassPrinter cp = new ClassPrinter(); - ClassReader cr = new ClassReader(sampleJar.getInputStream(entry)); - cr.accept(cp, 0); - } - } - } - } -} diff --git a/src/main/java/org/example/Main.java b/src/main/java/org/example/Main.java new file mode 100644 index 0000000..3fe7399 --- /dev/null +++ b/src/main/java/org/example/Main.java @@ -0,0 +1,43 @@ +package org.example; + +import org.example.metrics.ClassMetrics; +import org.example.metrics.TotalMetrics; +import org.example.visitor.ClassMetricsVisitor; +import org.objectweb.asm.ClassReader; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Enumeration; +import java.util.List; +import java.util.jar.JarEntry; +import java.util.jar.JarFile; + +public class Main { + + public static void main(String[] args) throws IOException { + if (args.length != 2) { + System.out.println("Expected args: "); + } + + var jarPath = args[0]; + var destinationFilePath = args[1]; + + TotalMetrics totalMetrics = new TotalMetrics(); + + try (JarFile sampleJar = new JarFile(jarPath)) { + Enumeration enumeration = sampleJar.entries(); + + while (enumeration.hasMoreElements()) { + JarEntry entry = enumeration.nextElement(); + if (entry.getName().endsWith(".class")) { + ClassReader cr = new ClassReader(sampleJar.getInputStream(entry)); + ClassMetricsVisitor cmv = new ClassMetricsVisitor(); + cr.accept(cmv, 0); + totalMetrics.addClassMetrics(cmv.getClassMetrics()); + } + } + } + + totalMetrics.print(destinationFilePath); + } +} diff --git a/src/main/java/org/example/example/BubbleSort.java b/src/main/java/org/example/example/BubbleSort.java deleted file mode 100644 index 8a21c95..0000000 --- a/src/main/java/org/example/example/BubbleSort.java +++ /dev/null @@ -1,29 +0,0 @@ -package org.example.example; - -public class BubbleSort { - - static void bubbleSort(int[] arr, int n) - { - int i, j, temp; - boolean swapped; - for (i = 0; i < n - 1; i++) { - swapped = false; - for (j = 0; j < n - i - 1; j++) { - if (arr[j] > arr[j + 1]) { - - // Swap arr[j] and arr[j+1] - temp = arr[j]; - arr[j] = arr[j + 1]; - arr[j + 1] = temp; - swapped = true; - } - } - - // If no two elements were - // swapped by inner loop, then break - if (!swapped) - break; - } - } - -} diff --git a/src/main/java/org/example/metrics/ClassMetrics.java b/src/main/java/org/example/metrics/ClassMetrics.java new file mode 100644 index 0000000..793f71e --- /dev/null +++ b/src/main/java/org/example/metrics/ClassMetrics.java @@ -0,0 +1,29 @@ +package org.example.metrics; + +import lombok.Getter; +import lombok.Setter; + +import java.util.ArrayList; +import java.util.List; + +@Getter +public class ClassMetrics { + + private final List methodMetricsList = new ArrayList<>(); + + private long fields; + + @Setter + private String name; + @Setter + private String superName; + + public void addMethod(MethodMetrics methodMetrics) { + methodMetricsList.add(methodMetrics); + } + + public void incFields() { + fields++; + } + +} diff --git a/src/main/java/org/example/metrics/MethodMetrics.java b/src/main/java/org/example/metrics/MethodMetrics.java new file mode 100644 index 0000000..feb1505 --- /dev/null +++ b/src/main/java/org/example/metrics/MethodMetrics.java @@ -0,0 +1,33 @@ +package org.example.metrics; + +import lombok.Getter; +import lombok.Setter; + +@Getter +public class MethodMetrics { + + private long assignments; + private long branches; + private long conditions; + + @Setter + private String name; + @Setter + private String descriptor; + + public void incAssignments() { + assignments++; + } + + public void incBranches() { + branches++; + } + + public void incConditions() { + conditions++; + } + + public void incConditions(long amount) { + conditions += amount; + } +} diff --git a/src/main/java/org/example/metrics/TotalMetrics.java b/src/main/java/org/example/metrics/TotalMetrics.java new file mode 100644 index 0000000..cdb7660 --- /dev/null +++ b/src/main/java/org/example/metrics/TotalMetrics.java @@ -0,0 +1,171 @@ +package org.example.metrics; + +import java.io.FileWriter; +import java.io.IOException; +import java.io.PrintWriter; +import java.util.*; +import java.util.stream.Collectors; + +public class TotalMetrics { + + private final List classesMetrics = new ArrayList<>(); + + public void addClassMetrics(ClassMetrics classMetrics) { + classesMetrics.add(classMetrics); + } + + public void print(String destinationFile) throws IOException { + var classToSuper = getClassToSuper(); + var classToItsMethodSignatures = getClassToItsMethodDescriptors(); + + int maxInheritanceDepth = getMaxInheritanceDepth(classToSuper); + double avgInheritanceDepth = getAvgInheritanceDepth(classToSuper); + double abc = getAbcMetric(); + double avgOverriddenMethods = getAvgOverriddenMethods(classToSuper, classToItsMethodSignatures); + double avgFields = getAvgFields(); + + String json = """ + { + "maxInheritanceDepth": %d, + "averageInheritanceDepth": %.2f, + "abc": %.2f, + "averageOverriddenMethodsNumber": %.2f, + "averageFieldsNumber": %.2f + } + """.formatted( + maxInheritanceDepth, + avgInheritanceDepth, + abc, + avgOverriddenMethods, + avgFields + ); + + System.out.println(json); + + try (PrintWriter writer = new PrintWriter(new FileWriter(destinationFile))) { + writer.println(json); + } + } + + private Map getClassToSuper() { + Map classToSuper = new HashMap<>(); + for (ClassMetrics cm : classesMetrics) { + classToSuper.put(cm.getName(), cm.getSuperName()); + } + return classToSuper; + } + + private Map> getClassToItsMethodDescriptors() { + Map> classToMethods = new HashMap<>(); + for (ClassMetrics cm : classesMetrics) { + String className = cm.getName(); + Set methodSignatures = cm.getMethodMetricsList().stream() + .filter(m -> !m.getName().equals("") && !m.getName().equals("")) + .map(m -> m.getName() + m.getDescriptor()) + .collect(Collectors.toSet()); + classToMethods.put(className, methodSignatures); + } + return classToMethods; + } + + private int getMaxInheritanceDepth(Map classToSuper) { + int maxDepth = 0; + for (String className : classToSuper.keySet()) { + int depth = calculateInheritanceDepth(className, classToSuper); + maxDepth = Math.max(maxDepth, depth); + } + return maxDepth; + } + + private double getAvgInheritanceDepth(Map classToSuper) { + if (classToSuper.isEmpty()) { + return 0.0; + } + List depths = new ArrayList<>(); + for (String className : classToSuper.keySet()) { + depths.add(calculateInheritanceDepth(className, classToSuper)); + } + return depths.stream() + .mapToInt(Integer::intValue) + .average() + .orElse(0.0); + } + + private int calculateInheritanceDepth(String className, Map classToSuper) { + int depth = 0; + String current = className; + while (true) { + String parent = classToSuper.get(current); + if (parent == null) { + break; + } + depth++; + current = parent; + } + return depth; + } + + private double getAbcMetric() { + long totalAssignments = 0; + long totalBranches = 0; + long totalConditions = 0; + + for (ClassMetrics cm : classesMetrics) { + for (MethodMetrics mm : cm.getMethodMetricsList()) { + totalAssignments += mm.getAssignments(); + totalBranches += mm.getBranches(); + totalConditions += mm.getConditions(); + } + } + + // ABC = sqrt(A^2 + B^2 + C^2) + return Math.sqrt( + totalAssignments * totalAssignments + + totalBranches * totalBranches + + totalConditions * totalConditions + ); + } + + private double getAvgOverriddenMethods(Map classToSuper, Map> classToMethods) { + if (classesMetrics.isEmpty()) { + return 0.0; + } + + int totalOverridden = 0; + + for (ClassMetrics cm : classesMetrics) { + String className = cm.getName(); + Set currentMethods = classToMethods.get(className); + if (currentMethods == null || currentMethods.isEmpty()) { + continue; + } + + Set parentMethods = new HashSet<>(); + String parent = classToSuper.get(className); + + while (parent != null) { + Set parentMethodSet = classToMethods.get(parent); + if (parentMethodSet != null) { + parentMethods.addAll(parentMethodSet); + } + parent = classToSuper.get(parent); + } + + Set overridden = new HashSet<>(currentMethods); + overridden.retainAll(parentMethods); + totalOverridden += overridden.size(); + } + + return (double) totalOverridden / classesMetrics.size(); + } + + private double getAvgFields() { + if (classesMetrics.isEmpty()) { + return 0.0; + } + long totalFields = classesMetrics.stream() + .mapToLong(ClassMetrics::getFields) + .sum(); + return (double) totalFields / classesMetrics.size(); + } +} diff --git a/src/main/java/org/example/util/ByteCodePrinter.java b/src/main/java/org/example/util/ByteCodePrinter.java deleted file mode 100644 index 3d1ca38..0000000 --- a/src/main/java/org/example/util/ByteCodePrinter.java +++ /dev/null @@ -1,90 +0,0 @@ -package org.example.util; - -import org.objectweb.asm.ClassReader; -import org.objectweb.asm.tree.ClassNode; -import org.objectweb.asm.tree.MethodNode; -import org.objectweb.asm.tree.TryCatchBlockNode; -import org.objectweb.asm.tree.analysis.*; -import org.objectweb.asm.util.Textifier; -import org.objectweb.asm.util.TraceMethodVisitor; - -import java.io.IOException; -import java.io.PrintWriter; -import java.nio.file.Files; -import java.nio.file.Path; - -public class ByteCodePrinter { - - private static String getUnqualifiedName(final String name) { - var lastSlashIndex = name.lastIndexOf('/'); - if (lastSlashIndex == -1) { - return name; - } else { - int endIndex = name.length(); - if (name.charAt(endIndex - 1) == ';') { - endIndex--; - } - int lastBracketIndex = name.lastIndexOf('['); - if (lastBracketIndex == -1) { - return name.substring(lastSlashIndex + 1, endIndex); - } - return name.substring(0, lastBracketIndex + 1) + name.substring(lastSlashIndex + 1, endIndex); - } - } - private static void analyzeMethod( - final MethodNode method, final Analyzer analyzer, final PrintWriter printWriter) { - var textifier = new Textifier(); - var traceMethodVisitor = new TraceMethodVisitor(textifier); - - printWriter.println(method.name + method.desc); - for (int i = 0; i < method.instructions.size(); ++i) { - method.instructions.get(i).accept(traceMethodVisitor); - - var stringBuilder = new StringBuilder(); - var frame = analyzer.getFrames()[i]; - if (frame == null) { - stringBuilder.append('?'); - } else { - for (int j = 0; j < frame.getLocals(); ++j) { - stringBuilder.append(getUnqualifiedName(frame.getLocal(j).toString())).append(' '); - } - stringBuilder.append(" : "); - for (int j = 0; j < frame.getStackSize(); ++j) { - stringBuilder.append(getUnqualifiedName(frame.getStack(j).toString())).append(' '); - } - } - while (stringBuilder.length() < method.maxStack + method.maxLocals + 1) { - stringBuilder.append(' '); - } - printWriter.print(Integer.toString(i + 100000).substring(1)); - printWriter.print( - " " + stringBuilder + " : " + textifier.text.get(textifier.text.size() - 1)); - } - for (TryCatchBlockNode tryCatchBlock : method.tryCatchBlocks) { - tryCatchBlock.accept(traceMethodVisitor); - printWriter.print(" " + textifier.text.get(textifier.text.size() - 1)); - } - printWriter.println(); - } - - public void printBytecode(ClassNode cn) { - var sortMethod = cn.methods.get(1); - var analyzer = new CheckFrameAnalyzer<>(new BasicVerifier()); - try { - analyzer.analyze("dummy", sortMethod); - } catch (AnalyzerException e) { - throw new RuntimeException(e); - } - var pw = new PrintWriter(System.out); - analyzeMethod(sortMethod, analyzer, pw); - pw.flush(); - } - - public void printBubbleSortBytecode() throws IOException { - var cn = new ClassNode(); - var classFileBytes = Files.readAllBytes(Path.of("build/classes/java/main/org/itmo/lab1/example/BubbleSort.class")); - var classReader = new ClassReader(classFileBytes); - classReader.accept(cn, ClassReader.EXPAND_FRAMES); - printBytecode(cn); - } -} diff --git a/src/main/java/org/example/util/CheckFrameAnalyzer.java b/src/main/java/org/example/util/CheckFrameAnalyzer.java deleted file mode 100644 index 5231ca7..0000000 --- a/src/main/java/org/example/util/CheckFrameAnalyzer.java +++ /dev/null @@ -1,475 +0,0 @@ -package org.example.util; - -// ASM: a very small and fast Java bytecode manipulation framework -// Copyright (c) 2000-2011 INRIA, France Telecom -// All rights reserved. -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions -// are met: -// 1. Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// 2. Redistributions in binary form must reproduce the above copyright -// notice, this list of conditions and the following disclaimer in the -// documentation and/or other materials provided with the distribution. -// 3. Neither the name of the copyright holders nor the names of its -// contributors may be used to endorse or promote products derived from -// this software without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF -// THE POSSIBILITY OF SUCH DAMAGE. - -import java.util.Collections; -import java.util.List; -import org.objectweb.asm.Opcodes; -import org.objectweb.asm.Type; -import org.objectweb.asm.tree.AbstractInsnNode; -import org.objectweb.asm.tree.FrameNode; -import org.objectweb.asm.tree.InsnList; -import org.objectweb.asm.tree.InsnNode; -import org.objectweb.asm.tree.JumpInsnNode; -import org.objectweb.asm.tree.LabelNode; -import org.objectweb.asm.tree.LookupSwitchInsnNode; -import org.objectweb.asm.tree.MethodNode; -import org.objectweb.asm.tree.TableSwitchInsnNode; -import org.objectweb.asm.tree.TryCatchBlockNode; -import org.objectweb.asm.tree.TypeInsnNode; -import org.objectweb.asm.tree.analysis.Analyzer; -import org.objectweb.asm.tree.analysis.AnalyzerException; -import org.objectweb.asm.tree.analysis.Frame; -import org.objectweb.asm.tree.analysis.Interpreter; -import org.objectweb.asm.tree.analysis.Value; - -/** - * An {@link Analyzer} subclass which checks that methods provide stack map frames where expected - * (i.e. at jump target and after instructions without immediate successor), and that these stack - * map frames are valid (for the provided interpreter; they may still be invalid for the JVM, if the - * {@link Interpreter} uses a simplified type system compared to the JVM verifier). This is done in - * two steps: - * - *
    - *
  • First, the stack map frames in {@link FrameNode}s are expanded, and stored at their - * respective instruction offsets. The expansion process uncompresses the APPEND, CHOP and - * SAME frames to FULL frames. It also converts the stack map frame verification types to - * {@link Value}s, via the provided {@link Interpreter}. The expansion is done in {@link - * #expandFrames}, by looking at each {@link FrameNode} in sequence (compressed frames are - * defined relatively to the previous {@link FrameNode}, or the implicit first frame). The - * actual decompression is done in {@link #expandFrame}, and the type conversion in {@link - * #newFrameValue}. - *
  • Next, the method instructions are checked in sequence. Starting from the implicit initial - * frame, the execution of each instruction i is simulated on the current stack map - * frame, with the {@link Frame#execute} method. This gives a new stack map frame f, - * representing the stack map frame state after the execution of i. Then: - *
      - *
    • If there is a next instruction and if the control flow cannot continue to it (e.g. if - * i is a RETURN or an ATHROW, for instance): an existing stack map frame - * f0 (coming from the first step) is expected after i. - *
    • If there is a next instruction and if the control flow can continue to it (e.g. if - * i is a ALOAD, for instance): either there an existing stack map frame - * f0 (coming from the first step) after i, or there is none. In the - * first case f and f0 must be compatible: the types in - * f must be sub types of the corresponding types in the existing frame - * f0 (otherwise an exception is thrown). In the second case, f0 is - * simply set to the value of f. - *
    • If the control flow can continue to some instruction j (e.g. if i - * is an IF_EQ, for instance): an existing stack map frame f0 (coming from the - * first step) is expected at j, which must be compatible with f (as - * defined previously). - *
    - * The sequential loop over the instructions is done in {@link #init}, which is called from - * the {@link Analyzer#analyze} method. Cases where the control flow cannot continue to the - * next instruction are handled in {@link #endControlFlow}. Cases where the control flow can - * continue to the next instruction, or jump to another instruction, are handled in {@link - * #checkFrame}. This method checks that an existing stack map frame is present when required, - * and checks the stack map frames compatibility with {@link #checkMerge}. - *
- * - * @author Eric Bruneton - * @param type of the {@link Value} used for the analysis. - */ -class CheckFrameAnalyzer extends Analyzer { - - /** The interpreter to use to symbolically interpret the bytecode instructions. */ - private final Interpreter interpreter; - - /** The instructions of the currently analyzed method. */ - private InsnList insnList; - - /** - * double values are represented with two elements. - */ - private int currentLocals; - - CheckFrameAnalyzer(final Interpreter interpreter) { - super(interpreter); - this.interpreter = interpreter; - } - - @Override - protected void init(final String owner, final MethodNode method) throws AnalyzerException { - insnList = method.instructions; - currentLocals = Type.getArgumentsAndReturnSizes(method.desc) >> 2; - - Frame[] frames = getFrames(); - Frame currentFrame = frames[0]; - expandFrames(owner, method, currentFrame); - for (int insnIndex = 0; insnIndex < insnList.size(); ++insnIndex) { - Frame oldFrame = frames[insnIndex]; - - // Simulate the execution of this instruction. - AbstractInsnNode insnNode = null; - try { - insnNode = method.instructions.get(insnIndex); - int insnOpcode = insnNode.getOpcode(); - int insnType = insnNode.getType(); - - if (insnType == AbstractInsnNode.LABEL - || insnType == AbstractInsnNode.LINE - || insnType == AbstractInsnNode.FRAME) { - checkFrame(insnIndex + 1, oldFrame, /* requireFrame = */ false); - } else { - currentFrame.init(oldFrame).execute(insnNode, interpreter); - - if (insnNode instanceof JumpInsnNode) { - if (insnOpcode == JSR) { - throw new AnalyzerException(insnNode, "JSR instructions are unsupported"); - } - JumpInsnNode jumpInsn = (JumpInsnNode) insnNode; - int targetInsnIndex = insnList.indexOf(jumpInsn.label); - checkFrame(targetInsnIndex, currentFrame, /* requireFrame = */ true); - if (insnOpcode == GOTO) { - endControlFlow(insnIndex); - } else { - checkFrame(insnIndex + 1, currentFrame, /* requireFrame = */ false); - } - } else if (insnNode instanceof LookupSwitchInsnNode) { - LookupSwitchInsnNode lookupSwitchInsn = (LookupSwitchInsnNode) insnNode; - int targetInsnIndex = insnList.indexOf(lookupSwitchInsn.dflt); - checkFrame(targetInsnIndex, currentFrame, /* requireFrame = */ true); - for (int i = 0; i < lookupSwitchInsn.labels.size(); ++i) { - LabelNode label = lookupSwitchInsn.labels.get(i); - targetInsnIndex = insnList.indexOf(label); - currentFrame.initJumpTarget(insnOpcode, label); - checkFrame(targetInsnIndex, currentFrame, /* requireFrame = */ true); - } - endControlFlow(insnIndex); - } else if (insnNode instanceof TableSwitchInsnNode) { - TableSwitchInsnNode tableSwitchInsn = (TableSwitchInsnNode) insnNode; - int targetInsnIndex = insnList.indexOf(tableSwitchInsn.dflt); - currentFrame.initJumpTarget(insnOpcode, tableSwitchInsn.dflt); - checkFrame(targetInsnIndex, currentFrame, /* requireFrame = */ true); - newControlFlowEdge(insnIndex, targetInsnIndex); - for (int i = 0; i < tableSwitchInsn.labels.size(); ++i) { - LabelNode label = tableSwitchInsn.labels.get(i); - currentFrame.initJumpTarget(insnOpcode, label); - targetInsnIndex = insnList.indexOf(label); - checkFrame(targetInsnIndex, currentFrame, /* requireFrame = */ true); - } - endControlFlow(insnIndex); - } else if (insnOpcode == RET) { - throw new AnalyzerException(insnNode, "RET instructions are unsupported"); - } else if (insnOpcode != ATHROW && (insnOpcode < IRETURN || insnOpcode > RETURN)) { - checkFrame(insnIndex + 1, currentFrame, /* requireFrame = */ false); - } else { - endControlFlow(insnIndex); - } - } - - List insnHandlers = getHandlers(insnIndex); - if (insnHandlers != null) { - for (TryCatchBlockNode tryCatchBlock : insnHandlers) { - Type catchType; - if (tryCatchBlock.type == null) { - catchType = Type.getObjectType("java/lang/Throwable"); - } else { - catchType = Type.getObjectType(tryCatchBlock.type); - } - Frame handler = newFrame(oldFrame); - handler.clearStack(); - handler.push(interpreter.newExceptionValue(tryCatchBlock, handler, catchType)); - checkFrame(insnList.indexOf(tryCatchBlock.handler), handler, /* requireFrame = */ true); - } - } - - if (!hasNextJvmInsnOrFrame(insnIndex)) { - break; - } - } catch (AnalyzerException e) { - throw new AnalyzerException( - e.node, "Error at instruction " + insnIndex + ": " + e.getMessage(), e); - } catch (RuntimeException e) { - // DontCheck(IllegalCatch): can't be fixed, for backward compatibility. - throw new AnalyzerException( - insnNode, "Error at instruction " + insnIndex + ": " + e.getMessage(), e); - } - } - } - - /** - * Expands the {@link FrameNode} "instructions" of the given method into {@link Frame} objects and - * also associated with the label and line number nodes immediately preceding each frame node. - * - * @param owner the internal name of the class to which 'method' belongs. - * @param method the method whose frames must be expanded. - * @param initialFrame the implicit initial frame of 'method'. - * @throws AnalyzerException if the stack map frames of 'method', i.e. its FrameNode - * "instructions", are invalid. - */ - private void expandFrames( - final String owner, final MethodNode method, final Frame initialFrame) - throws AnalyzerException { - int lastJvmOrFrameInsnIndex = -1; - Frame currentFrame = initialFrame; - int currentInsnIndex = 0; - for (AbstractInsnNode insnNode : method.instructions) { - if (insnNode instanceof FrameNode) { - try { - currentFrame = expandFrame(owner, currentFrame, (FrameNode) insnNode); - } catch (AnalyzerException e) { - throw new AnalyzerException( - e.node, "Error at instruction " + currentInsnIndex + ": " + e.getMessage(), e); - } - for (int index = lastJvmOrFrameInsnIndex + 1; index <= currentInsnIndex; ++index) { - getFrames()[index] = currentFrame; - } - } - if (isJvmInsnNode(insnNode) || insnNode instanceof FrameNode) { - lastJvmOrFrameInsnIndex = currentInsnIndex; - } - currentInsnIndex += 1; - } - } - - /** - * Returns the expanded representation of the given {@link FrameNode}. - * - * @param owner the internal name of the class to which 'frameNode' belongs. - * @param previousFrame the frame before 'frameNode', in expanded form. - * @param frameNode a possibly compressed stack map frame. - * @return the expanded version of 'frameNode'. - * @throws AnalyzerException if 'frameNode' is invalid. - */ - private Frame expandFrame( - final String owner, final Frame previousFrame, final FrameNode frameNode) - throws AnalyzerException { - Frame frame = newFrame(previousFrame); - List locals = frameNode.local == null ? Collections.emptyList() : frameNode.local; - int currentLocal = currentLocals; - switch (frameNode.type) { - case Opcodes.F_NEW: - case Opcodes.F_FULL: - currentLocal = 0; - // fall through - case Opcodes.F_APPEND: - for (Object type : locals) { - V value = newFrameValue(owner, frameNode, type); - if (currentLocal + value.getSize() > frame.getLocals()) { - throw new AnalyzerException(frameNode, "Cannot append more locals than maxLocals"); - } - frame.setLocal(currentLocal++, value); - if (value.getSize() == 2) { - frame.setLocal(currentLocal++, interpreter.newValue(null)); - } - } - break; - case Opcodes.F_CHOP: - for (Object unusedType : locals) { - if (currentLocal <= 0) { - throw new AnalyzerException(frameNode, "Cannot chop more locals than defined"); - } - if (currentLocal > 1 && frame.getLocal(currentLocal - 2).getSize() == 2) { - currentLocal -= 2; - } else { - currentLocal -= 1; - } - } - break; - case Opcodes.F_SAME: - case Opcodes.F_SAME1: - break; - default: - throw new AnalyzerException(frameNode, "Illegal frame type " + frameNode.type); - } - currentLocals = currentLocal; - while (currentLocal < frame.getLocals()) { - frame.setLocal(currentLocal++, interpreter.newValue(null)); - } - - List stack = frameNode.stack == null ? Collections.emptyList() : frameNode.stack; - frame.clearStack(); - for (Object type : stack) { - frame.push(newFrameValue(owner, frameNode, type)); - } - return frame; - } - - /** - * Creates a new {@link Value} that represents the given stack map frame type. - * - * @param owner the internal name of the class to which 'frameNode' belongs. - * @param frameNode the stack map frame to which 'type' belongs. - * @param type an Integer, String or LabelNode object representing a primitive, reference or - * uninitialized a stack map frame type, respectively. See {@link FrameNode}. - * @return a value that represents the given type. - * @throws AnalyzerException if 'type' is an invalid stack map frame type. - */ - private V newFrameValue(final String owner, final FrameNode frameNode, final Object type) - throws AnalyzerException { - if (type == Opcodes.TOP) { - return interpreter.newValue(null); - } else if (type == Opcodes.INTEGER) { - return interpreter.newValue(Type.INT_TYPE); - } else if (type == Opcodes.FLOAT) { - return interpreter.newValue(Type.FLOAT_TYPE); - } else if (type == Opcodes.LONG) { - return interpreter.newValue(Type.LONG_TYPE); - } else if (type == Opcodes.DOUBLE) { - return interpreter.newValue(Type.DOUBLE_TYPE); - } else if (type == Opcodes.NULL) { - return interpreter.newOperation(new InsnNode(Opcodes.ACONST_NULL)); - } else if (type == Opcodes.UNINITIALIZED_THIS) { - return interpreter.newValue(Type.getObjectType(owner)); - } else if (type instanceof String) { - return interpreter.newValue(Type.getObjectType((String) type)); - } else if (type instanceof LabelNode) { - AbstractInsnNode referencedNode = (LabelNode) type; - while (referencedNode != null && !isJvmInsnNode(referencedNode)) { - referencedNode = referencedNode.getNext(); - } - if (referencedNode == null || referencedNode.getOpcode() != Opcodes.NEW) { - throw new AnalyzerException(frameNode, "LabelNode does not designate a NEW instruction"); - } - return interpreter.newValue(Type.getObjectType(((TypeInsnNode) referencedNode).desc)); - } - throw new AnalyzerException(frameNode, "Illegal stack map frame value " + type); - } - - /** - * Checks that the given frame is compatible with the frame at the given instruction index, if - * any. If there is no frame at this instruction index and none is required, the frame at - * 'insnIndex' is set to the given frame. Otherwise, if the merge of the two frames is not equal - * to the current frame at 'insnIndex', an exception is thrown. - * - * @param insnIndex an instruction index. - * @param frame a frame. This frame is left unchanged by this method. - * 'insnIndex'. - * @throws AnalyzerException if the frames have incompatible sizes or if the frame at 'insnIndex' - * is missing (if required) or not compatible with 'frame'. - */ - private void checkFrame(final int insnIndex, final Frame frame, final boolean requireFrame) - throws AnalyzerException { - Frame oldFrame = getFrames()[insnIndex]; - if (oldFrame == null) { - if (requireFrame) { - throw new AnalyzerException(null, "Expected stack map frame at instruction " + insnIndex); - } - getFrames()[insnIndex] = newFrame(frame); - } else { - String error = checkMerge(frame, oldFrame); - if (error != null) { - throw new AnalyzerException( - null, - "Stack map frame incompatible with frame at instruction " - + insnIndex - + " (" - + error - + ")"); - } - } - } - - /** - * Checks that merging the two given frames would not produce any change, i.e. that the types in - * the source frame are sub types of the corresponding types in the destination frame. - * - * @param srcFrame a source frame. This frame is left unchanged by this method. - * @param dstFrame a destination frame. This frame is left unchanged by this method. - * @return an error message if the frames have incompatible sizes, or if a type in the source - * frame is not a sub type of the corresponding type in the destination frame. Returns - * {@literal null} otherwise. - */ - private String checkMerge(final Frame srcFrame, final Frame dstFrame) { - int numLocals = srcFrame.getLocals(); - if (numLocals != dstFrame.getLocals()) { - throw new AssertionError(); - } - for (int i = 0; i < numLocals; ++i) { - V v = interpreter.merge(srcFrame.getLocal(i), dstFrame.getLocal(i)); - if (!v.equals(dstFrame.getLocal(i))) { - return "incompatible types at local " - + i - + ": " - + srcFrame.getLocal(i) - + " and " - + dstFrame.getLocal(i); - } - } - int numStack = srcFrame.getStackSize(); - if (numStack != dstFrame.getStackSize()) { - return "incompatible stack heights"; - } - for (int i = 0; i < numStack; ++i) { - V v = interpreter.merge(srcFrame.getStack(i), dstFrame.getStack(i)); - if (!v.equals(dstFrame.getStack(i))) { - return "incompatible types at stack item " - + i - + ": " - + srcFrame.getStack(i) - + " and " - + dstFrame.getStack(i); - } - } - return null; - } - - /** - * Ends the control flow graph at the given instruction. This method checks that there is an - * existing frame for the next instruction, if any. - * - * @param insnIndex an instruction index. - * @throws AnalyzerException if 'insnIndex' is not the last instruction and there is no frame at - * 'insnIndex' + 1 in {@link #getFrames}. - */ - private void endControlFlow(final int insnIndex) throws AnalyzerException { - if (hasNextJvmInsnOrFrame(insnIndex) && getFrames()[insnIndex + 1] == null) { - throw new AnalyzerException( - null, "Expected stack map frame at instruction " + (insnIndex + 1)); - } - } - - /** - * Returns true if the given instruction is followed by a JVM instruction or a by stack map frame. - * - * @param insnIndex an instruction index. - * @return true if 'insnIndex' is followed by a JVM instruction or a by stack map frame. - */ - private boolean hasNextJvmInsnOrFrame(final int insnIndex) { - AbstractInsnNode insn = insnList.get(insnIndex).getNext(); - while (insn != null) { - if (isJvmInsnNode(insn) || insn instanceof FrameNode) { - return true; - } - insn = insn.getNext(); - } - return false; - } - - /** - * Returns true if the given instruction node corresponds to a real JVM instruction. - * - * @param insnNode an instruction node. - * @return true except for label, line number and stack map frame nodes. - */ - private static boolean isJvmInsnNode(final AbstractInsnNode insnNode) { - return insnNode.getOpcode() >= 0; - } -} diff --git a/src/main/java/org/example/visitor/ClassMetricsVisitor.java b/src/main/java/org/example/visitor/ClassMetricsVisitor.java new file mode 100644 index 0000000..67e5e06 --- /dev/null +++ b/src/main/java/org/example/visitor/ClassMetricsVisitor.java @@ -0,0 +1,41 @@ +package org.example.visitor; + +import lombok.Getter; +import org.example.metrics.ClassMetrics; +import org.example.metrics.MethodMetrics; +import org.objectweb.asm.ClassVisitor; +import org.objectweb.asm.FieldVisitor; +import org.objectweb.asm.MethodVisitor; +import org.objectweb.asm.Opcodes; + +@Getter +public class ClassMetricsVisitor extends ClassVisitor { + + private final ClassMetrics classMetrics = new ClassMetrics(); + + public ClassMetricsVisitor() { + super(Opcodes.ASM9); + } + + @Override + public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) { + classMetrics.setName(name); + classMetrics.setSuperName(superName); + } + + @Override + public FieldVisitor visitField(int access, String name, String desc, String signature, Object value) { + classMetrics.incFields(); + return null; + } + + @Override + public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) { + var methodMetrics = new MethodMetrics(); + methodMetrics.setName(name); + methodMetrics.setDescriptor(desc); + classMetrics.addMethod(methodMetrics); + return new MethodMetricsVisitor(methodMetrics); + } + +} diff --git a/src/main/java/org/example/visitor/ClassPrinter.java b/src/main/java/org/example/visitor/ClassPrinter.java deleted file mode 100644 index ba1ab9f..0000000 --- a/src/main/java/org/example/visitor/ClassPrinter.java +++ /dev/null @@ -1,46 +0,0 @@ -package org.example.visitor; - -import org.objectweb.asm.*; - -import static org.objectweb.asm.Opcodes.ASM8; - -public class ClassPrinter extends ClassVisitor { - public ClassPrinter() { - super(ASM8); - } - - public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) { - System.out.println("\n" + name + " extends " + superName + " {"); - } - - public void visitSource(String source, String debug) { - } - - public void visitOuterClass(String owner, String name, String desc) { - } - - public AnnotationVisitor visitAnnotation(String desc, boolean visible) { - return null; - } - - public void visitAttribute(Attribute attr) { - } - - public void visitInnerClass(String name, String outerName, String innerName, int access) { - } - - public FieldVisitor visitField(int access, String name, String desc, String signature, Object value) { - System.out.println(" " + desc + " " + name); - return null; - } - - public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) { - System.out.println(" " + name + desc); - return null; - } - - public void visitEnd() { - System.out.println("}"); - } -} - diff --git a/src/main/java/org/example/visitor/MethodMetricsVisitor.java b/src/main/java/org/example/visitor/MethodMetricsVisitor.java new file mode 100644 index 0000000..dd69bfd --- /dev/null +++ b/src/main/java/org/example/visitor/MethodMetricsVisitor.java @@ -0,0 +1,93 @@ +package org.example.visitor; + +import org.example.metrics.MethodMetrics; +import org.objectweb.asm.Handle; +import org.objectweb.asm.Label; +import org.objectweb.asm.MethodVisitor; +import org.objectweb.asm.Opcodes; + +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +public class MethodMetricsVisitor extends MethodVisitor { + + private static final Set STORE_OPCODES = Set.of(Opcodes.ISTORE, Opcodes.LSTORE, Opcodes.FSTORE, Opcodes.DSTORE, Opcodes.ASTORE); + private static final Set NEW_OPCODES = Set.of(Opcodes.NEW, Opcodes.ANEWARRAY); + private static final Set CONDITION_OPCODES = Set.of( + Opcodes.IFEQ, Opcodes.IFNE, Opcodes.IFLT, Opcodes.IFGE, Opcodes.IFGT, Opcodes.IFLE, + Opcodes.IF_ICMPEQ, Opcodes.IF_ICMPNE, Opcodes.IF_ICMPLT, Opcodes.IF_ICMPGE, + Opcodes.IF_ICMPGT, Opcodes.IF_ICMPLE, Opcodes.IF_ACMPEQ, Opcodes.IF_ACMPNE, + Opcodes.IFNULL, Opcodes.IFNONNULL + ); + + private final MethodMetrics methodMetrics; + + public MethodMetricsVisitor(MethodMetrics methodMetrics) { + super(Opcodes.ASM9); + this.methodMetrics = methodMetrics; + } + + // Assignments + + @Override + public void visitVarInsn(int opcode, int varIndex) { + if (STORE_OPCODES.contains(opcode)) { + methodMetrics.incAssignments(); + } + } + + @Override + public void visitIincInsn(int varIndex, int increment) { + methodMetrics.incAssignments(); + } + + // Branches + + @Override + public void visitInvokeDynamicInsn(String name, String descriptor, Handle bootstrapMethodHandle, Object... bootstrapMethodArguments) { + methodMetrics.incBranches(); + } + + @Override + public void visitMultiANewArrayInsn(String descriptor, int numDimensions) { + methodMetrics.incBranches(); + } + + @Override + public void visitMethodInsn(int opcode, String owner, String name, String descriptor, boolean isInterface) { + // new is handled in typeInsn + if (!name.equals("") && !name.equals("")) { + methodMetrics.incBranches(); + } + } + + @Override + public void visitTypeInsn(int opcode, String type) { + if (NEW_OPCODES.contains(opcode)) { + methodMetrics.incBranches(); + } + } + + // Conditions + + @Override + public void visitLookupSwitchInsn(Label dflt, int[] keys, Label[] labels) { + methodMetrics.incConditions(labels.length); + } + + @Override + public void visitTableSwitchInsn(int min, int max, Label dflt, Label... labels) { + var distinct = new HashSet<>(List.of(dflt)); + Collections.addAll(distinct, labels); + methodMetrics.incConditions((distinct.size())); + } + + @Override + public void visitJumpInsn(int opcode, Label label) { + if (CONDITION_OPCODES.contains(opcode)) { + methodMetrics.incConditions(); + } + } +}