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
  18 // doPassInitialization - For the lower allocations pass, this ensures that a
  19 // module contains a declaration for a malloc and a free function.
  20 //
  21 // This function is always successful.
  22 //
  23 bool LowerAllocations::doPassInitialization(Module *M) {
  24   bool Changed = false;
  25   const MethodType *MallocType =
  26     MethodType::get(PointerType::get(Type::SByteTy),
  27                     vector<const Type*>(1, Type::UIntTy), false);
  28
  29   SymbolTable *SymTab = M->getSymbolTableSure();
  30
  31   // Check for a definition of malloc
  32   if (Value *V = SymTab->lookup(PointerType::get(MallocType), "malloc")) {
  33     MallocMeth = cast<Method>(V);      // Yup, got it
  34   } else {                             // Nope, add one
  35     M->getMethodList().push_back(MallocMeth = new Method(MallocType, false,
  36                                                          "malloc"));
  37     Changed = true;
  38   }
  39
  40   const MethodType *FreeType =
  41     MethodType::get(Type::VoidTy,
  42                     vector<const Type*>(1, PointerType::get(Type::SByteTy)),
  43                     false);
  44
  45   // Check for a definition of free
  46   if (Value *V = SymTab->lookup(PointerType::get(FreeType), "free")) {
  47     FreeMeth = cast<Method>(V);      // Yup, got it
  48   } else {                             // Nope, add one
  49     M->getMethodList().push_back(FreeMeth = new Method(FreeType, false,"free"));
  50     Changed = true;
  51   }
  52
  53   return Changed;  // Always successful
  54 }
  55
  56 // doPerMethodWork - This method does the actual work of converting
  57 // instructions over, assuming that the pass has already been initialized.
  58 //
  59 bool LowerAllocations::doPerMethodWork(Method *M) {
  60   bool Changed = false;
  61   assert(MallocMeth && FreeMeth && M && "Pass not initialized!");
  62
  63   // Loop over all of the instructions, looking for malloc or free instructions
  64   for (Method::iterator BBI = M->begin(), BBE = M->end(); BBI != BBE; ++BBI) {
  65     BasicBlock *BB = *BBI;
  66     for (unsigned i = 0; i < BB->size(); ++i) {
  67       BasicBlock::InstListType &BBIL = BB->getInstList();
  68       if (MallocInst *MI = dyn_cast<MallocInst>(*(BBIL.begin()+i))) {
  69         BBIL.remove(BBIL.begin()+i);   // remove the malloc instr...
  70
  71         const Type *AllocTy =cast<PointerType>(MI->getType())->getElementType();
  72
  73         // If the user is allocating an unsized array with a dynamic size arg,
  74         // start by getting the size of one element.
  75         //
  76         if (const ArrayType *ATy = dyn_cast<ArrayType>(AllocTy))
  77           if (ATy->isUnsized()) AllocTy = ATy->getElementType();
  78
  79         // Get the number of bytes to be allocated for one element of the
  80         // requested type...
  81         unsigned Size = DataLayout.getTypeSize(AllocTy);
  82
  83         // malloc(type) becomes sbyte *malloc(constint)
  84         Value *MallocArg = ConstantUInt::get(Type::UIntTy, Size);
  85         if (MI->getNumOperands() && Size == 1) {
  86           MallocArg = MI->getOperand(0);         // Operand * 1 = Operand
  87         } else if (MI->getNumOperands()) {
  88           // Multiply it by the array size if neccesary...
  89           MallocArg = BinaryOperator::create(Instruction::Mul,MI->getOperand(0),
  90                                              MallocArg);
  91           BBIL.insert(BBIL.begin()+i++, cast<Instruction>(MallocArg));
  92         }
  93
  94         // Create the call to Malloc...
  95         CallInst *MCall = new CallInst(MallocMeth,
  96                                        vector<Value*>(1, MallocArg));
  97         BBIL.insert(BBIL.begin()+i, MCall);
  98
  99         // Create a cast instruction to convert to the right type...
 100         CastInst *MCast = new CastInst(MCall, MI->getType());
 101         BBIL.insert(BBIL.begin()+i+1, MCast);
 102
 103         // Replace all uses of the old malloc inst with the cast inst
 104         MI->replaceAllUsesWith(MCast);
 105         delete MI;                          // Delete the malloc inst
 106         Changed = true;
 107       } else if (FreeInst *FI = dyn_cast<FreeInst>(*(BBIL.begin()+i))) {
 108         BBIL.remove(BB->getInstList().begin()+i);
 109
 110         // Cast the argument to free into a ubyte*...
 111         CastInst *MCast = new CastInst(FI->getOperand(0),
 112                                        PointerType::get(Type::UByteTy));
 113         BBIL.insert(BBIL.begin()+i, MCast);
 114
 115         // Insert a call to the free function...
 116         CallInst *FCall = new CallInst(FreeMeth,
 117                                        vector<Value*>(1, MCast));
 118         BBIL.insert(BBIL.begin()+i+1, FCall);
 119
 120         // Delete the old free instruction
 121         delete FI;
 122         Changed = true;
 123       }
 124     }
 125   }
 126
 127   return Changed;
 128 }
 129