stats.hpp

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <functional>
#include <mutex>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>
 
// To enable stats tracking, compile in RelWithAssert mode.
// cmake --preset $PRESET -DCMAKE_BUILD_TYPE=RelWithAssert
// TODO(fcarreiro): This should be possible to disable.
#define AVM_TRACK_STATS
 
#ifdef AVM_TRACK_STATS
// For tracking time spent in a block of code.
#define AVM_TRACK_TIME(key, body) ::bb::avm2::Stats::get().time(key, [&]() { body; });
// For tracking time spent in a block of code and returning a value.
#define AVM_TRACK_TIME_V(key, body) ::bb::avm2::Stats::get().time_r(key, [&]() { return body; });
#else
#define AVM_TRACK_TIME(key, body) body
#define AVM_TRACK_TIME_V(key, body) body
#endif
 
namespace bb::avm2 {
 
class Stats {
  public:
    static Stats& get();
    void reset();
    void increment(const std::string& key, uint64_t value);
    void time(const std::string& key, const std::function<void()>& f);
 
    template <typename F> auto time_r(const std::string& key, F&& f)
    {
        auto start = std::chrono::system_clock::now();
        auto result = f();
        auto elapsed = std::chrono::system_clock::now() - start;
        increment(key + "_ms",
                  static_cast<uint64_t>(std::chrono::duration_cast<std::chrono::milliseconds>(elapsed).count()));
        return result;
    }
 
    // Returns a string representation of the stats.
    // E.g., if depth = 2, it will show the top 2 levels of the stats.
    // That is, prove/logderiv_ms will be shown but
    // prove/logderiv/relation_ms will not be shown.
    std::string to_string(int depth = 2) const;
 
    // Returns a copy of the stats as (key, value_ms) pairs. Keys retain the "_ms" suffix added by time().
    std::vector<std::pair<std::string, uint64_t>> snapshot() const;
 
  private:
    Stats() = default;
 
    std::unordered_map<std::string, uint64_t> stats;
    mutable std::mutex stats_mutex;
};
 
} // namespace bb::avm2