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