CGCall.h revision 425ef72306d4ff6b3698b744353e5f0e56b4b884
10dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar//===----- CGCall.h - Encapsulate calling convention details ----*- C++ -*-===// 20dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar// 30dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar// The LLVM Compiler Infrastructure 40dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar// 50dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar// This file is distributed under the University of Illinois Open Source 60dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar// License. See LICENSE.TXT for details. 70dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar// 80dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar//===----------------------------------------------------------------------===// 90dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar// 100dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar// These classes wrap the information about a call or function 110dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar// definition used to handle ABI compliancy. 120dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar// 130dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar//===----------------------------------------------------------------------===// 140dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar 150dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar#ifndef CLANG_CODEGEN_CGCALL_H 160dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar#define CLANG_CODEGEN_CGCALL_H 170dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar 1831777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson#include "llvm/ADT/FoldingSet.h" 1931777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson#include "llvm/Value.h" 200dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar#include "clang/AST/Type.h" 21ead608af31b6c9abeae1ca6d0b75094dac4641c0John McCall#include "clang/AST/CanonicalType.h" 220dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar 2346f45b9bec4a265ad8400a538e5ec3a5683617f1Daniel Dunbar#include "CGValue.h" 2446f45b9bec4a265ad8400a538e5ec3a5683617f1Daniel Dunbar 2588c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar// FIXME: Restructure so we don't have to expose so much stuff. 2688c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar#include "ABIInfo.h" 2788c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar 280dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbarnamespace llvm { 29761d7f78e2dac7ea5f35828c2271e60d91e106ceDevang Patel struct AttributeWithIndex; 3088c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar class Function; 3188c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar class Type; 320dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar class Value; 330dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar 340dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar template<typename T, unsigned> class SmallVector; 350dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar} 360dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar 370dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbarnamespace clang { 380dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar class ASTContext; 390dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar class Decl; 400dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar class FunctionDecl; 410dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar class ObjCMethodDecl; 427c086516f3cc9fba2733b1919973206c6ba4b171Daniel Dunbar class VarDecl; 430dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar 440dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbarnamespace CodeGen { 45761d7f78e2dac7ea5f35828c2271e60d91e106ceDevang Patel typedef llvm::SmallVector<llvm::AttributeWithIndex, 8> AttributeListType; 460dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar 470dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar /// CallArgList - Type for representing both the value and type of 480dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar /// arguments in a call. 4946f45b9bec4a265ad8400a538e5ec3a5683617f1Daniel Dunbar typedef llvm::SmallVector<std::pair<RValue, QualType>, 16> CallArgList; 500dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar 517c086516f3cc9fba2733b1919973206c6ba4b171Daniel Dunbar /// FunctionArgList - Type for representing both the decl and type 527c086516f3cc9fba2733b1919973206c6ba4b171Daniel Dunbar /// of parameters to a function. The decl must be either a 537c086516f3cc9fba2733b1919973206c6ba4b171Daniel Dunbar /// ParmVarDecl or ImplicitParamDecl. 541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump typedef llvm::SmallVector<std::pair<const VarDecl*, QualType>, 557c086516f3cc9fba2733b1919973206c6ba4b171Daniel Dunbar 16> FunctionArgList; 561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 570dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar /// CGFunctionInfo - Class to encapsulate the information about a 580dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar /// function definition. 5940a6be686e5d5bb4198f1affda574e8a4b3a7710Daniel Dunbar class CGFunctionInfo : public llvm::FoldingSetNode { 6088c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar struct ArgInfo { 61ead608af31b6c9abeae1ca6d0b75094dac4641c0John McCall CanQualType type; 6288c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar ABIArgInfo info; 6388c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar }; 6488c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar 65ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar /// The LLVM::CallingConv to use for this function (as specified by the 66ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar /// user). 67bac7c250c9b098ee3d637c8ed77da62e860d9244Daniel Dunbar unsigned CallingConvention; 68bac7c250c9b098ee3d637c8ed77da62e860d9244Daniel Dunbar 69ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar /// The LLVM::CallingConv to actually use for this function, which may 70ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar /// depend on the ABI. 71ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar unsigned EffectiveCallingConvention; 72ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar 7304a67a6aa3dfdc92d57f7f8d93ba397348c868a4John McCall /// Whether this function is noreturn. 7404a67a6aa3dfdc92d57f7f8d93ba397348c868a4John McCall bool NoReturn; 7504a67a6aa3dfdc92d57f7f8d93ba397348c868a4John McCall 7688c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar unsigned NumArgs; 7788c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar ArgInfo *Args; 780dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar 79425ef72306d4ff6b3698b744353e5f0e56b4b884Rafael Espindola /// How many arguments to pass inreg. 80425ef72306d4ff6b3698b744353e5f0e56b4b884Rafael Espindola unsigned RegParm; 81425ef72306d4ff6b3698b744353e5f0e56b4b884Rafael Espindola 820dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar public: 8388c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar typedef const ArgInfo *const_arg_iterator; 8488c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar typedef ArgInfo *arg_iterator; 85a0a99e02f5b2de3817706071077298ef040634feDaniel Dunbar 86bac7c250c9b098ee3d637c8ed77da62e860d9244Daniel Dunbar CGFunctionInfo(unsigned CallingConvention, 8704a67a6aa3dfdc92d57f7f8d93ba397348c868a4John McCall bool NoReturn, 88425ef72306d4ff6b3698b744353e5f0e56b4b884Rafael Espindola unsigned RegParm, 89ead608af31b6c9abeae1ca6d0b75094dac4641c0John McCall CanQualType ResTy, 90ead608af31b6c9abeae1ca6d0b75094dac4641c0John McCall const llvm::SmallVectorImpl<CanQualType> &ArgTys); 9188c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar ~CGFunctionInfo() { delete[] Args; } 9288c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar 9388c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar const_arg_iterator arg_begin() const { return Args + 1; } 9488c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar const_arg_iterator arg_end() const { return Args + 1 + NumArgs; } 9588c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar arg_iterator arg_begin() { return Args + 1; } 9688c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar arg_iterator arg_end() { return Args + 1 + NumArgs; } 970dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar 984b5f0a4bd6645e87e5feae4be4675ce87d97b4a5Daniel Dunbar unsigned arg_size() const { return NumArgs; } 994b5f0a4bd6645e87e5feae4be4675ce87d97b4a5Daniel Dunbar 10004a67a6aa3dfdc92d57f7f8d93ba397348c868a4John McCall bool isNoReturn() const { return NoReturn; } 10104a67a6aa3dfdc92d57f7f8d93ba397348c868a4John McCall 102ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar /// getCallingConvention - Return the user specified calling 103ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar /// convention. 104bac7c250c9b098ee3d637c8ed77da62e860d9244Daniel Dunbar unsigned getCallingConvention() const { return CallingConvention; } 105bac7c250c9b098ee3d637c8ed77da62e860d9244Daniel Dunbar 106ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar /// getEffectiveCallingConvention - Return the actual calling convention to 107ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar /// use, which may depend on the ABI. 108ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar unsigned getEffectiveCallingConvention() const { 109ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar return EffectiveCallingConvention; 110ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar } 111ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar void setEffectiveCallingConvention(unsigned Value) { 112ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar EffectiveCallingConvention = Value; 113ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar } 114ca6408c3176783f0b29da4679a08512aa05f0c73Daniel Dunbar 115425ef72306d4ff6b3698b744353e5f0e56b4b884Rafael Espindola unsigned getRegParm() const { return RegParm; } 116425ef72306d4ff6b3698b744353e5f0e56b4b884Rafael Espindola 117ead608af31b6c9abeae1ca6d0b75094dac4641c0John McCall CanQualType getReturnType() const { return Args[0].type; } 118bb36d331f439f49859efcfb4435c61762fbba6f9Daniel Dunbar 11988c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar ABIArgInfo &getReturnInfo() { return Args[0].info; } 12088c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar const ABIArgInfo &getReturnInfo() const { return Args[0].info; } 12140a6be686e5d5bb4198f1affda574e8a4b3a7710Daniel Dunbar 12240a6be686e5d5bb4198f1affda574e8a4b3a7710Daniel Dunbar void Profile(llvm::FoldingSetNodeID &ID) { 123bac7c250c9b098ee3d637c8ed77da62e860d9244Daniel Dunbar ID.AddInteger(getCallingConvention()); 12404a67a6aa3dfdc92d57f7f8d93ba397348c868a4John McCall ID.AddBoolean(NoReturn); 125425ef72306d4ff6b3698b744353e5f0e56b4b884Rafael Espindola ID.AddInteger(RegParm); 12635e67d4387bbe3e7e17ee6b17eaa42eebb0eb9f1Daniel Dunbar getReturnType().Profile(ID); 12788c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar for (arg_iterator it = arg_begin(), ie = arg_end(); it != ie; ++it) 12888c2fa96be989571b4afb6229f0ef5a3ef4450cbDaniel Dunbar it->type.Profile(ID); 12940a6be686e5d5bb4198f1affda574e8a4b3a7710Daniel Dunbar } 13040a6be686e5d5bb4198f1affda574e8a4b3a7710Daniel Dunbar template<class Iterator> 1311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump static void Profile(llvm::FoldingSetNodeID &ID, 132264ba48dc98f3f843935a485d5b086f7e0fdc4f1Rafael Espindola const FunctionType::ExtInfo &Info, 133ead608af31b6c9abeae1ca6d0b75094dac4641c0John McCall CanQualType ResTy, 13440a6be686e5d5bb4198f1affda574e8a4b3a7710Daniel Dunbar Iterator begin, 13540a6be686e5d5bb4198f1affda574e8a4b3a7710Daniel Dunbar Iterator end) { 136264ba48dc98f3f843935a485d5b086f7e0fdc4f1Rafael Espindola ID.AddInteger(Info.getCC()); 137264ba48dc98f3f843935a485d5b086f7e0fdc4f1Rafael Espindola ID.AddBoolean(Info.getNoReturn()); 138425ef72306d4ff6b3698b744353e5f0e56b4b884Rafael Espindola ID.AddInteger(Info.getRegParm()); 13940a6be686e5d5bb4198f1affda574e8a4b3a7710Daniel Dunbar ResTy.Profile(ID); 140ead608af31b6c9abeae1ca6d0b75094dac4641c0John McCall for (; begin != end; ++begin) { 141ead608af31b6c9abeae1ca6d0b75094dac4641c0John McCall CanQualType T = *begin; // force iterator to be over canonical types 142ead608af31b6c9abeae1ca6d0b75094dac4641c0John McCall T.Profile(ID); 143ead608af31b6c9abeae1ca6d0b75094dac4641c0John McCall } 14440a6be686e5d5bb4198f1affda574e8a4b3a7710Daniel Dunbar } 1450dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar }; 14631777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson 147d2490a91341b57df7a7e54f8a707e7ecde2eeb4eAnders Carlsson /// ReturnValueSlot - Contains the address where the return value of a 148d2490a91341b57df7a7e54f8a707e7ecde2eeb4eAnders Carlsson /// function can be stored, and whether the address is volatile or not. 14931777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson class ReturnValueSlot { 15031777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson llvm::PointerIntPair<llvm::Value *, 1, bool> Value; 15131777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson 15231777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson public: 15331777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson ReturnValueSlot() {} 15431777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson ReturnValueSlot(llvm::Value *Value, bool IsVolatile) 15531777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson : Value(Value, IsVolatile) {} 15631777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson 15731777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson bool isNull() const { return !getValue(); } 15831777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson 15931777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson bool isVolatile() const { return Value.getInt(); } 16031777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson llvm::Value *getValue() const { return Value.getPointer(); } 16131777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson }; 16231777a2540879051a3c643b90e02c3fd3d315243Anders Carlsson 1630dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar} // end namespace CodeGen 1640dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar} // end namespace clang 1650dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar 1660dbe227feccf6a8dbadfff8ca3f80416b7bf2f28Daniel Dunbar#endif 167