| //===- Pattern.cpp - Pattern wrapper class --------------------------------===// |
| // |
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| // See https://llvm.org/LICENSE.txt for license information. |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| // |
| //===----------------------------------------------------------------------===// |
| // |
| // Pattern wrapper class to simplify using TableGen Record defining a MLIR |
| // Pattern. |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #include "mlir/TableGen/Pattern.h" |
| #include "llvm/ADT/StringExtras.h" |
| #include "llvm/ADT/Twine.h" |
| #include "llvm/Support/Debug.h" |
| #include "llvm/Support/FormatVariadic.h" |
| #include "llvm/TableGen/Error.h" |
| #include "llvm/TableGen/Record.h" |
| |
| #define DEBUG_TYPE "mlir-tblgen-pattern" |
| |
| using namespace mlir; |
| |
| using llvm::formatv; |
| using mlir::tblgen::Operator; |
| |
| //===----------------------------------------------------------------------===// |
| // DagLeaf |
| //===----------------------------------------------------------------------===// |
| |
| bool tblgen::DagLeaf::isUnspecified() const { |
| return dyn_cast_or_null<llvm::UnsetInit>(def); |
| } |
| |
| bool tblgen::DagLeaf::isOperandMatcher() const { |
| // Operand matchers specify a type constraint. |
| return isSubClassOf("TypeConstraint"); |
| } |
| |
| bool tblgen::DagLeaf::isAttrMatcher() const { |
| // Attribute matchers specify an attribute constraint. |
| return isSubClassOf("AttrConstraint"); |
| } |
| |
| bool tblgen::DagLeaf::isNativeCodeCall() const { |
| return isSubClassOf("NativeCodeCall"); |
| } |
| |
| bool tblgen::DagLeaf::isConstantAttr() const { |
| return isSubClassOf("ConstantAttr"); |
| } |
| |
| bool tblgen::DagLeaf::isEnumAttrCase() const { |
| return isSubClassOf("EnumAttrCaseInfo"); |
| } |
| |
| tblgen::Constraint tblgen::DagLeaf::getAsConstraint() const { |
| assert((isOperandMatcher() || isAttrMatcher()) && |
| "the DAG leaf must be operand or attribute"); |
| return Constraint(cast<llvm::DefInit>(def)->getDef()); |
| } |
| |
| tblgen::ConstantAttr tblgen::DagLeaf::getAsConstantAttr() const { |
| assert(isConstantAttr() && "the DAG leaf must be constant attribute"); |
| return ConstantAttr(cast<llvm::DefInit>(def)); |
| } |
| |
| tblgen::EnumAttrCase tblgen::DagLeaf::getAsEnumAttrCase() const { |
| assert(isEnumAttrCase() && "the DAG leaf must be an enum attribute case"); |
| return EnumAttrCase(cast<llvm::DefInit>(def)); |
| } |
| |
| std::string tblgen::DagLeaf::getConditionTemplate() const { |
| return getAsConstraint().getConditionTemplate(); |
| } |
| |
| llvm::StringRef tblgen::DagLeaf::getNativeCodeTemplate() const { |
| assert(isNativeCodeCall() && "the DAG leaf must be NativeCodeCall"); |
| return cast<llvm::DefInit>(def)->getDef()->getValueAsString("expression"); |
| } |
| |
| bool tblgen::DagLeaf::isSubClassOf(StringRef superclass) const { |
| if (auto *defInit = dyn_cast_or_null<llvm::DefInit>(def)) |
| return defInit->getDef()->isSubClassOf(superclass); |
| return false; |
| } |
| |
| void tblgen::DagLeaf::print(raw_ostream &os) const { |
| if (def) |
| def->print(os); |
| } |
| |
| //===----------------------------------------------------------------------===// |
| // DagNode |
| //===----------------------------------------------------------------------===// |
| |
| bool tblgen::DagNode::isNativeCodeCall() const { |
| if (auto *defInit = dyn_cast_or_null<llvm::DefInit>(node->getOperator())) |
| return defInit->getDef()->isSubClassOf("NativeCodeCall"); |
| return false; |
| } |
| |
| bool tblgen::DagNode::isOperation() const { |
| return !(isNativeCodeCall() || isReplaceWithValue()); |
| } |
| |
| llvm::StringRef tblgen::DagNode::getNativeCodeTemplate() const { |
| assert(isNativeCodeCall() && "the DAG leaf must be NativeCodeCall"); |
| return cast<llvm::DefInit>(node->getOperator()) |
| ->getDef() |
| ->getValueAsString("expression"); |
| } |
| |
| llvm::StringRef tblgen::DagNode::getSymbol() const { |
| return node->getNameStr(); |
| } |
| |
| Operator &tblgen::DagNode::getDialectOp(RecordOperatorMap *mapper) const { |
| llvm::Record *opDef = cast<llvm::DefInit>(node->getOperator())->getDef(); |
| auto it = mapper->find(opDef); |
| if (it != mapper->end()) |
| return *it->second; |
| return *mapper->try_emplace(opDef, std::make_unique<Operator>(opDef)) |
| .first->second; |
| } |
| |
| int tblgen::DagNode::getNumOps() const { |
| int count = isReplaceWithValue() ? 0 : 1; |
| for (int i = 0, e = getNumArgs(); i != e; ++i) { |
| if (auto child = getArgAsNestedDag(i)) |
| count += child.getNumOps(); |
| } |
| return count; |
| } |
| |
| int tblgen::DagNode::getNumArgs() const { return node->getNumArgs(); } |
| |
| bool tblgen::DagNode::isNestedDagArg(unsigned index) const { |
| return isa<llvm::DagInit>(node->getArg(index)); |
| } |
| |
| tblgen::DagNode tblgen::DagNode::getArgAsNestedDag(unsigned index) const { |
| return DagNode(dyn_cast_or_null<llvm::DagInit>(node->getArg(index))); |
| } |
| |
| tblgen::DagLeaf tblgen::DagNode::getArgAsLeaf(unsigned index) const { |
| assert(!isNestedDagArg(index)); |
| return DagLeaf(node->getArg(index)); |
| } |
| |
| StringRef tblgen::DagNode::getArgName(unsigned index) const { |
| return node->getArgNameStr(index); |
| } |
| |
| bool tblgen::DagNode::isReplaceWithValue() const { |
| auto *dagOpDef = cast<llvm::DefInit>(node->getOperator())->getDef(); |
| return dagOpDef->getName() == "replaceWithValue"; |
| } |
| |
| void tblgen::DagNode::print(raw_ostream &os) const { |
| if (node) |
| node->print(os); |
| } |
| |
| //===----------------------------------------------------------------------===// |
| // SymbolInfoMap |
| //===----------------------------------------------------------------------===// |
| |
| StringRef tblgen::SymbolInfoMap::getValuePackName(StringRef symbol, |
| int *index) { |
| StringRef name, indexStr; |
| int idx = -1; |
| std::tie(name, indexStr) = symbol.rsplit("__"); |
| |
| if (indexStr.consumeInteger(10, idx)) { |
| // The second part is not an index; we return the whole symbol as-is. |
| return symbol; |
| } |
| if (index) { |
| *index = idx; |
| } |
| return name; |
| } |
| |
| tblgen::SymbolInfoMap::SymbolInfo::SymbolInfo(const Operator *op, |
| SymbolInfo::Kind kind, |
| Optional<int> index) |
| : op(op), kind(kind), argIndex(index) {} |
| |
| int tblgen::SymbolInfoMap::SymbolInfo::getStaticValueCount() const { |
| switch (kind) { |
| case Kind::Attr: |
| case Kind::Operand: |
| case Kind::Value: |
| return 1; |
| case Kind::Result: |
| return op->getNumResults(); |
| } |
| llvm_unreachable("unknown kind"); |
| } |
| |
| std::string |
| tblgen::SymbolInfoMap::SymbolInfo::getVarDecl(StringRef name) const { |
| LLVM_DEBUG(llvm::dbgs() << "getVarDecl for '" << name << "': "); |
| switch (kind) { |
| case Kind::Attr: { |
| auto type = |
| op->getArg(*argIndex).get<NamedAttribute *>()->attr.getStorageType(); |
| return std::string(formatv("{0} {1};\n", type, name)); |
| } |
| case Kind::Operand: { |
| // Use operand range for captured operands (to support potential variadic |
| // operands). |
| return std::string( |
| formatv("Operation::operand_range {0}(op0->getOperands());\n", name)); |
| } |
| case Kind::Value: { |
| return std::string(formatv("ArrayRef<Value> {0};\n", name)); |
| } |
| case Kind::Result: { |
| // Use the op itself for captured results. |
| return std::string(formatv("{0} {1};\n", op->getQualCppClassName(), name)); |
| } |
| } |
| llvm_unreachable("unknown kind"); |
| } |
| |
| std::string tblgen::SymbolInfoMap::SymbolInfo::getValueAndRangeUse( |
| StringRef name, int index, const char *fmt, const char *separator) const { |
| LLVM_DEBUG(llvm::dbgs() << "getValueAndRangeUse for '" << name << "': "); |
| switch (kind) { |
| case Kind::Attr: { |
| assert(index < 0); |
| auto repl = formatv(fmt, name); |
| LLVM_DEBUG(llvm::dbgs() << repl << " (Attr)\n"); |
| return std::string(repl); |
| } |
| case Kind::Operand: { |
| assert(index < 0); |
| auto *operand = op->getArg(*argIndex).get<NamedTypeConstraint *>(); |
| // If this operand is variadic, then return a range. Otherwise, return the |
| // value itself. |
| if (operand->isVariadic()) { |
| auto repl = formatv(fmt, name); |
| LLVM_DEBUG(llvm::dbgs() << repl << " (VariadicOperand)\n"); |
| return std::string(repl); |
| } |
| auto repl = formatv(fmt, formatv("(*{0}.begin())", name)); |
| LLVM_DEBUG(llvm::dbgs() << repl << " (SingleOperand)\n"); |
| return std::string(repl); |
| } |
| case Kind::Result: { |
| // If `index` is greater than zero, then we are referencing a specific |
| // result of a multi-result op. The result can still be variadic. |
| if (index >= 0) { |
| std::string v = |
| std::string(formatv("{0}.getODSResults({1})", name, index)); |
| if (!op->getResult(index).isVariadic()) |
| v = std::string(formatv("(*{0}.begin())", v)); |
| auto repl = formatv(fmt, v); |
| LLVM_DEBUG(llvm::dbgs() << repl << " (SingleResult)\n"); |
| return std::string(repl); |
| } |
| |
| // If this op has no result at all but still we bind a symbol to it, it |
| // means we want to capture the op itself. |
| if (op->getNumResults() == 0) { |
| LLVM_DEBUG(llvm::dbgs() << name << " (Op)\n"); |
| return std::string(name); |
| } |
| |
| // We are referencing all results of the multi-result op. A specific result |
| // can either be a value or a range. Then join them with `separator`. |
| SmallVector<std::string, 4> values; |
| values.reserve(op->getNumResults()); |
| |
| for (int i = 0, e = op->getNumResults(); i < e; ++i) { |
| std::string v = std::string(formatv("{0}.getODSResults({1})", name, i)); |
| if (!op->getResult(i).isVariadic()) { |
| v = std::string(formatv("(*{0}.begin())", v)); |
| } |
| values.push_back(std::string(formatv(fmt, v))); |
| } |
| auto repl = llvm::join(values, separator); |
| LLVM_DEBUG(llvm::dbgs() << repl << " (VariadicResult)\n"); |
| return repl; |
| } |
| case Kind::Value: { |
| assert(index < 0); |
| assert(op == nullptr); |
| auto repl = formatv(fmt, name); |
| LLVM_DEBUG(llvm::dbgs() << repl << " (Value)\n"); |
| return std::string(repl); |
| } |
| } |
| llvm_unreachable("unknown kind"); |
| } |
| |
| std::string tblgen::SymbolInfoMap::SymbolInfo::getAllRangeUse( |
| StringRef name, int index, const char *fmt, const char *separator) const { |
| LLVM_DEBUG(llvm::dbgs() << "getAllRangeUse for '" << name << "': "); |
| switch (kind) { |
| case Kind::Attr: |
| case Kind::Operand: { |
| assert(index < 0 && "only allowed for symbol bound to result"); |
| auto repl = formatv(fmt, name); |
| LLVM_DEBUG(llvm::dbgs() << repl << " (Operand/Attr)\n"); |
| return std::string(repl); |
| } |
| case Kind::Result: { |
| if (index >= 0) { |
| auto repl = formatv(fmt, formatv("{0}.getODSResults({1})", name, index)); |
| LLVM_DEBUG(llvm::dbgs() << repl << " (SingleResult)\n"); |
| return std::string(repl); |
| } |
| |
| // We are referencing all results of the multi-result op. Each result should |
| // have a value range, and then join them with `separator`. |
| SmallVector<std::string, 4> values; |
| values.reserve(op->getNumResults()); |
| |
| for (int i = 0, e = op->getNumResults(); i < e; ++i) { |
| values.push_back(std::string( |
| formatv(fmt, formatv("{0}.getODSResults({1})", name, i)))); |
| } |
| auto repl = llvm::join(values, separator); |
| LLVM_DEBUG(llvm::dbgs() << repl << " (VariadicResult)\n"); |
| return repl; |
| } |
| case Kind::Value: { |
| assert(index < 0 && "only allowed for symbol bound to result"); |
| assert(op == nullptr); |
| auto repl = formatv(fmt, formatv("{{{0}}", name)); |
| LLVM_DEBUG(llvm::dbgs() << repl << " (Value)\n"); |
| return std::string(repl); |
| } |
| } |
| llvm_unreachable("unknown kind"); |
| } |
| |
| bool tblgen::SymbolInfoMap::bindOpArgument(StringRef symbol, const Operator &op, |
| int argIndex) { |
| StringRef name = getValuePackName(symbol); |
| if (name != symbol) { |
| auto error = formatv( |
| "symbol '{0}' with trailing index cannot bind to op argument", symbol); |
| PrintFatalError(loc, error); |
| } |
| |
| auto symInfo = op.getArg(argIndex).is<NamedAttribute *>() |
| ? SymbolInfo::getAttr(&op, argIndex) |
| : SymbolInfo::getOperand(&op, argIndex); |
| |
| return symbolInfoMap.insert({symbol, symInfo}).second; |
| } |
| |
| bool tblgen::SymbolInfoMap::bindOpResult(StringRef symbol, const Operator &op) { |
| StringRef name = getValuePackName(symbol); |
| return symbolInfoMap.insert({name, SymbolInfo::getResult(&op)}).second; |
| } |
| |
| bool tblgen::SymbolInfoMap::bindValue(StringRef symbol) { |
| return symbolInfoMap.insert({symbol, SymbolInfo::getValue()}).second; |
| } |
| |
| bool tblgen::SymbolInfoMap::contains(StringRef symbol) const { |
| return find(symbol) != symbolInfoMap.end(); |
| } |
| |
| tblgen::SymbolInfoMap::const_iterator |
| tblgen::SymbolInfoMap::find(StringRef key) const { |
| StringRef name = getValuePackName(key); |
| return symbolInfoMap.find(name); |
| } |
| |
| int tblgen::SymbolInfoMap::getStaticValueCount(StringRef symbol) const { |
| StringRef name = getValuePackName(symbol); |
| if (name != symbol) { |
| // If there is a trailing index inside symbol, it references just one |
| // static value. |
| return 1; |
| } |
| // Otherwise, find how many it represents by querying the symbol's info. |
| return find(name)->getValue().getStaticValueCount(); |
| } |
| |
| std::string |
| tblgen::SymbolInfoMap::getValueAndRangeUse(StringRef symbol, const char *fmt, |
| const char *separator) const { |
| int index = -1; |
| StringRef name = getValuePackName(symbol, &index); |
| |
| auto it = symbolInfoMap.find(name); |
| if (it == symbolInfoMap.end()) { |
| auto error = formatv("referencing unbound symbol '{0}'", symbol); |
| PrintFatalError(loc, error); |
| } |
| |
| return it->getValue().getValueAndRangeUse(name, index, fmt, separator); |
| } |
| |
| std::string tblgen::SymbolInfoMap::getAllRangeUse(StringRef symbol, |
| const char *fmt, |
| const char *separator) const { |
| int index = -1; |
| StringRef name = getValuePackName(symbol, &index); |
| |
| auto it = symbolInfoMap.find(name); |
| if (it == symbolInfoMap.end()) { |
| auto error = formatv("referencing unbound symbol '{0}'", symbol); |
| PrintFatalError(loc, error); |
| } |
| |
| return it->getValue().getAllRangeUse(name, index, fmt, separator); |
| } |
| |
| //===----------------------------------------------------------------------===// |
| // Pattern |
| //==----------------------------------------------------------------------===// |
| |
| tblgen::Pattern::Pattern(const llvm::Record *def, RecordOperatorMap *mapper) |
| : def(*def), recordOpMap(mapper) {} |
| |
| tblgen::DagNode tblgen::Pattern::getSourcePattern() const { |
| return tblgen::DagNode(def.getValueAsDag("sourcePattern")); |
| } |
| |
| int tblgen::Pattern::getNumResultPatterns() const { |
| auto *results = def.getValueAsListInit("resultPatterns"); |
| return results->size(); |
| } |
| |
| tblgen::DagNode tblgen::Pattern::getResultPattern(unsigned index) const { |
| auto *results = def.getValueAsListInit("resultPatterns"); |
| return tblgen::DagNode(cast<llvm::DagInit>(results->getElement(index))); |
| } |
| |
| void tblgen::Pattern::collectSourcePatternBoundSymbols( |
| tblgen::SymbolInfoMap &infoMap) { |
| LLVM_DEBUG(llvm::dbgs() << "start collecting source pattern bound symbols\n"); |
| collectBoundSymbols(getSourcePattern(), infoMap, /*isSrcPattern=*/true); |
| LLVM_DEBUG(llvm::dbgs() << "done collecting source pattern bound symbols\n"); |
| } |
| |
| void tblgen::Pattern::collectResultPatternBoundSymbols( |
| tblgen::SymbolInfoMap &infoMap) { |
| LLVM_DEBUG(llvm::dbgs() << "start collecting result pattern bound symbols\n"); |
| for (int i = 0, e = getNumResultPatterns(); i < e; ++i) { |
| auto pattern = getResultPattern(i); |
| collectBoundSymbols(pattern, infoMap, /*isSrcPattern=*/false); |
| } |
| LLVM_DEBUG(llvm::dbgs() << "done collecting result pattern bound symbols\n"); |
| } |
| |
| const tblgen::Operator &tblgen::Pattern::getSourceRootOp() { |
| return getSourcePattern().getDialectOp(recordOpMap); |
| } |
| |
| tblgen::Operator &tblgen::Pattern::getDialectOp(DagNode node) { |
| return node.getDialectOp(recordOpMap); |
| } |
| |
| std::vector<tblgen::AppliedConstraint> tblgen::Pattern::getConstraints() const { |
| auto *listInit = def.getValueAsListInit("constraints"); |
| std::vector<tblgen::AppliedConstraint> ret; |
| ret.reserve(listInit->size()); |
| |
| for (auto it : *listInit) { |
| auto *dagInit = dyn_cast<llvm::DagInit>(it); |
| if (!dagInit) |
| PrintFatalError(def.getLoc(), "all elements in Pattern multi-entity " |
| "constraints should be DAG nodes"); |
| |
| std::vector<std::string> entities; |
| entities.reserve(dagInit->arg_size()); |
| for (auto *argName : dagInit->getArgNames()) { |
| if (!argName) { |
| PrintFatalError( |
| def.getLoc(), |
| "operands to additional constraints can only be symbol references"); |
| } |
| entities.push_back(std::string(argName->getValue())); |
| } |
| |
| ret.emplace_back(cast<llvm::DefInit>(dagInit->getOperator())->getDef(), |
| dagInit->getNameStr(), std::move(entities)); |
| } |
| return ret; |
| } |
| |
| int tblgen::Pattern::getBenefit() const { |
| // The initial benefit value is a heuristic with number of ops in the source |
| // pattern. |
| int initBenefit = getSourcePattern().getNumOps(); |
| llvm::DagInit *delta = def.getValueAsDag("benefitDelta"); |
| if (delta->getNumArgs() != 1 || !isa<llvm::IntInit>(delta->getArg(0))) { |
| PrintFatalError(def.getLoc(), |
| "The 'addBenefit' takes and only takes one integer value"); |
| } |
| return initBenefit + dyn_cast<llvm::IntInit>(delta->getArg(0))->getValue(); |
| } |
| |
| std::vector<tblgen::Pattern::IdentifierLine> |
| tblgen::Pattern::getLocation() const { |
| std::vector<std::pair<StringRef, unsigned>> result; |
| result.reserve(def.getLoc().size()); |
| for (auto loc : def.getLoc()) { |
| unsigned buf = llvm::SrcMgr.FindBufferContainingLoc(loc); |
| assert(buf && "invalid source location"); |
| result.emplace_back( |
| llvm::SrcMgr.getBufferInfo(buf).Buffer->getBufferIdentifier(), |
| llvm::SrcMgr.getLineAndColumn(loc, buf).first); |
| } |
| return result; |
| } |
| |
| void tblgen::Pattern::collectBoundSymbols(DagNode tree, SymbolInfoMap &infoMap, |
| bool isSrcPattern) { |
| auto treeName = tree.getSymbol(); |
| if (!tree.isOperation()) { |
| if (!treeName.empty()) { |
| PrintFatalError( |
| def.getLoc(), |
| formatv("binding symbol '{0}' to non-operation unsupported right now", |
| treeName)); |
| } |
| return; |
| } |
| |
| auto &op = getDialectOp(tree); |
| auto numOpArgs = op.getNumArgs(); |
| auto numTreeArgs = tree.getNumArgs(); |
| |
| if (numOpArgs != numTreeArgs) { |
| auto err = formatv("op '{0}' argument number mismatch: " |
| "{1} in pattern vs. {2} in definition", |
| op.getOperationName(), numTreeArgs, numOpArgs); |
| PrintFatalError(def.getLoc(), err); |
| } |
| |
| // The name attached to the DAG node's operator is for representing the |
| // results generated from this op. It should be remembered as bound results. |
| if (!treeName.empty()) { |
| LLVM_DEBUG(llvm::dbgs() |
| << "found symbol bound to op result: " << treeName << '\n'); |
| if (!infoMap.bindOpResult(treeName, op)) |
| PrintFatalError(def.getLoc(), |
| formatv("symbol '{0}' bound more than once", treeName)); |
| } |
| |
| for (int i = 0; i != numTreeArgs; ++i) { |
| if (auto treeArg = tree.getArgAsNestedDag(i)) { |
| // This DAG node argument is a DAG node itself. Go inside recursively. |
| collectBoundSymbols(treeArg, infoMap, isSrcPattern); |
| } else if (isSrcPattern) { |
| // We can only bind symbols to op arguments in source pattern. Those |
| // symbols are referenced in result patterns. |
| auto treeArgName = tree.getArgName(i); |
| // `$_` is a special symbol meaning ignore the current argument. |
| if (!treeArgName.empty() && treeArgName != "_") { |
| LLVM_DEBUG(llvm::dbgs() << "found symbol bound to op argument: " |
| << treeArgName << '\n'); |
| if (!infoMap.bindOpArgument(treeArgName, op, i)) { |
| auto err = formatv("symbol '{0}' bound more than once", treeArgName); |
| PrintFatalError(def.getLoc(), err); |
| } |
| } |
| } |
| } |
| } |