lib/Transforms/Utils/LowerAllocations.cpp

   1 //===- llvm/Transforms/LowerAllocations.h - Remove Malloc & Free Insts ------=//
   2 //
   3 // This file implements a pass that lowers malloc and free instructions to
   4 // calls to %malloc & %free functions.  This transformation is a target
   5 // dependant tranformation because we depend on the size of data types and
   6 // alignment constraints.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "llvm/Transforms/LowerAllocations.h"
  11 #include "llvm/Target/TargetData.h"
  12 #include "llvm/DerivedTypes.h"
  13 #include "llvm/iMemory.h"
  14 #include "llvm/iOther.h"
  15 #include "llvm/SymbolTable.h"
  16 #include "llvm/ConstantVals.h"
  17 using std::vector;
  18
  19
  20 // doInitialization - For the lower allocations pass, this ensures that a
  21 // module contains a declaration for a malloc and a free function.
  22 //
  23 // This function is always successful.
  24 //
  25 bool LowerAllocations::doInitialization(Module *M) {
  26   bool Changed = false;
  27   const MethodType *MallocType =
  28     MethodType::get(PointerType::get(Type::SByteTy),
  29                     vector<const Type*>(1, Type::UIntTy), false);
  30
  31   SymbolTable *SymTab = M->getSymbolTableSure();
  32
  33   // Check for a definition of malloc
  34   if (Value *V = SymTab->lookup(PointerType::get(MallocType), "malloc")) {
  35     MallocMeth = cast<Method>(V);      // Yup, got it
  36   } else {                             // Nope, add one
  37     M->getMethodList().push_back(MallocMeth = new Method(MallocType, false,
  38                                                          "malloc"));
  39     Changed = true;
  40   }
  41
  42   const MethodType *FreeType =
  43     MethodType::get(Type::VoidTy,
  44                     vector<const Type*>(1, PointerType::get(Type::SByteTy)),
  45                     false);
  46
  47   // Check for a definition of free
  48   if (Value *V = SymTab->lookup(PointerType::get(FreeType), "free")) {
  49     FreeMeth = cast<Method>(V);      // Yup, got it
  50   } else {                             // Nope, add one
  51     M->getMethodList().push_back(FreeMeth = new Method(FreeType, false,"free"));
  52     Changed = true;
  53   }
  54
  55   return Changed;  // Always successful
  56 }
  57
  58 // runOnMethod - This method does the actual work of converting
  59 // instructions over, assuming that the pass has already been initialized.
  60 //
  61 bool LowerAllocations::runOnMethod(Method *M) {
  62   bool Changed = false;
  63   assert(MallocMeth && FreeMeth && M && "Pass not initialized!");
  64
  65   // Loop over all of the instructions, looking for malloc or free instructions
  66   for (Method::iterator BBI = M->begin(), BBE = M->end(); BBI != BBE; ++BBI) {
  67     BasicBlock *BB = *BBI;
  68     for (unsigned i = 0; i < BB->size(); ++i) {
  69       BasicBlock::InstListType &BBIL = BB->getInstList();
  70       if (MallocInst *MI = dyn_cast<MallocInst>(*(BBIL.begin()+i))) {
  71         BBIL.remove(BBIL.begin()+i);   // remove the malloc instr...
  72
  73         const Type *AllocTy =cast<PointerType>(MI->getType())->getElementType();
  74
  75         // Get the number of bytes to be allocated for one element of the
  76         // requested type...
  77         unsigned Size = DataLayout.getTypeSize(AllocTy);
  78
  79         // malloc(type) becomes sbyte *malloc(constint)
  80         Value *MallocArg = ConstantUInt::get(Type::UIntTy, Size);
  81         if (MI->getNumOperands() && Size == 1) {
  82           MallocArg = MI->getOperand(0);         // Operand * 1 = Operand
  83         } else if (MI->getNumOperands()) {
  84           // Multiply it by the array size if neccesary...
  85           MallocArg = BinaryOperator::create(Instruction::Mul,MI->getOperand(0),
  86                                              MallocArg);
  87           BBIL.insert(BBIL.begin()+i++, cast<Instruction>(MallocArg));
  88         }
  89
  90         // Create the call to Malloc...
  91         CallInst *MCall = new CallInst(MallocMeth,
  92                                        vector<Value*>(1, MallocArg));
  93         BBIL.insert(BBIL.begin()+i, MCall);
  94
  95         // Create a cast instruction to convert to the right type...
  96         CastInst *MCast = new CastInst(MCall, MI->getType());
  97         BBIL.insert(BBIL.begin()+i+1, MCast);
  98
  99         // Replace all uses of the old malloc inst with the cast inst
 100         MI->replaceAllUsesWith(MCast);
 101         delete MI;                          // Delete the malloc inst
 102         Changed = true;
 103       } else if (FreeInst *FI = dyn_cast<FreeInst>(*(BBIL.begin()+i))) {
 104         BBIL.remove(BB->getInstList().begin()+i);
 105
 106         // Cast the argument to free into a ubyte*...
 107         CastInst *MCast = new CastInst(FI->getOperand(0),
 108                                        PointerType::get(Type::UByteTy));
 109         BBIL.insert(BBIL.begin()+i, MCast);
 110
 111         // Insert a call to the free function...
 112         CallInst *FCall = new CallInst(FreeMeth,
 113                                        vector<Value*>(1, MCast));
 114         BBIL.insert(BBIL.begin()+i+1, FCall);
 115
 116         // Delete the old free instruction
 117         delete FI;
 118         Changed = true;
 119       }
 120     }
 121   }
 122
 123   return Changed;
 124 }
 125