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/CodeGen/GCMetadataPrinter.h"
22 #include "llvm/CodeGen/MachineConstantPool.h"
23 #include "llvm/CodeGen/MachineFrameInfo.h"
24 #include "llvm/CodeGen/MachineFunction.h"
25 #include "llvm/CodeGen/MachineInstrBundle.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/Mangler.h"
32 #include "llvm/IR/Module.h"
33 #include "llvm/IR/Operator.h"
34 #include "llvm/MC/MCAsmInfo.h"
35 #include "llvm/MC/MCContext.h"
36 #include "llvm/MC/MCExpr.h"
37 #include "llvm/MC/MCInst.h"
38 #include "llvm/MC/MCSection.h"
39 #include "llvm/MC/MCStreamer.h"
40 #include "llvm/MC/MCSymbol.h"
41 #include "llvm/Support/ErrorHandling.h"
42 #include "llvm/Support/Format.h"
43 #include "llvm/Support/MathExtras.h"
44 #include "llvm/Support/Timer.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"
51 #include "llvm/Target/TargetSubtargetInfo.h"
52 #include "llvm/Transforms/Utils/GlobalStatus.h"
53 #include "WinCodeViewLineTables.h"
56 static const char *const DWARFGroupName = "DWARF Emission";
57 static const char *const DbgTimerName = "Debug Info Emission";
58 static const char *const EHTimerName = "DWARF Exception Writer";
59 static const char *const CodeViewLineTablesGroupName = "CodeView Line Tables";
61 STATISTIC(EmittedInsts, "Number of machine instrs printed");
63 char AsmPrinter::ID = 0;
65 typedef DenseMap<GCStrategy*,GCMetadataPrinter*> gcp_map_type;
66 static gcp_map_type &getGCMap(void *&P) {
68 P = new gcp_map_type();
69 return *(gcp_map_type*)P;
73 /// getGVAlignmentLog2 - Return the alignment to use for the specified global
74 /// value in log2 form. This rounds up to the preferred alignment if possible
76 static unsigned getGVAlignmentLog2(const GlobalValue *GV, const DataLayout &TD,
77 unsigned InBits = 0) {
79 if (const GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV))
80 NumBits = TD.getPreferredAlignmentLog(GVar);
82 // If InBits is specified, round it to it.
86 // If the GV has a specified alignment, take it into account.
87 if (GV->getAlignment() == 0)
90 unsigned GVAlign = Log2_32(GV->getAlignment());
92 // If the GVAlign is larger than NumBits, or if we are required to obey
93 // NumBits because the GV has an assigned section, obey it.
94 if (GVAlign > NumBits || GV->hasSection())
99 AsmPrinter::AsmPrinter(TargetMachine &tm, MCStreamer &Streamer)
100 : MachineFunctionPass(ID),
101 TM(tm), MAI(tm.getMCAsmInfo()), MII(tm.getInstrInfo()),
102 OutContext(Streamer.getContext()),
103 OutStreamer(Streamer),
104 LastMI(0), LastFn(0), Counter(~0U), SetCounter(0) {
105 DD = 0; MMI = 0; LI = 0; MF = 0;
106 CurrentFnSym = CurrentFnSymForSize = 0;
107 GCMetadataPrinters = 0;
108 VerboseAsm = Streamer.isVerboseAsm();
111 AsmPrinter::~AsmPrinter() {
112 assert(DD == 0 && Handlers.empty() && "Debug/EH info didn't get finalized");
114 if (GCMetadataPrinters != 0) {
115 gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
117 for (gcp_map_type::iterator I = GCMap.begin(), E = GCMap.end(); I != E; ++I)
120 GCMetadataPrinters = 0;
126 /// getFunctionNumber - Return a unique ID for the current function.
128 unsigned AsmPrinter::getFunctionNumber() const {
129 return MF->getFunctionNumber();
132 const TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
133 return TM.getTargetLowering()->getObjFileLowering();
136 /// getDataLayout - Return information about data layout.
137 const DataLayout &AsmPrinter::getDataLayout() const {
138 return *TM.getDataLayout();
141 const MCSubtargetInfo &AsmPrinter::getSubtargetInfo() const {
142 return TM.getSubtarget<MCSubtargetInfo>();
145 void AsmPrinter::EmitToStreamer(MCStreamer &S, const MCInst &Inst) {
146 S.EmitInstruction(Inst, getSubtargetInfo());
149 StringRef AsmPrinter::getTargetTriple() const {
150 return TM.getTargetTriple();
153 /// getCurrentSection() - Return the current section we are emitting to.
154 const MCSection *AsmPrinter::getCurrentSection() const {
155 return OutStreamer.getCurrentSection().first;
160 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
161 AU.setPreservesAll();
162 MachineFunctionPass::getAnalysisUsage(AU);
163 AU.addRequired<MachineModuleInfo>();
164 AU.addRequired<GCModuleInfo>();
166 AU.addRequired<MachineLoopInfo>();
169 bool AsmPrinter::doInitialization(Module &M) {
170 MMI = getAnalysisIfAvailable<MachineModuleInfo>();
171 MMI->AnalyzeModule(M);
173 // Initialize TargetLoweringObjectFile.
174 const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
175 .Initialize(OutContext, TM);
177 OutStreamer.InitSections(false);
179 Mang = new Mangler(TM.getDataLayout());
181 // Allow the target to emit any magic that it wants at the start of the file.
182 EmitStartOfAsmFile(M);
184 // Very minimal debug info. It is ignored if we emit actual debug info. If we
185 // don't, this at least helps the user find where a global came from.
186 if (MAI->hasSingleParameterDotFile()) {
188 OutStreamer.EmitFileDirective(M.getModuleIdentifier());
191 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
192 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
193 for (GCModuleInfo::iterator I = MI->begin(), E = MI->end(); I != E; ++I)
194 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
195 MP->beginAssembly(*this);
197 // Emit module-level inline asm if it exists.
198 if (!M.getModuleInlineAsm().empty()) {
199 OutStreamer.AddComment("Start of file scope inline assembly");
200 OutStreamer.AddBlankLine();
201 EmitInlineAsm(M.getModuleInlineAsm()+"\n");
202 OutStreamer.AddComment("End of file scope inline assembly");
203 OutStreamer.AddBlankLine();
206 if (MAI->doesSupportDebugInformation()) {
207 if (Triple(TM.getTargetTriple()).getOS() == Triple::Win32) {
208 Handlers.push_back(HandlerInfo(new WinCodeViewLineTables(this),
210 CodeViewLineTablesGroupName));
212 DD = new DwarfDebug(this, &M);
213 Handlers.push_back(HandlerInfo(DD, DbgTimerName, DWARFGroupName));
217 DwarfException *DE = 0;
218 switch (MAI->getExceptionHandlingType()) {
219 case ExceptionHandling::None:
221 case ExceptionHandling::SjLj:
222 case ExceptionHandling::DwarfCFI:
223 DE = new DwarfCFIException(this);
225 case ExceptionHandling::ARM:
226 DE = new ARMException(this);
228 case ExceptionHandling::Win64:
229 DE = new Win64Exception(this);
233 Handlers.push_back(HandlerInfo(DE, EHTimerName, DWARFGroupName));
237 static bool canBeHidden(const GlobalValue *GV, const MCAsmInfo &MAI) {
238 GlobalValue::LinkageTypes Linkage = GV->getLinkage();
239 if (Linkage != GlobalValue::LinkOnceODRLinkage)
242 if (!MAI.hasWeakDefCanBeHiddenDirective())
245 if (GV->hasUnnamedAddr())
248 // This is only used for MachO, so right now it doesn't really matter how
249 // we handle alias. Revisit this once the MachO linker implements aliases.
250 if (isa<GlobalAlias>(GV))
253 // If it is a non constant variable, it needs to be uniqued across shared
255 if (const GlobalVariable *Var = dyn_cast<GlobalVariable>(GV)) {
256 if (!Var->isConstant())
261 if (!GlobalStatus::analyzeGlobal(GV, GS) && !GS.IsCompared)
267 void AsmPrinter::EmitLinkage(const GlobalValue *GV, MCSymbol *GVSym) const {
268 GlobalValue::LinkageTypes Linkage = GV->getLinkage();
270 case GlobalValue::CommonLinkage:
271 case GlobalValue::LinkOnceAnyLinkage:
272 case GlobalValue::LinkOnceODRLinkage:
273 case GlobalValue::WeakAnyLinkage:
274 case GlobalValue::WeakODRLinkage:
275 case GlobalValue::LinkerPrivateWeakLinkage:
276 if (MAI->hasWeakDefDirective()) {
278 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
280 if (!canBeHidden(GV, *MAI))
281 // .weak_definition _foo
282 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefinition);
284 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefAutoPrivate);
285 } else if (MAI->hasLinkOnceDirective()) {
287 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
288 //NOTE: linkonce is handled by the section the symbol was assigned to.
291 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Weak);
294 case GlobalValue::AppendingLinkage:
295 // FIXME: appending linkage variables should go into a section of
296 // their name or something. For now, just emit them as external.
297 case GlobalValue::ExternalLinkage:
298 // If external or appending, declare as a global symbol.
300 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
302 case GlobalValue::PrivateLinkage:
303 case GlobalValue::InternalLinkage:
304 case GlobalValue::LinkerPrivateLinkage:
306 case GlobalValue::AvailableExternallyLinkage:
307 llvm_unreachable("Should never emit this");
308 case GlobalValue::ExternalWeakLinkage:
309 llvm_unreachable("Don't know how to emit these");
311 llvm_unreachable("Unknown linkage type!");
314 MCSymbol *AsmPrinter::getSymbol(const GlobalValue *GV) const {
315 return getObjFileLowering().getSymbol(GV, *Mang);
318 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
319 void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
320 if (GV->hasInitializer()) {
321 // Check to see if this is a special global used by LLVM, if so, emit it.
322 if (EmitSpecialLLVMGlobal(GV))
326 GV->printAsOperand(OutStreamer.GetCommentOS(),
327 /*PrintType=*/false, GV->getParent());
328 OutStreamer.GetCommentOS() << '\n';
332 MCSymbol *GVSym = getSymbol(GV);
333 EmitVisibility(GVSym, GV->getVisibility(), !GV->isDeclaration());
335 if (!GV->hasInitializer()) // External globals require no extra code.
338 if (MAI->hasDotTypeDotSizeDirective())
339 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_ELF_TypeObject);
341 SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
343 const DataLayout *DL = TM.getDataLayout();
344 uint64_t Size = DL->getTypeAllocSize(GV->getType()->getElementType());
346 // If the alignment is specified, we *must* obey it. Overaligning a global
347 // with a specified alignment is a prompt way to break globals emitted to
348 // sections and expected to be contiguous (e.g. ObjC metadata).
349 unsigned AlignLog = getGVAlignmentLog2(GV, *DL);
351 for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
352 const HandlerInfo &OI = Handlers[I];
353 NamedRegionTimer T(OI.TimerName, OI.TimerGroupName, TimePassesIsEnabled);
354 OI.Handler->setSymbolSize(GVSym, Size);
357 // Handle common and BSS local symbols (.lcomm).
358 if (GVKind.isCommon() || GVKind.isBSSLocal()) {
359 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
360 unsigned Align = 1 << AlignLog;
362 // Handle common symbols.
363 if (GVKind.isCommon()) {
364 if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
368 OutStreamer.EmitCommonSymbol(GVSym, Size, Align);
372 // Handle local BSS symbols.
373 if (MAI->hasMachoZeroFillDirective()) {
374 const MCSection *TheSection =
375 getObjFileLowering().SectionForGlobal(GV, GVKind, *Mang, TM);
376 // .zerofill __DATA, __bss, _foo, 400, 5
377 OutStreamer.EmitZerofill(TheSection, GVSym, Size, Align);
381 // Use .lcomm only if it supports user-specified alignment.
382 // Otherwise, while it would still be correct to use .lcomm in some
383 // cases (e.g. when Align == 1), the external assembler might enfore
384 // some -unknown- default alignment behavior, which could cause
385 // spurious differences between external and integrated assembler.
386 // Prefer to simply fall back to .local / .comm in this case.
387 if (MAI->getLCOMMDirectiveAlignmentType() != LCOMM::NoAlignment) {
389 OutStreamer.EmitLocalCommonSymbol(GVSym, Size, Align);
393 if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
397 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Local);
399 OutStreamer.EmitCommonSymbol(GVSym, Size, Align);
403 const MCSection *TheSection =
404 getObjFileLowering().SectionForGlobal(GV, GVKind, *Mang, TM);
406 // Handle the zerofill directive on darwin, which is a special form of BSS
408 if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
409 if (Size == 0) Size = 1; // zerofill of 0 bytes is undefined.
412 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
413 // .zerofill __DATA, __common, _foo, 400, 5
414 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
418 // Handle thread local data for mach-o which requires us to output an
419 // additional structure of data and mangle the original symbol so that we
420 // can reference it later.
422 // TODO: This should become an "emit thread local global" method on TLOF.
423 // All of this macho specific stuff should be sunk down into TLOFMachO and
424 // stuff like "TLSExtraDataSection" should no longer be part of the parent
425 // TLOF class. This will also make it more obvious that stuff like
426 // MCStreamer::EmitTBSSSymbol is macho specific and only called from macho
428 if (GVKind.isThreadLocal() && MAI->hasMachoTBSSDirective()) {
429 // Emit the .tbss symbol
431 OutContext.GetOrCreateSymbol(GVSym->getName() + Twine("$tlv$init"));
433 if (GVKind.isThreadBSS()) {
434 TheSection = getObjFileLowering().getTLSBSSSection();
435 OutStreamer.EmitTBSSSymbol(TheSection, MangSym, Size, 1 << AlignLog);
436 } else if (GVKind.isThreadData()) {
437 OutStreamer.SwitchSection(TheSection);
439 EmitAlignment(AlignLog, GV);
440 OutStreamer.EmitLabel(MangSym);
442 EmitGlobalConstant(GV->getInitializer());
445 OutStreamer.AddBlankLine();
447 // Emit the variable struct for the runtime.
448 const MCSection *TLVSect
449 = getObjFileLowering().getTLSExtraDataSection();
451 OutStreamer.SwitchSection(TLVSect);
452 // Emit the linkage here.
453 EmitLinkage(GV, GVSym);
454 OutStreamer.EmitLabel(GVSym);
456 // Three pointers in size:
457 // - __tlv_bootstrap - used to make sure support exists
458 // - spare pointer, used when mapped by the runtime
459 // - pointer to mangled symbol above with initializer
460 unsigned PtrSize = DL->getPointerTypeSize(GV->getType());
461 OutStreamer.EmitSymbolValue(GetExternalSymbolSymbol("_tlv_bootstrap"),
463 OutStreamer.EmitIntValue(0, PtrSize);
464 OutStreamer.EmitSymbolValue(MangSym, PtrSize);
466 OutStreamer.AddBlankLine();
470 OutStreamer.SwitchSection(TheSection);
472 EmitLinkage(GV, GVSym);
473 EmitAlignment(AlignLog, GV);
475 OutStreamer.EmitLabel(GVSym);
477 EmitGlobalConstant(GV->getInitializer());
479 if (MAI->hasDotTypeDotSizeDirective())
481 OutStreamer.EmitELFSize(GVSym, MCConstantExpr::Create(Size, OutContext));
483 OutStreamer.AddBlankLine();
486 /// EmitFunctionHeader - This method emits the header for the current
488 void AsmPrinter::EmitFunctionHeader() {
489 // Print out constants referenced by the function
492 // Print the 'header' of function.
493 const Function *F = MF->getFunction();
495 OutStreamer.SwitchSection(
496 getObjFileLowering().SectionForGlobal(F, *Mang, TM));
497 EmitVisibility(CurrentFnSym, F->getVisibility());
499 EmitLinkage(F, CurrentFnSym);
500 EmitAlignment(MF->getAlignment(), F);
502 if (MAI->hasDotTypeDotSizeDirective())
503 OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCSA_ELF_TypeFunction);
506 F->printAsOperand(OutStreamer.GetCommentOS(),
507 /*PrintType=*/false, F->getParent());
508 OutStreamer.GetCommentOS() << '\n';
511 // Emit the CurrentFnSym. This is a virtual function to allow targets to
512 // do their wild and crazy things as required.
513 EmitFunctionEntryLabel();
515 // If the function had address-taken blocks that got deleted, then we have
516 // references to the dangling symbols. Emit them at the start of the function
517 // so that we don't get references to undefined symbols.
518 std::vector<MCSymbol*> DeadBlockSyms;
519 MMI->takeDeletedSymbolsForFunction(F, DeadBlockSyms);
520 for (unsigned i = 0, e = DeadBlockSyms.size(); i != e; ++i) {
521 OutStreamer.AddComment("Address taken block that was later removed");
522 OutStreamer.EmitLabel(DeadBlockSyms[i]);
525 // Emit pre-function debug and/or EH information.
526 for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
527 const HandlerInfo &OI = Handlers[I];
528 NamedRegionTimer T(OI.TimerName, OI.TimerGroupName, TimePassesIsEnabled);
529 OI.Handler->beginFunction(MF);
532 // Emit the prefix data.
533 if (F->hasPrefixData())
534 EmitGlobalConstant(F->getPrefixData());
537 /// EmitFunctionEntryLabel - Emit the label that is the entrypoint for the
538 /// function. This can be overridden by targets as required to do custom stuff.
539 void AsmPrinter::EmitFunctionEntryLabel() {
540 // The function label could have already been emitted if two symbols end up
541 // conflicting due to asm renaming. Detect this and emit an error.
542 if (CurrentFnSym->isUndefined())
543 return OutStreamer.EmitLabel(CurrentFnSym);
545 report_fatal_error("'" + Twine(CurrentFnSym->getName()) +
546 "' label emitted multiple times to assembly file");
549 /// emitComments - Pretty-print comments for instructions.
550 static void emitComments(const MachineInstr &MI, raw_ostream &CommentOS) {
551 const MachineFunction *MF = MI.getParent()->getParent();
552 const TargetMachine &TM = MF->getTarget();
554 // Check for spills and reloads
557 const MachineFrameInfo *FrameInfo = MF->getFrameInfo();
559 // We assume a single instruction only has a spill or reload, not
561 const MachineMemOperand *MMO;
562 if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
563 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
564 MMO = *MI.memoperands_begin();
565 CommentOS << MMO->getSize() << "-byte Reload\n";
567 } else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
568 if (FrameInfo->isSpillSlotObjectIndex(FI))
569 CommentOS << MMO->getSize() << "-byte Folded Reload\n";
570 } else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
571 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
572 MMO = *MI.memoperands_begin();
573 CommentOS << MMO->getSize() << "-byte Spill\n";
575 } else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
576 if (FrameInfo->isSpillSlotObjectIndex(FI))
577 CommentOS << MMO->getSize() << "-byte Folded Spill\n";
580 // Check for spill-induced copies
581 if (MI.getAsmPrinterFlag(MachineInstr::ReloadReuse))
582 CommentOS << " Reload Reuse\n";
585 /// emitImplicitDef - This method emits the specified machine instruction
586 /// that is an implicit def.
587 void AsmPrinter::emitImplicitDef(const MachineInstr *MI) const {
588 unsigned RegNo = MI->getOperand(0).getReg();
589 OutStreamer.AddComment(Twine("implicit-def: ") +
590 TM.getRegisterInfo()->getName(RegNo));
591 OutStreamer.AddBlankLine();
594 static void emitKill(const MachineInstr *MI, AsmPrinter &AP) {
595 std::string Str = "kill:";
596 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
597 const MachineOperand &Op = MI->getOperand(i);
598 assert(Op.isReg() && "KILL instruction must have only register operands");
600 Str += AP.TM.getRegisterInfo()->getName(Op.getReg());
601 Str += (Op.isDef() ? "<def>" : "<kill>");
603 AP.OutStreamer.AddComment(Str);
604 AP.OutStreamer.AddBlankLine();
607 /// emitDebugValueComment - This method handles the target-independent form
608 /// of DBG_VALUE, returning true if it was able to do so. A false return
609 /// means the target will need to handle MI in EmitInstruction.
610 static bool emitDebugValueComment(const MachineInstr *MI, AsmPrinter &AP) {
611 // This code handles only the 3-operand target-independent form.
612 if (MI->getNumOperands() != 3)
615 SmallString<128> Str;
616 raw_svector_ostream OS(Str);
617 OS << "DEBUG_VALUE: ";
619 DIVariable V(MI->getOperand(2).getMetadata());
620 if (V.getContext().isSubprogram()) {
621 StringRef Name = DISubprogram(V.getContext()).getDisplayName();
625 OS << V.getName() << " <- ";
627 // The second operand is only an offset if it's an immediate.
628 bool Deref = MI->getOperand(0).isReg() && MI->getOperand(1).isImm();
629 int64_t Offset = Deref ? MI->getOperand(1).getImm() : 0;
631 // Register or immediate value. Register 0 means undef.
632 if (MI->getOperand(0).isFPImm()) {
633 APFloat APF = APFloat(MI->getOperand(0).getFPImm()->getValueAPF());
634 if (MI->getOperand(0).getFPImm()->getType()->isFloatTy()) {
635 OS << (double)APF.convertToFloat();
636 } else if (MI->getOperand(0).getFPImm()->getType()->isDoubleTy()) {
637 OS << APF.convertToDouble();
639 // There is no good way to print long double. Convert a copy to
640 // double. Ah well, it's only a comment.
642 APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
644 OS << "(long double) " << APF.convertToDouble();
646 } else if (MI->getOperand(0).isImm()) {
647 OS << MI->getOperand(0).getImm();
648 } else if (MI->getOperand(0).isCImm()) {
649 MI->getOperand(0).getCImm()->getValue().print(OS, false /*isSigned*/);
652 if (MI->getOperand(0).isReg()) {
653 Reg = MI->getOperand(0).getReg();
655 assert(MI->getOperand(0).isFI() && "Unknown operand type");
656 const TargetFrameLowering *TFI = AP.TM.getFrameLowering();
657 Offset += TFI->getFrameIndexReference(*AP.MF,
658 MI->getOperand(0).getIndex(), Reg);
662 // Suppress offset, it is not meaningful here.
664 // NOTE: Want this comment at start of line, don't emit with AddComment.
665 AP.OutStreamer.emitRawComment(OS.str());
670 OS << AP.TM.getRegisterInfo()->getName(Reg);
674 OS << '+' << Offset << ']';
676 // NOTE: Want this comment at start of line, don't emit with AddComment.
677 AP.OutStreamer.emitRawComment(OS.str());
681 AsmPrinter::CFIMoveType AsmPrinter::needsCFIMoves() {
682 if (MAI->getExceptionHandlingType() == ExceptionHandling::DwarfCFI &&
683 MF->getFunction()->needsUnwindTableEntry())
686 if (MMI->hasDebugInfo())
692 bool AsmPrinter::needsSEHMoves() {
693 return MAI->getExceptionHandlingType() == ExceptionHandling::Win64 &&
694 MF->getFunction()->needsUnwindTableEntry();
697 void AsmPrinter::emitPrologLabel(const MachineInstr &MI) {
698 const MCSymbol *Label = MI.getOperand(0).getMCSymbol();
700 if (MAI->getExceptionHandlingType() != ExceptionHandling::DwarfCFI)
703 if (needsCFIMoves() == CFI_M_None)
706 if (MMI->getCompactUnwindEncoding() != 0)
707 OutStreamer.EmitCompactUnwindEncoding(MMI->getCompactUnwindEncoding());
709 const MachineModuleInfo &MMI = MF->getMMI();
710 const std::vector<MCCFIInstruction> &Instrs = MMI.getFrameInstructions();
711 bool FoundOne = false;
713 for (std::vector<MCCFIInstruction>::const_iterator I = Instrs.begin(),
714 E = Instrs.end(); I != E; ++I) {
715 if (I->getLabel() == Label) {
716 emitCFIInstruction(*I);
723 /// EmitFunctionBody - This method emits the body and trailer for a
725 void AsmPrinter::EmitFunctionBody() {
726 // Emit target-specific gunk before the function body.
727 EmitFunctionBodyStart();
729 bool ShouldPrintDebugScopes = MMI->hasDebugInfo();
731 // Print out code for the function.
732 bool HasAnyRealCode = false;
733 const MachineInstr *LastMI = 0;
734 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
736 // Print a label for the basic block.
737 EmitBasicBlockStart(I);
738 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
742 // Print the assembly for the instruction.
743 if (!II->isLabel() && !II->isImplicitDef() && !II->isKill() &&
744 !II->isDebugValue()) {
745 HasAnyRealCode = true;
749 if (ShouldPrintDebugScopes) {
750 for (unsigned III = 0, EEE = Handlers.size(); III != EEE; ++III) {
751 const HandlerInfo &OI = Handlers[III];
752 NamedRegionTimer T(OI.TimerName, OI.TimerGroupName,
753 TimePassesIsEnabled);
754 OI.Handler->beginInstruction(II);
759 emitComments(*II, OutStreamer.GetCommentOS());
761 switch (II->getOpcode()) {
762 case TargetOpcode::PROLOG_LABEL:
763 emitPrologLabel(*II);
766 case TargetOpcode::EH_LABEL:
767 case TargetOpcode::GC_LABEL:
768 OutStreamer.EmitLabel(II->getOperand(0).getMCSymbol());
770 case TargetOpcode::INLINEASM:
773 case TargetOpcode::DBG_VALUE:
775 if (!emitDebugValueComment(II, *this))
779 case TargetOpcode::IMPLICIT_DEF:
780 if (isVerbose()) emitImplicitDef(II);
782 case TargetOpcode::KILL:
783 if (isVerbose()) emitKill(II, *this);
790 if (ShouldPrintDebugScopes) {
791 for (unsigned III = 0, EEE = Handlers.size(); III != EEE; ++III) {
792 const HandlerInfo &OI = Handlers[III];
793 NamedRegionTimer T(OI.TimerName, OI.TimerGroupName,
794 TimePassesIsEnabled);
795 OI.Handler->endInstruction();
801 // If the last instruction was a prolog label, then we have a situation where
802 // we emitted a prolog but no function body. This results in the ending prolog
803 // label equaling the end of function label and an invalid "row" in the
804 // FDE. We need to emit a noop in this situation so that the FDE's rows are
806 bool RequiresNoop = LastMI && LastMI->isPrologLabel();
808 // If the function is empty and the object file uses .subsections_via_symbols,
809 // then we need to emit *something* to the function body to prevent the
810 // labels from collapsing together. Just emit a noop.
811 if ((MAI->hasSubsectionsViaSymbols() && !HasAnyRealCode) || RequiresNoop) {
813 TM.getInstrInfo()->getNoopForMachoTarget(Noop);
814 if (Noop.getOpcode()) {
815 OutStreamer.AddComment("avoids zero-length function");
816 OutStreamer.EmitInstruction(Noop, getSubtargetInfo());
817 } else // Target not mc-ized yet.
818 OutStreamer.EmitRawText(StringRef("\tnop\n"));
821 const Function *F = MF->getFunction();
822 for (Function::const_iterator i = F->begin(), e = F->end(); i != e; ++i) {
823 const BasicBlock *BB = i;
824 if (!BB->hasAddressTaken())
826 MCSymbol *Sym = GetBlockAddressSymbol(BB);
827 if (Sym->isDefined())
829 OutStreamer.AddComment("Address of block that was removed by CodeGen");
830 OutStreamer.EmitLabel(Sym);
833 // Emit target-specific gunk after the function body.
834 EmitFunctionBodyEnd();
836 // If the target wants a .size directive for the size of the function, emit
838 if (MAI->hasDotTypeDotSizeDirective()) {
839 // Create a symbol for the end of function, so we can get the size as
840 // difference between the function label and the temp label.
841 MCSymbol *FnEndLabel = OutContext.CreateTempSymbol();
842 OutStreamer.EmitLabel(FnEndLabel);
844 const MCExpr *SizeExp =
845 MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(FnEndLabel, OutContext),
846 MCSymbolRefExpr::Create(CurrentFnSymForSize,
849 OutStreamer.EmitELFSize(CurrentFnSym, SizeExp);
852 // Emit post-function debug and/or EH information.
853 for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
854 const HandlerInfo &OI = Handlers[I];
855 NamedRegionTimer T(OI.TimerName, OI.TimerGroupName, TimePassesIsEnabled);
856 OI.Handler->endFunction(MF);
860 // Print out jump tables referenced by the function.
863 OutStreamer.AddBlankLine();
866 /// EmitDwarfRegOp - Emit dwarf register operation.
867 void AsmPrinter::EmitDwarfRegOp(const MachineLocation &MLoc,
868 bool Indirect) const {
869 const TargetRegisterInfo *TRI = TM.getRegisterInfo();
870 int Reg = TRI->getDwarfRegNum(MLoc.getReg(), false);
872 for (MCSuperRegIterator SR(MLoc.getReg(), TRI); SR.isValid() && Reg < 0;
874 Reg = TRI->getDwarfRegNum(*SR, false);
875 // FIXME: Get the bit range this register uses of the superregister
876 // so that we can produce a DW_OP_bit_piece
879 // FIXME: Handle cases like a super register being encoded as
880 // DW_OP_reg 32 DW_OP_piece 4 DW_OP_reg 33
882 // FIXME: We have no reasonable way of handling errors in here. The
883 // caller might be in the middle of an dwarf expression. We should
884 // probably assert that Reg >= 0 once debug info generation is more mature.
886 if (MLoc.isIndirect() || Indirect) {
888 OutStreamer.AddComment(
889 dwarf::OperationEncodingString(dwarf::DW_OP_breg0 + Reg));
890 EmitInt8(dwarf::DW_OP_breg0 + Reg);
892 OutStreamer.AddComment("DW_OP_bregx");
893 EmitInt8(dwarf::DW_OP_bregx);
894 OutStreamer.AddComment(Twine(Reg));
897 EmitSLEB128(!MLoc.isIndirect() ? 0 : MLoc.getOffset());
898 if (MLoc.isIndirect() && Indirect)
899 EmitInt8(dwarf::DW_OP_deref);
902 OutStreamer.AddComment(
903 dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
904 EmitInt8(dwarf::DW_OP_reg0 + Reg);
906 OutStreamer.AddComment("DW_OP_regx");
907 EmitInt8(dwarf::DW_OP_regx);
908 OutStreamer.AddComment(Twine(Reg));
913 // FIXME: Produce a DW_OP_bit_piece if we used a superregister
916 bool AsmPrinter::doFinalization(Module &M) {
917 // Emit global variables.
918 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
920 EmitGlobalVariable(I);
922 // Emit visibility info for declarations
923 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
924 const Function &F = *I;
925 if (!F.isDeclaration())
927 GlobalValue::VisibilityTypes V = F.getVisibility();
928 if (V == GlobalValue::DefaultVisibility)
931 MCSymbol *Name = getSymbol(&F);
932 EmitVisibility(Name, V, false);
935 // Emit module flags.
936 SmallVector<Module::ModuleFlagEntry, 8> ModuleFlags;
937 M.getModuleFlagsMetadata(ModuleFlags);
938 if (!ModuleFlags.empty())
939 getObjFileLowering().emitModuleFlags(OutStreamer, ModuleFlags, *Mang, TM);
941 // Make sure we wrote out everything we need.
944 // Finalize debug and EH information.
945 for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
946 const HandlerInfo &OI = Handlers[I];
947 NamedRegionTimer T(OI.TimerName, OI.TimerGroupName,
948 TimePassesIsEnabled);
949 OI.Handler->endModule();
955 // If the target wants to know about weak references, print them all.
956 if (MAI->getWeakRefDirective()) {
957 // FIXME: This is not lazy, it would be nice to only print weak references
958 // to stuff that is actually used. Note that doing so would require targets
959 // to notice uses in operands (due to constant exprs etc). This should
960 // happen with the MC stuff eventually.
962 // Print out module-level global variables here.
963 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
965 if (!I->hasExternalWeakLinkage()) continue;
966 OutStreamer.EmitSymbolAttribute(getSymbol(I), MCSA_WeakReference);
969 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
970 if (!I->hasExternalWeakLinkage()) continue;
971 OutStreamer.EmitSymbolAttribute(getSymbol(I), MCSA_WeakReference);
975 if (MAI->hasSetDirective()) {
976 OutStreamer.AddBlankLine();
977 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
979 MCSymbol *Name = getSymbol(I);
981 const GlobalValue *GV = I->getAliasedGlobal();
982 if (GV->isDeclaration()) {
983 report_fatal_error(Name->getName() +
984 ": Target doesn't support aliases to declarations");
987 MCSymbol *Target = getSymbol(GV);
989 if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
990 OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
991 else if (I->hasWeakLinkage() || I->hasLinkOnceLinkage())
992 OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
994 assert(I->hasLocalLinkage() && "Invalid alias linkage");
996 EmitVisibility(Name, I->getVisibility());
998 // Emit the directives as assignments aka .set:
999 OutStreamer.EmitAssignment(Name,
1000 MCSymbolRefExpr::Create(Target, OutContext));
1004 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
1005 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
1006 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
1007 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
1008 MP->finishAssembly(*this);
1010 // Emit llvm.ident metadata in an '.ident' directive.
1011 EmitModuleIdents(M);
1013 // If we don't have any trampolines, then we don't require stack memory
1014 // to be executable. Some targets have a directive to declare this.
1015 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
1016 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
1017 if (const MCSection *S = MAI->getNonexecutableStackSection(OutContext))
1018 OutStreamer.SwitchSection(S);
1020 // Allow the target to emit any magic that it wants at the end of the file,
1021 // after everything else has gone out.
1022 EmitEndOfAsmFile(M);
1024 delete Mang; Mang = 0;
1027 OutStreamer.Finish();
1028 OutStreamer.reset();
1033 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
1035 // Get the function symbol.
1036 CurrentFnSym = getSymbol(MF.getFunction());
1037 CurrentFnSymForSize = CurrentFnSym;
1040 LI = &getAnalysis<MachineLoopInfo>();
1044 // SectionCPs - Keep track the alignment, constpool entries per Section.
1048 SmallVector<unsigned, 4> CPEs;
1049 SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
1053 /// EmitConstantPool - Print to the current output stream assembly
1054 /// representations of the constants in the constant pool MCP. This is
1055 /// used to print out constants which have been "spilled to memory" by
1056 /// the code generator.
1058 void AsmPrinter::EmitConstantPool() {
1059 const MachineConstantPool *MCP = MF->getConstantPool();
1060 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
1061 if (CP.empty()) return;
1063 // Calculate sections for constant pool entries. We collect entries to go into
1064 // the same section together to reduce amount of section switch statements.
1065 SmallVector<SectionCPs, 4> CPSections;
1066 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
1067 const MachineConstantPoolEntry &CPE = CP[i];
1068 unsigned Align = CPE.getAlignment();
1071 switch (CPE.getRelocationInfo()) {
1072 default: llvm_unreachable("Unknown section kind");
1073 case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
1075 Kind = SectionKind::getReadOnlyWithRelLocal();
1078 switch (TM.getDataLayout()->getTypeAllocSize(CPE.getType())) {
1079 case 4: Kind = SectionKind::getMergeableConst4(); break;
1080 case 8: Kind = SectionKind::getMergeableConst8(); break;
1081 case 16: Kind = SectionKind::getMergeableConst16();break;
1082 default: Kind = SectionKind::getMergeableConst(); break;
1086 const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
1088 // The number of sections are small, just do a linear search from the
1089 // last section to the first.
1091 unsigned SecIdx = CPSections.size();
1092 while (SecIdx != 0) {
1093 if (CPSections[--SecIdx].S == S) {
1099 SecIdx = CPSections.size();
1100 CPSections.push_back(SectionCPs(S, Align));
1103 if (Align > CPSections[SecIdx].Alignment)
1104 CPSections[SecIdx].Alignment = Align;
1105 CPSections[SecIdx].CPEs.push_back(i);
1108 // Now print stuff into the calculated sections.
1109 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
1110 OutStreamer.SwitchSection(CPSections[i].S);
1111 EmitAlignment(Log2_32(CPSections[i].Alignment));
1113 unsigned Offset = 0;
1114 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
1115 unsigned CPI = CPSections[i].CPEs[j];
1116 MachineConstantPoolEntry CPE = CP[CPI];
1118 // Emit inter-object padding for alignment.
1119 unsigned AlignMask = CPE.getAlignment() - 1;
1120 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
1121 OutStreamer.EmitZeros(NewOffset - Offset);
1123 Type *Ty = CPE.getType();
1124 Offset = NewOffset + TM.getDataLayout()->getTypeAllocSize(Ty);
1125 OutStreamer.EmitLabel(GetCPISymbol(CPI));
1127 if (CPE.isMachineConstantPoolEntry())
1128 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
1130 EmitGlobalConstant(CPE.Val.ConstVal);
1135 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
1136 /// by the current function to the current output stream.
1138 void AsmPrinter::EmitJumpTableInfo() {
1139 const DataLayout *DL = MF->getTarget().getDataLayout();
1140 const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
1141 if (MJTI == 0) return;
1142 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline) return;
1143 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1144 if (JT.empty()) return;
1146 // Pick the directive to use to print the jump table entries, and switch to
1147 // the appropriate section.
1148 const Function *F = MF->getFunction();
1149 bool JTInDiffSection = false;
1150 if (// In PIC mode, we need to emit the jump table to the same section as the
1151 // function body itself, otherwise the label differences won't make sense.
1152 // FIXME: Need a better predicate for this: what about custom entries?
1153 MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 ||
1154 // We should also do if the section name is NULL or function is declared
1155 // in discardable section
1156 // FIXME: this isn't the right predicate, should be based on the MCSection
1157 // for the function.
1158 F->isWeakForLinker()) {
1159 OutStreamer.SwitchSection(
1160 getObjFileLowering().SectionForGlobal(F, *Mang, TM));
1162 // Otherwise, drop it in the readonly section.
1163 const MCSection *ReadOnlySection =
1164 getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
1165 OutStreamer.SwitchSection(ReadOnlySection);
1166 JTInDiffSection = true;
1169 EmitAlignment(Log2_32(MJTI->getEntryAlignment(*TM.getDataLayout())));
1171 // Jump tables in code sections are marked with a data_region directive
1172 // where that's supported.
1173 if (!JTInDiffSection)
1174 OutStreamer.EmitDataRegion(MCDR_DataRegionJT32);
1176 for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) {
1177 const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
1179 // If this jump table was deleted, ignore it.
1180 if (JTBBs.empty()) continue;
1182 // For the EK_LabelDifference32 entry, if the target supports .set, emit a
1183 // .set directive for each unique entry. This reduces the number of
1184 // relocations the assembler will generate for the jump table.
1185 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
1186 MAI->hasSetDirective()) {
1187 SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets;
1188 const TargetLowering *TLI = TM.getTargetLowering();
1189 const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF,JTI,OutContext);
1190 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
1191 const MachineBasicBlock *MBB = JTBBs[ii];
1192 if (!EmittedSets.insert(MBB)) continue;
1194 // .set LJTSet, LBB32-base
1196 MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1197 OutStreamer.EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()),
1198 MCBinaryExpr::CreateSub(LHS, Base, OutContext));
1202 // On some targets (e.g. Darwin) we want to emit two consecutive labels
1203 // before each jump table. The first label is never referenced, but tells
1204 // the assembler and linker the extents of the jump table object. The
1205 // second label is actually referenced by the code.
1206 if (JTInDiffSection && DL->hasLinkerPrivateGlobalPrefix())
1207 // FIXME: This doesn't have to have any specific name, just any randomly
1208 // named and numbered 'l' label would work. Simplify GetJTISymbol.
1209 OutStreamer.EmitLabel(GetJTISymbol(JTI, true));
1211 OutStreamer.EmitLabel(GetJTISymbol(JTI));
1213 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
1214 EmitJumpTableEntry(MJTI, JTBBs[ii], JTI);
1216 if (!JTInDiffSection)
1217 OutStreamer.EmitDataRegion(MCDR_DataRegionEnd);
1220 /// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
1222 void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
1223 const MachineBasicBlock *MBB,
1224 unsigned UID) const {
1225 assert(MBB && MBB->getNumber() >= 0 && "Invalid basic block");
1226 const MCExpr *Value = 0;
1227 switch (MJTI->getEntryKind()) {
1228 case MachineJumpTableInfo::EK_Inline:
1229 llvm_unreachable("Cannot emit EK_Inline jump table entry");
1230 case MachineJumpTableInfo::EK_Custom32:
1231 Value = TM.getTargetLowering()->LowerCustomJumpTableEntry(MJTI, MBB, UID,
1234 case MachineJumpTableInfo::EK_BlockAddress:
1235 // EK_BlockAddress - Each entry is a plain address of block, e.g.:
1237 Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1239 case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
1240 // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
1241 // with a relocation as gp-relative, e.g.:
1243 MCSymbol *MBBSym = MBB->getSymbol();
1244 OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1248 case MachineJumpTableInfo::EK_GPRel64BlockAddress: {
1249 // EK_GPRel64BlockAddress - Each entry is an address of block, encoded
1250 // with a relocation as gp-relative, e.g.:
1252 MCSymbol *MBBSym = MBB->getSymbol();
1253 OutStreamer.EmitGPRel64Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1257 case MachineJumpTableInfo::EK_LabelDifference32: {
1258 // EK_LabelDifference32 - Each entry is the address of the block minus
1259 // the address of the jump table. This is used for PIC jump tables where
1260 // gprel32 is not supported. e.g.:
1261 // .word LBB123 - LJTI1_2
1262 // If the .set directive is supported, this is emitted as:
1263 // .set L4_5_set_123, LBB123 - LJTI1_2
1264 // .word L4_5_set_123
1266 // If we have emitted set directives for the jump table entries, print
1267 // them rather than the entries themselves. If we're emitting PIC, then
1268 // emit the table entries as differences between two text section labels.
1269 if (MAI->hasSetDirective()) {
1270 // If we used .set, reference the .set's symbol.
1271 Value = MCSymbolRefExpr::Create(GetJTSetSymbol(UID, MBB->getNumber()),
1275 // Otherwise, use the difference as the jump table entry.
1276 Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1277 const MCExpr *JTI = MCSymbolRefExpr::Create(GetJTISymbol(UID), OutContext);
1278 Value = MCBinaryExpr::CreateSub(Value, JTI, OutContext);
1283 assert(Value && "Unknown entry kind!");
1285 unsigned EntrySize = MJTI->getEntrySize(*TM.getDataLayout());
1286 OutStreamer.EmitValue(Value, EntrySize);
1290 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
1291 /// special global used by LLVM. If so, emit it and return true, otherwise
1292 /// do nothing and return false.
1293 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
1294 if (GV->getName() == "llvm.used") {
1295 if (MAI->hasNoDeadStrip()) // No need to emit this at all.
1296 EmitLLVMUsedList(cast<ConstantArray>(GV->getInitializer()));
1300 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
1301 if (GV->getSection() == "llvm.metadata" ||
1302 GV->hasAvailableExternallyLinkage())
1305 if (!GV->hasAppendingLinkage()) return false;
1307 assert(GV->hasInitializer() && "Not a special LLVM global!");
1309 if (GV->getName() == "llvm.global_ctors") {
1310 EmitXXStructorList(GV->getInitializer(), /* isCtor */ true);
1312 if (TM.getRelocationModel() == Reloc::Static &&
1313 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1314 StringRef Sym(".constructors_used");
1315 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1321 if (GV->getName() == "llvm.global_dtors") {
1322 EmitXXStructorList(GV->getInitializer(), /* isCtor */ false);
1324 if (TM.getRelocationModel() == Reloc::Static &&
1325 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1326 StringRef Sym(".destructors_used");
1327 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1336 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
1337 /// global in the specified llvm.used list for which emitUsedDirectiveFor
1338 /// is true, as being used with this directive.
1339 void AsmPrinter::EmitLLVMUsedList(const ConstantArray *InitList) {
1340 // Should be an array of 'i8*'.
1341 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
1342 const GlobalValue *GV =
1343 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
1344 if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, *Mang))
1345 OutStreamer.EmitSymbolAttribute(getSymbol(GV), MCSA_NoDeadStrip);
1349 /// EmitXXStructorList - Emit the ctor or dtor list taking into account the init
1351 void AsmPrinter::EmitXXStructorList(const Constant *List, bool isCtor) {
1352 // Should be an array of '{ int, void ()* }' structs. The first value is the
1354 if (!isa<ConstantArray>(List)) return;
1356 // Sanity check the structors list.
1357 const ConstantArray *InitList = dyn_cast<ConstantArray>(List);
1358 if (!InitList) return; // Not an array!
1359 StructType *ETy = dyn_cast<StructType>(InitList->getType()->getElementType());
1360 if (!ETy || ETy->getNumElements() != 2) return; // Not an array of pairs!
1361 if (!isa<IntegerType>(ETy->getTypeAtIndex(0U)) ||
1362 !isa<PointerType>(ETy->getTypeAtIndex(1U))) return; // Not (int, ptr).
1364 // Gather the structors in a form that's convenient for sorting by priority.
1365 typedef std::pair<unsigned, Constant *> Structor;
1366 SmallVector<Structor, 8> Structors;
1367 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
1368 ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i));
1369 if (!CS) continue; // Malformed.
1370 if (CS->getOperand(1)->isNullValue())
1371 break; // Found a null terminator, skip the rest.
1372 ConstantInt *Priority = dyn_cast<ConstantInt>(CS->getOperand(0));
1373 if (!Priority) continue; // Malformed.
1374 Structors.push_back(std::make_pair(Priority->getLimitedValue(65535),
1375 CS->getOperand(1)));
1378 // Emit the function pointers in the target-specific order
1379 const DataLayout *DL = TM.getDataLayout();
1380 unsigned Align = Log2_32(DL->getPointerPrefAlignment());
1381 std::stable_sort(Structors.begin(), Structors.end(), less_first());
1382 for (unsigned i = 0, e = Structors.size(); i != e; ++i) {
1383 const MCSection *OutputSection =
1385 getObjFileLowering().getStaticCtorSection(Structors[i].first) :
1386 getObjFileLowering().getStaticDtorSection(Structors[i].first));
1387 OutStreamer.SwitchSection(OutputSection);
1388 if (OutStreamer.getCurrentSection() != OutStreamer.getPreviousSection())
1389 EmitAlignment(Align);
1390 EmitXXStructor(Structors[i].second);
1394 void AsmPrinter::EmitModuleIdents(Module &M) {
1395 if (!MAI->hasIdentDirective())
1398 if (const NamedMDNode *NMD = M.getNamedMetadata("llvm.ident")) {
1399 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1400 const MDNode *N = NMD->getOperand(i);
1401 assert(N->getNumOperands() == 1 &&
1402 "llvm.ident metadata entry can have only one operand");
1403 const MDString *S = cast<MDString>(N->getOperand(0));
1404 OutStreamer.EmitIdent(S->getString());
1409 //===--------------------------------------------------------------------===//
1410 // Emission and print routines
1413 /// EmitInt8 - Emit a byte directive and value.
1415 void AsmPrinter::EmitInt8(int Value) const {
1416 OutStreamer.EmitIntValue(Value, 1);
1419 /// EmitInt16 - Emit a short directive and value.
1421 void AsmPrinter::EmitInt16(int Value) const {
1422 OutStreamer.EmitIntValue(Value, 2);
1425 /// EmitInt32 - Emit a long directive and value.
1427 void AsmPrinter::EmitInt32(int Value) const {
1428 OutStreamer.EmitIntValue(Value, 4);
1431 /// EmitLabelDifference - Emit something like ".long Hi-Lo" where the size
1432 /// in bytes of the directive is specified by Size and Hi/Lo specify the
1433 /// labels. This implicitly uses .set if it is available.
1434 void AsmPrinter::EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
1435 unsigned Size) const {
1436 // Get the Hi-Lo expression.
1437 const MCExpr *Diff =
1438 MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(Hi, OutContext),
1439 MCSymbolRefExpr::Create(Lo, OutContext),
1442 if (!MAI->hasSetDirective()) {
1443 OutStreamer.EmitValue(Diff, Size);
1447 // Otherwise, emit with .set (aka assignment).
1448 MCSymbol *SetLabel = GetTempSymbol("set", SetCounter++);
1449 OutStreamer.EmitAssignment(SetLabel, Diff);
1450 OutStreamer.EmitSymbolValue(SetLabel, Size);
1453 /// EmitLabelOffsetDifference - Emit something like ".long Hi+Offset-Lo"
1454 /// where the size in bytes of the directive is specified by Size and Hi/Lo
1455 /// specify the labels. This implicitly uses .set if it is available.
1456 void AsmPrinter::EmitLabelOffsetDifference(const MCSymbol *Hi, uint64_t Offset,
1458 unsigned Size) const {
1460 // Emit Hi+Offset - Lo
1461 // Get the Hi+Offset expression.
1462 const MCExpr *Plus =
1463 MCBinaryExpr::CreateAdd(MCSymbolRefExpr::Create(Hi, OutContext),
1464 MCConstantExpr::Create(Offset, OutContext),
1467 // Get the Hi+Offset-Lo expression.
1468 const MCExpr *Diff =
1469 MCBinaryExpr::CreateSub(Plus,
1470 MCSymbolRefExpr::Create(Lo, OutContext),
1473 if (!MAI->hasSetDirective())
1474 OutStreamer.EmitValue(Diff, Size);
1476 // Otherwise, emit with .set (aka assignment).
1477 MCSymbol *SetLabel = GetTempSymbol("set", SetCounter++);
1478 OutStreamer.EmitAssignment(SetLabel, Diff);
1479 OutStreamer.EmitSymbolValue(SetLabel, Size);
1483 /// EmitLabelPlusOffset - Emit something like ".long Label+Offset"
1484 /// where the size in bytes of the directive is specified by Size and Label
1485 /// specifies the label. This implicitly uses .set if it is available.
1486 void AsmPrinter::EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
1488 bool IsSectionRelative) const {
1489 if (MAI->needsDwarfSectionOffsetDirective() && IsSectionRelative) {
1490 OutStreamer.EmitCOFFSecRel32(Label);
1494 // Emit Label+Offset (or just Label if Offset is zero)
1495 const MCExpr *Expr = MCSymbolRefExpr::Create(Label, OutContext);
1497 Expr = MCBinaryExpr::CreateAdd(
1498 Expr, MCConstantExpr::Create(Offset, OutContext), OutContext);
1500 OutStreamer.EmitValue(Expr, Size);
1503 //===----------------------------------------------------------------------===//
1505 // EmitAlignment - Emit an alignment directive to the specified power of
1506 // two boundary. For example, if you pass in 3 here, you will get an 8
1507 // byte alignment. If a global value is specified, and if that global has
1508 // an explicit alignment requested, it will override the alignment request
1509 // if required for correctness.
1511 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV) const {
1512 if (GV) NumBits = getGVAlignmentLog2(GV, *TM.getDataLayout(), NumBits);
1514 if (NumBits == 0) return; // 1-byte aligned: no need to emit alignment.
1516 if (getCurrentSection()->getKind().isText())
1517 OutStreamer.EmitCodeAlignment(1 << NumBits);
1519 OutStreamer.EmitValueToAlignment(1 << NumBits);
1522 //===----------------------------------------------------------------------===//
1523 // Constant emission.
1524 //===----------------------------------------------------------------------===//
1526 /// lowerConstant - Lower the specified LLVM Constant to an MCExpr.
1528 static const MCExpr *lowerConstant(const Constant *CV, AsmPrinter &AP) {
1529 MCContext &Ctx = AP.OutContext;
1531 if (CV->isNullValue() || isa<UndefValue>(CV))
1532 return MCConstantExpr::Create(0, Ctx);
1534 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
1535 return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
1537 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
1538 return MCSymbolRefExpr::Create(AP.getSymbol(GV), Ctx);
1540 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
1541 return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
1543 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
1545 llvm_unreachable("Unknown constant value to lower!");
1548 if (const MCExpr *RelocExpr =
1549 AP.getObjFileLowering().getExecutableRelativeSymbol(CE, *AP.Mang))
1552 switch (CE->getOpcode()) {
1554 // If the code isn't optimized, there may be outstanding folding
1555 // opportunities. Attempt to fold the expression using DataLayout as a
1556 // last resort before giving up.
1558 ConstantFoldConstantExpression(CE, AP.TM.getDataLayout()))
1560 return lowerConstant(C, AP);
1562 // Otherwise report the problem to the user.
1565 raw_string_ostream OS(S);
1566 OS << "Unsupported expression in static initializer: ";
1567 CE->printAsOperand(OS, /*PrintType=*/false,
1568 !AP.MF ? 0 : AP.MF->getFunction()->getParent());
1569 report_fatal_error(OS.str());
1571 case Instruction::GetElementPtr: {
1572 const DataLayout &DL = *AP.TM.getDataLayout();
1573 // Generate a symbolic expression for the byte address
1574 APInt OffsetAI(DL.getPointerTypeSizeInBits(CE->getType()), 0);
1575 cast<GEPOperator>(CE)->accumulateConstantOffset(DL, OffsetAI);
1577 const MCExpr *Base = lowerConstant(CE->getOperand(0), AP);
1581 int64_t Offset = OffsetAI.getSExtValue();
1582 return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
1586 case Instruction::Trunc:
1587 // We emit the value and depend on the assembler to truncate the generated
1588 // expression properly. This is important for differences between
1589 // blockaddress labels. Since the two labels are in the same function, it
1590 // is reasonable to treat their delta as a 32-bit value.
1592 case Instruction::BitCast:
1593 return lowerConstant(CE->getOperand(0), AP);
1595 case Instruction::IntToPtr: {
1596 const DataLayout &DL = *AP.TM.getDataLayout();
1597 // Handle casts to pointers by changing them into casts to the appropriate
1598 // integer type. This promotes constant folding and simplifies this code.
1599 Constant *Op = CE->getOperand(0);
1600 Op = ConstantExpr::getIntegerCast(Op, DL.getIntPtrType(CV->getType()),
1602 return lowerConstant(Op, AP);
1605 case Instruction::PtrToInt: {
1606 const DataLayout &DL = *AP.TM.getDataLayout();
1607 // Support only foldable casts to/from pointers that can be eliminated by
1608 // changing the pointer to the appropriately sized integer type.
1609 Constant *Op = CE->getOperand(0);
1610 Type *Ty = CE->getType();
1612 const MCExpr *OpExpr = lowerConstant(Op, AP);
1614 // We can emit the pointer value into this slot if the slot is an
1615 // integer slot equal to the size of the pointer.
1616 if (DL.getTypeAllocSize(Ty) == DL.getTypeAllocSize(Op->getType()))
1619 // Otherwise the pointer is smaller than the resultant integer, mask off
1620 // the high bits so we are sure to get a proper truncation if the input is
1622 unsigned InBits = DL.getTypeAllocSizeInBits(Op->getType());
1623 const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
1624 return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
1627 // The MC library also has a right-shift operator, but it isn't consistently
1628 // signed or unsigned between different targets.
1629 case Instruction::Add:
1630 case Instruction::Sub:
1631 case Instruction::Mul:
1632 case Instruction::SDiv:
1633 case Instruction::SRem:
1634 case Instruction::Shl:
1635 case Instruction::And:
1636 case Instruction::Or:
1637 case Instruction::Xor: {
1638 const MCExpr *LHS = lowerConstant(CE->getOperand(0), AP);
1639 const MCExpr *RHS = lowerConstant(CE->getOperand(1), AP);
1640 switch (CE->getOpcode()) {
1641 default: llvm_unreachable("Unknown binary operator constant cast expr");
1642 case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
1643 case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
1644 case Instruction::Mul: return MCBinaryExpr::CreateMul(LHS, RHS, Ctx);
1645 case Instruction::SDiv: return MCBinaryExpr::CreateDiv(LHS, RHS, Ctx);
1646 case Instruction::SRem: return MCBinaryExpr::CreateMod(LHS, RHS, Ctx);
1647 case Instruction::Shl: return MCBinaryExpr::CreateShl(LHS, RHS, Ctx);
1648 case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
1649 case Instruction::Or: return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
1650 case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
1656 static void emitGlobalConstantImpl(const Constant *C, AsmPrinter &AP);
1658 /// isRepeatedByteSequence - Determine whether the given value is
1659 /// composed of a repeated sequence of identical bytes and return the
1660 /// byte value. If it is not a repeated sequence, return -1.
1661 static int isRepeatedByteSequence(const ConstantDataSequential *V) {
1662 StringRef Data = V->getRawDataValues();
1663 assert(!Data.empty() && "Empty aggregates should be CAZ node");
1665 for (unsigned i = 1, e = Data.size(); i != e; ++i)
1666 if (Data[i] != C) return -1;
1667 return static_cast<uint8_t>(C); // Ensure 255 is not returned as -1.
1671 /// isRepeatedByteSequence - Determine whether the given value is
1672 /// composed of a repeated sequence of identical bytes and return the
1673 /// byte value. If it is not a repeated sequence, return -1.
1674 static int isRepeatedByteSequence(const Value *V, TargetMachine &TM) {
1676 if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
1677 if (CI->getBitWidth() > 64) return -1;
1679 uint64_t Size = TM.getDataLayout()->getTypeAllocSize(V->getType());
1680 uint64_t Value = CI->getZExtValue();
1682 // Make sure the constant is at least 8 bits long and has a power
1683 // of 2 bit width. This guarantees the constant bit width is
1684 // always a multiple of 8 bits, avoiding issues with padding out
1685 // to Size and other such corner cases.
1686 if (CI->getBitWidth() < 8 || !isPowerOf2_64(CI->getBitWidth())) return -1;
1688 uint8_t Byte = static_cast<uint8_t>(Value);
1690 for (unsigned i = 1; i < Size; ++i) {
1692 if (static_cast<uint8_t>(Value) != Byte) return -1;
1696 if (const ConstantArray *CA = dyn_cast<ConstantArray>(V)) {
1697 // Make sure all array elements are sequences of the same repeated
1699 assert(CA->getNumOperands() != 0 && "Should be a CAZ");
1700 int Byte = isRepeatedByteSequence(CA->getOperand(0), TM);
1701 if (Byte == -1) return -1;
1703 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1704 int ThisByte = isRepeatedByteSequence(CA->getOperand(i), TM);
1705 if (ThisByte == -1) return -1;
1706 if (Byte != ThisByte) return -1;
1711 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V))
1712 return isRepeatedByteSequence(CDS);
1717 static void emitGlobalConstantDataSequential(const ConstantDataSequential *CDS,
1720 // See if we can aggregate this into a .fill, if so, emit it as such.
1721 int Value = isRepeatedByteSequence(CDS, AP.TM);
1723 uint64_t Bytes = AP.TM.getDataLayout()->getTypeAllocSize(CDS->getType());
1724 // Don't emit a 1-byte object as a .fill.
1726 return AP.OutStreamer.EmitFill(Bytes, Value);
1729 // If this can be emitted with .ascii/.asciz, emit it as such.
1730 if (CDS->isString())
1731 return AP.OutStreamer.EmitBytes(CDS->getAsString());
1733 // Otherwise, emit the values in successive locations.
1734 unsigned ElementByteSize = CDS->getElementByteSize();
1735 if (isa<IntegerType>(CDS->getElementType())) {
1736 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1738 AP.OutStreamer.GetCommentOS() << format("0x%" PRIx64 "\n",
1739 CDS->getElementAsInteger(i));
1740 AP.OutStreamer.EmitIntValue(CDS->getElementAsInteger(i),
1743 } else if (ElementByteSize == 4) {
1744 // FP Constants are printed as integer constants to avoid losing
1746 assert(CDS->getElementType()->isFloatTy());
1747 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1753 F = CDS->getElementAsFloat(i);
1755 AP.OutStreamer.GetCommentOS() << "float " << F << '\n';
1756 AP.OutStreamer.EmitIntValue(I, 4);
1759 assert(CDS->getElementType()->isDoubleTy());
1760 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1766 F = CDS->getElementAsDouble(i);
1768 AP.OutStreamer.GetCommentOS() << "double " << F << '\n';
1769 AP.OutStreamer.EmitIntValue(I, 8);
1773 const DataLayout &DL = *AP.TM.getDataLayout();
1774 unsigned Size = DL.getTypeAllocSize(CDS->getType());
1775 unsigned EmittedSize = DL.getTypeAllocSize(CDS->getType()->getElementType()) *
1776 CDS->getNumElements();
1777 if (unsigned Padding = Size - EmittedSize)
1778 AP.OutStreamer.EmitZeros(Padding);
1782 static void emitGlobalConstantArray(const ConstantArray *CA, AsmPrinter &AP) {
1783 // See if we can aggregate some values. Make sure it can be
1784 // represented as a series of bytes of the constant value.
1785 int Value = isRepeatedByteSequence(CA, AP.TM);
1788 uint64_t Bytes = AP.TM.getDataLayout()->getTypeAllocSize(CA->getType());
1789 AP.OutStreamer.EmitFill(Bytes, Value);
1792 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1793 emitGlobalConstantImpl(CA->getOperand(i), AP);
1797 static void emitGlobalConstantVector(const ConstantVector *CV, AsmPrinter &AP) {
1798 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
1799 emitGlobalConstantImpl(CV->getOperand(i), AP);
1801 const DataLayout &DL = *AP.TM.getDataLayout();
1802 unsigned Size = DL.getTypeAllocSize(CV->getType());
1803 unsigned EmittedSize = DL.getTypeAllocSize(CV->getType()->getElementType()) *
1804 CV->getType()->getNumElements();
1805 if (unsigned Padding = Size - EmittedSize)
1806 AP.OutStreamer.EmitZeros(Padding);
1809 static void emitGlobalConstantStruct(const ConstantStruct *CS, AsmPrinter &AP) {
1810 // Print the fields in successive locations. Pad to align if needed!
1811 const DataLayout *DL = AP.TM.getDataLayout();
1812 unsigned Size = DL->getTypeAllocSize(CS->getType());
1813 const StructLayout *Layout = DL->getStructLayout(CS->getType());
1814 uint64_t SizeSoFar = 0;
1815 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
1816 const Constant *Field = CS->getOperand(i);
1818 // Check if padding is needed and insert one or more 0s.
1819 uint64_t FieldSize = DL->getTypeAllocSize(Field->getType());
1820 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
1821 - Layout->getElementOffset(i)) - FieldSize;
1822 SizeSoFar += FieldSize + PadSize;
1824 // Now print the actual field value.
1825 emitGlobalConstantImpl(Field, AP);
1827 // Insert padding - this may include padding to increase the size of the
1828 // current field up to the ABI size (if the struct is not packed) as well
1829 // as padding to ensure that the next field starts at the right offset.
1830 AP.OutStreamer.EmitZeros(PadSize);
1832 assert(SizeSoFar == Layout->getSizeInBytes() &&
1833 "Layout of constant struct may be incorrect!");
1836 static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP) {
1837 APInt API = CFP->getValueAPF().bitcastToAPInt();
1839 // First print a comment with what we think the original floating-point value
1840 // should have been.
1841 if (AP.isVerbose()) {
1842 SmallString<8> StrVal;
1843 CFP->getValueAPF().toString(StrVal);
1845 CFP->getType()->print(AP.OutStreamer.GetCommentOS());
1846 AP.OutStreamer.GetCommentOS() << ' ' << StrVal << '\n';
1849 // Now iterate through the APInt chunks, emitting them in endian-correct
1850 // order, possibly with a smaller chunk at beginning/end (e.g. for x87 80-bit
1852 unsigned NumBytes = API.getBitWidth() / 8;
1853 unsigned TrailingBytes = NumBytes % sizeof(uint64_t);
1854 const uint64_t *p = API.getRawData();
1856 // PPC's long double has odd notions of endianness compared to how LLVM
1857 // handles it: p[0] goes first for *big* endian on PPC.
1858 if (AP.TM.getDataLayout()->isBigEndian() != CFP->getType()->isPPC_FP128Ty()) {
1859 int Chunk = API.getNumWords() - 1;
1862 AP.OutStreamer.EmitIntValue(p[Chunk--], TrailingBytes);
1864 for (; Chunk >= 0; --Chunk)
1865 AP.OutStreamer.EmitIntValue(p[Chunk], sizeof(uint64_t));
1868 for (Chunk = 0; Chunk < NumBytes / sizeof(uint64_t); ++Chunk)
1869 AP.OutStreamer.EmitIntValue(p[Chunk], sizeof(uint64_t));
1872 AP.OutStreamer.EmitIntValue(p[Chunk], TrailingBytes);
1875 // Emit the tail padding for the long double.
1876 const DataLayout &DL = *AP.TM.getDataLayout();
1877 AP.OutStreamer.EmitZeros(DL.getTypeAllocSize(CFP->getType()) -
1878 DL.getTypeStoreSize(CFP->getType()));
1881 static void emitGlobalConstantLargeInt(const ConstantInt *CI, AsmPrinter &AP) {
1882 const DataLayout *DL = AP.TM.getDataLayout();
1883 unsigned BitWidth = CI->getBitWidth();
1885 // Copy the value as we may massage the layout for constants whose bit width
1886 // is not a multiple of 64-bits.
1887 APInt Realigned(CI->getValue());
1888 uint64_t ExtraBits = 0;
1889 unsigned ExtraBitsSize = BitWidth & 63;
1891 if (ExtraBitsSize) {
1892 // The bit width of the data is not a multiple of 64-bits.
1893 // The extra bits are expected to be at the end of the chunk of the memory.
1895 // * Nothing to be done, just record the extra bits to emit.
1897 // * Record the extra bits to emit.
1898 // * Realign the raw data to emit the chunks of 64-bits.
1899 if (DL->isBigEndian()) {
1900 // Basically the structure of the raw data is a chunk of 64-bits cells:
1901 // 0 1 BitWidth / 64
1902 // [chunk1][chunk2] ... [chunkN].
1903 // The most significant chunk is chunkN and it should be emitted first.
1904 // However, due to the alignment issue chunkN contains useless bits.
1905 // Realign the chunks so that they contain only useless information:
1906 // ExtraBits 0 1 (BitWidth / 64) - 1
1907 // chu[nk1 chu][nk2 chu] ... [nkN-1 chunkN]
1908 ExtraBits = Realigned.getRawData()[0] &
1909 (((uint64_t)-1) >> (64 - ExtraBitsSize));
1910 Realigned = Realigned.lshr(ExtraBitsSize);
1912 ExtraBits = Realigned.getRawData()[BitWidth / 64];
1915 // We don't expect assemblers to support integer data directives
1916 // for more than 64 bits, so we emit the data in at most 64-bit
1917 // quantities at a time.
1918 const uint64_t *RawData = Realigned.getRawData();
1919 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1920 uint64_t Val = DL->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1921 AP.OutStreamer.EmitIntValue(Val, 8);
1924 if (ExtraBitsSize) {
1925 // Emit the extra bits after the 64-bits chunks.
1927 // Emit a directive that fills the expected size.
1928 uint64_t Size = AP.TM.getDataLayout()->getTypeAllocSize(CI->getType());
1929 Size -= (BitWidth / 64) * 8;
1930 assert(Size && Size * 8 >= ExtraBitsSize &&
1931 (ExtraBits & (((uint64_t)-1) >> (64 - ExtraBitsSize)))
1932 == ExtraBits && "Directive too small for extra bits.");
1933 AP.OutStreamer.EmitIntValue(ExtraBits, Size);
1937 static void emitGlobalConstantImpl(const Constant *CV, AsmPrinter &AP) {
1938 const DataLayout *DL = AP.TM.getDataLayout();
1939 uint64_t Size = DL->getTypeAllocSize(CV->getType());
1940 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV))
1941 return AP.OutStreamer.EmitZeros(Size);
1943 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1950 AP.OutStreamer.GetCommentOS() << format("0x%" PRIx64 "\n",
1951 CI->getZExtValue());
1952 AP.OutStreamer.EmitIntValue(CI->getZExtValue(), Size);
1955 emitGlobalConstantLargeInt(CI, AP);
1960 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1961 return emitGlobalConstantFP(CFP, AP);
1963 if (isa<ConstantPointerNull>(CV)) {
1964 AP.OutStreamer.EmitIntValue(0, Size);
1968 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(CV))
1969 return emitGlobalConstantDataSequential(CDS, AP);
1971 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1972 return emitGlobalConstantArray(CVA, AP);
1974 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1975 return emitGlobalConstantStruct(CVS, AP);
1977 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1978 // Look through bitcasts, which might not be able to be MCExpr'ized (e.g. of
1980 if (CE->getOpcode() == Instruction::BitCast)
1981 return emitGlobalConstantImpl(CE->getOperand(0), AP);
1984 // If the constant expression's size is greater than 64-bits, then we have
1985 // to emit the value in chunks. Try to constant fold the value and emit it
1987 Constant *New = ConstantFoldConstantExpression(CE, DL);
1988 if (New && New != CE)
1989 return emitGlobalConstantImpl(New, AP);
1993 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1994 return emitGlobalConstantVector(V, AP);
1996 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it
1997 // thread the streamer with EmitValue.
1998 AP.OutStreamer.EmitValue(lowerConstant(CV, AP), Size);
2001 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
2002 void AsmPrinter::EmitGlobalConstant(const Constant *CV) {
2003 uint64_t Size = TM.getDataLayout()->getTypeAllocSize(CV->getType());
2005 emitGlobalConstantImpl(CV, *this);
2006 else if (MAI->hasSubsectionsViaSymbols()) {
2007 // If the global has zero size, emit a single byte so that two labels don't
2008 // look like they are at the same location.
2009 OutStreamer.EmitIntValue(0, 1);
2013 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
2014 // Target doesn't support this yet!
2015 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
2018 void AsmPrinter::printOffset(int64_t Offset, raw_ostream &OS) const {
2020 OS << '+' << Offset;
2021 else if (Offset < 0)
2025 //===----------------------------------------------------------------------===//
2026 // Symbol Lowering Routines.
2027 //===----------------------------------------------------------------------===//
2029 /// GetTempSymbol - Return the MCSymbol corresponding to the assembler
2030 /// temporary label with the specified stem and unique ID.
2031 MCSymbol *AsmPrinter::GetTempSymbol(StringRef Name, unsigned ID) const {
2032 const DataLayout *DL = TM.getDataLayout();
2033 return OutContext.GetOrCreateSymbol(Twine(DL->getPrivateGlobalPrefix()) +
2037 /// GetTempSymbol - Return an assembler temporary label with the specified
2039 MCSymbol *AsmPrinter::GetTempSymbol(StringRef Name) const {
2040 const DataLayout *DL = TM.getDataLayout();
2041 return OutContext.GetOrCreateSymbol(Twine(DL->getPrivateGlobalPrefix())+
2046 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const {
2047 return MMI->getAddrLabelSymbol(BA->getBasicBlock());
2050 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BasicBlock *BB) const {
2051 return MMI->getAddrLabelSymbol(BB);
2054 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
2055 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
2056 const DataLayout *DL = TM.getDataLayout();
2057 return OutContext.GetOrCreateSymbol
2058 (Twine(DL->getPrivateGlobalPrefix()) + "CPI" + Twine(getFunctionNumber())
2059 + "_" + Twine(CPID));
2062 /// GetJTISymbol - Return the symbol for the specified jump table entry.
2063 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
2064 return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
2067 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
2068 /// FIXME: privatize to AsmPrinter.
2069 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
2070 const DataLayout *DL = TM.getDataLayout();
2071 return OutContext.GetOrCreateSymbol
2072 (Twine(DL->getPrivateGlobalPrefix()) + Twine(getFunctionNumber()) + "_" +
2073 Twine(UID) + "_set_" + Twine(MBBID));
2076 MCSymbol *AsmPrinter::getSymbolWithGlobalValueBase(const GlobalValue *GV,
2077 StringRef Suffix) const {
2078 return getObjFileLowering().getSymbolWithGlobalValueBase(GV, Suffix, *Mang);
2081 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
2083 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
2084 SmallString<60> NameStr;
2085 Mang->getNameWithPrefix(NameStr, Sym);
2086 return OutContext.GetOrCreateSymbol(NameStr.str());
2091 /// PrintParentLoopComment - Print comments about parent loops of this one.
2092 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2093 unsigned FunctionNumber) {
2094 if (Loop == 0) return;
2095 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
2096 OS.indent(Loop->getLoopDepth()*2)
2097 << "Parent Loop BB" << FunctionNumber << "_"
2098 << Loop->getHeader()->getNumber()
2099 << " Depth=" << Loop->getLoopDepth() << '\n';
2103 /// PrintChildLoopComment - Print comments about child loops within
2104 /// the loop for this basic block, with nesting.
2105 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2106 unsigned FunctionNumber) {
2107 // Add child loop information
2108 for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
2109 OS.indent((*CL)->getLoopDepth()*2)
2110 << "Child Loop BB" << FunctionNumber << "_"
2111 << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
2113 PrintChildLoopComment(OS, *CL, FunctionNumber);
2117 /// emitBasicBlockLoopComments - Pretty-print comments for basic blocks.
2118 static void emitBasicBlockLoopComments(const MachineBasicBlock &MBB,
2119 const MachineLoopInfo *LI,
2120 const AsmPrinter &AP) {
2121 // Add loop depth information
2122 const MachineLoop *Loop = LI->getLoopFor(&MBB);
2123 if (Loop == 0) return;
2125 MachineBasicBlock *Header = Loop->getHeader();
2126 assert(Header && "No header for loop");
2128 // If this block is not a loop header, just print out what is the loop header
2130 if (Header != &MBB) {
2131 AP.OutStreamer.AddComment(" in Loop: Header=BB" +
2132 Twine(AP.getFunctionNumber())+"_" +
2133 Twine(Loop->getHeader()->getNumber())+
2134 " Depth="+Twine(Loop->getLoopDepth()));
2138 // Otherwise, it is a loop header. Print out information about child and
2140 raw_ostream &OS = AP.OutStreamer.GetCommentOS();
2142 PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
2145 OS.indent(Loop->getLoopDepth()*2-2);
2150 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
2152 PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
2156 /// EmitBasicBlockStart - This method prints the label for the specified
2157 /// MachineBasicBlock, an alignment (if present) and a comment describing
2158 /// it if appropriate.
2159 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
2160 // Emit an alignment directive for this block, if needed.
2161 if (unsigned Align = MBB->getAlignment())
2162 EmitAlignment(Align);
2164 // If the block has its address taken, emit any labels that were used to
2165 // reference the block. It is possible that there is more than one label
2166 // here, because multiple LLVM BB's may have been RAUW'd to this block after
2167 // the references were generated.
2168 if (MBB->hasAddressTaken()) {
2169 const BasicBlock *BB = MBB->getBasicBlock();
2171 OutStreamer.AddComment("Block address taken");
2173 std::vector<MCSymbol*> Syms = MMI->getAddrLabelSymbolToEmit(BB);
2175 for (unsigned i = 0, e = Syms.size(); i != e; ++i)
2176 OutStreamer.EmitLabel(Syms[i]);
2179 // Print some verbose block comments.
2181 if (const BasicBlock *BB = MBB->getBasicBlock())
2183 OutStreamer.AddComment("%" + BB->getName());
2184 emitBasicBlockLoopComments(*MBB, LI, *this);
2187 // Print the main label for the block.
2188 if (MBB->pred_empty() || isBlockOnlyReachableByFallthrough(MBB)) {
2190 // NOTE: Want this comment at start of line, don't emit with AddComment.
2191 OutStreamer.emitRawComment(" BB#" + Twine(MBB->getNumber()) + ":", false);
2194 OutStreamer.EmitLabel(MBB->getSymbol());
2198 void AsmPrinter::EmitVisibility(MCSymbol *Sym, unsigned Visibility,
2199 bool IsDefinition) const {
2200 MCSymbolAttr Attr = MCSA_Invalid;
2202 switch (Visibility) {
2204 case GlobalValue::HiddenVisibility:
2206 Attr = MAI->getHiddenVisibilityAttr();
2208 Attr = MAI->getHiddenDeclarationVisibilityAttr();
2210 case GlobalValue::ProtectedVisibility:
2211 Attr = MAI->getProtectedVisibilityAttr();
2215 if (Attr != MCSA_Invalid)
2216 OutStreamer.EmitSymbolAttribute(Sym, Attr);
2219 /// isBlockOnlyReachableByFallthough - Return true if the basic block has
2220 /// exactly one predecessor and the control transfer mechanism between
2221 /// the predecessor and this block is a fall-through.
2223 isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const {
2224 // If this is a landing pad, it isn't a fall through. If it has no preds,
2225 // then nothing falls through to it.
2226 if (MBB->isLandingPad() || MBB->pred_empty())
2229 // If there isn't exactly one predecessor, it can't be a fall through.
2230 MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(), PI2 = PI;
2232 if (PI2 != MBB->pred_end())
2235 // The predecessor has to be immediately before this block.
2236 MachineBasicBlock *Pred = *PI;
2238 if (!Pred->isLayoutSuccessor(MBB))
2241 // If the block is completely empty, then it definitely does fall through.
2245 // Check the terminators in the previous blocks
2246 for (MachineBasicBlock::iterator II = Pred->getFirstTerminator(),
2247 IE = Pred->end(); II != IE; ++II) {
2248 MachineInstr &MI = *II;
2250 // If it is not a simple branch, we are in a table somewhere.
2251 if (!MI.isBranch() || MI.isIndirectBranch())
2254 // If we are the operands of one of the branches, this is not a fall
2255 // through. Note that targets with delay slots will usually bundle
2256 // terminators with the delay slot instruction.
2257 for (ConstMIBundleOperands OP(&MI); OP.isValid(); ++OP) {
2260 if (OP->isMBB() && OP->getMBB() == MBB)
2270 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
2271 if (!S->usesMetadata())
2274 gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
2275 gcp_map_type::iterator GCPI = GCMap.find(S);
2276 if (GCPI != GCMap.end())
2277 return GCPI->second;
2279 const char *Name = S->getName().c_str();
2281 for (GCMetadataPrinterRegistry::iterator
2282 I = GCMetadataPrinterRegistry::begin(),
2283 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
2284 if (strcmp(Name, I->getName()) == 0) {
2285 GCMetadataPrinter *GMP = I->instantiate();
2287 GCMap.insert(std::make_pair(S, GMP));
2291 report_fatal_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
2294 /// Pin vtable to this file.
2295 AsmPrinterHandler::~AsmPrinterHandler() {}