blob: 868f8710d89bfd9b6da938cb384b6604e3a326bb [file] [log] [blame]
Chris Lattnere88f78c2001-09-19 13:47:27 +00001//===-- EmitAssembly.cpp - Emit Sparc Specific .s File ---------------------==//
2//
3// This file implements all of the stuff neccesary to output a .s file from
4// LLVM. The code in this file assumes that the specified module has already
5// been compiled into the internal data structures of the Module.
6//
Chris Lattnerf57b8452002-04-27 06:56:12 +00007// This code largely consists of two LLVM Pass's: a FunctionPass and a Pass.
8// The FunctionPass is pipelined together with all of the rest of the code
9// generation stages, and the Pass runs at the end to emit code for global
10// variables and such.
Chris Lattnere88f78c2001-09-19 13:47:27 +000011//
12//===----------------------------------------------------------------------===//
13
14#include "SparcInternals.h"
Chris Lattnere88f78c2001-09-19 13:47:27 +000015#include "llvm/CodeGen/MachineInstr.h"
Chris Lattnerc019a172002-02-03 07:48:06 +000016#include "llvm/CodeGen/MachineCodeForMethod.h"
Vikram S. Adve953c83e2001-10-28 21:38:52 +000017#include "llvm/GlobalVariable.h"
Chris Lattner31bcdb82002-04-28 19:55:58 +000018#include "llvm/Constants.h"
Vikram S. Adve953c83e2001-10-28 21:38:52 +000019#include "llvm/DerivedTypes.h"
Chris Lattnere88f78c2001-09-19 13:47:27 +000020#include "llvm/BasicBlock.h"
Chris Lattner2fbfdcf2002-04-07 20:49:59 +000021#include "llvm/Function.h"
Chris Lattnere88f78c2001-09-19 13:47:27 +000022#include "llvm/Module.h"
Chris Lattnerb5794002002-04-07 22:49:37 +000023#include "llvm/SlotCalculator.h"
Chris Lattnerd50b6712002-04-28 20:40:59 +000024#include "llvm/Pass.h"
Chris Lattner4b1de8e2002-04-18 18:15:38 +000025#include "llvm/Assembly/Writer.h"
Chris Lattnercee8f9a2001-11-27 00:03:19 +000026#include "Support/StringExtras.h"
Vikram S. Adve9ee9d712002-03-03 20:46:32 +000027#include <iostream>
Chris Lattner697954c2002-01-20 22:54:45 +000028using std::string;
Chris Lattnere88f78c2001-09-19 13:47:27 +000029
30namespace {
31
Vikram S. Adved198c472002-03-18 03:07:26 +000032class GlobalIdTable: public Annotation {
33 static AnnotationID AnnotId;
34 friend class AsmPrinter; // give access to AnnotId
Vikram S. Adve953c83e2001-10-28 21:38:52 +000035
Vikram S. Adved198c472002-03-18 03:07:26 +000036 typedef std::hash_map<const Value*, int> ValIdMap;
37 typedef ValIdMap::const_iterator ValIdMapConstIterator;
38 typedef ValIdMap:: iterator ValIdMapIterator;
39public:
Chris Lattnerfd63f25f2002-04-28 04:50:54 +000040 SlotCalculator Table; // map anonymous values to unique integer IDs
Chris Lattnerc19b8b12002-02-03 23:41:08 +000041 ValIdMap valToIdMap; // used for values not handled by SlotCalculator
Vikram S. Adved198c472002-03-18 03:07:26 +000042
Chris Lattnerfd63f25f2002-04-28 04:50:54 +000043 GlobalIdTable(Module* M) : Annotation(AnnotId), Table(M, true) {}
Vikram S. Adved198c472002-03-18 03:07:26 +000044};
45
46AnnotationID GlobalIdTable::AnnotId =
47 AnnotationManager::getID("ASM PRINTER GLOBAL TABLE ANNOT");
48
49//===---------------------------------------------------------------------===//
50// Code Shared By the two printer passes, as a mixin
51//===---------------------------------------------------------------------===//
52
53class AsmPrinter {
54 GlobalIdTable* idTable;
Chris Lattnerc19b8b12002-02-03 23:41:08 +000055public:
Chris Lattner697954c2002-01-20 22:54:45 +000056 std::ostream &toAsm;
Chris Lattner59ba1092002-02-04 15:53:23 +000057 const TargetMachine &Target;
Vikram S. Adved198c472002-03-18 03:07:26 +000058
Chris Lattnere88f78c2001-09-19 13:47:27 +000059 enum Sections {
60 Unknown,
61 Text,
Vikram S. Adve953c83e2001-10-28 21:38:52 +000062 ReadOnlyData,
63 InitRWData,
64 UninitRWData,
Chris Lattnere88f78c2001-09-19 13:47:27 +000065 } CurSection;
Chris Lattnerc19b8b12002-02-03 23:41:08 +000066
Chris Lattner59ba1092002-02-04 15:53:23 +000067 AsmPrinter(std::ostream &os, const TargetMachine &T)
Vikram S. Adved198c472002-03-18 03:07:26 +000068 : idTable(0), toAsm(os), Target(T), CurSection(Unknown) {}
69
Chris Lattner2fbfdcf2002-04-07 20:49:59 +000070 // (start|end)(Module|Function) - Callback methods to be invoked by subclasses
Chris Lattnerc19b8b12002-02-03 23:41:08 +000071 void startModule(Module *M) {
Vikram S. Adved198c472002-03-18 03:07:26 +000072 // Create the global id table if it does not already exist
73 idTable = (GlobalIdTable*) M->getAnnotation(GlobalIdTable::AnnotId);
74 if (idTable == NULL) {
75 idTable = new GlobalIdTable(M);
76 M->addAnnotation(idTable);
77 }
Chris Lattnerc19b8b12002-02-03 23:41:08 +000078 }
Chris Lattner2fbfdcf2002-04-07 20:49:59 +000079 void startFunction(Function *F) {
Chris Lattnerb5794002002-04-07 22:49:37 +000080 // Make sure the slot table has information about this function...
Chris Lattnerfd63f25f2002-04-28 04:50:54 +000081 idTable->Table.incorporateFunction(F);
Chris Lattnerc19b8b12002-02-03 23:41:08 +000082 }
Chris Lattner2fbfdcf2002-04-07 20:49:59 +000083 void endFunction(Function *F) {
Chris Lattnerfd63f25f2002-04-28 04:50:54 +000084 idTable->Table.purgeFunction(); // Forget all about F
Chris Lattnerc19b8b12002-02-03 23:41:08 +000085 }
86 void endModule() {
Chris Lattnere88f78c2001-09-19 13:47:27 +000087 }
88
Vikram S. Adved198c472002-03-18 03:07:26 +000089 // Check if a name is external or accessible from external code.
90 // Only functions can currently be external. "main" is the only name
91 // that is visible externally.
92 bool isExternal(const Value* V) {
Chris Lattner2fbfdcf2002-04-07 20:49:59 +000093 const Function *F = dyn_cast<Function>(V);
94 return F && (F->isExternal() || F->getName() == "main");
Vikram S. Adved198c472002-03-18 03:07:26 +000095 }
Vikram S. Adve953c83e2001-10-28 21:38:52 +000096
Chris Lattnere88f78c2001-09-19 13:47:27 +000097 // enterSection - Use this method to enter a different section of the output
98 // executable. This is used to only output neccesary section transitions.
99 //
100 void enterSection(enum Sections S) {
101 if (S == CurSection) return; // Only switch section if neccesary
102 CurSection = S;
103
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000104 toAsm << "\n\t.section ";
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000105 switch (S)
106 {
107 default: assert(0 && "Bad section name!");
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000108 case Text: toAsm << "\".text\""; break;
109 case ReadOnlyData: toAsm << "\".rodata\",#alloc"; break;
110 case InitRWData: toAsm << "\".data\",#alloc,#write"; break;
111 case UninitRWData: toAsm << "\".bss\",#alloc,#write\nBbss.bss:"; break;
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000112 }
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000113 toAsm << "\n";
Chris Lattnere88f78c2001-09-19 13:47:27 +0000114 }
115
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000116 static std::string getValidSymbolName(const string &S) {
Chris Lattnerc56d7792001-09-28 15:07:24 +0000117 string Result;
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000118
119 // Symbol names in Sparc assembly language have these rules:
120 // (a) Must match { letter | _ | . | $ } { letter | _ | . | $ | digit }*
121 // (b) A name beginning in "." is treated as a local name.
122 // (c) Names beginning with "_" are reserved by ANSI C and shd not be used.
123 //
124 if (S[0] == '_' || isdigit(S[0]))
125 Result += "ll";
126
127 for (unsigned i = 0; i < S.size(); ++i)
128 {
129 char C = S[i];
130 if (C == '_' || C == '.' || C == '$' || isalpha(C) || isdigit(C))
131 Result += C;
132 else
133 {
134 Result += '_';
135 Result += char('0' + ((unsigned char)C >> 4));
136 Result += char('0' + (C & 0xF));
137 }
Chris Lattnerc56d7792001-09-28 15:07:24 +0000138 }
Chris Lattnerc56d7792001-09-28 15:07:24 +0000139 return Result;
140 }
141
Chris Lattnere88f78c2001-09-19 13:47:27 +0000142 // getID - Return a valid identifier for the specified value. Base it on
Vikram S. Adved198c472002-03-18 03:07:26 +0000143 // the name of the identifier if possible (qualified by the type), and
144 // use a numbered value based on prefix otherwise.
145 // FPrefix is always prepended to the output identifier.
Chris Lattnere88f78c2001-09-19 13:47:27 +0000146 //
147 string getID(const Value *V, const char *Prefix, const char *FPrefix = 0) {
Vikram S. Adved198c472002-03-18 03:07:26 +0000148 string Result = FPrefix ? FPrefix : ""; // "Forced prefix"
149
150 Result = Result + (V->hasName()? V->getName() : string(Prefix));
151
152 // Qualify all internal names with a unique id.
153 if (!isExternal(V)) {
Chris Lattnerfd63f25f2002-04-28 04:50:54 +0000154 int valId = idTable->Table.getValSlot(V);
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000155 if (valId == -1) {
Vikram S. Adved198c472002-03-18 03:07:26 +0000156 GlobalIdTable::ValIdMapConstIterator I = idTable->valToIdMap.find(V);
157 if (I == idTable->valToIdMap.end())
158 valId = idTable->valToIdMap[V] = idTable->valToIdMap.size();
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000159 else
160 valId = I->second;
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000161 }
Vikram S. Adved198c472002-03-18 03:07:26 +0000162 Result = Result + "_" + itostr(valId);
Chris Lattnere88f78c2001-09-19 13:47:27 +0000163 }
Vikram S. Adved198c472002-03-18 03:07:26 +0000164
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000165 return getValidSymbolName(Result);
Chris Lattnere88f78c2001-09-19 13:47:27 +0000166 }
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000167
Chris Lattnere88f78c2001-09-19 13:47:27 +0000168 // getID Wrappers - Ensure consistent usage...
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000169 string getID(const Function *F) {
170 return getID(F, "LLVMFunction_");
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000171 }
172 string getID(const BasicBlock *BB) {
173 return getID(BB, "LL", (".L_"+getID(BB->getParent())+"_").c_str());
174 }
175 string getID(const GlobalVariable *GV) {
176 return getID(GV, "LLVMGlobal_", ".G_");
177 }
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000178 string getID(const Constant *CV) {
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000179 return getID(CV, "LLVMConst_", ".C_");
180 }
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000181};
182
183
184
185//===----------------------------------------------------------------------===//
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000186// SparcFunctionAsmPrinter Code
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000187//===----------------------------------------------------------------------===//
188
Chris Lattnerf57b8452002-04-27 06:56:12 +0000189struct SparcFunctionAsmPrinter : public FunctionPass, public AsmPrinter {
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000190 inline SparcFunctionAsmPrinter(std::ostream &os, const TargetMachine &t)
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000191 : AsmPrinter(os, t) {}
192
Chris Lattner96c466b2002-04-29 14:57:45 +0000193 const char *getPassName() const {
194 return "Output Sparc Assembly for Functions";
195 }
196
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000197 virtual bool doInitialization(Module *M) {
198 startModule(M);
199 return false;
200 }
201
Chris Lattnerf57b8452002-04-27 06:56:12 +0000202 virtual bool runOnFunction(Function *F) {
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000203 startFunction(F);
204 emitFunction(F);
205 endFunction(F);
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000206 return false;
207 }
208
209 virtual bool doFinalization(Module *M) {
210 endModule();
211 return false;
212 }
213
Chris Lattner97e52e42002-04-28 21:27:06 +0000214 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
215 AU.setPreservesAll();
216 }
217
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000218 void emitFunction(const Function *F);
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000219private :
220 void emitBasicBlock(const BasicBlock *BB);
221 void emitMachineInst(const MachineInstr *MI);
222
223 unsigned int printOperands(const MachineInstr *MI, unsigned int opNum);
224 void printOneOperand(const MachineOperand &Op);
225
226 bool OpIsBranchTargetLabel(const MachineInstr *MI, unsigned int opNum);
227 bool OpIsMemoryAddressBase(const MachineInstr *MI, unsigned int opNum);
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000228
Chris Lattnere88f78c2001-09-19 13:47:27 +0000229 unsigned getOperandMask(unsigned Opcode) {
230 switch (Opcode) {
231 case SUBcc: return 1 << 3; // Remove CC argument
Vikram S. Adve998cf0d2001-11-11 23:11:36 +0000232 case BA: return 1 << 0; // Remove Arg #0, which is always null or xcc
Chris Lattnere88f78c2001-09-19 13:47:27 +0000233 default: return 0; // By default, don't hack operands...
234 }
235 }
236};
237
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000238inline bool
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000239SparcFunctionAsmPrinter::OpIsBranchTargetLabel(const MachineInstr *MI,
240 unsigned int opNum) {
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000241 switch (MI->getOpCode()) {
242 case JMPLCALL:
243 case JMPLRET: return (opNum == 0);
244 default: return false;
245 }
246}
247
248
249inline bool
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000250SparcFunctionAsmPrinter::OpIsMemoryAddressBase(const MachineInstr *MI,
251 unsigned int opNum) {
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000252 if (Target.getInstrInfo().isLoad(MI->getOpCode()))
253 return (opNum == 0);
254 else if (Target.getInstrInfo().isStore(MI->getOpCode()))
255 return (opNum == 1);
256 else
257 return false;
258}
259
260
261#define PrintOp1PlusOp2(Op1, Op2) \
262 printOneOperand(Op1); \
263 toAsm << "+"; \
264 printOneOperand(Op2);
265
266unsigned int
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000267SparcFunctionAsmPrinter::printOperands(const MachineInstr *MI,
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000268 unsigned int opNum)
269{
270 const MachineOperand& Op = MI->getOperand(opNum);
271
272 if (OpIsBranchTargetLabel(MI, opNum))
273 {
274 PrintOp1PlusOp2(Op, MI->getOperand(opNum+1));
275 return 2;
276 }
277 else if (OpIsMemoryAddressBase(MI, opNum))
278 {
279 toAsm << "[";
280 PrintOp1PlusOp2(Op, MI->getOperand(opNum+1));
281 toAsm << "]";
282 return 2;
283 }
284 else
285 {
286 printOneOperand(Op);
287 return 1;
288 }
289}
290
291
292void
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000293SparcFunctionAsmPrinter::printOneOperand(const MachineOperand &op)
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000294{
295 switch (op.getOperandType())
296 {
297 case MachineOperand::MO_VirtualRegister:
298 case MachineOperand::MO_CCRegister:
299 case MachineOperand::MO_MachineRegister:
300 {
301 int RegNum = (int)op.getAllocatedRegNum();
302
Vikram S. Advefbd21612002-03-31 19:03:58 +0000303 // better to print code with NULL registers than to die
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000304 if (RegNum == Target.getRegInfo().getInvalidRegNum()) {
305 toAsm << "<NULL VALUE>";
306 } else {
307 toAsm << "%" << Target.getRegInfo().getUnifiedRegName(RegNum);
308 }
309 break;
310 }
311
312 case MachineOperand::MO_PCRelativeDisp:
313 {
314 const Value *Val = op.getVRegValue();
315 if (!Val)
316 toAsm << "\t<*NULL Value*>";
Chris Lattner31bcdb82002-04-28 19:55:58 +0000317 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(Val))
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000318 toAsm << getID(BB);
Chris Lattner31bcdb82002-04-28 19:55:58 +0000319 else if (const Function *M = dyn_cast<Function>(Val))
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000320 toAsm << getID(M);
Chris Lattner31bcdb82002-04-28 19:55:58 +0000321 else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Val))
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000322 toAsm << getID(GV);
Chris Lattner31bcdb82002-04-28 19:55:58 +0000323 else if (const Constant *CV = dyn_cast<Constant>(Val))
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000324 toAsm << getID(CV);
325 else
326 toAsm << "<unknown value=" << Val << ">";
327 break;
328 }
329
330 case MachineOperand::MO_SignExtendedImmed:
331 case MachineOperand::MO_UnextendedImmed:
332 toAsm << (long)op.getImmedValue();
333 break;
334
335 default:
336 toAsm << op; // use dump field
337 break;
338 }
339}
340
341
342void
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000343SparcFunctionAsmPrinter::emitMachineInst(const MachineInstr *MI)
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000344{
345 unsigned Opcode = MI->getOpCode();
346
347 if (TargetInstrDescriptors[Opcode].iclass & M_DUMMY_PHI_FLAG)
348 return; // IGNORE PHI NODES
349
350 toAsm << "\t" << TargetInstrDescriptors[Opcode].opCodeString << "\t";
351
352 unsigned Mask = getOperandMask(Opcode);
353
354 bool NeedComma = false;
355 unsigned N = 1;
356 for (unsigned OpNum = 0; OpNum < MI->getNumOperands(); OpNum += N)
357 if (! ((1 << OpNum) & Mask)) { // Ignore this operand?
358 if (NeedComma) toAsm << ", "; // Handle comma outputing
359 NeedComma = true;
360 N = printOperands(MI, OpNum);
361 }
362 else
363 N = 1;
364
365 toAsm << "\n";
366}
367
368void
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000369SparcFunctionAsmPrinter::emitBasicBlock(const BasicBlock *BB)
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000370{
371 // Emit a label for the basic block
372 toAsm << getID(BB) << ":\n";
373
374 // Get the vector of machine instructions corresponding to this bb.
375 const MachineCodeForBasicBlock &MIs = BB->getMachineInstrVec();
376 MachineCodeForBasicBlock::const_iterator MII = MIs.begin(), MIE = MIs.end();
377
378 // Loop over all of the instructions in the basic block...
379 for (; MII != MIE; ++MII)
380 emitMachineInst(*MII);
381 toAsm << "\n"; // Seperate BB's with newlines
382}
383
384void
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000385SparcFunctionAsmPrinter::emitFunction(const Function *M)
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000386{
387 string methName = getID(M);
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000388 toAsm << "!****** Outputing Function: " << methName << " ******\n";
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000389 enterSection(AsmPrinter::Text);
390 toAsm << "\t.align\t4\n\t.global\t" << methName << "\n";
391 //toAsm << "\t.type\t" << methName << ",#function\n";
392 toAsm << "\t.type\t" << methName << ", 2\n";
393 toAsm << methName << ":\n";
394
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000395 // Output code for all of the basic blocks in the function...
396 for (Function::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000397 emitBasicBlock(*I);
398
399 // Output a .size directive so the debugger knows the extents of the function
400 toAsm << ".EndOf_" << methName << ":\n\t.size "
401 << methName << ", .EndOf_"
402 << methName << "-" << methName << "\n";
403
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000404 // Put some spaces between the functions
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000405 toAsm << "\n\n";
406}
407
408} // End anonymous namespace
409
Chris Lattnerf57b8452002-04-27 06:56:12 +0000410Pass *UltraSparc::getFunctionAsmPrinterPass(PassManager &PM, std::ostream &Out){
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000411 return new SparcFunctionAsmPrinter(Out, *this);
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000412}
413
414
415
416
417
418//===----------------------------------------------------------------------===//
Chris Lattner2fbfdcf2002-04-07 20:49:59 +0000419// SparcFunctionAsmPrinter Code
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000420//===----------------------------------------------------------------------===//
421
422namespace {
423
424class SparcModuleAsmPrinter : public Pass, public AsmPrinter {
425public:
Chris Lattner49b8a9c2002-02-24 23:02:40 +0000426 SparcModuleAsmPrinter(std::ostream &os, TargetMachine &t)
427 : AsmPrinter(os, t) {}
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000428
Chris Lattner96c466b2002-04-29 14:57:45 +0000429 const char *getPassName() const { return "Output Sparc Assembly for Module"; }
430
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000431 virtual bool run(Module *M) {
432 startModule(M);
433 emitGlobalsAndConstants(M);
434 endModule();
435 return false;
436 }
437
Chris Lattner97e52e42002-04-28 21:27:06 +0000438 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
439 AU.setPreservesAll();
440 }
441
442private:
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000443 void emitGlobalsAndConstants(const Module *M);
444
445 void printGlobalVariable(const GlobalVariable *GV);
446 void printSingleConstant( const Constant* CV);
447 void printConstantValueOnly(const Constant* CV);
448 void printConstant( const Constant* CV, std::string valID = "");
449
450 static void FoldConstants(const Module *M,
451 std::hash_set<const Constant*> &moduleConstants);
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000452};
453
Chris Lattnercee8f9a2001-11-27 00:03:19 +0000454
455// Can we treat the specified array as a string? Only if it is an array of
456// ubytes or non-negative sbytes.
457//
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000458static bool isStringCompatible(ConstantArray *CPA) {
Chris Lattnercee8f9a2001-11-27 00:03:19 +0000459 const Type *ETy = cast<ArrayType>(CPA->getType())->getElementType();
460 if (ETy == Type::UByteTy) return true;
461 if (ETy != Type::SByteTy) return false;
462
463 for (unsigned i = 0; i < CPA->getNumOperands(); ++i)
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000464 if (cast<ConstantSInt>(CPA->getOperand(i))->getValue() < 0)
Chris Lattnercee8f9a2001-11-27 00:03:19 +0000465 return false;
466
467 return true;
468}
469
470// toOctal - Convert the low order bits of X into an octal letter
471static inline char toOctal(int X) {
472 return (X&7)+'0';
473}
474
475// getAsCString - Return the specified array as a C compatible string, only if
476// the predicate isStringCompatible is true.
477//
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000478static string getAsCString(ConstantArray *CPA) {
Chris Lattner4b1de8e2002-04-18 18:15:38 +0000479 assert(isStringCompatible(CPA) && "Array is not string compatible!");
Chris Lattnercee8f9a2001-11-27 00:03:19 +0000480
Chris Lattner4b1de8e2002-04-18 18:15:38 +0000481 string Result;
482 const Type *ETy = cast<ArrayType>(CPA->getType())->getElementType();
483 Result = "\"";
484 for (unsigned i = 0; i < CPA->getNumOperands(); ++i) {
485 unsigned char C = (ETy == Type::SByteTy) ?
486 (unsigned char)cast<ConstantSInt>(CPA->getOperand(i))->getValue() :
487 (unsigned char)cast<ConstantUInt>(CPA->getOperand(i))->getValue();
488
489 if (isprint(C)) {
490 Result += C;
491 } else {
492 switch(C) {
493 case '\a': Result += "\\a"; break;
494 case '\b': Result += "\\b"; break;
495 case '\f': Result += "\\f"; break;
496 case '\n': Result += "\\n"; break;
497 case '\r': Result += "\\r"; break;
498 case '\t': Result += "\\t"; break;
499 case '\v': Result += "\\v"; break;
500 default:
501 Result += '\\';
502 Result += toOctal(C >> 6);
503 Result += toOctal(C >> 3);
504 Result += toOctal(C >> 0);
505 break;
Chris Lattnercee8f9a2001-11-27 00:03:19 +0000506 }
507 }
Chris Lattnercee8f9a2001-11-27 00:03:19 +0000508 }
Chris Lattner4b1de8e2002-04-18 18:15:38 +0000509 Result += "\"";
510
511 return Result;
Chris Lattnercee8f9a2001-11-27 00:03:19 +0000512}
513
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000514inline bool
515ArrayTypeIsString(ArrayType* arrayType)
516{
517 return (arrayType->getElementType() == Type::UByteTy ||
518 arrayType->getElementType() == Type::SByteTy);
519}
Chris Lattnere88f78c2001-09-19 13:47:27 +0000520
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000521inline const string
522TypeToDataDirective(const Type* type)
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000523{
524 switch(type->getPrimitiveID())
525 {
526 case Type::BoolTyID: case Type::UByteTyID: case Type::SByteTyID:
527 return ".byte";
528 case Type::UShortTyID: case Type::ShortTyID:
529 return ".half";
530 case Type::UIntTyID: case Type::IntTyID:
531 return ".word";
532 case Type::ULongTyID: case Type::LongTyID: case Type::PointerTyID:
533 return ".xword";
534 case Type::FloatTyID:
Chris Lattnerf678dc62002-04-11 21:44:02 +0000535 return ".word";
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000536 case Type::DoubleTyID:
Chris Lattnerf678dc62002-04-11 21:44:02 +0000537 return ".xword";
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000538 case Type::ArrayTyID:
539 if (ArrayTypeIsString((ArrayType*) type))
540 return ".ascii";
541 else
542 return "<InvaliDataTypeForPrinting>";
543 default:
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000544 return "<InvaliDataTypeForPrinting>";
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000545 }
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000546}
547
Vikram S. Adve21447222001-11-10 02:03:06 +0000548// Get the size of the constant for the given target.
549// If this is an unsized array, return 0.
550//
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000551inline unsigned int
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000552ConstantToSize(const Constant* CV, const TargetMachine& target)
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000553{
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000554 if (ConstantArray* CPA = dyn_cast<ConstantArray>(CV))
Vikram S. Adve21447222001-11-10 02:03:06 +0000555 {
556 ArrayType *aty = cast<ArrayType>(CPA->getType());
557 if (ArrayTypeIsString(aty))
558 return 1 + CPA->getNumOperands();
Vikram S. Adve21447222001-11-10 02:03:06 +0000559 }
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000560
561 return target.findOptimalStorageSize(CV->getType());
562}
563
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000564
565
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000566// Align data larger than one L1 cache line on L1 cache line boundaries.
Vikram S. Adve21447222001-11-10 02:03:06 +0000567// Align all smaller data on the next higher 2^x boundary (4, 8, ...).
568//
569inline unsigned int
570SizeToAlignment(unsigned int size, const TargetMachine& target)
571{
572 unsigned short cacheLineSize = target.getCacheInfo().getCacheLineSize(1);
573 if (size > (unsigned) cacheLineSize / 2)
574 return cacheLineSize;
575 else
576 for (unsigned sz=1; /*no condition*/; sz *= 2)
577 if (sz >= size)
578 return sz;
579}
580
581// Get the size of the type and then use SizeToAlignment.
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000582//
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000583inline unsigned int
584TypeToAlignment(const Type* type, const TargetMachine& target)
585{
Vikram S. Adve21447222001-11-10 02:03:06 +0000586 return SizeToAlignment(target.findOptimalStorageSize(type), target);
587}
588
589// Get the size of the constant and then use SizeToAlignment.
590// Handles strings as a special case;
591inline unsigned int
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000592ConstantToAlignment(const Constant* CV, const TargetMachine& target)
Vikram S. Adve21447222001-11-10 02:03:06 +0000593{
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000594 if (ConstantArray* CPA = dyn_cast<ConstantArray>(CV))
Vikram S. Adve21447222001-11-10 02:03:06 +0000595 if (ArrayTypeIsString(cast<ArrayType>(CPA->getType())))
596 return SizeToAlignment(1 + CPA->getNumOperands(), target);
597
598 return TypeToAlignment(CV->getType(), target);
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000599}
600
601
Vikram S. Adve21447222001-11-10 02:03:06 +0000602// Print a single constant value.
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000603void
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000604SparcModuleAsmPrinter::printSingleConstant(const Constant* CV)
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000605{
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000606 assert(CV->getType() != Type::VoidTy &&
607 CV->getType() != Type::TypeTy &&
608 CV->getType() != Type::LabelTy &&
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000609 "Unexpected type for Constant");
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000610
Chris Lattnerf678dc62002-04-11 21:44:02 +0000611 assert((!isa<ConstantArray>(CV) && ! isa<ConstantStruct>(CV))
612 && "Aggregate types should be handled outside this function");
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000613
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000614 toAsm << "\t" << TypeToDataDirective(CV->getType()) << "\t";
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000615
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000616 if (CV->getType()->isPrimitiveType())
617 {
Chris Lattnerf678dc62002-04-11 21:44:02 +0000618 if (CV->getType()->isFloatingPoint()) {
619 // FP Constants are printed as integer constants to avoid losing
620 // precision...
621 double Val = cast<ConstantFP>(CV)->getValue();
622 if (CV->getType() == Type::FloatTy) {
623 float FVal = (float)Val;
624 char *ProxyPtr = (char*)&FVal; // Abide by C TBAA rules
625 toAsm << *(unsigned int*)ProxyPtr;
626 } else if (CV->getType() == Type::DoubleTy) {
627 char *ProxyPtr = (char*)&Val; // Abide by C TBAA rules
628 toAsm << *(uint64_t*)ProxyPtr;
629 } else {
630 assert(0 && "Unknown floating point type!");
631 }
632
633 toAsm << "\t! " << CV->getType()->getDescription()
634 << " value: " << Val << "\n";
635 } else {
Chris Lattner4b1de8e2002-04-18 18:15:38 +0000636 WriteAsOperand(toAsm, CV, false, false) << "\n";
Chris Lattnerf678dc62002-04-11 21:44:02 +0000637 }
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000638 }
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000639 else if (ConstantPointer* CPP = dyn_cast<ConstantPointer>(CV))
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000640 {
Chris Lattner697954c2002-01-20 22:54:45 +0000641 assert(CPP->isNullValue() &&
642 "Cannot yet print non-null pointer constants to assembly");
643 toAsm << "0\n";
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000644 }
Chris Lattner697954c2002-01-20 22:54:45 +0000645 else if (isa<ConstantPointerRef>(CV))
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000646 {
647 assert(0 && "Cannot yet initialize pointer refs in assembly");
648 }
649 else
650 {
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000651 assert(0 && "Unknown elementary type for constant");
Vikram S. Adve29ff8732001-11-08 05:12:37 +0000652 }
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000653}
654
Vikram S. Adve21447222001-11-10 02:03:06 +0000655// Print a constant value or values (it may be an aggregate).
656// Uses printSingleConstant() to print each individual value.
657void
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000658SparcModuleAsmPrinter::printConstantValueOnly(const Constant* CV)
Vikram S. Adve21447222001-11-10 02:03:06 +0000659{
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000660 ConstantArray *CPA = dyn_cast<ConstantArray>(CV);
Vikram S. Adve21447222001-11-10 02:03:06 +0000661
662 if (CPA && isStringCompatible(CPA))
663 { // print the string alone and return
Chris Lattner697954c2002-01-20 22:54:45 +0000664 toAsm << "\t" << ".ascii" << "\t" << getAsCString(CPA) << "\n";
Vikram S. Adve21447222001-11-10 02:03:06 +0000665 }
666 else if (CPA)
667 { // Not a string. Print the values in successive locations
Chris Lattner697954c2002-01-20 22:54:45 +0000668 const std::vector<Use> &constValues = CPA->getValues();
Vikram S. Adve21447222001-11-10 02:03:06 +0000669 for (unsigned i=1; i < constValues.size(); i++)
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000670 this->printConstantValueOnly(cast<Constant>(constValues[i].get()));
Vikram S. Adve21447222001-11-10 02:03:06 +0000671 }
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000672 else if (ConstantStruct *CPS = dyn_cast<ConstantStruct>(CV))
Vikram S. Adve21447222001-11-10 02:03:06 +0000673 { // Print the fields in successive locations
Chris Lattner697954c2002-01-20 22:54:45 +0000674 const std::vector<Use>& constValues = CPS->getValues();
Vikram S. Adve21447222001-11-10 02:03:06 +0000675 for (unsigned i=1; i < constValues.size(); i++)
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000676 this->printConstantValueOnly(cast<Constant>(constValues[i].get()));
Vikram S. Adve21447222001-11-10 02:03:06 +0000677 }
678 else
679 this->printSingleConstant(CV);
680}
681
682// Print a constant (which may be an aggregate) prefixed by all the
683// appropriate directives. Uses printConstantValueOnly() to print the
684// value or values.
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000685void
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000686SparcModuleAsmPrinter::printConstant(const Constant* CV, string valID)
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000687{
688 if (valID.length() == 0)
689 valID = getID(CV);
690
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000691 toAsm << "\t.align\t" << ConstantToAlignment(CV, Target) << "\n";
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000692
693 // Print .size and .type only if it is not a string.
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000694 ConstantArray *CPA = dyn_cast<ConstantArray>(CV);
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000695 if (CPA && isStringCompatible(CPA))
696 { // print it as a string and return
Chris Lattner697954c2002-01-20 22:54:45 +0000697 toAsm << valID << ":\n";
698 toAsm << "\t" << ".ascii" << "\t" << getAsCString(CPA) << "\n";
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000699 return;
700 }
Vikram S. Adve21447222001-11-10 02:03:06 +0000701
Chris Lattner697954c2002-01-20 22:54:45 +0000702 toAsm << "\t.type" << "\t" << valID << ",#object\n";
Vikram S. Adve21447222001-11-10 02:03:06 +0000703
704 unsigned int constSize = ConstantToSize(CV, Target);
705 if (constSize)
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000706 toAsm << "\t.size" << "\t" << valID << "," << constSize << "\n";
Vikram S. Adve21447222001-11-10 02:03:06 +0000707
Chris Lattner697954c2002-01-20 22:54:45 +0000708 toAsm << valID << ":\n";
Vikram S. Adve915b58d2001-11-09 02:19:29 +0000709
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000710 printConstantValueOnly(CV);
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000711}
712
713
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000714void SparcModuleAsmPrinter::FoldConstants(const Module *M,
715 std::hash_set<const Constant*> &MC) {
716 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
717 if (!(*I)->isExternal()) {
718 const std::hash_set<const Constant*> &pool =
719 MachineCodeForMethod::get(*I).getConstantPoolValues();
720 MC.insert(pool.begin(), pool.end());
721 }
722}
723
724void SparcModuleAsmPrinter::printGlobalVariable(const GlobalVariable* GV)
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000725{
Chris Lattner697954c2002-01-20 22:54:45 +0000726 toAsm << "\t.global\t" << getID(GV) << "\n";
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000727
728 if (GV->hasInitializer())
729 printConstant(GV->getInitializer(), getID(GV));
730 else {
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000731 toAsm << "\t.align\t" << TypeToAlignment(GV->getType()->getElementType(),
732 Target) << "\n";
Chris Lattner697954c2002-01-20 22:54:45 +0000733 toAsm << "\t.type\t" << getID(GV) << ",#object\n";
Vikram S. Adveffbba0f2001-11-08 14:29:57 +0000734 toAsm << "\t.reserve\t" << getID(GV) << ","
Chris Lattnerc019a172002-02-03 07:48:06 +0000735 << Target.findOptimalStorageSize(GV->getType()->getElementType())
Chris Lattner697954c2002-01-20 22:54:45 +0000736 << "\n";
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000737 }
738}
739
740
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000741void SparcModuleAsmPrinter::emitGlobalsAndConstants(const Module *M) {
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000742 // First, get the constants there were marked by the code generator for
743 // inclusion in the assembly code data area and fold them all into a
744 // single constant pool since there may be lots of duplicates. Also,
745 // lets force these constants into the slot table so that we can get
746 // unique names for unnamed constants also.
747 //
Chris Lattner697954c2002-01-20 22:54:45 +0000748 std::hash_set<const Constant*> moduleConstants;
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000749 FoldConstants(M, moduleConstants);
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000750
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000751 // Now, emit the three data sections separately; the cost of I/O should
752 // make up for the cost of extra passes over the globals list!
Vikram S. Advefbd21612002-03-31 19:03:58 +0000753
754 // Section 1 : Read-only data section (implies initialized)
755 enterSection(AsmPrinter::ReadOnlyData);
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000756 for (Module::const_giterator GI=M->gbegin(), GE=M->gend(); GI != GE; ++GI)
Vikram S. Advefbd21612002-03-31 19:03:58 +0000757 if ((*GI)->hasInitializer() && (*GI)->isConstant())
758 printGlobalVariable(*GI);
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000759
Chris Lattner697954c2002-01-20 22:54:45 +0000760 for (std::hash_set<const Constant*>::const_iterator
761 I = moduleConstants.begin(),
Chris Lattnere9bb2df2001-12-03 22:26:30 +0000762 E = moduleConstants.end(); I != E; ++I)
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000763 printConstant(*I);
764
Vikram S. Advefbd21612002-03-31 19:03:58 +0000765 // Section 2 : Initialized read-write data section
766 enterSection(AsmPrinter::InitRWData);
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000767 for (Module::const_giterator GI=M->gbegin(), GE=M->gend(); GI != GE; ++GI)
Vikram S. Advefbd21612002-03-31 19:03:58 +0000768 if ((*GI)->hasInitializer() && ! (*GI)->isConstant())
769 printGlobalVariable(*GI);
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000770
Vikram S. Advefbd21612002-03-31 19:03:58 +0000771 // Section 3 : Uninitialized read-write data section
772 enterSection(AsmPrinter::UninitRWData);
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000773 for (Module::const_giterator GI=M->gbegin(), GE=M->gend(); GI != GE; ++GI)
Vikram S. Advefbd21612002-03-31 19:03:58 +0000774 if (! (*GI)->hasInitializer())
775 printGlobalVariable(*GI);
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000776
Chris Lattner697954c2002-01-20 22:54:45 +0000777 toAsm << "\n";
Vikram S. Adve953c83e2001-10-28 21:38:52 +0000778}
779
Chris Lattnere88f78c2001-09-19 13:47:27 +0000780} // End anonymous namespace
781
Chris Lattnerc19b8b12002-02-03 23:41:08 +0000782Pass *UltraSparc::getModuleAsmPrinterPass(PassManager &PM, std::ostream &Out) {
783 return new SparcModuleAsmPrinter(Out, *this);
Chris Lattnerc019a172002-02-03 07:48:06 +0000784}