cetus.analysis

Class PointsToDomain

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<Symbol,java.util.HashSet<PointsToRel>>

cetus.analysis.PointsToDomain

All Implemented Interfaces:

Domain, java.io.Serializable, java.lang.Cloneable, java.util.Map<Symbol,java.util.HashSet<PointsToRel>>

public class PointsToDomain
extends java.util.LinkedHashMap<Symbol,java.util.HashSet<PointsToRel>>
implements Domain

PointsToDomain represents a set of pointer-relationships at a given program point, and is used by the Points-to Analyzer.

Implements the domain interface used by Cetus analysis passes for easier flexibility and sharing between passes. Specifically implements the merge, union, diff, intersect, kill and clone functionality.

Relationships inside of this domain are represented by PointsToRel.

See Also:

PointsToRel, Domain, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PointsToDomain.Universe The Universe Domain is associated with the Points-To Domain and hence the points-to analyzer.

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
PointsToDomain() Create an empty Domain constructor
PointsToDomain(PointsToRel p_rel) Create a domain with a single pointer relationship

Method Summary

Methods

Modifier and Type	Method and Description
void	addRel(PointsToRel p_rel) Add relationship to this domain
PointsToDomain	clone() Provides deep clone
boolean	containsPTR(PointsToRel ptr) Checks if the specified points-to relation is found.
Domain	diffStrong(Domain other) Returns a subtraction of the relationships that are identical in the other domain.
Domain	diffWeak(Domain other) Not supported
boolean	equals(Domain other) Compares equality based on set comparison for set of PointsToRel
Domain	intersect(Domain other) Extract all pointer relationships that are identical in the other points-to domain and return a domain representing the intersection
void	kill(java.util.Set<Symbol> vars) Not supported
Domain	killSet(java.util.Set<Symbol> exps) Provides a new Points-to domain that contains all the pointer relationships for the symbols provided as input to the kill Set.
Domain	merge(Domain other) Merge this domain with another.
static Domain	merge(Domain s1, Domain s2) Static method to merge two Points-to domains.
java.lang.String	toString()
java.lang.String	toString2()
Domain	union(Domain other) Union two points-to domains.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, get

Methods inherited from class java.util.HashMap

containsKey, entrySet, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

containsKey, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

PointsToDomain

public PointsToDomain()

Create an empty Domain constructor

PointsToDomain

public PointsToDomain(PointsToRel p_rel)

Create a domain with a single pointer relationship

Parameters:

p_rel -

Method Detail

clone

public PointsToDomain clone()

Provides deep clone

Specified by:

clone in interface Domain

Overrides:

clone in class java.util.HashMap<Symbol,java.util.HashSet<PointsToRel>>

Returns:

the cloned domain.

equals

public boolean equals(Domain other)

Compares equality based on set comparison for set of PointsToRel

Specified by:

equals in interface Domain

Parameters:

other - the domain to be compared.

Returns:

true if they are equal, false otherwise.

addRel

public void addRel(PointsToRel p_rel)

Add relationship to this domain

Parameters:

p_rel - Relationship to be added

union

public Domain union(Domain other)

Union two points-to domains. This functionality is used to combine points-to domains that may contain the same information, additional information is then combined together. Different from merge functionality.

Specified by:

union in interface Domain

Parameters:

other - Domain to union with

Returns:

a new Domain which represents the union

merge

public Domain merge(Domain other)

Merge this domain with another.

Specified by:

merge in interface Domain

Parameters:

other - Domain to merge with

Returns:

merged domain

merge

public static Domain merge(Domain s1,
           Domain s2)

Static method to merge two Points-to domains. Merge must handle types of relationships when combining the two domains, as opposed to a simple union. This functionality is used to combine information coming down different paths, and the new information must reflect the flow from more than one path.

Parameters:

s1 - First domain in the merge

s2 - Second domain in the merge

Returns:

merged domain

intersect

public Domain intersect(Domain other)

Extract all pointer relationships that are identical in the other points-to domain and return a domain representing the intersection

Specified by:

intersect in interface Domain

Parameters:

other - the domain to be intersected.

Returns:

the resulting Domain.

diffWeak

public Domain diffWeak(Domain other)

Not supported

Specified by:

diffWeak in interface Domain

Parameters:

other - the domain to be subtracted.

Returns:

the resulting Domain.

diffStrong

public Domain diffStrong(Domain other)

Returns a subtraction of the relationships that are identical in the other domain.

Specified by:

diffStrong in interface Domain

Parameters:

other - the domain to be subtracted.

Returns:

the resulting Domain.

kill

public void kill(java.util.Set<Symbol> vars)

Not supported

Specified by:

kill in interface Domain

Parameters:

vars - the input set of symbols.

killSet

public Domain killSet(java.util.Set<Symbol> exps)

Provides a new Points-to domain that contains all the pointer relationships for the symbols provided as input to the kill Set. The return domain relationships are the relationships that must be killed

Parameters:

exps - Symbols whose relationships must be killed

Returns:

the killed domain.

toString2

public java.lang.String toString2()

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractMap<Symbol,java.util.HashSet<PointsToRel>>

containsPTR

public boolean containsPTR(PointsToRel ptr)

Checks if the specified points-to relation is found.