Package org.apache.bcel.verifier.structurals

Class Subroutines

  • public class Subroutines
extends java.lang.Object
    Instances of this class contain information about the subroutines found in a code array of a method. This implementation considers the top-level (the instructions reachable without a JSR or JSR_W starting off from the first instruction in a code array of a method) being a special subroutine; see getTopLevel() for that. Please note that the definition of subroutines in the Java Virtual Machine Specification, Second Edition is somewhat incomplete. Therefore, JustIce uses an own, more rigid notion. Basically, a subroutine is a piece of code that starts at the target of a JSR of JSR_W instruction and ends at a corresponding RET instruction. Note also that the control flow of a subroutine may be complex and non-linear; and that subroutines may be nested. JustIce also mandates subroutines not to be protected by exception handling code (for the sake of control flow predictability). To understand JustIce's notion of subroutines, please read TODO: refer to the paper.
    See Also:
    getTopLevel()

    • Field Summary

      Fields 
      Modifier and Type Field Description
      Subroutine TOPLEVEL
      This is referring to a special subroutine, namely the top level.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Subroutine getSubroutine​(InstructionHandle leader)
      Returns the Subroutine object associated with the given leader (that is, the first instruction of the subroutine).
      Subroutine getTopLevel()
      For easy handling, the piece of code that is not a subroutine, the top-level, is also modeled as a Subroutine object.
      Subroutine subroutineOf​(InstructionHandle any)
      Returns the subroutine object associated with the given instruction.
      java.lang.String toString()
      Returns a String representation of this object; merely for debugging puposes.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • TOPLEVEL

        public final Subroutine TOPLEVEL
        This is referring to a special subroutine, namely the top level. This is not really a subroutine but we use it to distinguish between top level instructions and unreachable instructions.

    • Constructor Detail

      • Subroutines

        public Subroutines​(MethodGen mg)
        Constructor.
        Parameters:
        mg - A MethodGen object representing method to create the Subroutine objects of. Assumes that JustIce strict checks are needed.

      • Subroutines

        public Subroutines​(MethodGen mg,
                   boolean enableJustIceCheck)
        Constructor.
        Parameters:
        mg - A MethodGen object representing method to create the Subroutine objects of.
        enableJustIceCheck - whether to enable additional JustIce checks
        Since:
        6.0

    • Method Detail

      • getSubroutine

        public Subroutine getSubroutine​(InstructionHandle leader)
        Returns the Subroutine object associated with the given leader (that is, the first instruction of the subroutine). You must not use this to get the top-level instructions modeled as a Subroutine object.
        See Also:
        getTopLevel()

      • subroutineOf

        public Subroutine subroutineOf​(InstructionHandle any)
        Returns the subroutine object associated with the given instruction. This is a costly operation, you should consider using getSubroutine(InstructionHandle). Returns 'null' if the given InstructionHandle lies in so-called 'dead code', i.e. code that can never be executed.
        See Also:
        getSubroutine(InstructionHandle), getTopLevel()

      • toString

        public java.lang.String toString()
        Returns a String representation of this object; merely for debugging puposes.
        Overrides:
        toString in class java.lang.Object