1 /* 2 * Copyright (c) 2018-2019 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 */ 24 #ifndef ARM_COMPUTE_GRAPH_PASSMANAGER_H 25 #define ARM_COMPUTE_GRAPH_PASSMANAGER_H 26 27 #include "arm_compute/graph/IGraphMutator.h" 28 29 #include <memory> 30 #include <vector> 31 32 namespace arm_compute 33 { 34 namespace graph 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 * 70 * @param[in] pass Pass to append 71 * @param[in] conditional (Optional) Append pass if true else false. Defaults to true. 72 */ 73 void append(std::unique_ptr<IGraphMutator> pass, bool conditional = true); 74 /** Clears all the passes */ 75 void clear(); 76 /** Runs all the mutation passes on a given graph 77 * 78 * @param[in, out] g Graph to run the mutations on 79 */ 80 void run_all(Graph &g); 81 /** Runs a mutation passes of a specific type on a given graph 82 * 83 * @param[in, out] g Graph to run the mutation on 84 * @param[in] type Type of the mutations to execute 85 */ 86 void run_type(Graph &g, IGraphMutator::MutationType type); 87 /** Runs a specific mutation pass on a given graph 88 * 89 * @param[in, out] g Graph to run the mutation on 90 * @param[in] index Index of the mutation to execute 91 */ 92 void run_index(Graph &g, size_t index); 93 94 private: 95 std::vector<std::unique_ptr<IGraphMutator>> _passes; /**< Vector of graph passes */ 96 }; 97 } // namespace graph 98 } // namespace arm_compute 99 #endif /* ARM_COMPUTE_GRAPH_PASSMANAGER_H */ 100