* Use Classname and ClassPrefix instead of hard-coded V9 values
[oota-llvm.git] / utils / TableGen / CodeEmitterGen.cpp
index 90474cf4c0271ea1ffee427c2e5bcdee49b602d7..40065bf009cec59f9dd525ca8914f0348da63ff8 100644 (file)
-#include "Record.h"
-#include "CodeEmitterGen.h"
-#include <ostream>
+//===- CodeEmitterGen.cpp - Code Emitter Generator ------------------------===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
+//
+// CodeEmitterGen uses the descriptions of instructions and their fields to
+// construct an automated code emitter: a function that, given a MachineInstr,
+// returns the (currently, 32-bit unsigned) value of the instruction.
+//
+//===----------------------------------------------------------------------===//
 
-void CodeEmitterGen::createEmitter(std::ostream &o) {
-  std::vector<Record*> Insts;
+#include "CodeEmitterGen.h"
+#include "Record.h"
+#include "Support/Debug.h"
+using namespace llvm;
 
-  const std::map<std::string, Record*> &Defs = Records.getDefs();
-  Record *Inst = Records.getClass("Instruction");
-  assert(Inst && "Couldn't find Instruction class!");
+void CodeEmitterGen::run(std::ostream &o) {
+  std::vector<Record*> Insts = Records.getAllDerivedDefinitions("Instruction");
 
-  for (std::map<std::string, Record*>::const_iterator I = Defs.begin(),
-        E = Defs.end(); I != E; ++I)
-    if (I->second->isSubClassOf(Inst))
-      Insts.push_back(I->second);
+  EmitSourceFileHeader("Machine Code Emitter", o);
 
-  std::string Namespace = "V9::";
-  std::string ClassName = "SparcV9CodeEmitter::";
+  std::string Namespace = Insts[0]->getValueAsString("Namespace") + "::";
+  std::string ClassName = Insts[0]->getValueAsString("ClassPrefix") + 
+    "CodeEmitter::";
 
   //const std::string &Namespace = Inst->getValue("Namespace")->getName();
-  o << "static unsigned " << ClassName
+  o << "unsigned " << ClassName
     << "getBinaryCodeForInstr(MachineInstr &MI) {\n"
     << "  unsigned Value = 0;\n"
-    << "  std::cerr << MI;\n"
+    << "  DEBUG(std::cerr << MI);\n"
     << "  switch (MI.getOpcode()) {\n";
   for (std::vector<Record*>::iterator I = Insts.begin(), E = Insts.end();
-       I != E; ++I)
-  {
+       I != E; ++I) {
     Record *R = *I;
-    o << "    case " << Namespace << R->getName() << ": {\n";
-
-    const RecordVal *InstVal = R->getValue("Inst");
-    Init *InitVal = InstVal->getValue();
+    o << "    case " << Namespace << R->getName() << ": {\n"
+      << "      DEBUG(std::cerr << \"Emitting " << R->getName() << "\\n\");\n";
 
-    assert(dynamic_cast<BitsInit*>(InitVal) &&
-           "Can only handle undefined bits<> types!");
-    BitsInit *BI = (BitsInit*)InitVal;
+    BitsInit *BI = R->getValueAsBitsInit("Inst");
 
     unsigned Value = 0;
     const std::vector<RecordVal> &Vals = R->getValues();
 
-    o << "      // prefilling: ";
+    DEBUG(o << "      // prefilling: ");
     // Start by filling in fixed values...
     for (unsigned i = 0, e = BI->getNumBits(); i != e; ++i) {
       if (BitInit *B = dynamic_cast<BitInit*>(BI->getBit(e-i-1))) {
         Value |= B->getValue() << (e-i-1);
-        o << B->getValue();
+        DEBUG(o << B->getValue());
       } else {
-        o << "0";
+        DEBUG(o << "0");
       }
     }
-    o << "\n\n";
+    DEBUG(o << "\n");
 
-    o << "      // " << *InstVal << "\n\n";
+    DEBUG(o << "      // " << *R->getValue("Inst") << "\n");
     o << "      Value = " << Value << "U;\n\n";
     
-    // Loop over all of the fields in the instruction adding in any
-    // contributions to this value (due to bit references).
+    // Loop over all of the fields in the instruction determining which are the
+    // operands to the instruction. 
     //
     unsigned op = 0;
-    std::map<const std::string,unsigned> OpOrder;
+    std::map<std::string, unsigned> OpOrder;
+    std::map<std::string, bool> OpContinuous;
     for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
-      if (Vals[i].getName() != "Inst" && 
-          !Vals[i].getValue()->isComplete() &&
-          Vals[i].getName() != "annul" && 
-          Vals[i].getName() != "cc" &&
-          Vals[i].getName() != "predict")
-      {
-        o << "      // op" << op << ": " << Vals[i].getName() << "\n"
-          << "      int64_t op" << op 
-          <<" = getMachineOpValue(MI.getOperand("<<op<<"));\n";
-        //<< "      MachineOperand &op" << op <<" = MI.getOperand("<<op<<");\n";
-        OpOrder[Vals[i].getName()] = op++;
+      if (!Vals[i].getPrefix() &&  !Vals[i].getValue()->isComplete()) {
+        // Is the operand continuous? If so, we can just mask and OR it in
+        // instead of doing it bit-by-bit, saving a lot in runtime cost.        
+        const BitsInit *InstInit = BI;
+        int beginBitInVar = -1, endBitInVar = -1;
+        int beginBitInInst = -1, endBitInInst = -1;
+        bool continuous = true;
+
+        for (int bit = InstInit->getNumBits()-1; bit >= 0; --bit) {
+          if (VarBitInit *VBI =
+              dynamic_cast<VarBitInit*>(InstInit->getBit(bit))) {
+            TypedInit *TI = VBI->getVariable();
+            if (VarInit *VI = dynamic_cast<VarInit*>(TI)) {
+              // only process the current variable
+              if (VI->getName() != Vals[i].getName())
+                continue;
+
+              if (beginBitInVar == -1)
+                beginBitInVar = VBI->getBitNum();
+
+              if (endBitInVar == -1)
+                endBitInVar = VBI->getBitNum();
+              else {
+                if (endBitInVar == (int)VBI->getBitNum() + 1)
+                  endBitInVar = VBI->getBitNum();
+                else {
+                  continuous = false;
+                  break;
+                }
+              }
+
+              if (beginBitInInst == -1)
+                beginBitInInst = bit;
+              if (endBitInInst == -1)
+                endBitInInst = bit;
+              else {
+                if (endBitInInst == bit + 1)
+                  endBitInInst = bit;
+                else {
+                  continuous = false;
+                  break;
+                }
+              }
+
+              // maintain same distance between bits in field and bits in
+              // instruction. if the relative distances stay the same
+              // throughout,
+              if (beginBitInVar - (int)VBI->getBitNum() !=
+                  beginBitInInst - bit) {
+                continuous = false;
+                break;
+              }
+            }
+          }
+        }
+
+        // If we have found no bit in "Inst" which comes from this field, then
+        // this is not an operand!!
+        if (beginBitInInst != -1) {
+          o << "      // op" << op << ": " << Vals[i].getName() << "\n"
+            << "      int64_t op" << op 
+            <<" = getMachineOpValue(MI, MI.getOperand("<<op<<"));\n";
+          //<< "   MachineOperand &op" << op <<" = MI.getOperand("<<op<<");\n";
+          OpOrder[Vals[i].getName()] = op++;
+          
+          DEBUG(o << "      // Var: begin = " << beginBitInVar 
+                  << ", end = " << endBitInVar
+                  << "; Inst: begin = " << beginBitInInst
+                  << ", end = " << endBitInInst << "\n");
+          
+          if (continuous) {
+            DEBUG(o << "      // continuous: op" << OpOrder[Vals[i].getName()]
+                    << "\n");
+            
+            // Mask off the right bits
+            // Low mask (ie. shift, if necessary)
+            assert(endBitInVar >= 0 && "Negative shift amount in masking!");
+            if (endBitInVar != 0) {
+              o << "      op" << OpOrder[Vals[i].getName()]
+                << " >>= " << endBitInVar << ";\n";
+              beginBitInVar -= endBitInVar;
+              endBitInVar = 0;
+            }
+            
+            // High mask
+            o << "      op" << OpOrder[Vals[i].getName()]
+              << " &= (1<<" << beginBitInVar+1 << ") - 1;\n";
+            
+            // Shift the value to the correct place (according to place in inst)
+            assert(endBitInInst >= 0 && "Negative shift amount!");
+            if (endBitInInst != 0)
+              o << "      op" << OpOrder[Vals[i].getName()]
+              << " <<= " << endBitInInst << ";\n";
+            
+            // Just OR in the result
+            o << "      Value |= op" << OpOrder[Vals[i].getName()] << ";\n";
+          }
+          
+          // otherwise, will be taken care of in the loop below using this
+          // value:
+          OpContinuous[Vals[i].getName()] = continuous;
+        }
       }
     }
 
-    unsigned Offset = 31;
-    for (int f = Vals.size()-1; f >= 0; --f) {
+    for (unsigned f = 0, e = Vals.size(); f != e; ++f) {
       if (Vals[f].getPrefix()) {
         BitsInit *FieldInitializer = (BitsInit*)Vals[f].getValue();
 
         // Scan through the field looking for bit initializers of the current
         // variable...
         for (int i = FieldInitializer->getNumBits()-1; i >= 0; --i) {
-          if (BitInit *BI=dynamic_cast<BitInit*>(FieldInitializer->getBit(i))){
-            --Offset;
-          } else if (UnsetInit *UI = 
-                     dynamic_cast<UnsetInit*>(FieldInitializer->getBit(i))) {
-            --Offset;
-          } else if (VarBitInit *VBI =
-                     dynamic_cast<VarBitInit*>(FieldInitializer->getBit(i))) {
+          Init *I = FieldInitializer->getBit(i);
+          if (BitInit *BI = dynamic_cast<BitInit*>(I)) {
+            DEBUG(o << "      // bit init: f: " << f << ", i: " << i << "\n");
+          } else if (UnsetInit *UI = dynamic_cast<UnsetInit*>(I)) {
+            DEBUG(o << "      // unset init: f: " << f << ", i: " << i << "\n");
+          } else if (VarBitInit *VBI = dynamic_cast<VarBitInit*>(I)) {
             TypedInit *TI = VBI->getVariable();
             if (VarInit *VI = dynamic_cast<VarInit*>(TI)) {
-              o << "      Value |= getValueBit(op" << OpOrder[VI->getName()]
-                << ", " << VBI->getBitNum()
-                << ")" << " << " << Offset << ";\n";
-              --Offset;
+              // If the bits of the field are laid out consecutively in the
+              // instruction, then instead of separately ORing in bits, just
+              // mask and shift the entire field for efficiency.
+              if (OpContinuous[VI->getName()]) {
+                // already taken care of in the loop above, thus there is no
+                // need to individually OR in the bits
+
+                // for debugging, output the regular version anyway, commented
+                DEBUG(o << "      // Value |= getValueBit(op"
+                        << OpOrder[VI->getName()] << ", " << VBI->getBitNum()
+                        << ")" << " << " << i << ";\n");
+              } else {
+                o << "      Value |= getValueBit(op" << OpOrder[VI->getName()]
+                  << ", " << VBI->getBitNum()
+                  << ")" << " << " << i << ";\n";
+              }
             } else if (FieldInit *FI = dynamic_cast<FieldInit*>(TI)) {
               // FIXME: implement this!
               o << "FIELD INIT not implemented yet!\n";
@@ -102,21 +209,20 @@ void CodeEmitterGen::createEmitter(std::ostream &o) {
               o << "Error: UNIMPLEMENTED\n";
             }
           }
-        } 
-      } else {
-        if (Vals[f].getName() == "annul" || Vals[f].getName() == "cc" ||
-            Vals[f].getName() == "predict")
-          --Offset;
+        }
       }
     }
 
     o << "      break;\n"
       << "    }\n";
   }
+
   o << "  default:\n"
     << "    std::cerr << \"Not supported instr: \" << MI << \"\\n\";\n"
     << "    abort();\n"
     << "  }\n"
     << "  return Value;\n"
     << "}\n";
+
+  EmitSourceFileTail(o);
 }