Various cleanups and efficiency improvements
[oota-llvm.git] / lib / Transforms / Utils / LowerAllocations.cpp
index ceb45f59c6710c9874424c229d53994104a17895..96008881bbaba321325a9e0efee3ad73f709de54 100644 (file)
-//===- llvm/Transforms/LowerAllocations.h - Remove Malloc & Free Insts ------=//
+//===- LowerAllocations.cpp - Reduce malloc & free insts to calls ---------===//
+// 
+//                     The LLVM Compiler Infrastructure
 //
-// This file implements a pass that lowers malloc and free instructions to
-// calls to %malloc & %free functions.  This transformation is a target
-// dependant tranformation because we depend on the size of data types and
-// alignment constraints.
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// The LowerAllocations transformation is a target dependent tranformation
+// because it depends on the size of data types and alignment constraints.
 //
 //===----------------------------------------------------------------------===//
 
-#include "llvm/Transforms/LowerAllocations.h"
-#include "llvm/Target/TargetData.h"
+#include "llvm/Transforms/Scalar.h"
+#include "llvm/Module.h"
 #include "llvm/DerivedTypes.h"
 #include "llvm/iMemory.h"
 #include "llvm/iOther.h"
-#include "llvm/SymbolTable.h"
-#include "llvm/ConstantVals.h"
+#include "llvm/Constants.h"
+#include "llvm/Pass.h"
+#include "llvm/Target/TargetData.h"
+#include "Support/Statistic.h"
+
+namespace {
+  Statistic<> NumLowered("lowerallocs", "Number of allocations lowered");
+
+  /// LowerAllocations - Turn malloc and free instructions into %malloc and
+  /// %free calls.
+  ///
+  class LowerAllocations : public BasicBlockPass {
+    Function *MallocFunc;   // Functions in the module we are processing
+    Function *FreeFunc;     // Initialized by doInitialization
+  public:
+    LowerAllocations() : MallocFunc(0), FreeFunc(0) {}
+
+    virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+      AU.addRequired<TargetData>();
+    }
+
+    /// doPassInitialization - For the lower allocations pass, this ensures that
+    /// a module contains a declaration for a malloc and a free function.
+    ///
+    bool doInitialization(Module &M);
+    
+    /// runOnBasicBlock - This method does the actual work of converting
+    /// instructions over, assuming that the pass has already been initialized.
+    ///
+    bool runOnBasicBlock(BasicBlock &BB);
+  };
+
+  RegisterOpt<LowerAllocations>
+  X("lowerallocs", "Lower allocations from instructions to calls");
+}
 
-// doPassInitialization - For the lower allocations pass, this ensures that a
+// createLowerAllocationsPass - Interface to this file...
+FunctionPass *createLowerAllocationsPass() {
+  return new LowerAllocations();
+}
+
+
+// doInitialization - For the lower allocations pass, this ensures that a
 // module contains a declaration for a malloc and a free function.
 //
 // This function is always successful.
 //
-bool LowerAllocations::doPassInitialization(Module *M) {
-  bool Changed = false;
-  const MethodType *MallocType = 
-    MethodType::get(PointerType::get(Type::SByteTy),
-                    vector<const Type*>(1, Type::UIntTy), false);
-
-  SymbolTable *SymTab = M->getSymbolTableSure();
-  
-  // Check for a definition of malloc
-  if (Value *V = SymTab->lookup(PointerType::get(MallocType), "malloc")) {
-    MallocMeth = cast<Method>(V);      // Yup, got it
-  } else {                             // Nope, add one
-    M->getMethodList().push_back(MallocMeth = new Method(MallocType, "malloc"));
-    Changed = true;
-  }
-
-  const MethodType *FreeType = 
-    MethodType::get(Type::VoidTy,
-                    vector<const Type*>(1, PointerType::get(Type::SByteTy)),
-                   false);
+bool LowerAllocations::doInitialization(Module &M) {
+  const Type *SBPTy = PointerType::get(Type::SByteTy);
+  MallocFunc = M.getOrInsertFunction("malloc", SBPTy, Type::UIntTy, 0);
+  FreeFunc   = M.getOrInsertFunction("free"  , Type::VoidTy, SBPTy, 0);
 
-  // Check for a definition of free
-  if (Value *V = SymTab->lookup(PointerType::get(FreeType), "free")) {
-    FreeMeth = cast<Method>(V);      // Yup, got it
-  } else {                             // Nope, add one
-    M->getMethodList().push_back(FreeMeth = new Method(FreeType, "free"));
-    Changed = true;
-  }
-
-  return Changed;  // Always successful
+  return true;
 }
 
-// doPerMethodWork - This method does the actual work of converting
+// runOnBasicBlock - This method does the actual work of converting
 // instructions over, assuming that the pass has already been initialized.
 //
-bool LowerAllocations::doPerMethodWork(Method *M) {
+bool LowerAllocations::runOnBasicBlock(BasicBlock &BB) {
   bool Changed = false;
-  assert(MallocMeth && FreeMeth && M && "Pass not initialized!");
-
-  // Loop over all of the instructions, looking for malloc or free instructions
-  for (Method::iterator BBI = M->begin(), BBE = M->end(); BBI != BBE; ++BBI) {
-    BasicBlock *BB = *BBI;
-    for (unsigned i = 0; i < BB->size(); ++i) {
-      BasicBlock::InstListType &BBIL = BB->getInstList();
-      if (MallocInst *MI = dyn_cast<MallocInst>(*(BBIL.begin()+i))) {
-        BBIL.remove(BBIL.begin()+i);   // remove the malloc instr...
-        
-        const Type *AllocTy = cast<PointerType>(MI->getType())->getValueType();
-
-        // If the user is allocating an unsized array with a dynamic size arg,
-        // start by getting the size of one element.
-        //
-        if (const ArrayType *ATy = dyn_cast<ArrayType>(AllocTy)) 
-          if (ATy->isUnsized()) AllocTy = ATy->getElementType();
-
-        // Get the number of bytes to be allocated for one element of the
-        // requested type...
-        unsigned Size = DataLayout.getTypeSize(AllocTy);
-
-        // malloc(type) becomes sbyte *malloc(constint)
-        Value *MallocArg = ConstantUInt::get(Type::UIntTy, Size);
-        if (MI->getNumOperands() && Size == 1) {
-          MallocArg = MI->getOperand(0);         // Operand * 1 = Operand
-        } else if (MI->getNumOperands()) {
-          // Multiply it by the array size if neccesary...
-          MallocArg = BinaryOperator::create(Instruction::Mul,MI->getOperand(0),
-                                             MallocArg);
-          BBIL.insert(BBIL.begin()+i++, cast<Instruction>(MallocArg));
-        }
+  assert(MallocFunc && FreeFunc && "Pass not initialized!");
 
-        // Create the call to Malloc...
-        CallInst *MCall = new CallInst(MallocMeth,
-                                       vector<Value*>(1, MallocArg));
-        BBIL.insert(BBIL.begin()+i, MCall);
+  BasicBlock::InstListType &BBIL = BB.getInstList();
+  TargetData &DataLayout = getAnalysis<TargetData>();
 
-        // Create a cast instruction to convert to the right type...
-        CastInst *MCast = new CastInst(MCall, MI->getType());
-        BBIL.insert(BBIL.begin()+i+1, MCast);
-
-        // Replace all uses of the old malloc inst with the cast inst
-        MI->replaceAllUsesWith(MCast);
-        delete MI;                          // Delete the malloc inst
-        Changed = true;
-      } else if (FreeInst *FI = dyn_cast<FreeInst>(*(BBIL.begin()+i))) {
-        BBIL.remove(BB->getInstList().begin()+i);
-
-        // Cast the argument to free into a ubyte*...
-        CastInst *MCast = new CastInst(FI->getOperand(0), 
-                                       PointerType::get(Type::UByteTy));
-        BBIL.insert(BBIL.begin()+i, MCast);
-
-        // Insert a call to the free function...
-        CallInst *FCall = new CallInst(FreeMeth,
-                                       vector<Value*>(1, MCast));
-        BBIL.insert(BBIL.begin()+i+1, FCall);
-
-        // Delete the old free instruction
-        delete FI;
-        Changed = true;
+  // Loop over all of the instructions, looking for malloc or free instructions
+  for (BasicBlock::iterator I = BB.begin(), E = BB.end(); I != E; ++I) {
+    if (MallocInst *MI = dyn_cast<MallocInst>(I)) {
+      const Type *AllocTy = MI->getType()->getElementType();
+      
+      // Get the number of bytes to be allocated for one element of the
+      // requested type...
+      unsigned Size = DataLayout.getTypeSize(AllocTy);
+      
+      // malloc(type) becomes sbyte *malloc(constint)
+      Value *MallocArg = ConstantUInt::get(Type::UIntTy, Size);
+      if (MI->getNumOperands() && Size == 1) {
+        MallocArg = MI->getOperand(0);         // Operand * 1 = Operand
+      } else if (MI->getNumOperands()) {
+        // Multiply it by the array size if necessary...
+        MallocArg = BinaryOperator::create(Instruction::Mul, MI->getOperand(0),
+                                           MallocArg, "", I);
       }
+      
+      // Create the call to Malloc...
+      CallInst *MCall = new CallInst(MallocFunc,
+                                     std::vector<Value*>(1, MallocArg), "", I);
+      
+      // Create a cast instruction to convert to the right type...
+      CastInst *MCast = new CastInst(MCall, MI->getType(), "", I);
+      
+      // Replace all uses of the old malloc inst with the cast inst
+      MI->replaceAllUsesWith(MCast);
+      I = --BBIL.erase(I);         // remove and delete the malloc instr...
+      Changed = true;
+      ++NumLowered;
+    } else if (FreeInst *FI = dyn_cast<FreeInst>(I)) {
+      // Cast the argument to free into a ubyte*...
+      CastInst *MCast = new CastInst(FI->getOperand(0), 
+                                     PointerType::get(Type::SByteTy), "", I);
+      
+      // Insert a call to the free function...
+      CallInst *FCall = new CallInst(FreeFunc, std::vector<Value*>(1, MCast),
+                                     "", I);
+      
+      // Delete the old free instruction
+      I = --BBIL.erase(I);
+      Changed = true;
+      ++NumLowered;
     }
   }
 
   return Changed;
 }
-