1266179a2cdbb238838fcd54245909c8c6e5c34f
[oota-llvm.git] / lib / CodeGen / AsmPrinter.cpp
1 //===-- AsmPrinter.cpp - Common AsmPrinter code ---------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
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.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the AsmPrinter class.
11 //
12 //===----------------------------------------------------------------------===//
13
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"
29 #include <cerrno>
30 using namespace llvm;
31
32 static cl::opt<bool>
33 AsmVerbose("asm-verbose", cl::Hidden, cl::desc("Add comments to directives."));
34
35 AsmPrinter::AsmPrinter(std::ostream &o, TargetMachine &tm,
36                        const TargetAsmInfo *T)
37 : FunctionNumber(0), O(o), TM(tm), TAI(T)
38 {}
39
40 std::string AsmPrinter::getSectionForFunction(const Function &F) const {
41   return TAI->getTextSection();
42 }
43
44
45 /// SwitchToTextSection - Switch to the specified text section of the executable
46 /// if we are not already in it!
47 ///
48 void AsmPrinter::SwitchToTextSection(const char *NewSection,
49                                      const GlobalValue *GV) {
50   std::string NS;
51   if (GV && GV->hasSection())
52     NS = TAI->getSwitchToSectionDirective() + GV->getSection();
53   else
54     NS = NewSection;
55   
56   // If we're already in this section, we're done.
57   if (CurrentSection == NS) return;
58
59   // Close the current section, if applicable.
60   if (TAI->getSectionEndDirectiveSuffix() && !CurrentSection.empty())
61     O << CurrentSection << TAI->getSectionEndDirectiveSuffix() << "\n";
62
63   CurrentSection = NS;
64
65   if (!CurrentSection.empty())
66     O << CurrentSection << TAI->getTextSectionStartSuffix() << '\n';
67 }
68
69 /// SwitchToDataSection - Switch to the specified data section of the executable
70 /// if we are not already in it!
71 ///
72 void AsmPrinter::SwitchToDataSection(const char *NewSection,
73                                      const GlobalValue *GV) {
74   std::string NS;
75   if (GV && GV->hasSection())
76     NS = TAI->getSwitchToSectionDirective() + GV->getSection();
77   else
78     NS = NewSection;
79   
80   // If we're already in this section, we're done.
81   if (CurrentSection == NS) return;
82
83   // Close the current section, if applicable.
84   if (TAI->getSectionEndDirectiveSuffix() && !CurrentSection.empty())
85     O << CurrentSection << TAI->getSectionEndDirectiveSuffix() << "\n";
86
87   CurrentSection = NS;
88   
89   if (!CurrentSection.empty())
90     O << CurrentSection << TAI->getDataSectionStartSuffix() << '\n';
91 }
92
93
94 bool AsmPrinter::doInitialization(Module &M) {
95   Mang = new Mangler(M, TAI->getGlobalPrefix());
96   
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";
102
103   SwitchToDataSection("");   // Reset back to no section.
104   
105   if (MachineModuleInfo *MMI = getAnalysisToUpdate<MachineModuleInfo>()) {
106     MMI->AnalyzeModule(M);
107   }
108   
109   return false;
110 }
111
112 bool AsmPrinter::doFinalization(Module &M) {
113   if (TAI->getWeakRefDirective()) {
114     if (ExtWeakSymbols.begin() != ExtWeakSymbols.end())
115       SwitchToDataSection("");
116
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";
122     }
123   }
124
125   delete Mang; Mang = 0;
126   return false;
127 }
128
129 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
130   // What's my mangled name?
131   CurrentFnName = Mang->getValueName(MF.getFunction());
132   IncrementFunctionNumber();
133 }
134
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.
139 ///
140 void AsmPrinter::EmitConstantPool(MachineConstantPool *MCP) {
141   const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
142   if (CP.empty()) return;
143
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));
163     else
164       OtherCPs.push_back(std::make_pair(CPE, i));
165   }
166
167   unsigned Alignment = MCP->getConstantPoolAlignment();
168   EmitConstantPool(Alignment, TAI->getFourByteConstantSection(), FourByteCPs);
169   EmitConstantPool(Alignment, TAI->getEightByteConstantSection(), EightByteCPs);
170   EmitConstantPool(Alignment, TAI->getSixteenByteConstantSection(),
171                    SixteenByteCPs);
172   EmitConstantPool(Alignment, TAI->getConstantPoolSection(), OtherCPs);
173 }
174
175 void AsmPrinter::EmitConstantPool(unsigned Alignment, const char *Section,
176                std::vector<std::pair<MachineConstantPoolEntry,unsigned> > &CP) {
177   if (CP.empty()) return;
178
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);
187      else
188       EmitGlobalConstant(CP[i].first.Val.ConstVal);
189     if (i != e-1) {
190       const Type *Ty = CP[i].first.getType();
191       unsigned EntSize =
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);
196     }
197   }
198 }
199
200 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
201 /// by the current function to the current output stream.  
202 ///
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_;
208   
209   // Use JumpTableDirective otherwise honor the entry size from the jump table
210   // info.
211   const char *JTEntryDirective = TAI->getJumpTableDirective();
212   bool HadJTEntryDirective = JTEntryDirective != NULL;
213   if (!HadJTEntryDirective) {
214     JTEntryDirective = MJTI->getEntrySize() == 4 ?
215       TAI->getData32bitsDirective() : TAI->getData64bitsDirective();
216   }
217   
218   // Pick the directive to use to print the jump table entries, and switch to 
219   // the appropriate section.
220   TargetLowering *LoweringInfo = TM.getTargetLowering();
221
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);
230   } else {
231     SwitchToDataSection(JumpTableDataSection);
232   }
233   
234   EmitAlignment(Log2_32(MJTI->getAlignment()));
235   
236   for (unsigned i = 0, e = JT.size(); i != e; ++i) {
237     const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
238     
239     // If this jump table was deleted, ignore it. 
240     if (JTBBs.empty()) continue;
241
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]);
250     
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";
257     
258     O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber() 
259       << '_' << i << ":\n";
260     
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();
271       } else if (IsPic) {
272         printBasicBlockLabel(JTBBs[ii], false, false);
273         // If the arch uses custom Jump Table directives, don't calc relative to
274         // JT
275         if (!HadJTEntryDirective) 
276           O << '-' << TAI->getPrivateGlobalPrefix() << "JTI"
277             << getFunctionNumber() << '_' << i;
278       } else {
279         printBasicBlockLabel(JTBBs[ii], false, false);
280       }
281       O << '\n';
282     }
283   }
284 }
285
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;
292   
293   if (!GV->hasAppendingLinkage()) return false;
294
295   assert(GV->hasInitializer() && "Not a special LLVM global!");
296   
297   if (GV->getName() == "llvm.used") {
298     if (TAI->getUsedDirective() != 0)    // No need to emit this at all.
299       EmitLLVMUsedList(GV->getInitializer());
300     return true;
301   }
302
303   if (GV->getName() == "llvm.global_ctors" && GV->use_empty()) {
304     SwitchToDataSection(TAI->getStaticCtorsSection());
305     EmitAlignment(2, 0);
306     EmitXXStructorList(GV->getInitializer());
307     return true;
308   } 
309   
310   if (GV->getName() == "llvm.global_dtors" && GV->use_empty()) {
311     SwitchToDataSection(TAI->getStaticDtorsSection());
312     EmitAlignment(2, 0);
313     EmitXXStructorList(GV->getInitializer());
314     return true;
315   }
316   
317   return false;
318 }
319
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();
324
325   // Should be an array of 'sbyte*'.
326   ConstantArray *InitList = dyn_cast<ConstantArray>(List);
327   if (InitList == 0) return;
328   
329   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
330     O << Directive;
331     EmitConstantValueOnly(InitList->getOperand(i));
332     O << "\n";
333   }
334 }
335
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.
346
347       if (CS->getOperand(1)->isNullValue())
348         return;  // Found a null terminator, exit printing.
349       // Emit the function pointer.
350       EmitGlobalConstant(CS->getOperand(1));
351     }
352 }
353
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;
359   
360   if (isa<Function>(GV)) {
361     LinkName += TAI->getFunctionAddrPrefix();
362     LinkName += Mang->getValueName(GV);
363     LinkName += TAI->getFunctionAddrSuffix();
364   } else {
365     LinkName += TAI->getGlobalVarAddrPrefix();
366     LinkName += Mang->getValueName(GV);
367     LinkName += TAI->getGlobalVarAddrSuffix();
368   }  
369   
370   return LinkName;
371 }
372
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);
377 }
378
379
380
381 //===----------------------------------------------------------------------===//
382 /// LEB 128 number encoding.
383
384 /// PrintULEB128 - Print a series of hexidecimal values (separated by commas)
385 /// representing an unsigned leb128 value.
386 void AsmPrinter::PrintULEB128(unsigned Value) const {
387   do {
388     unsigned Byte = Value & 0x7f;
389     Value >>= 7;
390     if (Value) Byte |= 0x80;
391     O << "0x" << std::hex << Byte << std::dec;
392     if (Value) O << ", ";
393   } while (Value);
394 }
395
396 /// SizeULEB128 - Compute the number of bytes required for an unsigned leb128
397 /// value.
398 unsigned AsmPrinter::SizeULEB128(unsigned Value) {
399   unsigned Size = 0;
400   do {
401     Value >>= 7;
402     Size += sizeof(int8_t);
403   } while (Value);
404   return Size;
405 }
406
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);
411   bool IsMore;
412   
413   do {
414     unsigned Byte = Value & 0x7f;
415     Value >>= 7;
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 << ", ";
420   } while (IsMore);
421 }
422
423 /// SizeSLEB128 - Compute the number of bytes required for a signed leb128
424 /// value.
425 unsigned AsmPrinter::SizeSLEB128(int Value) {
426   unsigned Size = 0;
427   int Sign = Value >> (8 * sizeof(Value) - 1);
428   bool IsMore;
429   
430   do {
431     unsigned Byte = Value & 0x7f;
432     Value >>= 7;
433     IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
434     Size += sizeof(int8_t);
435   } while (IsMore);
436   return Size;
437 }
438
439 //===--------------------------------------------------------------------===//
440 // Emission and print routines
441 //
442
443 /// PrintHex - Print a value as a hexidecimal value.
444 ///
445 void AsmPrinter::PrintHex(int Value) const { 
446   O << "0x" << std::hex << Value << std::dec;
447 }
448
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 {
452   O << "\n";
453 }
454 void AsmPrinter::EOL(const std::string &Comment) const {
455   if (AsmVerbose && !Comment.empty()) {
456     O << "\t"
457       << TAI->getCommentString()
458       << " "
459       << Comment;
460   }
461   O << "\n";
462 }
463
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()) {
468     O << "\t.uleb128\t"
469       << Value;
470   } else {
471     O << TAI->getData8bitsDirective();
472     PrintULEB128(Value);
473   }
474 }
475
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()) {
480     O << "\t.sleb128\t"
481       << Value;
482   } else {
483     O << TAI->getData8bitsDirective();
484     PrintSLEB128(Value);
485   }
486 }
487
488 /// EmitInt8 - Emit a byte directive and value.
489 ///
490 void AsmPrinter::EmitInt8(int Value) const {
491   O << TAI->getData8bitsDirective();
492   PrintHex(Value & 0xFF);
493 }
494
495 /// EmitInt16 - Emit a short directive and value.
496 ///
497 void AsmPrinter::EmitInt16(int Value) const {
498   O << TAI->getData16bitsDirective();
499   PrintHex(Value & 0xFFFF);
500 }
501
502 /// EmitInt32 - Emit a long directive and value.
503 ///
504 void AsmPrinter::EmitInt32(int Value) const {
505   O << TAI->getData32bitsDirective();
506   PrintHex(Value);
507 }
508
509 /// EmitInt64 - Emit a long long directive and value.
510 ///
511 void AsmPrinter::EmitInt64(uint64_t Value) const {
512   if (TAI->getData64bitsDirective()) {
513     O << TAI->getData64bitsDirective();
514     PrintHex(Value);
515   } else {
516     if (TM.getTargetData()->isBigEndian()) {
517       EmitInt32(unsigned(Value >> 32)); O << "\n";
518       EmitInt32(unsigned(Value));
519     } else {
520       EmitInt32(unsigned(Value)); O << "\n";
521       EmitInt32(unsigned(Value >> 32));
522     }
523   }
524 }
525
526 /// toOctal - Convert the low order bits of X into an octal digit.
527 ///
528 static inline char toOctal(int X) {
529   return (X&7)+'0';
530 }
531
532 /// printStringChar - Print a char, escaped if necessary.
533 ///
534 static void printStringChar(std::ostream &O, unsigned char C) {
535   if (C == '"') {
536     O << "\\\"";
537   } else if (C == '\\') {
538     O << "\\\\";
539   } else if (isprint(C)) {
540     O << C;
541   } else {
542     switch(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;
548     default:
549       O << '\\';
550       O << toOctal(C >> 6);
551       O << toOctal(C >> 3);
552       O << toOctal(C >> 0);
553       break;
554     }
555   }
556 }
557
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();
563   if (AscizDirective)
564     O << AscizDirective;
565   else
566     O << TAI->getAsciiDirective();
567   O << "\"";
568   for (unsigned i = 0, N = String.size(); i < N; ++i) {
569     unsigned char C = String[i];
570     printStringChar(O, C);
571   }
572   if (AscizDirective)
573     O << "\"";
574   else
575     O << "\\0\"";
576 }
577
578
579 //===----------------------------------------------------------------------===//
580
581 // EmitAlignment - Emit an alignment directive to the specified power of two.
582 // Use the maximum of the specified alignment and the alignment from the
583 // specified GlobalValue (if any).
584 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV) const {
585   if (GV && GV->getAlignment() && Log2_32(GV->getAlignment()) > NumBits)
586     NumBits = Log2_32(GV->getAlignment());
587   if (NumBits == 0) return;   // No need to emit alignment.
588   if (TAI->getAlignmentIsInBytes()) NumBits = 1 << NumBits;
589   O << TAI->getAlignDirective() << NumBits << "\n";
590 }
591
592     
593 /// EmitZeros - Emit a block of zeros.
594 ///
595 void AsmPrinter::EmitZeros(uint64_t NumZeros) const {
596   if (NumZeros) {
597     if (TAI->getZeroDirective()) {
598       O << TAI->getZeroDirective() << NumZeros;
599       if (TAI->getZeroDirectiveSuffix())
600         O << TAI->getZeroDirectiveSuffix();
601       O << "\n";
602     } else {
603       for (; NumZeros; --NumZeros)
604         O << TAI->getData8bitsDirective() << "0\n";
605     }
606   }
607 }
608
609 // Print out the specified constant, without a storage class.  Only the
610 // constants valid in constant expressions can occur here.
611 void AsmPrinter::EmitConstantValueOnly(const Constant *CV) {
612   if (CV->isNullValue() || isa<UndefValue>(CV))
613     O << "0";
614   else if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
615     O << CI->getZExtValue();
616   } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV)) {
617     // This is a constant address for a global variable or function. Use the
618     // name of the variable or function as the address value, possibly
619     // decorating it with GlobalVarAddrPrefix/Suffix or
620     // FunctionAddrPrefix/Suffix (these all default to "" )
621     if (isa<Function>(GV)) {
622       O << TAI->getFunctionAddrPrefix()
623         << Mang->getValueName(GV)
624         << TAI->getFunctionAddrSuffix();
625     } else {
626       O << TAI->getGlobalVarAddrPrefix()
627         << Mang->getValueName(GV)
628         << TAI->getGlobalVarAddrSuffix();
629     }
630   } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
631     const TargetData *TD = TM.getTargetData();
632     unsigned Opcode = CE->getOpcode();    
633     switch (Opcode) {
634     case Instruction::GetElementPtr: {
635       // generate a symbolic expression for the byte address
636       const Constant *ptrVal = CE->getOperand(0);
637       SmallVector<Value*, 8> idxVec(CE->op_begin()+1, CE->op_end());
638       if (int64_t Offset = TD->getIndexedOffset(ptrVal->getType(), &idxVec[0],
639                                                 idxVec.size())) {
640         if (Offset)
641           O << "(";
642         EmitConstantValueOnly(ptrVal);
643         if (Offset > 0)
644           O << ") + " << Offset;
645         else if (Offset < 0)
646           O << ") - " << -Offset;
647       } else {
648         EmitConstantValueOnly(ptrVal);
649       }
650       break;
651     }
652     case Instruction::Trunc:
653     case Instruction::ZExt:
654     case Instruction::SExt:
655     case Instruction::FPTrunc:
656     case Instruction::FPExt:
657     case Instruction::UIToFP:
658     case Instruction::SIToFP:
659     case Instruction::FPToUI:
660     case Instruction::FPToSI:
661       assert(0 && "FIXME: Don't yet support this kind of constant cast expr");
662       break;
663     case Instruction::BitCast:
664       return EmitConstantValueOnly(CE->getOperand(0));
665
666     case Instruction::IntToPtr: {
667       // Handle casts to pointers by changing them into casts to the appropriate
668       // integer type.  This promotes constant folding and simplifies this code.
669       Constant *Op = CE->getOperand(0);
670       Op = ConstantExpr::getIntegerCast(Op, TD->getIntPtrType(), false/*ZExt*/);
671       return EmitConstantValueOnly(Op);
672     }
673       
674       
675     case Instruction::PtrToInt: {
676       // Support only foldable casts to/from pointers that can be eliminated by
677       // changing the pointer to the appropriately sized integer type.
678       Constant *Op = CE->getOperand(0);
679       const Type *Ty = CE->getType();
680
681       // We can emit the pointer value into this slot if the slot is an
682       // integer slot greater or equal to the size of the pointer.
683       if (Ty->isInteger() &&
684           TD->getTypeSize(Ty) >= TD->getTypeSize(Op->getType()))
685         return EmitConstantValueOnly(Op);
686       
687       assert(0 && "FIXME: Don't yet support this kind of constant cast expr");
688       EmitConstantValueOnly(Op);
689       break;
690     }
691     case Instruction::Add:
692     case Instruction::Sub:
693       O << "(";
694       EmitConstantValueOnly(CE->getOperand(0));
695       O << (Opcode==Instruction::Add ? ") + (" : ") - (");
696       EmitConstantValueOnly(CE->getOperand(1));
697       O << ")";
698       break;
699     default:
700       assert(0 && "Unsupported operator!");
701     }
702   } else {
703     assert(0 && "Unknown constant value!");
704   }
705 }
706
707 /// printAsCString - Print the specified array as a C compatible string, only if
708 /// the predicate isString is true.
709 ///
710 static void printAsCString(std::ostream &O, const ConstantArray *CVA,
711                            unsigned LastElt) {
712   assert(CVA->isString() && "Array is not string compatible!");
713
714   O << "\"";
715   for (unsigned i = 0; i != LastElt; ++i) {
716     unsigned char C =
717         (unsigned char)cast<ConstantInt>(CVA->getOperand(i))->getZExtValue();
718     printStringChar(O, C);
719   }
720   O << "\"";
721 }
722
723 /// EmitString - Emit a zero-byte-terminated string constant.
724 ///
725 void AsmPrinter::EmitString(const ConstantArray *CVA) const {
726   unsigned NumElts = CVA->getNumOperands();
727   if (TAI->getAscizDirective() && NumElts && 
728       cast<ConstantInt>(CVA->getOperand(NumElts-1))->getZExtValue() == 0) {
729     O << TAI->getAscizDirective();
730     printAsCString(O, CVA, NumElts-1);
731   } else {
732     O << TAI->getAsciiDirective();
733     printAsCString(O, CVA, NumElts);
734   }
735   O << "\n";
736 }
737
738 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
739 ///
740 void AsmPrinter::EmitGlobalConstant(const Constant *CV) {
741   const TargetData *TD = TM.getTargetData();
742
743   if (CV->isNullValue() || isa<UndefValue>(CV)) {
744     EmitZeros(TD->getTypeSize(CV->getType()));
745     return;
746   } else if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
747     if (CVA->isString()) {
748       EmitString(CVA);
749     } else { // Not a string.  Print the values in successive locations
750       for (unsigned i = 0, e = CVA->getNumOperands(); i != e; ++i)
751         EmitGlobalConstant(CVA->getOperand(i));
752     }
753     return;
754   } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
755     // Print the fields in successive locations. Pad to align if needed!
756     const StructLayout *cvsLayout = TD->getStructLayout(CVS->getType());
757     uint64_t sizeSoFar = 0;
758     for (unsigned i = 0, e = CVS->getNumOperands(); i != e; ++i) {
759       const Constant* field = CVS->getOperand(i);
760
761       // Check if padding is needed and insert one or more 0s.
762       uint64_t fieldSize = TD->getTypeSize(field->getType());
763       uint64_t padSize = ((i == e-1? cvsLayout->getSizeInBytes()
764                            : cvsLayout->getElementOffset(i+1))
765                           - cvsLayout->getElementOffset(i)) - fieldSize;
766       sizeSoFar += fieldSize + padSize;
767
768       // Now print the actual field value
769       EmitGlobalConstant(field);
770
771       // Insert the field padding unless it's zero bytes...
772       EmitZeros(padSize);
773     }
774     assert(sizeSoFar == cvsLayout->getSizeInBytes() &&
775            "Layout of constant struct may be incorrect!");
776     return;
777   } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
778     // FP Constants are printed as integer constants to avoid losing
779     // precision...
780     double Val = CFP->getValue();
781     if (CFP->getType() == Type::DoubleTy) {
782       if (TAI->getData64bitsDirective())
783         O << TAI->getData64bitsDirective() << DoubleToBits(Val) << "\t"
784           << TAI->getCommentString() << " double value: " << Val << "\n";
785       else if (TD->isBigEndian()) {
786         O << TAI->getData32bitsDirective() << unsigned(DoubleToBits(Val) >> 32)
787           << "\t" << TAI->getCommentString()
788           << " double most significant word " << Val << "\n";
789         O << TAI->getData32bitsDirective() << unsigned(DoubleToBits(Val))
790           << "\t" << TAI->getCommentString()
791           << " double least significant word " << Val << "\n";
792       } else {
793         O << TAI->getData32bitsDirective() << unsigned(DoubleToBits(Val))
794           << "\t" << TAI->getCommentString()
795           << " double least significant word " << Val << "\n";
796         O << TAI->getData32bitsDirective() << unsigned(DoubleToBits(Val) >> 32)
797           << "\t" << TAI->getCommentString()
798           << " double most significant word " << Val << "\n";
799       }
800       return;
801     } else {
802       O << TAI->getData32bitsDirective() << FloatToBits(Val)
803         << "\t" << TAI->getCommentString() << " float " << Val << "\n";
804       return;
805     }
806   } else if (CV->getType() == Type::Int64Ty) {
807     if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
808       uint64_t Val = CI->getZExtValue();
809
810       if (TAI->getData64bitsDirective())
811         O << TAI->getData64bitsDirective() << Val << "\n";
812       else if (TD->isBigEndian()) {
813         O << TAI->getData32bitsDirective() << unsigned(Val >> 32)
814           << "\t" << TAI->getCommentString()
815           << " Double-word most significant word " << Val << "\n";
816         O << TAI->getData32bitsDirective() << unsigned(Val)
817           << "\t" << TAI->getCommentString()
818           << " Double-word least significant word " << Val << "\n";
819       } else {
820         O << TAI->getData32bitsDirective() << unsigned(Val)
821           << "\t" << TAI->getCommentString()
822           << " Double-word least significant word " << Val << "\n";
823         O << TAI->getData32bitsDirective() << unsigned(Val >> 32)
824           << "\t" << TAI->getCommentString()
825           << " Double-word most significant word " << Val << "\n";
826       }
827       return;
828     }
829   } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
830     const VectorType *PTy = CP->getType();
831     
832     for (unsigned I = 0, E = PTy->getNumElements(); I < E; ++I)
833       EmitGlobalConstant(CP->getOperand(I));
834     
835     return;
836   }
837
838   const Type *type = CV->getType();
839   printDataDirective(type);
840   EmitConstantValueOnly(CV);
841   O << "\n";
842 }
843
844 void
845 AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
846   // Target doesn't support this yet!
847   abort();
848 }
849
850 /// PrintSpecial - Print information related to the specified machine instr
851 /// that is independent of the operand, and may be independent of the instr
852 /// itself.  This can be useful for portably encoding the comment character
853 /// or other bits of target-specific knowledge into the asmstrings.  The
854 /// syntax used is ${:comment}.  Targets can override this to add support
855 /// for their own strange codes.
856 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) {
857   if (!strcmp(Code, "private")) {
858     O << TAI->getPrivateGlobalPrefix();
859   } else if (!strcmp(Code, "comment")) {
860     O << TAI->getCommentString();
861   } else if (!strcmp(Code, "uid")) {
862     // Assign a unique ID to this machine instruction.
863     static const MachineInstr *LastMI = 0;
864     static const Function *F = 0;
865     static unsigned Counter = 0U-1;
866
867     // Comparing the address of MI isn't sufficient, because machineinstrs may
868     // be allocated to the same address across functions.
869     const Function *ThisF = MI->getParent()->getParent()->getFunction();
870     
871     // If this is a new machine instruction, bump the counter.
872     if (LastMI != MI || F != ThisF) {
873       ++Counter;
874       LastMI = MI;
875       F = ThisF;
876     }
877     O << Counter;
878   } else {
879     cerr << "Unknown special formatter '" << Code
880          << "' for machine instr: " << *MI;
881     exit(1);
882   }    
883 }
884
885
886 /// printInlineAsm - This method formats and prints the specified machine
887 /// instruction that is an inline asm.
888 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
889   unsigned NumOperands = MI->getNumOperands();
890   
891   // Count the number of register definitions.
892   unsigned NumDefs = 0;
893   for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
894        ++NumDefs)
895     assert(NumDefs != NumOperands-1 && "No asm string?");
896   
897   assert(MI->getOperand(NumDefs).isExternalSymbol() && "No asm string?");
898
899   // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
900   const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
901
902   // If this asmstr is empty, don't bother printing the #APP/#NOAPP markers.
903   if (AsmStr[0] == 0) {
904     O << "\n";  // Tab already printed, avoid double indenting next instr.
905     return;
906   }
907   
908   O << TAI->getInlineAsmStart() << "\n\t";
909
910   // The variant of the current asmprinter.
911   int AsmPrinterVariant = TAI->getAssemblerDialect();
912
913   int CurVariant = -1;            // The number of the {.|.|.} region we are in.
914   const char *LastEmitted = AsmStr; // One past the last character emitted.
915   
916   while (*LastEmitted) {
917     switch (*LastEmitted) {
918     default: {
919       // Not a special case, emit the string section literally.
920       const char *LiteralEnd = LastEmitted+1;
921       while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
922              *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
923         ++LiteralEnd;
924       if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
925         O.write(LastEmitted, LiteralEnd-LastEmitted);
926       LastEmitted = LiteralEnd;
927       break;
928     }
929     case '\n':
930       ++LastEmitted;   // Consume newline character.
931       O << "\n\t";     // Indent code with newline.
932       break;
933     case '$': {
934       ++LastEmitted;   // Consume '$' character.
935       bool Done = true;
936
937       // Handle escapes.
938       switch (*LastEmitted) {
939       default: Done = false; break;
940       case '$':     // $$ -> $
941         if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
942           O << '$';
943         ++LastEmitted;  // Consume second '$' character.
944         break;
945       case '(':             // $( -> same as GCC's { character.
946         ++LastEmitted;      // Consume '(' character.
947         if (CurVariant != -1) {
948           cerr << "Nested variants found in inline asm string: '"
949                << AsmStr << "'\n";
950           exit(1);
951         }
952         CurVariant = 0;     // We're in the first variant now.
953         break;
954       case '|':
955         ++LastEmitted;  // consume '|' character.
956         if (CurVariant == -1) {
957           cerr << "Found '|' character outside of variant in inline asm "
958                << "string: '" << AsmStr << "'\n";
959           exit(1);
960         }
961         ++CurVariant;   // We're in the next variant.
962         break;
963       case ')':         // $) -> same as GCC's } char.
964         ++LastEmitted;  // consume ')' character.
965         if (CurVariant == -1) {
966           cerr << "Found '}' character outside of variant in inline asm "
967                << "string: '" << AsmStr << "'\n";
968           exit(1);
969         }
970         CurVariant = -1;
971         break;
972       }
973       if (Done) break;
974       
975       bool HasCurlyBraces = false;
976       if (*LastEmitted == '{') {     // ${variable}
977         ++LastEmitted;               // Consume '{' character.
978         HasCurlyBraces = true;
979       }
980       
981       const char *IDStart = LastEmitted;
982       char *IDEnd;
983       errno = 0;
984       long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
985       if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
986         cerr << "Bad $ operand number in inline asm string: '" 
987              << AsmStr << "'\n";
988         exit(1);
989       }
990       LastEmitted = IDEnd;
991       
992       char Modifier[2] = { 0, 0 };
993       
994       if (HasCurlyBraces) {
995         // If we have curly braces, check for a modifier character.  This
996         // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
997         if (*LastEmitted == ':') {
998           ++LastEmitted;    // Consume ':' character.
999           if (*LastEmitted == 0) {
1000             cerr << "Bad ${:} expression in inline asm string: '" 
1001                  << AsmStr << "'\n";
1002             exit(1);
1003           }
1004           
1005           Modifier[0] = *LastEmitted;
1006           ++LastEmitted;    // Consume modifier character.
1007         }
1008         
1009         if (*LastEmitted != '}') {
1010           cerr << "Bad ${} expression in inline asm string: '" 
1011                << AsmStr << "'\n";
1012           exit(1);
1013         }
1014         ++LastEmitted;    // Consume '}' character.
1015       }
1016       
1017       if ((unsigned)Val >= NumOperands-1) {
1018         cerr << "Invalid $ operand number in inline asm string: '" 
1019              << AsmStr << "'\n";
1020         exit(1);
1021       }
1022       
1023       // Okay, we finally have a value number.  Ask the target to print this
1024       // operand!
1025       if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1026         unsigned OpNo = 1;
1027
1028         bool Error = false;
1029
1030         // Scan to find the machine operand number for the operand.
1031         for (; Val; --Val) {
1032           if (OpNo >= MI->getNumOperands()) break;
1033           unsigned OpFlags = MI->getOperand(OpNo).getImmedValue();
1034           OpNo += (OpFlags >> 3) + 1;
1035         }
1036
1037         if (OpNo >= MI->getNumOperands()) {
1038           Error = true;
1039         } else {
1040           unsigned OpFlags = MI->getOperand(OpNo).getImmedValue();
1041           ++OpNo;  // Skip over the ID number.
1042
1043           AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1044           if ((OpFlags & 7) == 4 /*ADDR MODE*/) {
1045             Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1046                                               Modifier[0] ? Modifier : 0);
1047           } else {
1048             Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1049                                         Modifier[0] ? Modifier : 0);
1050           }
1051         }
1052         if (Error) {
1053           cerr << "Invalid operand found in inline asm: '"
1054                << AsmStr << "'\n";
1055           MI->dump();
1056           exit(1);
1057         }
1058       }
1059       break;
1060     }
1061     }
1062   }
1063   O << "\n\t" << TAI->getInlineAsmEnd() << "\n";
1064 }
1065
1066 /// printLabel - This method prints a local label used by debug and
1067 /// exception handling tables.
1068 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1069   O << "\n"
1070     << TAI->getPrivateGlobalPrefix()
1071     << "label"
1072     << MI->getOperand(0).getImmedValue()
1073     << ":\n";
1074 }
1075
1076 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1077 /// instruction, using the specified assembler variant.  Targets should
1078 /// overried this to format as appropriate.
1079 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1080                                  unsigned AsmVariant, const char *ExtraCode) {
1081   // Target doesn't support this yet!
1082   return true;
1083 }
1084
1085 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1086                                        unsigned AsmVariant,
1087                                        const char *ExtraCode) {
1088   // Target doesn't support this yet!
1089   return true;
1090 }
1091
1092 /// printBasicBlockLabel - This method prints the label for the specified
1093 /// MachineBasicBlock
1094 void AsmPrinter::printBasicBlockLabel(const MachineBasicBlock *MBB,
1095                                       bool printColon,
1096                                       bool printComment) const {
1097   O << TAI->getPrivateGlobalPrefix() << "BB" << FunctionNumber << "_"
1098     << MBB->getNumber();
1099   if (printColon)
1100     O << ':';
1101   if (printComment && MBB->getBasicBlock())
1102     O << '\t' << TAI->getCommentString() << MBB->getBasicBlock()->getName();
1103 }
1104
1105 /// printSetLabel - This method prints a set label for the specified
1106 /// MachineBasicBlock
1107 void AsmPrinter::printSetLabel(unsigned uid, 
1108                                const MachineBasicBlock *MBB) const {
1109   if (!TAI->getSetDirective())
1110     return;
1111   
1112   O << TAI->getSetDirective() << ' ' << TAI->getPrivateGlobalPrefix()
1113     << getFunctionNumber() << '_' << uid << "_set_" << MBB->getNumber() << ',';
1114   printBasicBlockLabel(MBB, false, false);
1115   O << '-' << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber() 
1116     << '_' << uid << '\n';
1117 }
1118
1119 void AsmPrinter::printSetLabel(unsigned uid, unsigned uid2,
1120                                const MachineBasicBlock *MBB) const {
1121   if (!TAI->getSetDirective())
1122     return;
1123   
1124   O << TAI->getSetDirective() << ' ' << TAI->getPrivateGlobalPrefix()
1125     << getFunctionNumber() << '_' << uid << '_' << uid2
1126     << "_set_" << MBB->getNumber() << ',';
1127   printBasicBlockLabel(MBB, false, false);
1128   O << '-' << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber() 
1129     << '_' << uid << '_' << uid2 << '\n';
1130 }
1131
1132 /// printDataDirective - This method prints the asm directive for the
1133 /// specified type.
1134 void AsmPrinter::printDataDirective(const Type *type) {
1135   const TargetData *TD = TM.getTargetData();
1136   switch (type->getTypeID()) {
1137   case Type::IntegerTyID: {
1138     unsigned BitWidth = cast<IntegerType>(type)->getBitWidth();
1139     if (BitWidth <= 8)
1140       O << TAI->getData8bitsDirective();
1141     else if (BitWidth <= 16)
1142       O << TAI->getData16bitsDirective();
1143     else if (BitWidth <= 32)
1144       O << TAI->getData32bitsDirective();
1145     else if (BitWidth <= 64) {
1146       assert(TAI->getData64bitsDirective() &&
1147              "Target cannot handle 64-bit constant exprs!");
1148       O << TAI->getData64bitsDirective();
1149     }
1150     break;
1151   }
1152   case Type::PointerTyID:
1153     if (TD->getPointerSize() == 8) {
1154       assert(TAI->getData64bitsDirective() &&
1155              "Target cannot handle 64-bit pointer exprs!");
1156       O << TAI->getData64bitsDirective();
1157     } else {
1158       O << TAI->getData32bitsDirective();
1159     }
1160     break;
1161   case Type::FloatTyID: case Type::DoubleTyID:
1162     assert (0 && "Should have already output floating point constant.");
1163   default:
1164     assert (0 && "Can't handle printing this type of thing");
1165     break;
1166   }
1167 }
1168