tests/framework/instruments/PMUCounter.h

   1 /*
   2  * Copyright (c) 2017-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  */
  24 #ifndef ARM_COMPUTE_TEST_PMU_COUNTER
  25 #define ARM_COMPUTE_TEST_PMU_COUNTER
  26
  27 #include "Instrument.h"
  28 #include "PMU.h"
  29
  30 namespace arm_compute
  31 {
  32 namespace test
  33 {
  34 namespace framework
  35 {
  36 /** Implementation of an instrument to count CPU cycles. */
  37 class PMUCounter : public Instrument
  38 {
  39 public:
  40     /** Construct a PMU counter.
  41      *
  42      * @param[in] scale_factor Measurement scale factor.
  43      */
  44     PMUCounter(ScaleFactor scale_factor)
  45     {
  46         switch(scale_factor)
  47         {
  48             case ScaleFactor::NONE:
  49                 _scale_factor = 1;
  50                 _unit         = "";
  51                 break;
  52             case ScaleFactor::SCALE_1K:
  53                 _scale_factor = 1000;
  54                 _unit         = "K ";
  55                 break;
  56             case ScaleFactor::SCALE_1M:
  57                 _scale_factor = 1000000;
  58                 _unit         = "M ";
  59                 break;
  60             default:
  61                 ARM_COMPUTE_ERROR("Invalid scale");
  62         }
  63     };
  64
  65     std::string     id() const override;
  66     void            start() override;
  67     void            stop() override;
  68     MeasurementsMap measurements() const override;
  69
  70 private:
  71     PMU       _pmu_cycles{ PERF_COUNT_HW_CPU_CYCLES };
  72     PMU       _pmu_instructions{ PERF_COUNT_HW_INSTRUCTIONS };
  73     long long _cycles{ 0 };
  74     long long _instructions{ 0 };
  75     int       _scale_factor{};
  76 };
  77 } // namespace framework
  78 } // namespace test
  79 } // namespace arm_compute
  80 #endif /* ARM_COMPUTE_TEST_PMU_COUNTER */