granicus.if.org Git - clang/blob - lib/CodeGen/CGCall.h

   1 //===----- CGCall.h - Encapsulate calling convention details ----*- 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 // These classes wrap the information about a call or function
  11 // definition used to handle ABI compliancy.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef CLANG_CODEGEN_CGCALL_H
  16 #define CLANG_CODEGEN_CGCALL_H
  17
  18 #include "CGValue.h"
  19 #include "clang/AST/CanonicalType.h"
  20 #include "clang/AST/Type.h"
  21 #include "llvm/ADT/FoldingSet.h"
  22 #include "llvm/Value.h"
  23
  24 // FIXME: Restructure so we don't have to expose so much stuff.
  25 #include "ABIInfo.h"
  26
  27 namespace llvm {
  28   struct AttributeWithIndex;
  29   class Function;
  30   class Type;
  31   class Value;
  32
  33   template<typename T, unsigned> class SmallVector;
  34 }
  35
  36 namespace clang {
  37   class ASTContext;
  38   class Decl;
  39   class FunctionDecl;
  40   class ObjCMethodDecl;
  41   class VarDecl;
  42
  43 namespace CodeGen {
  44   typedef SmallVector<llvm::AttributeWithIndex, 8> AttributeListType;
  45
  46   struct CallArg {
  47     RValue RV;
  48     QualType Ty;
  49     bool NeedsCopy;
  50     CallArg(RValue rv, QualType ty, bool needscopy)
  51     : RV(rv), Ty(ty), NeedsCopy(needscopy)
  52     { }
  53   };
  54
  55   /// CallArgList - Type for representing both the value and type of
  56   /// arguments in a call.
  57   class CallArgList :
  58     public SmallVector<CallArg, 16> {
  59   public:
  60     struct Writeback {
  61       /// The original argument.
  62       llvm::Value *Address;
  63
  64       /// The pointee type of the original argument.
  65       QualType AddressType;
  66
  67       /// The temporary alloca.
  68       llvm::Value *Temporary;
  69     };
  70
  71     void add(RValue rvalue, QualType type, bool needscopy = false) {
  72       push_back(CallArg(rvalue, type, needscopy));
  73     }
  74
  75     void addFrom(const CallArgList &other) {
  76       insert(end(), other.begin(), other.end());
  77       Writebacks.insert(Writebacks.end(),
  78                         other.Writebacks.begin(), other.Writebacks.end());
  79     }
  80
  81     void addWriteback(llvm::Value *address, QualType addressType,
  82                       llvm::Value *temporary) {
  83       Writeback writeback;
  84       writeback.Address = address;
  85       writeback.AddressType = addressType;
  86       writeback.Temporary = temporary;
  87       Writebacks.push_back(writeback);
  88     }
  89
  90     bool hasWritebacks() const { return !Writebacks.empty(); }
  91
  92     typedef SmallVectorImpl<Writeback>::const_iterator writeback_iterator;
  93     writeback_iterator writeback_begin() const { return Writebacks.begin(); }
  94     writeback_iterator writeback_end() const { return Writebacks.end(); }
  95
  96   private:
  97     SmallVector<Writeback, 1> Writebacks;
  98   };
  99
 100   /// A class for recording the number of arguments that a function
 101   /// signature requires.
 102   class RequiredArgs {
 103     /// The number of required arguments, or ~0 if the signature does
 104     /// not permit optional arguments.
 105     unsigned NumRequired;
 106   public:
 107     enum All_t { All };
 108
 109     RequiredArgs(All_t _) : NumRequired(~0U) {}
 110     explicit RequiredArgs(unsigned n) : NumRequired(n) {
 111       assert(n != ~0U);
 112     }
 113
 114     /// Compute the arguments required by the given formal prototype,
 115     /// given that there may be some additional, non-formal arguments
 116     /// in play.
 117     static RequiredArgs forPrototypePlus(const FunctionProtoType *prototype,
 118                                          unsigned additional) {
 119       if (!prototype->isVariadic()) return All;
 120       return RequiredArgs(prototype->getNumArgs() + additional);
 121     }
 122
 123     static RequiredArgs forPrototype(const FunctionProtoType *prototype) {
 124       return forPrototypePlus(prototype, 0);
 125     }
 126
 127     static RequiredArgs forPrototype(CanQual<FunctionProtoType> prototype) {
 128       return forPrototype(prototype.getTypePtr());
 129     }
 130
 131     static RequiredArgs forPrototypePlus(CanQual<FunctionProtoType> prototype,
 132                                          unsigned additional) {
 133       return forPrototypePlus(prototype.getTypePtr(), additional);
 134     }
 135
 136     bool allowsOptionalArgs() const { return NumRequired != ~0U; }
 137     bool getNumRequiredArgs() const {
 138       assert(allowsOptionalArgs());
 139       return NumRequired;
 140     }
 141
 142     unsigned getOpaqueData() const { return NumRequired; }
 143     static RequiredArgs getFromOpaqueData(unsigned value) {
 144       if (value == ~0U) return All;
 145       return RequiredArgs(value);
 146     }
 147   };
 148
 149   /// FunctionArgList - Type for representing both the decl and type
 150   /// of parameters to a function. The decl must be either a
 151   /// ParmVarDecl or ImplicitParamDecl.
 152   class FunctionArgList : public SmallVector<const VarDecl*, 16> {
 153   };
 154
 155   /// CGFunctionInfo - Class to encapsulate the information about a
 156   /// function definition.
 157   class CGFunctionInfo : public llvm::FoldingSetNode {
 158     struct ArgInfo {
 159       CanQualType type;
 160       ABIArgInfo info;
 161     };
 162
 163     /// The LLVM::CallingConv to use for this function (as specified by the
 164     /// user).
 165     unsigned CallingConvention : 8;
 166
 167     /// The LLVM::CallingConv to actually use for this function, which may
 168     /// depend on the ABI.
 169     unsigned EffectiveCallingConvention : 8;
 170
 171     /// The clang::CallingConv that this was originally created with.
 172     unsigned ASTCallingConvention : 8;
 173
 174     /// Whether this function is noreturn.
 175     unsigned NoReturn : 1;
 176
 177     /// Whether this function is returns-retained.
 178     unsigned ReturnsRetained : 1;
 179
 180     /// How many arguments to pass inreg.
 181     unsigned HasRegParm : 1;
 182     unsigned RegParm : 4;
 183
 184     RequiredArgs Required;
 185
 186     unsigned NumArgs;
 187     ArgInfo *getArgsBuffer() {
 188       return reinterpret_cast<ArgInfo*>(this+1);
 189     }
 190     const ArgInfo *getArgsBuffer() const {
 191       return reinterpret_cast<const ArgInfo*>(this + 1);
 192     }
 193
 194     CGFunctionInfo() : Required(RequiredArgs::All) {}
 195
 196   public:
 197     static CGFunctionInfo *create(unsigned llvmCC,
 198                                   const FunctionType::ExtInfo &extInfo,
 199                                   CanQualType resultType,
 200                                   ArrayRef<CanQualType> argTypes,
 201                                   RequiredArgs required);
 202
 203     typedef const ArgInfo *const_arg_iterator;
 204     typedef ArgInfo *arg_iterator;
 205
 206     const_arg_iterator arg_begin() const { return getArgsBuffer() + 1; }
 207     const_arg_iterator arg_end() const { return getArgsBuffer() + 1 + NumArgs; }
 208     arg_iterator arg_begin() { return getArgsBuffer() + 1; }
 209     arg_iterator arg_end() { return getArgsBuffer() + 1 + NumArgs; }
 210
 211     unsigned  arg_size() const { return NumArgs; }
 212
 213     bool isVariadic() const { return Required.allowsOptionalArgs(); }
 214     RequiredArgs getRequiredArgs() const { return Required; }
 215
 216     bool isNoReturn() const { return NoReturn; }
 217
 218     /// In ARC, whether this function retains its return value.  This
 219     /// is not always reliable for call sites.
 220     bool isReturnsRetained() const { return ReturnsRetained; }
 221
 222     /// getASTCallingConvention() - Return the AST-specified calling
 223     /// convention.
 224     CallingConv getASTCallingConvention() const {
 225       return CallingConv(ASTCallingConvention);
 226     }
 227
 228     /// getCallingConvention - Return the user specified calling
 229     /// convention, which has been translated into an LLVM CC.
 230     unsigned getCallingConvention() const { return CallingConvention; }
 231
 232     /// getEffectiveCallingConvention - Return the actual calling convention to
 233     /// use, which may depend on the ABI.
 234     unsigned getEffectiveCallingConvention() const {
 235       return EffectiveCallingConvention;
 236     }
 237     void setEffectiveCallingConvention(unsigned Value) {
 238       EffectiveCallingConvention = Value;
 239     }
 240
 241     bool getHasRegParm() const { return HasRegParm; }
 242     unsigned getRegParm() const { return RegParm; }
 243
 244     FunctionType::ExtInfo getExtInfo() const {
 245       return FunctionType::ExtInfo(isNoReturn(),
 246                                    getHasRegParm(), getRegParm(),
 247                                    getASTCallingConvention(),
 248                                    isReturnsRetained());
 249     }
 250
 251     CanQualType getReturnType() const { return getArgsBuffer()[0].type; }
 252
 253     ABIArgInfo &getReturnInfo() { return getArgsBuffer()[0].info; }
 254     const ABIArgInfo &getReturnInfo() const { return getArgsBuffer()[0].info; }
 255
 256     void Profile(llvm::FoldingSetNodeID &ID) {
 257       ID.AddInteger(getASTCallingConvention());
 258       ID.AddBoolean(NoReturn);
 259       ID.AddBoolean(ReturnsRetained);
 260       ID.AddBoolean(HasRegParm);
 261       ID.AddInteger(RegParm);
 262       ID.AddInteger(Required.getOpaqueData());
 263       getReturnType().Profile(ID);
 264       for (arg_iterator it = arg_begin(), ie = arg_end(); it != ie; ++it)
 265         it->type.Profile(ID);
 266     }
 267     static void Profile(llvm::FoldingSetNodeID &ID,
 268                         const FunctionType::ExtInfo &info,
 269                         RequiredArgs required,
 270                         CanQualType resultType,
 271                         ArrayRef<CanQualType> argTypes) {
 272       ID.AddInteger(info.getCC());
 273       ID.AddBoolean(info.getNoReturn());
 274       ID.AddBoolean(info.getProducesResult());
 275       ID.AddBoolean(info.getHasRegParm());
 276       ID.AddInteger(info.getRegParm());
 277       ID.AddInteger(required.getOpaqueData());
 278       resultType.Profile(ID);
 279       for (ArrayRef<CanQualType>::iterator
 280              i = argTypes.begin(), e = argTypes.end(); i != e; ++i) {
 281         i->Profile(ID);
 282       }
 283     }
 284   };
 285
 286   /// ReturnValueSlot - Contains the address where the return value of a
 287   /// function can be stored, and whether the address is volatile or not.
 288   class ReturnValueSlot {
 289     llvm::PointerIntPair<llvm::Value *, 1, bool> Value;
 290
 291   public:
 292     ReturnValueSlot() {}
 293     ReturnValueSlot(llvm::Value *Value, bool IsVolatile)
 294       : Value(Value, IsVolatile) {}
 295
 296     bool isNull() const { return !getValue(); }
 297
 298     bool isVolatile() const { return Value.getInt(); }
 299     llvm::Value *getValue() const { return Value.getPointer(); }
 300   };
 301
 302 }  // end namespace CodeGen
 303 }  // end namespace clang
 304
 305 #endif