lib/Target/PIC16/PIC16AsmPrinter.cpp

   1 //===-- PIC16AsmPrinter.cpp - PIC16 LLVM assembly writer ------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains a printer that converts from our internal representation
  11 // of machine-dependent LLVM code to PIC16 assembly language.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "PIC16AsmPrinter.h"
  16 #include "PIC16TargetAsmInfo.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/Function.h"
  19 #include "llvm/Module.h"
  20 #include "llvm/CodeGen/DwarfWriter.h"
  21 #include "llvm/Support/FormattedStream.h"
  22 #include "llvm/CodeGen/MachineFrameInfo.h"
  23 #include "llvm/Support/Mangler.h"
  24 #include "llvm/Support/ErrorHandling.h"
  25 #include "llvm/CodeGen/DwarfWriter.h"
  26 #include "llvm/CodeGen/MachineModuleInfo.h"
  27
  28 using namespace llvm;
  29
  30 #include "PIC16GenAsmWriter.inc"
  31
  32 bool PIC16AsmPrinter::printMachineInstruction(const MachineInstr *MI) {
  33   printInstruction(MI);
  34   return true;
  35 }
  36
  37 /// runOnMachineFunction - This emits the frame section, autos section and
  38 /// assembly for each instruction. Also takes care of function begin debug
  39 /// directive and file begin debug directive (if required) for the function.
  40 ///
  41 bool PIC16AsmPrinter::runOnMachineFunction(MachineFunction &MF) {
  42   this->MF = &MF;
  43
  44   // This calls the base class function required to be called at beginning
  45   // of runOnMachineFunction.
  46   SetupMachineFunction(MF);
  47
  48   // Get the mangled name.
  49   const Function *F = MF.getFunction();
  50   CurrentFnName = Mang->getMangledName(F);
  51
  52   // Emit the function frame (args and temps).
  53   EmitFunctionFrame(MF);
  54
  55   DbgInfo.BeginFunction(MF);
  56
  57   // Emit the autos section of function.
  58   EmitAutos(CurrentFnName);
  59
  60   // Now emit the instructions of function in its code section.
  61   const char *codeSection = PAN::getCodeSectionName(CurrentFnName).c_str();
  62
  63   const Section *fCodeSection = TAI->getNamedSection(codeSection,
  64                                                      SectionFlags::Code);
  65   // Start the Code Section.
  66   O <<  "\n";
  67   SwitchToSection(fCodeSection);
  68
  69   // Emit the frame address of the function at the beginning of code.
  70   O << "\tretlw  low(" << PAN::getFrameLabel(CurrentFnName) << ")\n";
  71   O << "\tretlw  high(" << PAN::getFrameLabel(CurrentFnName) << ")\n";
  72
  73   // Emit function start label.
  74   O << CurrentFnName << ":\n";
  75
  76   DebugLoc CurDL;
  77   O << "\n";
  78   // Print out code for the function.
  79   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
  80        I != E; ++I) {
  81
  82     // Print a label for the basic block.
  83     if (I != MF.begin()) {
  84       printBasicBlockLabel(I, true);
  85       O << '\n';
  86     }
  87
  88     // Print a basic block.
  89     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
  90          II != E; ++II) {
  91
  92       // Emit the line directive if source line changed.
  93       const DebugLoc DL = II->getDebugLoc();
  94       if (!DL.isUnknown() && DL != CurDL) {
  95         DbgInfo.ChangeDebugLoc(MF, DL);
  96         CurDL = DL;
  97       }
  98
  99       // Print the assembly for the instruction.
 100       printMachineInstruction(II);
 101     }
 102   }
 103
 104   // Emit function end debug directives.
 105   DbgInfo.EndFunction(MF);
 106
 107   return false;  // we didn't modify anything.
 108 }
 109
 110 /// createPIC16CodePrinterPass - Returns a pass that prints the PIC16
 111 /// assembly code for a MachineFunction to the given output stream,
 112 /// using the given target machine description.  This should work
 113 /// regardless of whether the function is in SSA form.
 114 ///
 115 FunctionPass *llvm::createPIC16CodePrinterPass(formatted_raw_ostream &o,
 116                                                TargetMachine &tm,
 117                                                bool verbose) {
 118   return new PIC16AsmPrinter(o, tm, tm.getTargetAsmInfo(), verbose);
 119 }
 120
 121
 122 // printOperand - print operand of insn.
 123 void PIC16AsmPrinter::printOperand(const MachineInstr *MI, int opNum) {
 124   const MachineOperand &MO = MI->getOperand(opNum);
 125
 126   switch (MO.getType()) {
 127     case MachineOperand::MO_Register:
 128       if (TargetRegisterInfo::isPhysicalRegister(MO.getReg()))
 129         O << TM.getRegisterInfo()->get(MO.getReg()).AsmName;
 130       else
 131         llvm_unreachable("not implemented");
 132       return;
 133
 134     case MachineOperand::MO_Immediate:
 135       O << (int)MO.getImm();
 136       return;
 137
 138     case MachineOperand::MO_GlobalAddress: {
 139       O << Mang->getMangledName(MO.getGlobal());
 140       break;
 141     }
 142     case MachineOperand::MO_ExternalSymbol: {
 143        const char *Sname = MO.getSymbolName();
 144
 145       // If its a libcall name, record it to decls section.
 146       if (PAN::getSymbolTag(Sname) == PAN::LIBCALL) {
 147         LibcallDecls.push_back(Sname);
 148       }
 149
 150       O  << Sname;
 151       break;
 152     }
 153     case MachineOperand::MO_MachineBasicBlock:
 154       printBasicBlockLabel(MO.getMBB());
 155       return;
 156
 157     default:
 158       llvm_unreachable(" Operand type not supported.");
 159   }
 160 }
 161
 162 /// printCCOperand - Print the cond code operand.
 163 ///
 164 void PIC16AsmPrinter::printCCOperand(const MachineInstr *MI, int opNum) {
 165   int CC = (int)MI->getOperand(opNum).getImm();
 166   O << PIC16CondCodeToString((PIC16CC::CondCodes)CC);
 167 }
 168
 169 /// printLibcallDecls - print the extern declarations for compiler
 170 /// intrinsics.
 171 ///
 172 void PIC16AsmPrinter::printLibcallDecls(void) {
 173   // If no libcalls used, return.
 174   if (LibcallDecls.empty()) return;
 175
 176   O << TAI->getCommentString() << "External decls for libcalls - BEGIN." <<"\n";
 177   // Remove duplicate entries.
 178   LibcallDecls.sort();
 179   LibcallDecls.unique();
 180   for (std::list<const char*>::const_iterator I = LibcallDecls.begin();
 181        I != LibcallDecls.end(); I++) {
 182     O << TAI->getExternDirective() << *I << "\n";
 183     O << TAI->getExternDirective() << PAN::getArgsLabel(*I) << "\n";
 184     O << TAI->getExternDirective() << PAN::getRetvalLabel(*I) << "\n";
 185   }
 186   O << TAI->getCommentString() << "External decls for libcalls - END." <<"\n";
 187 }
 188
 189 /// doInitialization - Perfrom Module level initializations here.
 190 /// One task that we do here is to sectionize all global variables.
 191 /// The MemSelOptimizer pass depends on the sectionizing.
 192 ///
 193 bool PIC16AsmPrinter::doInitialization(Module &M) {
 194   bool Result = AsmPrinter::doInitialization(M);
 195
 196   // FIXME:: This is temporary solution to generate the include file.
 197   // The processor should be passed to llc as in input and the header file
 198   // should be generated accordingly.
 199   O << "\n\t#include P16F1937.INC\n";
 200
 201   // Set the section names for all globals.
 202   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 203        I != E; ++I) {
 204     I->setSection(TAI->SectionForGlobal(I)->getName());
 205   }
 206
 207   DbgInfo.BeginModule(M);
 208   EmitFunctionDecls(M);
 209   EmitUndefinedVars(M);
 210   EmitDefinedVars(M);
 211   EmitIData(M);
 212   EmitUData(M);
 213   EmitRomData(M);
 214   return Result;
 215 }
 216
 217 /// Emit extern decls for functions imported from other modules, and emit
 218 /// global declarations for function defined in this module and which are
 219 /// available to other modules.
 220 ///
 221 void PIC16AsmPrinter::EmitFunctionDecls(Module &M) {
 222  // Emit declarations for external functions.
 223   O <<"\n"<<TAI->getCommentString() << "Function Declarations - BEGIN." <<"\n";
 224   for (Module::iterator I = M.begin(), E = M.end(); I != E; I++) {
 225     std::string Name = Mang->getMangledName(I);
 226     if (Name.compare("@abort") == 0)
 227       continue;
 228
 229     // If it is llvm intrinsic call then don't emit
 230     if (Name.find("llvm.") != std::string::npos)
 231       continue;
 232
 233     if (!I->isDeclaration() && !I->hasExternalLinkage())
 234       continue;
 235
 236     const char *directive = I->isDeclaration() ? TAI->getExternDirective() :
 237                                                  TAI->getGlobalDirective();
 238
 239     O << directive << Name << "\n";
 240     O << directive << PAN::getRetvalLabel(Name) << "\n";
 241     O << directive << PAN::getArgsLabel(Name) << "\n";
 242   }
 243
 244   O << TAI->getCommentString() << "Function Declarations - END." <<"\n";
 245 }
 246
 247 // Emit variables imported from other Modules.
 248 void PIC16AsmPrinter::EmitUndefinedVars(Module &M) {
 249   std::vector<const GlobalVariable*> Items = PTAI->ExternalVarDecls->Items;
 250   if (!Items.size()) return;
 251
 252   O << "\n" << TAI->getCommentString() << "Imported Variables - BEGIN" << "\n";
 253   for (unsigned j = 0; j < Items.size(); j++) {
 254     O << TAI->getExternDirective() << Mang->getMangledName(Items[j]) << "\n";
 255   }
 256   O << TAI->getCommentString() << "Imported Variables - END" << "\n";
 257 }
 258
 259 // Emit variables defined in this module and are available to other modules.
 260 void PIC16AsmPrinter::EmitDefinedVars(Module &M) {
 261   std::vector<const GlobalVariable*> Items = PTAI->ExternalVarDefs->Items;
 262   if (!Items.size()) return;
 263
 264   O << "\n" <<  TAI->getCommentString() << "Exported Variables - BEGIN" << "\n";
 265   for (unsigned j = 0; j < Items.size(); j++) {
 266     O << TAI->getGlobalDirective() << Mang->getMangledName(Items[j]) << "\n";
 267   }
 268   O <<  TAI->getCommentString() << "Exported Variables - END" << "\n";
 269 }
 270
 271 // Emit initialized data placed in ROM.
 272 void PIC16AsmPrinter::EmitRomData(Module &M) {
 273   // Print ROM Data section.
 274   const std::vector<PIC16Section*> &ROSections = PTAI->ROSections;
 275   for (unsigned i = 0; i < ROSections.size(); i++) {
 276     const std::vector<const GlobalVariable*> &Items = ROSections[i]->Items;
 277     if (!Items.size()) continue;
 278     O << "\n";
 279     SwitchToSection(PTAI->ROSections[i]->S_);
 280     for (unsigned j = 0; j < Items.size(); j++) {
 281       O << Mang->getMangledName(Items[j]);
 282       Constant *C = Items[j]->getInitializer();
 283       int AddrSpace = Items[j]->getType()->getAddressSpace();
 284       EmitGlobalConstant(C, AddrSpace);
 285     }
 286   }
 287 }
 288
 289 bool PIC16AsmPrinter::doFinalization(Module &M) {
 290   printLibcallDecls();
 291   EmitRemainingAutos();
 292   DbgInfo.EndModule(M);
 293   O << "\n\t" << "END\n";
 294   bool Result = AsmPrinter::doFinalization(M);
 295   return Result;
 296 }
 297
 298 void PIC16AsmPrinter::EmitFunctionFrame(MachineFunction &MF) {
 299   const Function *F = MF.getFunction();
 300   std::string FuncName = Mang->getMangledName(F);
 301   const TargetData *TD = TM.getTargetData();
 302   // Emit the data section name.
 303   O << "\n";
 304   const char *SectionName = PAN::getFrameSectionName(CurrentFnName).c_str();
 305
 306   const Section *fPDataSection = TAI->getNamedSection(SectionName,
 307                                                       SectionFlags::Writeable);
 308   SwitchToSection(fPDataSection);
 309
 310   // Emit function frame label
 311   O << PAN::getFrameLabel(CurrentFnName) << ":\n";
 312
 313   const Type *RetType = F->getReturnType();
 314   unsigned RetSize = 0;
 315   if (RetType->getTypeID() != Type::VoidTyID)
 316     RetSize = TD->getTypeAllocSize(RetType);
 317
 318   //Emit function return value space
 319   // FIXME: Do not emit RetvalLable when retsize is zero. To do this
 320   // we will need to avoid printing a global directive for Retval label
 321   // in emitExternandGloblas.
 322   if(RetSize > 0)
 323      O << PAN::getRetvalLabel(CurrentFnName) << " RES " << RetSize << "\n";
 324   else
 325      O << PAN::getRetvalLabel(CurrentFnName) << ": \n";
 326
 327   // Emit variable to hold the space for function arguments
 328   unsigned ArgSize = 0;
 329   for (Function::const_arg_iterator argi = F->arg_begin(),
 330            arge = F->arg_end(); argi != arge ; ++argi) {
 331     const Type *Ty = argi->getType();
 332     ArgSize += TD->getTypeAllocSize(Ty);
 333    }
 334
 335   O << PAN::getArgsLabel(CurrentFnName) << " RES " << ArgSize << "\n";
 336
 337   // Emit temporary space
 338   int TempSize = PTLI->GetTmpSize();
 339   if (TempSize > 0)
 340     O << PAN::getTempdataLabel(CurrentFnName) << " RES  " << TempSize << '\n';
 341 }
 342
 343 void PIC16AsmPrinter::EmitIData(Module &M) {
 344
 345   // Print all IDATA sections.
 346   const std::vector<PIC16Section*> &IDATASections = PTAI->IDATASections;
 347   for (unsigned i = 0; i < IDATASections.size(); i++) {
 348     O << "\n";
 349     if (IDATASections[i]->S_->getName().find("llvm.") != std::string::npos)
 350       continue;
 351     SwitchToSection(IDATASections[i]->S_);
 352     std::vector<const GlobalVariable*> Items = IDATASections[i]->Items;
 353     for (unsigned j = 0; j < Items.size(); j++) {
 354       std::string Name = Mang->getMangledName(Items[j]);
 355       Constant *C = Items[j]->getInitializer();
 356       int AddrSpace = Items[j]->getType()->getAddressSpace();
 357       O << Name;
 358       EmitGlobalConstant(C, AddrSpace);
 359     }
 360   }
 361 }
 362
 363 void PIC16AsmPrinter::EmitUData(Module &M) {
 364   const TargetData *TD = TM.getTargetData();
 365
 366   // Print all BSS sections.
 367   const std::vector<PIC16Section*> &BSSSections = PTAI->BSSSections;
 368   for (unsigned i = 0; i < BSSSections.size(); i++) {
 369     O << "\n";
 370     SwitchToSection(BSSSections[i]->S_);
 371     std::vector<const GlobalVariable*> Items = BSSSections[i]->Items;
 372     for (unsigned j = 0; j < Items.size(); j++) {
 373       std::string Name = Mang->getMangledName(Items[j]);
 374       Constant *C = Items[j]->getInitializer();
 375       const Type *Ty = C->getType();
 376       unsigned Size = TD->getTypeAllocSize(Ty);
 377
 378       O << Name << " RES " << Size << "\n";
 379     }
 380   }
 381 }
 382
 383 void PIC16AsmPrinter::EmitAutos(std::string FunctName) {
 384   // Section names for all globals are already set.
 385   const TargetData *TD = TM.getTargetData();
 386
 387   // Now print Autos section for this function.
 388   std::string SectionName = PAN::getAutosSectionName(FunctName);
 389   const std::vector<PIC16Section*> &AutosSections = PTAI->AutosSections;
 390   for (unsigned i = 0; i < AutosSections.size(); i++) {
 391     O << "\n";
 392     if (AutosSections[i]->S_->getName() == SectionName) {
 393       // Set the printing status to true
 394       AutosSections[i]->setPrintedStatus(true);
 395       SwitchToSection(AutosSections[i]->S_);
 396       const std::vector<const GlobalVariable*> &Items = AutosSections[i]->Items;
 397       for (unsigned j = 0; j < Items.size(); j++) {
 398         std::string VarName = Mang->getMangledName(Items[j]);
 399         Constant *C = Items[j]->getInitializer();
 400         const Type *Ty = C->getType();
 401         unsigned Size = TD->getTypeAllocSize(Ty);
 402         // Emit memory reserve directive.
 403         O << VarName << "  RES  " << Size << "\n";
 404       }
 405       break;
 406     }
 407   }
 408 }
 409
 410 // Print autos that were not printed during the code printing of functions.
 411 // As the functions might themselves would have got deleted by the optimizer.
 412 void PIC16AsmPrinter::EmitRemainingAutos() {
 413   const TargetData *TD = TM.getTargetData();
 414
 415   // Now print Autos section for this function.
 416   std::vector <PIC16Section *>AutosSections = PTAI->AutosSections;
 417   for (unsigned i = 0; i < AutosSections.size(); i++) {
 418
 419     // if the section is already printed then don't print again
 420     if (AutosSections[i]->isPrinted())
 421       continue;
 422
 423     // Set status as printed
 424     AutosSections[i]->setPrintedStatus(true);
 425
 426     O << "\n";
 427     SwitchToSection(AutosSections[i]->S_);
 428     const std::vector<const GlobalVariable*> &Items = AutosSections[i]->Items;
 429     for (unsigned j = 0; j < Items.size(); j++) {
 430       std::string VarName = Mang->getMangledName(Items[j]);
 431       Constant *C = Items[j]->getInitializer();
 432       const Type *Ty = C->getType();
 433       unsigned Size = TD->getTypeAllocSize(Ty);
 434       // Emit memory reserve directive.
 435       O << VarName << "  RES  " << Size << "\n";
 436     }
 437   }
 438 }
 439