soot.toolkits.scalar

Class CombinedDUAnalysis

java.lang.Object

soot.toolkits.scalar.AbstractFlowAnalysis<N,A>

soot.toolkits.scalar.FlowAnalysis<N,A>

soot.toolkits.scalar.BackwardFlowAnalysis<Unit,FlowSet<ValueBox>>

soot.toolkits.scalar.CombinedDUAnalysis

All Implemented Interfaces:

CombinedAnalysis, LiveLocals, LocalDefs, LocalUses

public class CombinedDUAnalysis
extends BackwardFlowAnalysis<Unit,FlowSet<ValueBox>>
implements CombinedAnalysis, LocalDefs, LocalUses, LiveLocals

Analysis that computes live locals, local defs, and local uses all at once. SA, 09.09.2014: Inefficient as hell (memory). Use the distinct analyses or fix this class before using it.

Nested Class Summary

Nested classes/interfaces inherited from class soot.toolkits.scalar.FlowAnalysis

FlowAnalysis.Flow

Nested classes/interfaces inherited from interface soot.toolkits.scalar.LocalDefs

LocalDefs.Factory

Nested classes/interfaces inherited from interface soot.toolkits.scalar.LocalUses

LocalUses.Factory

Nested classes/interfaces inherited from interface soot.toolkits.scalar.LiveLocals

LiveLocals.Factory

Field Summary

Fields inherited from class soot.toolkits.scalar.FlowAnalysis

filterUnitToAfterFlow, unitToAfterFlow

Fields inherited from class soot.toolkits.scalar.AbstractFlowAnalysis

filterUnitToBeforeFlow, graph, unitToBeforeFlow

Constructor Summary

Constructors

Constructor and Description
CombinedDUAnalysis(UnitGraph graph)

Method Summary

Modifier and Type	Method and Description
protected void	copy(FlowSet<ValueBox> source, FlowSet<ValueBox> dest) Creates a copy of the source flow object in dest.
protected FlowSet<ValueBox>	entryInitialFlow() Returns the initial flow value for entry/exit graph nodes.
protected void	flowThrough(FlowSet<ValueBox> out, Unit u, FlowSet<ValueBox> in) Given the merge of the out sets, compute the in set for s (or in to out, depending on direction).
java.util.List<Unit>	getDefsOf(Local l) Returns the definition sites for a Local merged over all points in a method.
java.util.List<Unit>	getDefsOfAt(Local l, Unit s) Returns the definition sites for a Local at a certain point (Unit) in a method.
java.util.List<Local>	getLiveLocalsAfter(Unit u) Returns the list of Locals that are live after the specified Unit.
java.util.List<Local>	getLiveLocalsBefore(Unit u) Returns the list of Locals that are live before the specified Unit.
java.util.List<UnitValueBoxPair>	getUsesOf(Unit u) Returns a list of the Units that use the Local that is defined by a given Unit.
protected void	merge(FlowSet<ValueBox> inout, FlowSet<ValueBox> in)
protected void	merge(FlowSet<ValueBox> in1, FlowSet<ValueBox> in2, FlowSet<ValueBox> out) Compute the merge of the in1 and in2 sets, putting the result into out.
protected FlowSet<ValueBox>	newInitialFlow() Returns the flow object corresponding to the initial values for each graph node.

Methods inherited from class soot.toolkits.scalar.BackwardFlowAnalysis

doAnalysis, isForward

Methods inherited from class soot.toolkits.scalar.FlowAnalysis

getFlow, getFlowAfter, getFlowBefore, omissible

Methods inherited from class soot.toolkits.scalar.AbstractFlowAnalysis

merge, mergeInto, treatTrapHandlersAsEntries

Methods inherited from class java.lang.Object

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

Constructor Detail

CombinedDUAnalysis

public CombinedDUAnalysis(UnitGraph graph)

Method Detail

getDefsOfAt

public java.util.List<Unit> getDefsOfAt(Local l,
                                        Unit s)

Description copied from interface: LocalDefs

Returns the definition sites for a Local at a certain point (Unit) in a method. You can assume this method never returns null.

Specified by:

getDefsOfAt in interface LocalDefs

Parameters:

l - the Local in question.

s - a unit that specifies the method context (location) to query for the definitions of the Local.

Returns:

a list of Units where the local is defined in the current method context. If there are no uses an empty list will returned.

getDefsOf

public java.util.List<Unit> getDefsOf(Local l)

Description copied from interface: LocalDefs

Returns the definition sites for a Local merged over all points in a method. You can assume this method never returns null.

Specified by:

getDefsOf in interface LocalDefs

Parameters:

l - the Local in question.

Returns:

a list of Units where the local is defined in the current method context. If there are no uses an empty list will returned.

getUsesOf

public java.util.List<UnitValueBoxPair> getUsesOf(Unit u)

Description copied from interface: LocalUses

Returns a list of the Units that use the Local that is defined by a given Unit.

Specified by:

getUsesOf in interface LocalUses

Parameters:

u - the unit we wish to query for the use of the Local it defines.

Returns:

a list of the Local's uses.

getLiveLocalsBefore

public java.util.List<Local> getLiveLocalsBefore(Unit u)

Description copied from interface: LiveLocals

Returns the list of Locals that are live before the specified Unit.

Specified by:

getLiveLocalsBefore in interface LiveLocals

Parameters:

u - the Unit that defines this query.

Returns:

a list of Locals that are live before the specified unit in the method.

getLiveLocalsAfter

public java.util.List<Local> getLiveLocalsAfter(Unit u)

Description copied from interface: LiveLocals

Returns the list of Locals that are live after the specified Unit.

Specified by:

getLiveLocalsAfter in interface LiveLocals

Parameters:

u - the Unit that defines this query.

Returns:

a list of Locals that are live after the specified unit in the method.

merge

protected void merge(FlowSet<ValueBox> inout,
                     FlowSet<ValueBox> in)

merge

protected void merge(FlowSet<ValueBox> in1,
                     FlowSet<ValueBox> in2,
                     FlowSet<ValueBox> out)

Description copied from class: AbstractFlowAnalysis

Compute the merge of the in1 and in2 sets, putting the result into out. The behavior of this function depends on the implementation ( it may be necessary to check whether in1 and in2 are equal or aliased ). Used by the doAnalysis method.

Specified by:

merge in class AbstractFlowAnalysis<Unit,FlowSet<ValueBox>>

flowThrough

protected void flowThrough(FlowSet<ValueBox> out,
                           Unit u,
                           FlowSet<ValueBox> in)

Description copied from class: FlowAnalysis

Given the merge of the out sets, compute the in set for s (or in to out, depending on direction). This function often causes confusion, because the same interface is used for both forward and backward flow analyses. The first parameter is always the argument to the flow function (i.e. it is the "in" set in a forward analysis and the "out" set in a backward analysis), and the third parameter is always the result of the flow function (i.e. it is the "out" set in a forward analysis and the "in" set in a backward analysis).

Specified by:

flowThrough in class FlowAnalysis<Unit,FlowSet<ValueBox>>

Parameters:

out - the input flow

u - the current node

in - the returned flow

entryInitialFlow

protected FlowSet<ValueBox> entryInitialFlow()

Description copied from class: AbstractFlowAnalysis

Returns the initial flow value for entry/exit graph nodes. This is equal to AbstractFlowAnalysis.newInitialFlow()

Overrides:

entryInitialFlow in class AbstractFlowAnalysis<Unit,FlowSet<ValueBox>>

newInitialFlow

protected FlowSet<ValueBox> newInitialFlow()

Description copied from class: AbstractFlowAnalysis

Returns the flow object corresponding to the initial values for each graph node.

Specified by:

newInitialFlow in class AbstractFlowAnalysis<Unit,FlowSet<ValueBox>>

copy

protected void copy(FlowSet<ValueBox> source,
                    FlowSet<ValueBox> dest)

Description copied from class: AbstractFlowAnalysis

Creates a copy of the source flow object in dest.

Specified by:

copy in class AbstractFlowAnalysis<Unit,FlowSet<ValueBox>>