17 #include "llvm/Support/FormatVariadic.h"
18 #include "llvm/Support/Path.h"
19 #include "llvm/TableGen/Record.h"
30 StringRef inputFilename = records.getInputFilename();
33 StringRef nameRef = sys::path::filename(inputFilename);
34 nameRef.consume_back(
".td");
37 std::string uniqueName(tag);
38 for (
char c : nameRef) {
39 if (isAlnum(c) || c ==
'_')
40 uniqueName.push_back(c);
42 uniqueName.append(utohexstr((
unsigned char)c));
47 StaticVerifierFunctionEmitter::StaticVerifierFunctionEmitter(
48 raw_ostream &os,
const RecordKeeper &records, StringRef tag)
54 emitTypeConstraints();
55 emitAttrConstraints();
56 emitPropConstraints();
57 emitSuccessorConstraints();
58 emitRegionConstraints();
61 void StaticVerifierFunctionEmitter::emitPatternConstraints(
63 collectPatternConstraints(constraints);
73 const auto *it = typeConstraints.find(constraint);
74 assert(it != typeConstraints.end() &&
"expected to find a type constraint");
82 const auto *it = attrConstraints.find(constraint);
83 return it == attrConstraints.end() ? std::optional<StringRef>()
84 : StringRef(it->second);
91 const auto *it = propConstraints.find(constraint);
92 return it == propConstraints.end() ? std::optional<StringRef>()
93 : StringRef(it->second);
98 const auto *it = successorConstraints.find(constraint);
99 assert(it != successorConstraints.end() &&
100 "expected to find a sucessor constraint");
106 const auto *it = regionConstraints.find(constraint);
107 assert(it != regionConstraints.end() &&
108 "expected to find a region constraint");
126 static ::llvm::LogicalResult {0}(
127 ::mlir::Operation *op, ::mlir::Type type, ::llvm::StringRef valueKind,
128 unsigned valueIndex) {
130 return op->emitOpError(valueKind) << " #" << valueIndex
131 << " must be {2}, but got " << type;
133 return ::mlir::success();
144 static ::llvm::LogicalResult {0}(
145 ::mlir::Attribute attr, ::llvm::StringRef attrName, llvm::function_ref<::mlir::InFlightDiagnostic()> emitError) {{
147 return emitError() << "attribute '" << attrName
148 << "' failed to satisfy constraint: {2}";
149 return ::mlir::success();
151 static ::llvm::LogicalResult {0}(
152 ::mlir::Operation *op, ::mlir::Attribute attr, ::llvm::StringRef attrName) {{
153 return {0}(attr, attrName, [op]() {{
154 return op->emitOpError();
163 static ::llvm::LogicalResult {0}(
164 {3} prop, ::llvm::StringRef propName, llvm::function_ref<::mlir::InFlightDiagnostic()> emitError) {{
166 return emitError() << "property '" << propName
167 << "' failed to satisfy constraint: {2}";
168 return ::mlir::success();
170 static ::llvm::LogicalResult {0}(
171 ::mlir::Operation *op, {3} prop, ::llvm::StringRef propName) {{
172 return {0}(prop, propName, [op]() {{
173 return op->emitOpError();
180 static ::llvm::LogicalResult {0}(
181 ::mlir::Operation *op, ::mlir::Block *successor,
182 ::llvm::StringRef successorName, unsigned successorIndex) {
184 return op->emitOpError("successor #") << successorIndex << " ('"
185 << successorName << ")' failed to verify constraint: {2}";
187 return ::mlir::success();
194 static ::llvm::LogicalResult {0}(
195 ::mlir::Operation *op, ::mlir::Region ®ion, ::llvm::StringRef regionName,
196 unsigned regionIndex) {
198 return op->emitOpError("region #") << regionIndex
199 << (regionName.empty() ? " " : " ('" + regionName + "') ")
200 << "failed to verify constraint: {2}";
202 return ::mlir::success();
214 static ::llvm::LogicalResult {0}(
215 ::mlir::PatternRewriter &rewriter, ::mlir::Operation *op, {3},
216 ::llvm::StringRef failureStr) {
218 return rewriter.notifyMatchFailure(op, [&](::mlir::Diagnostic &diag) {
219 diag << failureStr << ": {2}";
222 return ::mlir::success();
226 void StaticVerifierFunctionEmitter::emitConstraints(
227 const ConstraintMap &constraints, StringRef selfName,
228 const char *
const codeTemplate) {
231 for (
auto &it : constraints) {
232 os << formatv(codeTemplate, it.second,
233 tgfmt(it.first.getConditionTemplate(), &ctx),
238 void StaticVerifierFunctionEmitter::emitTypeConstraints() {
242 void StaticVerifierFunctionEmitter::emitAttrConstraints() {
248 void StaticVerifierFunctionEmitter::emitPropConstraints() {
251 for (
auto &it : propConstraints) {
252 auto propConstraint = cast<PropConstraint>(it.first);
254 tgfmt(propConstraint.getConditionTemplate(), &ctx),
256 propConstraint.getInterfaceType());
260 void StaticVerifierFunctionEmitter::emitSuccessorConstraints() {
264 void StaticVerifierFunctionEmitter::emitRegionConstraints() {
268 void StaticVerifierFunctionEmitter::emitPatternConstraints() {
271 for (
auto &it : typeConstraints) {
273 tgfmt(it.first.getConditionTemplate(), &ctx),
274 escapeString(it.first.getSummary()),
"::mlir::Type type");
277 for (
auto &it : attrConstraints) {
279 tgfmt(it.first.getConditionTemplate(), &ctx),
281 "::mlir::Attribute attr");
284 for (
auto &it : propConstraints) {
289 if (interfaceType.empty()) {
291 os <<
"template <typename T>";
296 Twine(interfaceType) +
" prop");
311 auto test =
tgfmt(attr.getConditionTemplate(),
314 return !StringRef(test).contains(
"<no-subst-found>");
327 return !StringRef(test).contains(
"<no-subst-found>") && test !=
"true" &&
331 std::string StaticVerifierFunctionEmitter::getUniqueName(StringRef
kind,
333 return (
"__mlir_ods_local_" +
kind +
"_constraint_" + uniqueOutputLabel +
338 void StaticVerifierFunctionEmitter::collectConstraint(ConstraintMap &map,
341 auto [it, inserted] = map.try_emplace(constraint);
343 it->second = getUniqueName(
kind, map.size());
350 if (value.hasPredicate())
351 collectConstraint(typeConstraints,
"type", value.constraint);
354 for (
const Record *def : opDefs) {
361 if (!namedAttr.attr.getPredicate().isNull() &&
362 !namedAttr.attr.isDerivedAttr() &&
364 collectConstraint(attrConstraints,
"attr", namedAttr.attr);
368 if (!namedProp.prop.getPredicate().isNull() &&
370 collectConstraint(propConstraints,
"prop", namedProp.prop);
375 if (!successor.constraint.getPredicate().isNull()) {
376 collectConstraint(successorConstraints,
"successor",
377 successor.constraint);
382 if (!region.constraint.getPredicate().isNull())
383 collectConstraint(regionConstraints,
"region", region.constraint);
387 void StaticVerifierFunctionEmitter::collectPatternConstraints(
389 for (
auto &leaf : constraints) {
390 assert(leaf.isOperandMatcher() || leaf.isAttrMatcher() ||
391 leaf.isPropMatcher());
392 Constraint constraint = leaf.getAsConstraint();
393 if (leaf.isOperandMatcher())
394 collectConstraint(typeConstraints,
"type", constraint);
395 else if (leaf.isAttrMatcher())
396 collectConstraint(attrConstraints,
"attr", constraint);
397 else if (leaf.isPropMatcher())
398 collectConstraint(propConstraints,
"prop", constraint);
408 raw_string_ostream os(ret);
409 os.write_escaped(value);
static const char *const successorConstraintCode
Code for a successor constraint.
static const char *const patternConstraintCode
Code for a pattern type or attribute constraint.
static const char *const regionConstraintCode
Code for a region constraint.
static const char *const typeConstraintCode
Code templates for emitting type, attribute, successor, and region constraints.
static std::string getUniqueOutputLabel(const RecordKeeper &records, StringRef tag)
Generate a unique label based on the current file name to prevent name collisions if multiple generat...
static const char *const propConstraintCode
Code for a property constraint.
static bool canUniqueAttrConstraint(Attribute attr)
An attribute constraint that references anything other than itself and the current op cannot be gener...
static bool canUniquePropConstraint(Property prop)
A property constraint that references anything other than itself and the current op cannot be generic...
static const char *const attrConstraintCode
Code for an attribute constraint.
union mlir::linalg::@1216::ArityGroupAndKind::Kind kind
Attributes are known-constant values of operations.
StringRef getSummary() const
std::string getConditionTemplate() const
Format context containing substitutions for special placeholders.
FmtContext & withBuilder(Twine subst)
FmtContext & withSelf(Twine subst)
FmtContext & addSubst(StringRef placeholder, const Twine &subst)
Wrapper class that contains a MLIR op's information (e.g., operands, attributes) defined in TableGen ...
llvm::iterator_range< const_region_iterator > getRegions() const
const_value_range getResults() const
const_value_range getOperands() const
llvm::iterator_range< const_attribute_iterator > getAttributes() const
llvm::iterator_range< const_successor_iterator > getSuccessors() const
llvm::iterator_range< const_property_iterator > getProperties() const
StringRef getInterfaceType() const
StringRef getInterfaceType() const
StringRef getRegionConstraintFn(const Constraint &constraint) const
Get the name of the static function used for the given region constraint.
void emitPatternConstraints(const ArrayRef< DagLeaf > constraints)
Unique all compatible type and attribute constraints from a pattern file and emit them at the top of ...
std::optional< StringRef > getAttrConstraintFn(const Constraint &constraint) const
Get the name of the static function used for the given attribute constraint.
std::optional< StringRef > getPropConstraintFn(const Constraint &constraint) const
Get the name of the static function used for the given property constraint.
void emitOpConstraints(ArrayRef< const llvm::Record * > opDefs)
Collect and unique all compatible type, attribute, successor, and region constraints from the operati...
void collectOpConstraints(ArrayRef< const llvm::Record * > opDefs)
Collect and unique all the constraints used by operations.
StringRef getTypeConstraintFn(const Constraint &constraint) const
Get the name of the static function used for the given type constraint.
StringRef getSuccessorConstraintFn(const Constraint &constraint) const
Get the name of the static function used for the given successor constraint.
The OpAsmOpInterface, see OpAsmInterface.td for more details.
auto tgfmt(StringRef fmt, const FmtContext *ctx, Ts &&...vals) -> FmtObject< decltype(std::make_tuple(llvm::support::detail::build_format_adapter(std::forward< Ts >(vals))...))>
Formats text by substituting placeholders in format string with replacement parameters.
std::string escapeString(StringRef value)
Escape a string using C++ encoding. E.g. foo"bar -> foo\x22bar.
Include the generated interface declarations.