1 //===-- AsmPrinter.cpp - Common AsmPrinter code ---------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the AsmPrinter class.
12 //===----------------------------------------------------------------------===//
14 #define DEBUG_TYPE "asm-printer"
15 #include "llvm/CodeGen/AsmPrinter.h"
16 #include "DwarfDebug.h"
17 #include "DwarfException.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/ADT/Statistic.h"
20 #include "llvm/Analysis/ConstantFolding.h"
21 #include "llvm/Assembly/Writer.h"
22 #include "llvm/CodeGen/GCMetadataPrinter.h"
23 #include "llvm/CodeGen/MachineConstantPool.h"
24 #include "llvm/CodeGen/MachineFrameInfo.h"
25 #include "llvm/CodeGen/MachineFunction.h"
26 #include "llvm/CodeGen/MachineJumpTableInfo.h"
27 #include "llvm/CodeGen/MachineLoopInfo.h"
28 #include "llvm/CodeGen/MachineModuleInfo.h"
29 #include "llvm/DebugInfo.h"
30 #include "llvm/IR/DataLayout.h"
31 #include "llvm/IR/Module.h"
32 #include "llvm/IR/Operator.h"
33 #include "llvm/MC/MCAsmInfo.h"
34 #include "llvm/MC/MCContext.h"
35 #include "llvm/MC/MCExpr.h"
36 #include "llvm/MC/MCInst.h"
37 #include "llvm/MC/MCSection.h"
38 #include "llvm/MC/MCStreamer.h"
39 #include "llvm/MC/MCSymbol.h"
40 #include "llvm/Support/ErrorHandling.h"
41 #include "llvm/Support/Format.h"
42 #include "llvm/Support/MathExtras.h"
43 #include "llvm/Support/Timer.h"
44 #include "llvm/Target/Mangler.h"
45 #include "llvm/Target/TargetFrameLowering.h"
46 #include "llvm/Target/TargetInstrInfo.h"
47 #include "llvm/Target/TargetLowering.h"
48 #include "llvm/Target/TargetLoweringObjectFile.h"
49 #include "llvm/Target/TargetOptions.h"
50 #include "llvm/Target/TargetRegisterInfo.h"
53 static const char *const DWARFGroupName = "DWARF Emission";
54 static const char *const DbgTimerName = "DWARF Debug Writer";
55 static const char *const EHTimerName = "DWARF Exception Writer";
57 STATISTIC(EmittedInsts, "Number of machine instrs printed");
59 char AsmPrinter::ID = 0;
61 typedef DenseMap<GCStrategy*,GCMetadataPrinter*> gcp_map_type;
62 static gcp_map_type &getGCMap(void *&P) {
64 P = new gcp_map_type();
65 return *(gcp_map_type*)P;
69 /// getGVAlignmentLog2 - Return the alignment to use for the specified global
70 /// value in log2 form. This rounds up to the preferred alignment if possible
72 static unsigned getGVAlignmentLog2(const GlobalValue *GV, const DataLayout &TD,
73 unsigned InBits = 0) {
75 if (const GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV))
76 NumBits = TD.getPreferredAlignmentLog(GVar);
78 // If InBits is specified, round it to it.
82 // If the GV has a specified alignment, take it into account.
83 if (GV->getAlignment() == 0)
86 unsigned GVAlign = Log2_32(GV->getAlignment());
88 // If the GVAlign is larger than NumBits, or if we are required to obey
89 // NumBits because the GV has an assigned section, obey it.
90 if (GVAlign > NumBits || GV->hasSection())
95 AsmPrinter::AsmPrinter(TargetMachine &tm, MCStreamer &Streamer)
96 : MachineFunctionPass(ID),
97 TM(tm), MAI(tm.getMCAsmInfo()), MII(tm.getInstrInfo()),
98 OutContext(Streamer.getContext()),
99 OutStreamer(Streamer),
100 LastMI(0), LastFn(0), Counter(~0U), SetCounter(0) {
101 DD = 0; DE = 0; MMI = 0; LI = 0; MF = 0;
102 CurrentFnSym = CurrentFnSymForSize = 0;
103 GCMetadataPrinters = 0;
104 VerboseAsm = Streamer.isVerboseAsm();
107 AsmPrinter::~AsmPrinter() {
108 assert(DD == 0 && DE == 0 && "Debug/EH info didn't get finalized");
110 if (GCMetadataPrinters != 0) {
111 gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
113 for (gcp_map_type::iterator I = GCMap.begin(), E = GCMap.end(); I != E; ++I)
116 GCMetadataPrinters = 0;
122 /// getFunctionNumber - Return a unique ID for the current function.
124 unsigned AsmPrinter::getFunctionNumber() const {
125 return MF->getFunctionNumber();
128 const TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
129 return TM.getTargetLowering()->getObjFileLowering();
132 /// getDataLayout - Return information about data layout.
133 const DataLayout &AsmPrinter::getDataLayout() const {
134 return *TM.getDataLayout();
137 StringRef AsmPrinter::getTargetTriple() const {
138 return TM.getTargetTriple();
141 /// getCurrentSection() - Return the current section we are emitting to.
142 const MCSection *AsmPrinter::getCurrentSection() const {
143 return OutStreamer.getCurrentSection().first;
148 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
149 AU.setPreservesAll();
150 MachineFunctionPass::getAnalysisUsage(AU);
151 AU.addRequired<MachineModuleInfo>();
152 AU.addRequired<GCModuleInfo>();
154 AU.addRequired<MachineLoopInfo>();
157 bool AsmPrinter::doInitialization(Module &M) {
158 MMI = getAnalysisIfAvailable<MachineModuleInfo>();
159 MMI->AnalyzeModule(M);
161 // Initialize TargetLoweringObjectFile.
162 const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
163 .Initialize(OutContext, TM);
165 OutStreamer.InitStreamer();
167 Mang = new Mangler(OutContext, &TM);
169 // Allow the target to emit any magic that it wants at the start of the file.
170 EmitStartOfAsmFile(M);
172 // Very minimal debug info. It is ignored if we emit actual debug info. If we
173 // don't, this at least helps the user find where a global came from.
174 if (MAI->hasSingleParameterDotFile()) {
176 OutStreamer.EmitFileDirective(M.getModuleIdentifier());
179 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
180 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
181 for (GCModuleInfo::iterator I = MI->begin(), E = MI->end(); I != E; ++I)
182 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
183 MP->beginAssembly(*this);
185 // Emit module-level inline asm if it exists.
186 if (!M.getModuleInlineAsm().empty()) {
187 OutStreamer.AddComment("Start of file scope inline assembly");
188 OutStreamer.AddBlankLine();
189 EmitInlineAsm(M.getModuleInlineAsm()+"\n");
190 OutStreamer.AddComment("End of file scope inline assembly");
191 OutStreamer.AddBlankLine();
194 if (MAI->doesSupportDebugInformation())
195 DD = new DwarfDebug(this, &M);
197 switch (MAI->getExceptionHandlingType()) {
198 case ExceptionHandling::None:
200 case ExceptionHandling::SjLj:
201 case ExceptionHandling::DwarfCFI:
202 DE = new DwarfCFIException(this);
204 case ExceptionHandling::ARM:
205 DE = new ARMException(this);
207 case ExceptionHandling::Win64:
208 DE = new Win64Exception(this);
212 llvm_unreachable("Unknown exception type.");
215 void AsmPrinter::EmitLinkage(unsigned Linkage, MCSymbol *GVSym) const {
216 switch ((GlobalValue::LinkageTypes)Linkage) {
217 case GlobalValue::CommonLinkage:
218 case GlobalValue::LinkOnceAnyLinkage:
219 case GlobalValue::LinkOnceODRLinkage:
220 case GlobalValue::LinkOnceODRAutoHideLinkage:
221 case GlobalValue::WeakAnyLinkage:
222 case GlobalValue::WeakODRLinkage:
223 case GlobalValue::LinkerPrivateWeakLinkage:
224 if (MAI->getWeakDefDirective() != 0) {
226 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
228 if ((GlobalValue::LinkageTypes)Linkage !=
229 GlobalValue::LinkOnceODRAutoHideLinkage)
230 // .weak_definition _foo
231 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefinition);
233 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefAutoPrivate);
234 } else if (MAI->getLinkOnceDirective() != 0) {
236 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
237 //NOTE: linkonce is handled by the section the symbol was assigned to.
240 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Weak);
243 case GlobalValue::DLLExportLinkage:
244 case GlobalValue::AppendingLinkage:
245 // FIXME: appending linkage variables should go into a section of
246 // their name or something. For now, just emit them as external.
247 case GlobalValue::ExternalLinkage:
248 // If external or appending, declare as a global symbol.
250 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
252 case GlobalValue::PrivateLinkage:
253 case GlobalValue::InternalLinkage:
254 case GlobalValue::LinkerPrivateLinkage:
257 llvm_unreachable("Unknown linkage type!");
262 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
263 void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
264 if (GV->hasInitializer()) {
265 // Check to see if this is a special global used by LLVM, if so, emit it.
266 if (EmitSpecialLLVMGlobal(GV))
270 WriteAsOperand(OutStreamer.GetCommentOS(), GV,
271 /*PrintType=*/false, GV->getParent());
272 OutStreamer.GetCommentOS() << '\n';
276 MCSymbol *GVSym = Mang->getSymbol(GV);
277 EmitVisibility(GVSym, GV->getVisibility(), !GV->isDeclaration());
279 if (!GV->hasInitializer()) // External globals require no extra code.
282 if (MAI->hasDotTypeDotSizeDirective())
283 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_ELF_TypeObject);
285 SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
287 const DataLayout *TD = TM.getDataLayout();
288 uint64_t Size = TD->getTypeAllocSize(GV->getType()->getElementType());
290 // If the alignment is specified, we *must* obey it. Overaligning a global
291 // with a specified alignment is a prompt way to break globals emitted to
292 // sections and expected to be contiguous (e.g. ObjC metadata).
293 unsigned AlignLog = getGVAlignmentLog2(GV, *TD);
295 // Handle common and BSS local symbols (.lcomm).
296 if (GVKind.isCommon() || GVKind.isBSSLocal()) {
297 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
298 unsigned Align = 1 << AlignLog;
300 // Handle common symbols.
301 if (GVKind.isCommon()) {
302 if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
306 OutStreamer.EmitCommonSymbol(GVSym, Size, Align);
310 // Handle local BSS symbols.
311 if (MAI->hasMachoZeroFillDirective()) {
312 const MCSection *TheSection =
313 getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
314 // .zerofill __DATA, __bss, _foo, 400, 5
315 OutStreamer.EmitZerofill(TheSection, GVSym, Size, Align);
319 // Use .lcomm only if it supports user-specified alignment.
320 // Otherwise, while it would still be correct to use .lcomm in some
321 // cases (e.g. when Align == 1), the external assembler might enfore
322 // some -unknown- default alignment behavior, which could cause
323 // spurious differences between external and integrated assembler.
324 // Prefer to simply fall back to .local / .comm in this case.
325 if (MAI->getLCOMMDirectiveAlignmentType() != LCOMM::NoAlignment) {
327 OutStreamer.EmitLocalCommonSymbol(GVSym, Size, Align);
331 if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
335 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Local);
337 OutStreamer.EmitCommonSymbol(GVSym, Size, Align);
341 const MCSection *TheSection =
342 getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
344 // Handle the zerofill directive on darwin, which is a special form of BSS
346 if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
347 if (Size == 0) Size = 1; // zerofill of 0 bytes is undefined.
350 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
351 // .zerofill __DATA, __common, _foo, 400, 5
352 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
356 // Handle thread local data for mach-o which requires us to output an
357 // additional structure of data and mangle the original symbol so that we
358 // can reference it later.
360 // TODO: This should become an "emit thread local global" method on TLOF.
361 // All of this macho specific stuff should be sunk down into TLOFMachO and
362 // stuff like "TLSExtraDataSection" should no longer be part of the parent
363 // TLOF class. This will also make it more obvious that stuff like
364 // MCStreamer::EmitTBSSSymbol is macho specific and only called from macho
366 if (GVKind.isThreadLocal() && MAI->hasMachoTBSSDirective()) {
367 // Emit the .tbss symbol
369 OutContext.GetOrCreateSymbol(GVSym->getName() + Twine("$tlv$init"));
371 if (GVKind.isThreadBSS()) {
372 TheSection = getObjFileLowering().getTLSBSSSection();
373 OutStreamer.EmitTBSSSymbol(TheSection, MangSym, Size, 1 << AlignLog);
374 } else if (GVKind.isThreadData()) {
375 OutStreamer.SwitchSection(TheSection);
377 EmitAlignment(AlignLog, GV);
378 OutStreamer.EmitLabel(MangSym);
380 EmitGlobalConstant(GV->getInitializer());
383 OutStreamer.AddBlankLine();
385 // Emit the variable struct for the runtime.
386 const MCSection *TLVSect
387 = getObjFileLowering().getTLSExtraDataSection();
389 OutStreamer.SwitchSection(TLVSect);
390 // Emit the linkage here.
391 EmitLinkage(GV->getLinkage(), GVSym);
392 OutStreamer.EmitLabel(GVSym);
394 // Three pointers in size:
395 // - __tlv_bootstrap - used to make sure support exists
396 // - spare pointer, used when mapped by the runtime
397 // - pointer to mangled symbol above with initializer
398 unsigned PtrSize = TD->getPointerSizeInBits()/8;
399 OutStreamer.EmitSymbolValue(GetExternalSymbolSymbol("_tlv_bootstrap"),
401 OutStreamer.EmitIntValue(0, PtrSize);
402 OutStreamer.EmitSymbolValue(MangSym, PtrSize);
404 OutStreamer.AddBlankLine();
408 OutStreamer.SwitchSection(TheSection);
410 EmitLinkage(GV->getLinkage(), GVSym);
411 EmitAlignment(AlignLog, GV);
413 OutStreamer.EmitLabel(GVSym);
415 EmitGlobalConstant(GV->getInitializer());
417 if (MAI->hasDotTypeDotSizeDirective())
419 OutStreamer.EmitELFSize(GVSym, MCConstantExpr::Create(Size, OutContext));
421 OutStreamer.AddBlankLine();
424 /// EmitFunctionHeader - This method emits the header for the current
426 void AsmPrinter::EmitFunctionHeader() {
427 // Print out constants referenced by the function
430 // Print the 'header' of function.
431 const Function *F = MF->getFunction();
433 OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang, TM));
434 EmitVisibility(CurrentFnSym, F->getVisibility());
436 EmitLinkage(F->getLinkage(), CurrentFnSym);
437 EmitAlignment(MF->getAlignment(), F);
439 if (MAI->hasDotTypeDotSizeDirective())
440 OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCSA_ELF_TypeFunction);
443 WriteAsOperand(OutStreamer.GetCommentOS(), F,
444 /*PrintType=*/false, F->getParent());
445 OutStreamer.GetCommentOS() << '\n';
448 // Emit the CurrentFnSym. This is a virtual function to allow targets to
449 // do their wild and crazy things as required.
450 EmitFunctionEntryLabel();
452 // If the function had address-taken blocks that got deleted, then we have
453 // references to the dangling symbols. Emit them at the start of the function
454 // so that we don't get references to undefined symbols.
455 std::vector<MCSymbol*> DeadBlockSyms;
456 MMI->takeDeletedSymbolsForFunction(F, DeadBlockSyms);
457 for (unsigned i = 0, e = DeadBlockSyms.size(); i != e; ++i) {
458 OutStreamer.AddComment("Address taken block that was later removed");
459 OutStreamer.EmitLabel(DeadBlockSyms[i]);
462 // Emit the prefix data.
463 if (F->hasPrefixData())
464 EmitGlobalConstant(F->getPrefixData());
466 // Emit pre-function debug and/or EH information.
468 NamedRegionTimer T(EHTimerName, DWARFGroupName, TimePassesIsEnabled);
469 DE->BeginFunction(MF);
472 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
473 DD->beginFunction(MF);
477 /// EmitFunctionEntryLabel - Emit the label that is the entrypoint for the
478 /// function. This can be overridden by targets as required to do custom stuff.
479 void AsmPrinter::EmitFunctionEntryLabel() {
480 // The function label could have already been emitted if two symbols end up
481 // conflicting due to asm renaming. Detect this and emit an error.
482 if (CurrentFnSym->isUndefined())
483 return OutStreamer.EmitLabel(CurrentFnSym);
485 report_fatal_error("'" + Twine(CurrentFnSym->getName()) +
486 "' label emitted multiple times to assembly file");
489 /// emitComments - Pretty-print comments for instructions.
490 static void emitComments(const MachineInstr &MI, raw_ostream &CommentOS) {
491 const MachineFunction *MF = MI.getParent()->getParent();
492 const TargetMachine &TM = MF->getTarget();
494 // Check for spills and reloads
497 const MachineFrameInfo *FrameInfo = MF->getFrameInfo();
499 // We assume a single instruction only has a spill or reload, not
501 const MachineMemOperand *MMO;
502 if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
503 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
504 MMO = *MI.memoperands_begin();
505 CommentOS << MMO->getSize() << "-byte Reload\n";
507 } else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
508 if (FrameInfo->isSpillSlotObjectIndex(FI))
509 CommentOS << MMO->getSize() << "-byte Folded Reload\n";
510 } else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
511 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
512 MMO = *MI.memoperands_begin();
513 CommentOS << MMO->getSize() << "-byte Spill\n";
515 } else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
516 if (FrameInfo->isSpillSlotObjectIndex(FI))
517 CommentOS << MMO->getSize() << "-byte Folded Spill\n";
520 // Check for spill-induced copies
521 if (MI.getAsmPrinterFlag(MachineInstr::ReloadReuse))
522 CommentOS << " Reload Reuse\n";
525 /// emitImplicitDef - This method emits the specified machine instruction
526 /// that is an implicit def.
527 static void emitImplicitDef(const MachineInstr *MI, AsmPrinter &AP) {
528 unsigned RegNo = MI->getOperand(0).getReg();
529 AP.OutStreamer.AddComment(Twine("implicit-def: ") +
530 AP.TM.getRegisterInfo()->getName(RegNo));
531 AP.OutStreamer.AddBlankLine();
534 static void emitKill(const MachineInstr *MI, AsmPrinter &AP) {
535 std::string Str = "kill:";
536 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
537 const MachineOperand &Op = MI->getOperand(i);
538 assert(Op.isReg() && "KILL instruction must have only register operands");
540 Str += AP.TM.getRegisterInfo()->getName(Op.getReg());
541 Str += (Op.isDef() ? "<def>" : "<kill>");
543 AP.OutStreamer.AddComment(Str);
544 AP.OutStreamer.AddBlankLine();
547 /// emitDebugValueComment - This method handles the target-independent form
548 /// of DBG_VALUE, returning true if it was able to do so. A false return
549 /// means the target will need to handle MI in EmitInstruction.
550 static bool emitDebugValueComment(const MachineInstr *MI, AsmPrinter &AP) {
551 // This code handles only the 3-operand target-independent form.
552 if (MI->getNumOperands() != 3)
555 SmallString<128> Str;
556 raw_svector_ostream OS(Str);
557 OS << '\t' << AP.MAI->getCommentString() << "DEBUG_VALUE: ";
559 // cast away const; DIetc do not take const operands for some reason.
560 DIVariable V(const_cast<MDNode*>(MI->getOperand(2).getMetadata()));
561 if (V.getContext().isSubprogram()) {
562 StringRef Name = DISubprogram(V.getContext()).getDisplayName();
566 OS << V.getName() << " <- ";
568 // The second operand is only an offset if it's an immediate.
569 bool Deref = MI->getOperand(0).isReg() && MI->getOperand(1).isImm();
570 int64_t Offset = Deref ? MI->getOperand(1).getImm() : 0;
572 // Register or immediate value. Register 0 means undef.
573 if (MI->getOperand(0).isFPImm()) {
574 APFloat APF = APFloat(MI->getOperand(0).getFPImm()->getValueAPF());
575 if (MI->getOperand(0).getFPImm()->getType()->isFloatTy()) {
576 OS << (double)APF.convertToFloat();
577 } else if (MI->getOperand(0).getFPImm()->getType()->isDoubleTy()) {
578 OS << APF.convertToDouble();
580 // There is no good way to print long double. Convert a copy to
581 // double. Ah well, it's only a comment.
583 APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
585 OS << "(long double) " << APF.convertToDouble();
587 } else if (MI->getOperand(0).isImm()) {
588 OS << MI->getOperand(0).getImm();
589 } else if (MI->getOperand(0).isCImm()) {
590 MI->getOperand(0).getCImm()->getValue().print(OS, false /*isSigned*/);
593 if (MI->getOperand(0).isReg()) {
594 Reg = MI->getOperand(0).getReg();
596 assert(MI->getOperand(0).isFI() && "Unknown operand type");
597 const TargetFrameLowering *TFI = AP.TM.getFrameLowering();
598 Offset += TFI->getFrameIndexReference(*AP.MF,
599 MI->getOperand(0).getIndex(), Reg);
603 // Suppress offset, it is not meaningful here.
605 // NOTE: Want this comment at start of line, don't emit with AddComment.
606 AP.OutStreamer.EmitRawText(OS.str());
611 OS << AP.TM.getRegisterInfo()->getName(Reg);
615 OS << '+' << Offset << ']';
617 // NOTE: Want this comment at start of line, don't emit with AddComment.
618 AP.OutStreamer.EmitRawText(OS.str());
622 AsmPrinter::CFIMoveType AsmPrinter::needsCFIMoves() {
623 if (MAI->getExceptionHandlingType() == ExceptionHandling::DwarfCFI &&
624 MF->getFunction()->needsUnwindTableEntry())
627 if (MMI->hasDebugInfo())
633 bool AsmPrinter::needsSEHMoves() {
634 return MAI->getExceptionHandlingType() == ExceptionHandling::Win64 &&
635 MF->getFunction()->needsUnwindTableEntry();
638 bool AsmPrinter::needsRelocationsForDwarfStringPool() const {
639 return MAI->doesDwarfUseRelocationsAcrossSections();
642 void AsmPrinter::emitPrologLabel(const MachineInstr &MI) {
643 const MCSymbol *Label = MI.getOperand(0).getMCSymbol();
645 if (MAI->getExceptionHandlingType() != ExceptionHandling::DwarfCFI)
648 if (needsCFIMoves() == CFI_M_None)
651 if (MMI->getCompactUnwindEncoding() != 0)
652 OutStreamer.EmitCompactUnwindEncoding(MMI->getCompactUnwindEncoding());
654 const MachineModuleInfo &MMI = MF->getMMI();
655 const std::vector<MCCFIInstruction> &Instrs = MMI.getFrameInstructions();
656 bool FoundOne = false;
658 for (std::vector<MCCFIInstruction>::const_iterator I = Instrs.begin(),
659 E = Instrs.end(); I != E; ++I) {
660 if (I->getLabel() == Label) {
661 emitCFIInstruction(*I);
668 /// EmitFunctionBody - This method emits the body and trailer for a
670 void AsmPrinter::EmitFunctionBody() {
671 // Emit target-specific gunk before the function body.
672 EmitFunctionBodyStart();
674 bool ShouldPrintDebugScopes = DD && MMI->hasDebugInfo();
676 // Print out code for the function.
677 bool HasAnyRealCode = false;
678 const MachineInstr *LastMI = 0;
679 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
681 // Print a label for the basic block.
682 EmitBasicBlockStart(I);
683 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
687 // Print the assembly for the instruction.
688 if (!II->isLabel() && !II->isImplicitDef() && !II->isKill() &&
689 !II->isDebugValue()) {
690 HasAnyRealCode = true;
694 if (ShouldPrintDebugScopes) {
695 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
696 DD->beginInstruction(II);
700 emitComments(*II, OutStreamer.GetCommentOS());
702 switch (II->getOpcode()) {
703 case TargetOpcode::PROLOG_LABEL:
704 emitPrologLabel(*II);
707 case TargetOpcode::EH_LABEL:
708 case TargetOpcode::GC_LABEL:
709 OutStreamer.EmitLabel(II->getOperand(0).getMCSymbol());
711 case TargetOpcode::INLINEASM:
714 case TargetOpcode::DBG_VALUE:
716 if (!emitDebugValueComment(II, *this))
720 case TargetOpcode::IMPLICIT_DEF:
721 if (isVerbose()) emitImplicitDef(II, *this);
723 case TargetOpcode::KILL:
724 if (isVerbose()) emitKill(II, *this);
727 if (!TM.hasMCUseLoc())
728 MCLineEntry::Make(&OutStreamer, getCurrentSection());
734 if (ShouldPrintDebugScopes) {
735 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
736 DD->endInstruction(II);
741 // If the last instruction was a prolog label, then we have a situation where
742 // we emitted a prolog but no function body. This results in the ending prolog
743 // label equaling the end of function label and an invalid "row" in the
744 // FDE. We need to emit a noop in this situation so that the FDE's rows are
746 bool RequiresNoop = LastMI && LastMI->isPrologLabel();
748 // If the function is empty and the object file uses .subsections_via_symbols,
749 // then we need to emit *something* to the function body to prevent the
750 // labels from collapsing together. Just emit a noop.
751 if ((MAI->hasSubsectionsViaSymbols() && !HasAnyRealCode) || RequiresNoop) {
753 TM.getInstrInfo()->getNoopForMachoTarget(Noop);
754 if (Noop.getOpcode()) {
755 OutStreamer.AddComment("avoids zero-length function");
756 OutStreamer.EmitInstruction(Noop);
757 } else // Target not mc-ized yet.
758 OutStreamer.EmitRawText(StringRef("\tnop\n"));
761 const Function *F = MF->getFunction();
762 for (Function::const_iterator i = F->begin(), e = F->end(); i != e; ++i) {
763 const BasicBlock *BB = i;
764 if (!BB->hasAddressTaken())
766 MCSymbol *Sym = GetBlockAddressSymbol(BB);
767 if (Sym->isDefined())
769 OutStreamer.AddComment("Address of block that was removed by CodeGen");
770 OutStreamer.EmitLabel(Sym);
773 // Emit target-specific gunk after the function body.
774 EmitFunctionBodyEnd();
776 // If the target wants a .size directive for the size of the function, emit
778 if (MAI->hasDotTypeDotSizeDirective()) {
779 // Create a symbol for the end of function, so we can get the size as
780 // difference between the function label and the temp label.
781 MCSymbol *FnEndLabel = OutContext.CreateTempSymbol();
782 OutStreamer.EmitLabel(FnEndLabel);
784 const MCExpr *SizeExp =
785 MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(FnEndLabel, OutContext),
786 MCSymbolRefExpr::Create(CurrentFnSymForSize,
789 OutStreamer.EmitELFSize(CurrentFnSym, SizeExp);
792 // Emit post-function debug information.
794 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
798 NamedRegionTimer T(EHTimerName, DWARFGroupName, TimePassesIsEnabled);
803 // Print out jump tables referenced by the function.
806 OutStreamer.AddBlankLine();
809 /// EmitDwarfRegOp - Emit dwarf register operation.
810 void AsmPrinter::EmitDwarfRegOp(const MachineLocation &MLoc,
811 bool Indirect) const {
812 const TargetRegisterInfo *TRI = TM.getRegisterInfo();
813 int Reg = TRI->getDwarfRegNum(MLoc.getReg(), false);
815 for (MCSuperRegIterator SR(MLoc.getReg(), TRI); SR.isValid() && Reg < 0;
817 Reg = TRI->getDwarfRegNum(*SR, false);
818 // FIXME: Get the bit range this register uses of the superregister
819 // so that we can produce a DW_OP_bit_piece
822 // FIXME: Handle cases like a super register being encoded as
823 // DW_OP_reg 32 DW_OP_piece 4 DW_OP_reg 33
825 // FIXME: We have no reasonable way of handling errors in here. The
826 // caller might be in the middle of an dwarf expression. We should
827 // probably assert that Reg >= 0 once debug info generation is more mature.
829 if (MLoc.isIndirect() || Indirect) {
831 OutStreamer.AddComment(
832 dwarf::OperationEncodingString(dwarf::DW_OP_breg0 + Reg));
833 EmitInt8(dwarf::DW_OP_breg0 + Reg);
835 OutStreamer.AddComment("DW_OP_bregx");
836 EmitInt8(dwarf::DW_OP_bregx);
837 OutStreamer.AddComment(Twine(Reg));
840 EmitSLEB128(!MLoc.isIndirect() ? 0 : MLoc.getOffset());
841 if (MLoc.isIndirect() && Indirect)
842 EmitInt8(dwarf::DW_OP_deref);
845 OutStreamer.AddComment(
846 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
847 EmitInt8(dwarf::DW_OP_reg0 + Reg);
849 OutStreamer.AddComment("DW_OP_regx");
850 EmitInt8(dwarf::DW_OP_regx);
851 OutStreamer.AddComment(Twine(Reg));
856 // FIXME: Produce a DW_OP_bit_piece if we used a superregister
859 bool AsmPrinter::doFinalization(Module &M) {
860 // Emit global variables.
861 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
863 EmitGlobalVariable(I);
865 // Emit visibility info for declarations
866 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
867 const Function &F = *I;
868 if (!F.isDeclaration())
870 GlobalValue::VisibilityTypes V = F.getVisibility();
871 if (V == GlobalValue::DefaultVisibility)
874 MCSymbol *Name = Mang->getSymbol(&F);
875 EmitVisibility(Name, V, false);
878 // Emit module flags.
879 SmallVector<Module::ModuleFlagEntry, 8> ModuleFlags;
880 M.getModuleFlagsMetadata(ModuleFlags);
881 if (!ModuleFlags.empty())
882 getObjFileLowering().emitModuleFlags(OutStreamer, ModuleFlags, Mang, TM);
884 // Make sure we wrote out everything we need.
887 // Finalize debug and EH information.
890 NamedRegionTimer T(EHTimerName, DWARFGroupName, TimePassesIsEnabled);
897 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
903 // If the target wants to know about weak references, print them all.
904 if (MAI->getWeakRefDirective()) {
905 // FIXME: This is not lazy, it would be nice to only print weak references
906 // to stuff that is actually used. Note that doing so would require targets
907 // to notice uses in operands (due to constant exprs etc). This should
908 // happen with the MC stuff eventually.
910 // Print out module-level global variables here.
911 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
913 if (!I->hasExternalWeakLinkage()) continue;
914 OutStreamer.EmitSymbolAttribute(Mang->getSymbol(I), MCSA_WeakReference);
917 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
918 if (!I->hasExternalWeakLinkage()) continue;
919 OutStreamer.EmitSymbolAttribute(Mang->getSymbol(I), MCSA_WeakReference);
923 if (MAI->hasSetDirective()) {
924 OutStreamer.AddBlankLine();
925 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
927 MCSymbol *Name = Mang->getSymbol(I);
929 const GlobalValue *GV = I->getAliasedGlobal();
930 MCSymbol *Target = Mang->getSymbol(GV);
932 if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
933 OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
934 else if (I->hasWeakLinkage())
935 OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
937 assert(I->hasLocalLinkage() && "Invalid alias linkage");
939 EmitVisibility(Name, I->getVisibility());
941 // Emit the directives as assignments aka .set:
942 OutStreamer.EmitAssignment(Name,
943 MCSymbolRefExpr::Create(Target, OutContext));
947 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
948 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
949 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
950 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
951 MP->finishAssembly(*this);
953 // If we don't have any trampolines, then we don't require stack memory
954 // to be executable. Some targets have a directive to declare this.
955 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
956 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
957 if (const MCSection *S = MAI->getNonexecutableStackSection(OutContext))
958 OutStreamer.SwitchSection(S);
960 // Allow the target to emit any magic that it wants at the end of the file,
961 // after everything else has gone out.
964 delete Mang; Mang = 0;
967 OutStreamer.Finish();
973 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
975 // Get the function symbol.
976 CurrentFnSym = Mang->getSymbol(MF.getFunction());
977 CurrentFnSymForSize = CurrentFnSym;
980 LI = &getAnalysis<MachineLoopInfo>();
984 // SectionCPs - Keep track the alignment, constpool entries per Section.
988 SmallVector<unsigned, 4> CPEs;
989 SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
993 /// EmitConstantPool - Print to the current output stream assembly
994 /// representations of the constants in the constant pool MCP. This is
995 /// used to print out constants which have been "spilled to memory" by
996 /// the code generator.
998 void AsmPrinter::EmitConstantPool() {
999 const MachineConstantPool *MCP = MF->getConstantPool();
1000 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
1001 if (CP.empty()) return;
1003 // Calculate sections for constant pool entries. We collect entries to go into
1004 // the same section together to reduce amount of section switch statements.
1005 SmallVector<SectionCPs, 4> CPSections;
1006 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
1007 const MachineConstantPoolEntry &CPE = CP[i];
1008 unsigned Align = CPE.getAlignment();
1011 switch (CPE.getRelocationInfo()) {
1012 default: llvm_unreachable("Unknown section kind");
1013 case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
1015 Kind = SectionKind::getReadOnlyWithRelLocal();
1018 switch (TM.getDataLayout()->getTypeAllocSize(CPE.getType())) {
1019 case 4: Kind = SectionKind::getMergeableConst4(); break;
1020 case 8: Kind = SectionKind::getMergeableConst8(); break;
1021 case 16: Kind = SectionKind::getMergeableConst16();break;
1022 default: Kind = SectionKind::getMergeableConst(); break;
1026 const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
1028 // The number of sections are small, just do a linear search from the
1029 // last section to the first.
1031 unsigned SecIdx = CPSections.size();
1032 while (SecIdx != 0) {
1033 if (CPSections[--SecIdx].S == S) {
1039 SecIdx = CPSections.size();
1040 CPSections.push_back(SectionCPs(S, Align));
1043 if (Align > CPSections[SecIdx].Alignment)
1044 CPSections[SecIdx].Alignment = Align;
1045 CPSections[SecIdx].CPEs.push_back(i);
1048 // Now print stuff into the calculated sections.
1049 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
1050 OutStreamer.SwitchSection(CPSections[i].S);
1051 EmitAlignment(Log2_32(CPSections[i].Alignment));
1053 unsigned Offset = 0;
1054 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
1055 unsigned CPI = CPSections[i].CPEs[j];
1056 MachineConstantPoolEntry CPE = CP[CPI];
1058 // Emit inter-object padding for alignment.
1059 unsigned AlignMask = CPE.getAlignment() - 1;
1060 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
1061 OutStreamer.EmitZeros(NewOffset - Offset);
1063 Type *Ty = CPE.getType();
1064 Offset = NewOffset + TM.getDataLayout()->getTypeAllocSize(Ty);
1065 OutStreamer.EmitLabel(GetCPISymbol(CPI));
1067 if (CPE.isMachineConstantPoolEntry())
1068 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
1070 EmitGlobalConstant(CPE.Val.ConstVal);
1075 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
1076 /// by the current function to the current output stream.
1078 void AsmPrinter::EmitJumpTableInfo() {
1079 const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
1080 if (MJTI == 0) return;
1081 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline) return;
1082 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1083 if (JT.empty()) return;
1085 // Pick the directive to use to print the jump table entries, and switch to
1086 // the appropriate section.
1087 const Function *F = MF->getFunction();
1088 bool JTInDiffSection = false;
1089 if (// In PIC mode, we need to emit the jump table to the same section as the
1090 // function body itself, otherwise the label differences won't make sense.
1091 // FIXME: Need a better predicate for this: what about custom entries?
1092 MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 ||
1093 // We should also do if the section name is NULL or function is declared
1094 // in discardable section
1095 // FIXME: this isn't the right predicate, should be based on the MCSection
1096 // for the function.
1097 F->isWeakForLinker()) {
1098 OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F,Mang,TM));
1100 // Otherwise, drop it in the readonly section.
1101 const MCSection *ReadOnlySection =
1102 getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
1103 OutStreamer.SwitchSection(ReadOnlySection);
1104 JTInDiffSection = true;
1107 EmitAlignment(Log2_32(MJTI->getEntryAlignment(*TM.getDataLayout())));
1109 // Jump tables in code sections are marked with a data_region directive
1110 // where that's supported.
1111 if (!JTInDiffSection)
1112 OutStreamer.EmitDataRegion(MCDR_DataRegionJT32);
1114 for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) {
1115 const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
1117 // If this jump table was deleted, ignore it.
1118 if (JTBBs.empty()) continue;
1120 // For the EK_LabelDifference32 entry, if the target supports .set, emit a
1121 // .set directive for each unique entry. This reduces the number of
1122 // relocations the assembler will generate for the jump table.
1123 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
1124 MAI->hasSetDirective()) {
1125 SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets;
1126 const TargetLowering *TLI = TM.getTargetLowering();
1127 const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF,JTI,OutContext);
1128 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
1129 const MachineBasicBlock *MBB = JTBBs[ii];
1130 if (!EmittedSets.insert(MBB)) continue;
1132 // .set LJTSet, LBB32-base
1134 MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1135 OutStreamer.EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()),
1136 MCBinaryExpr::CreateSub(LHS, Base, OutContext));
1140 // On some targets (e.g. Darwin) we want to emit two consecutive labels
1141 // before each jump table. The first label is never referenced, but tells
1142 // the assembler and linker the extents of the jump table object. The
1143 // second label is actually referenced by the code.
1144 if (JTInDiffSection && MAI->getLinkerPrivateGlobalPrefix()[0])
1145 // FIXME: This doesn't have to have any specific name, just any randomly
1146 // named and numbered 'l' label would work. Simplify GetJTISymbol.
1147 OutStreamer.EmitLabel(GetJTISymbol(JTI, true));
1149 OutStreamer.EmitLabel(GetJTISymbol(JTI));
1151 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
1152 EmitJumpTableEntry(MJTI, JTBBs[ii], JTI);
1154 if (!JTInDiffSection)
1155 OutStreamer.EmitDataRegion(MCDR_DataRegionEnd);
1158 /// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
1160 void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
1161 const MachineBasicBlock *MBB,
1162 unsigned UID) const {
1163 assert(MBB && MBB->getNumber() >= 0 && "Invalid basic block");
1164 const MCExpr *Value = 0;
1165 switch (MJTI->getEntryKind()) {
1166 case MachineJumpTableInfo::EK_Inline:
1167 llvm_unreachable("Cannot emit EK_Inline jump table entry");
1168 case MachineJumpTableInfo::EK_Custom32:
1169 Value = TM.getTargetLowering()->LowerCustomJumpTableEntry(MJTI, MBB, UID,
1172 case MachineJumpTableInfo::EK_BlockAddress:
1173 // EK_BlockAddress - Each entry is a plain address of block, e.g.:
1175 Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1177 case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
1178 // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
1179 // with a relocation as gp-relative, e.g.:
1181 MCSymbol *MBBSym = MBB->getSymbol();
1182 OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1186 case MachineJumpTableInfo::EK_GPRel64BlockAddress: {
1187 // EK_GPRel64BlockAddress - Each entry is an address of block, encoded
1188 // with a relocation as gp-relative, e.g.:
1190 MCSymbol *MBBSym = MBB->getSymbol();
1191 OutStreamer.EmitGPRel64Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1195 case MachineJumpTableInfo::EK_LabelDifference32: {
1196 // EK_LabelDifference32 - Each entry is the address of the block minus
1197 // the address of the jump table. This is used for PIC jump tables where
1198 // gprel32 is not supported. e.g.:
1199 // .word LBB123 - LJTI1_2
1200 // If the .set directive is supported, this is emitted as:
1201 // .set L4_5_set_123, LBB123 - LJTI1_2
1202 // .word L4_5_set_123
1204 // If we have emitted set directives for the jump table entries, print
1205 // them rather than the entries themselves. If we're emitting PIC, then
1206 // emit the table entries as differences between two text section labels.
1207 if (MAI->hasSetDirective()) {
1208 // If we used .set, reference the .set's symbol.
1209 Value = MCSymbolRefExpr::Create(GetJTSetSymbol(UID, MBB->getNumber()),
1213 // Otherwise, use the difference as the jump table entry.
1214 Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1215 const MCExpr *JTI = MCSymbolRefExpr::Create(GetJTISymbol(UID), OutContext);
1216 Value = MCBinaryExpr::CreateSub(Value, JTI, OutContext);
1221 assert(Value && "Unknown entry kind!");
1223 unsigned EntrySize = MJTI->getEntrySize(*TM.getDataLayout());
1224 OutStreamer.EmitValue(Value, EntrySize);
1228 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
1229 /// special global used by LLVM. If so, emit it and return true, otherwise
1230 /// do nothing and return false.
1231 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
1232 if (GV->getName() == "llvm.used") {
1233 if (MAI->hasNoDeadStrip()) // No need to emit this at all.
1234 EmitLLVMUsedList(cast<ConstantArray>(GV->getInitializer()));
1238 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
1239 if (GV->getSection() == "llvm.metadata" ||
1240 GV->hasAvailableExternallyLinkage())
1243 if (!GV->hasAppendingLinkage()) return false;
1245 assert(GV->hasInitializer() && "Not a special LLVM global!");
1247 if (GV->getName() == "llvm.global_ctors") {
1248 EmitXXStructorList(GV->getInitializer(), /* isCtor */ true);
1250 if (TM.getRelocationModel() == Reloc::Static &&
1251 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1252 StringRef Sym(".constructors_used");
1253 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1259 if (GV->getName() == "llvm.global_dtors") {
1260 EmitXXStructorList(GV->getInitializer(), /* isCtor */ false);
1262 if (TM.getRelocationModel() == Reloc::Static &&
1263 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1264 StringRef Sym(".destructors_used");
1265 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1274 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
1275 /// global in the specified llvm.used list for which emitUsedDirectiveFor
1276 /// is true, as being used with this directive.
1277 void AsmPrinter::EmitLLVMUsedList(const ConstantArray *InitList) {
1278 // Should be an array of 'i8*'.
1279 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
1280 const GlobalValue *GV =
1281 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
1282 if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, Mang))
1283 OutStreamer.EmitSymbolAttribute(Mang->getSymbol(GV), MCSA_NoDeadStrip);
1287 /// EmitXXStructorList - Emit the ctor or dtor list taking into account the init
1289 void AsmPrinter::EmitXXStructorList(const Constant *List, bool isCtor) {
1290 // Should be an array of '{ int, void ()* }' structs. The first value is the
1292 if (!isa<ConstantArray>(List)) return;
1294 // Sanity check the structors list.
1295 const ConstantArray *InitList = dyn_cast<ConstantArray>(List);
1296 if (!InitList) return; // Not an array!
1297 StructType *ETy = dyn_cast<StructType>(InitList->getType()->getElementType());
1298 if (!ETy || ETy->getNumElements() != 2) return; // Not an array of pairs!
1299 if (!isa<IntegerType>(ETy->getTypeAtIndex(0U)) ||
1300 !isa<PointerType>(ETy->getTypeAtIndex(1U))) return; // Not (int, ptr).
1302 // Gather the structors in a form that's convenient for sorting by priority.
1303 typedef std::pair<unsigned, Constant *> Structor;
1304 SmallVector<Structor, 8> Structors;
1305 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
1306 ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i));
1307 if (!CS) continue; // Malformed.
1308 if (CS->getOperand(1)->isNullValue())
1309 break; // Found a null terminator, skip the rest.
1310 ConstantInt *Priority = dyn_cast<ConstantInt>(CS->getOperand(0));
1311 if (!Priority) continue; // Malformed.
1312 Structors.push_back(std::make_pair(Priority->getLimitedValue(65535),
1313 CS->getOperand(1)));
1316 // Emit the function pointers in the target-specific order
1317 const DataLayout *TD = TM.getDataLayout();
1318 unsigned Align = Log2_32(TD->getPointerPrefAlignment());
1319 std::stable_sort(Structors.begin(), Structors.end(), less_first());
1320 for (unsigned i = 0, e = Structors.size(); i != e; ++i) {
1321 const MCSection *OutputSection =
1323 getObjFileLowering().getStaticCtorSection(Structors[i].first) :
1324 getObjFileLowering().getStaticDtorSection(Structors[i].first));
1325 OutStreamer.SwitchSection(OutputSection);
1326 if (OutStreamer.getCurrentSection() != OutStreamer.getPreviousSection())
1327 EmitAlignment(Align);
1328 EmitXXStructor(Structors[i].second);
1332 //===--------------------------------------------------------------------===//
1333 // Emission and print routines
1336 /// EmitInt8 - Emit a byte directive and value.
1338 void AsmPrinter::EmitInt8(int Value) const {
1339 OutStreamer.EmitIntValue(Value, 1);
1342 /// EmitInt16 - Emit a short directive and value.
1344 void AsmPrinter::EmitInt16(int Value) const {
1345 OutStreamer.EmitIntValue(Value, 2);
1348 /// EmitInt32 - Emit a long directive and value.
1350 void AsmPrinter::EmitInt32(int Value) const {
1351 OutStreamer.EmitIntValue(Value, 4);
1354 /// EmitLabelDifference - Emit something like ".long Hi-Lo" where the size
1355 /// in bytes of the directive is specified by Size and Hi/Lo specify the
1356 /// labels. This implicitly uses .set if it is available.
1357 void AsmPrinter::EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
1358 unsigned Size) const {
1359 // Get the Hi-Lo expression.
1360 const MCExpr *Diff =
1361 MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(Hi, OutContext),
1362 MCSymbolRefExpr::Create(Lo, OutContext),
1365 if (!MAI->hasSetDirective()) {
1366 OutStreamer.EmitValue(Diff, Size);
1370 // Otherwise, emit with .set (aka assignment).
1371 MCSymbol *SetLabel = GetTempSymbol("set", SetCounter++);
1372 OutStreamer.EmitAssignment(SetLabel, Diff);
1373 OutStreamer.EmitSymbolValue(SetLabel, Size);
1376 /// EmitLabelOffsetDifference - Emit something like ".long Hi+Offset-Lo"
1377 /// where the size in bytes of the directive is specified by Size and Hi/Lo
1378 /// specify the labels. This implicitly uses .set if it is available.
1379 void AsmPrinter::EmitLabelOffsetDifference(const MCSymbol *Hi, uint64_t Offset,
1380 const MCSymbol *Lo, unsigned Size)
1383 // Emit Hi+Offset - Lo
1384 // Get the Hi+Offset expression.
1385 const MCExpr *Plus =
1386 MCBinaryExpr::CreateAdd(MCSymbolRefExpr::Create(Hi, OutContext),
1387 MCConstantExpr::Create(Offset, OutContext),
1390 // Get the Hi+Offset-Lo expression.
1391 const MCExpr *Diff =
1392 MCBinaryExpr::CreateSub(Plus,
1393 MCSymbolRefExpr::Create(Lo, OutContext),
1396 if (!MAI->hasSetDirective())
1397 OutStreamer.EmitValue(Diff, 4);
1399 // Otherwise, emit with .set (aka assignment).
1400 MCSymbol *SetLabel = GetTempSymbol("set", SetCounter++);
1401 OutStreamer.EmitAssignment(SetLabel, Diff);
1402 OutStreamer.EmitSymbolValue(SetLabel, 4);
1406 /// EmitLabelPlusOffset - Emit something like ".long Label+Offset"
1407 /// where the size in bytes of the directive is specified by Size and Label
1408 /// specifies the label. This implicitly uses .set if it is available.
1409 void AsmPrinter::EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
1410 unsigned Size, bool IsSectionRelative)
1412 if (MAI->needsDwarfSectionOffsetDirective() && IsSectionRelative) {
1413 OutStreamer.EmitCOFFSecRel32(Label);
1417 // Emit Label+Offset (or just Label if Offset is zero)
1418 const MCExpr *Expr = MCSymbolRefExpr::Create(Label, OutContext);
1420 Expr = MCBinaryExpr::CreateAdd(Expr,
1421 MCConstantExpr::Create(Offset, OutContext),
1424 OutStreamer.EmitValue(Expr, Size);
1428 //===----------------------------------------------------------------------===//
1430 // EmitAlignment - Emit an alignment directive to the specified power of
1431 // two boundary. For example, if you pass in 3 here, you will get an 8
1432 // byte alignment. If a global value is specified, and if that global has
1433 // an explicit alignment requested, it will override the alignment request
1434 // if required for correctness.
1436 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV) const {
1437 if (GV) NumBits = getGVAlignmentLog2(GV, *TM.getDataLayout(), NumBits);
1439 if (NumBits == 0) return; // 1-byte aligned: no need to emit alignment.
1441 if (getCurrentSection()->getKind().isText())
1442 OutStreamer.EmitCodeAlignment(1 << NumBits);
1444 OutStreamer.EmitValueToAlignment(1 << NumBits, 0, 1, 0);
1447 //===----------------------------------------------------------------------===//
1448 // Constant emission.
1449 //===----------------------------------------------------------------------===//
1451 /// lowerConstant - Lower the specified LLVM Constant to an MCExpr.
1453 static const MCExpr *lowerConstant(const Constant *CV, AsmPrinter &AP) {
1454 MCContext &Ctx = AP.OutContext;
1456 if (CV->isNullValue() || isa<UndefValue>(CV))
1457 return MCConstantExpr::Create(0, Ctx);
1459 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
1460 return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
1462 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
1463 return MCSymbolRefExpr::Create(AP.Mang->getSymbol(GV), Ctx);
1465 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
1466 return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
1468 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
1470 llvm_unreachable("Unknown constant value to lower!");
1473 switch (CE->getOpcode()) {
1475 // If the code isn't optimized, there may be outstanding folding
1476 // opportunities. Attempt to fold the expression using DataLayout as a
1477 // last resort before giving up.
1479 ConstantFoldConstantExpression(CE, AP.TM.getDataLayout()))
1481 return lowerConstant(C, AP);
1483 // Otherwise report the problem to the user.
1486 raw_string_ostream OS(S);
1487 OS << "Unsupported expression in static initializer: ";
1488 WriteAsOperand(OS, CE, /*PrintType=*/false,
1489 !AP.MF ? 0 : AP.MF->getFunction()->getParent());
1490 report_fatal_error(OS.str());
1492 case Instruction::GetElementPtr: {
1493 const DataLayout &TD = *AP.TM.getDataLayout();
1494 // Generate a symbolic expression for the byte address
1495 APInt OffsetAI(TD.getPointerSizeInBits(), 0);
1496 cast<GEPOperator>(CE)->accumulateConstantOffset(TD, OffsetAI);
1498 const MCExpr *Base = lowerConstant(CE->getOperand(0), AP);
1502 int64_t Offset = OffsetAI.getSExtValue();
1503 return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
1507 case Instruction::Trunc:
1508 // We emit the value and depend on the assembler to truncate the generated
1509 // expression properly. This is important for differences between
1510 // blockaddress labels. Since the two labels are in the same function, it
1511 // is reasonable to treat their delta as a 32-bit value.
1513 case Instruction::BitCast:
1514 return lowerConstant(CE->getOperand(0), AP);
1516 case Instruction::IntToPtr: {
1517 const DataLayout &TD = *AP.TM.getDataLayout();
1518 // Handle casts to pointers by changing them into casts to the appropriate
1519 // integer type. This promotes constant folding and simplifies this code.
1520 Constant *Op = CE->getOperand(0);
1521 Op = ConstantExpr::getIntegerCast(Op, TD.getIntPtrType(CV->getContext()),
1523 return lowerConstant(Op, AP);
1526 case Instruction::PtrToInt: {
1527 const DataLayout &TD = *AP.TM.getDataLayout();
1528 // Support only foldable casts to/from pointers that can be eliminated by
1529 // changing the pointer to the appropriately sized integer type.
1530 Constant *Op = CE->getOperand(0);
1531 Type *Ty = CE->getType();
1533 const MCExpr *OpExpr = lowerConstant(Op, AP);
1535 // We can emit the pointer value into this slot if the slot is an
1536 // integer slot equal to the size of the pointer.
1537 if (TD.getTypeAllocSize(Ty) == TD.getTypeAllocSize(Op->getType()))
1540 // Otherwise the pointer is smaller than the resultant integer, mask off
1541 // the high bits so we are sure to get a proper truncation if the input is
1543 unsigned InBits = TD.getTypeAllocSizeInBits(Op->getType());
1544 const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
1545 return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
1548 // The MC library also has a right-shift operator, but it isn't consistently
1549 // signed or unsigned between different targets.
1550 case Instruction::Add:
1551 case Instruction::Sub:
1552 case Instruction::Mul:
1553 case Instruction::SDiv:
1554 case Instruction::SRem:
1555 case Instruction::Shl:
1556 case Instruction::And:
1557 case Instruction::Or:
1558 case Instruction::Xor: {
1559 const MCExpr *LHS = lowerConstant(CE->getOperand(0), AP);
1560 const MCExpr *RHS = lowerConstant(CE->getOperand(1), AP);
1561 switch (CE->getOpcode()) {
1562 default: llvm_unreachable("Unknown binary operator constant cast expr");
1563 case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
1564 case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
1565 case Instruction::Mul: return MCBinaryExpr::CreateMul(LHS, RHS, Ctx);
1566 case Instruction::SDiv: return MCBinaryExpr::CreateDiv(LHS, RHS, Ctx);
1567 case Instruction::SRem: return MCBinaryExpr::CreateMod(LHS, RHS, Ctx);
1568 case Instruction::Shl: return MCBinaryExpr::CreateShl(LHS, RHS, Ctx);
1569 case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
1570 case Instruction::Or: return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
1571 case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
1577 static void emitGlobalConstantImpl(const Constant *C, AsmPrinter &AP);
1579 /// isRepeatedByteSequence - Determine whether the given value is
1580 /// composed of a repeated sequence of identical bytes and return the
1581 /// byte value. If it is not a repeated sequence, return -1.
1582 static int isRepeatedByteSequence(const ConstantDataSequential *V) {
1583 StringRef Data = V->getRawDataValues();
1584 assert(!Data.empty() && "Empty aggregates should be CAZ node");
1586 for (unsigned i = 1, e = Data.size(); i != e; ++i)
1587 if (Data[i] != C) return -1;
1588 return static_cast<uint8_t>(C); // Ensure 255 is not returned as -1.
1592 /// isRepeatedByteSequence - Determine whether the given value is
1593 /// composed of a repeated sequence of identical bytes and return the
1594 /// byte value. If it is not a repeated sequence, return -1.
1595 static int isRepeatedByteSequence(const Value *V, TargetMachine &TM) {
1597 if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
1598 if (CI->getBitWidth() > 64) return -1;
1600 uint64_t Size = TM.getDataLayout()->getTypeAllocSize(V->getType());
1601 uint64_t Value = CI->getZExtValue();
1603 // Make sure the constant is at least 8 bits long and has a power
1604 // of 2 bit width. This guarantees the constant bit width is
1605 // always a multiple of 8 bits, avoiding issues with padding out
1606 // to Size and other such corner cases.
1607 if (CI->getBitWidth() < 8 || !isPowerOf2_64(CI->getBitWidth())) return -1;
1609 uint8_t Byte = static_cast<uint8_t>(Value);
1611 for (unsigned i = 1; i < Size; ++i) {
1613 if (static_cast<uint8_t>(Value) != Byte) return -1;
1617 if (const ConstantArray *CA = dyn_cast<ConstantArray>(V)) {
1618 // Make sure all array elements are sequences of the same repeated
1620 assert(CA->getNumOperands() != 0 && "Should be a CAZ");
1621 int Byte = isRepeatedByteSequence(CA->getOperand(0), TM);
1622 if (Byte == -1) return -1;
1624 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1625 int ThisByte = isRepeatedByteSequence(CA->getOperand(i), TM);
1626 if (ThisByte == -1) return -1;
1627 if (Byte != ThisByte) return -1;
1632 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V))
1633 return isRepeatedByteSequence(CDS);
1638 static void emitGlobalConstantDataSequential(const ConstantDataSequential *CDS,
1641 // See if we can aggregate this into a .fill, if so, emit it as such.
1642 int Value = isRepeatedByteSequence(CDS, AP.TM);
1644 uint64_t Bytes = AP.TM.getDataLayout()->getTypeAllocSize(CDS->getType());
1645 // Don't emit a 1-byte object as a .fill.
1647 return AP.OutStreamer.EmitFill(Bytes, Value);
1650 // If this can be emitted with .ascii/.asciz, emit it as such.
1651 if (CDS->isString())
1652 return AP.OutStreamer.EmitBytes(CDS->getAsString());
1654 // Otherwise, emit the values in successive locations.
1655 unsigned ElementByteSize = CDS->getElementByteSize();
1656 if (isa<IntegerType>(CDS->getElementType())) {
1657 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1659 AP.OutStreamer.GetCommentOS() << format("0x%" PRIx64 "\n",
1660 CDS->getElementAsInteger(i));
1661 AP.OutStreamer.EmitIntValue(CDS->getElementAsInteger(i),
1664 } else if (ElementByteSize == 4) {
1665 // FP Constants are printed as integer constants to avoid losing
1667 assert(CDS->getElementType()->isFloatTy());
1668 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1674 F = CDS->getElementAsFloat(i);
1676 AP.OutStreamer.GetCommentOS() << "float " << F << '\n';
1677 AP.OutStreamer.EmitIntValue(I, 4);
1680 assert(CDS->getElementType()->isDoubleTy());
1681 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1687 F = CDS->getElementAsDouble(i);
1689 AP.OutStreamer.GetCommentOS() << "double " << F << '\n';
1690 AP.OutStreamer.EmitIntValue(I, 8);
1694 const DataLayout &TD = *AP.TM.getDataLayout();
1695 unsigned Size = TD.getTypeAllocSize(CDS->getType());
1696 unsigned EmittedSize = TD.getTypeAllocSize(CDS->getType()->getElementType()) *
1697 CDS->getNumElements();
1698 if (unsigned Padding = Size - EmittedSize)
1699 AP.OutStreamer.EmitZeros(Padding);
1703 static void emitGlobalConstantArray(const ConstantArray *CA, AsmPrinter &AP) {
1704 // See if we can aggregate some values. Make sure it can be
1705 // represented as a series of bytes of the constant value.
1706 int Value = isRepeatedByteSequence(CA, AP.TM);
1709 uint64_t Bytes = AP.TM.getDataLayout()->getTypeAllocSize(CA->getType());
1710 AP.OutStreamer.EmitFill(Bytes, Value);
1713 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1714 emitGlobalConstantImpl(CA->getOperand(i), AP);
1718 static void emitGlobalConstantVector(const ConstantVector *CV, AsmPrinter &AP) {
1719 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
1720 emitGlobalConstantImpl(CV->getOperand(i), AP);
1722 const DataLayout &TD = *AP.TM.getDataLayout();
1723 unsigned Size = TD.getTypeAllocSize(CV->getType());
1724 unsigned EmittedSize = TD.getTypeAllocSize(CV->getType()->getElementType()) *
1725 CV->getType()->getNumElements();
1726 if (unsigned Padding = Size - EmittedSize)
1727 AP.OutStreamer.EmitZeros(Padding);
1730 static void emitGlobalConstantStruct(const ConstantStruct *CS, AsmPrinter &AP) {
1731 // Print the fields in successive locations. Pad to align if needed!
1732 const DataLayout *TD = AP.TM.getDataLayout();
1733 unsigned Size = TD->getTypeAllocSize(CS->getType());
1734 const StructLayout *Layout = TD->getStructLayout(CS->getType());
1735 uint64_t SizeSoFar = 0;
1736 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
1737 const Constant *Field = CS->getOperand(i);
1739 // Check if padding is needed and insert one or more 0s.
1740 uint64_t FieldSize = TD->getTypeAllocSize(Field->getType());
1741 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
1742 - Layout->getElementOffset(i)) - FieldSize;
1743 SizeSoFar += FieldSize + PadSize;
1745 // Now print the actual field value.
1746 emitGlobalConstantImpl(Field, AP);
1748 // Insert padding - this may include padding to increase the size of the
1749 // current field up to the ABI size (if the struct is not packed) as well
1750 // as padding to ensure that the next field starts at the right offset.
1751 AP.OutStreamer.EmitZeros(PadSize);
1753 assert(SizeSoFar == Layout->getSizeInBytes() &&
1754 "Layout of constant struct may be incorrect!");
1757 static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP) {
1758 APInt API = CFP->getValueAPF().bitcastToAPInt();
1760 // First print a comment with what we think the original floating-point value
1761 // should have been.
1762 if (AP.isVerbose()) {
1763 SmallString<8> StrVal;
1764 CFP->getValueAPF().toString(StrVal);
1766 CFP->getType()->print(AP.OutStreamer.GetCommentOS());
1767 AP.OutStreamer.GetCommentOS() << ' ' << StrVal << '\n';
1770 // Now iterate through the APInt chunks, emitting them in endian-correct
1771 // order, possibly with a smaller chunk at beginning/end (e.g. for x87 80-bit
1773 unsigned NumBytes = API.getBitWidth() / 8;
1774 unsigned TrailingBytes = NumBytes % sizeof(uint64_t);
1775 const uint64_t *p = API.getRawData();
1777 // PPC's long double has odd notions of endianness compared to how LLVM
1778 // handles it: p[0] goes first for *big* endian on PPC.
1779 if (AP.TM.getDataLayout()->isBigEndian() != CFP->getType()->isPPC_FP128Ty()) {
1780 int Chunk = API.getNumWords() - 1;
1783 AP.OutStreamer.EmitIntValue(p[Chunk--], TrailingBytes);
1785 for (; Chunk >= 0; --Chunk)
1786 AP.OutStreamer.EmitIntValue(p[Chunk], sizeof(uint64_t));
1789 for (Chunk = 0; Chunk < NumBytes / sizeof(uint64_t); ++Chunk)
1790 AP.OutStreamer.EmitIntValue(p[Chunk], sizeof(uint64_t));
1793 AP.OutStreamer.EmitIntValue(p[Chunk], TrailingBytes);
1796 // Emit the tail padding for the long double.
1797 const DataLayout &TD = *AP.TM.getDataLayout();
1798 AP.OutStreamer.EmitZeros(TD.getTypeAllocSize(CFP->getType()) -
1799 TD.getTypeStoreSize(CFP->getType()));
1802 static void emitGlobalConstantLargeInt(const ConstantInt *CI, AsmPrinter &AP) {
1803 const DataLayout *TD = AP.TM.getDataLayout();
1804 unsigned BitWidth = CI->getBitWidth();
1806 // Copy the value as we may massage the layout for constants whose bit width
1807 // is not a multiple of 64-bits.
1808 APInt Realigned(CI->getValue());
1809 uint64_t ExtraBits = 0;
1810 unsigned ExtraBitsSize = BitWidth & 63;
1812 if (ExtraBitsSize) {
1813 // The bit width of the data is not a multiple of 64-bits.
1814 // The extra bits are expected to be at the end of the chunk of the memory.
1816 // * Nothing to be done, just record the extra bits to emit.
1818 // * Record the extra bits to emit.
1819 // * Realign the raw data to emit the chunks of 64-bits.
1820 if (TD->isBigEndian()) {
1821 // Basically the structure of the raw data is a chunk of 64-bits cells:
1822 // 0 1 BitWidth / 64
1823 // [chunk1][chunk2] ... [chunkN].
1824 // The most significant chunk is chunkN and it should be emitted first.
1825 // However, due to the alignment issue chunkN contains useless bits.
1826 // Realign the chunks so that they contain only useless information:
1827 // ExtraBits 0 1 (BitWidth / 64) - 1
1828 // chu[nk1 chu][nk2 chu] ... [nkN-1 chunkN]
1829 ExtraBits = Realigned.getRawData()[0] &
1830 (((uint64_t)-1) >> (64 - ExtraBitsSize));
1831 Realigned = Realigned.lshr(ExtraBitsSize);
1833 ExtraBits = Realigned.getRawData()[BitWidth / 64];
1836 // We don't expect assemblers to support integer data directives
1837 // for more than 64 bits, so we emit the data in at most 64-bit
1838 // quantities at a time.
1839 const uint64_t *RawData = Realigned.getRawData();
1840 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1841 uint64_t Val = TD->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1842 AP.OutStreamer.EmitIntValue(Val, 8);
1845 if (ExtraBitsSize) {
1846 // Emit the extra bits after the 64-bits chunks.
1848 // Emit a directive that fills the expected size.
1849 uint64_t Size = AP.TM.getDataLayout()->getTypeAllocSize(CI->getType());
1850 Size -= (BitWidth / 64) * 8;
1851 assert(Size && Size * 8 >= ExtraBitsSize &&
1852 (ExtraBits & (((uint64_t)-1) >> (64 - ExtraBitsSize)))
1853 == ExtraBits && "Directive too small for extra bits.");
1854 AP.OutStreamer.EmitIntValue(ExtraBits, Size);
1858 static void emitGlobalConstantImpl(const Constant *CV, AsmPrinter &AP) {
1859 const DataLayout *TD = AP.TM.getDataLayout();
1860 uint64_t Size = TD->getTypeAllocSize(CV->getType());
1861 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV))
1862 return AP.OutStreamer.EmitZeros(Size);
1864 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1871 AP.OutStreamer.GetCommentOS() << format("0x%" PRIx64 "\n",
1872 CI->getZExtValue());
1873 AP.OutStreamer.EmitIntValue(CI->getZExtValue(), Size);
1876 emitGlobalConstantLargeInt(CI, AP);
1881 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1882 return emitGlobalConstantFP(CFP, AP);
1884 if (isa<ConstantPointerNull>(CV)) {
1885 AP.OutStreamer.EmitIntValue(0, Size);
1889 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(CV))
1890 return emitGlobalConstantDataSequential(CDS, AP);
1892 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1893 return emitGlobalConstantArray(CVA, AP);
1895 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1896 return emitGlobalConstantStruct(CVS, AP);
1898 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1899 // Look through bitcasts, which might not be able to be MCExpr'ized (e.g. of
1901 if (CE->getOpcode() == Instruction::BitCast)
1902 return emitGlobalConstantImpl(CE->getOperand(0), AP);
1905 // If the constant expression's size is greater than 64-bits, then we have
1906 // to emit the value in chunks. Try to constant fold the value and emit it
1908 Constant *New = ConstantFoldConstantExpression(CE, TD);
1909 if (New && New != CE)
1910 return emitGlobalConstantImpl(New, AP);
1914 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1915 return emitGlobalConstantVector(V, AP);
1917 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it
1918 // thread the streamer with EmitValue.
1919 AP.OutStreamer.EmitValue(lowerConstant(CV, AP), Size);
1922 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1923 void AsmPrinter::EmitGlobalConstant(const Constant *CV) {
1924 uint64_t Size = TM.getDataLayout()->getTypeAllocSize(CV->getType());
1926 emitGlobalConstantImpl(CV, *this);
1927 else if (MAI->hasSubsectionsViaSymbols()) {
1928 // If the global has zero size, emit a single byte so that two labels don't
1929 // look like they are at the same location.
1930 OutStreamer.EmitIntValue(0, 1);
1934 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1935 // Target doesn't support this yet!
1936 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1939 void AsmPrinter::printOffset(int64_t Offset, raw_ostream &OS) const {
1941 OS << '+' << Offset;
1942 else if (Offset < 0)
1946 //===----------------------------------------------------------------------===//
1947 // Symbol Lowering Routines.
1948 //===----------------------------------------------------------------------===//
1950 /// GetTempSymbol - Return the MCSymbol corresponding to the assembler
1951 /// temporary label with the specified stem and unique ID.
1952 MCSymbol *AsmPrinter::GetTempSymbol(StringRef Name, unsigned ID) const {
1953 return OutContext.GetOrCreateSymbol(Twine(MAI->getPrivateGlobalPrefix()) +
1957 /// GetTempSymbol - Return an assembler temporary label with the specified
1959 MCSymbol *AsmPrinter::GetTempSymbol(StringRef Name) const {
1960 return OutContext.GetOrCreateSymbol(Twine(MAI->getPrivateGlobalPrefix())+
1965 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const {
1966 return MMI->getAddrLabelSymbol(BA->getBasicBlock());
1969 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BasicBlock *BB) const {
1970 return MMI->getAddrLabelSymbol(BB);
1973 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
1974 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
1975 return OutContext.GetOrCreateSymbol
1976 (Twine(MAI->getPrivateGlobalPrefix()) + "CPI" + Twine(getFunctionNumber())
1977 + "_" + Twine(CPID));
1980 /// GetJTISymbol - Return the symbol for the specified jump table entry.
1981 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
1982 return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
1985 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
1986 /// FIXME: privatize to AsmPrinter.
1987 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
1988 return OutContext.GetOrCreateSymbol
1989 (Twine(MAI->getPrivateGlobalPrefix()) + Twine(getFunctionNumber()) + "_" +
1990 Twine(UID) + "_set_" + Twine(MBBID));
1993 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
1994 /// global value name as its base, with the specified suffix, and where the
1995 /// symbol is forced to have private linkage if ForcePrivate is true.
1996 MCSymbol *AsmPrinter::GetSymbolWithGlobalValueBase(const GlobalValue *GV,
1998 bool ForcePrivate) const {
1999 SmallString<60> NameStr;
2000 Mang->getNameWithPrefix(NameStr, GV, ForcePrivate);
2001 NameStr.append(Suffix.begin(), Suffix.end());
2002 return OutContext.GetOrCreateSymbol(NameStr.str());
2005 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
2007 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
2008 SmallString<60> NameStr;
2009 Mang->getNameWithPrefix(NameStr, Sym);
2010 return OutContext.GetOrCreateSymbol(NameStr.str());
2015 /// PrintParentLoopComment - Print comments about parent loops of this one.
2016 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2017 unsigned FunctionNumber) {
2018 if (Loop == 0) return;
2019 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
2020 OS.indent(Loop->getLoopDepth()*2)
2021 << "Parent Loop BB" << FunctionNumber << "_"
2022 << Loop->getHeader()->getNumber()
2023 << " Depth=" << Loop->getLoopDepth() << '\n';
2027 /// PrintChildLoopComment - Print comments about child loops within
2028 /// the loop for this basic block, with nesting.
2029 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2030 unsigned FunctionNumber) {
2031 // Add child loop information
2032 for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
2033 OS.indent((*CL)->getLoopDepth()*2)
2034 << "Child Loop BB" << FunctionNumber << "_"
2035 << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
2037 PrintChildLoopComment(OS, *CL, FunctionNumber);
2041 /// emitBasicBlockLoopComments - Pretty-print comments for basic blocks.
2042 static void emitBasicBlockLoopComments(const MachineBasicBlock &MBB,
2043 const MachineLoopInfo *LI,
2044 const AsmPrinter &AP) {
2045 // Add loop depth information
2046 const MachineLoop *Loop = LI->getLoopFor(&MBB);
2047 if (Loop == 0) return;
2049 MachineBasicBlock *Header = Loop->getHeader();
2050 assert(Header && "No header for loop");
2052 // If this block is not a loop header, just print out what is the loop header
2054 if (Header != &MBB) {
2055 AP.OutStreamer.AddComment(" in Loop: Header=BB" +
2056 Twine(AP.getFunctionNumber())+"_" +
2057 Twine(Loop->getHeader()->getNumber())+
2058 " Depth="+Twine(Loop->getLoopDepth()));
2062 // Otherwise, it is a loop header. Print out information about child and
2064 raw_ostream &OS = AP.OutStreamer.GetCommentOS();
2066 PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
2069 OS.indent(Loop->getLoopDepth()*2-2);
2074 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
2076 PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
2080 /// EmitBasicBlockStart - This method prints the label for the specified
2081 /// MachineBasicBlock, an alignment (if present) and a comment describing
2082 /// it if appropriate.
2083 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
2084 // Emit an alignment directive for this block, if needed.
2085 if (unsigned Align = MBB->getAlignment())
2086 EmitAlignment(Align);
2088 // If the block has its address taken, emit any labels that were used to
2089 // reference the block. It is possible that there is more than one label
2090 // here, because multiple LLVM BB's may have been RAUW'd to this block after
2091 // the references were generated.
2092 if (MBB->hasAddressTaken()) {
2093 const BasicBlock *BB = MBB->getBasicBlock();
2095 OutStreamer.AddComment("Block address taken");
2097 std::vector<MCSymbol*> Syms = MMI->getAddrLabelSymbolToEmit(BB);
2099 for (unsigned i = 0, e = Syms.size(); i != e; ++i)
2100 OutStreamer.EmitLabel(Syms[i]);
2103 // Print some verbose block comments.
2105 if (const BasicBlock *BB = MBB->getBasicBlock())
2107 OutStreamer.AddComment("%" + BB->getName());
2108 emitBasicBlockLoopComments(*MBB, LI, *this);
2111 // Print the main label for the block.
2112 if (MBB->pred_empty() || isBlockOnlyReachableByFallthrough(MBB)) {
2113 if (isVerbose() && OutStreamer.hasRawTextSupport()) {
2114 // NOTE: Want this comment at start of line, don't emit with AddComment.
2115 OutStreamer.EmitRawText(Twine(MAI->getCommentString()) + " BB#" +
2116 Twine(MBB->getNumber()) + ":");
2119 OutStreamer.EmitLabel(MBB->getSymbol());
2123 void AsmPrinter::EmitVisibility(MCSymbol *Sym, unsigned Visibility,
2124 bool IsDefinition) const {
2125 MCSymbolAttr Attr = MCSA_Invalid;
2127 switch (Visibility) {
2129 case GlobalValue::HiddenVisibility:
2131 Attr = MAI->getHiddenVisibilityAttr();
2133 Attr = MAI->getHiddenDeclarationVisibilityAttr();
2135 case GlobalValue::ProtectedVisibility:
2136 Attr = MAI->getProtectedVisibilityAttr();
2140 if (Attr != MCSA_Invalid)
2141 OutStreamer.EmitSymbolAttribute(Sym, Attr);
2144 /// isBlockOnlyReachableByFallthough - Return true if the basic block has
2145 /// exactly one predecessor and the control transfer mechanism between
2146 /// the predecessor and this block is a fall-through.
2148 isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const {
2149 // If this is a landing pad, it isn't a fall through. If it has no preds,
2150 // then nothing falls through to it.
2151 if (MBB->isLandingPad() || MBB->pred_empty())
2154 // If there isn't exactly one predecessor, it can't be a fall through.
2155 MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(), PI2 = PI;
2157 if (PI2 != MBB->pred_end())
2160 // The predecessor has to be immediately before this block.
2161 MachineBasicBlock *Pred = *PI;
2163 if (!Pred->isLayoutSuccessor(MBB))
2166 // If the block is completely empty, then it definitely does fall through.
2170 // Check the terminators in the previous blocks
2171 for (MachineBasicBlock::iterator II = Pred->getFirstTerminator(),
2172 IE = Pred->end(); II != IE; ++II) {
2173 MachineInstr &MI = *II;
2175 // If it is not a simple branch, we are in a table somewhere.
2176 if (!MI.isBranch() || MI.isIndirectBranch())
2179 // If we are the operands of one of the branches, this is not
2181 for (MachineInstr::mop_iterator OI = MI.operands_begin(),
2182 OE = MI.operands_end(); OI != OE; ++OI) {
2183 const MachineOperand& OP = *OI;
2186 if (OP.isMBB() && OP.getMBB() == MBB)
2196 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
2197 if (!S->usesMetadata())
2200 gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
2201 gcp_map_type::iterator GCPI = GCMap.find(S);
2202 if (GCPI != GCMap.end())
2203 return GCPI->second;
2205 const char *Name = S->getName().c_str();
2207 for (GCMetadataPrinterRegistry::iterator
2208 I = GCMetadataPrinterRegistry::begin(),
2209 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
2210 if (strcmp(Name, I->getName()) == 0) {
2211 GCMetadataPrinter *GMP = I->instantiate();
2213 GCMap.insert(std::make_pair(S, GMP));
2217 report_fatal_error("no GCMetadataPrinter registered for GC: " + Twine(Name));