1 //===--- CodeGenFunction.cpp - Emit LLVM Code from ASTs for a Function ----===// 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 coordinates the per-function state used while generating code. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "CodeGenFunction.h" 15 #include "CGBlocks.h" 16 #include "CGCleanup.h" 17 #include "CGCUDARuntime.h" 18 #include "CGCXXABI.h" 19 #include "CGDebugInfo.h" 20 #include "CGOpenMPRuntime.h" 21 #include "CodeGenModule.h" 22 #include "CodeGenPGO.h" 23 #include "TargetInfo.h" 24 #include "clang/AST/ASTContext.h" 25 #include "clang/AST/Decl.h" 26 #include "clang/AST/DeclCXX.h" 27 #include "clang/AST/StmtCXX.h" 28 #include "clang/AST/StmtObjC.h" 29 #include "clang/Basic/Builtins.h" 30 #include "clang/Basic/TargetInfo.h" 31 #include "clang/CodeGen/CGFunctionInfo.h" 32 #include "clang/Frontend/CodeGenOptions.h" 33 #include "clang/Sema/SemaDiagnostic.h" 34 #include "llvm/IR/DataLayout.h" 35 #include "llvm/IR/Intrinsics.h" 36 #include "llvm/IR/MDBuilder.h" 37 #include "llvm/IR/Operator.h" 38 using namespace clang; 39 using namespace CodeGen; 40 41 /// shouldEmitLifetimeMarkers - Decide whether we need emit the life-time 42 /// markers. 43 static bool shouldEmitLifetimeMarkers(const CodeGenOptions &CGOpts, 44 const LangOptions &LangOpts) { 45 if (CGOpts.DisableLifetimeMarkers) 46 return false; 47 48 // Asan uses markers for use-after-scope checks. 49 if (CGOpts.SanitizeAddressUseAfterScope) 50 return true; 51 52 // Disable lifetime markers in msan builds. 53 // FIXME: Remove this when msan works with lifetime markers. 54 if (LangOpts.Sanitize.has(SanitizerKind::Memory)) 55 return false; 56 57 // For now, only in optimized builds. 58 return CGOpts.OptimizationLevel != 0; 59 } 60 61 CodeGenFunction::CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext) 62 : CodeGenTypeCache(cgm), CGM(cgm), Target(cgm.getTarget()), 63 Builder(cgm, cgm.getModule().getContext(), llvm::ConstantFolder(), 64 CGBuilderInserterTy(this)), 65 CurFn(nullptr), ReturnValue(Address::invalid()), 66 CapturedStmtInfo(nullptr), SanOpts(CGM.getLangOpts().Sanitize), 67 IsSanitizerScope(false), CurFuncIsThunk(false), AutoreleaseResult(false), 68 SawAsmBlock(false), IsOutlinedSEHHelper(false), BlockInfo(nullptr), 69 BlockPointer(nullptr), LambdaThisCaptureField(nullptr), 70 NormalCleanupDest(nullptr), NextCleanupDestIndex(1), 71 FirstBlockInfo(nullptr), EHResumeBlock(nullptr), ExceptionSlot(nullptr), 72 EHSelectorSlot(nullptr), DebugInfo(CGM.getModuleDebugInfo()), 73 DisableDebugInfo(false), DidCallStackSave(false), IndirectBranch(nullptr), 74 PGO(cgm), SwitchInsn(nullptr), SwitchWeights(nullptr), 75 CaseRangeBlock(nullptr), UnreachableBlock(nullptr), NumReturnExprs(0), 76 NumSimpleReturnExprs(0), CXXABIThisDecl(nullptr), 77 CXXABIThisValue(nullptr), CXXThisValue(nullptr), 78 CXXStructorImplicitParamDecl(nullptr), 79 CXXStructorImplicitParamValue(nullptr), OutermostConditional(nullptr), 80 CurLexicalScope(nullptr), TerminateLandingPad(nullptr), 81 TerminateHandler(nullptr), TrapBB(nullptr), 82 ShouldEmitLifetimeMarkers( 83 shouldEmitLifetimeMarkers(CGM.getCodeGenOpts(), CGM.getLangOpts())) { 84 if (!suppressNewContext) 85 CGM.getCXXABI().getMangleContext().startNewFunction(); 86 87 llvm::FastMathFlags FMF; 88 if (CGM.getLangOpts().FastMath) 89 FMF.setUnsafeAlgebra(); 90 if (CGM.getLangOpts().FiniteMathOnly) { 91 FMF.setNoNaNs(); 92 FMF.setNoInfs(); 93 } 94 if (CGM.getCodeGenOpts().NoNaNsFPMath) { 95 FMF.setNoNaNs(); 96 } 97 if (CGM.getCodeGenOpts().NoSignedZeros) { 98 FMF.setNoSignedZeros(); 99 } 100 if (CGM.getCodeGenOpts().ReciprocalMath) { 101 FMF.setAllowReciprocal(); 102 } 103 Builder.setFastMathFlags(FMF); 104 } 105 106 CodeGenFunction::~CodeGenFunction() { 107 assert(LifetimeExtendedCleanupStack.empty() && "failed to emit a cleanup"); 108 109 // If there are any unclaimed block infos, go ahead and destroy them 110 // now. This can happen if IR-gen gets clever and skips evaluating 111 // something. 112 if (FirstBlockInfo) 113 destroyBlockInfos(FirstBlockInfo); 114 115 if (getLangOpts().OpenMP && CurFn) 116 CGM.getOpenMPRuntime().functionFinished(*this); 117 } 118 119 CharUnits CodeGenFunction::getNaturalPointeeTypeAlignment(QualType T, 120 AlignmentSource *Source) { 121 return getNaturalTypeAlignment(T->getPointeeType(), Source, 122 /*forPointee*/ true); 123 } 124 125 CharUnits CodeGenFunction::getNaturalTypeAlignment(QualType T, 126 AlignmentSource *Source, 127 bool forPointeeType) { 128 // Honor alignment typedef attributes even on incomplete types. 129 // We also honor them straight for C++ class types, even as pointees; 130 // there's an expressivity gap here. 131 if (auto TT = T->getAs<TypedefType>()) { 132 if (auto Align = TT->getDecl()->getMaxAlignment()) { 133 if (Source) *Source = AlignmentSource::AttributedType; 134 return getContext().toCharUnitsFromBits(Align); 135 } 136 } 137 138 if (Source) *Source = AlignmentSource::Type; 139 140 CharUnits Alignment; 141 if (T->isIncompleteType()) { 142 Alignment = CharUnits::One(); // Shouldn't be used, but pessimistic is best. 143 } else { 144 // For C++ class pointees, we don't know whether we're pointing at a 145 // base or a complete object, so we generally need to use the 146 // non-virtual alignment. 147 const CXXRecordDecl *RD; 148 if (forPointeeType && (RD = T->getAsCXXRecordDecl())) { 149 Alignment = CGM.getClassPointerAlignment(RD); 150 } else { 151 Alignment = getContext().getTypeAlignInChars(T); 152 } 153 154 // Cap to the global maximum type alignment unless the alignment 155 // was somehow explicit on the type. 156 if (unsigned MaxAlign = getLangOpts().MaxTypeAlign) { 157 if (Alignment.getQuantity() > MaxAlign && 158 !getContext().isAlignmentRequired(T)) 159 Alignment = CharUnits::fromQuantity(MaxAlign); 160 } 161 } 162 return Alignment; 163 } 164 165 LValue CodeGenFunction::MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) { 166 AlignmentSource AlignSource; 167 CharUnits Alignment = getNaturalTypeAlignment(T, &AlignSource); 168 return LValue::MakeAddr(Address(V, Alignment), T, getContext(), AlignSource, 169 CGM.getTBAAInfo(T)); 170 } 171 172 /// Given a value of type T* that may not be to a complete object, 173 /// construct an l-value with the natural pointee alignment of T. 174 LValue 175 CodeGenFunction::MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T) { 176 AlignmentSource AlignSource; 177 CharUnits Align = getNaturalTypeAlignment(T, &AlignSource, /*pointee*/ true); 178 return MakeAddrLValue(Address(V, Align), T, AlignSource); 179 } 180 181 182 llvm::Type *CodeGenFunction::ConvertTypeForMem(QualType T) { 183 return CGM.getTypes().ConvertTypeForMem(T); 184 } 185 186 llvm::Type *CodeGenFunction::ConvertType(QualType T) { 187 return CGM.getTypes().ConvertType(T); 188 } 189 190 TypeEvaluationKind CodeGenFunction::getEvaluationKind(QualType type) { 191 type = type.getCanonicalType(); 192 while (true) { 193 switch (type->getTypeClass()) { 194 #define TYPE(name, parent) 195 #define ABSTRACT_TYPE(name, parent) 196 #define NON_CANONICAL_TYPE(name, parent) case Type::name: 197 #define DEPENDENT_TYPE(name, parent) case Type::name: 198 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(name, parent) case Type::name: 199 #include "clang/AST/TypeNodes.def" 200 llvm_unreachable("non-canonical or dependent type in IR-generation"); 201 202 case Type::Auto: 203 case Type::DeducedTemplateSpecialization: 204 llvm_unreachable("undeduced type in IR-generation"); 205 206 // Various scalar types. 207 case Type::Builtin: 208 case Type::Pointer: 209 case Type::BlockPointer: 210 case Type::LValueReference: 211 case Type::RValueReference: 212 case Type::MemberPointer: 213 case Type::Vector: 214 case Type::ExtVector: 215 case Type::FunctionProto: 216 case Type::FunctionNoProto: 217 case Type::Enum: 218 case Type::ObjCObjectPointer: 219 case Type::Pipe: 220 return TEK_Scalar; 221 222 // Complexes. 223 case Type::Complex: 224 return TEK_Complex; 225 226 // Arrays, records, and Objective-C objects. 227 case Type::ConstantArray: 228 case Type::IncompleteArray: 229 case Type::VariableArray: 230 case Type::Record: 231 case Type::ObjCObject: 232 case Type::ObjCInterface: 233 return TEK_Aggregate; 234 235 // We operate on atomic values according to their underlying type. 236 case Type::Atomic: 237 type = cast<AtomicType>(type)->getValueType(); 238 continue; 239 } 240 llvm_unreachable("unknown type kind!"); 241 } 242 } 243 244 llvm::DebugLoc CodeGenFunction::EmitReturnBlock() { 245 // For cleanliness, we try to avoid emitting the return block for 246 // simple cases. 247 llvm::BasicBlock *CurBB = Builder.GetInsertBlock(); 248 249 if (CurBB) { 250 assert(!CurBB->getTerminator() && "Unexpected terminated block."); 251 252 // We have a valid insert point, reuse it if it is empty or there are no 253 // explicit jumps to the return block. 254 if (CurBB->empty() || ReturnBlock.getBlock()->use_empty()) { 255 ReturnBlock.getBlock()->replaceAllUsesWith(CurBB); 256 delete ReturnBlock.getBlock(); 257 } else 258 EmitBlock(ReturnBlock.getBlock()); 259 return llvm::DebugLoc(); 260 } 261 262 // Otherwise, if the return block is the target of a single direct 263 // branch then we can just put the code in that block instead. This 264 // cleans up functions which started with a unified return block. 265 if (ReturnBlock.getBlock()->hasOneUse()) { 266 llvm::BranchInst *BI = 267 dyn_cast<llvm::BranchInst>(*ReturnBlock.getBlock()->user_begin()); 268 if (BI && BI->isUnconditional() && 269 BI->getSuccessor(0) == ReturnBlock.getBlock()) { 270 // Record/return the DebugLoc of the simple 'return' expression to be used 271 // later by the actual 'ret' instruction. 272 llvm::DebugLoc Loc = BI->getDebugLoc(); 273 Builder.SetInsertPoint(BI->getParent()); 274 BI->eraseFromParent(); 275 delete ReturnBlock.getBlock(); 276 return Loc; 277 } 278 } 279 280 // FIXME: We are at an unreachable point, there is no reason to emit the block 281 // unless it has uses. However, we still need a place to put the debug 282 // region.end for now. 283 284 EmitBlock(ReturnBlock.getBlock()); 285 return llvm::DebugLoc(); 286 } 287 288 static void EmitIfUsed(CodeGenFunction &CGF, llvm::BasicBlock *BB) { 289 if (!BB) return; 290 if (!BB->use_empty()) 291 return CGF.CurFn->getBasicBlockList().push_back(BB); 292 delete BB; 293 } 294 295 void CodeGenFunction::FinishFunction(SourceLocation EndLoc) { 296 assert(BreakContinueStack.empty() && 297 "mismatched push/pop in break/continue stack!"); 298 299 bool OnlySimpleReturnStmts = NumSimpleReturnExprs > 0 300 && NumSimpleReturnExprs == NumReturnExprs 301 && ReturnBlock.getBlock()->use_empty(); 302 // Usually the return expression is evaluated before the cleanup 303 // code. If the function contains only a simple return statement, 304 // such as a constant, the location before the cleanup code becomes 305 // the last useful breakpoint in the function, because the simple 306 // return expression will be evaluated after the cleanup code. To be 307 // safe, set the debug location for cleanup code to the location of 308 // the return statement. Otherwise the cleanup code should be at the 309 // end of the function's lexical scope. 310 // 311 // If there are multiple branches to the return block, the branch 312 // instructions will get the location of the return statements and 313 // all will be fine. 314 if (CGDebugInfo *DI = getDebugInfo()) { 315 if (OnlySimpleReturnStmts) 316 DI->EmitLocation(Builder, LastStopPoint); 317 else 318 DI->EmitLocation(Builder, EndLoc); 319 } 320 321 // Pop any cleanups that might have been associated with the 322 // parameters. Do this in whatever block we're currently in; it's 323 // important to do this before we enter the return block or return 324 // edges will be *really* confused. 325 bool HasCleanups = EHStack.stable_begin() != PrologueCleanupDepth; 326 bool HasOnlyLifetimeMarkers = 327 HasCleanups && EHStack.containsOnlyLifetimeMarkers(PrologueCleanupDepth); 328 bool EmitRetDbgLoc = !HasCleanups || HasOnlyLifetimeMarkers; 329 if (HasCleanups) { 330 // Make sure the line table doesn't jump back into the body for 331 // the ret after it's been at EndLoc. 332 if (CGDebugInfo *DI = getDebugInfo()) 333 if (OnlySimpleReturnStmts) 334 DI->EmitLocation(Builder, EndLoc); 335 336 PopCleanupBlocks(PrologueCleanupDepth); 337 } 338 339 // Emit function epilog (to return). 340 llvm::DebugLoc Loc = EmitReturnBlock(); 341 342 if (ShouldInstrumentFunction()) 343 EmitFunctionInstrumentation("__cyg_profile_func_exit"); 344 345 // Emit debug descriptor for function end. 346 if (CGDebugInfo *DI = getDebugInfo()) 347 DI->EmitFunctionEnd(Builder); 348 349 // Reset the debug location to that of the simple 'return' expression, if any 350 // rather than that of the end of the function's scope '}'. 351 ApplyDebugLocation AL(*this, Loc); 352 EmitFunctionEpilog(*CurFnInfo, EmitRetDbgLoc, EndLoc); 353 EmitEndEHSpec(CurCodeDecl); 354 355 assert(EHStack.empty() && 356 "did not remove all scopes from cleanup stack!"); 357 358 // If someone did an indirect goto, emit the indirect goto block at the end of 359 // the function. 360 if (IndirectBranch) { 361 EmitBlock(IndirectBranch->getParent()); 362 Builder.ClearInsertionPoint(); 363 } 364 365 // If some of our locals escaped, insert a call to llvm.localescape in the 366 // entry block. 367 if (!EscapedLocals.empty()) { 368 // Invert the map from local to index into a simple vector. There should be 369 // no holes. 370 SmallVector<llvm::Value *, 4> EscapeArgs; 371 EscapeArgs.resize(EscapedLocals.size()); 372 for (auto &Pair : EscapedLocals) 373 EscapeArgs[Pair.second] = Pair.first; 374 llvm::Function *FrameEscapeFn = llvm::Intrinsic::getDeclaration( 375 &CGM.getModule(), llvm::Intrinsic::localescape); 376 CGBuilderTy(*this, AllocaInsertPt).CreateCall(FrameEscapeFn, EscapeArgs); 377 } 378 379 // Remove the AllocaInsertPt instruction, which is just a convenience for us. 380 llvm::Instruction *Ptr = AllocaInsertPt; 381 AllocaInsertPt = nullptr; 382 Ptr->eraseFromParent(); 383 384 // If someone took the address of a label but never did an indirect goto, we 385 // made a zero entry PHI node, which is illegal, zap it now. 386 if (IndirectBranch) { 387 llvm::PHINode *PN = cast<llvm::PHINode>(IndirectBranch->getAddress()); 388 if (PN->getNumIncomingValues() == 0) { 389 PN->replaceAllUsesWith(llvm::UndefValue::get(PN->getType())); 390 PN->eraseFromParent(); 391 } 392 } 393 394 EmitIfUsed(*this, EHResumeBlock); 395 EmitIfUsed(*this, TerminateLandingPad); 396 EmitIfUsed(*this, TerminateHandler); 397 EmitIfUsed(*this, UnreachableBlock); 398 399 if (CGM.getCodeGenOpts().EmitDeclMetadata) 400 EmitDeclMetadata(); 401 402 for (SmallVectorImpl<std::pair<llvm::Instruction *, llvm::Value *> >::iterator 403 I = DeferredReplacements.begin(), 404 E = DeferredReplacements.end(); 405 I != E; ++I) { 406 I->first->replaceAllUsesWith(I->second); 407 I->first->eraseFromParent(); 408 } 409 } 410 411 /// ShouldInstrumentFunction - Return true if the current function should be 412 /// instrumented with __cyg_profile_func_* calls 413 bool CodeGenFunction::ShouldInstrumentFunction() { 414 if (!CGM.getCodeGenOpts().InstrumentFunctions) 415 return false; 416 if (!CurFuncDecl || CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>()) 417 return false; 418 return true; 419 } 420 421 /// ShouldXRayInstrument - Return true if the current function should be 422 /// instrumented with XRay nop sleds. 423 bool CodeGenFunction::ShouldXRayInstrumentFunction() const { 424 return CGM.getCodeGenOpts().XRayInstrumentFunctions; 425 } 426 427 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified 428 /// instrumentation function with the current function and the call site, if 429 /// function instrumentation is enabled. 430 void CodeGenFunction::EmitFunctionInstrumentation(const char *Fn) { 431 auto NL = ApplyDebugLocation::CreateArtificial(*this); 432 // void __cyg_profile_func_{enter,exit} (void *this_fn, void *call_site); 433 llvm::PointerType *PointerTy = Int8PtrTy; 434 llvm::Type *ProfileFuncArgs[] = { PointerTy, PointerTy }; 435 llvm::FunctionType *FunctionTy = 436 llvm::FunctionType::get(VoidTy, ProfileFuncArgs, false); 437 438 llvm::Constant *F = CGM.CreateRuntimeFunction(FunctionTy, Fn); 439 llvm::CallInst *CallSite = Builder.CreateCall( 440 CGM.getIntrinsic(llvm::Intrinsic::returnaddress), 441 llvm::ConstantInt::get(Int32Ty, 0), 442 "callsite"); 443 444 llvm::Value *args[] = { 445 llvm::ConstantExpr::getBitCast(CurFn, PointerTy), 446 CallSite 447 }; 448 449 EmitNounwindRuntimeCall(F, args); 450 } 451 452 static void removeImageAccessQualifier(std::string& TyName) { 453 std::string ReadOnlyQual("__read_only"); 454 std::string::size_type ReadOnlyPos = TyName.find(ReadOnlyQual); 455 if (ReadOnlyPos != std::string::npos) 456 // "+ 1" for the space after access qualifier. 457 TyName.erase(ReadOnlyPos, ReadOnlyQual.size() + 1); 458 else { 459 std::string WriteOnlyQual("__write_only"); 460 std::string::size_type WriteOnlyPos = TyName.find(WriteOnlyQual); 461 if (WriteOnlyPos != std::string::npos) 462 TyName.erase(WriteOnlyPos, WriteOnlyQual.size() + 1); 463 else { 464 std::string ReadWriteQual("__read_write"); 465 std::string::size_type ReadWritePos = TyName.find(ReadWriteQual); 466 if (ReadWritePos != std::string::npos) 467 TyName.erase(ReadWritePos, ReadWriteQual.size() + 1); 468 } 469 } 470 } 471 472 // Returns the address space id that should be produced to the 473 // kernel_arg_addr_space metadata. This is always fixed to the ids 474 // as specified in the SPIR 2.0 specification in order to differentiate 475 // for example in clGetKernelArgInfo() implementation between the address 476 // spaces with targets without unique mapping to the OpenCL address spaces 477 // (basically all single AS CPUs). 478 static unsigned ArgInfoAddressSpace(unsigned LangAS) { 479 switch (LangAS) { 480 case LangAS::opencl_global: return 1; 481 case LangAS::opencl_constant: return 2; 482 case LangAS::opencl_local: return 3; 483 case LangAS::opencl_generic: return 4; // Not in SPIR 2.0 specs. 484 default: 485 return 0; // Assume private. 486 } 487 } 488 489 // OpenCL v1.2 s5.6.4.6 allows the compiler to store kernel argument 490 // information in the program executable. The argument information stored 491 // includes the argument name, its type, the address and access qualifiers used. 492 static void GenOpenCLArgMetadata(const FunctionDecl *FD, llvm::Function *Fn, 493 CodeGenModule &CGM, llvm::LLVMContext &Context, 494 CGBuilderTy &Builder, ASTContext &ASTCtx) { 495 // Create MDNodes that represent the kernel arg metadata. 496 // Each MDNode is a list in the form of "key", N number of values which is 497 // the same number of values as their are kernel arguments. 498 499 const PrintingPolicy &Policy = ASTCtx.getPrintingPolicy(); 500 501 // MDNode for the kernel argument address space qualifiers. 502 SmallVector<llvm::Metadata *, 8> addressQuals; 503 504 // MDNode for the kernel argument access qualifiers (images only). 505 SmallVector<llvm::Metadata *, 8> accessQuals; 506 507 // MDNode for the kernel argument type names. 508 SmallVector<llvm::Metadata *, 8> argTypeNames; 509 510 // MDNode for the kernel argument base type names. 511 SmallVector<llvm::Metadata *, 8> argBaseTypeNames; 512 513 // MDNode for the kernel argument type qualifiers. 514 SmallVector<llvm::Metadata *, 8> argTypeQuals; 515 516 // MDNode for the kernel argument names. 517 SmallVector<llvm::Metadata *, 8> argNames; 518 519 for (unsigned i = 0, e = FD->getNumParams(); i != e; ++i) { 520 const ParmVarDecl *parm = FD->getParamDecl(i); 521 QualType ty = parm->getType(); 522 std::string typeQuals; 523 524 if (ty->isPointerType()) { 525 QualType pointeeTy = ty->getPointeeType(); 526 527 // Get address qualifier. 528 addressQuals.push_back(llvm::ConstantAsMetadata::get(Builder.getInt32( 529 ArgInfoAddressSpace(pointeeTy.getAddressSpace())))); 530 531 // Get argument type name. 532 std::string typeName = 533 pointeeTy.getUnqualifiedType().getAsString(Policy) + "*"; 534 535 // Turn "unsigned type" to "utype" 536 std::string::size_type pos = typeName.find("unsigned"); 537 if (pointeeTy.isCanonical() && pos != std::string::npos) 538 typeName.erase(pos+1, 8); 539 540 argTypeNames.push_back(llvm::MDString::get(Context, typeName)); 541 542 std::string baseTypeName = 543 pointeeTy.getUnqualifiedType().getCanonicalType().getAsString( 544 Policy) + 545 "*"; 546 547 // Turn "unsigned type" to "utype" 548 pos = baseTypeName.find("unsigned"); 549 if (pos != std::string::npos) 550 baseTypeName.erase(pos+1, 8); 551 552 argBaseTypeNames.push_back(llvm::MDString::get(Context, baseTypeName)); 553 554 // Get argument type qualifiers: 555 if (ty.isRestrictQualified()) 556 typeQuals = "restrict"; 557 if (pointeeTy.isConstQualified() || 558 (pointeeTy.getAddressSpace() == LangAS::opencl_constant)) 559 typeQuals += typeQuals.empty() ? "const" : " const"; 560 if (pointeeTy.isVolatileQualified()) 561 typeQuals += typeQuals.empty() ? "volatile" : " volatile"; 562 } else { 563 uint32_t AddrSpc = 0; 564 bool isPipe = ty->isPipeType(); 565 if (ty->isImageType() || isPipe) 566 AddrSpc = ArgInfoAddressSpace(LangAS::opencl_global); 567 568 addressQuals.push_back( 569 llvm::ConstantAsMetadata::get(Builder.getInt32(AddrSpc))); 570 571 // Get argument type name. 572 std::string typeName; 573 if (isPipe) 574 typeName = ty.getCanonicalType()->getAs<PipeType>()->getElementType() 575 .getAsString(Policy); 576 else 577 typeName = ty.getUnqualifiedType().getAsString(Policy); 578 579 // Turn "unsigned type" to "utype" 580 std::string::size_type pos = typeName.find("unsigned"); 581 if (ty.isCanonical() && pos != std::string::npos) 582 typeName.erase(pos+1, 8); 583 584 std::string baseTypeName; 585 if (isPipe) 586 baseTypeName = ty.getCanonicalType()->getAs<PipeType>() 587 ->getElementType().getCanonicalType() 588 .getAsString(Policy); 589 else 590 baseTypeName = 591 ty.getUnqualifiedType().getCanonicalType().getAsString(Policy); 592 593 // Remove access qualifiers on images 594 // (as they are inseparable from type in clang implementation, 595 // but OpenCL spec provides a special query to get access qualifier 596 // via clGetKernelArgInfo with CL_KERNEL_ARG_ACCESS_QUALIFIER): 597 if (ty->isImageType()) { 598 removeImageAccessQualifier(typeName); 599 removeImageAccessQualifier(baseTypeName); 600 } 601 602 argTypeNames.push_back(llvm::MDString::get(Context, typeName)); 603 604 // Turn "unsigned type" to "utype" 605 pos = baseTypeName.find("unsigned"); 606 if (pos != std::string::npos) 607 baseTypeName.erase(pos+1, 8); 608 609 argBaseTypeNames.push_back(llvm::MDString::get(Context, baseTypeName)); 610 611 // Get argument type qualifiers: 612 if (ty.isConstQualified()) 613 typeQuals = "const"; 614 if (ty.isVolatileQualified()) 615 typeQuals += typeQuals.empty() ? "volatile" : " volatile"; 616 if (isPipe) 617 typeQuals = "pipe"; 618 } 619 620 argTypeQuals.push_back(llvm::MDString::get(Context, typeQuals)); 621 622 // Get image and pipe access qualifier: 623 if (ty->isImageType()|| ty->isPipeType()) { 624 const OpenCLAccessAttr *A = parm->getAttr<OpenCLAccessAttr>(); 625 if (A && A->isWriteOnly()) 626 accessQuals.push_back(llvm::MDString::get(Context, "write_only")); 627 else if (A && A->isReadWrite()) 628 accessQuals.push_back(llvm::MDString::get(Context, "read_write")); 629 else 630 accessQuals.push_back(llvm::MDString::get(Context, "read_only")); 631 } else 632 accessQuals.push_back(llvm::MDString::get(Context, "none")); 633 634 // Get argument name. 635 argNames.push_back(llvm::MDString::get(Context, parm->getName())); 636 } 637 638 Fn->setMetadata("kernel_arg_addr_space", 639 llvm::MDNode::get(Context, addressQuals)); 640 Fn->setMetadata("kernel_arg_access_qual", 641 llvm::MDNode::get(Context, accessQuals)); 642 Fn->setMetadata("kernel_arg_type", 643 llvm::MDNode::get(Context, argTypeNames)); 644 Fn->setMetadata("kernel_arg_base_type", 645 llvm::MDNode::get(Context, argBaseTypeNames)); 646 Fn->setMetadata("kernel_arg_type_qual", 647 llvm::MDNode::get(Context, argTypeQuals)); 648 if (CGM.getCodeGenOpts().EmitOpenCLArgMetadata) 649 Fn->setMetadata("kernel_arg_name", 650 llvm::MDNode::get(Context, argNames)); 651 } 652 653 void CodeGenFunction::EmitOpenCLKernelMetadata(const FunctionDecl *FD, 654 llvm::Function *Fn) 655 { 656 if (!FD->hasAttr<OpenCLKernelAttr>()) 657 return; 658 659 llvm::LLVMContext &Context = getLLVMContext(); 660 661 GenOpenCLArgMetadata(FD, Fn, CGM, Context, Builder, getContext()); 662 663 if (const VecTypeHintAttr *A = FD->getAttr<VecTypeHintAttr>()) { 664 QualType hintQTy = A->getTypeHint(); 665 const ExtVectorType *hintEltQTy = hintQTy->getAs<ExtVectorType>(); 666 bool isSignedInteger = 667 hintQTy->isSignedIntegerType() || 668 (hintEltQTy && hintEltQTy->getElementType()->isSignedIntegerType()); 669 llvm::Metadata *attrMDArgs[] = { 670 llvm::ConstantAsMetadata::get(llvm::UndefValue::get( 671 CGM.getTypes().ConvertType(A->getTypeHint()))), 672 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get( 673 llvm::IntegerType::get(Context, 32), 674 llvm::APInt(32, (uint64_t)(isSignedInteger ? 1 : 0))))}; 675 Fn->setMetadata("vec_type_hint", llvm::MDNode::get(Context, attrMDArgs)); 676 } 677 678 if (const WorkGroupSizeHintAttr *A = FD->getAttr<WorkGroupSizeHintAttr>()) { 679 llvm::Metadata *attrMDArgs[] = { 680 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())), 681 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())), 682 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))}; 683 Fn->setMetadata("work_group_size_hint", llvm::MDNode::get(Context, attrMDArgs)); 684 } 685 686 if (const ReqdWorkGroupSizeAttr *A = FD->getAttr<ReqdWorkGroupSizeAttr>()) { 687 llvm::Metadata *attrMDArgs[] = { 688 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())), 689 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())), 690 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))}; 691 Fn->setMetadata("reqd_work_group_size", llvm::MDNode::get(Context, attrMDArgs)); 692 } 693 } 694 695 /// Determine whether the function F ends with a return stmt. 696 static bool endsWithReturn(const Decl* F) { 697 const Stmt *Body = nullptr; 698 if (auto *FD = dyn_cast_or_null<FunctionDecl>(F)) 699 Body = FD->getBody(); 700 else if (auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(F)) 701 Body = OMD->getBody(); 702 703 if (auto *CS = dyn_cast_or_null<CompoundStmt>(Body)) { 704 auto LastStmt = CS->body_rbegin(); 705 if (LastStmt != CS->body_rend()) 706 return isa<ReturnStmt>(*LastStmt); 707 } 708 return false; 709 } 710 711 static void markAsIgnoreThreadCheckingAtRuntime(llvm::Function *Fn) { 712 Fn->addFnAttr("sanitize_thread_no_checking_at_run_time"); 713 Fn->removeFnAttr(llvm::Attribute::SanitizeThread); 714 } 715 716 void CodeGenFunction::StartFunction(GlobalDecl GD, 717 QualType RetTy, 718 llvm::Function *Fn, 719 const CGFunctionInfo &FnInfo, 720 const FunctionArgList &Args, 721 SourceLocation Loc, 722 SourceLocation StartLoc) { 723 assert(!CurFn && 724 "Do not use a CodeGenFunction object for more than one function"); 725 726 const Decl *D = GD.getDecl(); 727 728 DidCallStackSave = false; 729 CurCodeDecl = D; 730 if (const auto *FD = dyn_cast_or_null<FunctionDecl>(D)) 731 if (FD->usesSEHTry()) 732 CurSEHParent = FD; 733 CurFuncDecl = (D ? D->getNonClosureContext() : nullptr); 734 FnRetTy = RetTy; 735 CurFn = Fn; 736 CurFnInfo = &FnInfo; 737 assert(CurFn->isDeclaration() && "Function already has body?"); 738 739 if (CGM.isInSanitizerBlacklist(Fn, Loc)) 740 SanOpts.clear(); 741 742 if (D) { 743 // Apply the no_sanitize* attributes to SanOpts. 744 for (auto Attr : D->specific_attrs<NoSanitizeAttr>()) 745 SanOpts.Mask &= ~Attr->getMask(); 746 } 747 748 // Apply sanitizer attributes to the function. 749 if (SanOpts.hasOneOf(SanitizerKind::Address | SanitizerKind::KernelAddress)) 750 Fn->addFnAttr(llvm::Attribute::SanitizeAddress); 751 if (SanOpts.has(SanitizerKind::Thread)) 752 Fn->addFnAttr(llvm::Attribute::SanitizeThread); 753 if (SanOpts.has(SanitizerKind::Memory)) 754 Fn->addFnAttr(llvm::Attribute::SanitizeMemory); 755 if (SanOpts.has(SanitizerKind::SafeStack)) 756 Fn->addFnAttr(llvm::Attribute::SafeStack); 757 758 // Ignore TSan memory acesses from within ObjC/ObjC++ dealloc, initialize, 759 // .cxx_destruct, __destroy_helper_block_ and all of their calees at run time. 760 if (SanOpts.has(SanitizerKind::Thread)) { 761 if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) { 762 IdentifierInfo *II = OMD->getSelector().getIdentifierInfoForSlot(0); 763 if (OMD->getMethodFamily() == OMF_dealloc || 764 OMD->getMethodFamily() == OMF_initialize || 765 (OMD->getSelector().isUnarySelector() && II->isStr(".cxx_destruct"))) { 766 markAsIgnoreThreadCheckingAtRuntime(Fn); 767 } 768 } else if (const auto *FD = dyn_cast_or_null<FunctionDecl>(D)) { 769 IdentifierInfo *II = FD->getIdentifier(); 770 if (II && II->isStr("__destroy_helper_block_")) 771 markAsIgnoreThreadCheckingAtRuntime(Fn); 772 } 773 } 774 775 // Apply xray attributes to the function (as a string, for now) 776 if (D && ShouldXRayInstrumentFunction()) { 777 if (const auto *XRayAttr = D->getAttr<XRayInstrumentAttr>()) { 778 if (XRayAttr->alwaysXRayInstrument()) 779 Fn->addFnAttr("function-instrument", "xray-always"); 780 if (XRayAttr->neverXRayInstrument()) 781 Fn->addFnAttr("function-instrument", "xray-never"); 782 } else { 783 Fn->addFnAttr( 784 "xray-instruction-threshold", 785 llvm::itostr(CGM.getCodeGenOpts().XRayInstructionThreshold)); 786 } 787 } 788 789 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) 790 if (CGM.getLangOpts().OpenMP && FD->hasAttr<OMPDeclareSimdDeclAttr>()) 791 CGM.getOpenMPRuntime().emitDeclareSimdFunction(FD, Fn); 792 793 // Add no-jump-tables value. 794 Fn->addFnAttr("no-jump-tables", 795 llvm::toStringRef(CGM.getCodeGenOpts().NoUseJumpTables)); 796 797 if (getLangOpts().OpenCL) { 798 // Add metadata for a kernel function. 799 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) 800 EmitOpenCLKernelMetadata(FD, Fn); 801 } 802 803 // If we are checking function types, emit a function type signature as 804 // prologue data. 805 if (getLangOpts().CPlusPlus && SanOpts.has(SanitizerKind::Function)) { 806 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) { 807 if (llvm::Constant *PrologueSig = 808 CGM.getTargetCodeGenInfo().getUBSanFunctionSignature(CGM)) { 809 llvm::Constant *FTRTTIConst = 810 CGM.GetAddrOfRTTIDescriptor(FD->getType(), /*ForEH=*/true); 811 llvm::Constant *PrologueStructElems[] = { PrologueSig, FTRTTIConst }; 812 llvm::Constant *PrologueStructConst = 813 llvm::ConstantStruct::getAnon(PrologueStructElems, /*Packed=*/true); 814 Fn->setPrologueData(PrologueStructConst); 815 } 816 } 817 } 818 819 // If we're in C++ mode and the function name is "main", it is guaranteed 820 // to be norecurse by the standard (3.6.1.3 "The function main shall not be 821 // used within a program"). 822 if (getLangOpts().CPlusPlus) 823 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) 824 if (FD->isMain()) 825 Fn->addFnAttr(llvm::Attribute::NoRecurse); 826 827 llvm::BasicBlock *EntryBB = createBasicBlock("entry", CurFn); 828 829 // Create a marker to make it easy to insert allocas into the entryblock 830 // later. Don't create this with the builder, because we don't want it 831 // folded. 832 llvm::Value *Undef = llvm::UndefValue::get(Int32Ty); 833 AllocaInsertPt = new llvm::BitCastInst(Undef, Int32Ty, "allocapt", EntryBB); 834 835 ReturnBlock = getJumpDestInCurrentScope("return"); 836 837 Builder.SetInsertPoint(EntryBB); 838 839 // Emit subprogram debug descriptor. 840 if (CGDebugInfo *DI = getDebugInfo()) { 841 // Reconstruct the type from the argument list so that implicit parameters, 842 // such as 'this' and 'vtt', show up in the debug info. Preserve the calling 843 // convention. 844 CallingConv CC = CallingConv::CC_C; 845 if (auto *FD = dyn_cast_or_null<FunctionDecl>(D)) 846 if (const auto *SrcFnTy = FD->getType()->getAs<FunctionType>()) 847 CC = SrcFnTy->getCallConv(); 848 SmallVector<QualType, 16> ArgTypes; 849 for (const VarDecl *VD : Args) 850 ArgTypes.push_back(VD->getType()); 851 QualType FnType = getContext().getFunctionType( 852 RetTy, ArgTypes, FunctionProtoType::ExtProtoInfo(CC)); 853 DI->EmitFunctionStart(GD, Loc, StartLoc, FnType, CurFn, Builder); 854 } 855 856 if (ShouldInstrumentFunction()) 857 EmitFunctionInstrumentation("__cyg_profile_func_enter"); 858 859 // Since emitting the mcount call here impacts optimizations such as function 860 // inlining, we just add an attribute to insert a mcount call in backend. 861 // The attribute "counting-function" is set to mcount function name which is 862 // architecture dependent. 863 if (CGM.getCodeGenOpts().InstrumentForProfiling) { 864 if (CGM.getCodeGenOpts().CallFEntry) 865 Fn->addFnAttr("fentry-call", "true"); 866 else 867 Fn->addFnAttr("counting-function", getTarget().getMCountName()); 868 } 869 870 if (RetTy->isVoidType()) { 871 // Void type; nothing to return. 872 ReturnValue = Address::invalid(); 873 874 // Count the implicit return. 875 if (!endsWithReturn(D)) 876 ++NumReturnExprs; 877 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect && 878 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) { 879 // Indirect aggregate return; emit returned value directly into sret slot. 880 // This reduces code size, and affects correctness in C++. 881 auto AI = CurFn->arg_begin(); 882 if (CurFnInfo->getReturnInfo().isSRetAfterThis()) 883 ++AI; 884 ReturnValue = Address(&*AI, CurFnInfo->getReturnInfo().getIndirectAlign()); 885 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::InAlloca && 886 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) { 887 // Load the sret pointer from the argument struct and return into that. 888 unsigned Idx = CurFnInfo->getReturnInfo().getInAllocaFieldIndex(); 889 llvm::Function::arg_iterator EI = CurFn->arg_end(); 890 --EI; 891 llvm::Value *Addr = Builder.CreateStructGEP(nullptr, &*EI, Idx); 892 Addr = Builder.CreateAlignedLoad(Addr, getPointerAlign(), "agg.result"); 893 ReturnValue = Address(Addr, getNaturalTypeAlignment(RetTy)); 894 } else { 895 ReturnValue = CreateIRTemp(RetTy, "retval"); 896 897 // Tell the epilog emitter to autorelease the result. We do this 898 // now so that various specialized functions can suppress it 899 // during their IR-generation. 900 if (getLangOpts().ObjCAutoRefCount && 901 !CurFnInfo->isReturnsRetained() && 902 RetTy->isObjCRetainableType()) 903 AutoreleaseResult = true; 904 } 905 906 EmitStartEHSpec(CurCodeDecl); 907 908 PrologueCleanupDepth = EHStack.stable_begin(); 909 EmitFunctionProlog(*CurFnInfo, CurFn, Args); 910 911 if (D && isa<CXXMethodDecl>(D) && cast<CXXMethodDecl>(D)->isInstance()) { 912 CGM.getCXXABI().EmitInstanceFunctionProlog(*this); 913 const CXXMethodDecl *MD = cast<CXXMethodDecl>(D); 914 if (MD->getParent()->isLambda() && 915 MD->getOverloadedOperator() == OO_Call) { 916 // We're in a lambda; figure out the captures. 917 MD->getParent()->getCaptureFields(LambdaCaptureFields, 918 LambdaThisCaptureField); 919 if (LambdaThisCaptureField) { 920 // If the lambda captures the object referred to by '*this' - either by 921 // value or by reference, make sure CXXThisValue points to the correct 922 // object. 923 924 // Get the lvalue for the field (which is a copy of the enclosing object 925 // or contains the address of the enclosing object). 926 LValue ThisFieldLValue = EmitLValueForLambdaField(LambdaThisCaptureField); 927 if (!LambdaThisCaptureField->getType()->isPointerType()) { 928 // If the enclosing object was captured by value, just use its address. 929 CXXThisValue = ThisFieldLValue.getAddress().getPointer(); 930 } else { 931 // Load the lvalue pointed to by the field, since '*this' was captured 932 // by reference. 933 CXXThisValue = 934 EmitLoadOfLValue(ThisFieldLValue, SourceLocation()).getScalarVal(); 935 } 936 } 937 for (auto *FD : MD->getParent()->fields()) { 938 if (FD->hasCapturedVLAType()) { 939 auto *ExprArg = EmitLoadOfLValue(EmitLValueForLambdaField(FD), 940 SourceLocation()).getScalarVal(); 941 auto VAT = FD->getCapturedVLAType(); 942 VLASizeMap[VAT->getSizeExpr()] = ExprArg; 943 } 944 } 945 } else { 946 // Not in a lambda; just use 'this' from the method. 947 // FIXME: Should we generate a new load for each use of 'this'? The 948 // fast register allocator would be happier... 949 CXXThisValue = CXXABIThisValue; 950 } 951 952 // Null-check the 'this' pointer once per function, if it's available. 953 if (CXXThisValue) { 954 SanitizerSet SkippedChecks; 955 SkippedChecks.set(SanitizerKind::Alignment, true); 956 SkippedChecks.set(SanitizerKind::ObjectSize, true); 957 EmitTypeCheck(TCK_Load, Loc, CXXThisValue, MD->getThisType(getContext()), 958 /*Alignment=*/CharUnits::Zero(), SkippedChecks); 959 } 960 } 961 962 // If any of the arguments have a variably modified type, make sure to 963 // emit the type size. 964 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end(); 965 i != e; ++i) { 966 const VarDecl *VD = *i; 967 968 // Dig out the type as written from ParmVarDecls; it's unclear whether 969 // the standard (C99 6.9.1p10) requires this, but we're following the 970 // precedent set by gcc. 971 QualType Ty; 972 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(VD)) 973 Ty = PVD->getOriginalType(); 974 else 975 Ty = VD->getType(); 976 977 if (Ty->isVariablyModifiedType()) 978 EmitVariablyModifiedType(Ty); 979 } 980 // Emit a location at the end of the prologue. 981 if (CGDebugInfo *DI = getDebugInfo()) 982 DI->EmitLocation(Builder, StartLoc); 983 } 984 985 void CodeGenFunction::EmitFunctionBody(FunctionArgList &Args, 986 const Stmt *Body) { 987 incrementProfileCounter(Body); 988 if (const CompoundStmt *S = dyn_cast<CompoundStmt>(Body)) 989 EmitCompoundStmtWithoutScope(*S); 990 else 991 EmitStmt(Body); 992 } 993 994 /// When instrumenting to collect profile data, the counts for some blocks 995 /// such as switch cases need to not include the fall-through counts, so 996 /// emit a branch around the instrumentation code. When not instrumenting, 997 /// this just calls EmitBlock(). 998 void CodeGenFunction::EmitBlockWithFallThrough(llvm::BasicBlock *BB, 999 const Stmt *S) { 1000 llvm::BasicBlock *SkipCountBB = nullptr; 1001 if (HaveInsertPoint() && CGM.getCodeGenOpts().hasProfileClangInstr()) { 1002 // When instrumenting for profiling, the fallthrough to certain 1003 // statements needs to skip over the instrumentation code so that we 1004 // get an accurate count. 1005 SkipCountBB = createBasicBlock("skipcount"); 1006 EmitBranch(SkipCountBB); 1007 } 1008 EmitBlock(BB); 1009 uint64_t CurrentCount = getCurrentProfileCount(); 1010 incrementProfileCounter(S); 1011 setCurrentProfileCount(getCurrentProfileCount() + CurrentCount); 1012 if (SkipCountBB) 1013 EmitBlock(SkipCountBB); 1014 } 1015 1016 /// Tries to mark the given function nounwind based on the 1017 /// non-existence of any throwing calls within it. We believe this is 1018 /// lightweight enough to do at -O0. 1019 static void TryMarkNoThrow(llvm::Function *F) { 1020 // LLVM treats 'nounwind' on a function as part of the type, so we 1021 // can't do this on functions that can be overwritten. 1022 if (F->isInterposable()) return; 1023 1024 for (llvm::BasicBlock &BB : *F) 1025 for (llvm::Instruction &I : BB) 1026 if (I.mayThrow()) 1027 return; 1028 1029 F->setDoesNotThrow(); 1030 } 1031 1032 QualType CodeGenFunction::BuildFunctionArgList(GlobalDecl GD, 1033 FunctionArgList &Args) { 1034 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl()); 1035 QualType ResTy = FD->getReturnType(); 1036 1037 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD); 1038 if (MD && MD->isInstance()) { 1039 if (CGM.getCXXABI().HasThisReturn(GD)) 1040 ResTy = MD->getThisType(getContext()); 1041 else if (CGM.getCXXABI().hasMostDerivedReturn(GD)) 1042 ResTy = CGM.getContext().VoidPtrTy; 1043 CGM.getCXXABI().buildThisParam(*this, Args); 1044 } 1045 1046 // The base version of an inheriting constructor whose constructed base is a 1047 // virtual base is not passed any arguments (because it doesn't actually call 1048 // the inherited constructor). 1049 bool PassedParams = true; 1050 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD)) 1051 if (auto Inherited = CD->getInheritedConstructor()) 1052 PassedParams = 1053 getTypes().inheritingCtorHasParams(Inherited, GD.getCtorType()); 1054 1055 if (PassedParams) { 1056 for (auto *Param : FD->parameters()) { 1057 Args.push_back(Param); 1058 if (!Param->hasAttr<PassObjectSizeAttr>()) 1059 continue; 1060 1061 IdentifierInfo *NoID = nullptr; 1062 auto *Implicit = ImplicitParamDecl::Create( 1063 getContext(), Param->getDeclContext(), Param->getLocation(), NoID, 1064 getContext().getSizeType()); 1065 SizeArguments[Param] = Implicit; 1066 Args.push_back(Implicit); 1067 } 1068 } 1069 1070 if (MD && (isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD))) 1071 CGM.getCXXABI().addImplicitStructorParams(*this, ResTy, Args); 1072 1073 return ResTy; 1074 } 1075 1076 static bool 1077 shouldUseUndefinedBehaviorReturnOptimization(const FunctionDecl *FD, 1078 const ASTContext &Context) { 1079 QualType T = FD->getReturnType(); 1080 // Avoid the optimization for functions that return a record type with a 1081 // trivial destructor or another trivially copyable type. 1082 if (const RecordType *RT = T.getCanonicalType()->getAs<RecordType>()) { 1083 if (const auto *ClassDecl = dyn_cast<CXXRecordDecl>(RT->getDecl())) 1084 return !ClassDecl->hasTrivialDestructor(); 1085 } 1086 return !T.isTriviallyCopyableType(Context); 1087 } 1088 1089 void CodeGenFunction::GenerateCode(GlobalDecl GD, llvm::Function *Fn, 1090 const CGFunctionInfo &FnInfo) { 1091 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl()); 1092 CurGD = GD; 1093 1094 FunctionArgList Args; 1095 QualType ResTy = BuildFunctionArgList(GD, Args); 1096 1097 // Check if we should generate debug info for this function. 1098 if (FD->hasAttr<NoDebugAttr>()) 1099 DebugInfo = nullptr; // disable debug info indefinitely for this function 1100 1101 // The function might not have a body if we're generating thunks for a 1102 // function declaration. 1103 SourceRange BodyRange; 1104 if (Stmt *Body = FD->getBody()) 1105 BodyRange = Body->getSourceRange(); 1106 else 1107 BodyRange = FD->getLocation(); 1108 CurEHLocation = BodyRange.getEnd(); 1109 1110 // Use the location of the start of the function to determine where 1111 // the function definition is located. By default use the location 1112 // of the declaration as the location for the subprogram. A function 1113 // may lack a declaration in the source code if it is created by code 1114 // gen. (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk). 1115 SourceLocation Loc = FD->getLocation(); 1116 1117 // If this is a function specialization then use the pattern body 1118 // as the location for the function. 1119 if (const FunctionDecl *SpecDecl = FD->getTemplateInstantiationPattern()) 1120 if (SpecDecl->hasBody(SpecDecl)) 1121 Loc = SpecDecl->getLocation(); 1122 1123 Stmt *Body = FD->getBody(); 1124 1125 // Initialize helper which will detect jumps which can cause invalid lifetime 1126 // markers. 1127 if (Body && ShouldEmitLifetimeMarkers) 1128 Bypasses.Init(Body); 1129 1130 // Emit the standard function prologue. 1131 StartFunction(GD, ResTy, Fn, FnInfo, Args, Loc, BodyRange.getBegin()); 1132 1133 // Generate the body of the function. 1134 PGO.assignRegionCounters(GD, CurFn); 1135 if (isa<CXXDestructorDecl>(FD)) 1136 EmitDestructorBody(Args); 1137 else if (isa<CXXConstructorDecl>(FD)) 1138 EmitConstructorBody(Args); 1139 else if (getLangOpts().CUDA && 1140 !getLangOpts().CUDAIsDevice && 1141 FD->hasAttr<CUDAGlobalAttr>()) 1142 CGM.getCUDARuntime().emitDeviceStub(*this, Args); 1143 else if (isa<CXXConversionDecl>(FD) && 1144 cast<CXXConversionDecl>(FD)->isLambdaToBlockPointerConversion()) { 1145 // The lambda conversion to block pointer is special; the semantics can't be 1146 // expressed in the AST, so IRGen needs to special-case it. 1147 EmitLambdaToBlockPointerBody(Args); 1148 } else if (isa<CXXMethodDecl>(FD) && 1149 cast<CXXMethodDecl>(FD)->isLambdaStaticInvoker()) { 1150 // The lambda static invoker function is special, because it forwards or 1151 // clones the body of the function call operator (but is actually static). 1152 EmitLambdaStaticInvokeFunction(cast<CXXMethodDecl>(FD)); 1153 } else if (FD->isDefaulted() && isa<CXXMethodDecl>(FD) && 1154 (cast<CXXMethodDecl>(FD)->isCopyAssignmentOperator() || 1155 cast<CXXMethodDecl>(FD)->isMoveAssignmentOperator())) { 1156 // Implicit copy-assignment gets the same special treatment as implicit 1157 // copy-constructors. 1158 emitImplicitAssignmentOperatorBody(Args); 1159 } else if (Body) { 1160 EmitFunctionBody(Args, Body); 1161 } else 1162 llvm_unreachable("no definition for emitted function"); 1163 1164 // C++11 [stmt.return]p2: 1165 // Flowing off the end of a function [...] results in undefined behavior in 1166 // a value-returning function. 1167 // C11 6.9.1p12: 1168 // If the '}' that terminates a function is reached, and the value of the 1169 // function call is used by the caller, the behavior is undefined. 1170 if (getLangOpts().CPlusPlus && !FD->hasImplicitReturnZero() && !SawAsmBlock && 1171 !FD->getReturnType()->isVoidType() && Builder.GetInsertBlock()) { 1172 bool ShouldEmitUnreachable = 1173 CGM.getCodeGenOpts().StrictReturn || 1174 shouldUseUndefinedBehaviorReturnOptimization(FD, getContext()); 1175 if (SanOpts.has(SanitizerKind::Return)) { 1176 SanitizerScope SanScope(this); 1177 llvm::Value *IsFalse = Builder.getFalse(); 1178 EmitCheck(std::make_pair(IsFalse, SanitizerKind::Return), 1179 SanitizerHandler::MissingReturn, 1180 EmitCheckSourceLocation(FD->getLocation()), None); 1181 } else if (ShouldEmitUnreachable) { 1182 if (CGM.getCodeGenOpts().OptimizationLevel == 0) 1183 EmitTrapCall(llvm::Intrinsic::trap); 1184 } 1185 if (SanOpts.has(SanitizerKind::Return) || ShouldEmitUnreachable) { 1186 Builder.CreateUnreachable(); 1187 Builder.ClearInsertionPoint(); 1188 } 1189 } 1190 1191 // Emit the standard function epilogue. 1192 FinishFunction(BodyRange.getEnd()); 1193 1194 // If we haven't marked the function nothrow through other means, do 1195 // a quick pass now to see if we can. 1196 if (!CurFn->doesNotThrow()) 1197 TryMarkNoThrow(CurFn); 1198 } 1199 1200 /// ContainsLabel - Return true if the statement contains a label in it. If 1201 /// this statement is not executed normally, it not containing a label means 1202 /// that we can just remove the code. 1203 bool CodeGenFunction::ContainsLabel(const Stmt *S, bool IgnoreCaseStmts) { 1204 // Null statement, not a label! 1205 if (!S) return false; 1206 1207 // If this is a label, we have to emit the code, consider something like: 1208 // if (0) { ... foo: bar(); } goto foo; 1209 // 1210 // TODO: If anyone cared, we could track __label__'s, since we know that you 1211 // can't jump to one from outside their declared region. 1212 if (isa<LabelStmt>(S)) 1213 return true; 1214 1215 // If this is a case/default statement, and we haven't seen a switch, we have 1216 // to emit the code. 1217 if (isa<SwitchCase>(S) && !IgnoreCaseStmts) 1218 return true; 1219 1220 // If this is a switch statement, we want to ignore cases below it. 1221 if (isa<SwitchStmt>(S)) 1222 IgnoreCaseStmts = true; 1223 1224 // Scan subexpressions for verboten labels. 1225 for (const Stmt *SubStmt : S->children()) 1226 if (ContainsLabel(SubStmt, IgnoreCaseStmts)) 1227 return true; 1228 1229 return false; 1230 } 1231 1232 /// containsBreak - Return true if the statement contains a break out of it. 1233 /// If the statement (recursively) contains a switch or loop with a break 1234 /// inside of it, this is fine. 1235 bool CodeGenFunction::containsBreak(const Stmt *S) { 1236 // Null statement, not a label! 1237 if (!S) return false; 1238 1239 // If this is a switch or loop that defines its own break scope, then we can 1240 // include it and anything inside of it. 1241 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || isa<DoStmt>(S) || 1242 isa<ForStmt>(S)) 1243 return false; 1244 1245 if (isa<BreakStmt>(S)) 1246 return true; 1247 1248 // Scan subexpressions for verboten breaks. 1249 for (const Stmt *SubStmt : S->children()) 1250 if (containsBreak(SubStmt)) 1251 return true; 1252 1253 return false; 1254 } 1255 1256 bool CodeGenFunction::mightAddDeclToScope(const Stmt *S) { 1257 if (!S) return false; 1258 1259 // Some statement kinds add a scope and thus never add a decl to the current 1260 // scope. Note, this list is longer than the list of statements that might 1261 // have an unscoped decl nested within them, but this way is conservatively 1262 // correct even if more statement kinds are added. 1263 if (isa<IfStmt>(S) || isa<SwitchStmt>(S) || isa<WhileStmt>(S) || 1264 isa<DoStmt>(S) || isa<ForStmt>(S) || isa<CompoundStmt>(S) || 1265 isa<CXXForRangeStmt>(S) || isa<CXXTryStmt>(S) || 1266 isa<ObjCForCollectionStmt>(S) || isa<ObjCAtTryStmt>(S)) 1267 return false; 1268 1269 if (isa<DeclStmt>(S)) 1270 return true; 1271 1272 for (const Stmt *SubStmt : S->children()) 1273 if (mightAddDeclToScope(SubStmt)) 1274 return true; 1275 1276 return false; 1277 } 1278 1279 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold 1280 /// to a constant, or if it does but contains a label, return false. If it 1281 /// constant folds return true and set the boolean result in Result. 1282 bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond, 1283 bool &ResultBool, 1284 bool AllowLabels) { 1285 llvm::APSInt ResultInt; 1286 if (!ConstantFoldsToSimpleInteger(Cond, ResultInt, AllowLabels)) 1287 return false; 1288 1289 ResultBool = ResultInt.getBoolValue(); 1290 return true; 1291 } 1292 1293 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold 1294 /// to a constant, or if it does but contains a label, return false. If it 1295 /// constant folds return true and set the folded value. 1296 bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond, 1297 llvm::APSInt &ResultInt, 1298 bool AllowLabels) { 1299 // FIXME: Rename and handle conversion of other evaluatable things 1300 // to bool. 1301 llvm::APSInt Int; 1302 if (!Cond->EvaluateAsInt(Int, getContext())) 1303 return false; // Not foldable, not integer or not fully evaluatable. 1304 1305 if (!AllowLabels && CodeGenFunction::ContainsLabel(Cond)) 1306 return false; // Contains a label. 1307 1308 ResultInt = Int; 1309 return true; 1310 } 1311 1312 1313 1314 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an if 1315 /// statement) to the specified blocks. Based on the condition, this might try 1316 /// to simplify the codegen of the conditional based on the branch. 1317 /// 1318 void CodeGenFunction::EmitBranchOnBoolExpr(const Expr *Cond, 1319 llvm::BasicBlock *TrueBlock, 1320 llvm::BasicBlock *FalseBlock, 1321 uint64_t TrueCount) { 1322 Cond = Cond->IgnoreParens(); 1323 1324 if (const BinaryOperator *CondBOp = dyn_cast<BinaryOperator>(Cond)) { 1325 1326 // Handle X && Y in a condition. 1327 if (CondBOp->getOpcode() == BO_LAnd) { 1328 // If we have "1 && X", simplify the code. "0 && X" would have constant 1329 // folded if the case was simple enough. 1330 bool ConstantBool = false; 1331 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) && 1332 ConstantBool) { 1333 // br(1 && X) -> br(X). 1334 incrementProfileCounter(CondBOp); 1335 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, 1336 TrueCount); 1337 } 1338 1339 // If we have "X && 1", simplify the code to use an uncond branch. 1340 // "X && 0" would have been constant folded to 0. 1341 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) && 1342 ConstantBool) { 1343 // br(X && 1) -> br(X). 1344 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock, 1345 TrueCount); 1346 } 1347 1348 // Emit the LHS as a conditional. If the LHS conditional is false, we 1349 // want to jump to the FalseBlock. 1350 llvm::BasicBlock *LHSTrue = createBasicBlock("land.lhs.true"); 1351 // The counter tells us how often we evaluate RHS, and all of TrueCount 1352 // can be propagated to that branch. 1353 uint64_t RHSCount = getProfileCount(CondBOp->getRHS()); 1354 1355 ConditionalEvaluation eval(*this); 1356 { 1357 ApplyDebugLocation DL(*this, Cond); 1358 EmitBranchOnBoolExpr(CondBOp->getLHS(), LHSTrue, FalseBlock, RHSCount); 1359 EmitBlock(LHSTrue); 1360 } 1361 1362 incrementProfileCounter(CondBOp); 1363 setCurrentProfileCount(getProfileCount(CondBOp->getRHS())); 1364 1365 // Any temporaries created here are conditional. 1366 eval.begin(*this); 1367 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, TrueCount); 1368 eval.end(*this); 1369 1370 return; 1371 } 1372 1373 if (CondBOp->getOpcode() == BO_LOr) { 1374 // If we have "0 || X", simplify the code. "1 || X" would have constant 1375 // folded if the case was simple enough. 1376 bool ConstantBool = false; 1377 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) && 1378 !ConstantBool) { 1379 // br(0 || X) -> br(X). 1380 incrementProfileCounter(CondBOp); 1381 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, 1382 TrueCount); 1383 } 1384 1385 // If we have "X || 0", simplify the code to use an uncond branch. 1386 // "X || 1" would have been constant folded to 1. 1387 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) && 1388 !ConstantBool) { 1389 // br(X || 0) -> br(X). 1390 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock, 1391 TrueCount); 1392 } 1393 1394 // Emit the LHS as a conditional. If the LHS conditional is true, we 1395 // want to jump to the TrueBlock. 1396 llvm::BasicBlock *LHSFalse = createBasicBlock("lor.lhs.false"); 1397 // We have the count for entry to the RHS and for the whole expression 1398 // being true, so we can divy up True count between the short circuit and 1399 // the RHS. 1400 uint64_t LHSCount = 1401 getCurrentProfileCount() - getProfileCount(CondBOp->getRHS()); 1402 uint64_t RHSCount = TrueCount - LHSCount; 1403 1404 ConditionalEvaluation eval(*this); 1405 { 1406 ApplyDebugLocation DL(*this, Cond); 1407 EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, LHSFalse, LHSCount); 1408 EmitBlock(LHSFalse); 1409 } 1410 1411 incrementProfileCounter(CondBOp); 1412 setCurrentProfileCount(getProfileCount(CondBOp->getRHS())); 1413 1414 // Any temporaries created here are conditional. 1415 eval.begin(*this); 1416 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, RHSCount); 1417 1418 eval.end(*this); 1419 1420 return; 1421 } 1422 } 1423 1424 if (const UnaryOperator *CondUOp = dyn_cast<UnaryOperator>(Cond)) { 1425 // br(!x, t, f) -> br(x, f, t) 1426 if (CondUOp->getOpcode() == UO_LNot) { 1427 // Negate the count. 1428 uint64_t FalseCount = getCurrentProfileCount() - TrueCount; 1429 // Negate the condition and swap the destination blocks. 1430 return EmitBranchOnBoolExpr(CondUOp->getSubExpr(), FalseBlock, TrueBlock, 1431 FalseCount); 1432 } 1433 } 1434 1435 if (const ConditionalOperator *CondOp = dyn_cast<ConditionalOperator>(Cond)) { 1436 // br(c ? x : y, t, f) -> br(c, br(x, t, f), br(y, t, f)) 1437 llvm::BasicBlock *LHSBlock = createBasicBlock("cond.true"); 1438 llvm::BasicBlock *RHSBlock = createBasicBlock("cond.false"); 1439 1440 ConditionalEvaluation cond(*this); 1441 EmitBranchOnBoolExpr(CondOp->getCond(), LHSBlock, RHSBlock, 1442 getProfileCount(CondOp)); 1443 1444 // When computing PGO branch weights, we only know the overall count for 1445 // the true block. This code is essentially doing tail duplication of the 1446 // naive code-gen, introducing new edges for which counts are not 1447 // available. Divide the counts proportionally between the LHS and RHS of 1448 // the conditional operator. 1449 uint64_t LHSScaledTrueCount = 0; 1450 if (TrueCount) { 1451 double LHSRatio = 1452 getProfileCount(CondOp) / (double)getCurrentProfileCount(); 1453 LHSScaledTrueCount = TrueCount * LHSRatio; 1454 } 1455 1456 cond.begin(*this); 1457 EmitBlock(LHSBlock); 1458 incrementProfileCounter(CondOp); 1459 { 1460 ApplyDebugLocation DL(*this, Cond); 1461 EmitBranchOnBoolExpr(CondOp->getLHS(), TrueBlock, FalseBlock, 1462 LHSScaledTrueCount); 1463 } 1464 cond.end(*this); 1465 1466 cond.begin(*this); 1467 EmitBlock(RHSBlock); 1468 EmitBranchOnBoolExpr(CondOp->getRHS(), TrueBlock, FalseBlock, 1469 TrueCount - LHSScaledTrueCount); 1470 cond.end(*this); 1471 1472 return; 1473 } 1474 1475 if (const CXXThrowExpr *Throw = dyn_cast<CXXThrowExpr>(Cond)) { 1476 // Conditional operator handling can give us a throw expression as a 1477 // condition for a case like: 1478 // br(c ? throw x : y, t, f) -> br(c, br(throw x, t, f), br(y, t, f) 1479 // Fold this to: 1480 // br(c, throw x, br(y, t, f)) 1481 EmitCXXThrowExpr(Throw, /*KeepInsertionPoint*/false); 1482 return; 1483 } 1484 1485 // If the branch has a condition wrapped by __builtin_unpredictable, 1486 // create metadata that specifies that the branch is unpredictable. 1487 // Don't bother if not optimizing because that metadata would not be used. 1488 llvm::MDNode *Unpredictable = nullptr; 1489 auto *Call = dyn_cast<CallExpr>(Cond); 1490 if (Call && CGM.getCodeGenOpts().OptimizationLevel != 0) { 1491 auto *FD = dyn_cast_or_null<FunctionDecl>(Call->getCalleeDecl()); 1492 if (FD && FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) { 1493 llvm::MDBuilder MDHelper(getLLVMContext()); 1494 Unpredictable = MDHelper.createUnpredictable(); 1495 } 1496 } 1497 1498 // Create branch weights based on the number of times we get here and the 1499 // number of times the condition should be true. 1500 uint64_t CurrentCount = std::max(getCurrentProfileCount(), TrueCount); 1501 llvm::MDNode *Weights = 1502 createProfileWeights(TrueCount, CurrentCount - TrueCount); 1503 1504 // Emit the code with the fully general case. 1505 llvm::Value *CondV; 1506 { 1507 ApplyDebugLocation DL(*this, Cond); 1508 CondV = EvaluateExprAsBool(Cond); 1509 } 1510 Builder.CreateCondBr(CondV, TrueBlock, FalseBlock, Weights, Unpredictable); 1511 } 1512 1513 /// ErrorUnsupported - Print out an error that codegen doesn't support the 1514 /// specified stmt yet. 1515 void CodeGenFunction::ErrorUnsupported(const Stmt *S, const char *Type) { 1516 CGM.ErrorUnsupported(S, Type); 1517 } 1518 1519 /// emitNonZeroVLAInit - Emit the "zero" initialization of a 1520 /// variable-length array whose elements have a non-zero bit-pattern. 1521 /// 1522 /// \param baseType the inner-most element type of the array 1523 /// \param src - a char* pointing to the bit-pattern for a single 1524 /// base element of the array 1525 /// \param sizeInChars - the total size of the VLA, in chars 1526 static void emitNonZeroVLAInit(CodeGenFunction &CGF, QualType baseType, 1527 Address dest, Address src, 1528 llvm::Value *sizeInChars) { 1529 CGBuilderTy &Builder = CGF.Builder; 1530 1531 CharUnits baseSize = CGF.getContext().getTypeSizeInChars(baseType); 1532 llvm::Value *baseSizeInChars 1533 = llvm::ConstantInt::get(CGF.IntPtrTy, baseSize.getQuantity()); 1534 1535 Address begin = 1536 Builder.CreateElementBitCast(dest, CGF.Int8Ty, "vla.begin"); 1537 llvm::Value *end = 1538 Builder.CreateInBoundsGEP(begin.getPointer(), sizeInChars, "vla.end"); 1539 1540 llvm::BasicBlock *originBB = CGF.Builder.GetInsertBlock(); 1541 llvm::BasicBlock *loopBB = CGF.createBasicBlock("vla-init.loop"); 1542 llvm::BasicBlock *contBB = CGF.createBasicBlock("vla-init.cont"); 1543 1544 // Make a loop over the VLA. C99 guarantees that the VLA element 1545 // count must be nonzero. 1546 CGF.EmitBlock(loopBB); 1547 1548 llvm::PHINode *cur = Builder.CreatePHI(begin.getType(), 2, "vla.cur"); 1549 cur->addIncoming(begin.getPointer(), originBB); 1550 1551 CharUnits curAlign = 1552 dest.getAlignment().alignmentOfArrayElement(baseSize); 1553 1554 // memcpy the individual element bit-pattern. 1555 Builder.CreateMemCpy(Address(cur, curAlign), src, baseSizeInChars, 1556 /*volatile*/ false); 1557 1558 // Go to the next element. 1559 llvm::Value *next = 1560 Builder.CreateInBoundsGEP(CGF.Int8Ty, cur, baseSizeInChars, "vla.next"); 1561 1562 // Leave if that's the end of the VLA. 1563 llvm::Value *done = Builder.CreateICmpEQ(next, end, "vla-init.isdone"); 1564 Builder.CreateCondBr(done, contBB, loopBB); 1565 cur->addIncoming(next, loopBB); 1566 1567 CGF.EmitBlock(contBB); 1568 } 1569 1570 void 1571 CodeGenFunction::EmitNullInitialization(Address DestPtr, QualType Ty) { 1572 // Ignore empty classes in C++. 1573 if (getLangOpts().CPlusPlus) { 1574 if (const RecordType *RT = Ty->getAs<RecordType>()) { 1575 if (cast<CXXRecordDecl>(RT->getDecl())->isEmpty()) 1576 return; 1577 } 1578 } 1579 1580 // Cast the dest ptr to the appropriate i8 pointer type. 1581 if (DestPtr.getElementType() != Int8Ty) 1582 DestPtr = Builder.CreateElementBitCast(DestPtr, Int8Ty); 1583 1584 // Get size and alignment info for this aggregate. 1585 CharUnits size = getContext().getTypeSizeInChars(Ty); 1586 1587 llvm::Value *SizeVal; 1588 const VariableArrayType *vla; 1589 1590 // Don't bother emitting a zero-byte memset. 1591 if (size.isZero()) { 1592 // But note that getTypeInfo returns 0 for a VLA. 1593 if (const VariableArrayType *vlaType = 1594 dyn_cast_or_null<VariableArrayType>( 1595 getContext().getAsArrayType(Ty))) { 1596 QualType eltType; 1597 llvm::Value *numElts; 1598 std::tie(numElts, eltType) = getVLASize(vlaType); 1599 1600 SizeVal = numElts; 1601 CharUnits eltSize = getContext().getTypeSizeInChars(eltType); 1602 if (!eltSize.isOne()) 1603 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(eltSize)); 1604 vla = vlaType; 1605 } else { 1606 return; 1607 } 1608 } else { 1609 SizeVal = CGM.getSize(size); 1610 vla = nullptr; 1611 } 1612 1613 // If the type contains a pointer to data member we can't memset it to zero. 1614 // Instead, create a null constant and copy it to the destination. 1615 // TODO: there are other patterns besides zero that we can usefully memset, 1616 // like -1, which happens to be the pattern used by member-pointers. 1617 if (!CGM.getTypes().isZeroInitializable(Ty)) { 1618 // For a VLA, emit a single element, then splat that over the VLA. 1619 if (vla) Ty = getContext().getBaseElementType(vla); 1620 1621 llvm::Constant *NullConstant = CGM.EmitNullConstant(Ty); 1622 1623 llvm::GlobalVariable *NullVariable = 1624 new llvm::GlobalVariable(CGM.getModule(), NullConstant->getType(), 1625 /*isConstant=*/true, 1626 llvm::GlobalVariable::PrivateLinkage, 1627 NullConstant, Twine()); 1628 CharUnits NullAlign = DestPtr.getAlignment(); 1629 NullVariable->setAlignment(NullAlign.getQuantity()); 1630 Address SrcPtr(Builder.CreateBitCast(NullVariable, Builder.getInt8PtrTy()), 1631 NullAlign); 1632 1633 if (vla) return emitNonZeroVLAInit(*this, Ty, DestPtr, SrcPtr, SizeVal); 1634 1635 // Get and call the appropriate llvm.memcpy overload. 1636 Builder.CreateMemCpy(DestPtr, SrcPtr, SizeVal, false); 1637 return; 1638 } 1639 1640 // Otherwise, just memset the whole thing to zero. This is legal 1641 // because in LLVM, all default initializers (other than the ones we just 1642 // handled above) are guaranteed to have a bit pattern of all zeros. 1643 Builder.CreateMemSet(DestPtr, Builder.getInt8(0), SizeVal, false); 1644 } 1645 1646 llvm::BlockAddress *CodeGenFunction::GetAddrOfLabel(const LabelDecl *L) { 1647 // Make sure that there is a block for the indirect goto. 1648 if (!IndirectBranch) 1649 GetIndirectGotoBlock(); 1650 1651 llvm::BasicBlock *BB = getJumpDestForLabel(L).getBlock(); 1652 1653 // Make sure the indirect branch includes all of the address-taken blocks. 1654 IndirectBranch->addDestination(BB); 1655 return llvm::BlockAddress::get(CurFn, BB); 1656 } 1657 1658 llvm::BasicBlock *CodeGenFunction::GetIndirectGotoBlock() { 1659 // If we already made the indirect branch for indirect goto, return its block. 1660 if (IndirectBranch) return IndirectBranch->getParent(); 1661 1662 CGBuilderTy TmpBuilder(*this, createBasicBlock("indirectgoto")); 1663 1664 // Create the PHI node that indirect gotos will add entries to. 1665 llvm::Value *DestVal = TmpBuilder.CreatePHI(Int8PtrTy, 0, 1666 "indirect.goto.dest"); 1667 1668 // Create the indirect branch instruction. 1669 IndirectBranch = TmpBuilder.CreateIndirectBr(DestVal); 1670 return IndirectBranch->getParent(); 1671 } 1672 1673 /// Computes the length of an array in elements, as well as the base 1674 /// element type and a properly-typed first element pointer. 1675 llvm::Value *CodeGenFunction::emitArrayLength(const ArrayType *origArrayType, 1676 QualType &baseType, 1677 Address &addr) { 1678 const ArrayType *arrayType = origArrayType; 1679 1680 // If it's a VLA, we have to load the stored size. Note that 1681 // this is the size of the VLA in bytes, not its size in elements. 1682 llvm::Value *numVLAElements = nullptr; 1683 if (isa<VariableArrayType>(arrayType)) { 1684 numVLAElements = getVLASize(cast<VariableArrayType>(arrayType)).first; 1685 1686 // Walk into all VLAs. This doesn't require changes to addr, 1687 // which has type T* where T is the first non-VLA element type. 1688 do { 1689 QualType elementType = arrayType->getElementType(); 1690 arrayType = getContext().getAsArrayType(elementType); 1691 1692 // If we only have VLA components, 'addr' requires no adjustment. 1693 if (!arrayType) { 1694 baseType = elementType; 1695 return numVLAElements; 1696 } 1697 } while (isa<VariableArrayType>(arrayType)); 1698 1699 // We get out here only if we find a constant array type 1700 // inside the VLA. 1701 } 1702 1703 // We have some number of constant-length arrays, so addr should 1704 // have LLVM type [M x [N x [...]]]*. Build a GEP that walks 1705 // down to the first element of addr. 1706 SmallVector<llvm::Value*, 8> gepIndices; 1707 1708 // GEP down to the array type. 1709 llvm::ConstantInt *zero = Builder.getInt32(0); 1710 gepIndices.push_back(zero); 1711 1712 uint64_t countFromCLAs = 1; 1713 QualType eltType; 1714 1715 llvm::ArrayType *llvmArrayType = 1716 dyn_cast<llvm::ArrayType>(addr.getElementType()); 1717 while (llvmArrayType) { 1718 assert(isa<ConstantArrayType>(arrayType)); 1719 assert(cast<ConstantArrayType>(arrayType)->getSize().getZExtValue() 1720 == llvmArrayType->getNumElements()); 1721 1722 gepIndices.push_back(zero); 1723 countFromCLAs *= llvmArrayType->getNumElements(); 1724 eltType = arrayType->getElementType(); 1725 1726 llvmArrayType = 1727 dyn_cast<llvm::ArrayType>(llvmArrayType->getElementType()); 1728 arrayType = getContext().getAsArrayType(arrayType->getElementType()); 1729 assert((!llvmArrayType || arrayType) && 1730 "LLVM and Clang types are out-of-synch"); 1731 } 1732 1733 if (arrayType) { 1734 // From this point onwards, the Clang array type has been emitted 1735 // as some other type (probably a packed struct). Compute the array 1736 // size, and just emit the 'begin' expression as a bitcast. 1737 while (arrayType) { 1738 countFromCLAs *= 1739 cast<ConstantArrayType>(arrayType)->getSize().getZExtValue(); 1740 eltType = arrayType->getElementType(); 1741 arrayType = getContext().getAsArrayType(eltType); 1742 } 1743 1744 llvm::Type *baseType = ConvertType(eltType); 1745 addr = Builder.CreateElementBitCast(addr, baseType, "array.begin"); 1746 } else { 1747 // Create the actual GEP. 1748 addr = Address(Builder.CreateInBoundsGEP(addr.getPointer(), 1749 gepIndices, "array.begin"), 1750 addr.getAlignment()); 1751 } 1752 1753 baseType = eltType; 1754 1755 llvm::Value *numElements 1756 = llvm::ConstantInt::get(SizeTy, countFromCLAs); 1757 1758 // If we had any VLA dimensions, factor them in. 1759 if (numVLAElements) 1760 numElements = Builder.CreateNUWMul(numVLAElements, numElements); 1761 1762 return numElements; 1763 } 1764 1765 std::pair<llvm::Value*, QualType> 1766 CodeGenFunction::getVLASize(QualType type) { 1767 const VariableArrayType *vla = getContext().getAsVariableArrayType(type); 1768 assert(vla && "type was not a variable array type!"); 1769 return getVLASize(vla); 1770 } 1771 1772 std::pair<llvm::Value*, QualType> 1773 CodeGenFunction::getVLASize(const VariableArrayType *type) { 1774 // The number of elements so far; always size_t. 1775 llvm::Value *numElements = nullptr; 1776 1777 QualType elementType; 1778 do { 1779 elementType = type->getElementType(); 1780 llvm::Value *vlaSize = VLASizeMap[type->getSizeExpr()]; 1781 assert(vlaSize && "no size for VLA!"); 1782 assert(vlaSize->getType() == SizeTy); 1783 1784 if (!numElements) { 1785 numElements = vlaSize; 1786 } else { 1787 // It's undefined behavior if this wraps around, so mark it that way. 1788 // FIXME: Teach -fsanitize=undefined to trap this. 1789 numElements = Builder.CreateNUWMul(numElements, vlaSize); 1790 } 1791 } while ((type = getContext().getAsVariableArrayType(elementType))); 1792 1793 return std::pair<llvm::Value*,QualType>(numElements, elementType); 1794 } 1795 1796 void CodeGenFunction::EmitVariablyModifiedType(QualType type) { 1797 assert(type->isVariablyModifiedType() && 1798 "Must pass variably modified type to EmitVLASizes!"); 1799 1800 EnsureInsertPoint(); 1801 1802 // We're going to walk down into the type and look for VLA 1803 // expressions. 1804 do { 1805 assert(type->isVariablyModifiedType()); 1806 1807 const Type *ty = type.getTypePtr(); 1808 switch (ty->getTypeClass()) { 1809 1810 #define TYPE(Class, Base) 1811 #define ABSTRACT_TYPE(Class, Base) 1812 #define NON_CANONICAL_TYPE(Class, Base) 1813 #define DEPENDENT_TYPE(Class, Base) case Type::Class: 1814 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base) 1815 #include "clang/AST/TypeNodes.def" 1816 llvm_unreachable("unexpected dependent type!"); 1817 1818 // These types are never variably-modified. 1819 case Type::Builtin: 1820 case Type::Complex: 1821 case Type::Vector: 1822 case Type::ExtVector: 1823 case Type::Record: 1824 case Type::Enum: 1825 case Type::Elaborated: 1826 case Type::TemplateSpecialization: 1827 case Type::ObjCTypeParam: 1828 case Type::ObjCObject: 1829 case Type::ObjCInterface: 1830 case Type::ObjCObjectPointer: 1831 llvm_unreachable("type class is never variably-modified!"); 1832 1833 case Type::Adjusted: 1834 type = cast<AdjustedType>(ty)->getAdjustedType(); 1835 break; 1836 1837 case Type::Decayed: 1838 type = cast<DecayedType>(ty)->getPointeeType(); 1839 break; 1840 1841 case Type::Pointer: 1842 type = cast<PointerType>(ty)->getPointeeType(); 1843 break; 1844 1845 case Type::BlockPointer: 1846 type = cast<BlockPointerType>(ty)->getPointeeType(); 1847 break; 1848 1849 case Type::LValueReference: 1850 case Type::RValueReference: 1851 type = cast<ReferenceType>(ty)->getPointeeType(); 1852 break; 1853 1854 case Type::MemberPointer: 1855 type = cast<MemberPointerType>(ty)->getPointeeType(); 1856 break; 1857 1858 case Type::ConstantArray: 1859 case Type::IncompleteArray: 1860 // Losing element qualification here is fine. 1861 type = cast<ArrayType>(ty)->getElementType(); 1862 break; 1863 1864 case Type::VariableArray: { 1865 // Losing element qualification here is fine. 1866 const VariableArrayType *vat = cast<VariableArrayType>(ty); 1867 1868 // Unknown size indication requires no size computation. 1869 // Otherwise, evaluate and record it. 1870 if (const Expr *size = vat->getSizeExpr()) { 1871 // It's possible that we might have emitted this already, 1872 // e.g. with a typedef and a pointer to it. 1873 llvm::Value *&entry = VLASizeMap[size]; 1874 if (!entry) { 1875 llvm::Value *Size = EmitScalarExpr(size); 1876 1877 // C11 6.7.6.2p5: 1878 // If the size is an expression that is not an integer constant 1879 // expression [...] each time it is evaluated it shall have a value 1880 // greater than zero. 1881 if (SanOpts.has(SanitizerKind::VLABound) && 1882 size->getType()->isSignedIntegerType()) { 1883 SanitizerScope SanScope(this); 1884 llvm::Value *Zero = llvm::Constant::getNullValue(Size->getType()); 1885 llvm::Constant *StaticArgs[] = { 1886 EmitCheckSourceLocation(size->getLocStart()), 1887 EmitCheckTypeDescriptor(size->getType()) 1888 }; 1889 EmitCheck(std::make_pair(Builder.CreateICmpSGT(Size, Zero), 1890 SanitizerKind::VLABound), 1891 SanitizerHandler::VLABoundNotPositive, StaticArgs, Size); 1892 } 1893 1894 // Always zexting here would be wrong if it weren't 1895 // undefined behavior to have a negative bound. 1896 entry = Builder.CreateIntCast(Size, SizeTy, /*signed*/ false); 1897 } 1898 } 1899 type = vat->getElementType(); 1900 break; 1901 } 1902 1903 case Type::FunctionProto: 1904 case Type::FunctionNoProto: 1905 type = cast<FunctionType>(ty)->getReturnType(); 1906 break; 1907 1908 case Type::Paren: 1909 case Type::TypeOf: 1910 case Type::UnaryTransform: 1911 case Type::Attributed: 1912 case Type::SubstTemplateTypeParm: 1913 case Type::PackExpansion: 1914 // Keep walking after single level desugaring. 1915 type = type.getSingleStepDesugaredType(getContext()); 1916 break; 1917 1918 case Type::Typedef: 1919 case Type::Decltype: 1920 case Type::Auto: 1921 case Type::DeducedTemplateSpecialization: 1922 // Stop walking: nothing to do. 1923 return; 1924 1925 case Type::TypeOfExpr: 1926 // Stop walking: emit typeof expression. 1927 EmitIgnoredExpr(cast<TypeOfExprType>(ty)->getUnderlyingExpr()); 1928 return; 1929 1930 case Type::Atomic: 1931 type = cast<AtomicType>(ty)->getValueType(); 1932 break; 1933 1934 case Type::Pipe: 1935 type = cast<PipeType>(ty)->getElementType(); 1936 break; 1937 } 1938 } while (type->isVariablyModifiedType()); 1939 } 1940 1941 Address CodeGenFunction::EmitVAListRef(const Expr* E) { 1942 if (getContext().getBuiltinVaListType()->isArrayType()) 1943 return EmitPointerWithAlignment(E); 1944 return EmitLValue(E).getAddress(); 1945 } 1946 1947 Address CodeGenFunction::EmitMSVAListRef(const Expr *E) { 1948 return EmitLValue(E).getAddress(); 1949 } 1950 1951 void CodeGenFunction::EmitDeclRefExprDbgValue(const DeclRefExpr *E, 1952 const APValue &Init) { 1953 assert(!Init.isUninit() && "Invalid DeclRefExpr initializer!"); 1954 if (CGDebugInfo *Dbg = getDebugInfo()) 1955 if (CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo) 1956 Dbg->EmitGlobalVariable(E->getDecl(), Init); 1957 } 1958 1959 CodeGenFunction::PeepholeProtection 1960 CodeGenFunction::protectFromPeepholes(RValue rvalue) { 1961 // At the moment, the only aggressive peephole we do in IR gen 1962 // is trunc(zext) folding, but if we add more, we can easily 1963 // extend this protection. 1964 1965 if (!rvalue.isScalar()) return PeepholeProtection(); 1966 llvm::Value *value = rvalue.getScalarVal(); 1967 if (!isa<llvm::ZExtInst>(value)) return PeepholeProtection(); 1968 1969 // Just make an extra bitcast. 1970 assert(HaveInsertPoint()); 1971 llvm::Instruction *inst = new llvm::BitCastInst(value, value->getType(), "", 1972 Builder.GetInsertBlock()); 1973 1974 PeepholeProtection protection; 1975 protection.Inst = inst; 1976 return protection; 1977 } 1978 1979 void CodeGenFunction::unprotectFromPeepholes(PeepholeProtection protection) { 1980 if (!protection.Inst) return; 1981 1982 // In theory, we could try to duplicate the peepholes now, but whatever. 1983 protection.Inst->eraseFromParent(); 1984 } 1985 1986 llvm::Value *CodeGenFunction::EmitAnnotationCall(llvm::Value *AnnotationFn, 1987 llvm::Value *AnnotatedVal, 1988 StringRef AnnotationStr, 1989 SourceLocation Location) { 1990 llvm::Value *Args[4] = { 1991 AnnotatedVal, 1992 Builder.CreateBitCast(CGM.EmitAnnotationString(AnnotationStr), Int8PtrTy), 1993 Builder.CreateBitCast(CGM.EmitAnnotationUnit(Location), Int8PtrTy), 1994 CGM.EmitAnnotationLineNo(Location) 1995 }; 1996 return Builder.CreateCall(AnnotationFn, Args); 1997 } 1998 1999 void CodeGenFunction::EmitVarAnnotations(const VarDecl *D, llvm::Value *V) { 2000 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute"); 2001 // FIXME We create a new bitcast for every annotation because that's what 2002 // llvm-gcc was doing. 2003 for (const auto *I : D->specific_attrs<AnnotateAttr>()) 2004 EmitAnnotationCall(CGM.getIntrinsic(llvm::Intrinsic::var_annotation), 2005 Builder.CreateBitCast(V, CGM.Int8PtrTy, V->getName()), 2006 I->getAnnotation(), D->getLocation()); 2007 } 2008 2009 Address CodeGenFunction::EmitFieldAnnotations(const FieldDecl *D, 2010 Address Addr) { 2011 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute"); 2012 llvm::Value *V = Addr.getPointer(); 2013 llvm::Type *VTy = V->getType(); 2014 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::ptr_annotation, 2015 CGM.Int8PtrTy); 2016 2017 for (const auto *I : D->specific_attrs<AnnotateAttr>()) { 2018 // FIXME Always emit the cast inst so we can differentiate between 2019 // annotation on the first field of a struct and annotation on the struct 2020 // itself. 2021 if (VTy != CGM.Int8PtrTy) 2022 V = Builder.Insert(new llvm::BitCastInst(V, CGM.Int8PtrTy)); 2023 V = EmitAnnotationCall(F, V, I->getAnnotation(), D->getLocation()); 2024 V = Builder.CreateBitCast(V, VTy); 2025 } 2026 2027 return Address(V, Addr.getAlignment()); 2028 } 2029 2030 CodeGenFunction::CGCapturedStmtInfo::~CGCapturedStmtInfo() { } 2031 2032 CodeGenFunction::SanitizerScope::SanitizerScope(CodeGenFunction *CGF) 2033 : CGF(CGF) { 2034 assert(!CGF->IsSanitizerScope); 2035 CGF->IsSanitizerScope = true; 2036 } 2037 2038 CodeGenFunction::SanitizerScope::~SanitizerScope() { 2039 CGF->IsSanitizerScope = false; 2040 } 2041 2042 void CodeGenFunction::InsertHelper(llvm::Instruction *I, 2043 const llvm::Twine &Name, 2044 llvm::BasicBlock *BB, 2045 llvm::BasicBlock::iterator InsertPt) const { 2046 LoopStack.InsertHelper(I); 2047 if (IsSanitizerScope) 2048 CGM.getSanitizerMetadata()->disableSanitizerForInstruction(I); 2049 } 2050 2051 void CGBuilderInserter::InsertHelper( 2052 llvm::Instruction *I, const llvm::Twine &Name, llvm::BasicBlock *BB, 2053 llvm::BasicBlock::iterator InsertPt) const { 2054 llvm::IRBuilderDefaultInserter::InsertHelper(I, Name, BB, InsertPt); 2055 if (CGF) 2056 CGF->InsertHelper(I, Name, BB, InsertPt); 2057 } 2058 2059 static bool hasRequiredFeatures(const SmallVectorImpl<StringRef> &ReqFeatures, 2060 CodeGenModule &CGM, const FunctionDecl *FD, 2061 std::string &FirstMissing) { 2062 // If there aren't any required features listed then go ahead and return. 2063 if (ReqFeatures.empty()) 2064 return false; 2065 2066 // Now build up the set of caller features and verify that all the required 2067 // features are there. 2068 llvm::StringMap<bool> CallerFeatureMap; 2069 CGM.getFunctionFeatureMap(CallerFeatureMap, FD); 2070 2071 // If we have at least one of the features in the feature list return 2072 // true, otherwise return false. 2073 return std::all_of( 2074 ReqFeatures.begin(), ReqFeatures.end(), [&](StringRef Feature) { 2075 SmallVector<StringRef, 1> OrFeatures; 2076 Feature.split(OrFeatures, "|"); 2077 return std::any_of(OrFeatures.begin(), OrFeatures.end(), 2078 [&](StringRef Feature) { 2079 if (!CallerFeatureMap.lookup(Feature)) { 2080 FirstMissing = Feature.str(); 2081 return false; 2082 } 2083 return true; 2084 }); 2085 }); 2086 } 2087 2088 // Emits an error if we don't have a valid set of target features for the 2089 // called function. 2090 void CodeGenFunction::checkTargetFeatures(const CallExpr *E, 2091 const FunctionDecl *TargetDecl) { 2092 // Early exit if this is an indirect call. 2093 if (!TargetDecl) 2094 return; 2095 2096 // Get the current enclosing function if it exists. If it doesn't 2097 // we can't check the target features anyhow. 2098 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurFuncDecl); 2099 if (!FD) 2100 return; 2101 2102 // Grab the required features for the call. For a builtin this is listed in 2103 // the td file with the default cpu, for an always_inline function this is any 2104 // listed cpu and any listed features. 2105 unsigned BuiltinID = TargetDecl->getBuiltinID(); 2106 std::string MissingFeature; 2107 if (BuiltinID) { 2108 SmallVector<StringRef, 1> ReqFeatures; 2109 const char *FeatureList = 2110 CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID); 2111 // Return if the builtin doesn't have any required features. 2112 if (!FeatureList || StringRef(FeatureList) == "") 2113 return; 2114 StringRef(FeatureList).split(ReqFeatures, ","); 2115 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature)) 2116 CGM.getDiags().Report(E->getLocStart(), diag::err_builtin_needs_feature) 2117 << TargetDecl->getDeclName() 2118 << CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID); 2119 2120 } else if (TargetDecl->hasAttr<TargetAttr>()) { 2121 // Get the required features for the callee. 2122 SmallVector<StringRef, 1> ReqFeatures; 2123 llvm::StringMap<bool> CalleeFeatureMap; 2124 CGM.getFunctionFeatureMap(CalleeFeatureMap, TargetDecl); 2125 for (const auto &F : CalleeFeatureMap) { 2126 // Only positive features are "required". 2127 if (F.getValue()) 2128 ReqFeatures.push_back(F.getKey()); 2129 } 2130 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature)) 2131 CGM.getDiags().Report(E->getLocStart(), diag::err_function_needs_feature) 2132 << FD->getDeclName() << TargetDecl->getDeclName() << MissingFeature; 2133 } 2134 } 2135 2136 void CodeGenFunction::EmitSanitizerStatReport(llvm::SanitizerStatKind SSK) { 2137 if (!CGM.getCodeGenOpts().SanitizeStats) 2138 return; 2139 2140 llvm::IRBuilder<> IRB(Builder.GetInsertBlock(), Builder.GetInsertPoint()); 2141 IRB.SetCurrentDebugLocation(Builder.getCurrentDebugLocation()); 2142 CGM.getSanStats().create(IRB, SSK); 2143 } 2144 2145 llvm::DebugLoc CodeGenFunction::SourceLocToDebugLoc(SourceLocation Location) { 2146 if (CGDebugInfo *DI = getDebugInfo()) 2147 return DI->SourceLocToDebugLoc(Location); 2148 2149 return llvm::DebugLoc(); 2150 } 2151