1 package Analysis.OwnershipAnalysis;
9 public class TokenTupleSet extends Canonical {
11 private HashSet<TokenTuple> tokenTuples;
14 public TokenTupleSet() {
15 tokenTuples = new HashSet<TokenTuple>();
18 public TokenTupleSet(TokenTuple tt) {
24 public TokenTupleSet(TokenTupleSet tts) {
26 // okay to clone, TokenTuple and TokenTupleSet should be canonical
27 tokenTuples = (HashSet<TokenTuple>)tts.tokenTuples.clone();
31 public TokenTupleSet makeCanonical() {
32 return (TokenTupleSet) Canonical.makeCanonical(this);
35 public Iterator iterator() {
36 return tokenTuples.iterator();
39 public boolean isEmpty() {
40 return tokenTuples.isEmpty();
43 public boolean isSubset(TokenTupleSet ttsIn) {
45 return ttsIn.tokenTuples.containsAll(this.tokenTuples);
48 public boolean containsTuple(TokenTuple tt) {
50 return tokenTuples.contains(tt);
54 public TokenTupleSet union(TokenTupleSet ttsIn) {
56 TokenTupleSet ttsOut = new TokenTupleSet(this);
57 ttsOut.tokenTuples.addAll(ttsIn.tokenTuples);
58 return ttsOut.makeCanonical();
61 public TokenTupleSet unionUpArity(TokenTupleSet ttsIn) {
63 TokenTupleSet ttsOut = new TokenTupleSet();
65 Iterator<TokenTuple> ttItr = this.iterator();
66 while( ttItr.hasNext() ) {
67 TokenTuple tt = ttItr.next();
69 if( ttsIn.containsToken(tt.getToken() ) ) {
70 ttsOut.tokenTuples.add(tt.increaseArity());
72 ttsOut.tokenTuples.add(tt);
76 ttItr = ttsIn.iterator();
77 while( ttItr.hasNext() ) {
78 TokenTuple tt = ttItr.next();
80 if( !ttsOut.containsToken(tt.getToken()) ) {
81 ttsOut.tokenTuples.add(tt);
85 return ttsOut.makeCanonical();
88 public TokenTupleSet add(TokenTuple tt) {
90 TokenTupleSet ttsOut = new TokenTupleSet(tt);
91 return ttsOut.union(this);
95 // this should only be done with a multiple-object heap region's token!
96 public TokenTupleSet increaseArity(Integer token) {
98 TokenTupleSet ttsOut = new TokenTupleSet(this);
100 = new TokenTuple(token, true, TokenTuple.ARITY_ONE).makeCanonical();
101 if( ttsOut.tokenTuples.contains(tt) ) {
102 ttsOut.tokenTuples.remove(tt);
103 ttsOut.tokenTuples.add(
104 new TokenTuple(token, true, TokenTuple.ARITY_MANY).makeCanonical()
108 return ttsOut.makeCanonical();
112 public boolean equals(Object o) {
117 if( !(o instanceof TokenTupleSet) ) {
121 TokenTupleSet tts = (TokenTupleSet) o;
122 return tokenTuples.equals(tts.tokenTuples);
125 public int hashCode() {
126 return tokenTuples.hashCode();
130 // this should be a hash table so we can do this by key
131 public boolean containsToken(Integer token) {
132 assert token != null;
134 Iterator itr = tokenTuples.iterator();
135 while( itr.hasNext() ) {
136 TokenTuple tt = (TokenTuple) itr.next();
137 if( token.equals(tt.getToken() ) ) {
145 public TokenTupleSet ageTokens(AllocationSite as) {
148 TokenTupleSet ttsOut = new TokenTupleSet();
150 TokenTuple ttSummary = null;
151 boolean foundOldest = false;
153 Iterator itrT = this.iterator();
154 while( itrT.hasNext() ) {
155 TokenTuple tt = (TokenTuple) itrT.next();
157 Integer token = tt.getToken();
158 int age = as.getAgeCategory(token);
160 // tokens not associated with
161 // the site should be left alone
162 if( age == AllocationSite.AGE_notInThisSite ) {
163 ttsOut.tokenTuples.add(tt);
165 } else if( age == AllocationSite.AGE_summary ) {
166 // remember the summary tuple, but don't add it
167 // we may combine it with the oldest tuple
170 } else if( age == AllocationSite.AGE_oldest ) {
171 // found an oldest token, again just remember
176 assert age == AllocationSite.AGE_in_I;
178 Integer I = as.getAge(token);
181 // otherwise, we change this token to the
183 Integer tokenToChangeTo = as.getIthOldest(I + 1);
184 TokenTuple ttAged = tt.changeTokenTo(tokenToChangeTo);
185 ttsOut.tokenTuples.add(ttAged);
189 // there are four cases to consider here
190 // 1. we found a summary tuple and no oldest tuple
191 // Here we just pass the summary unchanged
192 // 2. we found an oldest tuple, no summary
193 // Make a new, arity-one summary tuple
194 // 3. we found both a summary and an oldest
195 // Merge them by increasing arity of summary
196 // 4. (not handled) we found neither, do nothing
197 if ( ttSummary != null && !foundOldest ) {
198 ttsOut.tokenTuples.add(ttSummary);
200 } else if( ttSummary == null && foundOldest ) {
201 ttsOut.tokenTuples.add(new TokenTuple(as.getSummary(),
203 TokenTuple.ARITY_ONE).makeCanonical() );
205 } else if( ttSummary != null && foundOldest ) {
206 ttsOut.tokenTuples.add(ttSummary.increaseArity() );
209 return ttsOut.makeCanonical();
213 public TokenTupleSet unshadowTokens(AllocationSite as) {
216 TokenTupleSet ttsOut = new TokenTupleSet();
218 TokenTuple ttSummary = null;
219 boolean foundShadowSummary = false;
221 Iterator itrT = this.iterator();
222 while( itrT.hasNext() ) {
223 TokenTuple tt = (TokenTuple) itrT.next();
225 Integer token = tt.getToken();
226 int shadowAge = as.getShadowAgeCategory(token);
228 if( shadowAge == AllocationSite.AGE_summary ) {
229 // remember the summary tuple, but don't add it
230 // we may combine it with the oldest tuple
233 } else if( shadowAge == AllocationSite.SHADOWAGE_notInThisSite ) {
234 ttsOut.tokenTuples.add(tt);
236 } else if( shadowAge == AllocationSite.SHADOWAGE_summary ) {
237 // found the shadow summary token, again just remember
239 foundShadowSummary = true;
241 } else if( shadowAge == AllocationSite.SHADOWAGE_oldest ) {
242 Integer tokenToChangeTo = as.getOldest();
243 TokenTuple ttNormal = tt.changeTokenTo(tokenToChangeTo);
244 ttsOut.tokenTuples.add(ttNormal);
247 assert shadowAge == AllocationSite.SHADOWAGE_in_I;
249 Integer I = as.getShadowAge(token);
252 Integer tokenToChangeTo = as.getIthOldest(-I);
253 TokenTuple ttNormal = tt.changeTokenTo(tokenToChangeTo);
254 ttsOut.tokenTuples.add(ttNormal);
258 if ( ttSummary != null && !foundShadowSummary ) {
259 ttsOut.tokenTuples.add(ttSummary);
261 } else if( ttSummary == null && foundShadowSummary ) {
262 ttSummary = new TokenTuple(as.getSummary(),
264 TokenTuple.ARITY_ONE).makeCanonical();
265 ttsOut.tokenTuples.add(ttSummary);
267 } else if( ttSummary != null && foundShadowSummary ) {
268 ttsOut.tokenTuples.add(ttSummary.increaseArity() );
271 return ttsOut.makeCanonical();
275 public TokenTupleSet toShadowTokens(AllocationSite as) {
278 TokenTupleSet ttsOut = new TokenTupleSet();
280 Iterator itrT = this.iterator();
281 while( itrT.hasNext() ) {
282 TokenTuple tt = (TokenTuple) itrT.next();
284 Integer token = tt.getToken();
285 int age = as.getAgeCategory(token);
287 // summary tokens and tokens not associated with
288 // the site should be left alone
289 if( age == AllocationSite.AGE_notInThisSite ) {
290 ttsOut.tokenTuples.add(tt);
292 } else if( age == AllocationSite.AGE_summary ) {
293 ttsOut.tokenTuples.add(tt.changeTokenTo(as.getSummaryShadow() ));
295 } else if( age == AllocationSite.AGE_oldest ) {
296 ttsOut.tokenTuples.add(tt.changeTokenTo(as.getOldestShadow() ));
299 assert age == AllocationSite.AGE_in_I;
301 Integer I = as.getAge(token);
304 ttsOut.tokenTuples.add(tt.changeTokenTo(as.getIthOldestShadow(I) ));
308 return ttsOut.makeCanonical();
312 public ReachabilitySet rewriteToken(TokenTuple tokenToRewrite,
313 ReachabilitySet replacements,
314 boolean makeChangeSet,
315 Hashtable<TokenTupleSet, HashSet<TokenTupleSet> > forChangeSet) {
317 ReachabilitySet rsOut = new ReachabilitySet().makeCanonical();
319 if( !tokenTuples.contains(tokenToRewrite) ) {
320 rsOut = rsOut.add(this);
323 TokenTupleSet ttsMinusToken = new TokenTupleSet(this);
324 ttsMinusToken.tokenTuples.remove(tokenToRewrite);
326 Iterator<TokenTupleSet> replaceItr = replacements.iterator();
327 while( replaceItr.hasNext() ) {
328 TokenTupleSet replacement = replaceItr.next();
329 TokenTupleSet replaced = new TokenTupleSet(ttsMinusToken);
330 replaced = replaced.unionUpArity(replacement);
331 rsOut = rsOut.add(replaced);
333 if( makeChangeSet ) {
334 assert forChangeSet != null;
336 if( forChangeSet.get(this) == null ) {
337 forChangeSet.put(this, new HashSet<TokenTupleSet>() );
340 forChangeSet.get(this).add(replaced);
345 return rsOut.makeCanonical();
349 public String toString() {
350 return tokenTuples.toString();