Make User track whether a class has 'hung off uses' and delete them in its destructor.
[oota-llvm.git] / lib / IR / User.cpp
1 //===-- User.cpp - Implement the User 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 #include "llvm/IR/User.h"
11 #include "llvm/IR/Constant.h"
12 #include "llvm/IR/GlobalValue.h"
13 #include "llvm/IR/Operator.h"
14
15 namespace llvm {
16 class BasicBlock;
17
18 //===----------------------------------------------------------------------===//
19 //                                 User Class
20 //===----------------------------------------------------------------------===//
21
22 void User::anchor() {}
23
24 void User::replaceUsesOfWith(Value *From, Value *To) {
25   if (From == To) return;   // Duh what?
26
27   assert((!isa<Constant>(this) || isa<GlobalValue>(this)) &&
28          "Cannot call User::replaceUsesOfWith on a constant!");
29
30   for (unsigned i = 0, E = getNumOperands(); i != E; ++i)
31     if (getOperand(i) == From) {  // Is This operand is pointing to oldval?
32       // The side effects of this setOperand call include linking to
33       // "To", adding "this" to the uses list of To, and
34       // most importantly, removing "this" from the use list of "From".
35       setOperand(i, To); // Fix it now...
36     }
37 }
38
39 //===----------------------------------------------------------------------===//
40 //                         User allocHungoffUses Implementation
41 //===----------------------------------------------------------------------===//
42
43 Use *User::allocHungoffUses(unsigned N, bool IsPhi) {
44   // Allocate the array of Uses, followed by a pointer (with bottom bit set) to
45   // the User.
46   size_t size = N * sizeof(Use) + sizeof(Use::UserRef);
47   if (IsPhi)
48     size += N * sizeof(BasicBlock *);
49   Use *Begin = static_cast<Use*>(::operator new(size));
50   Use *End = Begin + N;
51   (void) new(End) Use::UserRef(const_cast<User*>(this), 1);
52   Use *Uses = Use::initTags(Begin, End);
53   OperandList = Uses;
54   // Tag this operand list as being a hung off.
55   HasHungOffUses = true;
56   return Uses;
57 }
58
59 //===----------------------------------------------------------------------===//
60 //                         User operator new Implementations
61 //===----------------------------------------------------------------------===//
62
63 void *User::operator new(size_t s, unsigned Us) {
64   void *Storage = ::operator new(s + sizeof(Use) * Us);
65   Use *Start = static_cast<Use*>(Storage);
66   Use *End = Start + Us;
67   User *Obj = reinterpret_cast<User*>(End);
68   Obj->OperandList = Start;
69   Obj->HasHungOffUses = false;
70   Obj->NumOperands = Us;
71   Use::initTags(Start, End);
72   return Obj;
73 }
74
75 //===----------------------------------------------------------------------===//
76 //                         User operator delete Implementation
77 //===----------------------------------------------------------------------===//
78
79 void User::operator delete(void *Usr) {
80   User *Start = static_cast<User*>(Usr);
81   Use *Storage = static_cast<Use*>(Usr) - Start->NumOperands;
82   // If there were hung-off uses, they will have been freed already and
83   // NumOperands reset to 0, so here we just free the User itself.
84   ::operator delete(Storage);
85 }
86
87 //===----------------------------------------------------------------------===//
88 //                             Operator Class
89 //===----------------------------------------------------------------------===//
90
91 Operator::~Operator() {
92   llvm_unreachable("should never destroy an Operator");
93 }
94
95 } // End llvm namespace