Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 1 | /* |
Michele Di Giorgio | d9eaf61 | 2020-07-08 11:12:57 +0100 | [diff] [blame] | 2 | * Copyright (c) 2017-2020 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_INSTRUMENT |
| 25 | #define ARM_COMPUTE_TEST_INSTRUMENT |
| 26 | |
| 27 | #include "../Utils.h" |
Moritz Pflanzer | 09e4f98 | 2017-08-30 12:47:06 +0100 | [diff] [blame] | 28 | #include "Measurement.h" |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 29 | |
Moritz Pflanzer | 09e4f98 | 2017-08-30 12:47:06 +0100 | [diff] [blame] | 30 | #include <map> |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 31 | #include <memory> |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 32 | #include <string> |
| 33 | |
| 34 | namespace arm_compute |
| 35 | { |
| 36 | namespace test |
| 37 | { |
| 38 | namespace framework |
| 39 | { |
Giorgio Arena | ce58a9f | 2017-10-31 17:59:17 +0000 | [diff] [blame] | 40 | enum class ScaleFactor : unsigned int |
| 41 | { |
| 42 | NONE, /* Default scale */ |
| 43 | SCALE_1K, /* 1000 */ |
| 44 | SCALE_1M, /* 1 000 000 */ |
| 45 | TIME_US, /* Microseconds */ |
| 46 | TIME_MS, /* Milliseconds */ |
| 47 | TIME_S, /* Seconds */ |
| 48 | }; |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 49 | /** Interface for classes that can be used to measure performance. */ |
| 50 | class Instrument |
| 51 | { |
| 52 | public: |
| 53 | /** Helper function to create an instrument of the given type. |
| 54 | * |
| 55 | * @return Instance of an instrument of the given type. |
| 56 | */ |
Giorgio Arena | ce58a9f | 2017-10-31 17:59:17 +0000 | [diff] [blame] | 57 | template <typename T, ScaleFactor scale> |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 58 | static std::unique_ptr<Instrument> make_instrument(); |
| 59 | |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 60 | /** Default constructor. */ |
Giorgio Arena | ce58a9f | 2017-10-31 17:59:17 +0000 | [diff] [blame] | 61 | Instrument() = default; |
| 62 | |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 63 | /** Allow instances of this class to be copy constructed */ |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 64 | Instrument(const Instrument &) = default; |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 65 | /** Allow instances of this class to be move constructed */ |
| 66 | Instrument(Instrument &&) = default; |
| 67 | /** Allow instances of this class to be copied */ |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 68 | Instrument &operator=(const Instrument &) = default; |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 69 | /** Allow instances of this class to be moved */ |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 70 | Instrument &operator=(Instrument &&) = default; |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 71 | /** Default destructor. */ |
| 72 | virtual ~Instrument() = default; |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 73 | |
| 74 | /** Identifier for the instrument */ |
| 75 | virtual std::string id() const = 0; |
| 76 | |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 77 | /** Start of the test |
| 78 | * |
| 79 | * Called before the test set up starts |
| 80 | */ |
| 81 | virtual void test_start() |
| 82 | { |
| 83 | } |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 84 | |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 85 | /** Start measuring. |
| 86 | * |
| 87 | * Called just before the run of the test starts |
| 88 | */ |
| 89 | virtual void start() |
| 90 | { |
| 91 | } |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 92 | |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 93 | /** Stop measuring. |
| 94 | * |
| 95 | * Called just after the run of the test ends |
| 96 | */ |
| 97 | virtual void stop() |
| 98 | { |
| 99 | } |
| 100 | |
| 101 | /** End of the test |
| 102 | * |
| 103 | * Called after the test teardown ended |
| 104 | */ |
| 105 | virtual void test_stop() |
| 106 | { |
| 107 | } |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 108 | /** Map of measurements */ |
Moritz Pflanzer | 09e4f98 | 2017-08-30 12:47:06 +0100 | [diff] [blame] | 109 | using MeasurementsMap = std::map<std::string, Measurement>; |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 110 | |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 111 | /** Return the latest measurements. |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 112 | * |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 113 | * @return the latest measurements. |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 114 | */ |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 115 | virtual MeasurementsMap measurements() const |
| 116 | { |
| 117 | return MeasurementsMap(); |
| 118 | } |
| 119 | |
| 120 | /** Return the latest test measurements. |
| 121 | * |
| 122 | * @return the latest test measurements. |
| 123 | */ |
| 124 | virtual MeasurementsMap test_measurements() const |
| 125 | { |
| 126 | return MeasurementsMap(); |
| 127 | } |
Giorgio Arena | ce58a9f | 2017-10-31 17:59:17 +0000 | [diff] [blame] | 128 | |
| 129 | protected: |
| 130 | std::string _unit{}; |
Moritz Pflanzer | 09e4f98 | 2017-08-30 12:47:06 +0100 | [diff] [blame] | 131 | }; |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 132 | |
Giorgio Arena | ce58a9f | 2017-10-31 17:59:17 +0000 | [diff] [blame] | 133 | template <typename T, ScaleFactor scale> |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 134 | inline std::unique_ptr<Instrument> Instrument::make_instrument() |
| 135 | { |
Georgios Pinitas | 40f51a6 | 2020-11-21 03:04:18 +0000 | [diff] [blame] | 136 | return std::make_unique<T>(scale); |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 137 | } |
Anthony Barbier | c9afce5 | 2018-01-26 16:07:50 +0000 | [diff] [blame] | 138 | |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 139 | } // namespace framework |
| 140 | } // namespace test |
| 141 | } // namespace arm_compute |
| 142 | #endif /* ARM_COMPUTE_TEST_INSTRUMENT */ |