AliasSetTracker.h revision 34cd4a484e532cc463fd5a4bf59b88d13c5467c1
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" 21b5ebf15b2b2ce8989caf1a1114b05d80b0f9bd48Bill Wendling#include "llvm/Support/Streams.h" 22551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/ADT/iterator" 23551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/ADT/hash_map" 24551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/ADT/ilist" 25d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 26d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekenamespace llvm { 27d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 28009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerclass AliasAnalysis; 29009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerclass LoadInst; 30009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerclass StoreInst; 315c88260f70d5286adeca61c31bdf51f8debaccbcChris Lattnerclass FreeInst; 32235fc57ef2ed0a3c43a6e2d77b7c13f96a6f8036Dan Gohmanclass VAArgInst; 33009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerclass AliasSetTracker; 349971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattnerclass AliasSet; 35009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 36009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerclass AliasSet { 37009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner friend class AliasSetTracker; 389971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 391fca5ff62bb2ecb5bfc8974f4dbfc56e9d3ca721Chris Lattner class PointerRec; 409971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner typedef std::pair<Value* const, PointerRec> HashNodePair; 419971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 429971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner class PointerRec { 432cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner HashNodePair **PrevInList, *NextInList; 449971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet *AS; 4531a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner unsigned Size; 469971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner public: 472cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner PointerRec() : PrevInList(0), NextInList(0), AS(0), Size(0) {} 489971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 499971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner HashNodePair *getNext() const { return NextInList; } 509971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner bool hasAliasSet() const { return AS != 0; } 519971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 522cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner HashNodePair** setPrevInList(HashNodePair **PIL) { 532cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner PrevInList = PIL; 542cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner return &NextInList; 552cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner } 562cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner 5731a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner void updateSize(unsigned NewSize) { 5831a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner if (NewSize > Size) Size = NewSize; 5931a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner } 6031a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner 6131a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner unsigned getSize() const { return Size; } 6231a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner 639769ab22265b313171d201b5928688524a01bd87Misha Brukman AliasSet *getAliasSet(AliasSetTracker &AST) { 649971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner assert(AS && "No AliasSet yet!"); 659971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner if (AS->Forward) { 669971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet *OldAS = AS; 679971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AS = OldAS->getForwardedTarget(AST); 68b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner AS->addRef(); 69b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner OldAS->dropRef(AST); 709971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 719971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return AS; 729971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 739971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 749971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner void setAliasSet(AliasSet *as) { 759971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner assert(AS == 0 && "Already have an alias set!"); 769971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AS = as; 779971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 782cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner 792cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner void removeFromList() { 802cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner if (NextInList) NextInList->second.PrevInList = PrevInList; 812cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner *PrevInList = NextInList; 827e0e9c635f5439426252bd1ccbfa90b878ba0ca6Chris Lattner if (AS->PtrListEnd == &NextInList) { 837e0e9c635f5439426252bd1ccbfa90b878ba0ca6Chris Lattner AS->PtrListEnd = PrevInList; 847e0e9c635f5439426252bd1ccbfa90b878ba0ca6Chris Lattner assert(*AS->PtrListEnd == 0 && "List not terminated right!"); 857e0e9c635f5439426252bd1ccbfa90b878ba0ca6Chris Lattner } 869971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 879971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner }; 889971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 892cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner HashNodePair *PtrList, **PtrListEnd; // Doubly linked list of nodes 909971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet *Forward; // Forwarding pointer 919971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet *Next, *Prev; // Doubly linked list of AliasSets 929971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 939971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner std::vector<CallSite> CallSites; // All calls & invokes in this node 949971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 959971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner // RefCount - Number of nodes pointing to this AliasSet plus the number of 969971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner // AliasSets forwarding to it. 97bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner unsigned RefCount : 28; 989971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 99009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// AccessType - Keep track of whether this alias set merely refers to the 100009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// locations of memory, whether it modifies the memory, or whether it does 1019971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// both. The lattice goes from "NoModRef" to either Refs or Mods, then to 1025560c9d49ccae132cabf1155f18aa0480dce3edaMisha Brukman /// ModRef as necessary. 103009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 104009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner enum AccessType { 1059971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner NoModRef = 0, Refs = 1, // Ref = bit 1 1069971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner Mods = 2, ModRef = 3 // Mod = bit 2 107009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner }; 1089971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner unsigned AccessTy : 2; 109009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 110009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// AliasType - Keep track the relationships between the pointers in the set. 111009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// Lattice goes from MustAlias to MayAlias. 112009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 113009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner enum AliasType { 1149971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner MustAlias = 0, MayAlias = 1 115009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner }; 1169971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner unsigned AliasTy : 1; 117009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 118bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner // Volatile - True if this alias set contains volatile loads or stores. 119bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner bool Volatile : 1; 120bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner 1211fca5ff62bb2ecb5bfc8974f4dbfc56e9d3ca721Chris Lattner friend struct ilist_traits<AliasSet>; 122b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner AliasSet *getPrev() const { return Prev; } 123b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner AliasSet *getNext() const { return Next; } 124b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner void setPrev(AliasSet *P) { Prev = P; } 125b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner void setNext(AliasSet *N) { Next = N; } 126b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner 127b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner void addRef() { ++RefCount; } 128b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner void dropRef(AliasSetTracker &AST) { 129b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner assert(RefCount >= 1 && "Invalid reference count detected!"); 130b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner if (--RefCount == 0) 131b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner removeFromTracker(AST); 132b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner } 133b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner 134b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattnerpublic: 135b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner /// Accessors... 136b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner bool isRef() const { return AccessTy & Refs; } 137b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner bool isMod() const { return AccessTy & Mods; } 138b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner bool isMustAlias() const { return AliasTy == MustAlias; } 139b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner bool isMayAlias() const { return AliasTy == MayAlias; } 140b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner 141bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner // isVolatile - Return true if this alias set contains volatile loads or 142bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner // stores. 143bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner bool isVolatile() const { return Volatile; } 144bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner 145b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner /// isForwardingAliasSet - Return true if this alias set should be ignored as 146b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner /// part of the AliasSetTracker object. 147b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner bool isForwardingAliasSet() const { return Forward; } 148b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner 149b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner /// mergeSetIn - Merge the specified alias set into this alias set... 150b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner /// 151276636c93b35786d5719e2eda335c79d38d92632Chris Lattner void mergeSetIn(AliasSet &AS, AliasSetTracker &AST); 152b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner 153b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner // Alias Set iteration - Allow access to all of the pointer which are part of 154b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner // this alias set... 155b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner class iterator; 1562cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner iterator begin() const { return iterator(PtrList); } 157b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner iterator end() const { return iterator(); } 158877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool empty() const { return PtrList == 0; } 159b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner 160b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner void print(std::ostream &OS) const; 1615c7e326585f3a543388ba871c3425f7664cd9143Bill Wendling void print(std::ostream *OS) const { if (OS) print(*OS); } 162b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner void dump() const; 163b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner 1649971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// Define an iterator for alias sets... this is just a forward iterator. 16531a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner class iterator : public forward_iterator<HashNodePair, ptrdiff_t> { 1669971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner HashNodePair *CurNode; 1679971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner public: 1689962054775455c43402bf176da4a28c68197feefDan Gohman explicit iterator(HashNodePair *CN = 0) : CurNode(CN) {} 1699769ab22265b313171d201b5928688524a01bd87Misha Brukman 1709971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner bool operator==(const iterator& x) const { 1719971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return CurNode == x.CurNode; 1729971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 1739971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner bool operator!=(const iterator& x) const { return !operator==(x); } 174009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 1759971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner const iterator &operator=(const iterator &I) { 1769971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner CurNode = I.CurNode; 1779971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return *this; 1789971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 1799769ab22265b313171d201b5928688524a01bd87Misha Brukman 18031a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner value_type &operator*() const { 1819971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner assert(CurNode && "Dereferencing AliasSet.end()!"); 18231a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner return *CurNode; 1839971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 18431a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner value_type *operator->() const { return &operator*(); } 185877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner 186877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner Value *getPointer() const { return CurNode->first; } 187877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner unsigned getSize() const { return CurNode->second.getSize(); } 1889769ab22265b313171d201b5928688524a01bd87Misha Brukman 1899971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner iterator& operator++() { // Preincrement 1909971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner assert(CurNode && "Advancing past AliasSet.end()!"); 1919971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner CurNode = CurNode->second.getNext(); 1929971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return *this; 1939971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 1949971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner iterator operator++(int) { // Postincrement 1959769ab22265b313171d201b5928688524a01bd87Misha Brukman iterator tmp = *this; ++*this; return tmp; 1969971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 1979971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner }; 1989971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 199009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerprivate: 2009971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner // Can only be created by AliasSetTracker 2012cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner AliasSet() : PtrList(0), PtrListEnd(&PtrList), Forward(0), RefCount(0), 202bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner AccessTy(NoModRef), AliasTy(MustAlias), Volatile(false) { 2039971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 204b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner 2052cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner AliasSet(const AliasSet &AS) { 206b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner assert(0 && "Copy ctor called!?!?!"); 207b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner abort(); 2082cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner } 2092cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner 21031a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner HashNodePair *getSomePointer() const { 2112cffeec014537a5f4d2313a5c21c3aa6fcf33288Chris Lattner return PtrList; 2129971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 2139971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 2149971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// getForwardedTarget - Return the real alias set this represents. If this 2159971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// has been merged with another set and is forwarding, return the ultimate 2169971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// destination set. This also implements the union-find collapsing as well. 2179971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet *getForwardedTarget(AliasSetTracker &AST) { 2189971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner if (!Forward) return this; 2199971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 2209971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet *Dest = Forward->getForwardedTarget(AST); 2219971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner if (Dest != Forward) { 222b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner Dest->addRef(); 223b8a31ace2c49af703cf7b1f1bda408a361f53447Chris Lattner Forward->dropRef(AST); 2249971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner Forward = Dest; 2259971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 2269971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return Dest; 2279971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 2289971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 2299971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner void removeFromTracker(AliasSetTracker &AST); 2309971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 231e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner void addPointer(AliasSetTracker &AST, HashNodePair &Entry, unsigned Size, 232e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner bool KnownMustAlias = false); 233c87f0bb345642b7c278b42fa93fb3dc3c8849688Chris Lattner void addCallSite(CallSite CS, AliasAnalysis &AA); 23469fd7a3973a5c4ba4fb883b836fd0b84c046d10cChris Lattner void removeCallSite(CallSite CS) { 23534cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng for (size_t i = 0, e = CallSites.size(); i != e; ++i) 23669fd7a3973a5c4ba4fb883b836fd0b84c046d10cChris Lattner if (CallSites[i].getInstruction() == CS.getInstruction()) { 23769fd7a3973a5c4ba4fb883b836fd0b84c046d10cChris Lattner CallSites[i] = CallSites.back(); 23869fd7a3973a5c4ba4fb883b836fd0b84c046d10cChris Lattner CallSites.pop_back(); 23969fd7a3973a5c4ba4fb883b836fd0b84c046d10cChris Lattner } 24069fd7a3973a5c4ba4fb883b836fd0b84c046d10cChris Lattner } 241bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner void setVolatile() { Volatile = true; } 2429971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 2439971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// aliasesPointer - Return true if the specified pointer "may" (or must) 2449971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// alias one of the members in the set. 2459971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// 24631a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner bool aliasesPointer(const Value *Ptr, unsigned Size, AliasAnalysis &AA) const; 2479971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner bool aliasesCallSite(CallSite CS, AliasAnalysis &AA) const; 248009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner}; 249009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 2509971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattnerinline std::ostream& operator<<(std::ostream &OS, const AliasSet &AS) { 2519971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AS.print(OS); 2529971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return OS; 2539971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner} 2549971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 255009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 256009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerclass AliasSetTracker { 257009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner AliasAnalysis &AA; 2589971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner ilist<AliasSet> AliasSets; 2599971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 2609971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner // Map from pointers to their node 2619971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner hash_map<Value*, AliasSet::PointerRec> PointerMap; 262009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerpublic: 263009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// AliasSetTracker ctor - Create an empty collection of AliasSets, and use 264009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// the specified alias analysis object to disambiguate load and store 265009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// addresses. 2669962054775455c43402bf176da4a28c68197feefDan Gohman explicit AliasSetTracker(AliasAnalysis &aa) : AA(aa) {} 267fd94dd58ffef1be3597ef8cb64f3b1d476d7d5ecAnton Korobeynikov ~AliasSetTracker() { clear(); } 268009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 269009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// add methods - These methods are used to add different types of 270009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// instructions to the alias sets. Adding a new instruction can result in 271009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// one of three actions happening: 272009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 273009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 1. If the instruction doesn't alias any other sets, create a new set. 274009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 2. If the instruction aliases exactly one set, add it to the set 275009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 3. If the instruction aliases multiple sets, merge the sets, and add 276009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// the instruction to the result. 277009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// 27812c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner /// These methods return true if inserting the instruction resulted in the 27912c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner /// addition of a new alias set (i.e., the pointer did not alias anything). 28012c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner /// 281558cb5f4a131be8de67dd66d06f5c053cbf7403eChris Lattner bool add(Value *Ptr, unsigned Size); // Add a location 28212c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool add(LoadInst *LI); 28312c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool add(StoreInst *SI); 2845c88260f70d5286adeca61c31bdf51f8debaccbcChris Lattner bool add(FreeInst *FI); 285235fc57ef2ed0a3c43a6e2d77b7c13f96a6f8036Dan Gohman bool add(VAArgInst *VAAI); 28612c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool add(CallSite CS); // Call/Invoke instructions 28712c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool add(CallInst *CI) { return add(CallSite(CI)); } 28812c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool add(InvokeInst *II) { return add(CallSite(II)); } 28912c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool add(Instruction *I); // Dispatch to one of the other add methods... 290b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner void add(BasicBlock &BB); // Add all instructions in basic block 291b75f9dda9e436b346c684c3694fbef6b14a00795Chris Lattner void add(const AliasSetTracker &AST); // Add alias relations from another AST 292009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 293877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner /// remove methods - These methods are used to remove all entries that might 294877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner /// be aliased by the specified instruction. These methods return true if any 295877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner /// alias sets were eliminated. 296558cb5f4a131be8de67dd66d06f5c053cbf7403eChris Lattner bool remove(Value *Ptr, unsigned Size); // Remove a location 297877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool remove(LoadInst *LI); 298877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool remove(StoreInst *SI); 2995c88260f70d5286adeca61c31bdf51f8debaccbcChris Lattner bool remove(FreeInst *FI); 300235fc57ef2ed0a3c43a6e2d77b7c13f96a6f8036Dan Gohman bool remove(VAArgInst *VAAI); 301877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool remove(CallSite CS); 302877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool remove(CallInst *CI) { return remove(CallSite(CI)); } 303877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool remove(InvokeInst *II) { return remove(CallSite(II)); } 304877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner bool remove(Instruction *I); 305877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner void remove(AliasSet &AS); 3068bdbb632433a2acddfebb387361e40b01f469192Chris Lattner 3078bdbb632433a2acddfebb387361e40b01f469192Chris Lattner void clear() { 3088bdbb632433a2acddfebb387361e40b01f469192Chris Lattner PointerMap.clear(); 3098bdbb632433a2acddfebb387361e40b01f469192Chris Lattner AliasSets.clear(); 3108bdbb632433a2acddfebb387361e40b01f469192Chris Lattner } 311877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner 312009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner /// getAliasSets - Return the alias sets that are active. 313e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// 3149971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner const ilist<AliasSet> &getAliasSets() const { return AliasSets; } 3159971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 3169971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// getAliasSetForPointer - Return the alias set that the specified pointer 31712c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner /// lives in. If the New argument is non-null, this method sets the value to 31812c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner /// true if a new alias set is created to contain the pointer (because the 31912c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner /// pointer didn't alias anything). 32012c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner AliasSet &getAliasSetForPointer(Value *P, unsigned Size, bool *New = 0); 3219971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 322877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner /// getAliasSetForPointerIfExists - Return the alias set containing the 323877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner /// location specified if one exists, otherwise return null. 324877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner AliasSet *getAliasSetForPointerIfExists(Value *P, unsigned Size) { 325877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner return findAliasSetForPointer(P, Size); 326877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner } 3279769ab22265b313171d201b5928688524a01bd87Misha Brukman 32807bfa52405feb99155304c1a28b71e69d046589cChris Lattner /// containsPointer - Return true if the specified location is represented by 32907bfa52405feb99155304c1a28b71e69d046589cChris Lattner /// this alias set, false otherwise. This does not modify the AST object or 33007bfa52405feb99155304c1a28b71e69d046589cChris Lattner /// alias sets. 33107bfa52405feb99155304c1a28b71e69d046589cChris Lattner bool containsPointer(Value *P, unsigned Size) const; 332877ad7d80b3eac84f9f61294bc1b78817bbca530Chris Lattner 3339971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// getAliasAnalysis - Return the underlying alias analysis object used by 3349971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner /// this tracker. 3359971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasAnalysis &getAliasAnalysis() const { return AA; } 3369971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 337e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// deleteValue method - This method is used to remove a pointer value from 338e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// the AliasSetTracker entirely. It should be used when an instruction is 339e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// deleted from the program to update the AST. If you don't use this, you 340e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// would have dangling pointers to deleted instructions. 341e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// 342e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner void deleteValue(Value *PtrVal); 343e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner 344e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// copyValue - This method should be used whenever a preexisting value in the 345e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// program is copied or cloned, introducing a new value. Note that it is ok 346e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// for clients that use this method to introduce the same value multiple 347e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// times: if the tracker already knows about a value, it will ignore the 348e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// request. 349e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner /// 350e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner void copyValue(Value *From, Value *To); 351e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner 352e2fe784500ee910536bfc7332eae82ab0fdd1bc7Chris Lattner 3539971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner typedef ilist<AliasSet>::iterator iterator; 3549971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner typedef ilist<AliasSet>::const_iterator const_iterator; 3559971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 3569971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner const_iterator begin() const { return AliasSets.begin(); } 3579971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner const_iterator end() const { return AliasSets.end(); } 3589971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 3599971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner iterator begin() { return AliasSets.begin(); } 3609971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner iterator end() { return AliasSets.end(); } 3619971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 3629971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner void print(std::ostream &OS) const; 3635c7e326585f3a543388ba871c3425f7664cd9143Bill Wendling void print(std::ostream *OS) const { if (OS) print(*OS); } 3649971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner void dump() const; 365009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 366009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattnerprivate: 3679971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner friend class AliasSet; 3689971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner void removeAliasSet(AliasSet *AS); 3699971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 3709971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet::HashNodePair &getEntryFor(Value *V) { 3719971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner // Standard operator[], except that it returns the whole pair, not just 3729971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner // ->second. 3739971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return *PointerMap.insert(AliasSet::HashNodePair(V, 3749971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet::PointerRec())).first; 3759971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 3769971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 37712c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner AliasSet &addPointer(Value *P, unsigned Size, AliasSet::AccessType E, 37812c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner bool &NewSet) { 37912c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner NewSet = false; 38012c1155403fd2dbd3a24e3748e7d80bbaa27c7f6Chris Lattner AliasSet &AS = getAliasSetForPointer(P, Size, &NewSet); 3819971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AS.AccessTy |= E; 382bb8f4769a2ee48b82c30de52083942781e920dd9Chris Lattner return AS; 3839971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner } 38431a9d185bfa253af2f0fece59d8b1227dad64b15Chris Lattner AliasSet *findAliasSetForPointer(const Value *Ptr, unsigned Size); 3859971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 3869971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AliasSet *findAliasSetForCallSite(CallSite CS); 387009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner}; 388009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner 3899971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattnerinline std::ostream& operator<<(std::ostream &OS, const AliasSetTracker &AST) { 3909971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner AST.print(OS); 3919971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner return OS; 3929971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner} 3939971ac4a36c54488bcdf55d7e493ac0cd6dc168aChris Lattner 394d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 395d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 396009cc3d2e85674f01f70d915e0c802d89d0b672fChris Lattner#endif 397