lib/Target/IA64/IA64AsmPrinter.cpp

   1 //===-- IA64AsmPrinter.cpp - Print out IA64 LLVM as assembly --------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Duraid Madina and is distributed under the
   6 // University of Illinois Open Source 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 assembly accepted by the GNU binutils 'gas'
  12 // assembler. The Intel 'ias' and HP-UX 'as' assemblers *may* choke on this
  13 // output, but if so that's a bug I'd like to hear about: please file a bug
  14 // report in bugzilla. FYI, the excellent 'ias' assembler is bundled with
  15 // the Intel C/C++ compiler for Itanium Linux.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "IA64.h"
  20 #include "IA64TargetMachine.h"
  21 #include "llvm/Module.h"
  22 #include "llvm/Type.h"
  23 #include "llvm/Assembly/Writer.h"
  24 #include "llvm/CodeGen/AsmPrinter.h"
  25 #include "llvm/CodeGen/MachineConstantPool.h"
  26 #include "llvm/CodeGen/MachineFunctionPass.h"
  27 #include "llvm/CodeGen/ValueTypes.h"
  28 #include "llvm/Target/TargetMachine.h"
  29 #include "llvm/Support/Mangler.h"
  30 #include "llvm/ADT/Statistic.h"
  31 #include "llvm/Support/CommandLine.h"
  32 using namespace llvm;
  33
  34 namespace {
  35   Statistic<> EmittedInsts("asm-printer", "Number of machine instrs printed");
  36
  37   struct IA64SharedAsmPrinter : public AsmPrinter {
  38
  39     std::set<std::string> ExternalFunctionNames, ExternalObjectNames;
  40
  41     IA64SharedAsmPrinter(std::ostream &O, TargetMachine &TM)
  42       : AsmPrinter(O, TM) { }
  43
  44     void printConstantPool(MachineConstantPool *MCP);
  45     bool doFinalization(Module &M);
  46   };
  47 }
  48
  49 static bool isScale(const MachineOperand &MO) {
  50   return MO.isImmediate() &&
  51     (MO.getImmedValue() == 1 || MO.getImmedValue() == 2 ||
  52      MO.getImmedValue() == 4 || MO.getImmedValue() == 8);
  53 }
  54
  55 static bool isMem(const MachineInstr *MI, unsigned Op) {
  56   if (MI->getOperand(Op).isFrameIndex()) return true;
  57   if (MI->getOperand(Op).isConstantPoolIndex()) return true;
  58   return Op+4 <= MI->getNumOperands() &&
  59     MI->getOperand(Op  ).isRegister() && isScale(MI->getOperand(Op+1)) &&
  60     MI->getOperand(Op+2).isRegister() && (MI->getOperand(Op+3).isImmediate() ||
  61         MI->getOperand(Op+3).isGlobalAddress());
  62 }
  63
  64 // SwitchSection - Switch to the specified section of the executable if we are
  65 // not already in it!
  66 //
  67 static void SwitchSection(std::ostream &OS, std::string &CurSection,
  68                           const char *NewSection) {
  69   if (CurSection != NewSection) {
  70     CurSection = NewSection;
  71     if (!CurSection.empty())
  72       OS << "\t" << NewSection << "\n";
  73   }
  74 }
  75
  76 /// printConstantPool - Print to the current output stream assembly
  77 /// representations of the constants in the constant pool MCP. This is
  78 /// used to print out constants which have been "spilled to memory" by
  79 /// the code generator.
  80 ///
  81 void IA64SharedAsmPrinter::printConstantPool(MachineConstantPool *MCP) {
  82   const std::vector<Constant*> &CP = MCP->getConstants();
  83   const TargetData &TD = TM.getTargetData();
  84
  85   if (CP.empty()) return;
  86
  87   O << "\n\t.section .data, \"aw\", \"progbits\"\n";
  88       // FIXME: would be nice to have rodata (no 'w') when appropriate?
  89   for (unsigned i = 0, e = CP.size(); i != e; ++i) {
  90     emitAlignment(TD.getTypeAlignmentShift(CP[i]->getType()));
  91     O << ".CPI" << CurrentFnName << "_" << i << ":\t\t\t\t\t" << CommentString
  92       << *CP[i] << "\n";
  93     emitGlobalConstant(CP[i]);
  94   }
  95 }
  96
  97 bool IA64SharedAsmPrinter::doFinalization(Module &M) {
  98   const TargetData &TD = TM.getTargetData();
  99   std::string CurSection;
 100
 101   // Print out module-level global variables here.
 102   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 103        I != E; ++I)
 104     if (I->hasInitializer()) {   // External global require no code
 105       O << "\n\n";
 106       std::string name = Mang->getValueName(I);
 107       Constant *C = I->getInitializer();
 108       unsigned Size = TD.getTypeSize(C->getType());
 109       unsigned Align = TD.getTypeAlignmentShift(C->getType());
 110
 111       if (C->isNullValue() &&
 112           (I->hasLinkOnceLinkage() || I->hasInternalLinkage() ||
 113            I->hasWeakLinkage() /* FIXME: Verify correct */)) {
 114         SwitchSection(O, CurSection, ".data");
 115         if (I->hasInternalLinkage()) {
 116           O << "\t.lcomm " << name << "," << TD.getTypeSize(C->getType())
 117             << "," << (1 << Align);
 118           O << "\t\t// ";
 119         } else {
 120           O << "\t.common " << name << "," << TD.getTypeSize(C->getType())
 121             << "," << (1 << Align);
 122           O << "\t\t// ";
 123         }
 124         WriteAsOperand(O, I, true, true, &M);
 125         O << "\n";
 126       } else {
 127         switch (I->getLinkage()) {
 128         case GlobalValue::LinkOnceLinkage:
 129         case GlobalValue::WeakLinkage:   // FIXME: Verify correct for weak.
 130           // Nonnull linkonce -> weak
 131           O << "\t.weak " << name << "\n";
 132           SwitchSection(O, CurSection, "");
 133           O << "\t.section\t.llvm.linkonce.d." << name
 134             << ", \"aw\", \"progbits\"\n";
 135           break;
 136         case GlobalValue::AppendingLinkage:
 137           // FIXME: appending linkage variables should go into a section of
 138           // their name or something.  For now, just emit them as external.
 139         case GlobalValue::ExternalLinkage:
 140           // If external or appending, declare as a global symbol
 141           O << "\t.global " << name << "\n";
 142           // FALL THROUGH
 143         case GlobalValue::InternalLinkage:
 144           if (C->isNullValue())
 145             SwitchSection(O, CurSection, ".bss");
 146           else
 147             SwitchSection(O, CurSection, ".data");
 148           break;
 149         case GlobalValue::GhostLinkage:
 150           std::cerr << "GhostLinkage cannot appear in IA64AsmPrinter!\n";
 151           abort();
 152         }
 153
 154         emitAlignment(Align);
 155         O << "\t.type " << name << ",@object\n";
 156         O << "\t.size " << name << "," << Size << "\n";
 157         O << name << ":\t\t\t\t// ";
 158         WriteAsOperand(O, I, true, true, &M);
 159         O << " = ";
 160         WriteAsOperand(O, C, false, false, &M);
 161         O << "\n";
 162         emitGlobalConstant(C);
 163       }
 164     }
 165
 166   // we print out ".global X \n .type X, @function" for each external function
 167   O << "\n\n// br.call targets referenced (and not defined) above: \n";
 168   for (std::set<std::string>::iterator i = ExternalFunctionNames.begin(),
 169        e = ExternalFunctionNames.end(); i!=e; ++i) {
 170     O << "\t.global " << *i << "\n\t.type " << *i << ", @function\n";
 171   }
 172   O << "\n\n";
 173
 174   // we print out ".global X \n .type X, @object" for each external object
 175   O << "\n\n// (external) symbols referenced (and not defined) above: \n";
 176   for (std::set<std::string>::iterator i = ExternalObjectNames.begin(),
 177        e = ExternalObjectNames.end(); i!=e; ++i) {
 178     O << "\t.global " << *i << "\n\t.type " << *i << ", @object\n";
 179   }
 180   O << "\n\n";
 181
 182   AsmPrinter::doFinalization(M);
 183   return false; // success
 184 }
 185
 186 namespace {
 187   struct IA64AsmPrinter : public IA64SharedAsmPrinter {
 188     IA64AsmPrinter(std::ostream &O, TargetMachine &TM)
 189       : IA64SharedAsmPrinter(O, TM) {
 190
 191       CommentString = "//";
 192       Data8bitsDirective = "\tdata1\t";     // FIXME: check that we are
 193       Data16bitsDirective = "\tdata2.ua\t"; // disabling auto-alignment
 194       Data32bitsDirective = "\tdata4.ua\t"; // properly
 195       Data64bitsDirective = "\tdata8.ua\t";
 196       ZeroDirective = "\t.skip\t";
 197       AsciiDirective = "\tstring\t";
 198
 199       GlobalVarAddrPrefix="";
 200       GlobalVarAddrSuffix="";
 201       FunctionAddrPrefix="@fptr(";
 202       FunctionAddrSuffix=")";
 203
 204     }
 205
 206     virtual const char *getPassName() const {
 207       return "IA64 Assembly Printer";
 208     }
 209
 210     /// printInstruction - This method is automatically generated by tablegen
 211     /// from the instruction set description.  This method returns true if the
 212     /// machine instruction was sufficiently described to print it, otherwise it
 213     /// returns false.
 214     bool printInstruction(const MachineInstr *MI);
 215
 216     // This method is used by the tablegen'erated instruction printer.
 217     void printOperand(const MachineInstr *MI, unsigned OpNo, MVT::ValueType VT){
 218       const MachineOperand &MO = MI->getOperand(OpNo);
 219       if (MO.getType() == MachineOperand::MO_MachineRegister) {
 220         assert(MRegisterInfo::isPhysicalRegister(MO.getReg())&&"Not physref??");
 221         //XXX Bug Workaround: See note in Printer::doInitialization about %.
 222         O << TM.getRegisterInfo()->get(MO.getReg()).Name;
 223       } else {
 224         printOp(MO);
 225       }
 226     }
 227
 228     void printS8ImmOperand(const MachineInstr *MI, unsigned OpNo,
 229                             MVT::ValueType VT) {
 230       int val=(unsigned int)MI->getOperand(OpNo).getImmedValue();
 231       if(val>=128) val=val-256; // if negative, flip sign
 232       O << val;
 233     }
 234     void printS14ImmOperand(const MachineInstr *MI, unsigned OpNo,
 235                             MVT::ValueType VT) {
 236       int val=(unsigned int)MI->getOperand(OpNo).getImmedValue();
 237       if(val>=8192) val=val-16384; // if negative, flip sign
 238       O << val;
 239     }
 240     void printS22ImmOperand(const MachineInstr *MI, unsigned OpNo,
 241                             MVT::ValueType VT) {
 242       int val=(unsigned int)MI->getOperand(OpNo).getImmedValue();
 243       if(val>=2097152) val=val-4194304; // if negative, flip sign
 244       O << val;
 245     }
 246     void printU64ImmOperand(const MachineInstr *MI, unsigned OpNo,
 247                             MVT::ValueType VT) {
 248       O << (uint64_t)MI->getOperand(OpNo).getImmedValue();
 249     }
 250
 251     void printCallOperand(const MachineInstr *MI, unsigned OpNo,
 252                           MVT::ValueType VT) {
 253       printOp(MI->getOperand(OpNo), true); // this is a br.call instruction
 254     }
 255
 256     void printMachineInstruction(const MachineInstr *MI);
 257     void printOp(const MachineOperand &MO, bool isBRCALLinsn= false);
 258     bool runOnMachineFunction(MachineFunction &F);
 259     bool doInitialization(Module &M);
 260   };
 261 } // end of anonymous namespace
 262
 263
 264 // Include the auto-generated portion of the assembly writer.
 265 #include "IA64GenAsmWriter.inc"
 266
 267
 268 /// runOnMachineFunction - This uses the printMachineInstruction()
 269 /// method to print assembly for each instruction.
 270 ///
 271 bool IA64AsmPrinter::runOnMachineFunction(MachineFunction &MF) {
 272   setupMachineFunction(MF);
 273   O << "\n\n";
 274
 275   // Print out constants referenced by the function
 276   printConstantPool(MF.getConstantPool());
 277
 278   // Print out labels for the function.
 279   O << "\n\t.section .text, \"ax\", \"progbits\"\n";
 280               // ^^  means "Allocated instruXions in mem, initialized"
 281   emitAlignment(5);
 282   O << "\t.global\t" << CurrentFnName << "\n";
 283   O << "\t.type\t" << CurrentFnName << ", @function\n";
 284   O << CurrentFnName << ":\n";
 285
 286   // Print out code for the function.
 287   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 288        I != E; ++I) {
 289     // Print a label for the basic block if there are any predecessors.
 290     if (I->pred_begin() != I->pred_end())
 291       O << ".LBB" << CurrentFnName << "_" << I->getNumber() << ":\t"
 292         << CommentString << " " << I->getBasicBlock()->getName() << "\n";
 293     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
 294          II != E; ++II) {
 295       // Print the assembly for the instruction.
 296       O << "\t";
 297       printMachineInstruction(II);
 298     }
 299   }
 300
 301   // We didn't modify anything.
 302   return false;
 303 }
 304
 305 void IA64AsmPrinter::printOp(const MachineOperand &MO,
 306                                  bool isBRCALLinsn /* = false */) {
 307   const MRegisterInfo &RI = *TM.getRegisterInfo();
 308   switch (MO.getType()) {
 309   case MachineOperand::MO_VirtualRegister:
 310     if (Value *V = MO.getVRegValueOrNull()) {
 311       O << "<" << V->getName() << ">";
 312       return;
 313     }
 314     // FALLTHROUGH
 315   case MachineOperand::MO_MachineRegister:
 316   case MachineOperand::MO_CCRegister: {
 317     O << RI.get(MO.getReg()).Name;
 318     return;
 319   }
 320
 321   case MachineOperand::MO_SignExtendedImmed:
 322   case MachineOperand::MO_UnextendedImmed:
 323     O << /*(unsigned int)*/MO.getImmedValue();
 324     return;
 325   case MachineOperand::MO_MachineBasicBlock: {
 326     MachineBasicBlock *MBBOp = MO.getMachineBasicBlock();
 327     O << ".LBB" << Mang->getValueName(MBBOp->getParent()->getFunction())
 328       << "_" << MBBOp->getNumber () << "\t// "
 329       << MBBOp->getBasicBlock ()->getName ();
 330     return;
 331   }
 332   case MachineOperand::MO_PCRelativeDisp:
 333     std::cerr << "Shouldn't use addPCDisp() when building IA64 MachineInstrs";
 334     abort ();
 335     return;
 336
 337   case MachineOperand::MO_ConstantPoolIndex: {
 338     O << "@gprel(.CPI" << CurrentFnName << "_"
 339       << MO.getConstantPoolIndex() << ")";
 340     return;
 341   }
 342
 343   case MachineOperand::MO_GlobalAddress: {
 344
 345     // functions need @ltoff(@fptr(fn_name)) form
 346     GlobalValue *GV = MO.getGlobal();
 347     Function *F = dyn_cast<Function>(GV);
 348
 349     bool Needfptr=false; // if we're computing an address @ltoff(X), do
 350                          // we need to decorate it so it becomes
 351                          // @ltoff(@fptr(X)) ?
 352     if(F && !isBRCALLinsn /*&& F->isExternal()*/)
 353       Needfptr=true;
 354
 355     // if this is the target of a call instruction, we should define
 356     // the function somewhere (GNU gas has no problem without this, but
 357     // Intel ias rightly complains of an 'undefined symbol')
 358
 359     if(F /*&& isBRCALLinsn*/ && F->isExternal())
 360       ExternalFunctionNames.insert(Mang->getValueName(MO.getGlobal()));
 361     else
 362       if(GV->isExternal()) // e.g. stuff like 'stdin'
 363         ExternalObjectNames.insert(Mang->getValueName(MO.getGlobal()));
 364
 365     if (!isBRCALLinsn)
 366       O << "@ltoff(";
 367     if (Needfptr)
 368       O << "@fptr(";
 369     O << Mang->getValueName(MO.getGlobal());
 370     if (Needfptr)
 371       O << ")"; // close fptr(
 372     if (!isBRCALLinsn)
 373       O << ")"; // close ltoff(
 374     int Offset = MO.getOffset();
 375     if (Offset > 0)
 376       O << " + " << Offset;
 377     else if (Offset < 0)
 378       O << " - " << -Offset;
 379     return;
 380   }
 381   case MachineOperand::MO_ExternalSymbol:
 382     O << MO.getSymbolName();
 383     ExternalFunctionNames.insert(MO.getSymbolName());
 384     return;
 385   default:
 386     O << "<AsmPrinter: unknown operand type: " << MO.getType() << " >"; return;
 387   }
 388 }
 389
 390 /// printMachineInstruction -- Print out a single IA64 LLVM instruction
 391 /// MI to the current output stream.
 392 ///
 393 void IA64AsmPrinter::printMachineInstruction(const MachineInstr *MI) {
 394
 395   ++EmittedInsts;
 396
 397   // Call the autogenerated instruction printer routines.
 398   printInstruction(MI);
 399 }
 400
 401 bool IA64AsmPrinter::doInitialization(Module &M) {
 402   AsmPrinter::doInitialization(M);
 403
 404   O << "\n.ident \"LLVM-ia64\"\n\n"
 405     << "\t.psr    lsb\n"  // should be "msb" on HP-UX, for starters
 406     << "\t.radix  C\n"
 407     << "\t.psr    abi64\n"; // we only support 64 bits for now
 408   return false;
 409 }
 410
 411 /// createIA64CodePrinterPass - Returns a pass that prints the IA64
 412 /// assembly code for a MachineFunction to the given output stream, using
 413 /// the given target machine description.
 414 ///
 415 FunctionPass *llvm::createIA64CodePrinterPass(std::ostream &o,TargetMachine &tm){
 416   return new IA64AsmPrinter(o, tm);
 417 }
 418
 419