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/ADT/StringExtras.h"
  20 #include "llvm/Support/Debug.h"
  21 using namespace llvm;
  22
  23 void CodeEmitterGen::reverseBits(std::vector<Record*> &Insts) {
  24   for (std::vector<Record*>::iterator I = Insts.begin(), E = Insts.end();
  25        I != E; ++I) {
  26     Record *R = *I;
  27     if (R->getName() == "PHI" || R->getName() == "INLINEASM") continue;
  28
  29     BitsInit *BI = R->getValueAsBitsInit("Inst");
  30
  31     unsigned numBits = BI->getNumBits();
  32     BitsInit *NewBI = new BitsInit(numBits);
  33     for (unsigned bit = 0, end = numBits / 2; bit != end; ++bit) {
  34       unsigned bitSwapIdx = numBits - bit - 1;
  35       Init *OrigBit = BI->getBit(bit);
  36       Init *BitSwap = BI->getBit(bitSwapIdx);
  37       NewBI->setBit(bit, BitSwap);
  38       NewBI->setBit(bitSwapIdx, OrigBit);
  39     }
  40     if (numBits % 2) {
  41       unsigned middle = (numBits + 1) / 2;
  42       NewBI->setBit(middle, BI->getBit(middle));
  43     }
  44
  45     // Update the bits in reversed order so that emitInstrOpBits will get the
  46     // correct endianness.
  47     R->getValue("Inst")->setValue(NewBI);
  48   }
  49 }
  50
  51
  52 // If the VarBitInit at position 'bit' matches the specified variable then
  53 // return the variable bit position.  Otherwise return -1.
  54 int CodeEmitterGen::getVariableBit(const std::string &VarName,
  55             BitsInit *BI, int bit) {
  56   if (VarBitInit *VBI = dynamic_cast<VarBitInit*>(BI->getBit(bit))) {
  57     TypedInit *TI = VBI->getVariable();
  58
  59     if (VarInit *VI = dynamic_cast<VarInit*>(TI)) {
  60       if (VI->getName() == VarName) return VBI->getBitNum();
  61     }
  62   }
  63
  64   return -1;
  65 }
  66
  67
  68 void CodeEmitterGen::run(std::ostream &o) {
  69   CodeGenTarget Target;
  70   std::vector<Record*> Insts = Records.getAllDerivedDefinitions("Instruction");
  71
  72   // For little-endian instruction bit encodings, reverse the bit order
  73   if (Target.isLittleEndianEncoding()) reverseBits(Insts);
  74
  75   EmitSourceFileHeader("Machine Code Emitter", o);
  76   std::string Namespace = Insts[0]->getValueAsString("Namespace") + "::";
  77
  78   std::vector<const CodeGenInstruction*> NumberedInstructions;
  79   Target.getInstructionsByEnumValue(NumberedInstructions);
  80
  81   // Emit function declaration
  82   o << "unsigned " << Target.getName() << "CodeEmitter::"
  83     << "getBinaryCodeForInstr(MachineInstr &MI) {\n";
  84
  85   // Emit instruction base values
  86   o << "  static const unsigned InstBits[] = {\n";
  87   for (std::vector<const CodeGenInstruction*>::iterator
  88           IN = NumberedInstructions.begin(),
  89           EN = NumberedInstructions.end();
  90        IN != EN; ++IN) {
  91     const CodeGenInstruction *CGI = *IN;
  92     Record *R = CGI->TheDef;
  93
  94     if (IN != NumberedInstructions.begin()) o << ",\n";
  95
  96     if (R->getName() == "PHI" || R->getName() == "INLINEASM") {
  97       o << "    0U";
  98       continue;
  99     }
 100
 101     BitsInit *BI = R->getValueAsBitsInit("Inst");
 102
 103     unsigned Value = 0;
 104     const std::vector<RecordVal> &Vals = R->getValues();
 105
 106     // Start by filling in fixed values...
 107     for (unsigned i = 0, e = BI->getNumBits(); i != e; ++i) {
 108       if (BitInit *B = dynamic_cast<BitInit*>(BI->getBit(e-i-1))) {
 109         Value |= B->getValue() << (e-i-1);
 110       }
 111     }
 112     o << "    " << Value << "U";
 113   }
 114   o << "\n  };\n";
 115
 116   // Map to accumulate all the cases.
 117   std::map<std::string, std::vector<std::string> > CaseMap;
 118
 119   // Construct all cases statement for each opcode
 120   for (std::vector<Record*>::iterator IC = Insts.begin(), EC = Insts.end();
 121         IC != EC; ++IC) {
 122     Record *R = *IC;
 123     const std::string &InstName = R->getName();
 124     std::string Case("");
 125
 126     if (InstName == "PHI" || InstName == "INLINEASM") continue;
 127
 128     BitsInit *BI = R->getValueAsBitsInit("Inst");
 129     const std::vector<RecordVal> &Vals = R->getValues();
 130
 131     // Loop over all of the fields in the instruction, determining which are the
 132     // operands to the instruction.
 133     unsigned op = 0;
 134     for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
 135       if (!Vals[i].getPrefix() && !Vals[i].getValue()->isComplete()) {
 136         // Is the operand continuous? If so, we can just mask and OR it in
 137         // instead of doing it bit-by-bit, saving a lot in runtime cost.
 138         const std::string &VarName = Vals[i].getName();
 139         bool gotOp = false;
 140
 141         for (int bit = BI->getNumBits()-1; bit >= 0; ) {
 142           int varBit = getVariableBit(VarName, BI, bit);
 143
 144           if (varBit == -1) {
 145             --bit;
 146           } else {
 147             int beginInstBit = bit;
 148             int beginVarBit = varBit;
 149             int N = 1;
 150
 151             for (--bit; bit >= 0;) {
 152               varBit = getVariableBit(VarName, BI, bit);
 153               if (varBit == -1 || varBit != (beginVarBit - N)) break;
 154               ++N;
 155               --bit;
 156             }
 157
 158             if (!gotOp) {
 159               Case += "      // op: " + VarName + "\n"
 160                    +  "      op = getMachineOpValue(MI, MI.getOperand("
 161                    +  utostr(op++)
 162                    +  "));\n";
 163               gotOp = true;
 164             }
 165
 166             unsigned opMask = (1 << N) - 1;
 167             int opShift = beginVarBit - N + 1;
 168             opMask <<= opShift;
 169             opShift = beginInstBit - beginVarBit;
 170
 171             if (opShift > 0) {
 172               Case += "      Value |= (op & " + utostr(opMask) + "U) << "
 173                    +  itostr(opShift) + ";\n";
 174             } else if (opShift < 0) {
 175               Case += "      Value |= (op & " + utostr(opMask) + "U) >> "
 176                    +  itostr(-opShift) + ";\n";
 177             } else {
 178               Case += "      Value |= op & " + utostr(opMask) + "U;\n";
 179             }
 180           }
 181         }
 182       }
 183     }
 184
 185     std::vector<std::string> &InstList =  CaseMap[Case];
 186     InstList.push_back(InstName);
 187   }
 188
 189
 190   // Emit initial function code
 191   o << "  const unsigned opcode = MI.getOpcode();\n"
 192     << "  unsigned Value = InstBits[opcode];\n"
 193     << "  unsigned op;\n"
 194     << "  switch (opcode) {\n";
 195
 196   // Emit each case statement
 197   std::map<std::string, std::vector<std::string> >::iterator IE, EE;
 198   for (IE = CaseMap.begin(), EE = CaseMap.end(); IE != EE; ++IE) {
 199     const std::string &Case = IE->first;
 200     std::vector<std::string> &InstList = IE->second;
 201
 202     for (int i = 0, N = InstList.size(); i < N; i++) {
 203       if (i) o << "\n";
 204       o << "    case " << Namespace << InstList[i]  << ":";
 205     }
 206     o << " {\n";
 207     o << Case;
 208     o << "      break;\n"
 209       << "    }\n";
 210   }
 211
 212   // Default case: unhandled opcode
 213   o << "  default:\n"
 214     << "    std::cerr << \"Not supported instr: \" << MI << \"\\n\";\n"
 215     << "    abort();\n"
 216     << "  }\n"
 217     << "  return Value;\n"
 218     << "}\n\n";
 219 }