stk::diag Namespace Reference


Classes

class  TimerSet
 Class TimerSet implements a set of timer classifications. More...
class  Timer
 Class Timer implements a diagnostic timer and timer container for the collection and display of execution times. More...
class  TimeBlock
 Class TimeBlock is a time sentry for timing a statement block. More...
class  TimeBlockSynchronized
 Class TimeBlockSynchronized is a time sentry for timing a statement block. More...
struct  LapCount
struct  CPUTime
struct  WallTime
struct  MPICount
struct  MPIByteCount
struct  MetricTraits< LapCount >
struct  MetricTraits< CPUTime >
struct  MetricTraits< WallTime >
struct  MetricTraits< MPICount >
struct  MetricTraits< MPIByteCount >
class  WriterThrowSafe
class  Writer
 Class Writer implements a runtime selectable diagnostic output writer to aid in the development and diagnostics of massively parallel applications. More...
struct  _setlinemask
 Class _setlinemask is the line mask manipulator. More...
class  c_ptr_
 Class c_ptr_ simply stores a pointer to an object of type T. More...
class  c_ptr_func_
 Class c_ptr_func_ simply stores a pointer to an object of type T. More...
struct  _setw
 Class _setw is the width manipulator. More...
struct  _setprecision
 Class _setprecision is the precision manipulator. More...
struct  _setfill
 Class _setfill is the fill character manipulator. More...
struct  _setiosflags
 Class _setiosflags is the flags manipulator. More...
struct  _resetiosflags
 Class _resetiosflags is the reset ios flags reset manipulator. More...

Typedefs

typedef unsigned TimerMask
 Timer classification mask.
typedef std::list< TimerTimerList
 A vector of subordinate timers.
typedef unsigned long MetricsMask
typedef unsigned long PrintMask

Enumerations

enum  Metrics {
  METRICS_LAP_COUNT = 0x0001,
  METRICS_CPU_TIME = 0x0002,
  METRICS_WALL_TIME = 0x0004,
  METRICS_MPI_COUNT = 0x0008,
  METRICS_MPI_BYTE_COUNT = 0x0010,
  METRICS_ALL = 0x7FFF,
  METRICS_FORCE = 0x8000
}
 Enumeration Metrics assigns a unique but for each type of timer. More...

Functions

std::ostream & operator<< (std::ostream &os, const Percent &p)
 Member function operator&lt;< .
template<typename T>
Writeroperator<< (Writer &dout, const ParallelTimer::Metric< T > &t)
Writeroperator<< (Writer &dout, const ParallelTimer &parallel_timer)
void merge_parallel_timer (ParallelTimer &p0, const ParallelTimer &p1, bool checkpoint)
void collect_timers (Timer &root_timer, ParallelTimer &parallel_timer, bool checkpoint, ParallelMachine comm)
PrintTableprintSubtable (PrintTable &table, const Timer &root_timer, const Timer &timer, MetricsMask metrics_mask, int depth, bool timer_checkpoint)
PrintTableprintSubtable (PrintTable &table, const ParallelTimer &root_timer, const ParallelTimer &timer, MetricsMask metrics_mask, int depth, bool timer_checkpoint)
PrintTableprintTable (PrintTable &table, Timer &root_timer, MetricsMask metrics_mask, size_t name_width, bool timer_checkpoint)
PrintTableprintTable (PrintTable &table, Timer &root_timer, MetricsMask metrics_mask, size_t name_width, bool timer_checkpoint, ParallelMachine parallel_machine)
std::ostream & printTimersTable (std::ostream &os, Timer root_timer, MetricsMask metrics_mask, bool timer_checkpoint)
std::ostream & printTimersTable (std::ostream &os, Timer root_timer, MetricsMask metrics_mask, bool timer_checkpoint, ParallelMachine parallel_machine)
std::ostream & printXML (std::ostream &os, MetricsMask metrics_mask, bool timer_checkpoint)
std::ostream & printSubXML (std::ostream &os, MetricsMask metrics_mask, int depth, bool timer_checkpoint)
template<class T>
MetricTraits< T >::Type value_now ()
std::vector< std::string > & split (const std::string &path, char separator, std::vector< std::string > &path_vector)
MetricsMask getEnabledTimerMetricsMask ()
 Function getEnabledMetricsMask retruns the timer enable bit mask.
void setEnabledTimerMetricsMask (MetricsMask timer_mask)
 Function setEnabledMetricsMask set the timer enable bit mask to timer_mask.
Writeroperator<< (Writer &dout, const TimerImpl &timer)
 Member function operator&lt;< .
void updateRootTimer (Timer root_timer)
 Function updateRootTimer updates the root timers stop and total metric values with the current time.
Timer createRootTimer (const std::string &name, const TimerSet &timer_set)
 Function createRootTimer creates a root timer.
void deleteRootTimer (Timer timer)
 Function deleteRootTimer deletes a root timer and all of it's children timers.
std::vector< Timer > & findTimers (Timer root_timer, const std::string &path_tail, std::vector< Timer > &found_timers)
 Member function findTimer return a vector of timers whose tail of the dot separated name from root_time to leaf matches the specified path_tail.
template<class T>
Writeroperator<< (Writer &dout, const Timer::Metric< T > &timer)
 Function operator<< writes a timer to the diagnostic stream.
Writeroperator<< (Writer &dout, const Timer &timer)
 Function operator<< writes a timer metric to the diagnostic stream.
int getTimerTimeFormat ()
 Member function getTimerTimeFormat.
void setTimerTimeFormat (int time_format)
 Member function setTimerTimeFormat sets the display format of time in the output tables.
template<class T>
MetricTraits< T >::Type now ()
Writeroperator<< (Writer &dout, const void *ptr)
Writeroperator<< (Writer &dout, const char *c_str)
 Function operator<< writes the c sytle string to the output stream.
Writeroperator<< (Writer &dout, const std::string &s)
Writeroperator<< (Writer &dout, const float &x)
Writeroperator<< (Writer &dout, const double &x)
Writeroperator<< (Writer &dout, const long double &x)
Writeroperator<< (Writer &dout, const int &x)
Writeroperator<< (Writer &dout, const unsigned int &x)
Writeroperator<< (Writer &dout, const long &x)
Writeroperator<< (Writer &dout, const unsigned long &x)
Writeroperator<< (Writer &dout, const long long &x)
Writeroperator<< (Writer &dout, const unsigned long long &x)
Writeroperator<< (Writer &dout, const short &x)
Writeroperator<< (Writer &dout, const unsigned short &x)
Writerdendl (Writer &dout)
 Writer function dendl calls the Writer::dendl manipulator.
Writerdflush (Writer &dout)
 Writer function dflush calls the Writer::dflush manipulator.
Writerpush (Writer &dout)
 Function push calls the Writer::push manipulator.
Writerpop (Writer &dout)
 Member function pop calls the Writer::pop manipulator.
_setlinemask setlinemask (PrintMask line_mask)
 Function setlinemask sets the active line mask bits as a manipulator.
Writeroperator<< (Writer &dout, _setlinemask set_line_mask)
 Function operator<< class the Writer::setLineMask manipulator.
Writerresetlinemask (Writer &dout)
 Function resetlinemask calls the Writer::resetLineMask manipulator.
template<class T>
c_ptr_< T > c_ptr (const T *t)
 Member function c_ptr creates a c_ptr_ object of type T ala std::make_pair.
template<class T, typename R>
c_ptr_func_< T, R > c_ptr_func (const T *t, R(T::*pmf)() const)
 Template function c_ptr creates a c_ptr_func_ object of type T ala std::make_pair.
template<class T>
Writeroperator<< (Writer &dout, const c_ptr_< T > &c)
 Template function operator<< dereferences the c_ptr_ object's member m_t if it is not null and writes that to the diagnostic writer.
template<class T, typename R>
Writeroperator<< (Writer &dout, const c_ptr_func_< T, R > &c)
 Template function operator<< dereferences the c_ptr_func_ object's member m_t if it is not null and calls the m_pmf member function and writes the result of that to the diagnostic writer.
Writeroperator<< (Writer &dout, const std::type_info &t)
 Function operator<< wrties a std::type_info name to the diagnostic writer.
template<class T>
Writeroperator<< (Writer &dout, const std::auto_ptr< T > &t)
 Template function operator<< writes an std::auto_ptr object address and content to the diagnostic writer.
template<class T, class U>
Writeroperator<< (Writer &dout, const std::pair< T, U > &pair)
 Template function operator<< writes the members of an arbitrary std::pair object to the diagnostic writer.
template<class T>
Writerdump (Writer &dout, const std::vector< T > &t)
 Template dump prints the object contained within a std::vector object to the diagnostic writer.
template<class T>
Writerdump (Writer &dout, const std::vector< T * > &t)
 Template function dump prints the object pointed to that are contained within a std::vector object to the diagnostic writer.
template<class T>
Writerdump (Writer &dout, const std::list< T > &t)
 Template function dump prints the object contained within a std::list object to the diagnostic writer.
template<class T>
Writerdump (Writer &dout, const std::list< T * > &t)
 Template function dump prints the object pointed to that are contained within a std::list object to the diagnostic writer.
template<class Key, class T, class L>
Writerdump (Writer &dout, const std::map< Key, T, L > &t)
 Template function dump prints the object contained within a std::map object to the diagnostic writer.
template<class Key, class T, class L>
Writerdump (Writer &dout, const std::map< Key, T *, L > &t)
 Template function dump prints the object pointed to that are contained within a std::map to the diagnostic writer.
template<class Key, class T, class L>
Writerdump (Writer &dout, const std::multimap< Key, T, L > &t)
 Template function dump prints the object contained within a std::multimap object to the diagnostic writer.
template<class Key, class T, class L>
Writerdump (Writer &dout, const std::multimap< Key, T *, L > &t)
 Template function dump prints the object pointed to that are contained within a std::multimap to the diagnostic writer.
template<class Key, class L>
Writerdump (Writer &dout, const std::set< Key, L > &t)
 Template function dump prints the object contained within a std::set object to the diagnostic writer.
template<class Key, class L>
Writerdump (Writer &dout, const std::set< Key *, L > &t)
 Template function dump prints the object contained within a std::set object to the diagnostic writer.
template<class Key, class L>
Writerdump (Writer &dout, const std::multiset< Key, L > &t)
 Template function dump prints the object contained within a std::multiset object to the diagnostic writer.
template<class Key, class L>
Writerdump (Writer &dout, const std::multiset< Key *, L > &t)
 Template function dump prints the object contained within a std::multiset object to the diagnostic writer.
template<size_t n>
Writeroperator<< (Writer &dout, const std::bitset< n > &t)
 Template dump prints the object pointed to that are contained within a hash_map to the diagnostic writer.
template<class T>
Writeroperator<< (Writer &dout, const std::vector< T > &t)
 Member function operator<< write the std::vector object to the diagnostic writer.
template<class T>
Writeroperator<< (Writer &dout, const std::list< T > &t)
 Template function operator<< write the std::list object to the diagnostic writer.
template<class Key, class T, class L>
Writeroperator<< (Writer &dout, const std::map< Key, T, L > &t)
 Template function operator<< writes the std::map object to the diagnostic writer.
template<class Key, class T, class L>
Writeroperator<< (Writer &dout, const std::multimap< Key, T, L > &t)
 Template function operator<< writes the std::multimap object to the diagnostic writer.
template<class Key, class L>
Writeroperator<< (Writer &dout, const std::set< Key, L > &t)
 Template function operator<< writes the std::set object to the diagnostic writer.
template<class Key, class L>
Writeroperator<< (Writer &dout, const std::multiset< Key, L > &t)
 Template function operator<< writes the std::multiset object to the diagnostic writer.
Writeroperator<< (Writer &dout, _setw set_width)
Writeroperator<< (Writer &dout, _setprecision set_precision)
Writeroperator<< (Writer &dout, _setfill set_fill)
Writeroperator<< (Writer &dout, _resetiosflags reset_flags)
Writeroperator<< (Writer &dout, _setiosflags set_flags)
Writerfixed (Writer &dout)
Writerscientific (Writer &dout)
Writerdec (Writer &dout)
Writerhex (Writer &dout)
Writeroct (Writer &dout)
_setw setw (int width)
 Function setw sets the width for the next field as a manipulator.
_setprecision setprecision (int precision)
 Function setprecision sets the numeric precision as a manipulator.
_setfill setfill (char fill)
 Function setfill sets the fill character as a manipulator.
_setiosflags setiosflags (std::ios_base::fmtflags flags)
 Function setiosflags sets the ios flags as a manipulator.
_resetiosflags resetiosflags (std::ios_base::fmtflags flags)
 Function resetiosflags clears the ios flags as a manipulator.
template<class T>
Writeroperator<< (Writer &dout, const T &t)
 Function operator<< is the catch all std::ostream output put-to operator to Writer put-to operator.

Variables

MetricsMask s_enabledMetricsMask = METRICS_LAP_COUNT | METRICS_CPU_TIME | METRICS_WALL_TIME
 Bit mask of enabled metrics.
int s_timeFormat = TIMEFORMAT_HMS | TIMEFORMAT_MILLIS


Enumeration Type Documentation

enum stk::diag::Metrics

Enumeration Metrics assigns a unique but for each type of timer.

The METRICS_FORCE type allows a timer to force itself to be active, even is not enabled.

Enumerator:
METRICS_LAP_COUNT  Count of timer starts.
METRICS_CPU_TIME  CPU runtime.
METRICS_WALL_TIME  Wall clock time.
METRICS_MPI_COUNT  MPI class count.
METRICS_MPI_BYTE_COUNT  MPI byte count.
METRICS_FORCE  Force metrics to be acquired.

Definition at line 38 of file TimerMetricTraits.hpp.


Function Documentation

std::ostream& stk::diag::@98::operator<< ( std::ostream &  os,
const Percent &  p 
) [inline, static]

Member function operator&lt;< .

..

Parameters:
os a std::ostream variable ...
p a TimerImpl::Percent variable ...
Returns:
a std::ostream ...

Definition at line 109 of file PrintTimer.cpp.

MetricsMask stk::diag::getEnabledTimerMetricsMask (  ) 

Function getEnabledMetricsMask retruns the timer enable bit mask.

Returns:
a MetricsMask value of the timer enable bit mask.

Definition at line 59 of file Timer.cpp.

void stk::diag::setEnabledTimerMetricsMask ( MetricsMask  timer_mask  ) 

Function setEnabledMetricsMask set the timer enable bit mask to timer_mask.

Parameters:
timer_mask a MetricsMask value to set the timer enable bit mask to.

Definition at line 65 of file Timer.cpp.

Writer& stk::diag::operator<< ( Writer &  dout,
const TimerImpl &  timer 
) [inline]

Member function operator&lt;< .

..

Parameters:
dout a Writer variable ...
timer a TimerImpl variable ...
Returns:
a Writer ...

Definition at line 357 of file Timer.cpp.

void stk::diag::updateRootTimer ( Timer  root_timer  ) 

Function updateRootTimer updates the root timers stop and total metric values with the current time.

Parameters:
root_timer a Timer reference to the root timer.

Definition at line 363 of file Timer.cpp.

Timer stk::diag::createRootTimer ( const std::string &  name,
const TimerSet &  timer_set 
)

Function createRootTimer creates a root timer.

Root timers are the root of a timer hierarchy. The timer_set specifies the timer groupings for this root timer. The percentage of a child timer is the ratio of that timer the its root.

Parameters:
name a std::string const reference to the name of the new root timer.
timer_set a TimerSet const reference of the timer set of the new root timer.
Returns:
a Timer value of the new root timer.

Definition at line 371 of file Timer.cpp.

void stk::diag::deleteRootTimer ( Timer  timer  ) 

Function deleteRootTimer deletes a root timer and all of it's children timers.

All children Timers are invalidated and can no longer be used.

Parameters:
a Timer value of the root timer to delete.

Definition at line 380 of file Timer.cpp.

std::vector< Timer > & stk::diag::findTimers ( Timer  root_timer,
const std::string &  path_tail,
std::vector< Timer > &  found_timers 
)

Member function findTimer return a vector of timers whose tail of the dot separated name from root_time to leaf matches the specified path_tail.

Parameters:
root_timer a Timer value of the root to begin search.
path_tail a std::string const reference to the dot separated tail to match.
found_timer a std::vector<Timer> reference to the vector to store matching timers.
Returns:
a std::vector<Timer> reference to found_timer.

Definition at line 389 of file Timer.cpp.

template<class T>
Writer& stk::diag::operator<< ( Writer &  dout,
const Timer::Metric< T > &  timer 
) [inline]

Function operator<< writes a timer to the diagnostic stream.

Parameters:
dout a Writer reference to the diagnostic writer to print to.
timer a Timer::Metric const reference to the timer to print.
Returns:
a Writer reference to dout.

Definition at line 628 of file Timer.hpp.

Writer& stk::diag::operator<< ( Writer &  dout,
const Timer &  timer 
) [inline]

Function operator<< writes a timer metric to the diagnostic stream.

Parameters:
dout a Writer reference to the diagnostic writer to print to.
timer a Timer::Metric const reference to the timer to print.
Returns:
a Writer reference to dout.

Definition at line 643 of file Timer.hpp.

void stk::diag::setTimerTimeFormat ( int  time_format  ) 

Member function setTimerTimeFormat sets the display format of time in the output tables.

Parameters:
time_format a TimeFormat variable...

Definition at line 33 of file TimerMetricTraits.cpp.


Generated on Tue Jul 13 09:27:33 2010 for Sierra Toolkit by  doxygen 1.4.7