1 //===-- PIC16AsmPrinter.cpp - PIC16 LLVM assembly writer ------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains a printer that converts from our internal representation
11 // of machine-dependent LLVM code to PIC16 assembly language.
13 //===----------------------------------------------------------------------===//
15 #include "PIC16AsmPrinter.h"
16 #include "MCSectionPIC16.h"
17 #include "PIC16MCAsmInfo.h"
18 #include "llvm/DerivedTypes.h"
19 #include "llvm/Function.h"
20 #include "llvm/Module.h"
21 #include "llvm/CodeGen/DwarfWriter.h"
22 #include "llvm/CodeGen/MachineFrameInfo.h"
23 #include "llvm/CodeGen/DwarfWriter.h"
24 #include "llvm/CodeGen/MachineModuleInfo.h"
25 #include "llvm/MC/MCStreamer.h"
26 #include "llvm/MC/MCSymbol.h"
27 #include "llvm/Target/TargetRegistry.h"
28 #include "llvm/Target/TargetLoweringObjectFile.h"
29 #include "llvm/Support/ErrorHandling.h"
30 #include "llvm/Support/FormattedStream.h"
31 #include "llvm/Support/Mangler.h"
35 #include "PIC16GenAsmWriter.inc"
37 PIC16AsmPrinter::PIC16AsmPrinter(formatted_raw_ostream &O, TargetMachine &TM,
38 const MCAsmInfo *T, bool V)
39 : AsmPrinter(O, TM, T, V), DbgInfo(O, T) {
40 PTLI = static_cast<PIC16TargetLowering*>(TM.getTargetLowering());
41 PMAI = static_cast<const PIC16MCAsmInfo*>(T);
42 PTOF = (PIC16TargetObjectFile*)&PTLI->getObjFileLowering();
45 bool PIC16AsmPrinter::printMachineInstruction(const MachineInstr *MI) {
46 processDebugLoc(MI->getDebugLoc());
50 if (VerboseAsm && !MI->getDebugLoc().isUnknown())
56 /// runOnMachineFunction - This emits the frame section, autos section and
57 /// assembly for each instruction. Also takes care of function begin debug
58 /// directive and file begin debug directive (if required) for the function.
60 bool PIC16AsmPrinter::runOnMachineFunction(MachineFunction &MF) {
63 // This calls the base class function required to be called at beginning
64 // of runOnMachineFunction.
65 SetupMachineFunction(MF);
67 // Get the mangled name.
68 const Function *F = MF.getFunction();
69 CurrentFnName = Mang->getMangledName(F);
71 // Emit the function frame (args and temps).
72 EmitFunctionFrame(MF);
74 DbgInfo.BeginFunction(MF);
76 // Emit the autos section of function.
77 EmitAutos(CurrentFnName);
79 // Now emit the instructions of function in its code section.
80 const MCSection *fCodeSection =
81 getObjFileLowering().getSectionForFunction(CurrentFnName);
82 // Start the Code Section.
84 OutStreamer.SwitchSection(fCodeSection);
86 // Emit the frame address of the function at the beginning of code.
87 O << "\tretlw low(" << PAN::getFrameLabel(CurrentFnName) << ")\n";
88 O << "\tretlw high(" << PAN::getFrameLabel(CurrentFnName) << ")\n";
90 // Emit function start label.
91 O << CurrentFnName << ":\n";
95 // Print out code for the function.
96 for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
99 // Print a label for the basic block.
100 if (I != MF.begin()) {
101 EmitBasicBlockStart(I);
105 // Print a basic block.
106 for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
109 // Emit the line directive if source line changed.
110 const DebugLoc DL = II->getDebugLoc();
111 if (!DL.isUnknown() && DL != CurDL) {
112 DbgInfo.ChangeDebugLoc(MF, DL);
116 // Print the assembly for the instruction.
117 printMachineInstruction(II);
121 // Emit function end debug directives.
122 DbgInfo.EndFunction(MF);
124 return false; // we didn't modify anything.
128 // printOperand - print operand of insn.
129 void PIC16AsmPrinter::printOperand(const MachineInstr *MI, int opNum) {
130 const MachineOperand &MO = MI->getOperand(opNum);
132 switch (MO.getType()) {
133 case MachineOperand::MO_Register:
134 O << getRegisterName(MO.getReg());
137 case MachineOperand::MO_Immediate:
138 O << (int)MO.getImm();
141 case MachineOperand::MO_GlobalAddress: {
142 std::string Sname = Mang->getMangledName(MO.getGlobal());
143 // FIXME: currently we do not have a memcpy def coming in the module
144 // by any chance, as we do not link in those as .bc lib. So these calls
145 // are always external and it is safe to emit an extern.
146 if (PAN::isMemIntrinsic(Sname)) {
147 LibcallDecls.push_back(createESName(Sname));
153 case MachineOperand::MO_ExternalSymbol: {
154 const char *Sname = MO.getSymbolName();
156 // If its a libcall name, record it to decls section.
157 if (PAN::getSymbolTag(Sname) == PAN::LIBCALL) {
158 LibcallDecls.push_back(Sname);
161 // Record a call to intrinsic to print the extern declaration for it.
162 std::string Sym = Sname;
163 if (PAN::isMemIntrinsic(Sym)) {
164 Sym = PAN::addPrefix(Sym);
165 LibcallDecls.push_back(createESName(Sym));
171 case MachineOperand::MO_MachineBasicBlock:
172 GetMBBSymbol(MO.getMBB()->getNumber())->print(O, MAI);
176 llvm_unreachable(" Operand type not supported.");
180 /// printCCOperand - Print the cond code operand.
182 void PIC16AsmPrinter::printCCOperand(const MachineInstr *MI, int opNum) {
183 int CC = (int)MI->getOperand(opNum).getImm();
184 O << PIC16CondCodeToString((PIC16CC::CondCodes)CC);
187 // This function is used to sort the decls list.
188 // should return true if s1 should come before s2.
189 static bool is_before(const char *s1, const char *s2) {
190 return strcmp(s1, s2) <= 0;
193 // This is used by list::unique below.
194 // unique will filter out duplicates if it knows them.
195 static bool is_duplicate(const char *s1, const char *s2) {
196 return !strcmp(s1, s2);
199 /// printLibcallDecls - print the extern declarations for compiler
202 void PIC16AsmPrinter::printLibcallDecls() {
203 // If no libcalls used, return.
204 if (LibcallDecls.empty()) return;
206 O << MAI->getCommentString() << "External decls for libcalls - BEGIN." <<"\n";
207 // Remove duplicate entries.
208 LibcallDecls.sort(is_before);
209 LibcallDecls.unique(is_duplicate);
211 for (std::list<const char*>::const_iterator I = LibcallDecls.begin();
212 I != LibcallDecls.end(); I++) {
213 O << MAI->getExternDirective() << *I << "\n";
214 O << MAI->getExternDirective() << PAN::getArgsLabel(*I) << "\n";
215 O << MAI->getExternDirective() << PAN::getRetvalLabel(*I) << "\n";
217 O << MAI->getCommentString() << "External decls for libcalls - END." <<"\n";
220 /// doInitialization - Perform Module level initializations here.
221 /// One task that we do here is to sectionize all global variables.
222 /// The MemSelOptimizer pass depends on the sectionizing.
224 bool PIC16AsmPrinter::doInitialization(Module &M) {
225 bool Result = AsmPrinter::doInitialization(M);
227 // FIXME:: This is temporary solution to generate the include file.
228 // The processor should be passed to llc as in input and the header file
229 // should be generated accordingly.
230 O << "\n\t#include P16F1937.INC\n";
232 // Set the section names for all globals.
233 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
235 if (!I->isDeclaration() && !I->hasAvailableExternallyLinkage()) {
236 const MCSection *S = getObjFileLowering().SectionForGlobal(I, Mang, TM);
238 I->setSection(((const MCSectionPIC16*)S)->getName());
241 DbgInfo.BeginModule(M);
242 EmitFunctionDecls(M);
243 EmitUndefinedVars(M);
251 /// Emit extern decls for functions imported from other modules, and emit
252 /// global declarations for function defined in this module and which are
253 /// available to other modules.
255 void PIC16AsmPrinter::EmitFunctionDecls(Module &M) {
256 // Emit declarations for external functions.
257 O <<"\n"<<MAI->getCommentString() << "Function Declarations - BEGIN." <<"\n";
258 for (Module::iterator I = M.begin(), E = M.end(); I != E; I++) {
259 if (I->isIntrinsic())
262 std::string Name = Mang->getMangledName(I);
263 if (Name.compare("@abort") == 0)
266 if (!I->isDeclaration() && !I->hasExternalLinkage())
269 // Do not emit memcpy, memset, and memmove here.
270 // Calls to these routines can be generated in two ways,
271 // 1. User calling the standard lib function
272 // 2. Codegen generating these calls for llvm intrinsics.
273 // In the first case a prototype is alread availale, while in
274 // second case the call is via and externalsym and the prototype is missing.
275 // So declarations for these are currently always getting printing by
276 // tracking both kind of references in printInstrunction.
277 if (I->isDeclaration() && PAN::isMemIntrinsic(Name)) continue;
279 const char *directive = I->isDeclaration() ? MAI->getExternDirective() :
280 MAI->getGlobalDirective();
282 O << directive << Name << "\n";
283 O << directive << PAN::getRetvalLabel(Name) << "\n";
284 O << directive << PAN::getArgsLabel(Name) << "\n";
287 O << MAI->getCommentString() << "Function Declarations - END." <<"\n";
290 // Emit variables imported from other Modules.
291 void PIC16AsmPrinter::EmitUndefinedVars(Module &M) {
292 std::vector<const GlobalVariable*> Items = PTOF->ExternalVarDecls->Items;
293 if (!Items.size()) return;
295 O << "\n" << MAI->getCommentString() << "Imported Variables - BEGIN" << "\n";
296 for (unsigned j = 0; j < Items.size(); j++) {
297 O << MAI->getExternDirective() << Mang->getMangledName(Items[j]) << "\n";
299 O << MAI->getCommentString() << "Imported Variables - END" << "\n";
302 // Emit variables defined in this module and are available to other modules.
303 void PIC16AsmPrinter::EmitDefinedVars(Module &M) {
304 std::vector<const GlobalVariable*> Items = PTOF->ExternalVarDefs->Items;
305 if (!Items.size()) return;
307 O << "\n" << MAI->getCommentString() << "Exported Variables - BEGIN" << "\n";
308 for (unsigned j = 0; j < Items.size(); j++) {
309 O << MAI->getGlobalDirective() << Mang->getMangledName(Items[j]) << "\n";
311 O << MAI->getCommentString() << "Exported Variables - END" << "\n";
314 // Emit initialized data placed in ROM.
315 void PIC16AsmPrinter::EmitRomData(Module &M) {
316 // Print ROM Data section.
317 const std::vector<PIC16Section*> &ROSections = PTOF->ROSections;
318 for (unsigned i = 0; i < ROSections.size(); i++) {
319 const std::vector<const GlobalVariable*> &Items = ROSections[i]->Items;
320 if (!Items.size()) continue;
322 OutStreamer.SwitchSection(PTOF->ROSections[i]->S_);
323 for (unsigned j = 0; j < Items.size(); j++) {
324 O << Mang->getMangledName(Items[j]);
325 Constant *C = Items[j]->getInitializer();
326 int AddrSpace = Items[j]->getType()->getAddressSpace();
327 EmitGlobalConstant(C, AddrSpace);
332 bool PIC16AsmPrinter::doFinalization(Module &M) {
334 EmitRemainingAutos();
335 DbgInfo.EndModule(M);
336 O << "\n\t" << "END\n";
337 return AsmPrinter::doFinalization(M);
340 void PIC16AsmPrinter::EmitFunctionFrame(MachineFunction &MF) {
341 const Function *F = MF.getFunction();
342 std::string FuncName = Mang->getMangledName(F);
343 const TargetData *TD = TM.getTargetData();
344 // Emit the data section name.
347 const MCSection *fPDataSection =
348 getObjFileLowering().getSectionForFunctionFrame(CurrentFnName);
349 OutStreamer.SwitchSection(fPDataSection);
351 // Emit function frame label
352 O << PAN::getFrameLabel(CurrentFnName) << ":\n";
354 const Type *RetType = F->getReturnType();
355 unsigned RetSize = 0;
356 if (RetType->getTypeID() != Type::VoidTyID)
357 RetSize = TD->getTypeAllocSize(RetType);
359 //Emit function return value space
360 // FIXME: Do not emit RetvalLable when retsize is zero. To do this
361 // we will need to avoid printing a global directive for Retval label
362 // in emitExternandGloblas.
364 O << PAN::getRetvalLabel(CurrentFnName) << " RES " << RetSize << "\n";
366 O << PAN::getRetvalLabel(CurrentFnName) << ": \n";
368 // Emit variable to hold the space for function arguments
369 unsigned ArgSize = 0;
370 for (Function::const_arg_iterator argi = F->arg_begin(),
371 arge = F->arg_end(); argi != arge ; ++argi) {
372 const Type *Ty = argi->getType();
373 ArgSize += TD->getTypeAllocSize(Ty);
376 O << PAN::getArgsLabel(CurrentFnName) << " RES " << ArgSize << "\n";
378 // Emit temporary space
379 int TempSize = PTLI->GetTmpSize();
381 O << PAN::getTempdataLabel(CurrentFnName) << " RES " << TempSize << '\n';
384 void PIC16AsmPrinter::EmitIData(Module &M) {
386 // Print all IDATA sections.
387 const std::vector<PIC16Section*> &IDATASections = PTOF->IDATASections;
388 for (unsigned i = 0; i < IDATASections.size(); i++) {
390 if (IDATASections[i]->S_->getName().find("llvm.") != std::string::npos)
392 OutStreamer.SwitchSection(IDATASections[i]->S_);
393 std::vector<const GlobalVariable*> Items = IDATASections[i]->Items;
394 for (unsigned j = 0; j < Items.size(); j++) {
395 std::string Name = Mang->getMangledName(Items[j]);
396 Constant *C = Items[j]->getInitializer();
397 int AddrSpace = Items[j]->getType()->getAddressSpace();
399 EmitGlobalConstant(C, AddrSpace);
404 void PIC16AsmPrinter::EmitUData(Module &M) {
405 const TargetData *TD = TM.getTargetData();
407 // Print all BSS sections.
408 const std::vector<PIC16Section*> &BSSSections = PTOF->BSSSections;
409 for (unsigned i = 0; i < BSSSections.size(); i++) {
411 OutStreamer.SwitchSection(BSSSections[i]->S_);
412 std::vector<const GlobalVariable*> Items = BSSSections[i]->Items;
413 for (unsigned j = 0; j < Items.size(); j++) {
414 std::string Name = Mang->getMangledName(Items[j]);
415 Constant *C = Items[j]->getInitializer();
416 const Type *Ty = C->getType();
417 unsigned Size = TD->getTypeAllocSize(Ty);
419 O << Name << " RES " << Size << "\n";
424 void PIC16AsmPrinter::EmitAutos(std::string FunctName) {
425 // Section names for all globals are already set.
426 const TargetData *TD = TM.getTargetData();
428 // Now print Autos section for this function.
429 std::string SectionName = PAN::getAutosSectionName(FunctName);
430 const std::vector<PIC16Section*> &AutosSections = PTOF->AutosSections;
431 for (unsigned i = 0; i < AutosSections.size(); i++) {
433 if (AutosSections[i]->S_->getName() == SectionName) {
434 // Set the printing status to true
435 AutosSections[i]->setPrintedStatus(true);
436 OutStreamer.SwitchSection(AutosSections[i]->S_);
437 const std::vector<const GlobalVariable*> &Items = AutosSections[i]->Items;
438 for (unsigned j = 0; j < Items.size(); j++) {
439 std::string VarName = Mang->getMangledName(Items[j]);
440 Constant *C = Items[j]->getInitializer();
441 const Type *Ty = C->getType();
442 unsigned Size = TD->getTypeAllocSize(Ty);
443 // Emit memory reserve directive.
444 O << VarName << " RES " << Size << "\n";
451 // Print autos that were not printed during the code printing of functions.
452 // As the functions might themselves would have got deleted by the optimizer.
453 void PIC16AsmPrinter::EmitRemainingAutos() {
454 const TargetData *TD = TM.getTargetData();
456 // Now print Autos section for this function.
457 std::vector <PIC16Section *>AutosSections = PTOF->AutosSections;
458 for (unsigned i = 0; i < AutosSections.size(); i++) {
460 // if the section is already printed then don't print again
461 if (AutosSections[i]->isPrinted())
464 // Set status as printed
465 AutosSections[i]->setPrintedStatus(true);
468 OutStreamer.SwitchSection(AutosSections[i]->S_);
469 const std::vector<const GlobalVariable*> &Items = AutosSections[i]->Items;
470 for (unsigned j = 0; j < Items.size(); j++) {
471 std::string VarName = Mang->getMangledName(Items[j]);
472 Constant *C = Items[j]->getInitializer();
473 const Type *Ty = C->getType();
474 unsigned Size = TD->getTypeAllocSize(Ty);
475 // Emit memory reserve directive.
476 O << VarName << " RES " << Size << "\n";
482 extern "C" void LLVMInitializePIC16AsmPrinter() {
483 RegisterAsmPrinter<PIC16AsmPrinter> X(ThePIC16Target);