tim::component::cpu_util Struct Reference

this computes the CPU utilization percentage for the calling process and child processes. Only relevant as a time when a different is computed Do not use a single CPU time as an amount of time; it doesn't work that way. More...

#include "timemory/components/timing/components.hpp"

Collaboration diagram for tim::component::cpu_util:

Public Types
using	ratio_t = std::nano
using	value_type = std::pair< int64_t, int64_t >
using	base_type = base< cpu_util, value_type >
using	this_type = cpu_util

Public Member Functions
double	get () const noexcept
double	serialization () const noexcept
double	get_display () const noexcept
void	start () noexcept
void	stop () noexcept
this_type &	operator+= (const this_type &rhs) noexcept
this_type &	operator-= (const this_type &rhs) noexcept
bool	assemble (const wall_clock *wc, const cpu_clock *cc) noexcept
bool	assemble (const wall_clock *wc, const user_clock *uc, const system_clock *sc) noexcept
bool	derive (const wall_clock *wc, const cpu_clock *cc) noexcept
bool	derive (const wall_clock *wc, const user_clock *uc, const system_clock *sc) noexcept
bool	is_derived () const noexcept

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static value_type	record ()

Detailed Description

this computes the CPU utilization percentage for the calling process and child processes. Only relevant as a time when a different is computed Do not use a single CPU time as an amount of time; it doesn't work that way.

Definition at line 286 of file components.hpp.

Member Typedef Documentation

base_type

using tim::component::cpu_util::base_type = base<cpu_util, value_type>

Definition at line 290 of file components.hpp.

ratio_t

using tim::component::cpu_util::ratio_t = std::nano

Definition at line 288 of file components.hpp.

this_type

using tim::component::cpu_util::this_type = cpu_util

Definition at line 291 of file components.hpp.

value_type

using tim::component::cpu_util::value_type = std::pair<int64_t, int64_t>

Definition at line 289 of file components.hpp.

Member Function Documentation

assemble() [1/2]

bool tim::component::cpu_util::assemble ( const wall_clock *  wc, const cpu_clock *  cc  )

inlinenoexcept

Definition at line 342 of file components.hpp.

    {
        if(wc && cc)
            m_derive = true;
        return m_derive;
    }

assemble() [2/2]

bool tim::component::cpu_util::assemble ( const wall_clock *  wc, const user_clock *  uc, const system_clock *  sc  )

inlinenoexcept

Definition at line 349 of file components.hpp.

    {
        if(wc && uc && sc)
            m_derive = true;
        return m_derive;
    }

derive() [1/2]

bool tim::component::cpu_util::derive ( const wall_clock *  wc, const cpu_clock *  cc  )

inlinenoexcept

Definition at line 357 of file components.hpp.

    {
        if(m_derive && wc && cc)
        {
            value.first  = cc->get_value();
            value.second = wc->get_value();
            accum += value;
            return true;
        }
        return false;
    }

derive() [2/2]

bool tim::component::cpu_util::derive ( const wall_clock *  wc, const user_clock *  uc, const system_clock *  sc  )

inlinenoexcept

Definition at line 369 of file components.hpp.

    {
        if(m_derive && wc && uc && sc)
        {
            value.first  = uc->get_value() + sc->get_value();
            value.second = wc->get_value();
            accum += value;
            return true;
        }
        return false;
    }

description()

static std::string tim::component::cpu_util::description ( )

inlinestatic

Definition at line 294 of file components.hpp.

    {
        return "Percentage of CPU-clock time divided by wall-clock time";
    }

get()

double tim::component::cpu_util::get ( ) const

inlinenoexcept

Definition at line 302 of file components.hpp.

    {
        const auto& _data = load();
        double      denom = (_data.second > 0) ? _data.second : 1;
        double      numer = (_data.second > 0) ? _data.first : 0;
        return 100.0 * static_cast<double>(numer) / static_cast<double>(denom);
    }

References tim::component::base< cpu_util, std::pair< int64_t, int64_t > >::load().

Referenced by get_display(), tim::component::process_cpu_util::get_display(), and tim::component::thread_cpu_util::get_display().

get_display()

double tim::component::cpu_util::get_display ( ) const

inlinenoexcept

Definition at line 310 of file components.hpp.

{ return get(); }

References get().

Referenced by serialization(), tim::component::process_cpu_util::serialization(), and tim::component::thread_cpu_util::serialization().

is_derived()

bool tim::component::cpu_util::is_derived ( ) const

inlinenoexcept

Definition at line 382 of file components.hpp.

{ return m_derive; }

label()

static std::string tim::component::cpu_util::label ( )

inlinestatic

Definition at line 293 of file components.hpp.

{ return "cpu_util"; }

operator+=()

this_type& tim::component::cpu_util::operator+= ( const this_type &  rhs )

inlinenoexcept

Definition at line 328 of file components.hpp.

    {
        accum += rhs.accum;
        value += rhs.value;
        return *this;
    }

operator-=()

this_type& tim::component::cpu_util::operator-= ( const this_type &  rhs )

inlinenoexcept

Definition at line 335 of file components.hpp.

    {
        accum -= rhs.accum;
        value -= rhs.value;
        return *this;
    }

record()

static value_type tim::component::cpu_util::record ( )

inlinestatic

Definition at line 298 of file components.hpp.

    {
        return value_type(cpu_clock::record(), wall_clock::record());
    }

References tim::component::cpu_clock::record(), and tim::component::wall_clock::record().

Referenced by start(), tim::component::process_cpu_util::start(), tim::component::thread_cpu_util::start(), stop(), tim::component::process_cpu_util::stop(), and tim::component::thread_cpu_util::stop().

serialization()

double tim::component::cpu_util::serialization ( ) const

inlinenoexcept

Definition at line 309 of file components.hpp.

{ return get_display(); }

References get_display().

start()

void tim::component::cpu_util::start ( )

inlinenoexcept

Definition at line 312 of file components.hpp.

    {
        if(!m_derive)
            value = record();
    }

References record().

stop()

void tim::component::cpu_util::stop ( )

inlinenoexcept

Definition at line 318 of file components.hpp.

    {
        using namespace tim::component::operators;
        if(!m_derive)
        {
            value = (record() - value);
            accum += value;
        }
    }

References record().

---

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

• timemory/components/timing/components.hpp