contrib/llvm/utils/TableGen/CodeGenInstruction.cpp

   1 //===- CodeGenInstruction.cpp - CodeGen Instruction Class Wrapper ---------===//
   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 // This file implements the CodeGenInstruction class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "CodeGenInstruction.h"
  15 #include "CodeGenTarget.h"
  16 #include "llvm/ADT/STLExtras.h"
  17 #include "llvm/ADT/StringExtras.h"
  18 #include "llvm/ADT/StringMap.h"
  19 #include "llvm/TableGen/Error.h"
  20 #include "llvm/TableGen/Record.h"
  21 #include <set>
  22 using namespace llvm;
  23
  24 //===----------------------------------------------------------------------===//
  25 // CGIOperandList Implementation
  26 //===----------------------------------------------------------------------===//
  27
  28 CGIOperandList::CGIOperandList(Record *R) : TheDef(R) {
  29   isPredicable = false;
  30   hasOptionalDef = false;
  31   isVariadic = false;
  32
  33   DagInit *OutDI = R->getValueAsDag("OutOperandList");
  34
  35   if (DefInit *Init = dyn_cast<DefInit>(OutDI->getOperator())) {
  36     if (Init->getDef()->getName() != "outs")
  37       PrintFatalError(R->getName() + ": invalid def name for output list: use 'outs'");
  38   } else
  39     PrintFatalError(R->getName() + ": invalid output list: use 'outs'");
  40
  41   NumDefs = OutDI->getNumArgs();
  42
  43   DagInit *InDI = R->getValueAsDag("InOperandList");
  44   if (DefInit *Init = dyn_cast<DefInit>(InDI->getOperator())) {
  45     if (Init->getDef()->getName() != "ins")
  46       PrintFatalError(R->getName() + ": invalid def name for input list: use 'ins'");
  47   } else
  48     PrintFatalError(R->getName() + ": invalid input list: use 'ins'");
  49
  50   unsigned MIOperandNo = 0;
  51   std::set<std::string> OperandNames;
  52   unsigned e = InDI->getNumArgs() + OutDI->getNumArgs();
  53   OperandList.reserve(e);
  54   for (unsigned i = 0; i != e; ++i){
  55     Init *ArgInit;
  56     StringRef ArgName;
  57     if (i < NumDefs) {
  58       ArgInit = OutDI->getArg(i);
  59       ArgName = OutDI->getArgNameStr(i);
  60     } else {
  61       ArgInit = InDI->getArg(i-NumDefs);
  62       ArgName = InDI->getArgNameStr(i-NumDefs);
  63     }
  64
  65     DefInit *Arg = dyn_cast<DefInit>(ArgInit);
  66     if (!Arg)
  67       PrintFatalError("Illegal operand for the '" + R->getName() + "' instruction!");
  68
  69     Record *Rec = Arg->getDef();
  70     std::string PrintMethod = "printOperand";
  71     std::string EncoderMethod;
  72     std::string OperandType = "OPERAND_UNKNOWN";
  73     std::string OperandNamespace = "MCOI";
  74     unsigned NumOps = 1;
  75     DagInit *MIOpInfo = nullptr;
  76     if (Rec->isSubClassOf("RegisterOperand")) {
  77       PrintMethod = Rec->getValueAsString("PrintMethod");
  78       OperandType = Rec->getValueAsString("OperandType");
  79       OperandNamespace = Rec->getValueAsString("OperandNamespace");
  80       EncoderMethod = Rec->getValueAsString("EncoderMethod");
  81     } else if (Rec->isSubClassOf("Operand")) {
  82       PrintMethod = Rec->getValueAsString("PrintMethod");
  83       OperandType = Rec->getValueAsString("OperandType");
  84       OperandNamespace = Rec->getValueAsString("OperandNamespace");
  85       // If there is an explicit encoder method, use it.
  86       EncoderMethod = Rec->getValueAsString("EncoderMethod");
  87       MIOpInfo = Rec->getValueAsDag("MIOperandInfo");
  88
  89       // Verify that MIOpInfo has an 'ops' root value.
  90       if (!isa<DefInit>(MIOpInfo->getOperator()) ||
  91           cast<DefInit>(MIOpInfo->getOperator())->getDef()->getName() != "ops")
  92         PrintFatalError("Bad value for MIOperandInfo in operand '" + Rec->getName() +
  93           "'\n");
  94
  95       // If we have MIOpInfo, then we have #operands equal to number of entries
  96       // in MIOperandInfo.
  97       if (unsigned NumArgs = MIOpInfo->getNumArgs())
  98         NumOps = NumArgs;
  99
 100       if (Rec->isSubClassOf("PredicateOp"))
 101         isPredicable = true;
 102       else if (Rec->isSubClassOf("OptionalDefOperand"))
 103         hasOptionalDef = true;
 104     } else if (Rec->getName() == "variable_ops") {
 105       isVariadic = true;
 106       continue;
 107     } else if (Rec->isSubClassOf("RegisterClass")) {
 108       OperandType = "OPERAND_REGISTER";
 109     } else if (!Rec->isSubClassOf("PointerLikeRegClass") &&
 110                !Rec->isSubClassOf("unknown_class"))
 111       PrintFatalError("Unknown operand class '" + Rec->getName() +
 112         "' in '" + R->getName() + "' instruction!");
 113
 114     // Check that the operand has a name and that it's unique.
 115     if (ArgName.empty())
 116       PrintFatalError("In instruction '" + R->getName() + "', operand #" +
 117                       Twine(i) + " has no name!");
 118     if (!OperandNames.insert(ArgName).second)
 119       PrintFatalError("In instruction '" + R->getName() + "', operand #" +
 120                       Twine(i) + " has the same name as a previous operand!");
 121
 122     OperandList.emplace_back(Rec, ArgName, PrintMethod, EncoderMethod,
 123                              OperandNamespace + "::" + OperandType, MIOperandNo,
 124                              NumOps, MIOpInfo);
 125     MIOperandNo += NumOps;
 126   }
 127
 128
 129   // Make sure the constraints list for each operand is large enough to hold
 130   // constraint info, even if none is present.
 131   for (OperandInfo &OpInfo : OperandList)
 132     OpInfo.Constraints.resize(OpInfo.MINumOperands);
 133 }
 134
 135
 136 /// getOperandNamed - Return the index of the operand with the specified
 137 /// non-empty name.  If the instruction does not have an operand with the
 138 /// specified name, abort.
 139 ///
 140 unsigned CGIOperandList::getOperandNamed(StringRef Name) const {
 141   unsigned OpIdx;
 142   if (hasOperandNamed(Name, OpIdx)) return OpIdx;
 143   PrintFatalError("'" + TheDef->getName() +
 144                   "' does not have an operand named '$" + Name + "'!");
 145 }
 146
 147 /// hasOperandNamed - Query whether the instruction has an operand of the
 148 /// given name. If so, return true and set OpIdx to the index of the
 149 /// operand. Otherwise, return false.
 150 bool CGIOperandList::hasOperandNamed(StringRef Name, unsigned &OpIdx) const {
 151   assert(!Name.empty() && "Cannot search for operand with no name!");
 152   for (unsigned i = 0, e = OperandList.size(); i != e; ++i)
 153     if (OperandList[i].Name == Name) {
 154       OpIdx = i;
 155       return true;
 156     }
 157   return false;
 158 }
 159
 160 std::pair<unsigned,unsigned>
 161 CGIOperandList::ParseOperandName(const std::string &Op, bool AllowWholeOp) {
 162   if (Op.empty() || Op[0] != '$')
 163     PrintFatalError(TheDef->getName() + ": Illegal operand name: '" + Op + "'");
 164
 165   std::string OpName = Op.substr(1);
 166   std::string SubOpName;
 167
 168   // Check to see if this is $foo.bar.
 169   std::string::size_type DotIdx = OpName.find_first_of('.');
 170   if (DotIdx != std::string::npos) {
 171     SubOpName = OpName.substr(DotIdx+1);
 172     if (SubOpName.empty())
 173       PrintFatalError(TheDef->getName() + ": illegal empty suboperand name in '" +Op +"'");
 174     OpName = OpName.substr(0, DotIdx);
 175   }
 176
 177   unsigned OpIdx = getOperandNamed(OpName);
 178
 179   if (SubOpName.empty()) {  // If no suboperand name was specified:
 180     // If one was needed, throw.
 181     if (OperandList[OpIdx].MINumOperands > 1 && !AllowWholeOp &&
 182         SubOpName.empty())
 183       PrintFatalError(TheDef->getName() + ": Illegal to refer to"
 184         " whole operand part of complex operand '" + Op + "'");
 185
 186     // Otherwise, return the operand.
 187     return std::make_pair(OpIdx, 0U);
 188   }
 189
 190   // Find the suboperand number involved.
 191   DagInit *MIOpInfo = OperandList[OpIdx].MIOperandInfo;
 192   if (!MIOpInfo)
 193     PrintFatalError(TheDef->getName() + ": unknown suboperand name in '" + Op + "'");
 194
 195   // Find the operand with the right name.
 196   for (unsigned i = 0, e = MIOpInfo->getNumArgs(); i != e; ++i)
 197     if (MIOpInfo->getArgNameStr(i) == SubOpName)
 198       return std::make_pair(OpIdx, i);
 199
 200   // Otherwise, didn't find it!
 201   PrintFatalError(TheDef->getName() + ": unknown suboperand name in '" + Op + "'");
 202   return std::make_pair(0U, 0U);
 203 }
 204
 205 static void ParseConstraint(const std::string &CStr, CGIOperandList &Ops) {
 206   // EARLY_CLOBBER: @early $reg
 207   std::string::size_type wpos = CStr.find_first_of(" \t");
 208   std::string::size_type start = CStr.find_first_not_of(" \t");
 209   std::string Tok = CStr.substr(start, wpos - start);
 210   if (Tok == "@earlyclobber") {
 211     std::string Name = CStr.substr(wpos+1);
 212     wpos = Name.find_first_not_of(" \t");
 213     if (wpos == std::string::npos)
 214       PrintFatalError("Illegal format for @earlyclobber constraint: '" + CStr + "'");
 215     Name = Name.substr(wpos);
 216     std::pair<unsigned,unsigned> Op = Ops.ParseOperandName(Name, false);
 217
 218     // Build the string for the operand
 219     if (!Ops[Op.first].Constraints[Op.second].isNone())
 220       PrintFatalError("Operand '" + Name + "' cannot have multiple constraints!");
 221     Ops[Op.first].Constraints[Op.second] =
 222     CGIOperandList::ConstraintInfo::getEarlyClobber();
 223     return;
 224   }
 225
 226   // Only other constraint is "TIED_TO" for now.
 227   std::string::size_type pos = CStr.find_first_of('=');
 228   assert(pos != std::string::npos && "Unrecognized constraint");
 229   start = CStr.find_first_not_of(" \t");
 230   std::string Name = CStr.substr(start, pos - start);
 231
 232   // TIED_TO: $src1 = $dst
 233   wpos = Name.find_first_of(" \t");
 234   if (wpos == std::string::npos)
 235     PrintFatalError("Illegal format for tied-to constraint: '" + CStr + "'");
 236   std::string DestOpName = Name.substr(0, wpos);
 237   std::pair<unsigned,unsigned> DestOp = Ops.ParseOperandName(DestOpName, false);
 238
 239   Name = CStr.substr(pos+1);
 240   wpos = Name.find_first_not_of(" \t");
 241   if (wpos == std::string::npos)
 242     PrintFatalError("Illegal format for tied-to constraint: '" + CStr + "'");
 243
 244   std::string SrcOpName = Name.substr(wpos);
 245   std::pair<unsigned,unsigned> SrcOp = Ops.ParseOperandName(SrcOpName, false);
 246   if (SrcOp > DestOp) {
 247     std::swap(SrcOp, DestOp);
 248     std::swap(SrcOpName, DestOpName);
 249   }
 250
 251   unsigned FlatOpNo = Ops.getFlattenedOperandNumber(SrcOp);
 252
 253   if (!Ops[DestOp.first].Constraints[DestOp.second].isNone())
 254     PrintFatalError("Operand '" + DestOpName +
 255       "' cannot have multiple constraints!");
 256   Ops[DestOp.first].Constraints[DestOp.second] =
 257     CGIOperandList::ConstraintInfo::getTied(FlatOpNo);
 258 }
 259
 260 static void ParseConstraints(const std::string &CStr, CGIOperandList &Ops) {
 261   if (CStr.empty()) return;
 262
 263   const std::string delims(",");
 264   std::string::size_type bidx, eidx;
 265
 266   bidx = CStr.find_first_not_of(delims);
 267   while (bidx != std::string::npos) {
 268     eidx = CStr.find_first_of(delims, bidx);
 269     if (eidx == std::string::npos)
 270       eidx = CStr.length();
 271
 272     ParseConstraint(CStr.substr(bidx, eidx - bidx), Ops);
 273     bidx = CStr.find_first_not_of(delims, eidx);
 274   }
 275 }
 276
 277 void CGIOperandList::ProcessDisableEncoding(std::string DisableEncoding) {
 278   while (1) {
 279     std::pair<StringRef, StringRef> P = getToken(DisableEncoding, " ,\t");
 280     std::string OpName = P.first;
 281     DisableEncoding = P.second;
 282     if (OpName.empty()) break;
 283
 284     // Figure out which operand this is.
 285     std::pair<unsigned,unsigned> Op = ParseOperandName(OpName, false);
 286
 287     // Mark the operand as not-to-be encoded.
 288     if (Op.second >= OperandList[Op.first].DoNotEncode.size())
 289       OperandList[Op.first].DoNotEncode.resize(Op.second+1);
 290     OperandList[Op.first].DoNotEncode[Op.second] = true;
 291   }
 292
 293 }
 294
 295 //===----------------------------------------------------------------------===//
 296 // CodeGenInstruction Implementation
 297 //===----------------------------------------------------------------------===//
 298
 299 CodeGenInstruction::CodeGenInstruction(Record *R)
 300   : TheDef(R), Operands(R), InferredFrom(nullptr) {
 301   Namespace = R->getValueAsString("Namespace");
 302   AsmString = R->getValueAsString("AsmString");
 303
 304   isReturn     = R->getValueAsBit("isReturn");
 305   isBranch     = R->getValueAsBit("isBranch");
 306   isIndirectBranch = R->getValueAsBit("isIndirectBranch");
 307   isCompare    = R->getValueAsBit("isCompare");
 308   isMoveImm    = R->getValueAsBit("isMoveImm");
 309   isBitcast    = R->getValueAsBit("isBitcast");
 310   isSelect     = R->getValueAsBit("isSelect");
 311   isBarrier    = R->getValueAsBit("isBarrier");
 312   isCall       = R->getValueAsBit("isCall");
 313   isAdd        = R->getValueAsBit("isAdd");
 314   canFoldAsLoad = R->getValueAsBit("canFoldAsLoad");
 315   isPredicable = Operands.isPredicable || R->getValueAsBit("isPredicable");
 316   isConvertibleToThreeAddress = R->getValueAsBit("isConvertibleToThreeAddress");
 317   isCommutable = R->getValueAsBit("isCommutable");
 318   isTerminator = R->getValueAsBit("isTerminator");
 319   isReMaterializable = R->getValueAsBit("isReMaterializable");
 320   hasDelaySlot = R->getValueAsBit("hasDelaySlot");
 321   usesCustomInserter = R->getValueAsBit("usesCustomInserter");
 322   hasPostISelHook = R->getValueAsBit("hasPostISelHook");
 323   hasCtrlDep   = R->getValueAsBit("hasCtrlDep");
 324   isNotDuplicable = R->getValueAsBit("isNotDuplicable");
 325   isRegSequence = R->getValueAsBit("isRegSequence");
 326   isExtractSubreg = R->getValueAsBit("isExtractSubreg");
 327   isInsertSubreg = R->getValueAsBit("isInsertSubreg");
 328   isConvergent = R->getValueAsBit("isConvergent");
 329   hasNoSchedulingInfo = R->getValueAsBit("hasNoSchedulingInfo");
 330
 331   bool Unset;
 332   mayLoad      = R->getValueAsBitOrUnset("mayLoad", Unset);
 333   mayLoad_Unset = Unset;
 334   mayStore     = R->getValueAsBitOrUnset("mayStore", Unset);
 335   mayStore_Unset = Unset;
 336   hasSideEffects = R->getValueAsBitOrUnset("hasSideEffects", Unset);
 337   hasSideEffects_Unset = Unset;
 338
 339   isAsCheapAsAMove = R->getValueAsBit("isAsCheapAsAMove");
 340   hasExtraSrcRegAllocReq = R->getValueAsBit("hasExtraSrcRegAllocReq");
 341   hasExtraDefRegAllocReq = R->getValueAsBit("hasExtraDefRegAllocReq");
 342   isCodeGenOnly = R->getValueAsBit("isCodeGenOnly");
 343   isPseudo = R->getValueAsBit("isPseudo");
 344   ImplicitDefs = R->getValueAsListOfDefs("Defs");
 345   ImplicitUses = R->getValueAsListOfDefs("Uses");
 346
 347   // Parse Constraints.
 348   ParseConstraints(R->getValueAsString("Constraints"), Operands);
 349
 350   // Parse the DisableEncoding field.
 351   Operands.ProcessDisableEncoding(R->getValueAsString("DisableEncoding"));
 352
 353   // First check for a ComplexDeprecationPredicate.
 354   if (R->getValue("ComplexDeprecationPredicate")) {
 355     HasComplexDeprecationPredicate = true;
 356     DeprecatedReason = R->getValueAsString("ComplexDeprecationPredicate");
 357   } else if (RecordVal *Dep = R->getValue("DeprecatedFeatureMask")) {
 358     // Check if we have a Subtarget feature mask.
 359     HasComplexDeprecationPredicate = false;
 360     DeprecatedReason = Dep->getValue()->getAsString();
 361   } else {
 362     // This instruction isn't deprecated.
 363     HasComplexDeprecationPredicate = false;
 364     DeprecatedReason = "";
 365   }
 366 }
 367
 368 /// HasOneImplicitDefWithKnownVT - If the instruction has at least one
 369 /// implicit def and it has a known VT, return the VT, otherwise return
 370 /// MVT::Other.
 371 MVT::SimpleValueType CodeGenInstruction::
 372 HasOneImplicitDefWithKnownVT(const CodeGenTarget &TargetInfo) const {
 373   if (ImplicitDefs.empty()) return MVT::Other;
 374
 375   // Check to see if the first implicit def has a resolvable type.
 376   Record *FirstImplicitDef = ImplicitDefs[0];
 377   assert(FirstImplicitDef->isSubClassOf("Register"));
 378   const std::vector<ValueTypeByHwMode> &RegVTs =
 379     TargetInfo.getRegisterVTs(FirstImplicitDef);
 380   if (RegVTs.size() == 1 && RegVTs[0].isSimple())
 381     return RegVTs[0].getSimple().SimpleTy;
 382   return MVT::Other;
 383 }
 384
 385
 386 /// FlattenAsmStringVariants - Flatten the specified AsmString to only
 387 /// include text from the specified variant, returning the new string.
 388 std::string CodeGenInstruction::
 389 FlattenAsmStringVariants(StringRef Cur, unsigned Variant) {
 390   std::string Res = "";
 391
 392   for (;;) {
 393     // Find the start of the next variant string.
 394     size_t VariantsStart = 0;
 395     for (size_t e = Cur.size(); VariantsStart != e; ++VariantsStart)
 396       if (Cur[VariantsStart] == '{' &&
 397           (VariantsStart == 0 || (Cur[VariantsStart-1] != '$' &&
 398                                   Cur[VariantsStart-1] != '\\')))
 399         break;
 400
 401     // Add the prefix to the result.
 402     Res += Cur.slice(0, VariantsStart);
 403     if (VariantsStart == Cur.size())
 404       break;
 405
 406     ++VariantsStart; // Skip the '{'.
 407
 408     // Scan to the end of the variants string.
 409     size_t VariantsEnd = VariantsStart;
 410     unsigned NestedBraces = 1;
 411     for (size_t e = Cur.size(); VariantsEnd != e; ++VariantsEnd) {
 412       if (Cur[VariantsEnd] == '}' && Cur[VariantsEnd-1] != '\\') {
 413         if (--NestedBraces == 0)
 414           break;
 415       } else if (Cur[VariantsEnd] == '{')
 416         ++NestedBraces;
 417     }
 418
 419     // Select the Nth variant (or empty).
 420     StringRef Selection = Cur.slice(VariantsStart, VariantsEnd);
 421     for (unsigned i = 0; i != Variant; ++i)
 422       Selection = Selection.split('|').second;
 423     Res += Selection.split('|').first;
 424
 425     assert(VariantsEnd != Cur.size() &&
 426            "Unterminated variants in assembly string!");
 427     Cur = Cur.substr(VariantsEnd + 1);
 428   }
 429
 430   return Res;
 431 }
 432
 433 bool CodeGenInstruction::isOperandAPointer(unsigned i) const {
 434   if (DagInit *ConstraintList = TheDef->getValueAsDag("InOperandList")) {
 435     if (i < ConstraintList->getNumArgs()) {
 436       if (DefInit *Constraint = dyn_cast<DefInit>(ConstraintList->getArg(i))) {
 437         return Constraint->getDef()->isSubClassOf("TypedOperand") &&
 438                Constraint->getDef()->getValueAsBit("IsPointer");
 439       }
 440     }
 441   }
 442   return false;
 443 }
 444
 445 //===----------------------------------------------------------------------===//
 446 /// CodeGenInstAlias Implementation
 447 //===----------------------------------------------------------------------===//
 448
 449 /// tryAliasOpMatch - This is a helper function for the CodeGenInstAlias
 450 /// constructor.  It checks if an argument in an InstAlias pattern matches
 451 /// the corresponding operand of the instruction.  It returns true on a
 452 /// successful match, with ResOp set to the result operand to be used.
 453 bool CodeGenInstAlias::tryAliasOpMatch(DagInit *Result, unsigned AliasOpNo,
 454                                        Record *InstOpRec, bool hasSubOps,
 455                                        ArrayRef<SMLoc> Loc, CodeGenTarget &T,
 456                                        ResultOperand &ResOp) {
 457   Init *Arg = Result->getArg(AliasOpNo);
 458   DefInit *ADI = dyn_cast<DefInit>(Arg);
 459   Record *ResultRecord = ADI ? ADI->getDef() : nullptr;
 460
 461   if (ADI && ADI->getDef() == InstOpRec) {
 462     // If the operand is a record, it must have a name, and the record type
 463     // must match up with the instruction's argument type.
 464     if (!Result->getArgName(AliasOpNo))
 465       PrintFatalError(Loc, "result argument #" + Twine(AliasOpNo) +
 466                            " must have a name!");
 467     ResOp = ResultOperand(Result->getArgNameStr(AliasOpNo), ResultRecord);
 468     return true;
 469   }
 470
 471   // For register operands, the source register class can be a subclass
 472   // of the instruction register class, not just an exact match.
 473   if (InstOpRec->isSubClassOf("RegisterOperand"))
 474     InstOpRec = InstOpRec->getValueAsDef("RegClass");
 475
 476   if (ADI && ADI->getDef()->isSubClassOf("RegisterOperand"))
 477     ADI = ADI->getDef()->getValueAsDef("RegClass")->getDefInit();
 478
 479   if (ADI && ADI->getDef()->isSubClassOf("RegisterClass")) {
 480     if (!InstOpRec->isSubClassOf("RegisterClass"))
 481       return false;
 482     if (!T.getRegisterClass(InstOpRec)
 483               .hasSubClass(&T.getRegisterClass(ADI->getDef())))
 484       return false;
 485     ResOp = ResultOperand(Result->getArgNameStr(AliasOpNo), ResultRecord);
 486     return true;
 487   }
 488
 489   // Handle explicit registers.
 490   if (ADI && ADI->getDef()->isSubClassOf("Register")) {
 491     if (InstOpRec->isSubClassOf("OptionalDefOperand")) {
 492       DagInit *DI = InstOpRec->getValueAsDag("MIOperandInfo");
 493       // The operand info should only have a single (register) entry. We
 494       // want the register class of it.
 495       InstOpRec = cast<DefInit>(DI->getArg(0))->getDef();
 496     }
 497
 498     if (!InstOpRec->isSubClassOf("RegisterClass"))
 499       return false;
 500
 501     if (!T.getRegisterClass(InstOpRec)
 502         .contains(T.getRegBank().getReg(ADI->getDef())))
 503       PrintFatalError(Loc, "fixed register " + ADI->getDef()->getName() +
 504                       " is not a member of the " + InstOpRec->getName() +
 505                       " register class!");
 506
 507     if (Result->getArgName(AliasOpNo))
 508       PrintFatalError(Loc, "result fixed register argument must "
 509                       "not have a name!");
 510
 511     ResOp = ResultOperand(ResultRecord);
 512     return true;
 513   }
 514
 515   // Handle "zero_reg" for optional def operands.
 516   if (ADI && ADI->getDef()->getName() == "zero_reg") {
 517
 518     // Check if this is an optional def.
 519     // Tied operands where the source is a sub-operand of a complex operand
 520     // need to represent both operands in the alias destination instruction.
 521     // Allow zero_reg for the tied portion. This can and should go away once
 522     // the MC representation of things doesn't use tied operands at all.
 523     //if (!InstOpRec->isSubClassOf("OptionalDefOperand"))
 524     //  throw TGError(Loc, "reg0 used for result that is not an "
 525     //                "OptionalDefOperand!");
 526
 527     ResOp = ResultOperand(static_cast<Record*>(nullptr));
 528     return true;
 529   }
 530
 531   // Literal integers.
 532   if (IntInit *II = dyn_cast<IntInit>(Arg)) {
 533     if (hasSubOps || !InstOpRec->isSubClassOf("Operand"))
 534       return false;
 535     // Integer arguments can't have names.
 536     if (Result->getArgName(AliasOpNo))
 537       PrintFatalError(Loc, "result argument #" + Twine(AliasOpNo) +
 538                       " must not have a name!");
 539     ResOp = ResultOperand(II->getValue());
 540     return true;
 541   }
 542
 543   // Bits<n> (also used for 0bxx literals)
 544   if (BitsInit *BI = dyn_cast<BitsInit>(Arg)) {
 545     if (hasSubOps || !InstOpRec->isSubClassOf("Operand"))
 546       return false;
 547     if (!BI->isComplete())
 548       return false;
 549     // Convert the bits init to an integer and use that for the result.
 550     IntInit *II =
 551       dyn_cast_or_null<IntInit>(BI->convertInitializerTo(IntRecTy::get()));
 552     if (!II)
 553       return false;
 554     ResOp = ResultOperand(II->getValue());
 555     return true;
 556   }
 557
 558   // If both are Operands with the same MVT, allow the conversion. It's
 559   // up to the user to make sure the values are appropriate, just like
 560   // for isel Pat's.
 561   if (InstOpRec->isSubClassOf("Operand") && ADI &&
 562       ADI->getDef()->isSubClassOf("Operand")) {
 563     // FIXME: What other attributes should we check here? Identical
 564     // MIOperandInfo perhaps?
 565     if (InstOpRec->getValueInit("Type") != ADI->getDef()->getValueInit("Type"))
 566       return false;
 567     ResOp = ResultOperand(Result->getArgNameStr(AliasOpNo), ADI->getDef());
 568     return true;
 569   }
 570
 571   return false;
 572 }
 573
 574 unsigned CodeGenInstAlias::ResultOperand::getMINumOperands() const {
 575   if (!isRecord())
 576     return 1;
 577
 578   Record *Rec = getRecord();
 579   if (!Rec->isSubClassOf("Operand"))
 580     return 1;
 581
 582   DagInit *MIOpInfo = Rec->getValueAsDag("MIOperandInfo");
 583   if (MIOpInfo->getNumArgs() == 0) {
 584     // Unspecified, so it defaults to 1
 585     return 1;
 586   }
 587
 588   return MIOpInfo->getNumArgs();
 589 }
 590
 591 CodeGenInstAlias::CodeGenInstAlias(Record *R, unsigned Variant,
 592                                    CodeGenTarget &T)
 593     : TheDef(R) {
 594   Result = R->getValueAsDag("ResultInst");
 595   AsmString = R->getValueAsString("AsmString");
 596   AsmString = CodeGenInstruction::FlattenAsmStringVariants(AsmString, Variant);
 597
 598
 599   // Verify that the root of the result is an instruction.
 600   DefInit *DI = dyn_cast<DefInit>(Result->getOperator());
 601   if (!DI || !DI->getDef()->isSubClassOf("Instruction"))
 602     PrintFatalError(R->getLoc(),
 603                     "result of inst alias should be an instruction");
 604
 605   ResultInst = &T.getInstruction(DI->getDef());
 606
 607   // NameClass - If argument names are repeated, we need to verify they have
 608   // the same class.
 609   StringMap<Record*> NameClass;
 610   for (unsigned i = 0, e = Result->getNumArgs(); i != e; ++i) {
 611     DefInit *ADI = dyn_cast<DefInit>(Result->getArg(i));
 612     if (!ADI || !Result->getArgName(i))
 613       continue;
 614     // Verify we don't have something like: (someinst GR16:$foo, GR32:$foo)
 615     // $foo can exist multiple times in the result list, but it must have the
 616     // same type.
 617     Record *&Entry = NameClass[Result->getArgNameStr(i)];
 618     if (Entry && Entry != ADI->getDef())
 619       PrintFatalError(R->getLoc(), "result value $" + Result->getArgNameStr(i) +
 620                       " is both " + Entry->getName() + " and " +
 621                       ADI->getDef()->getName() + "!");
 622     Entry = ADI->getDef();
 623   }
 624
 625   // Decode and validate the arguments of the result.
 626   unsigned AliasOpNo = 0;
 627   for (unsigned i = 0, e = ResultInst->Operands.size(); i != e; ++i) {
 628
 629     // Tied registers don't have an entry in the result dag unless they're part
 630     // of a complex operand, in which case we include them anyways, as we
 631     // don't have any other way to specify the whole operand.
 632     if (ResultInst->Operands[i].MINumOperands == 1 &&
 633         ResultInst->Operands[i].getTiedRegister() != -1)
 634       continue;
 635
 636     if (AliasOpNo >= Result->getNumArgs())
 637       PrintFatalError(R->getLoc(), "not enough arguments for instruction!");
 638
 639     Record *InstOpRec = ResultInst->Operands[i].Rec;
 640     unsigned NumSubOps = ResultInst->Operands[i].MINumOperands;
 641     ResultOperand ResOp(static_cast<int64_t>(0));
 642     if (tryAliasOpMatch(Result, AliasOpNo, InstOpRec, (NumSubOps > 1),
 643                         R->getLoc(), T, ResOp)) {
 644       // If this is a simple operand, or a complex operand with a custom match
 645       // class, then we can match is verbatim.
 646       if (NumSubOps == 1 ||
 647           (InstOpRec->getValue("ParserMatchClass") &&
 648            InstOpRec->getValueAsDef("ParserMatchClass")
 649              ->getValueAsString("Name") != "Imm")) {
 650         ResultOperands.push_back(ResOp);
 651         ResultInstOperandIndex.push_back(std::make_pair(i, -1));
 652         ++AliasOpNo;
 653
 654       // Otherwise, we need to match each of the suboperands individually.
 655       } else {
 656          DagInit *MIOI = ResultInst->Operands[i].MIOperandInfo;
 657          for (unsigned SubOp = 0; SubOp != NumSubOps; ++SubOp) {
 658           Record *SubRec = cast<DefInit>(MIOI->getArg(SubOp))->getDef();
 659
 660           // Take care to instantiate each of the suboperands with the correct
 661           // nomenclature: $foo.bar
 662           ResultOperands.emplace_back(
 663             Result->getArgName(AliasOpNo)->getAsUnquotedString() + "." +
 664             MIOI->getArgName(SubOp)->getAsUnquotedString(), SubRec);
 665           ResultInstOperandIndex.push_back(std::make_pair(i, SubOp));
 666          }
 667          ++AliasOpNo;
 668       }
 669       continue;
 670     }
 671
 672     // If the argument did not match the instruction operand, and the operand
 673     // is composed of multiple suboperands, try matching the suboperands.
 674     if (NumSubOps > 1) {
 675       DagInit *MIOI = ResultInst->Operands[i].MIOperandInfo;
 676       for (unsigned SubOp = 0; SubOp != NumSubOps; ++SubOp) {
 677         if (AliasOpNo >= Result->getNumArgs())
 678           PrintFatalError(R->getLoc(), "not enough arguments for instruction!");
 679         Record *SubRec = cast<DefInit>(MIOI->getArg(SubOp))->getDef();
 680         if (tryAliasOpMatch(Result, AliasOpNo, SubRec, false,
 681                             R->getLoc(), T, ResOp)) {
 682           ResultOperands.push_back(ResOp);
 683           ResultInstOperandIndex.push_back(std::make_pair(i, SubOp));
 684           ++AliasOpNo;
 685         } else {
 686           PrintFatalError(R->getLoc(), "result argument #" + Twine(AliasOpNo) +
 687                         " does not match instruction operand class " +
 688                         (SubOp == 0 ? InstOpRec->getName() :SubRec->getName()));
 689         }
 690       }
 691       continue;
 692     }
 693     PrintFatalError(R->getLoc(), "result argument #" + Twine(AliasOpNo) +
 694                     " does not match instruction operand class " +
 695                     InstOpRec->getName());
 696   }
 697
 698   if (AliasOpNo != Result->getNumArgs())
 699     PrintFatalError(R->getLoc(), "too many operands for instruction!");
 700 }