1 //===--- CGDeclCXX.cpp - Emit LLVM Code for C++ declarations --------------===// 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 contains code dealing with code generation of C++ declarations 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "CodeGenFunction.h" 15 #include "CGCXXABI.h" 16 #include "CGObjCRuntime.h" 17 #include "CGOpenMPRuntime.h" 18 #include "clang/Frontend/CodeGenOptions.h" 19 #include "llvm/ADT/StringExtras.h" 20 #include "llvm/IR/Intrinsics.h" 21 #include "llvm/IR/MDBuilder.h" 22 #include "llvm/Support/Path.h" 23 24 using namespace clang; 25 using namespace CodeGen; 26 27 static void EmitDeclInit(CodeGenFunction &CGF, const VarDecl &D, 28 ConstantAddress DeclPtr) { 29 assert(D.hasGlobalStorage() && "VarDecl must have global storage!"); 30 assert(!D.getType()->isReferenceType() && 31 "Should not call EmitDeclInit on a reference!"); 32 33 QualType type = D.getType(); 34 LValue lv = CGF.MakeAddrLValue(DeclPtr, type); 35 36 const Expr *Init = D.getInit(); 37 switch (CGF.getEvaluationKind(type)) { 38 case TEK_Scalar: { 39 CodeGenModule &CGM = CGF.CGM; 40 if (lv.isObjCStrong()) 41 CGM.getObjCRuntime().EmitObjCGlobalAssign(CGF, CGF.EmitScalarExpr(Init), 42 DeclPtr, D.getTLSKind()); 43 else if (lv.isObjCWeak()) 44 CGM.getObjCRuntime().EmitObjCWeakAssign(CGF, CGF.EmitScalarExpr(Init), 45 DeclPtr); 46 else 47 CGF.EmitScalarInit(Init, &D, lv, false); 48 return; 49 } 50 case TEK_Complex: 51 CGF.EmitComplexExprIntoLValue(Init, lv, /*isInit*/ true); 52 return; 53 case TEK_Aggregate: 54 CGF.EmitAggExpr(Init, AggValueSlot::forLValue(lv,AggValueSlot::IsDestructed, 55 AggValueSlot::DoesNotNeedGCBarriers, 56 AggValueSlot::IsNotAliased, 57 AggValueSlot::DoesNotOverlap)); 58 return; 59 } 60 llvm_unreachable("bad evaluation kind"); 61 } 62 63 /// Emit code to cause the destruction of the given variable with 64 /// static storage duration. 65 static void EmitDeclDestroy(CodeGenFunction &CGF, const VarDecl &D, 66 ConstantAddress addr) { 67 CodeGenModule &CGM = CGF.CGM; 68 69 // FIXME: __attribute__((cleanup)) ? 70 71 QualType type = D.getType(); 72 QualType::DestructionKind dtorKind = type.isDestructedType(); 73 74 switch (dtorKind) { 75 case QualType::DK_none: 76 return; 77 78 case QualType::DK_cxx_destructor: 79 break; 80 81 case QualType::DK_objc_strong_lifetime: 82 case QualType::DK_objc_weak_lifetime: 83 case QualType::DK_nontrivial_c_struct: 84 // We don't care about releasing objects during process teardown. 85 assert(!D.getTLSKind() && "should have rejected this"); 86 return; 87 } 88 89 llvm::Constant *function; 90 llvm::Constant *argument; 91 92 // Special-case non-array C++ destructors, if they have the right signature. 93 // Under some ABIs, destructors return this instead of void, and cannot be 94 // passed directly to __cxa_atexit if the target does not allow this mismatch. 95 const CXXRecordDecl *Record = type->getAsCXXRecordDecl(); 96 bool CanRegisterDestructor = 97 Record && (!CGM.getCXXABI().HasThisReturn( 98 GlobalDecl(Record->getDestructor(), Dtor_Complete)) || 99 CGM.getCXXABI().canCallMismatchedFunctionType()); 100 // If __cxa_atexit is disabled via a flag, a different helper function is 101 // generated elsewhere which uses atexit instead, and it takes the destructor 102 // directly. 103 bool UsingExternalHelper = !CGM.getCodeGenOpts().CXAAtExit; 104 if (Record && (CanRegisterDestructor || UsingExternalHelper)) { 105 assert(!Record->hasTrivialDestructor()); 106 CXXDestructorDecl *dtor = Record->getDestructor(); 107 108 function = CGM.getAddrOfCXXStructor(dtor, StructorType::Complete); 109 argument = llvm::ConstantExpr::getBitCast( 110 addr.getPointer(), CGF.getTypes().ConvertType(type)->getPointerTo()); 111 112 // Otherwise, the standard logic requires a helper function. 113 } else { 114 function = CodeGenFunction(CGM) 115 .generateDestroyHelper(addr, type, CGF.getDestroyer(dtorKind), 116 CGF.needsEHCleanup(dtorKind), &D); 117 argument = llvm::Constant::getNullValue(CGF.Int8PtrTy); 118 } 119 120 CGM.getCXXABI().registerGlobalDtor(CGF, D, function, argument); 121 } 122 123 /// Emit code to cause the variable at the given address to be considered as 124 /// constant from this point onwards. 125 static void EmitDeclInvariant(CodeGenFunction &CGF, const VarDecl &D, 126 llvm::Constant *Addr) { 127 return CGF.EmitInvariantStart( 128 Addr, CGF.getContext().getTypeSizeInChars(D.getType())); 129 } 130 131 void CodeGenFunction::EmitInvariantStart(llvm::Constant *Addr, CharUnits Size) { 132 // Do not emit the intrinsic if we're not optimizing. 133 if (!CGM.getCodeGenOpts().OptimizationLevel) 134 return; 135 136 // Grab the llvm.invariant.start intrinsic. 137 llvm::Intrinsic::ID InvStartID = llvm::Intrinsic::invariant_start; 138 // Overloaded address space type. 139 llvm::Type *ObjectPtr[1] = {Int8PtrTy}; 140 llvm::Constant *InvariantStart = CGM.getIntrinsic(InvStartID, ObjectPtr); 141 142 // Emit a call with the size in bytes of the object. 143 uint64_t Width = Size.getQuantity(); 144 llvm::Value *Args[2] = { llvm::ConstantInt::getSigned(Int64Ty, Width), 145 llvm::ConstantExpr::getBitCast(Addr, Int8PtrTy)}; 146 Builder.CreateCall(InvariantStart, Args); 147 } 148 149 void CodeGenFunction::EmitCXXGlobalVarDeclInit(const VarDecl &D, 150 llvm::Constant *DeclPtr, 151 bool PerformInit) { 152 153 const Expr *Init = D.getInit(); 154 QualType T = D.getType(); 155 156 // The address space of a static local variable (DeclPtr) may be different 157 // from the address space of the "this" argument of the constructor. In that 158 // case, we need an addrspacecast before calling the constructor. 159 // 160 // struct StructWithCtor { 161 // __device__ StructWithCtor() {...} 162 // }; 163 // __device__ void foo() { 164 // __shared__ StructWithCtor s; 165 // ... 166 // } 167 // 168 // For example, in the above CUDA code, the static local variable s has a 169 // "shared" address space qualifier, but the constructor of StructWithCtor 170 // expects "this" in the "generic" address space. 171 unsigned ExpectedAddrSpace = getContext().getTargetAddressSpace(T); 172 unsigned ActualAddrSpace = DeclPtr->getType()->getPointerAddressSpace(); 173 if (ActualAddrSpace != ExpectedAddrSpace) { 174 llvm::Type *LTy = CGM.getTypes().ConvertTypeForMem(T); 175 llvm::PointerType *PTy = llvm::PointerType::get(LTy, ExpectedAddrSpace); 176 DeclPtr = llvm::ConstantExpr::getAddrSpaceCast(DeclPtr, PTy); 177 } 178 179 ConstantAddress DeclAddr(DeclPtr, getContext().getDeclAlign(&D)); 180 181 if (!T->isReferenceType()) { 182 if (getLangOpts().OpenMP && !getLangOpts().OpenMPSimd && 183 D.hasAttr<OMPThreadPrivateDeclAttr>()) { 184 (void)CGM.getOpenMPRuntime().emitThreadPrivateVarDefinition( 185 &D, DeclAddr, D.getAttr<OMPThreadPrivateDeclAttr>()->getLocation(), 186 PerformInit, this); 187 } 188 if (PerformInit) 189 EmitDeclInit(*this, D, DeclAddr); 190 if (CGM.isTypeConstant(D.getType(), true)) 191 EmitDeclInvariant(*this, D, DeclPtr); 192 else 193 EmitDeclDestroy(*this, D, DeclAddr); 194 return; 195 } 196 197 assert(PerformInit && "cannot have constant initializer which needs " 198 "destruction for reference"); 199 RValue RV = EmitReferenceBindingToExpr(Init); 200 EmitStoreOfScalar(RV.getScalarVal(), DeclAddr, false, T); 201 } 202 203 /// Create a stub function, suitable for being passed to atexit, 204 /// which passes the given address to the given destructor function. 205 llvm::Constant *CodeGenFunction::createAtExitStub(const VarDecl &VD, 206 llvm::Constant *dtor, 207 llvm::Constant *addr) { 208 // Get the destructor function type, void(*)(void). 209 llvm::FunctionType *ty = llvm::FunctionType::get(CGM.VoidTy, false); 210 SmallString<256> FnName; 211 { 212 llvm::raw_svector_ostream Out(FnName); 213 CGM.getCXXABI().getMangleContext().mangleDynamicAtExitDestructor(&VD, Out); 214 } 215 216 const CGFunctionInfo &FI = CGM.getTypes().arrangeNullaryFunction(); 217 llvm::Function *fn = CGM.CreateGlobalInitOrDestructFunction(ty, FnName.str(), 218 FI, 219 VD.getLocation()); 220 221 CodeGenFunction CGF(CGM); 222 223 CGF.StartFunction(&VD, CGM.getContext().VoidTy, fn, FI, FunctionArgList()); 224 225 llvm::CallInst *call = CGF.Builder.CreateCall(dtor, addr); 226 227 // Make sure the call and the callee agree on calling convention. 228 if (llvm::Function *dtorFn = 229 dyn_cast<llvm::Function>(dtor->stripPointerCasts())) 230 call->setCallingConv(dtorFn->getCallingConv()); 231 232 CGF.FinishFunction(); 233 234 return fn; 235 } 236 237 /// Register a global destructor using the C atexit runtime function. 238 void CodeGenFunction::registerGlobalDtorWithAtExit(const VarDecl &VD, 239 llvm::Constant *dtor, 240 llvm::Constant *addr) { 241 // Create a function which calls the destructor. 242 llvm::Constant *dtorStub = createAtExitStub(VD, dtor, addr); 243 registerGlobalDtorWithAtExit(dtorStub); 244 } 245 246 void CodeGenFunction::registerGlobalDtorWithAtExit(llvm::Constant *dtorStub) { 247 // extern "C" int atexit(void (*f)(void)); 248 llvm::FunctionType *atexitTy = 249 llvm::FunctionType::get(IntTy, dtorStub->getType(), false); 250 251 llvm::Constant *atexit = 252 CGM.CreateRuntimeFunction(atexitTy, "atexit", llvm::AttributeList(), 253 /*Local=*/true); 254 if (llvm::Function *atexitFn = dyn_cast<llvm::Function>(atexit)) 255 atexitFn->setDoesNotThrow(); 256 257 EmitNounwindRuntimeCall(atexit, dtorStub); 258 } 259 260 void CodeGenFunction::EmitCXXGuardedInit(const VarDecl &D, 261 llvm::GlobalVariable *DeclPtr, 262 bool PerformInit) { 263 // If we've been asked to forbid guard variables, emit an error now. 264 // This diagnostic is hard-coded for Darwin's use case; we can find 265 // better phrasing if someone else needs it. 266 if (CGM.getCodeGenOpts().ForbidGuardVariables) 267 CGM.Error(D.getLocation(), 268 "this initialization requires a guard variable, which " 269 "the kernel does not support"); 270 271 CGM.getCXXABI().EmitGuardedInit(*this, D, DeclPtr, PerformInit); 272 } 273 274 void CodeGenFunction::EmitCXXGuardedInitBranch(llvm::Value *NeedsInit, 275 llvm::BasicBlock *InitBlock, 276 llvm::BasicBlock *NoInitBlock, 277 GuardKind Kind, 278 const VarDecl *D) { 279 assert((Kind == GuardKind::TlsGuard || D) && "no guarded variable"); 280 281 // A guess at how many times we will enter the initialization of a 282 // variable, depending on the kind of variable. 283 static const uint64_t InitsPerTLSVar = 1024; 284 static const uint64_t InitsPerLocalVar = 1024 * 1024; 285 286 llvm::MDNode *Weights; 287 if (Kind == GuardKind::VariableGuard && !D->isLocalVarDecl()) { 288 // For non-local variables, don't apply any weighting for now. Due to our 289 // use of COMDATs, we expect there to be at most one initialization of the 290 // variable per DSO, but we have no way to know how many DSOs will try to 291 // initialize the variable. 292 Weights = nullptr; 293 } else { 294 uint64_t NumInits; 295 // FIXME: For the TLS case, collect and use profiling information to 296 // determine a more accurate brach weight. 297 if (Kind == GuardKind::TlsGuard || D->getTLSKind()) 298 NumInits = InitsPerTLSVar; 299 else 300 NumInits = InitsPerLocalVar; 301 302 // The probability of us entering the initializer is 303 // 1 / (total number of times we attempt to initialize the variable). 304 llvm::MDBuilder MDHelper(CGM.getLLVMContext()); 305 Weights = MDHelper.createBranchWeights(1, NumInits - 1); 306 } 307 308 Builder.CreateCondBr(NeedsInit, InitBlock, NoInitBlock, Weights); 309 } 310 311 llvm::Function *CodeGenModule::CreateGlobalInitOrDestructFunction( 312 llvm::FunctionType *FTy, const Twine &Name, const CGFunctionInfo &FI, 313 SourceLocation Loc, bool TLS) { 314 llvm::Function *Fn = 315 llvm::Function::Create(FTy, llvm::GlobalValue::InternalLinkage, 316 Name, &getModule()); 317 if (!getLangOpts().AppleKext && !TLS) { 318 // Set the section if needed. 319 if (const char *Section = getTarget().getStaticInitSectionSpecifier()) 320 Fn->setSection(Section); 321 } 322 323 SetInternalFunctionAttributes(GlobalDecl(), Fn, FI); 324 325 Fn->setCallingConv(getRuntimeCC()); 326 327 if (!getLangOpts().Exceptions) 328 Fn->setDoesNotThrow(); 329 330 if (getLangOpts().Sanitize.has(SanitizerKind::Address) && 331 !isInSanitizerBlacklist(SanitizerKind::Address, Fn, Loc)) 332 Fn->addFnAttr(llvm::Attribute::SanitizeAddress); 333 334 if (getLangOpts().Sanitize.has(SanitizerKind::KernelAddress) && 335 !isInSanitizerBlacklist(SanitizerKind::KernelAddress, Fn, Loc)) 336 Fn->addFnAttr(llvm::Attribute::SanitizeAddress); 337 338 if (getLangOpts().Sanitize.has(SanitizerKind::HWAddress) && 339 !isInSanitizerBlacklist(SanitizerKind::HWAddress, Fn, Loc)) 340 Fn->addFnAttr(llvm::Attribute::SanitizeHWAddress); 341 342 if (getLangOpts().Sanitize.has(SanitizerKind::KernelHWAddress) && 343 !isInSanitizerBlacklist(SanitizerKind::KernelHWAddress, Fn, Loc)) 344 Fn->addFnAttr(llvm::Attribute::SanitizeHWAddress); 345 346 if (getLangOpts().Sanitize.has(SanitizerKind::Thread) && 347 !isInSanitizerBlacklist(SanitizerKind::Thread, Fn, Loc)) 348 Fn->addFnAttr(llvm::Attribute::SanitizeThread); 349 350 if (getLangOpts().Sanitize.has(SanitizerKind::Memory) && 351 !isInSanitizerBlacklist(SanitizerKind::Memory, Fn, Loc)) 352 Fn->addFnAttr(llvm::Attribute::SanitizeMemory); 353 354 if (getLangOpts().Sanitize.has(SanitizerKind::KernelMemory) && 355 !isInSanitizerBlacklist(SanitizerKind::KernelMemory, Fn, Loc)) 356 Fn->addFnAttr(llvm::Attribute::SanitizeMemory); 357 358 if (getLangOpts().Sanitize.has(SanitizerKind::SafeStack) && 359 !isInSanitizerBlacklist(SanitizerKind::SafeStack, Fn, Loc)) 360 Fn->addFnAttr(llvm::Attribute::SafeStack); 361 362 if (getLangOpts().Sanitize.has(SanitizerKind::ShadowCallStack) && 363 !isInSanitizerBlacklist(SanitizerKind::ShadowCallStack, Fn, Loc)) 364 Fn->addFnAttr(llvm::Attribute::ShadowCallStack); 365 366 auto RASignKind = getCodeGenOpts().getSignReturnAddress(); 367 if (RASignKind != CodeGenOptions::SignReturnAddressScope::None) { 368 Fn->addFnAttr("sign-return-address", 369 RASignKind == CodeGenOptions::SignReturnAddressScope::All 370 ? "all" 371 : "non-leaf"); 372 auto RASignKey = getCodeGenOpts().getSignReturnAddressKey(); 373 Fn->addFnAttr("sign-return-address-key", 374 RASignKey == CodeGenOptions::SignReturnAddressKeyValue::AKey 375 ? "a_key" 376 : "b_key"); 377 } 378 379 if (getCodeGenOpts().BranchTargetEnforcement) 380 Fn->addFnAttr("branch-target-enforcement"); 381 382 return Fn; 383 } 384 385 /// Create a global pointer to a function that will initialize a global 386 /// variable. The user has requested that this pointer be emitted in a specific 387 /// section. 388 void CodeGenModule::EmitPointerToInitFunc(const VarDecl *D, 389 llvm::GlobalVariable *GV, 390 llvm::Function *InitFunc, 391 InitSegAttr *ISA) { 392 llvm::GlobalVariable *PtrArray = new llvm::GlobalVariable( 393 TheModule, InitFunc->getType(), /*isConstant=*/true, 394 llvm::GlobalValue::PrivateLinkage, InitFunc, "__cxx_init_fn_ptr"); 395 PtrArray->setSection(ISA->getSection()); 396 addUsedGlobal(PtrArray); 397 398 // If the GV is already in a comdat group, then we have to join it. 399 if (llvm::Comdat *C = GV->getComdat()) 400 PtrArray->setComdat(C); 401 } 402 403 void 404 CodeGenModule::EmitCXXGlobalVarDeclInitFunc(const VarDecl *D, 405 llvm::GlobalVariable *Addr, 406 bool PerformInit) { 407 408 // According to E.2.3.1 in CUDA-7.5 Programming guide: __device__, 409 // __constant__ and __shared__ variables defined in namespace scope, 410 // that are of class type, cannot have a non-empty constructor. All 411 // the checks have been done in Sema by now. Whatever initializers 412 // are allowed are empty and we just need to ignore them here. 413 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice && 414 (D->hasAttr<CUDADeviceAttr>() || D->hasAttr<CUDAConstantAttr>() || 415 D->hasAttr<CUDASharedAttr>())) 416 return; 417 418 if (getLangOpts().OpenMP && 419 getOpenMPRuntime().emitDeclareTargetVarDefinition(D, Addr, PerformInit)) 420 return; 421 422 // Check if we've already initialized this decl. 423 auto I = DelayedCXXInitPosition.find(D); 424 if (I != DelayedCXXInitPosition.end() && I->second == ~0U) 425 return; 426 427 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false); 428 SmallString<256> FnName; 429 { 430 llvm::raw_svector_ostream Out(FnName); 431 getCXXABI().getMangleContext().mangleDynamicInitializer(D, Out); 432 } 433 434 // Create a variable initialization function. 435 llvm::Function *Fn = 436 CreateGlobalInitOrDestructFunction(FTy, FnName.str(), 437 getTypes().arrangeNullaryFunction(), 438 D->getLocation()); 439 440 auto *ISA = D->getAttr<InitSegAttr>(); 441 CodeGenFunction(*this).GenerateCXXGlobalVarDeclInitFunc(Fn, D, Addr, 442 PerformInit); 443 444 llvm::GlobalVariable *COMDATKey = 445 supportsCOMDAT() && D->isExternallyVisible() ? Addr : nullptr; 446 447 if (D->getTLSKind()) { 448 // FIXME: Should we support init_priority for thread_local? 449 // FIXME: We only need to register one __cxa_thread_atexit function for the 450 // entire TU. 451 CXXThreadLocalInits.push_back(Fn); 452 CXXThreadLocalInitVars.push_back(D); 453 } else if (PerformInit && ISA) { 454 EmitPointerToInitFunc(D, Addr, Fn, ISA); 455 } else if (auto *IPA = D->getAttr<InitPriorityAttr>()) { 456 OrderGlobalInits Key(IPA->getPriority(), PrioritizedCXXGlobalInits.size()); 457 PrioritizedCXXGlobalInits.push_back(std::make_pair(Key, Fn)); 458 } else if (isTemplateInstantiation(D->getTemplateSpecializationKind())) { 459 // C++ [basic.start.init]p2: 460 // Definitions of explicitly specialized class template static data 461 // members have ordered initialization. Other class template static data 462 // members (i.e., implicitly or explicitly instantiated specializations) 463 // have unordered initialization. 464 // 465 // As a consequence, we can put them into their own llvm.global_ctors entry. 466 // 467 // If the global is externally visible, put the initializer into a COMDAT 468 // group with the global being initialized. On most platforms, this is a 469 // minor startup time optimization. In the MS C++ ABI, there are no guard 470 // variables, so this COMDAT key is required for correctness. 471 AddGlobalCtor(Fn, 65535, COMDATKey); 472 } else if (D->hasAttr<SelectAnyAttr>()) { 473 // SelectAny globals will be comdat-folded. Put the initializer into a 474 // COMDAT group associated with the global, so the initializers get folded 475 // too. 476 AddGlobalCtor(Fn, 65535, COMDATKey); 477 } else { 478 I = DelayedCXXInitPosition.find(D); // Re-do lookup in case of re-hash. 479 if (I == DelayedCXXInitPosition.end()) { 480 CXXGlobalInits.push_back(Fn); 481 } else if (I->second != ~0U) { 482 assert(I->second < CXXGlobalInits.size() && 483 CXXGlobalInits[I->second] == nullptr); 484 CXXGlobalInits[I->second] = Fn; 485 } 486 } 487 488 // Remember that we already emitted the initializer for this global. 489 DelayedCXXInitPosition[D] = ~0U; 490 } 491 492 void CodeGenModule::EmitCXXThreadLocalInitFunc() { 493 getCXXABI().EmitThreadLocalInitFuncs( 494 *this, CXXThreadLocals, CXXThreadLocalInits, CXXThreadLocalInitVars); 495 496 CXXThreadLocalInits.clear(); 497 CXXThreadLocalInitVars.clear(); 498 CXXThreadLocals.clear(); 499 } 500 501 void 502 CodeGenModule::EmitCXXGlobalInitFunc() { 503 while (!CXXGlobalInits.empty() && !CXXGlobalInits.back()) 504 CXXGlobalInits.pop_back(); 505 506 if (CXXGlobalInits.empty() && PrioritizedCXXGlobalInits.empty()) 507 return; 508 509 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false); 510 const CGFunctionInfo &FI = getTypes().arrangeNullaryFunction(); 511 512 // Create our global initialization function. 513 if (!PrioritizedCXXGlobalInits.empty()) { 514 SmallVector<llvm::Function *, 8> LocalCXXGlobalInits; 515 llvm::array_pod_sort(PrioritizedCXXGlobalInits.begin(), 516 PrioritizedCXXGlobalInits.end()); 517 // Iterate over "chunks" of ctors with same priority and emit each chunk 518 // into separate function. Note - everything is sorted first by priority, 519 // second - by lex order, so we emit ctor functions in proper order. 520 for (SmallVectorImpl<GlobalInitData >::iterator 521 I = PrioritizedCXXGlobalInits.begin(), 522 E = PrioritizedCXXGlobalInits.end(); I != E; ) { 523 SmallVectorImpl<GlobalInitData >::iterator 524 PrioE = std::upper_bound(I + 1, E, *I, GlobalInitPriorityCmp()); 525 526 LocalCXXGlobalInits.clear(); 527 unsigned Priority = I->first.priority; 528 // Compute the function suffix from priority. Prepend with zeroes to make 529 // sure the function names are also ordered as priorities. 530 std::string PrioritySuffix = llvm::utostr(Priority); 531 // Priority is always <= 65535 (enforced by sema). 532 PrioritySuffix = std::string(6-PrioritySuffix.size(), '0')+PrioritySuffix; 533 llvm::Function *Fn = CreateGlobalInitOrDestructFunction( 534 FTy, "_GLOBAL__I_" + PrioritySuffix, FI); 535 536 for (; I < PrioE; ++I) 537 LocalCXXGlobalInits.push_back(I->second); 538 539 CodeGenFunction(*this).GenerateCXXGlobalInitFunc(Fn, LocalCXXGlobalInits); 540 AddGlobalCtor(Fn, Priority); 541 } 542 PrioritizedCXXGlobalInits.clear(); 543 } 544 545 // Include the filename in the symbol name. Including "sub_" matches gcc and 546 // makes sure these symbols appear lexicographically behind the symbols with 547 // priority emitted above. 548 SmallString<128> FileName = llvm::sys::path::filename(getModule().getName()); 549 if (FileName.empty()) 550 FileName = "<null>"; 551 552 for (size_t i = 0; i < FileName.size(); ++i) { 553 // Replace everything that's not [a-zA-Z0-9._] with a _. This set happens 554 // to be the set of C preprocessing numbers. 555 if (!isPreprocessingNumberBody(FileName[i])) 556 FileName[i] = '_'; 557 } 558 559 llvm::Function *Fn = CreateGlobalInitOrDestructFunction( 560 FTy, llvm::Twine("_GLOBAL__sub_I_", FileName), FI); 561 562 CodeGenFunction(*this).GenerateCXXGlobalInitFunc(Fn, CXXGlobalInits); 563 AddGlobalCtor(Fn); 564 565 CXXGlobalInits.clear(); 566 } 567 568 void CodeGenModule::EmitCXXGlobalDtorFunc() { 569 if (CXXGlobalDtors.empty()) 570 return; 571 572 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false); 573 574 // Create our global destructor function. 575 const CGFunctionInfo &FI = getTypes().arrangeNullaryFunction(); 576 llvm::Function *Fn = 577 CreateGlobalInitOrDestructFunction(FTy, "_GLOBAL__D_a", FI); 578 579 CodeGenFunction(*this).GenerateCXXGlobalDtorsFunc(Fn, CXXGlobalDtors); 580 AddGlobalDtor(Fn); 581 } 582 583 /// Emit the code necessary to initialize the given global variable. 584 void CodeGenFunction::GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn, 585 const VarDecl *D, 586 llvm::GlobalVariable *Addr, 587 bool PerformInit) { 588 // Check if we need to emit debug info for variable initializer. 589 if (D->hasAttr<NoDebugAttr>()) 590 DebugInfo = nullptr; // disable debug info indefinitely for this function 591 592 CurEHLocation = D->getBeginLoc(); 593 594 StartFunction(GlobalDecl(D), getContext().VoidTy, Fn, 595 getTypes().arrangeNullaryFunction(), 596 FunctionArgList(), D->getLocation(), 597 D->getInit()->getExprLoc()); 598 599 // Use guarded initialization if the global variable is weak. This 600 // occurs for, e.g., instantiated static data members and 601 // definitions explicitly marked weak. 602 if (Addr->hasWeakLinkage() || Addr->hasLinkOnceLinkage()) { 603 EmitCXXGuardedInit(*D, Addr, PerformInit); 604 } else { 605 EmitCXXGlobalVarDeclInit(*D, Addr, PerformInit); 606 } 607 608 FinishFunction(); 609 } 610 611 void 612 CodeGenFunction::GenerateCXXGlobalInitFunc(llvm::Function *Fn, 613 ArrayRef<llvm::Function *> Decls, 614 ConstantAddress Guard) { 615 { 616 auto NL = ApplyDebugLocation::CreateEmpty(*this); 617 StartFunction(GlobalDecl(), getContext().VoidTy, Fn, 618 getTypes().arrangeNullaryFunction(), FunctionArgList()); 619 // Emit an artificial location for this function. 620 auto AL = ApplyDebugLocation::CreateArtificial(*this); 621 622 llvm::BasicBlock *ExitBlock = nullptr; 623 if (Guard.isValid()) { 624 // If we have a guard variable, check whether we've already performed 625 // these initializations. This happens for TLS initialization functions. 626 llvm::Value *GuardVal = Builder.CreateLoad(Guard); 627 llvm::Value *Uninit = Builder.CreateIsNull(GuardVal, 628 "guard.uninitialized"); 629 llvm::BasicBlock *InitBlock = createBasicBlock("init"); 630 ExitBlock = createBasicBlock("exit"); 631 EmitCXXGuardedInitBranch(Uninit, InitBlock, ExitBlock, 632 GuardKind::TlsGuard, nullptr); 633 EmitBlock(InitBlock); 634 // Mark as initialized before initializing anything else. If the 635 // initializers use previously-initialized thread_local vars, that's 636 // probably supposed to be OK, but the standard doesn't say. 637 Builder.CreateStore(llvm::ConstantInt::get(GuardVal->getType(),1), Guard); 638 639 // The guard variable can't ever change again. 640 EmitInvariantStart( 641 Guard.getPointer(), 642 CharUnits::fromQuantity( 643 CGM.getDataLayout().getTypeAllocSize(GuardVal->getType()))); 644 } 645 646 RunCleanupsScope Scope(*this); 647 648 // When building in Objective-C++ ARC mode, create an autorelease pool 649 // around the global initializers. 650 if (getLangOpts().ObjCAutoRefCount && getLangOpts().CPlusPlus) { 651 llvm::Value *token = EmitObjCAutoreleasePoolPush(); 652 EmitObjCAutoreleasePoolCleanup(token); 653 } 654 655 for (unsigned i = 0, e = Decls.size(); i != e; ++i) 656 if (Decls[i]) 657 EmitRuntimeCall(Decls[i]); 658 659 Scope.ForceCleanup(); 660 661 if (ExitBlock) { 662 Builder.CreateBr(ExitBlock); 663 EmitBlock(ExitBlock); 664 } 665 } 666 667 FinishFunction(); 668 } 669 670 void CodeGenFunction::GenerateCXXGlobalDtorsFunc( 671 llvm::Function *Fn, 672 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>> 673 &DtorsAndObjects) { 674 { 675 auto NL = ApplyDebugLocation::CreateEmpty(*this); 676 StartFunction(GlobalDecl(), getContext().VoidTy, Fn, 677 getTypes().arrangeNullaryFunction(), FunctionArgList()); 678 // Emit an artificial location for this function. 679 auto AL = ApplyDebugLocation::CreateArtificial(*this); 680 681 // Emit the dtors, in reverse order from construction. 682 for (unsigned i = 0, e = DtorsAndObjects.size(); i != e; ++i) { 683 llvm::Value *Callee = DtorsAndObjects[e - i - 1].first; 684 llvm::CallInst *CI = Builder.CreateCall(Callee, 685 DtorsAndObjects[e - i - 1].second); 686 // Make sure the call and the callee agree on calling convention. 687 if (llvm::Function *F = dyn_cast<llvm::Function>(Callee)) 688 CI->setCallingConv(F->getCallingConv()); 689 } 690 } 691 692 FinishFunction(); 693 } 694 695 /// generateDestroyHelper - Generates a helper function which, when 696 /// invoked, destroys the given object. The address of the object 697 /// should be in global memory. 698 llvm::Function *CodeGenFunction::generateDestroyHelper( 699 Address addr, QualType type, Destroyer *destroyer, 700 bool useEHCleanupForArray, const VarDecl *VD) { 701 FunctionArgList args; 702 ImplicitParamDecl Dst(getContext(), getContext().VoidPtrTy, 703 ImplicitParamDecl::Other); 704 args.push_back(&Dst); 705 706 const CGFunctionInfo &FI = 707 CGM.getTypes().arrangeBuiltinFunctionDeclaration(getContext().VoidTy, args); 708 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(FI); 709 llvm::Function *fn = CGM.CreateGlobalInitOrDestructFunction( 710 FTy, "__cxx_global_array_dtor", FI, VD->getLocation()); 711 712 CurEHLocation = VD->getBeginLoc(); 713 714 StartFunction(VD, getContext().VoidTy, fn, FI, args); 715 716 emitDestroy(addr, type, destroyer, useEHCleanupForArray); 717 718 FinishFunction(); 719 720 return fn; 721 } 722