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
  25 using namespace llvm;
  26
  27 #include "PIC16GenAsmWriter.inc"
  28 bool PIC16AsmPrinter::inSameBank (char *s1, char *s2){
  29
  30   assert (s1 && s2 && "Null pointer assignment");
  31
  32   if ((*s1 == '.') && (*s2 == '.')) { //skip if they both start with '.'
  33     s1++;
  34     s2++;
  35   }
  36   while (*s1 && *s2) {
  37     if (*s1 != *s2)
  38       goto _NotInSameBank;
  39
  40     if ((*s1 == '.') && (*s2 == '.')) //both symbols in same function
  41       goto _InSameBank;               //in the same bank
  42
  43     s1++;
  44     s2++;
  45   }
  46
  47   if (*s1 && *s1) {
  48   _InSameBank:
  49     return true;
  50   }
  51
  52  _NotInSameBank:
  53   return false;
  54 }
  55
  56 bool PIC16AsmPrinter::printMachineInstruction(const MachineInstr *MI) {
  57   std::string NewBankselLabel;
  58   unsigned Operands = MI->getNumOperands();
  59   if (Operands > 1) {
  60     // Global address or external symbol should be second operand from last
  61     // if we want to print banksel for it.
  62     const MachineOperand &Op = MI->getOperand(Operands-2);
  63     unsigned OpType = Op.getType();
  64     if (OpType == MachineOperand::MO_GlobalAddress ||
  65         OpType == MachineOperand::MO_ExternalSymbol) {
  66       if (OpType == MachineOperand::MO_GlobalAddress )
  67         NewBankselLabel =  Mang->getValueName(Op.getGlobal());
  68       else
  69         NewBankselLabel =  Op.getSymbolName();
  70
  71       // Operand after global address or external symbol should be  banksel.
  72       // Value 1 for this operand means we need to generate banksel else do not
  73       // generate banksel.
  74       const MachineOperand &BS = MI->getOperand(Operands-1);
  75       if (((int)BS.getImm() == 1) &&
  76           (!inSameBank ((char *)CurrentBankselLabelInBasicBlock.c_str(),
  77                         (char *)NewBankselLabel.c_str()))) {
  78         CurrentBankselLabelInBasicBlock = NewBankselLabel;
  79         O << "\tbanksel ";
  80         printOperand(MI, Operands-2);
  81         O << "\n";
  82       }
  83     }
  84   }
  85   printInstruction(MI);
  86   return true;
  87 }
  88
  89 /// runOnMachineFunction - This uses the printInstruction()
  90 /// method to print assembly for each instruction.
  91 ///
  92 bool PIC16AsmPrinter::runOnMachineFunction(MachineFunction &MF) {
  93   this->MF = &MF;
  94
  95   // This calls the base class function required to be called at beginning
  96   // of runOnMachineFunction.
  97   SetupMachineFunction(MF);
  98
  99   // Get the mangled name.
 100   const Function *F = MF.getFunction();
 101   CurrentFnName = Mang->getValueName(F);
 102
 103   // Emit the function variables.
 104   emitFunctionData(MF);
 105   std::string codeSection;
 106   codeSection = "code." + CurrentFnName + ".# " + "CODE";
 107   const Section *fCodeSection = TAI->getNamedSection(codeSection.c_str(),
 108                                                SectionFlags::Code);
 109   O <<  "\n";
 110   SwitchToSection (fCodeSection);
 111
 112   // Print out code for the function.
 113   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 114        I != E; ++I) {
 115     // Print a label for the basic block.
 116     if (I != MF.begin()) {
 117       printBasicBlockLabel(I, true);
 118       O << '\n';
 119     }
 120     else
 121       O << CurrentFnName << ":\n";
 122     CurrentBankselLabelInBasicBlock = "";
 123     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
 124          II != E; ++II) {
 125       // Print the assembly for the instruction.
 126         printMachineInstruction(II);
 127     }
 128   }
 129   return false;  // we didn't modify anything.
 130 }
 131
 132 /// createPIC16CodePrinterPass - Returns a pass that prints the PIC16
 133 /// assembly code for a MachineFunction to the given output stream,
 134 /// using the given target machine description.  This should work
 135 /// regardless of whether the function is in SSA form.
 136 ///
 137 FunctionPass *llvm::createPIC16CodePrinterPass(raw_ostream &o,
 138                                                PIC16TargetMachine &tm,
 139                                                bool fast) {
 140   return new PIC16AsmPrinter(o, tm, tm.getTargetAsmInfo(), fast);
 141 }
 142
 143 void PIC16AsmPrinter::printOperand(const MachineInstr *MI, int opNum) {
 144   const MachineOperand &MO = MI->getOperand(opNum);
 145
 146   switch (MO.getType()) {
 147     case MachineOperand::MO_Register:
 148       if (TargetRegisterInfo::isPhysicalRegister(MO.getReg()))
 149         O << TM.getRegisterInfo()->get(MO.getReg()).AsmName;
 150       else
 151         assert(0 && "not implemented");
 152         return;
 153
 154     case MachineOperand::MO_Immediate:
 155       O << (int)MO.getImm();
 156       return;
 157
 158     case MachineOperand::MO_GlobalAddress:
 159       O << Mang->getValueName(MO.getGlobal());
 160       break;
 161
 162     case MachineOperand::MO_ExternalSymbol:
 163       O << MO.getSymbolName();
 164       break;
 165
 166     case MachineOperand::MO_MachineBasicBlock:
 167       printBasicBlockLabel(MO.getMBB());
 168       return;
 169
 170     default:
 171       assert(0 && " Operand type not supported.");
 172   }
 173 }
 174
 175 void PIC16AsmPrinter::printCCOperand(const MachineInstr *MI, int opNum) {
 176   int CC = (int)MI->getOperand(opNum).getImm();
 177   O << PIC16CondCodeToString((PIC16CC::CondCodes)CC);
 178 }
 179
 180
 181 bool PIC16AsmPrinter::doInitialization (Module &M) {
 182   bool Result = AsmPrinter::doInitialization(M);
 183   // FIXME:: This is temporary solution to generate the include file.
 184   // The processor should be passed to llc as in input and the header file
 185   // should be generated accordingly.
 186   O << "\t#include P16F1937.INC\n";
 187   EmitExternsAndGlobals (M);
 188   EmitInitData (M);
 189   EmitUnInitData(M);
 190   EmitRomData(M);
 191   return Result;
 192 }
 193
 194 void PIC16AsmPrinter::EmitExternsAndGlobals (Module &M) {
 195  // Emit declarations for external functions.
 196   O << "section.0" <<"\n";
 197   for (Module::iterator I = M.begin(), E = M.end(); I != E; I++) {
 198     std::string Name = Mang->getValueName(I);
 199     if (Name.compare("abort") == 0)
 200       continue;
 201     if (I->isDeclaration()) {
 202       O << "\textern " <<Name << "\n";
 203       O << "\textern " << Name << ".retval\n";
 204       O << "\textern " << Name << ".args\n";
 205     }
 206     else if (I->hasExternalLinkage()) {
 207       O << "\tglobal " << Name << "\n";
 208       O << "\tglobal " << Name << ".retval\n";
 209       O << "\tglobal " << Name << ".args\n";
 210     }
 211   }
 212
 213   // Emit header file to include declaration of library functions
 214   O << "\t#include C16IntrinsicCalls.INC\n";
 215
 216   // Emit declarations for external globals.
 217   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 218        I != E; I++) {
 219     // Any variables reaching here with ".auto." in its name is a local scope
 220     // variable and should not be printed in global data section.
 221     std::string Name = Mang->getValueName(I);
 222     if (Name.find(".auto.") != std::string::npos)
 223       continue;
 224
 225     if (I->isDeclaration())
 226       O << "\textern "<< Name << "\n";
 227     else if (I->hasCommonLinkage() || I->hasExternalLinkage())
 228       O << "\tglobal "<< Name << "\n";
 229   }
 230 }
 231
 232 void PIC16AsmPrinter::EmitInitData (Module &M) {
 233   SwitchToSection(TAI->getDataSection());
 234   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 235        I != E; ++I) {
 236     if (!I->hasInitializer())   // External global require no code.
 237       continue;
 238
 239     Constant *C = I->getInitializer();
 240     const PointerType *PtrTy = I->getType();
 241     int AddrSpace = PtrTy->getAddressSpace();
 242
 243     if ((!C->isNullValue()) && (AddrSpace == PIC16ISD::RAM_SPACE)) {
 244
 245       if (EmitSpecialLLVMGlobal(I))
 246         continue;
 247
 248       // Any variables reaching here with "." in its name is a local scope
 249       // variable and should not be printed in global data section.
 250       std::string name = Mang->getValueName(I);
 251       if (name.find(".auto.") != std::string::npos)
 252         continue;
 253
 254       O << name;
 255       EmitGlobalConstant(C, AddrSpace);
 256     }
 257   }
 258 }
 259
 260 void PIC16AsmPrinter::EmitRomData (Module &M)
 261 {
 262   SwitchToSection(TAI->getReadOnlySection());
 263   IsRomData = true;
 264   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 265        I != E; ++I) {
 266     if (!I->hasInitializer())   // External global require no code.
 267       continue;
 268
 269     Constant *C = I->getInitializer();
 270     const PointerType *PtrTy = I->getType();
 271     int AddrSpace = PtrTy->getAddressSpace();
 272     if ((!C->isNullValue()) && (AddrSpace == PIC16ISD::ROM_SPACE)) {
 273
 274       if (EmitSpecialLLVMGlobal(I))
 275         continue;
 276
 277       // Any variables reaching here with "." in its name is a local scope
 278       // variable and should not be printed in global data section.
 279       std::string name = Mang->getValueName(I);
 280       if (name.find(".") != std::string::npos)
 281         continue;
 282
 283       O << name;
 284       EmitGlobalConstant(C, AddrSpace);
 285       O << "\n";
 286     }
 287   }
 288   IsRomData = false;
 289 }
 290
 291 void PIC16AsmPrinter::EmitUnInitData (Module &M)
 292 {
 293   SwitchToSection(TAI->getBSSSection_());
 294   const TargetData *TD = TM.getTargetData();
 295
 296   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 297        I != E; ++I) {
 298     if (!I->hasInitializer())   // External global require no code.
 299       continue;
 300
 301     Constant *C = I->getInitializer();
 302     if (C->isNullValue()) {
 303
 304       if (EmitSpecialLLVMGlobal(I))
 305         continue;
 306
 307       // Any variables reaching here with "." in its name is a local scope
 308       // variable and should not be printed in global data section.
 309       std::string name = Mang->getValueName(I);
 310       if (name.find(".") != std::string::npos)
 311         continue;
 312
 313       const Type *Ty = C->getType();
 314       unsigned Size = TD->getTypePaddedSize(Ty);
 315
 316       O << name << " " <<"RES"<< " " << Size ;
 317       O << "\n";
 318     }
 319   }
 320 }
 321
 322 bool PIC16AsmPrinter::doFinalization(Module &M) {
 323   O << "\t" << "END\n";
 324   bool Result = AsmPrinter::doFinalization(M);
 325   return Result;
 326 }
 327
 328 void PIC16AsmPrinter::emitFunctionData(MachineFunction &MF) {
 329   const Function *F = MF.getFunction();
 330   std::string FuncName = Mang->getValueName(F);
 331   const Module *M = F->getParent();
 332   const TargetData *TD = TM.getTargetData();
 333   unsigned FrameSize = 0;
 334   // Emit the data section name.
 335   O << "\n";
 336   std::string SectionName = "fdata." + CurrentFnName + ".# " + "UDATA";
 337
 338   const Section *fDataSection = TAI->getNamedSection(SectionName.c_str(),
 339                                                SectionFlags::Writeable);
 340   SwitchToSection(fDataSection);
 341
 342   //Emit function return value.
 343   O << CurrentFnName << ".retval:\n";
 344   const Type *RetType = F->getReturnType();
 345   unsigned RetSize = 0;
 346   if (RetType->getTypeID() != Type::VoidTyID)
 347     RetSize = TD->getTypePaddedSize(RetType);
 348
 349   // Emit function arguments.
 350   O << CurrentFnName << ".args:\n";
 351   // Emit the function variables.
 352
 353   // In PIC16 all the function arguments and local variables are global.
 354   // Therefore to get the variable belonging to this function entire
 355   // global list will be traversed and variables belonging to this function
 356   // will be emitted in the current data section.
 357   for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
 358        I != E; ++I) {
 359     std::string VarName = Mang->getValueName(I);
 360
 361     // The variables of a function are of form FuncName.* . If this variable
 362     // does not belong to this function then continue.
 363     // Static local varilabes of a function does not have .auto. in their
 364     // name. They are not printed as part of function data but module
 365     // level global data.
 366     if (!(VarName.find(FuncName + ".auto.") == 0 ? true : false))
 367       continue;
 368
 369     Constant *C = I->getInitializer();
 370     const Type *Ty = C->getType();
 371     unsigned Size = TD->getTypePaddedSize(Ty);
 372     FrameSize += Size;
 373     // Emit memory reserve directive.
 374     O << VarName << "  RES  " << Size << "\n";
 375   }
 376
 377   // Return value can not overlap with temp data, becasue a temp slot
 378   // may be read/written after a return value is calculated and saved
 379   // within the function.
 380   if (RetSize > FrameSize)
 381     O << CurrentFnName << ".dummy" << " RES " << (RetSize - FrameSize) << "\n";
 382
 383   emitFunctionTempData(MF, FrameSize);
 384 }
 385
 386 void PIC16AsmPrinter::emitFunctionTempData(MachineFunction &MF,
 387                                            unsigned &FrameSize) {
 388   // Emit temporary variables.
 389   MachineFrameInfo *FrameInfo = MF.getFrameInfo();
 390   if (FrameInfo->hasStackObjects()) {
 391     int indexBegin = FrameInfo->getObjectIndexBegin();
 392     int indexEnd = FrameInfo->getObjectIndexEnd();
 393
 394     if (indexBegin < indexEnd) {
 395       FrameSize += indexEnd - indexBegin;
 396       O << CurrentFnName << ".tmp RES"<< " "
 397         <<indexEnd - indexBegin <<"\n";
 398     }
 399     /*
 400     while (indexBegin < indexEnd) {
 401         O << CurrentFnName << "_tmp_" << indexBegin << " " << "RES"<< " "
 402           << 1 << "\n" ;
 403         indexBegin++;
 404     }
 405     */
 406   }
 407 }