1 //===-- AsmPrinter.cpp - Common AsmPrinter code ---------------------------===// 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 file implements the AsmPrinter class. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "llvm/CodeGen/AsmPrinter.h" 15 #include "DwarfDebug.h" 16 #include "DwarfException.h" 17 #include "WinException.h" 18 #include "WinCodeViewLineTables.h" 19 #include "llvm/ADT/SmallString.h" 20 #include "llvm/ADT/Statistic.h" 21 #include "llvm/Analysis/ConstantFolding.h" 22 #include "llvm/Analysis/JumpInstrTableInfo.h" 23 #include "llvm/CodeGen/Analysis.h" 24 #include "llvm/CodeGen/GCMetadataPrinter.h" 25 #include "llvm/CodeGen/MachineConstantPool.h" 26 #include "llvm/CodeGen/MachineFrameInfo.h" 27 #include "llvm/CodeGen/MachineFunction.h" 28 #include "llvm/CodeGen/MachineInstrBundle.h" 29 #include "llvm/CodeGen/MachineJumpTableInfo.h" 30 #include "llvm/CodeGen/MachineLoopInfo.h" 31 #include "llvm/CodeGen/MachineModuleInfoImpls.h" 32 #include "llvm/IR/DataLayout.h" 33 #include "llvm/IR/DebugInfo.h" 34 #include "llvm/IR/Mangler.h" 35 #include "llvm/IR/Module.h" 36 #include "llvm/IR/Operator.h" 37 #include "llvm/MC/MCAsmInfo.h" 38 #include "llvm/MC/MCContext.h" 39 #include "llvm/MC/MCExpr.h" 40 #include "llvm/MC/MCInst.h" 41 #include "llvm/MC/MCSection.h" 42 #include "llvm/MC/MCStreamer.h" 43 #include "llvm/MC/MCSymbolELF.h" 44 #include "llvm/MC/MCValue.h" 45 #include "llvm/Support/ErrorHandling.h" 46 #include "llvm/Support/Format.h" 47 #include "llvm/Support/MathExtras.h" 48 #include "llvm/Support/TargetRegistry.h" 49 #include "llvm/Support/Timer.h" 50 #include "llvm/Target/TargetFrameLowering.h" 51 #include "llvm/Target/TargetInstrInfo.h" 52 #include "llvm/Target/TargetLowering.h" 53 #include "llvm/Target/TargetLoweringObjectFile.h" 54 #include "llvm/Target/TargetRegisterInfo.h" 55 #include "llvm/Target/TargetSubtargetInfo.h" 56 using namespace llvm; 57 58 #define DEBUG_TYPE "asm-printer" 59 60 static const char *const DWARFGroupName = "DWARF Emission"; 61 static const char *const DbgTimerName = "Debug Info Emission"; 62 static const char *const EHTimerName = "DWARF Exception Writer"; 63 static const char *const CodeViewLineTablesGroupName = "CodeView Line Tables"; 64 65 STATISTIC(EmittedInsts, "Number of machine instrs printed"); 66 67 char AsmPrinter::ID = 0; 68 69 typedef DenseMap<GCStrategy*, std::unique_ptr<GCMetadataPrinter>> gcp_map_type; 70 static gcp_map_type &getGCMap(void *&P) { 71 if (!P) 72 P = new gcp_map_type(); 73 return *(gcp_map_type*)P; 74 } 75 76 77 /// getGVAlignmentLog2 - Return the alignment to use for the specified global 78 /// value in log2 form. This rounds up to the preferred alignment if possible 79 /// and legal. 80 static unsigned getGVAlignmentLog2(const GlobalValue *GV, const DataLayout &DL, 81 unsigned InBits = 0) { 82 unsigned NumBits = 0; 83 if (const GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV)) 84 NumBits = DL.getPreferredAlignmentLog(GVar); 85 86 // If InBits is specified, round it to it. 87 if (InBits > NumBits) 88 NumBits = InBits; 89 90 // If the GV has a specified alignment, take it into account. 91 if (GV->getAlignment() == 0) 92 return NumBits; 93 94 unsigned GVAlign = Log2_32(GV->getAlignment()); 95 96 // If the GVAlign is larger than NumBits, or if we are required to obey 97 // NumBits because the GV has an assigned section, obey it. 98 if (GVAlign > NumBits || GV->hasSection()) 99 NumBits = GVAlign; 100 return NumBits; 101 } 102 103 AsmPrinter::AsmPrinter(TargetMachine &tm, std::unique_ptr<MCStreamer> Streamer) 104 : MachineFunctionPass(ID), TM(tm), MAI(tm.getMCAsmInfo()), 105 OutContext(Streamer->getContext()), OutStreamer(std::move(Streamer)), 106 LastMI(nullptr), LastFn(0), Counter(~0U) { 107 DD = nullptr; 108 MMI = nullptr; 109 LI = nullptr; 110 MF = nullptr; 111 CurExceptionSym = CurrentFnSym = CurrentFnSymForSize = nullptr; 112 CurrentFnBegin = nullptr; 113 CurrentFnEnd = nullptr; 114 GCMetadataPrinters = nullptr; 115 VerboseAsm = OutStreamer->isVerboseAsm(); 116 } 117 118 AsmPrinter::~AsmPrinter() { 119 assert(!DD && Handlers.empty() && "Debug/EH info didn't get finalized"); 120 121 if (GCMetadataPrinters) { 122 gcp_map_type &GCMap = getGCMap(GCMetadataPrinters); 123 124 delete &GCMap; 125 GCMetadataPrinters = nullptr; 126 } 127 } 128 129 /// getFunctionNumber - Return a unique ID for the current function. 130 /// 131 unsigned AsmPrinter::getFunctionNumber() const { 132 return MF->getFunctionNumber(); 133 } 134 135 const TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const { 136 return *TM.getObjFileLowering(); 137 } 138 139 /// getDataLayout - Return information about data layout. 140 const DataLayout &AsmPrinter::getDataLayout() const { 141 return *TM.getDataLayout(); 142 } 143 144 const MCSubtargetInfo &AsmPrinter::getSubtargetInfo() const { 145 assert(MF && "getSubtargetInfo requires a valid MachineFunction!"); 146 return MF->getSubtarget<MCSubtargetInfo>(); 147 } 148 149 void AsmPrinter::EmitToStreamer(MCStreamer &S, const MCInst &Inst) { 150 S.EmitInstruction(Inst, getSubtargetInfo()); 151 } 152 153 StringRef AsmPrinter::getTargetTriple() const { 154 return TM.getTargetTriple(); 155 } 156 157 /// getCurrentSection() - Return the current section we are emitting to. 158 const MCSection *AsmPrinter::getCurrentSection() const { 159 return OutStreamer->getCurrentSection().first; 160 } 161 162 163 164 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const { 165 AU.setPreservesAll(); 166 MachineFunctionPass::getAnalysisUsage(AU); 167 AU.addRequired<MachineModuleInfo>(); 168 AU.addRequired<GCModuleInfo>(); 169 if (isVerbose()) 170 AU.addRequired<MachineLoopInfo>(); 171 } 172 173 bool AsmPrinter::doInitialization(Module &M) { 174 MMI = getAnalysisIfAvailable<MachineModuleInfo>(); 175 176 // Initialize TargetLoweringObjectFile. 177 const_cast<TargetLoweringObjectFile&>(getObjFileLowering()) 178 .Initialize(OutContext, TM); 179 180 OutStreamer->InitSections(false); 181 182 Mang = new Mangler(TM.getDataLayout()); 183 184 // Emit the version-min deplyment target directive if needed. 185 // 186 // FIXME: If we end up with a collection of these sorts of Darwin-specific 187 // or ELF-specific things, it may make sense to have a platform helper class 188 // that will work with the target helper class. For now keep it here, as the 189 // alternative is duplicated code in each of the target asm printers that 190 // use the directive, where it would need the same conditionalization 191 // anyway. 192 Triple TT(getTargetTriple()); 193 if (TT.isOSDarwin()) { 194 unsigned Major, Minor, Update; 195 TT.getOSVersion(Major, Minor, Update); 196 // If there is a version specified, Major will be non-zero. 197 if (Major) 198 OutStreamer->EmitVersionMin((TT.isMacOSX() ? 199 MCVM_OSXVersionMin : MCVM_IOSVersionMin), 200 Major, Minor, Update); 201 } 202 203 // Allow the target to emit any magic that it wants at the start of the file. 204 EmitStartOfAsmFile(M); 205 206 // Very minimal debug info. It is ignored if we emit actual debug info. If we 207 // don't, this at least helps the user find where a global came from. 208 if (MAI->hasSingleParameterDotFile()) { 209 // .file "foo.c" 210 OutStreamer->EmitFileDirective(M.getModuleIdentifier()); 211 } 212 213 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>(); 214 assert(MI && "AsmPrinter didn't require GCModuleInfo?"); 215 for (auto &I : *MI) 216 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I)) 217 MP->beginAssembly(M, *MI, *this); 218 219 // Emit module-level inline asm if it exists. 220 if (!M.getModuleInlineAsm().empty()) { 221 // We're at the module level. Construct MCSubtarget from the default CPU 222 // and target triple. 223 std::unique_ptr<MCSubtargetInfo> STI(TM.getTarget().createMCSubtargetInfo( 224 TM.getTargetTriple(), TM.getTargetCPU(), TM.getTargetFeatureString())); 225 OutStreamer->AddComment("Start of file scope inline assembly"); 226 OutStreamer->AddBlankLine(); 227 EmitInlineAsm(M.getModuleInlineAsm()+"\n", *STI, TM.Options.MCOptions); 228 OutStreamer->AddComment("End of file scope inline assembly"); 229 OutStreamer->AddBlankLine(); 230 } 231 232 if (MAI->doesSupportDebugInformation()) { 233 bool skip_dwarf = false; 234 if (Triple(TM.getTargetTriple()).isKnownWindowsMSVCEnvironment()) { 235 Handlers.push_back(HandlerInfo(new WinCodeViewLineTables(this), 236 DbgTimerName, 237 CodeViewLineTablesGroupName)); 238 // FIXME: Don't emit DWARF debug info if there's at least one function 239 // with AddressSanitizer instrumentation. 240 // This is a band-aid fix for PR22032. 241 for (auto &F : M.functions()) { 242 if (F.hasFnAttribute(Attribute::SanitizeAddress)) { 243 skip_dwarf = true; 244 break; 245 } 246 } 247 } 248 if (!skip_dwarf) { 249 DD = new DwarfDebug(this, &M); 250 Handlers.push_back(HandlerInfo(DD, DbgTimerName, DWARFGroupName)); 251 } 252 } 253 254 EHStreamer *ES = nullptr; 255 switch (MAI->getExceptionHandlingType()) { 256 case ExceptionHandling::None: 257 break; 258 case ExceptionHandling::SjLj: 259 case ExceptionHandling::DwarfCFI: 260 ES = new DwarfCFIException(this); 261 break; 262 case ExceptionHandling::ARM: 263 ES = new ARMException(this); 264 break; 265 case ExceptionHandling::WinEH: 266 switch (MAI->getWinEHEncodingType()) { 267 default: llvm_unreachable("unsupported unwinding information encoding"); 268 case WinEH::EncodingType::Invalid: 269 break; 270 case WinEH::EncodingType::X86: 271 case WinEH::EncodingType::Itanium: 272 ES = new WinException(this); 273 break; 274 } 275 break; 276 } 277 if (ES) 278 Handlers.push_back(HandlerInfo(ES, EHTimerName, DWARFGroupName)); 279 return false; 280 } 281 282 static bool canBeHidden(const GlobalValue *GV, const MCAsmInfo &MAI) { 283 if (!MAI.hasWeakDefCanBeHiddenDirective()) 284 return false; 285 286 return canBeOmittedFromSymbolTable(GV); 287 } 288 289 void AsmPrinter::EmitLinkage(const GlobalValue *GV, MCSymbol *GVSym) const { 290 GlobalValue::LinkageTypes Linkage = GV->getLinkage(); 291 switch (Linkage) { 292 case GlobalValue::CommonLinkage: 293 case GlobalValue::LinkOnceAnyLinkage: 294 case GlobalValue::LinkOnceODRLinkage: 295 case GlobalValue::WeakAnyLinkage: 296 case GlobalValue::WeakODRLinkage: 297 if (MAI->hasWeakDefDirective()) { 298 // .globl _foo 299 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_Global); 300 301 if (!canBeHidden(GV, *MAI)) 302 // .weak_definition _foo 303 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_WeakDefinition); 304 else 305 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_WeakDefAutoPrivate); 306 } else if (MAI->hasLinkOnceDirective()) { 307 // .globl _foo 308 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_Global); 309 //NOTE: linkonce is handled by the section the symbol was assigned to. 310 } else { 311 // .weak _foo 312 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_Weak); 313 } 314 return; 315 case GlobalValue::AppendingLinkage: 316 // FIXME: appending linkage variables should go into a section of 317 // their name or something. For now, just emit them as external. 318 case GlobalValue::ExternalLinkage: 319 // If external or appending, declare as a global symbol. 320 // .globl _foo 321 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_Global); 322 return; 323 case GlobalValue::PrivateLinkage: 324 case GlobalValue::InternalLinkage: 325 return; 326 case GlobalValue::AvailableExternallyLinkage: 327 llvm_unreachable("Should never emit this"); 328 case GlobalValue::ExternalWeakLinkage: 329 llvm_unreachable("Don't know how to emit these"); 330 } 331 llvm_unreachable("Unknown linkage type!"); 332 } 333 334 void AsmPrinter::getNameWithPrefix(SmallVectorImpl<char> &Name, 335 const GlobalValue *GV) const { 336 TM.getNameWithPrefix(Name, GV, *Mang); 337 } 338 339 MCSymbol *AsmPrinter::getSymbol(const GlobalValue *GV) const { 340 return TM.getSymbol(GV, *Mang); 341 } 342 343 /// EmitGlobalVariable - Emit the specified global variable to the .s file. 344 void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) { 345 if (GV->hasInitializer()) { 346 // Check to see if this is a special global used by LLVM, if so, emit it. 347 if (EmitSpecialLLVMGlobal(GV)) 348 return; 349 350 // Skip the emission of global equivalents. The symbol can be emitted later 351 // on by emitGlobalGOTEquivs in case it turns out to be needed. 352 if (GlobalGOTEquivs.count(getSymbol(GV))) 353 return; 354 355 if (isVerbose()) { 356 GV->printAsOperand(OutStreamer->GetCommentOS(), 357 /*PrintType=*/false, GV->getParent()); 358 OutStreamer->GetCommentOS() << '\n'; 359 } 360 } 361 362 MCSymbol *GVSym = getSymbol(GV); 363 EmitVisibility(GVSym, GV->getVisibility(), !GV->isDeclaration()); 364 365 if (!GV->hasInitializer()) // External globals require no extra code. 366 return; 367 368 GVSym->redefineIfPossible(); 369 if (GVSym->isDefined() || GVSym->isVariable()) 370 report_fatal_error("symbol '" + Twine(GVSym->getName()) + 371 "' is already defined"); 372 373 if (MAI->hasDotTypeDotSizeDirective()) 374 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_ELF_TypeObject); 375 376 SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM); 377 378 const DataLayout *DL = TM.getDataLayout(); 379 uint64_t Size = DL->getTypeAllocSize(GV->getType()->getElementType()); 380 381 // If the alignment is specified, we *must* obey it. Overaligning a global 382 // with a specified alignment is a prompt way to break globals emitted to 383 // sections and expected to be contiguous (e.g. ObjC metadata). 384 unsigned AlignLog = getGVAlignmentLog2(GV, *DL); 385 386 for (const HandlerInfo &HI : Handlers) { 387 NamedRegionTimer T(HI.TimerName, HI.TimerGroupName, TimePassesIsEnabled); 388 HI.Handler->setSymbolSize(GVSym, Size); 389 } 390 391 // Handle common and BSS local symbols (.lcomm). 392 if (GVKind.isCommon() || GVKind.isBSSLocal()) { 393 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it. 394 unsigned Align = 1 << AlignLog; 395 396 // Handle common symbols. 397 if (GVKind.isCommon()) { 398 if (!getObjFileLowering().getCommDirectiveSupportsAlignment()) 399 Align = 0; 400 401 // .comm _foo, 42, 4 402 OutStreamer->EmitCommonSymbol(GVSym, Size, Align); 403 return; 404 } 405 406 // Handle local BSS symbols. 407 if (MAI->hasMachoZeroFillDirective()) { 408 MCSection *TheSection = 409 getObjFileLowering().SectionForGlobal(GV, GVKind, *Mang, TM); 410 // .zerofill __DATA, __bss, _foo, 400, 5 411 OutStreamer->EmitZerofill(TheSection, GVSym, Size, Align); 412 return; 413 } 414 415 // Use .lcomm only if it supports user-specified alignment. 416 // Otherwise, while it would still be correct to use .lcomm in some 417 // cases (e.g. when Align == 1), the external assembler might enfore 418 // some -unknown- default alignment behavior, which could cause 419 // spurious differences between external and integrated assembler. 420 // Prefer to simply fall back to .local / .comm in this case. 421 if (MAI->getLCOMMDirectiveAlignmentType() != LCOMM::NoAlignment) { 422 // .lcomm _foo, 42 423 OutStreamer->EmitLocalCommonSymbol(GVSym, Size, Align); 424 return; 425 } 426 427 if (!getObjFileLowering().getCommDirectiveSupportsAlignment()) 428 Align = 0; 429 430 // .local _foo 431 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_Local); 432 // .comm _foo, 42, 4 433 OutStreamer->EmitCommonSymbol(GVSym, Size, Align); 434 return; 435 } 436 437 MCSection *TheSection = 438 getObjFileLowering().SectionForGlobal(GV, GVKind, *Mang, TM); 439 440 // Handle the zerofill directive on darwin, which is a special form of BSS 441 // emission. 442 if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) { 443 if (Size == 0) Size = 1; // zerofill of 0 bytes is undefined. 444 445 // .globl _foo 446 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_Global); 447 // .zerofill __DATA, __common, _foo, 400, 5 448 OutStreamer->EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog); 449 return; 450 } 451 452 // Handle thread local data for mach-o which requires us to output an 453 // additional structure of data and mangle the original symbol so that we 454 // can reference it later. 455 // 456 // TODO: This should become an "emit thread local global" method on TLOF. 457 // All of this macho specific stuff should be sunk down into TLOFMachO and 458 // stuff like "TLSExtraDataSection" should no longer be part of the parent 459 // TLOF class. This will also make it more obvious that stuff like 460 // MCStreamer::EmitTBSSSymbol is macho specific and only called from macho 461 // specific code. 462 if (GVKind.isThreadLocal() && MAI->hasMachoTBSSDirective()) { 463 // Emit the .tbss symbol 464 MCSymbol *MangSym = 465 OutContext.getOrCreateSymbol(GVSym->getName() + Twine("$tlv$init")); 466 467 if (GVKind.isThreadBSS()) { 468 TheSection = getObjFileLowering().getTLSBSSSection(); 469 OutStreamer->EmitTBSSSymbol(TheSection, MangSym, Size, 1 << AlignLog); 470 } else if (GVKind.isThreadData()) { 471 OutStreamer->SwitchSection(TheSection); 472 473 EmitAlignment(AlignLog, GV); 474 OutStreamer->EmitLabel(MangSym); 475 476 EmitGlobalConstant(GV->getInitializer()); 477 } 478 479 OutStreamer->AddBlankLine(); 480 481 // Emit the variable struct for the runtime. 482 MCSection *TLVSect = getObjFileLowering().getTLSExtraDataSection(); 483 484 OutStreamer->SwitchSection(TLVSect); 485 // Emit the linkage here. 486 EmitLinkage(GV, GVSym); 487 OutStreamer->EmitLabel(GVSym); 488 489 // Three pointers in size: 490 // - __tlv_bootstrap - used to make sure support exists 491 // - spare pointer, used when mapped by the runtime 492 // - pointer to mangled symbol above with initializer 493 unsigned PtrSize = DL->getPointerTypeSize(GV->getType()); 494 OutStreamer->EmitSymbolValue(GetExternalSymbolSymbol("_tlv_bootstrap"), 495 PtrSize); 496 OutStreamer->EmitIntValue(0, PtrSize); 497 OutStreamer->EmitSymbolValue(MangSym, PtrSize); 498 499 OutStreamer->AddBlankLine(); 500 return; 501 } 502 503 OutStreamer->SwitchSection(TheSection); 504 505 EmitLinkage(GV, GVSym); 506 EmitAlignment(AlignLog, GV); 507 508 OutStreamer->EmitLabel(GVSym); 509 510 EmitGlobalConstant(GV->getInitializer()); 511 512 if (MAI->hasDotTypeDotSizeDirective()) 513 // .size foo, 42 514 OutStreamer->emitELFSize(cast<MCSymbolELF>(GVSym), 515 MCConstantExpr::create(Size, OutContext)); 516 517 OutStreamer->AddBlankLine(); 518 } 519 520 /// EmitFunctionHeader - This method emits the header for the current 521 /// function. 522 void AsmPrinter::EmitFunctionHeader() { 523 // Print out constants referenced by the function 524 EmitConstantPool(); 525 526 // Print the 'header' of function. 527 const Function *F = MF->getFunction(); 528 529 OutStreamer->SwitchSection( 530 getObjFileLowering().SectionForGlobal(F, *Mang, TM)); 531 EmitVisibility(CurrentFnSym, F->getVisibility()); 532 533 EmitLinkage(F, CurrentFnSym); 534 if (MAI->hasFunctionAlignment()) 535 EmitAlignment(MF->getAlignment(), F); 536 537 if (MAI->hasDotTypeDotSizeDirective()) 538 OutStreamer->EmitSymbolAttribute(CurrentFnSym, MCSA_ELF_TypeFunction); 539 540 if (isVerbose()) { 541 F->printAsOperand(OutStreamer->GetCommentOS(), 542 /*PrintType=*/false, F->getParent()); 543 OutStreamer->GetCommentOS() << '\n'; 544 } 545 546 // Emit the prefix data. 547 if (F->hasPrefixData()) 548 EmitGlobalConstant(F->getPrefixData()); 549 550 // Emit the CurrentFnSym. This is a virtual function to allow targets to 551 // do their wild and crazy things as required. 552 EmitFunctionEntryLabel(); 553 554 // If the function had address-taken blocks that got deleted, then we have 555 // references to the dangling symbols. Emit them at the start of the function 556 // so that we don't get references to undefined symbols. 557 std::vector<MCSymbol*> DeadBlockSyms; 558 MMI->takeDeletedSymbolsForFunction(F, DeadBlockSyms); 559 for (unsigned i = 0, e = DeadBlockSyms.size(); i != e; ++i) { 560 OutStreamer->AddComment("Address taken block that was later removed"); 561 OutStreamer->EmitLabel(DeadBlockSyms[i]); 562 } 563 564 if (CurrentFnBegin) { 565 if (MAI->useAssignmentForEHBegin()) { 566 MCSymbol *CurPos = OutContext.createTempSymbol(); 567 OutStreamer->EmitLabel(CurPos); 568 OutStreamer->EmitAssignment(CurrentFnBegin, 569 MCSymbolRefExpr::create(CurPos, OutContext)); 570 } else { 571 OutStreamer->EmitLabel(CurrentFnBegin); 572 } 573 } 574 575 // Emit pre-function debug and/or EH information. 576 for (const HandlerInfo &HI : Handlers) { 577 NamedRegionTimer T(HI.TimerName, HI.TimerGroupName, TimePassesIsEnabled); 578 HI.Handler->beginFunction(MF); 579 } 580 581 // Emit the prologue data. 582 if (F->hasPrologueData()) 583 EmitGlobalConstant(F->getPrologueData()); 584 } 585 586 /// EmitFunctionEntryLabel - Emit the label that is the entrypoint for the 587 /// function. This can be overridden by targets as required to do custom stuff. 588 void AsmPrinter::EmitFunctionEntryLabel() { 589 CurrentFnSym->redefineIfPossible(); 590 591 // The function label could have already been emitted if two symbols end up 592 // conflicting due to asm renaming. Detect this and emit an error. 593 if (CurrentFnSym->isVariable()) 594 report_fatal_error("'" + Twine(CurrentFnSym->getName()) + 595 "' is a protected alias"); 596 if (CurrentFnSym->isDefined()) 597 report_fatal_error("'" + Twine(CurrentFnSym->getName()) + 598 "' label emitted multiple times to assembly file"); 599 600 return OutStreamer->EmitLabel(CurrentFnSym); 601 } 602 603 /// emitComments - Pretty-print comments for instructions. 604 static void emitComments(const MachineInstr &MI, raw_ostream &CommentOS) { 605 const MachineFunction *MF = MI.getParent()->getParent(); 606 const TargetInstrInfo *TII = MF->getSubtarget().getInstrInfo(); 607 608 // Check for spills and reloads 609 int FI; 610 611 const MachineFrameInfo *FrameInfo = MF->getFrameInfo(); 612 613 // We assume a single instruction only has a spill or reload, not 614 // both. 615 const MachineMemOperand *MMO; 616 if (TII->isLoadFromStackSlotPostFE(&MI, FI)) { 617 if (FrameInfo->isSpillSlotObjectIndex(FI)) { 618 MMO = *MI.memoperands_begin(); 619 CommentOS << MMO->getSize() << "-byte Reload\n"; 620 } 621 } else if (TII->hasLoadFromStackSlot(&MI, MMO, FI)) { 622 if (FrameInfo->isSpillSlotObjectIndex(FI)) 623 CommentOS << MMO->getSize() << "-byte Folded Reload\n"; 624 } else if (TII->isStoreToStackSlotPostFE(&MI, FI)) { 625 if (FrameInfo->isSpillSlotObjectIndex(FI)) { 626 MMO = *MI.memoperands_begin(); 627 CommentOS << MMO->getSize() << "-byte Spill\n"; 628 } 629 } else if (TII->hasStoreToStackSlot(&MI, MMO, FI)) { 630 if (FrameInfo->isSpillSlotObjectIndex(FI)) 631 CommentOS << MMO->getSize() << "-byte Folded Spill\n"; 632 } 633 634 // Check for spill-induced copies 635 if (MI.getAsmPrinterFlag(MachineInstr::ReloadReuse)) 636 CommentOS << " Reload Reuse\n"; 637 } 638 639 /// emitImplicitDef - This method emits the specified machine instruction 640 /// that is an implicit def. 641 void AsmPrinter::emitImplicitDef(const MachineInstr *MI) const { 642 unsigned RegNo = MI->getOperand(0).getReg(); 643 OutStreamer->AddComment(Twine("implicit-def: ") + 644 MMI->getContext().getRegisterInfo()->getName(RegNo)); 645 OutStreamer->AddBlankLine(); 646 } 647 648 static void emitKill(const MachineInstr *MI, AsmPrinter &AP) { 649 std::string Str = "kill:"; 650 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) { 651 const MachineOperand &Op = MI->getOperand(i); 652 assert(Op.isReg() && "KILL instruction must have only register operands"); 653 Str += ' '; 654 Str += AP.MMI->getContext().getRegisterInfo()->getName(Op.getReg()); 655 Str += (Op.isDef() ? "<def>" : "<kill>"); 656 } 657 AP.OutStreamer->AddComment(Str); 658 AP.OutStreamer->AddBlankLine(); 659 } 660 661 /// emitDebugValueComment - This method handles the target-independent form 662 /// of DBG_VALUE, returning true if it was able to do so. A false return 663 /// means the target will need to handle MI in EmitInstruction. 664 static bool emitDebugValueComment(const MachineInstr *MI, AsmPrinter &AP) { 665 // This code handles only the 4-operand target-independent form. 666 if (MI->getNumOperands() != 4) 667 return false; 668 669 SmallString<128> Str; 670 raw_svector_ostream OS(Str); 671 OS << "DEBUG_VALUE: "; 672 673 const DILocalVariable *V = MI->getDebugVariable(); 674 if (auto *SP = dyn_cast<DISubprogram>(V->getScope())) { 675 StringRef Name = SP->getDisplayName(); 676 if (!Name.empty()) 677 OS << Name << ":"; 678 } 679 OS << V->getName(); 680 681 const DIExpression *Expr = MI->getDebugExpression(); 682 if (Expr->isBitPiece()) 683 OS << " [bit_piece offset=" << Expr->getBitPieceOffset() 684 << " size=" << Expr->getBitPieceSize() << "]"; 685 OS << " <- "; 686 687 // The second operand is only an offset if it's an immediate. 688 bool Deref = MI->getOperand(0).isReg() && MI->getOperand(1).isImm(); 689 int64_t Offset = Deref ? MI->getOperand(1).getImm() : 0; 690 691 // Register or immediate value. Register 0 means undef. 692 if (MI->getOperand(0).isFPImm()) { 693 APFloat APF = APFloat(MI->getOperand(0).getFPImm()->getValueAPF()); 694 if (MI->getOperand(0).getFPImm()->getType()->isFloatTy()) { 695 OS << (double)APF.convertToFloat(); 696 } else if (MI->getOperand(0).getFPImm()->getType()->isDoubleTy()) { 697 OS << APF.convertToDouble(); 698 } else { 699 // There is no good way to print long double. Convert a copy to 700 // double. Ah well, it's only a comment. 701 bool ignored; 702 APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, 703 &ignored); 704 OS << "(long double) " << APF.convertToDouble(); 705 } 706 } else if (MI->getOperand(0).isImm()) { 707 OS << MI->getOperand(0).getImm(); 708 } else if (MI->getOperand(0).isCImm()) { 709 MI->getOperand(0).getCImm()->getValue().print(OS, false /*isSigned*/); 710 } else { 711 unsigned Reg; 712 if (MI->getOperand(0).isReg()) { 713 Reg = MI->getOperand(0).getReg(); 714 } else { 715 assert(MI->getOperand(0).isFI() && "Unknown operand type"); 716 const TargetFrameLowering *TFI = AP.MF->getSubtarget().getFrameLowering(); 717 Offset += TFI->getFrameIndexReference(*AP.MF, 718 MI->getOperand(0).getIndex(), Reg); 719 Deref = true; 720 } 721 if (Reg == 0) { 722 // Suppress offset, it is not meaningful here. 723 OS << "undef"; 724 // NOTE: Want this comment at start of line, don't emit with AddComment. 725 AP.OutStreamer->emitRawComment(OS.str()); 726 return true; 727 } 728 if (Deref) 729 OS << '['; 730 OS << AP.MMI->getContext().getRegisterInfo()->getName(Reg); 731 } 732 733 if (Deref) 734 OS << '+' << Offset << ']'; 735 736 // NOTE: Want this comment at start of line, don't emit with AddComment. 737 AP.OutStreamer->emitRawComment(OS.str()); 738 return true; 739 } 740 741 AsmPrinter::CFIMoveType AsmPrinter::needsCFIMoves() { 742 if (MAI->getExceptionHandlingType() == ExceptionHandling::DwarfCFI && 743 MF->getFunction()->needsUnwindTableEntry()) 744 return CFI_M_EH; 745 746 if (MMI->hasDebugInfo()) 747 return CFI_M_Debug; 748 749 return CFI_M_None; 750 } 751 752 bool AsmPrinter::needsSEHMoves() { 753 return MAI->usesWindowsCFI() && MF->getFunction()->needsUnwindTableEntry(); 754 } 755 756 void AsmPrinter::emitCFIInstruction(const MachineInstr &MI) { 757 ExceptionHandling ExceptionHandlingType = MAI->getExceptionHandlingType(); 758 if (ExceptionHandlingType != ExceptionHandling::DwarfCFI && 759 ExceptionHandlingType != ExceptionHandling::ARM) 760 return; 761 762 if (needsCFIMoves() == CFI_M_None) 763 return; 764 765 const MachineModuleInfo &MMI = MF->getMMI(); 766 const std::vector<MCCFIInstruction> &Instrs = MMI.getFrameInstructions(); 767 unsigned CFIIndex = MI.getOperand(0).getCFIIndex(); 768 const MCCFIInstruction &CFI = Instrs[CFIIndex]; 769 emitCFIInstruction(CFI); 770 } 771 772 void AsmPrinter::emitFrameAlloc(const MachineInstr &MI) { 773 // The operands are the MCSymbol and the frame offset of the allocation. 774 MCSymbol *FrameAllocSym = MI.getOperand(0).getMCSymbol(); 775 int FrameOffset = MI.getOperand(1).getImm(); 776 777 // Emit a symbol assignment. 778 OutStreamer->EmitAssignment(FrameAllocSym, 779 MCConstantExpr::create(FrameOffset, OutContext)); 780 } 781 782 /// EmitFunctionBody - This method emits the body and trailer for a 783 /// function. 784 void AsmPrinter::EmitFunctionBody() { 785 EmitFunctionHeader(); 786 787 // Emit target-specific gunk before the function body. 788 EmitFunctionBodyStart(); 789 790 bool ShouldPrintDebugScopes = MMI->hasDebugInfo(); 791 792 // Print out code for the function. 793 bool HasAnyRealCode = false; 794 for (auto &MBB : *MF) { 795 // Print a label for the basic block. 796 EmitBasicBlockStart(MBB); 797 for (auto &MI : MBB) { 798 799 // Print the assembly for the instruction. 800 if (!MI.isPosition() && !MI.isImplicitDef() && !MI.isKill() && 801 !MI.isDebugValue()) { 802 HasAnyRealCode = true; 803 ++EmittedInsts; 804 } 805 806 if (ShouldPrintDebugScopes) { 807 for (const HandlerInfo &HI : Handlers) { 808 NamedRegionTimer T(HI.TimerName, HI.TimerGroupName, 809 TimePassesIsEnabled); 810 HI.Handler->beginInstruction(&MI); 811 } 812 } 813 814 if (isVerbose()) 815 emitComments(MI, OutStreamer->GetCommentOS()); 816 817 switch (MI.getOpcode()) { 818 case TargetOpcode::CFI_INSTRUCTION: 819 emitCFIInstruction(MI); 820 break; 821 822 case TargetOpcode::FRAME_ALLOC: 823 emitFrameAlloc(MI); 824 break; 825 826 case TargetOpcode::EH_LABEL: 827 case TargetOpcode::GC_LABEL: 828 OutStreamer->EmitLabel(MI.getOperand(0).getMCSymbol()); 829 break; 830 case TargetOpcode::INLINEASM: 831 EmitInlineAsm(&MI); 832 break; 833 case TargetOpcode::DBG_VALUE: 834 if (isVerbose()) { 835 if (!emitDebugValueComment(&MI, *this)) 836 EmitInstruction(&MI); 837 } 838 break; 839 case TargetOpcode::IMPLICIT_DEF: 840 if (isVerbose()) emitImplicitDef(&MI); 841 break; 842 case TargetOpcode::KILL: 843 if (isVerbose()) emitKill(&MI, *this); 844 break; 845 default: 846 EmitInstruction(&MI); 847 break; 848 } 849 850 if (ShouldPrintDebugScopes) { 851 for (const HandlerInfo &HI : Handlers) { 852 NamedRegionTimer T(HI.TimerName, HI.TimerGroupName, 853 TimePassesIsEnabled); 854 HI.Handler->endInstruction(); 855 } 856 } 857 } 858 859 EmitBasicBlockEnd(MBB); 860 } 861 862 // If the function is empty and the object file uses .subsections_via_symbols, 863 // then we need to emit *something* to the function body to prevent the 864 // labels from collapsing together. Just emit a noop. 865 if ((MAI->hasSubsectionsViaSymbols() && !HasAnyRealCode)) { 866 MCInst Noop; 867 MF->getSubtarget().getInstrInfo()->getNoopForMachoTarget(Noop); 868 OutStreamer->AddComment("avoids zero-length function"); 869 870 // Targets can opt-out of emitting the noop here by leaving the opcode 871 // unspecified. 872 if (Noop.getOpcode()) 873 OutStreamer->EmitInstruction(Noop, getSubtargetInfo()); 874 } 875 876 const Function *F = MF->getFunction(); 877 for (const auto &BB : *F) { 878 if (!BB.hasAddressTaken()) 879 continue; 880 MCSymbol *Sym = GetBlockAddressSymbol(&BB); 881 if (Sym->isDefined()) 882 continue; 883 OutStreamer->AddComment("Address of block that was removed by CodeGen"); 884 OutStreamer->EmitLabel(Sym); 885 } 886 887 // Emit target-specific gunk after the function body. 888 EmitFunctionBodyEnd(); 889 890 if (!MMI->getLandingPads().empty() || MMI->hasDebugInfo() || 891 MAI->hasDotTypeDotSizeDirective()) { 892 // Create a symbol for the end of function. 893 CurrentFnEnd = createTempSymbol("func_end"); 894 OutStreamer->EmitLabel(CurrentFnEnd); 895 } 896 897 // If the target wants a .size directive for the size of the function, emit 898 // it. 899 if (MAI->hasDotTypeDotSizeDirective()) { 900 // We can get the size as difference between the function label and the 901 // temp label. 902 const MCExpr *SizeExp = 903 MCBinaryExpr::createSub(MCSymbolRefExpr::create(CurrentFnEnd, OutContext), 904 MCSymbolRefExpr::create(CurrentFnSymForSize, 905 OutContext), 906 OutContext); 907 OutStreamer->emitELFSize(cast<MCSymbolELF>(CurrentFnSym), SizeExp); 908 } 909 910 for (const HandlerInfo &HI : Handlers) { 911 NamedRegionTimer T(HI.TimerName, HI.TimerGroupName, TimePassesIsEnabled); 912 HI.Handler->markFunctionEnd(); 913 } 914 915 // Print out jump tables referenced by the function. 916 EmitJumpTableInfo(); 917 918 // Emit post-function debug and/or EH information. 919 for (const HandlerInfo &HI : Handlers) { 920 NamedRegionTimer T(HI.TimerName, HI.TimerGroupName, TimePassesIsEnabled); 921 HI.Handler->endFunction(MF); 922 } 923 MMI->EndFunction(); 924 925 OutStreamer->AddBlankLine(); 926 } 927 928 /// \brief Compute the number of Global Variables that uses a Constant. 929 static unsigned getNumGlobalVariableUses(const Constant *C) { 930 if (!C) 931 return 0; 932 933 if (isa<GlobalVariable>(C)) 934 return 1; 935 936 unsigned NumUses = 0; 937 for (auto *CU : C->users()) 938 NumUses += getNumGlobalVariableUses(dyn_cast<Constant>(CU)); 939 940 return NumUses; 941 } 942 943 /// \brief Only consider global GOT equivalents if at least one user is a 944 /// cstexpr inside an initializer of another global variables. Also, don't 945 /// handle cstexpr inside instructions. During global variable emission, 946 /// candidates are skipped and are emitted later in case at least one cstexpr 947 /// isn't replaced by a PC relative GOT entry access. 948 static bool isGOTEquivalentCandidate(const GlobalVariable *GV, 949 unsigned &NumGOTEquivUsers) { 950 // Global GOT equivalents are unnamed private globals with a constant 951 // pointer initializer to another global symbol. They must point to a 952 // GlobalVariable or Function, i.e., as GlobalValue. 953 if (!GV->hasUnnamedAddr() || !GV->hasInitializer() || !GV->isConstant() || 954 !GV->isDiscardableIfUnused() || !dyn_cast<GlobalValue>(GV->getOperand(0))) 955 return false; 956 957 // To be a got equivalent, at least one of its users need to be a constant 958 // expression used by another global variable. 959 for (auto *U : GV->users()) 960 NumGOTEquivUsers += getNumGlobalVariableUses(dyn_cast<Constant>(U)); 961 962 return NumGOTEquivUsers > 0; 963 } 964 965 /// \brief Unnamed constant global variables solely contaning a pointer to 966 /// another globals variable is equivalent to a GOT table entry; it contains the 967 /// the address of another symbol. Optimize it and replace accesses to these 968 /// "GOT equivalents" by using the GOT entry for the final global instead. 969 /// Compute GOT equivalent candidates among all global variables to avoid 970 /// emitting them if possible later on, after it use is replaced by a GOT entry 971 /// access. 972 void AsmPrinter::computeGlobalGOTEquivs(Module &M) { 973 if (!getObjFileLowering().supportIndirectSymViaGOTPCRel()) 974 return; 975 976 for (const auto &G : M.globals()) { 977 unsigned NumGOTEquivUsers = 0; 978 if (!isGOTEquivalentCandidate(&G, NumGOTEquivUsers)) 979 continue; 980 981 const MCSymbol *GOTEquivSym = getSymbol(&G); 982 GlobalGOTEquivs[GOTEquivSym] = std::make_pair(&G, NumGOTEquivUsers); 983 } 984 } 985 986 /// \brief Constant expressions using GOT equivalent globals may not be eligible 987 /// for PC relative GOT entry conversion, in such cases we need to emit such 988 /// globals we previously omitted in EmitGlobalVariable. 989 void AsmPrinter::emitGlobalGOTEquivs() { 990 if (!getObjFileLowering().supportIndirectSymViaGOTPCRel()) 991 return; 992 993 SmallVector<const GlobalVariable *, 8> FailedCandidates; 994 for (auto &I : GlobalGOTEquivs) { 995 const GlobalVariable *GV = I.second.first; 996 unsigned Cnt = I.second.second; 997 if (Cnt) 998 FailedCandidates.push_back(GV); 999 } 1000 GlobalGOTEquivs.clear(); 1001 1002 for (auto *GV : FailedCandidates) 1003 EmitGlobalVariable(GV); 1004 } 1005 1006 bool AsmPrinter::doFinalization(Module &M) { 1007 // Set the MachineFunction to nullptr so that we can catch attempted 1008 // accesses to MF specific features at the module level and so that 1009 // we can conditionalize accesses based on whether or not it is nullptr. 1010 MF = nullptr; 1011 1012 // Gather all GOT equivalent globals in the module. We really need two 1013 // passes over the globals: one to compute and another to avoid its emission 1014 // in EmitGlobalVariable, otherwise we would not be able to handle cases 1015 // where the got equivalent shows up before its use. 1016 computeGlobalGOTEquivs(M); 1017 1018 // Emit global variables. 1019 for (const auto &G : M.globals()) 1020 EmitGlobalVariable(&G); 1021 1022 // Emit remaining GOT equivalent globals. 1023 emitGlobalGOTEquivs(); 1024 1025 // Emit visibility info for declarations 1026 for (const Function &F : M) { 1027 if (!F.isDeclaration()) 1028 continue; 1029 GlobalValue::VisibilityTypes V = F.getVisibility(); 1030 if (V == GlobalValue::DefaultVisibility) 1031 continue; 1032 1033 MCSymbol *Name = getSymbol(&F); 1034 EmitVisibility(Name, V, false); 1035 } 1036 1037 const TargetLoweringObjectFile &TLOF = getObjFileLowering(); 1038 1039 // Emit module flags. 1040 SmallVector<Module::ModuleFlagEntry, 8> ModuleFlags; 1041 M.getModuleFlagsMetadata(ModuleFlags); 1042 if (!ModuleFlags.empty()) 1043 TLOF.emitModuleFlags(*OutStreamer, ModuleFlags, *Mang, TM); 1044 1045 Triple TT(TM.getTargetTriple()); 1046 if (TT.isOSBinFormatELF()) { 1047 MachineModuleInfoELF &MMIELF = MMI->getObjFileInfo<MachineModuleInfoELF>(); 1048 1049 // Output stubs for external and common global variables. 1050 MachineModuleInfoELF::SymbolListTy Stubs = MMIELF.GetGVStubList(); 1051 if (!Stubs.empty()) { 1052 OutStreamer->SwitchSection(TLOF.getDataRelSection()); 1053 const DataLayout *DL = TM.getDataLayout(); 1054 1055 for (const auto &Stub : Stubs) { 1056 OutStreamer->EmitLabel(Stub.first); 1057 OutStreamer->EmitSymbolValue(Stub.second.getPointer(), 1058 DL->getPointerSize()); 1059 } 1060 } 1061 } 1062 1063 // Make sure we wrote out everything we need. 1064 OutStreamer->Flush(); 1065 1066 // Finalize debug and EH information. 1067 for (const HandlerInfo &HI : Handlers) { 1068 NamedRegionTimer T(HI.TimerName, HI.TimerGroupName, 1069 TimePassesIsEnabled); 1070 HI.Handler->endModule(); 1071 delete HI.Handler; 1072 } 1073 Handlers.clear(); 1074 DD = nullptr; 1075 1076 // If the target wants to know about weak references, print them all. 1077 if (MAI->getWeakRefDirective()) { 1078 // FIXME: This is not lazy, it would be nice to only print weak references 1079 // to stuff that is actually used. Note that doing so would require targets 1080 // to notice uses in operands (due to constant exprs etc). This should 1081 // happen with the MC stuff eventually. 1082 1083 // Print out module-level global variables here. 1084 for (const auto &G : M.globals()) { 1085 if (!G.hasExternalWeakLinkage()) 1086 continue; 1087 OutStreamer->EmitSymbolAttribute(getSymbol(&G), MCSA_WeakReference); 1088 } 1089 1090 for (const auto &F : M) { 1091 if (!F.hasExternalWeakLinkage()) 1092 continue; 1093 OutStreamer->EmitSymbolAttribute(getSymbol(&F), MCSA_WeakReference); 1094 } 1095 } 1096 1097 OutStreamer->AddBlankLine(); 1098 for (const auto &Alias : M.aliases()) { 1099 MCSymbol *Name = getSymbol(&Alias); 1100 1101 if (Alias.hasExternalLinkage() || !MAI->getWeakRefDirective()) 1102 OutStreamer->EmitSymbolAttribute(Name, MCSA_Global); 1103 else if (Alias.hasWeakLinkage() || Alias.hasLinkOnceLinkage()) 1104 OutStreamer->EmitSymbolAttribute(Name, MCSA_WeakReference); 1105 else 1106 assert(Alias.hasLocalLinkage() && "Invalid alias linkage"); 1107 1108 EmitVisibility(Name, Alias.getVisibility()); 1109 1110 // Emit the directives as assignments aka .set: 1111 OutStreamer->EmitAssignment(Name, lowerConstant(Alias.getAliasee())); 1112 } 1113 1114 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>(); 1115 assert(MI && "AsmPrinter didn't require GCModuleInfo?"); 1116 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; ) 1117 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(**--I)) 1118 MP->finishAssembly(M, *MI, *this); 1119 1120 // Emit llvm.ident metadata in an '.ident' directive. 1121 EmitModuleIdents(M); 1122 1123 // Emit __morestack address if needed for indirect calls. 1124 if (MMI->usesMorestackAddr()) { 1125 MCSection *ReadOnlySection = 1126 getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly(), 1127 /*C=*/nullptr); 1128 OutStreamer->SwitchSection(ReadOnlySection); 1129 1130 MCSymbol *AddrSymbol = 1131 OutContext.getOrCreateSymbol(StringRef("__morestack_addr")); 1132 OutStreamer->EmitLabel(AddrSymbol); 1133 1134 unsigned PtrSize = TM.getDataLayout()->getPointerSize(0); 1135 OutStreamer->EmitSymbolValue(GetExternalSymbolSymbol("__morestack"), 1136 PtrSize); 1137 } 1138 1139 // If we don't have any trampolines, then we don't require stack memory 1140 // to be executable. Some targets have a directive to declare this. 1141 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline"); 1142 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty()) 1143 if (MCSection *S = MAI->getNonexecutableStackSection(OutContext)) 1144 OutStreamer->SwitchSection(S); 1145 1146 // Allow the target to emit any magic that it wants at the end of the file, 1147 // after everything else has gone out. 1148 EmitEndOfAsmFile(M); 1149 1150 delete Mang; Mang = nullptr; 1151 MMI = nullptr; 1152 1153 OutStreamer->Finish(); 1154 OutStreamer->reset(); 1155 1156 return false; 1157 } 1158 1159 MCSymbol *AsmPrinter::getCurExceptionSym() { 1160 if (!CurExceptionSym) 1161 CurExceptionSym = createTempSymbol("exception"); 1162 return CurExceptionSym; 1163 } 1164 1165 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) { 1166 this->MF = &MF; 1167 // Get the function symbol. 1168 CurrentFnSym = getSymbol(MF.getFunction()); 1169 CurrentFnSymForSize = CurrentFnSym; 1170 CurrentFnBegin = nullptr; 1171 CurExceptionSym = nullptr; 1172 bool NeedsLocalForSize = MAI->needsLocalForSize(); 1173 if (!MMI->getLandingPads().empty() || MMI->hasDebugInfo() || 1174 NeedsLocalForSize) { 1175 CurrentFnBegin = createTempSymbol("func_begin"); 1176 if (NeedsLocalForSize) 1177 CurrentFnSymForSize = CurrentFnBegin; 1178 } 1179 1180 if (isVerbose()) 1181 LI = &getAnalysis<MachineLoopInfo>(); 1182 } 1183 1184 namespace { 1185 // Keep track the alignment, constpool entries per Section. 1186 struct SectionCPs { 1187 MCSection *S; 1188 unsigned Alignment; 1189 SmallVector<unsigned, 4> CPEs; 1190 SectionCPs(MCSection *s, unsigned a) : S(s), Alignment(a) {} 1191 }; 1192 } 1193 1194 /// EmitConstantPool - Print to the current output stream assembly 1195 /// representations of the constants in the constant pool MCP. This is 1196 /// used to print out constants which have been "spilled to memory" by 1197 /// the code generator. 1198 /// 1199 void AsmPrinter::EmitConstantPool() { 1200 const MachineConstantPool *MCP = MF->getConstantPool(); 1201 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants(); 1202 if (CP.empty()) return; 1203 1204 // Calculate sections for constant pool entries. We collect entries to go into 1205 // the same section together to reduce amount of section switch statements. 1206 SmallVector<SectionCPs, 4> CPSections; 1207 for (unsigned i = 0, e = CP.size(); i != e; ++i) { 1208 const MachineConstantPoolEntry &CPE = CP[i]; 1209 unsigned Align = CPE.getAlignment(); 1210 1211 SectionKind Kind = 1212 CPE.getSectionKind(TM.getDataLayout()); 1213 1214 const Constant *C = nullptr; 1215 if (!CPE.isMachineConstantPoolEntry()) 1216 C = CPE.Val.ConstVal; 1217 1218 MCSection *S = getObjFileLowering().getSectionForConstant(Kind, C); 1219 1220 // The number of sections are small, just do a linear search from the 1221 // last section to the first. 1222 bool Found = false; 1223 unsigned SecIdx = CPSections.size(); 1224 while (SecIdx != 0) { 1225 if (CPSections[--SecIdx].S == S) { 1226 Found = true; 1227 break; 1228 } 1229 } 1230 if (!Found) { 1231 SecIdx = CPSections.size(); 1232 CPSections.push_back(SectionCPs(S, Align)); 1233 } 1234 1235 if (Align > CPSections[SecIdx].Alignment) 1236 CPSections[SecIdx].Alignment = Align; 1237 CPSections[SecIdx].CPEs.push_back(i); 1238 } 1239 1240 // Now print stuff into the calculated sections. 1241 const MCSection *CurSection = nullptr; 1242 unsigned Offset = 0; 1243 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) { 1244 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) { 1245 unsigned CPI = CPSections[i].CPEs[j]; 1246 MCSymbol *Sym = GetCPISymbol(CPI); 1247 if (!Sym->isUndefined()) 1248 continue; 1249 1250 if (CurSection != CPSections[i].S) { 1251 OutStreamer->SwitchSection(CPSections[i].S); 1252 EmitAlignment(Log2_32(CPSections[i].Alignment)); 1253 CurSection = CPSections[i].S; 1254 Offset = 0; 1255 } 1256 1257 MachineConstantPoolEntry CPE = CP[CPI]; 1258 1259 // Emit inter-object padding for alignment. 1260 unsigned AlignMask = CPE.getAlignment() - 1; 1261 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask; 1262 OutStreamer->EmitZeros(NewOffset - Offset); 1263 1264 Type *Ty = CPE.getType(); 1265 Offset = NewOffset + 1266 TM.getDataLayout()->getTypeAllocSize(Ty); 1267 1268 OutStreamer->EmitLabel(Sym); 1269 if (CPE.isMachineConstantPoolEntry()) 1270 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal); 1271 else 1272 EmitGlobalConstant(CPE.Val.ConstVal); 1273 } 1274 } 1275 } 1276 1277 /// EmitJumpTableInfo - Print assembly representations of the jump tables used 1278 /// by the current function to the current output stream. 1279 /// 1280 void AsmPrinter::EmitJumpTableInfo() { 1281 const DataLayout *DL = MF->getTarget().getDataLayout(); 1282 const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo(); 1283 if (!MJTI) return; 1284 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline) return; 1285 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables(); 1286 if (JT.empty()) return; 1287 1288 // Pick the directive to use to print the jump table entries, and switch to 1289 // the appropriate section. 1290 const Function *F = MF->getFunction(); 1291 const TargetLoweringObjectFile &TLOF = getObjFileLowering(); 1292 bool JTInDiffSection = !TLOF.shouldPutJumpTableInFunctionSection( 1293 MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32, 1294 *F); 1295 if (JTInDiffSection) { 1296 // Drop it in the readonly section. 1297 MCSection *ReadOnlySection = TLOF.getSectionForJumpTable(*F, *Mang, TM); 1298 OutStreamer->SwitchSection(ReadOnlySection); 1299 } 1300 1301 EmitAlignment(Log2_32( 1302 MJTI->getEntryAlignment(*TM.getDataLayout()))); 1303 1304 // Jump tables in code sections are marked with a data_region directive 1305 // where that's supported. 1306 if (!JTInDiffSection) 1307 OutStreamer->EmitDataRegion(MCDR_DataRegionJT32); 1308 1309 for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) { 1310 const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs; 1311 1312 // If this jump table was deleted, ignore it. 1313 if (JTBBs.empty()) continue; 1314 1315 // For the EK_LabelDifference32 entry, if using .set avoids a relocation, 1316 /// emit a .set directive for each unique entry. 1317 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 && 1318 MAI->doesSetDirectiveSuppressesReloc()) { 1319 SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets; 1320 const TargetLowering *TLI = MF->getSubtarget().getTargetLowering(); 1321 const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF,JTI,OutContext); 1322 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) { 1323 const MachineBasicBlock *MBB = JTBBs[ii]; 1324 if (!EmittedSets.insert(MBB).second) 1325 continue; 1326 1327 // .set LJTSet, LBB32-base 1328 const MCExpr *LHS = 1329 MCSymbolRefExpr::create(MBB->getSymbol(), OutContext); 1330 OutStreamer->EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()), 1331 MCBinaryExpr::createSub(LHS, Base, 1332 OutContext)); 1333 } 1334 } 1335 1336 // On some targets (e.g. Darwin) we want to emit two consecutive labels 1337 // before each jump table. The first label is never referenced, but tells 1338 // the assembler and linker the extents of the jump table object. The 1339 // second label is actually referenced by the code. 1340 if (JTInDiffSection && DL->hasLinkerPrivateGlobalPrefix()) 1341 // FIXME: This doesn't have to have any specific name, just any randomly 1342 // named and numbered 'l' label would work. Simplify GetJTISymbol. 1343 OutStreamer->EmitLabel(GetJTISymbol(JTI, true)); 1344 1345 OutStreamer->EmitLabel(GetJTISymbol(JTI)); 1346 1347 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) 1348 EmitJumpTableEntry(MJTI, JTBBs[ii], JTI); 1349 } 1350 if (!JTInDiffSection) 1351 OutStreamer->EmitDataRegion(MCDR_DataRegionEnd); 1352 } 1353 1354 /// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the 1355 /// current stream. 1356 void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI, 1357 const MachineBasicBlock *MBB, 1358 unsigned UID) const { 1359 assert(MBB && MBB->getNumber() >= 0 && "Invalid basic block"); 1360 const MCExpr *Value = nullptr; 1361 switch (MJTI->getEntryKind()) { 1362 case MachineJumpTableInfo::EK_Inline: 1363 llvm_unreachable("Cannot emit EK_Inline jump table entry"); 1364 case MachineJumpTableInfo::EK_Custom32: 1365 Value = MF->getSubtarget().getTargetLowering()->LowerCustomJumpTableEntry( 1366 MJTI, MBB, UID, OutContext); 1367 break; 1368 case MachineJumpTableInfo::EK_BlockAddress: 1369 // EK_BlockAddress - Each entry is a plain address of block, e.g.: 1370 // .word LBB123 1371 Value = MCSymbolRefExpr::create(MBB->getSymbol(), OutContext); 1372 break; 1373 case MachineJumpTableInfo::EK_GPRel32BlockAddress: { 1374 // EK_GPRel32BlockAddress - Each entry is an address of block, encoded 1375 // with a relocation as gp-relative, e.g.: 1376 // .gprel32 LBB123 1377 MCSymbol *MBBSym = MBB->getSymbol(); 1378 OutStreamer->EmitGPRel32Value(MCSymbolRefExpr::create(MBBSym, OutContext)); 1379 return; 1380 } 1381 1382 case MachineJumpTableInfo::EK_GPRel64BlockAddress: { 1383 // EK_GPRel64BlockAddress - Each entry is an address of block, encoded 1384 // with a relocation as gp-relative, e.g.: 1385 // .gpdword LBB123 1386 MCSymbol *MBBSym = MBB->getSymbol(); 1387 OutStreamer->EmitGPRel64Value(MCSymbolRefExpr::create(MBBSym, OutContext)); 1388 return; 1389 } 1390 1391 case MachineJumpTableInfo::EK_LabelDifference32: { 1392 // Each entry is the address of the block minus the address of the jump 1393 // table. This is used for PIC jump tables where gprel32 is not supported. 1394 // e.g.: 1395 // .word LBB123 - LJTI1_2 1396 // If the .set directive avoids relocations, this is emitted as: 1397 // .set L4_5_set_123, LBB123 - LJTI1_2 1398 // .word L4_5_set_123 1399 if (MAI->doesSetDirectiveSuppressesReloc()) { 1400 Value = MCSymbolRefExpr::create(GetJTSetSymbol(UID, MBB->getNumber()), 1401 OutContext); 1402 break; 1403 } 1404 Value = MCSymbolRefExpr::create(MBB->getSymbol(), OutContext); 1405 const TargetLowering *TLI = MF->getSubtarget().getTargetLowering(); 1406 const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF, UID, OutContext); 1407 Value = MCBinaryExpr::createSub(Value, Base, OutContext); 1408 break; 1409 } 1410 } 1411 1412 assert(Value && "Unknown entry kind!"); 1413 1414 unsigned EntrySize = 1415 MJTI->getEntrySize(*TM.getDataLayout()); 1416 OutStreamer->EmitValue(Value, EntrySize); 1417 } 1418 1419 1420 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a 1421 /// special global used by LLVM. If so, emit it and return true, otherwise 1422 /// do nothing and return false. 1423 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) { 1424 if (GV->getName() == "llvm.used") { 1425 if (MAI->hasNoDeadStrip()) // No need to emit this at all. 1426 EmitLLVMUsedList(cast<ConstantArray>(GV->getInitializer())); 1427 return true; 1428 } 1429 1430 // Ignore debug and non-emitted data. This handles llvm.compiler.used. 1431 if (StringRef(GV->getSection()) == "llvm.metadata" || 1432 GV->hasAvailableExternallyLinkage()) 1433 return true; 1434 1435 if (!GV->hasAppendingLinkage()) return false; 1436 1437 assert(GV->hasInitializer() && "Not a special LLVM global!"); 1438 1439 if (GV->getName() == "llvm.global_ctors") { 1440 EmitXXStructorList(GV->getInitializer(), /* isCtor */ true); 1441 1442 if (TM.getRelocationModel() == Reloc::Static && 1443 MAI->hasStaticCtorDtorReferenceInStaticMode()) { 1444 StringRef Sym(".constructors_used"); 1445 OutStreamer->EmitSymbolAttribute(OutContext.getOrCreateSymbol(Sym), 1446 MCSA_Reference); 1447 } 1448 return true; 1449 } 1450 1451 if (GV->getName() == "llvm.global_dtors") { 1452 EmitXXStructorList(GV->getInitializer(), /* isCtor */ false); 1453 1454 if (TM.getRelocationModel() == Reloc::Static && 1455 MAI->hasStaticCtorDtorReferenceInStaticMode()) { 1456 StringRef Sym(".destructors_used"); 1457 OutStreamer->EmitSymbolAttribute(OutContext.getOrCreateSymbol(Sym), 1458 MCSA_Reference); 1459 } 1460 return true; 1461 } 1462 1463 return false; 1464 } 1465 1466 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each 1467 /// global in the specified llvm.used list for which emitUsedDirectiveFor 1468 /// is true, as being used with this directive. 1469 void AsmPrinter::EmitLLVMUsedList(const ConstantArray *InitList) { 1470 // Should be an array of 'i8*'. 1471 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) { 1472 const GlobalValue *GV = 1473 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts()); 1474 if (GV) 1475 OutStreamer->EmitSymbolAttribute(getSymbol(GV), MCSA_NoDeadStrip); 1476 } 1477 } 1478 1479 namespace { 1480 struct Structor { 1481 Structor() : Priority(0), Func(nullptr), ComdatKey(nullptr) {} 1482 int Priority; 1483 llvm::Constant *Func; 1484 llvm::GlobalValue *ComdatKey; 1485 }; 1486 } // end namespace 1487 1488 /// EmitXXStructorList - Emit the ctor or dtor list taking into account the init 1489 /// priority. 1490 void AsmPrinter::EmitXXStructorList(const Constant *List, bool isCtor) { 1491 // Should be an array of '{ int, void ()* }' structs. The first value is the 1492 // init priority. 1493 if (!isa<ConstantArray>(List)) return; 1494 1495 // Sanity check the structors list. 1496 const ConstantArray *InitList = dyn_cast<ConstantArray>(List); 1497 if (!InitList) return; // Not an array! 1498 StructType *ETy = dyn_cast<StructType>(InitList->getType()->getElementType()); 1499 // FIXME: Only allow the 3-field form in LLVM 4.0. 1500 if (!ETy || ETy->getNumElements() < 2 || ETy->getNumElements() > 3) 1501 return; // Not an array of two or three elements! 1502 if (!isa<IntegerType>(ETy->getTypeAtIndex(0U)) || 1503 !isa<PointerType>(ETy->getTypeAtIndex(1U))) return; // Not (int, ptr). 1504 if (ETy->getNumElements() == 3 && !isa<PointerType>(ETy->getTypeAtIndex(2U))) 1505 return; // Not (int, ptr, ptr). 1506 1507 // Gather the structors in a form that's convenient for sorting by priority. 1508 SmallVector<Structor, 8> Structors; 1509 for (Value *O : InitList->operands()) { 1510 ConstantStruct *CS = dyn_cast<ConstantStruct>(O); 1511 if (!CS) continue; // Malformed. 1512 if (CS->getOperand(1)->isNullValue()) 1513 break; // Found a null terminator, skip the rest. 1514 ConstantInt *Priority = dyn_cast<ConstantInt>(CS->getOperand(0)); 1515 if (!Priority) continue; // Malformed. 1516 Structors.push_back(Structor()); 1517 Structor &S = Structors.back(); 1518 S.Priority = Priority->getLimitedValue(65535); 1519 S.Func = CS->getOperand(1); 1520 if (ETy->getNumElements() == 3 && !CS->getOperand(2)->isNullValue()) 1521 S.ComdatKey = dyn_cast<GlobalValue>(CS->getOperand(2)->stripPointerCasts()); 1522 } 1523 1524 // Emit the function pointers in the target-specific order 1525 const DataLayout *DL = TM.getDataLayout(); 1526 unsigned Align = Log2_32(DL->getPointerPrefAlignment()); 1527 std::stable_sort(Structors.begin(), Structors.end(), 1528 [](const Structor &L, 1529 const Structor &R) { return L.Priority < R.Priority; }); 1530 for (Structor &S : Structors) { 1531 const TargetLoweringObjectFile &Obj = getObjFileLowering(); 1532 const MCSymbol *KeySym = nullptr; 1533 if (GlobalValue *GV = S.ComdatKey) { 1534 if (GV->hasAvailableExternallyLinkage()) 1535 // If the associated variable is available_externally, some other TU 1536 // will provide its dynamic initializer. 1537 continue; 1538 1539 KeySym = getSymbol(GV); 1540 } 1541 MCSection *OutputSection = 1542 (isCtor ? Obj.getStaticCtorSection(S.Priority, KeySym) 1543 : Obj.getStaticDtorSection(S.Priority, KeySym)); 1544 OutStreamer->SwitchSection(OutputSection); 1545 if (OutStreamer->getCurrentSection() != OutStreamer->getPreviousSection()) 1546 EmitAlignment(Align); 1547 EmitXXStructor(S.Func); 1548 } 1549 } 1550 1551 void AsmPrinter::EmitModuleIdents(Module &M) { 1552 if (!MAI->hasIdentDirective()) 1553 return; 1554 1555 if (const NamedMDNode *NMD = M.getNamedMetadata("llvm.ident")) { 1556 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) { 1557 const MDNode *N = NMD->getOperand(i); 1558 assert(N->getNumOperands() == 1 && 1559 "llvm.ident metadata entry can have only one operand"); 1560 const MDString *S = cast<MDString>(N->getOperand(0)); 1561 OutStreamer->EmitIdent(S->getString()); 1562 } 1563 } 1564 } 1565 1566 //===--------------------------------------------------------------------===// 1567 // Emission and print routines 1568 // 1569 1570 /// EmitInt8 - Emit a byte directive and value. 1571 /// 1572 void AsmPrinter::EmitInt8(int Value) const { 1573 OutStreamer->EmitIntValue(Value, 1); 1574 } 1575 1576 /// EmitInt16 - Emit a short directive and value. 1577 /// 1578 void AsmPrinter::EmitInt16(int Value) const { 1579 OutStreamer->EmitIntValue(Value, 2); 1580 } 1581 1582 /// EmitInt32 - Emit a long directive and value. 1583 /// 1584 void AsmPrinter::EmitInt32(int Value) const { 1585 OutStreamer->EmitIntValue(Value, 4); 1586 } 1587 1588 /// Emit something like ".long Hi-Lo" where the size in bytes of the directive 1589 /// is specified by Size and Hi/Lo specify the labels. This implicitly uses 1590 /// .set if it avoids relocations. 1591 void AsmPrinter::EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo, 1592 unsigned Size) const { 1593 OutStreamer->emitAbsoluteSymbolDiff(Hi, Lo, Size); 1594 } 1595 1596 /// EmitLabelPlusOffset - Emit something like ".long Label+Offset" 1597 /// where the size in bytes of the directive is specified by Size and Label 1598 /// specifies the label. This implicitly uses .set if it is available. 1599 void AsmPrinter::EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset, 1600 unsigned Size, 1601 bool IsSectionRelative) const { 1602 if (MAI->needsDwarfSectionOffsetDirective() && IsSectionRelative) { 1603 OutStreamer->EmitCOFFSecRel32(Label); 1604 return; 1605 } 1606 1607 // Emit Label+Offset (or just Label if Offset is zero) 1608 const MCExpr *Expr = MCSymbolRefExpr::create(Label, OutContext); 1609 if (Offset) 1610 Expr = MCBinaryExpr::createAdd( 1611 Expr, MCConstantExpr::create(Offset, OutContext), OutContext); 1612 1613 OutStreamer->EmitValue(Expr, Size); 1614 } 1615 1616 //===----------------------------------------------------------------------===// 1617 1618 // EmitAlignment - Emit an alignment directive to the specified power of 1619 // two boundary. For example, if you pass in 3 here, you will get an 8 1620 // byte alignment. If a global value is specified, and if that global has 1621 // an explicit alignment requested, it will override the alignment request 1622 // if required for correctness. 1623 // 1624 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalObject *GV) const { 1625 if (GV) 1626 NumBits = getGVAlignmentLog2(GV, *TM.getDataLayout(), 1627 NumBits); 1628 1629 if (NumBits == 0) return; // 1-byte aligned: no need to emit alignment. 1630 1631 assert(NumBits < 1632 static_cast<unsigned>(std::numeric_limits<unsigned>::digits) && 1633 "undefined behavior"); 1634 if (getCurrentSection()->getKind().isText()) 1635 OutStreamer->EmitCodeAlignment(1u << NumBits); 1636 else 1637 OutStreamer->EmitValueToAlignment(1u << NumBits); 1638 } 1639 1640 //===----------------------------------------------------------------------===// 1641 // Constant emission. 1642 //===----------------------------------------------------------------------===// 1643 1644 const MCExpr *AsmPrinter::lowerConstant(const Constant *CV) { 1645 MCContext &Ctx = OutContext; 1646 1647 if (CV->isNullValue() || isa<UndefValue>(CV)) 1648 return MCConstantExpr::create(0, Ctx); 1649 1650 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) 1651 return MCConstantExpr::create(CI->getZExtValue(), Ctx); 1652 1653 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV)) 1654 return MCSymbolRefExpr::create(getSymbol(GV), Ctx); 1655 1656 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) 1657 return MCSymbolRefExpr::create(GetBlockAddressSymbol(BA), Ctx); 1658 1659 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV); 1660 if (!CE) { 1661 llvm_unreachable("Unknown constant value to lower!"); 1662 } 1663 1664 if (const MCExpr *RelocExpr 1665 = getObjFileLowering().getExecutableRelativeSymbol(CE, *Mang, TM)) 1666 return RelocExpr; 1667 1668 switch (CE->getOpcode()) { 1669 default: 1670 // If the code isn't optimized, there may be outstanding folding 1671 // opportunities. Attempt to fold the expression using DataLayout as a 1672 // last resort before giving up. 1673 if (Constant *C = ConstantFoldConstantExpression(CE, *TM.getDataLayout())) 1674 if (C != CE) 1675 return lowerConstant(C); 1676 1677 // Otherwise report the problem to the user. 1678 { 1679 std::string S; 1680 raw_string_ostream OS(S); 1681 OS << "Unsupported expression in static initializer: "; 1682 CE->printAsOperand(OS, /*PrintType=*/false, 1683 !MF ? nullptr : MF->getFunction()->getParent()); 1684 report_fatal_error(OS.str()); 1685 } 1686 case Instruction::GetElementPtr: { 1687 const DataLayout &DL = *TM.getDataLayout(); 1688 1689 // Generate a symbolic expression for the byte address 1690 APInt OffsetAI(DL.getPointerTypeSizeInBits(CE->getType()), 0); 1691 cast<GEPOperator>(CE)->accumulateConstantOffset(DL, OffsetAI); 1692 1693 const MCExpr *Base = lowerConstant(CE->getOperand(0)); 1694 if (!OffsetAI) 1695 return Base; 1696 1697 int64_t Offset = OffsetAI.getSExtValue(); 1698 return MCBinaryExpr::createAdd(Base, MCConstantExpr::create(Offset, Ctx), 1699 Ctx); 1700 } 1701 1702 case Instruction::Trunc: 1703 // We emit the value and depend on the assembler to truncate the generated 1704 // expression properly. This is important for differences between 1705 // blockaddress labels. Since the two labels are in the same function, it 1706 // is reasonable to treat their delta as a 32-bit value. 1707 // FALL THROUGH. 1708 case Instruction::BitCast: 1709 return lowerConstant(CE->getOperand(0)); 1710 1711 case Instruction::IntToPtr: { 1712 const DataLayout &DL = *TM.getDataLayout(); 1713 1714 // Handle casts to pointers by changing them into casts to the appropriate 1715 // integer type. This promotes constant folding and simplifies this code. 1716 Constant *Op = CE->getOperand(0); 1717 Op = ConstantExpr::getIntegerCast(Op, DL.getIntPtrType(CV->getType()), 1718 false/*ZExt*/); 1719 return lowerConstant(Op); 1720 } 1721 1722 case Instruction::PtrToInt: { 1723 const DataLayout &DL = *TM.getDataLayout(); 1724 1725 // Support only foldable casts to/from pointers that can be eliminated by 1726 // changing the pointer to the appropriately sized integer type. 1727 Constant *Op = CE->getOperand(0); 1728 Type *Ty = CE->getType(); 1729 1730 const MCExpr *OpExpr = lowerConstant(Op); 1731 1732 // We can emit the pointer value into this slot if the slot is an 1733 // integer slot equal to the size of the pointer. 1734 if (DL.getTypeAllocSize(Ty) == DL.getTypeAllocSize(Op->getType())) 1735 return OpExpr; 1736 1737 // Otherwise the pointer is smaller than the resultant integer, mask off 1738 // the high bits so we are sure to get a proper truncation if the input is 1739 // a constant expr. 1740 unsigned InBits = DL.getTypeAllocSizeInBits(Op->getType()); 1741 const MCExpr *MaskExpr = MCConstantExpr::create(~0ULL >> (64-InBits), Ctx); 1742 return MCBinaryExpr::createAnd(OpExpr, MaskExpr, Ctx); 1743 } 1744 1745 // The MC library also has a right-shift operator, but it isn't consistently 1746 // signed or unsigned between different targets. 1747 case Instruction::Add: 1748 case Instruction::Sub: 1749 case Instruction::Mul: 1750 case Instruction::SDiv: 1751 case Instruction::SRem: 1752 case Instruction::Shl: 1753 case Instruction::And: 1754 case Instruction::Or: 1755 case Instruction::Xor: { 1756 const MCExpr *LHS = lowerConstant(CE->getOperand(0)); 1757 const MCExpr *RHS = lowerConstant(CE->getOperand(1)); 1758 switch (CE->getOpcode()) { 1759 default: llvm_unreachable("Unknown binary operator constant cast expr"); 1760 case Instruction::Add: return MCBinaryExpr::createAdd(LHS, RHS, Ctx); 1761 case Instruction::Sub: return MCBinaryExpr::createSub(LHS, RHS, Ctx); 1762 case Instruction::Mul: return MCBinaryExpr::createMul(LHS, RHS, Ctx); 1763 case Instruction::SDiv: return MCBinaryExpr::createDiv(LHS, RHS, Ctx); 1764 case Instruction::SRem: return MCBinaryExpr::createMod(LHS, RHS, Ctx); 1765 case Instruction::Shl: return MCBinaryExpr::createShl(LHS, RHS, Ctx); 1766 case Instruction::And: return MCBinaryExpr::createAnd(LHS, RHS, Ctx); 1767 case Instruction::Or: return MCBinaryExpr::createOr (LHS, RHS, Ctx); 1768 case Instruction::Xor: return MCBinaryExpr::createXor(LHS, RHS, Ctx); 1769 } 1770 } 1771 } 1772 } 1773 1774 static void emitGlobalConstantImpl(const Constant *C, AsmPrinter &AP, 1775 const Constant *BaseCV = nullptr, 1776 uint64_t Offset = 0); 1777 1778 /// isRepeatedByteSequence - Determine whether the given value is 1779 /// composed of a repeated sequence of identical bytes and return the 1780 /// byte value. If it is not a repeated sequence, return -1. 1781 static int isRepeatedByteSequence(const ConstantDataSequential *V) { 1782 StringRef Data = V->getRawDataValues(); 1783 assert(!Data.empty() && "Empty aggregates should be CAZ node"); 1784 char C = Data[0]; 1785 for (unsigned i = 1, e = Data.size(); i != e; ++i) 1786 if (Data[i] != C) return -1; 1787 return static_cast<uint8_t>(C); // Ensure 255 is not returned as -1. 1788 } 1789 1790 1791 /// isRepeatedByteSequence - Determine whether the given value is 1792 /// composed of a repeated sequence of identical bytes and return the 1793 /// byte value. If it is not a repeated sequence, return -1. 1794 static int isRepeatedByteSequence(const Value *V, TargetMachine &TM) { 1795 1796 if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) { 1797 if (CI->getBitWidth() > 64) return -1; 1798 1799 uint64_t Size = 1800 TM.getDataLayout()->getTypeAllocSize(V->getType()); 1801 uint64_t Value = CI->getZExtValue(); 1802 1803 // Make sure the constant is at least 8 bits long and has a power 1804 // of 2 bit width. This guarantees the constant bit width is 1805 // always a multiple of 8 bits, avoiding issues with padding out 1806 // to Size and other such corner cases. 1807 if (CI->getBitWidth() < 8 || !isPowerOf2_64(CI->getBitWidth())) return -1; 1808 1809 uint8_t Byte = static_cast<uint8_t>(Value); 1810 1811 for (unsigned i = 1; i < Size; ++i) { 1812 Value >>= 8; 1813 if (static_cast<uint8_t>(Value) != Byte) return -1; 1814 } 1815 return Byte; 1816 } 1817 if (const ConstantArray *CA = dyn_cast<ConstantArray>(V)) { 1818 // Make sure all array elements are sequences of the same repeated 1819 // byte. 1820 assert(CA->getNumOperands() != 0 && "Should be a CAZ"); 1821 int Byte = isRepeatedByteSequence(CA->getOperand(0), TM); 1822 if (Byte == -1) return -1; 1823 1824 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) { 1825 int ThisByte = isRepeatedByteSequence(CA->getOperand(i), TM); 1826 if (ThisByte == -1) return -1; 1827 if (Byte != ThisByte) return -1; 1828 } 1829 return Byte; 1830 } 1831 1832 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V)) 1833 return isRepeatedByteSequence(CDS); 1834 1835 return -1; 1836 } 1837 1838 static void emitGlobalConstantDataSequential(const ConstantDataSequential *CDS, 1839 AsmPrinter &AP){ 1840 1841 // See if we can aggregate this into a .fill, if so, emit it as such. 1842 int Value = isRepeatedByteSequence(CDS, AP.TM); 1843 if (Value != -1) { 1844 uint64_t Bytes = 1845 AP.TM.getDataLayout()->getTypeAllocSize( 1846 CDS->getType()); 1847 // Don't emit a 1-byte object as a .fill. 1848 if (Bytes > 1) 1849 return AP.OutStreamer->EmitFill(Bytes, Value); 1850 } 1851 1852 // If this can be emitted with .ascii/.asciz, emit it as such. 1853 if (CDS->isString()) 1854 return AP.OutStreamer->EmitBytes(CDS->getAsString()); 1855 1856 // Otherwise, emit the values in successive locations. 1857 unsigned ElementByteSize = CDS->getElementByteSize(); 1858 if (isa<IntegerType>(CDS->getElementType())) { 1859 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) { 1860 if (AP.isVerbose()) 1861 AP.OutStreamer->GetCommentOS() << format("0x%" PRIx64 "\n", 1862 CDS->getElementAsInteger(i)); 1863 AP.OutStreamer->EmitIntValue(CDS->getElementAsInteger(i), 1864 ElementByteSize); 1865 } 1866 } else if (ElementByteSize == 4) { 1867 // FP Constants are printed as integer constants to avoid losing 1868 // precision. 1869 assert(CDS->getElementType()->isFloatTy()); 1870 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) { 1871 union { 1872 float F; 1873 uint32_t I; 1874 }; 1875 1876 F = CDS->getElementAsFloat(i); 1877 if (AP.isVerbose()) 1878 AP.OutStreamer->GetCommentOS() << "float " << F << '\n'; 1879 AP.OutStreamer->EmitIntValue(I, 4); 1880 } 1881 } else { 1882 assert(CDS->getElementType()->isDoubleTy()); 1883 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) { 1884 union { 1885 double F; 1886 uint64_t I; 1887 }; 1888 1889 F = CDS->getElementAsDouble(i); 1890 if (AP.isVerbose()) 1891 AP.OutStreamer->GetCommentOS() << "double " << F << '\n'; 1892 AP.OutStreamer->EmitIntValue(I, 8); 1893 } 1894 } 1895 1896 const DataLayout &DL = *AP.TM.getDataLayout(); 1897 unsigned Size = DL.getTypeAllocSize(CDS->getType()); 1898 unsigned EmittedSize = DL.getTypeAllocSize(CDS->getType()->getElementType()) * 1899 CDS->getNumElements(); 1900 if (unsigned Padding = Size - EmittedSize) 1901 AP.OutStreamer->EmitZeros(Padding); 1902 1903 } 1904 1905 static void emitGlobalConstantArray(const ConstantArray *CA, AsmPrinter &AP, 1906 const Constant *BaseCV, uint64_t Offset) { 1907 // See if we can aggregate some values. Make sure it can be 1908 // represented as a series of bytes of the constant value. 1909 int Value = isRepeatedByteSequence(CA, AP.TM); 1910 const DataLayout &DL = *AP.TM.getDataLayout(); 1911 1912 if (Value != -1) { 1913 uint64_t Bytes = DL.getTypeAllocSize(CA->getType()); 1914 AP.OutStreamer->EmitFill(Bytes, Value); 1915 } 1916 else { 1917 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i) { 1918 emitGlobalConstantImpl(CA->getOperand(i), AP, BaseCV, Offset); 1919 Offset += DL.getTypeAllocSize(CA->getOperand(i)->getType()); 1920 } 1921 } 1922 } 1923 1924 static void emitGlobalConstantVector(const ConstantVector *CV, AsmPrinter &AP) { 1925 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i) 1926 emitGlobalConstantImpl(CV->getOperand(i), AP); 1927 1928 const DataLayout &DL = *AP.TM.getDataLayout(); 1929 unsigned Size = DL.getTypeAllocSize(CV->getType()); 1930 unsigned EmittedSize = DL.getTypeAllocSize(CV->getType()->getElementType()) * 1931 CV->getType()->getNumElements(); 1932 if (unsigned Padding = Size - EmittedSize) 1933 AP.OutStreamer->EmitZeros(Padding); 1934 } 1935 1936 static void emitGlobalConstantStruct(const ConstantStruct *CS, AsmPrinter &AP, 1937 const Constant *BaseCV, uint64_t Offset) { 1938 // Print the fields in successive locations. Pad to align if needed! 1939 const DataLayout *DL = AP.TM.getDataLayout(); 1940 unsigned Size = DL->getTypeAllocSize(CS->getType()); 1941 const StructLayout *Layout = DL->getStructLayout(CS->getType()); 1942 uint64_t SizeSoFar = 0; 1943 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) { 1944 const Constant *Field = CS->getOperand(i); 1945 1946 // Print the actual field value. 1947 emitGlobalConstantImpl(Field, AP, BaseCV, Offset+SizeSoFar); 1948 1949 // Check if padding is needed and insert one or more 0s. 1950 uint64_t FieldSize = DL->getTypeAllocSize(Field->getType()); 1951 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1)) 1952 - Layout->getElementOffset(i)) - FieldSize; 1953 SizeSoFar += FieldSize + PadSize; 1954 1955 // Insert padding - this may include padding to increase the size of the 1956 // current field up to the ABI size (if the struct is not packed) as well 1957 // as padding to ensure that the next field starts at the right offset. 1958 AP.OutStreamer->EmitZeros(PadSize); 1959 } 1960 assert(SizeSoFar == Layout->getSizeInBytes() && 1961 "Layout of constant struct may be incorrect!"); 1962 } 1963 1964 static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP) { 1965 APInt API = CFP->getValueAPF().bitcastToAPInt(); 1966 1967 // First print a comment with what we think the original floating-point value 1968 // should have been. 1969 if (AP.isVerbose()) { 1970 SmallString<8> StrVal; 1971 CFP->getValueAPF().toString(StrVal); 1972 1973 if (CFP->getType()) 1974 CFP->getType()->print(AP.OutStreamer->GetCommentOS()); 1975 else 1976 AP.OutStreamer->GetCommentOS() << "Printing <null> Type"; 1977 AP.OutStreamer->GetCommentOS() << ' ' << StrVal << '\n'; 1978 } 1979 1980 // Now iterate through the APInt chunks, emitting them in endian-correct 1981 // order, possibly with a smaller chunk at beginning/end (e.g. for x87 80-bit 1982 // floats). 1983 unsigned NumBytes = API.getBitWidth() / 8; 1984 unsigned TrailingBytes = NumBytes % sizeof(uint64_t); 1985 const uint64_t *p = API.getRawData(); 1986 1987 // PPC's long double has odd notions of endianness compared to how LLVM 1988 // handles it: p[0] goes first for *big* endian on PPC. 1989 if (AP.TM.getDataLayout()->isBigEndian() && 1990 !CFP->getType()->isPPC_FP128Ty()) { 1991 int Chunk = API.getNumWords() - 1; 1992 1993 if (TrailingBytes) 1994 AP.OutStreamer->EmitIntValue(p[Chunk--], TrailingBytes); 1995 1996 for (; Chunk >= 0; --Chunk) 1997 AP.OutStreamer->EmitIntValue(p[Chunk], sizeof(uint64_t)); 1998 } else { 1999 unsigned Chunk; 2000 for (Chunk = 0; Chunk < NumBytes / sizeof(uint64_t); ++Chunk) 2001 AP.OutStreamer->EmitIntValue(p[Chunk], sizeof(uint64_t)); 2002 2003 if (TrailingBytes) 2004 AP.OutStreamer->EmitIntValue(p[Chunk], TrailingBytes); 2005 } 2006 2007 // Emit the tail padding for the long double. 2008 const DataLayout &DL = *AP.TM.getDataLayout(); 2009 AP.OutStreamer->EmitZeros(DL.getTypeAllocSize(CFP->getType()) - 2010 DL.getTypeStoreSize(CFP->getType())); 2011 } 2012 2013 static void emitGlobalConstantLargeInt(const ConstantInt *CI, AsmPrinter &AP) { 2014 const DataLayout *DL = AP.TM.getDataLayout(); 2015 unsigned BitWidth = CI->getBitWidth(); 2016 2017 // Copy the value as we may massage the layout for constants whose bit width 2018 // is not a multiple of 64-bits. 2019 APInt Realigned(CI->getValue()); 2020 uint64_t ExtraBits = 0; 2021 unsigned ExtraBitsSize = BitWidth & 63; 2022 2023 if (ExtraBitsSize) { 2024 // The bit width of the data is not a multiple of 64-bits. 2025 // The extra bits are expected to be at the end of the chunk of the memory. 2026 // Little endian: 2027 // * Nothing to be done, just record the extra bits to emit. 2028 // Big endian: 2029 // * Record the extra bits to emit. 2030 // * Realign the raw data to emit the chunks of 64-bits. 2031 if (DL->isBigEndian()) { 2032 // Basically the structure of the raw data is a chunk of 64-bits cells: 2033 // 0 1 BitWidth / 64 2034 // [chunk1][chunk2] ... [chunkN]. 2035 // The most significant chunk is chunkN and it should be emitted first. 2036 // However, due to the alignment issue chunkN contains useless bits. 2037 // Realign the chunks so that they contain only useless information: 2038 // ExtraBits 0 1 (BitWidth / 64) - 1 2039 // chu[nk1 chu][nk2 chu] ... [nkN-1 chunkN] 2040 ExtraBits = Realigned.getRawData()[0] & 2041 (((uint64_t)-1) >> (64 - ExtraBitsSize)); 2042 Realigned = Realigned.lshr(ExtraBitsSize); 2043 } else 2044 ExtraBits = Realigned.getRawData()[BitWidth / 64]; 2045 } 2046 2047 // We don't expect assemblers to support integer data directives 2048 // for more than 64 bits, so we emit the data in at most 64-bit 2049 // quantities at a time. 2050 const uint64_t *RawData = Realigned.getRawData(); 2051 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) { 2052 uint64_t Val = DL->isBigEndian() ? RawData[e - i - 1] : RawData[i]; 2053 AP.OutStreamer->EmitIntValue(Val, 8); 2054 } 2055 2056 if (ExtraBitsSize) { 2057 // Emit the extra bits after the 64-bits chunks. 2058 2059 // Emit a directive that fills the expected size. 2060 uint64_t Size = AP.TM.getDataLayout()->getTypeAllocSize( 2061 CI->getType()); 2062 Size -= (BitWidth / 64) * 8; 2063 assert(Size && Size * 8 >= ExtraBitsSize && 2064 (ExtraBits & (((uint64_t)-1) >> (64 - ExtraBitsSize))) 2065 == ExtraBits && "Directive too small for extra bits."); 2066 AP.OutStreamer->EmitIntValue(ExtraBits, Size); 2067 } 2068 } 2069 2070 /// \brief Transform a not absolute MCExpr containing a reference to a GOT 2071 /// equivalent global, by a target specific GOT pc relative access to the 2072 /// final symbol. 2073 static void handleIndirectSymViaGOTPCRel(AsmPrinter &AP, const MCExpr **ME, 2074 const Constant *BaseCst, 2075 uint64_t Offset) { 2076 // The global @foo below illustrates a global that uses a got equivalent. 2077 // 2078 // @bar = global i32 42 2079 // @gotequiv = private unnamed_addr constant i32* @bar 2080 // @foo = i32 trunc (i64 sub (i64 ptrtoint (i32** @gotequiv to i64), 2081 // i64 ptrtoint (i32* @foo to i64)) 2082 // to i32) 2083 // 2084 // The cstexpr in @foo is converted into the MCExpr `ME`, where we actually 2085 // check whether @foo is suitable to use a GOTPCREL. `ME` is usually in the 2086 // form: 2087 // 2088 // foo = cstexpr, where 2089 // cstexpr := <gotequiv> - "." + <cst> 2090 // cstexpr := <gotequiv> - (<foo> - <offset from @foo base>) + <cst> 2091 // 2092 // After canonicalization by evaluateAsRelocatable `ME` turns into: 2093 // 2094 // cstexpr := <gotequiv> - <foo> + gotpcrelcst, where 2095 // gotpcrelcst := <offset from @foo base> + <cst> 2096 // 2097 MCValue MV; 2098 if (!(*ME)->evaluateAsRelocatable(MV, nullptr, nullptr) || MV.isAbsolute()) 2099 return; 2100 2101 const MCSymbol *GOTEquivSym = &MV.getSymA()->getSymbol(); 2102 if (!AP.GlobalGOTEquivs.count(GOTEquivSym)) 2103 return; 2104 2105 const GlobalValue *BaseGV = dyn_cast<GlobalValue>(BaseCst); 2106 if (!BaseGV) 2107 return; 2108 2109 const MCSymbol *BaseSym = AP.getSymbol(BaseGV); 2110 if (BaseSym != &MV.getSymB()->getSymbol()) 2111 return; 2112 2113 // Make sure to match: 2114 // 2115 // gotpcrelcst := <offset from @foo base> + <cst> 2116 // 2117 // If gotpcrelcst is positive it means that we can safely fold the pc rel 2118 // displacement into the GOTPCREL. We can also can have an extra offset <cst> 2119 // if the target knows how to encode it. 2120 // 2121 int64_t GOTPCRelCst = Offset + MV.getConstant(); 2122 if (GOTPCRelCst < 0) 2123 return; 2124 if (!AP.getObjFileLowering().supportGOTPCRelWithOffset() && GOTPCRelCst != 0) 2125 return; 2126 2127 // Emit the GOT PC relative to replace the got equivalent global, i.e.: 2128 // 2129 // bar: 2130 // .long 42 2131 // gotequiv: 2132 // .quad bar 2133 // foo: 2134 // .long gotequiv - "." + <cst> 2135 // 2136 // is replaced by the target specific equivalent to: 2137 // 2138 // bar: 2139 // .long 42 2140 // foo: 2141 // .long bar@GOTPCREL+<gotpcrelcst> 2142 // 2143 AsmPrinter::GOTEquivUsePair Result = AP.GlobalGOTEquivs[GOTEquivSym]; 2144 const GlobalVariable *GV = Result.first; 2145 int NumUses = (int)Result.second; 2146 const GlobalValue *FinalGV = dyn_cast<GlobalValue>(GV->getOperand(0)); 2147 const MCSymbol *FinalSym = AP.getSymbol(FinalGV); 2148 *ME = AP.getObjFileLowering().getIndirectSymViaGOTPCRel( 2149 FinalSym, MV, Offset, AP.MMI, *AP.OutStreamer); 2150 2151 // Update GOT equivalent usage information 2152 --NumUses; 2153 if (NumUses >= 0) 2154 AP.GlobalGOTEquivs[GOTEquivSym] = std::make_pair(GV, NumUses); 2155 } 2156 2157 static void emitGlobalConstantImpl(const Constant *CV, AsmPrinter &AP, 2158 const Constant *BaseCV, uint64_t Offset) { 2159 const DataLayout *DL = AP.TM.getDataLayout(); 2160 uint64_t Size = DL->getTypeAllocSize(CV->getType()); 2161 2162 // Globals with sub-elements such as combinations of arrays and structs 2163 // are handled recursively by emitGlobalConstantImpl. Keep track of the 2164 // constant symbol base and the current position with BaseCV and Offset. 2165 if (!BaseCV && CV->hasOneUse()) 2166 BaseCV = dyn_cast<Constant>(CV->user_back()); 2167 2168 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) 2169 return AP.OutStreamer->EmitZeros(Size); 2170 2171 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) { 2172 switch (Size) { 2173 case 1: 2174 case 2: 2175 case 4: 2176 case 8: 2177 if (AP.isVerbose()) 2178 AP.OutStreamer->GetCommentOS() << format("0x%" PRIx64 "\n", 2179 CI->getZExtValue()); 2180 AP.OutStreamer->EmitIntValue(CI->getZExtValue(), Size); 2181 return; 2182 default: 2183 emitGlobalConstantLargeInt(CI, AP); 2184 return; 2185 } 2186 } 2187 2188 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) 2189 return emitGlobalConstantFP(CFP, AP); 2190 2191 if (isa<ConstantPointerNull>(CV)) { 2192 AP.OutStreamer->EmitIntValue(0, Size); 2193 return; 2194 } 2195 2196 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(CV)) 2197 return emitGlobalConstantDataSequential(CDS, AP); 2198 2199 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) 2200 return emitGlobalConstantArray(CVA, AP, BaseCV, Offset); 2201 2202 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) 2203 return emitGlobalConstantStruct(CVS, AP, BaseCV, Offset); 2204 2205 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) { 2206 // Look through bitcasts, which might not be able to be MCExpr'ized (e.g. of 2207 // vectors). 2208 if (CE->getOpcode() == Instruction::BitCast) 2209 return emitGlobalConstantImpl(CE->getOperand(0), AP); 2210 2211 if (Size > 8) { 2212 // If the constant expression's size is greater than 64-bits, then we have 2213 // to emit the value in chunks. Try to constant fold the value and emit it 2214 // that way. 2215 Constant *New = ConstantFoldConstantExpression(CE, *DL); 2216 if (New && New != CE) 2217 return emitGlobalConstantImpl(New, AP); 2218 } 2219 } 2220 2221 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV)) 2222 return emitGlobalConstantVector(V, AP); 2223 2224 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it 2225 // thread the streamer with EmitValue. 2226 const MCExpr *ME = AP.lowerConstant(CV); 2227 2228 // Since lowerConstant already folded and got rid of all IR pointer and 2229 // integer casts, detect GOT equivalent accesses by looking into the MCExpr 2230 // directly. 2231 if (AP.getObjFileLowering().supportIndirectSymViaGOTPCRel()) 2232 handleIndirectSymViaGOTPCRel(AP, &ME, BaseCV, Offset); 2233 2234 AP.OutStreamer->EmitValue(ME, Size); 2235 } 2236 2237 /// EmitGlobalConstant - Print a general LLVM constant to the .s file. 2238 void AsmPrinter::EmitGlobalConstant(const Constant *CV) { 2239 uint64_t Size = 2240 TM.getDataLayout()->getTypeAllocSize(CV->getType()); 2241 if (Size) 2242 emitGlobalConstantImpl(CV, *this); 2243 else if (MAI->hasSubsectionsViaSymbols()) { 2244 // If the global has zero size, emit a single byte so that two labels don't 2245 // look like they are at the same location. 2246 OutStreamer->EmitIntValue(0, 1); 2247 } 2248 } 2249 2250 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) { 2251 // Target doesn't support this yet! 2252 llvm_unreachable("Target does not support EmitMachineConstantPoolValue"); 2253 } 2254 2255 void AsmPrinter::printOffset(int64_t Offset, raw_ostream &OS) const { 2256 if (Offset > 0) 2257 OS << '+' << Offset; 2258 else if (Offset < 0) 2259 OS << Offset; 2260 } 2261 2262 //===----------------------------------------------------------------------===// 2263 // Symbol Lowering Routines. 2264 //===----------------------------------------------------------------------===// 2265 2266 MCSymbol *AsmPrinter::createTempSymbol(const Twine &Name) const { 2267 return OutContext.createTempSymbol(Name, true); 2268 } 2269 2270 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const { 2271 return MMI->getAddrLabelSymbol(BA->getBasicBlock()); 2272 } 2273 2274 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BasicBlock *BB) const { 2275 return MMI->getAddrLabelSymbol(BB); 2276 } 2277 2278 /// GetCPISymbol - Return the symbol for the specified constant pool entry. 2279 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const { 2280 const DataLayout *DL = TM.getDataLayout(); 2281 return OutContext.getOrCreateSymbol 2282 (Twine(DL->getPrivateGlobalPrefix()) + "CPI" + Twine(getFunctionNumber()) 2283 + "_" + Twine(CPID)); 2284 } 2285 2286 /// GetJTISymbol - Return the symbol for the specified jump table entry. 2287 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const { 2288 return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate); 2289 } 2290 2291 /// GetJTSetSymbol - Return the symbol for the specified jump table .set 2292 /// FIXME: privatize to AsmPrinter. 2293 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const { 2294 const DataLayout *DL = TM.getDataLayout(); 2295 return OutContext.getOrCreateSymbol 2296 (Twine(DL->getPrivateGlobalPrefix()) + Twine(getFunctionNumber()) + "_" + 2297 Twine(UID) + "_set_" + Twine(MBBID)); 2298 } 2299 2300 MCSymbol *AsmPrinter::getSymbolWithGlobalValueBase(const GlobalValue *GV, 2301 StringRef Suffix) const { 2302 return getObjFileLowering().getSymbolWithGlobalValueBase(GV, Suffix, *Mang, 2303 TM); 2304 } 2305 2306 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified 2307 /// ExternalSymbol. 2308 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const { 2309 SmallString<60> NameStr; 2310 Mang->getNameWithPrefix(NameStr, Sym); 2311 return OutContext.getOrCreateSymbol(NameStr); 2312 } 2313 2314 2315 2316 /// PrintParentLoopComment - Print comments about parent loops of this one. 2317 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop, 2318 unsigned FunctionNumber) { 2319 if (!Loop) return; 2320 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber); 2321 OS.indent(Loop->getLoopDepth()*2) 2322 << "Parent Loop BB" << FunctionNumber << "_" 2323 << Loop->getHeader()->getNumber() 2324 << " Depth=" << Loop->getLoopDepth() << '\n'; 2325 } 2326 2327 2328 /// PrintChildLoopComment - Print comments about child loops within 2329 /// the loop for this basic block, with nesting. 2330 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop, 2331 unsigned FunctionNumber) { 2332 // Add child loop information 2333 for (const MachineLoop *CL : *Loop) { 2334 OS.indent(CL->getLoopDepth()*2) 2335 << "Child Loop BB" << FunctionNumber << "_" 2336 << CL->getHeader()->getNumber() << " Depth " << CL->getLoopDepth() 2337 << '\n'; 2338 PrintChildLoopComment(OS, CL, FunctionNumber); 2339 } 2340 } 2341 2342 /// emitBasicBlockLoopComments - Pretty-print comments for basic blocks. 2343 static void emitBasicBlockLoopComments(const MachineBasicBlock &MBB, 2344 const MachineLoopInfo *LI, 2345 const AsmPrinter &AP) { 2346 // Add loop depth information 2347 const MachineLoop *Loop = LI->getLoopFor(&MBB); 2348 if (!Loop) return; 2349 2350 MachineBasicBlock *Header = Loop->getHeader(); 2351 assert(Header && "No header for loop"); 2352 2353 // If this block is not a loop header, just print out what is the loop header 2354 // and return. 2355 if (Header != &MBB) { 2356 AP.OutStreamer->AddComment(" in Loop: Header=BB" + 2357 Twine(AP.getFunctionNumber())+"_" + 2358 Twine(Loop->getHeader()->getNumber())+ 2359 " Depth="+Twine(Loop->getLoopDepth())); 2360 return; 2361 } 2362 2363 // Otherwise, it is a loop header. Print out information about child and 2364 // parent loops. 2365 raw_ostream &OS = AP.OutStreamer->GetCommentOS(); 2366 2367 PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber()); 2368 2369 OS << "=>"; 2370 OS.indent(Loop->getLoopDepth()*2-2); 2371 2372 OS << "This "; 2373 if (Loop->empty()) 2374 OS << "Inner "; 2375 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n'; 2376 2377 PrintChildLoopComment(OS, Loop, AP.getFunctionNumber()); 2378 } 2379 2380 2381 /// EmitBasicBlockStart - This method prints the label for the specified 2382 /// MachineBasicBlock, an alignment (if present) and a comment describing 2383 /// it if appropriate. 2384 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock &MBB) const { 2385 // Emit an alignment directive for this block, if needed. 2386 if (unsigned Align = MBB.getAlignment()) 2387 EmitAlignment(Align); 2388 2389 // If the block has its address taken, emit any labels that were used to 2390 // reference the block. It is possible that there is more than one label 2391 // here, because multiple LLVM BB's may have been RAUW'd to this block after 2392 // the references were generated. 2393 if (MBB.hasAddressTaken()) { 2394 const BasicBlock *BB = MBB.getBasicBlock(); 2395 if (isVerbose()) 2396 OutStreamer->AddComment("Block address taken"); 2397 2398 std::vector<MCSymbol*> Symbols = MMI->getAddrLabelSymbolToEmit(BB); 2399 for (auto *Sym : Symbols) 2400 OutStreamer->EmitLabel(Sym); 2401 } 2402 2403 // Print some verbose block comments. 2404 if (isVerbose()) { 2405 if (const BasicBlock *BB = MBB.getBasicBlock()) 2406 if (BB->hasName()) 2407 OutStreamer->AddComment("%" + BB->getName()); 2408 emitBasicBlockLoopComments(MBB, LI, *this); 2409 } 2410 2411 // Print the main label for the block. 2412 if (MBB.pred_empty() || isBlockOnlyReachableByFallthrough(&MBB)) { 2413 if (isVerbose()) { 2414 // NOTE: Want this comment at start of line, don't emit with AddComment. 2415 OutStreamer->emitRawComment(" BB#" + Twine(MBB.getNumber()) + ":", false); 2416 } 2417 } else { 2418 OutStreamer->EmitLabel(MBB.getSymbol()); 2419 } 2420 } 2421 2422 void AsmPrinter::EmitVisibility(MCSymbol *Sym, unsigned Visibility, 2423 bool IsDefinition) const { 2424 MCSymbolAttr Attr = MCSA_Invalid; 2425 2426 switch (Visibility) { 2427 default: break; 2428 case GlobalValue::HiddenVisibility: 2429 if (IsDefinition) 2430 Attr = MAI->getHiddenVisibilityAttr(); 2431 else 2432 Attr = MAI->getHiddenDeclarationVisibilityAttr(); 2433 break; 2434 case GlobalValue::ProtectedVisibility: 2435 Attr = MAI->getProtectedVisibilityAttr(); 2436 break; 2437 } 2438 2439 if (Attr != MCSA_Invalid) 2440 OutStreamer->EmitSymbolAttribute(Sym, Attr); 2441 } 2442 2443 /// isBlockOnlyReachableByFallthough - Return true if the basic block has 2444 /// exactly one predecessor and the control transfer mechanism between 2445 /// the predecessor and this block is a fall-through. 2446 bool AsmPrinter:: 2447 isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const { 2448 // If this is a landing pad, it isn't a fall through. If it has no preds, 2449 // then nothing falls through to it. 2450 if (MBB->isLandingPad() || MBB->pred_empty()) 2451 return false; 2452 2453 // If there isn't exactly one predecessor, it can't be a fall through. 2454 if (MBB->pred_size() > 1) 2455 return false; 2456 2457 // The predecessor has to be immediately before this block. 2458 MachineBasicBlock *Pred = *MBB->pred_begin(); 2459 if (!Pred->isLayoutSuccessor(MBB)) 2460 return false; 2461 2462 // If the block is completely empty, then it definitely does fall through. 2463 if (Pred->empty()) 2464 return true; 2465 2466 // Check the terminators in the previous blocks 2467 for (const auto &MI : Pred->terminators()) { 2468 // If it is not a simple branch, we are in a table somewhere. 2469 if (!MI.isBranch() || MI.isIndirectBranch()) 2470 return false; 2471 2472 // If we are the operands of one of the branches, this is not a fall 2473 // through. Note that targets with delay slots will usually bundle 2474 // terminators with the delay slot instruction. 2475 for (ConstMIBundleOperands OP(&MI); OP.isValid(); ++OP) { 2476 if (OP->isJTI()) 2477 return false; 2478 if (OP->isMBB() && OP->getMBB() == MBB) 2479 return false; 2480 } 2481 } 2482 2483 return true; 2484 } 2485 2486 2487 2488 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy &S) { 2489 if (!S.usesMetadata()) 2490 return nullptr; 2491 2492 assert(!S.useStatepoints() && "statepoints do not currently support custom" 2493 " stackmap formats, please see the documentation for a description of" 2494 " the default format. If you really need a custom serialized format," 2495 " please file a bug"); 2496 2497 gcp_map_type &GCMap = getGCMap(GCMetadataPrinters); 2498 gcp_map_type::iterator GCPI = GCMap.find(&S); 2499 if (GCPI != GCMap.end()) 2500 return GCPI->second.get(); 2501 2502 const char *Name = S.getName().c_str(); 2503 2504 for (GCMetadataPrinterRegistry::iterator 2505 I = GCMetadataPrinterRegistry::begin(), 2506 E = GCMetadataPrinterRegistry::end(); I != E; ++I) 2507 if (strcmp(Name, I->getName()) == 0) { 2508 std::unique_ptr<GCMetadataPrinter> GMP = I->instantiate(); 2509 GMP->S = &S; 2510 auto IterBool = GCMap.insert(std::make_pair(&S, std::move(GMP))); 2511 return IterBool.first->second.get(); 2512 } 2513 2514 report_fatal_error("no GCMetadataPrinter registered for GC: " + Twine(Name)); 2515 } 2516 2517 /// Pin vtable to this file. 2518 AsmPrinterHandler::~AsmPrinterHandler() {} 2519 2520 void AsmPrinterHandler::markFunctionEnd() {} 2521