Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2017 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_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 | |
Giorgio Arena | ce58a9f | 2017-10-31 17:59:17 +0000 | [diff] [blame^] | 60 | Instrument() = default; |
| 61 | |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 62 | Instrument(const Instrument &) = default; |
| 63 | Instrument(Instrument &&) = default; |
| 64 | Instrument &operator=(const Instrument &) = default; |
| 65 | Instrument &operator=(Instrument &&) = default; |
| 66 | virtual ~Instrument() = default; |
| 67 | |
| 68 | /** Identifier for the instrument */ |
| 69 | virtual std::string id() const = 0; |
| 70 | |
| 71 | /** Start measuring. */ |
| 72 | virtual void start() = 0; |
| 73 | |
| 74 | /** Stop measuring. */ |
| 75 | virtual void stop() = 0; |
| 76 | |
Moritz Pflanzer | 09e4f98 | 2017-08-30 12:47:06 +0100 | [diff] [blame] | 77 | using MeasurementsMap = std::map<std::string, Measurement>; |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 78 | |
Moritz Pflanzer | 09e4f98 | 2017-08-30 12:47:06 +0100 | [diff] [blame] | 79 | /** Return the latest measurement. */ |
| 80 | virtual MeasurementsMap measurements() const = 0; |
Giorgio Arena | ce58a9f | 2017-10-31 17:59:17 +0000 | [diff] [blame^] | 81 | |
| 82 | protected: |
| 83 | std::string _unit{}; |
Moritz Pflanzer | 09e4f98 | 2017-08-30 12:47:06 +0100 | [diff] [blame] | 84 | }; |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 85 | |
Giorgio Arena | ce58a9f | 2017-10-31 17:59:17 +0000 | [diff] [blame^] | 86 | template <typename T, ScaleFactor scale> |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 87 | inline std::unique_ptr<Instrument> Instrument::make_instrument() |
| 88 | { |
Giorgio Arena | ce58a9f | 2017-10-31 17:59:17 +0000 | [diff] [blame^] | 89 | return support::cpp14::make_unique<T>(scale); |
Moritz Pflanzer | a4f711b | 2017-07-05 11:02:23 +0100 | [diff] [blame] | 90 | } |
| 91 | } // namespace framework |
| 92 | } // namespace test |
| 93 | } // namespace arm_compute |
| 94 | #endif /* ARM_COMPUTE_TEST_INSTRUMENT */ |