CaloGPUTimed Class Reference

Base class to provide some basic common infrastructure for timing measurements... More...

#include <CaloGPUTimed.h>

Inheritance diagram for CaloGPUTimed:

Collaboration diagram for CaloGPUTimed:

Protected Member Functions
template<class T >
	CaloGPUTimed (T *ptr)
void	record_times (const size_t event_num, const std::vector< size_t > &times) const
template<class ... Args>
void	record_times (const size_t event_num, const size_t &value) const
template<class ... Args>
void	record_times (const size_t event_num, const size_t &value, Args &&... args) const
void	print_times (const std::string &header, const size_t time_size) const

Protected Attributes
std::mutex	m_timeMutex
	Mutex that is locked when recording times. More...
std::vector< size_t > m_times	ATLAS_THREAD_SAFE
	Vector to hold execution times to be recorded if necessary. More...
std::vector< size_t > m_eventNumbers	ATLAS_THREAD_SAFE
	Vector to hold the event numbers to be recorded if necessary. More...
Gaudi::Property< bool >	m_measureTimes
	If true, times are recorded to the file given by m_timeFileName. More...
Gaudi::Property< std::string >	m_timeFileName
	File to which times should be saved. More...

Private Member Functions
void	record_times_helper (size_t) const
void	record_times_helper (size_t index, size_t t) const
template<class ... Args>
void	record_times_helper (size_t index, size_t t, Args &&... args) const

Detailed Description

Base class to provide some basic common infrastructure for timing measurements...

Author

Nuno Fernandes nuno..nosp@m.dos..nosp@m.santo.nosp@m.s.fe.nosp@m.rnand.nosp@m.es@c.nosp@m.ern.c.nosp@m.h

Date

01 June 2022

Definition at line 24 of file CaloGPUTimed.h.

Constructor & Destructor Documentation

CaloGPUTimed()

template<class T >

CaloGPUTimed::CaloGPUTimed ( T *  ptr )

inlineprotected

Definition at line 55 of file CaloGPUTimed.h.

                       :
  m_measureTimes(ptr, "MeasureTimes", false, "Save time measurements"),
  m_timeFileName(ptr, "TimeFileOutput", "times.txt", "File to which time measurements should be saved")
  {
  }

Member Function Documentation

print_times()

void CaloGPUTimed::print_times ( const std::string &  header, const size_t  time_size  ) const

inlineprotected

Definition at line 138 of file CaloGPUTimed.h.

  {
    if (m_timeFileName.size() == 0)
    {
      return;
    }
 
    std::vector<size_t> indices(m_eventNumbers.size());
    std::iota(indices.begin(), indices.end(), 0);
    std::sort(indices.begin(), indices.end(), [&](size_t a, size_t b)
    {
      return m_eventNumbers[a] < m_eventNumbers[b];
    }
             );
    std::ofstream out(m_timeFileName);
 
    out << "Event_Number Total " << header << "\n";
 
    for (const size_t idx : indices)
      {
        out << m_eventNumbers[idx] << " ";
        
        size_t total = 0;
        
        for (size_t i = 0; i < time_size; ++i)
          {
            total += m_times[idx * time_size + i];
          }
        
        out << total << " ";
        
        for (size_t i = 0; i < time_size; ++i)
          {
            out << m_times[idx * time_size + i] << " ";
          }
        out << "\n";
      }
 
    out << std::endl;
 
    out.close();
  }

record_times() [1/3]

template<class ... Args>

void CaloGPUTimed::record_times ( const size_t  event_num, const size_t &  value  ) const

inlineprotected

Definition at line 102 of file CaloGPUTimed.h.

  {
    const size_t time_size = 1;
 
    size_t old_size;
 
    //Scope just for the lock_guard.
    {
      std::lock_guard<std::mutex> lock_guard(m_timeMutex);
      old_size = m_times.size();
      m_times.resize(old_size + time_size);
      m_eventNumbers.push_back(event_num);
    }
 
    record_times_helper(old_size, value);
  }

record_times() [2/3]

template<class ... Args>

void CaloGPUTimed::record_times ( const size_t  event_num, const size_t &  value, Args &&...  args  ) const

inlineprotected

Definition at line 120 of file CaloGPUTimed.h.

  {
    const size_t time_size = sizeof...(args) + 1;
 
    size_t old_size;
 
    //Scope just for the lock_guard.
    {
      std::lock_guard<std::mutex> lock_guard(m_timeMutex);
      old_size = m_times.size();
      m_times.resize(old_size + time_size);
      m_eventNumbers.push_back(event_num);
    }
 
    record_times_helper(old_size, value, std::forward<Args>(args)...);
 
  }

record_times() [3/3]

void CaloGPUTimed::record_times ( const size_t  event_num, const std::vector< size_t > &  times  ) const

inlineprotected

Definition at line 84 of file CaloGPUTimed.h.

  {
    size_t old_size;
    //Scope just for the lock_guard.
    {
      std::lock_guard<std::mutex> lock_guard(m_timeMutex);
      old_size = m_times.size();
      m_times.resize(old_size + times.size());
      m_eventNumbers.push_back(event_num);
    }
 
    for (size_t i = 0; i < times.size(); ++i)
      {
        m_times[old_size + i] = times[i];
      }
  }

record_times_helper() [1/3]

void CaloGPUTimed::record_times_helper ( size_t  index, size_t  t  ) const

inlineprivate

Definition at line 70 of file CaloGPUTimed.h.

  {
    m_times[index] = t;
  }

record_times_helper() [2/3]

template<class ... Args>

void CaloGPUTimed::record_times_helper ( size_t  index, size_t  t, Args &&...  args  ) const

inlineprivate

Definition at line 76 of file CaloGPUTimed.h.

  {
    record_times_helper(index, t);
    record_times_helper(index + 1, std::forward<Args>(args)...);
  }

record_times_helper() [3/3]

void CaloGPUTimed::record_times_helper ( size_t  ) const

inlineprivate

Definition at line 64 of file CaloGPUTimed.h.

  {
    //Do nothing
  }

Member Data Documentation

ATLAS_THREAD_SAFE [1/2]

std::vector<size_t> m_times CaloGPUTimed::ATLAS_THREAD_SAFE

mutableprotected

Vector to hold execution times to be recorded if necessary.

Definition at line 35 of file CaloGPUTimed.h.

ATLAS_THREAD_SAFE [2/2]

std::vector<size_t> m_eventNumbers CaloGPUTimed::ATLAS_THREAD_SAFE

mutableprotected

Vector to hold the event numbers to be recorded if necessary.

Definition at line 40 of file CaloGPUTimed.h.

m_measureTimes

Gaudi::Property<bool> CaloGPUTimed::m_measureTimes

protected

If true, times are recorded to the file given by m_timeFileName.

Defaults to false.

Definition at line 46 of file CaloGPUTimed.h.

m_timeFileName

Gaudi::Property<std::string> CaloGPUTimed::m_timeFileName

protected

File to which times should be saved.

Definition at line 50 of file CaloGPUTimed.h.

m_timeMutex

std::mutex CaloGPUTimed::m_timeMutex

mutableprotected

Mutex that is locked when recording times.

Definition at line 32 of file CaloGPUTimed.h.

---

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

• CaloGPUTimed.h