[TableGen][DecoderEmitter] Rename some variables for clarity (NFC)

Author: s-barannikov

llvm/utils/TableGen/DecoderEmitter.cpp

@@ -486,10 +486,10 @@ class FilterChooser {
 protected:
   friend class Filter;
 
-  // Vector of codegen instructions to choose our filter.
-  ArrayRef<EncodingAndInst> AllInstructions;
+  // Vector of encodings to choose our filter.
+  ArrayRef<EncodingAndInst> Encodings;
 
-  // Vector of uid's for this filter chooser to work on.
+  // Vector of encoding IDs for this filter chooser to work on.
   ArrayRef<unsigned> EncodingIDs;
 
   // Lookup table for the operand decoding of instructions.
@@ -518,20 +518,22 @@ class FilterChooser {
   };
 
 public:
-  FilterChooser(ArrayRef<EncodingAndInst> Insts, ArrayRef<unsigned> EncodingIDs,
+  FilterChooser(ArrayRef<EncodingAndInst> Encodings,
+                ArrayRef<unsigned> EncodingIDs,
                 const std::map<unsigned, std::vector<OperandInfo>> &Ops,
                 unsigned BW, const DecoderEmitter *E)
-      : AllInstructions(Insts), EncodingIDs(EncodingIDs), Operands(Ops),
+      : Encodings(Encodings), EncodingIDs(EncodingIDs), Operands(Ops),
         FilterBitValues(BW, BitValue::BIT_UNFILTERED), Parent(nullptr),
         BitWidth(BW), Emitter(E) {
     doFilter();
   }
 
-  FilterChooser(ArrayRef<EncodingAndInst> Insts, ArrayRef<unsigned> EncodingIDs,
+  FilterChooser(ArrayRef<EncodingAndInst> Encodings,
+                ArrayRef<unsigned> EncodingIDs,
                 const std::map<unsigned, std::vector<OperandInfo>> &Ops,
                 const std::vector<BitValue> &ParentFilterBitValues,
                 const FilterChooser &parent)
-      : AllInstructions(Insts), EncodingIDs(EncodingIDs), Operands(Ops),
+      : Encodings(Encodings), EncodingIDs(EncodingIDs), Operands(Ops),
         FilterBitValues(ParentFilterBitValues), Parent(&parent),
         BitWidth(parent.BitWidth), Emitter(parent.Emitter) {
     doFilter();
@@ -544,8 +546,8 @@ class FilterChooser {
 
 protected:
   // Populates the insn given the uid.
-  insn_t insnWithID(unsigned Opcode) const {
-    const Record *EncodingDef = AllInstructions[Opcode].EncodingDef;
+  insn_t insnWithID(unsigned EncodingID) const {
+    const Record *EncodingDef = Encodings[EncodingID].EncodingDef;
     const BitsInit &Bits = getBitsField(*EncodingDef, "Inst");
     insn_t Insn(std::max(BitWidth, Bits.getNumBits()), BitValue::BIT_UNSET);
     // We may have a SoftFail bitmask, which specifies a mask where an encoding
@@ -584,15 +586,17 @@ class FilterChooser {
 
   // Emits code to check the Predicates member of an instruction are true.
   // Returns true if predicate matches were emitted, false otherwise.
-  bool emitPredicateMatch(raw_ostream &OS, unsigned Opc) const;
+  bool emitPredicateMatch(raw_ostream &OS, unsigned EncodingID) const;
   bool emitPredicateMatchAux(const Init &Val, bool ParenIfBinOp,
                              raw_ostream &OS) const;
 
-  bool doesOpcodeNeedPredicate(unsigned Opc) const;
+  bool doesOpcodeNeedPredicate(unsigned EncodingID) const;
   unsigned getPredicateIndex(DecoderTableInfo &TableInfo, StringRef P) const;
-  void emitPredicateTableEntry(DecoderTableInfo &TableInfo, unsigned Opc) const;
+  void emitPredicateTableEntry(DecoderTableInfo &TableInfo,
+                               unsigned EncodingID) const;
 
-  void emitSoftFailTableEntry(DecoderTableInfo &TableInfo, unsigned Opc) const;
+  void emitSoftFailTableEntry(DecoderTableInfo &TableInfo,
+                              unsigned EncodingID) const;
 
   // Emits table entries to decode the singleton.
   void emitSingletonTableEntry(DecoderTableInfo &TableInfo,
@@ -605,9 +609,9 @@ class FilterChooser {
   bool emitBinaryParser(raw_ostream &OS, indent Indent,
                         const OperandInfo &OpInfo) const;
 
-  bool emitDecoder(raw_ostream &OS, indent Indent, unsigned Opc) const;
+  bool emitDecoder(raw_ostream &OS, indent Indent, unsigned EncodingID) const;
   std::pair<unsigned, bool> getDecoderIndex(DecoderSet &Decoders,
-                                            unsigned Opc) const;
+                                            unsigned EncodingID) const;
 
   // Assign a single filter and run with it.
   void runSingleFilter(unsigned startBit, unsigned numBit);
@@ -694,9 +698,8 @@ void Filter::recurse() {
 
     // Delegates to an inferior filter chooser for further processing on this
     // group of instructions whose segment values are variable.
-    VariableFC =
-        std::make_unique<FilterChooser>(Owner.AllInstructions, VariableIDs,
-                                        Owner.Operands, BitValueArray, Owner);
+    VariableFC = std::make_unique<FilterChooser>(
+        Owner.Encodings, VariableIDs, Owner.Operands, BitValueArray, Owner);
   }
 
   // No need to recurse for a singleton filtered instruction.
@@ -718,7 +721,7 @@ void Filter::recurse() {
     // category of instructions.
     FilterChooserMap.try_emplace(
         FilterVal,
-        std::make_unique<FilterChooser>(Owner.AllInstructions, EncodingIDs,
+        std::make_unique<FilterChooser>(Owner.Encodings, EncodingIDs,
                                         Owner.Operands, BitValueArray, Owner));
   }
 }
@@ -1197,10 +1200,10 @@ bool FilterChooser::emitBinaryParser(raw_ostream &OS, indent Indent,
 }
 
 bool FilterChooser::emitDecoder(raw_ostream &OS, indent Indent,
-                                unsigned Opc) const {
+                                unsigned EncodingID) const {
   bool HasCompleteDecoder = true;
 
-  for (const auto &Op : Operands.find(Opc)->second) {
+  for (const OperandInfo &Op : Operands.find(EncodingID)->second) {
     // If a custom instruction decoder was specified, use that.
     if (Op.numFields() == 0 && !Op.Decoder.empty()) {
       HasCompleteDecoder = Op.HasCompleteDecoder;
@@ -1216,15 +1219,16 @@ bool FilterChooser::emitDecoder(raw_ostream &OS, indent Indent,
   return HasCompleteDecoder;
 }
 
-std::pair<unsigned, bool> FilterChooser::getDecoderIndex(DecoderSet &Decoders,
-                                                         unsigned Opc) const {
+std::pair<unsigned, bool>
+FilterChooser::getDecoderIndex(DecoderSet &Decoders,
+                               unsigned EncodingID) const {
   // Build up the predicate string.
   SmallString<256> Decoder;
   // FIXME: emitDecoder() function can take a buffer directly rather than
   // a stream.
   raw_svector_ostream S(Decoder);
   indent Indent(UseFnTableInDecodeToMCInst ? 2 : 4);
-  bool HasCompleteDecoder = emitDecoder(S, Indent, Opc);
+  bool HasCompleteDecoder = emitDecoder(S, Indent, EncodingID);
 
   // Using the full decoder string as the key value here is a bit
   // heavyweight, but is effective. If the string comparisons become a
@@ -1273,9 +1277,10 @@ bool FilterChooser::emitPredicateMatchAux(const Init &Val, bool ParenIfBinOp,
   return true;
 }
 
-bool FilterChooser::emitPredicateMatch(raw_ostream &OS, unsigned Opc) const {
+bool FilterChooser::emitPredicateMatch(raw_ostream &OS,
+                                       unsigned EncodingID) const {
   const ListInit *Predicates =
-      AllInstructions[Opc].EncodingDef->getValueAsListInit("Predicates");
+      Encodings[EncodingID].EncodingDef->getValueAsListInit("Predicates");
   bool IsFirstEmission = true;
   for (unsigned i = 0; i < Predicates->size(); ++i) {
     const Record *Pred = Predicates->getElementAsRecord(i);
@@ -1295,9 +1300,9 @@ bool FilterChooser::emitPredicateMatch(raw_ostream &OS, unsigned Opc) const {
   return !Predicates->empty();
 }
 
-bool FilterChooser::doesOpcodeNeedPredicate(unsigned Opc) const {
+bool FilterChooser::doesOpcodeNeedPredicate(unsigned EncodingID) const {
   const ListInit *Predicates =
-      AllInstructions[Opc].EncodingDef->getValueAsListInit("Predicates");
+      Encodings[EncodingID].EncodingDef->getValueAsListInit("Predicates");
   for (unsigned i = 0; i < Predicates->size(); ++i) {
     const Record *Pred = Predicates->getElementAsRecord(i);
     if (!Pred->getValue("AssemblerMatcherPredicate"))
@@ -1325,16 +1330,16 @@ unsigned FilterChooser::getPredicateIndex(DecoderTableInfo &TableInfo,
 }
 
 void FilterChooser::emitPredicateTableEntry(DecoderTableInfo &TableInfo,
-                                            unsigned Opc) const {
-  if (!doesOpcodeNeedPredicate(Opc))
+                                            unsigned EncodingID) const {
+  if (!doesOpcodeNeedPredicate(EncodingID))
     return;
 
   // Build up the predicate string.
   SmallString<256> Predicate;
   // FIXME: emitPredicateMatch() functions can take a buffer directly rather
   // than a stream.
   raw_svector_ostream PS(Predicate);
-  emitPredicateMatch(PS, Opc);
+  emitPredicateMatch(PS, EncodingID);
 
   // Figure out the index into the predicate table for the predicate just
   // computed.
@@ -1353,8 +1358,8 @@ void FilterChooser::emitPredicateTableEntry(DecoderTableInfo &TableInfo,
 }
 
 void FilterChooser::emitSoftFailTableEntry(DecoderTableInfo &TableInfo,
-                                           unsigned Opc) const {
-  const Record *EncodingDef = AllInstructions[Opc].EncodingDef;
+                                           unsigned EncodingID) const {
+  const Record *EncodingDef = Encodings[EncodingID].EncodingDef;
   const RecordVal *RV = EncodingDef->getValue("SoftFail");
   const BitsInit *SFBits = RV ? dyn_cast<BitsInit>(RV->getValue()) : nullptr;
 
@@ -1380,7 +1385,7 @@ void FilterChooser::emitSoftFailTableEntry(DecoderTableInfo &TableInfo,
     } else {
       // The bit is not set; this must be an error!
       errs() << "SoftFail Conflict: bit SoftFail{" << i << "} in "
-             << AllInstructions[Opc] << " is set but Inst{" << i
+             << Encodings[EncodingID] << " is set but Inst{" << i
              << "} is unset!\n"
              << "  - You can only mark a bit as SoftFail if it is fully defined"
              << " (1/0 - not '?') in Inst\n";
@@ -1453,7 +1458,7 @@ void FilterChooser::emitSingletonTableEntry(DecoderTableInfo &TableInfo,
                                                       : MCD::OPC_TryDecode);
   TableInfo.Table.push_back(DecoderOp);
   NumEncodingsSupported++;
-  const Record *InstDef = AllInstructions[EncodingID].Inst->TheDef;
+  const Record *InstDef = Encodings[EncodingID].Inst->TheDef;
   TableInfo.Table.insertULEB128(Emitter->getTarget().getInstrIntValue(InstDef));
   TableInfo.Table.insertULEB128(DIdx);
 
@@ -1748,7 +1753,7 @@ void FilterChooser::doFilter() {
 
   // Dump encodings.
   for (unsigned EncodingID : EncodingIDs) {
-    const EncodingAndInst &Enc = AllInstructions[EncodingID];
+    const EncodingAndInst &Enc = Encodings[EncodingID];
     errs() << Indent;
     dumpBits(errs(), getBitsField(*Enc.EncodingDef, "Inst"), BitWidth);
     errs() << "  " << Enc << '\n';
@@ -1919,7 +1924,7 @@ static void addOneOperandFields(const Record &EncodingDef, const BitsInit &Bits,
 
 static unsigned
 populateInstruction(const CodeGenTarget &Target, const Record &EncodingDef,
-                    const CodeGenInstruction &CGI, unsigned Opc,
+                    const CodeGenInstruction &CGI, unsigned EncodingID,
                     std::map<unsigned, std::vector<OperandInfo>> &Operands,
                     bool IsVarLenInst) {
   const Record &Def = *CGI.TheDef;
@@ -1941,7 +1946,7 @@ populateInstruction(const CodeGenTarget &Target, const Record &EncodingDef,
         EncodingDef.getValueAsBit("hasCompleteDecoder");
     InsnOperands.push_back(
         OperandInfo(InstDecoder.str(), HasCompleteInstDecoder));
-    Operands[Opc] = std::move(InsnOperands);
+    Operands[EncodingID] = std::move(InsnOperands);
     return Bits.getNumBits();
   }
 
@@ -2063,7 +2068,7 @@ populateInstruction(const CodeGenTarget &Target, const Record &EncodingDef,
         InsnOperands.push_back(std::move(OpInfo));
     }
   }
-  Operands[Opc] = std::move(InsnOperands);
+  Operands[EncodingID] = std::move(InsnOperands);
 
 #if 0
   LLVM_DEBUG({