lib/Target/SparcV9/SparcV9AsmPrinter.cpp

   1 //===-- EmitAssembly.cpp - Emit Sparc Specific .s File ---------------------==//
   2 //
   3 // This file implements all of the stuff neccesary to output a .s file from
   4 // LLVM.  The code in this file assumes that the specified module has already
   5 // been compiled into the internal data structures of the Module.
   6 //
   7 // The entry point of this file is the UltraSparc::emitAssembly method.
   8 //
   9 //===----------------------------------------------------------------------===//
  10
  11 #include "SparcInternals.h"
  12 #include "llvm/Analysis/SlotCalculator.h"
  13 #include "llvm/CodeGen/MachineInstr.h"
  14 #include "llvm/BasicBlock.h"
  15 #include "llvm/Method.h"
  16 #include "llvm/Module.h"
  17 #include "llvm/Support/StringExtras.h"
  18
  19 namespace {
  20
  21 class SparcAsmPrinter {
  22   ostream &Out;
  23   SlotCalculator Table;
  24   const UltraSparc &Target;
  25
  26   enum Sections {
  27     Unknown,
  28     Text,
  29     Data,
  30     ReadOnly,
  31   } CurSection;
  32 public:
  33   inline SparcAsmPrinter(ostream &o, const Module *M, const UltraSparc &t)
  34     : Out(o), Table(SlotCalculator(M, true)), Target(t), CurSection(Unknown) {
  35     emitModule(M);
  36   }
  37
  38 private :
  39   void emitModule(const Module *M);
  40   /*
  41   void processSymbolTable(const SymbolTable &ST);
  42   void processConstant(const ConstPoolVal *CPV);
  43   void processGlobal(const GlobalVariable *GV);
  44   */
  45   void emitMethod(const Method *M);
  46   //void processMethodArgument(const MethodArgument *MA);
  47   void emitBasicBlock(const BasicBlock *BB);
  48   void emitMachineInst(const MachineInstr *MI);
  49   void printOperand(const MachineOperand &Op);
  50
  51
  52   // enterSection - Use this method to enter a different section of the output
  53   // executable.  This is used to only output neccesary section transitions.
  54   //
  55   void enterSection(enum Sections S) {
  56     if (S == CurSection) return;        // Only switch section if neccesary
  57     CurSection = S;
  58
  59     Out << ".section \".";
  60     switch (S) {
  61     default: assert(0 && "Bad section name!");
  62     case Text:     Out << "text"; break;
  63     case Data:     Out << "data"; break;
  64     case ReadOnly: Out << "rodata"; break;
  65     }
  66     Out << "\"\n";
  67   }
  68
  69   string getEscapedString(const string &S) {
  70     string Result;
  71
  72     for (unsigned i = 0; i < S.size(); ++i) {
  73       char C = S[i];
  74       if ((C >= 'a' && C <= 'z') || (C >= 'A' && C <= 'Z') ||
  75           (C >= '0' && C <= '9')) {
  76         Result += C;
  77       } else {
  78         Result += '$';
  79         Result += char('0' + ((unsigned char)C >> 4));
  80         Result += char('0' + (C & 0xF));
  81       }
  82     }
  83     return Result;
  84   }
  85
  86   // getID - Return a valid identifier for the specified value.  Base it on
  87   // the name of the identifier if possible, use a numbered value based on
  88   // prefix otherwise.  FPrefix is always prepended to the output identifier.
  89   //
  90   string getID(const Value *V, const char *Prefix, const char *FPrefix = 0) {
  91     string FP(FPrefix ? FPrefix : "");  // "Forced prefix"
  92     if (V->hasName()) {
  93       return FP + getEscapedString(V->getName());
  94     } else {
  95       assert(Table.getValSlot(V) != -1 && "Value not in value table!");
  96       return FP + string(Prefix) + itostr(Table.getValSlot(V));
  97     }
  98   }
  99
 100   // getID Wrappers - Ensure consistent usage...
 101   string getID(const Method *M) { return getID(M, "anon_method$"); }
 102   string getID(const BasicBlock *BB) {
 103     return getID(BB, "LL", (".L$"+getID(BB->getParent())+"$").c_str());
 104   }
 105
 106   unsigned getOperandMask(unsigned Opcode) {
 107     switch (Opcode) {
 108     case SUBcc:   return 1 << 3;  // Remove CC argument
 109     case BA:    case BRZ:         // Remove Arg #0, which is always null or xcc
 110     case BRLEZ: case BRLZ:
 111     case BRNZ:  case BRGZ:
 112     case BRGEZ:   return 1 << 0;
 113       // case RETURN:  return 1 << 1;  // Remove Arg #2 which is zero
 114
 115     default:      return 0;       // By default, don't hack operands...
 116     }
 117   }
 118 };
 119
 120
 121 void SparcAsmPrinter::printOperand(const MachineOperand &Op) {
 122   switch (Op.getOperandType()) {
 123   case MachineOperand::MO_VirtualRegister:
 124   case MachineOperand::MO_CCRegister:
 125   case MachineOperand::MO_MachineRegister: {
 126     int RegNum = (int)Op.getAllocatedRegNum();
 127
 128     // ****this code is temporary till NULL Values are fixed
 129     if (RegNum == 10000) {
 130       Out << "<NULL VALUE>";
 131     } else {
 132       Out << "%" << Target.getRegInfo().getUnifiedRegName(RegNum);
 133     }
 134     break;
 135   }
 136
 137   case MachineOperand::MO_PCRelativeDisp: {
 138     const Value *Val = Op.getVRegValue();
 139     if (!Val) {
 140       Out << "\t<*NULL Value*>";
 141     } else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(Val)) {
 142       Out << getID(BB);
 143     } else if (const Method *M = dyn_cast<const Method>(Val)) {
 144       Out << getID(M);
 145     } else {
 146       Out << "<unknown value=" << Val << ">";
 147     }
 148     break;
 149   }
 150
 151   default:
 152     Out << Op;      // use dump field
 153     break;
 154   }
 155 }
 156
 157
 158 void SparcAsmPrinter::emitMachineInst(const MachineInstr *MI) {
 159   unsigned Opcode = MI->getOpCode();
 160
 161   if (TargetInstrDescriptors[Opcode].iclass & M_DUMMY_PHI_FLAG)
 162     return;  // IGNORE PHI NODES
 163
 164   Out << "\t" << TargetInstrDescriptors[Opcode].opCodeString << "\t";
 165
 166   switch (Opcode) {   // Some opcodes have special syntax...
 167   case JMPL:
 168     assert(MI->getNumOperands() == 3 && "Unexpected JMPL instr!");
 169     printOperand(MI->getOperand(0));
 170     Out << "+";
 171     printOperand(MI->getOperand(1));
 172     Out << ", ";
 173     printOperand(MI->getOperand(2));
 174     Out << endl;
 175     return;
 176
 177   case RETURN:
 178     assert(MI->getNumOperands() == 2 && "Unexpected RETURN instr!");
 179     printOperand(MI->getOperand(0));
 180     Out << "+";
 181     printOperand(MI->getOperand(1));
 182     Out << endl;
 183     return;
 184
 185   default: break;
 186   }
 187
 188   unsigned Mask = getOperandMask(Opcode);
 189
 190   bool NeedComma = false;
 191   for(unsigned OpNum = 0; OpNum < MI->getNumOperands(); ++OpNum) {
 192     if ((1 << OpNum) & Mask) continue;  // Ignore this operand?
 193
 194     const MachineOperand &Op = MI->getOperand(OpNum);
 195     if (NeedComma) Out << ", ";    // Handle comma outputing
 196     NeedComma = true;
 197
 198     printOperand(Op);
 199   }
 200   Out << endl;
 201 }
 202
 203 void SparcAsmPrinter::emitBasicBlock(const BasicBlock *BB) {
 204   // Emit a label for the basic block
 205   Out << getID(BB) << ":\n";
 206
 207   // Get the vector of machine instructions corresponding to this bb.
 208   const MachineCodeForBasicBlock &MIs = BB->getMachineInstrVec();
 209   MachineCodeForBasicBlock::const_iterator MII = MIs.begin(), MIE = MIs.end();
 210
 211   // Loop over all of the instructions in the basic block...
 212   for (; MII != MIE; ++MII)
 213     emitMachineInst(*MII);
 214   Out << "\n";  // Seperate BB's with newlines
 215 }
 216
 217 void SparcAsmPrinter::emitMethod(const Method *M) {
 218   if (M->isExternal()) return;
 219
 220   // Make sure the slot table has information about this method...
 221   Table.incorporateMethod(M);
 222
 223   string MethName = getID(M);
 224   Out << "!****** Outputing Method: " << MethName << " ******\n";
 225   enterSection(Text);
 226   Out << "\t.align 4\n\t.global\t" << MethName << "\n";
 227   //Out << "\t.type\t" << MethName << ",#function\n";
 228   Out << "\t.type\t" << MethName << ", 2\n";
 229   Out << MethName << ":\n";
 230
 231   // Output code for all of the basic blocks in the method...
 232   for (Method::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
 233     emitBasicBlock(*I);
 234
 235   // Output a .size directive so the debugger knows the extents of the function
 236   Out << ".EndOf$" << MethName << ":\n\t.size " << MethName << ", .EndOf$"
 237       << MethName << "-" << MethName << endl;
 238
 239   // Put some spaces between the methods
 240   Out << "\n\n";
 241
 242   // Forget all about M.
 243   Table.purgeMethod();
 244 }
 245
 246
 247 void SparcAsmPrinter::emitModule(const Module *M) {
 248   // TODO: Look for a filename annotation on M to emit a .file directive
 249   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
 250     emitMethod(*I);
 251 }
 252
 253 }  // End anonymous namespace
 254
 255 //
 256 // emitAssembly - Output assembly language code (a .s file) for the specified
 257 // method. The specified method must have been compiled before this may be
 258 // used.
 259 //
 260 void UltraSparc::emitAssembly(const Module *M, ostream &Out) const {
 261   SparcAsmPrinter Print(Out, M, *this);
 262 }