utils/TableGen/CodeEmitterGen.cpp

   1 //===- CodeEmitterGen.cpp - Code Emitter Generator ------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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/CommandLine.h"
  21 #include "llvm/Support/Debug.h"
  22 using namespace llvm;
  23
  24 // FIXME: Somewhat hackish to use a command line option for this. There should
  25 // be a CodeEmitter class in the Target.td that controls this sort of thing
  26 // instead.
  27 static cl::opt<bool>
  28 MCEmitter("mc-emitter",
  29           cl::desc("Generate CodeEmitter for use with the MC library."),
  30           cl::init(false));
  31
  32 void CodeEmitterGen::reverseBits(std::vector<Record*> &Insts) {
  33   for (std::vector<Record*>::iterator I = Insts.begin(), E = Insts.end();
  34        I != E; ++I) {
  35     Record *R = *I;
  36     if (R->getValueAsString("Namespace") == "TargetOpcode")
  37       continue;
  38
  39     BitsInit *BI = R->getValueAsBitsInit("Inst");
  40
  41     unsigned numBits = BI->getNumBits();
  42     BitsInit *NewBI = new BitsInit(numBits);
  43     for (unsigned bit = 0, end = numBits / 2; bit != end; ++bit) {
  44       unsigned bitSwapIdx = numBits - bit - 1;
  45       Init *OrigBit = BI->getBit(bit);
  46       Init *BitSwap = BI->getBit(bitSwapIdx);
  47       NewBI->setBit(bit, BitSwap);
  48       NewBI->setBit(bitSwapIdx, OrigBit);
  49     }
  50     if (numBits % 2) {
  51       unsigned middle = (numBits + 1) / 2;
  52       NewBI->setBit(middle, BI->getBit(middle));
  53     }
  54
  55     // Update the bits in reversed order so that emitInstrOpBits will get the
  56     // correct endianness.
  57     R->getValue("Inst")->setValue(NewBI);
  58   }
  59 }
  60
  61 // If the VarBitInit at position 'bit' matches the specified variable then
  62 // return the variable bit position.  Otherwise return -1.
  63 int CodeEmitterGen::getVariableBit(const std::string &VarName,
  64                                    BitsInit *BI, int bit) {
  65   if (VarBitInit *VBI = dynamic_cast<VarBitInit*>(BI->getBit(bit)))
  66     if (VarInit *VI = dynamic_cast<VarInit*>(VBI->getVariable()))
  67       if (VI->getName() == VarName)
  68         return VBI->getBitNum();
  69
  70   return -1;
  71 }
  72
  73 void CodeEmitterGen::
  74 AddCodeToMergeInOperand(Record *R, BitsInit *BI, const std::string &VarName,
  75                         unsigned &NumberedOp,
  76                         std::string &Case, CodeGenTarget &Target) {
  77   bool gotOp = false;
  78   CodeGenInstruction &CGI = Target.getInstruction(R);
  79
  80   for (int bit = BI->getNumBits()-1; bit >= 0; ) {
  81     int varBit = getVariableBit(VarName, BI, bit);
  82
  83     // If this bit isn't from a variable, skip it.
  84     if (varBit == -1) {
  85       --bit;
  86       continue;
  87     }
  88
  89     // Figure out the consequtive range of bits covered by this operand, in
  90     // order to generate better encoding code.
  91     int beginInstBit = bit;
  92     int beginVarBit = varBit;
  93     int N = 1;
  94     for (--bit; bit >= 0;) {
  95       varBit = getVariableBit(VarName, BI, bit);
  96       if (varBit == -1 || varBit != (beginVarBit - N)) break;
  97       ++N;
  98       --bit;
  99     }
 100
 101     if (!gotOp) {
 102       // If the operand matches by name, reference according to that
 103       // operand number. Non-matching operands are assumed to be in
 104       // order.
 105       unsigned OpIdx;
 106       if (CGI.Operands.hasOperandNamed(VarName, OpIdx)) {
 107         // Get the machine operand number for the indicated operand.
 108         OpIdx = CGI.Operands[OpIdx].MIOperandNo;
 109         assert(!CGI.Operands.isFlatOperandNotEmitted(OpIdx) &&
 110                "Explicitly used operand also marked as not emitted!");
 111       } else {
 112         /// If this operand is not supposed to be emitted by the
 113         /// generated emitter, skip it.
 114         while (CGI.Operands.isFlatOperandNotEmitted(NumberedOp))
 115           ++NumberedOp;
 116         OpIdx = NumberedOp++;
 117       }
 118       std::pair<unsigned, unsigned> SO =CGI.Operands.getSubOperandNumber(OpIdx);
 119       std::string &EncoderMethodName = CGI.Operands[SO.first].EncoderMethodName;
 120
 121       // If the source operand has a custom encoder, use it. This will
 122       // get the encoding for all of the suboperands.
 123       if (!EncoderMethodName.empty()) {
 124         // A custom encoder has all of the information for the
 125         // sub-operands, if there are more than one, so only
 126         // query the encoder once per source operand.
 127         if (SO.second == 0) {
 128           Case += "      // op: " + VarName + "\n"
 129           + "      op = " + EncoderMethodName + "(MI, "
 130           + utostr(OpIdx);
 131           if (MCEmitter)
 132             Case += ", Fixups";
 133           Case += ");\n";
 134         }
 135       } else {
 136         Case += "      // op: " + VarName + "\n" +
 137                 "      op = getMachineOpValue(MI, MI.getOperand(" +
 138                 utostr(OpIdx) + ")";
 139         if (MCEmitter)
 140           Case += ", Fixups";
 141         Case += ");\n";
 142       }
 143       gotOp = true;
 144     }
 145
 146     unsigned opMask = ~0U >> (32-N);
 147     int opShift = beginVarBit - N + 1;
 148     opMask <<= opShift;
 149     opShift = beginInstBit - beginVarBit;
 150
 151     if (opShift > 0) {
 152       Case += "      Value |= (op & " + utostr(opMask) + "U) << " +
 153               itostr(opShift) + ";\n";
 154     } else if (opShift < 0) {
 155       Case += "      Value |= (op & " + utostr(opMask) + "U) >> " +
 156               itostr(-opShift) + ";\n";
 157     } else {
 158       Case += "      Value |= op & " + utostr(opMask) + "U;\n";
 159     }
 160   }
 161 }
 162
 163
 164 std::string CodeEmitterGen::getInstructionCase(Record *R,
 165                                                CodeGenTarget &Target) {
 166   std::string Case;
 167
 168   BitsInit *BI = R->getValueAsBitsInit("Inst");
 169   const std::vector<RecordVal> &Vals = R->getValues();
 170   unsigned NumberedOp = 0;
 171
 172   // Loop over all of the fields in the instruction, determining which are the
 173   // operands to the instruction.
 174   for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
 175     // Ignore fixed fields in the record, we're looking for values like:
 176     //    bits<5> RST = { ?, ?, ?, ?, ? };
 177     if (Vals[i].getPrefix() || Vals[i].getValue()->isComplete())
 178       continue;
 179
 180     AddCodeToMergeInOperand(R, BI, Vals[i].getName(), NumberedOp, Case, Target);
 181   }
 182
 183   std::string PostEmitter = R->getValueAsString("PostEncoderMethod");
 184   if (!PostEmitter.empty())
 185     Case += "      Value = " + PostEmitter + "(MI, Value);\n";
 186
 187   return Case;
 188 }
 189
 190 void CodeEmitterGen::run(raw_ostream &o) {
 191   CodeGenTarget Target;
 192   std::vector<Record*> Insts = Records.getAllDerivedDefinitions("Instruction");
 193
 194   // For little-endian instruction bit encodings, reverse the bit order
 195   if (Target.isLittleEndianEncoding()) reverseBits(Insts);
 196
 197   EmitSourceFileHeader("Machine Code Emitter", o);
 198   std::string Namespace = Insts[0]->getValueAsString("Namespace") + "::";
 199
 200   const std::vector<const CodeGenInstruction*> &NumberedInstructions =
 201     Target.getInstructionsByEnumValue();
 202
 203   // Emit function declaration
 204   o << "unsigned " << Target.getName();
 205   if (MCEmitter)
 206     o << "MCCodeEmitter::getBinaryCodeForInstr(const MCInst &MI,\n"
 207       << "    SmallVectorImpl<MCFixup> &Fixups) const {\n";
 208   else
 209     o << "CodeEmitter::getBinaryCodeForInstr(const MachineInstr &MI) const {\n";
 210
 211   // Emit instruction base values
 212   o << "  static const unsigned InstBits[] = {\n";
 213   for (std::vector<const CodeGenInstruction*>::const_iterator
 214           IN = NumberedInstructions.begin(),
 215           EN = NumberedInstructions.end();
 216        IN != EN; ++IN) {
 217     const CodeGenInstruction *CGI = *IN;
 218     Record *R = CGI->TheDef;
 219
 220     if (R->getValueAsString("Namespace") == "TargetOpcode") {
 221       o << "    0U,\n";
 222       continue;
 223     }
 224
 225     BitsInit *BI = R->getValueAsBitsInit("Inst");
 226
 227     // Start by filling in fixed values.
 228     unsigned Value = 0;
 229     for (unsigned i = 0, e = BI->getNumBits(); i != e; ++i) {
 230       if (BitInit *B = dynamic_cast<BitInit*>(BI->getBit(e-i-1)))
 231         Value |= B->getValue() << (e-i-1);
 232     }
 233     o << "    " << Value << "U," << '\t' << "// " << R->getName() << "\n";
 234   }
 235   o << "    0U\n  };\n";
 236
 237   // Map to accumulate all the cases.
 238   std::map<std::string, std::vector<std::string> > CaseMap;
 239
 240   // Construct all cases statement for each opcode
 241   for (std::vector<Record*>::iterator IC = Insts.begin(), EC = Insts.end();
 242         IC != EC; ++IC) {
 243     Record *R = *IC;
 244     if (R->getValueAsString("Namespace") == "TargetOpcode")
 245       continue;
 246     const std::string &InstName = R->getName();
 247     std::string Case = getInstructionCase(R, Target);
 248
 249     CaseMap[Case].push_back(InstName);
 250   }
 251
 252   // Emit initial function code
 253   o << "  const unsigned opcode = MI.getOpcode();\n"
 254     << "  unsigned Value = InstBits[opcode];\n"
 255     << "  unsigned op = 0;\n"
 256     << "  op = op;  // suppress warning\n"
 257     << "  switch (opcode) {\n";
 258
 259   // Emit each case statement
 260   std::map<std::string, std::vector<std::string> >::iterator IE, EE;
 261   for (IE = CaseMap.begin(), EE = CaseMap.end(); IE != EE; ++IE) {
 262     const std::string &Case = IE->first;
 263     std::vector<std::string> &InstList = IE->second;
 264
 265     for (int i = 0, N = InstList.size(); i < N; i++) {
 266       if (i) o << "\n";
 267       o << "    case " << Namespace << InstList[i]  << ":";
 268     }
 269     o << " {\n";
 270     o << Case;
 271     o << "      break;\n"
 272       << "    }\n";
 273   }
 274
 275   // Default case: unhandled opcode
 276   o << "  default:\n"
 277     << "    std::string msg;\n"
 278     << "    raw_string_ostream Msg(msg);\n"
 279     << "    Msg << \"Not supported instr: \" << MI;\n"
 280     << "    report_fatal_error(Msg.str());\n"
 281     << "  }\n"
 282     << "  return Value;\n"
 283     << "}\n\n";
 284 }