soot.jimple.toolkits.pointer

Class LocalMustNotAliasAnalysis

java.lang.Object

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

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

soot.toolkits.scalar.ForwardFlowAnalysis<Unit,HashMap<Local,Set<NewExpr>>>

soot.jimple.toolkits.pointer.LocalMustNotAliasAnalysis

public class LocalMustNotAliasAnalysis
extends ForwardFlowAnalysis<Unit,HashMap<Local,Set<NewExpr>>>

LocalNotMayAliasAnalysis attempts to determine if two local variables (at two potentially different program points) definitely point to different objects. The underlying abstraction is that of definition expressions. When a local variable gets assigned a new object (unlike LocalMust, only NewExprs), the analysis tracks the source of the value. If two variables have different sources, then they are different. See Sable TR 2007-8 for details.

Author:

Patrick Lam

Nested Class Summary

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

FlowAnalysis.Flow

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<Local>	locals
protected static NewExpr	UNKNOWN

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
LocalMustNotAliasAnalysis(DirectedGraph<Unit> directedGraph, Body b)
LocalMustNotAliasAnalysis(UnitGraph g)

Method Summary

Modifier and Type	Method and Description
RefType	concreteType(Local l, Stmt s) If the given local at the given statement was initialized with a single, concrete new-expression then the type of this expression is returned.
protected void	copy(HashMap<Local,Set<NewExpr>> source, HashMap<Local,Set<NewExpr>> dest) Creates a copy of the source flow object in dest.
protected HashMap<Local,Set<NewExpr>>	entryInitialFlow() Returns the initial flow value for entry/exit graph nodes.
protected void	flowThrough(HashMap<Local,Set<NewExpr>> in, Unit unit, HashMap<Local,Set<NewExpr>> out) Given the merge of the out sets, compute the in set for s (or in to out, depending on direction).
boolean	hasInfoOn(Local l, Stmt s) Returns true if this analysis has any information about local l at statement s (i.e.
protected void	merge(HashMap<Local,Set<NewExpr>> in1, HashMap<Local,Set<NewExpr>> in2, HashMap<Local,Set<NewExpr>> o) Compute the merge of the in1 and in2 sets, putting the result into out.
protected HashMap<Local,Set<NewExpr>>	newInitialFlow() Returns the flow object corresponding to the initial values for each graph node.
boolean	notMayAlias(Local l1, Stmt s1, Local l2, Stmt s2)

Methods inherited from class soot.toolkits.scalar.ForwardFlowAnalysis

doAnalysis, isForward

Methods inherited from class soot.toolkits.scalar.FlowAnalysis

copyFreshToExisting, 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

Field Detail

UNKNOWN

protected static final NewExpr UNKNOWN

locals

protected final Set<Local> locals

Constructor Detail

LocalMustNotAliasAnalysis

public LocalMustNotAliasAnalysis(UnitGraph g)

LocalMustNotAliasAnalysis

public LocalMustNotAliasAnalysis(DirectedGraph<Unit> directedGraph,
                                 Body b)

Method Detail

merge

protected void merge(HashMap<Local,Set<NewExpr>> in1,
                     HashMap<Local,Set<NewExpr>> in2,
                     HashMap<Local,Set<NewExpr>> o)

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,HashMap<Local,Set<NewExpr>>>

flowThrough

protected void flowThrough(HashMap<Local,Set<NewExpr>> in,
                           Unit unit,
                           HashMap<Local,Set<NewExpr>> out)

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,HashMap<Local,Set<NewExpr>>>

Parameters:

in - the input flow

unit - the current node

out - the returned flow

copy

protected void copy(HashMap<Local,Set<NewExpr>> source,
                    HashMap<Local,Set<NewExpr>> dest)

Description copied from class: AbstractFlowAnalysis

Creates a copy of the source flow object in dest.

Specified by:

copy in class AbstractFlowAnalysis<Unit,HashMap<Local,Set<NewExpr>>>

entryInitialFlow

protected HashMap<Local,Set<NewExpr>> 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,HashMap<Local,Set<NewExpr>>>

newInitialFlow

protected HashMap<Local,Set<NewExpr>> 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,HashMap<Local,Set<NewExpr>>>

hasInfoOn

public boolean hasInfoOn(Local l,
                         Stmt s)

Returns true if this analysis has any information about local l at statement s (i.e. it is not UNKNOWN). In particular, it is safe to pass in locals/statements that are not even part of the right method. In those cases false will be returned. Permits s to be null, in which case false will be returned.

notMayAlias

public boolean notMayAlias(Local l1,
                           Stmt s1,
                           Local l2,
                           Stmt s2)

Returns:

true if values of l1 (at s1) and l2 (at s2) are known to point to different objects

concreteType

public RefType concreteType(Local l,
                            Stmt s)

If the given local at the given statement was initialized with a single, concrete new-expression then the type of this expression is returned. Otherwise this method returns null.