CGObjCRuntime.h revision 2a03192a02dbf4fdff438d1e658356bde871aba4
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; 280f984268b05edab2cc555a427c441baa9c252658Chris Lattner class Type; 290f984268b05edab2cc555a427c441baa9c252658Chris Lattner class Value; 300f984268b05edab2cc555a427c441baa9c252658Chris Lattner class Module; 31391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner class Function; 320f984268b05edab2cc555a427c441baa9c252658Chris Lattner} 330f984268b05edab2cc555a427c441baa9c252658Chris Lattner 340f984268b05edab2cc555a427c441baa9c252658Chris Lattnernamespace clang { 3546f45b9bec4a265ad8400a538e5ec3a5683617f1Daniel Dunbarnamespace CodeGen { 3646f45b9bec4a265ad8400a538e5ec3a5683617f1Daniel Dunbar class CodeGenFunction; 3746f45b9bec4a265ad8400a538e5ec3a5683617f1Daniel Dunbar} 388f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar 3964d5d6c5903157c521af496479d06dc26032d718Anders Carlsson class ObjCAtTryStmt; 4064d5d6c5903157c521af496479d06dc26032d718Anders Carlsson class ObjCAtThrowStmt; 4110cac6f7115b59a466bb8d2d51cdddeb38aadc37Chris Lattner class ObjCAtSynchronizedStmt; 42679a502d462ef819e6175b58e255ca3f3391e7cfFariborz Jahanian class ObjCContainerDecl; 437ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar class ObjCCategoryImplDecl; 447ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar class ObjCImplementationDecl; 45ddb2a3d55a24a1dbdf9152621642d9a4b4fc2f61Daniel Dunbar class ObjCInterfaceDecl; 468f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar class ObjCMessageExpr; 477ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar class ObjCMethodDecl; 48af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar class ObjCProtocolDecl; 498e67b63530b4f39a48bc12d97376f373a6901279Chris Lattner class Selector; 500bb20361a321593887f067515dd04cf109f4c74aFariborz Jahanian class ObjCIvarDecl; 5133fdb738a6c125f4c788733897021b7c1a062b0cSteve Naroff class ObjCStringLiteral; 52af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 530f984268b05edab2cc555a427c441baa9c252658Chris Lattnernamespace CodeGen { 54dce1406f1c1f572cfd61c494546572d63461c741Chris Lattner class CodeGenModule; 550f984268b05edab2cc555a427c441baa9c252658Chris Lattner 5620ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov//FIXME Several methods should be pure virtual but aren't to avoid the 5720ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov//partially-implemented subclass breaking. 5820ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov 5920ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov/// Implements runtime-specific code generation functions. 600f984268b05edab2cc555a427c441baa9c252658Chris Lattnerclass CGObjCRuntime { 6158bf6101062867ca4b3028f9e77e4ae642f09b44Daniel Dunbar 620f984268b05edab2cc555a427c441baa9c252658Chris Lattnerpublic: 630f984268b05edab2cc555a427c441baa9c252658Chris Lattner virtual ~CGObjCRuntime(); 64af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 65391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner /// Generate the function required to register all Objective-C components in 66391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner /// this compilation unit with the runtime library. 677ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar virtual llvm::Function *ModuleInitFunction() = 0; 68af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 697ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// Get a selector for the specified name and type values. The 707ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// return value should have the LLVM type for pointer-to 717ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// ASTContext::getObjCSelType(). 7245d196b8387dcefc4df26cda114fa34c6528e928Daniel Dunbar virtual llvm::Value *GetSelector(CGBuilderTy &Builder, 737ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar Selector Sel) = 0; 74af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 757ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// Generate a constant string object. 7633fdb738a6c125f4c788733897021b7c1a062b0cSteve Naroff virtual llvm::Constant *GenerateConstantString(const ObjCStringLiteral *) = 0; 77af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 7820ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov /// Generate a category. A category contains a list of methods (and 7920ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov /// accompanying metadata) and a list of protocols. 807ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar virtual void GenerateCategory(const ObjCCategoryImplDecl *OCD) = 0; 81af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 8220ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov /// Generate a class stucture for this class. 837ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar virtual void GenerateClass(const ObjCImplementationDecl *OID) = 0; 847ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar 857ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// Generate an Objective-C message send operation. 868f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar virtual CodeGen::RValue 878f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar GenerateMessageSend(CodeGen::CodeGenFunction &CGF, 887f8ea5c5b3a6a4332a841eefdd86b0726722ea7bDaniel Dunbar QualType ResultType, 897f8ea5c5b3a6a4332a841eefdd86b0726722ea7bDaniel Dunbar Selector Sel, 90f56f1913e91ad32bed52dd3f6afc26735d336584Daniel Dunbar llvm::Value *Receiver, 9119cd87eb5fb3c197e631ce08fd52c446c4d4e8f1Daniel Dunbar bool IsClassMessage, 9219cd87eb5fb3c197e631ce08fd52c446c4d4e8f1Daniel Dunbar const CallArgList &CallArgs) = 0; 93af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 947ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// Generate an Objective-C message send operation to the super 95f56f1913e91ad32bed52dd3f6afc26735d336584Daniel Dunbar /// class initiated in a method for Class and with the given Self 96f56f1913e91ad32bed52dd3f6afc26735d336584Daniel Dunbar /// object. 978f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar virtual CodeGen::RValue 988f2926b73ed635afecd020da787af6a837601a2bDaniel Dunbar GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF, 997f8ea5c5b3a6a4332a841eefdd86b0726722ea7bDaniel Dunbar QualType ResultType, 1007f8ea5c5b3a6a4332a841eefdd86b0726722ea7bDaniel Dunbar Selector Sel, 101f56f1913e91ad32bed52dd3f6afc26735d336584Daniel Dunbar const ObjCInterfaceDecl *Class, 1027ce77920a35060f1c8dd72e541e42ce296ccd168Fariborz Jahanian bool isCategoryImpl, 103f56f1913e91ad32bed52dd3f6afc26735d336584Daniel Dunbar llvm::Value *Self, 10419cd87eb5fb3c197e631ce08fd52c446c4d4e8f1Daniel Dunbar bool IsClassMessage, 10519cd87eb5fb3c197e631ce08fd52c446c4d4e8f1Daniel Dunbar const CallArgList &CallArgs) = 0; 10698c5ead87d720d8b68b6f236c3c3579a388fc882Daniel Dunbar 10798c5ead87d720d8b68b6f236c3c3579a388fc882Daniel Dunbar /// Emit the code to return the named protocol as an object, as in a 10898c5ead87d720d8b68b6f236c3c3579a388fc882Daniel Dunbar /// @protocol expression. 10945d196b8387dcefc4df26cda114fa34c6528e928Daniel Dunbar virtual llvm::Value *GenerateProtocolRef(CGBuilderTy &Builder, 1107ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar const ObjCProtocolDecl *OPD) = 0; 11198c5ead87d720d8b68b6f236c3c3579a388fc882Daniel Dunbar 11220ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov /// Generate the named protocol. Protocols contain method metadata but no 11320ff3108fcd2c3bd734dc79efc22ebaa090abd41Anton Korobeynikov /// implementations. 1147ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar virtual void GenerateProtocol(const ObjCProtocolDecl *OPD) = 0; 1157ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar 1167ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// Generate a function preamble for a method with the specified 1177ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar /// types. 1187ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar 1197ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar // FIXME: Current this just generates the Function definition, but 1207ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar // really this should also be generating the loads of the 1217ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar // parameters, as the runtime should have full control over how 1227ded7f4983dc4a20561db7a8d02c6b2435030961Daniel Dunbar // parameters are passed. 123679a502d462ef819e6175b58e255ca3f3391e7cfFariborz Jahanian virtual llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD, 124679a502d462ef819e6175b58e255ca3f3391e7cfFariborz Jahanian const ObjCContainerDecl *CD) = 0; 125af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 12649f6602707887eea1a558a1dffe0213102f887f2Daniel Dunbar /// Return the runtime function for getting properties. 12774391b48b4791cded373683a3baf67314f358d50Chris Lattner virtual llvm::Constant *GetPropertyGetFunction() = 0; 12849f6602707887eea1a558a1dffe0213102f887f2Daniel Dunbar 12949f6602707887eea1a558a1dffe0213102f887f2Daniel Dunbar /// Return the runtime function for setting properties. 13074391b48b4791cded373683a3baf67314f358d50Chris Lattner virtual llvm::Constant *GetPropertySetFunction() = 0; 13149f6602707887eea1a558a1dffe0213102f887f2Daniel Dunbar 132ddb2a3d55a24a1dbdf9152621642d9a4b4fc2f61Daniel Dunbar /// GetClass - Return a reference to the class for the given 133ddb2a3d55a24a1dbdf9152621642d9a4b4fc2f61Daniel Dunbar /// interface decl. 13445d196b8387dcefc4df26cda114fa34c6528e928Daniel Dunbar virtual llvm::Value *GetClass(CGBuilderTy &Builder, 135ddb2a3d55a24a1dbdf9152621642d9a4b4fc2f61Daniel Dunbar const ObjCInterfaceDecl *OID) = 0; 136af2f62ce32e462f256855cd24b06dec4755d2827Daniel Dunbar 1372abd89c039e835e84519a4cd8a7495899a70153dAnders Carlsson /// EnumerationMutationFunction - Return the function that's called by the 1382abd89c039e835e84519a4cd8a7495899a70153dAnders Carlsson /// compiler when a mutation is detected during foreach iteration. 13974391b48b4791cded373683a3baf67314f358d50Chris Lattner virtual llvm::Constant *EnumerationMutationFunction() = 0; 1406bf2ae05c777052e5ec05649710380dea263e7e0Daniel Dunbar 141bd71be4683c195260d5245118b1e13e6b2e20504Fariborz Jahanian virtual void EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF, 142bd71be4683c195260d5245118b1e13e6b2e20504Fariborz Jahanian const Stmt &S) = 0; 14364d5d6c5903157c521af496479d06dc26032d718Anders Carlsson virtual void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, 14464d5d6c5903157c521af496479d06dc26032d718Anders Carlsson const ObjCAtThrowStmt &S) = 0; 1456bf2ae05c777052e5ec05649710380dea263e7e0Daniel Dunbar virtual llvm::Value *EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF, 1466bf2ae05c777052e5ec05649710380dea263e7e0Daniel Dunbar llvm::Value *AddrWeakObj) = 0; 1473e283e344595e0bd499b13b30a92b7d9c10a2140Fariborz Jahanian virtual void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF, 1483e283e344595e0bd499b13b30a92b7d9c10a2140Fariborz Jahanian llvm::Value *src, llvm::Value *dest) = 0; 14958626500527695865683d1d65053743de8770b60Fariborz Jahanian virtual void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF, 15058626500527695865683d1d65053743de8770b60Fariborz Jahanian llvm::Value *src, llvm::Value *dest) = 0; 1517eda8367cf63caee8acf907356b1d199ccaa6e89Fariborz Jahanian virtual void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF, 1527eda8367cf63caee8acf907356b1d199ccaa6e89Fariborz Jahanian llvm::Value *src, llvm::Value *dest) = 0; 15358626500527695865683d1d65053743de8770b60Fariborz Jahanian virtual void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF, 15458626500527695865683d1d65053743de8770b60Fariborz Jahanian llvm::Value *src, llvm::Value *dest) = 0; 1550bb20361a321593887f067515dd04cf109f4c74aFariborz Jahanian 156598d3f61b6ca854e9d3c2f3359e24468502a61aaFariborz Jahanian virtual LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, 157598d3f61b6ca854e9d3c2f3359e24468502a61aaFariborz Jahanian QualType ObjectTy, 158598d3f61b6ca854e9d3c2f3359e24468502a61aaFariborz Jahanian llvm::Value *BaseValue, 159598d3f61b6ca854e9d3c2f3359e24468502a61aaFariborz Jahanian const ObjCIvarDecl *Ivar, 160598d3f61b6ca854e9d3c2f3359e24468502a61aaFariborz Jahanian unsigned CVRQualifiers) = 0; 161f63aa3fd429cdb9145d78f0b656bc78754efedb9Fariborz Jahanian virtual llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF, 1622a03192a02dbf4fdff438d1e658356bde871aba4Daniel Dunbar const ObjCInterfaceDecl *Interface, 163f63aa3fd429cdb9145d78f0b656bc78754efedb9Fariborz Jahanian const ObjCIvarDecl *Ivar) = 0; 1640f984268b05edab2cc555a427c441baa9c252658Chris Lattner}; 1650f984268b05edab2cc555a427c441baa9c252658Chris Lattner 166391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner/// Creates an instance of an Objective-C runtime class. 167391d77a26382dddf25da73e29fc1fa5aaaea4c6fChris Lattner//TODO: This should include some way of selecting which runtime to target. 168c17a4d3b16a2624a76de5d7508805534545bd3bfDaniel DunbarCGObjCRuntime *CreateGNUObjCRuntime(CodeGenModule &CGM); 169c17a4d3b16a2624a76de5d7508805534545bd3bfDaniel DunbarCGObjCRuntime *CreateMacObjCRuntime(CodeGenModule &CGM); 17030bc57187be7535c57ef1ca8ff3e765653e94332Fariborz JahanianCGObjCRuntime *CreateMacNonFragileABIObjCRuntime(CodeGenModule &CGM); 1710f984268b05edab2cc555a427c441baa9c252658Chris Lattner} 1720f984268b05edab2cc555a427c441baa9c252658Chris Lattner} 1730f984268b05edab2cc555a427c441baa9c252658Chris Lattner#endif 174