8ca2a4a68765c506c97c54912e06472b2ddfb69d
[lldb.git] / mlir / include / mlir / Reducer / Tester.h
1 //===- Tester.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 // This file defines the Tester class used in the MLIR Reduce tool.
10 //
11 // A Tester object is passed as an argument to the reduction passes and it is
12 // used to keep track of the state of the reduction throughout the multiple
13 // passes.
14 //
15 //===----------------------------------------------------------------------===//
16
17 #ifndef MLIR_REDUCER_TESTER_H
18 #define MLIR_REDUCER_TESTER_H
19
20 #include <vector>
21
22 #include "mlir/IR/Module.h"
23 #include "llvm/ADT/SmallString.h"
24 #include "llvm/Support/Error.h"
25 #include "llvm/Support/FileSystem.h"
26 #include "llvm/Support/Program.h"
27
28 namespace mlir {
29
30 /// This class is used to keep track of the state of the reduction. It contains
31 /// a method to run the interestingness testing script on MLIR test case files
32 /// and provides functionality to track the most reduced test case.
33 class Tester {
34 public:
35   Tester(StringRef testScript, ArrayRef<std::string> testScriptArgs);
36
37   /// Runs the interestingness testing script on a MLIR test case file. Returns
38   /// true if the interesting behavior is present in the test case or false
39   /// otherwise.
40   bool isInteresting(StringRef testCase);
41
42   /// Returns the most reduced MLIR test case module.
43   ModuleOp getMostReduced() const { return mostReduced; }
44
45   /// Updates the most reduced MLIR test case module. If a
46   /// generated variant is found to be successful and shorter than the
47   /// mostReduced module, the mostReduced module must be updated with the new
48   /// variant.
49   void setMostReduced(ModuleOp t) { mostReduced = t; }
50
51 private:
52   StringRef testScript;
53   ArrayRef<std::string> testScriptArgs;
54   ModuleOp mostReduced;
55 };
56
57 } // end namespace mlir
58
59 #endif