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/CodeGen/MachineFrameInfo.h"
  22 #include "llvm/Support/raw_ostream.h"
  23 #include "llvm/Support/Mangler.h"
  24 #include "llvm/CodeGen/DwarfWriter.h"
  25 #include "llvm/CodeGen/MachineModuleInfo.h"
  26
  27 using namespace llvm;
  28
  29 #include "PIC16GenAsmWriter.inc"
  30
  31 bool PIC16AsmPrinter::printMachineInstruction(const MachineInstr *MI) {
  32   printInstruction(MI);
  33   return true;
  34 }
  35
  36 /// runOnMachineFunction - This emits the frame section, autos section and
  37 /// assembly for each instruction. Also takes care of function begin debug
  38 /// directive and file begin debug directive (if required) for the function.
  39 ///
  40 bool PIC16AsmPrinter::runOnMachineFunction(MachineFunction &MF) {
  41   this->MF = &MF;
  42
  43   // This calls the base class function required to be called at beginning
  44   // of runOnMachineFunction.
  45   SetupMachineFunction(MF);
  46
  47   // Get the mangled name.
  48   const Function *F = MF.getFunction();
  49   CurrentFnName = Mang->getValueName(F);
  50
  51   // Emit the function frame (args and temps).
  52   EmitFunctionFrame(MF);
  53
  54   DbgInfo.BeginFunction(MF);
  55
  56   // Emit the autos section of function.
  57   EmitAutos(CurrentFnName);
  58
  59   // Now emit the instructions of function in its code section.
  60   const char *codeSection = PAN::getCodeSectionName(CurrentFnName).c_str();
  61
  62   const Section *fCodeSection = TAI->getNamedSection(codeSection,
  63                                                      SectionFlags::Code);
  64   // Start the Code Section.
  65   O <<  "\n";
  66   SwitchToSection (fCodeSection);
  67
  68   // Emit the frame address of the function at the beginning of code.
  69   O << "\tretlw  low(" << PAN::getFrameLabel(CurrentFnName) << ")\n";
  70   O << "\tretlw  high(" << PAN::getFrameLabel(CurrentFnName) << ")\n";
  71
  72   // Emit function start label.
  73   O << CurrentFnName << ":\n";
  74
  75   DebugLoc CurDL;
  76   O << "\n";
  77   // Print out code for the function.
  78   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
  79        I != E; ++I) {
  80
  81     // Print a label for the basic block.
  82     if (I != MF.begin()) {
  83       printBasicBlockLabel(I, true);
  84       O << '\n';
  85     }
  86
  87     // Print a basic block.
  88     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
  89          II != E; ++II) {
  90
  91       // Emit the line directive if source line changed.
  92       const DebugLoc DL = II->getDebugLoc();
  93       if (!DL.isUnknown() && DL != CurDL) {
  94         DbgInfo.ChangeDebugLoc(MF, DL);
  95         CurDL = DL;
  96       }
  97
  98       // Print the assembly for the instruction.
  99       printMachineInstruction(II);
 100     }
 101   }
 102
 103   // Emit function end debug directives.
 104   DbgInfo.EndFunction(MF);
 105
 106   return false;  // we didn't modify anything.
 107 }
 108
 109 /// createPIC16CodePrinterPass - Returns a pass that prints the PIC16
 110 /// assembly code for a MachineFunction to the given output stream,
 111 /// using the given target machine description.  This should work
 112 /// regardless of whether the function is in SSA form.
 113 ///
 114 FunctionPass *llvm::createPIC16CodePrinterPass(raw_ostream &o,
 115                                                PIC16TargetMachine &tm,
 116                                                CodeGenOpt::Level OptLevel,
 117                                                bool verbose) {
 118   return new PIC16AsmPrinter(o, tm, tm.getTargetAsmInfo(), OptLevel, 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         assert(0 && "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->getValueName(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       assert(0 && " 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->getValueName(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 {
 250   std::vector<const GlobalVariable*> Items = PTAI->ExternalVarDecls->Items;
 251   if (! Items.size()) return;
 252
 253   O << "\n" << TAI->getCommentString() << "Imported Variables - BEGIN" << "\n";
 254   for (unsigned j = 0; j < Items.size(); j++) {
 255     O << TAI->getExternDirective() << Mang->getValueName(Items[j]) << "\n";
 256   }
 257   O << TAI->getCommentString() << "Imported Variables - END" << "\n";
 258 }
 259
 260 // Emit variables defined in this module and are available to other modules.
 261 void PIC16AsmPrinter::EmitDefinedVars (Module &M)
 262 {
 263   std::vector<const GlobalVariable*> Items = PTAI->ExternalVarDefs->Items;
 264   if (! Items.size()) return;
 265
 266   O << "\n" <<  TAI->getCommentString() << "Exported Variables - BEGIN" << "\n";
 267   for (unsigned j = 0; j < Items.size(); j++) {
 268     O << TAI->getGlobalDirective() << Mang->getValueName(Items[j]) << "\n";
 269   }
 270   O <<  TAI->getCommentString() << "Exported Variables - END" << "\n";
 271 }
 272
 273 // Emit initialized data placed in ROM.
 274 void PIC16AsmPrinter::EmitRomData (Module &M)
 275 {
 276
 277   std::vector<const GlobalVariable*> Items = PTAI->ROSection->Items;
 278   if (! Items.size()) return;
 279
 280   // Print ROData ection.
 281   O << "\n";
 282   SwitchToSection(PTAI->ROSection->S_);
 283   for (unsigned j = 0; j < Items.size(); j++) {
 284     O << Mang->getValueName(Items[j]);
 285     Constant *C = Items[j]->getInitializer();
 286     int AddrSpace = Items[j]->getType()->getAddressSpace();
 287     EmitGlobalConstant(C, AddrSpace);
 288   }
 289 }
 290
 291 bool PIC16AsmPrinter::doFinalization(Module &M) {
 292   printLibcallDecls();
 293   EmitRemainingAutos();
 294   DbgInfo.EndModule(M);
 295   O << "\n\t" << "END\n";
 296   bool Result = AsmPrinter::doFinalization(M);
 297   return Result;
 298 }
 299
 300 void PIC16AsmPrinter::EmitFunctionFrame(MachineFunction &MF) {
 301   const Function *F = MF.getFunction();
 302   std::string FuncName = Mang->getValueName(F);
 303   const TargetData *TD = TM.getTargetData();
 304   // Emit the data section name.
 305   O << "\n";
 306   const char *SectionName = PAN::getFrameSectionName(CurrentFnName).c_str();
 307
 308   const Section *fPDataSection = TAI->getNamedSection(SectionName,
 309                                                       SectionFlags::Writeable);
 310   SwitchToSection(fPDataSection);
 311
 312   // Emit function frame label
 313   O << PAN::getFrameLabel(CurrentFnName) << ":\n";
 314
 315   const Type *RetType = F->getReturnType();
 316   unsigned RetSize = 0;
 317   if (RetType->getTypeID() != Type::VoidTyID)
 318     RetSize = TD->getTypeAllocSize(RetType);
 319
 320   //Emit function return value space
 321   // FIXME: Do not emit RetvalLable when retsize is zero. To do this
 322   // we will need to avoid printing a global directive for Retval label
 323   // in emitExternandGloblas.
 324   if(RetSize > 0)
 325      O << PAN::getRetvalLabel(CurrentFnName) << " RES " << RetSize << "\n";
 326   else
 327      O << PAN::getRetvalLabel(CurrentFnName) << ": \n";
 328
 329   // Emit variable to hold the space for function arguments
 330   unsigned ArgSize = 0;
 331   for (Function::const_arg_iterator argi = F->arg_begin(),
 332            arge = F->arg_end(); argi != arge ; ++argi) {
 333     const Type *Ty = argi->getType();
 334     ArgSize += TD->getTypeAllocSize(Ty);
 335    }
 336
 337   O << PAN::getArgsLabel(CurrentFnName) << " RES " << ArgSize << "\n";
 338
 339   // Emit temporary space
 340   int TempSize = PTLI->GetTmpSize();
 341   if (TempSize > 0 )
 342     O << PAN::getTempdataLabel(CurrentFnName) << " RES  " << TempSize <<"\n";
 343 }
 344
 345 void PIC16AsmPrinter::EmitIData (Module &M) {
 346
 347   // Print all IDATA sections.
 348   std::vector <PIC16Section *>IDATASections = PTAI->IDATASections;
 349   for (unsigned i = 0; i < IDATASections.size(); i++) {
 350     O << "\n";
 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->getValueName(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   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->getValueName(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 ;
 379       O << "\n";
 380     }
 381   }
 382 }
 383
 384 void PIC16AsmPrinter::EmitAutos (std::string FunctName)
 385 {
 386   // Section names for all globals are already set.
 387
 388   const TargetData *TD = TM.getTargetData();
 389
 390   // Now print Autos section for this function.
 391   std::string SectionName = PAN::getAutosSectionName(FunctName);
 392   std::vector <PIC16Section *>AutosSections = PTAI->AutosSections;
 393   for (unsigned i = 0; i < AutosSections.size(); i++) {
 394     O << "\n";
 395     if (AutosSections[i]->S_->getName() == SectionName) {
 396       // Set the printing status to true
 397       AutosSections[i]->setPrintedStatus(true);
 398       SwitchToSection(AutosSections[i]->S_);
 399       std::vector<const GlobalVariable*> Items = AutosSections[i]->Items;
 400       for (unsigned j = 0; j < Items.size(); j++) {
 401         std::string VarName = Mang->getValueName(Items[j]);
 402         Constant *C = Items[j]->getInitializer();
 403         const Type *Ty = C->getType();
 404         unsigned Size = TD->getTypeAllocSize(Ty);
 405         // Emit memory reserve directive.
 406         O << VarName << "  RES  " << Size << "\n";
 407       }
 408       break;
 409     }
 410   }
 411 }
 412
 413 // Print autos that were not printed during the code printing of functions.
 414 // As the functions might themselves would have got deleted by the optimizer.
 415 void PIC16AsmPrinter::EmitRemainingAutos()
 416 {
 417   const TargetData *TD = TM.getTargetData();
 418
 419   // Now print Autos section for this function.
 420   std::vector <PIC16Section *>AutosSections = PTAI->AutosSections;
 421   for (unsigned i = 0; i < AutosSections.size(); i++) {
 422
 423     // if the section is already printed then don't print again
 424     if (AutosSections[i]->isPrinted())
 425       continue;
 426
 427     // Set status as printed
 428     AutosSections[i]->setPrintedStatus(true);
 429
 430     O << "\n";
 431     SwitchToSection(AutosSections[i]->S_);
 432     std::vector<const GlobalVariable*> Items = AutosSections[i]->Items;
 433     for (unsigned j = 0; j < Items.size(); j++) {
 434       std::string VarName = Mang->getValueName(Items[j]);
 435       Constant *C = Items[j]->getInitializer();
 436       const Type *Ty = C->getType();
 437       unsigned Size = TD->getTypeAllocSize(Ty);
 438       // Emit memory reserve directive.
 439       O << VarName << "  RES  " << Size << "\n";
 440     }
 441   }
 442 }
 443