1 //===-- AsmPrinter.cpp - Common AsmPrinter code ---------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the AsmPrinter class.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/CodeGen/AsmPrinter.h"
15 #include "llvm/Assembly/Writer.h"
16 #include "llvm/DerivedTypes.h"
17 #include "llvm/Constants.h"
18 #include "llvm/Module.h"
19 #include "llvm/CodeGen/MachineConstantPool.h"
20 #include "llvm/CodeGen/MachineJumpTableInfo.h"
21 #include "llvm/Support/CommandLine.h"
22 #include "llvm/Support/Mangler.h"
23 #include "llvm/Support/MathExtras.h"
24 #include "llvm/Support/Streams.h"
25 #include "llvm/Target/TargetAsmInfo.h"
26 #include "llvm/Target/TargetData.h"
27 #include "llvm/Target/TargetLowering.h"
28 #include "llvm/Target/TargetMachine.h"
33 AsmVerbose("asm-verbose", cl::Hidden, cl::desc("Add comments to directives."));
35 AsmPrinter::AsmPrinter(std::ostream &o, TargetMachine &tm,
36 const TargetAsmInfo *T)
37 : FunctionNumber(0), O(o), TM(tm), TAI(T)
40 std::string AsmPrinter::getSectionForFunction(const Function &F) const {
41 return TAI->getTextSection();
45 /// SwitchToTextSection - Switch to the specified text section of the executable
46 /// if we are not already in it!
48 void AsmPrinter::SwitchToTextSection(const char *NewSection,
49 const GlobalValue *GV) {
51 if (GV && GV->hasSection())
52 NS = TAI->getSwitchToSectionDirective() + GV->getSection();
56 // If we're already in this section, we're done.
57 if (CurrentSection == NS) return;
59 // Close the current section, if applicable.
60 if (TAI->getSectionEndDirectiveSuffix() && !CurrentSection.empty())
61 O << CurrentSection << TAI->getSectionEndDirectiveSuffix() << "\n";
65 if (!CurrentSection.empty())
66 O << CurrentSection << TAI->getTextSectionStartSuffix() << '\n';
69 /// SwitchToDataSection - Switch to the specified data section of the executable
70 /// if we are not already in it!
72 void AsmPrinter::SwitchToDataSection(const char *NewSection,
73 const GlobalValue *GV) {
75 if (GV && GV->hasSection())
76 NS = TAI->getSwitchToSectionDirective() + GV->getSection();
80 // If we're already in this section, we're done.
81 if (CurrentSection == NS) return;
83 // Close the current section, if applicable.
84 if (TAI->getSectionEndDirectiveSuffix() && !CurrentSection.empty())
85 O << CurrentSection << TAI->getSectionEndDirectiveSuffix() << "\n";
89 if (!CurrentSection.empty())
90 O << CurrentSection << TAI->getDataSectionStartSuffix() << '\n';
94 bool AsmPrinter::doInitialization(Module &M) {
95 Mang = new Mangler(M, TAI->getGlobalPrefix());
97 if (!M.getModuleInlineAsm().empty())
98 O << TAI->getCommentString() << " Start of file scope inline assembly\n"
99 << M.getModuleInlineAsm()
100 << "\n" << TAI->getCommentString()
101 << " End of file scope inline assembly\n";
103 SwitchToDataSection(""); // Reset back to no section.
105 if (MachineModuleInfo *MMI = getAnalysisToUpdate<MachineModuleInfo>()) {
106 MMI->AnalyzeModule(M);
112 bool AsmPrinter::doFinalization(Module &M) {
113 if (TAI->getWeakRefDirective()) {
114 if (ExtWeakSymbols.begin() != ExtWeakSymbols.end())
115 SwitchToDataSection("");
117 for (std::set<const GlobalValue*>::iterator i = ExtWeakSymbols.begin(),
118 e = ExtWeakSymbols.end(); i != e; ++i) {
119 const GlobalValue *GV = *i;
120 std::string Name = Mang->getValueName(GV);
121 O << TAI->getWeakRefDirective() << Name << "\n";
125 delete Mang; Mang = 0;
129 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
130 // What's my mangled name?
131 CurrentFnName = Mang->getValueName(MF.getFunction());
132 IncrementFunctionNumber();
135 /// EmitConstantPool - Print to the current output stream assembly
136 /// representations of the constants in the constant pool MCP. This is
137 /// used to print out constants which have been "spilled to memory" by
138 /// the code generator.
140 void AsmPrinter::EmitConstantPool(MachineConstantPool *MCP) {
141 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
142 if (CP.empty()) return;
144 // Some targets require 4-, 8-, and 16- byte constant literals to be placed
145 // in special sections.
146 std::vector<std::pair<MachineConstantPoolEntry,unsigned> > FourByteCPs;
147 std::vector<std::pair<MachineConstantPoolEntry,unsigned> > EightByteCPs;
148 std::vector<std::pair<MachineConstantPoolEntry,unsigned> > SixteenByteCPs;
149 std::vector<std::pair<MachineConstantPoolEntry,unsigned> > OtherCPs;
150 std::vector<std::pair<MachineConstantPoolEntry,unsigned> > TargetCPs;
151 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
152 MachineConstantPoolEntry CPE = CP[i];
153 const Type *Ty = CPE.getType();
154 if (TAI->getFourByteConstantSection() &&
155 TM.getTargetData()->getTypeSize(Ty) == 4)
156 FourByteCPs.push_back(std::make_pair(CPE, i));
157 else if (TAI->getEightByteConstantSection() &&
158 TM.getTargetData()->getTypeSize(Ty) == 8)
159 EightByteCPs.push_back(std::make_pair(CPE, i));
160 else if (TAI->getSixteenByteConstantSection() &&
161 TM.getTargetData()->getTypeSize(Ty) == 16)
162 SixteenByteCPs.push_back(std::make_pair(CPE, i));
164 OtherCPs.push_back(std::make_pair(CPE, i));
167 unsigned Alignment = MCP->getConstantPoolAlignment();
168 EmitConstantPool(Alignment, TAI->getFourByteConstantSection(), FourByteCPs);
169 EmitConstantPool(Alignment, TAI->getEightByteConstantSection(), EightByteCPs);
170 EmitConstantPool(Alignment, TAI->getSixteenByteConstantSection(),
172 EmitConstantPool(Alignment, TAI->getConstantPoolSection(), OtherCPs);
175 void AsmPrinter::EmitConstantPool(unsigned Alignment, const char *Section,
176 std::vector<std::pair<MachineConstantPoolEntry,unsigned> > &CP) {
177 if (CP.empty()) return;
179 SwitchToDataSection(Section);
180 EmitAlignment(Alignment);
181 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
182 O << TAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber() << '_'
183 << CP[i].second << ":\t\t\t\t\t" << TAI->getCommentString() << " ";
184 WriteTypeSymbolic(O, CP[i].first.getType(), 0) << '\n';
185 if (CP[i].first.isMachineConstantPoolEntry())
186 EmitMachineConstantPoolValue(CP[i].first.Val.MachineCPVal);
188 EmitGlobalConstant(CP[i].first.Val.ConstVal);
190 const Type *Ty = CP[i].first.getType();
192 TM.getTargetData()->getTypeSize(Ty);
193 unsigned ValEnd = CP[i].first.getOffset() + EntSize;
194 // Emit inter-object padding for alignment.
195 EmitZeros(CP[i+1].first.getOffset()-ValEnd);
200 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
201 /// by the current function to the current output stream.
203 void AsmPrinter::EmitJumpTableInfo(MachineJumpTableInfo *MJTI,
204 MachineFunction &MF) {
205 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
206 if (JT.empty()) return;
207 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
209 // Use JumpTableDirective otherwise honor the entry size from the jump table
211 const char *JTEntryDirective = TAI->getJumpTableDirective();
212 bool HadJTEntryDirective = JTEntryDirective != NULL;
213 if (!HadJTEntryDirective) {
214 JTEntryDirective = MJTI->getEntrySize() == 4 ?
215 TAI->getData32bitsDirective() : TAI->getData64bitsDirective();
218 // Pick the directive to use to print the jump table entries, and switch to
219 // the appropriate section.
220 TargetLowering *LoweringInfo = TM.getTargetLowering();
222 const char* JumpTableDataSection = TAI->getJumpTableDataSection();
223 if ((IsPic && !(LoweringInfo && LoweringInfo->usesGlobalOffsetTable())) ||
224 !JumpTableDataSection) {
225 // In PIC mode, we need to emit the jump table to the same section as the
226 // function body itself, otherwise the label differences won't make sense.
227 // We should also do if the section name is NULL.
228 const Function *F = MF.getFunction();
229 SwitchToTextSection(getSectionForFunction(*F).c_str(), F);
231 SwitchToDataSection(JumpTableDataSection);
234 EmitAlignment(Log2_32(MJTI->getAlignment()));
236 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
237 const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
239 // If this jump table was deleted, ignore it.
240 if (JTBBs.empty()) continue;
242 // For PIC codegen, if possible we want to use the SetDirective to reduce
243 // the number of relocations the assembler will generate for the jump table.
244 // Set directives are all printed before the jump table itself.
245 std::set<MachineBasicBlock*> EmittedSets;
246 if (TAI->getSetDirective() && IsPic)
247 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
248 if (EmittedSets.insert(JTBBs[ii]).second)
249 printSetLabel(i, JTBBs[ii]);
251 // On some targets (e.g. darwin) we want to emit two consequtive labels
252 // before each jump table. The first label is never referenced, but tells
253 // the assembler and linker the extents of the jump table object. The
254 // second label is actually referenced by the code.
255 if (const char *JTLabelPrefix = TAI->getJumpTableSpecialLabelPrefix())
256 O << JTLabelPrefix << "JTI" << getFunctionNumber() << '_' << i << ":\n";
258 O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
259 << '_' << i << ":\n";
261 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
262 O << JTEntryDirective << ' ';
263 // If we have emitted set directives for the jump table entries, print
264 // them rather than the entries themselves. If we're emitting PIC, then
265 // emit the table entries as differences between two text section labels.
266 // If we're emitting non-PIC code, then emit the entries as direct
267 // references to the target basic blocks.
268 if (!EmittedSets.empty()) {
269 O << TAI->getPrivateGlobalPrefix() << getFunctionNumber()
270 << '_' << i << "_set_" << JTBBs[ii]->getNumber();
272 printBasicBlockLabel(JTBBs[ii], false, false);
273 // If the arch uses custom Jump Table directives, don't calc relative to
275 if (!HadJTEntryDirective)
276 O << '-' << TAI->getPrivateGlobalPrefix() << "JTI"
277 << getFunctionNumber() << '_' << i;
279 printBasicBlockLabel(JTBBs[ii], false, false);
286 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
287 /// special global used by LLVM. If so, emit it and return true, otherwise
288 /// do nothing and return false.
289 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
290 // Ignore debug and non-emitted data.
291 if (GV->getSection() == "llvm.metadata") return true;
293 if (!GV->hasAppendingLinkage()) return false;
295 assert(GV->hasInitializer() && "Not a special LLVM global!");
297 if (GV->getName() == "llvm.used") {
298 if (TAI->getUsedDirective() != 0) // No need to emit this at all.
299 EmitLLVMUsedList(GV->getInitializer());
303 if (GV->getName() == "llvm.global_ctors" && GV->use_empty()) {
304 SwitchToDataSection(TAI->getStaticCtorsSection());
306 EmitXXStructorList(GV->getInitializer());
310 if (GV->getName() == "llvm.global_dtors" && GV->use_empty()) {
311 SwitchToDataSection(TAI->getStaticDtorsSection());
313 EmitXXStructorList(GV->getInitializer());
320 /// EmitLLVMUsedList - For targets that define a TAI::UsedDirective, mark each
321 /// global in the specified llvm.used list as being used with this directive.
322 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
323 const char *Directive = TAI->getUsedDirective();
325 // Should be an array of 'sbyte*'.
326 ConstantArray *InitList = dyn_cast<ConstantArray>(List);
327 if (InitList == 0) return;
329 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
331 EmitConstantValueOnly(InitList->getOperand(i));
336 /// EmitXXStructorList - Emit the ctor or dtor list. This just prints out the
337 /// function pointers, ignoring the init priority.
338 void AsmPrinter::EmitXXStructorList(Constant *List) {
339 // Should be an array of '{ int, void ()* }' structs. The first value is the
340 // init priority, which we ignore.
341 if (!isa<ConstantArray>(List)) return;
342 ConstantArray *InitList = cast<ConstantArray>(List);
343 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
344 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
345 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
347 if (CS->getOperand(1)->isNullValue())
348 return; // Found a null terminator, exit printing.
349 // Emit the function pointer.
350 EmitGlobalConstant(CS->getOperand(1));
354 /// getGlobalLinkName - Returns the asm/link name of of the specified
355 /// global variable. Should be overridden by each target asm printer to
356 /// generate the appropriate value.
357 const std::string AsmPrinter::getGlobalLinkName(const GlobalVariable *GV) const{
358 std::string LinkName;
360 if (isa<Function>(GV)) {
361 LinkName += TAI->getFunctionAddrPrefix();
362 LinkName += Mang->getValueName(GV);
363 LinkName += TAI->getFunctionAddrSuffix();
365 LinkName += TAI->getGlobalVarAddrPrefix();
366 LinkName += Mang->getValueName(GV);
367 LinkName += TAI->getGlobalVarAddrSuffix();
373 /// EmitExternalGlobal - Emit the external reference to a global variable.
374 /// Should be overridden if an indirect reference should be used.
375 void AsmPrinter::EmitExternalGlobal(const GlobalVariable *GV) {
376 O << getGlobalLinkName(GV);
381 //===----------------------------------------------------------------------===//
382 /// LEB 128 number encoding.
384 /// PrintULEB128 - Print a series of hexidecimal values (separated by commas)
385 /// representing an unsigned leb128 value.
386 void AsmPrinter::PrintULEB128(unsigned Value) const {
388 unsigned Byte = Value & 0x7f;
390 if (Value) Byte |= 0x80;
391 O << "0x" << std::hex << Byte << std::dec;
392 if (Value) O << ", ";
396 /// SizeULEB128 - Compute the number of bytes required for an unsigned leb128
398 unsigned AsmPrinter::SizeULEB128(unsigned Value) {
402 Size += sizeof(int8_t);
407 /// PrintSLEB128 - Print a series of hexidecimal values (separated by commas)
408 /// representing a signed leb128 value.
409 void AsmPrinter::PrintSLEB128(int Value) const {
410 int Sign = Value >> (8 * sizeof(Value) - 1);
414 unsigned Byte = Value & 0x7f;
416 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
417 if (IsMore) Byte |= 0x80;
418 O << "0x" << std::hex << Byte << std::dec;
419 if (IsMore) O << ", ";
423 /// SizeSLEB128 - Compute the number of bytes required for a signed leb128
425 unsigned AsmPrinter::SizeSLEB128(int Value) {
427 int Sign = Value >> (8 * sizeof(Value) - 1);
431 unsigned Byte = Value & 0x7f;
433 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
434 Size += sizeof(int8_t);
439 //===--------------------------------------------------------------------===//
440 // Emission and print routines
443 /// PrintHex - Print a value as a hexidecimal value.
445 void AsmPrinter::PrintHex(int Value) const {
446 O << "0x" << std::hex << Value << std::dec;
449 /// EOL - Print a newline character to asm stream. If a comment is present
450 /// then it will be printed first. Comments should not contain '\n'.
451 void AsmPrinter::EOL() const {
454 void AsmPrinter::EOL(const std::string &Comment) const {
455 if (AsmVerbose && !Comment.empty()) {
457 << TAI->getCommentString()
464 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
465 /// unsigned leb128 value.
466 void AsmPrinter::EmitULEB128Bytes(unsigned Value) const {
467 if (TAI->hasLEB128()) {
471 O << TAI->getData8bitsDirective();
476 /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
477 /// signed leb128 value.
478 void AsmPrinter::EmitSLEB128Bytes(int Value) const {
479 if (TAI->hasLEB128()) {
483 O << TAI->getData8bitsDirective();
488 /// EmitInt8 - Emit a byte directive and value.
490 void AsmPrinter::EmitInt8(int Value) const {
491 O << TAI->getData8bitsDirective();
492 PrintHex(Value & 0xFF);
495 /// EmitInt16 - Emit a short directive and value.
497 void AsmPrinter::EmitInt16(int Value) const {
498 O << TAI->getData16bitsDirective();
499 PrintHex(Value & 0xFFFF);
502 /// EmitInt32 - Emit a long directive and value.
504 void AsmPrinter::EmitInt32(int Value) const {
505 O << TAI->getData32bitsDirective();
509 /// EmitInt64 - Emit a long long directive and value.
511 void AsmPrinter::EmitInt64(uint64_t Value) const {
512 if (TAI->getData64bitsDirective()) {
513 O << TAI->getData64bitsDirective();
516 if (TM.getTargetData()->isBigEndian()) {
517 EmitInt32(unsigned(Value >> 32)); O << "\n";
518 EmitInt32(unsigned(Value));
520 EmitInt32(unsigned(Value)); O << "\n";
521 EmitInt32(unsigned(Value >> 32));
526 /// toOctal - Convert the low order bits of X into an octal digit.
528 static inline char toOctal(int X) {
532 /// printStringChar - Print a char, escaped if necessary.
534 static void printStringChar(std::ostream &O, unsigned char C) {
537 } else if (C == '\\') {
539 } else if (isprint(C)) {
543 case '\b': O << "\\b"; break;
544 case '\f': O << "\\f"; break;
545 case '\n': O << "\\n"; break;
546 case '\r': O << "\\r"; break;
547 case '\t': O << "\\t"; break;
550 O << toOctal(C >> 6);
551 O << toOctal(C >> 3);
552 O << toOctal(C >> 0);
558 /// EmitString - Emit a string with quotes and a null terminator.
559 /// Special characters are emitted properly.
560 /// \literal (Eg. '\t') \endliteral
561 void AsmPrinter::EmitString(const std::string &String) const {
562 const char* AscizDirective = TAI->getAscizDirective();
566 O << TAI->getAsciiDirective();
568 for (unsigned i = 0, N = String.size(); i < N; ++i) {
569 unsigned char C = String[i];
570 printStringChar(O, C);
579 //===----------------------------------------------------------------------===//
581 // EmitAlignment - Emit an alignment directive to the specified power of two.
582 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV) const {
583 if (GV && GV->getAlignment())
584 NumBits = Log2_32(GV->getAlignment());
585 if (NumBits == 0) return; // No need to emit alignment.
586 if (TAI->getAlignmentIsInBytes()) NumBits = 1 << NumBits;
587 O << TAI->getAlignDirective() << NumBits << "\n";
591 /// EmitZeros - Emit a block of zeros.
593 void AsmPrinter::EmitZeros(uint64_t NumZeros) const {
595 if (TAI->getZeroDirective()) {
596 O << TAI->getZeroDirective() << NumZeros;
597 if (TAI->getZeroDirectiveSuffix())
598 O << TAI->getZeroDirectiveSuffix();
601 for (; NumZeros; --NumZeros)
602 O << TAI->getData8bitsDirective() << "0\n";
607 // Print out the specified constant, without a storage class. Only the
608 // constants valid in constant expressions can occur here.
609 void AsmPrinter::EmitConstantValueOnly(const Constant *CV) {
610 if (CV->isNullValue() || isa<UndefValue>(CV))
612 else if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
613 O << CI->getZExtValue();
614 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV)) {
615 // This is a constant address for a global variable or function. Use the
616 // name of the variable or function as the address value, possibly
617 // decorating it with GlobalVarAddrPrefix/Suffix or
618 // FunctionAddrPrefix/Suffix (these all default to "" )
619 if (isa<Function>(GV)) {
620 O << TAI->getFunctionAddrPrefix()
621 << Mang->getValueName(GV)
622 << TAI->getFunctionAddrSuffix();
624 O << TAI->getGlobalVarAddrPrefix()
625 << Mang->getValueName(GV)
626 << TAI->getGlobalVarAddrSuffix();
628 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
629 const TargetData *TD = TM.getTargetData();
630 unsigned Opcode = CE->getOpcode();
632 case Instruction::GetElementPtr: {
633 // generate a symbolic expression for the byte address
634 const Constant *ptrVal = CE->getOperand(0);
635 SmallVector<Value*, 8> idxVec(CE->op_begin()+1, CE->op_end());
636 if (int64_t Offset = TD->getIndexedOffset(ptrVal->getType(), &idxVec[0],
640 EmitConstantValueOnly(ptrVal);
642 O << ") + " << Offset;
644 O << ") - " << -Offset;
646 EmitConstantValueOnly(ptrVal);
650 case Instruction::Trunc:
651 case Instruction::ZExt:
652 case Instruction::SExt:
653 case Instruction::FPTrunc:
654 case Instruction::FPExt:
655 case Instruction::UIToFP:
656 case Instruction::SIToFP:
657 case Instruction::FPToUI:
658 case Instruction::FPToSI:
659 assert(0 && "FIXME: Don't yet support this kind of constant cast expr");
661 case Instruction::BitCast:
662 return EmitConstantValueOnly(CE->getOperand(0));
664 case Instruction::IntToPtr: {
665 // Handle casts to pointers by changing them into casts to the appropriate
666 // integer type. This promotes constant folding and simplifies this code.
667 Constant *Op = CE->getOperand(0);
668 Op = ConstantExpr::getIntegerCast(Op, TD->getIntPtrType(), false/*ZExt*/);
669 return EmitConstantValueOnly(Op);
673 case Instruction::PtrToInt: {
674 // Support only foldable casts to/from pointers that can be eliminated by
675 // changing the pointer to the appropriately sized integer type.
676 Constant *Op = CE->getOperand(0);
677 const Type *Ty = CE->getType();
679 // We can emit the pointer value into this slot if the slot is an
680 // integer slot greater or equal to the size of the pointer.
681 if (Ty->isInteger() &&
682 TD->getTypeSize(Ty) >= TD->getTypeSize(Op->getType()))
683 return EmitConstantValueOnly(Op);
685 assert(0 && "FIXME: Don't yet support this kind of constant cast expr");
686 EmitConstantValueOnly(Op);
689 case Instruction::Add:
690 case Instruction::Sub:
692 EmitConstantValueOnly(CE->getOperand(0));
693 O << (Opcode==Instruction::Add ? ") + (" : ") - (");
694 EmitConstantValueOnly(CE->getOperand(1));
698 assert(0 && "Unsupported operator!");
701 assert(0 && "Unknown constant value!");
705 /// printAsCString - Print the specified array as a C compatible string, only if
706 /// the predicate isString is true.
708 static void printAsCString(std::ostream &O, const ConstantArray *CVA,
710 assert(CVA->isString() && "Array is not string compatible!");
713 for (unsigned i = 0; i != LastElt; ++i) {
715 (unsigned char)cast<ConstantInt>(CVA->getOperand(i))->getZExtValue();
716 printStringChar(O, C);
721 /// EmitString - Emit a zero-byte-terminated string constant.
723 void AsmPrinter::EmitString(const ConstantArray *CVA) const {
724 unsigned NumElts = CVA->getNumOperands();
725 if (TAI->getAscizDirective() && NumElts &&
726 cast<ConstantInt>(CVA->getOperand(NumElts-1))->getZExtValue() == 0) {
727 O << TAI->getAscizDirective();
728 printAsCString(O, CVA, NumElts-1);
730 O << TAI->getAsciiDirective();
731 printAsCString(O, CVA, NumElts);
736 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
738 void AsmPrinter::EmitGlobalConstant(const Constant *CV) {
739 const TargetData *TD = TM.getTargetData();
741 if (CV->isNullValue() || isa<UndefValue>(CV)) {
742 EmitZeros(TD->getTypeSize(CV->getType()));
744 } else if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
745 if (CVA->isString()) {
747 } else { // Not a string. Print the values in successive locations
748 for (unsigned i = 0, e = CVA->getNumOperands(); i != e; ++i)
749 EmitGlobalConstant(CVA->getOperand(i));
752 } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
753 // Print the fields in successive locations. Pad to align if needed!
754 const StructLayout *cvsLayout = TD->getStructLayout(CVS->getType());
755 uint64_t sizeSoFar = 0;
756 for (unsigned i = 0, e = CVS->getNumOperands(); i != e; ++i) {
757 const Constant* field = CVS->getOperand(i);
759 // Check if padding is needed and insert one or more 0s.
760 uint64_t fieldSize = TD->getTypeSize(field->getType());
761 uint64_t padSize = ((i == e-1? cvsLayout->getSizeInBytes()
762 : cvsLayout->getElementOffset(i+1))
763 - cvsLayout->getElementOffset(i)) - fieldSize;
764 sizeSoFar += fieldSize + padSize;
766 // Now print the actual field value
767 EmitGlobalConstant(field);
769 // Insert the field padding unless it's zero bytes...
772 assert(sizeSoFar == cvsLayout->getSizeInBytes() &&
773 "Layout of constant struct may be incorrect!");
775 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
776 // FP Constants are printed as integer constants to avoid losing
778 double Val = CFP->getValue();
779 if (CFP->getType() == Type::DoubleTy) {
780 if (TAI->getData64bitsDirective())
781 O << TAI->getData64bitsDirective() << DoubleToBits(Val) << "\t"
782 << TAI->getCommentString() << " double value: " << Val << "\n";
783 else if (TD->isBigEndian()) {
784 O << TAI->getData32bitsDirective() << unsigned(DoubleToBits(Val) >> 32)
785 << "\t" << TAI->getCommentString()
786 << " double most significant word " << Val << "\n";
787 O << TAI->getData32bitsDirective() << unsigned(DoubleToBits(Val))
788 << "\t" << TAI->getCommentString()
789 << " double least significant word " << Val << "\n";
791 O << TAI->getData32bitsDirective() << unsigned(DoubleToBits(Val))
792 << "\t" << TAI->getCommentString()
793 << " double least significant word " << Val << "\n";
794 O << TAI->getData32bitsDirective() << unsigned(DoubleToBits(Val) >> 32)
795 << "\t" << TAI->getCommentString()
796 << " double most significant word " << Val << "\n";
800 O << TAI->getData32bitsDirective() << FloatToBits(Val)
801 << "\t" << TAI->getCommentString() << " float " << Val << "\n";
804 } else if (CV->getType() == Type::Int64Ty) {
805 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
806 uint64_t Val = CI->getZExtValue();
808 if (TAI->getData64bitsDirective())
809 O << TAI->getData64bitsDirective() << Val << "\n";
810 else if (TD->isBigEndian()) {
811 O << TAI->getData32bitsDirective() << unsigned(Val >> 32)
812 << "\t" << TAI->getCommentString()
813 << " Double-word most significant word " << Val << "\n";
814 O << TAI->getData32bitsDirective() << unsigned(Val)
815 << "\t" << TAI->getCommentString()
816 << " Double-word least significant word " << Val << "\n";
818 O << TAI->getData32bitsDirective() << unsigned(Val)
819 << "\t" << TAI->getCommentString()
820 << " Double-word least significant word " << Val << "\n";
821 O << TAI->getData32bitsDirective() << unsigned(Val >> 32)
822 << "\t" << TAI->getCommentString()
823 << " Double-word most significant word " << Val << "\n";
827 } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
828 const VectorType *PTy = CP->getType();
830 for (unsigned I = 0, E = PTy->getNumElements(); I < E; ++I)
831 EmitGlobalConstant(CP->getOperand(I));
836 const Type *type = CV->getType();
837 printDataDirective(type);
838 EmitConstantValueOnly(CV);
843 AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
844 // Target doesn't support this yet!
848 /// PrintSpecial - Print information related to the specified machine instr
849 /// that is independent of the operand, and may be independent of the instr
850 /// itself. This can be useful for portably encoding the comment character
851 /// or other bits of target-specific knowledge into the asmstrings. The
852 /// syntax used is ${:comment}. Targets can override this to add support
853 /// for their own strange codes.
854 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) {
855 if (!strcmp(Code, "private")) {
856 O << TAI->getPrivateGlobalPrefix();
857 } else if (!strcmp(Code, "comment")) {
858 O << TAI->getCommentString();
859 } else if (!strcmp(Code, "uid")) {
860 // Assign a unique ID to this machine instruction.
861 static const MachineInstr *LastMI = 0;
862 static const Function *F = 0;
863 static unsigned Counter = 0U-1;
865 // Comparing the address of MI isn't sufficient, because machineinstrs may
866 // be allocated to the same address across functions.
867 const Function *ThisF = MI->getParent()->getParent()->getFunction();
869 // If this is a new machine instruction, bump the counter.
870 if (LastMI != MI || F != ThisF) {
877 cerr << "Unknown special formatter '" << Code
878 << "' for machine instr: " << *MI;
884 /// printInlineAsm - This method formats and prints the specified machine
885 /// instruction that is an inline asm.
886 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
887 unsigned NumOperands = MI->getNumOperands();
889 // Count the number of register definitions.
890 unsigned NumDefs = 0;
891 for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
893 assert(NumDefs != NumOperands-1 && "No asm string?");
895 assert(MI->getOperand(NumDefs).isExternalSymbol() && "No asm string?");
897 // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
898 const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
900 // If this asmstr is empty, don't bother printing the #APP/#NOAPP markers.
901 if (AsmStr[0] == 0) {
902 O << "\n"; // Tab already printed, avoid double indenting next instr.
906 O << TAI->getInlineAsmStart() << "\n\t";
908 // The variant of the current asmprinter.
909 int AsmPrinterVariant = TAI->getAssemblerDialect();
911 int CurVariant = -1; // The number of the {.|.|.} region we are in.
912 const char *LastEmitted = AsmStr; // One past the last character emitted.
914 while (*LastEmitted) {
915 switch (*LastEmitted) {
917 // Not a special case, emit the string section literally.
918 const char *LiteralEnd = LastEmitted+1;
919 while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
920 *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
922 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
923 O.write(LastEmitted, LiteralEnd-LastEmitted);
924 LastEmitted = LiteralEnd;
928 ++LastEmitted; // Consume newline character.
929 O << "\n\t"; // Indent code with newline.
932 ++LastEmitted; // Consume '$' character.
936 switch (*LastEmitted) {
937 default: Done = false; break;
939 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
941 ++LastEmitted; // Consume second '$' character.
943 case '(': // $( -> same as GCC's { character.
944 ++LastEmitted; // Consume '(' character.
945 if (CurVariant != -1) {
946 cerr << "Nested variants found in inline asm string: '"
950 CurVariant = 0; // We're in the first variant now.
953 ++LastEmitted; // consume '|' character.
954 if (CurVariant == -1) {
955 cerr << "Found '|' character outside of variant in inline asm "
956 << "string: '" << AsmStr << "'\n";
959 ++CurVariant; // We're in the next variant.
961 case ')': // $) -> same as GCC's } char.
962 ++LastEmitted; // consume ')' character.
963 if (CurVariant == -1) {
964 cerr << "Found '}' character outside of variant in inline asm "
965 << "string: '" << AsmStr << "'\n";
973 bool HasCurlyBraces = false;
974 if (*LastEmitted == '{') { // ${variable}
975 ++LastEmitted; // Consume '{' character.
976 HasCurlyBraces = true;
979 const char *IDStart = LastEmitted;
982 long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
983 if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
984 cerr << "Bad $ operand number in inline asm string: '"
990 char Modifier[2] = { 0, 0 };
992 if (HasCurlyBraces) {
993 // If we have curly braces, check for a modifier character. This
994 // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
995 if (*LastEmitted == ':') {
996 ++LastEmitted; // Consume ':' character.
997 if (*LastEmitted == 0) {
998 cerr << "Bad ${:} expression in inline asm string: '"
1003 Modifier[0] = *LastEmitted;
1004 ++LastEmitted; // Consume modifier character.
1007 if (*LastEmitted != '}') {
1008 cerr << "Bad ${} expression in inline asm string: '"
1012 ++LastEmitted; // Consume '}' character.
1015 if ((unsigned)Val >= NumOperands-1) {
1016 cerr << "Invalid $ operand number in inline asm string: '"
1021 // Okay, we finally have a value number. Ask the target to print this
1023 if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1028 // Scan to find the machine operand number for the operand.
1029 for (; Val; --Val) {
1030 if (OpNo >= MI->getNumOperands()) break;
1031 unsigned OpFlags = MI->getOperand(OpNo).getImmedValue();
1032 OpNo += (OpFlags >> 3) + 1;
1035 if (OpNo >= MI->getNumOperands()) {
1038 unsigned OpFlags = MI->getOperand(OpNo).getImmedValue();
1039 ++OpNo; // Skip over the ID number.
1041 AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1042 if ((OpFlags & 7) == 4 /*ADDR MODE*/) {
1043 Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1044 Modifier[0] ? Modifier : 0);
1046 Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1047 Modifier[0] ? Modifier : 0);
1051 cerr << "Invalid operand found in inline asm: '"
1061 O << "\n\t" << TAI->getInlineAsmEnd() << "\n";
1064 /// printLabel - This method prints a local label used by debug and
1065 /// exception handling tables.
1066 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1068 << TAI->getPrivateGlobalPrefix()
1070 << MI->getOperand(0).getImmedValue()
1074 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1075 /// instruction, using the specified assembler variant. Targets should
1076 /// overried this to format as appropriate.
1077 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1078 unsigned AsmVariant, const char *ExtraCode) {
1079 // Target doesn't support this yet!
1083 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1084 unsigned AsmVariant,
1085 const char *ExtraCode) {
1086 // Target doesn't support this yet!
1090 /// printBasicBlockLabel - This method prints the label for the specified
1091 /// MachineBasicBlock
1092 void AsmPrinter::printBasicBlockLabel(const MachineBasicBlock *MBB,
1094 bool printComment) const {
1095 O << TAI->getPrivateGlobalPrefix() << "BB" << FunctionNumber << "_"
1096 << MBB->getNumber();
1099 if (printComment && MBB->getBasicBlock())
1100 O << '\t' << TAI->getCommentString() << MBB->getBasicBlock()->getName();
1103 /// printSetLabel - This method prints a set label for the specified
1104 /// MachineBasicBlock
1105 void AsmPrinter::printSetLabel(unsigned uid,
1106 const MachineBasicBlock *MBB) const {
1107 if (!TAI->getSetDirective())
1110 O << TAI->getSetDirective() << ' ' << TAI->getPrivateGlobalPrefix()
1111 << getFunctionNumber() << '_' << uid << "_set_" << MBB->getNumber() << ',';
1112 printBasicBlockLabel(MBB, false, false);
1113 O << '-' << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
1114 << '_' << uid << '\n';
1117 void AsmPrinter::printSetLabel(unsigned uid, unsigned uid2,
1118 const MachineBasicBlock *MBB) const {
1119 if (!TAI->getSetDirective())
1122 O << TAI->getSetDirective() << ' ' << TAI->getPrivateGlobalPrefix()
1123 << getFunctionNumber() << '_' << uid << '_' << uid2
1124 << "_set_" << MBB->getNumber() << ',';
1125 printBasicBlockLabel(MBB, false, false);
1126 O << '-' << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
1127 << '_' << uid << '_' << uid2 << '\n';
1130 /// printDataDirective - This method prints the asm directive for the
1132 void AsmPrinter::printDataDirective(const Type *type) {
1133 const TargetData *TD = TM.getTargetData();
1134 switch (type->getTypeID()) {
1135 case Type::IntegerTyID: {
1136 unsigned BitWidth = cast<IntegerType>(type)->getBitWidth();
1138 O << TAI->getData8bitsDirective();
1139 else if (BitWidth <= 16)
1140 O << TAI->getData16bitsDirective();
1141 else if (BitWidth <= 32)
1142 O << TAI->getData32bitsDirective();
1143 else if (BitWidth <= 64) {
1144 assert(TAI->getData64bitsDirective() &&
1145 "Target cannot handle 64-bit constant exprs!");
1146 O << TAI->getData64bitsDirective();
1150 case Type::PointerTyID:
1151 if (TD->getPointerSize() == 8) {
1152 assert(TAI->getData64bitsDirective() &&
1153 "Target cannot handle 64-bit pointer exprs!");
1154 O << TAI->getData64bitsDirective();
1156 O << TAI->getData32bitsDirective();
1159 case Type::FloatTyID: case Type::DoubleTyID:
1160 assert (0 && "Should have already output floating point constant.");
1162 assert (0 && "Can't handle printing this type of thing");