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 Matcher *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 Matcher *N, unsigned Indent, unsigned CurrentIdx,
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 static unsigned GetVBRSize(unsigned Val) {
133 if (Val <= 127) return 1;
135 unsigned NumBytes = 0;
143 /// EmitVBRValue - Emit the specified value as a VBR, returning the number of
145 static unsigned EmitVBRValue(unsigned Val, raw_ostream &OS) {
151 unsigned InVal = Val;
152 unsigned NumBytes = 0;
154 OS << (Val&127) << "|128,";
158 OS << Val << "/*" << InVal << "*/, ";
162 /// EmitMatcherOpcodes - Emit bytes for the specified matcher and return
163 /// the number of bytes emitted.
164 unsigned MatcherTableEmitter::
165 EmitMatcher(const Matcher *N, unsigned Indent, unsigned CurrentIdx,
166 formatted_raw_ostream &OS) {
167 OS.PadToColumn(Indent*2);
169 switch (N->getKind()) {
170 case Matcher::Scope: {
171 const ScopeMatcher *SM = cast<ScopeMatcher>(N);
172 assert(SM->getNext() == 0 && "Shouldn't have next after scope");
174 unsigned StartIdx = CurrentIdx;
176 // Emit all of the children.
177 for (unsigned i = 0, e = SM->getNumChildren(); i != e; ++i) {
182 OS << "/*" << CurrentIdx << "*/";
183 OS.PadToColumn(Indent*2) << "/*Scope*/ ";
186 // We need to encode the child and the offset of the failure code before
187 // emitting either of them. Handle this by buffering the output into a
188 // string while we get the size. Unfortunately, the offset of the
189 // children depends on the VBR size of the child, so for large children we
190 // have to iterate a bit.
191 SmallString<128> TmpBuf;
192 unsigned ChildSize = 0;
193 unsigned VBRSize = 0;
195 VBRSize = GetVBRSize(ChildSize);
198 raw_svector_ostream OS(TmpBuf);
199 formatted_raw_ostream FOS(OS);
200 ChildSize = EmitMatcherList(cast<ScopeMatcher>(N)->getChild(i),
201 Indent+1, CurrentIdx+VBRSize, FOS);
202 } while (GetVBRSize(ChildSize) != VBRSize);
204 assert(ChildSize != 0 && "Should not have a zero-sized child!");
206 CurrentIdx += EmitVBRValue(ChildSize, OS);
207 OS << "/*->" << CurrentIdx+ChildSize << "*/";
210 OS.PadToColumn(CommentIndent) << "// " << SM->getNumChildren()
211 << " children in Scope";
213 OS << '\n' << TmpBuf.str();
214 CurrentIdx += ChildSize;
217 // Emit a zero as a sentinel indicating end of 'Scope'.
218 OS << "/*" << CurrentIdx << "*/";
219 OS.PadToColumn(Indent*2) << "0, /*End of Scope*/\n";
220 return CurrentIdx - StartIdx + 1;
223 case Matcher::RecordNode:
224 OS << "OPC_RecordNode,";
225 OS.PadToColumn(CommentIndent) << "// "
226 << cast<RecordMatcher>(N)->getWhatFor() << '\n';
229 case Matcher::RecordChild:
230 OS << "OPC_RecordChild" << cast<RecordChildMatcher>(N)->getChildNo()
232 OS.PadToColumn(CommentIndent) << "// "
233 << cast<RecordChildMatcher>(N)->getWhatFor() << '\n';
236 case Matcher::RecordMemRef:
237 OS << "OPC_RecordMemRef,\n";
240 case Matcher::CaptureFlagInput:
241 OS << "OPC_CaptureFlagInput,\n";
244 case Matcher::MoveChild:
245 OS << "OPC_MoveChild, " << cast<MoveChildMatcher>(N)->getChildNo() << ",\n";
248 case Matcher::MoveParent:
249 OS << "OPC_MoveParent,\n";
252 case Matcher::CheckSame:
253 OS << "OPC_CheckSame, "
254 << cast<CheckSameMatcher>(N)->getMatchNumber() << ",\n";
257 case Matcher::CheckPatternPredicate: {
258 StringRef Pred = cast<CheckPatternPredicateMatcher>(N)->getPredicate();
259 OS << "OPC_CheckPatternPredicate, " << getPatternPredicate(Pred) << ',';
260 OS.PadToColumn(CommentIndent) << "// " << Pred << '\n';
263 case Matcher::CheckPredicate: {
264 StringRef Pred = cast<CheckPredicateMatcher>(N)->getPredicateName();
265 OS << "OPC_CheckPredicate, " << getNodePredicate(Pred) << ',';
266 OS.PadToColumn(CommentIndent) << "// " << Pred << '\n';
270 case Matcher::CheckOpcode:
271 OS << "OPC_CheckOpcode, "
272 << cast<CheckOpcodeMatcher>(N)->getOpcode().getEnumName() << ",\n";
275 case Matcher::CheckMultiOpcode: {
276 const CheckMultiOpcodeMatcher *CMO = cast<CheckMultiOpcodeMatcher>(N);
277 OS << "OPC_CheckMultiOpcode, " << CMO->getNumOpcodes() << ", ";
278 for (unsigned i = 0, e = CMO->getNumOpcodes(); i != e; ++i)
279 OS << CMO->getOpcode(i).getEnumName() << ", ";
281 return 2 + CMO->getNumOpcodes();
284 case Matcher::CheckType:
285 OS << "OPC_CheckType, "
286 << getEnumName(cast<CheckTypeMatcher>(N)->getType()) << ",\n";
288 case Matcher::CheckChildType:
289 OS << "OPC_CheckChild"
290 << cast<CheckChildTypeMatcher>(N)->getChildNo() << "Type, "
291 << getEnumName(cast<CheckChildTypeMatcher>(N)->getType()) << ",\n";
294 case Matcher::CheckInteger: {
295 int64_t Val = cast<CheckIntegerMatcher>(N)->getValue();
296 OS << "OPC_CheckInteger" << ClassifyInt(Val) << ", ";
297 return EmitInt(Val, OS)+1;
299 case Matcher::CheckCondCode:
300 OS << "OPC_CheckCondCode, ISD::"
301 << cast<CheckCondCodeMatcher>(N)->getCondCodeName() << ",\n";
304 case Matcher::CheckValueType:
305 OS << "OPC_CheckValueType, MVT::"
306 << cast<CheckValueTypeMatcher>(N)->getTypeName() << ",\n";
309 case Matcher::CheckComplexPat: {
310 const ComplexPattern &Pattern =
311 cast<CheckComplexPatMatcher>(N)->getPattern();
312 OS << "OPC_CheckComplexPat, " << getComplexPat(Pattern) << ',';
313 OS.PadToColumn(CommentIndent) << "// " << Pattern.getSelectFunc();
314 OS << ": " << Pattern.getNumOperands() << " operands";
315 if (Pattern.hasProperty(SDNPHasChain))
316 OS << " + chain result and input";
321 case Matcher::CheckAndImm: {
322 int64_t Val = cast<CheckAndImmMatcher>(N)->getValue();
323 OS << "OPC_CheckAndImm" << ClassifyInt(Val) << ", ";
324 return EmitInt(Val, OS)+1;
327 case Matcher::CheckOrImm: {
328 int64_t Val = cast<CheckOrImmMatcher>(N)->getValue();
329 OS << "OPC_CheckOrImm" << ClassifyInt(Val) << ", ";
330 return EmitInt(Val, OS)+1;
332 case Matcher::CheckFoldableChainNode:
333 OS << "OPC_CheckFoldableChainNode,\n";
335 case Matcher::CheckChainCompatible:
336 OS << "OPC_CheckChainCompatible, "
337 << cast<CheckChainCompatibleMatcher>(N)->getPreviousOp() << ",\n";
340 case Matcher::EmitInteger: {
341 int64_t Val = cast<EmitIntegerMatcher>(N)->getValue();
342 OS << "OPC_EmitInteger" << ClassifyInt(Val) << ", "
343 << getEnumName(cast<EmitIntegerMatcher>(N)->getVT()) << ", ";
344 return EmitInt(Val, OS)+2;
346 case Matcher::EmitStringInteger: {
347 const std::string &Val = cast<EmitStringIntegerMatcher>(N)->getValue();
348 // These should always fit into one byte.
349 OS << "OPC_EmitInteger1, "
350 << getEnumName(cast<EmitStringIntegerMatcher>(N)->getVT()) << ", "
355 case Matcher::EmitRegister:
356 OS << "OPC_EmitRegister, "
357 << getEnumName(cast<EmitRegisterMatcher>(N)->getVT()) << ", ";
358 if (Record *R = cast<EmitRegisterMatcher>(N)->getReg())
359 OS << getQualifiedName(R) << ",\n";
361 OS << "0 /*zero_reg*/,\n";
364 case Matcher::EmitConvertToTarget:
365 OS << "OPC_EmitConvertToTarget, "
366 << cast<EmitConvertToTargetMatcher>(N)->getSlot() << ",\n";
369 case Matcher::EmitMergeInputChains: {
370 const EmitMergeInputChainsMatcher *MN =
371 cast<EmitMergeInputChainsMatcher>(N);
372 OS << "OPC_EmitMergeInputChains, " << MN->getNumNodes() << ", ";
373 for (unsigned i = 0, e = MN->getNumNodes(); i != e; ++i)
374 OS << MN->getNode(i) << ", ";
376 return 2+MN->getNumNodes();
378 case Matcher::EmitCopyToReg:
379 OS << "OPC_EmitCopyToReg, "
380 << cast<EmitCopyToRegMatcher>(N)->getSrcSlot() << ", "
381 << getQualifiedName(cast<EmitCopyToRegMatcher>(N)->getDestPhysReg())
384 case Matcher::EmitNodeXForm: {
385 const EmitNodeXFormMatcher *XF = cast<EmitNodeXFormMatcher>(N);
386 OS << "OPC_EmitNodeXForm, " << getNodeXFormID(XF->getNodeXForm()) << ", "
387 << XF->getSlot() << ',';
388 OS.PadToColumn(CommentIndent) << "// "<<XF->getNodeXForm()->getName()<<'\n';
392 case Matcher::EmitNode: {
393 const EmitNodeMatcher *EN = cast<EmitNodeMatcher>(N);
394 OS << "OPC_EmitNode, TARGET_OPCODE(" << EN->getOpcodeName() << "), 0";
396 if (EN->hasChain()) OS << "|OPFL_Chain";
397 if (EN->hasFlag()) OS << "|OPFL_Flag";
398 if (EN->hasMemRefs()) OS << "|OPFL_MemRefs";
399 if (EN->getNumFixedArityOperands() != -1)
400 OS << "|OPFL_Variadic" << EN->getNumFixedArityOperands();
403 OS.PadToColumn(Indent*2+4) << EN->getNumVTs() << "/*#VTs*/, ";
404 for (unsigned i = 0, e = EN->getNumVTs(); i != e; ++i)
405 OS << getEnumName(EN->getVT(i)) << ", ";
407 OS << EN->getNumOperands() << "/*#Ops*/, ";
408 unsigned NumOperandBytes = 0;
409 for (unsigned i = 0, e = EN->getNumOperands(); i != e; ++i) {
410 // We emit the operand numbers in VBR encoded format, in case the number
411 // is too large to represent with a byte.
412 NumOperandBytes += EmitVBRValue(EN->getOperand(i), OS);
415 return 6+EN->getNumVTs()+NumOperandBytes;
417 case Matcher::MarkFlagResults: {
418 const MarkFlagResultsMatcher *CFR = cast<MarkFlagResultsMatcher>(N);
419 OS << "OPC_MarkFlagResults, " << CFR->getNumNodes() << ", ";
420 unsigned NumOperandBytes = 0;
421 for (unsigned i = 0, e = CFR->getNumNodes(); i != e; ++i)
422 NumOperandBytes += EmitVBRValue(CFR->getNode(i), OS);
424 return 2+NumOperandBytes;
426 case Matcher::CompleteMatch: {
427 const CompleteMatchMatcher *CM = cast<CompleteMatchMatcher>(N);
428 OS << "OPC_CompleteMatch, " << CM->getNumResults() << ", ";
429 unsigned NumResultBytes = 0;
430 for (unsigned i = 0, e = CM->getNumResults(); i != e; ++i)
431 NumResultBytes += EmitVBRValue(CM->getResult(i), OS);
433 OS.PadToColumn(Indent*2) << "// Src: "
434 << *CM->getPattern().getSrcPattern() << '\n';
435 OS.PadToColumn(Indent*2) << "// Dst: "
436 << *CM->getPattern().getDstPattern() << '\n';
437 return 2 + NumResultBytes;
440 assert(0 && "Unreachable");
444 /// EmitMatcherList - Emit the bytes for the specified matcher subtree.
445 unsigned MatcherTableEmitter::
446 EmitMatcherList(const Matcher *N, unsigned Indent, unsigned CurrentIdx,
447 formatted_raw_ostream &OS) {
450 if (unsigned(N->getKind()) >= Histogram.size())
451 Histogram.resize(N->getKind()+1);
452 Histogram[N->getKind()]++;
454 OS << "/*" << CurrentIdx << "*/";
455 unsigned MatcherSize = EmitMatcher(N, Indent, CurrentIdx, OS);
457 CurrentIdx += MatcherSize;
459 // If there are other nodes in this list, iterate to them, otherwise we're
466 void MatcherTableEmitter::EmitPredicateFunctions(formatted_raw_ostream &OS) {
467 // FIXME: Don't build off the DAGISelEmitter's predicates, emit them directly
468 // here into the case stmts.
470 // Emit pattern predicates.
471 OS << "bool CheckPatternPredicate(unsigned PredNo) const {\n";
472 OS << " switch (PredNo) {\n";
473 OS << " default: assert(0 && \"Invalid predicate in table?\");\n";
474 for (unsigned i = 0, e = PatternPredicates.size(); i != e; ++i)
475 OS << " case " << i << ": return " << PatternPredicates[i] << ";\n";
479 // Emit Node predicates.
480 OS << "bool CheckNodePredicate(SDNode *N, unsigned PredNo) const {\n";
481 OS << " switch (PredNo) {\n";
482 OS << " default: assert(0 && \"Invalid predicate in table?\");\n";
483 for (unsigned i = 0, e = NodePredicates.size(); i != e; ++i)
484 OS << " case " << i << ": return " << NodePredicates[i] << "(N);\n";
488 // Emit CompletePattern matchers.
489 // FIXME: This should be const.
490 OS << "bool CheckComplexPattern(SDNode *Root, SDValue N,\n";
491 OS << " unsigned PatternNo, SmallVectorImpl<SDValue> &Result) {\n";
492 OS << " switch (PatternNo) {\n";
493 OS << " default: assert(0 && \"Invalid pattern # in table?\");\n";
494 for (unsigned i = 0, e = ComplexPatterns.size(); i != e; ++i) {
495 const ComplexPattern &P = *ComplexPatterns[i];
496 unsigned NumOps = P.getNumOperands();
498 if (P.hasProperty(SDNPHasChain))
499 ++NumOps; // Get the chained node too.
501 OS << " case " << i << ":\n";
502 OS << " Result.resize(Result.size()+" << NumOps << ");\n";
503 OS << " return " << P.getSelectFunc();
505 // FIXME: Temporary hack until old isel dies.
506 if (P.hasProperty(SDNPHasChain))
510 for (unsigned i = 0; i != NumOps; ++i)
511 OS << ", Result[Result.size()-" << (NumOps-i) << ']';
517 // Emit SDNodeXForm handlers.
518 // FIXME: This should be const.
519 OS << "SDValue RunSDNodeXForm(SDValue V, unsigned XFormNo) {\n";
520 OS << " switch (XFormNo) {\n";
521 OS << " default: assert(0 && \"Invalid xform # in table?\");\n";
523 // FIXME: The node xform could take SDValue's instead of SDNode*'s.
524 for (unsigned i = 0, e = NodeXForms.size(); i != e; ++i)
525 OS << " case " << i << ": return Transform_" << NodeXForms[i]->getName()
526 << "(V.getNode());\n";
531 void MatcherTableEmitter::EmitHistogram(formatted_raw_ostream &OS) {
532 OS << " // Opcode Histogram:\n";
533 for (unsigned i = 0, e = Histogram.size(); i != e; ++i) {
535 switch ((Matcher::KindTy)i) {
536 case Matcher::Scope: OS << "OPC_Scope"; break;
537 case Matcher::RecordNode: OS << "OPC_RecordNode"; break;
538 case Matcher::RecordChild: OS << "OPC_RecordChild"; break;
539 case Matcher::RecordMemRef: OS << "OPC_RecordMemRef"; break;
540 case Matcher::CaptureFlagInput: OS << "OPC_CaptureFlagInput"; break;
541 case Matcher::MoveChild: OS << "OPC_MoveChild"; break;
542 case Matcher::MoveParent: OS << "OPC_MoveParent"; break;
543 case Matcher::CheckSame: OS << "OPC_CheckSame"; break;
544 case Matcher::CheckPatternPredicate:
545 OS << "OPC_CheckPatternPredicate"; break;
546 case Matcher::CheckPredicate: OS << "OPC_CheckPredicate"; break;
547 case Matcher::CheckOpcode: OS << "OPC_CheckOpcode"; break;
548 case Matcher::CheckMultiOpcode: OS << "OPC_CheckMultiOpcode"; break;
549 case Matcher::CheckType: OS << "OPC_CheckType"; break;
550 case Matcher::CheckChildType: OS << "OPC_CheckChildType"; break;
551 case Matcher::CheckInteger: OS << "OPC_CheckInteger"; break;
552 case Matcher::CheckCondCode: OS << "OPC_CheckCondCode"; break;
553 case Matcher::CheckValueType: OS << "OPC_CheckValueType"; break;
554 case Matcher::CheckComplexPat: OS << "OPC_CheckComplexPat"; break;
555 case Matcher::CheckAndImm: OS << "OPC_CheckAndImm"; break;
556 case Matcher::CheckOrImm: OS << "OPC_CheckOrImm"; break;
557 case Matcher::CheckFoldableChainNode:
558 OS << "OPC_CheckFoldableChainNode"; break;
559 case Matcher::CheckChainCompatible: OS << "OPC_CheckChainCompatible"; break;
560 case Matcher::EmitInteger: OS << "OPC_EmitInteger"; break;
561 case Matcher::EmitStringInteger: OS << "OPC_EmitStringInteger"; break;
562 case Matcher::EmitRegister: OS << "OPC_EmitRegister"; break;
563 case Matcher::EmitConvertToTarget: OS << "OPC_EmitConvertToTarget"; break;
564 case Matcher::EmitMergeInputChains: OS << "OPC_EmitMergeInputChains"; break;
565 case Matcher::EmitCopyToReg: OS << "OPC_EmitCopyToReg"; break;
566 case Matcher::EmitNode: OS << "OPC_EmitNode"; break;
567 case Matcher::EmitNodeXForm: OS << "OPC_EmitNodeXForm"; break;
568 case Matcher::MarkFlagResults: OS << "OPC_MarkFlagResults"; break;
569 case Matcher::CompleteMatch: OS << "OPC_CompleteMatch"; break;
572 OS.PadToColumn(40) << " = " << Histogram[i] << '\n';
578 void llvm::EmitMatcherTable(const Matcher *TheMatcher, raw_ostream &O) {
579 formatted_raw_ostream OS(O);
581 OS << "// The main instruction selector code.\n";
582 OS << "SDNode *SelectCode(SDNode *N) {\n";
584 MatcherTableEmitter MatcherEmitter;
586 OS << " // Opcodes are emitted as 2 bytes, TARGET_OPCODE handles this.\n";
587 OS << " #define TARGET_OPCODE(X) X & 255, unsigned(X) >> 8\n";
588 OS << " static const unsigned char MatcherTable[] = {\n";
589 unsigned TotalSize = MatcherEmitter.EmitMatcherList(TheMatcher, 5, 0, OS);
590 OS << " 0\n }; // Total Array size is " << (TotalSize+1) << " bytes\n\n";
592 MatcherEmitter.EmitHistogram(OS);
594 OS << " #undef TARGET_OPCODE\n";
595 OS << " return SelectCodeCommon(N, MatcherTable,sizeof(MatcherTable));\n}\n";
598 // Next up, emit the function for node and pattern predicates:
599 MatcherEmitter.EmitPredicateFunctions(OS);