Auxiliary class for CPU timing and usage. More...

#include <JTimer.hh>

Inheritance diagram for JEEP::JTimer:

Public Types
enum	JStatus_t { CLK_STOPPED = 0 , CLK_RUNNING = 1 }
	Status of clock. More...

typedef unsigned long long	ull

Public Member Functions
	JTimer ()
	Default constructor.

	JTimer (const JTitle &title)
	Constructor.

void	reset ()
	Reset timer.

void	start ()
	Start timer.

void	stop ()
	Stop timer.

unsigned int	timing_get_cpu_percentage () const
	Get CPU usage.

void	print (std::ostream &out, const JScale_t scale=milli_t) const
	Print timer data.

void	print (std::ostream &out, const bool normalise, const JScale_t scale=milli_t) const
	Print timer data.

void	print (std::ostream &out, const double factor, const JScale_t scale=milli_t) const
	Print timer data.

const std::string &	getTitle () const
	Get title.

void	setTitle (const std::string &title)
	Set title.

Static Public Member Functions
static void	enable ()
	Enable timers.

static void	disable ()
	Disable timers.

static unsigned long long	timeval_to_usec (const struct timeval &tv)
	Convert timeval to micro-seconds.

Public Attributes
unsigned long long	usec_wall

unsigned long long	usec_ucpu

unsigned long long	usec_scpu

unsigned long long	counter

Protected Attributes
JStatus_t	status

std::string	title

Static Private Member Functions
static bool &	get_status ()
	Get status.

Private Attributes
struct timeval	tv

struct rusage	usage

Friends
std::ostream &	operator<< (std::ostream &out, const JTimer &timer)
	Print timer data.

Detailed Description

Auxiliary class for CPU timing and usage.

Definition at line 31 of file JTimer.hh.

Member Typedef Documentation

◆ ull

unsigned long long JEEP::JTimer::ull

Definition at line 36 of file JTimer.hh.

Member Enumeration Documentation

◆ JStatus_t

enum JEEP::JTimer::JStatus_t

Status of clock.

Enumerator
CLK_STOPPED
CLK_RUNNING

Definition at line 41 of file JTimer.hh.

41{ CLK_STOPPED = 0, CLK_RUNNING = 1 };

JEEP::JTimer::CLK_STOPPED

@ CLK_STOPPED

Definition JTimer.hh:41

JEEP::JTimer::CLK_RUNNING

@ CLK_RUNNING

Definition JTimer.hh:41

Constructor & Destructor Documentation

◆ JTimer() [1/2]

JEEP::JTimer::JTimer ( )

inline

Default constructor.

Definition at line 47 of file JTimer.hh.

             :
      JTitle(),
      usec_wall(0ULL),
      usec_ucpu(0ULL),
      usec_scpu(0ULL),
      counter  (0ULL),
      status   (CLK_STOPPED)
    {}

◆ JTimer() [2/2]

JEEP::JTimer::JTimer ( const JTitle & title )

inline

Constructor.

Parameters

title title

Definition at line 62 of file JTimer.hh.

                                :
      JTitle(title),
      usec_wall(0ULL),
      usec_ucpu(0ULL),
      usec_scpu(0ULL),
      counter  (0ULL),
      status   (CLK_STOPPED)
    {}

Member Function Documentation

◆ enable()

static void JEEP::JTimer::enable ( )

inlinestatic

Enable timers.

Definition at line 75 of file JTimer.hh.

    {
      get_status() = true;
    }

◆ disable()

static void JEEP::JTimer::disable ( )

inlinestatic

Disable timers.

Definition at line 84 of file JTimer.hh.

    {
      get_status() = false;
    }

◆ reset()

void JEEP::JTimer::reset ( )

inline

Reset timer.

Definition at line 93 of file JTimer.hh.

    {
      usec_wall = 0;
      usec_ucpu = 0;
      usec_scpu = 0;
      counter   = 0;
      status    = CLK_STOPPED;
    }

◆ start()

void JEEP::JTimer::start ( )

inline

Start timer.

Definition at line 106 of file JTimer.hh.

    {
      if (status == CLK_STOPPED && get_status()) {
        
        gettimeofday(&tv, NULL);
        getrusage(RUSAGE_SELF, &usage);
        
        usec_wall -= timeval_to_usec(tv);
        usec_ucpu -= timeval_to_usec(usage.ru_utime);
        usec_scpu -= timeval_to_usec(usage.ru_stime);
        
        status    = CLK_RUNNING;
        
        ++counter;
      }
    }

◆ stop()

void JEEP::JTimer::stop ( )

inline

Stop timer.

Definition at line 127 of file JTimer.hh.

    {
      if (status == CLK_RUNNING && get_status()) {
        
        gettimeofday(&tv, NULL);
        getrusage(RUSAGE_SELF, &usage);
        
        usec_wall += timeval_to_usec(tv);
        usec_ucpu += timeval_to_usec(usage.ru_utime);
        usec_scpu += timeval_to_usec(usage.ru_stime);
      }
 
      status    = CLK_STOPPED;
    }

◆ timing_get_cpu_percentage()

unsigned int JEEP::JTimer::timing_get_cpu_percentage ( ) const

inline

Get CPU usage.

Returns: CPU usage [%]

Definition at line 148 of file JTimer.hh.

    {
      return (100ULL * (usec_ucpu + usec_scpu) / (usec_wall+1));
    }

◆ timeval_to_usec()

static unsigned long long JEEP::JTimer::timeval_to_usec ( const struct timeval & tv )

inlinestatic

Convert timeval to micro-seconds.

Parameters

tv timeval

Returns: time [us]

Definition at line 160 of file JTimer.hh.

    {
      return (unsigned long long) tv.tv_sec * 1000000ULL + (unsigned long long) tv.tv_usec;
    }

◆ print() [1/3]

void JEEP::JTimer::print	(	std::ostream &	out,
		const JScale_t	scale = milli_t ) const

inline

Print timer data.

Parameters

out	output stream
scale	scale

Definition at line 172 of file JTimer.hh.

    {
      print(out, 1.0, scale);
    }

◆ print() [2/3]

void JEEP::JTimer::print	(	std::ostream &	out,
		const bool	normalise,
		const JScale_t	scale = milli_t ) const

inline

Print timer data.

Parameters

out	output stream
normalise	normalise to number of starts
scale	scale

Definition at line 185 of file JTimer.hh.

    {
      double factor = 1.0;
 
      if (normalise && counter != 0) {
        factor = 1.0 / (double) counter;
      }
 
      print(out, factor, scale);
    }

◆ print() [3/3]

void JEEP::JTimer::print	(	std::ostream &	out,
		const double	factor,
		const JScale_t	scale = milli_t ) const

inline

Print timer data.

Parameters

out	output stream
factor	multiplication factor
scale	scale

Definition at line 204 of file JTimer.hh.

    {
      using namespace std;
      using namespace JPP;
 
      if (get_status()) {
 
        const double y = factor * 1e-3 * getValue(milli_t) / getValue(scale);
        const char*  u = getUnit(scale);
 
        out << getTitle()  << endl;
        out << FIXED(10,3) << usec_wall * y << " " << u << "s elapsed" << endl;
        out << FIXED(10,3) << usec_ucpu * y << " " << u << "s user"    << endl;
        out << FIXED(10,3) << usec_scpu * y << " " << u << "s system"  << endl;
        out << setw( 3)    << timing_get_cpu_percentage() << "%CPU" << endl;
      }
    }

◆ get_status()

static bool & JEEP::JTimer::get_status ( )

inlinestaticprivate

Get status.

Returns: status

Definition at line 255 of file JTimer.hh.

    {
      static bool status = true;
 
      return status;
    }

◆ getTitle()

const std::string & JLANG::JTitle::getTitle ( ) const

inlineinherited

Get title.

Returns: title

Definition at line 55 of file JTitle.hh.

    {
      return this->title;
    }

◆ setTitle()

void JLANG::JTitle::setTitle ( const std::string & title )

inlineinherited

Set title.

Parameters

title title

Definition at line 66 of file JTitle.hh.

    {
      this->title = title;
    }

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	out,
		const JTimer &	timer )

friend

Print timer data.

Parameters

out	output stream
timer	timer

Returns: output stream

Definition at line 230 of file JTimer.hh.

    {
      timer.print(out);
 
      return out;
    }

Member Data Documentation

◆ usec_wall

unsigned long long JEEP::JTimer::usec_wall

Definition at line 238 of file JTimer.hh.

◆ usec_ucpu

unsigned long long JEEP::JTimer::usec_ucpu

Definition at line 239 of file JTimer.hh.

◆ usec_scpu

unsigned long long JEEP::JTimer::usec_scpu

Definition at line 240 of file JTimer.hh.

◆ counter

unsigned long long JEEP::JTimer::counter

Definition at line 241 of file JTimer.hh.

◆ status

JStatus_t JEEP::JTimer::status

protected

Definition at line 244 of file JTimer.hh.

◆ tv

struct timeval JEEP::JTimer::tv

private

Definition at line 247 of file JTimer.hh.

◆ usage

struct rusage JEEP::JTimer::usage

private

Definition at line 248 of file JTimer.hh.

◆ title

std::string JLANG::JTitle::title

protectedinherited

Definition at line 73 of file JTitle.hh.

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

JTimer.hh

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ull

Member Enumeration Documentation

◆ JStatus_t

Constructor & Destructor Documentation

◆ JTimer() [1/2]

◆ JTimer() [2/2]

Member Function Documentation

◆ enable()

◆ disable()

◆ reset()

◆ start()

◆ stop()

◆ timing_get_cpu_percentage()

◆ timeval_to_usec()

◆ print() [1/3]

◆ print() [2/3]

◆ print() [3/3]

◆ get_status()

◆ getTitle()

◆ setTitle()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ usec_wall

◆ usec_ucpu

◆ usec_scpu

◆ counter

◆ status

◆ tv

◆ usage

◆ title