Botan::Timer Class Reference

#include <timer.h>

Classes
class	Timer_Scope

Public Member Functions
size_t	buf_size () const
double	bytes_per_second () const
uint64_t	cycles_consumed () const
const std::string &	doing () const
uint64_t	events () const
double	events_per_second () const
const std::string &	get_name () const
double	milliseconds () const
double	ms_per_event () const
bool	operator< (const Timer &other) const
Timer &	operator= (const Timer &other)=default
template<typename F >
auto	run (F f) -> decltype(f())
template<typename F >
void	run_until_elapsed (std::chrono::milliseconds msec, F f)
double	seconds () const
double	seconds_per_event () const
void	set_custom_msg (std::string_view s)
void	start ()
void	stop ()
	Timer (const Timer &other)=default
	Timer (std::string_view name)
	Timer (std::string_view name, size_t buf_size)
	Timer (std::string_view name, std::string_view provider, std::string_view doing, uint64_t event_mult, size_t buf_size, double clock_cycle_ratio, uint64_t clock_speed)
std::string	to_string () const
bool	under (std::chrono::milliseconds msec) const
uint64_t	value () const

Detailed Description

Definition at line 16 of file timer.h.

Constructor & Destructor Documentation

Timer() [1/4]

Botan::Timer::Timer	(	std::string_view	name,
		std::string_view	provider,
		std::string_view	doing,
		uint64_t	event_mult,
		size_t	buf_size,
		double	clock_cycle_ratio,
		uint64_t	clock_speed )

Definition at line 30 of file timer.cpp.

                                   :
      m_name(format_timer_name(name, provider)),
      m_doing(doing),
      m_buf_size(buf_size),
      m_event_mult(event_mult),
      m_clock_cycle_ratio(clock_cycle_ratio),
      m_clock_speed(clock_speed) {}

Timer() [2/4]

Botan::Timer::Timer ( std::string_view name )

inline

Definition at line 26 of file timer.h.

: Timer(name, "", "", 1, 0, 0.0, 0) {}

Timer() [3/4]

Botan::Timer::Timer ( std::string_view name, size_t buf_size )

inline

Definition at line 28 of file timer.h.

: Timer(name, "", "", buf_size, buf_size, 0.0, 0) {}

Timer() [4/4]

Botan::Timer::Timer ( const Timer & other )

default

Member Function Documentation

buf_size()

size_t Botan::Timer::buf_size ( ) const

inline

Definition at line 87 of file timer.h.

{ return m_buf_size; }

Referenced by to_string().

bytes_per_second()

double Botan::Timer::bytes_per_second ( ) const

inline

Definition at line 89 of file timer.h.

{ return seconds() > 0.0 ? events() / seconds() : 0.0; }

Referenced by Botan::RFC4880_S2K_Family::tune().

cycles_consumed()

uint64_t Botan::Timer::cycles_consumed ( ) const

inline

Definition at line 74 of file timer.h.

                                       {
         if(m_clock_speed != 0) {
            return static_cast<uint64_t>((m_clock_speed * value()) / 1000.0);
         }
         return m_cpu_cycles_used;
      }

doing()

const std::string & Botan::Timer::doing ( ) const

inline

Definition at line 85 of file timer.h.

{ return m_doing; }

Referenced by operator<().

events()

uint64_t Botan::Timer::events ( ) const

inline

Definition at line 81 of file timer.h.

{ return m_event_count * m_event_mult; }

Referenced by Botan::Argon2_Family::tune(), Botan::Bcrypt_PBKDF_Family::tune(), and Botan::Scrypt_Family::tune().

events_per_second()

double Botan::Timer::events_per_second ( ) const

inline

Definition at line 91 of file timer.h.

{ return seconds() > 0.0 ? events() / seconds() : 0.0; }

get_name()

const std::string & Botan::Timer::get_name ( ) const

inline

Definition at line 83 of file timer.h.

{ return m_name; }

Referenced by operator<().

milliseconds()

double Botan::Timer::milliseconds ( ) const

inline

Definition at line 70 of file timer.h.

{ return value() / 1000000.0; }

ms_per_event()

double Botan::Timer::ms_per_event ( ) const

inline

Definition at line 72 of file timer.h.

{ return milliseconds() / events(); }

operator<()

bool Botan::Timer::operator<

(

const Timer &

other

)

const

Definition at line 70 of file timer.cpp.

                                              {
   if(this->doing() != other.doing()) {
      return (this->doing() < other.doing());
   }
 
   return (this->get_name() < other.get_name());
}

References doing(), and get_name().

operator=()

Timer & Botan::Timer::operator= ( const Timer & other )

default

run()

template<typename F >

auto Botan::Timer::run ( F f ) -> decltype(f())

inline

Definition at line 54 of file timer.h.

                                     {
         Timer_Scope timer(*this);
         return f();
      }

run_until_elapsed()

template<typename F >

void Botan::Timer::run_until_elapsed ( std::chrono::milliseconds msec, F f )

inline

Definition at line 60 of file timer.h.

                                                              {
         while(this->under(msec)) {
            run(f);
         }
      }

Referenced by Botan::Argon2_Family::tune(), Botan::Bcrypt_PBKDF_Family::tune(), Botan::RFC4880_S2K_Family::tune(), and Botan::Scrypt_Family::tune().

seconds()

double Botan::Timer::seconds ( ) const

inline

Definition at line 68 of file timer.h.

{ return milliseconds() / 1000.0; }

seconds_per_event()

double Botan::Timer::seconds_per_event ( ) const

inline

Definition at line 93 of file timer.h.

{ return events() > 0 ? seconds() / events() : 0.0; }

set_custom_msg()

void Botan::Timer::set_custom_msg ( std::string_view s )

inline

Definition at line 95 of file timer.h.

{ m_custom_msg = s; }

start()

void Botan::Timer::start

(

)

Definition at line 44 of file timer.cpp.

                  {
   stop();
   m_timer_start = OS::get_system_timestamp_ns();
   m_cpu_cycles_start = OS::get_cpu_cycle_counter();
}

References Botan::OS::get_cpu_cycle_counter(), Botan::OS::get_system_timestamp_ns(), and stop().

stop()

void Botan::Timer::stop

(

)

Definition at line 50 of file timer.cpp.

                 {
   if(m_timer_start) {
      const uint64_t now = OS::get_system_timestamp_ns();
 
      if(now > m_timer_start) {
         m_time_used += (now - m_timer_start);
      }
 
      if(m_cpu_cycles_start != 0) {
         const uint64_t cycles_taken = OS::get_cpu_cycle_counter() - m_cpu_cycles_start;
         if(cycles_taken > 0) {
            m_cpu_cycles_used += static_cast<size_t>(cycles_taken * m_clock_cycle_ratio);
         }
      }
 
      m_timer_start = 0;
      ++m_event_count;
   }
}

References Botan::OS::get_cpu_cycle_counter(), and Botan::OS::get_system_timestamp_ns().

Referenced by start().

to_string()

std::string Botan::Timer::to_string

(

)

const

Definition at line 78 of file timer.cpp.

                                 {
   if(!m_custom_msg.empty()) {
      return m_custom_msg;
   } else if(this->buf_size() == 0) {
      return result_string_ops();
   } else {
      return result_string_bps();
   }
}

References buf_size().

under()

bool Botan::Timer::under ( std::chrono::milliseconds msec ) const

inline

Definition at line 37 of file timer.h.

{ return (milliseconds() < msec.count()); }

value()

uint64_t Botan::Timer::value ( ) const

inline

Definition at line 66 of file timer.h.

{ return m_time_used; }

Referenced by Botan::Argon2_Family::tune(), Botan::Bcrypt_PBKDF_Family::tune(), and Botan::Scrypt_Family::tune().

---

The documentation for this class was generated from the following files:

• src/lib/utils/timer.h
• src/lib/utils/timer.cpp