Create Reduction Tree Pass
[lldb.git] / mlir / include / mlir / Reducer / ReductionNode.h
1 //===- ReductionNode.h - Reduction Node Implementation ----------*- 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 // This file defines the reduction nodes which are used to track of the metadata
10 // for a specific generated variant within a reduction pass and are the building
11 // blocks of the reduction tree structure. A reduction tree is used to keep
12 // track of the different generated variants throughout a reduction pass in the
13 // MLIR Reduce tool.
14 //
15 //===----------------------------------------------------------------------===//
16
17 #ifndef MLIR_REDUCER_REDUCTIONNODE_H
18 #define MLIR_REDUCER_REDUCTIONNODE_H
19
20 #include <vector>
21
22 #include "mlir/Reducer/Tester.h"
23 #include "llvm/Support/ToolOutputFile.h"
24
25 namespace mlir {
26
27 /// This class defines the ReductionNode which is used to wrap the module of
28 /// a generated variant and keep track of the necessary metadata for the
29 /// reduction pass. The nodes are linked together in a reduction tree stucture
30 /// which defines the relationship between all the different generated variants.
31 class ReductionNode {
32 public:
33   ReductionNode(ModuleOp module, ReductionNode *parent);
34
35   /// Calculates and initializes the size and interesting values of the node.
36   void measureAndTest(const Tester *test);
37
38   /// Returns the module.
39   ModuleOp getModule() const { return module; }
40
41   /// Returns true if the size and interestingness have been calculated.
42   bool isEvaluated() const;
43
44   /// Returns the size in bytes of the module.
45   int getSize() const;
46
47   /// Returns true if the module exhibits the interesting behavior.
48   bool isInteresting() const;
49
50   /// Returns the pointer to a child variant by index.
51   ReductionNode *getVariant(unsigned long index) const;
52
53   /// Returns true if the vector containing the child variants is empty.
54   bool variantsEmpty() const;
55
56   /// Sort the child variants and remove the uninteresting ones.
57   void organizeVariants(const Tester *test);
58
59 private:
60   /// Link a child variant node.
61   void linkVariant(ReductionNode *newVariant);
62
63   // This is the MLIR module of this variant.
64   ModuleOp module;
65
66   // This is true if the module has been evaluated and it exhibits the
67   // interesting behavior.
68   bool interesting;
69
70   // This indicates the number of characters in the printed module if the module
71   // has been evaluated.
72   int size;
73
74   // This indicates if the module has been evalueated (measured and tested).
75   bool evaluated;
76
77   // This points to the ReductionNode that was used as a starting point to
78   // create this variant. It is null if the reduction node is the root.
79   ReductionNode *parent;
80
81   // This points to the child variants that were created using this node as a
82   // starting point.
83   std::vector<std::unique_ptr<ReductionNode>> variants;
84 };
85
86 } // end namespace mlir
87
88 #endif