1 //===- CodeGenInstruction.cpp - CodeGen Instruction Class Wrapper ---------===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // This file implements the CodeGenInstruction class.
11 //===----------------------------------------------------------------------===//
13 #include "CodeGenInstruction.h"
14 #include "CodeGenTarget.h"
15 #include "llvm/ADT/StringExtras.h"
16 #include "llvm/ADT/StringMap.h"
17 #include "llvm/TableGen/Error.h"
18 #include "llvm/TableGen/Record.h"
22 //===----------------------------------------------------------------------===//
23 // CGIOperandList Implementation
24 //===----------------------------------------------------------------------===//
26 CGIOperandList::CGIOperandList(Record *R) : TheDef(R) {
28 hasOptionalDef = false;
31 DagInit *OutDI = R->getValueAsDag("OutOperandList");
33 if (DefInit *Init = dyn_cast<DefInit>(OutDI->getOperator())) {
34 if (Init->getDef()->getName() != "outs")
35 PrintFatalError(R->getLoc(),
37 ": invalid def name for output list: use 'outs'");
39 PrintFatalError(R->getLoc(),
40 R->getName() + ": invalid output list: use 'outs'");
42 NumDefs = OutDI->getNumArgs();
44 DagInit *InDI = R->getValueAsDag("InOperandList");
45 if (DefInit *Init = dyn_cast<DefInit>(InDI->getOperator())) {
46 if (Init->getDef()->getName() != "ins")
47 PrintFatalError(R->getLoc(),
49 ": invalid def name for input list: use 'ins'");
51 PrintFatalError(R->getLoc(),
52 R->getName() + ": invalid input list: use 'ins'");
54 unsigned MIOperandNo = 0;
55 std::set<std::string> OperandNames;
56 unsigned e = InDI->getNumArgs() + OutDI->getNumArgs();
57 OperandList.reserve(e);
58 bool VariadicOuts = false;
59 for (unsigned i = 0; i != e; ++i){
63 ArgInit = OutDI->getArg(i);
64 ArgName = OutDI->getArgNameStr(i);
66 ArgInit = InDI->getArg(i-NumDefs);
67 ArgName = InDI->getArgNameStr(i-NumDefs);
70 DefInit *Arg = dyn_cast<DefInit>(ArgInit);
72 PrintFatalError(R->getLoc(), "Illegal operand for the '" + R->getName() +
75 Record *Rec = Arg->getDef();
76 std::string PrintMethod = "printOperand";
77 std::string EncoderMethod;
78 std::string OperandType = "OPERAND_UNKNOWN";
79 std::string OperandNamespace = "MCOI";
81 DagInit *MIOpInfo = nullptr;
82 if (Rec->isSubClassOf("RegisterOperand")) {
83 PrintMethod = std::string(Rec->getValueAsString("PrintMethod"));
84 OperandType = std::string(Rec->getValueAsString("OperandType"));
85 OperandNamespace = std::string(Rec->getValueAsString("OperandNamespace"));
86 EncoderMethod = std::string(Rec->getValueAsString("EncoderMethod"));
87 } else if (Rec->isSubClassOf("Operand")) {
88 PrintMethod = std::string(Rec->getValueAsString("PrintMethod"));
89 OperandType = std::string(Rec->getValueAsString("OperandType"));
90 OperandNamespace = std::string(Rec->getValueAsString("OperandNamespace"));
91 // If there is an explicit encoder method, use it.
92 EncoderMethod = std::string(Rec->getValueAsString("EncoderMethod"));
93 MIOpInfo = Rec->getValueAsDag("MIOperandInfo");
95 // Verify that MIOpInfo has an 'ops' root value.
96 if (!isa<DefInit>(MIOpInfo->getOperator()) ||
97 cast<DefInit>(MIOpInfo->getOperator())->getDef()->getName() != "ops")
98 PrintFatalError(R->getLoc(),
99 "Bad value for MIOperandInfo in operand '" +
100 Rec->getName() + "'\n");
102 // If we have MIOpInfo, then we have #operands equal to number of entries
104 if (unsigned NumArgs = MIOpInfo->getNumArgs())
107 if (Rec->isSubClassOf("PredicateOp"))
109 else if (Rec->isSubClassOf("OptionalDefOperand"))
110 hasOptionalDef = true;
111 } else if (Rec->getName() == "variable_ops") {
116 } else if (Rec->isSubClassOf("RegisterClass")) {
117 OperandType = "OPERAND_REGISTER";
118 } else if (!Rec->isSubClassOf("PointerLikeRegClass") &&
119 !Rec->isSubClassOf("unknown_class"))
120 PrintFatalError(R->getLoc(), "Unknown operand class '" + Rec->getName() +
121 "' in '" + R->getName() +
124 // Check that the operand has a name and that it's unique.
126 PrintFatalError(R->getLoc(), "In instruction '" + R->getName() +
127 "', operand #" + Twine(i) +
129 if (!OperandNames.insert(std::string(ArgName)).second)
130 PrintFatalError(R->getLoc(),
131 "In instruction '" + R->getName() + "', operand #" +
133 " has the same name as a previous operand!");
135 OperandList.emplace_back(
136 Rec, std::string(ArgName), std::string(PrintMethod),
137 std::string(EncoderMethod), OperandNamespace + "::" + OperandType,
138 MIOperandNo, NumOps, MIOpInfo);
139 MIOperandNo += NumOps;
145 // Make sure the constraints list for each operand is large enough to hold
146 // constraint info, even if none is present.
147 for (OperandInfo &OpInfo : OperandList)
148 OpInfo.Constraints.resize(OpInfo.MINumOperands);
152 /// getOperandNamed - Return the index of the operand with the specified
153 /// non-empty name. If the instruction does not have an operand with the
154 /// specified name, abort.
156 unsigned CGIOperandList::getOperandNamed(StringRef Name) const {
158 if (hasOperandNamed(Name, OpIdx))
160 PrintFatalError(TheDef->getLoc(), "'" + TheDef->getName() +
161 "' does not have an operand named '$" +
165 /// hasOperandNamed - Query whether the instruction has an operand of the
166 /// given name. If so, return true and set OpIdx to the index of the
167 /// operand. Otherwise, return false.
168 bool CGIOperandList::hasOperandNamed(StringRef Name, unsigned &OpIdx) const {
169 assert(!Name.empty() && "Cannot search for operand with no name!");
170 for (unsigned i = 0, e = OperandList.size(); i != e; ++i)
171 if (OperandList[i].Name == Name) {
178 std::pair<unsigned,unsigned>
179 CGIOperandList::ParseOperandName(StringRef Op, bool AllowWholeOp) {
180 if (Op.empty() || Op[0] != '$')
181 PrintFatalError(TheDef->getLoc(),
182 TheDef->getName() + ": Illegal operand name: '" + Op + "'");
184 StringRef OpName = Op.substr(1);
187 // Check to see if this is $foo.bar.
188 StringRef::size_type DotIdx = OpName.find_first_of('.');
189 if (DotIdx != StringRef::npos) {
190 SubOpName = OpName.substr(DotIdx+1);
191 if (SubOpName.empty())
192 PrintFatalError(TheDef->getLoc(),
194 ": illegal empty suboperand name in '" + Op + "'");
195 OpName = OpName.substr(0, DotIdx);
198 unsigned OpIdx = getOperandNamed(OpName);
200 if (SubOpName.empty()) { // If no suboperand name was specified:
201 // If one was needed, throw.
202 if (OperandList[OpIdx].MINumOperands > 1 && !AllowWholeOp &&
204 PrintFatalError(TheDef->getLoc(),
206 ": Illegal to refer to"
207 " whole operand part of complex operand '" +
210 // Otherwise, return the operand.
211 return std::make_pair(OpIdx, 0U);
214 // Find the suboperand number involved.
215 DagInit *MIOpInfo = OperandList[OpIdx].MIOperandInfo;
217 PrintFatalError(TheDef->getLoc(), TheDef->getName() +
218 ": unknown suboperand name in '" +
221 // Find the operand with the right name.
222 for (unsigned i = 0, e = MIOpInfo->getNumArgs(); i != e; ++i)
223 if (MIOpInfo->getArgNameStr(i) == SubOpName)
224 return std::make_pair(OpIdx, i);
226 // Otherwise, didn't find it!
227 PrintFatalError(TheDef->getLoc(), TheDef->getName() +
228 ": unknown suboperand name in '" + Op +
230 return std::make_pair(0U, 0U);
233 static void ParseConstraint(StringRef CStr, CGIOperandList &Ops,
235 // EARLY_CLOBBER: @early $reg
236 StringRef::size_type wpos = CStr.find_first_of(" \t");
237 StringRef::size_type start = CStr.find_first_not_of(" \t");
238 StringRef Tok = CStr.substr(start, wpos - start);
239 if (Tok == "@earlyclobber") {
240 StringRef Name = CStr.substr(wpos+1);
241 wpos = Name.find_first_not_of(" \t");
242 if (wpos == StringRef::npos)
244 Rec->getLoc(), "Illegal format for @earlyclobber constraint in '" +
245 Rec->getName() + "': '" + CStr + "'");
246 Name = Name.substr(wpos);
247 std::pair<unsigned,unsigned> Op = Ops.ParseOperandName(Name, false);
249 // Build the string for the operand
250 if (!Ops[Op.first].Constraints[Op.second].isNone())
252 Rec->getLoc(), "Operand '" + Name + "' of '" + Rec->getName() +
253 "' cannot have multiple constraints!");
254 Ops[Op.first].Constraints[Op.second] =
255 CGIOperandList::ConstraintInfo::getEarlyClobber();
259 // Only other constraint is "TIED_TO" for now.
260 StringRef::size_type pos = CStr.find_first_of('=');
261 if (pos == StringRef::npos)
263 Rec->getLoc(), "Unrecognized constraint '" + CStr +
264 "' in '" + Rec->getName() + "'");
265 start = CStr.find_first_not_of(" \t");
267 // TIED_TO: $src1 = $dst
268 wpos = CStr.find_first_of(" \t", start);
269 if (wpos == StringRef::npos || wpos > pos)
271 Rec->getLoc(), "Illegal format for tied-to constraint in '" +
272 Rec->getName() + "': '" + CStr + "'");
273 StringRef LHSOpName = CStr.substr(start, wpos - start);
274 std::pair<unsigned,unsigned> LHSOp = Ops.ParseOperandName(LHSOpName, false);
276 wpos = CStr.find_first_not_of(" \t", pos + 1);
277 if (wpos == StringRef::npos)
279 Rec->getLoc(), "Illegal format for tied-to constraint: '" + CStr + "'");
281 StringRef RHSOpName = CStr.substr(wpos);
282 std::pair<unsigned,unsigned> RHSOp = Ops.ParseOperandName(RHSOpName, false);
284 // Sort the operands into order, which should put the output one
285 // first. But keep the original order, for use in diagnostics.
286 bool FirstIsDest = (LHSOp < RHSOp);
287 std::pair<unsigned,unsigned> DestOp = (FirstIsDest ? LHSOp : RHSOp);
288 StringRef DestOpName = (FirstIsDest ? LHSOpName : RHSOpName);
289 std::pair<unsigned,unsigned> SrcOp = (FirstIsDest ? RHSOp : LHSOp);
290 StringRef SrcOpName = (FirstIsDest ? RHSOpName : LHSOpName);
292 // Ensure one operand is a def and the other is a use.
293 if (DestOp.first >= Ops.NumDefs)
295 Rec->getLoc(), "Input operands '" + LHSOpName + "' and '" + RHSOpName +
296 "' of '" + Rec->getName() + "' cannot be tied!");
297 if (SrcOp.first < Ops.NumDefs)
299 Rec->getLoc(), "Output operands '" + LHSOpName + "' and '" + RHSOpName +
300 "' of '" + Rec->getName() + "' cannot be tied!");
302 // The constraint has to go on the operand with higher index, i.e.
303 // the source one. Check there isn't another constraint there
305 if (!Ops[SrcOp.first].Constraints[SrcOp.second].isNone())
307 Rec->getLoc(), "Operand '" + SrcOpName + "' of '" + Rec->getName() +
308 "' cannot have multiple constraints!");
310 unsigned DestFlatOpNo = Ops.getFlattenedOperandNumber(DestOp);
311 auto NewConstraint = CGIOperandList::ConstraintInfo::getTied(DestFlatOpNo);
313 // Check that the earlier operand is not the target of another tie
314 // before making it the target of this one.
315 for (const CGIOperandList::OperandInfo &Op : Ops) {
316 for (unsigned i = 0; i < Op.MINumOperands; i++)
317 if (Op.Constraints[i] == NewConstraint)
319 Rec->getLoc(), "Operand '" + DestOpName + "' of '" + Rec->getName() +
320 "' cannot have multiple operands tied to it!");
323 Ops[SrcOp.first].Constraints[SrcOp.second] = NewConstraint;
326 static void ParseConstraints(StringRef CStr, CGIOperandList &Ops, Record *Rec) {
327 if (CStr.empty()) return;
329 StringRef delims(",");
330 StringRef::size_type bidx, eidx;
332 bidx = CStr.find_first_not_of(delims);
333 while (bidx != StringRef::npos) {
334 eidx = CStr.find_first_of(delims, bidx);
335 if (eidx == StringRef::npos)
338 ParseConstraint(CStr.substr(bidx, eidx - bidx), Ops, Rec);
339 bidx = CStr.find_first_not_of(delims, eidx);
343 void CGIOperandList::ProcessDisableEncoding(StringRef DisableEncoding) {
346 std::tie(OpName, DisableEncoding) = getToken(DisableEncoding, " ,\t");
347 if (OpName.empty()) break;
349 // Figure out which operand this is.
350 std::pair<unsigned,unsigned> Op = ParseOperandName(OpName, false);
352 // Mark the operand as not-to-be encoded.
353 if (Op.second >= OperandList[Op.first].DoNotEncode.size())
354 OperandList[Op.first].DoNotEncode.resize(Op.second+1);
355 OperandList[Op.first].DoNotEncode[Op.second] = true;
360 //===----------------------------------------------------------------------===//
361 // CodeGenInstruction Implementation
362 //===----------------------------------------------------------------------===//
364 CodeGenInstruction::CodeGenInstruction(Record *R)
365 : TheDef(R), Operands(R), InferredFrom(nullptr) {
366 Namespace = R->getValueAsString("Namespace");
367 AsmString = std::string(R->getValueAsString("AsmString"));
369 isPreISelOpcode = R->getValueAsBit("isPreISelOpcode");
370 isReturn = R->getValueAsBit("isReturn");
371 isEHScopeReturn = R->getValueAsBit("isEHScopeReturn");
372 isBranch = R->getValueAsBit("isBranch");
373 isIndirectBranch = R->getValueAsBit("isIndirectBranch");
374 isCompare = R->getValueAsBit("isCompare");
375 isMoveImm = R->getValueAsBit("isMoveImm");
376 isMoveReg = R->getValueAsBit("isMoveReg");
377 isBitcast = R->getValueAsBit("isBitcast");
378 isSelect = R->getValueAsBit("isSelect");
379 isBarrier = R->getValueAsBit("isBarrier");
380 isCall = R->getValueAsBit("isCall");
381 isAdd = R->getValueAsBit("isAdd");
382 isTrap = R->getValueAsBit("isTrap");
383 canFoldAsLoad = R->getValueAsBit("canFoldAsLoad");
384 isPredicable = !R->getValueAsBit("isUnpredicable") && (
385 Operands.isPredicable || R->getValueAsBit("isPredicable"));
386 isConvertibleToThreeAddress = R->getValueAsBit("isConvertibleToThreeAddress");
387 isCommutable = R->getValueAsBit("isCommutable");
388 isTerminator = R->getValueAsBit("isTerminator");
389 isReMaterializable = R->getValueAsBit("isReMaterializable");
390 hasDelaySlot = R->getValueAsBit("hasDelaySlot");
391 usesCustomInserter = R->getValueAsBit("usesCustomInserter");
392 hasPostISelHook = R->getValueAsBit("hasPostISelHook");
393 hasCtrlDep = R->getValueAsBit("hasCtrlDep");
394 isNotDuplicable = R->getValueAsBit("isNotDuplicable");
395 isRegSequence = R->getValueAsBit("isRegSequence");
396 isExtractSubreg = R->getValueAsBit("isExtractSubreg");
397 isInsertSubreg = R->getValueAsBit("isInsertSubreg");
398 isConvergent = R->getValueAsBit("isConvergent");
399 hasNoSchedulingInfo = R->getValueAsBit("hasNoSchedulingInfo");
400 FastISelShouldIgnore = R->getValueAsBit("FastISelShouldIgnore");
401 variadicOpsAreDefs = R->getValueAsBit("variadicOpsAreDefs");
402 isAuthenticated = R->getValueAsBit("isAuthenticated");
405 mayLoad = R->getValueAsBitOrUnset("mayLoad", Unset);
406 mayLoad_Unset = Unset;
407 mayStore = R->getValueAsBitOrUnset("mayStore", Unset);
408 mayStore_Unset = Unset;
409 mayRaiseFPException = R->getValueAsBit("mayRaiseFPException");
410 hasSideEffects = R->getValueAsBitOrUnset("hasSideEffects", Unset);
411 hasSideEffects_Unset = Unset;
413 isAsCheapAsAMove = R->getValueAsBit("isAsCheapAsAMove");
414 hasExtraSrcRegAllocReq = R->getValueAsBit("hasExtraSrcRegAllocReq");
415 hasExtraDefRegAllocReq = R->getValueAsBit("hasExtraDefRegAllocReq");
416 isCodeGenOnly = R->getValueAsBit("isCodeGenOnly");
417 isPseudo = R->getValueAsBit("isPseudo");
418 isMeta = R->getValueAsBit("isMeta");
419 ImplicitDefs = R->getValueAsListOfDefs("Defs");
420 ImplicitUses = R->getValueAsListOfDefs("Uses");
422 // This flag is only inferred from the pattern.
424 hasChain_Inferred = false;
426 // Parse Constraints.
427 ParseConstraints(R->getValueAsString("Constraints"), Operands, R);
429 // Parse the DisableEncoding field.
430 Operands.ProcessDisableEncoding(
431 R->getValueAsString("DisableEncoding"));
433 // First check for a ComplexDeprecationPredicate.
434 if (R->getValue("ComplexDeprecationPredicate")) {
435 HasComplexDeprecationPredicate = true;
437 std::string(R->getValueAsString("ComplexDeprecationPredicate"));
438 } else if (RecordVal *Dep = R->getValue("DeprecatedFeatureMask")) {
439 // Check if we have a Subtarget feature mask.
440 HasComplexDeprecationPredicate = false;
441 DeprecatedReason = Dep->getValue()->getAsString();
443 // This instruction isn't deprecated.
444 HasComplexDeprecationPredicate = false;
445 DeprecatedReason = "";
449 /// HasOneImplicitDefWithKnownVT - If the instruction has at least one
450 /// implicit def and it has a known VT, return the VT, otherwise return
452 MVT::SimpleValueType CodeGenInstruction::
453 HasOneImplicitDefWithKnownVT(const CodeGenTarget &TargetInfo) const {
454 if (ImplicitDefs.empty()) return MVT::Other;
456 // Check to see if the first implicit def has a resolvable type.
457 Record *FirstImplicitDef = ImplicitDefs[0];
458 assert(FirstImplicitDef->isSubClassOf("Register"));
459 const std::vector<ValueTypeByHwMode> &RegVTs =
460 TargetInfo.getRegisterVTs(FirstImplicitDef);
461 if (RegVTs.size() == 1 && RegVTs[0].isSimple())
462 return RegVTs[0].getSimple().SimpleTy;
467 /// FlattenAsmStringVariants - Flatten the specified AsmString to only
468 /// include text from the specified variant, returning the new string.
469 std::string CodeGenInstruction::
470 FlattenAsmStringVariants(StringRef Cur, unsigned Variant) {
474 // Find the start of the next variant string.
475 size_t VariantsStart = 0;
476 for (size_t e = Cur.size(); VariantsStart != e; ++VariantsStart)
477 if (Cur[VariantsStart] == '{' &&
478 (VariantsStart == 0 || (Cur[VariantsStart-1] != '$' &&
479 Cur[VariantsStart-1] != '\\')))
482 // Add the prefix to the result.
483 Res += Cur.slice(0, VariantsStart);
484 if (VariantsStart == Cur.size())
487 ++VariantsStart; // Skip the '{'.
489 // Scan to the end of the variants string.
490 size_t VariantsEnd = VariantsStart;
491 unsigned NestedBraces = 1;
492 for (size_t e = Cur.size(); VariantsEnd != e; ++VariantsEnd) {
493 if (Cur[VariantsEnd] == '}' && Cur[VariantsEnd-1] != '\\') {
494 if (--NestedBraces == 0)
496 } else if (Cur[VariantsEnd] == '{')
500 // Select the Nth variant (or empty).
501 StringRef Selection = Cur.slice(VariantsStart, VariantsEnd);
502 for (unsigned i = 0; i != Variant; ++i)
503 Selection = Selection.split('|').second;
504 Res += Selection.split('|').first;
506 assert(VariantsEnd != Cur.size() &&
507 "Unterminated variants in assembly string!");
508 Cur = Cur.substr(VariantsEnd + 1);
514 bool CodeGenInstruction::isOperandImpl(unsigned i,
515 StringRef PropertyName) const {
516 DagInit *ConstraintList = TheDef->getValueAsDag("InOperandList");
517 if (!ConstraintList || i >= ConstraintList->getNumArgs())
520 DefInit *Constraint = dyn_cast<DefInit>(ConstraintList->getArg(i));
524 return Constraint->getDef()->isSubClassOf("TypedOperand") &&
525 Constraint->getDef()->getValueAsBit(PropertyName);
528 //===----------------------------------------------------------------------===//
529 /// CodeGenInstAlias Implementation
530 //===----------------------------------------------------------------------===//
532 /// tryAliasOpMatch - This is a helper function for the CodeGenInstAlias
533 /// constructor. It checks if an argument in an InstAlias pattern matches
534 /// the corresponding operand of the instruction. It returns true on a
535 /// successful match, with ResOp set to the result operand to be used.
536 bool CodeGenInstAlias::tryAliasOpMatch(DagInit *Result, unsigned AliasOpNo,
537 Record *InstOpRec, bool hasSubOps,
538 ArrayRef<SMLoc> Loc, CodeGenTarget &T,
539 ResultOperand &ResOp) {
540 Init *Arg = Result->getArg(AliasOpNo);
541 DefInit *ADI = dyn_cast<DefInit>(Arg);
542 Record *ResultRecord = ADI ? ADI->getDef() : nullptr;
544 if (ADI && ADI->getDef() == InstOpRec) {
545 // If the operand is a record, it must have a name, and the record type
546 // must match up with the instruction's argument type.
547 if (!Result->getArgName(AliasOpNo))
548 PrintFatalError(Loc, "result argument #" + Twine(AliasOpNo) +
549 " must have a name!");
550 ResOp = ResultOperand(std::string(Result->getArgNameStr(AliasOpNo)),
555 // For register operands, the source register class can be a subclass
556 // of the instruction register class, not just an exact match.
557 if (InstOpRec->isSubClassOf("RegisterOperand"))
558 InstOpRec = InstOpRec->getValueAsDef("RegClass");
560 if (ADI && ADI->getDef()->isSubClassOf("RegisterOperand"))
561 ADI = ADI->getDef()->getValueAsDef("RegClass")->getDefInit();
563 if (ADI && ADI->getDef()->isSubClassOf("RegisterClass")) {
564 if (!InstOpRec->isSubClassOf("RegisterClass"))
566 if (!T.getRegisterClass(InstOpRec)
567 .hasSubClass(&T.getRegisterClass(ADI->getDef())))
569 ResOp = ResultOperand(std::string(Result->getArgNameStr(AliasOpNo)),
574 // Handle explicit registers.
575 if (ADI && ADI->getDef()->isSubClassOf("Register")) {
576 if (InstOpRec->isSubClassOf("OptionalDefOperand")) {
577 DagInit *DI = InstOpRec->getValueAsDag("MIOperandInfo");
578 // The operand info should only have a single (register) entry. We
579 // want the register class of it.
580 InstOpRec = cast<DefInit>(DI->getArg(0))->getDef();
583 if (!InstOpRec->isSubClassOf("RegisterClass"))
586 if (!T.getRegisterClass(InstOpRec)
587 .contains(T.getRegBank().getReg(ADI->getDef())))
588 PrintFatalError(Loc, "fixed register " + ADI->getDef()->getName() +
589 " is not a member of the " + InstOpRec->getName() +
592 if (Result->getArgName(AliasOpNo))
593 PrintFatalError(Loc, "result fixed register argument must "
596 ResOp = ResultOperand(ResultRecord);
600 // Handle "zero_reg" for optional def operands.
601 if (ADI && ADI->getDef()->getName() == "zero_reg") {
603 // Check if this is an optional def.
604 // Tied operands where the source is a sub-operand of a complex operand
605 // need to represent both operands in the alias destination instruction.
606 // Allow zero_reg for the tied portion. This can and should go away once
607 // the MC representation of things doesn't use tied operands at all.
608 //if (!InstOpRec->isSubClassOf("OptionalDefOperand"))
609 // throw TGError(Loc, "reg0 used for result that is not an "
610 // "OptionalDefOperand!");
612 ResOp = ResultOperand(static_cast<Record*>(nullptr));
617 if (IntInit *II = dyn_cast<IntInit>(Arg)) {
618 if (hasSubOps || !InstOpRec->isSubClassOf("Operand"))
620 // Integer arguments can't have names.
621 if (Result->getArgName(AliasOpNo))
622 PrintFatalError(Loc, "result argument #" + Twine(AliasOpNo) +
623 " must not have a name!");
624 ResOp = ResultOperand(II->getValue());
628 // Bits<n> (also used for 0bxx literals)
629 if (BitsInit *BI = dyn_cast<BitsInit>(Arg)) {
630 if (hasSubOps || !InstOpRec->isSubClassOf("Operand"))
632 if (!BI->isComplete())
634 // Convert the bits init to an integer and use that for the result.
635 IntInit *II = dyn_cast_or_null<IntInit>(
636 BI->convertInitializerTo(IntRecTy::get(BI->getRecordKeeper())));
639 ResOp = ResultOperand(II->getValue());
643 // If both are Operands with the same MVT, allow the conversion. It's
644 // up to the user to make sure the values are appropriate, just like
646 if (InstOpRec->isSubClassOf("Operand") && ADI &&
647 ADI->getDef()->isSubClassOf("Operand")) {
648 // FIXME: What other attributes should we check here? Identical
649 // MIOperandInfo perhaps?
650 if (InstOpRec->getValueInit("Type") != ADI->getDef()->getValueInit("Type"))
652 ResOp = ResultOperand(std::string(Result->getArgNameStr(AliasOpNo)),
660 unsigned CodeGenInstAlias::ResultOperand::getMINumOperands() const {
664 Record *Rec = getRecord();
665 if (!Rec->isSubClassOf("Operand"))
668 DagInit *MIOpInfo = Rec->getValueAsDag("MIOperandInfo");
669 if (MIOpInfo->getNumArgs() == 0) {
670 // Unspecified, so it defaults to 1
674 return MIOpInfo->getNumArgs();
677 CodeGenInstAlias::CodeGenInstAlias(Record *R, CodeGenTarget &T)
679 Result = R->getValueAsDag("ResultInst");
680 AsmString = std::string(R->getValueAsString("AsmString"));
682 // Verify that the root of the result is an instruction.
683 DefInit *DI = dyn_cast<DefInit>(Result->getOperator());
684 if (!DI || !DI->getDef()->isSubClassOf("Instruction"))
685 PrintFatalError(R->getLoc(),
686 "result of inst alias should be an instruction");
688 ResultInst = &T.getInstruction(DI->getDef());
690 // NameClass - If argument names are repeated, we need to verify they have
692 StringMap<Record*> NameClass;
693 for (unsigned i = 0, e = Result->getNumArgs(); i != e; ++i) {
694 DefInit *ADI = dyn_cast<DefInit>(Result->getArg(i));
695 if (!ADI || !Result->getArgName(i))
697 // Verify we don't have something like: (someinst GR16:$foo, GR32:$foo)
698 // $foo can exist multiple times in the result list, but it must have the
700 Record *&Entry = NameClass[Result->getArgNameStr(i)];
701 if (Entry && Entry != ADI->getDef())
702 PrintFatalError(R->getLoc(), "result value $" + Result->getArgNameStr(i) +
703 " is both " + Entry->getName() + " and " +
704 ADI->getDef()->getName() + "!");
705 Entry = ADI->getDef();
708 // Decode and validate the arguments of the result.
709 unsigned AliasOpNo = 0;
710 for (unsigned i = 0, e = ResultInst->Operands.size(); i != e; ++i) {
712 // Tied registers don't have an entry in the result dag unless they're part
713 // of a complex operand, in which case we include them anyways, as we
714 // don't have any other way to specify the whole operand.
715 if (ResultInst->Operands[i].MINumOperands == 1 &&
716 ResultInst->Operands[i].getTiedRegister() != -1) {
717 // Tied operands of different RegisterClass should be explicit within an
718 // instruction's syntax and so cannot be skipped.
719 int TiedOpNum = ResultInst->Operands[i].getTiedRegister();
720 if (ResultInst->Operands[i].Rec->getName() ==
721 ResultInst->Operands[TiedOpNum].Rec->getName())
725 if (AliasOpNo >= Result->getNumArgs())
726 PrintFatalError(R->getLoc(), "not enough arguments for instruction!");
728 Record *InstOpRec = ResultInst->Operands[i].Rec;
729 unsigned NumSubOps = ResultInst->Operands[i].MINumOperands;
730 ResultOperand ResOp(static_cast<int64_t>(0));
731 if (tryAliasOpMatch(Result, AliasOpNo, InstOpRec, (NumSubOps > 1),
732 R->getLoc(), T, ResOp)) {
733 // If this is a simple operand, or a complex operand with a custom match
734 // class, then we can match is verbatim.
735 if (NumSubOps == 1 ||
736 (InstOpRec->getValue("ParserMatchClass") &&
737 InstOpRec->getValueAsDef("ParserMatchClass")
738 ->getValueAsString("Name") != "Imm")) {
739 ResultOperands.push_back(ResOp);
740 ResultInstOperandIndex.push_back(std::make_pair(i, -1));
743 // Otherwise, we need to match each of the suboperands individually.
745 DagInit *MIOI = ResultInst->Operands[i].MIOperandInfo;
746 for (unsigned SubOp = 0; SubOp != NumSubOps; ++SubOp) {
747 Record *SubRec = cast<DefInit>(MIOI->getArg(SubOp))->getDef();
749 // Take care to instantiate each of the suboperands with the correct
750 // nomenclature: $foo.bar
751 ResultOperands.emplace_back(
752 Result->getArgName(AliasOpNo)->getAsUnquotedString() + "." +
753 MIOI->getArgName(SubOp)->getAsUnquotedString(), SubRec);
754 ResultInstOperandIndex.push_back(std::make_pair(i, SubOp));
761 // If the argument did not match the instruction operand, and the operand
762 // is composed of multiple suboperands, try matching the suboperands.
764 DagInit *MIOI = ResultInst->Operands[i].MIOperandInfo;
765 for (unsigned SubOp = 0; SubOp != NumSubOps; ++SubOp) {
766 if (AliasOpNo >= Result->getNumArgs())
767 PrintFatalError(R->getLoc(), "not enough arguments for instruction!");
768 Record *SubRec = cast<DefInit>(MIOI->getArg(SubOp))->getDef();
769 if (tryAliasOpMatch(Result, AliasOpNo, SubRec, false,
770 R->getLoc(), T, ResOp)) {
771 ResultOperands.push_back(ResOp);
772 ResultInstOperandIndex.push_back(std::make_pair(i, SubOp));
775 PrintFatalError(R->getLoc(), "result argument #" + Twine(AliasOpNo) +
776 " does not match instruction operand class " +
777 (SubOp == 0 ? InstOpRec->getName() :SubRec->getName()));
782 PrintFatalError(R->getLoc(), "result argument #" + Twine(AliasOpNo) +
783 " does not match instruction operand class " +
784 InstOpRec->getName());
787 if (AliasOpNo != Result->getNumArgs())
788 PrintFatalError(R->getLoc(), "too many operands for instruction!");