1//===-- VPlanVerifier.h -----------------------------------------*- 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/// \file
10/// This file declares the class VPlanVerifier, which contains utility functions
11/// to check the consistency of a VPlan. This includes the following kinds of
12/// invariants:
13///
14/// 1. Region/Block invariants:
15///   - Region's entry/exit block must have no predecessors/successors,
16///     respectively.
17///   - Block's parent must be the region immediately containing the block.
18///   - Linked blocks must have a bi-directional link (successor/predecessor).
19///   - All predecessors/successors of a block must belong to the same region.
20///   - Blocks must have no duplicated successor/predecessor.
21///
22//===----------------------------------------------------------------------===//
23
24#ifndef LLVM_TRANSFORMS_VECTORIZE_VPLANVERIFIER_H
25#define LLVM_TRANSFORMS_VECTORIZE_VPLANVERIFIER_H
26
27namespace llvm {
28class VPRegionBlock;
29
30/// Struct with utility functions that can be used to check the consistency and
31/// invariants of a VPlan, including the components of its H-CFG.
32struct VPlanVerifier {
33  /// Verify the invariants of the H-CFG starting from \p TopRegion. The
34  /// verification process comprises the following steps:
35  /// 1. Region/Block verification: Check the Region/Block verification
36  /// invariants for every region in the H-CFG.
37  void verifyHierarchicalCFG(const VPRegionBlock *TopRegion) const;
38};
39} // namespace llvm
40
41#endif //LLVM_TRANSFORMS_VECTORIZE_VPLANVERIFIER_H
42