include/llvm/Analysis/MemoryBuiltins.h

   1 //===- llvm/Analysis/MemoryBuiltins.h- Calls to memory builtins -*- C++ -*-===//
   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 // This family of functions identifies calls to builtin functions that allocate
  11 // or free memory.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_ANALYSIS_MEMORYBUILTINS_H
  16 #define LLVM_ANALYSIS_MEMORYBUILTINS_H
  17
  18 namespace llvm {
  19 class CallInst;
  20 class LLVMContext;
  21 class PointerType;
  22 class TargetData;
  23 class Type;
  24 class Value;
  25
  26 //===----------------------------------------------------------------------===//
  27 //  malloc Call Utility Functions.
  28 //
  29
  30 /// isMalloc - Returns true if the value is either a malloc call or a bitcast of
  31 /// the result of a malloc call
  32 bool isMalloc(const Value* I);
  33
  34 /// extractMallocCall - Returns the corresponding CallInst if the instruction
  35 /// is a malloc call.  Since CallInst::CreateMalloc() only creates calls, we
  36 /// ignore InvokeInst here.
  37 const CallInst* extractMallocCall(const Value* I);
  38 CallInst* extractMallocCall(Value* I);
  39
  40 /// extractMallocCallFromBitCast - Returns the corresponding CallInst if the
  41 /// instruction is a bitcast of the result of a malloc call.
  42 const CallInst* extractMallocCallFromBitCast(const Value* I);
  43 CallInst* extractMallocCallFromBitCast(Value* I);
  44
  45 /// isArrayMalloc - Returns the corresponding CallInst if the instruction
  46 /// matches the malloc call IR generated by CallInst::CreateMalloc().  This
  47 /// means that it is a malloc call with one bitcast use AND the malloc call's
  48 /// size argument is:
  49 ///  1. a constant not equal to the size of the malloced type
  50 /// or
  51 ///  2. the result of a multiplication by the size of the malloced type
  52 /// Otherwise it returns NULL.
  53 /// The unique bitcast is needed to determine the type/size of the array
  54 /// allocation.
  55 CallInst* isArrayMalloc(Value* I, LLVMContext &Context, const TargetData* TD);
  56 const CallInst* isArrayMalloc(const Value* I, LLVMContext &Context,
  57                               const TargetData* TD);
  58
  59 /// getMallocType - Returns the PointerType resulting from the malloc call.
  60 /// This PointerType is the result type of the call's only bitcast use.
  61 /// If there is no unique bitcast use, then return NULL.
  62 const PointerType* getMallocType(const CallInst* CI);
  63
  64 /// getMallocAllocatedType - Returns the Type allocated by malloc call. This
  65 /// Type is the result type of the call's only bitcast use. If there is no
  66 /// unique bitcast use, then return NULL.
  67 const Type* getMallocAllocatedType(const CallInst* CI);
  68
  69 /// getMallocArraySize - Returns the array size of a malloc call.  For array
  70 /// mallocs, the size is computated in 1 of 3 ways:
  71 ///  1. If the element type is of size 1, then array size is the argument to
  72 ///     malloc.
  73 ///  2. Else if the malloc's argument is a constant, the array size is that
  74 ///     argument divided by the element type's size.
  75 ///  3. Else the malloc argument must be a multiplication and the array size is
  76 ///     the first operand of the multiplication.
  77 /// For non-array mallocs, the computed size is constant 1.
  78 /// This function returns NULL for all mallocs whose array size cannot be
  79 /// determined.
  80 Value* getMallocArraySize(CallInst* CI, LLVMContext &Context,
  81                           const TargetData* TD);
  82
  83 //===----------------------------------------------------------------------===//
  84 //  free Call Utility Functions.
  85 //
  86
  87 /// isFreeCall - Returns true if the the value is a call to the builtin free()
  88 bool isFreeCall(const Value* I);
  89
  90 } // End llvm namespace
  91
  92 #endif