Ryzom

h1. Timing system in NeL

h2. Introduction

This page will describe all classes related to the time on NeL. All these classes are in the NeLMisc library.

h2. CTime in time_nl.h

CTime contains only static methods to get the time, in second since Unix epoch, in millisecond or using processor ticks. Check time_nl.h or "Doxygen":http://dev.ryzom.com/ext/doxygen/nel/index.html for more information.

h2. CCPUTimeStat in cpu_time_stat.h

Only works on Unices. Allows accurate timing measures for both cpu and process (at least at OS timing accuracy). Check cpu_time_stat.h or "Doxygen":http://dev.ryzom.com/ext/doxygen/nel/index.html for more information.

h2. CStopWatch in stop_watch.h

Stopwatch class used for performance measurements and statistics. It allows you to measure the time elapsed with controls like ''start'', ''stop'', ''pause'', and ''resume''.

Check stop_watch.h or "Doxygen":http://dev.ryzom.com/ext/doxygen/nel/index.html for more information.

* Simple Stop Watch usage is straight forward:

<pre><code class="CPP">void foo()

{

    // create the stop watch.

    NLMISC::CStopWatch stopWatch;

    // start the timer.

    stopWatch.start();

    // ... process some code here.

    // stop the timer.

    stopWatch.stop();

    // and output the results.

    nlinfo("Time Elapsed in Milliseconds: %d", stopWatch.getDuration());

}</code></pre>

* Some slightly more advanced options are:

<pre><code class="CPP">void foo()

{

    // create the stop watch.

    NLMISC::CStopWatch stopWatch;

    // start the timer.

    stopWatch.start();

    // ... process some code here.

    // pause the timer..

    stopWatch.pause();

    // ... process some code that shouldn't affect your dynamically.

    // add the time we want to assume the above code took.

    stopWatch.addTime( /* time here is in ticks... */ 1500 );

    // resume the timer.

    stopWatch.resume();

    // ... process some code here.

    // stop the timer.

    stopWatch.stop();

    // start the timer.

    stopWatch.start();

    // ... process the same code here.

    // stop the timer.

    stopWatch.stop();

    // and output the results.

    nlinfo("Time Elapsed in Milliseconds: %d", stopWatch.getDuration());

    nlinfo("Average Time of Both start/stop calls in Milliseconds: %d", stopWatch.getAverageDuration());

}</code></pre>

h2. CHTimer in hierarchical_timer.h

Allows to accurately measure performance of routines, and displays results hierarchically. It's the best way to know what is slow in your program. It's really easy to use and give you good measures.

* Create a function to activate/deactivate the bench.

<pre><code class="CPP">void switchBench()

{

    static bool benching = false;

    benching = !benching;

    if(benching)

    {

        nlinfo("Start of benchmark");

        CHTimer::startBench();

    }

    else

    {

        nlinfo("End of benchmark");

        CHTimer::endBench();

        CHTimer::display(InfoLog, CHTimer::TotalTime, true, true);

        CHTimer::displayHierarchicalByExecutionPathSorted(InfoLog, CHTimer::TotalTime, true, 64, 3);

    }

}</code></pre>

* Then add H_BEFORE and H_AFTER around each code block you want to bench.

<pre><code class="CPP">H_BEFORE( nameofbenchinlist );

// ... your code to bench ...

H_AFTER( nameofbenchinlist );</code></pre>

* If you use H_AUTO, it'll bench the current scope.

<pre><code class="CPP">void func()

{

  H_AUTO( func ); // it'll bench the func() scope

  // ...some code...

  if(i<j)

  {

    H_AUTO( func_less ); // it'll bench the if() scope

    // ...some code...

  }

  // ...some code...

}</code></pre>