Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2018 ARM Limited. |
| 3 | * |
| 4 | * SPDX-License-Identifier: MIT |
| 5 | * |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | * of this software and associated documentation files (the "Software"), to |
| 8 | * deal in the Software without restriction, including without limitation the |
| 9 | * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| 10 | * sell copies of the Software, and to permit persons to whom the Software is |
| 11 | * furnished to do so, subject to the following conditions: |
| 12 | * |
| 13 | * The above copyright notice and this permission notice shall be included in all |
| 14 | * copies or substantial portions of the Software. |
| 15 | * |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 22 | * SOFTWARE. |
| 23 | */ |
Georgios Pinitas | d9eb275 | 2018-04-03 13:44:29 +0100 | [diff] [blame] | 24 | #ifndef __ARM_COMPUTE_GRAPH_PASSMANAGER_H__ |
| 25 | #define __ARM_COMPUTE_GRAPH_PASSMANAGER_H__ |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 26 | |
Georgios Pinitas | d9eb275 | 2018-04-03 13:44:29 +0100 | [diff] [blame] | 27 | #include "arm_compute/graph/IGraphMutator.h" |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 28 | |
| 29 | #include <memory> |
| 30 | #include <vector> |
| 31 | |
| 32 | namespace arm_compute |
| 33 | { |
Georgios Pinitas | d9eb275 | 2018-04-03 13:44:29 +0100 | [diff] [blame] | 34 | namespace graph |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 35 | { |
| 36 | // Forward declarations |
| 37 | class Graph; |
| 38 | |
| 39 | /** Pass manager |
| 40 | * |
| 41 | * Responsible for performing the mutating graph passes with a given order |
| 42 | **/ |
| 43 | class PassManager final |
| 44 | { |
| 45 | public: |
| 46 | /** Constructor */ |
| 47 | PassManager(); |
| 48 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 49 | PassManager(const PassManager &) = delete; |
| 50 | /** Default move constructor */ |
| 51 | PassManager(PassManager &&) = default; |
| 52 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 53 | PassManager &operator=(const PassManager &) = delete; |
| 54 | /** Default move assignment operator */ |
| 55 | PassManager &operator=(PassManager &&) = default; |
| 56 | /** Mutation passes accessors |
| 57 | * |
| 58 | * @return Returns the vector with the mutation passes that are to be executed on a graph |
| 59 | */ |
| 60 | const std::vector<std::unique_ptr<IGraphMutator>> &passes() const; |
| 61 | /** Accessor of a pass at a given index |
| 62 | * |
| 63 | * @param[in] index Index of the requested pass |
| 64 | * |
| 65 | * @return A pointer to the given pass if exists else nullptr |
| 66 | */ |
| 67 | IGraphMutator *pass(size_t index); |
| 68 | /** Appends a mutation pass |
| 69 | * |
Georgios Pinitas | 1c32bf396 | 2018-11-12 18:36:19 +0000 | [diff] [blame] | 70 | * @param[in] pass Pass to append |
| 71 | * @param[in] conditional (Optional) Append pass if true else false. Defaults to true. |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 72 | */ |
Georgios Pinitas | 1c32bf396 | 2018-11-12 18:36:19 +0000 | [diff] [blame] | 73 | void append(std::unique_ptr<IGraphMutator> pass, bool conditional = true); |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 74 | /** Clears all the passes */ |
| 75 | void clear(); |
| 76 | /** Runs all the mutation passes on a given graph |
| 77 | * |
Georgios Pinitas | 2a2db59 | 2018-08-15 12:14:46 +0100 | [diff] [blame] | 78 | * @param[in, out] g Graph to run the mutations on |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 79 | */ |
| 80 | void run_all(Graph &g); |
| 81 | /** Runs a specific mutation pass on a given graph |
| 82 | * |
Georgios Pinitas | 2a2db59 | 2018-08-15 12:14:46 +0100 | [diff] [blame] | 83 | * @param[in, out] g Graph to run the mutation on |
| 84 | * @param[in] index Index of the mutation to execute |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 85 | */ |
| 86 | void run(Graph &g, size_t index); |
| 87 | |
| 88 | private: |
| 89 | std::vector<std::unique_ptr<IGraphMutator>> _passes; /**< Vector of graph passes */ |
| 90 | }; |
Georgios Pinitas | d9eb275 | 2018-04-03 13:44:29 +0100 | [diff] [blame] | 91 | } // namespace graph |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 92 | } // namespace arm_compute |
Georgios Pinitas | d9eb275 | 2018-04-03 13:44:29 +0100 | [diff] [blame] | 93 | #endif /* __ARM_COMPUTE_GRAPH_PASSMANAGER_H__ */ |