Re-reapply "[IR] Move optional data in llvm::Function into a hungoff uselist"

Make personality functions, prefix data, and prologue data hungoff
operands of Function.

This is based on the email thread "[RFC] Clean up the way we store
optional Function data" on llvm-dev.

Thanks to sanjoyd, majnemer, rnk, loladiro, and dexonsmith for feedback!

Includes a fix to scrub value subclass data in dropAllReferences. Does not
use binary literals.

Differential Revision: http://reviews.llvm.org/D13829

llvm-svn: 256095
diff --git a/llvm/lib/IR/Function.cpp b/llvm/lib/IR/Function.cpp
index 5e4d2d2..f5974a6 100644
--- a/llvm/lib/IR/Function.cpp
+++ b/llvm/lib/IR/Function.cpp
@@ -279,9 +279,6 @@
 
   // Remove the function from the on-the-side GC table.
   clearGC();
-
-  // FIXME: needed by operator delete
-  setFunctionNumOperands(1);
 }
 
 void Function::BuildLazyArguments() const {
@@ -328,14 +325,15 @@
   while (!BasicBlocks.empty())
     BasicBlocks.begin()->eraseFromParent();
 
-  // Prefix and prologue data are stored in a side table.
-  setPrefixData(nullptr);
-  setPrologueData(nullptr);
+  // Drop uses of any optional data (real or placeholder).
+  if (getNumOperands()) {
+    User::dropAllReferences();
+    setNumHungOffUseOperands(0);
+    setValueSubclassData(getSubclassDataFromValue() & ~0xe);
+  }
 
   // Metadata is stored in a side-table.
   clearMetadata();
-
-  setPersonalityFn(nullptr);
 }
 
 void Function::addAttribute(unsigned i, Attribute::AttrKind attr) {
@@ -425,18 +423,12 @@
     setGC(SrcF->getGC());
   else
     clearGC();
-  if (SrcF->hasPrefixData())
-    setPrefixData(SrcF->getPrefixData());
-  else
-    setPrefixData(nullptr);
-  if (SrcF->hasPrologueData())
-    setPrologueData(SrcF->getPrologueData());
-  else
-    setPrologueData(nullptr);
   if (SrcF->hasPersonalityFn())
     setPersonalityFn(SrcF->getPersonalityFn());
-  else
-    setPersonalityFn(nullptr);
+  if (SrcF->hasPrefixData())
+    setPrefixData(SrcF->getPrefixData());
+  if (SrcF->hasPrologueData())
+    setPrologueData(SrcF->getPrologueData());
 }
 
 /// \brief This does the actual lookup of an intrinsic ID which
@@ -944,61 +936,67 @@
   return false;
 }
 
-static Constant *
-getFunctionData(const Function *F,
-                const LLVMContextImpl::FunctionDataMapTy &Map) {
-  const auto &Entry = Map.find(F);
-  assert(Entry != Map.end());
-  return cast<Constant>(Entry->second->getReturnValue());
+Constant *Function::getPersonalityFn() const {
+  assert(hasPersonalityFn() && getNumOperands());
+  return cast<Constant>(Op<0>());
 }
 
-/// setFunctionData - Set "Map[F] = Data". Return an updated SubclassData value
-/// in which Bit is low iff Data is null.
-static unsigned setFunctionData(Function *F,
-                                LLVMContextImpl::FunctionDataMapTy &Map,
-                                Constant *Data, unsigned SCData, unsigned Bit) {
-  ReturnInst *&Holder = Map[F];
-  if (Data) {
-    if (Holder)
-      Holder->setOperand(0, Data);
-    else
-      Holder = ReturnInst::Create(F->getContext(), Data);
-    return SCData | (1 << Bit);
-  } else {
-    delete Holder;
-    Map.erase(F);
-    return SCData & ~(1 << Bit);
-  }
+void Function::setPersonalityFn(Constant *Fn) {
+  if (Fn)
+    setHungoffOperand<0>(Fn);
+  setValueSubclassDataBit(3, Fn != nullptr);
 }
 
 Constant *Function::getPrefixData() const {
-  assert(hasPrefixData());
-  return getFunctionData(this, getContext().pImpl->PrefixDataMap);
+  assert(hasPrefixData() && getNumOperands());
+  return cast<Constant>(Op<1>());
 }
 
 void Function::setPrefixData(Constant *PrefixData) {
-  if (!PrefixData && !hasPrefixData())
-    return;
-
-  unsigned SCData = getSubclassDataFromValue();
-  SCData = setFunctionData(this, getContext().pImpl->PrefixDataMap, PrefixData,
-                           SCData, /*Bit=*/1);
-  setValueSubclassData(SCData);
+  if (PrefixData)
+    setHungoffOperand<1>(PrefixData);
+  setValueSubclassDataBit(1, PrefixData != nullptr);
 }
 
 Constant *Function::getPrologueData() const {
-  assert(hasPrologueData());
-  return getFunctionData(this, getContext().pImpl->PrologueDataMap);
+  assert(hasPrologueData() && getNumOperands());
+  return cast<Constant>(Op<2>());
 }
 
 void Function::setPrologueData(Constant *PrologueData) {
-  if (!PrologueData && !hasPrologueData())
+  if (PrologueData)
+    setHungoffOperand<2>(PrologueData);
+  setValueSubclassDataBit(2, PrologueData != nullptr);
+}
+
+void Function::allocHungoffUselist() {
+  // If we've already allocated a uselist, stop here.
+  if (getNumOperands())
     return;
 
-  unsigned SCData = getSubclassDataFromValue();
-  SCData = setFunctionData(this, getContext().pImpl->PrologueDataMap,
-                           PrologueData, SCData, /*Bit=*/2);
-  setValueSubclassData(SCData);
+  allocHungoffUses(3, /*IsPhi=*/ false);
+  setNumHungOffUseOperands(3);
+
+  // Initialize the uselist with placeholder operands to allow traversal.
+  auto *CPN = ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0));
+  Op<0>().set(CPN);
+  Op<1>().set(CPN);
+  Op<2>().set(CPN);
+}
+
+template <int Idx>
+void Function::setHungoffOperand(Constant *C) {
+  assert(C && "Cannot set hungoff operand to nullptr");
+  allocHungoffUselist();
+  Op<Idx>().set(C);
+}
+
+void Function::setValueSubclassDataBit(unsigned Bit, bool On) {
+  assert(Bit < 16 && "SubclassData contains only 16 bits");
+  if (On)
+    setValueSubclassData(getSubclassDataFromValue() | (1 << Bit));
+  else
+    setValueSubclassData(getSubclassDataFromValue() & ~(1 << Bit));
 }
 
 void Function::setEntryCount(uint64_t Count) {
@@ -1016,22 +1014,3 @@
       }
   return None;
 }
-
-void Function::setPersonalityFn(Constant *C) {
-  if (!C) {
-    if (hasPersonalityFn()) {
-      // Note, the num operands is used to compute the offset of the operand, so
-      // the order here matters.  Clearing the operand then clearing the num
-      // operands ensures we have the correct offset to the operand.
-      Op<0>().set(nullptr);
-      setFunctionNumOperands(0);
-    }
-  } else {
-    // Note, the num operands is used to compute the offset of the operand, so
-    // the order here matters.  We need to set num operands to 1 first so that
-    // we get the correct offset to the first operand when we set it.
-    if (!hasPersonalityFn())
-      setFunctionNumOperands(1);
-    Op<0>().set(C);
-  }
-}