MLIR  16.0.0git
Constraint.h
Go to the documentation of this file.
1 //===- Constraint.h - Constraint class --------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // Constraint wrapper to simplify using TableGen Record for constraints.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef MLIR_TABLEGEN_CONSTRAINT_H_
14 #define MLIR_TABLEGEN_CONSTRAINT_H_
15 
16 #include "mlir/Support/LLVM.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/ADT/StringRef.h"
20 
21 namespace llvm {
22 class Record;
23 } // namespace llvm
24 
25 namespace mlir {
26 namespace tblgen {
27 
28 // Wrapper class with helper methods for accessing Constraint defined in
29 // TableGen.
30 class Constraint {
31 public:
32  // Constraint kind
34 
35  // Create a constraint with a TableGen definition and a kind.
36  Constraint(const llvm::Record *record, Kind kind) : def(record), kind(kind) {}
37  // Create a constraint with a TableGen definition, and infer the kind.
38  Constraint(const llvm::Record *record);
39 
40  /// Constraints are pointer-comparable.
41  bool operator==(const Constraint &that) { return def == that.def; }
42  bool operator!=(const Constraint &that) { return def != that.def; }
43 
44  // Returns the predicate for this constraint.
45  Pred getPredicate() const;
46 
47  // Returns the condition template that can be used to check if a type or
48  // attribute satisfies this constraint. The template may contain "{0}" that
49  // must be substituted with an expression returning an mlir::Type or
50  // mlir::Attribute.
51  std::string getConditionTemplate() const;
52 
53  // Returns the user-readable summary of this constraint. If the summary is not
54  // provided, returns the TableGen def name.
55  StringRef getSummary() const;
56 
57  // Returns the long-form description of this constraint. If the description is
58  // not provided, returns an empty string.
59  StringRef getDescription() const;
60 
61  /// Returns the name of the TablGen def of this constraint. In some cases
62  /// where the current def is anonymous, the name of the base def is used (e.g.
63  /// `std::optional<>`/`Variadic<>` type constraints).
64  StringRef getDefName() const;
65 
66  /// Returns a unique name for the TablGen def of this constraint. This is
67  /// generally just the name of the def, but in some cases where the current
68  /// def is anonymous, the name of the base def is attached (to provide more
69  /// context on the def).
70  std::string getUniqueDefName() const;
71 
72  Kind getKind() const { return kind; }
73 
74  /// Return the underlying def.
75  const llvm::Record &getDef() const { return *def; }
76 
77 protected:
78  // The TableGen definition of this constraint.
79  const llvm::Record *def;
80 
81 private:
82  /// Return the name of the base def if there is one, or std::nullopt
83  /// otherwise.
84  std::optional<StringRef> getBaseDefName() const;
85 
86  // What kind of constraint this is.
87  Kind kind;
88 };
89 
90 // An constraint and the concrete entities to place the constraint on.
92  AppliedConstraint(Constraint &&constraint, StringRef self,
93  std::vector<std::string> &&entities);
94 
96  // The symbol to replace `$_self` special placeholder in the constraint.
97  std::string self;
98  // The symbols to replace `$N` positional placeholders in the constraint.
99  std::vector<std::string> entities;
100 };
101 
102 } // namespace tblgen
103 } // namespace mlir
104 
105 namespace llvm {
106 /// Unique constraints by their predicate and summary. Constraints that share
107 /// the same predicate may have different descriptions; ensure that the
108 /// correct error message is reported when verification fails.
109 template <>
110 struct DenseMapInfo<mlir::tblgen::Constraint> {
112 
115  static unsigned getHashValue(mlir::tblgen::Constraint constraint);
118 };
119 } // namespace llvm
120 
121 #endif // MLIR_TABLEGEN_CONSTRAINT_H_
bool operator==(const Constraint &that)
Constraints are pointer-comparable.
Definition: Constraint.h:41
Pred getPredicate() const
Definition: Constraint.cpp:38
Kind getKind() const
Definition: Constraint.h:72
StringRef getSummary() const
Definition: Constraint.cpp:54
const llvm::Record * def
Definition: Constraint.h:79
const llvm::Record & getDef() const
Return the underlying def.
Definition: Constraint.h:75
bool operator!=(const Constraint &that)
Definition: Constraint.h:42
std::string getUniqueDefName() const
Returns a unique name for the TablGen def of this constraint.
Definition: Constraint.cpp:71
StringRef getDescription() const
Definition: Constraint.cpp:61
StringRef getDefName() const
Returns the name of the TablGen def of this constraint.
Definition: Constraint.cpp:65
Constraint(const llvm::Record *record, Kind kind)
Definition: Constraint.h:36
std::string getConditionTemplate() const
Definition: Constraint.cpp:50
Include the generated interface declarations.
Definition: CallGraph.h:229
Include the generated interface declarations.
static mlir::tblgen::Constraint getEmptyKey()
static mlir::tblgen::Constraint getTombstoneKey()
static bool isEqual(mlir::tblgen::Constraint lhs, mlir::tblgen::Constraint rhs)
static unsigned getHashValue(mlir::tblgen::Constraint constraint)
std::vector< std::string > entities
Definition: Constraint.h:99
AppliedConstraint(Constraint &&constraint, StringRef self, std::vector< std::string > &&entities)
Definition: Constraint.cpp:111