lib/VMCore/Use.cpp

   1 //===-- Use.cpp - Implement the Use class ---------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the algorithm for finding the User of a Use.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/User.h"
  15
  16 namespace llvm {
  17
  18 //===----------------------------------------------------------------------===//
  19 //                         Use swap Implementation
  20 //===----------------------------------------------------------------------===//
  21
  22 void Use::swap(Use &RHS) {
  23   Value *V1(Val);
  24   Value *V2(RHS.Val);
  25   if (V1 != V2) {
  26     if (V1) {
  27       removeFromList();
  28     }
  29
  30     if (V2) {
  31       RHS.removeFromList();
  32       Val = V2;
  33       V2->addUse(*this);
  34     } else {
  35       Val = 0;
  36     }
  37
  38     if (V1) {
  39       RHS.Val = V1;
  40       V1->addUse(RHS);
  41     } else {
  42       RHS.Val = 0;
  43     }
  44   }
  45 }
  46
  47 //===----------------------------------------------------------------------===//
  48 //                         Use getImpliedUser Implementation
  49 //===----------------------------------------------------------------------===//
  50
  51 const Use *Use::getImpliedUser() const {
  52   const Use *Current = this;
  53
  54   while (true) {
  55     unsigned Tag = (Current++)->Prev.getInt();
  56     switch (Tag) {
  57       case zeroDigitTag:
  58       case oneDigitTag:
  59         continue;
  60
  61       case stopTag: {
  62         ++Current;
  63         ptrdiff_t Offset = 1;
  64         while (true) {
  65           unsigned Tag = Current->Prev.getInt();
  66           switch (Tag) {
  67             case zeroDigitTag:
  68             case oneDigitTag:
  69               ++Current;
  70               Offset = (Offset << 1) + Tag;
  71               continue;
  72             default:
  73               return Current + Offset;
  74           }
  75         }
  76       }
  77
  78       case fullStopTag:
  79         return Current;
  80     }
  81   }
  82 }
  83
  84 //===----------------------------------------------------------------------===//
  85 //                         Use initTags Implementation
  86 //===----------------------------------------------------------------------===//
  87
  88 Use *Use::initTags(Use * const Start, Use *Stop, ptrdiff_t Done) {
  89   while (Done < 6) {
  90     if (Start == Stop--)
  91       return Start;
  92     static const PrevPtrTag tags[6] = { fullStopTag, oneDigitTag, stopTag,
  93                                         oneDigitTag, oneDigitTag, stopTag };
  94     Stop->Prev.setFromOpaqueValue(reinterpret_cast<Use**>(tags[Done++]));
  95     Stop->Val = 0;
  96   }
  97
  98   ptrdiff_t Count = Done;
  99   while (Start != Stop) {
 100     --Stop;
 101     Stop->Val = 0;
 102     if (!Count) {
 103       Stop->Prev.setFromOpaqueValue(reinterpret_cast<Use**>(Done == 0
 104                                                             ? fullStopTag
 105                                                             : stopTag));
 106       ++Done;
 107       Count = Done;
 108     } else {
 109       Stop->Prev.setFromOpaqueValue(reinterpret_cast<Use**>(Count & 1));
 110       Count >>= 1;
 111       ++Done;
 112     }
 113   }
 114
 115   return Start;
 116 }
 117
 118 //===----------------------------------------------------------------------===//
 119 //                         Use zap Implementation
 120 //===----------------------------------------------------------------------===//
 121
 122 void Use::zap(Use *Start, const Use *Stop, bool del) {
 123   if (del) {
 124     while (Start != Stop) {
 125       (--Stop)->~Use();
 126     }
 127     ::operator delete(Start);
 128     return;
 129   }
 130
 131   while (Start != Stop) {
 132     (Start++)->set(0);
 133   }
 134 }
 135
 136 //===----------------------------------------------------------------------===//
 137 //                         AugmentedUse layout struct
 138 //===----------------------------------------------------------------------===//
 139
 140 struct AugmentedUse : public Use {
 141   PointerIntPair<User*, 1, Tag> ref;
 142   AugmentedUse(); // not implemented
 143 };
 144
 145
 146 //===----------------------------------------------------------------------===//
 147 //                         Use getUser Implementation
 148 //===----------------------------------------------------------------------===//
 149
 150 User *Use::getUser() const {
 151   const Use *End = getImpliedUser();
 152   const PointerIntPair<User*, 1, Tag>& ref(
 153                                 static_cast<const AugmentedUse*>(End - 1)->ref);
 154   User *She = ref.getPointer();
 155   return ref.getInt()
 156     ? She
 157     : (User*)End;
 158 }
 159
 160 //===----------------------------------------------------------------------===//
 161 //                         User allocHungoffUses Implementation
 162 //===----------------------------------------------------------------------===//
 163
 164 Use *User::allocHungoffUses(unsigned N) const {
 165   Use *Begin = static_cast<Use*>(::operator new(sizeof(Use) * N
 166                                                 + sizeof(AugmentedUse)
 167                                                 - sizeof(Use)));
 168   Use *End = Begin + N;
 169   PointerIntPair<User*, 1, Tag>& ref(static_cast<AugmentedUse&>(End[-1]).ref);
 170   ref.setPointer(const_cast<User*>(this));
 171   ref.setInt(tagOne);
 172   return Use::initTags(Begin, End);
 173 }
 174
 175 //===----------------------------------------------------------------------===//
 176 //                         User operator new Implementations
 177 //===----------------------------------------------------------------------===//
 178
 179 void *User::operator new(size_t s, unsigned Us) {
 180   void *Storage = ::operator new(s + sizeof(Use) * Us);
 181   Use *Start = static_cast<Use*>(Storage);
 182   Use *End = Start + Us;
 183   User *Obj = reinterpret_cast<User*>(End);
 184   Obj->OperandList = Start;
 185   Obj->NumOperands = Us;
 186   Use::initTags(Start, End);
 187   return Obj;
 188 }
 189
 190 /// Prefixed allocation - just before the first Use, allocate a NULL pointer.
 191 /// The destructor can detect its presence and readjust the OperandList
 192 /// for deletition.
 193 ///
 194 void *User::operator new(size_t s, unsigned Us, bool Prefix) {
 195   // currently prefixed allocation only admissible for
 196   // unconditional branch instructions
 197   if (!Prefix)
 198     return operator new(s, Us);
 199
 200   assert(Us == 1 && "Other than one Use allocated?");
 201   typedef PointerIntPair<void*, 2, Use::PrevPtrTag> TaggedPrefix;
 202   void *Raw = ::operator new(s + sizeof(TaggedPrefix) + sizeof(Use) * Us);
 203   TaggedPrefix *Pre = static_cast<TaggedPrefix*>(Raw);
 204   Pre->setFromOpaqueValue(0);
 205   void *Storage = Pre + 1; // skip over prefix
 206   Use *Start = static_cast<Use*>(Storage);
 207   Use *End = Start + Us;
 208   User *Obj = reinterpret_cast<User*>(End);
 209   Obj->OperandList = Start;
 210   Obj->NumOperands = Us;
 211   Use::initTags(Start, End);
 212   return Obj;
 213 }
 214
 215 //===----------------------------------------------------------------------===//
 216 //                         User operator delete Implementation
 217 //===----------------------------------------------------------------------===//
 218
 219 void User::operator delete(void *Usr) {
 220   User *Start = static_cast<User*>(Usr);
 221   Use *Storage = static_cast<Use*>(Usr) - Start->NumOperands;
 222   //
 223   // look for a variadic User
 224   if (Storage == Start->OperandList) {
 225     ::operator delete(Storage);
 226     return;
 227   }
 228   //
 229   // check for the flag whether the destructor has detected a prefixed
 230   // allocation, in which case we remove the flag and delete starting
 231   // at OperandList
 232   if (reinterpret_cast<intptr_t>(Start->OperandList) & 1) {
 233     ::operator delete(reinterpret_cast<char*>(Start->OperandList) - 1);
 234     return;
 235   }
 236   //
 237   // in all other cases just delete the nullary User (covers hung-off
 238   // uses also
 239   ::operator delete(Usr);
 240 }
 241
 242 } // End llvm namespace