Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 1 | /* |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 2 | * Copyright (c) 2017-2018 ARM Limited. |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 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_TEST_PROFILER |
| 25 | #define ARM_COMPUTE_TEST_PROFILER |
| 26 | |
| 27 | #include "instruments/Instrument.h" |
Moritz Pflanzer | 09e4f98 | 2017-08-30 12:47:06 +0100 | [diff] [blame] | 28 | #include "instruments/Measurement.h" |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 29 | |
| 30 | #include <map> |
| 31 | #include <memory> |
| 32 | #include <string> |
| 33 | #include <vector> |
| 34 | |
| 35 | namespace arm_compute |
| 36 | { |
| 37 | namespace test |
| 38 | { |
| 39 | namespace framework |
| 40 | { |
| 41 | /** Profiler class to collect benchmark numbers. |
| 42 | * |
| 43 | * A profiler manages multiple instruments that can collect different types of benchmarking numbers. |
| 44 | */ |
| 45 | class Profiler |
| 46 | { |
| 47 | public: |
| 48 | /** Mapping from instrument ids to their measurements. */ |
Moritz Pflanzer | 09e4f98 | 2017-08-30 12:47:06 +0100 | [diff] [blame] | 49 | using MeasurementsMap = std::map<std::string, std::vector<Measurement>>; |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 50 | |
| 51 | /** Add @p instrument to the performance monitor. |
| 52 | * |
| 53 | * All added instruments will be used when @ref start or @ref stop are |
| 54 | * called to make measurements. |
| 55 | * |
| 56 | * @param[in] instrument Instrument to be used to measure performance. |
| 57 | */ |
| 58 | void add(std::unique_ptr<Instrument> instrument); |
| 59 | |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 60 | /** Call test_start() on all the added instruments |
| 61 | * |
| 62 | * Called before the test set up starts |
| 63 | */ |
| 64 | void test_start(); |
| 65 | |
| 66 | /** Call start() on all the added instruments |
| 67 | * |
| 68 | * Called just before the run of the test starts |
| 69 | */ |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 70 | void start(); |
| 71 | |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 72 | /** Call stop() on all the added instruments |
| 73 | * |
| 74 | * Called just after the run of the test ends |
| 75 | */ |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 76 | void stop(); |
| 77 | |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 78 | /** Call test_stop() on all the added instruments |
| 79 | * |
| 80 | * Called after the test teardown ended |
| 81 | */ |
| 82 | void test_stop(); |
| 83 | |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 84 | /** Return measurements for all instruments. |
| 85 | * |
| 86 | * @return measurements for all instruments. |
| 87 | */ |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 88 | const MeasurementsMap &measurements() const; |
| 89 | |
| 90 | private: |
| 91 | std::vector<std::unique_ptr<Instrument>> _instruments{}; |
| 92 | MeasurementsMap _measurements{}; |
| 93 | }; |
| 94 | } // namespace framework |
| 95 | } // namespace test |
| 96 | } // namespace arm_compute |
| 97 | #endif /* ARM_COMPUTE_TEST_PROFILER */ |