blob: 9f00fb2bff26f759046c926c251cfc68aa092b97 [file] [log] [blame]
Chris Lattnera80ba712004-08-16 23:15:22 +00001//===-- 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
Evan Cheng932f0222006-03-03 02:04:29 +000014#include "llvm/CodeGen/AsmPrinter.h"
Evan Cheng246ae0d2006-03-01 22:18:09 +000015#include "llvm/Assembly/Writer.h"
Nate Begeman8cfa57b2005-12-06 06:18:55 +000016#include "llvm/DerivedTypes.h"
Chris Lattnera80ba712004-08-16 23:15:22 +000017#include "llvm/Constants.h"
Chris Lattner450de392005-11-10 18:36:17 +000018#include "llvm/Module.h"
Chris Lattner3b4fd322005-11-21 08:25:09 +000019#include "llvm/CodeGen/MachineConstantPool.h"
Nate Begeman37efe672006-04-22 18:53:45 +000020#include "llvm/CodeGen/MachineJumpTableInfo.h"
Chris Lattnera80ba712004-08-16 23:15:22 +000021#include "llvm/Support/Mangler.h"
Jim Laskeycb6682f2005-08-17 19:34:49 +000022#include "llvm/Support/MathExtras.h"
Owen Anderson07000c62006-05-12 06:33:49 +000023#include "llvm/Target/TargetData.h"
Chris Lattnera80ba712004-08-16 23:15:22 +000024#include "llvm/Target/TargetMachine.h"
Duraid Madina2e096c12005-12-28 06:29:02 +000025#include <iostream>
Chris Lattner66099132006-02-01 22:41:11 +000026#include <cerrno>
Chris Lattnera80ba712004-08-16 23:15:22 +000027using namespace llvm;
28
Chris Lattnered138932005-12-13 06:32:10 +000029AsmPrinter::AsmPrinter(std::ostream &o, TargetMachine &tm)
30: FunctionNumber(0), O(o), TM(tm),
31 CommentString("#"),
32 GlobalPrefix(""),
33 PrivateGlobalPrefix("."),
34 GlobalVarAddrPrefix(""),
35 GlobalVarAddrSuffix(""),
36 FunctionAddrPrefix(""),
37 FunctionAddrSuffix(""),
Chris Lattner1c059972006-05-05 21:47:05 +000038 InlineAsmStart("#APP"),
39 InlineAsmEnd("#NO_APP"),
Chris Lattnered138932005-12-13 06:32:10 +000040 ZeroDirective("\t.zero\t"),
Jeff Cohenc6a057b2006-05-02 03:46:13 +000041 ZeroDirectiveSuffix(0),
Chris Lattnered138932005-12-13 06:32:10 +000042 AsciiDirective("\t.ascii\t"),
43 AscizDirective("\t.asciz\t"),
44 Data8bitsDirective("\t.byte\t"),
45 Data16bitsDirective("\t.short\t"),
46 Data32bitsDirective("\t.long\t"),
47 Data64bitsDirective("\t.quad\t"),
48 AlignDirective("\t.align\t"),
49 AlignmentIsInBytes(true),
50 SwitchToSectionDirective("\t.section\t"),
Chris Lattner7faec9b2006-05-09 05:33:48 +000051 TextSectionStartSuffix(""),
52 DataSectionStartSuffix(""),
53 SectionEndDirectiveSuffix(0),
Chris Lattnered138932005-12-13 06:32:10 +000054 ConstantPoolSection("\t.section .rodata\n"),
Nate Begeman37efe672006-04-22 18:53:45 +000055 JumpTableSection("\t.section .rodata\n"),
Chris Lattnered138932005-12-13 06:32:10 +000056 StaticCtorsSection("\t.section .ctors,\"aw\",@progbits"),
57 StaticDtorsSection("\t.section .dtors,\"aw\",@progbits"),
58 LCOMMDirective(0),
59 COMMDirective("\t.comm\t"),
60 COMMDirectiveTakesAlignment(true),
61 HasDotTypeDotSizeDirective(true) {
62}
63
64
Chris Lattner4632d7a2006-05-09 04:59:56 +000065/// SwitchToTextSection - Switch to the specified text section of the executable
66/// if we are not already in it!
Chris Lattnerac28fbd2005-11-21 07:06:27 +000067///
Chris Lattner4632d7a2006-05-09 04:59:56 +000068void AsmPrinter::SwitchToTextSection(const char *NewSection,
69 const GlobalValue *GV) {
Chris Lattnerac28fbd2005-11-21 07:06:27 +000070 std::string NS;
Chris Lattnera7090ae2006-05-09 05:24:50 +000071 if (GV && GV->hasSection())
Chris Lattnerc8d37c62006-05-09 16:41:59 +000072 NS = SwitchToSectionDirective + GV->getSection();
Chris Lattnera7090ae2006-05-09 05:24:50 +000073 else
74 NS = NewSection;
75
76 // If we're already in this section, we're done.
77 if (CurrentSection == NS) return;
Jeff Cohen51b776d2006-05-02 03:58:45 +000078
Chris Lattner7faec9b2006-05-09 05:33:48 +000079 // Close the current section, if applicable.
80 if (SectionEndDirectiveSuffix && !CurrentSection.empty())
81 O << CurrentSection << SectionEndDirectiveSuffix << "\n";
Jeff Cohen51b776d2006-05-02 03:58:45 +000082
Chris Lattner7faec9b2006-05-09 05:33:48 +000083 CurrentSection = NS;
84
85 if (!CurrentSection.empty())
86 O << CurrentSection << TextSectionStartSuffix << '\n';
Chris Lattnerac28fbd2005-11-21 07:06:27 +000087}
88
Chris Lattner4632d7a2006-05-09 04:59:56 +000089/// SwitchToTextSection - Switch to the specified text section of the executable
90/// if we are not already in it!
91///
92void AsmPrinter::SwitchToDataSection(const char *NewSection,
93 const GlobalValue *GV) {
94 std::string NS;
Chris Lattnerb81cb612006-05-09 05:23:12 +000095 if (GV && GV->hasSection())
96 NS = SwitchToSectionDirective + GV->getSection();
97 else
98 NS = NewSection;
Chris Lattner4632d7a2006-05-09 04:59:56 +000099
Chris Lattnerb81cb612006-05-09 05:23:12 +0000100 // If we're already in this section, we're done.
101 if (CurrentSection == NS) return;
102
Chris Lattner7faec9b2006-05-09 05:33:48 +0000103 // Close the current section, if applicable.
104 if (SectionEndDirectiveSuffix && !CurrentSection.empty())
105 O << CurrentSection << SectionEndDirectiveSuffix << "\n";
106
107 CurrentSection = NS;
Chris Lattner4632d7a2006-05-09 04:59:56 +0000108
Chris Lattner7faec9b2006-05-09 05:33:48 +0000109 if (!CurrentSection.empty())
110 O << CurrentSection << DataSectionStartSuffix << '\n';
Chris Lattner4632d7a2006-05-09 04:59:56 +0000111}
112
113
Chris Lattnera80ba712004-08-16 23:15:22 +0000114bool AsmPrinter::doInitialization(Module &M) {
Chris Lattneraf2bf0a2004-08-17 06:06:19 +0000115 Mang = new Mangler(M, GlobalPrefix);
Chris Lattner2c1b1592006-01-23 23:47:53 +0000116
Chris Lattner3e2fa7a2006-01-24 04:16:34 +0000117 if (!M.getModuleInlineAsm().empty())
118 O << CommentString << " Start of file scope inline assembly\n"
119 << M.getModuleInlineAsm()
120 << "\n" << CommentString << " End of file scope inline assembly\n";
Chris Lattner2c1b1592006-01-23 23:47:53 +0000121
Chris Lattner4632d7a2006-05-09 04:59:56 +0000122 SwitchToDataSection("", 0); // Reset back to no section.
Jim Laskeyb3e789a2006-01-26 20:21:46 +0000123
124 if (MachineDebugInfo *DebugInfo = getAnalysisToUpdate<MachineDebugInfo>()) {
125 DebugInfo->AnalyzeModule(M);
126 }
127
Chris Lattnera80ba712004-08-16 23:15:22 +0000128 return false;
129}
130
131bool AsmPrinter::doFinalization(Module &M) {
132 delete Mang; Mang = 0;
133 return false;
134}
135
Chris Lattner25045bd2005-11-21 07:51:36 +0000136void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
Chris Lattnera80ba712004-08-16 23:15:22 +0000137 // What's my mangled name?
Chris Lattner450de392005-11-10 18:36:17 +0000138 CurrentFnName = Mang->getValueName(MF.getFunction());
Chris Lattner77bc2282005-11-21 08:13:27 +0000139 IncrementFunctionNumber();
Chris Lattnera80ba712004-08-16 23:15:22 +0000140}
141
Chris Lattner3b4fd322005-11-21 08:25:09 +0000142/// EmitConstantPool - Print to the current output stream assembly
143/// representations of the constants in the constant pool MCP. This is
144/// used to print out constants which have been "spilled to memory" by
145/// the code generator.
146///
147void AsmPrinter::EmitConstantPool(MachineConstantPool *MCP) {
Chris Lattnerfa77d432006-02-09 04:22:52 +0000148 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
Chris Lattner3b4fd322005-11-21 08:25:09 +0000149 if (CP.empty()) return;
Chris Lattner3b4fd322005-11-21 08:25:09 +0000150
Chris Lattner4632d7a2006-05-09 04:59:56 +0000151 SwitchToDataSection(ConstantPoolSection, 0);
Chris Lattner3029f922006-02-09 04:46:04 +0000152 EmitAlignment(MCP->getConstantPoolAlignment());
Chris Lattner3b4fd322005-11-21 08:25:09 +0000153 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
Chris Lattner3b4fd322005-11-21 08:25:09 +0000154 O << PrivateGlobalPrefix << "CPI" << getFunctionNumber() << '_' << i
Evan Cheng246ae0d2006-03-01 22:18:09 +0000155 << ":\t\t\t\t\t" << CommentString << " ";
156 WriteTypeSymbolic(O, CP[i].Val->getType(), 0) << '\n';
Chris Lattnerfa77d432006-02-09 04:22:52 +0000157 EmitGlobalConstant(CP[i].Val);
Chris Lattner3029f922006-02-09 04:46:04 +0000158 if (i != e-1) {
Owen Andersona69571c2006-05-03 01:29:57 +0000159 unsigned EntSize = TM.getTargetData()->getTypeSize(CP[i].Val->getType());
Chris Lattner3029f922006-02-09 04:46:04 +0000160 unsigned ValEnd = CP[i].Offset + EntSize;
161 // Emit inter-object padding for alignment.
162 EmitZeros(CP[i+1].Offset-ValEnd);
163 }
Chris Lattner3b4fd322005-11-21 08:25:09 +0000164 }
165}
166
Nate Begeman37efe672006-04-22 18:53:45 +0000167/// EmitJumpTableInfo - Print assembly representations of the jump tables used
168/// by the current function to the current output stream.
169///
170void AsmPrinter::EmitJumpTableInfo(MachineJumpTableInfo *MJTI) {
171 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
172 if (JT.empty()) return;
Owen Andersona69571c2006-05-03 01:29:57 +0000173 const TargetData *TD = TM.getTargetData();
Nate Begeman37efe672006-04-22 18:53:45 +0000174
175 // FIXME: someday we need to handle PIC jump tables
176 assert((TM.getRelocationModel() == Reloc::Static ||
177 TM.getRelocationModel() == Reloc::DynamicNoPIC) &&
178 "Unhandled relocation model emitting jump table information!");
179
Chris Lattner4632d7a2006-05-09 04:59:56 +0000180 SwitchToDataSection(JumpTableSection, 0);
Owen Andersona69571c2006-05-03 01:29:57 +0000181 EmitAlignment(Log2_32(TD->getPointerAlignment()));
Nate Begeman37efe672006-04-22 18:53:45 +0000182 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
183 O << PrivateGlobalPrefix << "JTI" << getFunctionNumber() << '_' << i
184 << ":\n";
185 const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
186 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
187 O << Data32bitsDirective << ' ';
188 printBasicBlockLabel(JTBBs[ii]);
189 O << '\n';
190 }
191 }
192}
193
Chris Lattnered138932005-12-13 06:32:10 +0000194/// EmitSpecialLLVMGlobal - Check to see if the specified global is a
195/// special global used by LLVM. If so, emit it and return true, otherwise
196/// do nothing and return false.
197bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
Jim Laskey78098112006-03-07 22:00:35 +0000198 // Ignore debug and non-emitted data.
199 if (GV->getSection() == "llvm.metadata") return true;
200
201 if (!GV->hasAppendingLinkage()) return false;
202
203 assert(GV->hasInitializer() && "Not a special LLVM global!");
Chris Lattnered138932005-12-13 06:32:10 +0000204
205 if (GV->getName() == "llvm.used")
206 return true; // No need to emit this at all.
207
Chris Lattner5166b822006-01-12 19:17:23 +0000208 if (GV->getName() == "llvm.global_ctors" && GV->use_empty()) {
Chris Lattner4632d7a2006-05-09 04:59:56 +0000209 SwitchToDataSection(StaticCtorsSection, 0);
Chris Lattnered138932005-12-13 06:32:10 +0000210 EmitAlignment(2, 0);
211 EmitXXStructorList(GV->getInitializer());
212 return true;
213 }
214
Chris Lattner5166b822006-01-12 19:17:23 +0000215 if (GV->getName() == "llvm.global_dtors" && GV->use_empty()) {
Chris Lattner4632d7a2006-05-09 04:59:56 +0000216 SwitchToDataSection(StaticDtorsSection, 0);
Chris Lattnered138932005-12-13 06:32:10 +0000217 EmitAlignment(2, 0);
218 EmitXXStructorList(GV->getInitializer());
219 return true;
220 }
221
222 return false;
223}
224
225/// EmitXXStructorList - Emit the ctor or dtor list. This just prints out the
226/// function pointers, ignoring the init priority.
227void AsmPrinter::EmitXXStructorList(Constant *List) {
228 // Should be an array of '{ int, void ()* }' structs. The first value is the
229 // init priority, which we ignore.
230 if (!isa<ConstantArray>(List)) return;
231 ConstantArray *InitList = cast<ConstantArray>(List);
232 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
233 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
234 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
Chris Lattner8de324b2005-12-21 01:17:37 +0000235
236 if (CS->getOperand(1)->isNullValue())
237 return; // Found a null terminator, exit printing.
238 // Emit the function pointer.
Chris Lattnered138932005-12-13 06:32:10 +0000239 EmitGlobalConstant(CS->getOperand(1));
240 }
241}
Chris Lattner3b4fd322005-11-21 08:25:09 +0000242
Chris Lattner4d57e0c2006-02-05 01:29:18 +0000243/// getPreferredAlignmentLog - Return the preferred alignment of the
244/// specified global, returned in log form. This includes an explicitly
245/// requested alignment (if the global has one).
246unsigned AsmPrinter::getPreferredAlignmentLog(const GlobalVariable *GV) const {
Jim Laskey35f8c202006-06-15 13:10:58 +0000247 const Type *ElemType = GV->getType()->getElementType();
248 unsigned Alignment = TM.getTargetData()->getTypeAlignmentShift(ElemType);
Chris Lattner4d57e0c2006-02-05 01:29:18 +0000249 if (GV->getAlignment() > (1U << Alignment))
250 Alignment = Log2_32(GV->getAlignment());
251
Chris Lattner519ea2a2006-02-05 01:46:49 +0000252 if (GV->hasInitializer()) {
Jim Laskeyd5a932b2006-06-15 19:37:14 +0000253 // Always round up alignment of global doubles to 8 bytes.
254 if (GV->getType()->getElementType() == Type::DoubleTy && Alignment < 3)
255 Alignment = 3;
Chris Lattner519ea2a2006-02-05 01:46:49 +0000256 if (Alignment < 4) {
257 // If the global is not external, see if it is large. If so, give it a
258 // larger alignment.
Jim Laskey35f8c202006-06-15 13:10:58 +0000259 if (TM.getTargetData()->getTypeSize(ElemType) > 128)
Chris Lattner519ea2a2006-02-05 01:46:49 +0000260 Alignment = 4; // 16-byte alignment.
261 }
Chris Lattner4d57e0c2006-02-05 01:29:18 +0000262 }
263 return Alignment;
264}
Chris Lattner3b4fd322005-11-21 08:25:09 +0000265
Chris Lattner25045bd2005-11-21 07:51:36 +0000266// EmitAlignment - Emit an alignment directive to the specified power of two.
267void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV) const {
Chris Lattnera1ab72d2005-11-14 19:00:06 +0000268 if (GV && GV->getAlignment())
269 NumBits = Log2_32(GV->getAlignment());
Chris Lattner2a21c6e2005-11-10 18:09:27 +0000270 if (NumBits == 0) return; // No need to emit alignment.
Chris Lattnerbfddc202004-08-17 19:14:29 +0000271 if (AlignmentIsInBytes) NumBits = 1 << NumBits;
272 O << AlignDirective << NumBits << "\n";
273}
274
Chris Lattner25045bd2005-11-21 07:51:36 +0000275/// EmitZeros - Emit a block of zeros.
Chris Lattner7d057a32004-08-17 21:38:40 +0000276///
Chris Lattner25045bd2005-11-21 07:51:36 +0000277void AsmPrinter::EmitZeros(uint64_t NumZeros) const {
Chris Lattner7d057a32004-08-17 21:38:40 +0000278 if (NumZeros) {
Jeff Cohenc6a057b2006-05-02 03:46:13 +0000279 if (ZeroDirective) {
280 O << ZeroDirective << NumZeros;
281 if (ZeroDirectiveSuffix)
282 O << ZeroDirectiveSuffix;
283 O << "\n";
284 } else {
Chris Lattner7d057a32004-08-17 21:38:40 +0000285 for (; NumZeros; --NumZeros)
286 O << Data8bitsDirective << "0\n";
287 }
288 }
289}
290
Chris Lattnera80ba712004-08-16 23:15:22 +0000291// Print out the specified constant, without a storage class. Only the
292// constants valid in constant expressions can occur here.
Chris Lattner25045bd2005-11-21 07:51:36 +0000293void AsmPrinter::EmitConstantValueOnly(const Constant *CV) {
Chris Lattnerbd1d3822004-10-16 18:19:26 +0000294 if (CV->isNullValue() || isa<UndefValue>(CV))
Chris Lattnera80ba712004-08-16 23:15:22 +0000295 O << "0";
296 else if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
297 assert(CB == ConstantBool::True);
298 O << "1";
299 } else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV))
300 if (((CI->getValue() << 32) >> 32) == CI->getValue())
301 O << CI->getValue();
302 else
Duraid Madina45606572005-05-15 13:05:48 +0000303 O << (uint64_t)CI->getValue();
Chris Lattnera80ba712004-08-16 23:15:22 +0000304 else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV))
305 O << CI->getValue();
Chris Lattner450de392005-11-10 18:36:17 +0000306 else if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV)) {
Duraid Madina855a5192005-04-02 12:21:51 +0000307 // This is a constant address for a global variable or function. Use the
308 // name of the variable or function as the address value, possibly
309 // decorating it with GlobalVarAddrPrefix/Suffix or
310 // FunctionAddrPrefix/Suffix (these all default to "" )
Chris Lattner450de392005-11-10 18:36:17 +0000311 if (isa<Function>(GV))
312 O << FunctionAddrPrefix << Mang->getValueName(GV) << FunctionAddrSuffix;
Duraid Madina855a5192005-04-02 12:21:51 +0000313 else
Chris Lattner450de392005-11-10 18:36:17 +0000314 O << GlobalVarAddrPrefix << Mang->getValueName(GV) << GlobalVarAddrSuffix;
Duraid Madina855a5192005-04-02 12:21:51 +0000315 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
Owen Andersona69571c2006-05-03 01:29:57 +0000316 const TargetData *TD = TM.getTargetData();
Chris Lattnera80ba712004-08-16 23:15:22 +0000317 switch(CE->getOpcode()) {
318 case Instruction::GetElementPtr: {
319 // generate a symbolic expression for the byte address
320 const Constant *ptrVal = CE->getOperand(0);
321 std::vector<Value*> idxVec(CE->op_begin()+1, CE->op_end());
Owen Andersona69571c2006-05-03 01:29:57 +0000322 if (int64_t Offset = TD->getIndexedOffset(ptrVal->getType(), idxVec)) {
Chris Lattner27e19212005-02-14 21:40:26 +0000323 if (Offset)
324 O << "(";
Chris Lattner25045bd2005-11-21 07:51:36 +0000325 EmitConstantValueOnly(ptrVal);
Chris Lattner27e19212005-02-14 21:40:26 +0000326 if (Offset > 0)
327 O << ") + " << Offset;
328 else if (Offset < 0)
329 O << ") - " << -Offset;
Chris Lattnera80ba712004-08-16 23:15:22 +0000330 } else {
Chris Lattner25045bd2005-11-21 07:51:36 +0000331 EmitConstantValueOnly(ptrVal);
Chris Lattnera80ba712004-08-16 23:15:22 +0000332 }
333 break;
334 }
335 case Instruction::Cast: {
336 // Support only non-converting or widening casts for now, that is, ones
337 // that do not involve a change in value. This assertion is really gross,
338 // and may not even be a complete check.
339 Constant *Op = CE->getOperand(0);
340 const Type *OpTy = Op->getType(), *Ty = CE->getType();
341
342 // Remember, kids, pointers can be losslessly converted back and forth
343 // into 32-bit or wider integers, regardless of signedness. :-P
344 assert(((isa<PointerType>(OpTy)
345 && (Ty == Type::LongTy || Ty == Type::ULongTy
346 || Ty == Type::IntTy || Ty == Type::UIntTy))
347 || (isa<PointerType>(Ty)
348 && (OpTy == Type::LongTy || OpTy == Type::ULongTy
349 || OpTy == Type::IntTy || OpTy == Type::UIntTy))
Owen Andersona69571c2006-05-03 01:29:57 +0000350 || (((TD->getTypeSize(Ty) >= TD->getTypeSize(OpTy))
Chris Lattnera80ba712004-08-16 23:15:22 +0000351 && OpTy->isLosslesslyConvertibleTo(Ty))))
352 && "FIXME: Don't yet support this kind of constant cast expr");
Chris Lattner25045bd2005-11-21 07:51:36 +0000353 EmitConstantValueOnly(Op);
Chris Lattnera80ba712004-08-16 23:15:22 +0000354 break;
355 }
356 case Instruction::Add:
357 O << "(";
Chris Lattner25045bd2005-11-21 07:51:36 +0000358 EmitConstantValueOnly(CE->getOperand(0));
Chris Lattnera80ba712004-08-16 23:15:22 +0000359 O << ") + (";
Chris Lattner25045bd2005-11-21 07:51:36 +0000360 EmitConstantValueOnly(CE->getOperand(1));
Chris Lattnera80ba712004-08-16 23:15:22 +0000361 O << ")";
362 break;
363 default:
364 assert(0 && "Unsupported operator!");
365 }
366 } else {
367 assert(0 && "Unknown constant value!");
368 }
369}
Chris Lattner1b7e2352004-08-17 06:36:49 +0000370
371/// toOctal - Convert the low order bits of X into an octal digit.
372///
373static inline char toOctal(int X) {
374 return (X&7)+'0';
375}
376
Chris Lattner2980cef2005-11-10 18:06:33 +0000377/// printAsCString - Print the specified array as a C compatible string, only if
Chris Lattner1b7e2352004-08-17 06:36:49 +0000378/// the predicate isString is true.
379///
Chris Lattner2980cef2005-11-10 18:06:33 +0000380static void printAsCString(std::ostream &O, const ConstantArray *CVA,
381 unsigned LastElt) {
Chris Lattner1b7e2352004-08-17 06:36:49 +0000382 assert(CVA->isString() && "Array is not string compatible!");
383
384 O << "\"";
Chris Lattner2980cef2005-11-10 18:06:33 +0000385 for (unsigned i = 0; i != LastElt; ++i) {
Misha Brukmanedf128a2005-04-21 22:36:52 +0000386 unsigned char C =
Chris Lattnerdea18b62005-01-08 19:59:10 +0000387 (unsigned char)cast<ConstantInt>(CVA->getOperand(i))->getRawValue();
Chris Lattner1b7e2352004-08-17 06:36:49 +0000388
389 if (C == '"') {
390 O << "\\\"";
391 } else if (C == '\\') {
392 O << "\\\\";
393 } else if (isprint(C)) {
394 O << C;
395 } else {
396 switch(C) {
397 case '\b': O << "\\b"; break;
398 case '\f': O << "\\f"; break;
399 case '\n': O << "\\n"; break;
400 case '\r': O << "\\r"; break;
401 case '\t': O << "\\t"; break;
402 default:
403 O << '\\';
404 O << toOctal(C >> 6);
405 O << toOctal(C >> 3);
406 O << toOctal(C >> 0);
407 break;
408 }
409 }
410 }
411 O << "\"";
412}
413
Jeff Cohenc884db42006-05-02 01:16:28 +0000414/// EmitString - Emit a zero-byte-terminated string constant.
415///
416void AsmPrinter::EmitString(const ConstantArray *CVA) const {
417 unsigned NumElts = CVA->getNumOperands();
418 if (AscizDirective && NumElts &&
419 cast<ConstantInt>(CVA->getOperand(NumElts-1))->getRawValue() == 0) {
420 O << AscizDirective;
421 printAsCString(O, CVA, NumElts-1);
422 } else {
423 O << AsciiDirective;
424 printAsCString(O, CVA, NumElts);
425 }
426 O << "\n";
427}
428
Chris Lattner25045bd2005-11-21 07:51:36 +0000429/// EmitGlobalConstant - Print a general LLVM constant to the .s file.
Chris Lattner1b7e2352004-08-17 06:36:49 +0000430///
Chris Lattner25045bd2005-11-21 07:51:36 +0000431void AsmPrinter::EmitGlobalConstant(const Constant *CV) {
Owen Andersona69571c2006-05-03 01:29:57 +0000432 const TargetData *TD = TM.getTargetData();
Chris Lattner1b7e2352004-08-17 06:36:49 +0000433
Chris Lattnerbd1d3822004-10-16 18:19:26 +0000434 if (CV->isNullValue() || isa<UndefValue>(CV)) {
Owen Andersona69571c2006-05-03 01:29:57 +0000435 EmitZeros(TD->getTypeSize(CV->getType()));
Chris Lattner1b7e2352004-08-17 06:36:49 +0000436 return;
437 } else if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
438 if (CVA->isString()) {
Jeff Cohenc884db42006-05-02 01:16:28 +0000439 EmitString(CVA);
Chris Lattner1b7e2352004-08-17 06:36:49 +0000440 } else { // Not a string. Print the values in successive locations
441 for (unsigned i = 0, e = CVA->getNumOperands(); i != e; ++i)
Chris Lattner25045bd2005-11-21 07:51:36 +0000442 EmitGlobalConstant(CVA->getOperand(i));
Chris Lattner1b7e2352004-08-17 06:36:49 +0000443 }
444 return;
445 } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
446 // Print the fields in successive locations. Pad to align if needed!
Owen Andersona69571c2006-05-03 01:29:57 +0000447 const StructLayout *cvsLayout = TD->getStructLayout(CVS->getType());
Chris Lattnerdea18b62005-01-08 19:59:10 +0000448 uint64_t sizeSoFar = 0;
Chris Lattner1b7e2352004-08-17 06:36:49 +0000449 for (unsigned i = 0, e = CVS->getNumOperands(); i != e; ++i) {
450 const Constant* field = CVS->getOperand(i);
451
452 // Check if padding is needed and insert one or more 0s.
Owen Andersona69571c2006-05-03 01:29:57 +0000453 uint64_t fieldSize = TD->getTypeSize(field->getType());
Chris Lattnerdea18b62005-01-08 19:59:10 +0000454 uint64_t padSize = ((i == e-1? cvsLayout->StructSize
Chris Lattner1b7e2352004-08-17 06:36:49 +0000455 : cvsLayout->MemberOffsets[i+1])
456 - cvsLayout->MemberOffsets[i]) - fieldSize;
457 sizeSoFar += fieldSize + padSize;
458
459 // Now print the actual field value
Chris Lattner25045bd2005-11-21 07:51:36 +0000460 EmitGlobalConstant(field);
Chris Lattner1b7e2352004-08-17 06:36:49 +0000461
462 // Insert the field padding unless it's zero bytes...
Chris Lattner25045bd2005-11-21 07:51:36 +0000463 EmitZeros(padSize);
Chris Lattner1b7e2352004-08-17 06:36:49 +0000464 }
465 assert(sizeSoFar == cvsLayout->StructSize &&
466 "Layout of constant struct may be incorrect!");
467 return;
468 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
469 // FP Constants are printed as integer constants to avoid losing
470 // precision...
471 double Val = CFP->getValue();
472 if (CFP->getType() == Type::DoubleTy) {
Chris Lattnere85a5a92004-08-17 06:48:16 +0000473 if (Data64bitsDirective)
Jim Laskeycb6682f2005-08-17 19:34:49 +0000474 O << Data64bitsDirective << DoubleToBits(Val) << "\t" << CommentString
Chris Lattner7d057a32004-08-17 21:38:40 +0000475 << " double value: " << Val << "\n";
Owen Andersona69571c2006-05-03 01:29:57 +0000476 else if (TD->isBigEndian()) {
Jim Laskeycb6682f2005-08-17 19:34:49 +0000477 O << Data32bitsDirective << unsigned(DoubleToBits(Val) >> 32)
Chris Lattnerf746a7d2004-08-18 02:22:55 +0000478 << "\t" << CommentString << " double most significant word "
Chris Lattner0554fb62004-08-17 16:27:05 +0000479 << Val << "\n";
Jim Laskeycb6682f2005-08-17 19:34:49 +0000480 O << Data32bitsDirective << unsigned(DoubleToBits(Val))
Chris Lattnerf746a7d2004-08-18 02:22:55 +0000481 << "\t" << CommentString << " double least significant word "
Chris Lattner0554fb62004-08-17 16:27:05 +0000482 << Val << "\n";
Chris Lattner1b7e2352004-08-17 06:36:49 +0000483 } else {
Jim Laskeycb6682f2005-08-17 19:34:49 +0000484 O << Data32bitsDirective << unsigned(DoubleToBits(Val))
Chris Lattnerf746a7d2004-08-18 02:22:55 +0000485 << "\t" << CommentString << " double least significant word " << Val
Chris Lattner0554fb62004-08-17 16:27:05 +0000486 << "\n";
Jim Laskeycb6682f2005-08-17 19:34:49 +0000487 O << Data32bitsDirective << unsigned(DoubleToBits(Val) >> 32)
Chris Lattnerf746a7d2004-08-18 02:22:55 +0000488 << "\t" << CommentString << " double most significant word " << Val
Chris Lattner0554fb62004-08-17 16:27:05 +0000489 << "\n";
Chris Lattner1b7e2352004-08-17 06:36:49 +0000490 }
491 return;
492 } else {
Jim Laskeycb6682f2005-08-17 19:34:49 +0000493 O << Data32bitsDirective << FloatToBits(Val) << "\t" << CommentString
Chris Lattner0554fb62004-08-17 16:27:05 +0000494 << " float " << Val << "\n";
Chris Lattner1b7e2352004-08-17 06:36:49 +0000495 return;
496 }
497 } else if (CV->getType() == Type::ULongTy || CV->getType() == Type::LongTy) {
498 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
499 uint64_t Val = CI->getRawValue();
Misha Brukmanedf128a2005-04-21 22:36:52 +0000500
Chris Lattnere85a5a92004-08-17 06:48:16 +0000501 if (Data64bitsDirective)
502 O << Data64bitsDirective << Val << "\n";
Owen Andersona69571c2006-05-03 01:29:57 +0000503 else if (TD->isBigEndian()) {
Chris Lattner1b7e2352004-08-17 06:36:49 +0000504 O << Data32bitsDirective << unsigned(Val >> 32)
Chris Lattnerf746a7d2004-08-18 02:22:55 +0000505 << "\t" << CommentString << " Double-word most significant word "
Chris Lattner0554fb62004-08-17 16:27:05 +0000506 << Val << "\n";
Chris Lattner1b7e2352004-08-17 06:36:49 +0000507 O << Data32bitsDirective << unsigned(Val)
Chris Lattnerf746a7d2004-08-18 02:22:55 +0000508 << "\t" << CommentString << " Double-word least significant word "
Chris Lattner0554fb62004-08-17 16:27:05 +0000509 << Val << "\n";
Chris Lattner1b7e2352004-08-17 06:36:49 +0000510 } else {
511 O << Data32bitsDirective << unsigned(Val)
Chris Lattnerf746a7d2004-08-18 02:22:55 +0000512 << "\t" << CommentString << " Double-word least significant word "
Chris Lattner0554fb62004-08-17 16:27:05 +0000513 << Val << "\n";
Chris Lattner1b7e2352004-08-17 06:36:49 +0000514 O << Data32bitsDirective << unsigned(Val >> 32)
Chris Lattnerf746a7d2004-08-18 02:22:55 +0000515 << "\t" << CommentString << " Double-word most significant word "
Chris Lattner0554fb62004-08-17 16:27:05 +0000516 << Val << "\n";
Chris Lattner1b7e2352004-08-17 06:36:49 +0000517 }
518 return;
519 }
Nate Begeman8cfa57b2005-12-06 06:18:55 +0000520 } else if (const ConstantPacked *CP = dyn_cast<ConstantPacked>(CV)) {
521 const PackedType *PTy = CP->getType();
522
523 for (unsigned I = 0, E = PTy->getNumElements(); I < E; ++I)
524 EmitGlobalConstant(CP->getOperand(I));
525
526 return;
Chris Lattner1b7e2352004-08-17 06:36:49 +0000527 }
528
529 const Type *type = CV->getType();
Chris Lattner1b7e2352004-08-17 06:36:49 +0000530 switch (type->getTypeID()) {
Misha Brukmanedf128a2005-04-21 22:36:52 +0000531 case Type::BoolTyID:
Chris Lattner1b7e2352004-08-17 06:36:49 +0000532 case Type::UByteTyID: case Type::SByteTyID:
533 O << Data8bitsDirective;
534 break;
535 case Type::UShortTyID: case Type::ShortTyID:
536 O << Data16bitsDirective;
537 break;
Chris Lattner1b7e2352004-08-17 06:36:49 +0000538 case Type::PointerTyID:
Owen Andersona69571c2006-05-03 01:29:57 +0000539 if (TD->getPointerSize() == 8) {
Evan Chenga9767f62006-06-15 08:10:56 +0000540 assert(Data64bitsDirective &&
541 "Target cannot handle 64-bit pointer exprs!");
Andrew Lenharth571c9c32005-02-04 13:47:16 +0000542 O << Data64bitsDirective;
543 break;
544 }
545 //Fall through for pointer size == int size
Chris Lattner1b7e2352004-08-17 06:36:49 +0000546 case Type::UIntTyID: case Type::IntTyID:
547 O << Data32bitsDirective;
548 break;
Misha Brukmanedf128a2005-04-21 22:36:52 +0000549 case Type::ULongTyID: case Type::LongTyID:
Chris Lattner660538c2005-08-08 04:26:32 +0000550 assert(Data64bitsDirective &&"Target cannot handle 64-bit constant exprs!");
551 O << Data64bitsDirective;
552 break;
Chris Lattner1b7e2352004-08-17 06:36:49 +0000553 case Type::FloatTyID: case Type::DoubleTyID:
554 assert (0 && "Should have already output floating point constant.");
555 default:
556 assert (0 && "Can't handle printing this type of thing");
557 break;
558 }
Chris Lattner25045bd2005-11-21 07:51:36 +0000559 EmitConstantValueOnly(CV);
Chris Lattner1b7e2352004-08-17 06:36:49 +0000560 O << "\n";
561}
Chris Lattner0264d1a2006-01-27 02:10:10 +0000562
563/// printInlineAsm - This method formats and prints the specified machine
564/// instruction that is an inline asm.
565void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
Chris Lattner1c059972006-05-05 21:47:05 +0000566 O << InlineAsmStart << "\n\t";
Chris Lattnerf2b67cf2006-01-30 23:00:08 +0000567 unsigned NumOperands = MI->getNumOperands();
568
569 // Count the number of register definitions.
570 unsigned NumDefs = 0;
571 for (; MI->getOperand(NumDefs).isDef(); ++NumDefs)
572 assert(NumDefs != NumOperands-1 && "No asm string?");
573
574 assert(MI->getOperand(NumDefs).isExternalSymbol() && "No asm string?");
Chris Lattner66099132006-02-01 22:41:11 +0000575
576 // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
Chris Lattnerf2b67cf2006-01-30 23:00:08 +0000577 const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
Chris Lattner66099132006-02-01 22:41:11 +0000578
579 // The variant of the current asmprinter: FIXME: change.
580 int AsmPrinterVariant = 0;
Chris Lattnerf2b67cf2006-01-30 23:00:08 +0000581
Chris Lattner66099132006-02-01 22:41:11 +0000582 int CurVariant = -1; // The number of the {.|.|.} region we are in.
583 const char *LastEmitted = AsmStr; // One past the last character emitted.
Chris Lattner2cc2f662006-02-01 01:28:23 +0000584
Chris Lattner66099132006-02-01 22:41:11 +0000585 while (*LastEmitted) {
586 switch (*LastEmitted) {
587 default: {
588 // Not a special case, emit the string section literally.
589 const char *LiteralEnd = LastEmitted+1;
590 while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
Chris Lattner1c059972006-05-05 21:47:05 +0000591 *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
Chris Lattner66099132006-02-01 22:41:11 +0000592 ++LiteralEnd;
593 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
594 O.write(LastEmitted, LiteralEnd-LastEmitted);
595 LastEmitted = LiteralEnd;
596 break;
597 }
Chris Lattner1c059972006-05-05 21:47:05 +0000598 case '\n':
599 ++LastEmitted; // Consume newline character.
600 O << "\n\t"; // Indent code with newline.
601 break;
Chris Lattner66099132006-02-01 22:41:11 +0000602 case '$': {
603 ++LastEmitted; // Consume '$' character.
604 if (*LastEmitted == '$') { // $$ -> $
605 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
606 O << '$';
607 ++LastEmitted; // Consume second '$' character.
608 break;
609 }
610
611 bool HasCurlyBraces = false;
612 if (*LastEmitted == '{') { // ${variable}
613 ++LastEmitted; // Consume '{' character.
614 HasCurlyBraces = true;
615 }
616
617 const char *IDStart = LastEmitted;
618 char *IDEnd;
619 long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
620 if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
621 std::cerr << "Bad $ operand number in inline asm string: '"
622 << AsmStr << "'\n";
623 exit(1);
624 }
625 LastEmitted = IDEnd;
626
Chris Lattnera36cb0a2006-02-06 22:17:23 +0000627 char Modifier[2] = { 0, 0 };
628
Chris Lattner66099132006-02-01 22:41:11 +0000629 if (HasCurlyBraces) {
Chris Lattnera36cb0a2006-02-06 22:17:23 +0000630 // If we have curly braces, check for a modifier character. This
631 // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
632 if (*LastEmitted == ':') {
633 ++LastEmitted; // Consume ':' character.
634 if (*LastEmitted == 0) {
635 std::cerr << "Bad ${:} expression in inline asm string: '"
636 << AsmStr << "'\n";
637 exit(1);
638 }
639
640 Modifier[0] = *LastEmitted;
641 ++LastEmitted; // Consume modifier character.
642 }
643
Chris Lattner66099132006-02-01 22:41:11 +0000644 if (*LastEmitted != '}') {
645 std::cerr << "Bad ${} expression in inline asm string: '"
646 << AsmStr << "'\n";
647 exit(1);
648 }
649 ++LastEmitted; // Consume '}' character.
650 }
651
652 if ((unsigned)Val >= NumOperands-1) {
653 std::cerr << "Invalid $ operand number in inline asm string: '"
654 << AsmStr << "'\n";
655 exit(1);
656 }
657
Chris Lattnerc3a9f8d2006-02-23 19:21:04 +0000658 // Okay, we finally have a value number. Ask the target to print this
Chris Lattner66099132006-02-01 22:41:11 +0000659 // operand!
Chris Lattnerc3a9f8d2006-02-23 19:21:04 +0000660 if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
661 unsigned OpNo = 1;
Chris Lattnerfd561cd2006-06-08 18:00:47 +0000662
663 bool Error = false;
664
Chris Lattnerc3a9f8d2006-02-23 19:21:04 +0000665 // Scan to find the machine operand number for the operand.
Chris Lattnerdaf6bc62006-02-24 19:50:58 +0000666 for (; Val; --Val) {
Chris Lattnerfd561cd2006-06-08 18:00:47 +0000667 if (OpNo >= MI->getNumOperands()) break;
Chris Lattnerdaf6bc62006-02-24 19:50:58 +0000668 unsigned OpFlags = MI->getOperand(OpNo).getImmedValue();
669 OpNo += (OpFlags >> 3) + 1;
670 }
Chris Lattnerdd260332006-02-24 20:21:58 +0000671
Chris Lattnerfd561cd2006-06-08 18:00:47 +0000672 if (OpNo >= MI->getNumOperands()) {
673 Error = true;
Chris Lattnerdd260332006-02-24 20:21:58 +0000674 } else {
Chris Lattnerfd561cd2006-06-08 18:00:47 +0000675 unsigned OpFlags = MI->getOperand(OpNo).getImmedValue();
676 ++OpNo; // Skip over the ID number.
677
678 AsmPrinter *AP = const_cast<AsmPrinter*>(this);
679 if ((OpFlags & 7) == 4 /*ADDR MODE*/) {
680 Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
681 Modifier[0] ? Modifier : 0);
682 } else {
683 Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
684 Modifier[0] ? Modifier : 0);
685 }
Chris Lattnerdd260332006-02-24 20:21:58 +0000686 }
687 if (Error) {
Chris Lattner66099132006-02-01 22:41:11 +0000688 std::cerr << "Invalid operand found in inline asm: '"
689 << AsmStr << "'\n";
690 MI->dump();
691 exit(1);
692 }
Chris Lattnerc3a9f8d2006-02-23 19:21:04 +0000693 }
Chris Lattner66099132006-02-01 22:41:11 +0000694 break;
695 }
696 case '{':
697 ++LastEmitted; // Consume '{' character.
698 if (CurVariant != -1) {
699 std::cerr << "Nested variants found in inline asm string: '"
700 << AsmStr << "'\n";
701 exit(1);
702 }
703 CurVariant = 0; // We're in the first variant now.
704 break;
705 case '|':
706 ++LastEmitted; // consume '|' character.
707 if (CurVariant == -1) {
708 std::cerr << "Found '|' character outside of variant in inline asm "
709 << "string: '" << AsmStr << "'\n";
710 exit(1);
711 }
712 ++CurVariant; // We're in the next variant.
713 break;
714 case '}':
715 ++LastEmitted; // consume '}' character.
716 if (CurVariant == -1) {
717 std::cerr << "Found '}' character outside of variant in inline asm "
718 << "string: '" << AsmStr << "'\n";
719 exit(1);
720 }
721 CurVariant = -1;
722 break;
723 }
724 }
Chris Lattner1c059972006-05-05 21:47:05 +0000725 O << "\n\t" << InlineAsmEnd << "\n";
Chris Lattner66099132006-02-01 22:41:11 +0000726}
727
728/// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
729/// instruction, using the specified assembler variant. Targets should
730/// overried this to format as appropriate.
731bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
Chris Lattnera36cb0a2006-02-06 22:17:23 +0000732 unsigned AsmVariant, const char *ExtraCode) {
Chris Lattner66099132006-02-01 22:41:11 +0000733 // Target doesn't support this yet!
734 return true;
Chris Lattner0264d1a2006-01-27 02:10:10 +0000735}
Chris Lattnerdd260332006-02-24 20:21:58 +0000736
737bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
738 unsigned AsmVariant,
739 const char *ExtraCode) {
740 // Target doesn't support this yet!
741 return true;
742}
Nate Begeman37efe672006-04-22 18:53:45 +0000743
744/// printBasicBlockLabel - This method prints the label for the specified
745/// MachineBasicBlock
Nate Begemancdf38c42006-05-02 05:37:32 +0000746void AsmPrinter::printBasicBlockLabel(const MachineBasicBlock *MBB,
747 bool printColon,
748 bool printComment) const {
Nate Begeman9d51eeb2006-05-02 17:36:46 +0000749 O << PrivateGlobalPrefix << "BB" << FunctionNumber << "_"
750 << MBB->getNumber();
Nate Begemancdf38c42006-05-02 05:37:32 +0000751 if (printColon)
752 O << ':';
753 if (printComment)
754 O << '\t' << CommentString << MBB->getBasicBlock()->getName();
Nate Begeman37efe672006-04-22 18:53:45 +0000755}