1 //===- CodeGenInstruction.cpp - CodeGen Instruction Class Wrapper ---------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the CodeGenInstruction class.
12 //===----------------------------------------------------------------------===//
14 #include "CodeGenInstruction.h"
15 #include "CodeGenTarget.h"
17 #include "llvm/ADT/StringExtras.h"
18 #include "llvm/ADT/StringMap.h"
19 #include "llvm/ADT/STLExtras.h"
23 //===----------------------------------------------------------------------===//
24 // CGIOperandList Implementation
25 //===----------------------------------------------------------------------===//
27 CGIOperandList::CGIOperandList(Record *R) : TheDef(R) {
29 hasOptionalDef = false;
32 DagInit *OutDI = R->getValueAsDag("OutOperandList");
34 if (DefInit *Init = dynamic_cast<DefInit*>(OutDI->getOperator())) {
35 if (Init->getDef()->getName() != "outs")
36 throw R->getName() + ": invalid def name for output list: use 'outs'";
38 throw R->getName() + ": invalid output list: use 'outs'";
40 NumDefs = OutDI->getNumArgs();
42 DagInit *InDI = R->getValueAsDag("InOperandList");
43 if (DefInit *Init = dynamic_cast<DefInit*>(InDI->getOperator())) {
44 if (Init->getDef()->getName() != "ins")
45 throw R->getName() + ": invalid def name for input list: use 'ins'";
47 throw R->getName() + ": invalid input list: use 'ins'";
49 unsigned MIOperandNo = 0;
50 std::set<std::string> OperandNames;
51 for (unsigned i = 0, e = InDI->getNumArgs()+OutDI->getNumArgs(); i != e; ++i){
55 ArgInit = OutDI->getArg(i);
56 ArgName = OutDI->getArgName(i);
58 ArgInit = InDI->getArg(i-NumDefs);
59 ArgName = InDI->getArgName(i-NumDefs);
62 DefInit *Arg = dynamic_cast<DefInit*>(ArgInit);
64 throw "Illegal operand for the '" + R->getName() + "' instruction!";
66 Record *Rec = Arg->getDef();
67 std::string PrintMethod = "printOperand";
68 std::string EncoderMethod;
70 DagInit *MIOpInfo = 0;
71 if (Rec->isSubClassOf("Operand")) {
72 PrintMethod = Rec->getValueAsString("PrintMethod");
73 // If there is an explicit encoder method, use it.
74 EncoderMethod = Rec->getValueAsString("EncoderMethod");
75 MIOpInfo = Rec->getValueAsDag("MIOperandInfo");
77 // Verify that MIOpInfo has an 'ops' root value.
78 if (!dynamic_cast<DefInit*>(MIOpInfo->getOperator()) ||
79 dynamic_cast<DefInit*>(MIOpInfo->getOperator())
80 ->getDef()->getName() != "ops")
81 throw "Bad value for MIOperandInfo in operand '" + Rec->getName() +
84 // If we have MIOpInfo, then we have #operands equal to number of entries
86 if (unsigned NumArgs = MIOpInfo->getNumArgs())
89 if (Rec->isSubClassOf("PredicateOperand"))
91 else if (Rec->isSubClassOf("OptionalDefOperand"))
92 hasOptionalDef = true;
93 } else if (Rec->getName() == "variable_ops") {
96 } else if (!Rec->isSubClassOf("RegisterClass") &&
97 Rec->getName() != "ptr_rc" && Rec->getName() != "unknown")
98 throw "Unknown operand class '" + Rec->getName() +
99 "' in '" + R->getName() + "' instruction!";
101 // Check that the operand has a name and that it's unique.
103 throw "In instruction '" + R->getName() + "', operand #" + utostr(i) +
105 if (!OperandNames.insert(ArgName).second)
106 throw "In instruction '" + R->getName() + "', operand #" + utostr(i) +
107 " has the same name as a previous operand!";
109 OperandList.push_back(OperandInfo(Rec, ArgName, PrintMethod, EncoderMethod,
110 MIOperandNo, NumOps, MIOpInfo));
111 MIOperandNo += NumOps;
115 // Make sure the constraints list for each operand is large enough to hold
116 // constraint info, even if none is present.
117 for (unsigned i = 0, e = OperandList.size(); i != e; ++i)
118 OperandList[i].Constraints.resize(OperandList[i].MINumOperands);
122 /// getOperandNamed - Return the index of the operand with the specified
123 /// non-empty name. If the instruction does not have an operand with the
124 /// specified name, throw an exception.
126 unsigned CGIOperandList::getOperandNamed(StringRef Name) const {
128 if (hasOperandNamed(Name, OpIdx)) return OpIdx;
129 throw "'" + TheDef->getName() + "' does not have an operand named '$" +
133 /// hasOperandNamed - Query whether the instruction has an operand of the
134 /// given name. If so, return true and set OpIdx to the index of the
135 /// operand. Otherwise, return false.
136 bool CGIOperandList::hasOperandNamed(StringRef Name, unsigned &OpIdx) const {
137 assert(!Name.empty() && "Cannot search for operand with no name!");
138 for (unsigned i = 0, e = OperandList.size(); i != e; ++i)
139 if (OperandList[i].Name == Name) {
146 std::pair<unsigned,unsigned>
147 CGIOperandList::ParseOperandName(const std::string &Op, bool AllowWholeOp) {
148 if (Op.empty() || Op[0] != '$')
149 throw TheDef->getName() + ": Illegal operand name: '" + Op + "'";
151 std::string OpName = Op.substr(1);
152 std::string SubOpName;
154 // Check to see if this is $foo.bar.
155 std::string::size_type DotIdx = OpName.find_first_of(".");
156 if (DotIdx != std::string::npos) {
157 SubOpName = OpName.substr(DotIdx+1);
158 if (SubOpName.empty())
159 throw TheDef->getName() + ": illegal empty suboperand name in '" +Op +"'";
160 OpName = OpName.substr(0, DotIdx);
163 unsigned OpIdx = getOperandNamed(OpName);
165 if (SubOpName.empty()) { // If no suboperand name was specified:
166 // If one was needed, throw.
167 if (OperandList[OpIdx].MINumOperands > 1 && !AllowWholeOp &&
169 throw TheDef->getName() + ": Illegal to refer to"
170 " whole operand part of complex operand '" + Op + "'";
172 // Otherwise, return the operand.
173 return std::make_pair(OpIdx, 0U);
176 // Find the suboperand number involved.
177 DagInit *MIOpInfo = OperandList[OpIdx].MIOperandInfo;
179 throw TheDef->getName() + ": unknown suboperand name in '" + Op + "'";
181 // Find the operand with the right name.
182 for (unsigned i = 0, e = MIOpInfo->getNumArgs(); i != e; ++i)
183 if (MIOpInfo->getArgName(i) == SubOpName)
184 return std::make_pair(OpIdx, i);
186 // Otherwise, didn't find it!
187 throw TheDef->getName() + ": unknown suboperand name in '" + Op + "'";
190 static void ParseConstraint(const std::string &CStr, CGIOperandList &Ops) {
191 // EARLY_CLOBBER: @early $reg
192 std::string::size_type wpos = CStr.find_first_of(" \t");
193 std::string::size_type start = CStr.find_first_not_of(" \t");
194 std::string Tok = CStr.substr(start, wpos - start);
195 if (Tok == "@earlyclobber") {
196 std::string Name = CStr.substr(wpos+1);
197 wpos = Name.find_first_not_of(" \t");
198 if (wpos == std::string::npos)
199 throw "Illegal format for @earlyclobber constraint: '" + CStr + "'";
200 Name = Name.substr(wpos);
201 std::pair<unsigned,unsigned> Op = Ops.ParseOperandName(Name, false);
203 // Build the string for the operand
204 if (!Ops[Op.first].Constraints[Op.second].isNone())
205 throw "Operand '" + Name + "' cannot have multiple constraints!";
206 Ops[Op.first].Constraints[Op.second] =
207 CGIOperandList::ConstraintInfo::getEarlyClobber();
211 // Only other constraint is "TIED_TO" for now.
212 std::string::size_type pos = CStr.find_first_of('=');
213 assert(pos != std::string::npos && "Unrecognized constraint");
214 start = CStr.find_first_not_of(" \t");
215 std::string Name = CStr.substr(start, pos - start);
217 // TIED_TO: $src1 = $dst
218 wpos = Name.find_first_of(" \t");
219 if (wpos == std::string::npos)
220 throw "Illegal format for tied-to constraint: '" + CStr + "'";
221 std::string DestOpName = Name.substr(0, wpos);
222 std::pair<unsigned,unsigned> DestOp = Ops.ParseOperandName(DestOpName, false);
224 Name = CStr.substr(pos+1);
225 wpos = Name.find_first_not_of(" \t");
226 if (wpos == std::string::npos)
227 throw "Illegal format for tied-to constraint: '" + CStr + "'";
229 std::pair<unsigned,unsigned> SrcOp =
230 Ops.ParseOperandName(Name.substr(wpos), false);
232 throw "Illegal tied-to operand constraint '" + CStr + "'";
235 unsigned FlatOpNo = Ops.getFlattenedOperandNumber(SrcOp);
237 if (!Ops[DestOp.first].Constraints[DestOp.second].isNone())
238 throw "Operand '" + DestOpName + "' cannot have multiple constraints!";
239 Ops[DestOp.first].Constraints[DestOp.second] =
240 CGIOperandList::ConstraintInfo::getTied(FlatOpNo);
243 static void ParseConstraints(const std::string &CStr, CGIOperandList &Ops) {
244 if (CStr.empty()) return;
246 const std::string delims(",");
247 std::string::size_type bidx, eidx;
249 bidx = CStr.find_first_not_of(delims);
250 while (bidx != std::string::npos) {
251 eidx = CStr.find_first_of(delims, bidx);
252 if (eidx == std::string::npos)
253 eidx = CStr.length();
255 ParseConstraint(CStr.substr(bidx, eidx - bidx), Ops);
256 bidx = CStr.find_first_not_of(delims, eidx);
260 void CGIOperandList::ProcessDisableEncoding(std::string DisableEncoding) {
263 tie(OpName, DisableEncoding) = getToken(DisableEncoding, " ,\t");
264 if (OpName.empty()) break;
266 // Figure out which operand this is.
267 std::pair<unsigned,unsigned> Op = ParseOperandName(OpName, false);
269 // Mark the operand as not-to-be encoded.
270 if (Op.second >= OperandList[Op.first].DoNotEncode.size())
271 OperandList[Op.first].DoNotEncode.resize(Op.second+1);
272 OperandList[Op.first].DoNotEncode[Op.second] = true;
277 //===----------------------------------------------------------------------===//
278 // CodeGenInstruction Implementation
279 //===----------------------------------------------------------------------===//
281 CodeGenInstruction::CodeGenInstruction(Record *R) : TheDef(R), Operands(R) {
282 Namespace = R->getValueAsString("Namespace");
283 AsmString = R->getValueAsString("AsmString");
285 isReturn = R->getValueAsBit("isReturn");
286 isBranch = R->getValueAsBit("isBranch");
287 isIndirectBranch = R->getValueAsBit("isIndirectBranch");
288 isCompare = R->getValueAsBit("isCompare");
289 isMoveImm = R->getValueAsBit("isMoveImm");
290 isBarrier = R->getValueAsBit("isBarrier");
291 isCall = R->getValueAsBit("isCall");
292 canFoldAsLoad = R->getValueAsBit("canFoldAsLoad");
293 mayLoad = R->getValueAsBit("mayLoad");
294 mayStore = R->getValueAsBit("mayStore");
295 isPredicable = Operands.isPredicable || R->getValueAsBit("isPredicable");
296 isConvertibleToThreeAddress = R->getValueAsBit("isConvertibleToThreeAddress");
297 isCommutable = R->getValueAsBit("isCommutable");
298 isTerminator = R->getValueAsBit("isTerminator");
299 isReMaterializable = R->getValueAsBit("isReMaterializable");
300 hasDelaySlot = R->getValueAsBit("hasDelaySlot");
301 usesCustomInserter = R->getValueAsBit("usesCustomInserter");
302 hasCtrlDep = R->getValueAsBit("hasCtrlDep");
303 isNotDuplicable = R->getValueAsBit("isNotDuplicable");
304 hasSideEffects = R->getValueAsBit("hasSideEffects");
305 neverHasSideEffects = R->getValueAsBit("neverHasSideEffects");
306 isAsCheapAsAMove = R->getValueAsBit("isAsCheapAsAMove");
307 hasExtraSrcRegAllocReq = R->getValueAsBit("hasExtraSrcRegAllocReq");
308 hasExtraDefRegAllocReq = R->getValueAsBit("hasExtraDefRegAllocReq");
309 ImplicitDefs = R->getValueAsListOfDefs("Defs");
310 ImplicitUses = R->getValueAsListOfDefs("Uses");
312 if (neverHasSideEffects + hasSideEffects > 1)
313 throw R->getName() + ": multiple conflicting side-effect flags set!";
315 // Parse Constraints.
316 ParseConstraints(R->getValueAsString("Constraints"), Operands);
318 // Parse the DisableEncoding field.
319 Operands.ProcessDisableEncoding(R->getValueAsString("DisableEncoding"));
322 /// HasOneImplicitDefWithKnownVT - If the instruction has at least one
323 /// implicit def and it has a known VT, return the VT, otherwise return
325 MVT::SimpleValueType CodeGenInstruction::
326 HasOneImplicitDefWithKnownVT(const CodeGenTarget &TargetInfo) const {
327 if (ImplicitDefs.empty()) return MVT::Other;
329 // Check to see if the first implicit def has a resolvable type.
330 Record *FirstImplicitDef = ImplicitDefs[0];
331 assert(FirstImplicitDef->isSubClassOf("Register"));
332 const std::vector<MVT::SimpleValueType> &RegVTs =
333 TargetInfo.getRegisterVTs(FirstImplicitDef);
334 if (RegVTs.size() == 1)
340 /// FlattenAsmStringVariants - Flatten the specified AsmString to only
341 /// include text from the specified variant, returning the new string.
342 std::string CodeGenInstruction::
343 FlattenAsmStringVariants(StringRef Cur, unsigned Variant) {
344 std::string Res = "";
347 // Find the start of the next variant string.
348 size_t VariantsStart = 0;
349 for (size_t e = Cur.size(); VariantsStart != e; ++VariantsStart)
350 if (Cur[VariantsStart] == '{' &&
351 (VariantsStart == 0 || (Cur[VariantsStart-1] != '$' &&
352 Cur[VariantsStart-1] != '\\')))
355 // Add the prefix to the result.
356 Res += Cur.slice(0, VariantsStart);
357 if (VariantsStart == Cur.size())
360 ++VariantsStart; // Skip the '{'.
362 // Scan to the end of the variants string.
363 size_t VariantsEnd = VariantsStart;
364 unsigned NestedBraces = 1;
365 for (size_t e = Cur.size(); VariantsEnd != e; ++VariantsEnd) {
366 if (Cur[VariantsEnd] == '}' && Cur[VariantsEnd-1] != '\\') {
367 if (--NestedBraces == 0)
369 } else if (Cur[VariantsEnd] == '{')
373 // Select the Nth variant (or empty).
374 StringRef Selection = Cur.slice(VariantsStart, VariantsEnd);
375 for (unsigned i = 0; i != Variant; ++i)
376 Selection = Selection.split('|').second;
377 Res += Selection.split('|').first;
379 assert(VariantsEnd != Cur.size() &&
380 "Unterminated variants in assembly string!");
381 Cur = Cur.substr(VariantsEnd + 1);
388 //===----------------------------------------------------------------------===//
389 /// CodeGenInstAlias Implementation
390 //===----------------------------------------------------------------------===//
392 CodeGenInstAlias::CodeGenInstAlias(Record *R, CodeGenTarget &T) : TheDef(R) {
393 AsmString = R->getValueAsString("AsmString");
394 Result = R->getValueAsDag("ResultInst");
396 // Verify that the root of the result is an instruction.
397 DefInit *DI = dynamic_cast<DefInit*>(Result->getOperator());
398 if (DI == 0 || !DI->getDef()->isSubClassOf("Instruction"))
399 throw TGError(R->getLoc(), "result of inst alias should be an instruction");
401 ResultInst = &T.getInstruction(DI->getDef());
403 // NameClass - If argument names are repeated, we need to verify they have
405 StringMap<Record*> NameClass;
406 for (unsigned i = 0, e = Result->getNumArgs(); i != e; ++i) {
407 DefInit *ADI = dynamic_cast<DefInit*>(Result->getArg(i));
408 if (!ADI || Result->getArgName(i).empty())
410 // Verify we don't have something like: (someinst GR16:$foo, GR32:$foo)
411 // $foo can exist multiple times in the result list, but it must have the
413 Record *&Entry = NameClass[Result->getArgName(i)];
414 if (Entry && Entry != ADI->getDef())
415 throw TGError(R->getLoc(), "result value $" + Result->getArgName(i) +
416 " is both " + Entry->getName() + " and " +
417 ADI->getDef()->getName() + "!");
418 Entry = ADI->getDef();
421 // Decode and validate the arguments of the result.
422 unsigned AliasOpNo = 0;
423 for (unsigned i = 0, e = ResultInst->Operands.size(); i != e; ++i) {
424 // Tied registers don't have an entry in the result dag.
425 if (ResultInst->Operands[i].getTiedRegister() != -1)
428 if (AliasOpNo >= Result->getNumArgs())
429 throw TGError(R->getLoc(), "result has " + utostr(Result->getNumArgs()) +
430 " arguments, but " + ResultInst->TheDef->getName() +
431 " instruction expects " +
432 utostr(ResultInst->Operands.size()) + " operands!");
435 Init *Arg = Result->getArg(AliasOpNo);
436 Record *ResultOpRec = ResultInst->Operands[i].Rec;
438 // Handle explicit registers.
439 if (DefInit *ADI = dynamic_cast<DefInit*>(Arg)) {
440 if (ADI->getDef()->isSubClassOf("Register")) {
441 if (!Result->getArgName(AliasOpNo).empty())
442 throw TGError(R->getLoc(), "result fixed register argument must "
445 if (!ResultOpRec->isSubClassOf("RegisterClass"))
446 throw TGError(R->getLoc(), "result fixed register argument is not "
447 "passed to a RegisterClass operand!");
449 if (!T.getRegisterClass(ResultOpRec).containsRegister(ADI->getDef()))
450 throw TGError(R->getLoc(), "fixed register " +ADI->getDef()->getName()
451 + " is not a member of the " + ResultOpRec->getName() +
454 // Now that it is validated, add it.
455 ResultOperands.push_back(ResultOperand(ADI->getDef()));
456 ResultInstOperandIndex.push_back(i);
460 if (ADI->getDef()->getName() == "zero_reg") {
461 if (!Result->getArgName(AliasOpNo).empty())
462 throw TGError(R->getLoc(), "result fixed register argument must "
465 // Check if this is an optional def.
466 if (!ResultOpRec->isSubClassOf("OptionalDefOperand"))
467 throw TGError(R->getLoc(), "reg0 used for result that is not an "
468 "OptionalDefOperand!");
470 // Now that it is validated, add it.
471 ResultOperands.push_back(ResultOperand(static_cast<Record*>(0)));
472 ResultInstOperandIndex.push_back(i);
478 // If the operand is a record, it must have a name, and the record type must
479 // match up with the instruction's argument type.
480 if (DefInit *ADI = dynamic_cast<DefInit*>(Arg)) {
481 if (Result->getArgName(AliasOpNo).empty())
482 throw TGError(R->getLoc(), "result argument #" + utostr(AliasOpNo) +
483 " must have a name!");
485 if (ADI->getDef() != ResultOpRec)
486 throw TGError(R->getLoc(), "result argument #" + utostr(AliasOpNo) +
487 " declared with class " + ADI->getDef()->getName() +
488 ", instruction operand is class " +
489 ResultOpRec->getName());
491 // Now that it is validated, add it.
492 ResultOperands.push_back(ResultOperand(Result->getArgName(AliasOpNo),
494 ResultInstOperandIndex.push_back(i);
499 if (IntInit *II = dynamic_cast<IntInit*>(Arg)) {
500 // Integer arguments can't have names.
501 if (!Result->getArgName(AliasOpNo).empty())
502 throw TGError(R->getLoc(), "result argument #" + utostr(AliasOpNo) +
503 " must not have a name!");
504 if (ResultInst->Operands[i].MINumOperands != 1 ||
505 !ResultOpRec->isSubClassOf("Operand"))
506 throw TGError(R->getLoc(), "invalid argument class " +
507 ResultOpRec->getName() +
508 " for integer result operand!");
509 ResultOperands.push_back(ResultOperand(II->getValue()));
510 ResultInstOperandIndex.push_back(i);
515 throw TGError(R->getLoc(), "result of inst alias has unknown operand type");
518 if (AliasOpNo != Result->getNumArgs())
519 throw TGError(R->getLoc(), "result has " + utostr(Result->getNumArgs()) +
520 " arguments, but " + ResultInst->TheDef->getName() +
521 " instruction expects " + utostr(ResultInst->Operands.size())+