Files
test2/source/blender/blenlib/BLI_timeit.hh
2025-03-29 15:18:50 +11:00

93 lines
2.4 KiB
C++

/* SPDX-FileCopyrightText: 2023 Blender Authors
*
* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup bli
*/
#pragma once
#include <chrono>
#include <optional>
#include <string>
#include "BLI_sys_types.h"
namespace blender::timeit {
using Clock = std::chrono::steady_clock;
using TimePoint = Clock::time_point;
using Nanoseconds = std::chrono::nanoseconds;
void print_duration(Nanoseconds duration);
class ScopedTimer {
private:
std::string name_;
TimePoint start_;
public:
ScopedTimer(std::string name) : name_(std::move(name))
{
start_ = Clock::now();
}
~ScopedTimer();
};
class ScopedTimerAveraged {
private:
std::string name_;
TimePoint start_;
Nanoseconds rolling_average_ = Nanoseconds();
int64_t &total_count_;
Nanoseconds &total_time_;
Nanoseconds &min_time_;
std::optional<int64_t> window_size_;
public:
ScopedTimerAveraged(std::string name,
int64_t &total_count,
Nanoseconds &total_time,
Nanoseconds &min_time,
const std::optional<int64_t> window_size)
: name_(std::move(name)),
total_count_(total_count),
total_time_(total_time),
min_time_(min_time),
window_size_(window_size)
{
start_ = Clock::now();
}
~ScopedTimerAveraged();
};
} // namespace blender::timeit
#define SCOPED_TIMER(name) blender::timeit::ScopedTimer scoped_timer(name)
/**
* Print the average and minimum runtime of the timer's scope.
* \warning This uses static variables, so it is not thread-safe.
*/
#define SCOPED_TIMER_AVERAGED(name) \
static int64_t total_count_; \
static blender::timeit::Nanoseconds total_time_; \
static blender::timeit::Nanoseconds min_time_ = blender::timeit::Nanoseconds::max(); \
blender::timeit::ScopedTimerAveraged scoped_timer( \
name, total_count_, total_time_, min_time_, std::nullopt)
/**
* Print the rolling average and minimum runtime of the timer's scope.
* \warning This uses static variables, so it is not thread-safe.
*/
#define SCOPED_TIMER_ROLLING_AVERAGED(name, window_size) \
static int64_t total_count_; \
static blender::timeit::Nanoseconds total_time_; \
static blender::timeit::Nanoseconds min_time_ = blender::timeit::Nanoseconds::max(); \
blender::timeit::ScopedTimerAveraged scoped_timer( \
name, total_count_, total_time_, min_time_, window_size)