AliasSetTracker.h revision cb7f65342291caa3636cb50c0ee04b383cd79f8d
1e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy//===- llvm/Analysis/AliasSetTracker.h - Build Alias Sets -------*- C++ -*-===// 2e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy// 3e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy// The LLVM Compiler Infrastructure 4e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy// 5e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy// This file is distributed under the University of Illinois Open Source 6e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy// License. See LICENSE.TXT for details. 7e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy// 8e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy//===----------------------------------------------------------------------===// 9e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy// 10e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy// This file defines two classes: AliasSetTracker and AliasSet. These interface 11e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy// are used to classify a collection of pointer references into a maximal number 12e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy// of disjoint sets. Each AliasSet object constructed by the AliasSetTracker 13e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy// object refers to memory disjoint from the other sets. 14e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy// 15e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy//===----------------------------------------------------------------------===// 16e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 17e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy#ifndef LLVM_ANALYSIS_ALIASSETTRACKER_H 18e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy#define LLVM_ANALYSIS_ALIASSETTRACKER_H 19e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 20e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy#include "llvm/Support/CallSite.h" 2152244fff29042926e21fa897ef5ab11148e35299John Reck#include "llvm/Support/ValueHandle.h" 22e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy#include "llvm/ADT/DenseMap.h" 23e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy#include "llvm/ADT/ilist.h" 243b748a44c6bd2ea05fe16839caf73dbe50bd7ae9Romain Guy#include "llvm/ADT/ilist_node.h" 25e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy#include <vector> 265ff9df658230d49e42c43586997a02d8e4dd417eRomain Guy 27e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guynamespace llvm { 28e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 29e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guyclass AliasAnalysis; 30e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guyclass LoadInst; 31e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guyclass StoreInst; 32e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guyclass VAArgInst; 33d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guyclass AliasSetTracker; 34a1db574036c9bc2d397b69f8200594027e1fff16Romain Guyclass AliasSet; 35a1db574036c9bc2d397b69f8200594027e1fff16Romain Guy 36a1db574036c9bc2d397b69f8200594027e1fff16Romain Guyclass AliasSet : public ilist_node<AliasSet> { 37a1db574036c9bc2d397b69f8200594027e1fff16Romain Guy friend class AliasSetTracker; 38a1db574036c9bc2d397b69f8200594027e1fff16Romain Guy 39e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy class PointerRec { 40e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy Value *Val; // The pointer this record corresponds to. 41e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy PointerRec **PrevInList, *NextInList; 42e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy AliasSet *AS; 43b051e895ccb696604349c6c5efe7c4747e1d1ab6Romain Guy unsigned Size; 44e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy public: 4544fd8d24f761f82d21e9b00932648a1b6bf91449John Reck PointerRec(Value *V) 46f890fab5a6715548e520a6f010a3bfe7607ce56ePatrick Dubroy : Val(V), PrevInList(0), NextInList(0), AS(0), Size(0) {} 47f890fab5a6715548e520a6f010a3bfe7607ce56ePatrick Dubroy 48f890fab5a6715548e520a6f010a3bfe7607ce56ePatrick Dubroy Value *getValue() const { return Val; } 49eea60692b060737faeaa02bb30f5b79e2202b482Romain Guy 50f890fab5a6715548e520a6f010a3bfe7607ce56ePatrick Dubroy PointerRec *getNext() const { return NextInList; } 51f890fab5a6715548e520a6f010a3bfe7607ce56ePatrick Dubroy bool hasAliasSet() const { return AS != 0; } 52e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 53e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy PointerRec** setPrevInList(PointerRec **PIL) { 54051910b9f998030dacb8a0722588cc715813fde1Raph Levien PrevInList = PIL; 556410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy return &NextInList; 566410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy } 57051910b9f998030dacb8a0722588cc715813fde1Raph Levien 586410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy void updateSize(unsigned NewSize) { 596410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy if (NewSize > Size) Size = NewSize; 606926c72e25b8dec3dd4b84af0819fa1937ae7296Romain Guy } 616926c72e25b8dec3dd4b84af0819fa1937ae7296Romain Guy 62da8532c6f48b4c10b5e2ccb9e08690341efa1616Romain Guy unsigned getSize() const { return Size; } 63163935113919a184122b8b3bd672ef08c8df65dcRomain Guy 64163935113919a184122b8b3bd672ef08c8df65dcRomain Guy AliasSet *getAliasSet(AliasSetTracker &AST) { 65163935113919a184122b8b3bd672ef08c8df65dcRomain Guy assert(AS && "No AliasSet yet!"); 66163935113919a184122b8b3bd672ef08c8df65dcRomain Guy if (AS->Forward) { 67163935113919a184122b8b3bd672ef08c8df65dcRomain Guy AliasSet *OldAS = AS; 68163935113919a184122b8b3bd672ef08c8df65dcRomain Guy AS = OldAS->getForwardedTarget(AST); 69163935113919a184122b8b3bd672ef08c8df65dcRomain Guy AS->addRef(); 70163935113919a184122b8b3bd672ef08c8df65dcRomain Guy OldAS->dropRef(AST); 71163935113919a184122b8b3bd672ef08c8df65dcRomain Guy } 72163935113919a184122b8b3bd672ef08c8df65dcRomain Guy return AS; 73e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy } 74e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 75e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy void setAliasSet(AliasSet *as) { 76e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy assert(AS == 0 && "Already have an alias set!"); 77b051e895ccb696604349c6c5efe7c4747e1d1ab6Romain Guy AS = as; 7884a4c887a07c1c2939443f4e0587d7f1ac109e4bJohn Reck } 7984a4c887a07c1c2939443f4e0587d7f1ac109e4bJohn Reck 8084a4c887a07c1c2939443f4e0587d7f1ac109e4bJohn Reck void eraseFromList() { 8184a4c887a07c1c2939443f4e0587d7f1ac109e4bJohn Reck if (NextInList) NextInList->PrevInList = PrevInList; 826c319ca1275c8db892c39b48fc54864c949f9171Romain Guy *PrevInList = NextInList; 836c319ca1275c8db892c39b48fc54864c949f9171Romain Guy if (AS->PtrListEnd == &NextInList) { 846c319ca1275c8db892c39b48fc54864c949f9171Romain Guy AS->PtrListEnd = PrevInList; 856c319ca1275c8db892c39b48fc54864c949f9171Romain Guy assert(*AS->PtrListEnd == 0 && "List not terminated right!"); 86fb8b763f762ae21923c58d64caa729b012f40e05Romain Guy } 87fb8b763f762ae21923c58d64caa729b012f40e05Romain Guy delete this; 885c13d89c1332fcc499379b9064b891187b75ca32Chet Haase } 89162a0217563f4665da6eb183dfce0fef740f641fJeff Brown }; 90fb8b763f762ae21923c58d64caa729b012f40e05Romain Guy 91e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy PointerRec *PtrList, **PtrListEnd; // Doubly linked list of nodes. 92b051e895ccb696604349c6c5efe7c4747e1d1ab6Romain Guy AliasSet *Forward; // Forwarding pointer. 9336bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat AliasSet *Next, *Prev; // Doubly linked list of AliasSets. 9436bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat 9536bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat // All calls & invokes in this alias set. 965c13d89c1332fcc499379b9064b891187b75ca32Chet Haase std::vector<AssertingVH<Instruction> > CallSites; 97162a0217563f4665da6eb183dfce0fef740f641fJeff Brown 9836bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat // RefCount - Number of nodes pointing to this AliasSet plus the number of 995977baa1fa24125c148a72699b53e62abaf08960Chet Haase // AliasSets forwarding to it. 10036bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat unsigned RefCount : 28; 101f890fab5a6715548e520a6f010a3bfe7607ce56ePatrick Dubroy 1025c13d89c1332fcc499379b9064b891187b75ca32Chet Haase /// AccessType - Keep track of whether this alias set merely refers to the 1035c13d89c1332fcc499379b9064b891187b75ca32Chet Haase /// locations of memory, whether it modifies the memory, or whether it does 1045c13d89c1332fcc499379b9064b891187b75ca32Chet Haase /// both. The lattice goes from "NoModRef" to either Refs or Mods, then to 105f890fab5a6715548e520a6f010a3bfe7607ce56ePatrick Dubroy /// ModRef as necessary. 106171c592f0b7066acf279863c8a52ddabea49d3dbRomain Guy /// 107162a0217563f4665da6eb183dfce0fef740f641fJeff Brown enum AccessType { 108171c592f0b7066acf279863c8a52ddabea49d3dbRomain Guy NoModRef = 0, Refs = 1, // Ref = bit 1 109171c592f0b7066acf279863c8a52ddabea49d3dbRomain Guy Mods = 2, ModRef = 3 // Mod = bit 2 110171c592f0b7066acf279863c8a52ddabea49d3dbRomain Guy }; 111e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy unsigned AccessTy : 2; 112e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 113ce0537b80087a6225273040a987414b1dd081aa0Romain Guy /// AliasType - Keep track the relationships between the pointers in the set. 114ba9b613437c34873fa95800a25fc51720638267cChris Craik /// Lattice goes from MustAlias to MayAlias. 115ba9b613437c34873fa95800a25fc51720638267cChris Craik /// 116ba9b613437c34873fa95800a25fc51720638267cChris Craik enum AliasType { 117ba9b613437c34873fa95800a25fc51720638267cChris Craik MustAlias = 0, MayAlias = 1 118ba9b613437c34873fa95800a25fc51720638267cChris Craik }; 119ba9b613437c34873fa95800a25fc51720638267cChris Craik unsigned AliasTy : 1; 120e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 121e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy // Volatile - True if this alias set contains volatile loads or stores. 122e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool Volatile : 1; 123e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 124e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy void addRef() { ++RefCount; } 125e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy void dropRef(AliasSetTracker &AST) { 126e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy assert(RefCount >= 1 && "Invalid reference count detected!"); 127e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy if (--RefCount == 0) 128e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy removeFromTracker(AST); 129e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy } 130e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 131e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy CallSite getCallSite(unsigned i) const { 132e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy assert(i < CallSites.size()); 133e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy return CallSite(CallSites[i]); 134e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy } 135e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 136e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guypublic: 137e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// Accessors... 138e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool isRef() const { return AccessTy & Refs; } 139f61970fc79e9c5cf340fa942597628242361864aRomain Guy bool isMod() const { return AccessTy & Mods; } 140f61970fc79e9c5cf340fa942597628242361864aRomain Guy bool isMustAlias() const { return AliasTy == MustAlias; } 141f61970fc79e9c5cf340fa942597628242361864aRomain Guy bool isMayAlias() const { return AliasTy == MayAlias; } 142f61970fc79e9c5cf340fa942597628242361864aRomain Guy 143f61970fc79e9c5cf340fa942597628242361864aRomain Guy // isVolatile - Return true if this alias set contains volatile loads or 144f61970fc79e9c5cf340fa942597628242361864aRomain Guy // stores. 145f61970fc79e9c5cf340fa942597628242361864aRomain Guy bool isVolatile() const { return Volatile; } 146f61970fc79e9c5cf340fa942597628242361864aRomain Guy 147f61970fc79e9c5cf340fa942597628242361864aRomain Guy /// isForwardingAliasSet - Return true if this alias set should be ignored as 148f61970fc79e9c5cf340fa942597628242361864aRomain Guy /// part of the AliasSetTracker object. 149f61970fc79e9c5cf340fa942597628242361864aRomain Guy bool isForwardingAliasSet() const { return Forward; } 150530041d3191ce817832a0108514617768e43cda6Romain Guy 151f61970fc79e9c5cf340fa942597628242361864aRomain Guy /// mergeSetIn - Merge the specified alias set into this alias set... 1522bf68f063b0077ddef6ebfe54f2ae5e063c2c229Romain Guy /// 1532bf68f063b0077ddef6ebfe54f2ae5e063c2c229Romain Guy void mergeSetIn(AliasSet &AS, AliasSetTracker &AST); 1542bf68f063b0077ddef6ebfe54f2ae5e063c2c229Romain Guy 15536bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat // Alias Set iteration - Allow access to all of the pointer which are part of 1562bf68f063b0077ddef6ebfe54f2ae5e063c2c229Romain Guy // this alias set... 1572bf68f063b0077ddef6ebfe54f2ae5e063c2c229Romain Guy class iterator; 1582bf68f063b0077ddef6ebfe54f2ae5e063c2c229Romain Guy iterator begin() const { return iterator(PtrList); } 159e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy iterator end() const { return iterator(); } 160e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool empty() const { return PtrList == 0; } 161e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 162e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy void print(raw_ostream &OS) const; 163e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy void dump() const; 164e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 165e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// Define an iterator for alias sets... this is just a forward iterator. 166e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy class iterator : public std::iterator<std::forward_iterator_tag, 167e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy PointerRec, ptrdiff_t> { 168e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy PointerRec *CurNode; 169e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy public: 170051910b9f998030dacb8a0722588cc715813fde1Raph Levien explicit iterator(PointerRec *CN = 0) : CurNode(CN) {} 171cce47eb580d666ead1f6095d1e3b65233592bbaaChris Craik 172cce47eb580d666ead1f6095d1e3b65233592bbaaChris Craik bool operator==(const iterator& x) const { 173cce47eb580d666ead1f6095d1e3b65233592bbaaChris Craik return CurNode == x.CurNode; 174cce47eb580d666ead1f6095d1e3b65233592bbaaChris Craik } 175cce47eb580d666ead1f6095d1e3b65233592bbaaChris Craik bool operator!=(const iterator& x) const { return !operator==(x); } 176cce47eb580d666ead1f6095d1e3b65233592bbaaChris Craik 177cce47eb580d666ead1f6095d1e3b65233592bbaaChris Craik const iterator &operator=(const iterator &I) { 178cce47eb580d666ead1f6095d1e3b65233592bbaaChris Craik CurNode = I.CurNode; 179cce47eb580d666ead1f6095d1e3b65233592bbaaChris Craik return *this; 180e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy } 181b051e895ccb696604349c6c5efe7c4747e1d1ab6Romain Guy 1828afd0f245cc0c4a0366f39f41b5f78e47ee83be3Chris Craik value_type &operator*() const { 1838afd0f245cc0c4a0366f39f41b5f78e47ee83be3Chris Craik assert(CurNode && "Dereferencing AliasSet.end()!"); 1848afd0f245cc0c4a0366f39f41b5f78e47ee83be3Chris Craik return *CurNode; 1858afd0f245cc0c4a0366f39f41b5f78e47ee83be3Chris Craik } 1868afd0f245cc0c4a0366f39f41b5f78e47ee83be3Chris Craik value_type *operator->() const { return &operator*(); } 1878afd0f245cc0c4a0366f39f41b5f78e47ee83be3Chris Craik 1888afd0f245cc0c4a0366f39f41b5f78e47ee83be3Chris Craik Value *getPointer() const { return CurNode->getValue(); } 1898afd0f245cc0c4a0366f39f41b5f78e47ee83be3Chris Craik unsigned getSize() const { return CurNode->getSize(); } 1908afd0f245cc0c4a0366f39f41b5f78e47ee83be3Chris Craik 1918afd0f245cc0c4a0366f39f41b5f78e47ee83be3Chris Craik iterator& operator++() { // Preincrement 1928afd0f245cc0c4a0366f39f41b5f78e47ee83be3Chris Craik assert(CurNode && "Advancing past AliasSet.end()!"); 1938afd0f245cc0c4a0366f39f41b5f78e47ee83be3Chris Craik CurNode = CurNode->getNext(); 19444b2fe3fc114ee5f7273c6b0fee2cc999bf244a2Chet Haase return *this; 1957d7b5490a0b0763e831b31bc11f17d8159b5914aRomain Guy } 19644b2fe3fc114ee5f7273c6b0fee2cc999bf244a2Chet Haase iterator operator++(int) { // Postincrement 19744b2fe3fc114ee5f7273c6b0fee2cc999bf244a2Chet Haase iterator tmp = *this; ++*this; return tmp; 1987d7b5490a0b0763e831b31bc11f17d8159b5914aRomain Guy } 19944b2fe3fc114ee5f7273c6b0fee2cc999bf244a2Chet Haase }; 2007d7b5490a0b0763e831b31bc11f17d8159b5914aRomain Guy 201e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guyprivate: 202b025b9c8b4efefadb01937db61a1f8ee7d2452bfRomain Guy // Can only be created by AliasSetTracker. Also, ilist creates one 20336bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat // to serve as a sentinel. 20436bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat friend struct ilist_sentinel_traits<AliasSet>; 2057d7b5490a0b0763e831b31bc11f17d8159b5914aRomain Guy AliasSet() : PtrList(0), PtrListEnd(&PtrList), Forward(0), RefCount(0), 206e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy AccessTy(NoModRef), AliasTy(MustAlias), Volatile(false) { 207b051e895ccb696604349c6c5efe7c4747e1d1ab6Romain Guy } 208b35ab7b72967adcfd01cec483a705dafe8b951d1Gilles Debunne 209b025b9c8b4efefadb01937db61a1f8ee7d2452bfRomain Guy AliasSet(const AliasSet &AS); // do not implement 210b025b9c8b4efefadb01937db61a1f8ee7d2452bfRomain Guy void operator=(const AliasSet &AS); // do not implement 2119ace8f5e79e76893fe4ca9e4d10f6c4056330485Romain Guy 21236bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat PointerRec *getSomePointer() const { 213b025b9c8b4efefadb01937db61a1f8ee7d2452bfRomain Guy return PtrList; 214530041d3191ce817832a0108514617768e43cda6Romain Guy } 215530041d3191ce817832a0108514617768e43cda6Romain Guy 216530041d3191ce817832a0108514617768e43cda6Romain Guy /// getForwardedTarget - Return the real alias set this represents. If this 217530041d3191ce817832a0108514617768e43cda6Romain Guy /// has been merged with another set and is forwarding, return the ultimate 218da8532c6f48b4c10b5e2ccb9e08690341efa1616Romain Guy /// destination set. This also implements the union-find collapsing as well. 219680df8d60e3445bd14df902796079d730c283c46John Reck AliasSet *getForwardedTarget(AliasSetTracker &AST) { 220daf98e941e140e8739458126640183b9f296a2abChet Haase if (!Forward) return this; 221daf98e941e140e8739458126640183b9f296a2abChet Haase 222daf98e941e140e8739458126640183b9f296a2abChet Haase AliasSet *Dest = Forward->getForwardedTarget(AST); 22336bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat if (Dest != Forward) { 224daf98e941e140e8739458126640183b9f296a2abChet Haase Dest->addRef(); 225bdf7609867a3f886455c51dba91623a86cceb6e2Romain Guy Forward->dropRef(AST); 226b051e895ccb696604349c6c5efe7c4747e1d1ab6Romain Guy Forward = Dest; 227b051e895ccb696604349c6c5efe7c4747e1d1ab6Romain Guy } 228b051e895ccb696604349c6c5efe7c4747e1d1ab6Romain Guy return Dest; 22944fd8d24f761f82d21e9b00932648a1b6bf91449John Reck } 23065b345fa22b878e141b8fd8ece9c208df00fa40fRomain Guy 23152036b19a5f82bc4d75cfcbff99c65df8d25a99bRomain Guy void removeFromTracker(AliasSetTracker &AST); 232a7090e0cfd7c719a6d4c03aae34f5db98754cbddChris Craik 233a7090e0cfd7c719a6d4c03aae34f5db98754cbddChris Craik void addPointer(AliasSetTracker &AST, PointerRec &Entry, unsigned Size, 234b051e895ccb696604349c6c5efe7c4747e1d1ab6Romain Guy bool KnownMustAlias = false); 235b051e895ccb696604349c6c5efe7c4747e1d1ab6Romain Guy void addCallSite(CallSite CS, AliasAnalysis &AA); 236a7090e0cfd7c719a6d4c03aae34f5db98754cbddChris Craik void removeCallSite(CallSite CS) { 2371271e2cc80b01d577e9db339459ef0222bb9320dChet Haase for (size_t i = 0, e = CallSites.size(); i != e; ++i) 238da8532c6f48b4c10b5e2ccb9e08690341efa1616Romain Guy if (CallSites[i] == CS.getInstruction()) { 239e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy CallSites[i] = CallSites.back(); 2406c319ca1275c8db892c39b48fc54864c949f9171Romain Guy CallSites.pop_back(); 2416c319ca1275c8db892c39b48fc54864c949f9171Romain Guy } 242051910b9f998030dacb8a0722588cc715813fde1Raph Levien } 243ada830f639591b99c3e40de22b07296c7932a33fRomain Guy void setVolatile() { Volatile = true; } 244a4e16c58c9e3c983251e0475125a2a6f5bec2dbfChris Craik 24512f5e3433226f0a2886a98b0b8da8d5e947c5cdeJohn Reck /// aliasesPointer - Return true if the specified pointer "may" (or must) 2466c319ca1275c8db892c39b48fc54864c949f9171Romain Guy /// alias one of the members in the set. 2476c319ca1275c8db892c39b48fc54864c949f9171Romain Guy /// 24836bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat bool aliasesPointer(const Value *Ptr, unsigned Size, AliasAnalysis &AA) const; 249aa6c24c21c727a196451332448d4e3b11a80be69Romain Guy bool aliasesCallSite(CallSite CS, AliasAnalysis &AA) const; 2506c319ca1275c8db892c39b48fc54864c949f9171Romain Guy}; 2516410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy 2526410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guyinline raw_ostream& operator<<(raw_ostream &OS, const AliasSet &AS) { 2536410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy AS.print(OS); 2546410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy return OS; 2556410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy} 2566410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy 2576410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy 2586410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guyclass AliasSetTracker { 2596410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy /// CallbackVH - A CallbackVH to arrange for AliasSetTracker to be 2606410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy /// notified whenever a Value is deleted. 2616410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy class ASTCallbackVH : public CallbackVH { 2626410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy AliasSetTracker *AST; 2636410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy virtual void deleted(); 2646410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy public: 2656410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy ASTCallbackVH(Value *V, AliasSetTracker *AST = 0); 2666410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy ASTCallbackVH &operator=(Value *V); 2676410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy }; 2686410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy /// ASTCallbackVHDenseMapInfo - Traits to tell DenseMap that tell us how to 2696410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy /// compare and hash the value handle. 2706410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy struct ASTCallbackVHDenseMapInfo : public DenseMapInfo<Value *> {}; 2716410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy 2726410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy AliasAnalysis &AA; 2736410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy ilist<AliasSet> AliasSets; 2746410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy 2756410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy typedef DenseMap<ASTCallbackVH, AliasSet::PointerRec*, 276e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy ASTCallbackVHDenseMapInfo> 277e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy PointerMapType; 278e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 279e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy // Map from pointers to their node 280e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy PointerMapType PointerMap; 281735738c4ddf3229caa5f6e634bf591953ac29944Romain Guy 282e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guypublic: 283e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// AliasSetTracker ctor - Create an empty collection of AliasSets, and use 284e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// the specified alias analysis object to disambiguate load and store 285e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// addresses. 286735738c4ddf3229caa5f6e634bf591953ac29944Romain Guy explicit AliasSetTracker(AliasAnalysis &aa) : AA(aa) {} 287e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy ~AliasSetTracker() { clear(); } 288e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 28936bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat /// add methods - These methods are used to add different types of 290735738c4ddf3229caa5f6e634bf591953ac29944Romain Guy /// instructions to the alias sets. Adding a new instruction can result in 291e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// one of three actions happening: 292e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// 293079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy /// 1. If the instruction doesn't alias any other sets, create a new set. 294e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// 2. If the instruction aliases exactly one set, add it to the set 295051910b9f998030dacb8a0722588cc715813fde1Raph Levien /// 3. If the instruction aliases multiple sets, merge the sets, and add 29636bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat /// the instruction to the result. 297079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy /// 298e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// These methods return true if inserting the instruction resulted in the 299e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// addition of a new alias set (i.e., the pointer did not alias anything). 300e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// 301079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy bool add(Value *Ptr, unsigned Size); // Add a location 302e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool add(LoadInst *LI); 303e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool add(StoreInst *SI); 304e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool add(VAArgInst *VAAI); 305e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool add(CallSite CS); // Call/Invoke instructions 306daf98e941e140e8739458126640183b9f296a2abChet Haase bool add(CallInst *CI) { return add(CallSite(CI)); } 307e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool add(InvokeInst *II) { return add(CallSite(II)); } 308051910b9f998030dacb8a0722588cc715813fde1Raph Levien bool add(Instruction *I); // Dispatch to one of the other add methods... 30936bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat void add(BasicBlock &BB); // Add all instructions in basic block 310735738c4ddf3229caa5f6e634bf591953ac29944Romain Guy void add(const AliasSetTracker &AST); // Add alias relations from another AST 311e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 312e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// remove methods - These methods are used to remove all entries that might 313e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// be aliased by the specified instruction. These methods return true if any 314079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy /// alias sets were eliminated. 315051910b9f998030dacb8a0722588cc715813fde1Raph Levien bool remove(Value *Ptr, unsigned Size); // Remove a location 316e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool remove(LoadInst *LI); 317e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool remove(StoreInst *SI); 318e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool remove(VAArgInst *VAAI); 319e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool remove(CallSite CS); 320079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy bool remove(CallInst *CI) { return remove(CallSite(CI)); } 321e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool remove(InvokeInst *II) { return remove(CallSite(II)); } 322e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool remove(Instruction *I); 323e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy void remove(AliasSet &AS); 324e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 325079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy void clear(); 326079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 327e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// getAliasSets - Return the alias sets that are active. 328e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// 329e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy const ilist<AliasSet> &getAliasSets() const { return AliasSets; } 330e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 331079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy /// getAliasSetForPointer - Return the alias set that the specified pointer 332e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// lives in. If the New argument is non-null, this method sets the value to 333e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// true if a new alias set is created to contain the pointer (because the 334e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// pointer didn't alias anything). 335e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy AliasSet &getAliasSetForPointer(Value *P, unsigned Size, bool *New = 0); 336735738c4ddf3229caa5f6e634bf591953ac29944Romain Guy 337e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// getAliasSetForPointerIfExists - Return the alias set containing the 338e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// location specified if one exists, otherwise return null. 339e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy AliasSet *getAliasSetForPointerIfExists(Value *P, unsigned Size) { 340e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy return findAliasSetForPointer(P, Size); 341735738c4ddf3229caa5f6e634bf591953ac29944Romain Guy } 342e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 343e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// containsPointer - Return true if the specified location is represented by 34436bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat /// this alias set, false otherwise. This does not modify the AST object or 345735738c4ddf3229caa5f6e634bf591953ac29944Romain Guy /// alias sets. 346e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy bool containsPointer(Value *P, unsigned Size) const; 347e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 3489d5316e3f56d138504565ff311145ac01621dff4Romain Guy /// getAliasAnalysis - Return the underlying alias analysis object used by 349e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// this tracker. 350e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy AliasAnalysis &getAliasAnalysis() const { return AA; } 35136bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat 3529d5316e3f56d138504565ff311145ac01621dff4Romain Guy /// deleteValue method - This method is used to remove a pointer value from 353e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// the AliasSetTracker entirely. It should be used when an instruction is 354e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// deleted from the program to update the AST. If you don't use this, you 355ca79cf69d09efa0c327e9b1237d86a119aea5da7Derek Sollenberger /// would have dangling pointers to deleted instructions. 356e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// 357051910b9f998030dacb8a0722588cc715813fde1Raph Levien void deleteValue(Value *PtrVal); 35836bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat 359ca79cf69d09efa0c327e9b1237d86a119aea5da7Derek Sollenberger /// copyValue - This method should be used whenever a preexisting value in the 360e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// program is copied or cloned, introducing a new value. Note that it is ok 361e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// for clients that use this method to introduce the same value multiple 362e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy /// times: if the tracker already knows about a value, it will ignore the 3636410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy /// request. 3646410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy /// 3656410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy void copyValue(Value *From, Value *To); 3666410c0aaf13c9aec606b90ee942f2ac2d98b1609Romain Guy 367e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 368e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy typedef ilist<AliasSet>::iterator iterator; 369e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy typedef ilist<AliasSet>::const_iterator const_iterator; 370e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 371ca79cf69d09efa0c327e9b1237d86a119aea5da7Derek Sollenberger const_iterator begin() const { return AliasSets.begin(); } 372e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy const_iterator end() const { return AliasSets.end(); } 373e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 374e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy iterator begin() { return AliasSets.begin(); } 375e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy iterator end() { return AliasSets.end(); } 376e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 377e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy void print(raw_ostream &OS) const; 378e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy void dump() const; 379e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 380807daf7df615b60ce6fc41355aabe3aa353cebabRomain Guyprivate: 381e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy friend class AliasSet; 382051910b9f998030dacb8a0722588cc715813fde1Raph Levien void removeAliasSet(AliasSet *AS); 38336bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat 384e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy // getEntryFor - Just like operator[] on the map, except that it creates an 385e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy // entry for the pointer if it doesn't already exist. 386e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy AliasSet::PointerRec &getEntryFor(Value *V) { 387807daf7df615b60ce6fc41355aabe3aa353cebabRomain Guy AliasSet::PointerRec *&Entry = PointerMap[ASTCallbackVH(V, this)]; 388e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy if (Entry == 0) 389e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy Entry = new AliasSet::PointerRec(V); 39036bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat return *Entry; 391807daf7df615b60ce6fc41355aabe3aa353cebabRomain Guy } 392e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 393e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy AliasSet &addPointer(Value *P, unsigned Size, AliasSet::AccessType E, 394f6a11b8a9e25ff9861bbba19251bea84d8a5daf2Romain Guy bool &NewSet) { 395e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy NewSet = false; 396051910b9f998030dacb8a0722588cc715813fde1Raph Levien AliasSet &AS = getAliasSetForPointer(P, Size, &NewSet); 39736bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat AS.AccessTy |= E; 398e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy return AS; 399e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy } 400e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy AliasSet *findAliasSetForPointer(const Value *Ptr, unsigned Size); 401f6a11b8a9e25ff9861bbba19251bea84d8a5daf2Romain Guy 402e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy AliasSet *findAliasSetForCallSite(CallSite CS); 403051910b9f998030dacb8a0722588cc715813fde1Raph Levien}; 40436bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat 405f6a11b8a9e25ff9861bbba19251bea84d8a5daf2Romain Guyinline raw_ostream& operator<<(raw_ostream &OS, const AliasSetTracker &AST) { 406e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy AST.print(OS); 407e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy return OS; 408e707859415f4c8e1c01228dfaa58fb0a690d442eRomain Guy} 409e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy 410051910b9f998030dacb8a0722588cc715813fde1Raph Levien} // End llvm namespace 41136bef0bf30d6bae48cf3837df351075ca4fce654Ashok Bhat 412e4d011201cea40d46cb2b2eef401db8fddc5c9c6Romain Guy#endif 4135ff9df658230d49e42c43586997a02d8e4dd417eRomain Guy