1 //===- DAGISelMatcherEmitter.cpp - Matcher Emitter ------------------------===//
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 contains code to generate C++ code a matcher.
12 //===----------------------------------------------------------------------===//
14 #include "DAGISelMatcher.h"
15 #include "CodeGenDAGPatterns.h"
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/ADT/StringMap.h"
20 #include "llvm/Support/FormattedStream.h"
27 /// ClassifyInt - Classify an integer by size, return '1','2','4','8' if this
28 /// fits in 1, 2, 4, or 8 sign extended bytes.
29 static char ClassifyInt(int64_t Val) {
30 if (Val == int8_t(Val)) return '1';
31 if (Val == int16_t(Val)) return '2';
32 if (Val == int32_t(Val)) return '4';
36 /// EmitInt - Emit the specified integer, returning the number of bytes emitted.
37 static unsigned EmitInt(int64_t Val, formatted_raw_ostream &OS) {
38 unsigned BytesEmitted = 1;
39 OS << (int)(unsigned char)Val << ", ";
40 if (Val == int8_t(Val)) {
45 OS << (int)(unsigned char)(Val >> 8) << ", ";
48 if (Val != int16_t(Val)) {
49 OS << (int)(unsigned char)(Val >> 16) << ", "
50 << (int)(unsigned char)(Val >> 24) << ", ";
53 if (Val != int32_t(Val)) {
54 OS << (int)(unsigned char)(Val >> 32) << ", "
55 << (int)(unsigned char)(Val >> 40) << ", "
56 << (int)(unsigned char)(Val >> 48) << ", "
57 << (int)(unsigned char)(Val >> 56) << ", ";
62 OS.PadToColumn(CommentIndent) << "// " << Val << " aka 0x";
63 OS.write_hex(Val) << '\n';
68 class MatcherTableEmitter {
69 StringMap<unsigned> NodePredicateMap, PatternPredicateMap;
70 std::vector<std::string> NodePredicates, PatternPredicates;
72 DenseMap<const ComplexPattern*, unsigned> ComplexPatternMap;
73 std::vector<const ComplexPattern*> ComplexPatterns;
76 DenseMap<Record*, unsigned> NodeXFormMap;
77 std::vector<const Record*> NodeXForms;
79 // Per opcode frequence count.
80 std::vector<unsigned> Histogram;
82 MatcherTableEmitter() {}
84 unsigned EmitMatcherList(const MatcherNode *N, unsigned Indent,
85 unsigned StartIdx, formatted_raw_ostream &OS);
87 void EmitPredicateFunctions(formatted_raw_ostream &OS);
89 void EmitHistogram(formatted_raw_ostream &OS);
91 unsigned EmitMatcher(const MatcherNode *N, unsigned Indent,
92 formatted_raw_ostream &OS);
94 unsigned getNodePredicate(StringRef PredName) {
95 unsigned &Entry = NodePredicateMap[PredName];
97 NodePredicates.push_back(PredName.str());
98 Entry = NodePredicates.size();
102 unsigned getPatternPredicate(StringRef PredName) {
103 unsigned &Entry = PatternPredicateMap[PredName];
105 PatternPredicates.push_back(PredName.str());
106 Entry = PatternPredicates.size();
111 unsigned getComplexPat(const ComplexPattern &P) {
112 unsigned &Entry = ComplexPatternMap[&P];
114 ComplexPatterns.push_back(&P);
115 Entry = ComplexPatterns.size();
120 unsigned getNodeXFormID(Record *Rec) {
121 unsigned &Entry = NodeXFormMap[Rec];
123 NodeXForms.push_back(Rec);
124 Entry = NodeXForms.size();
130 } // end anonymous namespace.
132 /// EmitVBRValue - Emit the specified value as a VBR, returning the number of
134 static unsigned EmitVBRValue(unsigned Val, raw_ostream &OS) {
140 unsigned InVal = Val;
141 unsigned NumBytes = 0;
143 OS << (Val&127) << "|128,";
147 OS << Val << "/*" << InVal << "*/, ";
151 /// EmitMatcherOpcodes - Emit bytes for the specified matcher and return
152 /// the number of bytes emitted.
153 unsigned MatcherTableEmitter::
154 EmitMatcher(const MatcherNode *N, unsigned Indent, formatted_raw_ostream &OS) {
155 OS.PadToColumn(Indent*2);
157 switch (N->getKind()) {
158 case MatcherNode::Scope: assert(0 && "Should be handled by caller");
159 case MatcherNode::RecordNode:
160 OS << "OPC_RecordNode,";
161 OS.PadToColumn(CommentIndent) << "// "
162 << cast<RecordMatcherNode>(N)->getWhatFor() << '\n';
165 case MatcherNode::RecordChild:
166 OS << "OPC_RecordChild" << cast<RecordChildMatcherNode>(N)->getChildNo()
168 OS.PadToColumn(CommentIndent) << "// "
169 << cast<RecordChildMatcherNode>(N)->getWhatFor() << '\n';
172 case MatcherNode::RecordMemRef:
173 OS << "OPC_RecordMemRef,\n";
176 case MatcherNode::CaptureFlagInput:
177 OS << "OPC_CaptureFlagInput,\n";
180 case MatcherNode::MoveChild:
181 OS << "OPC_MoveChild, "
182 << cast<MoveChildMatcherNode>(N)->getChildNo() << ",\n";
185 case MatcherNode::MoveParent:
186 OS << "OPC_MoveParent,\n";
189 case MatcherNode::CheckSame:
190 OS << "OPC_CheckSame, "
191 << cast<CheckSameMatcherNode>(N)->getMatchNumber() << ",\n";
194 case MatcherNode::CheckPatternPredicate: {
195 StringRef Pred = cast<CheckPatternPredicateMatcherNode>(N)->getPredicate();
196 OS << "OPC_CheckPatternPredicate, " << getPatternPredicate(Pred) << ',';
197 OS.PadToColumn(CommentIndent) << "// " << Pred << '\n';
200 case MatcherNode::CheckPredicate: {
201 StringRef Pred = cast<CheckPredicateMatcherNode>(N)->getPredicateName();
202 OS << "OPC_CheckPredicate, " << getNodePredicate(Pred) << ',';
203 OS.PadToColumn(CommentIndent) << "// " << Pred << '\n';
207 case MatcherNode::CheckOpcode:
208 OS << "OPC_CheckOpcode, "
209 << cast<CheckOpcodeMatcherNode>(N)->getOpcodeName() << ",\n";
212 case MatcherNode::CheckMultiOpcode: {
213 const CheckMultiOpcodeMatcherNode *CMO=cast<CheckMultiOpcodeMatcherNode>(N);
214 OS << "OPC_CheckMultiOpcode, " << CMO->getNumOpcodeNames() << ", ";
215 for (unsigned i = 0, e = CMO->getNumOpcodeNames(); i != e; ++i)
216 OS << CMO->getOpcodeName(i) << ", ";
218 return 2 + CMO->getNumOpcodeNames();
221 case MatcherNode::CheckType:
222 OS << "OPC_CheckType, "
223 << getEnumName(cast<CheckTypeMatcherNode>(N)->getType()) << ",\n";
225 case MatcherNode::CheckChildType:
226 OS << "OPC_CheckChild"
227 << cast<CheckChildTypeMatcherNode>(N)->getChildNo() << "Type, "
228 << getEnumName(cast<CheckChildTypeMatcherNode>(N)->getType()) << ",\n";
231 case MatcherNode::CheckInteger: {
232 int64_t Val = cast<CheckIntegerMatcherNode>(N)->getValue();
233 OS << "OPC_CheckInteger" << ClassifyInt(Val) << ", ";
234 return EmitInt(Val, OS)+1;
236 case MatcherNode::CheckCondCode:
237 OS << "OPC_CheckCondCode, ISD::"
238 << cast<CheckCondCodeMatcherNode>(N)->getCondCodeName() << ",\n";
241 case MatcherNode::CheckValueType:
242 OS << "OPC_CheckValueType, MVT::"
243 << cast<CheckValueTypeMatcherNode>(N)->getTypeName() << ",\n";
246 case MatcherNode::CheckComplexPat: {
247 const ComplexPattern &Pattern =
248 cast<CheckComplexPatMatcherNode>(N)->getPattern();
249 OS << "OPC_CheckComplexPat, " << getComplexPat(Pattern) << ',';
250 OS.PadToColumn(CommentIndent) << "// " << Pattern.getSelectFunc();
251 OS << ": " << Pattern.getNumOperands() << " operands";
252 if (Pattern.hasProperty(SDNPHasChain))
253 OS << " + chain result and input";
258 case MatcherNode::CheckAndImm: {
259 int64_t Val = cast<CheckAndImmMatcherNode>(N)->getValue();
260 OS << "OPC_CheckAndImm" << ClassifyInt(Val) << ", ";
261 return EmitInt(Val, OS)+1;
264 case MatcherNode::CheckOrImm: {
265 int64_t Val = cast<CheckOrImmMatcherNode>(N)->getValue();
266 OS << "OPC_CheckOrImm" << ClassifyInt(Val) << ", ";
267 return EmitInt(Val, OS)+1;
269 case MatcherNode::CheckFoldableChainNode:
270 OS << "OPC_CheckFoldableChainNode,\n";
272 case MatcherNode::CheckChainCompatible:
273 OS << "OPC_CheckChainCompatible, "
274 << cast<CheckChainCompatibleMatcherNode>(N)->getPreviousOp() << ",\n";
277 case MatcherNode::EmitInteger: {
278 int64_t Val = cast<EmitIntegerMatcherNode>(N)->getValue();
279 OS << "OPC_EmitInteger" << ClassifyInt(Val) << ", "
280 << getEnumName(cast<EmitIntegerMatcherNode>(N)->getVT()) << ", ";
281 return EmitInt(Val, OS)+2;
283 case MatcherNode::EmitStringInteger: {
284 const std::string &Val = cast<EmitStringIntegerMatcherNode>(N)->getValue();
285 // These should always fit into one byte.
286 OS << "OPC_EmitInteger1, "
287 << getEnumName(cast<EmitStringIntegerMatcherNode>(N)->getVT()) << ", "
292 case MatcherNode::EmitRegister:
293 OS << "OPC_EmitRegister, "
294 << getEnumName(cast<EmitRegisterMatcherNode>(N)->getVT()) << ", ";
295 if (Record *R = cast<EmitRegisterMatcherNode>(N)->getReg())
296 OS << getQualifiedName(R) << ",\n";
298 OS << "0 /*zero_reg*/,\n";
301 case MatcherNode::EmitConvertToTarget:
302 OS << "OPC_EmitConvertToTarget, "
303 << cast<EmitConvertToTargetMatcherNode>(N)->getSlot() << ",\n";
306 case MatcherNode::EmitMergeInputChains: {
307 const EmitMergeInputChainsMatcherNode *MN =
308 cast<EmitMergeInputChainsMatcherNode>(N);
309 OS << "OPC_EmitMergeInputChains, " << MN->getNumNodes() << ", ";
310 for (unsigned i = 0, e = MN->getNumNodes(); i != e; ++i)
311 OS << MN->getNode(i) << ", ";
313 return 2+MN->getNumNodes();
315 case MatcherNode::EmitCopyToReg:
316 OS << "OPC_EmitCopyToReg, "
317 << cast<EmitCopyToRegMatcherNode>(N)->getSrcSlot() << ", "
318 << getQualifiedName(cast<EmitCopyToRegMatcherNode>(N)->getDestPhysReg())
321 case MatcherNode::EmitNodeXForm: {
322 const EmitNodeXFormMatcherNode *XF = cast<EmitNodeXFormMatcherNode>(N);
323 OS << "OPC_EmitNodeXForm, " << getNodeXFormID(XF->getNodeXForm()) << ", "
324 << XF->getSlot() << ',';
325 OS.PadToColumn(CommentIndent) << "// "<<XF->getNodeXForm()->getName()<<'\n';
329 case MatcherNode::EmitNode: {
330 const EmitNodeMatcherNode *EN = cast<EmitNodeMatcherNode>(N);
331 OS << "OPC_EmitNode, TARGET_OPCODE(" << EN->getOpcodeName() << "), 0";
333 if (EN->hasChain()) OS << "|OPFL_Chain";
334 if (EN->hasFlag()) OS << "|OPFL_Flag";
335 if (EN->hasMemRefs()) OS << "|OPFL_MemRefs";
336 if (EN->getNumFixedArityOperands() != -1)
337 OS << "|OPFL_Variadic" << EN->getNumFixedArityOperands();
340 OS.PadToColumn(Indent*2+4) << EN->getNumVTs() << "/*#VTs*/, ";
341 for (unsigned i = 0, e = EN->getNumVTs(); i != e; ++i)
342 OS << getEnumName(EN->getVT(i)) << ", ";
344 OS << EN->getNumOperands() << "/*#Ops*/, ";
345 unsigned NumOperandBytes = 0;
346 for (unsigned i = 0, e = EN->getNumOperands(); i != e; ++i) {
347 // We emit the operand numbers in VBR encoded format, in case the number
348 // is too large to represent with a byte.
349 NumOperandBytes += EmitVBRValue(EN->getOperand(i), OS);
352 return 6+EN->getNumVTs()+NumOperandBytes;
354 case MatcherNode::MarkFlagResults: {
355 const MarkFlagResultsMatcherNode *CFR = cast<MarkFlagResultsMatcherNode>(N);
356 OS << "OPC_MarkFlagResults, " << CFR->getNumNodes() << ", ";
357 unsigned NumOperandBytes = 0;
358 for (unsigned i = 0, e = CFR->getNumNodes(); i != e; ++i)
359 NumOperandBytes += EmitVBRValue(CFR->getNode(i), OS);
361 return 2+NumOperandBytes;
363 case MatcherNode::CompleteMatch: {
364 const CompleteMatchMatcherNode *CM = cast<CompleteMatchMatcherNode>(N);
365 OS << "OPC_CompleteMatch, " << CM->getNumResults() << ", ";
366 unsigned NumResultBytes = 0;
367 for (unsigned i = 0, e = CM->getNumResults(); i != e; ++i)
368 NumResultBytes += EmitVBRValue(CM->getResult(i), OS);
370 OS.PadToColumn(Indent*2) << "// Src: "
371 << *CM->getPattern().getSrcPattern() << '\n';
372 OS.PadToColumn(Indent*2) << "// Dst: "
373 << *CM->getPattern().getDstPattern() << '\n';
374 return 2 + NumResultBytes;
377 assert(0 && "Unreachable");
381 /// EmitMatcherList - Emit the bytes for the specified matcher subtree.
382 unsigned MatcherTableEmitter::
383 EmitMatcherList(const MatcherNode *N, unsigned Indent, unsigned CurrentIdx,
384 formatted_raw_ostream &OS) {
387 if (unsigned(N->getKind()) >= Histogram.size())
388 Histogram.resize(N->getKind()+1);
389 Histogram[N->getKind()]++;
391 // Scope is a special case since it is binary.
392 if (const ScopeMatcherNode *SMN = dyn_cast<ScopeMatcherNode>(N)) {
393 // We need to encode the child and the offset of the failure code before
394 // emitting either of them. Handle this by buffering the output into a
395 // string while we get the size.
396 SmallString<128> TmpBuf;
399 raw_svector_ostream OS(TmpBuf);
400 formatted_raw_ostream FOS(OS);
401 NextSize = EmitMatcherList(cast<ScopeMatcherNode>(N)->getCheck(),
402 Indent+1, CurrentIdx+2, FOS);
405 // In the unlikely event that we have something too big to emit with a
406 // one byte offset, regenerate it with a two-byte one.
407 if (NextSize > 255) {
409 raw_svector_ostream OS(TmpBuf);
410 formatted_raw_ostream FOS(OS);
411 NextSize = EmitMatcherList(cast<ScopeMatcherNode>(N)->getCheck(),
412 Indent+1, CurrentIdx+3, FOS);
413 if (NextSize > 65535) {
415 "Tblgen internal error: can't handle pattern this complex yet\n";
420 OS << "/*" << CurrentIdx << "*/";
421 OS.PadToColumn(Indent*2);
424 OS << "OPC_Scope, " << NextSize << ",\n";
426 OS << "OPC_Scope2, " << (NextSize&255) << ", " << (NextSize>>8) <<",\n";
430 CurrentIdx += 2+NextSize;
435 OS << "/*" << CurrentIdx << "*/";
436 unsigned MatcherSize = EmitMatcher(N, Indent, OS);
438 CurrentIdx += MatcherSize;
440 // If there are other nodes in this list, iterate to them, otherwise we're
447 void MatcherTableEmitter::EmitPredicateFunctions(formatted_raw_ostream &OS) {
448 // FIXME: Don't build off the DAGISelEmitter's predicates, emit them directly
449 // here into the case stmts.
451 // Emit pattern predicates.
452 OS << "bool CheckPatternPredicate(unsigned PredNo) const {\n";
453 OS << " switch (PredNo) {\n";
454 OS << " default: assert(0 && \"Invalid predicate in table?\");\n";
455 for (unsigned i = 0, e = PatternPredicates.size(); i != e; ++i)
456 OS << " case " << i << ": return " << PatternPredicates[i] << ";\n";
460 // Emit Node predicates.
461 OS << "bool CheckNodePredicate(SDNode *N, unsigned PredNo) const {\n";
462 OS << " switch (PredNo) {\n";
463 OS << " default: assert(0 && \"Invalid predicate in table?\");\n";
464 for (unsigned i = 0, e = NodePredicates.size(); i != e; ++i)
465 OS << " case " << i << ": return " << NodePredicates[i] << "(N);\n";
469 // Emit CompletePattern matchers.
470 // FIXME: This should be const.
471 OS << "bool CheckComplexPattern(SDNode *Root, SDValue N,\n";
472 OS << " unsigned PatternNo, SmallVectorImpl<SDValue> &Result) {\n";
473 OS << " switch (PatternNo) {\n";
474 OS << " default: assert(0 && \"Invalid pattern # in table?\");\n";
475 for (unsigned i = 0, e = ComplexPatterns.size(); i != e; ++i) {
476 const ComplexPattern &P = *ComplexPatterns[i];
477 unsigned NumOps = P.getNumOperands();
479 if (P.hasProperty(SDNPHasChain))
480 ++NumOps; // Get the chained node too.
482 OS << " case " << i << ":\n";
483 OS << " Result.resize(Result.size()+" << NumOps << ");\n";
484 OS << " return " << P.getSelectFunc();
486 // FIXME: Temporary hack until old isel dies.
487 if (P.hasProperty(SDNPHasChain))
491 for (unsigned i = 0; i != NumOps; ++i)
492 OS << ", Result[Result.size()-" << (NumOps-i) << ']';
498 // Emit SDNodeXForm handlers.
499 // FIXME: This should be const.
500 OS << "SDValue RunSDNodeXForm(SDValue V, unsigned XFormNo) {\n";
501 OS << " switch (XFormNo) {\n";
502 OS << " default: assert(0 && \"Invalid xform # in table?\");\n";
504 // FIXME: The node xform could take SDValue's instead of SDNode*'s.
505 for (unsigned i = 0, e = NodeXForms.size(); i != e; ++i)
506 OS << " case " << i << ": return Transform_" << NodeXForms[i]->getName()
507 << "(V.getNode());\n";
512 void MatcherTableEmitter::EmitHistogram(formatted_raw_ostream &OS) {
513 OS << " // Opcode Histogram:\n";
514 for (unsigned i = 0, e = Histogram.size(); i != e; ++i) {
516 switch ((MatcherNode::KindTy)i) {
517 case MatcherNode::Scope: OS << "OPC_Scope"; break;
518 case MatcherNode::RecordNode: OS << "OPC_RecordNode"; break;
519 case MatcherNode::RecordChild: OS << "OPC_RecordChild"; break;
520 case MatcherNode::RecordMemRef: OS << "OPC_RecordMemRef"; break;
521 case MatcherNode::CaptureFlagInput: OS << "OPC_CaptureFlagInput"; break;
522 case MatcherNode::MoveChild: OS << "OPC_MoveChild"; break;
523 case MatcherNode::MoveParent: OS << "OPC_MoveParent"; break;
524 case MatcherNode::CheckSame: OS << "OPC_CheckSame"; break;
525 case MatcherNode::CheckPatternPredicate:
526 OS << "OPC_CheckPatternPredicate"; break;
527 case MatcherNode::CheckPredicate: OS << "OPC_CheckPredicate"; break;
528 case MatcherNode::CheckOpcode: OS << "OPC_CheckOpcode"; break;
529 case MatcherNode::CheckMultiOpcode: OS << "OPC_CheckMultiOpcode"; break;
530 case MatcherNode::CheckType: OS << "OPC_CheckType"; break;
531 case MatcherNode::CheckChildType: OS << "OPC_CheckChildType"; break;
532 case MatcherNode::CheckInteger: OS << "OPC_CheckInteger"; break;
533 case MatcherNode::CheckCondCode: OS << "OPC_CheckCondCode"; break;
534 case MatcherNode::CheckValueType: OS << "OPC_CheckValueType"; break;
535 case MatcherNode::CheckComplexPat: OS << "OPC_CheckComplexPat"; break;
536 case MatcherNode::CheckAndImm: OS << "OPC_CheckAndImm"; break;
537 case MatcherNode::CheckOrImm: OS << "OPC_CheckOrImm"; break;
538 case MatcherNode::CheckFoldableChainNode:
539 OS << "OPC_CheckFoldableChainNode"; break;
540 case MatcherNode::CheckChainCompatible:
541 OS << "OPC_CheckChainCompatible"; break;
542 case MatcherNode::EmitInteger: OS << "OPC_EmitInteger"; break;
543 case MatcherNode::EmitStringInteger: OS << "OPC_EmitStringInteger"; break;
544 case MatcherNode::EmitRegister: OS << "OPC_EmitRegister"; break;
545 case MatcherNode::EmitConvertToTarget:
546 OS << "OPC_EmitConvertToTarget"; break;
547 case MatcherNode::EmitMergeInputChains:
548 OS << "OPC_EmitMergeInputChains"; break;
549 case MatcherNode::EmitCopyToReg: OS << "OPC_EmitCopyToReg"; break;
550 case MatcherNode::EmitNode: OS << "OPC_EmitNode"; break;
551 case MatcherNode::EmitNodeXForm: OS << "OPC_EmitNodeXForm"; break;
552 case MatcherNode::MarkFlagResults: OS << "OPC_MarkFlagResults"; break;
553 case MatcherNode::CompleteMatch: OS << "OPC_CompleteMatch"; break;
556 OS.PadToColumn(40) << " = " << Histogram[i] << '\n';
562 void llvm::EmitMatcherTable(const MatcherNode *Matcher, raw_ostream &O) {
563 formatted_raw_ostream OS(O);
565 OS << "// The main instruction selector code.\n";
566 OS << "SDNode *SelectCode(SDNode *N) {\n";
568 MatcherTableEmitter MatcherEmitter;
570 OS << " // Opcodes are emitted as 2 bytes, TARGET_OPCODE handles this.\n";
571 OS << " #define TARGET_OPCODE(X) X & 255, unsigned(X) >> 8\n";
572 OS << " static const unsigned char MatcherTable[] = {\n";
573 unsigned TotalSize = MatcherEmitter.EmitMatcherList(Matcher, 5, 0, OS);
574 OS << " 0\n }; // Total Array size is " << (TotalSize+1) << " bytes\n\n";
576 MatcherEmitter.EmitHistogram(OS);
578 OS << " #undef TARGET_OPCODE\n";
579 OS << " return SelectCodeCommon(N, MatcherTable,sizeof(MatcherTable));\n}\n";
582 // Next up, emit the function for node and pattern predicates:
583 MatcherEmitter.EmitPredicateFunctions(OS);