contrib/llvm/tools/clang/lib/CodeGen/CGObjCRuntime.cpp

   1 //==- CGObjCRuntime.cpp - Interface to Shared Objective-C Runtime Features ==//
   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 // This abstract class defines the interface for Objective-C runtime-specific
  11 // code generation.  It provides some concrete helper methods for functionality
  12 // shared between all (or most) of the Objective-C runtimes supported by clang.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "CGObjCRuntime.h"
  17 #include "CGCleanup.h"
  18 #include "CGRecordLayout.h"
  19 #include "CodeGenFunction.h"
  20 #include "CodeGenModule.h"
  21 #include "clang/AST/RecordLayout.h"
  22 #include "clang/AST/StmtObjC.h"
  23 #include "clang/CodeGen/CGFunctionInfo.h"
  24 #include "llvm/IR/CallSite.h"
  25
  26 using namespace clang;
  27 using namespace CodeGen;
  28
  29 uint64_t CGObjCRuntime::ComputeIvarBaseOffset(CodeGen::CodeGenModule &CGM,
  30                                               const ObjCInterfaceDecl *OID,
  31                                               const ObjCIvarDecl *Ivar) {
  32   return CGM.getContext().lookupFieldBitOffset(OID, nullptr, Ivar) /
  33          CGM.getContext().getCharWidth();
  34 }
  35
  36 uint64_t CGObjCRuntime::ComputeIvarBaseOffset(CodeGen::CodeGenModule &CGM,
  37                                               const ObjCImplementationDecl *OID,
  38                                               const ObjCIvarDecl *Ivar) {
  39   return CGM.getContext().lookupFieldBitOffset(OID->getClassInterface(), OID,
  40                                                Ivar) /
  41          CGM.getContext().getCharWidth();
  42 }
  43
  44 unsigned CGObjCRuntime::ComputeBitfieldBitOffset(
  45     CodeGen::CodeGenModule &CGM,
  46     const ObjCInterfaceDecl *ID,
  47     const ObjCIvarDecl *Ivar) {
  48   return CGM.getContext().lookupFieldBitOffset(ID, ID->getImplementation(),
  49                                                Ivar);
  50 }
  51
  52 LValue CGObjCRuntime::EmitValueForIvarAtOffset(CodeGen::CodeGenFunction &CGF,
  53                                                const ObjCInterfaceDecl *OID,
  54                                                llvm::Value *BaseValue,
  55                                                const ObjCIvarDecl *Ivar,
  56                                                unsigned CVRQualifiers,
  57                                                llvm::Value *Offset) {
  58   // Compute (type*) ( (char *) BaseValue + Offset)
  59   QualType InterfaceTy{OID->getTypeForDecl(), 0};
  60   QualType ObjectPtrTy =
  61       CGF.CGM.getContext().getObjCObjectPointerType(InterfaceTy);
  62   QualType IvarTy =
  63       Ivar->getUsageType(ObjectPtrTy).withCVRQualifiers(CVRQualifiers);
  64   llvm::Type *LTy = CGF.CGM.getTypes().ConvertTypeForMem(IvarTy);
  65   llvm::Value *V = CGF.Builder.CreateBitCast(BaseValue, CGF.Int8PtrTy);
  66   V = CGF.Builder.CreateInBoundsGEP(V, Offset, "add.ptr");
  67
  68   if (!Ivar->isBitField()) {
  69     V = CGF.Builder.CreateBitCast(V, llvm::PointerType::getUnqual(LTy));
  70     LValue LV = CGF.MakeNaturalAlignAddrLValue(V, IvarTy);
  71     return LV;
  72   }
  73
  74   // We need to compute an access strategy for this bit-field. We are given the
  75   // offset to the first byte in the bit-field, the sub-byte offset is taken
  76   // from the original layout. We reuse the normal bit-field access strategy by
  77   // treating this as an access to a struct where the bit-field is in byte 0,
  78   // and adjust the containing type size as appropriate.
  79   //
  80   // FIXME: Note that currently we make a very conservative estimate of the
  81   // alignment of the bit-field, because (a) it is not clear what guarantees the
  82   // runtime makes us, and (b) we don't have a way to specify that the struct is
  83   // at an alignment plus offset.
  84   //
  85   // Note, there is a subtle invariant here: we can only call this routine on
  86   // non-synthesized ivars but we may be called for synthesized ivars.  However,
  87   // a synthesized ivar can never be a bit-field, so this is safe.
  88   uint64_t FieldBitOffset =
  89       CGF.CGM.getContext().lookupFieldBitOffset(OID, nullptr, Ivar);
  90   uint64_t BitOffset = FieldBitOffset % CGF.CGM.getContext().getCharWidth();
  91   uint64_t AlignmentBits = CGF.CGM.getTarget().getCharAlign();
  92   uint64_t BitFieldSize = Ivar->getBitWidthValue(CGF.getContext());
  93   CharUnits StorageSize = CGF.CGM.getContext().toCharUnitsFromBits(
  94       llvm::alignTo(BitOffset + BitFieldSize, AlignmentBits));
  95   CharUnits Alignment = CGF.CGM.getContext().toCharUnitsFromBits(AlignmentBits);
  96
  97   // Allocate a new CGBitFieldInfo object to describe this access.
  98   //
  99   // FIXME: This is incredibly wasteful, these should be uniqued or part of some
 100   // layout object. However, this is blocked on other cleanups to the
 101   // Objective-C code, so for now we just live with allocating a bunch of these
 102   // objects.
 103   CGBitFieldInfo *Info = new (CGF.CGM.getContext()) CGBitFieldInfo(
 104     CGBitFieldInfo::MakeInfo(CGF.CGM.getTypes(), Ivar, BitOffset, BitFieldSize,
 105                              CGF.CGM.getContext().toBits(StorageSize),
 106                              CharUnits::fromQuantity(0)));
 107
 108   Address Addr(V, Alignment);
 109   Addr = CGF.Builder.CreateElementBitCast(Addr,
 110                                    llvm::Type::getIntNTy(CGF.getLLVMContext(),
 111                                                          Info->StorageSize));
 112   return LValue::MakeBitfield(Addr, *Info, IvarTy,
 113                               LValueBaseInfo(AlignmentSource::Decl, false));
 114 }
 115
 116 namespace {
 117   struct CatchHandler {
 118     const VarDecl *Variable;
 119     const Stmt *Body;
 120     llvm::BasicBlock *Block;
 121     llvm::Constant *TypeInfo;
 122   };
 123
 124   struct CallObjCEndCatch final : EHScopeStack::Cleanup {
 125     CallObjCEndCatch(bool MightThrow, llvm::Value *Fn)
 126         : MightThrow(MightThrow), Fn(Fn) {}
 127     bool MightThrow;
 128     llvm::Value *Fn;
 129
 130     void Emit(CodeGenFunction &CGF, Flags flags) override {
 131       if (MightThrow)
 132         CGF.EmitRuntimeCallOrInvoke(Fn);
 133       else
 134         CGF.EmitNounwindRuntimeCall(Fn);
 135     }
 136   };
 137 }
 138
 139
 140 void CGObjCRuntime::EmitTryCatchStmt(CodeGenFunction &CGF,
 141                                      const ObjCAtTryStmt &S,
 142                                      llvm::Constant *beginCatchFn,
 143                                      llvm::Constant *endCatchFn,
 144                                      llvm::Constant *exceptionRethrowFn) {
 145   // Jump destination for falling out of catch bodies.
 146   CodeGenFunction::JumpDest Cont;
 147   if (S.getNumCatchStmts())
 148     Cont = CGF.getJumpDestInCurrentScope("eh.cont");
 149
 150   CodeGenFunction::FinallyInfo FinallyInfo;
 151   if (const ObjCAtFinallyStmt *Finally = S.getFinallyStmt())
 152     FinallyInfo.enter(CGF, Finally->getFinallyBody(),
 153                       beginCatchFn, endCatchFn, exceptionRethrowFn);
 154
 155   SmallVector<CatchHandler, 8> Handlers;
 156
 157   // Enter the catch, if there is one.
 158   if (S.getNumCatchStmts()) {
 159     for (unsigned I = 0, N = S.getNumCatchStmts(); I != N; ++I) {
 160       const ObjCAtCatchStmt *CatchStmt = S.getCatchStmt(I);
 161       const VarDecl *CatchDecl = CatchStmt->getCatchParamDecl();
 162
 163       Handlers.push_back(CatchHandler());
 164       CatchHandler &Handler = Handlers.back();
 165       Handler.Variable = CatchDecl;
 166       Handler.Body = CatchStmt->getCatchBody();
 167       Handler.Block = CGF.createBasicBlock("catch");
 168
 169       // @catch(...) always matches.
 170       if (!CatchDecl) {
 171         Handler.TypeInfo = nullptr; // catch-all
 172         // Don't consider any other catches.
 173         break;
 174       }
 175
 176       Handler.TypeInfo = GetEHType(CatchDecl->getType());
 177     }
 178
 179     EHCatchScope *Catch = CGF.EHStack.pushCatch(Handlers.size());
 180     for (unsigned I = 0, E = Handlers.size(); I != E; ++I)
 181       Catch->setHandler(I, Handlers[I].TypeInfo, Handlers[I].Block);
 182   }
 183
 184   // Emit the try body.
 185   CGF.EmitStmt(S.getTryBody());
 186
 187   // Leave the try.
 188   if (S.getNumCatchStmts())
 189     CGF.popCatchScope();
 190
 191   // Remember where we were.
 192   CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
 193
 194   // Emit the handlers.
 195   for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
 196     CatchHandler &Handler = Handlers[I];
 197
 198     CGF.EmitBlock(Handler.Block);
 199     llvm::Value *RawExn = CGF.getExceptionFromSlot();
 200
 201     // Enter the catch.
 202     llvm::Value *Exn = RawExn;
 203     if (beginCatchFn)
 204       Exn = CGF.EmitNounwindRuntimeCall(beginCatchFn, RawExn, "exn.adjusted");
 205
 206     CodeGenFunction::LexicalScope cleanups(CGF, Handler.Body->getSourceRange());
 207
 208     if (endCatchFn) {
 209       // Add a cleanup to leave the catch.
 210       bool EndCatchMightThrow = (Handler.Variable == nullptr);
 211
 212       CGF.EHStack.pushCleanup<CallObjCEndCatch>(NormalAndEHCleanup,
 213                                                 EndCatchMightThrow,
 214                                                 endCatchFn);
 215     }
 216
 217     // Bind the catch parameter if it exists.
 218     if (const VarDecl *CatchParam = Handler.Variable) {
 219       llvm::Type *CatchType = CGF.ConvertType(CatchParam->getType());
 220       llvm::Value *CastExn = CGF.Builder.CreateBitCast(Exn, CatchType);
 221
 222       CGF.EmitAutoVarDecl(*CatchParam);
 223       EmitInitOfCatchParam(CGF, CastExn, CatchParam);
 224     }
 225
 226     CGF.ObjCEHValueStack.push_back(Exn);
 227     CGF.EmitStmt(Handler.Body);
 228     CGF.ObjCEHValueStack.pop_back();
 229
 230     // Leave any cleanups associated with the catch.
 231     cleanups.ForceCleanup();
 232
 233     CGF.EmitBranchThroughCleanup(Cont);
 234   }
 235
 236   // Go back to the try-statement fallthrough.
 237   CGF.Builder.restoreIP(SavedIP);
 238
 239   // Pop out of the finally.
 240   if (S.getFinallyStmt())
 241     FinallyInfo.exit(CGF);
 242
 243   if (Cont.isValid())
 244     CGF.EmitBlock(Cont.getBlock());
 245 }
 246
 247 void CGObjCRuntime::EmitInitOfCatchParam(CodeGenFunction &CGF,
 248                                          llvm::Value *exn,
 249                                          const VarDecl *paramDecl) {
 250
 251   Address paramAddr = CGF.GetAddrOfLocalVar(paramDecl);
 252
 253   switch (paramDecl->getType().getQualifiers().getObjCLifetime()) {
 254   case Qualifiers::OCL_Strong:
 255     exn = CGF.EmitARCRetainNonBlock(exn);
 256     // fallthrough
 257
 258   case Qualifiers::OCL_None:
 259   case Qualifiers::OCL_ExplicitNone:
 260   case Qualifiers::OCL_Autoreleasing:
 261     CGF.Builder.CreateStore(exn, paramAddr);
 262     return;
 263
 264   case Qualifiers::OCL_Weak:
 265     CGF.EmitARCInitWeak(paramAddr, exn);
 266     return;
 267   }
 268   llvm_unreachable("invalid ownership qualifier");
 269 }
 270
 271 namespace {
 272   struct CallSyncExit final : EHScopeStack::Cleanup {
 273     llvm::Value *SyncExitFn;
 274     llvm::Value *SyncArg;
 275     CallSyncExit(llvm::Value *SyncExitFn, llvm::Value *SyncArg)
 276       : SyncExitFn(SyncExitFn), SyncArg(SyncArg) {}
 277
 278     void Emit(CodeGenFunction &CGF, Flags flags) override {
 279       CGF.Builder.CreateCall(SyncExitFn, SyncArg)->setDoesNotThrow();
 280     }
 281   };
 282 }
 283
 284 void CGObjCRuntime::EmitAtSynchronizedStmt(CodeGenFunction &CGF,
 285                                            const ObjCAtSynchronizedStmt &S,
 286                                            llvm::Function *syncEnterFn,
 287                                            llvm::Function *syncExitFn) {
 288   CodeGenFunction::RunCleanupsScope cleanups(CGF);
 289
 290   // Evaluate the lock operand.  This is guaranteed to dominate the
 291   // ARC release and lock-release cleanups.
 292   const Expr *lockExpr = S.getSynchExpr();
 293   llvm::Value *lock;
 294   if (CGF.getLangOpts().ObjCAutoRefCount) {
 295     lock = CGF.EmitARCRetainScalarExpr(lockExpr);
 296     lock = CGF.EmitObjCConsumeObject(lockExpr->getType(), lock);
 297   } else {
 298     lock = CGF.EmitScalarExpr(lockExpr);
 299   }
 300   lock = CGF.Builder.CreateBitCast(lock, CGF.VoidPtrTy);
 301
 302   // Acquire the lock.
 303   CGF.Builder.CreateCall(syncEnterFn, lock)->setDoesNotThrow();
 304
 305   // Register an all-paths cleanup to release the lock.
 306   CGF.EHStack.pushCleanup<CallSyncExit>(NormalAndEHCleanup, syncExitFn, lock);
 307
 308   // Emit the body of the statement.
 309   CGF.EmitStmt(S.getSynchBody());
 310 }
 311
 312 /// Compute the pointer-to-function type to which a message send
 313 /// should be casted in order to correctly call the given method
 314 /// with the given arguments.
 315 ///
 316 /// \param method - may be null
 317 /// \param resultType - the result type to use if there's no method
 318 /// \param callArgs - the actual arguments, including implicit ones
 319 CGObjCRuntime::MessageSendInfo
 320 CGObjCRuntime::getMessageSendInfo(const ObjCMethodDecl *method,
 321                                   QualType resultType,
 322                                   CallArgList &callArgs) {
 323   // If there's a method, use information from that.
 324   if (method) {
 325     const CGFunctionInfo &signature =
 326       CGM.getTypes().arrangeObjCMessageSendSignature(method, callArgs[0].Ty);
 327
 328     llvm::PointerType *signatureType =
 329       CGM.getTypes().GetFunctionType(signature)->getPointerTo();
 330
 331     const CGFunctionInfo &signatureForCall =
 332       CGM.getTypes().arrangeCall(signature, callArgs);
 333
 334     return MessageSendInfo(signatureForCall, signatureType);
 335   }
 336
 337   // There's no method;  just use a default CC.
 338   const CGFunctionInfo &argsInfo =
 339     CGM.getTypes().arrangeUnprototypedObjCMessageSend(resultType, callArgs);
 340
 341   // Derive the signature to call from that.
 342   llvm::PointerType *signatureType =
 343     CGM.getTypes().GetFunctionType(argsInfo)->getPointerTo();
 344   return MessageSendInfo(argsInfo, signatureType);
 345 }