34 #include "llvm/ADT/DenseMapInfoVariant.h"
35 #include "llvm/ADT/StringMap.h"
36 #include "llvm/Support/FormatVariadic.h"
37 #include "llvm/Support/PrettyStackTrace.h"
38 #include "llvm/Support/Regex.h"
46 class OperationVerifier {
50 explicit OperationVerifier(
bool verifyRecursively)
51 : verifyRecursively(verifyRecursively) {}
79 bool verifyRecursively;
85 if (
failed(verifyOperation(op)))
94 if (
failed(verifyDominanceOfContainedRegions(op, domInfo)))
110 if (!llvm::hasSingleElement(*block->
getParent()))
118 if (arg.getOwner() != &block)
119 return emitError(arg.getLoc(),
"block argument not owned by block");
126 "empty block: expect at least a terminator");
135 "operation with block successors must terminate its parent block");
145 if (successor->getParent() != block.
getParent())
147 "branching to block of a different region");
155 return block.
back().
emitError(
"block with no terminator, has ")
165 return op.
emitError(
"null operand found");
170 if (
auto *dialect = attr.getNameDialect())
171 if (
failed(dialect->verifyOperationAttribute(&op, attr)))
177 std::optional<RegisteredOperationName> registeredInfo =
179 if (registeredInfo &&
failed(registeredInfo->verifyInvariants(&op)))
185 auto kindInterface = dyn_cast<RegionKindInterface>(&op);
189 for (
unsigned i = 0; i < numRegions; ++i) {
190 Region ®ion = regions[i];
202 << i <<
" to have 0 or 1 blocks";
212 "entry block of region may not have predecessors");
219 if (verifyRecursively) {
221 for (
Block &block : region)
223 if (o.getNumRegions() != 0 &&
225 opsWithIsolatedRegions.push_back(&o);
229 [&](
Operation *o) { return verifyOpAndDominance(*o); })))
232 std::optional<RegisteredOperationName> registeredInfo =
236 if (registeredInfo &&
failed(registeredInfo->verifyRegionInvariants(&op)))
248 <<
"created with unregistered dialect. If this is "
249 "intended, please call allowUnregisteredDialects() on the "
250 "MLIRContext, or use -allow-unregistered-dialect with "
251 "the MLIR opt tool used";
257 return op.
emitError(
"unregistered operation '")
259 <<
"') that does not allow unknown operations";
272 while (!worklist.empty()) {
273 WorkItem top = worklist.back();
275 auto visit = [](
auto &&visitor, WorkItem w) {
278 return visitor(w.get<
Block *>());
281 const bool isExit = !seen.insert(top).second;
286 [
this](
auto *workItem) {
return verifyOnExit(*workItem); }, top)))
293 [
this](
auto *workItem) {
return verifyOnEntrance(*workItem); },
297 if (top.is<
Block *>()) {
300 for (
Operation &o : llvm::reverse(currentBlock)) {
303 worklist.emplace_back(&o);
309 if (verifyRecursively)
311 for (
Block &block : llvm::reverse(region))
312 worklist.emplace_back(&block);
325 << operandNo <<
" does not dominate this use";
333 note <<
"operand defined here";
335 Block *block2 = useOp->getBlock();
338 if (block1 == block2)
339 note <<
" (op in the same block)";
340 else if (region1 == region2)
341 note <<
" (op in the same region)";
343 note <<
" (op in a parent region)";
345 note <<
" (op in a child region)";
347 note <<
" (op is neither in a parent nor in a child region)";
352 Block *block2 = llvm::cast<BlockArgument>(operand).getOwner();
360 note <<
" (block without parent)";
363 if (block1 == block2)
364 llvm::report_fatal_error(
"Internal error in dominance verification");
365 int index = std::distance(region2->
begin(), block2->getIterator());
366 note <<
"operand defined as a block argument (block #" << index;
367 if (region1 == region2)
368 note <<
" in the same region)";
370 note <<
" in a parent region)";
372 note <<
" in a child region)";
374 note <<
" neither in a parent nor in a child region)";
379 OperationVerifier::verifyDominanceOfContainedRegions(
Operation &op,
382 while (!worklist.empty()) {
383 auto *op = worklist.pop_back_val();
385 for (
auto &block : region.getBlocks()) {
388 for (
auto &op : block) {
408 worklist.push_back(&op);
422 OperationVerifier verifier(verifyRecursively);
423 return verifier.verifyOpAndDominance(*op);
static void visit(Operation *op, DenseSet< Operation * > &visited)
Visits all the pdl.operand(s), pdl.result(s), and pdl.operation(s) connected to the given operation.
static std::string diag(const llvm::Value &value)
static bool isReachable(Block *from, Block *to, ArrayRef< Block * > except)
static bool mayBeValidWithoutTerminator(Block *block)
Returns true if this block may be valid without terminator.
static void diagnoseInvalidOperandDominance(Operation &op, unsigned operandNo)
Emit an error when the specified operand of the specified operation is an invalid use because of domi...
Block represents an ordered list of Operations.
Region * getParent() const
Provide a 'getParent' method for ilist_node_with_parent methods.
SuccessorRange getSuccessors()
BlockArgListType getArguments()
bool hasNoPredecessors()
Return true if this block has no predecessors.
Operation * getParentOp()
Returns the closest surrounding operation that contains this block.
This class contains all of the information necessary to report a diagnostic to the DiagnosticEngine.
Dialects are groups of MLIR operations, types and attributes, as well as behavior associated with the...
StringRef getNamespace() const
bool allowsUnknownOperations() const
Returns true if this dialect allows for unregistered operations, i.e.
A class for computing basic dominance information.
bool properlyDominates(Operation *a, Operation *b, bool enclosingOpOk=true) const
Return true if operation A properly dominates operation B, i.e.
This class represents a diagnostic that is inflight and set to be reported.
This class defines the main interface for locations in MLIR and acts as a non-nullable wrapper around...
bool allowsUnregisteredDialects()
Return true if we allow to create operation for unregistered dialects.
This class provides the API for ops that are known to be isolated from above.
This class provides the API for ops that are known to be terminators.
This class indicates that the regions associated with this op don't have terminators.
Dialect * getDialect() const
Return the dialect this operation is registered to if the dialect is loaded in the context,...
std::optional< RegisteredOperationName > getRegisteredInfo() const
If this operation is registered, returns the registered information, std::nullopt otherwise.
Operation is the basic unit of execution within MLIR.
Value getOperand(unsigned idx)
bool hasTrait()
Returns true if the operation was registered with a particular trait, e.g.
unsigned getNumSuccessors()
bool isRegistered()
Returns true if this operation has a registered operation description, otherwise false.
bool mightHaveTrait()
Returns true if the operation might have the provided trait.
MLIRContext * getContext()
Return the context this operation is associated with.
unsigned getNumRegions()
Returns the number of regions held by this operation.
Location getLoc()
The source location the operation was defined or derived from.
InFlightDiagnostic emitError(const Twine &message={})
Emit an error about fatal conditions with this operation, reporting up to any diagnostic handlers tha...
Block * getBlock()
Returns the operation block that contains this operation.
MutableArrayRef< Region > getRegions()
Returns the regions held by this operation.
OperationName getName()
The name of an operation is the key identifier for it.
DictionaryAttr getDiscardableAttrDictionary()
Return all of the discardable attributes on this operation as a DictionaryAttr.
operand_range getOperands()
Returns an iterator on the underlying Value's.
InFlightDiagnostic emitOpError(const Twine &message={})
Emit an error with the op name prefixed, like "'dim' op " which is convenient for verifiers.
This class contains a list of basic blocks and a link to the parent operation it is attached to.
bool isProperAncestor(Region *other)
Return true if this region is a proper ancestor of the other region.
Location getLoc()
Return a location for this region.
bool hasOneBlock()
Return true if this region has exactly one block.
This class represents an instance of an SSA value in the MLIR system, representing a computable value...
Operation * getDefiningOp() const
If this value is the result of an operation, return the operation that defines it.
bool isReachableFromEntry(Block *a) const
Return true if the specified block is reachable from the entry block of its region.
constexpr void enumerate(std::tuple< Tys... > &tuple, CallbackT &&callback)
Include the generated interface declarations.
LogicalResult failure(bool isFailure=true)
Utility function to generate a LogicalResult.
LogicalResult failableParallelForEach(MLIRContext *context, IteratorT begin, IteratorT end, FuncT &&func)
Invoke the given function on the elements between [begin, end) asynchronously.
InFlightDiagnostic emitError(Location loc)
Utility method to emit an error message using this location.
LogicalResult success(bool isSuccess=true)
Utility function to generate a LogicalResult.
auto get(MLIRContext *context, Ts &&...params)
Helper method that injects context only if needed, this helps unify some of the attribute constructio...
RegionKind
The kinds of regions contained in an operation.
LogicalResult verify(Operation *op, bool verifyRecursively=true)
Perform (potentially expensive) checks of invariants, used to detect compiler bugs,...
bool failed(LogicalResult result)
Utility function that returns true if the provided LogicalResult corresponds to a failure value.
This class represents an efficient way to signal success or failure.