Profiler Class Reference

A simple profiler to measure the average time lengths that a particular task/function takes. Currently not thread-safe and not thread-smart, but it will probably work fine if you use it on a high level. More...

#include <Profiler.h>

Collaboration diagram for Profiler:

Public Member Functions
virtual	~Profiler ()
	write to a profile at the end of the test. More...
void	Begin (const char *fileName, int lineNum, const char *taskDescription)
	start the task timer. More...
void	End (const char *fileName, int lineNum, const char *taskDescription)
	end the task timer. More...

Static Public Member Functions
static Profiler *	Instance ()
	Gets the singleton instance. More...

Protected Member Functions
	Profiler ()
	private constructor - Singleton. More...
TaskProfile *	GetOrCreateTaskProfile (const char *fileName, int lineNum)
	find a taskProfile for the given task, otherwise create More...
TaskProfile *	GetTaskProfileByDescription (const char *description)

Protected Attributes
std::vector< std::unique_ptr< TaskProfile > >	mTasks
std::mutex	mTasksMutex

Detailed Description

A simple profiler to measure the average time lengths that a particular task/function takes. Currently not thread-safe and not thread-smart, but it will probably work fine if you use it on a high level.

Definition at line 39 of file Profiler.h.

Constructor & Destructor Documentation

~Profiler()

Profiler::~Profiler ( )

virtual

write to a profile at the end of the test.

Definition at line 30 of file Profiler.cpp.

{
   if(mTasks.size())
   {
      //print everything out.  append to a log.
      FILE* log = fopen("AudacityProfilerLog.txt", "a");
      time_t now;
 
      time(&now);
      wxFprintf(log,"Audacity Profiler Run, Ended at ");
      wxFprintf(log,"%s",ctime(&now));
      wxFprintf(log,"****************************************\n");
      //print out the tasks
      for(int i=0;i<(int)mTasks.size();i++)
      {
         if(mTasks[i]->mNumHits>0)
         {
            wxFprintf(log,"Task: %s\n(begins at line %d in %s)\n\n",mTasks[i]->mDescription.get(), mTasks[i]->mLine, mTasks[i]->mFileName.get());
            wxFprintf(log,"Number of times run: %d\n",mTasks[i]->mNumHits);
            wxFprintf(log,"Total run time (seconds): %f\n", (double)mTasks[i]->mCumTime/CLOCKS_PER_SEC);
            wxFprintf(log,"Average run time (seconds): %f\n",mTasks[i]->ComputeAverageRunTime());
 
            if(i < ((int)mTasks.size()) -1)
               wxFprintf(log,"----------------------------\n");
         }
      }
      wxFprintf(log,"\n****************************************\n\n\n");
 
      fclose(log);
   }
}

References mTasks.

Profiler()

Profiler::Profiler ( )

inlineprotected

private constructor - Singleton.

Definition at line 56 of file Profiler.h.

{};

Member Function Documentation

Begin()

void Profiler::Begin	(	const char *	fileName,
		int	lineNum,
		const char *	taskDescription
	)

start the task timer.

Definition at line 63 of file Profiler.cpp.

{
   std::lock_guard<std::mutex> guard{ mTasksMutex };
   GetOrCreateTaskProfile(fileName,lineNum)->Begin(fileName,lineNum,taskDescription);
}

References TaskProfile::Begin(), GetOrCreateTaskProfile(), and mTasksMutex.

Here is the call graph for this function:

End()

void Profiler::End	(	const char *	fileName,
		int	lineNum,
		const char *	taskDescription
	)

end the task timer.

Definition at line 70 of file Profiler.cpp.

{
   std::lock_guard<std::mutex> guard{ mTasksMutex };
   TaskProfile* tp;
   tp=GetTaskProfileByDescription(taskDescription);
   if(tp)
      tp->End(fileName,lineNum,taskDescription);
}

References TaskProfile::End(), GetTaskProfileByDescription(), and mTasksMutex.

Here is the call graph for this function:

GetOrCreateTaskProfile()

TaskProfile * Profiler::GetOrCreateTaskProfile ( const char *  fileName, int  lineNum  )

protected

find a taskProfile for the given task, otherwise create

Definition at line 89 of file Profiler.cpp.

{
   for(int i=0;i<(int)mTasks.size();i++)
   {
      if(strcmp(fileName, mTasks[i]->mFileName.get())==0 && lineNum == mTasks[i]->mLine)
         return mTasks[i].get();
   }
 
   auto tp = std::make_unique<TaskProfile>();
   mTasks.push_back(std::move(tp));
   return mTasks.back().get();
}

References mTasks.

Referenced by Begin().

Here is the caller graph for this function:

GetTaskProfileByDescription()

TaskProfile * Profiler::GetTaskProfileByDescription ( const char *  description )

protected

Definition at line 102 of file Profiler.cpp.

{
   for(int i=0;i<(int)mTasks.size();i++)
   {
      if(strcmp(description, mTasks[i]->mDescription.get())==0)
         return mTasks[i].get();
   }
 
   return NULL;
 
}

References mTasks.

Referenced by End().

Here is the caller graph for this function:

Instance()

Profiler * Profiler::Instance ( )

static

Gets the singleton instance.

Definition at line 80 of file Profiler.cpp.

{
   static Profiler pro;
   //this isn't 100% threadsafe but I think Okay for this purpose.
 
   return &pro;
}

Member Data Documentation

mTasks

std::vector<std::unique_ptr<TaskProfile> > Profiler::mTasks

protected

Definition at line 63 of file Profiler.h.

Referenced by GetOrCreateTaskProfile(), GetTaskProfileByDescription(), and ~Profiler().

mTasksMutex

std::mutex Profiler::mTasksMutex

protected

Definition at line 65 of file Profiler.h.

Referenced by Begin(), and End().

---

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

• Profiler.h
• Profiler.cpp