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 "WinCodeViewLineTables.h"
19 #include "llvm/ADT/SmallString.h"
20 #include "llvm/ADT/Statistic.h"
21 #include "llvm/Analysis/ConstantFolding.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/MachineInstrBundle.h"
27 #include "llvm/CodeGen/MachineJumpTableInfo.h"
28 #include "llvm/CodeGen/MachineLoopInfo.h"
29 #include "llvm/CodeGen/MachineModuleInfo.h"
30 #include "llvm/IR/DataLayout.h"
31 #include "llvm/IR/DebugInfo.h"
32 #include "llvm/IR/Mangler.h"
33 #include "llvm/IR/Module.h"
34 #include "llvm/IR/Operator.h"
35 #include "llvm/MC/MCAsmInfo.h"
36 #include "llvm/MC/MCContext.h"
37 #include "llvm/MC/MCExpr.h"
38 #include "llvm/MC/MCInst.h"
39 #include "llvm/MC/MCSection.h"
40 #include "llvm/MC/MCStreamer.h"
41 #include "llvm/MC/MCSymbol.h"
42 #include "llvm/Support/ErrorHandling.h"
43 #include "llvm/Support/Format.h"
44 #include "llvm/Support/MathExtras.h"
45 #include "llvm/Support/Timer.h"
46 #include "llvm/Target/TargetFrameLowering.h"
47 #include "llvm/Target/TargetInstrInfo.h"
48 #include "llvm/Target/TargetLowering.h"
49 #include "llvm/Target/TargetLoweringObjectFile.h"
50 #include "llvm/Target/TargetOptions.h"
51 #include "llvm/Target/TargetRegisterInfo.h"
52 #include "llvm/Target/TargetSubtargetInfo.h"
53 #include "llvm/Transforms/Utils/GlobalStatus.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();
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 void AsmPrinter::getNameWithPrefix(SmallVectorImpl<char> &Name,
315 const GlobalValue *GV) const {
316 TM.getNameWithPrefix(Name, GV, *Mang);
319 MCSymbol *AsmPrinter::getSymbol(const GlobalValue *GV) const {
320 return TM.getSymbol(GV, *Mang);
323 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
324 void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
325 if (GV->hasInitializer()) {
326 // Check to see if this is a special global used by LLVM, if so, emit it.
327 if (EmitSpecialLLVMGlobal(GV))
331 GV->printAsOperand(OutStreamer.GetCommentOS(),
332 /*PrintType=*/false, GV->getParent());
333 OutStreamer.GetCommentOS() << '\n';
337 MCSymbol *GVSym = getSymbol(GV);
338 EmitVisibility(GVSym, GV->getVisibility(), !GV->isDeclaration());
340 if (!GV->hasInitializer()) // External globals require no extra code.
343 if (MAI->hasDotTypeDotSizeDirective())
344 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_ELF_TypeObject);
346 SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
348 const DataLayout *DL = TM.getDataLayout();
349 uint64_t Size = DL->getTypeAllocSize(GV->getType()->getElementType());
351 // If the alignment is specified, we *must* obey it. Overaligning a global
352 // with a specified alignment is a prompt way to break globals emitted to
353 // sections and expected to be contiguous (e.g. ObjC metadata).
354 unsigned AlignLog = getGVAlignmentLog2(GV, *DL);
356 for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
357 const HandlerInfo &OI = Handlers[I];
358 NamedRegionTimer T(OI.TimerName, OI.TimerGroupName, TimePassesIsEnabled);
359 OI.Handler->setSymbolSize(GVSym, Size);
362 // Handle common and BSS local symbols (.lcomm).
363 if (GVKind.isCommon() || GVKind.isBSSLocal()) {
364 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
365 unsigned Align = 1 << AlignLog;
367 // Handle common symbols.
368 if (GVKind.isCommon()) {
369 if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
373 OutStreamer.EmitCommonSymbol(GVSym, Size, Align);
377 // Handle local BSS symbols.
378 if (MAI->hasMachoZeroFillDirective()) {
379 const MCSection *TheSection =
380 getObjFileLowering().SectionForGlobal(GV, GVKind, *Mang, TM);
381 // .zerofill __DATA, __bss, _foo, 400, 5
382 OutStreamer.EmitZerofill(TheSection, GVSym, Size, Align);
386 // Use .lcomm only if it supports user-specified alignment.
387 // Otherwise, while it would still be correct to use .lcomm in some
388 // cases (e.g. when Align == 1), the external assembler might enfore
389 // some -unknown- default alignment behavior, which could cause
390 // spurious differences between external and integrated assembler.
391 // Prefer to simply fall back to .local / .comm in this case.
392 if (MAI->getLCOMMDirectiveAlignmentType() != LCOMM::NoAlignment) {
394 OutStreamer.EmitLocalCommonSymbol(GVSym, Size, Align);
398 if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
402 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Local);
404 OutStreamer.EmitCommonSymbol(GVSym, Size, Align);
408 const MCSection *TheSection =
409 getObjFileLowering().SectionForGlobal(GV, GVKind, *Mang, TM);
411 // Handle the zerofill directive on darwin, which is a special form of BSS
413 if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
414 if (Size == 0) Size = 1; // zerofill of 0 bytes is undefined.
417 OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
418 // .zerofill __DATA, __common, _foo, 400, 5
419 OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
423 // Handle thread local data for mach-o which requires us to output an
424 // additional structure of data and mangle the original symbol so that we
425 // can reference it later.
427 // TODO: This should become an "emit thread local global" method on TLOF.
428 // All of this macho specific stuff should be sunk down into TLOFMachO and
429 // stuff like "TLSExtraDataSection" should no longer be part of the parent
430 // TLOF class. This will also make it more obvious that stuff like
431 // MCStreamer::EmitTBSSSymbol is macho specific and only called from macho
433 if (GVKind.isThreadLocal() && MAI->hasMachoTBSSDirective()) {
434 // Emit the .tbss symbol
436 OutContext.GetOrCreateSymbol(GVSym->getName() + Twine("$tlv$init"));
438 if (GVKind.isThreadBSS()) {
439 TheSection = getObjFileLowering().getTLSBSSSection();
440 OutStreamer.EmitTBSSSymbol(TheSection, MangSym, Size, 1 << AlignLog);
441 } else if (GVKind.isThreadData()) {
442 OutStreamer.SwitchSection(TheSection);
444 EmitAlignment(AlignLog, GV);
445 OutStreamer.EmitLabel(MangSym);
447 EmitGlobalConstant(GV->getInitializer());
450 OutStreamer.AddBlankLine();
452 // Emit the variable struct for the runtime.
453 const MCSection *TLVSect
454 = getObjFileLowering().getTLSExtraDataSection();
456 OutStreamer.SwitchSection(TLVSect);
457 // Emit the linkage here.
458 EmitLinkage(GV, GVSym);
459 OutStreamer.EmitLabel(GVSym);
461 // Three pointers in size:
462 // - __tlv_bootstrap - used to make sure support exists
463 // - spare pointer, used when mapped by the runtime
464 // - pointer to mangled symbol above with initializer
465 unsigned PtrSize = DL->getPointerTypeSize(GV->getType());
466 OutStreamer.EmitSymbolValue(GetExternalSymbolSymbol("_tlv_bootstrap"),
468 OutStreamer.EmitIntValue(0, PtrSize);
469 OutStreamer.EmitSymbolValue(MangSym, PtrSize);
471 OutStreamer.AddBlankLine();
475 OutStreamer.SwitchSection(TheSection);
477 EmitLinkage(GV, GVSym);
478 EmitAlignment(AlignLog, GV);
480 OutStreamer.EmitLabel(GVSym);
482 EmitGlobalConstant(GV->getInitializer());
484 if (MAI->hasDotTypeDotSizeDirective())
486 OutStreamer.EmitELFSize(GVSym, MCConstantExpr::Create(Size, OutContext));
488 OutStreamer.AddBlankLine();
491 /// EmitFunctionHeader - This method emits the header for the current
493 void AsmPrinter::EmitFunctionHeader() {
494 // Print out constants referenced by the function
497 // Print the 'header' of function.
498 const Function *F = MF->getFunction();
500 OutStreamer.SwitchSection(
501 getObjFileLowering().SectionForGlobal(F, *Mang, TM));
502 EmitVisibility(CurrentFnSym, F->getVisibility());
504 EmitLinkage(F, CurrentFnSym);
505 EmitAlignment(MF->getAlignment(), F);
507 if (MAI->hasDotTypeDotSizeDirective())
508 OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCSA_ELF_TypeFunction);
511 F->printAsOperand(OutStreamer.GetCommentOS(),
512 /*PrintType=*/false, F->getParent());
513 OutStreamer.GetCommentOS() << '\n';
516 // Emit the CurrentFnSym. This is a virtual function to allow targets to
517 // do their wild and crazy things as required.
518 EmitFunctionEntryLabel();
520 // If the function had address-taken blocks that got deleted, then we have
521 // references to the dangling symbols. Emit them at the start of the function
522 // so that we don't get references to undefined symbols.
523 std::vector<MCSymbol*> DeadBlockSyms;
524 MMI->takeDeletedSymbolsForFunction(F, DeadBlockSyms);
525 for (unsigned i = 0, e = DeadBlockSyms.size(); i != e; ++i) {
526 OutStreamer.AddComment("Address taken block that was later removed");
527 OutStreamer.EmitLabel(DeadBlockSyms[i]);
530 // Emit pre-function debug and/or EH information.
531 for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
532 const HandlerInfo &OI = Handlers[I];
533 NamedRegionTimer T(OI.TimerName, OI.TimerGroupName, TimePassesIsEnabled);
534 OI.Handler->beginFunction(MF);
537 // Emit the prefix data.
538 if (F->hasPrefixData())
539 EmitGlobalConstant(F->getPrefixData());
542 /// EmitFunctionEntryLabel - Emit the label that is the entrypoint for the
543 /// function. This can be overridden by targets as required to do custom stuff.
544 void AsmPrinter::EmitFunctionEntryLabel() {
545 // The function label could have already been emitted if two symbols end up
546 // conflicting due to asm renaming. Detect this and emit an error.
547 if (CurrentFnSym->isUndefined())
548 return OutStreamer.EmitLabel(CurrentFnSym);
550 report_fatal_error("'" + Twine(CurrentFnSym->getName()) +
551 "' label emitted multiple times to assembly file");
554 /// emitComments - Pretty-print comments for instructions.
555 static void emitComments(const MachineInstr &MI, raw_ostream &CommentOS) {
556 const MachineFunction *MF = MI.getParent()->getParent();
557 const TargetMachine &TM = MF->getTarget();
559 // Check for spills and reloads
562 const MachineFrameInfo *FrameInfo = MF->getFrameInfo();
564 // We assume a single instruction only has a spill or reload, not
566 const MachineMemOperand *MMO;
567 if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
568 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
569 MMO = *MI.memoperands_begin();
570 CommentOS << MMO->getSize() << "-byte Reload\n";
572 } else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
573 if (FrameInfo->isSpillSlotObjectIndex(FI))
574 CommentOS << MMO->getSize() << "-byte Folded Reload\n";
575 } else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
576 if (FrameInfo->isSpillSlotObjectIndex(FI)) {
577 MMO = *MI.memoperands_begin();
578 CommentOS << MMO->getSize() << "-byte Spill\n";
580 } else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
581 if (FrameInfo->isSpillSlotObjectIndex(FI))
582 CommentOS << MMO->getSize() << "-byte Folded Spill\n";
585 // Check for spill-induced copies
586 if (MI.getAsmPrinterFlag(MachineInstr::ReloadReuse))
587 CommentOS << " Reload Reuse\n";
590 /// emitImplicitDef - This method emits the specified machine instruction
591 /// that is an implicit def.
592 void AsmPrinter::emitImplicitDef(const MachineInstr *MI) const {
593 unsigned RegNo = MI->getOperand(0).getReg();
594 OutStreamer.AddComment(Twine("implicit-def: ") +
595 TM.getRegisterInfo()->getName(RegNo));
596 OutStreamer.AddBlankLine();
599 static void emitKill(const MachineInstr *MI, AsmPrinter &AP) {
600 std::string Str = "kill:";
601 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
602 const MachineOperand &Op = MI->getOperand(i);
603 assert(Op.isReg() && "KILL instruction must have only register operands");
605 Str += AP.TM.getRegisterInfo()->getName(Op.getReg());
606 Str += (Op.isDef() ? "<def>" : "<kill>");
608 AP.OutStreamer.AddComment(Str);
609 AP.OutStreamer.AddBlankLine();
612 /// emitDebugValueComment - This method handles the target-independent form
613 /// of DBG_VALUE, returning true if it was able to do so. A false return
614 /// means the target will need to handle MI in EmitInstruction.
615 static bool emitDebugValueComment(const MachineInstr *MI, AsmPrinter &AP) {
616 // This code handles only the 3-operand target-independent form.
617 if (MI->getNumOperands() != 3)
620 SmallString<128> Str;
621 raw_svector_ostream OS(Str);
622 OS << "DEBUG_VALUE: ";
624 DIVariable V(MI->getOperand(2).getMetadata());
625 if (V.getContext().isSubprogram()) {
626 StringRef Name = DISubprogram(V.getContext()).getDisplayName();
630 OS << V.getName() << " <- ";
632 // The second operand is only an offset if it's an immediate.
633 bool Deref = MI->getOperand(0).isReg() && MI->getOperand(1).isImm();
634 int64_t Offset = Deref ? MI->getOperand(1).getImm() : 0;
636 // Register or immediate value. Register 0 means undef.
637 if (MI->getOperand(0).isFPImm()) {
638 APFloat APF = APFloat(MI->getOperand(0).getFPImm()->getValueAPF());
639 if (MI->getOperand(0).getFPImm()->getType()->isFloatTy()) {
640 OS << (double)APF.convertToFloat();
641 } else if (MI->getOperand(0).getFPImm()->getType()->isDoubleTy()) {
642 OS << APF.convertToDouble();
644 // There is no good way to print long double. Convert a copy to
645 // double. Ah well, it's only a comment.
647 APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
649 OS << "(long double) " << APF.convertToDouble();
651 } else if (MI->getOperand(0).isImm()) {
652 OS << MI->getOperand(0).getImm();
653 } else if (MI->getOperand(0).isCImm()) {
654 MI->getOperand(0).getCImm()->getValue().print(OS, false /*isSigned*/);
657 if (MI->getOperand(0).isReg()) {
658 Reg = MI->getOperand(0).getReg();
660 assert(MI->getOperand(0).isFI() && "Unknown operand type");
661 const TargetFrameLowering *TFI = AP.TM.getFrameLowering();
662 Offset += TFI->getFrameIndexReference(*AP.MF,
663 MI->getOperand(0).getIndex(), Reg);
667 // Suppress offset, it is not meaningful here.
669 // NOTE: Want this comment at start of line, don't emit with AddComment.
670 AP.OutStreamer.emitRawComment(OS.str());
675 OS << AP.TM.getRegisterInfo()->getName(Reg);
679 OS << '+' << Offset << ']';
681 // NOTE: Want this comment at start of line, don't emit with AddComment.
682 AP.OutStreamer.emitRawComment(OS.str());
686 AsmPrinter::CFIMoveType AsmPrinter::needsCFIMoves() {
687 if (MAI->getExceptionHandlingType() == ExceptionHandling::DwarfCFI &&
688 MF->getFunction()->needsUnwindTableEntry())
691 if (MMI->hasDebugInfo())
697 bool AsmPrinter::needsSEHMoves() {
698 return MAI->getExceptionHandlingType() == ExceptionHandling::Win64 &&
699 MF->getFunction()->needsUnwindTableEntry();
702 void AsmPrinter::emitCFIInstruction(const MachineInstr &MI) {
703 ExceptionHandling::ExceptionsType ExceptionHandlingType =
704 MAI->getExceptionHandlingType();
705 if (ExceptionHandlingType != ExceptionHandling::DwarfCFI &&
706 ExceptionHandlingType != ExceptionHandling::ARM)
709 if (needsCFIMoves() == CFI_M_None)
712 if (MMI->getCompactUnwindEncoding() != 0)
713 OutStreamer.EmitCompactUnwindEncoding(MMI->getCompactUnwindEncoding());
715 const MachineModuleInfo &MMI = MF->getMMI();
716 const std::vector<MCCFIInstruction> &Instrs = MMI.getFrameInstructions();
717 unsigned CFIIndex = MI.getOperand(0).getCFIIndex();
718 const MCCFIInstruction &CFI = Instrs[CFIIndex];
719 emitCFIInstruction(CFI);
722 /// EmitFunctionBody - This method emits the body and trailer for a
724 void AsmPrinter::EmitFunctionBody() {
725 // Emit target-specific gunk before the function body.
726 EmitFunctionBodyStart();
728 bool ShouldPrintDebugScopes = MMI->hasDebugInfo();
730 // Print out code for the function.
731 bool HasAnyRealCode = false;
732 const MachineInstr *LastMI = 0;
733 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
735 // Print a label for the basic block.
736 EmitBasicBlockStart(I);
737 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
741 // Print the assembly for the instruction.
742 if (!II->isPosition() && !II->isImplicitDef() && !II->isKill() &&
743 !II->isDebugValue()) {
744 HasAnyRealCode = true;
748 if (ShouldPrintDebugScopes) {
749 for (unsigned III = 0, EEE = Handlers.size(); III != EEE; ++III) {
750 const HandlerInfo &OI = Handlers[III];
751 NamedRegionTimer T(OI.TimerName, OI.TimerGroupName,
752 TimePassesIsEnabled);
753 OI.Handler->beginInstruction(II);
758 emitComments(*II, OutStreamer.GetCommentOS());
760 switch (II->getOpcode()) {
761 case TargetOpcode::CFI_INSTRUCTION:
762 emitCFIInstruction(*II);
765 case TargetOpcode::EH_LABEL:
766 case TargetOpcode::GC_LABEL:
767 OutStreamer.EmitLabel(II->getOperand(0).getMCSymbol());
769 case TargetOpcode::INLINEASM:
772 case TargetOpcode::DBG_VALUE:
774 if (!emitDebugValueComment(II, *this))
778 case TargetOpcode::IMPLICIT_DEF:
779 if (isVerbose()) emitImplicitDef(II);
781 case TargetOpcode::KILL:
782 if (isVerbose()) emitKill(II, *this);
789 if (ShouldPrintDebugScopes) {
790 for (unsigned III = 0, EEE = Handlers.size(); III != EEE; ++III) {
791 const HandlerInfo &OI = Handlers[III];
792 NamedRegionTimer T(OI.TimerName, OI.TimerGroupName,
793 TimePassesIsEnabled);
794 OI.Handler->endInstruction();
800 // If the last instruction was a prolog label, then we have a situation where
801 // we emitted a prolog but no function body. This results in the ending prolog
802 // label equaling the end of function label and an invalid "row" in the
803 // FDE. We need to emit a noop in this situation so that the FDE's rows are
805 bool RequiresNoop = LastMI && LastMI->isCFIInstruction();
807 // If the function is empty and the object file uses .subsections_via_symbols,
808 // then we need to emit *something* to the function body to prevent the
809 // labels from collapsing together. Just emit a noop.
810 if ((MAI->hasSubsectionsViaSymbols() && !HasAnyRealCode) || RequiresNoop) {
812 TM.getInstrInfo()->getNoopForMachoTarget(Noop);
813 if (Noop.getOpcode()) {
814 OutStreamer.AddComment("avoids zero-length function");
815 OutStreamer.EmitInstruction(Noop, getSubtargetInfo());
816 } else // Target not mc-ized yet.
817 OutStreamer.EmitRawText(StringRef("\tnop\n"));
820 const Function *F = MF->getFunction();
821 for (Function::const_iterator i = F->begin(), e = F->end(); i != e; ++i) {
822 const BasicBlock *BB = i;
823 if (!BB->hasAddressTaken())
825 MCSymbol *Sym = GetBlockAddressSymbol(BB);
826 if (Sym->isDefined())
828 OutStreamer.AddComment("Address of block that was removed by CodeGen");
829 OutStreamer.EmitLabel(Sym);
832 // Emit target-specific gunk after the function body.
833 EmitFunctionBodyEnd();
835 // If the target wants a .size directive for the size of the function, emit
837 if (MAI->hasDotTypeDotSizeDirective()) {
838 // Create a symbol for the end of function, so we can get the size as
839 // difference between the function label and the temp label.
840 MCSymbol *FnEndLabel = OutContext.CreateTempSymbol();
841 OutStreamer.EmitLabel(FnEndLabel);
843 const MCExpr *SizeExp =
844 MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(FnEndLabel, OutContext),
845 MCSymbolRefExpr::Create(CurrentFnSymForSize,
848 OutStreamer.EmitELFSize(CurrentFnSym, SizeExp);
851 // Emit post-function debug and/or EH information.
852 for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
853 const HandlerInfo &OI = Handlers[I];
854 NamedRegionTimer T(OI.TimerName, OI.TimerGroupName, TimePassesIsEnabled);
855 OI.Handler->endFunction(MF);
859 // Print out jump tables referenced by the function.
862 OutStreamer.AddBlankLine();
865 bool AsmPrinter::doFinalization(Module &M) {
866 // Emit global variables.
867 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
869 EmitGlobalVariable(I);
871 // Emit visibility info for declarations
872 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
873 const Function &F = *I;
874 if (!F.isDeclaration())
876 GlobalValue::VisibilityTypes V = F.getVisibility();
877 if (V == GlobalValue::DefaultVisibility)
880 MCSymbol *Name = getSymbol(&F);
881 EmitVisibility(Name, V, false);
884 // Emit module flags.
885 SmallVector<Module::ModuleFlagEntry, 8> ModuleFlags;
886 M.getModuleFlagsMetadata(ModuleFlags);
887 if (!ModuleFlags.empty())
888 getObjFileLowering().emitModuleFlags(OutStreamer, ModuleFlags, *Mang, TM);
890 // Make sure we wrote out everything we need.
893 // Finalize debug and EH information.
894 for (unsigned I = 0, E = Handlers.size(); I != E; ++I) {
895 const HandlerInfo &OI = Handlers[I];
896 NamedRegionTimer T(OI.TimerName, OI.TimerGroupName,
897 TimePassesIsEnabled);
898 OI.Handler->endModule();
904 // If the target wants to know about weak references, print them all.
905 if (MAI->getWeakRefDirective()) {
906 // FIXME: This is not lazy, it would be nice to only print weak references
907 // to stuff that is actually used. Note that doing so would require targets
908 // to notice uses in operands (due to constant exprs etc). This should
909 // happen with the MC stuff eventually.
911 // Print out module-level global variables here.
912 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
914 if (!I->hasExternalWeakLinkage()) continue;
915 OutStreamer.EmitSymbolAttribute(getSymbol(I), MCSA_WeakReference);
918 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
919 if (!I->hasExternalWeakLinkage()) continue;
920 OutStreamer.EmitSymbolAttribute(getSymbol(I), MCSA_WeakReference);
924 if (MAI->hasSetDirective()) {
925 OutStreamer.AddBlankLine();
926 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
928 MCSymbol *Name = getSymbol(I);
930 const GlobalValue *GV = I->getAliasedGlobal();
931 assert(!GV->isDeclaration());
932 MCSymbol *Target = getSymbol(GV);
934 if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
935 OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
936 else if (I->hasWeakLinkage() || I->hasLinkOnceLinkage())
937 OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
939 assert(I->hasLocalLinkage() && "Invalid alias linkage");
941 EmitVisibility(Name, I->getVisibility());
943 // Emit the directives as assignments aka .set:
944 OutStreamer.EmitAssignment(Name,
945 MCSymbolRefExpr::Create(Target, OutContext));
949 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
950 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
951 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
952 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
953 MP->finishAssembly(*this);
955 // Emit llvm.ident metadata in an '.ident' directive.
958 // If we don't have any trampolines, then we don't require stack memory
959 // to be executable. Some targets have a directive to declare this.
960 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
961 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
962 if (const MCSection *S = MAI->getNonexecutableStackSection(OutContext))
963 OutStreamer.SwitchSection(S);
965 // Allow the target to emit any magic that it wants at the end of the file,
966 // after everything else has gone out.
969 delete Mang; Mang = 0;
972 OutStreamer.Finish();
978 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
980 // Get the function symbol.
981 CurrentFnSym = getSymbol(MF.getFunction());
982 CurrentFnSymForSize = CurrentFnSym;
985 LI = &getAnalysis<MachineLoopInfo>();
989 // SectionCPs - Keep track the alignment, constpool entries per Section.
993 SmallVector<unsigned, 4> CPEs;
994 SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
998 /// EmitConstantPool - Print to the current output stream assembly
999 /// representations of the constants in the constant pool MCP. This is
1000 /// used to print out constants which have been "spilled to memory" by
1001 /// the code generator.
1003 void AsmPrinter::EmitConstantPool() {
1004 const MachineConstantPool *MCP = MF->getConstantPool();
1005 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
1006 if (CP.empty()) return;
1008 // Calculate sections for constant pool entries. We collect entries to go into
1009 // the same section together to reduce amount of section switch statements.
1010 SmallVector<SectionCPs, 4> CPSections;
1011 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
1012 const MachineConstantPoolEntry &CPE = CP[i];
1013 unsigned Align = CPE.getAlignment();
1016 switch (CPE.getRelocationInfo()) {
1017 default: llvm_unreachable("Unknown section kind");
1018 case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
1020 Kind = SectionKind::getReadOnlyWithRelLocal();
1023 switch (TM.getDataLayout()->getTypeAllocSize(CPE.getType())) {
1024 case 4: Kind = SectionKind::getMergeableConst4(); break;
1025 case 8: Kind = SectionKind::getMergeableConst8(); break;
1026 case 16: Kind = SectionKind::getMergeableConst16();break;
1027 default: Kind = SectionKind::getMergeableConst(); break;
1031 const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
1033 // The number of sections are small, just do a linear search from the
1034 // last section to the first.
1036 unsigned SecIdx = CPSections.size();
1037 while (SecIdx != 0) {
1038 if (CPSections[--SecIdx].S == S) {
1044 SecIdx = CPSections.size();
1045 CPSections.push_back(SectionCPs(S, Align));
1048 if (Align > CPSections[SecIdx].Alignment)
1049 CPSections[SecIdx].Alignment = Align;
1050 CPSections[SecIdx].CPEs.push_back(i);
1053 // Now print stuff into the calculated sections.
1054 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
1055 OutStreamer.SwitchSection(CPSections[i].S);
1056 EmitAlignment(Log2_32(CPSections[i].Alignment));
1058 unsigned Offset = 0;
1059 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
1060 unsigned CPI = CPSections[i].CPEs[j];
1061 MachineConstantPoolEntry CPE = CP[CPI];
1063 // Emit inter-object padding for alignment.
1064 unsigned AlignMask = CPE.getAlignment() - 1;
1065 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
1066 OutStreamer.EmitZeros(NewOffset - Offset);
1068 Type *Ty = CPE.getType();
1069 Offset = NewOffset + TM.getDataLayout()->getTypeAllocSize(Ty);
1070 OutStreamer.EmitLabel(GetCPISymbol(CPI));
1072 if (CPE.isMachineConstantPoolEntry())
1073 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
1075 EmitGlobalConstant(CPE.Val.ConstVal);
1080 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
1081 /// by the current function to the current output stream.
1083 void AsmPrinter::EmitJumpTableInfo() {
1084 const DataLayout *DL = MF->getTarget().getDataLayout();
1085 const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
1086 if (MJTI == 0) return;
1087 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline) return;
1088 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1089 if (JT.empty()) return;
1091 // Pick the directive to use to print the jump table entries, and switch to
1092 // the appropriate section.
1093 const Function *F = MF->getFunction();
1094 bool JTInDiffSection = false;
1095 if (// In PIC mode, we need to emit the jump table to the same section as the
1096 // function body itself, otherwise the label differences won't make sense.
1097 // FIXME: Need a better predicate for this: what about custom entries?
1098 MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 ||
1099 // We should also do if the section name is NULL or function is declared
1100 // in discardable section
1101 // FIXME: this isn't the right predicate, should be based on the MCSection
1102 // for the function.
1103 F->isWeakForLinker()) {
1104 OutStreamer.SwitchSection(
1105 getObjFileLowering().SectionForGlobal(F, *Mang, TM));
1107 // Otherwise, drop it in the readonly section.
1108 const MCSection *ReadOnlySection =
1109 getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
1110 OutStreamer.SwitchSection(ReadOnlySection);
1111 JTInDiffSection = true;
1114 EmitAlignment(Log2_32(MJTI->getEntryAlignment(*TM.getDataLayout())));
1116 // Jump tables in code sections are marked with a data_region directive
1117 // where that's supported.
1118 if (!JTInDiffSection)
1119 OutStreamer.EmitDataRegion(MCDR_DataRegionJT32);
1121 for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) {
1122 const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
1124 // If this jump table was deleted, ignore it.
1125 if (JTBBs.empty()) continue;
1127 // For the EK_LabelDifference32 entry, if the target supports .set, emit a
1128 // .set directive for each unique entry. This reduces the number of
1129 // relocations the assembler will generate for the jump table.
1130 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
1131 MAI->hasSetDirective()) {
1132 SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets;
1133 const TargetLowering *TLI = TM.getTargetLowering();
1134 const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF,JTI,OutContext);
1135 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
1136 const MachineBasicBlock *MBB = JTBBs[ii];
1137 if (!EmittedSets.insert(MBB)) continue;
1139 // .set LJTSet, LBB32-base
1141 MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1142 OutStreamer.EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()),
1143 MCBinaryExpr::CreateSub(LHS, Base, OutContext));
1147 // On some targets (e.g. Darwin) we want to emit two consecutive labels
1148 // before each jump table. The first label is never referenced, but tells
1149 // the assembler and linker the extents of the jump table object. The
1150 // second label is actually referenced by the code.
1151 if (JTInDiffSection && DL->hasLinkerPrivateGlobalPrefix())
1152 // FIXME: This doesn't have to have any specific name, just any randomly
1153 // named and numbered 'l' label would work. Simplify GetJTISymbol.
1154 OutStreamer.EmitLabel(GetJTISymbol(JTI, true));
1156 OutStreamer.EmitLabel(GetJTISymbol(JTI));
1158 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
1159 EmitJumpTableEntry(MJTI, JTBBs[ii], JTI);
1161 if (!JTInDiffSection)
1162 OutStreamer.EmitDataRegion(MCDR_DataRegionEnd);
1165 /// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
1167 void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
1168 const MachineBasicBlock *MBB,
1169 unsigned UID) const {
1170 assert(MBB && MBB->getNumber() >= 0 && "Invalid basic block");
1171 const MCExpr *Value = 0;
1172 switch (MJTI->getEntryKind()) {
1173 case MachineJumpTableInfo::EK_Inline:
1174 llvm_unreachable("Cannot emit EK_Inline jump table entry");
1175 case MachineJumpTableInfo::EK_Custom32:
1176 Value = TM.getTargetLowering()->LowerCustomJumpTableEntry(MJTI, MBB, UID,
1179 case MachineJumpTableInfo::EK_BlockAddress:
1180 // EK_BlockAddress - Each entry is a plain address of block, e.g.:
1182 Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1184 case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
1185 // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
1186 // with a relocation as gp-relative, e.g.:
1188 MCSymbol *MBBSym = MBB->getSymbol();
1189 OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1193 case MachineJumpTableInfo::EK_GPRel64BlockAddress: {
1194 // EK_GPRel64BlockAddress - Each entry is an address of block, encoded
1195 // with a relocation as gp-relative, e.g.:
1197 MCSymbol *MBBSym = MBB->getSymbol();
1198 OutStreamer.EmitGPRel64Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1202 case MachineJumpTableInfo::EK_LabelDifference32: {
1203 // EK_LabelDifference32 - Each entry is the address of the block minus
1204 // the address of the jump table. This is used for PIC jump tables where
1205 // gprel32 is not supported. e.g.:
1206 // .word LBB123 - LJTI1_2
1207 // If the .set directive is supported, this is emitted as:
1208 // .set L4_5_set_123, LBB123 - LJTI1_2
1209 // .word L4_5_set_123
1211 // If we have emitted set directives for the jump table entries, print
1212 // them rather than the entries themselves. If we're emitting PIC, then
1213 // emit the table entries as differences between two text section labels.
1214 if (MAI->hasSetDirective()) {
1215 // If we used .set, reference the .set's symbol.
1216 Value = MCSymbolRefExpr::Create(GetJTSetSymbol(UID, MBB->getNumber()),
1220 // Otherwise, use the difference as the jump table entry.
1221 Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1222 const MCExpr *JTI = MCSymbolRefExpr::Create(GetJTISymbol(UID), OutContext);
1223 Value = MCBinaryExpr::CreateSub(Value, JTI, OutContext);
1228 assert(Value && "Unknown entry kind!");
1230 unsigned EntrySize = MJTI->getEntrySize(*TM.getDataLayout());
1231 OutStreamer.EmitValue(Value, EntrySize);
1235 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
1236 /// special global used by LLVM. If so, emit it and return true, otherwise
1237 /// do nothing and return false.
1238 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
1239 if (GV->getName() == "llvm.used") {
1240 if (MAI->hasNoDeadStrip()) // No need to emit this at all.
1241 EmitLLVMUsedList(cast<ConstantArray>(GV->getInitializer()));
1245 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
1246 if (GV->getSection() == "llvm.metadata" ||
1247 GV->hasAvailableExternallyLinkage())
1250 if (!GV->hasAppendingLinkage()) return false;
1252 assert(GV->hasInitializer() && "Not a special LLVM global!");
1254 if (GV->getName() == "llvm.global_ctors") {
1255 EmitXXStructorList(GV->getInitializer(), /* isCtor */ true);
1257 if (TM.getRelocationModel() == Reloc::Static &&
1258 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1259 StringRef Sym(".constructors_used");
1260 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1266 if (GV->getName() == "llvm.global_dtors") {
1267 EmitXXStructorList(GV->getInitializer(), /* isCtor */ false);
1269 if (TM.getRelocationModel() == Reloc::Static &&
1270 MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1271 StringRef Sym(".destructors_used");
1272 OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1281 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
1282 /// global in the specified llvm.used list for which emitUsedDirectiveFor
1283 /// is true, as being used with this directive.
1284 void AsmPrinter::EmitLLVMUsedList(const ConstantArray *InitList) {
1285 // Should be an array of 'i8*'.
1286 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
1287 const GlobalValue *GV =
1288 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
1290 OutStreamer.EmitSymbolAttribute(getSymbol(GV), MCSA_NoDeadStrip);
1294 /// EmitXXStructorList - Emit the ctor or dtor list taking into account the init
1296 void AsmPrinter::EmitXXStructorList(const Constant *List, bool isCtor) {
1297 // Should be an array of '{ int, void ()* }' structs. The first value is the
1299 if (!isa<ConstantArray>(List)) return;
1301 // Sanity check the structors list.
1302 const ConstantArray *InitList = dyn_cast<ConstantArray>(List);
1303 if (!InitList) return; // Not an array!
1304 StructType *ETy = dyn_cast<StructType>(InitList->getType()->getElementType());
1305 if (!ETy || ETy->getNumElements() != 2) return; // Not an array of pairs!
1306 if (!isa<IntegerType>(ETy->getTypeAtIndex(0U)) ||
1307 !isa<PointerType>(ETy->getTypeAtIndex(1U))) return; // Not (int, ptr).
1309 // Gather the structors in a form that's convenient for sorting by priority.
1310 typedef std::pair<unsigned, Constant *> Structor;
1311 SmallVector<Structor, 8> Structors;
1312 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
1313 ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i));
1314 if (!CS) continue; // Malformed.
1315 if (CS->getOperand(1)->isNullValue())
1316 break; // Found a null terminator, skip the rest.
1317 ConstantInt *Priority = dyn_cast<ConstantInt>(CS->getOperand(0));
1318 if (!Priority) continue; // Malformed.
1319 Structors.push_back(std::make_pair(Priority->getLimitedValue(65535),
1320 CS->getOperand(1)));
1323 // Emit the function pointers in the target-specific order
1324 const DataLayout *DL = TM.getDataLayout();
1325 unsigned Align = Log2_32(DL->getPointerPrefAlignment());
1326 std::stable_sort(Structors.begin(), Structors.end(), less_first());
1327 for (unsigned i = 0, e = Structors.size(); i != e; ++i) {
1328 const MCSection *OutputSection =
1330 getObjFileLowering().getStaticCtorSection(Structors[i].first) :
1331 getObjFileLowering().getStaticDtorSection(Structors[i].first));
1332 OutStreamer.SwitchSection(OutputSection);
1333 if (OutStreamer.getCurrentSection() != OutStreamer.getPreviousSection())
1334 EmitAlignment(Align);
1335 EmitXXStructor(Structors[i].second);
1339 void AsmPrinter::EmitModuleIdents(Module &M) {
1340 if (!MAI->hasIdentDirective())
1343 if (const NamedMDNode *NMD = M.getNamedMetadata("llvm.ident")) {
1344 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1345 const MDNode *N = NMD->getOperand(i);
1346 assert(N->getNumOperands() == 1 &&
1347 "llvm.ident metadata entry can have only one operand");
1348 const MDString *S = cast<MDString>(N->getOperand(0));
1349 OutStreamer.EmitIdent(S->getString());
1354 //===--------------------------------------------------------------------===//
1355 // Emission and print routines
1358 /// EmitInt8 - Emit a byte directive and value.
1360 void AsmPrinter::EmitInt8(int Value) const {
1361 OutStreamer.EmitIntValue(Value, 1);
1364 /// EmitInt16 - Emit a short directive and value.
1366 void AsmPrinter::EmitInt16(int Value) const {
1367 OutStreamer.EmitIntValue(Value, 2);
1370 /// EmitInt32 - Emit a long directive and value.
1372 void AsmPrinter::EmitInt32(int Value) const {
1373 OutStreamer.EmitIntValue(Value, 4);
1376 /// EmitLabelDifference - Emit something like ".long Hi-Lo" where the size
1377 /// in bytes of the directive is specified by Size and Hi/Lo specify the
1378 /// labels. This implicitly uses .set if it is available.
1379 void AsmPrinter::EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
1380 unsigned Size) const {
1381 // Get the Hi-Lo expression.
1382 const MCExpr *Diff =
1383 MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(Hi, OutContext),
1384 MCSymbolRefExpr::Create(Lo, OutContext),
1387 if (!MAI->hasSetDirective()) {
1388 OutStreamer.EmitValue(Diff, Size);
1392 // Otherwise, emit with .set (aka assignment).
1393 MCSymbol *SetLabel = GetTempSymbol("set", SetCounter++);
1394 OutStreamer.EmitAssignment(SetLabel, Diff);
1395 OutStreamer.EmitSymbolValue(SetLabel, Size);
1398 /// EmitLabelOffsetDifference - Emit something like ".long Hi+Offset-Lo"
1399 /// where the size in bytes of the directive is specified by Size and Hi/Lo
1400 /// specify the labels. This implicitly uses .set if it is available.
1401 void AsmPrinter::EmitLabelOffsetDifference(const MCSymbol *Hi, uint64_t Offset,
1403 unsigned Size) const {
1405 // Emit Hi+Offset - Lo
1406 // Get the Hi+Offset expression.
1407 const MCExpr *Plus =
1408 MCBinaryExpr::CreateAdd(MCSymbolRefExpr::Create(Hi, OutContext),
1409 MCConstantExpr::Create(Offset, OutContext),
1412 // Get the Hi+Offset-Lo expression.
1413 const MCExpr *Diff =
1414 MCBinaryExpr::CreateSub(Plus,
1415 MCSymbolRefExpr::Create(Lo, OutContext),
1418 if (!MAI->hasSetDirective())
1419 OutStreamer.EmitValue(Diff, Size);
1421 // Otherwise, emit with .set (aka assignment).
1422 MCSymbol *SetLabel = GetTempSymbol("set", SetCounter++);
1423 OutStreamer.EmitAssignment(SetLabel, Diff);
1424 OutStreamer.EmitSymbolValue(SetLabel, Size);
1428 /// EmitLabelPlusOffset - Emit something like ".long Label+Offset"
1429 /// where the size in bytes of the directive is specified by Size and Label
1430 /// specifies the label. This implicitly uses .set if it is available.
1431 void AsmPrinter::EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
1433 bool IsSectionRelative) const {
1434 if (MAI->needsDwarfSectionOffsetDirective() && IsSectionRelative) {
1435 OutStreamer.EmitCOFFSecRel32(Label);
1439 // Emit Label+Offset (or just Label if Offset is zero)
1440 const MCExpr *Expr = MCSymbolRefExpr::Create(Label, OutContext);
1442 Expr = MCBinaryExpr::CreateAdd(
1443 Expr, MCConstantExpr::Create(Offset, OutContext), OutContext);
1445 OutStreamer.EmitValue(Expr, Size);
1448 //===----------------------------------------------------------------------===//
1450 // EmitAlignment - Emit an alignment directive to the specified power of
1451 // two boundary. For example, if you pass in 3 here, you will get an 8
1452 // byte alignment. If a global value is specified, and if that global has
1453 // an explicit alignment requested, it will override the alignment request
1454 // if required for correctness.
1456 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV) const {
1457 if (GV) NumBits = getGVAlignmentLog2(GV, *TM.getDataLayout(), NumBits);
1459 if (NumBits == 0) return; // 1-byte aligned: no need to emit alignment.
1461 if (getCurrentSection()->getKind().isText())
1462 OutStreamer.EmitCodeAlignment(1 << NumBits);
1464 OutStreamer.EmitValueToAlignment(1 << NumBits);
1467 //===----------------------------------------------------------------------===//
1468 // Constant emission.
1469 //===----------------------------------------------------------------------===//
1471 /// lowerConstant - Lower the specified LLVM Constant to an MCExpr.
1473 static const MCExpr *lowerConstant(const Constant *CV, AsmPrinter &AP) {
1474 MCContext &Ctx = AP.OutContext;
1476 if (CV->isNullValue() || isa<UndefValue>(CV))
1477 return MCConstantExpr::Create(0, Ctx);
1479 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
1480 return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
1482 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
1483 return MCSymbolRefExpr::Create(AP.getSymbol(GV), Ctx);
1485 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
1486 return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
1488 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
1490 llvm_unreachable("Unknown constant value to lower!");
1493 if (const MCExpr *RelocExpr =
1494 AP.getObjFileLowering().getExecutableRelativeSymbol(CE, *AP.Mang,
1498 switch (CE->getOpcode()) {
1500 // If the code isn't optimized, there may be outstanding folding
1501 // opportunities. Attempt to fold the expression using DataLayout as a
1502 // last resort before giving up.
1504 ConstantFoldConstantExpression(CE, AP.TM.getDataLayout()))
1506 return lowerConstant(C, AP);
1508 // Otherwise report the problem to the user.
1511 raw_string_ostream OS(S);
1512 OS << "Unsupported expression in static initializer: ";
1513 CE->printAsOperand(OS, /*PrintType=*/false,
1514 !AP.MF ? 0 : AP.MF->getFunction()->getParent());
1515 report_fatal_error(OS.str());
1517 case Instruction::GetElementPtr: {
1518 const DataLayout &DL = *AP.TM.getDataLayout();
1519 // Generate a symbolic expression for the byte address
1520 APInt OffsetAI(DL.getPointerTypeSizeInBits(CE->getType()), 0);
1521 cast<GEPOperator>(CE)->accumulateConstantOffset(DL, OffsetAI);
1523 const MCExpr *Base = lowerConstant(CE->getOperand(0), AP);
1527 int64_t Offset = OffsetAI.getSExtValue();
1528 return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
1532 case Instruction::Trunc:
1533 // We emit the value and depend on the assembler to truncate the generated
1534 // expression properly. This is important for differences between
1535 // blockaddress labels. Since the two labels are in the same function, it
1536 // is reasonable to treat their delta as a 32-bit value.
1538 case Instruction::BitCast:
1539 return lowerConstant(CE->getOperand(0), AP);
1541 case Instruction::IntToPtr: {
1542 const DataLayout &DL = *AP.TM.getDataLayout();
1543 // Handle casts to pointers by changing them into casts to the appropriate
1544 // integer type. This promotes constant folding and simplifies this code.
1545 Constant *Op = CE->getOperand(0);
1546 Op = ConstantExpr::getIntegerCast(Op, DL.getIntPtrType(CV->getType()),
1548 return lowerConstant(Op, AP);
1551 case Instruction::PtrToInt: {
1552 const DataLayout &DL = *AP.TM.getDataLayout();
1553 // Support only foldable casts to/from pointers that can be eliminated by
1554 // changing the pointer to the appropriately sized integer type.
1555 Constant *Op = CE->getOperand(0);
1556 Type *Ty = CE->getType();
1558 const MCExpr *OpExpr = lowerConstant(Op, AP);
1560 // We can emit the pointer value into this slot if the slot is an
1561 // integer slot equal to the size of the pointer.
1562 if (DL.getTypeAllocSize(Ty) == DL.getTypeAllocSize(Op->getType()))
1565 // Otherwise the pointer is smaller than the resultant integer, mask off
1566 // the high bits so we are sure to get a proper truncation if the input is
1568 unsigned InBits = DL.getTypeAllocSizeInBits(Op->getType());
1569 const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
1570 return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
1573 // The MC library also has a right-shift operator, but it isn't consistently
1574 // signed or unsigned between different targets.
1575 case Instruction::Add:
1576 case Instruction::Sub:
1577 case Instruction::Mul:
1578 case Instruction::SDiv:
1579 case Instruction::SRem:
1580 case Instruction::Shl:
1581 case Instruction::And:
1582 case Instruction::Or:
1583 case Instruction::Xor: {
1584 const MCExpr *LHS = lowerConstant(CE->getOperand(0), AP);
1585 const MCExpr *RHS = lowerConstant(CE->getOperand(1), AP);
1586 switch (CE->getOpcode()) {
1587 default: llvm_unreachable("Unknown binary operator constant cast expr");
1588 case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
1589 case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
1590 case Instruction::Mul: return MCBinaryExpr::CreateMul(LHS, RHS, Ctx);
1591 case Instruction::SDiv: return MCBinaryExpr::CreateDiv(LHS, RHS, Ctx);
1592 case Instruction::SRem: return MCBinaryExpr::CreateMod(LHS, RHS, Ctx);
1593 case Instruction::Shl: return MCBinaryExpr::CreateShl(LHS, RHS, Ctx);
1594 case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
1595 case Instruction::Or: return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
1596 case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
1602 static void emitGlobalConstantImpl(const Constant *C, AsmPrinter &AP);
1604 /// isRepeatedByteSequence - Determine whether the given value is
1605 /// composed of a repeated sequence of identical bytes and return the
1606 /// byte value. If it is not a repeated sequence, return -1.
1607 static int isRepeatedByteSequence(const ConstantDataSequential *V) {
1608 StringRef Data = V->getRawDataValues();
1609 assert(!Data.empty() && "Empty aggregates should be CAZ node");
1611 for (unsigned i = 1, e = Data.size(); i != e; ++i)
1612 if (Data[i] != C) return -1;
1613 return static_cast<uint8_t>(C); // Ensure 255 is not returned as -1.
1617 /// isRepeatedByteSequence - Determine whether the given value is
1618 /// composed of a repeated sequence of identical bytes and return the
1619 /// byte value. If it is not a repeated sequence, return -1.
1620 static int isRepeatedByteSequence(const Value *V, TargetMachine &TM) {
1622 if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
1623 if (CI->getBitWidth() > 64) return -1;
1625 uint64_t Size = TM.getDataLayout()->getTypeAllocSize(V->getType());
1626 uint64_t Value = CI->getZExtValue();
1628 // Make sure the constant is at least 8 bits long and has a power
1629 // of 2 bit width. This guarantees the constant bit width is
1630 // always a multiple of 8 bits, avoiding issues with padding out
1631 // to Size and other such corner cases.
1632 if (CI->getBitWidth() < 8 || !isPowerOf2_64(CI->getBitWidth())) return -1;
1634 uint8_t Byte = static_cast<uint8_t>(Value);
1636 for (unsigned i = 1; i < Size; ++i) {
1638 if (static_cast<uint8_t>(Value) != Byte) return -1;
1642 if (const ConstantArray *CA = dyn_cast<ConstantArray>(V)) {
1643 // Make sure all array elements are sequences of the same repeated
1645 assert(CA->getNumOperands() != 0 && "Should be a CAZ");
1646 int Byte = isRepeatedByteSequence(CA->getOperand(0), TM);
1647 if (Byte == -1) return -1;
1649 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1650 int ThisByte = isRepeatedByteSequence(CA->getOperand(i), TM);
1651 if (ThisByte == -1) return -1;
1652 if (Byte != ThisByte) return -1;
1657 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V))
1658 return isRepeatedByteSequence(CDS);
1663 static void emitGlobalConstantDataSequential(const ConstantDataSequential *CDS,
1666 // See if we can aggregate this into a .fill, if so, emit it as such.
1667 int Value = isRepeatedByteSequence(CDS, AP.TM);
1669 uint64_t Bytes = AP.TM.getDataLayout()->getTypeAllocSize(CDS->getType());
1670 // Don't emit a 1-byte object as a .fill.
1672 return AP.OutStreamer.EmitFill(Bytes, Value);
1675 // If this can be emitted with .ascii/.asciz, emit it as such.
1676 if (CDS->isString())
1677 return AP.OutStreamer.EmitBytes(CDS->getAsString());
1679 // Otherwise, emit the values in successive locations.
1680 unsigned ElementByteSize = CDS->getElementByteSize();
1681 if (isa<IntegerType>(CDS->getElementType())) {
1682 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1684 AP.OutStreamer.GetCommentOS() << format("0x%" PRIx64 "\n",
1685 CDS->getElementAsInteger(i));
1686 AP.OutStreamer.EmitIntValue(CDS->getElementAsInteger(i),
1689 } else if (ElementByteSize == 4) {
1690 // FP Constants are printed as integer constants to avoid losing
1692 assert(CDS->getElementType()->isFloatTy());
1693 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1699 F = CDS->getElementAsFloat(i);
1701 AP.OutStreamer.GetCommentOS() << "float " << F << '\n';
1702 AP.OutStreamer.EmitIntValue(I, 4);
1705 assert(CDS->getElementType()->isDoubleTy());
1706 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1712 F = CDS->getElementAsDouble(i);
1714 AP.OutStreamer.GetCommentOS() << "double " << F << '\n';
1715 AP.OutStreamer.EmitIntValue(I, 8);
1719 const DataLayout &DL = *AP.TM.getDataLayout();
1720 unsigned Size = DL.getTypeAllocSize(CDS->getType());
1721 unsigned EmittedSize = DL.getTypeAllocSize(CDS->getType()->getElementType()) *
1722 CDS->getNumElements();
1723 if (unsigned Padding = Size - EmittedSize)
1724 AP.OutStreamer.EmitZeros(Padding);
1728 static void emitGlobalConstantArray(const ConstantArray *CA, AsmPrinter &AP) {
1729 // See if we can aggregate some values. Make sure it can be
1730 // represented as a series of bytes of the constant value.
1731 int Value = isRepeatedByteSequence(CA, AP.TM);
1734 uint64_t Bytes = AP.TM.getDataLayout()->getTypeAllocSize(CA->getType());
1735 AP.OutStreamer.EmitFill(Bytes, Value);
1738 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1739 emitGlobalConstantImpl(CA->getOperand(i), AP);
1743 static void emitGlobalConstantVector(const ConstantVector *CV, AsmPrinter &AP) {
1744 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
1745 emitGlobalConstantImpl(CV->getOperand(i), AP);
1747 const DataLayout &DL = *AP.TM.getDataLayout();
1748 unsigned Size = DL.getTypeAllocSize(CV->getType());
1749 unsigned EmittedSize = DL.getTypeAllocSize(CV->getType()->getElementType()) *
1750 CV->getType()->getNumElements();
1751 if (unsigned Padding = Size - EmittedSize)
1752 AP.OutStreamer.EmitZeros(Padding);
1755 static void emitGlobalConstantStruct(const ConstantStruct *CS, AsmPrinter &AP) {
1756 // Print the fields in successive locations. Pad to align if needed!
1757 const DataLayout *DL = AP.TM.getDataLayout();
1758 unsigned Size = DL->getTypeAllocSize(CS->getType());
1759 const StructLayout *Layout = DL->getStructLayout(CS->getType());
1760 uint64_t SizeSoFar = 0;
1761 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
1762 const Constant *Field = CS->getOperand(i);
1764 // Check if padding is needed and insert one or more 0s.
1765 uint64_t FieldSize = DL->getTypeAllocSize(Field->getType());
1766 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
1767 - Layout->getElementOffset(i)) - FieldSize;
1768 SizeSoFar += FieldSize + PadSize;
1770 // Now print the actual field value.
1771 emitGlobalConstantImpl(Field, AP);
1773 // Insert padding - this may include padding to increase the size of the
1774 // current field up to the ABI size (if the struct is not packed) as well
1775 // as padding to ensure that the next field starts at the right offset.
1776 AP.OutStreamer.EmitZeros(PadSize);
1778 assert(SizeSoFar == Layout->getSizeInBytes() &&
1779 "Layout of constant struct may be incorrect!");
1782 static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP) {
1783 APInt API = CFP->getValueAPF().bitcastToAPInt();
1785 // First print a comment with what we think the original floating-point value
1786 // should have been.
1787 if (AP.isVerbose()) {
1788 SmallString<8> StrVal;
1789 CFP->getValueAPF().toString(StrVal);
1791 CFP->getType()->print(AP.OutStreamer.GetCommentOS());
1792 AP.OutStreamer.GetCommentOS() << ' ' << StrVal << '\n';
1795 // Now iterate through the APInt chunks, emitting them in endian-correct
1796 // order, possibly with a smaller chunk at beginning/end (e.g. for x87 80-bit
1798 unsigned NumBytes = API.getBitWidth() / 8;
1799 unsigned TrailingBytes = NumBytes % sizeof(uint64_t);
1800 const uint64_t *p = API.getRawData();
1802 // PPC's long double has odd notions of endianness compared to how LLVM
1803 // handles it: p[0] goes first for *big* endian on PPC.
1804 if (AP.TM.getDataLayout()->isBigEndian() != CFP->getType()->isPPC_FP128Ty()) {
1805 int Chunk = API.getNumWords() - 1;
1808 AP.OutStreamer.EmitIntValue(p[Chunk--], TrailingBytes);
1810 for (; Chunk >= 0; --Chunk)
1811 AP.OutStreamer.EmitIntValue(p[Chunk], sizeof(uint64_t));
1814 for (Chunk = 0; Chunk < NumBytes / sizeof(uint64_t); ++Chunk)
1815 AP.OutStreamer.EmitIntValue(p[Chunk], sizeof(uint64_t));
1818 AP.OutStreamer.EmitIntValue(p[Chunk], TrailingBytes);
1821 // Emit the tail padding for the long double.
1822 const DataLayout &DL = *AP.TM.getDataLayout();
1823 AP.OutStreamer.EmitZeros(DL.getTypeAllocSize(CFP->getType()) -
1824 DL.getTypeStoreSize(CFP->getType()));
1827 static void emitGlobalConstantLargeInt(const ConstantInt *CI, AsmPrinter &AP) {
1828 const DataLayout *DL = AP.TM.getDataLayout();
1829 unsigned BitWidth = CI->getBitWidth();
1831 // Copy the value as we may massage the layout for constants whose bit width
1832 // is not a multiple of 64-bits.
1833 APInt Realigned(CI->getValue());
1834 uint64_t ExtraBits = 0;
1835 unsigned ExtraBitsSize = BitWidth & 63;
1837 if (ExtraBitsSize) {
1838 // The bit width of the data is not a multiple of 64-bits.
1839 // The extra bits are expected to be at the end of the chunk of the memory.
1841 // * Nothing to be done, just record the extra bits to emit.
1843 // * Record the extra bits to emit.
1844 // * Realign the raw data to emit the chunks of 64-bits.
1845 if (DL->isBigEndian()) {
1846 // Basically the structure of the raw data is a chunk of 64-bits cells:
1847 // 0 1 BitWidth / 64
1848 // [chunk1][chunk2] ... [chunkN].
1849 // The most significant chunk is chunkN and it should be emitted first.
1850 // However, due to the alignment issue chunkN contains useless bits.
1851 // Realign the chunks so that they contain only useless information:
1852 // ExtraBits 0 1 (BitWidth / 64) - 1
1853 // chu[nk1 chu][nk2 chu] ... [nkN-1 chunkN]
1854 ExtraBits = Realigned.getRawData()[0] &
1855 (((uint64_t)-1) >> (64 - ExtraBitsSize));
1856 Realigned = Realigned.lshr(ExtraBitsSize);
1858 ExtraBits = Realigned.getRawData()[BitWidth / 64];
1861 // We don't expect assemblers to support integer data directives
1862 // for more than 64 bits, so we emit the data in at most 64-bit
1863 // quantities at a time.
1864 const uint64_t *RawData = Realigned.getRawData();
1865 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1866 uint64_t Val = DL->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1867 AP.OutStreamer.EmitIntValue(Val, 8);
1870 if (ExtraBitsSize) {
1871 // Emit the extra bits after the 64-bits chunks.
1873 // Emit a directive that fills the expected size.
1874 uint64_t Size = AP.TM.getDataLayout()->getTypeAllocSize(CI->getType());
1875 Size -= (BitWidth / 64) * 8;
1876 assert(Size && Size * 8 >= ExtraBitsSize &&
1877 (ExtraBits & (((uint64_t)-1) >> (64 - ExtraBitsSize)))
1878 == ExtraBits && "Directive too small for extra bits.");
1879 AP.OutStreamer.EmitIntValue(ExtraBits, Size);
1883 static void emitGlobalConstantImpl(const Constant *CV, AsmPrinter &AP) {
1884 const DataLayout *DL = AP.TM.getDataLayout();
1885 uint64_t Size = DL->getTypeAllocSize(CV->getType());
1886 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV))
1887 return AP.OutStreamer.EmitZeros(Size);
1889 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1896 AP.OutStreamer.GetCommentOS() << format("0x%" PRIx64 "\n",
1897 CI->getZExtValue());
1898 AP.OutStreamer.EmitIntValue(CI->getZExtValue(), Size);
1901 emitGlobalConstantLargeInt(CI, AP);
1906 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1907 return emitGlobalConstantFP(CFP, AP);
1909 if (isa<ConstantPointerNull>(CV)) {
1910 AP.OutStreamer.EmitIntValue(0, Size);
1914 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(CV))
1915 return emitGlobalConstantDataSequential(CDS, AP);
1917 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1918 return emitGlobalConstantArray(CVA, AP);
1920 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1921 return emitGlobalConstantStruct(CVS, AP);
1923 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1924 // Look through bitcasts, which might not be able to be MCExpr'ized (e.g. of
1926 if (CE->getOpcode() == Instruction::BitCast)
1927 return emitGlobalConstantImpl(CE->getOperand(0), AP);
1930 // If the constant expression's size is greater than 64-bits, then we have
1931 // to emit the value in chunks. Try to constant fold the value and emit it
1933 Constant *New = ConstantFoldConstantExpression(CE, DL);
1934 if (New && New != CE)
1935 return emitGlobalConstantImpl(New, AP);
1939 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1940 return emitGlobalConstantVector(V, AP);
1942 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it
1943 // thread the streamer with EmitValue.
1944 AP.OutStreamer.EmitValue(lowerConstant(CV, AP), Size);
1947 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1948 void AsmPrinter::EmitGlobalConstant(const Constant *CV) {
1949 uint64_t Size = TM.getDataLayout()->getTypeAllocSize(CV->getType());
1951 emitGlobalConstantImpl(CV, *this);
1952 else if (MAI->hasSubsectionsViaSymbols()) {
1953 // If the global has zero size, emit a single byte so that two labels don't
1954 // look like they are at the same location.
1955 OutStreamer.EmitIntValue(0, 1);
1959 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1960 // Target doesn't support this yet!
1961 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1964 void AsmPrinter::printOffset(int64_t Offset, raw_ostream &OS) const {
1966 OS << '+' << Offset;
1967 else if (Offset < 0)
1971 //===----------------------------------------------------------------------===//
1972 // Symbol Lowering Routines.
1973 //===----------------------------------------------------------------------===//
1975 /// GetTempSymbol - Return the MCSymbol corresponding to the assembler
1976 /// temporary label with the specified stem and unique ID.
1977 MCSymbol *AsmPrinter::GetTempSymbol(Twine Name, unsigned ID) const {
1978 const DataLayout *DL = TM.getDataLayout();
1979 return OutContext.GetOrCreateSymbol(Twine(DL->getPrivateGlobalPrefix()) +
1983 /// GetTempSymbol - Return an assembler temporary label with the specified
1985 MCSymbol *AsmPrinter::GetTempSymbol(Twine Name) const {
1986 const DataLayout *DL = TM.getDataLayout();
1987 return OutContext.GetOrCreateSymbol(Twine(DL->getPrivateGlobalPrefix())+
1992 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const {
1993 return MMI->getAddrLabelSymbol(BA->getBasicBlock());
1996 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BasicBlock *BB) const {
1997 return MMI->getAddrLabelSymbol(BB);
2000 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
2001 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
2002 const DataLayout *DL = TM.getDataLayout();
2003 return OutContext.GetOrCreateSymbol
2004 (Twine(DL->getPrivateGlobalPrefix()) + "CPI" + Twine(getFunctionNumber())
2005 + "_" + Twine(CPID));
2008 /// GetJTISymbol - Return the symbol for the specified jump table entry.
2009 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
2010 return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
2013 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
2014 /// FIXME: privatize to AsmPrinter.
2015 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
2016 const DataLayout *DL = TM.getDataLayout();
2017 return OutContext.GetOrCreateSymbol
2018 (Twine(DL->getPrivateGlobalPrefix()) + Twine(getFunctionNumber()) + "_" +
2019 Twine(UID) + "_set_" + Twine(MBBID));
2022 MCSymbol *AsmPrinter::getSymbolWithGlobalValueBase(const GlobalValue *GV,
2023 StringRef Suffix) const {
2024 return getObjFileLowering().getSymbolWithGlobalValueBase(GV, Suffix, *Mang,
2028 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
2030 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
2031 SmallString<60> NameStr;
2032 Mang->getNameWithPrefix(NameStr, Sym);
2033 return OutContext.GetOrCreateSymbol(NameStr.str());
2038 /// PrintParentLoopComment - Print comments about parent loops of this one.
2039 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2040 unsigned FunctionNumber) {
2041 if (Loop == 0) return;
2042 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
2043 OS.indent(Loop->getLoopDepth()*2)
2044 << "Parent Loop BB" << FunctionNumber << "_"
2045 << Loop->getHeader()->getNumber()
2046 << " Depth=" << Loop->getLoopDepth() << '\n';
2050 /// PrintChildLoopComment - Print comments about child loops within
2051 /// the loop for this basic block, with nesting.
2052 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2053 unsigned FunctionNumber) {
2054 // Add child loop information
2055 for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
2056 OS.indent((*CL)->getLoopDepth()*2)
2057 << "Child Loop BB" << FunctionNumber << "_"
2058 << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
2060 PrintChildLoopComment(OS, *CL, FunctionNumber);
2064 /// emitBasicBlockLoopComments - Pretty-print comments for basic blocks.
2065 static void emitBasicBlockLoopComments(const MachineBasicBlock &MBB,
2066 const MachineLoopInfo *LI,
2067 const AsmPrinter &AP) {
2068 // Add loop depth information
2069 const MachineLoop *Loop = LI->getLoopFor(&MBB);
2070 if (Loop == 0) return;
2072 MachineBasicBlock *Header = Loop->getHeader();
2073 assert(Header && "No header for loop");
2075 // If this block is not a loop header, just print out what is the loop header
2077 if (Header != &MBB) {
2078 AP.OutStreamer.AddComment(" in Loop: Header=BB" +
2079 Twine(AP.getFunctionNumber())+"_" +
2080 Twine(Loop->getHeader()->getNumber())+
2081 " Depth="+Twine(Loop->getLoopDepth()));
2085 // Otherwise, it is a loop header. Print out information about child and
2087 raw_ostream &OS = AP.OutStreamer.GetCommentOS();
2089 PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
2092 OS.indent(Loop->getLoopDepth()*2-2);
2097 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
2099 PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
2103 /// EmitBasicBlockStart - This method prints the label for the specified
2104 /// MachineBasicBlock, an alignment (if present) and a comment describing
2105 /// it if appropriate.
2106 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
2107 // Emit an alignment directive for this block, if needed.
2108 if (unsigned Align = MBB->getAlignment())
2109 EmitAlignment(Align);
2111 // If the block has its address taken, emit any labels that were used to
2112 // reference the block. It is possible that there is more than one label
2113 // here, because multiple LLVM BB's may have been RAUW'd to this block after
2114 // the references were generated.
2115 if (MBB->hasAddressTaken()) {
2116 const BasicBlock *BB = MBB->getBasicBlock();
2118 OutStreamer.AddComment("Block address taken");
2120 std::vector<MCSymbol*> Syms = MMI->getAddrLabelSymbolToEmit(BB);
2122 for (unsigned i = 0, e = Syms.size(); i != e; ++i)
2123 OutStreamer.EmitLabel(Syms[i]);
2126 // Print some verbose block comments.
2128 if (const BasicBlock *BB = MBB->getBasicBlock())
2130 OutStreamer.AddComment("%" + BB->getName());
2131 emitBasicBlockLoopComments(*MBB, LI, *this);
2134 // Print the main label for the block.
2135 if (MBB->pred_empty() || isBlockOnlyReachableByFallthrough(MBB)) {
2137 // NOTE: Want this comment at start of line, don't emit with AddComment.
2138 OutStreamer.emitRawComment(" BB#" + Twine(MBB->getNumber()) + ":", false);
2141 OutStreamer.EmitLabel(MBB->getSymbol());
2145 void AsmPrinter::EmitVisibility(MCSymbol *Sym, unsigned Visibility,
2146 bool IsDefinition) const {
2147 MCSymbolAttr Attr = MCSA_Invalid;
2149 switch (Visibility) {
2151 case GlobalValue::HiddenVisibility:
2153 Attr = MAI->getHiddenVisibilityAttr();
2155 Attr = MAI->getHiddenDeclarationVisibilityAttr();
2157 case GlobalValue::ProtectedVisibility:
2158 Attr = MAI->getProtectedVisibilityAttr();
2162 if (Attr != MCSA_Invalid)
2163 OutStreamer.EmitSymbolAttribute(Sym, Attr);
2166 /// isBlockOnlyReachableByFallthough - Return true if the basic block has
2167 /// exactly one predecessor and the control transfer mechanism between
2168 /// the predecessor and this block is a fall-through.
2170 isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const {
2171 // If this is a landing pad, it isn't a fall through. If it has no preds,
2172 // then nothing falls through to it.
2173 if (MBB->isLandingPad() || MBB->pred_empty())
2176 // If there isn't exactly one predecessor, it can't be a fall through.
2177 MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(), PI2 = PI;
2179 if (PI2 != MBB->pred_end())
2182 // The predecessor has to be immediately before this block.
2183 MachineBasicBlock *Pred = *PI;
2185 if (!Pred->isLayoutSuccessor(MBB))
2188 // If the block is completely empty, then it definitely does fall through.
2192 // Check the terminators in the previous blocks
2193 for (MachineBasicBlock::iterator II = Pred->getFirstTerminator(),
2194 IE = Pred->end(); II != IE; ++II) {
2195 MachineInstr &MI = *II;
2197 // If it is not a simple branch, we are in a table somewhere.
2198 if (!MI.isBranch() || MI.isIndirectBranch())
2201 // If we are the operands of one of the branches, this is not a fall
2202 // through. Note that targets with delay slots will usually bundle
2203 // terminators with the delay slot instruction.
2204 for (ConstMIBundleOperands OP(&MI); OP.isValid(); ++OP) {
2207 if (OP->isMBB() && OP->getMBB() == MBB)
2217 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
2218 if (!S->usesMetadata())
2221 gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
2222 gcp_map_type::iterator GCPI = GCMap.find(S);
2223 if (GCPI != GCMap.end())
2224 return GCPI->second;
2226 const char *Name = S->getName().c_str();
2228 for (GCMetadataPrinterRegistry::iterator
2229 I = GCMetadataPrinterRegistry::begin(),
2230 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
2231 if (strcmp(Name, I->getName()) == 0) {
2232 GCMetadataPrinter *GMP = I->instantiate();
2234 GCMap.insert(std::make_pair(S, GMP));
2238 report_fatal_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
2241 /// Pin vtable to this file.
2242 AsmPrinterHandler::~AsmPrinterHandler() {}