utils/TableGen/CodeEmitterGen.cpp

   1 //===- CodeEmitterGen.cpp - Code Emitter Generator ------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // CodeEmitterGen uses the descriptions of instructions and their fields to
  11 // construct an automated code emitter: a function that, given a MachineInstr,
  12 // returns the (currently, 32-bit unsigned) value of the instruction.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "CodeEmitterGen.h"
  17 #include "CodeGenTarget.h"
  18 #include "Record.h"
  19 #include "llvm/Support/Debug.h"
  20 using namespace llvm;
  21
  22 void CodeEmitterGen::emitInstrOpBits(std::ostream &o,
  23                                      const std::vector<RecordVal> &Vals,
  24                                      std::map<std::string, unsigned> &OpOrder,
  25                                      std::map<std::string, bool> &OpContinuous)
  26 {
  27   for (unsigned f = 0, e = Vals.size(); f != e; ++f) {
  28     if (Vals[f].getPrefix()) {
  29       BitsInit *FieldInitializer = (BitsInit*)Vals[f].getValue();
  30
  31       // Scan through the field looking for bit initializers of the current
  32       // variable...
  33       for (int i = FieldInitializer->getNumBits()-1; i >= 0; --i) {
  34         Init *I = FieldInitializer->getBit(i);
  35         if (BitInit *BI = dynamic_cast<BitInit*>(I)) {
  36           DEBUG(o << "      // bit init: f: " << f << ", i: " << i << "\n");
  37         } else if (UnsetInit *UI = dynamic_cast<UnsetInit*>(I)) {
  38           DEBUG(o << "      // unset init: f: " << f << ", i: " << i << "\n");
  39         } else if (VarBitInit *VBI = dynamic_cast<VarBitInit*>(I)) {
  40           TypedInit *TI = VBI->getVariable();
  41           if (VarInit *VI = dynamic_cast<VarInit*>(TI)) {
  42             // If the bits of the field are laid out consecutively in the
  43             // instruction, then instead of separately ORing in bits, just
  44             // mask and shift the entire field for efficiency.
  45             if (OpContinuous[VI->getName()]) {
  46               // already taken care of in the loop above, thus there is no
  47               // need to individually OR in the bits
  48
  49               // for debugging, output the regular version anyway, commented
  50               DEBUG(o << "      // Value |= getValueBit(op"
  51                       << OpOrder[VI->getName()] << ", " << VBI->getBitNum()
  52                       << ")" << " << " << i << ";\n");
  53             } else {
  54               o << "      Value |= getValueBit(op" << OpOrder[VI->getName()]
  55                 << ", " << VBI->getBitNum()
  56                 << ")" << " << " << i << ";\n";
  57             }
  58           } else if (FieldInit *FI = dynamic_cast<FieldInit*>(TI)) {
  59             // FIXME: implement this!
  60             std::cerr << "Error: FieldInit not implemented!\n";
  61             abort();
  62           } else {
  63             std::cerr << "Error: unimplemented case in "
  64                       << "CodeEmitterGen::emitInstrOpBits()\n";
  65             abort();
  66           }
  67         }
  68       }
  69     }
  70   }
  71 }
  72
  73
  74 void CodeEmitterGen::run(std::ostream &o) {
  75   CodeGenTarget Target;
  76   std::vector<Record*> Insts = Records.getAllDerivedDefinitions("Instruction");
  77
  78   EmitSourceFileHeader("Machine Code Emitter", o);
  79   std::string Namespace = Insts[0]->getValueAsString("Namespace") + "::";
  80
  81   // Emit function declaration
  82   o << "unsigned " << Target.getName() << "CodeEmitter::"
  83     << "getBinaryCodeForInstr(MachineInstr &MI) {\n"
  84     << "  unsigned Value = 0;\n"
  85     << "  DEBUG(std::cerr << MI);\n"
  86     << "  switch (MI.getOpcode()) {\n";
  87
  88   // Emit a case statement for each opcode
  89   for (std::vector<Record*>::iterator I = Insts.begin(), E = Insts.end();
  90        I != E; ++I) {
  91     Record *R = *I;
  92     if (R->getName() == "PHI" || R->getName() == "INLINEASM") continue;
  93
  94     o << "    case " << Namespace << R->getName() << ": {\n"
  95       << "      DEBUG(std::cerr << \"Emitting " << R->getName() << "\\n\");\n";
  96
  97     BitsInit *BI = R->getValueAsBitsInit("Inst");
  98
  99     // For little-endian instruction bit encodings, reverse the bit order
 100     if (Target.isLittleEndianEncoding()) {
 101       unsigned numBits = BI->getNumBits();
 102       BitsInit *NewBI = new BitsInit(numBits);
 103       for (unsigned bit = 0, end = numBits / 2; bit != end; ++bit) {
 104         unsigned bitSwapIdx = numBits - bit - 1;
 105         Init *OrigBit = BI->getBit(bit);
 106         Init *BitSwap = BI->getBit(bitSwapIdx);
 107         NewBI->setBit(bit, BitSwap);
 108         NewBI->setBit(bitSwapIdx, OrigBit);
 109       }
 110       if (numBits % 2) {
 111         unsigned middle = (numBits + 1) / 2;
 112         NewBI->setBit(middle, BI->getBit(middle));
 113       }
 114       BI = NewBI;
 115
 116       // Update the bits in reversed order so that emitInstrOpBits will get the
 117       // correct endianness.
 118       R->getValue("Inst")->setValue(NewBI);
 119     }
 120
 121     unsigned Value = 0;
 122     const std::vector<RecordVal> &Vals = R->getValues();
 123
 124     DEBUG(o << "      // prefilling: ");
 125     // Start by filling in fixed values...
 126     for (unsigned i = 0, e = BI->getNumBits(); i != e; ++i) {
 127       if (BitInit *B = dynamic_cast<BitInit*>(BI->getBit(e-i-1))) {
 128         Value |= B->getValue() << (e-i-1);
 129         DEBUG(o << B->getValue());
 130       } else {
 131         DEBUG(o << "0");
 132       }
 133     }
 134     DEBUG(o << "\n");
 135
 136     DEBUG(o << "      // " << *R->getValue("Inst") << "\n");
 137     o << "      Value = " << Value << "U;\n\n";
 138
 139     // Loop over all of the fields in the instruction, determining which are the
 140     // operands to the instruction.
 141     unsigned op = 0;
 142     std::map<std::string, unsigned> OpOrder;
 143     std::map<std::string, bool> OpContinuous;
 144     for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
 145       if (!Vals[i].getPrefix() && !Vals[i].getValue()->isComplete()) {
 146         // Is the operand continuous? If so, we can just mask and OR it in
 147         // instead of doing it bit-by-bit, saving a lot in runtime cost.
 148         BitsInit *InstInit = BI;
 149         int beginBitInVar = -1, endBitInVar = -1;
 150         int beginBitInInst = -1, endBitInInst = -1;
 151         bool continuous = true;
 152
 153         for (int bit = InstInit->getNumBits()-1; bit >= 0; --bit) {
 154           if (VarBitInit *VBI =
 155               dynamic_cast<VarBitInit*>(InstInit->getBit(bit))) {
 156             TypedInit *TI = VBI->getVariable();
 157             if (VarInit *VI = dynamic_cast<VarInit*>(TI)) {
 158               // only process the current variable
 159               if (VI->getName() != Vals[i].getName())
 160                 continue;
 161
 162               if (beginBitInVar == -1)
 163                 beginBitInVar = VBI->getBitNum();
 164
 165               if (endBitInVar == -1)
 166                 endBitInVar = VBI->getBitNum();
 167               else {
 168                 if (endBitInVar == (int)VBI->getBitNum() + 1)
 169                   endBitInVar = VBI->getBitNum();
 170                 else {
 171                   continuous = false;
 172                   break;
 173                 }
 174               }
 175
 176               if (beginBitInInst == -1)
 177                 beginBitInInst = bit;
 178               if (endBitInInst == -1)
 179                 endBitInInst = bit;
 180               else {
 181                 if (endBitInInst == bit + 1)
 182                   endBitInInst = bit;
 183                 else {
 184                   continuous = false;
 185                   break;
 186                 }
 187               }
 188
 189               // maintain same distance between bits in field and bits in
 190               // instruction. if the relative distances stay the same
 191               // throughout,
 192               if (beginBitInVar - (int)VBI->getBitNum() !=
 193                   beginBitInInst - bit) {
 194                 continuous = false;
 195                 break;
 196               }
 197             }
 198           }
 199         }
 200
 201         // If we have found no bit in "Inst" which comes from this field, then
 202         // this is not an operand!!
 203         if (beginBitInInst != -1) {
 204           o << "      // op" << op << ": " << Vals[i].getName() << "\n"
 205             << "      int op" << op
 206             <<" = getMachineOpValue(MI, MI.getOperand("<<op<<"));\n";
 207           //<< "   MachineOperand &op" << op <<" = MI.getOperand("<<op<<");\n";
 208           OpOrder[Vals[i].getName()] = op++;
 209
 210           DEBUG(o << "      // Var: begin = " << beginBitInVar
 211                   << ", end = " << endBitInVar
 212                   << "; Inst: begin = " << beginBitInInst
 213                   << ", end = " << endBitInInst << "\n");
 214
 215           if (continuous) {
 216             DEBUG(o << "      // continuous: op" << OpOrder[Vals[i].getName()]
 217                     << "\n");
 218
 219             // Mask off the right bits
 220             // Low mask (ie. shift, if necessary)
 221             assert(endBitInVar >= 0 && "Negative shift amount in masking!");
 222             if (endBitInVar != 0) {
 223               o << "      op" << OpOrder[Vals[i].getName()]
 224                 << " >>= " << endBitInVar << ";\n";
 225               beginBitInVar -= endBitInVar;
 226               endBitInVar = 0;
 227             }
 228
 229             // High mask
 230             o << "      op" << OpOrder[Vals[i].getName()]
 231               << " &= (1<<" << beginBitInVar+1 << ") - 1;\n";
 232
 233             // Shift the value to the correct place (according to place in inst)
 234             assert(endBitInInst >= 0 && "Negative shift amount!");
 235             if (endBitInInst != 0)
 236               o << "      op" << OpOrder[Vals[i].getName()]
 237               << " <<= " << endBitInInst << ";\n";
 238
 239             // Just OR in the result
 240             o << "      Value |= op" << OpOrder[Vals[i].getName()] << ";\n";
 241           }
 242
 243           // otherwise, will be taken care of in the loop below using this
 244           // value:
 245           OpContinuous[Vals[i].getName()] = continuous;
 246         }
 247       }
 248     }
 249
 250     emitInstrOpBits(o, Vals, OpOrder, OpContinuous);
 251
 252     o << "      break;\n"
 253       << "    }\n";
 254   }
 255
 256   // Default case: unhandled opcode
 257   o << "  default:\n"
 258     << "    std::cerr << \"Not supported instr: \" << MI << \"\\n\";\n"
 259     << "    abort();\n"
 260     << "  }\n"
 261     << "  return Value;\n"
 262     << "}\n\n";
 263 }