BetterCFGBuilder2.java

Index Score
edu.umd.cs.findbugs.ba
FindBugs

View: Reasons, Metrics, Source Code

These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.

MetricDescription
JAVA0034JAVA0034 Missing braces in if statement
EXEC_COMMENTSComments in executable code
LINE_COMMENTNumber of line comments
DECL_COMMENTSComments in declarations
EXITSProcedure exits
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
COMMENTSComment lines
SIZESize of the file in bytes
DOC_COMMENTNumber of javadoc comment lines
LINESNumber of lines in the source file
CYCLOMATICCyclomatic complexity
UNIQUE_OPERANDSNumber of unique operands
LOGICAL_LINESNumber of statements
OPERANDSNumber of operands
RETURNSNumber of return points from functions
PROGRAM_LENGTHHalstead program length
PROGRAM_VOCABHalstead program vocabulary
OPERATORSNumber of operators
FUNCTIONSNumber of function declarations
JAVA0266JAVA0266 Use of System.out
INTERFACE_COMPLEXITYInterface complexity
JAVA0128JAVA0128 Public constructor in non-public class
JAVA0115JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
ELOCEffective lines of code
JAVA0108JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0254JAVA0254 Use enhanced for loop construct instead of Iterator
LOCLines of code
LOOPSNumber of loops
JAVA0049JAVA0049 Nested block at depth N (maximum: M)
BLOCKSNumber of blocks
JAVA0145JAVA0145 Tab character used in source file
COMPARISONSNumber of comparison operators
PARAMSNumber of formal parameter declarations
NEST_DEPTHMaximum nesting depth
WHITESPACENumber of whitespace lines
JAVA0096JAVA0096 Field in nested class hides outer field
JAVA0117JAVA0117 Missing javadoc: method 'method'
JAVA0077JAVA0077 Private field not used in declaring class
UNIQUE_OPERATORSNumber of unique operators
PROGRAM_VOLUMEHalstead program volume
JAVA0136JAVA0136 N methods defined in class (maximum: M)
BLOCK_COMMENTNumber of block comment lines
JAVA0126JAVA0126 Method declares unchecked exception in throws
JAVA0267JAVA0267 Use of System.err
JAVA0130JAVA0130 Non-static method does not use instance fields
JAVA0075JAVA0075 Method parameter hides field
/* * Bytecode Analysis Framework * Copyright (C) 2003,2004 University of Maryland * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ package edu.umd.cs.findbugs.ba; import java.util.BitSet; import java.util.IdentityHashMap; import java.util.Iterator; import java.util.LinkedList; import java.util.List; import org.apache.bcel.Constants; import org.apache.bcel.classfile.ClassParser; import org.apache.bcel.classfile.JavaClass; import org.apache.bcel.classfile.Method; import org.apache.bcel.generic.BranchInstruction; import org.apache.bcel.generic.ClassGen; import org.apache.bcel.generic.CodeExceptionGen; import org.apache.bcel.generic.ConstantPoolGen; import org.apache.bcel.generic.ExceptionThrower; import org.apache.bcel.generic.GETSTATIC; import org.apache.bcel.generic.INSTANCEOF; import org.apache.bcel.generic.Instruction; import org.apache.bcel.generic.InstructionHandle; import org.apache.bcel.generic.InstructionList; import org.apache.bcel.generic.InstructionTargeter; import org.apache.bcel.generic.JsrInstruction; import org.apache.bcel.generic.MONITOREXIT; import org.apache.bcel.generic.MethodGen; import org.apache.bcel.generic.NEW; import org.apache.bcel.generic.NOP; import org.apache.bcel.generic.PUTSTATIC; import org.apache.bcel.generic.ReturnInstruction; import edu.umd.cs.findbugs.SystemProperties; import edu.umd.cs.findbugs.annotations.NonNull; import edu.umd.cs.findbugs.annotations.Nullable; /** * A CFGBuilder that really tries to construct accurate control flow graphs. * The CFGs it creates have accurate exception edges, and have accurately * inlined JSR subroutines. * * @author David Hovemeyer * @see CFG */ public class BetterCFGBuilder2 implements CFGBuilder, EdgeTypes, Debug { private static final boolean DEBUG = SystemProperties.getBoolean("cfgbuilder.debug"); // TODO: don't forget to change BasicBlock so ATHROW is considered to have a null check /* ---------------------------------------------------------------------- * Helper classes * ---------------------------------------------------------------------- */ /** * A work list item for creating the CFG for a subroutine. */ private static class WorkListItem { private final InstructionHandle start; private final BasicBlock basicBlock; /** * Constructor. * * @param start first instruction in the basic block * @param basicBlock the basic block to build */ public WorkListItem(InstructionHandle start, BasicBlock basicBlock) { this.start = start; this.basicBlock = basicBlock; } /** * Get the start instruction. */ public InstructionHandle getStartInstruction() { return start; } /** * Get the basic block. */ public BasicBlock getBasicBlock() { return basicBlock; } } /** * A placeholder for a control edge that escapes its subroutine to return * control back to an outer (calling) subroutine. It will turn into a * real edge during inlining. */ private static class EscapeTarget { private final InstructionHandle target; private final int edgeType; /** * Constructor. * * @param target the target instruction in a calling subroutine * @param edgeType the type of edge that should be created when the * subroutine is inlined into its calling context */ public EscapeTarget(InstructionHandle target, int edgeType) { this.target = target; this.edgeType = edgeType; } /** * Get the target instruction. */ public InstructionHandle getTarget() { return target; } /** * Get the edge type. */ public int getEdgeType() { return edgeType; } } private static final LinkedList<EscapeTarget> emptyEscapeTargetList = new LinkedList<EscapeTarget>(); /** * JSR subroutine. The top level subroutine is where execution starts. * Each subroutine has its own CFG. Eventually, * all JSR subroutines will be inlined into the top level subroutine, * resulting in an accurate CFG for the overall method. */ private class Subroutine { private final InstructionHandle start; private final BitSet instructionSet; private final CFG cfg; private IdentityHashMap<InstructionHandle, BasicBlock> blockMap; private IdentityHashMap<BasicBlock, List<EscapeTarget>> escapeTargetListMap; private BitSet returnBlockSet; private BitSet exitBlockSet; private BitSet unhandledExceptionBlockSet; private LinkedList<WorkListItem> workList; /** * Constructor. * * @param start the start instruction for the subroutine */ public Subroutine(InstructionHandle start) { this.start = start; this.instructionSet = new BitSet(); this.cfg = new CFG(); this.blockMap = new IdentityHashMap<InstructionHandle, BasicBlock>(); this.escapeTargetListMap = new IdentityHashMap<BasicBlock, List<EscapeTarget>>(); this.returnBlockSet = new BitSet(); this.exitBlockSet = new BitSet(); this.unhandledExceptionBlockSet = new BitSet(); this.workList = new LinkedList<WorkListItem>(); } /** * Get the start instruction. */ public InstructionHandle getStartInstruction() { return start; } /** * Allocate a new basic block in the subroutine. */ public BasicBlock allocateBasicBlock() { return cfg.allocate(); } /** * Add a work list item for a basic block to be constructed. */ public void addItem(WorkListItem item) { workList.add(item); } /** * Are there more work list items? */ public boolean hasMoreWork() { return !workList.isEmpty(); } /** * Get the next work list item. */ public WorkListItem nextItem() { return workList.removeFirst(); } /** * Get the entry block for the subroutine's CFG. */ public BasicBlock getEntry() { return cfg.getEntry(); } /** * Get the exit block for the subroutine's CFG. */ public BasicBlock getExit() { return cfg.getExit(); } /** * Get the start block for the subroutine's CFG. * (I.e., the block containing the start instruction.) */ public BasicBlock getStartBlock() { return getBlock(start); } /** * Get the subroutine's CFG. */ public CFG getCFG() { return cfg; } /** * Add an instruction to the subroutine. * We keep track of which instructions are part of which subroutines. * No instruction may be part of more than one subroutine. * * @param handle the instruction to be added to the subroutine */ public void addInstruction(InstructionHandle handle) throws CFGBuilderException { int position = handle.getPosition(); if (usedInstructionSet.get(position)) throw new CFGBuilderException("Instruction " + handle + " visited in multiple subroutines"); instructionSet.set(position); usedInstructionSet.set(position); } /** * Is the given instruction part of this subroutine? */ public boolean containsInstruction(InstructionHandle handle) { return instructionSet.get(handle.getPosition()); } /** * Get the basic block in the subroutine for the given instruction. * If the block doesn't exist yet, it is created, and a work list * item is added which will populate it. Note that if start is * an exception thrower, the block returned will be its ETB. * * @param start the start instruction for the block * @return the basic block for the instruction */ public BasicBlock getBlock(InstructionHandle start) { BasicBlock block = blockMap.get(start); if (block == null) { block = allocateBasicBlock(); blockMap.put(start, block); // Block is an exception handler? CodeExceptionGen exceptionGen = exceptionHandlerMap.getHandlerForStartInstruction(start); if (exceptionGen != null) block.setExceptionGen(exceptionGen); addItem(new WorkListItem(start, block)); } return block; } /** * Indicate that the method returns at the end of the given block. * * @param block the returning block */ public void setReturnBlock(BasicBlock block) { returnBlockSet.set(block.getLabel()); } /** * Does the method return at the end of this block? */ public boolean isReturnBlock(BasicBlock block) { return returnBlockSet.get(block.getLabel()); } /** * Indicate that System.exit() is called at the end of the given block. * * @param block the exiting block */ public void setExitBlock(BasicBlock block) { exitBlockSet.set(block.getLabel()); } /** * Is System.exit() called at the end of this block? */ public boolean isExitBlock(BasicBlock block) { return exitBlockSet.get(block.getLabel()); } /** * Indicate that an unhandled exception may be thrown by * the given block. * * @param block the block throwing an unhandled exception */ public void setUnhandledExceptionBlock(BasicBlock block) { unhandledExceptionBlockSet.set(block.getLabel()); } /** * Does this block throw an unhandled exception? */ public boolean isUnhandledExceptionBlock(BasicBlock block) { return unhandledExceptionBlockSet.get(block.getLabel()); } /** * Add a control flow edge to the subroutine. * If the control target has not yet been added to the subroutine, * a new work list item is added. If the control target is in * another subroutine, an EscapeTarget is added. * * @param sourceBlock the source basic block * @param target the control target * @param edgeType the type of control edge */ public void addEdgeAndExplore(BasicBlock sourceBlock, InstructionHandle target, int edgeType) { if (usedInstructionSet.get(target.getPosition()) && !containsInstruction(target)) { // Control escapes this subroutine List<EscapeTarget> escapeTargetList = escapeTargetListMap.get(sourceBlock); if (escapeTargetList == null) { escapeTargetList = new LinkedList<EscapeTarget>(); escapeTargetListMap.put(sourceBlock, escapeTargetList); } escapeTargetList.add(new EscapeTarget(target, edgeType)); } else { // Edge within the current subroutine BasicBlock targetBlock = getBlock(target); addEdge(sourceBlock, targetBlock, edgeType); } } /** * Add an edge to the subroutine's CFG. * * @param sourceBlock the source basic block * @param destBlock the destination basic block * @param edgeType the type of edge */ public void addEdge(BasicBlock sourceBlock, BasicBlock destBlock, int edgeType) { if (VERIFY_INTEGRITY) { if (destBlock.isExceptionHandler() && edgeType != HANDLED_EXCEPTION_EDGE) throw new IllegalStateException("In method " + SignatureConverter.convertMethodSignature(methodGen) + ": exception handler " + destBlock.getFirstInstruction() + " reachable by non exception edge type " + edgeType); } cfg.createEdge(sourceBlock, destBlock, edgeType); } /** * Get an Iterator over the EscapeTargets of given basic block. * * @param sourceBlock the basic block * @return an Iterator over the EscapeTargets */ public Iterator<EscapeTarget> escapeTargetIterator(BasicBlock sourceBlock) { List<EscapeTarget> escapeTargetList = escapeTargetListMap.get(sourceBlock); if (escapeTargetList == null) escapeTargetList = emptyEscapeTargetList; return escapeTargetList.iterator(); } } /** * Inlining context. * This essentially consists of a inlining site and * a subroutine to be inlined. A stack of calling contexts * is maintained in order to resolve EscapeTargets. */ private static class Context { private final Context caller; private final Subroutine subroutine; private final CFG result; private final IdentityHashMap<BasicBlock, BasicBlock> blockMap; private final LinkedList<BasicBlock> workList; /** * Constructor. * * @param caller the calling context * @param subroutine the subroutine being inlined * @param result the result CFG */ public Context(@Nullable Context caller, Subroutine subroutine, CFG result) { this.caller = caller; this.subroutine = subroutine; this.result = result; this.blockMap = new IdentityHashMap<BasicBlock, BasicBlock>(); this.workList = new LinkedList<BasicBlock>(); } /** * Get the calling context. */ public Context getCaller() { return caller; } /** * Get the subroutine being inlined. */ public Subroutine getSubroutine() { return subroutine; } /** * Get the result CFG. */ public CFG getResult() { return result; } /** * Add a basic block to the inlining work list. */ public void addItem(BasicBlock item) { workList.add(item); } /** * Are there more work list items? */ public boolean hasMoreWork() { return !workList.isEmpty(); } /** * Get the next work list item (basic block to be inlined). */ public BasicBlock nextItem() { return workList.removeFirst(); } /** * Map a basic block in a subroutine to the corresponding block * in the resulting CFG. * * @param subBlock the subroutine block * @param resultBlock the result CFG block */ public void mapBlock(BasicBlock subBlock, BasicBlock resultBlock) { blockMap.put(subBlock, resultBlock); } /** * Get the block in the result CFG corresponding to the given * subroutine block. * * @param subBlock the subroutine block * @return the result CFG block */ public BasicBlock getBlock(BasicBlock subBlock) { BasicBlock resultBlock = blockMap.get(subBlock); if (resultBlock == null) { resultBlock = result.allocate(); blockMap.put(subBlock, resultBlock); workList.add(subBlock); } return resultBlock; } /** * Check to ensure that this context is not the result of recursion. */ public void checkForRecursion() throws CFGBuilderException { Context callerContext = caller; while (callerContext != null) { if (callerContext.subroutine == this.subroutine) throw new CFGBuilderException("JSR recursion detected!"); callerContext = callerContext.caller; } } } /* ---------------------------------------------------------------------- * Instance data * ---------------------------------------------------------------------- */ private MethodGen methodGen; private ConstantPoolGen cpg; private ExceptionHandlerMap exceptionHandlerMap; private BitSet usedInstructionSet; private LinkedList<Subroutine> subroutineWorkList; private IdentityHashMap<InstructionHandle, Subroutine> jsrSubroutineMap; private Subroutine topLevelSubroutine; private CFG cfg; /* ---------------------------------------------------------------------- * Public methods * ---------------------------------------------------------------------- */ /** * Constructor. * * @param methodGen the method to build a CFG for */ public BetterCFGBuilder2(@NonNull MethodGen methodGen) { this.methodGen = methodGen; this.cpg = methodGen.getConstantPool(); this.exceptionHandlerMap = new ExceptionHandlerMap(methodGen); this.usedInstructionSet = new BitSet(); this.jsrSubroutineMap = new IdentityHashMap<InstructionHandle, Subroutine>(); this.subroutineWorkList = new LinkedList<Subroutine>(); } public void build() throws CFGBuilderException { topLevelSubroutine = new Subroutine(methodGen.getInstructionList().getStart()); subroutineWorkList.add(topLevelSubroutine); // Build top level subroutine and all JSR subroutines while (!subroutineWorkList.isEmpty()) { Subroutine subroutine = subroutineWorkList.removeFirst(); if (DEBUG) System.out.println("Starting subroutine " + subroutine.getStartInstruction()); build(subroutine); } // Inline everything into the top level subroutine cfg = inlineAll(); // Add a NOP instruction to the entry block. // This allows analyses to construct a Location // representing the entry to the method. BasicBlock entryBlock = cfg.getEntry(); InstructionList il = new InstructionList(); entryBlock.addInstruction(il.append(new NOP())); if (VERIFY_INTEGRITY) cfg.checkIntegrity(); } public CFG getCFG() { return cfg; } /* ---------------------------------------------------------------------- * Implementation * ---------------------------------------------------------------------- */ /** * Build a subroutine. * We iteratively add basic blocks to the subroutine * until there are no more blocks reachable from the calling context. * As JSR instructions are encountered, new Subroutines are added * to the subroutine work list. * * @param subroutine the subroutine */ private void build(Subroutine subroutine) throws CFGBuilderException { // Prime the work list subroutine.addEdgeAndExplore(subroutine.getEntry(), subroutine.getStartInstruction(), START_EDGE); // Keep going until all basic blocks in the subroutine have been added while (subroutine.hasMoreWork()) { WorkListItem item = subroutine.nextItem(); InstructionHandle handle = item.getStartInstruction(); BasicBlock basicBlock = item.getBasicBlock(); // Add exception handler block (ETB) for exception-throwing instructions if (isPEI(handle)) { if (DEBUG) System.out.println("ETB block " + basicBlock.getLabel() + " for " + handle); handleExceptions(subroutine, handle, basicBlock); BasicBlock body = subroutine.allocateBasicBlock(); subroutine.addEdge(basicBlock, body, FALL_THROUGH_EDGE); basicBlock = body; } if (DEBUG) System.out.println("BODY block " + basicBlock.getLabel() + " for " + handle); if (!basicBlock.isEmpty()) throw new IllegalStateException("Block isn't empty!"); // Add instructions until we get to the end of the block boolean endOfBasicBlock = false; do { Instruction ins = handle.getInstruction(); // Add the instruction to the block if (DEBUG) System.out.println("BB " + basicBlock.getLabel() + ": adding" + handle); basicBlock.addInstruction(handle); subroutine.addInstruction(handle); short opcode = ins.getOpcode(); // TODO: should check instruction to ensure that in a JSR subroutine // no assignments are made to the local containing the return address. // if (ins instanceof ASTORE) ... if (opcode == Constants.JSR || opcode == Constants.JSR_W) { // Find JSR subroutine, add it to subroutine work list if // we haven't built a CFG for it yet JsrInstruction jsr = (JsrInstruction) ins; InstructionHandle jsrTarget = jsr.getTarget(); Subroutine jsrSubroutine = jsrSubroutineMap.get(jsrTarget); if (jsrSubroutine == null) { jsrSubroutine = new Subroutine(jsrTarget); jsrSubroutineMap.put(jsrTarget, jsrSubroutine); subroutineWorkList.add(jsrSubroutine); } // This ends the basic block. // Add a JSR_EDGE to the successor. // It will be replaced later by the inlined JSR subroutine. subroutine.addEdgeAndExplore(basicBlock, handle.getNext(), JSR_EDGE); endOfBasicBlock = true; } else if (opcode == Constants.RET) { // End of JSR subroutine subroutine.addEdge(basicBlock, subroutine.getExit(), RET_EDGE); endOfBasicBlock = true; } else { TargetEnumeratingVisitor visitor = new TargetEnumeratingVisitor(handle, cpg); if (visitor.isEndOfBasicBlock()) { endOfBasicBlock = true; // Add control edges as appropriate if (visitor.instructionIsThrow()) { handleExceptions(subroutine, handle, basicBlock); } else if (visitor.instructionIsExit()) { subroutine.setExitBlock(basicBlock); } else if (visitor.instructionIsReturn()) { subroutine.setReturnBlock(basicBlock); } else { Iterator<Target> i = visitor.targetIterator(); while (i.hasNext()) { Target target = i.next(); subroutine.addEdgeAndExplore(basicBlock, target.getTargetInstruction(), target.getEdgeType()); } } } } if (!endOfBasicBlock) { InstructionHandle next = handle.getNext(); if (next == null) throw new CFGBuilderException("Control falls off end of method: " + handle); // Is the next instruction a control merge or a PEI? if (isMerge(next) || isPEI(next)) { subroutine.addEdgeAndExplore(basicBlock, next, FALL_THROUGH_EDGE); endOfBasicBlock = true; } else { // Basic block continues handle = next; } } } while (!endOfBasicBlock); } } /** * Add exception edges for given instruction. * * @param subroutine the subroutine containing the instruction * @param pei the instruction which throws an exception * @param etb the exception thrower block (ETB) for the instruction */ private void handleExceptions(Subroutine subroutine, InstructionHandle pei, BasicBlock etb) { etb.setExceptionThrower(pei); // Remember whether or not a universal exception handler // is reachable. If so, then we know that exceptions raised // at this instruction cannot propagate out of the method. boolean sawUniversalExceptionHandler = false; List<CodeExceptionGen> exceptionHandlerList = exceptionHandlerMap.getHandlerList(pei); if (exceptionHandlerList != null) { for (CodeExceptionGen exceptionHandler : exceptionHandlerList) { InstructionHandle handlerStart = exceptionHandler.getHandlerPC(); subroutine.addEdgeAndExplore(etb, handlerStart, HANDLED_EXCEPTION_EDGE); if (Hierarchy.isUniversalExceptionHandler(exceptionHandler.getCatchType())) sawUniversalExceptionHandler = true; } } // If required, mark this block as throwing an unhandled exception. // For now, we assume that if there is no reachable handler that handles // ANY exception type, then the exception can be thrown out of the method. if (!sawUniversalExceptionHandler) { if (DEBUG) System.out.println("Adding unhandled exception edge from " + pei); subroutine.setUnhandledExceptionBlock(etb); } } /** * Return whether or not the given instruction can throw exceptions. * * @param handle the instruction * @return true if the instruction can throw an exception, false otherwise */ private boolean isPEI(InstructionHandle handle) { Instruction ins = handle.getInstruction(); if (!(ins instanceof ExceptionThrower)) return false; if (ins instanceof NEW) return false; // if (ins instanceof ATHROW) return false; if (ins instanceof GETSTATIC) return false; if (ins instanceof PUTSTATIC) return false; if (ins instanceof ReturnInstruction) return false; if (ins instanceof INSTANCEOF) return false; // if (ins instanceof INVOKESTATIC) return false; // if (ins instanceof MONITORENTER) return false; if (ins instanceof MONITOREXIT) return false; return true; } /** * Determine whether or not the given instruction is a control flow merge. * * @param handle the instruction * @return true if the instruction is a control merge, false otherwise */ private static boolean isMerge(InstructionHandle handle) { if (handle.hasTargeters()) { // Check all targeters of this handle to see if any // of them are branches. If so, the instruction is a merge. InstructionTargeter[] targeterList = handle.getTargeters(); for (InstructionTargeter targeter : targeterList) { if (targeter instanceof BranchInstruction) return true; } } return false; } /** * Inline all JSR subroutines into the top-level subroutine. * This produces a complete CFG for the entire method, in which * all JSR subroutines are inlined. * * @return the CFG for the method */ private CFG inlineAll() throws CFGBuilderException { CFG result = new CFG(); Context rootContext = new Context(null, topLevelSubroutine, result); rootContext.mapBlock(topLevelSubroutine.getEntry(), result.getEntry()); rootContext.mapBlock(topLevelSubroutine.getExit(), result.getExit()); BasicBlock resultStartBlock = rootContext.getBlock(topLevelSubroutine.getStartBlock()); result.createEdge(result.getEntry(), resultStartBlock, START_EDGE); inline(rootContext); return result; } /** * Inline a subroutine into a calling context. * * @param context the Context */ public void inline(Context context) throws CFGBuilderException { CFG result = context.getResult(); // Check to ensure we're not trying to inline something that is recursive context.checkForRecursion(); Subroutine subroutine = context.getSubroutine(); CFG subCFG = subroutine.getCFG(); while (context.hasMoreWork()) { BasicBlock subBlock = context.nextItem(); BasicBlock resultBlock = context.getBlock(subBlock); // Mark blocks which are in JSR subroutines resultBlock.setInJSRSubroutine(context.getCaller() != null); // Copy instructions into the result block BasicBlock.InstructionIterator insIter = subBlock.instructionIterator(); while (insIter.hasNext()) { InstructionHandle handle = insIter.next(); resultBlock.addInstruction(handle); } // Set exception thrower status if (subBlock.isExceptionThrower()) resultBlock.setExceptionThrower(subBlock.getExceptionThrower()); // Set exception handler status if (subBlock.isExceptionHandler()) resultBlock.setExceptionGen(subBlock.getExceptionGen()); // Add control edges (including inlining JSR subroutines) Iterator<Edge> edgeIter = subCFG.outgoingEdgeIterator(subBlock); while (edgeIter.hasNext()) { Edge edge = edgeIter.next(); int edgeType = edge.getType(); if (edgeType == JSR_EDGE) { // Inline a JSR subroutine... // Create a new Context InstructionHandle jsrHandle = subBlock.getLastInstruction(); JsrInstruction jsr = (JsrInstruction) jsrHandle.getInstruction(); Subroutine jsrSub = jsrSubroutineMap.get(jsr.getTarget()); Context jsrContext = new Context(context, jsrSub, context.getResult()); // The start block in the JSR subroutine maps to the first // inlined block in the result CFG. BasicBlock resultJSRStartBlock = jsrContext.getBlock(jsrSub.getStartBlock()); result.createEdge(resultBlock, resultJSRStartBlock, GOTO_EDGE); // The exit block in the JSR subroutine maps to the result block // corresponding to the instruction following the JSR. // (I.e., that is where control returns after the execution of // the JSR subroutine.) BasicBlock subJSRSuccessorBlock = subroutine.getBlock(jsrHandle.getNext()); BasicBlock resultJSRSuccessorBlock = context.getBlock(subJSRSuccessorBlock); jsrContext.mapBlock(jsrSub.getExit(), resultJSRSuccessorBlock); // Inline the JSR subroutine inline(jsrContext); } else { // Ordinary control edge BasicBlock resultTarget = context.getBlock(edge.getTarget()); result.createEdge(resultBlock, resultTarget, edge.getType()); } } // Add control edges for escape targets Iterator<EscapeTarget> escapeTargetIter = subroutine.escapeTargetIterator(subBlock); while (escapeTargetIter.hasNext()) { EscapeTarget escapeTarget = escapeTargetIter.next(); InstructionHandle targetInstruction = escapeTarget.getTarget(); // Look for the calling context which has the target instruction Context caller = context.getCaller(); while (caller != null) { if (caller.getSubroutine().containsInstruction(targetInstruction)) break; caller = caller.getCaller(); } if (caller == null) throw new CFGBuilderException("Unknown caller for escape target " + targetInstruction + " referenced by " + context.getSubroutine().getStartInstruction()); // Find result block in caller BasicBlock subCallerTargetBlock = caller.getSubroutine().getBlock(targetInstruction); BasicBlock resultCallerTargetBlock = caller.getBlock(subCallerTargetBlock); // Add an edge to caller context result.createEdge(resultBlock, resultCallerTargetBlock, escapeTarget.getEdgeType()); } // If the block returns from the method, add a return edge if (subroutine.isReturnBlock(subBlock)) { result.createEdge(resultBlock, result.getExit(), RETURN_EDGE); } // If the block calls System.exit(), add an exit edge if (subroutine.isExitBlock(subBlock)) { result.createEdge(resultBlock, result.getExit(), EXIT_EDGE); } // If the block throws an unhandled exception, add an unhandled // exception edge if (subroutine.isUnhandledExceptionBlock(subBlock)) { result.createEdge(resultBlock, result.getExit(), UNHANDLED_EXCEPTION_EDGE); } } /* while (blocks are left) { get block from subroutine get corresponding block from result copy instructions into result block if (block terminated by JSR) { get JSR subroutine create new context create GOTO edge from current result block to start block of new inlined context map subroutine exit block to result JSR successor block inline (new context, result) } else { for each outgoing edge { map each target to result blocks (add block to to work list if needed) add edges to result } for each outgoing escape target { add edges into blocks in outer contexts (adding those blocks to outer work list if needed) } if (block returns) { add return edge from result block to result CFG exit block } if (block calls System.exit()) { add exit edge from result block to result CFG exit block } if (block throws unhandled exception) { add unhandled exception edge from result block to result CFG exit block } } } */ } /** * Test driver. */ public static void main(String[] argv) throws Exception { if (argv.length != 1) { System.err.println("Usage: " + BetterCFGBuilder2.class.getName() + " <class file>"); System.exit(1); } String methodName = SystemProperties.getProperty("cfgbuilder.method"); JavaClass jclass = new ClassParser(argv[0]).parse(); ClassGen classGen = new ClassGen(jclass); Method[] methodList = jclass.getMethods(); for (Method method : methodList) { if (method.isAbstract() || method.isNative()) continue; if (methodName != null && !method.getName().equals(methodName)) continue; MethodGen methodGen = new MethodGen(method, jclass.getClassName(), classGen.getConstantPool()); CFGBuilder cfgBuilder = new BetterCFGBuilder2(methodGen); cfgBuilder.build(); CFG cfg = cfgBuilder.getCFG(); CFGPrinter cfgPrinter = new CFGPrinter(cfg); System.out.println("---------------------------------------------------------------------"); System.out.println("Method: " + SignatureConverter.convertMethodSignature(methodGen)); System.out.println("---------------------------------------------------------------------"); cfgPrinter.print(System.out); } } } // vim:ts=4

The table below shows all metrics for BetterCFGBuilder2.java.

MetricValueDescription
BLOCKS89.00Number of blocks
BLOCK_COMMENT68.00Number of block comment lines
COMMENTS373.00Comment lines
COMMENT_DENSITY 0.95Comment density
COMPARISONS59.00Number of comparison operators
CYCLOMATIC114.00Cyclomatic complexity
DECL_COMMENTS58.00Comments in declarations
DOC_COMMENT243.00Number of javadoc comment lines
ELOC392.00Effective lines of code
EXEC_COMMENTS43.00Comments in executable code
EXITS131.00Procedure exits
FUNCTIONS48.00Number of function declarations
HALSTEAD_DIFFICULTY79.16Halstead difficulty
HALSTEAD_EFFORT 0.00Halstead effort
INTERFACE_COMPLEXITY109.00Interface complexity
JAVA0001 0.00JAVA0001 Package name does not contain only lower case letters
JAVA0002 0.00JAVA0002 Package name does not begin with a top level domain name or country code
JAVA0003 0.00JAVA0003 Minimize use of on-demand (.*) imports
JAVA0004 0.00JAVA0004 Unnecessary import from java.lang
JAVA0005 0.00JAVA0005 Imports not in specified order
JAVA0006 0.00JAVA0006 Empty finally block
JAVA0007 0.00JAVA0007 Should not declare public field
JAVA0008 0.00JAVA0008 Empty catch block
JAVA0009 0.00JAVA0009 Protected member in final class
JAVA0010 0.00JAVA0010 Non-instantiable class does not contain a non-private static member
JAVA0011 0.00JAVA0011 Abstract class does not contain an abstract method
JAVA0012 0.00JAVA0012 Non-constructor method with same name as declaring class
JAVA0013 0.00JAVA0013 Non-blank final field is not static
JAVA0014 0.00JAVA0014 Class with only static members has non-private constructor
JAVA0015 0.00JAVA0015 Package class contains public nested type
JAVA0016 0.00JAVA0016 Abstract class contains public constructor
JAVA0017 0.00JAVA0017 Class name does not have required form
JAVA0018 0.00JAVA0018 Method name does not have required form
JAVA0019 0.00JAVA0019 Interface name does not have required form
JAVA0020 0.00JAVA0020 Field name does not have required form
JAVA0021 0.00JAVA0021 Interface method name does not have required form
JAVA0022 0.00JAVA0022 Static final field name does not have required form
JAVA0023 0.00JAVA0023 Empty finalize method
JAVA0024 0.00JAVA0024 Empty class
JAVA0025 0.00JAVA0025 Method override is empty
JAVA0026 0.00JAVA0026 Finalize method with parameters
JAVA0029 0.00JAVA0029 Private method not used
JAVA0030 0.00JAVA0030 Private field not used
JAVA0031 0.00JAVA0031 Case statement not properly closed
JAVA0032 0.00JAVA0032 Switch statement missing default
JAVA0033 0.00JAVA0033 default: not last case in switch statement
JAVA003428.00JAVA0034 Missing braces in if statement
JAVA0035 0.00JAVA0035 Missing braces in for statement
JAVA0036 0.00JAVA0036 Missing braces in while statement
JAVA0038 0.00JAVA0038 Non-case label in switch statement
JAVA0039 0.00JAVA0039 Break statement with label
JAVA0040 0.00JAVA0040 Switch statement contains N cases (maximum: M)
JAVA0041 0.00JAVA0041 Nested synchronized block
JAVA0042 0.00JAVA0042 Empty synchronized statement
JAVA0043 0.00JAVA0043 Inner class does not use outer class
JAVA0044 0.00JAVA0044 Serializable class with no instance variables
JAVA0045 0.00JAVA0045 Serializable class with only transient fields
JAVA0046 0.00JAVA0046 Name of class not derived from Exception ends with 'Exception'
JAVA0047 0.00JAVA0047 Serializable class derives from invalid base class
JAVA0048 0.00JAVA0048 Name of class derived from Exception does not end with 'Exception'
JAVA0049 4.00JAVA0049 Nested block at depth N (maximum: M)
JAVA0050 0.00JAVA0050 Class derives from java.lang.Error
JAVA0051 0.00JAVA0051 Class derives from java.lang.RuntimeException
JAVA0052 0.00JAVA0052 Class derives from java.lang.Throwable
JAVA0053 0.00JAVA0053 Unused label
JAVA0054 0.00JAVA0054 Inheritance depth N exceeds maximum M
JAVA0055 0.00JAVA0055 Class should be interface
JAVA0056 0.00JAVA0056 Unnecessary abstract modifier for interface or annotation
JAVA0057 0.00JAVA0057 Unnecessary default constructor
JAVA0058 0.00JAVA0058 Constructor calls super()
JAVA0059 0.00JAVA0059 Method override only calls super()
JAVA0061 0.00JAVA0061 Inaccessible member in anonymous class
JAVA0062 0.00JAVA0062 Public class missing public member or protected constructor
JAVA0063 0.00JAVA0063 Identifier name should not contain '$'
JAVA0064 0.00JAVA0064 N variations of identifier name (maximum: M)
JAVA0065 0.00JAVA0065 Unnecessary final modifier for method in final class
JAVA0066 0.00JAVA0066 Unnecessary modifier for interface nested type
JAVA0067 0.00JAVA0067 Array descriptor on identifier name
JAVA0068 0.00JAVA0068 Modifiers not declared in recommended order
JAVA0071 0.00JAVA0071 Strings compared with ==
JAVA0073 0.00JAVA0073 Integer division in floating-point context
JAVA0074 0.00JAVA0074 Use of Object.notify()
JAVA0075 1.00JAVA0075 Method parameter hides field
JAVA0076 0.00JAVA0076 Use of magic number
JAVA0077 1.00JAVA0077 Private field not used in declaring class
JAVA0078 0.00JAVA0078 Floating point values compared with ==
JAVA0079 0.00JAVA0079 Use of instance to reference static member
JAVA0080 0.00JAVA0080 Import declaration not used
JAVA0081 0.00JAVA0081 Boolean literal in comparison
JAVA0082 0.00JAVA0082 Unnecessary widening cast
JAVA0083 0.00JAVA0083 Unnecessary instanceof test
JAVA0084 0.00JAVA0084 Should use compound assignment operator
JAVA0085 0.00JAVA0085 Use of sun.* class
JAVA0087 0.00JAVA0087 Use of Thread.sleep()
JAVA0089 0.00JAVA0089 Use of restricted package
JAVA0092 0.00JAVA0092 Use of restricted type
JAVA0093 0.00JAVA0093 Redundant assignment
JAVA0094 0.00JAVA0094 Field hides a superclass field
JAVA0095 0.00JAVA0095 Uninitialized private field
JAVA0096 1.00JAVA0096 Field in nested class hides outer field
JAVA0098 0.00JAVA0098 Minimize use of implicit field initializers
JAVA0100 0.00JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101 0.00JAVA0101 Unnecessary modifier for field in interface
JAVA0102 0.00JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103 0.00JAVA0103 Explicit call to finalize()
JAVA0104 0.00JAVA0104 finalize() only calls super.finalize()
JAVA0105 0.00JAVA0105 Duplicate import declaration
JAVA0106 0.00JAVA0106 Unnecessary import from current package
JAVA0108 7.00JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109 0.00JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA011021.00JAVA0110 Incorrect javadoc: no @return tag
JAVA0111 0.00JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112 0.00JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113 0.00JAVA0113 Incorrect javadoc: no @author tag
JAVA0114 1.00JAVA0114 Incorrect javadoc: no @version tag
JAVA0115 6.00JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116 0.00JAVA0116 Missing javadoc: field 'field'
JAVA0117 0.00JAVA0117 Missing javadoc: method 'method'
JAVA0118 0.00JAVA0118 Missing javadoc: type 'type'
JAVA0119 0.00JAVA0119 Control variable changed within body of for loop
JAVA0123 0.00JAVA0123 Use all three components of for loop
JAVA0125 0.00JAVA0125 Continue statement with label
JAVA0126 0.00JAVA0126 Method declares unchecked exception in throws
JAVA0128 4.00JAVA0128 Public constructor in non-public class
JAVA0130 1.00JAVA0130 Non-static method does not use instance fields
JAVA0131 0.00JAVA0131 Compatible method does not override base
JAVA0132 0.00JAVA0132 Method overload with compatible signature
JAVA0133 0.00JAVA0133 Non-synchronized method overrides synchronized method
JAVA0135 0.00JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method'
JAVA0136 1.00JAVA0136 N methods defined in class (maximum: M)
JAVA0137 0.00JAVA0137 Non-abstract class missing constructor
JAVA0138 0.00JAVA0138 N parameters defined for method (maximum: M)
JAVA0139 1.00JAVA0139 Definition of main other than public static void main(java.lang.String[])
JAVA0141 0.00JAVA0141 Unnecessary modifier for method in interface
JAVA0143 0.00JAVA0143 Synchronized method
JAVA0144 0.00JAVA0144 Line exceeds maximum M characters
JAVA01452078.00JAVA0145 Tab character used in source file
JAVA0150 0.00JAVA0150 java.lang.Error (or subclass) thrown
JAVA0153 0.00JAVA0153 Inefficient conversion of integer to string
JAVA0159 0.00JAVA0159 Inefficient conversion of string to integer
JAVA0160 0.00JAVA0160 Method does not throw specified exception
JAVA0161 0.00JAVA0161 Conditional wait() not in loop
JAVA0163 0.00JAVA0163 Empty statement
JAVA0165 0.00JAVA0165 Conflicting return statement in finally block
JAVA0166 0.00JAVA0166 Generic exception caught
JAVA0167 0.00JAVA0167 ThreadDeath not rethrown
JAVA0169 0.00JAVA0169 Unnecessary catch block: exception 'exception'
JAVA0170 0.00JAVA0170 Caught exception not derived from java.lang.Exception
JAVA0171 0.00JAVA0171 Unused local variable
JAVA0173 0.00JAVA0173 Unused method parameter
JAVA0174 0.00JAVA0174 Assigned local variable never used
JAVA0175 0.00JAVA0175 Successive assignment to variable
JAVA0176 0.00JAVA0176 Local variable name does not have required form
JAVA0177 0.00JAVA0177 Variable declaration missing initializer
JAVA0179 0.00JAVA0179 Local variable hides visible field
JAVA0233 0.00JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0234 0.00JAVA0234 Class is Serializable but does not define serialVersionUID
JAVA0235 0.00JAVA0235 Class defines serialVersionUID but does not implement Serializable
JAVA0236 0.00JAVA0236 Attempt to clone an object which does not implement Cloneable
JAVA0237 0.00JAVA0237 Class implements Cloneable but does not have public clone method
JAVA0238 0.00JAVA0238 Clone method does not call super.clone()
JAVA0239 0.00JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable
JAVA0240 0.00JAVA0240 Serializable class which declares readObject or writeObject but not both
JAVA0241 0.00JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class
JAVA0242 0.00JAVA0242 Transient field in non-Serializable class
JAVA0243 0.00JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected
JAVA0244 0.00JAVA0244 Field or method name in subclass differs only by case from inherited field or method
JAVA0245 0.00JAVA0245 JUnit TestCase with non-trivial constructor
JAVA0246 0.00JAVA0246 JUnit assertXXX statement missing message parameter
JAVA0247 0.00JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method
JAVA0248 0.00JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature
JAVA0249 0.00JAVA0249 JUnit TestCase 'suite()' should be declared static
JAVA0250 0.00JAVA0250 JUnit TestCase declares testXXX method with incorrect signature
JAVA0251 0.00JAVA0251 Use '%n' for line breaks in printf/format for platform independence
JAVA0252 0.00JAVA0252 'enum' is a Java 1.5 reserved word
JAVA0253 0.00JAVA0253 Not all enum constants consumed in switch statement
JAVA0254 4.00JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0255 0.00JAVA0255 Result of method invocation not used
JAVA0256 0.00JAVA0256 Assignment of external collection/array to field
JAVA0257 2.00JAVA0257 Use of 'Constant Interface' anti-pattern
JAVA0258 1.00JAVA0258 Implement Iterable for foreach compatibility
JAVA0259 0.00JAVA0259 Return of collection/array field
JAVA0260 0.00JAVA0260 Use 'enum' instead of Enumerated Type pattern
JAVA0261 0.00JAVA0261 Use specialized Enum collection types
JAVA0262 0.00JAVA0262 Use of char in integer context
JAVA0263 0.00JAVA0263 Long literal ends with 'l' instead of 'L'
JAVA0264 0.00JAVA0264 Integer math in long context - check for overflow
JAVA0265 0.00JAVA0265 Use of Throwable.printStackTrace()
JAVA0266 9.00JAVA0266 Use of System.out
JAVA0267 1.00JAVA0267 Use of System.err
JAVA0269 0.00JAVA0269 Contents of StringBuffer never used
JAVA0270 0.00JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0271 0.00JAVA0271 Minimize use of on-demand (.*) static imports
JAVA0272 0.00JAVA0272 Thread.run() called
JAVA0273 0.00JAVA0273 Non-final derivative of Thread calls start() in constructor
JAVA0274 0.00JAVA0274 Serializable class has a synchronized readObject()
JAVA0275 0.00JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods
JAVA0276 0.00JAVA0276 Unnecessary use of String constructor
JAVA0277 0.00JAVA0277 Iterator.next() implementation does not throw NoSuchElementException
JAVA0278 0.00JAVA0278 Unnecessary use of Boolean constructor
JAVA0279 0.00JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
JAVA0280 0.00JAVA0280 IllegalMonitorStateException caught
JAVA0281 0.00JAVA0281 Iterator.next() not called in loop
JAVA0282 0.00JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext()
JAVA0283 0.00JAVA0283 Control variable not updated in loop body
JAVA0284 0.00JAVA0284 Explicit garbage collection
JAVA0285 0.00JAVA0285 Dereference of potentially null variable
JAVA0286 0.00JAVA0286 Dereference of null variable
JAVA0287 0.00JAVA0287 Unnecessary null check
JAVA0288 0.00JAVA0288 Inconsistent null check
LINES981.00Number of lines in the source file
LINE_COMMENT62.00Number of line comments
LOC477.00Lines of code
LOGICAL_LINES277.00Number of statements
LOOPS10.00Number of loops
NEST_DEPTH 7.00Maximum nesting depth
OPERANDS1273.00Number of operands
OPERATORS2280.00Number of operators
PARAMS38.00Number of formal parameter declarations
PROGRAM_LENGTH3553.00Halstead program length
PROGRAM_VOCAB443.00Halstead program vocabulary
PROGRAM_VOLUME 0.00Halstead program volume
RETURNS71.00Number of return points from functions
SIZE31376.00Size of the file in bytes
UNIQUE_OPERANDS394.00Number of unique operands
UNIQUE_OPERATORS49.00Number of unique operators
WHITESPACE131.00Number of whitespace lines