CGObjCRuntime.h revision 9777687562c338601c2f17906e65e1c1a0aad96f
1c17a4d3b16a2624a76de5d7508805534545bd3bfDaniel Dunbar//===----- CGObjCRuntime.h - Interface to ObjC Runtimes ---------*- C++ -*-===// 20f984268b05edab2cc555a427c441baa9c252658Chris Lattner// 30f984268b05edab2cc555a427c441baa9c252658Chris Lattner// The LLVM Compiler Infrastructure 40f984268b05edab2cc555a427c441baa9c252658Chris Lattner// 50f984268b05edab2cc555a427c441baa9c252658Chris Lattner// This file is distributed under the University of Illinois Open Source 60f984268b05edab2cc555a427c441baa9c252658Chris Lattner// License. See LICENSE.TXT for details. 70f984268b05edab2cc555a427c441baa9c252658Chris Lattner// 80f984268b05edab2cc555a427c441baa9c252658Chris Lattner//===----------------------------------------------------------------------===// 90f984268b05edab2cc555a427c441baa9c252658Chris Lattner// 100f984268b05edab2cc555a427c441baa9c252658Chris Lattner// This provides an abstract class for Objective-C code generation. Concrete 110f984268b05edab2cc555a427c441baa9c252658Chris Lattner// subclasses of this implement code generation for specific Objective-C 120f984268b05edab2cc555a427c441baa9c252658Chris Lattner// runtime libraries. 130f984268b05edab2cc555a427c441baa9c252658Chris Lattner// 140f984268b05edab2cc555a427c441baa9c252658Chris Lattner//===----------------------------------------------------------------------===// 150f984268b05edab2cc555a427c441baa9c252658Chris Lattner 160f984268b05edab2cc555a427c441baa9c252658Chris Lattner#ifndef CLANG_CODEGEN_OBCJRUNTIME_H 170f984268b05edab2cc555a427c441baa9c252658Chris Lattner#define CLANG_CODEGEN_OBCJRUNTIME_H 18e91593ef084479340582b2ba177b44be50a717b7Daniel Dunbar#include "clang/Basic/IdentifierTable.h" // Selector 1920ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov#include "llvm/ADT/SmallVector.h" 208ef07c0a81727aae37c820a816dac019f5fe1d43Argyrios Kyrtzidis#include <string> 210f984268b05edab2cc555a427c441baa9c252658Chris Lattner 2245d196b8387dcefc4df26cda114fa34c6528e928Daniel Dunbar#include "CGBuilder.h" 2346f45b9bec4a265ad8400a538e5ec3a5683617f1Daniel Dunbar#include "CGCall.h" 2445d196b8387dcefc4df26cda114fa34c6528e928Daniel Dunbar#include "CGValue.h" 258f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar 260f984268b05edab2cc555a427c441baa9c252658Chris Lattnernamespace llvm { 270f984268b05edab2cc555a427c441baa9c252658Chris Lattner class Constant; 289777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar class Function; 299777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar class Module; 309777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar class StructLayout; 310f984268b05edab2cc555a427c441baa9c252658Chris Lattner class Type; 320f984268b05edab2cc555a427c441baa9c252658Chris Lattner class Value; 330f984268b05edab2cc555a427c441baa9c252658Chris Lattner} 340f984268b05edab2cc555a427c441baa9c252658Chris Lattner 350f984268b05edab2cc555a427c441baa9c252658Chris Lattnernamespace clang { 3646f45b9bec4a265ad8400a538e5ec3a5683617f1Daniel Dunbarnamespace CodeGen { 3746f45b9bec4a265ad8400a538e5ec3a5683617f1Daniel Dunbar class CodeGenFunction; 3846f45b9bec4a265ad8400a538e5ec3a5683617f1Daniel Dunbar} 398f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar 409777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar class FieldDecl; 4164d5d6c5903157c521af496479d06dc26032d718Anders Carlsson class ObjCAtTryStmt; 4264d5d6c5903157c521af496479d06dc26032d718Anders Carlsson class ObjCAtThrowStmt; 4310cac6f7115b59a466bb8d2d51cdddeb38aadc37Chris Lattner class ObjCAtSynchronizedStmt; 44679a502d462ef819e6175b58e255ca3f3391e7cfFariborz Jahanian class ObjCContainerDecl; 457ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar class ObjCCategoryImplDecl; 467ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar class ObjCImplementationDecl; 47ddb2a3d55a24a1dbdf9152621642d9a4b4fc2f61Daniel Dunbar class ObjCInterfaceDecl; 488f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar class ObjCMessageExpr; 497ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar class ObjCMethodDecl; 50af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar class ObjCProtocolDecl; 518e67b63530b4f39a48bc12d97376f373a6901279Chris Lattner class Selector; 520bb20361a321593887f067515dd04cf109f4c74aFariborz Jahanian class ObjCIvarDecl; 5333fdb738a6c125f4c788733897021b7c1a062b0cSteve Naroff class ObjCStringLiteral; 54af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 550f984268b05edab2cc555a427c441baa9c252658Chris Lattnernamespace CodeGen { 56dce1406f1c1f572cfd61c494546572d63461c741Chris Lattner class CodeGenModule; 570f984268b05edab2cc555a427c441baa9c252658Chris Lattner 5820ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov//FIXME Several methods should be pure virtual but aren't to avoid the 5920ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov//partially-implemented subclass breaking. 6020ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov 6120ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov/// Implements runtime-specific code generation functions. 620f984268b05edab2cc555a427c441baa9c252658Chris Lattnerclass CGObjCRuntime { 639777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbarprotected: 649777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar // Utility functions for unified ivar access. These need to 659777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar // eventually be folded into other places (the structure layout 669777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar // code). 679777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar 689777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar // Compute an offset to the given ivar, suitable for passing to 699777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar // EmitValueForIvarAtOffset. Note that the correct handling of 709777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar // bit-fields is carefully coordinated by these two, use caution! 719777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar uint64_t ComputeIvarBaseOffset(CodeGen::CodeGenModule &CGM, 729777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar const ObjCInterfaceDecl *OID, 739777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar const ObjCIvarDecl *Ivar); 749777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar 759777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar LValue EmitValueForIvarAtOffset(CodeGen::CodeGenFunction &CGF, 769777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar const ObjCInterfaceDecl *OID, 779777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar llvm::Value *BaseValue, 789777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar const ObjCIvarDecl *Ivar, 799777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar unsigned CVRQualifiers, 809777687562c338601c2f17906e65e1c1a0aad96fDaniel Dunbar llvm::Value *Offset); 8158bf6101062867ca4b3028f9e77e4ae642f09b44Daniel Dunbar 820f984268b05edab2cc555a427c441baa9c252658Chris Lattnerpublic: 830f984268b05edab2cc555a427c441baa9c252658Chris Lattner virtual ~CGObjCRuntime(); 84af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 85391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner /// Generate the function required to register all Objective-C components in 86391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner /// this compilation unit with the runtime library. 877ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar virtual llvm::Function *ModuleInitFunction() = 0; 88af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 897ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// Get a selector for the specified name and type values. The 907ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// return value should have the LLVM type for pointer-to 917ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// ASTContext::getObjCSelType(). 9245d196b8387dcefc4df26cda114fa34c6528e928Daniel Dunbar virtual llvm::Value *GetSelector(CGBuilderTy &Builder, 937ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar Selector Sel) = 0; 94af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 957ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// Generate a constant string object. 9633fdb738a6c125f4c788733897021b7c1a062b0cSteve Naroff virtual llvm::Constant *GenerateConstantString(const ObjCStringLiteral *) = 0; 97af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 9820ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov /// Generate a category. A category contains a list of methods (and 9920ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov /// accompanying metadata) and a list of protocols. 1007ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar virtual void GenerateCategory(const ObjCCategoryImplDecl *OCD) = 0; 101af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 10220ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov /// Generate a class stucture for this class. 1037ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar virtual void GenerateClass(const ObjCImplementationDecl *OID) = 0; 1047ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar 1057ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// Generate an Objective-C message send operation. 1068f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar virtual CodeGen::RValue 1078f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar GenerateMessageSend(CodeGen::CodeGenFunction &CGF, 1087f8ea5c5b3a6a4332a841eefdd86b0726722ea7bDaniel Dunbar QualType ResultType, 1097f8ea5c5b3a6a4332a841eefdd86b0726722ea7bDaniel Dunbar Selector Sel, 110f56f1913e91ad32bed52dd3f6afc26735d336584Daniel Dunbar llvm::Value *Receiver, 11119cd87eb5fb3c197e631ce08fd52c446c4d4e8f1Daniel Dunbar bool IsClassMessage, 11219cd87eb5fb3c197e631ce08fd52c446c4d4e8f1Daniel Dunbar const CallArgList &CallArgs) = 0; 113af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 1147ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// Generate an Objective-C message send operation to the super 115f56f1913e91ad32bed52dd3f6afc26735d336584Daniel Dunbar /// class initiated in a method for Class and with the given Self 116f56f1913e91ad32bed52dd3f6afc26735d336584Daniel Dunbar /// object. 1178f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar virtual CodeGen::RValue 1188f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF, 1197f8ea5c5b3a6a4332a841eefdd86b0726722ea7bDaniel Dunbar QualType ResultType, 1207f8ea5c5b3a6a4332a841eefdd86b0726722ea7bDaniel Dunbar Selector Sel, 121f56f1913e91ad32bed52dd3f6afc26735d336584Daniel Dunbar const ObjCInterfaceDecl *Class, 1227ce77920a35060f1c8dd72e541e42ce296ccd168Fariborz Jahanian bool isCategoryImpl, 123f56f1913e91ad32bed52dd3f6afc26735d336584Daniel Dunbar llvm::Value *Self, 12419cd87eb5fb3c197e631ce08fd52c446c4d4e8f1Daniel Dunbar bool IsClassMessage, 12519cd87eb5fb3c197e631ce08fd52c446c4d4e8f1Daniel Dunbar const CallArgList &CallArgs) = 0; 12698c5ead87d720d8b68b6f236c3c3579a388fc882Daniel Dunbar 12798c5ead87d720d8b68b6f236c3c3579a388fc882Daniel Dunbar /// Emit the code to return the named protocol as an object, as in a 12898c5ead87d720d8b68b6f236c3c3579a388fc882Daniel Dunbar /// @protocol expression. 12945d196b8387dcefc4df26cda114fa34c6528e928Daniel Dunbar virtual llvm::Value *GenerateProtocolRef(CGBuilderTy &Builder, 1307ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar const ObjCProtocolDecl *OPD) = 0; 13198c5ead87d720d8b68b6f236c3c3579a388fc882Daniel Dunbar 13220ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov /// Generate the named protocol. Protocols contain method metadata but no 13320ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov /// implementations. 1347ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar virtual void GenerateProtocol(const ObjCProtocolDecl *OPD) = 0; 1357ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar 1367ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// Generate a function preamble for a method with the specified 1377ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// types. 1387ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar 1397ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar // FIXME: Current this just generates the Function definition, but 1407ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar // really this should also be generating the loads of the 1417ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar // parameters, as the runtime should have full control over how 1427ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar // parameters are passed. 143679a502d462ef819e6175b58e255ca3f3391e7cfFariborz Jahanian virtual llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD, 144679a502d462ef819e6175b58e255ca3f3391e7cfFariborz Jahanian const ObjCContainerDecl *CD) = 0; 145af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 14649f6602707887eea1a558a1dffe0213102f887f2Daniel Dunbar /// Return the runtime function for getting properties. 14774391b48b4791cded373683a3baf67314f358d50Chris Lattner virtual llvm::Constant *GetPropertyGetFunction() = 0; 14849f6602707887eea1a558a1dffe0213102f887f2Daniel Dunbar 14949f6602707887eea1a558a1dffe0213102f887f2Daniel Dunbar /// Return the runtime function for setting properties. 15074391b48b4791cded373683a3baf67314f358d50Chris Lattner virtual llvm::Constant *GetPropertySetFunction() = 0; 15149f6602707887eea1a558a1dffe0213102f887f2Daniel Dunbar 152ddb2a3d55a24a1dbdf9152621642d9a4b4fc2f61Daniel Dunbar /// GetClass - Return a reference to the class for the given 153ddb2a3d55a24a1dbdf9152621642d9a4b4fc2f61Daniel Dunbar /// interface decl. 15445d196b8387dcefc4df26cda114fa34c6528e928Daniel Dunbar virtual llvm::Value *GetClass(CGBuilderTy &Builder, 155ddb2a3d55a24a1dbdf9152621642d9a4b4fc2f61Daniel Dunbar const ObjCInterfaceDecl *OID) = 0; 156af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 1572abd89c039e835e84519a4cd8a7495899a70153dAnders Carlsson /// EnumerationMutationFunction - Return the function that's called by the 1582abd89c039e835e84519a4cd8a7495899a70153dAnders Carlsson /// compiler when a mutation is detected during foreach iteration. 15974391b48b4791cded373683a3baf67314f358d50Chris Lattner virtual llvm::Constant *EnumerationMutationFunction() = 0; 1606bf2ae05c777052e5ec05649710380dea263e7e0Daniel Dunbar 161bd71be4683c195260d5245118b1e13e6b2e20504Fariborz Jahanian virtual void EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF, 162bd71be4683c195260d5245118b1e13e6b2e20504Fariborz Jahanian const Stmt &S) = 0; 16364d5d6c5903157c521af496479d06dc26032d718Anders Carlsson virtual void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, 16464d5d6c5903157c521af496479d06dc26032d718Anders Carlsson const ObjCAtThrowStmt &S) = 0; 1656bf2ae05c777052e5ec05649710380dea263e7e0Daniel Dunbar virtual llvm::Value *EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF, 1666bf2ae05c777052e5ec05649710380dea263e7e0Daniel Dunbar llvm::Value *AddrWeakObj) = 0; 1673e283e344595e0bd499b13b30a92b7d9c10a2140Fariborz Jahanian virtual void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF, 1683e283e344595e0bd499b13b30a92b7d9c10a2140Fariborz Jahanian llvm::Value *src, llvm::Value *dest) = 0; 16958626500527695865683d1d65053743de8770b60Fariborz Jahanian virtual void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF, 17058626500527695865683d1d65053743de8770b60Fariborz Jahanian llvm::Value *src, llvm::Value *dest) = 0; 1717eda8367cf63caee8acf907356b1d199ccaa6e89Fariborz Jahanian virtual void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF, 1727eda8367cf63caee8acf907356b1d199ccaa6e89Fariborz Jahanian llvm::Value *src, llvm::Value *dest) = 0; 17358626500527695865683d1d65053743de8770b60Fariborz Jahanian virtual void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF, 17458626500527695865683d1d65053743de8770b60Fariborz Jahanian llvm::Value *src, llvm::Value *dest) = 0; 1750bb20361a321593887f067515dd04cf109f4c74aFariborz Jahanian 176598d3f61b6ca854e9d3c2f3359e24468502a61aaFariborz Jahanian virtual LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, 177598d3f61b6ca854e9d3c2f3359e24468502a61aaFariborz Jahanian QualType ObjectTy, 178598d3f61b6ca854e9d3c2f3359e24468502a61aaFariborz Jahanian llvm::Value *BaseValue, 179598d3f61b6ca854e9d3c2f3359e24468502a61aaFariborz Jahanian const ObjCIvarDecl *Ivar, 180598d3f61b6ca854e9d3c2f3359e24468502a61aaFariborz Jahanian unsigned CVRQualifiers) = 0; 181f63aa3fd429cdb9145d78f0b656bc78754efedb9Fariborz Jahanian virtual llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF, 1822a03192a02dbf4fdff438d1e658356bde871aba4Daniel Dunbar const ObjCInterfaceDecl *Interface, 183f63aa3fd429cdb9145d78f0b656bc78754efedb9Fariborz Jahanian const ObjCIvarDecl *Ivar) = 0; 1840f984268b05edab2cc555a427c441baa9c252658Chris Lattner}; 1850f984268b05edab2cc555a427c441baa9c252658Chris Lattner 186391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner/// Creates an instance of an Objective-C runtime class. 187391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner//TODO: This should include some way of selecting which runtime to target. 188c17a4d3b16a2624a76de5d7508805534545bd3bfDaniel DunbarCGObjCRuntime *CreateGNUObjCRuntime(CodeGenModule &CGM); 189c17a4d3b16a2624a76de5d7508805534545bd3bfDaniel DunbarCGObjCRuntime *CreateMacObjCRuntime(CodeGenModule &CGM); 19030bc57187be7535c57ef1ca8ff3e765653e94332Fariborz JahanianCGObjCRuntime *CreateMacNonFragileABIObjCRuntime(CodeGenModule &CGM); 1910f984268b05edab2cc555a427c441baa9c252658Chris Lattner} 1920f984268b05edab2cc555a427c441baa9c252658Chris Lattner} 1930f984268b05edab2cc555a427c441baa9c252658Chris Lattner#endif 194