AliasSetTracker.h revision a818c30d664cd4ba4b9ed69fb2048a6ea55ec9cd
1009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner//===- llvm/Analysis/AliasSetTracker.h - Build Alias Sets -------*- C++ -*-===// 29769ab22265b313171d201b5928688524a01bd87Misha Brukman// 36fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// The LLVM Compiler Infrastructure 46fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// 57ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// This file is distributed under the University of Illinois Open Source 67ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// License. See LICENSE.TXT for details. 79769ab22265b313171d201b5928688524a01bd87Misha Brukman// 86fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell//===----------------------------------------------------------------------===// 9009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner// 10009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner// This file defines two classes: AliasSetTracker and AliasSet. These interface 11009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner// are used to classify a collection of pointer references into a maximal number 12009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner// of disjoint sets. Each AliasSet object constructed by the AliasSetTracker 13009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner// object refers to memory disjoint from the other sets. 149769ab22265b313171d201b5928688524a01bd87Misha Brukman// 15009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner//===----------------------------------------------------------------------===// 16009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 17009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner#ifndef LLVM_ANALYSIS_ALIASSETTRACKER_H 18009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner#define LLVM_ANALYSIS_ALIASSETTRACKER_H 19009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 209971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner#include "llvm/Support/CallSite.h" 21b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman#include "llvm/Support/ValueHandle.h" 22d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner#include "llvm/ADT/DenseMap.h" 2343d1fd449f1a0ac9d9dafa0b9569bb6b2e976198Anton Korobeynikov#include "llvm/ADT/iterator.h" 2443d1fd449f1a0ac9d9dafa0b9569bb6b2e976198Anton Korobeynikov#include "llvm/ADT/ilist.h" 25fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman#include "llvm/ADT/ilist_node.h" 26d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner#include <vector> 27d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 28d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekenamespace llvm { 29d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 30009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerclass AliasAnalysis; 31009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerclass LoadInst; 32009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerclass StoreInst; 335c88260f70d5286adeca61c31bdf51f8debaccbcChris Lattnerclass FreeInst; 34235fc57ef2ed0a3c43a6e2d77b7c13f96a6f8036Dan Gohmanclass VAArgInst; 35009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerclass AliasSetTracker; 369971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattnerclass AliasSet; 37009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 38fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohmanclass AliasSet : public ilist_node<AliasSet> { 39009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner friend class AliasSetTracker; 409971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 419971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner class PointerRec { 42d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner Value *Val; // The pointer this record corresponds to. 43d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner PointerRec **PrevInList, *NextInList; 449971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet *AS; 4531a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner unsigned Size; 469971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner public: 47d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner PointerRec(Value *V) 48d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner : Val(V), PrevInList(0), NextInList(0), AS(0), Size(0) {} 499971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 50d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner Value *getValue() const { return Val; } 51d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner 52d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner PointerRec *getNext() const { return NextInList; } 539971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner bool hasAliasSet() const { return AS != 0; } 549971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 55d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner PointerRec** setPrevInList(PointerRec **PIL) { 562cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner PrevInList = PIL; 572cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner return &NextInList; 582cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner } 592cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner 6031a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner void updateSize(unsigned NewSize) { 6131a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner if (NewSize > Size) Size = NewSize; 6231a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner } 6331a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner 6431a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner unsigned getSize() const { return Size; } 6531a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner 669769ab22265b313171d201b5928688524a01bd87Misha Brukman AliasSet *getAliasSet(AliasSetTracker &AST) { 679971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner assert(AS && "No AliasSet yet!"); 689971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner if (AS->Forward) { 699971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet *OldAS = AS; 709971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AS = OldAS->getForwardedTarget(AST); 71b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner AS->addRef(); 72b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner OldAS->dropRef(AST); 739971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 749971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return AS; 759971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 769971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 779971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner void setAliasSet(AliasSet *as) { 789971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner assert(AS == 0 && "Already have an alias set!"); 799971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AS = as; 809971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 812cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner 82d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner void eraseFromList() { 83d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner if (NextInList) NextInList->PrevInList = PrevInList; 842cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner *PrevInList = NextInList; 857e0e9c635f5439426252bd1ccbfa90b878ba0ca6Chris Lattner if (AS->PtrListEnd == &NextInList) { 867e0e9c635f5439426252bd1ccbfa90b878ba0ca6Chris Lattner AS->PtrListEnd = PrevInList; 877e0e9c635f5439426252bd1ccbfa90b878ba0ca6Chris Lattner assert(*AS->PtrListEnd == 0 && "List not terminated right!"); 887e0e9c635f5439426252bd1ccbfa90b878ba0ca6Chris Lattner } 89d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner delete this; 909971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 919971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner }; 929971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 93d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner PointerRec *PtrList, **PtrListEnd; // Doubly linked list of nodes. 94d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner AliasSet *Forward; // Forwarding pointer. 95d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner AliasSet *Next, *Prev; // Doubly linked list of AliasSets. 969971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 97d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner std::vector<CallSite> CallSites; // All calls & invokes in this alias set. 989971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 999971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner // RefCount - Number of nodes pointing to this AliasSet plus the number of 1009971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner // AliasSets forwarding to it. 101bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner unsigned RefCount : 28; 1029971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 103009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// AccessType - Keep track of whether this alias set merely refers to the 104009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// locations of memory, whether it modifies the memory, or whether it does 1059971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// both. The lattice goes from "NoModRef" to either Refs or Mods, then to 1065560c9d49ccae132cabf1155f18aa0480dce3edaMisha Brukman /// ModRef as necessary. 107009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 108009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner enum AccessType { 1099971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner NoModRef = 0, Refs = 1, // Ref = bit 1 1109971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner Mods = 2, ModRef = 3 // Mod = bit 2 111009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner }; 1129971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner unsigned AccessTy : 2; 113009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 114009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// AliasType - Keep track the relationships between the pointers in the set. 115009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// Lattice goes from MustAlias to MayAlias. 116009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 117009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner enum AliasType { 1189971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner MustAlias = 0, MayAlias = 1 119009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner }; 1209971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner unsigned AliasTy : 1; 121009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 122bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner // Volatile - True if this alias set contains volatile loads or stores. 123bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner bool Volatile : 1; 124bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner 125b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner void addRef() { ++RefCount; } 126b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner void dropRef(AliasSetTracker &AST) { 127b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner assert(RefCount >= 1 && "Invalid reference count detected!"); 128b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner if (--RefCount == 0) 129b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner removeFromTracker(AST); 130b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner } 131b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner 132b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattnerpublic: 133b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner /// Accessors... 134b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner bool isRef() const { return AccessTy & Refs; } 135b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner bool isMod() const { return AccessTy & Mods; } 136b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner bool isMustAlias() const { return AliasTy == MustAlias; } 137b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner bool isMayAlias() const { return AliasTy == MayAlias; } 138b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner 139bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner // isVolatile - Return true if this alias set contains volatile loads or 140bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner // stores. 141bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner bool isVolatile() const { return Volatile; } 142bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner 143b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner /// isForwardingAliasSet - Return true if this alias set should be ignored as 144b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner /// part of the AliasSetTracker object. 145b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner bool isForwardingAliasSet() const { return Forward; } 146b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner 147b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner /// mergeSetIn - Merge the specified alias set into this alias set... 148b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner /// 149276636c93b35786d5719e2eda335c79d38d92632Chris Lattner void mergeSetIn(AliasSet &AS, AliasSetTracker &AST); 150b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner 151b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner // Alias Set iteration - Allow access to all of the pointer which are part of 152b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner // this alias set... 153b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner class iterator; 1542cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner iterator begin() const { return iterator(PtrList); } 155b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner iterator end() const { return iterator(); } 156877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool empty() const { return PtrList == 0; } 157b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner 158b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner void print(std::ostream &OS) const; 1595c7e326585f3a543388ba871c3425f7664cd9143Bill Wendling void print(std::ostream *OS) const { if (OS) print(*OS); } 160b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner void dump() const; 161b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner 1629971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// Define an iterator for alias sets... this is just a forward iterator. 163d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner class iterator : public forward_iterator<PointerRec, ptrdiff_t> { 164d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner PointerRec *CurNode; 1659971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner public: 166d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner explicit iterator(PointerRec *CN = 0) : CurNode(CN) {} 1679769ab22265b313171d201b5928688524a01bd87Misha Brukman 1689971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner bool operator==(const iterator& x) const { 1699971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return CurNode == x.CurNode; 1709971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 1719971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner bool operator!=(const iterator& x) const { return !operator==(x); } 172009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 1739971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner const iterator &operator=(const iterator &I) { 1749971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner CurNode = I.CurNode; 1759971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return *this; 1769971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 1779769ab22265b313171d201b5928688524a01bd87Misha Brukman 17831a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner value_type &operator*() const { 1799971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner assert(CurNode && "Dereferencing AliasSet.end()!"); 18031a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner return *CurNode; 1819971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 18231a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner value_type *operator->() const { return &operator*(); } 183877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner 184d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner Value *getPointer() const { return CurNode->getValue(); } 185d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner unsigned getSize() const { return CurNode->getSize(); } 1869769ab22265b313171d201b5928688524a01bd87Misha Brukman 1879971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner iterator& operator++() { // Preincrement 1889971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner assert(CurNode && "Advancing past AliasSet.end()!"); 189d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner CurNode = CurNode->getNext(); 1909971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return *this; 1919971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 1929971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner iterator operator++(int) { // Postincrement 1939769ab22265b313171d201b5928688524a01bd87Misha Brukman iterator tmp = *this; ++*this; return tmp; 1949971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 1959971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner }; 1969971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 197009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerprivate: 198fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman // Can only be created by AliasSetTracker. Also, ilist creates one 199fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman // to serve as a sentinel. 200fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman friend struct ilist_sentinel_traits<AliasSet>; 2012cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner AliasSet() : PtrList(0), PtrListEnd(&PtrList), Forward(0), RefCount(0), 202bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner AccessTy(NoModRef), AliasTy(MustAlias), Volatile(false) { 2039971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 204b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner 205fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman AliasSet(const AliasSet &AS); // do not implement 206fed90b6d097d50881afb45e4d79f430db66dd741Dan Gohman void operator=(const AliasSet &AS); // do not implement 2072cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner 208d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner PointerRec *getSomePointer() const { 2092cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner return PtrList; 2109971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 2119971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 2129971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// getForwardedTarget - Return the real alias set this represents. If this 2139971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// has been merged with another set and is forwarding, return the ultimate 2149971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// destination set. This also implements the union-find collapsing as well. 2159971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet *getForwardedTarget(AliasSetTracker &AST) { 2169971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner if (!Forward) return this; 2179971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 2189971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet *Dest = Forward->getForwardedTarget(AST); 2199971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner if (Dest != Forward) { 220b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner Dest->addRef(); 221b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner Forward->dropRef(AST); 2229971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner Forward = Dest; 2239971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 2249971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return Dest; 2259971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 2269971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 2279971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner void removeFromTracker(AliasSetTracker &AST); 2289971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 229d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner void addPointer(AliasSetTracker &AST, PointerRec &Entry, unsigned Size, 230e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner bool KnownMustAlias = false); 231652f7ea955bb433d6b7a4d33685dca9485fd7b8bEvan Cheng void addCallSite(CallSite CS, AliasAnalysis &AA); 232652f7ea955bb433d6b7a4d33685dca9485fd7b8bEvan Cheng void removeCallSite(CallSite CS) { 23334cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng for (size_t i = 0, e = CallSites.size(); i != e; ++i) 234652f7ea955bb433d6b7a4d33685dca9485fd7b8bEvan Cheng if (CallSites[i].getInstruction() == CS.getInstruction()) { 23569fd7a3973a5c4ba4fb883b836fd0b84c046d10cChris Lattner CallSites[i] = CallSites.back(); 23669fd7a3973a5c4ba4fb883b836fd0b84c046d10cChris Lattner CallSites.pop_back(); 23769fd7a3973a5c4ba4fb883b836fd0b84c046d10cChris Lattner } 23869fd7a3973a5c4ba4fb883b836fd0b84c046d10cChris Lattner } 239bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner void setVolatile() { Volatile = true; } 2409971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 2419971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// aliasesPointer - Return true if the specified pointer "may" (or must) 2429971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// alias one of the members in the set. 2439971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// 24431a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner bool aliasesPointer(const Value *Ptr, unsigned Size, AliasAnalysis &AA) const; 245652f7ea955bb433d6b7a4d33685dca9485fd7b8bEvan Cheng bool aliasesCallSite(CallSite CS, AliasAnalysis &AA) const; 246009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner}; 247009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 2489971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattnerinline std::ostream& operator<<(std::ostream &OS, const AliasSet &AS) { 2499971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AS.print(OS); 2509971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return OS; 2519971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner} 2529971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 253009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 254009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerclass AliasSetTracker { 255b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman /// CallbackVH - A CallbackVH to arrange for AliasSetTracker to be 256b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman /// notified whenever a Value is deleted. 257b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman class ASTCallbackVH : public CallbackVH { 258b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman AliasSetTracker *AST; 259b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman virtual void deleted(); 260b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman public: 261b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman ASTCallbackVH(Value *V, AliasSetTracker *AST = 0); 262a818c30d664cd4ba4b9ed69fb2048a6ea55ec9cdDan Gohman ASTCallbackVH &operator=(Value *V); 263a818c30d664cd4ba4b9ed69fb2048a6ea55ec9cdDan Gohman }; 264a818c30d664cd4ba4b9ed69fb2048a6ea55ec9cdDan Gohman /// ASTCallbackVHDenseMapInfo - Traits to tell DenseMap that ASTCallbackVH 265a818c30d664cd4ba4b9ed69fb2048a6ea55ec9cdDan Gohman /// is not a POD (it needs its destructor called). 266a818c30d664cd4ba4b9ed69fb2048a6ea55ec9cdDan Gohman struct ASTCallbackVHDenseMapInfo : public DenseMapInfo<Value *> { 267a818c30d664cd4ba4b9ed69fb2048a6ea55ec9cdDan Gohman static bool isPod() { return false; } 268b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman }; 269b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman 270009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner AliasAnalysis &AA; 2719971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner ilist<AliasSet> AliasSets; 2729971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 273a818c30d664cd4ba4b9ed69fb2048a6ea55ec9cdDan Gohman typedef DenseMap<ASTCallbackVH, AliasSet::PointerRec*, 274a818c30d664cd4ba4b9ed69fb2048a6ea55ec9cdDan Gohman ASTCallbackVHDenseMapInfo> 275b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman PointerMapType; 276b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman 2779971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner // Map from pointers to their node 278b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman PointerMapType PointerMap; 279b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman 280009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerpublic: 281009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// AliasSetTracker ctor - Create an empty collection of AliasSets, and use 282009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// the specified alias analysis object to disambiguate load and store 283009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// addresses. 2849962054775455c43402bf176da4a28c68197feefDan Gohman explicit AliasSetTracker(AliasAnalysis &aa) : AA(aa) {} 285fd94dd58ffef1be3597ef8cb64f3b1d476d7d5ecAnton Korobeynikov ~AliasSetTracker() { clear(); } 286009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 287009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// add methods - These methods are used to add different types of 288009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// instructions to the alias sets. Adding a new instruction can result in 289009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// one of three actions happening: 290009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 291009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 1. If the instruction doesn't alias any other sets, create a new set. 292009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 2. If the instruction aliases exactly one set, add it to the set 293009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 3. If the instruction aliases multiple sets, merge the sets, and add 294009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// the instruction to the result. 295009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 29612c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner /// These methods return true if inserting the instruction resulted in the 29712c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner /// addition of a new alias set (i.e., the pointer did not alias anything). 29812c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner /// 299558cb5f4a131be8de67dd66d06f5c053cbf7403eChris Lattner bool add(Value *Ptr, unsigned Size); // Add a location 30012c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool add(LoadInst *LI); 30112c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool add(StoreInst *SI); 3025c88260f70d5286adeca61c31bdf51f8debaccbcChris Lattner bool add(FreeInst *FI); 303235fc57ef2ed0a3c43a6e2d77b7c13f96a6f8036Dan Gohman bool add(VAArgInst *VAAI); 304652f7ea955bb433d6b7a4d33685dca9485fd7b8bEvan Cheng bool add(CallSite CS); // Call/Invoke instructions 30512c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool add(CallInst *CI) { return add(CallSite(CI)); } 30612c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool add(InvokeInst *II) { return add(CallSite(II)); } 30712c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool add(Instruction *I); // Dispatch to one of the other add methods... 308b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner void add(BasicBlock &BB); // Add all instructions in basic block 309b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner void add(const AliasSetTracker &AST); // Add alias relations from another AST 310009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 311877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner /// remove methods - These methods are used to remove all entries that might 312877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner /// be aliased by the specified instruction. These methods return true if any 313877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner /// alias sets were eliminated. 314558cb5f4a131be8de67dd66d06f5c053cbf7403eChris Lattner bool remove(Value *Ptr, unsigned Size); // Remove a location 315877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool remove(LoadInst *LI); 316877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool remove(StoreInst *SI); 3175c88260f70d5286adeca61c31bdf51f8debaccbcChris Lattner bool remove(FreeInst *FI); 318235fc57ef2ed0a3c43a6e2d77b7c13f96a6f8036Dan Gohman bool remove(VAArgInst *VAAI); 319652f7ea955bb433d6b7a4d33685dca9485fd7b8bEvan Cheng bool remove(CallSite CS); 320877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool remove(CallInst *CI) { return remove(CallSite(CI)); } 321877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool remove(InvokeInst *II) { return remove(CallSite(II)); } 322877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool remove(Instruction *I); 323877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner void remove(AliasSet &AS); 3248bdbb632433a2acddfebb387361e40b01f469192Chris Lattner 325d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner void clear(); 326877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner 327009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// getAliasSets - Return the alias sets that are active. 328e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// 3299971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner const ilist<AliasSet> &getAliasSets() const { return AliasSets; } 3309971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 3319971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// getAliasSetForPointer - Return the alias set that the specified pointer 33212c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner /// lives in. If the New argument is non-null, this method sets the value to 33312c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner /// true if a new alias set is created to contain the pointer (because the 33412c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner /// pointer didn't alias anything). 33512c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner AliasSet &getAliasSetForPointer(Value *P, unsigned Size, bool *New = 0); 3369971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 337877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner /// getAliasSetForPointerIfExists - Return the alias set containing the 338877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner /// location specified if one exists, otherwise return null. 339877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner AliasSet *getAliasSetForPointerIfExists(Value *P, unsigned Size) { 340877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner return findAliasSetForPointer(P, Size); 341877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner } 3429769ab22265b313171d201b5928688524a01bd87Misha Brukman 34307bfa52405feb99155304c1a28b71e69d046589cChris Lattner /// containsPointer - Return true if the specified location is represented by 34407bfa52405feb99155304c1a28b71e69d046589cChris Lattner /// this alias set, false otherwise. This does not modify the AST object or 34507bfa52405feb99155304c1a28b71e69d046589cChris Lattner /// alias sets. 34607bfa52405feb99155304c1a28b71e69d046589cChris Lattner bool containsPointer(Value *P, unsigned Size) const; 347877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner 3489971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// getAliasAnalysis - Return the underlying alias analysis object used by 3499971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// this tracker. 3509971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasAnalysis &getAliasAnalysis() const { return AA; } 3519971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 352e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// deleteValue method - This method is used to remove a pointer value from 353e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// the AliasSetTracker entirely. It should be used when an instruction is 354e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// deleted from the program to update the AST. If you don't use this, you 355e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// would have dangling pointers to deleted instructions. 356e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// 357e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner void deleteValue(Value *PtrVal); 358e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner 359e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// copyValue - This method should be used whenever a preexisting value in the 360e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// program is copied or cloned, introducing a new value. Note that it is ok 361e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// for clients that use this method to introduce the same value multiple 362e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// times: if the tracker already knows about a value, it will ignore the 363e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// request. 364e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// 365e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner void copyValue(Value *From, Value *To); 366e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner 367e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner 3689971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner typedef ilist<AliasSet>::iterator iterator; 3699971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner typedef ilist<AliasSet>::const_iterator const_iterator; 3709971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 3719971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner const_iterator begin() const { return AliasSets.begin(); } 3729971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner const_iterator end() const { return AliasSets.end(); } 3739971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 3749971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner iterator begin() { return AliasSets.begin(); } 3759971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner iterator end() { return AliasSets.end(); } 3769971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 3779971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner void print(std::ostream &OS) const; 3785c7e326585f3a543388ba871c3425f7664cd9143Bill Wendling void print(std::ostream *OS) const { if (OS) print(*OS); } 3799971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner void dump() const; 380009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 381009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerprivate: 3829971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner friend class AliasSet; 3839971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner void removeAliasSet(AliasSet *AS); 3849971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 385d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner // getEntryFor - Just like operator[] on the map, except that it creates an 386d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner // entry for the pointer if it doesn't already exist. 387d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner AliasSet::PointerRec &getEntryFor(Value *V) { 388b5b56ba9d4df47e618d4e0f9e1e09bf216733ee8Dan Gohman AliasSet::PointerRec *&Entry = PointerMap[ASTCallbackVH(V, this)]; 389d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner if (Entry == 0) 390d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner Entry = new AliasSet::PointerRec(V); 391d7168ddb116c2e9aa1f8325ae887eb63d6003037Chris Lattner return *Entry; 3929971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 3939971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 39412c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner AliasSet &addPointer(Value *P, unsigned Size, AliasSet::AccessType E, 39512c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool &NewSet) { 39612c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner NewSet = false; 39712c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner AliasSet &AS = getAliasSetForPointer(P, Size, &NewSet); 3989971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AS.AccessTy |= E; 399bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner return AS; 4009971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 40131a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner AliasSet *findAliasSetForPointer(const Value *Ptr, unsigned Size); 4029971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 403652f7ea955bb433d6b7a4d33685dca9485fd7b8bEvan Cheng AliasSet *findAliasSetForCallSite(CallSite CS); 404009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner}; 405009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 4069971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattnerinline std::ostream& operator<<(std::ostream &OS, const AliasSetTracker &AST) { 4079971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AST.print(OS); 4089971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return OS; 4099971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner} 4109971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 411d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 412d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 413009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner#endif 414