src/armnn/WallClockTimer.hpp

//
// Copyright © 2017 Arm Ltd. All rights reserved.
// SPDX-License-Identifier: MIT
//

#pragma once

#include "Instrument.hpp"
#include <chrono>

namespace armnn
{

// Clock class that uses the same timestamp function as the Mali DDK where possible.
class monotonic_clock_raw {
public:
    using duration = std::chrono::nanoseconds;
    using time_point = std::chrono::time_point<monotonic_clock_raw, duration>;

    static std::chrono::time_point<monotonic_clock_raw, std::chrono::nanoseconds> now() noexcept
    {
#if defined(__unix__)
        timespec ts;
        clock_gettime(CLOCK_MONOTONIC_RAW, &ts);
        return time_point(std::chrono::nanoseconds(ts.tv_sec * 1000000000 + ts.tv_nsec));
#else
        // On other platforms we have to make do with the standard C++ API, which may not exactly match
        // the Mali DDK.
        return std::chrono::time_point<monotonic_clock_raw, std::chrono::nanoseconds>();
#endif
    }
};

// Implementation of an instrument to measure elapsed wall-clock time in microseconds.
class WallClockTimer : public Instrument
{
public:
    // Construct a Wall Clock Timer
    WallClockTimer() = default;
    ~WallClockTimer() = default;

    // Start the Wall clock timer
    void Start() override;

    // Stop the Wall clock timer
    void Stop() override;

    // Get the name of the timer
    const char* GetName() const override;

    // Get the recorded measurements
    std::vector<Measurement> GetMeasurements() const override;

#if defined(CLOCK_MONOTONIC_RAW)
    using clock = monotonic_clock_raw;
#else
    using clock = std::chrono::steady_clock;
#endif

    static const std::string WALL_CLOCK_TIME;
    static const std::string WALL_CLOCK_TIME_START;
    static const std::string WALL_CLOCK_TIME_STOP;

private:
    clock::time_point m_Start;
    clock::time_point m_Stop;
};

} //namespace armnn