xref: /netbsd-src/external/apache2/llvm/dist/llvm/utils/TableGen/CodeEmitterGen.cpp (revision 82d56013d7b633d116a93943de88e08335357a7c)
17330f729Sjoerg //===- CodeEmitterGen.cpp - Code Emitter Generator ------------------------===//
27330f729Sjoerg //
37330f729Sjoerg // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
47330f729Sjoerg // See https://llvm.org/LICENSE.txt for license information.
57330f729Sjoerg // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
67330f729Sjoerg //
77330f729Sjoerg //===----------------------------------------------------------------------===//
87330f729Sjoerg //
97330f729Sjoerg // CodeEmitterGen uses the descriptions of instructions and their fields to
107330f729Sjoerg // construct an automated code emitter: a function that, given a MachineInstr,
117330f729Sjoerg // returns the (currently, 32-bit unsigned) value of the instruction.
127330f729Sjoerg //
137330f729Sjoerg //===----------------------------------------------------------------------===//
147330f729Sjoerg 
157330f729Sjoerg #include "CodeGenInstruction.h"
167330f729Sjoerg #include "CodeGenTarget.h"
177330f729Sjoerg #include "SubtargetFeatureInfo.h"
187330f729Sjoerg #include "Types.h"
197330f729Sjoerg #include "llvm/ADT/APInt.h"
207330f729Sjoerg #include "llvm/ADT/ArrayRef.h"
217330f729Sjoerg #include "llvm/ADT/StringExtras.h"
227330f729Sjoerg #include "llvm/Support/Casting.h"
237330f729Sjoerg #include "llvm/Support/raw_ostream.h"
247330f729Sjoerg #include "llvm/TableGen/Record.h"
257330f729Sjoerg #include "llvm/TableGen/TableGenBackend.h"
267330f729Sjoerg #include <cassert>
277330f729Sjoerg #include <cstdint>
287330f729Sjoerg #include <map>
297330f729Sjoerg #include <set>
307330f729Sjoerg #include <string>
317330f729Sjoerg #include <utility>
327330f729Sjoerg #include <vector>
337330f729Sjoerg 
347330f729Sjoerg using namespace llvm;
357330f729Sjoerg 
367330f729Sjoerg namespace {
377330f729Sjoerg 
387330f729Sjoerg class CodeEmitterGen {
397330f729Sjoerg   RecordKeeper &Records;
407330f729Sjoerg 
417330f729Sjoerg public:
CodeEmitterGen(RecordKeeper & R)427330f729Sjoerg   CodeEmitterGen(RecordKeeper &R) : Records(R) {}
437330f729Sjoerg 
447330f729Sjoerg   void run(raw_ostream &o);
457330f729Sjoerg 
467330f729Sjoerg private:
477330f729Sjoerg   int getVariableBit(const std::string &VarName, BitsInit *BI, int bit);
487330f729Sjoerg   std::string getInstructionCase(Record *R, CodeGenTarget &Target);
497330f729Sjoerg   std::string getInstructionCaseForEncoding(Record *R, Record *EncodingDef,
507330f729Sjoerg                                             CodeGenTarget &Target);
517330f729Sjoerg   void AddCodeToMergeInOperand(Record *R, BitsInit *BI,
527330f729Sjoerg                                const std::string &VarName,
537330f729Sjoerg                                unsigned &NumberedOp,
547330f729Sjoerg                                std::set<unsigned> &NamedOpIndices,
557330f729Sjoerg                                std::string &Case, CodeGenTarget &Target);
567330f729Sjoerg 
577330f729Sjoerg   void emitInstructionBaseValues(
587330f729Sjoerg       raw_ostream &o, ArrayRef<const CodeGenInstruction *> NumberedInstructions,
597330f729Sjoerg       CodeGenTarget &Target, int HwMode = -1);
607330f729Sjoerg   unsigned BitWidth;
617330f729Sjoerg   bool UseAPInt;
627330f729Sjoerg };
637330f729Sjoerg 
647330f729Sjoerg // If the VarBitInit at position 'bit' matches the specified variable then
657330f729Sjoerg // return the variable bit position.  Otherwise return -1.
getVariableBit(const std::string & VarName,BitsInit * BI,int bit)667330f729Sjoerg int CodeEmitterGen::getVariableBit(const std::string &VarName,
677330f729Sjoerg                                    BitsInit *BI, int bit) {
687330f729Sjoerg   if (VarBitInit *VBI = dyn_cast<VarBitInit>(BI->getBit(bit))) {
697330f729Sjoerg     if (VarInit *VI = dyn_cast<VarInit>(VBI->getBitVar()))
707330f729Sjoerg       if (VI->getName() == VarName)
717330f729Sjoerg         return VBI->getBitNum();
727330f729Sjoerg   } else if (VarInit *VI = dyn_cast<VarInit>(BI->getBit(bit))) {
737330f729Sjoerg     if (VI->getName() == VarName)
747330f729Sjoerg       return 0;
757330f729Sjoerg   }
767330f729Sjoerg 
777330f729Sjoerg   return -1;
787330f729Sjoerg }
797330f729Sjoerg 
807330f729Sjoerg void CodeEmitterGen::
AddCodeToMergeInOperand(Record * R,BitsInit * BI,const std::string & VarName,unsigned & NumberedOp,std::set<unsigned> & NamedOpIndices,std::string & Case,CodeGenTarget & Target)817330f729Sjoerg AddCodeToMergeInOperand(Record *R, BitsInit *BI, const std::string &VarName,
827330f729Sjoerg                         unsigned &NumberedOp,
837330f729Sjoerg                         std::set<unsigned> &NamedOpIndices,
847330f729Sjoerg                         std::string &Case, CodeGenTarget &Target) {
857330f729Sjoerg   CodeGenInstruction &CGI = Target.getInstruction(R);
867330f729Sjoerg 
877330f729Sjoerg   // Determine if VarName actually contributes to the Inst encoding.
887330f729Sjoerg   int bit = BI->getNumBits()-1;
897330f729Sjoerg 
907330f729Sjoerg   // Scan for a bit that this contributed to.
917330f729Sjoerg   for (; bit >= 0; ) {
927330f729Sjoerg     if (getVariableBit(VarName, BI, bit) != -1)
937330f729Sjoerg       break;
947330f729Sjoerg 
957330f729Sjoerg     --bit;
967330f729Sjoerg   }
977330f729Sjoerg 
987330f729Sjoerg   // If we found no bits, ignore this value, otherwise emit the call to get the
997330f729Sjoerg   // operand encoding.
1007330f729Sjoerg   if (bit < 0) return;
1017330f729Sjoerg 
1027330f729Sjoerg   // If the operand matches by name, reference according to that
1037330f729Sjoerg   // operand number. Non-matching operands are assumed to be in
1047330f729Sjoerg   // order.
1057330f729Sjoerg   unsigned OpIdx;
1067330f729Sjoerg   if (CGI.Operands.hasOperandNamed(VarName, OpIdx)) {
1077330f729Sjoerg     // Get the machine operand number for the indicated operand.
1087330f729Sjoerg     OpIdx = CGI.Operands[OpIdx].MIOperandNo;
1097330f729Sjoerg     assert(!CGI.Operands.isFlatOperandNotEmitted(OpIdx) &&
1107330f729Sjoerg            "Explicitly used operand also marked as not emitted!");
1117330f729Sjoerg   } else {
1127330f729Sjoerg     unsigned NumberOps = CGI.Operands.size();
1137330f729Sjoerg     /// If this operand is not supposed to be emitted by the
1147330f729Sjoerg     /// generated emitter, skip it.
1157330f729Sjoerg     while (NumberedOp < NumberOps &&
1167330f729Sjoerg            (CGI.Operands.isFlatOperandNotEmitted(NumberedOp) ||
1177330f729Sjoerg               (!NamedOpIndices.empty() && NamedOpIndices.count(
1187330f729Sjoerg                 CGI.Operands.getSubOperandNumber(NumberedOp).first)))) {
1197330f729Sjoerg       ++NumberedOp;
1207330f729Sjoerg 
1217330f729Sjoerg       if (NumberedOp >= CGI.Operands.back().MIOperandNo +
1227330f729Sjoerg                         CGI.Operands.back().MINumOperands) {
1237330f729Sjoerg         errs() << "Too few operands in record " << R->getName() <<
1247330f729Sjoerg                   " (no match for variable " << VarName << "):\n";
1257330f729Sjoerg         errs() << *R;
1267330f729Sjoerg         errs() << '\n';
1277330f729Sjoerg 
1287330f729Sjoerg         return;
1297330f729Sjoerg       }
1307330f729Sjoerg     }
1317330f729Sjoerg 
1327330f729Sjoerg     OpIdx = NumberedOp++;
1337330f729Sjoerg   }
1347330f729Sjoerg 
1357330f729Sjoerg   std::pair<unsigned, unsigned> SO = CGI.Operands.getSubOperandNumber(OpIdx);
1367330f729Sjoerg   std::string &EncoderMethodName = CGI.Operands[SO.first].EncoderMethodName;
1377330f729Sjoerg 
1387330f729Sjoerg   if (UseAPInt)
1397330f729Sjoerg     Case += "      op.clearAllBits();\n";
1407330f729Sjoerg 
1417330f729Sjoerg   // If the source operand has a custom encoder, use it. This will
1427330f729Sjoerg   // get the encoding for all of the suboperands.
1437330f729Sjoerg   if (!EncoderMethodName.empty()) {
1447330f729Sjoerg     // A custom encoder has all of the information for the
1457330f729Sjoerg     // sub-operands, if there are more than one, so only
1467330f729Sjoerg     // query the encoder once per source operand.
1477330f729Sjoerg     if (SO.second == 0) {
1487330f729Sjoerg       Case += "      // op: " + VarName + "\n";
1497330f729Sjoerg       if (UseAPInt) {
1507330f729Sjoerg         Case += "      " + EncoderMethodName + "(MI, " + utostr(OpIdx);
1517330f729Sjoerg         Case += ", op";
1527330f729Sjoerg       } else {
1537330f729Sjoerg         Case += "      op = " + EncoderMethodName + "(MI, " + utostr(OpIdx);
1547330f729Sjoerg       }
1557330f729Sjoerg       Case += ", Fixups, STI);\n";
1567330f729Sjoerg     }
1577330f729Sjoerg   } else {
1587330f729Sjoerg     Case += "      // op: " + VarName + "\n";
1597330f729Sjoerg     if (UseAPInt) {
1607330f729Sjoerg       Case += "      getMachineOpValue(MI, MI.getOperand(" + utostr(OpIdx) + ")";
1617330f729Sjoerg       Case += ", op, Fixups, STI";
1627330f729Sjoerg     } else {
1637330f729Sjoerg       Case += "      op = getMachineOpValue(MI, MI.getOperand(" + utostr(OpIdx) + ")";
1647330f729Sjoerg       Case += ", Fixups, STI";
1657330f729Sjoerg     }
1667330f729Sjoerg     Case += ");\n";
1677330f729Sjoerg   }
1687330f729Sjoerg 
1697330f729Sjoerg   // Precalculate the number of lits this variable contributes to in the
1707330f729Sjoerg   // operand. If there is a single lit (consecutive range of bits) we can use a
1717330f729Sjoerg   // destructive sequence on APInt that reduces memory allocations.
1727330f729Sjoerg   int numOperandLits = 0;
1737330f729Sjoerg   for (int tmpBit = bit; tmpBit >= 0;) {
1747330f729Sjoerg     int varBit = getVariableBit(VarName, BI, tmpBit);
1757330f729Sjoerg 
1767330f729Sjoerg     // If this bit isn't from a variable, skip it.
1777330f729Sjoerg     if (varBit == -1) {
1787330f729Sjoerg       --tmpBit;
1797330f729Sjoerg       continue;
1807330f729Sjoerg     }
1817330f729Sjoerg 
1827330f729Sjoerg     // Figure out the consecutive range of bits covered by this operand, in
1837330f729Sjoerg     // order to generate better encoding code.
1847330f729Sjoerg     int beginVarBit = varBit;
1857330f729Sjoerg     int N = 1;
1867330f729Sjoerg     for (--tmpBit; tmpBit >= 0;) {
1877330f729Sjoerg       varBit = getVariableBit(VarName, BI, tmpBit);
1887330f729Sjoerg       if (varBit == -1 || varBit != (beginVarBit - N))
1897330f729Sjoerg         break;
1907330f729Sjoerg       ++N;
1917330f729Sjoerg       --tmpBit;
1927330f729Sjoerg     }
1937330f729Sjoerg     ++numOperandLits;
1947330f729Sjoerg   }
1957330f729Sjoerg 
1967330f729Sjoerg   for (; bit >= 0; ) {
1977330f729Sjoerg     int varBit = getVariableBit(VarName, BI, bit);
1987330f729Sjoerg 
1997330f729Sjoerg     // If this bit isn't from a variable, skip it.
2007330f729Sjoerg     if (varBit == -1) {
2017330f729Sjoerg       --bit;
2027330f729Sjoerg       continue;
2037330f729Sjoerg     }
2047330f729Sjoerg 
2057330f729Sjoerg     // Figure out the consecutive range of bits covered by this operand, in
2067330f729Sjoerg     // order to generate better encoding code.
2077330f729Sjoerg     int beginInstBit = bit;
2087330f729Sjoerg     int beginVarBit = varBit;
2097330f729Sjoerg     int N = 1;
2107330f729Sjoerg     for (--bit; bit >= 0;) {
2117330f729Sjoerg       varBit = getVariableBit(VarName, BI, bit);
2127330f729Sjoerg       if (varBit == -1 || varBit != (beginVarBit - N)) break;
2137330f729Sjoerg       ++N;
2147330f729Sjoerg       --bit;
2157330f729Sjoerg     }
2167330f729Sjoerg 
2177330f729Sjoerg     std::string maskStr;
2187330f729Sjoerg     int opShift;
2197330f729Sjoerg 
2207330f729Sjoerg     unsigned loBit = beginVarBit - N + 1;
2217330f729Sjoerg     unsigned hiBit = loBit + N;
2227330f729Sjoerg     unsigned loInstBit = beginInstBit - N + 1;
2237330f729Sjoerg     if (UseAPInt) {
2247330f729Sjoerg       std::string extractStr;
2257330f729Sjoerg       if (N >= 64) {
2267330f729Sjoerg         extractStr = "op.extractBits(" + itostr(hiBit - loBit) + ", " +
2277330f729Sjoerg                      itostr(loBit) + ")";
2287330f729Sjoerg         Case += "      Value.insertBits(" + extractStr + ", " +
2297330f729Sjoerg                 itostr(loInstBit) + ");\n";
2307330f729Sjoerg       } else {
2317330f729Sjoerg         extractStr = "op.extractBitsAsZExtValue(" + itostr(hiBit - loBit) +
2327330f729Sjoerg                      ", " + itostr(loBit) + ")";
2337330f729Sjoerg         Case += "      Value.insertBits(" + extractStr + ", " +
2347330f729Sjoerg                 itostr(loInstBit) + ", " + itostr(hiBit - loBit) + ");\n";
2357330f729Sjoerg       }
2367330f729Sjoerg     } else {
2377330f729Sjoerg       uint64_t opMask = ~(uint64_t)0 >> (64 - N);
2387330f729Sjoerg       opShift = beginVarBit - N + 1;
2397330f729Sjoerg       opMask <<= opShift;
2407330f729Sjoerg       maskStr = "UINT64_C(" + utostr(opMask) + ")";
2417330f729Sjoerg       opShift = beginInstBit - beginVarBit;
2427330f729Sjoerg 
2437330f729Sjoerg       if (numOperandLits == 1) {
2447330f729Sjoerg         Case += "      op &= " + maskStr + ";\n";
2457330f729Sjoerg         if (opShift > 0) {
2467330f729Sjoerg           Case += "      op <<= " + itostr(opShift) + ";\n";
2477330f729Sjoerg         } else if (opShift < 0) {
2487330f729Sjoerg           Case += "      op >>= " + itostr(-opShift) + ";\n";
2497330f729Sjoerg         }
2507330f729Sjoerg         Case += "      Value |= op;\n";
2517330f729Sjoerg       } else {
2527330f729Sjoerg         if (opShift > 0) {
2537330f729Sjoerg           Case += "      Value |= (op & " + maskStr + ") << " +
2547330f729Sjoerg                   itostr(opShift) + ";\n";
2557330f729Sjoerg         } else if (opShift < 0) {
2567330f729Sjoerg           Case += "      Value |= (op & " + maskStr + ") >> " +
2577330f729Sjoerg                   itostr(-opShift) + ";\n";
2587330f729Sjoerg         } else {
2597330f729Sjoerg           Case += "      Value |= (op & " + maskStr + ");\n";
2607330f729Sjoerg         }
2617330f729Sjoerg       }
2627330f729Sjoerg     }
2637330f729Sjoerg   }
2647330f729Sjoerg }
2657330f729Sjoerg 
getInstructionCase(Record * R,CodeGenTarget & Target)2667330f729Sjoerg std::string CodeEmitterGen::getInstructionCase(Record *R,
2677330f729Sjoerg                                                CodeGenTarget &Target) {
2687330f729Sjoerg   std::string Case;
2697330f729Sjoerg   if (const RecordVal *RV = R->getValue("EncodingInfos")) {
2707330f729Sjoerg     if (auto *DI = dyn_cast_or_null<DefInit>(RV->getValue())) {
2717330f729Sjoerg       const CodeGenHwModes &HWM = Target.getHwModes();
2727330f729Sjoerg       EncodingInfoByHwMode EBM(DI->getDef(), HWM);
2737330f729Sjoerg       Case += "      switch (HwMode) {\n";
2747330f729Sjoerg       Case += "      default: llvm_unreachable(\"Unhandled HwMode\");\n";
275*82d56013Sjoerg       for (auto &KV : EBM) {
2767330f729Sjoerg         Case += "      case " + itostr(KV.first) + ": {\n";
2777330f729Sjoerg         Case += getInstructionCaseForEncoding(R, KV.second, Target);
2787330f729Sjoerg         Case += "      break;\n";
2797330f729Sjoerg         Case += "      }\n";
2807330f729Sjoerg       }
2817330f729Sjoerg       Case += "      }\n";
2827330f729Sjoerg       return Case;
2837330f729Sjoerg     }
2847330f729Sjoerg   }
2857330f729Sjoerg   return getInstructionCaseForEncoding(R, R, Target);
2867330f729Sjoerg }
2877330f729Sjoerg 
getInstructionCaseForEncoding(Record * R,Record * EncodingDef,CodeGenTarget & Target)2887330f729Sjoerg std::string CodeEmitterGen::getInstructionCaseForEncoding(Record *R, Record *EncodingDef,
2897330f729Sjoerg                                                           CodeGenTarget &Target) {
2907330f729Sjoerg   std::string Case;
2917330f729Sjoerg   BitsInit *BI = EncodingDef->getValueAsBitsInit("Inst");
2927330f729Sjoerg   unsigned NumberedOp = 0;
2937330f729Sjoerg   std::set<unsigned> NamedOpIndices;
2947330f729Sjoerg 
2957330f729Sjoerg   // Collect the set of operand indices that might correspond to named
2967330f729Sjoerg   // operand, and skip these when assigning operands based on position.
2977330f729Sjoerg   if (Target.getInstructionSet()->
2987330f729Sjoerg        getValueAsBit("noNamedPositionallyEncodedOperands")) {
2997330f729Sjoerg     CodeGenInstruction &CGI = Target.getInstruction(R);
3007330f729Sjoerg     for (const RecordVal &RV : R->getValues()) {
3017330f729Sjoerg       unsigned OpIdx;
3027330f729Sjoerg       if (!CGI.Operands.hasOperandNamed(RV.getName(), OpIdx))
3037330f729Sjoerg         continue;
3047330f729Sjoerg 
3057330f729Sjoerg       NamedOpIndices.insert(OpIdx);
3067330f729Sjoerg     }
3077330f729Sjoerg   }
3087330f729Sjoerg 
3097330f729Sjoerg   // Loop over all of the fields in the instruction, determining which are the
3107330f729Sjoerg   // operands to the instruction.
3117330f729Sjoerg   for (const RecordVal &RV : EncodingDef->getValues()) {
3127330f729Sjoerg     // Ignore fixed fields in the record, we're looking for values like:
3137330f729Sjoerg     //    bits<5> RST = { ?, ?, ?, ?, ? };
314*82d56013Sjoerg     if (RV.isNonconcreteOK() || RV.getValue()->isComplete())
3157330f729Sjoerg       continue;
3167330f729Sjoerg 
317*82d56013Sjoerg     AddCodeToMergeInOperand(R, BI, std::string(RV.getName()), NumberedOp,
3187330f729Sjoerg                             NamedOpIndices, Case, Target);
3197330f729Sjoerg   }
3207330f729Sjoerg 
3217330f729Sjoerg   StringRef PostEmitter = R->getValueAsString("PostEncoderMethod");
3227330f729Sjoerg   if (!PostEmitter.empty()) {
3237330f729Sjoerg     Case += "      Value = ";
3247330f729Sjoerg     Case += PostEmitter;
3257330f729Sjoerg     Case += "(MI, Value";
3267330f729Sjoerg     Case += ", STI";
3277330f729Sjoerg     Case += ");\n";
3287330f729Sjoerg   }
3297330f729Sjoerg 
3307330f729Sjoerg   return Case;
3317330f729Sjoerg }
3327330f729Sjoerg 
3337330f729Sjoerg static std::string
getNameForFeatureBitset(const std::vector<Record * > & FeatureBitset)3347330f729Sjoerg getNameForFeatureBitset(const std::vector<Record *> &FeatureBitset) {
3357330f729Sjoerg   std::string Name = "CEFBS";
3367330f729Sjoerg   for (const auto &Feature : FeatureBitset)
3377330f729Sjoerg     Name += ("_" + Feature->getName()).str();
3387330f729Sjoerg   return Name;
3397330f729Sjoerg }
3407330f729Sjoerg 
emitInstBits(raw_ostream & OS,const APInt & Bits)3417330f729Sjoerg static void emitInstBits(raw_ostream &OS, const APInt &Bits) {
3427330f729Sjoerg   for (unsigned I = 0; I < Bits.getNumWords(); ++I)
3437330f729Sjoerg     OS << ((I > 0) ? ", " : "") << "UINT64_C(" << utostr(Bits.getRawData()[I])
3447330f729Sjoerg        << ")";
3457330f729Sjoerg }
3467330f729Sjoerg 
emitInstructionBaseValues(raw_ostream & o,ArrayRef<const CodeGenInstruction * > NumberedInstructions,CodeGenTarget & Target,int HwMode)3477330f729Sjoerg void CodeEmitterGen::emitInstructionBaseValues(
3487330f729Sjoerg     raw_ostream &o, ArrayRef<const CodeGenInstruction *> NumberedInstructions,
3497330f729Sjoerg     CodeGenTarget &Target, int HwMode) {
3507330f729Sjoerg   const CodeGenHwModes &HWM = Target.getHwModes();
3517330f729Sjoerg   if (HwMode == -1)
3527330f729Sjoerg     o << "  static const uint64_t InstBits[] = {\n";
3537330f729Sjoerg   else
3547330f729Sjoerg     o << "  static const uint64_t InstBits_" << HWM.getMode(HwMode).Name
3557330f729Sjoerg       << "[] = {\n";
3567330f729Sjoerg 
3577330f729Sjoerg   for (const CodeGenInstruction *CGI : NumberedInstructions) {
3587330f729Sjoerg     Record *R = CGI->TheDef;
3597330f729Sjoerg 
3607330f729Sjoerg     if (R->getValueAsString("Namespace") == "TargetOpcode" ||
3617330f729Sjoerg         R->getValueAsBit("isPseudo")) {
3627330f729Sjoerg       o << "    "; emitInstBits(o, APInt(BitWidth, 0)); o << ",\n";
3637330f729Sjoerg       continue;
3647330f729Sjoerg     }
3657330f729Sjoerg 
3667330f729Sjoerg     Record *EncodingDef = R;
3677330f729Sjoerg     if (const RecordVal *RV = R->getValue("EncodingInfos")) {
3687330f729Sjoerg       if (auto *DI = dyn_cast_or_null<DefInit>(RV->getValue())) {
3697330f729Sjoerg         EncodingInfoByHwMode EBM(DI->getDef(), HWM);
3707330f729Sjoerg         if (EBM.hasMode(HwMode))
3717330f729Sjoerg           EncodingDef = EBM.get(HwMode);
3727330f729Sjoerg       }
3737330f729Sjoerg     }
3747330f729Sjoerg     BitsInit *BI = EncodingDef->getValueAsBitsInit("Inst");
3757330f729Sjoerg 
3767330f729Sjoerg     // Start by filling in fixed values.
3777330f729Sjoerg     APInt Value(BitWidth, 0);
3787330f729Sjoerg     for (unsigned i = 0, e = BI->getNumBits(); i != e; ++i) {
3797330f729Sjoerg       if (BitInit *B = dyn_cast<BitInit>(BI->getBit(e - i - 1)))
3807330f729Sjoerg         Value |= APInt(BitWidth, (uint64_t)B->getValue()) << (e - i - 1);
3817330f729Sjoerg     }
3827330f729Sjoerg     o << "    ";
3837330f729Sjoerg     emitInstBits(o, Value);
3847330f729Sjoerg     o << "," << '\t' << "// " << R->getName() << "\n";
3857330f729Sjoerg   }
3867330f729Sjoerg   o << "    UINT64_C(0)\n  };\n";
3877330f729Sjoerg }
3887330f729Sjoerg 
run(raw_ostream & o)3897330f729Sjoerg void CodeEmitterGen::run(raw_ostream &o) {
3907330f729Sjoerg   CodeGenTarget Target(Records);
3917330f729Sjoerg   std::vector<Record*> Insts = Records.getAllDerivedDefinitions("Instruction");
3927330f729Sjoerg 
3937330f729Sjoerg   // For little-endian instruction bit encodings, reverse the bit order
3947330f729Sjoerg   Target.reverseBitsForLittleEndianEncoding();
3957330f729Sjoerg 
3967330f729Sjoerg   ArrayRef<const CodeGenInstruction*> NumberedInstructions =
3977330f729Sjoerg     Target.getInstructionsByEnumValue();
3987330f729Sjoerg 
3997330f729Sjoerg   const CodeGenHwModes &HWM = Target.getHwModes();
4007330f729Sjoerg   // The set of HwModes used by instruction encodings.
4017330f729Sjoerg   std::set<unsigned> HwModes;
4027330f729Sjoerg   BitWidth = 0;
4037330f729Sjoerg   for (const CodeGenInstruction *CGI : NumberedInstructions) {
4047330f729Sjoerg     Record *R = CGI->TheDef;
4057330f729Sjoerg     if (R->getValueAsString("Namespace") == "TargetOpcode" ||
4067330f729Sjoerg         R->getValueAsBit("isPseudo"))
4077330f729Sjoerg       continue;
4087330f729Sjoerg 
4097330f729Sjoerg     if (const RecordVal *RV = R->getValue("EncodingInfos")) {
4107330f729Sjoerg       if (DefInit *DI = dyn_cast_or_null<DefInit>(RV->getValue())) {
4117330f729Sjoerg         EncodingInfoByHwMode EBM(DI->getDef(), HWM);
412*82d56013Sjoerg         for (auto &KV : EBM) {
4137330f729Sjoerg           BitsInit *BI = KV.second->getValueAsBitsInit("Inst");
4147330f729Sjoerg           BitWidth = std::max(BitWidth, BI->getNumBits());
4157330f729Sjoerg           HwModes.insert(KV.first);
4167330f729Sjoerg         }
4177330f729Sjoerg         continue;
4187330f729Sjoerg       }
4197330f729Sjoerg     }
4207330f729Sjoerg     BitsInit *BI = R->getValueAsBitsInit("Inst");
4217330f729Sjoerg     BitWidth = std::max(BitWidth, BI->getNumBits());
4227330f729Sjoerg   }
4237330f729Sjoerg   UseAPInt = BitWidth > 64;
4247330f729Sjoerg 
4257330f729Sjoerg   // Emit function declaration
4267330f729Sjoerg   if (UseAPInt) {
4277330f729Sjoerg     o << "void " << Target.getName()
4287330f729Sjoerg       << "MCCodeEmitter::getBinaryCodeForInstr(const MCInst &MI,\n"
4297330f729Sjoerg       << "    SmallVectorImpl<MCFixup> &Fixups,\n"
4307330f729Sjoerg       << "    APInt &Inst,\n"
4317330f729Sjoerg       << "    APInt &Scratch,\n"
4327330f729Sjoerg       << "    const MCSubtargetInfo &STI) const {\n";
4337330f729Sjoerg   } else {
4347330f729Sjoerg     o << "uint64_t " << Target.getName();
4357330f729Sjoerg     o << "MCCodeEmitter::getBinaryCodeForInstr(const MCInst &MI,\n"
4367330f729Sjoerg       << "    SmallVectorImpl<MCFixup> &Fixups,\n"
4377330f729Sjoerg       << "    const MCSubtargetInfo &STI) const {\n";
4387330f729Sjoerg   }
4397330f729Sjoerg 
4407330f729Sjoerg   // Emit instruction base values
4417330f729Sjoerg   if (HwModes.empty()) {
4427330f729Sjoerg     emitInstructionBaseValues(o, NumberedInstructions, Target, -1);
4437330f729Sjoerg   } else {
4447330f729Sjoerg     for (unsigned HwMode : HwModes)
4457330f729Sjoerg       emitInstructionBaseValues(o, NumberedInstructions, Target, (int)HwMode);
4467330f729Sjoerg   }
4477330f729Sjoerg 
4487330f729Sjoerg   if (!HwModes.empty()) {
4497330f729Sjoerg     o << "  const uint64_t *InstBits;\n";
4507330f729Sjoerg     o << "  unsigned HwMode = STI.getHwMode();\n";
4517330f729Sjoerg     o << "  switch (HwMode) {\n";
4527330f729Sjoerg     o << "  default: llvm_unreachable(\"Unknown hardware mode!\"); break;\n";
4537330f729Sjoerg     for (unsigned I : HwModes) {
4547330f729Sjoerg       o << "  case " << I << ": InstBits = InstBits_" << HWM.getMode(I).Name
4557330f729Sjoerg         << "; break;\n";
4567330f729Sjoerg     }
4577330f729Sjoerg     o << "  };\n";
4587330f729Sjoerg   }
4597330f729Sjoerg 
4607330f729Sjoerg   // Map to accumulate all the cases.
4617330f729Sjoerg   std::map<std::string, std::vector<std::string>> CaseMap;
4627330f729Sjoerg 
4637330f729Sjoerg   // Construct all cases statement for each opcode
464*82d56013Sjoerg   for (Record *R : Insts) {
4657330f729Sjoerg     if (R->getValueAsString("Namespace") == "TargetOpcode" ||
4667330f729Sjoerg         R->getValueAsBit("isPseudo"))
4677330f729Sjoerg       continue;
4687330f729Sjoerg     std::string InstName =
4697330f729Sjoerg         (R->getValueAsString("Namespace") + "::" + R->getName()).str();
4707330f729Sjoerg     std::string Case = getInstructionCase(R, Target);
4717330f729Sjoerg 
4727330f729Sjoerg     CaseMap[Case].push_back(std::move(InstName));
4737330f729Sjoerg   }
4747330f729Sjoerg 
4757330f729Sjoerg   // Emit initial function code
4767330f729Sjoerg   if (UseAPInt) {
4777330f729Sjoerg     int NumWords = APInt::getNumWords(BitWidth);
4787330f729Sjoerg     int NumBytes = (BitWidth + 7) / 8;
4797330f729Sjoerg     o << "  const unsigned opcode = MI.getOpcode();\n"
4807330f729Sjoerg       << "  if (Inst.getBitWidth() != " << BitWidth << ")\n"
4817330f729Sjoerg       << "    Inst = Inst.zext(" << BitWidth << ");\n"
4827330f729Sjoerg       << "  if (Scratch.getBitWidth() != " << BitWidth << ")\n"
4837330f729Sjoerg       << "    Scratch = Scratch.zext(" << BitWidth << ");\n"
484*82d56013Sjoerg       << "  LoadIntFromMemory(Inst, (const uint8_t *)&InstBits[opcode * "
485*82d56013Sjoerg       << NumWords << "], " << NumBytes << ");\n"
4867330f729Sjoerg       << "  APInt &Value = Inst;\n"
4877330f729Sjoerg       << "  APInt &op = Scratch;\n"
4887330f729Sjoerg       << "  switch (opcode) {\n";
4897330f729Sjoerg   } else {
4907330f729Sjoerg     o << "  const unsigned opcode = MI.getOpcode();\n"
4917330f729Sjoerg       << "  uint64_t Value = InstBits[opcode];\n"
4927330f729Sjoerg       << "  uint64_t op = 0;\n"
4937330f729Sjoerg       << "  (void)op;  // suppress warning\n"
4947330f729Sjoerg       << "  switch (opcode) {\n";
4957330f729Sjoerg   }
4967330f729Sjoerg 
4977330f729Sjoerg   // Emit each case statement
4987330f729Sjoerg   std::map<std::string, std::vector<std::string>>::iterator IE, EE;
4997330f729Sjoerg   for (IE = CaseMap.begin(), EE = CaseMap.end(); IE != EE; ++IE) {
5007330f729Sjoerg     const std::string &Case = IE->first;
5017330f729Sjoerg     std::vector<std::string> &InstList = IE->second;
5027330f729Sjoerg 
5037330f729Sjoerg     for (int i = 0, N = InstList.size(); i < N; i++) {
5047330f729Sjoerg       if (i) o << "\n";
5057330f729Sjoerg       o << "    case " << InstList[i]  << ":";
5067330f729Sjoerg     }
5077330f729Sjoerg     o << " {\n";
5087330f729Sjoerg     o << Case;
5097330f729Sjoerg     o << "      break;\n"
5107330f729Sjoerg       << "    }\n";
5117330f729Sjoerg   }
5127330f729Sjoerg 
5137330f729Sjoerg   // Default case: unhandled opcode
5147330f729Sjoerg   o << "  default:\n"
5157330f729Sjoerg     << "    std::string msg;\n"
5167330f729Sjoerg     << "    raw_string_ostream Msg(msg);\n"
5177330f729Sjoerg     << "    Msg << \"Not supported instr: \" << MI;\n"
5187330f729Sjoerg     << "    report_fatal_error(Msg.str());\n"
5197330f729Sjoerg     << "  }\n";
5207330f729Sjoerg   if (UseAPInt)
5217330f729Sjoerg     o << "  Inst = Value;\n";
5227330f729Sjoerg   else
5237330f729Sjoerg     o << "  return Value;\n";
5247330f729Sjoerg   o << "}\n\n";
5257330f729Sjoerg 
5267330f729Sjoerg   const auto &All = SubtargetFeatureInfo::getAll(Records);
5277330f729Sjoerg   std::map<Record *, SubtargetFeatureInfo, LessRecordByID> SubtargetFeatures;
5287330f729Sjoerg   SubtargetFeatures.insert(All.begin(), All.end());
5297330f729Sjoerg 
5307330f729Sjoerg   o << "#ifdef ENABLE_INSTR_PREDICATE_VERIFIER\n"
5317330f729Sjoerg     << "#undef ENABLE_INSTR_PREDICATE_VERIFIER\n"
5327330f729Sjoerg     << "#include <sstream>\n\n";
5337330f729Sjoerg 
5347330f729Sjoerg   // Emit the subtarget feature enumeration.
5357330f729Sjoerg   SubtargetFeatureInfo::emitSubtargetFeatureBitEnumeration(SubtargetFeatures,
5367330f729Sjoerg                                                            o);
5377330f729Sjoerg 
5387330f729Sjoerg   // Emit the name table for error messages.
5397330f729Sjoerg   o << "#ifndef NDEBUG\n";
5407330f729Sjoerg   SubtargetFeatureInfo::emitNameTable(SubtargetFeatures, o);
5417330f729Sjoerg   o << "#endif // NDEBUG\n";
5427330f729Sjoerg 
5437330f729Sjoerg   // Emit the available features compute function.
5447330f729Sjoerg   SubtargetFeatureInfo::emitComputeAssemblerAvailableFeatures(
5457330f729Sjoerg       Target.getName(), "MCCodeEmitter", "computeAvailableFeatures",
5467330f729Sjoerg       SubtargetFeatures, o);
5477330f729Sjoerg 
5487330f729Sjoerg   std::vector<std::vector<Record *>> FeatureBitsets;
5497330f729Sjoerg   for (const CodeGenInstruction *Inst : Target.getInstructionsByEnumValue()) {
5507330f729Sjoerg     FeatureBitsets.emplace_back();
5517330f729Sjoerg     for (Record *Predicate : Inst->TheDef->getValueAsListOfDefs("Predicates")) {
5527330f729Sjoerg       const auto &I = SubtargetFeatures.find(Predicate);
5537330f729Sjoerg       if (I != SubtargetFeatures.end())
5547330f729Sjoerg         FeatureBitsets.back().push_back(I->second.TheDef);
5557330f729Sjoerg     }
5567330f729Sjoerg   }
5577330f729Sjoerg 
5587330f729Sjoerg   llvm::sort(FeatureBitsets, [&](const std::vector<Record *> &A,
5597330f729Sjoerg                                  const std::vector<Record *> &B) {
5607330f729Sjoerg     if (A.size() < B.size())
5617330f729Sjoerg       return true;
5627330f729Sjoerg     if (A.size() > B.size())
5637330f729Sjoerg       return false;
564*82d56013Sjoerg     for (auto Pair : zip(A, B)) {
5657330f729Sjoerg       if (std::get<0>(Pair)->getName() < std::get<1>(Pair)->getName())
5667330f729Sjoerg         return true;
5677330f729Sjoerg       if (std::get<0>(Pair)->getName() > std::get<1>(Pair)->getName())
5687330f729Sjoerg         return false;
5697330f729Sjoerg     }
5707330f729Sjoerg     return false;
5717330f729Sjoerg   });
5727330f729Sjoerg   FeatureBitsets.erase(
5737330f729Sjoerg       std::unique(FeatureBitsets.begin(), FeatureBitsets.end()),
5747330f729Sjoerg       FeatureBitsets.end());
5757330f729Sjoerg   o << "#ifndef NDEBUG\n"
5767330f729Sjoerg     << "// Feature bitsets.\n"
5777330f729Sjoerg     << "enum : " << getMinimalTypeForRange(FeatureBitsets.size()) << " {\n"
5787330f729Sjoerg     << "  CEFBS_None,\n";
5797330f729Sjoerg   for (const auto &FeatureBitset : FeatureBitsets) {
5807330f729Sjoerg     if (FeatureBitset.empty())
5817330f729Sjoerg       continue;
5827330f729Sjoerg     o << "  " << getNameForFeatureBitset(FeatureBitset) << ",\n";
5837330f729Sjoerg   }
5847330f729Sjoerg   o << "};\n\n"
5857330f729Sjoerg     << "static constexpr FeatureBitset FeatureBitsets[] = {\n"
5867330f729Sjoerg     << "  {}, // CEFBS_None\n";
5877330f729Sjoerg   for (const auto &FeatureBitset : FeatureBitsets) {
5887330f729Sjoerg     if (FeatureBitset.empty())
5897330f729Sjoerg       continue;
5907330f729Sjoerg     o << "  {";
5917330f729Sjoerg     for (const auto &Feature : FeatureBitset) {
5927330f729Sjoerg       const auto &I = SubtargetFeatures.find(Feature);
5937330f729Sjoerg       assert(I != SubtargetFeatures.end() && "Didn't import predicate?");
5947330f729Sjoerg       o << I->second.getEnumBitName() << ", ";
5957330f729Sjoerg     }
5967330f729Sjoerg     o << "},\n";
5977330f729Sjoerg   }
5987330f729Sjoerg   o << "};\n"
5997330f729Sjoerg     << "#endif // NDEBUG\n\n";
6007330f729Sjoerg 
6017330f729Sjoerg 
6027330f729Sjoerg   // Emit the predicate verifier.
6037330f729Sjoerg   o << "void " << Target.getName()
6047330f729Sjoerg     << "MCCodeEmitter::verifyInstructionPredicates(\n"
6057330f729Sjoerg     << "    const MCInst &Inst, const FeatureBitset &AvailableFeatures) const {\n"
6067330f729Sjoerg     << "#ifndef NDEBUG\n"
6077330f729Sjoerg     << "  static " << getMinimalTypeForRange(FeatureBitsets.size())
6087330f729Sjoerg     << " RequiredFeaturesRefs[] = {\n";
6097330f729Sjoerg   unsigned InstIdx = 0;
6107330f729Sjoerg   for (const CodeGenInstruction *Inst : Target.getInstructionsByEnumValue()) {
6117330f729Sjoerg     o << "    CEFBS";
6127330f729Sjoerg     unsigned NumPredicates = 0;
6137330f729Sjoerg     for (Record *Predicate : Inst->TheDef->getValueAsListOfDefs("Predicates")) {
6147330f729Sjoerg       const auto &I = SubtargetFeatures.find(Predicate);
6157330f729Sjoerg       if (I != SubtargetFeatures.end()) {
6167330f729Sjoerg         o << '_' << I->second.TheDef->getName();
6177330f729Sjoerg         NumPredicates++;
6187330f729Sjoerg       }
6197330f729Sjoerg     }
6207330f729Sjoerg     if (!NumPredicates)
6217330f729Sjoerg       o << "_None";
6227330f729Sjoerg     o << ", // " << Inst->TheDef->getName() << " = " << InstIdx << "\n";
6237330f729Sjoerg     InstIdx++;
6247330f729Sjoerg   }
6257330f729Sjoerg   o << "  };\n\n";
6267330f729Sjoerg   o << "  assert(Inst.getOpcode() < " << InstIdx << ");\n";
6277330f729Sjoerg   o << "  const FeatureBitset &RequiredFeatures = "
6287330f729Sjoerg        "FeatureBitsets[RequiredFeaturesRefs[Inst.getOpcode()]];\n";
6297330f729Sjoerg   o << "  FeatureBitset MissingFeatures =\n"
6307330f729Sjoerg     << "      (AvailableFeatures & RequiredFeatures) ^\n"
6317330f729Sjoerg     << "      RequiredFeatures;\n"
6327330f729Sjoerg     << "  if (MissingFeatures.any()) {\n"
6337330f729Sjoerg     << "    std::ostringstream Msg;\n"
6347330f729Sjoerg     << "    Msg << \"Attempting to emit \" << "
6357330f729Sjoerg        "MCII.getName(Inst.getOpcode()).str()\n"
6367330f729Sjoerg     << "        << \" instruction but the \";\n"
6377330f729Sjoerg     << "    for (unsigned i = 0, e = MissingFeatures.size(); i != e; ++i)\n"
6387330f729Sjoerg     << "      if (MissingFeatures.test(i))\n"
6397330f729Sjoerg     << "        Msg << SubtargetFeatureNames[i] << \" \";\n"
6407330f729Sjoerg     << "    Msg << \"predicate(s) are not met\";\n"
6417330f729Sjoerg     << "    report_fatal_error(Msg.str());\n"
6427330f729Sjoerg     << "  }\n"
6437330f729Sjoerg     << "#else\n"
6447330f729Sjoerg     << "  // Silence unused variable warning on targets that don't use MCII for "
6457330f729Sjoerg        "other purposes (e.g. BPF).\n"
6467330f729Sjoerg     << "  (void)MCII;\n"
6477330f729Sjoerg     << "#endif // NDEBUG\n";
6487330f729Sjoerg   o << "}\n";
6497330f729Sjoerg   o << "#endif\n";
6507330f729Sjoerg }
6517330f729Sjoerg 
6527330f729Sjoerg } // end anonymous namespace
6537330f729Sjoerg 
6547330f729Sjoerg namespace llvm {
6557330f729Sjoerg 
EmitCodeEmitter(RecordKeeper & RK,raw_ostream & OS)6567330f729Sjoerg void EmitCodeEmitter(RecordKeeper &RK, raw_ostream &OS) {
6577330f729Sjoerg   emitSourceFileHeader("Machine Code Emitter", OS);
6587330f729Sjoerg   CodeEmitterGen(RK).run(OS);
6597330f729Sjoerg }
6607330f729Sjoerg 
6617330f729Sjoerg } // end namespace llvm
662