contrib/llvm/tools/clang/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 "llvm/ADT/FoldingSet.h"
  19 #include "llvm/Value.h"
  20 #include "clang/AST/Type.h"
  21 #include "clang/AST/CanonicalType.h"
  22
  23 #include "CGValue.h"
  24
  25 // FIXME: Restructure so we don't have to expose so much stuff.
  26 #include "ABIInfo.h"
  27
  28 namespace llvm {
  29   struct AttributeWithIndex;
  30   class Function;
  31   class Type;
  32   class Value;
  33
  34   template<typename T, unsigned> class SmallVector;
  35 }
  36
  37 namespace clang {
  38   class ASTContext;
  39   class Decl;
  40   class FunctionDecl;
  41   class ObjCMethodDecl;
  42   class VarDecl;
  43
  44 namespace CodeGen {
  45   typedef llvm::SmallVector<llvm::AttributeWithIndex, 8> AttributeListType;
  46
  47   /// CallArgList - Type for representing both the value and type of
  48   /// arguments in a call.
  49   typedef llvm::SmallVector<std::pair<RValue, QualType>, 16> CallArgList;
  50
  51   /// FunctionArgList - Type for representing both the decl and type
  52   /// of parameters to a function. The decl must be either a
  53   /// ParmVarDecl or ImplicitParamDecl.
  54   typedef llvm::SmallVector<std::pair<const VarDecl*, QualType>,
  55                             16> FunctionArgList;
  56
  57   /// CGFunctionInfo - Class to encapsulate the information about a
  58   /// function definition.
  59   class CGFunctionInfo : public llvm::FoldingSetNode {
  60     struct ArgInfo {
  61       CanQualType type;
  62       ABIArgInfo info;
  63     };
  64
  65     /// The LLVM::CallingConv to use for this function (as specified by the
  66     /// user).
  67     unsigned CallingConvention;
  68
  69     /// The LLVM::CallingConv to actually use for this function, which may
  70     /// depend on the ABI.
  71     unsigned EffectiveCallingConvention;
  72
  73     /// Whether this function is noreturn.
  74     bool NoReturn;
  75
  76     unsigned NumArgs;
  77     ArgInfo *Args;
  78
  79     /// How many arguments to pass inreg.
  80     unsigned RegParm;
  81
  82   public:
  83     typedef const ArgInfo *const_arg_iterator;
  84     typedef ArgInfo *arg_iterator;
  85
  86     CGFunctionInfo(unsigned CallingConvention, bool NoReturn,
  87                    unsigned RegParm, CanQualType ResTy,
  88                    const CanQualType *ArgTys, unsigned NumArgTys);
  89     ~CGFunctionInfo() { delete[] Args; }
  90
  91     const_arg_iterator arg_begin() const { return Args + 1; }
  92     const_arg_iterator arg_end() const { return Args + 1 + NumArgs; }
  93     arg_iterator arg_begin() { return Args + 1; }
  94     arg_iterator arg_end() { return Args + 1 + NumArgs; }
  95
  96     unsigned  arg_size() const { return NumArgs; }
  97
  98     bool isNoReturn() const { return NoReturn; }
  99
 100     /// getCallingConvention - Return the user specified calling
 101     /// convention.
 102     unsigned getCallingConvention() const { return CallingConvention; }
 103
 104     /// getEffectiveCallingConvention - Return the actual calling convention to
 105     /// use, which may depend on the ABI.
 106     unsigned getEffectiveCallingConvention() const {
 107       return EffectiveCallingConvention;
 108     }
 109     void setEffectiveCallingConvention(unsigned Value) {
 110       EffectiveCallingConvention = Value;
 111     }
 112
 113     unsigned getRegParm() const { return RegParm; }
 114
 115     CanQualType getReturnType() const { return Args[0].type; }
 116
 117     ABIArgInfo &getReturnInfo() { return Args[0].info; }
 118     const ABIArgInfo &getReturnInfo() const { return Args[0].info; }
 119
 120     void Profile(llvm::FoldingSetNodeID &ID) {
 121       ID.AddInteger(getCallingConvention());
 122       ID.AddBoolean(NoReturn);
 123       ID.AddInteger(RegParm);
 124       getReturnType().Profile(ID);
 125       for (arg_iterator it = arg_begin(), ie = arg_end(); it != ie; ++it)
 126         it->type.Profile(ID);
 127     }
 128     template<class Iterator>
 129     static void Profile(llvm::FoldingSetNodeID &ID,
 130                         const FunctionType::ExtInfo &Info,
 131                         CanQualType ResTy,
 132                         Iterator begin,
 133                         Iterator end) {
 134       ID.AddInteger(Info.getCC());
 135       ID.AddBoolean(Info.getNoReturn());
 136       ID.AddInteger(Info.getRegParm());
 137       ResTy.Profile(ID);
 138       for (; begin != end; ++begin) {
 139         CanQualType T = *begin; // force iterator to be over canonical types
 140         T.Profile(ID);
 141       }
 142     }
 143   };
 144
 145   /// ReturnValueSlot - Contains the address where the return value of a
 146   /// function can be stored, and whether the address is volatile or not.
 147   class ReturnValueSlot {
 148     llvm::PointerIntPair<llvm::Value *, 1, bool> Value;
 149
 150   public:
 151     ReturnValueSlot() {}
 152     ReturnValueSlot(llvm::Value *Value, bool IsVolatile)
 153       : Value(Value, IsVolatile) {}
 154
 155     bool isNull() const { return !getValue(); }
 156
 157     bool isVolatile() const { return Value.getInt(); }
 158     llvm::Value *getValue() const { return Value.getPointer(); }
 159   };
 160
 161 }  // end namespace CodeGen
 162 }  // end namespace clang
 163
 164 #endif